64 Commits
v0.1 ... v1.1

Author SHA1 Message Date
Jamie Hardt
9e259e9d6c Version 1.1 2019-01-04 18:47:00 -08:00
Jamie Hardt
c20b17e82c Fixed an infinite loop
Parsing this new file from soundgrinder seems to be error-prone, for now this fixes it.
2019-01-04 18:36:22 -08:00
Jamie Hardt
5315575e35 Merge branch 'master' of https://github.com/iluvcapra/wavinfo 2019-01-04 17:55:32 -08:00
Jamie Hardt
52613b78f3 Create new_camera bumb 1.wav
Added test file for more code coverage
2019-01-04 17:55:30 -08:00
Jamie Hardt
0c24c2d986 Update .travis.yml 2019-01-04 17:23:57 -08:00
Jamie Hardt
2a86d7824d Update .travis.yml 2019-01-04 17:20:15 -08:00
Jamie Hardt
c2be0e77c5 Update .travis.yml 2019-01-04 17:16:40 -08:00
Jamie Hardt
9b8b964e74 Update .travis.yml 2019-01-04 17:12:05 -08:00
Jamie Hardt
488c0f2aa9 Update .travis.yml 2019-01-04 17:04:57 -08:00
Jamie Hardt
da51b22c59 Update .travis.yml 2019-01-04 16:55:37 -08:00
Jamie Hardt
a4ffe7dd6b Update README.md
Added coverage badge
2019-01-04 12:06:47 -08:00
Jamie Hardt
0ec5425cd8 Update wave_reader.py
Working on a walk() method, not done yet
2019-01-03 19:22:13 -08:00
Jamie Hardt
8e965f53e5 Documentation 2019-01-03 19:22:01 -08:00
Jamie Hardt
9e16f6ab1f Documentation 2019-01-03 18:24:44 -08:00
Jamie Hardt
477c71830e Comments
Removed dead code
2019-01-03 18:24:36 -08:00
Jamie Hardt
ed8b5f167e Update __init__.py
Version 1.0
2019-01-03 11:47:49 -08:00
Jamie Hardt
97c25ab61f Removed version 3.4 classifier 2019-01-03 11:46:03 -08:00
Jamie Hardt
910b3854c7 Update .travis.yml
Remove version 3.4 support
2019-01-03 11:44:24 -08:00
Jamie Hardt
f12bb0eea4 Update setup.py
Next will be version 1.0
2019-01-03 11:38:08 -08:00
Jamie Hardt
c88599f4fd Update test_wave_parsing.py
Decode ffprobe output before handing over to json
2019-01-03 11:38:00 -08:00
Jamie Hardt
68ccb09f53 Merge branch 'master' of https://github.com/iluvcapra/wavinfo 2019-01-03 11:32:45 -08:00
Jamie Hardt
b7d9f6758d Update test_wave_parsing.py
Removed absolute path to ffprobe
2019-01-03 11:32:41 -08:00
Jamie Hardt
e3adde7498 Update .travis.yml 2019-01-03 11:26:03 -08:00
Jamie Hardt
96885dfb4e Update .travis.yml 2019-01-03 11:20:29 -08:00
Jamie Hardt
126f1ea7c3 Update README.md 2019-01-03 11:16:14 -08:00
Jamie Hardt
0bb664357e Update .travis.yml 2019-01-03 11:15:05 -08:00
Jamie Hardt
9e2c60caf8 Update .travis.yml 2019-01-03 11:10:49 -08:00
Jamie Hardt
82d73b0316 Update .travis.yml 2019-01-03 11:05:27 -08:00
Jamie Hardt
0612e62a7b Update .travis.yml 2019-01-03 11:02:08 -08:00
Jamie Hardt
8fd509482c Update .travis.yml 2019-01-03 11:00:47 -08:00
Jamie Hardt
a9dbfdf5ec Update LICENSE 2019-01-03 10:26:11 -08:00
Jamie Hardt
413826b18f Update LICENSE 2019-01-03 10:25:47 -08:00
Jamie Hardt
71201adee4 Update LICENSE 2019-01-03 10:25:22 -08:00
Jamie Hardt
d88117878c Update LICENSE
Added title to license
2019-01-02 16:35:25 -08:00
Jamie Hardt
b20c5dd1bd Update demo.ipynb 2019-01-02 12:26:52 -08:00
Jamie Hardt
6c9fb38482 Merge branch 'master' of https://github.com/iluvcapra/wavinfo 2019-01-02 12:17:28 -08:00
Jamie Hardt
f5c0700e47 Delete BULLET Impact Plastic LCD TV Screen Shatter Debris 2x.wav 2019-01-02 12:17:26 -08:00
Jamie Hardt
3c101badac Update README.md 2019-01-02 11:38:15 -08:00
Jamie Hardt
50962aefcc Update README.md 2019-01-02 11:28:10 -08:00
Jamie Hardt
f52b2a195a Update wave_bext_reader.py
Oops comma
2019-01-02 11:04:55 -08:00
Jamie Hardt
4586d19a5f Renambed wave_parser -> riff_parser 2019-01-02 00:25:38 -08:00
Jamie Hardt
3e897d030c Removed premature decoding of iXML bytes 2019-01-02 00:17:20 -08:00
Jamie Hardt
9f943aeb61 Update wave_bext_reader.py 2019-01-01 23:55:18 -08:00
Jamie Hardt
a9c3600ad2 Update wave_bext_reader.py
Reorganized this initializer
2019-01-01 23:54:03 -08:00
Jamie Hardt
27d9a2f005 Update wave_bext_reader.py 2019-01-01 23:50:46 -08:00
Jamie Hardt
0c5c0a2088 Update README.md 2019-01-01 23:47:25 -08:00
Jamie Hardt
b150cd6d8e Nudged version, added author 2019-01-01 23:29:20 -08:00
Jamie Hardt
849ade92a4 Merge branch 'master' of https://github.com/iluvcapra/wavinfo 2019-01-01 23:24:36 -08:00
Jamie Hardt
482a3f86d1 Update wavinfo.ipynb 2019-01-01 23:24:23 -08:00
Jamie Hardt
991a12cbb5 Update README.md 2019-01-01 23:22:45 -08:00
Jamie Hardt
37b816045d Update README.md 2019-01-01 23:21:45 -08:00
Jamie Hardt
99aa29c5f3 More work 2019-01-01 23:19:22 -08:00
Jamie Hardt
41b599923a bext Version handling 2019-01-01 20:51:54 -08:00
Jamie Hardt
ae09897abf Fixed bext parsing for metacorder
These have really screwed-up bext chunks that aren't zero-filled.
2019-01-01 19:30:43 -08:00
Jamie Hardt
d37726f090 Reorganized test WAVs into folders 2019-01-01 19:30:06 -08:00
Jamie Hardt
ae52152111 More test WAV files
From Gallery Metacorder
2019-01-01 13:44:56 -08:00
Jamie Hardt
004249773a Update README.md
Fixed ixml URL
2019-01-01 12:36:09 -08:00
Jamie Hardt
ebbdb99c46 Update README.md
Removed Travis badge
2019-01-01 12:25:05 -08:00
Jamie Hardt
32454039bf Trying to get travis build to work 2019-01-01 12:22:23 -08:00
Jamie Hardt
830c702376 Update .travis.yml
Removed other old versions
2019-01-01 12:21:05 -08:00
Jamie Hardt
0723f21e4f Update .travis.yml
Add ffprobe to apt-get (I hope)
2019-01-01 12:20:24 -08:00
Jamie Hardt
08743be3fa Update .travis.yml
Removed unavailable versions
2019-01-01 12:16:16 -08:00
Jamie Hardt
bdb39684c7 Update test_wave_parsing.py
Removed capture_output argument, it's too new
2019-01-01 12:15:17 -08:00
Jamie Hardt
c3c3c12d38 Nudge version 2019-01-01 12:09:03 -08:00
38 changed files with 733 additions and 353 deletions

View File

@@ -1,13 +1,20 @@
dist: xenial
language: python
python:
- "3.6"
- "3.5"
- "3.4"
- "3.3"
- "3.2"
- "3.1"
- "3.0"
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

View File

@@ -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)
@@ -10,30 +11,29 @@ production metadata.
`wavinfo` reads:
* __Broadcast-WAVE__ metadata, compliant with [EBU Tech 3285v2 (2011)][ebu], including embedded program loudness and coding history, if extant.
* [__iXML__ production recorder metadata][ixml], including project, scene, and take tags, recorder notes and file family information.
* The __wav format__ is also parsed, so you can access the basic sample rate and channel count information.
* __Broadcast-WAVE__ metadata, compliant with [EBU Tech 3285v2 (2011)][ebu], including embedded program
loudness and coding history, if extant. This also includes the [SMPTE 330M __UMID__][smpte_330m2011]
Unique Materials Identifier.
* [__iXML__ production recorder metadata][ixml], including project, scene, and take tags, recorder notes
and file family information.
* Most of the common __RIFF INFO__ metadata fields.
* The __wav format__ is also parsed, so you can access the basic sample rate and channel count
information.
In progress:
* [SMPTE 330M __UMID__][smpte_330m2011] Unique Materials Identifier.
* iXML `STEINBERG` sound library attributes.
* Most of the common __RIFF INFO__ metadata fields.
* Pro Tools __embedded regions__.
This module is presently under construction and not sutiable for production at this time.
[ebu]:https://tech.ebu.ch/docs/tech/tech3285.pdf
[smpte_330m2011]:http://standards.smpte.org/content/978-1-61482-678-1/st-330-2011/SEC1.abstract
[ixml]:http://www.ixml.infoi
[ixml]:http://www.ixml.info
## Demonstration
The entry point for wavinfo is the WavInfoReader class.
```python
from wavinfo import WavInfoReader
@@ -44,10 +44,8 @@ info = WavInfoReader(path)
### Basic WAV Data
The length of the file in frames (interleaved samples) and bytes is available, as is the contents of the format chunk.
```python
(info.data.frame_count, info.data.byte_count)
>>> (240239, 1441434)
@@ -55,9 +53,27 @@ The length of the file in frames (interleaved samples) and bytes is available, a
>>> (48000, 2, 6, 24)
```
## Broadcast WAV Extension
### Broadcast WAV Extension
A WAV file produced to Broadcast-WAV specifications will have the broadcast metadata extension,
which includes a 256-character free text descrption, creating entity identifier (usually the
recording application or equipment), the date and time of recording and a time reference for
timecode synchronization.
The `coding_history` is designed to contain a record of every conversion performed on the audio
file.
In this example (from a Sound Devices 702T) the bext metadata contains scene/take slating
information in the `description`. Here also the `originator_ref` is a serial number conforming
to EBU Rec 99.
If the bext metadata conforms to EBU 3285 v1, it will contain the WAV's 32 or 64 byte SMPTE
330M UMID. The 32-byte version of the UMID is usually just a random number, while the 64-byte
UMID will also have information on the recording date and time, recording equipment and entity,
and geolocation data.
If the bext metadata conforms to EBU 3285 v2, it will hold precomputed program loudness values
as described by EBU Rec 128.
```python
print(info.bext.description)
@@ -92,8 +108,17 @@ print(info.bext.coding_history)
## iXML Production Recorder Metadata
### iXML Production Recorder Metadata
iXML allows an XML document to be embedded in a WAV file.
The iXML website recommends a schema for recorder information but
there is no official DTD and vendors mostly do their own thing, apart from
hitting a few key xpaths. iXML is used by most location/production recorders
to save slating information, timecode and sync points in a reliable way.
iXML is also used to link "families" of WAV files together, so WAV files
recorded simultaneously or contiguously can be related by a receiving client.
```python
print("iXML Project:", info.ixml.project)
@@ -110,6 +135,22 @@ print("iXML File Family UID:", info.ixml.family_uid)
iXML Tape: 18Y12M31
iXML File Family Name: None
iXML File Family UID: USSDVGR1112089007124001008206300
### INFO Metadata
INFO Metadata is a standard method for saving tagged text data in a WAV or AVI
file. INFO fields are often read by the file explorer and host OS, and used in
music library software.
```python
bullet_path = '../tests/test_files/BULLET Impact Plastic LCD TV Screen Shatter Debris 2x.wav'
bullet = WavInfoReader(bullet_path)
```
print("INFO Artist:", bullet.info.artist)
print("INFO Copyright:", bullet.info.copyright)
print("INFO Comment:", bullet.info.comment)

104
demo.md
View File

@@ -1,104 +0,0 @@
# `wavinfo` Demonstration
The entry point for wavinfo is the WavInfoReader class.
```python
from wavinfo import WavInfoReader
path = '../tests/test_files/A101_1.WAV'
info = WavInfoReader(path)
```
## Basic WAV Data
The length of the file in frames (interleaved samples) and bytes is available, as is the contents of the format chunk.
```python
(info.data.frame_count, info.data.byte_count)
```
(240239, 1441434)
```python
(info.fmt.sample_rate, info.fmt.channel_count, info.fmt.block_align, info.fmt.bits_per_sample)
```
(48000, 2, 6, 24)
## Broadcast WAV Extension
```python
print(info.bext.description)
print("----------")
print("Originator:", info.bext.originator)
print("Originator Ref:", info.bext.originator_ref)
print("Originator Date:", info.bext.originator_date)
print("Originator Time:", info.bext.originator_time)
print("Time Reference:", info.bext.time_reference)
print(info.bext.coding_history)
```
sSPEED=023.976-ND
sTAKE=1
sUBITS=$12311801
sSWVER=2.67
sPROJECT=BMH
sSCENE=A101
sFILENAME=A101_1.WAV
sTAPE=18Y12M31
sTRK1=MKH516 A
sTRK2=Boom
sNOTE=
----------
Originator: Sound Dev: 702T S#GR1112089007
Originator Ref: USSDVGR1112089007124001008206301
Originator Date: 2018-12-31
Originator Time: 12:40:00
Time Reference: 2190940753
A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch
## iXML Production Recorder Metadata
```python
print("iXML Project:", info.ixml.project)
print("iXML Scene:", info.ixml.scene)
print("iXML Take:", info.ixml.take)
print("iXML Tape:", info.ixml.tape)
print("iXML File Family Name:", info.ixml.family_name)
print("iXML File Family UID:", info.ixml.family_uid)
```
iXML Project: BMH
iXML Scene: A101
iXML Take: 1
iXML Tape: 18Y12M31
iXML File Family Name: None
iXML File Family UID: USSDVGR1112089007124001008206300
A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch
```python
```

19
docs/Makefile Normal file
View File

@@ -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)

184
docs/conf.py Normal file
View File

@@ -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

32
docs/index.rst Normal file
View File

@@ -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`

35
docs/make.bat Normal file
View File

@@ -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

View File

@@ -11,13 +11,13 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"from wavinfo import WavInfoReader\n",
"\n",
"path = '../tests/test_files/A101_1.WAV'\n",
"path = '../tests/test_files/sounddevices/A101_1.WAV'\n",
"\n",
"info = WavInfoReader(path)"
]
@@ -33,7 +33,7 @@
},
{
"cell_type": "code",
"execution_count": 4,
"execution_count": 2,
"metadata": {},
"outputs": [
{
@@ -42,7 +42,7 @@
"(240239, 1441434)"
]
},
"execution_count": 4,
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
@@ -53,7 +53,7 @@
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": 3,
"metadata": {},
"outputs": [
{
@@ -62,7 +62,7 @@
"(48000, 2, 6, 24)"
]
},
"execution_count": 7,
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
@@ -80,7 +80,7 @@
},
{
"cell_type": "code",
"execution_count": 13,
"execution_count": 4,
"metadata": {},
"outputs": [
{
@@ -130,7 +130,7 @@
},
{
"cell_type": "code",
"execution_count": 14,
"execution_count": 5,
"metadata": {},
"outputs": [
{
@@ -142,9 +142,7 @@
"iXML Take: 1\n",
"iXML Tape: 18Y12M31\n",
"iXML File Family Name: None\n",
"iXML File Family UID: USSDVGR1112089007124001008206300\n",
"A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch\r\n",
"\n"
"iXML File Family UID: USSDVGR1112089007124001008206300\n"
]
}
],
@@ -157,6 +155,13 @@
"print(\"iXML File Family UID:\", info.ixml.family_uid)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": null,

View File

@@ -25,86 +25,17 @@
"metadata": {},
"outputs": [],
"source": [
"testfile_path = \"../tests/test_files/\"\n",
"sound_devices_file = testfile_path + \"A101_1.WAV\"\n",
"path = '../tests/test_files/protools/PT A101_4.A1.wav'\n",
"\n",
"info = wavinfo.WavInfoReader(sound_devices_file)"
"info = wavinfo.WavInfoReader(path)"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"WavInfoFormat(audio_format=1, channel_count=2, sample_rate=48000, byte_rate=288000, block_align=6, bits_per_sample=24)\n"
]
}
],
"source": [
"pp.pprint(info.fmt)"
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"WavBextFormat(description='sSPEED=023.976-ND\\r\\nsTAKE=1\\r\\nsUBITS=$12311801\\r\\nsSWVER=2.67\\r\\nsPROJECT=BMH\\r\\nsSCENE=A101\\r\\nsFILENAME=A101_1.WAV\\r\\nsTAPE=18Y12M31\\r\\nsTRK1=MKH516 A\\r\\nsTRK2=Boom\\r\\nsNOTE=\\r\\n', originator='Sound Dev: 702T S#GR1112089007', originator_ref='USSDVGR1112089007124001008206301', originator_date='2018-12-31', originator_time='12:40:00', time_reference=2190940753, version=1, umid=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', loudness_value=0.0, loudness_range=0.0, max_true_peak=0.0, max_momentary_loudness=0.0, max_shortterm_loudness=0.0, coding_history='A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch\\r\\n')\n"
]
}
],
"source": [
"pp.pprint(info.bext)"
]
},
{
"cell_type": "code",
"execution_count": 6,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"('BMH', 'A101', '1', 240239)"
]
},
"execution_count": 6,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"info.ixml.project, info.ixml.scene, info.ixml.take, info.data.frame_count"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {},
"outputs": [],
"source": [
"pro_tools_file = testfile_path + \"PT A101_4.A1.wav\""
]
},
{
"cell_type": "code",
"execution_count": 8,
"metadata": {},
"metadata": {
"scrolled": true
},
"outputs": [
{
"name": "stdout",
@@ -123,7 +54,7 @@
"source": [
"import wavinfo.wave_parser\n",
"\n",
"with open(pro_tools_file,'rb') as f:\n",
"with open(path,'rb') as f:\n",
" chunk_tree = wavinfo.wave_parser.parse_chunk(f)\n",
"\n",
"pp.pprint(chunk_tree.children)"
@@ -131,75 +62,127 @@
},
{
"cell_type": "code",
"execution_count": 9,
"execution_count": 5,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"WavBextFormat(description='dUBITS=12311804\\r\\ndSCENE=A101\\r\\ndTAKE=4\\r\\ndTAPE=18Y12M31\\r\\ndFRAMERATE=23.976ND\\r\\ndSPEED=023.976-NDF\\r\\ndTRK1=MKH516 A\\r\\ndTRK2=Boom\\r\\n', originator='Sound Dev: 702T S#GR1112089007', originator_ref='aa4CKtcd13Vk', originator_date='2018-12-31', originator_time='12:40:07', time_reference=2191709524, version=0, umid=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', loudness_value=0.0, loudness_range=0.0, max_true_peak=0.0, max_momentary_loudness=0.0, max_shortterm_loudness=0.0, coding_history='A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch\\r\\n')\n"
"b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00*\\xfd\\xf5\\x0c$\\xe4s\\x80\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00'\n",
"000000000000002afdf50c24e47380000000000000000000\n",
"24\n"
]
}
],
"source": [
"ptinfo = wavinfo.WavInfoReader(pro_tools_file)\n",
"\n",
"print(ptinfo.bext)"
"with open(path,'rb') as f:\n",
" f.seek( chunk_tree.children[4].start )\n",
" umid_bin = f.read(chunk_tree.children[4].length)\n",
" f.seek( chunk_tree.children[6].start )\n",
" regn_bin = f.read(chunk_tree.children[6].length)\n",
" \n",
"print(umid_bin)\n",
"print(umid_bin.hex())\n",
"print(len(umid_bin))"
]
},
{
"cell_type": "code",
"execution_count": 10,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"'<BWFXML><IXML_VERSION>1.61</IXML_VERSION><STEINBERG><ATTR_LIST><ATTR><TYPE>string</TYPE><NAME>MediaLibrary</NAME><VALUE>The Recordist Christmas 2018</VALUE></ATTR><ATTR><TYPE>string</TYPE><NAME>MediaCategoryPost</NAME><VALUE>Bullets</VALUE></ATTR><ATTR><TYPE>string</TYPE><NAME>MediaLibraryManufacturerName</NAME><VALUE>Creative Sound Design, LLC</VALUE></ATTR><ATTR><TYPE>string</TYPE><NAME>AudioSoundEditor</NAME><VALUE>Frank Bry</VALUE></ATTR><ATTR><TYPE>string</TYPE><NAME>MediaComment</NAME><VALUE>BULLET Impact Plastic LCD TV Screen Shatter Debris 2x</VALUE></ATTR><ATTR><TYPE>string</TYPE><NAME>MusicalCategory</NAME><VALUE>Bullets</VALUE></ATTR></ATTR_LIST></STEINBERG></BWFXML>'"
]
},
"execution_count": 10,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"library_sound = testfile_path + 'BULLET Impact Plastic LCD TV Screen Shatter Debris 2x.wav'\n",
"\n",
"recinfo = wavinfo.WavInfoReader(library_sound)\n",
"\n",
"recinfo.ixml.source"
]
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": 6,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"[ ChunkDescriptor(ident=b'fmt ', start=20, length=40),\n",
" ChunkDescriptor(ident=b'bext', start=68, length=604),\n",
" ChunkDescriptor(ident=b'data', start=680, length=2833404),\n",
" ChunkDescriptor(ident=b'ID3 ', start=2834092, length=2048),\n",
" ChunkDescriptor(ident=b'SMED', start=2836148, length=5468),\n",
" ListChunkDescriptor(signature=b'INFO', children=[ChunkDescriptor(ident=b'IPRD', start=2841636, length=30), ChunkDescriptor(ident=b'IGNR', start=2841674, length=8), ChunkDescriptor(ident=b'IART', start=2841690, length=10), ChunkDescriptor(ident=b'ICMT', start=2841708, length=54), ChunkDescriptor(ident=b'ICOP', start=2841770, length=84), ChunkDescriptor(ident=b'ISFT', start=2841862, length=12), ChunkDescriptor(ident=b'ICRD', start=2841882, length=12)]),\n",
" ChunkDescriptor(ident=b'iXML', start=2841902, length=686),\n",
" ChunkDescriptor(ident=b'umid', start=2842596, length=24),\n",
" ChunkDescriptor(ident=b'_PMX', start=2842628, length=3560)]\n"
"<wavinfo.wave_bext_reader.WavBextReader object at 0x10d5f8ac8>\n"
]
}
],
"source": [
"with open(library_sound,'rb') as f:\n",
"print(info.bext)"
]
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"b'\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00*\\xfd\\xf5\\x0c$\\xe4s\\x80\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x0c3\\x02\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00T\\xd5\\xa2\\x82\\x00\\x00\\x00\\x00\\x10PT A101_4.A1.wavGK\\xaa\\xaf\\x7f\\x00\\x00@ }\\x06\\x00`\\x00\\x00'\n",
"01000000000000000000002afdf50c24e473800000000000000000000c330200000000000000000000000000000000000000000054d5a2820000000010505420413130315f342e41312e776176474baaaf7f000040207d0600600000\n",
"92\n"
]
}
],
"source": [
"\n",
"print(regn_bin)\n",
"print(regn_bin.hex())\n",
"print(len(regn_bin))"
]
},
{
"cell_type": "code",
"execution_count": 8,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"{ 'artist': 'Frank Bry',\n",
" 'comment': 'BULLET Impact Plastic LCD TV Screen Shatter Debris 2x',\n",
" 'copyright': '2018 Creative Sound Design, LLC (The Recordist Christmas '\n",
" '2018) www.therecordist.com',\n",
" 'created_date': '2018-11-15',\n",
" 'engineer': None,\n",
" 'genre': 'Bullets',\n",
" 'keywords': None,\n",
" 'product': 'The Recordist Christmas 2018',\n",
" 'software': 'Soundminer',\n",
" 'source': None,\n",
" 'tape': None,\n",
" 'title': None}\n",
"{ 'coding_history': '',\n",
" 'description': 'BULLET Impact Plastic LCD TV Screen Shatter Debris 2x',\n",
" 'loudness_range': None,\n",
" 'loudness_value': None,\n",
" 'max_momentary_loudness': None,\n",
" 'max_shortterm_loudness': None,\n",
" 'max_true_peak': None,\n",
" 'originator': 'TheRecordist',\n",
" 'originator_date': '2018-12-20',\n",
" 'originator_ref': 'aaiAKt3fCGTk',\n",
" 'originator_time': '12:15:37',\n",
" 'time_reference': 57882,\n",
" 'version': 0}\n"
]
}
],
"source": [
"path = '../tests/test_files/BULLET Impact Plastic LCD TV Screen Shatter Debris 2x.wav'\n",
"\n",
"info = wavinfo.WavInfoReader(path)\n",
"\n",
"with open(path,'rb') as f:\n",
" chunk_tree = wavinfo.wave_parser.parse_chunk(f)\n",
"\n",
"pp.pprint(chunk_tree.children)"
" \n",
"pp.pprint(info.info.to_dict())\n",
"pp.pprint(info.bext.to_dict())"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": null,

2
pypi_upload.sh Executable file
View File

@@ -0,0 +1,2 @@
#!/bin/bash
python3 -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

View File

@@ -4,15 +4,17 @@ with open("README.md", "r") as fh:
long_description = fh.read()
setup(name='wavinfo',
version='0.1',
version='1.1',
author='Jamie Hardt',
author_email='jamiehardt@me.com',
description='WAVE sound file metadata parser.',
long_description_content_type="text/markdown",
long_description=long_description,
url='https://github.com/iluvcapra/wavinfo',
classifiers=['Development Status :: 2 - Pre-Alpha',
classifiers=['Development Status :: 5 - Production/Stable',
'License :: OSI Approved :: MIT License',
'Topic :: Multimedia',
'Topic :: Multimedia :: Sound/Audio'],
'Topic :: Multimedia :: Sound/Audio',
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6"],
packages=['wavinfo'])

View File

@@ -1 +1 @@
SOUND REPORT
SOUND REPORT
Can't render this file because it contains an unexpected character in line 1 and column 53.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@@ -1,22 +1,24 @@
import os.path
import json
import subprocess
from subprocess import PIPE
from unittest import TestCase
import wavinfo
FFPROBE='/usr/local/bin/ffprobe'
FFPROBE='ffprobe'
def ffprobe(path):
arguments = [ FFPROBE , "-of", "json" , "-show_format", "-show_streams", path ]
process = subprocess.run(arguments, stdin=None, capture_output=True)
process = subprocess.run(arguments, stdin=None, stdout=PIPE, stderr=PIPE)
if process.returncode == 0:
return json.loads(process.stdout)
output_str = process.stdout.decode('utf-8')
return json.loads(output_str)
else:
return None
@@ -28,7 +30,7 @@ class TestWaveInfo(TestCase):
for dirpath, dirnames, filenames in os.walk('tests/test_files'):
for filename in filenames:
name, ext = os.path.splitext(filename)
if ext == '.wav':
if ext in ['.wav','.WAV']:
yield os.path.join(dirpath, filename)
@@ -64,16 +66,23 @@ 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']:
self.assertEqual( info.bext.originator_ref, ffprobe_info['format']['tags']['originator_reference'] )
else:
self.assertEqual( info.bext.originator_ref, '')
self.assertEqual( info.bext.description, ffprobe_info['format']['tags']['comment'] )
self.assertEqual( info.bext.originator, ffprobe_info['format']['tags']['encoded_by'] )
self.assertEqual( info.bext.originator_ref, ffprobe_info['format']['tags']['originator_reference'] )
# these don't always reflect the bext info
# self.assertEqual( info.bext.originator_date, ffprobe_info['format']['tags']['date'] )
# self.assertEqual( info.bext.originator_time, ffprobe_info['format']['tags']['creation_time'] )
self.assertEqual( info.bext.time_reference, int(ffprobe_info['format']['tags']['time_reference']) )
# these don't always reflect the bext info
#self.assertEqual( info.bext.originator_date, ffprobe_info['format']['tags']['date'] )
#self.assertEqual( info.bext.originator_time, ffprobe_info['format']['tags']['creation_time'] )
self.assertEqual( info.bext.time_reference, int(ffprobe_info['format']['tags']['time_reference']) )
self.assertEqual( info.bext.coding_history, ffprobe_info['format']['tags']['coding_history'] )
if 'coding_history' in ffprobe_info['format']['tags']:
self.assertEqual( info.bext.coding_history, ffprobe_info['format']['tags']['coding_history'] )
else:
self.assertEqual( info.bext.coding_history, '' )
def test_ixml(self):
expected = {'A101_4.WAV': {'project' : 'BMH', 'scene': 'A101', 'take': '4',

View File

@@ -1 +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.1'
__author__ = 'Jamie Hardt'

View File

@@ -1,32 +1,47 @@
import struct
import pdb
from collections import namedtuple
ListChunkDescriptor = namedtuple('ListChunkDescriptor' , 'signature children')
class ListChunkDescriptor(namedtuple('ListChunkDescriptor' , 'signature children')):
def find(chunk_path):
if len(chunk_path) > 1:
for chunk in self.children:
if type(chunk) is ListChunkDescriptor and \
chunk.signature is chunk_path[0]:
return chunk.find(chunk_path[1:])
else:
for chunk in self.children:
if type(chunk) is ChunkDescriptor and \
chunk.ident is chunk_path[0]:
return chunk
class ChunkDescriptor(namedtuple('ChunkDescriptor', 'ident start length') ):
def read_data(self, from_stream):
from_stream.seek(self.start)
return from_stream.read(self.length)
def parse_list_chunk(stream, length):
children = []
start = stream.tell()
signature = stream.read(4)
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:
if len(ident) != 4:
return
sizeb = stream.read(4)
@@ -47,11 +62,3 @@ def parse_chunk(stream):

View File

@@ -0,0 +1,83 @@
import struct
class WavBextReader:
def __init__(self,bext_data,encoding):
# description[256]
# originator[32]
# originatorref[32]
# originatordate[10] "YYYY:MM:DD"
# originatortime[8] "HH:MM:SS"
# lowtimeref U32
# hightimeref U32
# version U16
#
# V1 field
# umid[64]
#
# V2 fields
# loudnessvalue S16 (in LUFS*100)
# loudnessrange S16 (in LUFS*100)
# maxtruepeak S16 (in dbTB*100)
# maxmomentaryloudness S16 (LUFS*100)
# maxshorttermloudness S16 (LUFS*100)
#
# reserved[180]
# codinghistory []
packstring = "<256s"+ "32s" + "32s" + "10s" + "8s" + "QH" + "64s" + "hhhhh" + "180s"
rest_starts = struct.calcsize(packstring)
unpacked = struct.unpack(packstring, bext_data[:rest_starts])
def sanatize_bytes(bytes):
first_null = next( (index for index, byte in enumerate(bytes) if byte == 0 ), None )
if first_null is not None:
trimmed = bytes[:first_null]
else:
trimmed = bytes
decoded = trimmed.decode(encoding)
return decoded
self.description = sanatize_bytes(unpacked[0])
self.originator = sanatize_bytes(unpacked[1])
self.originator_ref = sanatize_bytes(unpacked[2])
self.originator_date = sanatize_bytes(unpacked[3])
self.originator_time = sanatize_bytes(unpacked[4])
self.time_reference = unpacked[5]
self.version = unpacked[6]
self.umid = None
self.loudness_value = None
self.loudness_range = None
self.max_true_peak = None
self.max_momentary_loudness = None
self.max_shortterm_loudness = None
self.coding_history = sanatize_bytes(bext_data[rest_starts:])
if self.version > 0:
self.umid = unpacked[7]
if self.version > 1:
self.loudness_value = unpacked[8] / 100.0
self.loudness_range = unpacked[9] / 100.0
self.max_true_peak = unpacked[10] / 100.0
self.max_momentary_loudness = unpacked[11] / 100.0
self.max_shortterm_loudness = unpacked[12] / 100.0
def to_dict(self):
return {'description': self.description,
'originator': self.originator,
'originator_ref': self.originator_ref,
'originator_date': self.originator_date,
'originator_time': self.originator_time,
'time_reference': self.time_reference,
'version': self.version,
'coding_history': self.coding_history,
'loudness_value': self.loudness_value,
'loudness_range': self.loudness_range,
'max_true_peak': self.max_true_peak,
'max_momentary_loudness': self.max_momentary_loudness,
'max_shortterm_loudness': self.max_shortterm_loudness
}

View File

@@ -0,0 +1,64 @@
from .riff_parser import parse_chunk, ListChunkDescriptor
class WavInfoChunkReader:
def __init__(self, f, encoding):
self.encoding = encoding
f.seek(0)
parsed_chunks = parse_chunk(f)
list_chunks = [chunk for chunk in parsed_chunks.children \
if type(chunk) is ListChunkDescriptor]
self.info_chunk = next((chunk for chunk in list_chunks \
if chunk.signature == b'INFO'), None)
self.copyright = self._get_field(f,b'ICOP')
self.product = self._get_field(f,b'IPRD')
self.genre = self._get_field(f,b'IGNR')
self.artist = self._get_field(f,b'IART')
self.comment = self._get_field(f,b'ICMT')
self.software = self._get_field(f,b'ISFT')
self.created_date = self._get_field(f,b'ICRD')
self.engineer = self._get_field(f,b'IENG')
self.keywords = self._get_field(f,b'IKEY')
self.title = self._get_field(f,b'INAM')
self.source = self._get_field(f,b'ISRC')
self.tape = self._get_field(f,b'TAPE')
def _get_field(self, f, field_ident):
search = next( ( (chunk.start, chunk.length) for chunk in self.info_chunk.children \
if chunk.ident == field_ident ), None)
if search is not None:
f.seek(search[0])
data = f.read(search[1])
return data.decode(self.encoding).rstrip('\0')
else:
return None
def to_dict(self):
return {'copyright': self.copyright,
'product': self.product,
'genre': self.genre,
'artist': self.artist,
'comment': self.comment,
'software': self.software,
'created_date': self.created_date,
'engineer': self.engineer,
'keywords': self.keywords,
'title': self.title,
'source': self.source,
'tape': self.tape
}

View File

@@ -1,4 +1,5 @@
import xml.etree.ElementTree as ET
import io
class WavIXMLFormat:
"""
@@ -6,17 +7,18 @@ class WavIXMLFormat:
"""
def __init__(self, xml):
self.source = xml
self.parsed = ET.fromstring(xml)
xmlBytes = io.BytesIO(xml)
self.parsed = ET.parse(xmlBytes)
def _get_text_value(self, xpath):
e = self.parsed.find("./" + xpath)
if e is not None:
return e.text
@property
def project(self):
return self._get_text_value("PROJECT")
@property
def scene(self):
return self._get_text_value("SCENE")

View File

@@ -1,38 +1,57 @@
#-*- coding: utf-8 -*-
import struct
from collections import namedtuple
from .wave_parser import parse_chunk, ChunkDescriptor, ListChunkDescriptor
from .riff_parser import parse_chunk, ChunkDescriptor, ListChunkDescriptor
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')
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')
#: The format of the audio samples.
WavAudioFormat = namedtuple('WavAudioFormat','audio_format channel_count sample_rate byte_rate block_align bits_per_sample')
class WavInfoReader():
"""
format : WAV format
bext : The Broadcast-WAV extension as definied by EBU Tech 3285 v2 (2011)
Parse a WAV audio file for metadata.
"""
def __init__(self, path):
def __init__(self, path, info_encoding='latin_1', bext_encoding='ascii'):
"""
Create a new reader object.
:param path: A filesystem path to the wav file you wish to probe.
:param info_encoding: The text encoding of the INFO metadata fields.
latin_1/Win CP1252 has always been a pretty good guess for this.
: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)
self.bext = self._get_bext(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)
def _find_chunk_data(self, ident, from_stream, default_none=False):
@@ -57,7 +76,6 @@ class WavInfoReader():
frame_count= int(data_chunk.length / self.fmt.block_align))
def _get_format(self,f):
fmt_data = self._find_chunk_data(b'fmt ',f)
@@ -78,71 +96,49 @@ class WavInfoReader():
#0x0006 WAVE_FORMAT_ALAW 8-bit ITU-T G.711 A-law
#0x0007 WAVE_FORMAT_MULAW 8-bit ITU-T G.711 µ-law
#0xFFFE WAVE_FORMAT_EXTENSIBLE Determined by SubFormat
if unpacked[0] == 0x0001:
return WavInfoFormat(audio_format = unpacked[0],
channel_count = unpacked[1],
sample_rate = unpacked[2],
byte_rate = unpacked[3],
block_align = unpacked[4],
#https://sno.phy.queensu.ca/~phil/exiftool/TagNames/RIFF.html
return WavAudioFormat(audio_format = unpacked[0],
channel_count = unpacked[1],
sample_rate = unpacked[2],
byte_rate = unpacked[3],
block_align = unpacked[4],
bits_per_sample = unpacked[5]
)
def _get_bext(self,f):
def _get_info(self, f, encoding):
finder = (chunk.signature for chunk in self.main_list \
if type(chunk) is ListChunkDescriptor)
if b'INFO' in finder:
return WavInfoChunkReader(f, encoding)
def _get_bext(self, f, encoding):
bext_data = self._find_chunk_data(b'bext',f,default_none=True)
# description[256]
# originator[32]
# originatorref[32]
# originatordate[10] "YYYY:MM:DD"
# originatortime[8] "HH:MM:SS"
# lowtimeref U32
# hightimeref U32
# version U16
# umid[64]
#
# EBU 3285 fields
# loudnessvalue S16 (in LUFS*100)
# loudnessrange S16 (in LUFS*100)
# maxtruepeak S16 (in dbTB*100)
# maxmomentaryloudness S16 (LUFS*100)
# maxshorttermloudness S16 (LUFS*100)
# reserved[180]
# codinghistory []
if bext_data is None:
if bext_data:
return WavBextReader(bext_data, encoding)
else:
return None
packstring = "<256s"+ "32s" + "32s" + "10s" + "8s" + "QH" + "64s" + "hhhhh" + "180s"
rest_starts = struct.calcsize(packstring)
unpacked = struct.unpack(packstring, bext_data[:rest_starts])
return WavBextFormat(description=unpacked[0].decode('ascii').rstrip('\0'),
originator = unpacked[1].decode('ascii').rstrip('\0'),
originator_ref = unpacked[2].decode('ascii').rstrip('\0'),
originator_date = unpacked[3].decode('ascii'),
originator_time = unpacked[4].decode('ascii'),
time_reference = unpacked[5],
version = unpacked[6],
umid = unpacked[7],
loudness_value = unpacked[8] / 100.0,
loudness_range = unpacked[9] / 100.0,
max_true_peak = unpacked[10] / 100.0,
max_momentary_loudness = unpacked[11] / 100.0,
max_shortterm_loudness = unpacked[12] / 100.0,
coding_history = bext_data[rest_starts:].decode('ascii').rstrip('\0')
)
def _get_ixml(self,f):
ixml_data = self._find_chunk_data(b'iXML',f,default_none=True)
if ixml_data is None:
return None
ixml_string = ixml_data.decode('utf-8')
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)