Version 1.1

Parsing this new file from soundgrinder seems to be error-prone, for now this fixes it.

.travis.yml

@@ -4,10 +4,17 @@ python:
     - "3.6"
     - "3.5"
 script:
-    - "python3 setup.py test"
+    - "python setup.py test"
+    - "py.test tests/ -v --cov wavinfo --cov-report term-missing"
 before_install:
     - "sudo apt-get update"
     - "sudo add-apt-repository universe"
     - "sudo apt-get install -y ffmpeg"
+    - "pip install coverage"
+#    - "pip install coverage==4.4"
+    - "pip install pytest-cov==2.5.0"
+    - "pip install python-coveralls"
 install:
-    - "pip3 install setuptools"
+    - "pip install setuptools"
+after_success:
+    - coveralls

README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.com/iluvcapra/wavinfo.svg?branch=master)](https://travis-ci.com/iluvcapra/wavinfo)
+[![Coverage Status](https://coveralls.io/repos/github/iluvcapra/wavinfo/badge.svg?branch=master)](https://coveralls.io/github/iluvcapra/wavinfo?branch=master)
 [![Documentation Status](https://readthedocs.org/projects/wavinfo/badge/?version=latest)](https://wavinfo.readthedocs.io/en/latest/?badge=latest) ![](https://img.shields.io/github/license/iluvcapra/wavinfo.svg) ![](https://img.shields.io/pypi/pyversions/wavinfo.svg) [![](https://img.shields.io/pypi/v/wavinfo.svg)](https://pypi.org/project/wavinfo/) ![](https://img.shields.io/pypi/wheel/wavinfo.svg)
 
 

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,184 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'wavinfo'
+copyright = u'2019, Jamie Hardt'
+author = u'Jamie Hardt'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u'v1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'wavinfodoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'wavinfo.tex', u'wavinfo Documentation',
+     u'Jamie Hardt', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'wavinfo', u'wavinfo Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'wavinfo', u'wavinfo Documentation',
+     author, 'wavinfo', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/index.rst

@@ -0,0 +1,32 @@
+.. wavinfo documentation master file, created by
+   sphinx-quickstart on Thu Jan  3 17:09:28 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to wavinfo's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. module:: wavinfo
+
+.. autoclass:: WavInfoReader
+   :members:
+
+   .. automethod:: __init__
+   
+
+.. autoclass:: wavinfo.wave_reader.WavAudioFormat
+   :members:
+
+.. autoclass:: wavinfo.wave_reader.WavDataDescriptor
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

setup.py

@@ -4,7 +4,7 @@ with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setup(name='wavinfo',
-      version='1.0',
+      version='1.1',
       author='Jamie Hardt',
       author_email='jamiehardt@me.com',
       description='WAVE sound file metadata parser.',

tests/test_wave_parsing.py

@@ -66,7 +66,7 @@ class TestWaveInfo(TestCase):
         for wav_file in self.all_files():
             info = wavinfo.WavInfoReader(wav_file)
             ffprobe_info = ffprobe(wav_file)
-
+            if info.bext:
                 self.assertEqual( info.bext.description, ffprobe_info['format']['tags']['comment']  )
                 self.assertEqual( info.bext.originator, ffprobe_info['format']['tags']['encoded_by']  )
                 if 'originator_reference' in ffprobe_info['format']['tags']:

wavinfo/__init__.py

@@ -1,4 +1,14 @@
+# -*- coding: utf-8 -*-
+
+# :module:`wavinfo` provides methods to probe a WAV file for
+# various kinds of production metadata.
+#
+#
+#
+#
+
+
 from .wave_reader import WavInfoReader
 
-__version__ = 1.0
+__version__ = '1.1'
 __author__ = 'Jamie Hardt'

wavinfo/riff_parser.py

@@ -1,6 +1,6 @@
 
 import struct
-
+import pdb
 from collections import namedtuple
 
 class ListChunkDescriptor(namedtuple('ListChunkDescriptor' , 'signature children')):
@@ -30,11 +30,16 @@ def parse_list_chunk(stream, length):
 
     children = []
     while (stream.tell() - start) < length:
-        children.append(parse_chunk(stream))
+        child_chunk = parse_chunk(stream)
+        if child_chunk:
+             children.append(child_chunk)
+        else: 
+             break
 
     return ListChunkDescriptor(signature=signature, children=children)
 
 def parse_chunk(stream):
+    #breakpoint()
     ident = stream.read(4)
     if len(ident) != 4:
         return

wavinfo/wave_bext_reader.py

@@ -24,9 +24,6 @@ class WavBextReader:
         #
         # reserved[180]
         # codinghistory []
-        if bext_data is None:
-            return None
-
         packstring = "<256s"+ "32s" + "32s" + "10s" + "8s" + "QH" + "64s" + "hhhhh" + "180s"
 
         rest_starts = struct.calcsize(packstring)

wavinfo/wave_reader.py

@@ -1,3 +1,4 @@
+#-*- coding: utf-8 -*-
 import struct
 
 from collections import namedtuple
@@ -7,46 +8,49 @@ from .wave_ixml_reader import WavIXMLFormat
 from .wave_bext_reader import WavBextReader
 from .wave_info_reader import WavInfoChunkReader
 
+#: Calculated statistics about the audio data.
 WavDataDescriptor = namedtuple('WavDataDescriptor','byte_count frame_count')
 
-WavInfoFormat = namedtuple("WavInfoFormat",'audio_format channel_count sample_rate byte_rate block_align bits_per_sample')
+#: The format of the audio samples.
-
+WavAudioFormat = namedtuple('WavAudioFormat','audio_format channel_count sample_rate byte_rate block_align bits_per_sample')
-WavBextFormat = namedtuple("WavBextFormat",'description originator originator_ref ' +
-    'originator_date originator_time time_reference version umid ' +
-    'loudness_value loudness_range max_true_peak max_momentary_loudness max_shortterm_loudness ' +
-    'coding_history')
 
 
 class WavInfoReader():
     """
-    format : WAV format
+    Parse a WAV audio file for metadata.
-    bext   : The Broadcast-WAV extension as definied by EBU Tech 3285 v2 (2011)
-
     """
 
     def __init__(self, path, info_encoding='latin_1', bext_encoding='ascii'):
         """
-        Parse a WAV audio file for metadata.
+        Create a new reader object.
 
-        * `path`: A filesystem path to the wav file you wish to probe.
+        :param path: A filesystem path to the wav file you wish to probe.
 
-        * `info_encoding`: The text encoding of the INFO metadata fields.
+        :param info_encoding: The text encoding of the INFO metadata fields.
-          `latin_1`/Win CP1252 has always been a pretty good guess for this.
+          latin_1/Win CP1252 has always been a pretty good guess for this.
 
-        * `bext_encoding`: The text encoding to use when decoding the string
+        :param bext_encoding: The text encoding to use when decoding the string
           fields of the Broadcast-WAV extension. Per EBU 3285 this is ASCII
           but this parameter is available to you if you encounter a werido.
 
         """
+
         with open(path, 'rb') as f:
             chunks = parse_chunk(f)
 
             self.main_list = chunks.children
             f.seek(0)
 
+            #: :class:`wavinfo.wave_reader.WavAudioFormat`
             self.fmt    = self._get_format(f)
+
+            #: :class:`wavinfo.wave_bext_reader.WavBextReader` with Broadcast-WAV metadata
             self.bext   = self._get_bext(f, encoding=bext_encoding)
+
+            #: :class:`wavinfo.wave_ixml_reader.WavIXMLFormat` with iXML metadata
             self.ixml   = self._get_ixml(f)
+
+            #: :class:`wavinfo.wave_info_reader.WavInfoChunkReader` with RIFF INFO metadata
             self.info   = self._get_info(f, encoding=info_encoding)
             self.data   = self._describe_data(f)
 
@@ -94,7 +98,7 @@ class WavInfoReader():
         #0xFFFE	WAVE_FORMAT_EXTENSIBLE	Determined by SubFormat
 
         #https://sno.phy.queensu.ca/~phil/exiftool/TagNames/RIFF.html
-        return WavInfoFormat(audio_format = unpacked[0],
+        return WavAudioFormat(audio_format = unpacked[0],
                     channel_count   = unpacked[1],
                     sample_rate     = unpacked[2],
                     byte_rate       = unpacked[3],
@@ -111,7 +115,10 @@ class WavInfoReader():
 
     def _get_bext(self, f, encoding):
         bext_data = self._find_chunk_data(b'bext',f,default_none=True)
+        if bext_data:
             return WavBextReader(bext_data, encoding)
+        else:
+            return None
 
     def _get_ixml(self,f):
         ixml_data = self._find_chunk_data(b'iXML',f,default_none=True)
@@ -121,7 +128,17 @@ class WavInfoReader():
         ixml_string = ixml_data
         return WavIXMLFormat(ixml_string)
 
+    def walk(self):
+        """
+        Walk all of the available metadata fields.
 
+        :yields: a string, the :scope: of the metadatum, the string :name: of the
+        metadata field, and the value
+        """
 
+        scopes = ('fmt','data')#,'bext','ixml','info')
 
-
+        for scope in scopes:
+            attr = self.__getattribute__(scope)
+            for field in attr._fields:
+                yield scope, field, attr.__getattribute__(field)