150 Commits

Author SHA1 Message Date
Jamie Hardt
9b4f3d7ede Merge pull request #33 from iluvcapra/py3.13-support
Py3.13 support
2024-10-25 12:28:58 -07:00
Jamie Hardt
38eddccf85 Update pyproject.toml
Update lxml dependency to ~= 5.3.0
2024-10-25 12:26:02 -07:00
Jamie Hardt
d3e8349d81 Update pyproject.toml
Adding Python 3.13 to classifiers
2024-10-25 12:22:21 -07:00
Jamie Hardt
57603ff618 Update python-package.yml
Adding 3.13 to the support matrix
2024-10-25 12:21:53 -07:00
Jamie Hardt
e7d5f612ea Update wavinfo.7
Nudged date
2024-07-10 22:58:39 -07:00
Jamie Hardt
b322c8171b Update wavinfo.7
Wow really dumb misspelling
2024-07-10 22:46:05 -07:00
Jamie Hardt
7e5c888e32 Update README.md
Removed Version 3 remark for now
2024-07-07 12:16:54 -07:00
Jamie Hardt
275ac10636 Update issue templates
Added Add Metadata template
2024-07-07 11:33:18 -07:00
Jamie Hardt
38601c64db Update README.md
Made the language in the readme less megalomaniacal.
2024-07-07 11:24:53 -07:00
Jamie Hardt
067cca82b6 Update README.md
Fixed mislaid bullet point
2023-11-19 19:55:04 -08:00
Jamie Hardt
37ae8de5b0 Update README.md 2023-11-11 10:13:52 -08:00
Jamie Hardt
a20e9dd9ac Update README.md
Fixed internal link
2023-11-11 10:13:31 -08:00
Jamie Hardt
94a84b49dd Update README.md
Version 3 coming soon.
2023-11-11 10:12:39 -08:00
Jamie Hardt
4210905e17 Update README.md
Twiddles
2023-11-10 20:44:17 -08:00
Jamie Hardt
a8ede17201 Update README.md
Mission statement
2023-11-10 20:41:34 -08:00
Jamie Hardt
8579dc0693 Merge pull request #30 from iluvcapra/maint-flake8-badge
Split test and lint into separate GitHub Actions, also slimming down the matrix for flake8 and coverage to just one version.
2023-11-10 17:57:06 -08:00
Jamie Hardt
89e9959a43 Update coverage.yml
Removed everything but 3.11 from test matrix.
2023-11-10 17:54:05 -08:00
Jamie Hardt
bfd2217e23 Update README.md
Rearranged badges
2023-11-10 17:50:53 -08:00
Jamie Hardt
f32055964d Typo in readme "last commit" badge 2023-11-10 17:49:06 -08:00
Jamie Hardt
8e97c2f7b0 Added separate badge for flake8 2023-11-10 17:47:02 -08:00
Jamie Hardt
6d0fee02fc Split test and lint into separate jobs 2023-11-10 17:43:21 -08:00
Jamie Hardt
10a28f8fb3 Update references.rst
Typo
2023-11-09 13:12:23 -08:00
Jamie Hardt
514cfe0e75 backed out of breaking change 2023-11-09 11:29:22 -08:00
Jamie Hardt
ab42cba5b0 Merge pull request #26 from iluvcapra/feature-man7
wavinfo(7) Improvements
2023-11-08 21:43:34 -08:00
Jamie Hardt
73a9f93beb flake8 2023-11-08 21:40:59 -08:00
Jamie Hardt
3071bad007 de-reddening 2023-11-08 21:34:55 -08:00
Jamie Hardt
dbb282ad07 fixing docstring 2023-11-08 21:33:21 -08:00
Jamie Hardt
51ca03816a fixing docstring 2023-11-08 21:33:09 -08:00
Jamie Hardt
6107342e98 Update __init__.py
Nudged version to 3.0.0
2023-11-08 21:31:24 -08:00
Jamie Hardt
adf90612cd Update __init__.py
Nudged short version
2023-11-08 21:16:57 -08:00
Jamie Hardt
a196e4786e Update __init__.py
Nudged version
2023-11-08 21:16:36 -08:00
Jamie Hardt
e2ca087e08 Merge pull request #29 from iluvcapra/maint-reds
Added flake8 Linting
2023-11-08 21:14:56 -08:00
Jamie Hardt
c5841a5fd0 Update wave_dbmd_reader.py
Whitespace for flake8
2023-11-08 21:12:35 -08:00
Jamie Hardt
2e5cd4331f Update wave_dbmd_reader.py 2023-11-08 21:09:52 -08:00
Jamie Hardt
5e07d01688 Update wave_info_reader.py
Flake8 note
2023-11-08 21:07:15 -08:00
Jamie Hardt
a01d791262 flake8 __init__ masking 2023-11-08 21:03:33 -08:00
Jamie Hardt
ca7a177ea6 flake8 cleanup IP 2023-11-08 21:00:49 -08:00
Jamie Hardt
4206cd4473 flake8 cleanup IP 2023-11-08 20:49:47 -08:00
Jamie Hardt
5b1e4ab631 In-progress flake8 fixes 2023-11-08 20:43:56 -08:00
Jamie Hardt
f978927648 Update python-package.yml
Added flake8 run
2023-11-08 20:04:21 -08:00
Jamie Hardt
6575a0c442 Merge branch 'master' into maint-reds 2023-11-08 19:54:59 -08:00
Jamie Hardt
f5be5b36d7 Text twiddles/red reduction 2023-11-08 19:46:14 -08:00
Jamie Hardt
8a58df2b87 Red reduction 2023-11-08 19:35:12 -08:00
Jamie Hardt
3817357fac Text twiddles/red reduction 2023-11-08 19:30:28 -08:00
Jamie Hardt
4f51584fe9 Text cleanup/red policing 2023-11-08 19:21:47 -08:00
Jamie Hardt
86a4edc983 Text twiddles 2023-11-08 19:15:42 -08:00
Jamie Hardt
ce2e1fe8bc Merge pull request #25 from iluvcapra/maint-docs
More Documentation Improvements: cues
2023-11-08 18:51:05 -08:00
Jamie Hardt
6a10cd8427 Merge branch 'master' into maint-docs 2023-11-08 18:48:45 -08:00
Jamie Hardt
d75e55e870 Text twiddles 2023-11-08 18:44:23 -08:00
Jamie Hardt
4f3ea72c98 Text formatting 2023-11-08 18:43:40 -08:00
Jamie Hardt
32b0878229 Silencing errors 2023-11-08 18:31:19 -08:00
Jamie Hardt
9fee03a67b Update README.md 2023-11-08 18:23:46 -08:00
Jamie Hardt
a2ea978de0 Update README.md 2023-11-08 18:04:49 -08:00
Jamie Hardt
bfeb7ed651 Merge pull request #27 from iluvcapra/maint-docs-1
Update README.md
2023-11-08 18:04:22 -08:00
Jamie Hardt
f978c5cf8b Update README.md 2023-11-08 18:03:38 -08:00
Jamie Hardt
41b84b8399 Change a param in WavInfoReader's __init__
It makes more sense this way but it breaks everything
prior to this version.
2023-11-08 17:58:00 -08:00
Jamie Hardt
77275a7351 Formatting tweaks 2023-11-08 17:49:02 -08:00
Jamie Hardt
c25ac56555 Merge pull request #24 from iluvcapra/feature-man7
Manpage wavinfo(7) enhancement
2023-11-08 17:17:34 -08:00
Jamie Hardt
99118367e9 More wavinfo elaboration 2023-11-08 17:07:38 -08:00
Jamie Hardt
c002120c61 gq gq gq 2023-11-08 15:42:59 -08:00
Jamie Hardt
d7540b0a79 Update wavinfo.7 2023-11-08 15:37:08 -08:00
Jamie Hardt
d04af2d194 Update wavinfo.7 2023-11-08 15:23:40 -08:00
Jamie Hardt
bbbe947f3b Update wavinfo.7
Introduction and description
2023-11-08 14:25:43 -08:00
Jamie Hardt
71a6d752ca Update README.md
Added link to wave format
2023-11-08 13:32:26 -08:00
Jamie Hardt
42c0f9ce0d Update README.md
Link to cues docs
2023-11-08 13:31:22 -08:00
Jamie Hardt
75ec68f500 More 2023-11-08 12:47:44 -08:00
Jamie Hardt
f3f9f6b784 More updates to man 2023-11-08 12:23:43 -08:00
Jamie Hardt
7bc5378304 BEginning to add references. 2023-11-08 11:59:21 -08:00
Jamie Hardt
45c6e90db6 Tweaked span formatting in WavCuesReader docs 2023-11-08 11:08:58 -08:00
Jamie Hardt
8da8e0f4f4 Cue documentation improvements 2023-11-08 11:08:07 -08:00
Jamie Hardt
9e41d39b26 More info 2023-11-08 09:36:58 -08:00
Jamie Hardt
cd5aacfe10 Update README.md
Added "Last Commit" badge and rearranged badges
2023-11-08 08:22:22 -08:00
Jamie Hardt
6654a194ba Merge pull request #23 from iluvcapra/maint-rm-umid
Removed UMID parsing for now, to improve test coverage
2023-11-08 08:04:01 -08:00
Jamie Hardt
af5b538115 Merge pull request #19 from iluvcapra/feature-cues
Cues Feature
2023-11-08 08:03:36 -08:00
Jamie Hardt
069666e9f9 Update test_main.py
Added --ixml flag
2023-11-07 18:11:44 -08:00
Jamie Hardt
13fdb147b5 Merge branch 'feature-cues' into maint-rm-umid 2023-11-07 18:07:35 -08:00
Jamie Hardt
8df6c52a9e more test impl 2023-11-07 18:00:09 -08:00
Jamie Hardt
408771c2e5 Added more main tests 2023-11-07 17:33:10 -08:00
Jamie Hardt
b0a4454f0d Added unit test for __main__ 2023-11-07 17:26:09 -08:00
Jamie Hardt
0952337a47 Removed UMID parsing for now 2023-11-07 15:47:27 -08:00
Jamie Hardt
0de314d0ac Merge remote-tracking branch 'origin' into feature-cues 2023-11-07 15:38:27 -08:00
Jamie Hardt
8d7597c0df Merge pull request #22 from iluvcapra/feature-manpage
Add a manpage for wavinfo command line tool
2023-11-07 14:35:44 -08:00
Jamie Hardt
e9bebcd022 More manpage stuff 2023-11-07 14:27:00 -08:00
Jamie Hardt
0138387d27 Made cues to_dict nicer 2023-11-07 11:44:28 -08:00
Jamie Hardt
d1b42bd836 Fixed a bug in the cues to_dict method 2023-11-07 11:37:36 -08:00
Jamie Hardt
3323aef36c Typos 2023-11-07 11:25:38 -08:00
Jamie Hardt
7cbdd3dab6 Added a manpage 2023-11-07 11:23:40 -08:00
Jamie Hardt
c392f48819 Documentation, removed dead lines 2023-11-07 10:33:32 -08:00
Jamie Hardt
2cfb88a59c Merge pull request #21 from iluvcapra/maint-copyright-dates
Update copyright dates to 2023
2023-11-07 10:31:08 -08:00
Jamie Hardt
267befc0b0 Documentation typo 2023-11-07 09:28:30 -08:00
Jamie Hardt
26a9104dd9 Documentation stuff 2023-11-07 09:27:08 -08:00
Jamie Hardt
f1089a7e08 Update conf.py 2023-11-07 08:44:43 -08:00
Jamie Hardt
ab7bd66f13 Update LICENSE
Updated year
2023-11-07 08:42:45 -08:00
Jamie Hardt
f1ce4888af Get timed ranges 2023-11-07 08:36:53 -08:00
Jamie Hardt
7ca3721ab8 Fixed a typo in a link 2023-11-07 08:34:26 -08:00
Jamie Hardt
5aa34dfbe4 Improved test coverage and touching up docs. 2023-11-07 08:20:23 -08:00
Jamie Hardt
208edd8bdc Added some examples 2023-11-07 00:32:19 -08:00
Jamie Hardt
96f79b5dc7 Examples 2023-11-07 00:10:48 -08:00
Jamie Hardt
6f6a90a262 Made a note about a test 2023-11-06 23:13:59 -08:00
Jamie Hardt
8aad9ae9b9 Cues reader implementation 2023-11-06 23:09:06 -08:00
Jamie Hardt
1a6349bdd8 Changed name of cue class methoChanged name of cue class method 2023-11-06 22:40:29 -08:00
Jamie Hardt
9f0b1f1106 elaboration of cue feature 2023-11-06 18:05:35 -08:00
Jamie Hardt
ec01f699fc Merge branch 'master' of https://github.com/iluvcapra/wavinfo into feature-cues 2023-11-06 17:56:03 -08:00
Jamie Hardt
2cc95b6f24 Merge pull request #20 from iluvcapra/support-py312
Python 3.12 Support
2023-11-06 17:55:07 -08:00
Jamie Hardt
e35a5aa736 Update pyproject.toml
Added "Programming Language :: Python :: 3.12" classifier
2023-11-06 17:51:06 -08:00
Jamie Hardt
8ad03e34bb Update coverage.yml
Add 3.12 to test coverage matrix
2023-11-06 17:50:27 -08:00
Jamie Hardt
f5ee41c8d5 Update python-package.yml
Adding 3.12 to workflow to see what happens
2023-11-06 17:46:58 -08:00
Jamie Hardt
f00a338cee removed in-progress feature 2023-11-06 17:44:59 -08:00
Jamie Hardt
d0e45a2d90 reorderd items in support list 2023-11-06 17:44:18 -08:00
Jamie Hardt
ee1a0b9ac0 typo 2023-11-06 17:43:12 -08:00
Jamie Hardt
4401745c96 typo 2023-11-06 17:42:22 -08:00
Jamie Hardt
2c760a9c68 Updating README 2023-11-06 17:37:07 -08:00
Jamie Hardt
df15428260 Merge branch 'master' of https://github.com/iluvcapra/wavinfo into feature-cues 2023-11-06 17:34:30 -08:00
Jamie Hardt
43666de976 Added formatting 2023-11-06 17:34:10 -08:00
Jamie Hardt
2ca21cd316 Documentation 2023-11-06 17:31:56 -08:00
Jamie Hardt
f963daa8a7 Adding tests for cues 2023-11-06 17:24:39 -08:00
Jamie Hardt
b87f4e135f Stubbing out documentation 2023-11-06 16:40:52 -08:00
Jamie Hardt
a42e9d1bbf Fixed a typo in rtd configuration 2023-11-06 16:27:56 -08:00
Jamie Hardt
77517db653 All existing tests pass 2023-11-06 16:24:01 -08:00
Jamie Hardt
16d2609558 Twiddles 2023-11-06 15:56:58 -08:00
Jamie Hardt
18eda82ebd Wave cue implementation, lots of cleanups 2023-11-06 15:56:15 -08:00
Jamie Hardt
c8add89bc2 Added more links to documentation 2023-11-06 14:33:15 -08:00
Jamie Hardt
553b9d4790 Added some documenation of encodings 2023-11-05 20:28:05 -08:00
Jamie Hardt
0792388871 Some line cleanup, starting cue impl 2023-11-05 19:55:38 -08:00
Jamie Hardt
4384d8f575 Silencing some more warnings, and autopep 2023-11-05 19:47:20 -08:00
Jamie Hardt
e41eadad95 Fixing some warnings 2023-11-05 19:40:17 -08:00
Jamie Hardt
0933c7f580 Added cue_chunk test audio 2023-11-05 19:24:45 -08:00
Jamie Hardt
538449bd9c Nudge version to 2.3.0 2023-06-10 01:11:37 -07:00
Jamie Hardt
a38c79d985 Added rf64 tests 2023-06-10 01:07:28 -07:00
Jamie Hardt
c0ab22115a Silending pylance errors 2023-06-10 00:58:05 -07:00
Jamie Hardt
75228830cb Fixed it, silly typo 2023-06-10 00:50:39 -07:00
Jamie Hardt
0c418cecdd Removed magic number from DPP supplemental metadata
Makes all the tests work but it's weird it's not being
found
2023-06-10 00:48:49 -07:00
Jamie Hardt
156568488e Degenerate steinberg case 2023-06-10 00:15:59 -07:00
Jamie Hardt
5f2c16bd35 Steinberg tests and implementation ip 2023-06-10 00:09:08 -07:00
Jamie Hardt
f63d8d8ef8 Implemented more steinberg metadata 2023-06-10 00:00:52 -07:00
Jamie Hardt
83500944eb Fixed bug in steinberg metadata 2023-06-09 23:45:11 -07:00
Jamie Hardt
cc29bfd801 Merge pull request #17 from iluvcapra/iluvcapra-patch-2
Update wave_ixml_reader.py
2023-06-09 23:28:28 -07:00
Jamie Hardt
c2ebaa8141 Update wave_ixml_reader.py 2023-06-09 23:27:53 -07:00
Jamie Hardt
48c4b1565d Oops typo 2023-06-09 23:25:35 -07:00
Jamie Hardt
f95a1ac652 Merge branch 'master' of https://github.com/iluvcapra/wavinfo 2023-06-09 23:21:37 -07:00
Jamie Hardt
c1e52ddba1 Format 2023-06-09 23:20:57 -07:00
Jamie Hardt
ef5078cc0d Added basic steinberg test 2023-06-09 23:20:10 -07:00
Jamie Hardt
64b69f9341 Update README.md
Adding codecov badge
2023-06-04 21:28:37 -07:00
Jamie Hardt
1e7a4f6218 Merge pull request #16 from iluvcapra/iluvcapra-patch-1
Create coverage.yml
2023-06-04 21:26:19 -07:00
Jamie Hardt
e47a7dbb89 Update coverage.yml
Install ffmpeg for tests
2023-06-04 21:16:38 -07:00
Jamie Hardt
3e3dd6d5bf Create coverage.yml 2023-06-04 21:14:23 -07:00
Jamie Hardt
453606d5b7 Update __init__.py
Nudged version
2023-05-30 16:04:25 -07:00
Jamie Hardt
2ae3a69d56 Delete requirements.txt
No longer needed.
2023-05-30 15:56:53 -07:00
Jamie Hardt
14b9cbb496 Update README.md
STEINBERG metadata in readme
2023-02-26 11:48:03 -08:00
Jamie Hardt
83742cc15e Update pythonpublish.yml 2023-02-26 11:42:36 -08:00
44 changed files with 2000 additions and 852 deletions

3
.flake8 Normal file
View File

@@ -0,0 +1,3 @@
[flake8]
per-file-ignores =
wavinfo/__init__.py: F401

View File

@@ -0,0 +1,26 @@
---
name: Add Support For New Metadata Type
about: For adding support for a new type of metadata
title: "[METADATA]"
labels: ''
assignees: ''
---
**Describe the type of metadata you want to read:**
???
**List some applications that read and write this metadata:**
???
**List the authorities or organizations that use and standardize this metadata:**
???
**URL for example WAVE file with this metadata:**
???
**(Optional) Four-character code identifier for this metadata (if known):**
???
**(Optional) URLs for documentation of this metadata:**
???

39
.github/workflows/coverage.yml vendored Normal file
View File

@@ -0,0 +1,39 @@
name: Test Coverage
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.11"]
steps:
- uses: actions/checkout@v2.5.0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4.3.0
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8 pytest
python -m pip install -e .
- name: Setup FFmpeg
uses: FedericoCarboni/setup-ffmpeg@v2
- name: Generate coverage report
run: |
pip install pytest
pip install pytest-cov
pytest --cov=./ --cov-report=xml
- name: Codecov
# You may pin to the exact commit or the version.
# uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d
uses: codecov/codecov-action@v3.1.4

40
.github/workflows/python-flake8.yml vendored Normal file
View File

@@ -0,0 +1,40 @@
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Flake8
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.11"]
steps:
- uses: actions/checkout@v2.5.0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4.3.0
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8
python -m pip install -e .
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Lint with flake8
run: |
flake8 wavinfo

View File

@@ -1,7 +1,7 @@
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Python Lint and Test
name: Tests
on:
push:
@@ -16,7 +16,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11"]
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
steps:
- uses: actions/checkout@v2.5.0
@@ -27,16 +27,10 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8 pytest
python -m pip install pytest
python -m pip install -e .
- name: Setup FFmpeg
uses: FedericoCarboni/setup-ffmpeg@v2
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pytest

View File

@@ -16,13 +16,13 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine lxml
pip install setuptools build wheel twine lxml
- name: Build and publish
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_APIKEY }}
run: |
python setup.py sdist bdist_wheel
python -m build .
twine upload dist/*
- name: Report to Mastodon
uses: cbrgm/mastodon-github-action@v1.0.1

View File

@@ -29,4 +29,4 @@ python:
- method: pip
path: .
extra_requirements:
- docs
- doc

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2022 Jamie Hardt
Copyright (c) 2018-2023 Jamie Hardt
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,29 +1,42 @@
[![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)
[![Lint and Test](https://github.com/iluvcapra/wavinfo/actions/workflows/python-package.yml/badge.svg)](https://github.com/iluvcapra/wavinfo/actions/workflows/python-package.yml)
![](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)
![GitHub last commit](https://img.shields.io/github/last-commit/iluvcapra/wavinfo) [![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)
[![Tests](https://github.com/iluvcapra/wavinfo/actions/workflows/python-package.yml/badge.svg)](https://github.com/iluvcapra/wavinfo/actions/workflows/python-package.yml)
[![Flake8](https://github.com/iluvcapra/wavinfo/actions/workflows/python-flake8.yml/badge.svg)](https://github.com/iluvcapra/wavinfo/actions/workflows/python-flake8.yml)
[![codecov](https://codecov.io/gh/iluvcapra/wavinfo/branch/master/graph/badge.svg?token=9DZQfZENYv)](https://codecov.io/gh/iluvcapra/wavinfo)
# wavinfo
The `wavinfo` package allows you to probe WAVE and [RF64/WAVE files][eburf64] and extract extended metadata, with an emphasis on film, video and professional music production metadata.
The `wavinfo` package allows you to probe WAVE and [RF64/WAVE files][eburf64]
and extract extended metadata. `wavinfo` has an emphasis on film, video and
professional music production but can read many other kinds.
If you are trying to read a particular kind of metadata from a WAV file and
it is not supported, please submit an issue!
## Metadata Support
`wavinfo` reads:
* [Broadcast-WAVE][bext] metadata, including embedded program
* All defined [Broadcast-WAVE][bext] fields, including embedded program
loudness, coding history and [SMPTE UMID][smpte_330m2011].
* [ADM][adm] track metadata and schema, including channel, pack formats, object, content and programme.
* [Dolby Digital Plus][ebu3285s6] and Dolby Atmos `dbmd` metadata.
* [iXML][ixml] production recorder metadata, including project, scene, and take tags, recorder notes
and file family information.
* Most of the common [RIFF INFO][info-tags] metadata fields.
* The __wav format__ is also parsed, so you can access the basic sample rate and channel count
information.
* [iXML][ixml] production recorder metadata, including project, scene, and
take tags, recorder notes and file family information.
* iXML `STEINBERG` sound library attributes.
* All known [RIFF INFO][info-tags] metadata fields.
* [Audio Definition Model (ADM)][adm] track metadata and schema, including
channel, pack formats,
object, content and programme, including [Dolby Digital Plus][ebu3285s6]
and Dolby Atmos `dbmd` metadata for re-renders and mixdowns.
* Wave embedded [cue markers][cues], cue marker labels, notes and timed ranges as used
by Zoom, iZotope RX, etc.
* The [wav format][format] is also parsed, so you can access the basic sample rate
and channel count information.
In progress:
* Pro Tools __embedded regions__.
* iXML `STEINBERG` sound library attributes.
[format]:https://wavinfo.readthedocs.io/en/latest/classes.html#wavinfo.wave_reader.WavAudioFormat
[cues]:https://wavinfo.readthedocs.io/en/latest/scopes/cue.html
[bext]:https://wavinfo.readthedocs.io/en/latest/scopes/bext.html
[smpte_330m2011]:https://wavinfo.readthedocs.io/en/latest/scopes/bext.html#wavinfo.wave_bext_reader.WavBextReader.umid
[adm]:https://wavinfo.readthedocs.io/en/latest/scopes/adm.html
@@ -54,6 +67,13 @@ The package also installs a shell command:
$ wavinfo test_files/A101_1.WAV
```
## Contributions!
Any new or different kind of metadata you find, or any
new or different use of exising metadata you encounter, please submit
an Issue or Pull Request!
## Other Resources
* For other file formats and ID3 decoding, look at [audio-metadata](https://github.com/thebigmunch/audio-metadata).
* For other file formats and ID3 decoding,
look at [audio-metadata](https://github.com/thebigmunch/audio-metadata).

View File

@@ -0,0 +1,74 @@
.TH wavinfo 1 "2023-11-07" "Jamie Hardt" "User Manuals"
.SH NAME
wavinfo \- probe wave files for metadata
.SH SYNOPSIS
.SY wavinfo
.I "[\-\-adm]"
.I "[\-\-ixml]"
.I FILE ...
.SH DESCRIPTION
.B wavinfo
extracts embedded metadata from WAVE and RF64/WAVE sound files, with an
emphasis on film, video and professional music production metadata.
.SH OPTIONS
.IP "(no options)"
With no options,
.B wavinfo
will emit a JSON (Javascript Object Notation) object containing all
detected metadata.
.IP "\-\-adm"
Output any Audio Definition Model (ADM) metadata in
.BR FILE .
.IP "\-\-ixml"
Output any iXML metdata in
.BR FILE .
.IP "\-h, \-\-help"
Print brief help.
.SH DETAILED DESCRIPTION
.B wavinfo
collects metadata according to different
.IR scopes .
.SS METADATA SCOPES
.IP fmt
Basic audio properties: sample format, sample rate, channel count, etc.
.IP data
Size and frame count of the WAVE file's
.I data
segment.
.IP cues
Timed cue points, labels, notes and time ranges.
.IP bext
Broadcast-WAV metadata: description, originator, date and time, UMID.
.IP ixml
A selection of parsed iXML fields: track list, project, scene, take, tape,
family name, family uid. For the full iXML document use the
.IR \-\-ixml
command option.
.IP adm
EBU Audio Definition Model (ADM) metadata: Programme, channels. For the full
ADM
.I <axml>
document use the
.IR \-\-adm
command option.
.IP dolby
Dolby bitstream and Atmos metadata.
.IP info
INFO metadata fields: IART (artist), ICMT (comment), etc.
.SH EXIT STATUS
.IP 0
On user quit.
.SH AUTHOR
Jamie Hardt
.UR https://github.com/iluvcapra
.UE
.SH BUGS
Issue submissions, feature requests, pull requests and other contributions
are welcome and should be directed at
.BR wavinfo 's
home page on GitHub:
.RS 4
.UR https://github.com/iluvcapra/wavinfo
.UE
.\" .SH SEE ALSO
.\" .BR "ffmpeg" "(1),"

View File

@@ -0,0 +1,380 @@
.TH waveinfo 7 "2024-07-10" "Jamie Hardt" "Miscellaneous Information Manuals"
.SH NAME
wavinfo \- WAVE file metadata
.SH SYNOPSIS
Everything you ever wanted to know about WAVE metadata but were afraid to ask.
.SH DESCRIPTION
.PP
The WAVE file format is forwards-compatible. Apart from audio data, it can
hold arbitrary blocks of bytes which clients will automatically ignore
unless they recognize them and know how to read them.
.PP
Without saying too much about the structure and parsing of WAVE files
themselves \- a subject beyond the scope of this document \- WAVE files are
divided into segments or
.BR chunks ,
which a client parser can either read or skip without reading. Chunks have
an identifier, or signature: a four-character-code that tells a client what
kind of chunk it is, and a length. Based on this information, a client can look
at the identifier and decide if it knows how to read a chunk and if it wants
to. If it doesn't, it can simply read the length and skip past it.
.PP
Some chunks are mandated by the Microsoft standard, specifically
.I fmt
and
.I data
in the case of PCM-encoded WAVE files. Other chunks, like
.I cue
or
.IR bext ,
are optional, and optional chunks usually hold metadata.
.PP
Chunks can also nest inside other chunks, a special identifier
.I LIST
is used to indicate these. A WAVE file is a recursive list: a top level
list of chunks, where chunks may contain a list of chunks themselves.
.SS Order and Arrangement of Metadata Chunks in a WAVE File
.PP
Chunks in a WAVE file can appear in any order, and a capable parser can accept
them appearing in any order. However, authorities give guidance on where chunks
should be placed when creating a new WAVE file.
.PP
.IP 1)
For all new WAVE files, clients should always place an empty chunk, a
so-called
.I JUNK
chunk, in the first position in the top-level list of a WAVE file, and
it should be sized large enough to hold a
.I ds64
chunk record. This will allow clients to upgrade the file to a RF64
WAVE file
.BR in-place ,
without having to re-write the file or audio data.
.IP 2)
Older authorites recommend placing metadata before the audio data, so clients
reading the file sequentially will hit it before having to seek through the
audio. This may improve metadata read performance on certain architectures.
.IP 3)
Older authorities also recommend inserting
.I JUNK
before the
.I data
chunk, sized so that the first byte of the
.I data
payload lands immediately at 0x1000 (4096), because this was a common factor of
the page boundaries of many operating systems and architectures. This may
optimize the audio I/O performance in certain situations.
.IP 4)
Modern implementations (we're looking at
.B Pro Tools
here) tend to place the Broadcast-WAVE
.I bext
metadata before the data, followed by the data itself, and then other data
after that.
.\" .PP
.\" Clients reading WAVE files should be tolerant and accept any configuration of
.\" chunks, and should accept any file as long as the obligatory
.\" .I fmt
.\" and
.\" .I data
.\" chunks
.\" are present.
.PP
It's not unheard-of to see a naive implementor expect
.B only
.I fmt
and
.I data
chunks, in this order, and to hard-code the offsets of the short
.I fmt
chunk and
.I data
chunk into their program, and this is something that should always be checked
when evaluating a new tool, just to make sure the developer didn't do this.
Many coding examples and WAVE file explainers from the 90s and early aughts
give the basic layout of a WAVE file, and naive devs go along with it.
.SS Encoding and Decoding Text Metadata
.\" .PP
.\" Modern metadata systems, anything developed since the late aughts, will defer
.\" encoding to an XML parser, so when dealing with
.\" .I ixml
.\" or
.\" .I axml
.\" so a client can mostly ignore this problem.
.\" .PP
.\" The most established metadata systems are older than this though, and so the
.\" entire weight of text encoding history falls upon the client.
.\" .PP
.\" The original WAVE specification, a part of the Microsoft/IBM Multimedia
.\" interface of 1991, was written at a time when Windows was an ascendant and
.\" soon-to-be dominant desktop environment. Audio files were almost
.\" never shared via LANs or the Internet or any other way. When audio files were
.\" shared, among the miniscule number of people who did this, it was via BBS or
.\" Usenet. Users at this time may have ripped them from CDs, but the cost of hard
.\" drives and low quality of compressed formats at the time made this little more
.\" than a curiosity. There was no CDBaby or CDDB to download and populate metadata
.\" from at this time.
.\" .PP
.\" So, the
.\" .I INFO
.\" and
.\" .I cue
.\" metadata systems, which are by far the most prevalent and supported, were
.\" published two years before the so-called "Endless September" of 1993 when the
.\" Internet became mainstream, when Unicode was still a twinkle in the eye, and
.\" two years before Ariana Grande was born.
.PP
The safest assumption, and the mandate of the Microsoft, is that all text
metadata, by default, be encoded in Windows codepage 819, a.k.a. ISO Latin
alphabet 1, or ISO 8859-1. This covers most Western European scripts but
excludes all of Asia, Russia, most of the European Near East, the Middle
East.
.PP
To account for this, Microsoft proposed a few conventions, none of which have
been adopted with any consistency among clients of the WAVE file standard.
.IP 1)
The RIFF standard defines a
.I cset
chunk which declares a Windows codepage for character encoding, along with a
native country code, language and dialect, which clients should use for
determining text information. We have never seen a WAVE
file with a
.I cest
chunk.
.IP 2)
Certain RIFF chunks allow the writing client to override the default encoding.
Relevant to audio files are the
.I ltxt
chunk, which encodes a country, language, dialect and codepage along with a
time range text note. We have never seen the text field on one of these
filled-out either.
.PP
Some clients, in our experience, simply write UTF-8 into
.IR cue ,
.IR labl ,
and
.I note
fields without any kind of framing.
.PP
A practical solution is to assume either ISO Latin 1, Windows CP 859 or Windows
CP 1252, and allow the client or user to override this based on its own
inferences. The
.I chardet
python package may provide useable guesses for text encoding, YMMV.
.SH CHUNK MENAGERIE
A list of chunks that you may find in a wave file from our experience.
.SS Essential WAV Chunks
.IP fmt
Defines the format of the audio in the
.I data
chunk: the audio codec, the sample rate, bit depth, channel count, block
alignment and other data. May take an "extended" form, with additional data
(such as channel speaker assignments) if there are more than two channels in
the file or if it is a compressed format.
.IP data
The audio data itself. PCM audio data is always stored as interleaved samples.
.SS Optional WAVE Chunks
.IP JUNK
A region of the file not currently in use. Clients sometimes add these before
the
.I data
chunk in order to align the beginning of the audio data with a memory page
boundary (this can make memory-mapped reads from a wave file a little more
efficient). A
.I JUNK
chunk is often placed at the beginning of a WAVE file to reserve space for
a
.I ds64
chunk that will be written to the file at the end of recording, in the event
that after the file is finalized, it exceeds the RIFF size limit. Thus a WAVE
file can be upgraded in-place to an RF64 without re-writing the audio data.
.IP fact
Fact chunks record the number of samples in the decoded audio stream. It's only
present in WAVE files that contain compressed audio.
.IP "LIST or list"
(Both have been seen) Not a chunk type itself but signals to a RIFF parser that
this chunk contains chunks itself. A LIST chunk's payload will begin with a
four-character code identifying the form of the list, and is then followed
by chunks of the standard key-length-data form, which may themselves be
LISTs that themselves contain child chunks. WAVE files don't tend to have a
very deep heirarchy of chunks, compared to AVI files.
.SS RIFF Metadata
The RIFF container format has a metadata system common to all RIFF files, WAVE
being the most common at present, AVI being another very common format
historically.
.IP "LIST form INFO"
A flat list of chunks, each containing text metadata. The role
of the string, like "Artist", "Composer", "Comment", "Engineer" etc. are given
by the four-character code: "Artist" is
.IR IART ,
Composer is
.IR ICMP ,
engineer is
.IR IENG ,
Comment is
.IR ICMT ,
etc.
.IP cue
A binary list of cues, which are timed points within the audio data.
.IP "LIST form adtl"
Contains text labels
.RI ( labl )
for the cues in the
.I cue
chunk, "notes"
.RI ( note ,
which are structurally identical to
.I labl
but hosts tend to use notes for longer text), and "length text"
.I ltxt
metadata records, which can give a cue a length, making it a range, and a text
field that defines its own encoding.
.IP cset
Defines the character set for all text fields in
.IR INFO ,
.I adtl
and other RIFF-defined text fields. By default, all of the text in RIFF
metadata fields is Windows Latin 1/ISO 8859-1, though as time passes many
clients have simply taken to sticking UTF-8 into these fields. The
.I cset
cannot represent UTF-8 as a valid option for text encoding, it only speaks
Windows codepages, and we've never seen one in a WAVE file in any event, and
it's unlikely an audio app would recognize one if it saw it.
.SS Broadcast-WAVE Metadata
Broadcast-WAVE is a set of extensions to WAVE files to facilitate media
production maintained by the EBU.
.IP bext
A multi-field structure containing mostly fixed-width text data capturing
essential production information: a 256 character free description field,
originator name and a unique reference, recording date and time, a frame-based
timestamp for sample-accurate recording time, and a coding history record. The
extended form of the structure can hold a SMPTE UMID (a kind of UUID, which
may also contain timestamp and geolocation data) and pre-computed program
loudness measurements.
.IP peak
A binary data structure containing the peak envelope for the audio data, for
use by clients to generate a waveform overview.
.SS Audio Definition Model Metadata
Audio Definition Model (ADM) metadata is a metadata standard for audio
broadcast and distribution maintained by the ITU.
.IP chna
A binary list that associates individual channels in the file to entities
in the ADM XML document stored in the
.I axml
chunk. A
.I chna
chunk will always appear with an
.I axml
chunk and vice versa.
.IP axml
Contains an XML document with Audio Definition Model metadata. ADM metadata
describes the program the WAVE file belongs to, role, channel assignment,
and encoding properties of individual channels in the WAVE file, and if the
WAVE file contains object-based audio, it will also give all of the positioning
and panning automation envelopes.
.IP bxml
This is defined by the ITU as a gzip-compressed version of the
.I axml
chunk.
.IP sxml
This is a hybrid binary/gzip-compressed-XML chunk that associates ADM
documents with timed ranges of a WAVE file.
.SS Dolby Metadata
Dolby metadata is present in Dolby Atmos master ADM WAVE files.
.IP dbmd
Records hints for Dolby playback applications for downmixing, level
normalization and other things.
.SS Proprietary Chunks
.IP ovwf
.B (Pro Tools)
Pre-computed waveform overview data.
.IP regn
.B (Pro Tools)
Region and cue point metadata.
.SS Chunks of Unknown Purpose
.IP elm1
.IP minf
.IP umid
.SH REFERENCES
(Note: We're not including URLs in this list, the title and standard number
should be sufficient to find almost all of these documents. The ITU, EBU and
IETF standards documents are freely-available.)
.SS Essential File Format
.TP
.B Multimedia Programming Interface and Data Specifications 1.0. Microsoft Corporation, 1991.
The original definition of the
.I RIFF
container, the
.I WAVE
form, the original metadata facilites (like
.IR INFO " and " cue ),
and things like language, country and
dialect enumerations. This document also contains descriptions of certain
variations on the WAVE, such as
.I LIST wavl
and compressed WAVE files that are so rare in practice as to be virtually
non-existent.
.TP
.B ITU Recommendation BS.2088-1-2019 \- Long-form file format for the international exchange of audio programme mterials with metadata. ITU 2019.
Formalized the RF64 file format, ADM carrier chunks like
.IR axml
and
.IR chna .
Formally supercedes the previous standard for RF64,
.BR "EBU 3306 v1" .
One oddity with this standard is it defines the file header for an extended
WAVE file to be
.IR BW64 ,
but this is never seen in practice.
.TP
.B RFC 2361 \- WAVE and AVI Codec Registries. IETF Network Working Group, 1998.
Gives an exhaustive list of all of the codecs that Microsoft had assigned to
vendor WAVE files as of 1998. At the time, numerous hardware vendors, sound
card and chip manufacturers, sound software developers and others all provided
their own slightly-different adaptive PCM codecs, linear predictive compression
codes, DCTs and other things, and Microsoft would issue these vendors WAVE
codec magic numbers. Almost all of these are no longer in use, the only ones
one ever encounters in the modern era are integer PCM (0x01), floating-point
PCM (0x03) and the extended format marker (0xFFFFFFFF). There are over a
hundred codecs assigned, however, a roll-call of failed software and hardware
brands.
.SS Broadcast WAVE Format
.TP
.B EBU Tech 3285 \- Specification of the Broadcast Wave Format (BWF). EBU, 2011.
Defines the elements of a Broadcast WAVE file, the
.I bext
metadata chunk structure, allowed sample formats and other things. Over the
years the EBU has published numerous supplements covering extensions to the
format, such as embedding SMPTE UMIDs, pre-calculated loudness data (EBU Tech
3285 v2),
.I peak
waveform overview data (Suppl. 3), ADM metadata (Suppl. 5 and 7), Dolby master
metadata (Suppl. 6), and other things.
.TP
.B SMPTE 330M-2011 \- Unique Material Identifier. SMPTE, 2011.
Describes the format of the SMPTE UMID field, a 32- or 64-byte UUID used to
identify media files. UMIDs are usually a dumb number in their 32-byte form,
but the extended form can encode a high-precision timestamp (with options for
epoch and timescale) and geolocation information. Broadcast-WAVE files
conforming to
.B "EBU 3285 v2"
have a SMPTE UMID embedded in the
.I bext
chunk.
.SS Audio Definition Model
.TP
.B ITU Recommendation BS.2076-2-2019 \- Audio definition model. ITU, 2019.
Defines the Audio Definition Model, entities, relationships and properties. If
you ever had any questions about how ADM works, this is where you would start.
.SS iXML Metadata
.TP
.B iXML Specification v3.01. Gallery Software, 2021.
iXML is a standard for embedding mostly human-created metadata into WAVE files,
and mostly with an emphasis on location sound recorders used on film and
television productions. Frustratingly the developer has never published a DTD
or schema validation or strict formal standard, and encourages vendors to just
do whatever, but most of the heavily-traveled metadata fields are standardized,
for recording information like a recording's scene, take, recording notes,
circled or alt status. iXML also has a system of
.B "families"
for associating several WAVE files together into one recording.

View File

@@ -1,25 +0,0 @@
alabaster==0.7.12
Babel==2.11.0
certifi==2022.9.24
charset-normalizer==2.1.1
docutils==0.17.1
idna==3.4
imagesize==1.4.1
Jinja2==3.1.2
lxml==4.9.1
MarkupSafe==2.1.1
packaging==21.3
Pygments==2.13.0
pyparsing==3.0.9
pytz==2022.6
requests==2.28.1
snowballstemmer==2.2.0
Sphinx==5.3.0
sphinx-rtd-theme==1.1.1
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
urllib3==1.26.12

View File

@@ -23,7 +23,7 @@ import wavinfo
# -- Project information -----------------------------------------------------
project = u'wavinfo'
copyright = u'2022, Jamie Hardt'
copyright = u'2018-2023, Jamie Hardt'
author = u'Jamie Hardt'
# The short X.Y version

View File

@@ -17,11 +17,14 @@ instance of :class:`WaveInfoReader`.
adm_metadata = info.adm
ixml_metadata = info.ixml
WavInfoReader Class Documentation
--------------------------------------
.. module:: wavinfo
:noindex:
.. autoclass:: wavinfo.wave_reader.WavInfoReader
:members:
:special-members: __init__

View File

@@ -1,6 +1,9 @@
References
==========
A complete list of technical references and commentary is available as a man page
and is installed as wavinfo(7) when you install `wavinfo` via pip.
Wave File Format
----------------
@@ -33,7 +36,8 @@ iXML
* `Gallery Software iXML Specification <http://www.gallery.co.uk/ixml/>`_
RIFF INFO
---------
RIFF Metadata
-------------
* `1991. Multimedia Programming Interface and Data Specifications 1.0 <https://www.aelius.com/njh/wavemetatools/doc/riffmci.pdf>`_
* `Exiftool Documentation <https://exiftool.org/TagNames/RIFF.html#Info_docs>`_

View File

@@ -4,32 +4,45 @@ Broadcast WAV Extension Metadata
Notes
-----
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.
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 :py:attr:`coding_history<wavinfo.wave_bext_reader.WavBextReader.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 :py:attr:`description<wavinfo.wave_bext_reader.WavBextReader.description>`.
Here also the :py:attr:`originator_ref<wavinfo.wave_bext_reader.WavBextReader.originator_ref>`
In this example (from a Sound Devices 702T) the bext metadata contains
scene/take slating information in the
:py:attr:`description<wavinfo.wave_bext_reader.WavBextReader.description>`.
Here also the
:py:attr:`originator_ref<wavinfo.wave_bext_reader.WavBextReader.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
ST 330 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 v1`_, it will contain the WAV's 32
or 64 byte `SMPTE ST 330 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`_.
If the bext metadata conforms to `EBU 3285 v2`_, it will hold precomputed
program loudness values as described by `EBU Rec 128`_.
.. _EBU 3285 v1: https://tech.ebu.ch/publications/tech3285s1
.. _SMPTE ST 330 UMID: https://standards.globalspec.com/std/1396751/smpte-st-330
.. _EBU 3285 v2: https://tech.ebu.ch/publications/tech3285s2
.. _EBU Rec 128: https://tech.ebu.ch/publications/r128
.. note::
All text fields in the Broadcast-WAV metadata structure are decoded by
default as flat ASCII. To override this and use a different encoding, pass
an string encoding name to the ``bext_encoding`` parameter of
:py:meth:`WavInfoReader()<wavinfo.wave_reader.WavInfoReader.__init__>`
Example
-------
.. code:: python
print(info.bext.description)

View File

@@ -0,0 +1,40 @@
Cue Marker and Range Metadata
------------------------------
Notes
=====
Cue metadata stores timed markers that clients use to mark times of interest
in a wave file, and optionally give them a name and longer comment. Markers
can also have an associated length, allowing ranges of times in a file to be
marked.
String Encoding of Cue Metadata
"""""""""""""""""""""""""""""""
Cue labels and notes will be decoded using the string encoding passed to
:py:meth:`WavInfoReader's<wavinfo.wave_reader.WaveInfoReader.__init__>`
``info_encoding=`` parameter, which by default is ``latin_1`` (ISO 8859-1).
Text associated with ``ltxt`` time ranges may specify their own encoding in
the form of a Windows codepage number. `wavinfo` will attempt to use the
encoding specified.
.. note::
``cset`` character set/locale metadata is not supported. If it is present
in the file it will be ignored by `wavinfo`.
Class Reference
===============
.. autoclass:: wavinfo.wave_cues_reader.WavCuesReader
:members:
.. autoclass:: wavinfo.wave_cues_reader.CueEntry
:members:
.. autoclass:: wavinfo.wave_cues_reader.LabelEntry
:members:
.. autoclass:: wavinfo.wave_cues_reader.NoteEntry
:members:

View File

@@ -20,16 +20,16 @@ music library software.
print("INFO Comment:", bullet.info.comment)
On Encodings
""""""""""""
According to Microsoft, the original developers of the RIFF file and RIFF INFO
metadata, these fields are always to be interpreted as ISO Latin 1 characters,
and this is the default encoding used by `wavinfo` for these fields. You can
select a different encoding (like Shift-JIS) by passing an encoding name (as
would be used by `string.encode()`) to `WavInfoReader.__init__()`'s
`info_encoding=` parameter.
String Encoding of INFO Metadata
""""""""""""""""""""""""""""""""
Info metadata fields will be decoded using the string encoding passed to
:py:meth:`WavInfoReader's<wavinfo.wave_reader.WaveInfoReader.__init__>`
``info_encoding=`` parameter, which by default is ``latin_1`` (ISO 8859-1).
.. note::
``cset`` character set/locale metadata is not supported. If it is present
in the file it will be ignored by `wavinfo`.
Class Reference
---------------

View File

@@ -6,7 +6,16 @@
"source": [
"# `wavinfo` Demonstration\n",
"\n",
"The entry point for wavinfo is the WavInfoReader class."
"The `wavinfo` module allows you to read most of the metadata formats that are available for WAV files."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Opening a WAV file for reading metadata\n",
"\n",
"The entry point for wavinfo is the `WavInfoReader` class:"
]
},
{
@@ -26,7 +35,35 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Basic WAV Data\n",
"Once you have a `WavInfoReader`, you can access different metadata systems or \"scopes.\"\n",
"\n",
"The scopes that are presently supported are: \n",
" * `fmt`: sample format, sample rate, bit depth, block alignment, etc.\n",
" * `data`: data chunk description, bytes length and frames length.\n",
" * `ixml`: Gallery Software's iXML metadata, used by production sound recorder equipment and DAWs.\n",
" * `bext`: Broacast-WAV metadata as used by DAWs.\n",
" * `info`: title, artist and description metadata tags, among other items.\n",
" * `adm`: EBU Audio Defintion Model metadata, as used by Dolby Atmos.\n",
" * `cues`: Cue marker metadata, including labels and notes \n",
" * `dolby`: Dolby recorder and playback metadata\n",
"\n",
"Each of these is an attribute of a `WavInfoReader` object.\n",
"\n",
"Each scope corresponds to a vendor-defined metadata system. Many scopes directly represent a specific file *chunk*, like `fmt` or `ixml`, and some may involve data read from many chunks. Examples of this would include `cues` or `adm`.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Metadata Scopes"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### `data` and `fmt`: Basic WAV Data\n",
"\n",
"The length of the file in frames (interleaved samples) and bytes is available, as is the contents of the format chunk."
]
@@ -51,6 +88,13 @@
"(info.data.frame_count, info.data.byte_count)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The `fmt` scope allows the client to read metadata from the WAVE format description."
]
},
{
"cell_type": "code",
"execution_count": 3,
@@ -75,7 +119,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Broadcast WAV Extension"
"### `bext`: Broadcast WAV Extension\n",
"\n",
"The `bext` scope allows the client to access Broadcast-WAV metadata. "
]
},
{
@@ -87,17 +133,17 @@
"name": "stdout",
"output_type": "stream",
"text": [
"sSPEED=023.976-ND\r\n",
"sTAKE=1\r\n",
"sUBITS=$12311801\r\n",
"sSWVER=2.67\r\n",
"sPROJECT=BMH\r\n",
"sSCENE=A101\r\n",
"sFILENAME=A101_1.WAV\r\n",
"sTAPE=18Y12M31\r\n",
"sTRK1=MKH516 A\r\n",
"sTRK2=Boom\r\n",
"sNOTE=\r\n",
"sSPEED=023.976-ND\n",
"sTAKE=1\n",
"sUBITS=$12311801\n",
"sSWVER=2.67\n",
"sPROJECT=BMH\n",
"sSCENE=A101\n",
"sFILENAME=A101_1.WAV\n",
"sTAPE=18Y12M31\n",
"sTRK1=MKH516 A\n",
"sTRK2=Boom\n",
"sNOTE=\n",
"\n",
"----------\n",
"Originator: Sound Dev: 702T S#GR1112089007\n",
@@ -105,7 +151,7 @@
"Originator Date: 2018-12-31\n",
"Originator Time: 12:40:00\n",
"Time Reference: 2190940753\n",
"A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch\r\n",
"A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch\n",
"\n"
]
}
@@ -125,7 +171,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## iXML Production Recorder Metadata"
"### `ixml`: iXML Production Recorder Metadata"
]
},
{
@@ -156,11 +202,83 @@
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": []
"source": [
"### `cues`: Cues Metadata\n",
"\n",
"Cue time markers are accessible through the `cues` scope. The `each_cue` method returns an iterator that yields a tuple of each cue \"name\" or integer UID, and sample location. "
]
},
{
"cell_type": "code",
"execution_count": 6,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Cue ID: 1\n",
"Cue Offset: 29616\n",
"Cue ID: 2\n",
"Cue Offset: 74592\n",
"Cue ID: 3\n",
"Cue Offset: 121200\n"
]
}
],
"source": [
"path = \"../tests/test_files/cue_chunks/STE-000.wav\"\n",
"info = WavInfoReader(path)\n",
"\n",
"for cue in info.cues.each_cue():\n",
" print(f\"Cue ID: {cue[0]}\")\n",
" print(f\"Cue Offset: {cue[1]}\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"There is also a convenience method to get the appropriate label and note for a given marker. (Note here also `WavInfoReader`'s facility for overriding default text encodings.)"
]
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Cue ID: 1\n",
" Label: Marker 1\n",
" At: 1000\n",
" Note: <NO NOTE>\n",
"Cue ID: 2\n",
" Label: Marker 2\n",
" At: 5000\n",
" Note: Marker Comment 1\n",
"Cue ID: 3\n",
" Label: Marker 3\n",
" At: 10000\n",
" Note: Лорем ипсум долор сит амет, тимеам вивендум хас ет, цу адолесценс дефинитионес еам.\n"
]
}
],
"source": [
"path = \"../tests/test_files/cue_chunks/izotoperx_cues_test.wav\"\n",
"info = WavInfoReader(path, info_encoding=\"utf-8\") # iZotope RX seems to encode marker text as UTF-8\n",
"\n",
"for cue in info.cues.each_cue():\n",
" print(f\"Cue ID: {cue[0]}\")\n",
" label, note = info.cues.label_and_note(cue[0])\n",
" print(f\" Label: {label}\")\n",
" print(f\" At: {cue[1]}\")\n",
" print(f\" Note: {note or '<NO NOTE>'}\")"
]
},
{
"cell_type": "code",
@@ -172,7 +290,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
@@ -186,9 +304,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.2"
"version": "3.11.5"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}

View File

@@ -1,215 +0,0 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"import wavinfo\n",
"import pprint"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [],
"source": [
"pp = pprint.PrettyPrinter(indent=4)"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"outputs": [],
"source": [
"path = '../tests/test_files/protools/PT A101_4.A1.wav'\n",
"\n",
"info = wavinfo.WavInfoReader(path)"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {
"scrolled": true
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"[ ChunkDescriptor(ident=b'bext', start=20, length=858),\n",
" ChunkDescriptor(ident=b'iXML', start=886, length=5226),\n",
" ChunkDescriptor(ident=b'fmt ', start=6120, length=16),\n",
" ChunkDescriptor(ident=b'data', start=6144, length=864840),\n",
" ChunkDescriptor(ident=b'umid', start=870992, length=24),\n",
" ChunkDescriptor(ident=b'minf', start=871024, length=16),\n",
" ChunkDescriptor(ident=b'regn', start=871048, length=92)]\n"
]
}
],
"source": [
"import wavinfo.wave_parser\n",
"\n",
"with open(path,'rb') as f:\n",
" chunk_tree = wavinfo.wave_parser.parse_chunk(f)\n",
"\n",
"pp.pprint(chunk_tree.children)"
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"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": [
"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": 6,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"<wavinfo.wave_bext_reader.WavBextReader object at 0x10d5f8ac8>\n"
]
}
],
"source": [
"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(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,
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.2"
}
},
"nbformat": 4,
"nbformat_minor": 2
}

View File

@@ -16,10 +16,12 @@ classifiers = [
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11"
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13"
]
dependencies = [
"lxml ~= 4.9.2"
"lxml ~= 5.3.0"
]
keywords = [
'waveform',
@@ -54,6 +56,9 @@ wavinfo = 'wavinfo.__main__:main'
[project.scripts]
wavinfo = "wavinfo.__main__:main"
[tool.flit.external-data]
directory = "data"
[tool.pyright]
typeCheckingMode = "basic"

View File

@@ -15,17 +15,20 @@ class TestADMWave(TestCase):
adm = info.adm
self.assertIsNotNone(adm)
assert adm is not None
self.assertEqual(len(adm.channel_uids), 14)
def test_to_dict(self):
info = wavinfo.WavInfoReader(self.protools_adm_wav)
adm = info.adm
assert adm is not None
dict = adm.to_dict()
self.assertIsNotNone(dict)
def test_programme(self):
info = wavinfo.WavInfoReader(self.protools_adm_wav)
adm = info.adm
assert adm is not None
pdict = adm.programme()
self.assertIn("programme_id", pdict.keys())
self.assertIn("programme_name", pdict.keys())
@@ -37,7 +40,7 @@ class TestADMWave(TestCase):
def test_track_info(self):
info = wavinfo.WavInfoReader(self.protools_adm_wav)
adm = info.adm
assert adm is not None
t1 = adm.track_info(0)
self.assertTrue("channel_format_name" in t1.keys())
self.assertEqual("RoomCentricLeft", t1["channel_format_name"])

75
tests/test_cue.py Normal file
View File

@@ -0,0 +1,75 @@
from unittest import TestCase
from glob import glob
import wavinfo
class TestCue(TestCase):
def setUp(self) -> None:
self.test_files = glob("tests/test_files/cue_chunks/*.wav")
return super().setUp()
def test_enumerate(self):
file1 = "tests/test_files/cue_chunks/STE-000.wav"
w1 = wavinfo.WavInfoReader(file1)
self.assertIsNotNone(w1.cues)
assert w1.cues is not None
vals = list(w1.cues.each_cue())
self.assertEqual(vals, [(1,29616),(2,74592),(3,121200)])
def test_labels_notes(self):
file = "tests/test_files/cue_chunks/izotoperx_cues_test.wav"
w1 = wavinfo.WavInfoReader(file)
self.assertIsNotNone(w1.cues)
assert w1.cues is not None
for name, _ in w1.cues.each_cue():
self.assertIn(name,[1,2,3])
label, note = w1.cues.label_and_note(name)
if name == 1:
self.assertEqual("Marker 1", label)
self.assertIsNone(note)
def test_range(self):
file = "tests/test_files/cue_chunks/izotoperx_cues_test.wav"
w1 = wavinfo.WavInfoReader(file)
self.assertIsNotNone(w1.cues)
assert w1.cues is not None
self.assertEqual(w1.cues.range(3), 10000)
def test_encoding_fallback(self):
"""
Added this after I noticed that iZotope RX seems to just encode "notes"
as utf-8 without bothering to dump this info into the ltxt or
specifying an encoding by some other means.
"""
file = "tests/test_files/cue_chunks/izotoperx_cues_test.wav"
w = wavinfo.WavInfoReader(file, info_encoding='utf-8')
expected = ("Лорем ипсум долор сит амет, тимеам вивендум хас ет, "
"цу адолесценс дефинитионес еам.")
assert w.cues is not None
note = [n for n in w.cues.notes if n.name == 3]
self.assertEqual(len(note), 1)
self.assertEqual(note[0].text, expected)
def test_label(self):
file = "tests/test_files/cue_chunks/izotoperx_cues_test.wav"
w = wavinfo.WavInfoReader(file)
self.assertIsNotNone(w.cues)
assert w.cues is not None
self.assertEqual(len(w.cues.labels), 3)
for label in w.cues.labels:
self.assertIn(label.name, [1,2,3])
if label.name == 1:
self.assertEqual(label.text, "Marker 1")
elif label.name == 2:
self.assertEqual(label.text, "Marker 2")
elif label.name == 3:
self.assertEqual(label.text, "Marker 3")

View File

@@ -1,7 +1,7 @@
from unittest import TestCase
import wavinfo
from wavinfo.wave_dbmd_reader import SegmentType, DolbyAtmosMetadata, DolbyDigitalPlusMetadata
from wavinfo.wave_dbmd_reader import SegmentType, DolbyDigitalPlusMetadata
class TestDolby(TestCase):
def setUp(self):
@@ -10,15 +10,19 @@ class TestDolby(TestCase):
def test_version(self):
t1 = wavinfo.WavInfoReader(self.test_file)
d = t1.dolby
assert d is not None
self.assertEqual((1,0,0,6), d.version)
def test_segments(self):
t1 = wavinfo.WavInfoReader(self.test_file)
d = t1.dolby
assert d is not None
ddp = [x for x in d.segment_list if x[0] == SegmentType.DolbyDigitalPlus]
atmos = [x for x in d.segment_list if x[0] == SegmentType.DolbyAtmos]
ddp = [x for x in d.segment_list \
if x[0] == SegmentType.DolbyDigitalPlus]
atmos = [x for x in d.segment_list \
if x[0] == SegmentType.DolbyAtmos]
self.assertEqual(len(ddp), 1)
self.assertEqual(len(atmos), 1)
@@ -26,6 +30,7 @@ class TestDolby(TestCase):
def test_checksums(self):
t1 = wavinfo.WavInfoReader(self.test_file)
d = t1.dolby
assert d is not None
for seg in d.segment_list:
self.assertTrue(seg[1])
@@ -33,17 +38,23 @@ class TestDolby(TestCase):
def test_ddp(self):
t1 = wavinfo.WavInfoReader(self.test_file)
d = t1.dolby
assert d is not None
ddp = d.dolby_digital_plus()
self.assertEqual(len(ddp), 1, "Failed to find exactly one Dolby Digital Plus metadata segment")
self.assertTrue( ddp[0].audio_coding_mode, DolbyDigitalPlusMetadata.AudioCodingMode.CH_ORD_3_2 )
self.assertEqual(len(ddp), 1,
("Failed to find exactly one Dolby Digital Plus "
"metadata segment")
)
self.assertTrue( ddp[0].audio_coding_mode,
DolbyDigitalPlusMetadata.AudioCodingMode.CH_ORD_3_2 )
self.assertTrue( ddp[0].lfe_on)
def test_atmos(self):
t1 = wavinfo.WavInfoReader(self.test_file)
d = t1.dolby
assert d is not None
atmos = d.dolby_atmos()
self.assertEqual(len(atmos), 1, "Failed to find exactly one Atmos metadata segment")
self.assertEqual(len(atmos), 1,
"Failed to find exactly one Atmos metadata segment")

Binary file not shown.

Binary file not shown.

34
tests/test_main.py Normal file
View File

@@ -0,0 +1,34 @@
import unittest
from unittest.mock import patch
from wavinfo.__main__ import main
import sys
import glob
class MainTest(unittest.TestCase):
def test_empty_argv(self):
with patch.object(sys, 'argv', []):
try:
main()
except:
self.fail("main() throwing an exception")
def test_a_file(self):
for path in glob.glob("tests/test_files/**/*.wav"):
with patch.object(sys, 'argv', ["TEST", path]):
try:
main()
except:
self.fail("main() throwing an exception")
def test_ixml(self):
with patch.object(sys, 'argv',
['TEST', '--ixml',
'tests/test_files/sounddevices/A101_1.WAV']):
try:
main()
except:
self.fail("main() throwing an exception")

25
tests/test_rf64.py Normal file
View File

@@ -0,0 +1,25 @@
# import os.path
import gzip
from glob import glob
# from typing import Dict, Any, cast
from unittest import TestCase
# from .utils import all_files, ffprobe
import wavinfo
class TestRf64(TestCase):
def setUp(self) -> None:
return super().setUp()
def test_open(self):
for path in glob("tests/test_files/rf64/*.wav.gz"):
gz = gzip.open(path)
wav_info = wavinfo.WavInfoReader(gz)
self.assertIsNotNone(wav_info)
# self.assertIsNotNone(wav_info.bext)

View File

@@ -1,6 +1,7 @@
import unittest
import wavinfo
import glob
class TestWalk(unittest.TestCase):
def test_walk_metadata(self):
@@ -20,6 +21,17 @@ class TestWalk(unittest.TestCase):
self.assertTrue(tested_data and tested_format)
def test_walk_all(self):
for file in glob.glob('tests/test_files/**/*.wav'):
info = wavinfo.WavInfoReader(file)
try:
for _, _, _ in info.walk():
pass
except:
self.fail(f"Failed to walk metadata in file {file}")
if __name__ == '__main__':
unittest.main()

View File

@@ -1,4 +1,6 @@
import os.path
from glob import glob
from typing import Dict, Any, cast
from unittest import TestCase
@@ -11,7 +13,9 @@ class TestWaveInfo(TestCase):
def test_sanity(self):
for wav_file in all_files():
info = wavinfo.WavInfoReader(wav_file)
self.assertEqual(info.__repr__(), 'WavInfoReader({}, latin_1, ascii)'.format(os.path.abspath(wav_file)))
self.assertEqual(info.__repr__(),
'WavInfoReader({}, latin_1, ascii)'
.format(os.path.abspath(wav_file)))
self.assertIsNotNone(info)
def test_fmt_against_ffprobe(self):
@@ -19,61 +23,100 @@ class TestWaveInfo(TestCase):
info = wavinfo.WavInfoReader(wav_file)
ffprobe_info = ffprobe(wav_file)
self.assertEqual(info.fmt.channel_count, ffprobe_info['streams'][0]['channels'])
self.assertEqual(info.fmt.sample_rate, int(ffprobe_info['streams'][0]['sample_rate']))
self.assertEqual(info.fmt.bits_per_sample, int(ffprobe_info['streams'][0]['bits_per_sample']))
assert info.fmt is not None
assert ffprobe_info is not None
self.assertEqual(info.fmt.channel_count,
ffprobe_info['streams'][0]['channels'])
self.assertEqual(info.fmt.sample_rate,
int(ffprobe_info['streams'][0]['sample_rate']))
self.assertEqual(info.fmt.bits_per_sample,
int(ffprobe_info['streams'][0]['bits_per_sample']
))
if info.fmt.audio_format == 1:
self.assertTrue(ffprobe_info['streams'][0]['codec_name'].startswith('pcm'))
self.assertTrue(ffprobe_info['streams'][0]['codec_name']\
.startswith('pcm'))
streams = ffprobe_info['streams'][0]
byte_rate = int(streams['sample_rate']) * streams['channels'] * int(streams['bits_per_sample']) / 8
byte_rate = int(streams['sample_rate']) * \
streams['channels'] * \
int(streams['bits_per_sample']) / 8
self.assertEqual(info.fmt.byte_rate, byte_rate)
def test_data_against_ffprobe(self):
for wav_file in all_files():
info = wavinfo.WavInfoReader(wav_file)
ffprobe_info = ffprobe(wav_file)
self.assertEqual(info.data.frame_count, int(ffprobe_info['streams'][0]['duration_ts']))
ffprobe_info = cast(Dict[str,Any], ffprobe(wav_file))
assert ffprobe_info is not None
assert info.data is not None
self.assertEqual(info.data.frame_count,
int(ffprobe_info['streams'][0]['duration_ts']))
def test_bext_against_ffprobe(self):
for wav_file in all_files():
info = wavinfo.WavInfoReader(wav_file)
ffprobe_info = ffprobe(wav_file)
assert ffprobe_info is not None
if info.bext:
if 'comment' in ffprobe_info['format']['tags']:
self.assertEqual(info.bext.description, ffprobe_info['format']['tags']['comment'])
self.assertEqual(info.bext.description,
ffprobe_info['format']['tags']\
['comment'])
else:
self.assertEqual(info.bext.description, '')
if 'encoded_by' in ffprobe_info['format']['tags']:
self.assertEqual(info.bext.originator, ffprobe_info['format']['tags']['encoded_by'])
self.assertEqual(info.bext.originator,
ffprobe_info['format']['tags']\
['encoded_by'])
else:
self.assertEqual(info.bext.originator, '')
if 'originator_reference' in ffprobe_info['format']['tags']:
self.assertEqual(info.bext.originator_ref, ffprobe_info['format']['tags']['originator_reference'])
self.assertEqual(info.bext.originator_ref,
ffprobe_info['format']['tags']\
['originator_reference'])
else:
self.assertEqual(info.bext.originator_ref, '')
# 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.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']))
if 'coding_history' in ffprobe_info['format']['tags']:
self.assertEqual(info.bext.coding_history, ffprobe_info['format']['tags']['coding_history'])
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',
'tape': '18Y12M31', 'family_uid': 'USSDVGR1112089007124015008231000'},
'A101_3.WAV': {'project': 'BMH', 'scene': 'A101', 'take': '3',
'tape': '18Y12M31', 'family_uid': 'USSDVGR1112089007124014008228300'},
'A101_2.WAV': {'project': 'BMH', 'scene': 'A101', 'take': '2',
'tape': '18Y12M31', 'family_uid': 'USSDVGR1112089007124004008218600'},
'A101_1.WAV': {'project': 'BMH', 'scene': 'A101', 'take': '1',
'tape': '18Y12M31', 'family_uid': 'USSDVGR1112089007124001008206300'},
expected = {'A101_4.WAV': {'project': 'BMH',
'scene': 'A101', 'take': '4',
'tape': '18Y12M31',
'family_uid':
'USSDVGR1112089007124015008231000'},
'A101_3.WAV': {'project': 'BMH',
'scene': 'A101', 'take': '3',
'tape': '18Y12M31',
'family_uid':
'USSDVGR1112089007124014008228300'},
'A101_2.WAV': {'project': 'BMH',
'scene': 'A101', 'take': '2',
'tape': '18Y12M31',
'family_uid':
'USSDVGR1112089007124004008218600'},
'A101_1.WAV': {'project': 'BMH',
'scene': 'A101', 'take': '1',
'tape': '18Y12M31',
'family_uid':
'USSDVGR1112089007124001008206300'},
}
for wav_file in all_files():
@@ -81,7 +124,8 @@ class TestWaveInfo(TestCase):
if basename in expected:
info = wavinfo.WavInfoReader(wav_file)
e = expected[basename]
self.assertIsNotNone(info.ixml)
assert info.ixml is not None
self.assertEqual(e['project'], info.ixml.project)
self.assertEqual(e['scene'], info.ixml.scene)
self.assertEqual(e['take'], info.ixml.take)
@@ -93,10 +137,34 @@ class TestWaveInfo(TestCase):
if basename == 'A101_4.WAV' and track.channel_index == '1':
self.assertEqual(track.name, 'MKH516 A')
def test_metadata(self):
file_with_metadata = 'tests/test_files/sound_grinder_pro/new_camera bumb 1.wav'
def test_steinberg_ixml(self):
nuendo_files = 'tests/test_files/nuendo/*.wav'
for file in glob(nuendo_files):
info = wavinfo.WavInfoReader(file)
assert info.ixml is not None
self.assertIsNotNone(info.ixml.steinberg)
assert info.ixml.steinberg is not None
self.assertIsNotNone(info.ixml.steinberg.audio_speaker_arrangement)
self.assertEqual(info.ixml.steinberg.sample_format_size, 3)
self.assertEqual(info.ixml.steinberg.media_company,
"https://github.com/iluvcapra/wavinfo")
self.assertFalse(info.ixml.steinberg.media_drop_frames)
self.assertEqual(info.ixml.steinberg.media_duration, 1200.0)
def test_steinberg_missing(self):
file_with_no_nuendo = "tests/test_files/sounddevices/A101_1.WAV"
info = wavinfo.WavInfoReader(file_with_no_nuendo)
assert info.ixml is not None
self.assertIsNone(info.ixml.steinberg)
def test_info_metadata(self):
file_with_metadata = \
'tests/test_files/sound_grinder_pro/new_camera bumb 1.wav'
self.assertTrue(os.path.exists(file_with_metadata))
info = wavinfo.WavInfoReader(file_with_metadata).info
assert info is not None
self.assertEqual(info.title, 'camera bumb 1')
self.assertEqual(info.artist, 'Jamie Hardt')
self.assertEqual(info.copyright, '© 2010 Jamie Hardt')
@@ -106,7 +174,8 @@ class TestWaveInfo(TestCase):
self.assertEqual(info.software, 'Sound Grinder Pro')
self.assertEqual(info.created_date, '2010-12-28')
self.assertEqual(info.engineer, 'JPH')
self.assertEqual(info.keywords, 'Sound Effect, movement, microphone, bump')
self.assertEqual(info.keywords,
'Sound Effect, movement, microphone, bump')
self.assertEqual(info.title, 'camera bumb 1')
self.assertEqual(type(info.to_dict()), dict)
self.assertEqual(type(info.__repr__()), str)

View File

@@ -8,7 +8,8 @@ FFPROBE = 'ffprobe'
def ffprobe(path):
arguments = [FFPROBE, "-of", "json", "-show_format", "-show_streams", path]
arguments = [FFPROBE, "-of", "json",
"-show_format", "-show_streams", path]
if int(sys.version[0]) < 3:
process = subprocess.Popen(arguments, stdout=PIPE)
process.wait()
@@ -20,7 +21,8 @@ def ffprobe(path):
else:
return None
else:
process = subprocess.run(arguments, stdin=None, stdout=PIPE, stderr=PIPE)
process = subprocess.run(arguments, stdin=None,
stdout=PIPE, stderr=PIPE)
if process.returncode == 0:
output_str = process.stdout.decode('utf-8')
return json.loads(output_str)

View File

@@ -5,5 +5,5 @@ Probe WAVE Files for iXML, Broadcast-WAVE and other metadata.
from .wave_reader import WavInfoReader
from .riff_parser import WavInfoEOFError
__version__ = '2.2.0'
__short_version__ = '2.2.0'
__version__ = '3.0.0'
__short_version__ = '3.0.0'

View File

@@ -1,11 +1,13 @@
from optparse import OptionParser, OptionGroup
import datetime
from . import WavInfoReader
from . import __version__
from optparse import OptionParser
import sys
import json
from enum import Enum
class MyJSONEncoder(json.JSONEncoder):
def default(self, o):
if isinstance(o, Enum):
@@ -13,23 +15,25 @@ class MyJSONEncoder(json.JSONEncoder):
else:
return super().default(o)
class MissingDataError(RuntimeError):
pass
def main():
parser = OptionParser()
parser.usage = 'wavinfo (--adm | --ixml) <FILE> +'
# parser.add_option('-f', dest='output_format', help='Set the output format',
# default='json',
# metavar='FORMAT')
parser.add_option('--adm', dest='adm',
help='Output ADM XML',
default=False,
action='store_true')
parser.add_option('--adm', dest='adm', help='Output ADM XML',
default=False, action='store_true')
parser.add_option('--ixml', dest='ixml', help='Output iXML',
default=False, action='store_true')
parser.add_option('--ixml', dest='ixml',
help='Output iXML',
default=False,
action='store_true')
(options, args) = parser.parse_args(sys.argv)
for arg in args[1:]:
@@ -47,9 +51,9 @@ def main():
raise MissingDataError("ixml")
else:
ret_dict = {
'filename': arg,
'run_date': datetime.datetime.now().isoformat() ,
'application': "wavinfo " + __version__,
'filename': arg,
'run_date': datetime.datetime.now().isoformat(),
'application': "wavinfo " + __version__,
'scopes': {}
}
for scope, name, value in this_file.walk():
@@ -60,7 +64,8 @@ def main():
json.dump(ret_dict, cls=MyJSONEncoder, fp=sys.stdout, indent=2)
except MissingDataError as e:
print("MissingDataError: Missing metadata (%s) in file %s" % (e, arg), file=sys.stderr)
print("MissingDataError: Missing metadata (%s) in file %s" %
(e, arg), file=sys.stderr)
continue
except Exception as e:
raise e

View File

@@ -1,40 +1,47 @@
import struct
from collections import namedtuple
# from collections import namedtuple
from typing import NamedTuple, Dict
from . import riff_parser
RF64Context = namedtuple('RF64Context','sample_count bigchunk_table')
class RF64Context(NamedTuple):
sample_count: int
bigchunk_table: Dict[str, int]
def parse_rf64(stream, signature = b'RF64'):
# print("starting parse_rf64")
def parse_rf64(stream, signature=b'RF64') -> RF64Context:
start = stream.tell()
assert( stream.read(4) == b'WAVE' )
assert stream.read(4) == b'WAVE'
ds64_chunk = riff_parser.parse_chunk(stream)
assert type(ds64_chunk) is riff_parser.ChunkDescriptor, \
f"Expected ds64 chunk here, found {type(ds64_chunk)}"
ds64_field_spec = "<QQQI"
ds64_fields_size = struct.calcsize(ds64_field_spec)
assert(ds64_chunk.ident == b'ds64')
assert ds64_chunk.ident == b'ds64'
ds64_data = ds64_chunk.read_data(stream)
assert(len(ds64_data) >= ds64_fields_size )
assert len(ds64_data) >= ds64_fields_size
# print("Read ds64 chunk: len()",len(ds64_data))
riff_size, data_size, sample_count, length_lookup_table = struct.unpack( ds64_field_spec , ds64_data[0:ds64_fields_size] )
riff_size, data_size, sample_count, length_lookup_table = struct.unpack(
ds64_field_spec, ds64_data[0:ds64_fields_size]
)
bigchunk_table = {}
chunksize64format = "<4sL"
chunksize64size = struct.calcsize(chunksize64format)
# print("Found chunks64s:", length_lookup_table)
# chunksize64size = struct.calcsize(chunksize64format)
for n in range(length_lookup_table):
bigname, bigsize = struct.unpack_from( chunksize64format , ds64_data, offset= ds64_fields_size )
for _ in range(length_lookup_table):
bigname, bigsize = struct.unpack_from(chunksize64format,
ds64_data,
offset=ds64_fields_size)
bigchunk_table[bigname] = bigsize
bigchunk_table[b'data'] = data_size
bigchunk_table[signature] = riff_size
stream.seek(start, 0)
# print("returning from parse_rf64, context: ", RF64Context(sample_count=sample_count, bigchunk_table=bigchunk_table))
return RF64Context( sample_count=sample_count, bigchunk_table=bigchunk_table )
return RF64Context(sample_count=sample_count,
bigchunk_table=bigchunk_table)

View File

@@ -1,7 +1,7 @@
# from optparse import Option
import struct
from collections import namedtuple
from .rf64_parser import parse_rf64
from .rf64_parser import parse_rf64, RF64Context
from typing import NamedTuple, Union, List, Optional
class WavInfoEOFError(EOFError):
@@ -10,23 +10,18 @@ class WavInfoEOFError(EOFError):
self.chunk_start = chunk_start
class ListChunkDescriptor(namedtuple('ListChunkDescriptor', 'signature children')):
pass
# def find(self, 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 ListChunkDescriptor(NamedTuple):
signature: bytes
children: List[Union['ChunkDescriptor', 'ListChunkDescriptor']]
class ChunkDescriptor(namedtuple('ChunkDescriptor', 'ident start length rf64_context')):
def read_data(self, from_stream):
class ChunkDescriptor(NamedTuple):
ident: bytes
start: int
length: int
rf64_context: Optional[RF64Context]
def read_data(self, from_stream) -> bytes:
from_stream.seek(self.start)
return from_stream.read(self.length)
@@ -59,15 +54,23 @@ def parse_chunk(stream, rf64_context=None):
if rf64_context is None and ident in {b'RF64', b'BW64'}:
rf64_context = parse_rf64(stream=stream, signature=ident)
assert rf64_context is not None, \
"Sentinel data size 0xFFFFFFFF found outside of RF64 context"
data_size = rf64_context.bigchunk_table[ident]
displacement = data_size
if displacement % 2:
displacement += 1
if ident in {b'RIFF', b'LIST', b'RF64', b'BW64'}:
return parse_list_chunk(stream=stream, length=data_size, rf64_context=rf64_context)
if ident in {b'RIFF', b'LIST', b'RF64', b'BW64', b'list'}:
return parse_list_chunk(stream=stream, length=data_size,
rf64_context=rf64_context)
else:
data_start = stream.tell()
stream.seek(displacement, 1)
return ChunkDescriptor(ident=ident, start=data_start, length=data_size, rf64_context=rf64_context)
return ChunkDescriptor(ident=ident,
start=data_start,
length=data_size,
rf64_context=rf64_context)

View File

@@ -1,121 +1,121 @@
from functools import reduce
# from functools import reduce
def binary_to_string(binary_value):
return reduce(lambda val, el: val + "{:02x}".format(el), binary_value, '')
# def binary_to_string(binary_value):
# return reduce(lambda val, el: val + "{:02x}".format(el),
# binary_value, '')
# class UMIDParser:
# """
# Parse a raw binary SMPTE 330M Universal Materials Identifier
#
# This implementation is based on SMPTE ST 330:2011
# """
# def __init__(self, raw_umid: bytes):
# self.raw_umid = raw_umid
#
# @property
# def universal_label(self) -> bytearray:
# return self.raw_umid[0:12]
#
# @property
# def basic_umid(self):
# return self.raw_umid[0:32]
class UMIDParser:
"""
Parse a raw binary SMPTE 330M Universal Materials Identifier
This implementation is based on SMPTE ST 330:2011
"""
def __init__(self, raw_umid: bytes):
self.raw_umid = raw_umid
#
# @property
# def universal_label(self) -> bytearray:
# return self.raw_umid[0:12]
#
# @property
# def basic_umid(self):
# return self.raw_umid[0:32]
def basic_umid_to_str(self):
return binary_to_string(self.raw_umid[0:32])
#
# @property
# def universal_label_is_valid(self) -> bool:
# valid_preamble = b'\x06\x0a\x2b\x34\x01\x01\x01\x05\x01\x01'
# return self.universal_label[0:len(valid_preamble)] == valid_preamble
#
# @property
# def material_type(self) -> str:
# material_byte = self.raw_umid[10]
# if material_byte == 0x1:
# return 'picture'
# elif material_byte == 0x2:
# return 'audio'
# elif material_byte == 0x3:
# return 'data'
# elif material_byte == 0x4:
# return 'other'
# elif material_byte == 0x5:
# return 'picture_single_component'
# elif material_byte == 0x6:
# return 'picture_multiple_component'
# elif material_byte == 0x7:
# return 'audio_single_component'
# elif material_byte == 0x9:
# return 'audio_multiple_component'
# elif material_byte == 0xb:
# return 'auxiliary_single_component'
# elif material_byte == 0xc:
# return 'auxiliary_multiple_component'
# elif material_byte == 0xd:
# return 'mixed_components'
# elif material_byte == 0xf:
# return 'not_identified'
# else:
# return 'not_recognized'
#
# @property
# def material_number_creation_method(self) -> str:
# method_byte = self.raw_umid[11]
# method_byte = (method_byte << 4) & 0xf
# if method_byte == 0x0:
# return 'undefined'
# elif method_byte == 0x1:
# return 'smpte'
# elif method_byte == 0x2:
# return 'uuid'
# elif method_byte == 0x3:
# return 'masked'
# elif method_byte == 0x4:
# return 'ieee1394'
# elif 0x5 <= method_byte <= 0x7:
# return 'reserved_undefined'
# else:
# return 'unrecognized'
#
# @property
# def instance_number_creation_method(self) -> str:
# method_byte = self.raw_umid[11]
# method_byte = method_byte & 0xf
# if method_byte == 0x0:
# return 'undefined'
# elif method_byte == 0x01:
# return 'local_registration'
# elif method_byte == 0x02:
# return '24_bit_prs'
# elif method_byte == 0x03:
# return 'copy_number_and_16_bit_prs'
# elif 0x04 <= method_byte <= 0x0e:
# return 'reserved_undefined'
# elif method_byte == 0x0f:
# return 'live_stream'
# else:
# return 'unrecognized'
#
# @property
# def indicated_length(self) -> str:
# if self.raw_umid[12] == 0x13:
# return 'basic'
# elif self.raw_umid[12] == 0x33:
# return 'extended'
#
# @property
# def instance_number(self) -> bytearray:
# return self.raw_umid[13:3]
#
# @property
# def material_number(self) -> bytearray:
# return self.raw_umid[16:16]
#
# @property
# def source_pack(self) -> Union[bytearray, None]:
# if self.indicated_length == 'extended':
# return self.raw_umid[32:32]
# else:
# return None
# def basic_umid_to_str(self):
# return binary_to_string(self.raw_umid[0:32])
#
# @property
# def universal_label_is_valid(self) -> bool:
# valid_preamble = b'\x06\x0a\x2b\x34\x01\x01\x01\x05\x01\x01'
# return self.universal_label[0:len(valid_preamble)] == valid_preamble
#
# @property
# def material_type(self) -> str:
# material_byte = self.raw_umid[10]
# if material_byte == 0x1:
# return 'picture'
# elif material_byte == 0x2:
# return 'audio'
# elif material_byte == 0x3:
# return 'data'
# elif material_byte == 0x4:
# return 'other'
# elif material_byte == 0x5:
# return 'picture_single_component'
# elif material_byte == 0x6:
# return 'picture_multiple_component'
# elif material_byte == 0x7:
# return 'audio_single_component'
# elif material_byte == 0x9:
# return 'audio_multiple_component'
# elif material_byte == 0xb:
# return 'auxiliary_single_component'
# elif material_byte == 0xc:
# return 'auxiliary_multiple_component'
# elif material_byte == 0xd:
# return 'mixed_components'
# elif material_byte == 0xf:
# return 'not_identified'
# else:
# return 'not_recognized'
#
# @property
# def material_number_creation_method(self) -> str:
# method_byte = self.raw_umid[11]
# method_byte = (method_byte << 4) & 0xf
# if method_byte == 0x0:
# return 'undefined'
# elif method_byte == 0x1:
# return 'smpte'
# elif method_byte == 0x2:
# return 'uuid'
# elif method_byte == 0x3:
# return 'masked'
# elif method_byte == 0x4:
# return 'ieee1394'
# elif 0x5 <= method_byte <= 0x7:
# return 'reserved_undefined'
# else:
# return 'unrecognized'
#
# @property
# def instance_number_creation_method(self) -> str:
# method_byte = self.raw_umid[11]
# method_byte = method_byte & 0xf
# if method_byte == 0x0:
# return 'undefined'
# elif method_byte == 0x01:
# return 'local_registration'
# elif method_byte == 0x02:
# return '24_bit_prs'
# elif method_byte == 0x03:
# return 'copy_number_and_16_bit_prs'
# elif 0x04 <= method_byte <= 0x0e:
# return 'reserved_undefined'
# elif method_byte == 0x0f:
# return 'live_stream'
# else:
# return 'unrecognized'
#
# @property
# def indicated_length(self) -> str:
# if self.raw_umid[12] == 0x13:
# return 'basic'
# elif self.raw_umid[12] == 0x33:
# return 'extended'
#
# @property
# def instance_number(self) -> bytearray:
# return self.raw_umid[13:3]
#
# @property
# def material_number(self) -> bytearray:
# return self.raw_umid[16:16]
#
# @property
# def source_pack(self) -> Union[bytearray, None]:
# if self.indicated_length == 'extended':
# return self.raw_umid[32:32]
# else:
# return None

View File

@@ -5,12 +5,14 @@ ADM Reader
from struct import unpack, unpack_from, calcsize
from io import BytesIO
from collections import namedtuple
from typing import Iterable, Tuple
from typing import Optional
from lxml import etree as ET
ChannelEntry = namedtuple('ChannelEntry', "track_index uid track_ref pack_ref")
class WavADMReader:
"""
Reads XML data from an EBU ADM (Audio Definiton Model) WAV File.
@@ -26,24 +28,24 @@ class WavADMReader:
_, uid_count = unpack(header_fmt, chna_data[0:4])
#: A list of :class:`ChannelEntry` objects parsed from the
#: `chna` metadata chunk.
#:
#: .. note::
#: In-file, the `chna` track indexes start at 1. However, this interface
#: numbers the first track 0, in order to maintain consistency with other
#: libraries.
self.channel_uids = []
offset = calcsize(header_fmt)
for _ in range(uid_count):
track_index, uid, track_ref, pack_ref = unpack_from(uid_fmt, chna_data, offset)
track_index, uid, track_ref, pack_ref = unpack_from(uid_fmt,
chna_data,
offset)
# these values are either ascii or all null
self.channel_uids.append(ChannelEntry(track_index - 1,
uid.decode('ascii') , track_ref.decode('ascii'), pack_ref.decode('ascii')))
self.channel_uids.append(
ChannelEntry(track_index - 1,
uid.decode('ascii'),
track_ref.decode('ascii'),
pack_ref.decode('ascii')
)
)
offset += calcsize(uid_fmt)
@@ -53,12 +55,13 @@ class WavADMReader:
def programme(self) -> dict:
"""
Read the ADM `audioProgramme` data structure and some of its reference properties.
Read the ADM `audioProgramme` data structure and some of its reference
properties.
"""
ret_dict = dict()
nsmap = self.axml.getroot().nsmap
nsmap = self.axml.getroot().nsmap
afext = self.axml.find(".//audioFormatExtended", namespaces=nsmap)
program = afext.find("audioProgramme", namespaces=nsmap)
@@ -68,17 +71,21 @@ class WavADMReader:
ret_dict['programme_end'] = program.get("end")
ret_dict['contents'] = []
for content_ref in program.findall("audioContentIDRef", namespaces=nsmap):
for content_ref in program.findall("audioContentIDRef",
namespaces=nsmap):
content_dict = dict()
content_dict['content_id'] = cid = content_ref.text
content = afext.find("audioContent[@audioContentID='%s']" % cid, namespaces=nsmap)
content = afext.find("audioContent[@audioContentID='%s']" % cid,
namespaces=nsmap)
content_dict['content_name'] = content.get("audioContentName")
content_dict['objects'] = []
for object_ref in content.findall("audioObjectIDRef", namespaces=nsmap):
for object_ref in content.findall("audioObjectIDRef",
namespaces=nsmap):
object_dict = dict()
object_dict['object_id'] = oid = object_ref.text
object = afext.find("audioObject[@audioObjectID='%s']" % oid, namespaces=nsmap)
object = afext.find("audioObject[@audioObjectID='%s']" % oid,
namespaces=nsmap)
pack = object.find("audioPackFormatIDRef", namespaces=nsmap)
object_dict['object_name'] = object.get("audioObjectName")
object_dict['object_start'] = object.get("start")
@@ -95,16 +102,18 @@ class WavADMReader:
return ret_dict
def track_info(self, index) -> dict:
def track_info(self, index) -> Optional[dict]:
"""
Information about a track in the WAV file.
:param index: index of audio track (indexed from zero)
:returns: a dictionary with *content_name*, *content_id*, *object_name*, *object_id*,
:param index: index of audio track (indexed from zero)
:returns: a dictionary with *content_name*, *content_id*,
*object_name*, *object_id*,
*pack_format_name*, *pack_type*, *channel_format_name*
"""
channel_info = next((x for x in self.channel_uids if x.track_index == index), None)
channel_info = next((x for x in self.channel_uids
if x.track_index == index), None)
if channel_info is None:
return None
@@ -112,46 +121,60 @@ class WavADMReader:
nsmap = self.axml.getroot().nsmap
afext = self.axml.find(".//audioFormatExtended", namespaces=nsmap)
afext = self.axml.find(".//audioFormatExtended",
namespaces=nsmap)
trackformat_elem = afext.find("audioTrackFormat[@audioTrackFormatID='%s']" % channel_info.track_ref,
namespaces=nsmap)
trackformat_elem = afext.find(
"audioTrackFormat[@audioTrackFormatID='%s']"
% channel_info.track_ref, namespaces=nsmap)
stream_id = trackformat_elem[0].text
channelformatref_elem = afext.find("audioStreamFormat[@audioStreamFormatID='%s']/audioChannelFormatIDRef" % stream_id,
channelformatref_elem = afext.find(
("audioStreamFormat[@audioStreamFormatID='%s']"
"/audioChannelFormatIDRef") % stream_id,
namespaces=nsmap)
channelformat_id = channelformatref_elem.text
packformatref_elem = afext.find("audioStreamFormat[@audioStreamFormatID='%s']/audioPackFormatIDRef" % stream_id,
packformatref_elem = afext.find(
("audioStreamFormat[@audioStreamFormatID='%s']"
"/audioPackFormatIDRef") % stream_id,
namespaces=nsmap)
packformat_id = packformatref_elem.text
channelformat_elem = afext.find("audioChannelFormat[@audioChannelFormatID='%s']" % channelformat_id,
namespaces=nsmap)
ret_dict['channel_format_name'] = channelformat_elem.get("audioChannelFormatName")
channelformat_elem = afext\
.find("audioChannelFormat[@audioChannelFormatID='%s']"
% channelformat_id,
namespaces=nsmap)
ret_dict['channel_format_name'] = channelformat_elem.get(
"audioChannelFormatName")
packformat_elem = afext.find("audioPackFormat[@audioPackFormatID='%s']" % packformat_id,
packformat_elem = afext.find(
"audioPackFormat[@audioPackFormatID='%s']" % packformat_id,
namespaces=nsmap)
ret_dict['pack_type'] = packformat_elem.get("typeDefinition")
ret_dict['pack_format_name'] = packformat_elem.get("audioPackFormatName")
ret_dict['pack_type'] = packformat_elem.get(
"typeDefinition")
ret_dict['pack_format_name'] = packformat_elem.get(
"audioPackFormatName")
object_elem = afext.find("audioObject[audioPackFormatIDRef = '%s']" % packformat_id,
namespaces=nsmap)
object_elem = afext.find("audioObject[audioPackFormatIDRef = '%s']"
% packformat_id,
namespaces=nsmap)
ret_dict['audio_object_name'] = object_elem.get("audioObjectName")
object_id = object_elem.get("audioObjectID")
ret_dict['object_id'] = object_id
content_elem = afext.find("audioContent/[audioObjectIDRef = '%s']" % object_id,
namespaces=nsmap)
content_elem = afext.find("audioContent/[audioObjectIDRef = '%s']"
% object_id,
namespaces=nsmap)
ret_dict['content_name'] = content_elem.get("audioContentName")
ret_dict['content_id'] = content_elem.get("audioContentID")
return ret_dict
def to_dict(self) -> dict: #FIXME should be "asdict"
def to_dict(self) -> dict: # FIXME should be "asdict"
"""
Get ADM metadata as a dictionary.
"""
@@ -161,5 +184,6 @@ class WavADMReader:
rd.update(self.track_info(channel_uid_rec.track_index))
return rd
return dict(channel_entries=list(map(lambda z: make_entry(z), self.channel_uids)),
programme=self.programme())
return dict(channel_entries=list(map(lambda z: make_entry(z),
self.channel_uids)),
programme=self.programme())

View File

@@ -1,73 +1,77 @@
import struct
from .umid_parser import UMIDParser
# from .umid_parser import UMIDParser
from typing import Optional
class WavBextReader:
def __init__(self, bext_data, encoding):
"""
Read Broadcast-WAV extended metadata.
:param bext_data: The bytes-like data.
:param encoding: The encoding to use when decoding the text fields of the
BEXT metadata scope. According to EBU Rec 3285 this shall be ASCII.
:param encoding: The encoding to use when decoding the text fields of
the BEXT metadata scope. According to EBU Rec 3285 this shall be
ASCII.
"""
packstring = "<256s" + "32s" + "32s" + "10s" + "8s" + "QH" + "64s" + "hhhhh" + "180s"
packstring = "<256s" + "32s" + "32s" + "10s" + "8s" + "QH" + "64s" + \
"hhhhh" + "180s"
rest_starts = struct.calcsize(packstring)
unpacked = struct.unpack(packstring, bext_data[:rest_starts])
def sanitize_bytes(b : bytes) -> str:
def sanitize_bytes(b: bytes) -> str:
# honestly can't remember why I'm stripping nulls this way
first_null = next((index for index, byte in enumerate(b) if byte == 0), None)
first_null = next((index for index, byte in enumerate(b)
if byte == 0), None)
trimmed = b if first_null is None else b[:first_null]
decoded = trimmed.decode(encoding)
return decoded
#: Description. A free-text field up to 256 characters long.
self.description : str = sanitize_bytes(unpacked[0])
self.description: str = sanitize_bytes(unpacked[0])
#: Originator. Usually the name of the encoding application, sometimes
#: an artist name.
self.originator : str = sanitize_bytes(unpacked[1])
self.originator: str = sanitize_bytes(unpacked[1])
#: A unique identifier for the file, a serial number.
self.originator_ref : str = sanitize_bytes(unpacked[2])
self.originator_ref: str = sanitize_bytes(unpacked[2])
#: Date of the recording, in the format YYYY-MM-DD.
self.originator_date : str = sanitize_bytes(unpacked[3])
self.originator_date: str = sanitize_bytes(unpacked[3])
#: Time of the recording, in the format HH:MM:SS.
self.originator_time : str = sanitize_bytes(unpacked[4])
#: The sample offset of the start, usually relative
#: to midnight.
self.time_reference : int = unpacked[5]
self.originator_time: str = sanitize_bytes(unpacked[4])
#: The sample offset of the start, usually relative
#: to midnight.
self.time_reference: int = unpacked[5]
#: A variable-length text field containing a list of processes and
#: and conversions performed on the file.
self.coding_history : str = sanitize_bytes(bext_data[rest_starts:])
#: BEXT version.
self.version : int = unpacked[6]
#: SMPTE 330M UMID of this audio file, 64 bytes are allocated though the UMID
#: may only be 32 bytes long.
self.umid : Optional[bytes] = None
self.coding_history: str = sanitize_bytes(bext_data[rest_starts:])
#: BEXT version.
self.version: int = unpacked[6]
#: SMPTE 330M UMID of this audio file, 64 bytes are allocated though
#: the UMID may only be 32 bytes long.
self.umid: Optional[bytes] = None
#: EBU R128 Integrated loudness, in LUFS.
self.loudness_value : Optional[float] = None
self.loudness_value: Optional[float] = None
#: EBU R128 Loudness range, in LUFS.
self.loudness_range : Optional[float] = None
self.loudness_range: Optional[float] = None
#: True peak level, in dBFS TP
self.max_true_peak : Optional[float] = None
self.max_true_peak: Optional[float] = None
#: EBU R128 Maximum momentary loudness, in LUFS
self.max_momentary_loudness : Optional[float] = None
self.max_momentary_loudness: Optional[float] = None
#: EBU R128 Maximum short-term loudness, in LUFS.
self.max_shortterm_loudness : Optional[float] = None
self.max_shortterm_loudness: Optional[float] = None
if self.version > 0:
self.umid = unpacked[7]
@@ -80,11 +84,12 @@ class WavBextReader:
self.max_shortterm_loudness = unpacked[12] / 100.0
def to_dict(self):
if self.umid is not None:
umid_parsed = UMIDParser(self.umid)
umid_str = umid_parsed.basic_umid_to_str()
else:
umid_str = None
# if self.umid is not None:
# umid_parsed = UMIDParser(self.umid)
# umid_str = umid_parsed.basic_umid_to_str()
# else:
umid_str = None
return {'description': self.description,
'originator': self.originator,

286
wavinfo/wave_cues_reader.py Normal file
View File

@@ -0,0 +1,286 @@
"""
Cues metadata
For reference on implementation of cues and related metadata see:
August 1991, "Multimedia Programming Interface and Data Specifications 1.0",
IBM Corporation and Microsoft Corporation
https://www.aelius.com/njh/wavemetatools/doc/riffmci.pdf
"""
from dataclasses import dataclass
from .riff_parser import ChunkDescriptor
from struct import unpack, calcsize
from typing import Optional, Tuple, NamedTuple, List, Dict, Any, Generator
#: Country Codes used in the RIFF standard to resolve locale. These codes
#: appear in CSET and LTXT metadata.
CountryCodes = """000 None Indicated
001,USA
002,Canada
003,Latin America
030,Greece
031,Netherlands
032,Belgium
033,France
034,Spain
039,Italy
041,Switzerland
043,Austria
044,United Kingdom
045,Denmark
046,Sweden
047,Norway
049,West Germany
052,Mexico
055,Brazil
061,Australia
064,New Zealand
081,Japan
082,Korea
086,Peoples Republic of China
088,Taiwan
090,Turkey
351,Portugal
352,Luxembourg
354,Iceland
358,Finland"""
#: Language and Dialect codes used in the RIFF standard to resolve native
#: language of text fields. These codes appear in CSET and LTXT metadata.
LanguageDialectCodes = """0 0 None Indicated
1,1,Arabic
2,1,Bulgarian
3,1,Catalan
4,1,Traditional Chinese
4,2,Simplified Chinese
5,1,Czech
6,1,Danish
7,1,German
7,2,Swiss German
8,1,Greek
9,1,US English
9,2,UK English
10,1,Spanish
10,2,Spanish Mexican
11,1,Finnish
12,1,French
12,2,Belgian French
12,3,Canadian French
12,4,Swiss French
13,1,Hebrew
14,1,Hungarian
15,1,Icelandic
16,1,Italian
16,2,Swiss Italian
17,1,Japanese
18,1,Korean
19,1,Dutch
19,2,Belgian Dutch
20,1,Norwegian - Bokmal
20,2,Norwegian - Nynorsk
21,1,Polish
22,1,Brazilian Portuguese
22,2,Portuguese
23,1,Rhaeto-Romanic
24,1,Romanian
25,1,Russian
26,1,Serbo-Croatian (Latin)
26,2,Serbo-Croatian (Cyrillic)
27,1,Slovak
28,1,Albanian
29,1,Swedish
30,1,Thai
31,1,Turkish
32,1,Urdu
33,1,Bahasa"""
class CueEntry(NamedTuple):
"""
A ``cue`` element structure.
"""
#: Cue "name" or id number
name: int
#: Cue position, as a frame count in the play order of the WAVE file. In
#: principle this can be affected by playlists and ``wavl`` chunk
#: placement.
position: int
chunk_id: bytes
chunk_start: int
block_start: int
sample_offset: int
Format = "<II4sIII"
@classmethod
def format_size(cls) -> int:
return calcsize(cls.Format)
@classmethod
def read(cls, data: bytes) -> 'CueEntry':
assert len(data) == cls.format_size(), \
(f"cue data size incorrect, expected {calcsize(cls.Format)} "
"found {len(data)}")
parsed = unpack(cls.Format, data)
return cls(name=parsed[0], position=parsed[1], chunk_id=parsed[2],
chunk_start=parsed[3], block_start=parsed[4],
sample_offset=parsed[5])
class LabelEntry(NamedTuple):
"""
A ``labl`` structure.
"""
name: int
text: str
@classmethod
def read(cls, data: bytes, encoding: str):
return cls(name=unpack("<I", data[0:4])[0],
text=data[4:].decode(encoding).rstrip("\0"))
NoteEntry = LabelEntry
class RangeLabel(NamedTuple):
"""
A ``ltxt`` structure.
"""
name: int
length: int
purpose: str
country: int
language: int
dialect: int
codepage: int
text: str
@classmethod
def read(cls, data: bytes, fallback_encoding: str):
leader_struct_fmt = "<II4sHHHH"
parsed = unpack(leader_struct_fmt, data[0:calcsize(leader_struct_fmt)])
text_data = data[calcsize(leader_struct_fmt):]
if data[6] != 0:
fallback_encoding = f"cp{data[6]}"
return cls(name=parsed[0], length=parsed[1], purpose=parsed[2],
country=parsed[3], language=parsed[4],
dialect=parsed[5], codepage=parsed[6],
text=text_data.decode(fallback_encoding))
@dataclass
class WavCuesReader:
#: Every ``cue`` entry in the file
cues: List[CueEntry]
#: Every ``labl`` in the file
labels: List[LabelEntry]
#: Every ``ltxt`` in the file
ranges: List[RangeLabel]
#: Every ``note`` in the file
notes: List[NoteEntry]
@classmethod
def read_all(cls, f,
cues: Optional[ChunkDescriptor],
labls: List[ChunkDescriptor],
ltxts: List[ChunkDescriptor],
notes: List[ChunkDescriptor],
fallback_encoding: str) -> 'WavCuesReader':
cue_list = []
if cues is not None:
cues_data = cues.read_data(f)
assert len(cues_data) >= 4, "cue metadata too short"
offset = calcsize("<I")
cues_count = unpack("<I", cues_data[0:offset])
for _ in range(cues_count[0]):
cue_bytes = cues_data[offset: offset + CueEntry.format_size()]
cue_list.append(CueEntry.read(cue_bytes))
offset += CueEntry.format_size()
label_list = []
for labl in labls:
label_list.append(
LabelEntry.read(labl.read_data(f),
encoding=fallback_encoding)
)
range_list = []
for r in ltxts:
range_list.append(
RangeLabel.read(r.read_data(f),
fallback_encoding=fallback_encoding)
)
note_list = []
for note in notes:
note_list.append(
NoteEntry.read(note.read_data(f),
encoding=fallback_encoding)
)
return WavCuesReader(cues=cue_list, labels=label_list,
ranges=range_list, notes=note_list)
def each_cue(self) -> Generator[Tuple[int, int], None, None]:
"""
Iterate through each cue.
:yields: the cue's ``name`` and ``sample_offset``
"""
for cue in self.cues:
yield (cue.name, cue.sample_offset)
def label_and_note(self, cue_ident: int) -> Tuple[Optional[str],
Optional[str]]:
"""
Get the label and note (extended comment) for a cue.
:param cue_ident: the cue's name, its unique identifying number
:returns: a tuple of the the cue's label (if present) and note (if
present)
"""
label = next((label.text for label in self.labels
if label.name == cue_ident), None)
note = next((n.text for n in self.notes
if n.name == cue_ident), None)
return (label, note)
def range(self, cue_ident: int) -> Optional[int]:
"""
Get the length of the time range for a cue, if it has one.
:param cue_ident: the cue's name, its unique identifying number
:returns: the length of the marker's range, or `None`
"""
return next((r.length for r in self.ranges
if r.name == cue_ident), None)
def to_dict(self) -> Dict[str, Any]:
retval = dict()
for n, t in self.each_cue():
retval[n] = dict()
retval[n]['frame'] = t
label, note = self.label_and_note(n)
r = self.range(n)
if label is not None:
retval[n]['label'] = label
if note is not None:
retval[n]['note'] = note
if r is not None:
retval[n]['length'] = r
return retval

View File

@@ -1,7 +1,7 @@
"""
Reading Dolby Bitstream Metadata
Unless otherwise stated, all § references here are to
Unless otherwise stated, all § references here are to
`EBU Tech 3285 Supplement 6`_.
.. _EBU Tech 3285 Supplement 6: https://tech.ebu.ch/docs/tech/tech3285s6.pdf
@@ -10,10 +10,11 @@ Unless otherwise stated, all § references here are to
from enum import IntEnum, Enum
from struct import unpack
from dataclasses import dataclass, asdict
from typing import List, Optional, Tuple, Any, Union
from typing import List, Tuple, Any, Union
from io import BytesIO
class SegmentType(IntEnum):
"""
Metadata segment type.
@@ -31,7 +32,7 @@ class SegmentType(IntEnum):
DolbyAtmosSupplemental = 0xa
@classmethod
def _missing_(cls,val):
def _missing_(cls, val):
return val
@@ -39,11 +40,11 @@ class SegmentType(IntEnum):
class DolbyDigitalPlusMetadata:
"""
*Dolby Digital Plus* is Dolby's brand for multichannel surround
on discrete formats that aren't AC-3 (Dolby Digital) or Dolby E. This
metadata segment is present in ADM wave files created with a Dolby Atmos
on discrete formats that aren't AC-3 (Dolby Digital) or Dolby E. This
metadata segment is present in ADM wave files created with a Dolby Atmos
Production Suite.
Where an AC-3 bitstream can contain multiple programs, a Dolby Digital
Where an AC-3 bitstream can contain multiple programs, a Dolby Digital
Plus bitstream will only contain one program.
"""
@@ -77,7 +78,6 @@ class DolbyDigitalPlusMetadata:
MUTE = 0b111
"-∞ dB"
class DolbySurroundEncodingMode(Enum):
"""
Dolby surround endcoding mode.
@@ -87,7 +87,6 @@ class DolbyDigitalPlusMetadata:
NOT_IN_USE = 0b01
NOT_INDICATED = 0b00
class BitStreamMode(Enum):
"""
Dolby Digital Plus `bsmod` field
@@ -122,7 +121,6 @@ class DolbyDigitalPlusMetadata:
should be interpreted as karaoke.
"""
class AudioCodingMode(Enum):
"""
Dolby Digital Plus `acmod` field
@@ -144,7 +142,6 @@ class DolbyDigitalPlusMetadata:
CH_ORD_3_2 = 0b111
"LCR + LR surround"
class CenterDownMixLevel(Enum):
"""
§ 4.3.3.1
@@ -152,16 +149,15 @@ class DolbyDigitalPlusMetadata:
DOWN_3DB = 0b00
"Attenuate 3 dB"
DOWN_45DB = 0b01
"Attenuate 4.5 dB"
DOWN_6DB = 0b10
"Attenuate 6 dB"
RESERVED = 0b11
class SurroundDownMixLevel(Enum):
"""
Dolby Digital Plus `surmixlev` field
@@ -172,7 +168,6 @@ class DolbyDigitalPlusMetadata:
MUTE = 0b10
RESERVED = 0b11
class LanguageCode(int):
"""
§ 4.3.4.1
@@ -181,21 +176,18 @@ class DolbyDigitalPlusMetadata:
"""
pass
class MixLevel(int):
"""
§ 4.3.6.2
"""
pass
class DialnormLevel(int):
"""
§ 4.3.4.4
"""
pass
class RoomType(Enum):
"""
`roomtyp` 4.3.6.3
@@ -205,11 +197,10 @@ class DolbyDigitalPlusMetadata:
SMALL_ROOM_FLAT_CURVE = 0b10
RESERVED = 0b11
class PreferredDownMixMode(Enum):
"""
Indicates the creating engineer's preference of what the receiver should
downmix.
Indicates the creating engineer's preference of what the receiver
should downmix.
§ 4.3.8.1
"""
NOT_INDICATED = 0b00
@@ -217,7 +208,6 @@ class DolbyDigitalPlusMetadata:
STEREO = 0b10
PRO_LOGIC_2 = 0b11
class SurroundEXMode(IntEnum):
"""
Dolby Surround-EX mode.
@@ -228,7 +218,6 @@ class DolbyDigitalPlusMetadata:
SEX = 0b10
PRO_LOGIC_2 = 0b11
class HeadphoneMode(IntEnum):
"""
`dheadphonmod` § 4.3.9.2
@@ -238,12 +227,10 @@ class DolbyDigitalPlusMetadata:
DOLBY_HEADPHONE = 0b10
RESERVED = 0b11
class ADConverterType(Enum):
STANDARD = 0
HDCD = 1
class StreamDependency(Enum):
"""
Encodes `ddplus_info1.stream_type` field § 4.3.12.1
@@ -254,7 +241,6 @@ class DolbyDigitalPlusMetadata:
INDEPENDENT_FROM_DOLBY_DIGITAL = 2
RESERVED = 3
class RFCompressionProfile(Enum):
"""
`compr1` RF compression profile
@@ -267,7 +253,7 @@ class DolbyDigitalPlusMetadata:
MUSIC_LIGHT = 4
SPEECH = 5
#: Program ID number, this identifies the program in a multi-program
#: Program ID number, this identifies the program in a multi-program
#: element. § 4.3.1
program_id: int
@@ -317,13 +303,13 @@ class DolbyDigitalPlusMetadata:
#: LoRo preferred center downmix level
loro_center_downmix_level: DownMixLevelToken
#: LoRo preferred surround downmix level
loro_surround_downmix_level: DownMixLevelToken
#: Preferred downmix mode
downmix_mode: PreferredDownMixMode
#: LtRt preferred center downmix level
ltrt_center_downmix_level: DownMixLevelToken
@@ -332,20 +318,20 @@ class DolbyDigitalPlusMetadata:
#: Surround-EX mode
surround_ex_mode: SurroundEXMode
#: Dolby Headphone mode
dolby_headphone_encoded: HeadphoneMode
ad_converter_type: ADConverterType
compression_profile: RFCompressionProfile
dynamic_range: RFCompressionProfile
#: Indicates if this stream can be decoded independently or not
stream_dependency: StreamDependency
#: Data rate of this bitstream in kilobits per second
datarate_kbps: int
@staticmethod
def load(buffer: bytes):
assert len(buffer) == 96, "Dolby Digital Plus segment incorrect size, "
@@ -363,12 +349,14 @@ class DolbyDigitalPlusMetadata:
pass
def surround_config(b):
return DolbyDigitalPlusMetadata.CenterDownMixLevel(b & 0x30 >> 4), \
DolbyDigitalPlusMetadata.SurroundDownMixLevel(b & 0xc >> 2), \
return (
DolbyDigitalPlusMetadata.CenterDownMixLevel(b & 0x30 >> 4),
DolbyDigitalPlusMetadata.SurroundDownMixLevel(b & 0xc >> 2),
DolbyDigitalPlusMetadata.DolbySurroundEncodingMode(b & 0x3)
)
def dialnorm_info(b):
return (b & 0x80) > 0 , b & 0x40 > 0, b & 0x20 > 0, \
return (b & 0x80) > 0, b & 0x40 > 0, b & 0x20 > 0, \
DolbyDigitalPlusMetadata.DialnormLevel(b & 0x1f)
def langcod(b) -> int:
@@ -379,22 +367,23 @@ class DolbyDigitalPlusMetadata:
DolbyDigitalPlusMetadata.MixLevel(b & 0x7c >> 2), \
DolbyDigitalPlusMetadata.RoomType(b & 0x3)
# loro_center_downmix_level, loro_surround_downmix_level
# loro_center_downmix_level, loro_surround_downmix_level
def ext_bsi1_word1(b):
return DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x38 >> 3), \
DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x7)
# downmix_mode, ltrt_center_downmix_level, ltrt_surround_downmix_level
def ext_bsi1_word2(b):
return DolbyDigitalPlusMetadata.PreferredDownMixMode(b & 0xC0 >> 6), \
return DolbyDigitalPlusMetadata\
.PreferredDownMixMode(b & 0xC0 >> 6), \
DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x38 >> 3), \
DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x7)
#surround_ex_mode, dolby_headphone_encoded, ad_converter_type
# surround_ex_mode, dolby_headphone_encoded, ad_converter_type
def ext_bsi2_word1(b):
return DolbyDigitalPlusMetadata.SurroundEXMode(b & 0x60 >> 5), \
DolbyDigitalPlusMetadata.HeadphoneMode(b & 0x18 >> 3), \
DolbyDigitalPlusMetadata.ADConverterType( b & 0x4 >> 2)
DolbyDigitalPlusMetadata.ADConverterType(b & 0x4 >> 2)
def ddplus_reserved2(_):
pass
@@ -403,7 +392,7 @@ class DolbyDigitalPlusMetadata:
return DolbyDigitalPlusMetadata.RFCompressionProfile(b)
def dynrng1(b):
DolbyDigitalPlusMetadata.RFCompressionProfile(b)
DolbyDigitalPlusMetadata.RFCompressionProfile(b)
def ddplus_reserved3(_):
pass
@@ -423,14 +412,19 @@ class DolbyDigitalPlusMetadata:
pid = program_id(buffer[0])
lfe_on, bitstream_mode, audio_coding_mode = program_info(buffer[1])
ddplus_reserved1(buffer[2:2])
center_downmix_level, surround_downmix_level, dolby_surround_encoded = surround_config(buffer[4])
langcode_present, copyright_bitstream, original_bitstream, dialnorm = dialnorm_info(buffer[5])
center_downmix_level, surround_downmix_level, \
dolby_surround_encoded = surround_config(buffer[4])
langcode_present, copyright_bitstream, original_bitstream, \
dialnorm = dialnorm_info(buffer[5])
langcode = langcod(buffer[6])
prod_info_exists, mixlevel, roomtype = audio_prod_info(buffer[7])
loro_center_downmix_level, loro_surround_downmix_level = ext_bsi1_word1(buffer[8])
downmix_mode, ltrt_center_downmix_level, ltrt_surround_downmix_level = ext_bsi1_word2(buffer[9])
surround_ex_mode, dolby_headphone_encoded, ad_converter_type = ext_bsi2_word1(buffer[10])
loro_center_downmix_level, \
loro_surround_downmix_level = ext_bsi1_word1(buffer[8])
downmix_mode, ltrt_center_downmix_level, \
ltrt_surround_downmix_level = ext_bsi1_word2(buffer[9])
surround_ex_mode, dolby_headphone_encoded, \
ad_converter_type = ext_bsi2_word1(buffer[10])
ddplus_reserved2(buffer[11:14])
compression = compr1(buffer[14])
@@ -441,33 +435,33 @@ class DolbyDigitalPlusMetadata:
data_rate = datarate(buffer[25:27])
reserved(buffer[27:69])
return DolbyDigitalPlusMetadata(program_id=pid,
lfe_on=lfe_on,
bitstream_mode=bitstream_mode,
audio_coding_mode=audio_coding_mode,
center_downmix_level=center_downmix_level,
surround_downmix_level=surround_downmix_level,
dolby_surround_encoded=dolby_surround_encoded,
langcode_present=langcode_present,
copyright_bitstream=copyright_bitstream,
original_bitstream=original_bitstream,
dialnorm=dialnorm,
langcode=langcode,
prod_info_exists=prod_info_exists,
mixlevel=mixlevel,
roomtype=roomtype,
loro_center_downmix_level=loro_center_downmix_level,
loro_surround_downmix_level=loro_surround_downmix_level,
downmix_mode=downmix_mode,
ltrt_center_downmix_level=ltrt_center_downmix_level,
ltrt_surround_downmix_level=ltrt_surround_downmix_level,
surround_ex_mode=surround_ex_mode,
dolby_headphone_encoded=dolby_headphone_encoded,
ad_converter_type=ad_converter_type,
compression_profile=compression,
dynamic_range=dynamic_range,
stream_dependency=stream_info,
datarate_kbps=data_rate)
return DolbyDigitalPlusMetadata(
program_id=pid, lfe_on=lfe_on,
bitstream_mode=bitstream_mode,
audio_coding_mode=audio_coding_mode,
center_downmix_level=center_downmix_level,
surround_downmix_level=surround_downmix_level,
dolby_surround_encoded=dolby_surround_encoded,
langcode_present=langcode_present,
copyright_bitstream=copyright_bitstream,
original_bitstream=original_bitstream,
dialnorm=dialnorm,
langcode=langcode,
prod_info_exists=prod_info_exists,
mixlevel=mixlevel,
roomtype=roomtype,
loro_center_downmix_level=loro_center_downmix_level,
loro_surround_downmix_level=loro_surround_downmix_level,
downmix_mode=downmix_mode,
ltrt_center_downmix_level=ltrt_center_downmix_level,
ltrt_surround_downmix_level=ltrt_surround_downmix_level,
surround_ex_mode=surround_ex_mode,
dolby_headphone_encoded=dolby_headphone_encoded,
ad_converter_type=ad_converter_type,
compression_profile=compression,
dynamic_range=dynamic_range,
stream_dependency=stream_info,
datarate_kbps=data_rate)
@dataclass
@@ -486,7 +480,7 @@ class DolbyAtmosMetadata:
NOT_INDICATED = 0x04
tool_name: str
tool_version: Tuple[int,int,int]
tool_version: Tuple[int, int, int]
warp_mode: WarpMode
SEGMENT_LENGTH = 248
@@ -494,8 +488,10 @@ class DolbyAtmosMetadata:
@classmethod
def load(cls, data: bytes):
assert len(data) == cls.SEGMENT_LENGTH, "DolbyAtmosMetadata segment "\
"is incorrect length, expected %i actual was %i" % (cls.SEGMENT_LENGTH, len(data))
assert len(data) == cls.SEGMENT_LENGTH
# (f"DolbyAtmosMetadata segment is incorrect length, "
# f"expected {cls.SEGMENT_LENGTH} actual was {len(data)}")
h = BytesIO(data)
@@ -512,17 +508,20 @@ class DolbyAtmosMetadata:
a_val = unpack("B", h.read(1))[0]
warp_mode = a_val & 0x7
return DolbyAtmosMetadata(tool_name=toolname,
tool_version=(major, minor, fix), warp_mode=DolbyAtmosMetadata.WarpMode(warp_mode))
return DolbyAtmosMetadata(tool_name=toolname,
tool_version=(major, minor, fix),
warp_mode=DolbyAtmosMetadata
.WarpMode(warp_mode))
@dataclass
class DolbyAtmosSupplementalMetadata:
"""
Dolby Atmos supplemental metadata segment.
https://github.com/DolbyLaboratories/dbmd-atmos-parser/blob/master/dbmd_atmos_parse/src/dbmd_atmos_parse.c
"""
https://github.com/DolbyLaboratories/dbmd-atmos-parser/blob/
master/dbmd_atmos_parse/src/dbmd_atmos_parse.c
"""
class BinauralRenderMode(Enum):
BYPASS = 0x00
@@ -531,12 +530,10 @@ class DolbyAtmosSupplementalMetadata:
MID = 0x03
NOT_INDICATED = 0x04
object_count: int
render_modes: List['DolbyAtmosSupplementalMetadata.BinauralRenderMode']
trim_modes: List[int]
MAGIC = 0xf8726fbd
TRIM_CONFIG_COUNT = 9
@@ -547,28 +544,29 @@ class DolbyAtmosSupplementalMetadata:
render_modes = []
h = BytesIO(data)
magic = unpack("<I", h.read(4))
magic = unpack("<I", h.read(4))[0]
assert magic == cls.MAGIC, "Magic value was not found"
object_count = unpack("<H", h.read(2))
object_count = unpack("<H", h.read(2))[0]
h.read(1) #skip 1
h.read(1) # skip 1
for _ in range(cls.TRIM_CONFIG_COUNT):
auto_trim = unpack("B", h.read(1))
trim_modes.append(auto_trim)
h.read(14) #skip 14
h.read(object_count) # skip object_count bytes
h.read(14) # skip 14
h.read(object_count) # skip object_count bytes
for _ in range(object_count):
binaural_mode = unpack("B", h.read(1))
binaural_mode = unpack("B", h.read(1))[0]
binaural_mode &= 0x7
render_modes.append(binaural_mode)
return DolbyAtmosSupplementalMetadata(object_count=object_count,
render_modes=render_modes,trim_modes=trim_modes)
render_modes=render_modes,
trim_modes=trim_modes)
class WavDolbyMetadataReader:
@@ -580,11 +578,11 @@ class WavDolbyMetadataReader:
#:
#: Each list entry is a tuple of `SegmentType`, a `bool`
#: indicating if the segment's checksum was valid, and the
#: segment's parsed dataclass (or a `bytes` array if it was
#: segment's parsed dataclass (or a `bytes` array if it was
#: not recognized).
segment_list: Tuple[Union[SegmentType, int], bool, Any]
segment_list: List[Tuple[Union[SegmentType, int], bool, Any]]
version: Tuple[int,int,int,int]
version: Tuple[int, int, int, int]
@staticmethod
def segment_checksum(bs: bytes, size: int):
@@ -597,7 +595,6 @@ class WavDolbyMetadataReader:
return retval
def __init__(self, dbmd_data):
self.segment_list = []
@@ -606,18 +603,19 @@ class WavDolbyMetadataReader:
v_vec = []
for _ in range(4):
b = h.read(1)
v_vec.insert(0, unpack("B",b)[0])
v_vec.insert(0, unpack("B", b)[0])
self.version = tuple(v_vec)
while True:
stype= SegmentType(unpack("B", h.read(1))[0])
stype = SegmentType(unpack("B", h.read(1))[0])
if stype == SegmentType.EndMarker:
break
else:
seg_size = unpack("<H", h.read(2))[0]
seg_payload = h.read(seg_size)
expected_checksum = WavDolbyMetadataReader.segment_checksum(seg_payload, seg_size)
expected_checksum = WavDolbyMetadataReader\
.segment_checksum(seg_payload, seg_size)
checksum = unpack("B", h.read(1))[0]
segment = seg_payload
@@ -625,37 +623,38 @@ class WavDolbyMetadataReader:
segment = DolbyDigitalPlusMetadata.load(segment)
elif stype == SegmentType.DolbyAtmos:
segment = DolbyAtmosMetadata.load(segment)
# elif stype == SegmentType.DolbyAtmosSupplemental:
# segment = DolbyAtmosSupplementalMetadata.load(segment)
self.segment_list.append( (stype, checksum == expected_checksum, segment) )
elif stype == SegmentType.DolbyAtmosSupplemental:
segment = DolbyAtmosSupplementalMetadata.load(segment)
self.segment_list\
.append((stype, checksum == expected_checksum, segment))
def dolby_digital_plus(self) -> List[DolbyDigitalPlusMetadata]:
"""
Every valid Dolby Digital Plus metadata segment in the file.
"""
return [x[2] for x in self.segment_list \
if x[0] == SegmentType.DolbyDigitalPlus and x[1]]
return [x[2] for x in self.segment_list
if x[0] == SegmentType.DolbyDigitalPlus and x[1]]
def dolby_atmos(self) -> List[DolbyAtmosMetadata]:
"""
Every valid Dolby Atmos metadata segment in the file.
"""
return [x[2] for x in self.segment_list \
if x[0] == SegmentType.DolbyAtmos and x[1]]
return [x[2] for x in self.segment_list
if x[0] == SegmentType.DolbyAtmos and x[1]]
# def dolby_atmos_supplemental(self) -> List[DolbyAtmosSupplementalMetadata]:
# """
# Every valid Dolby Atmos Supplemental metadata segment in the file.
# """
# return [x[2] for x in self.segment_list \
# if x[0] == SegmentType.DolbyAtmosSupplemental and x[1]]
def dolby_atmos_supplemental(self) -> List[DolbyAtmosSupplementalMetadata]:
"""
Every valid Dolby Atmos Supplemental metadata segment in the file.
"""
return [x[2] for x in self.segment_list
if x[0] == SegmentType.DolbyAtmosSupplemental and x[1]]
def to_dict(self) -> dict:
ddp = map(lambda x: asdict(x), self.dolby_digital_plus())
atmos = map(lambda x: asdict(x), self.dolby_atmos())
#atmos_sup = map(lambda x: asdict(x), self.dolby_atmos_supplemental())
# atmos_sup = map(lambda x: asdict(x), self.dolby_atmos_supplemental())
return dict(dolby_digital_plus=list(ddp),
dolby_atmos=list(atmos))
dolby_atmos=list(atmos))

View File

@@ -2,6 +2,7 @@ from .riff_parser import parse_chunk, ListChunkDescriptor
from typing import Optional
class WavInfoChunkReader:
def __init__(self, f, encoding):
@@ -9,47 +10,52 @@ class WavInfoChunkReader:
f.seek(0)
parsed_chunks = parse_chunk(f)
assert type(parsed_chunks) is ListChunkDescriptor
list_chunks = [chunk for chunk in parsed_chunks.children if type(chunk) is ListChunkDescriptor]
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.info_chunk = next((chunk for chunk in list_chunks
if chunk.signature == b'INFO'), None)
#: 'ICOP' Copyright
self.copyright : Optional[str] = self._get_field(f, b'ICOP')
self.copyright: Optional[str] = self._get_field(f, b'ICOP')
#: 'IPRD' Product
self.product : Optional[str]= self._get_field(f, b'IPRD')
self.album : Optional[str] = self.product
self.product: Optional[str] = self._get_field(f, b'IPRD')
self.album: Optional[str] = self.product
#: 'IGNR' Genre
self.genre : Optional[str] = self._get_field(f, b'IGNR')
self.genre: Optional[str] = self._get_field(f, b'IGNR')
#: 'ISBJ' Subject
self.subject : Optional[str] = self._get_field(f, b'ISBJ')
self.subject: Optional[str] = self._get_field(f, b'ISBJ')
#: 'IART' Artist, composer, author
self.artist : Optional[str] = self._get_field(f, b'IART')
self.artist: Optional[str] = self._get_field(f, b'IART')
#: 'ICMT' Comment
self.comment : Optional[str] = self._get_field(f, b'ICMT')
self.comment: Optional[str] = self._get_field(f, b'ICMT')
#: 'ISFT' Software, encoding application
self.software : Optional[str] = self._get_field(f, b'ISFT')
self.software: Optional[str] = self._get_field(f, b'ISFT')
#: 'ICRD' Created date
self.created_date : Optional[str] = self._get_field(f, b'ICRD')
self.created_date: Optional[str] = self._get_field(f, b'ICRD')
#: 'IENG' Engineer
self.engineer : Optional[str] = self._get_field(f, b'IENG')
self.engineer: Optional[str] = self._get_field(f, b'IENG')
#: 'ITCH' Technician
self.technician : Optional[str] = self._get_field(f, b'ITCH')
self.technician: Optional[str] = self._get_field(f, b'ITCH')
#: 'IKEY' Keywords, keyword list
self.keywords : Optional[str] = self._get_field(f, b'IKEY')
self.keywords: Optional[str] = self._get_field(f, b'IKEY')
#: 'INAM' Name, title
self.title : Optional[str] = self._get_field(f, b'INAM')
self.title: Optional[str] = self._get_field(f, b'INAM')
#: 'ISRC' Source
self.source : Optional[str] = self._get_field(f, b'ISRC')
self.source: Optional[str] = self._get_field(f, b'ISRC')
#: 'TAPE' Tape
self.tape : Optional[str] = self._get_field(f, b'TAPE')
self.tape: Optional[str] = self._get_field(f, b'TAPE')
#: 'IARL' Archival Location
self.archival_location : Optional[str] = self._get_field(f, b'IARL')
self.archival_location: Optional[str] = self._get_field(f, b'IARL')
#: 'ICSM' Commissioned
self.commissioned : Optional[str] = self._get_field(f, b'ICMS')
self.commissioned: Optional[str] = self._get_field(f, b'ICMS')
def _get_field(self, f, field_ident) -> Optional[str]:
search = next(((chunk.start, chunk.length) for chunk in self.info_chunk.children if chunk.ident == 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:
@@ -59,7 +65,7 @@ class WavInfoChunkReader:
else:
return None
def to_dict(self) -> dict: #FIXME should be asdict
def to_dict(self) -> dict: # FIXME should be asdict
"""
A dictionary with all of the key/values read from the INFO scope.
"""

View File

@@ -1,10 +1,16 @@
from lxml import etree as ET
import io
from collections import namedtuple
# from collections import namedtuple
from typing import Optional
from enum import IntEnum
from typing import NamedTuple
IXMLTrack = namedtuple('IXMLTrack', ['channel_index', 'interleave_index', 'name', 'function'])
class IXMLTrack(NamedTuple):
channel_index: int
interleave_index: int
name: str
function: str
class SteinbergMetadata:
@@ -29,7 +35,7 @@ class SteinbergMetadata:
CINE_71 = 27
SDDS_70 = 24
SDDS_71 = 26
MUSIC_60 = 21 #??
MUSIC_60 = 21 # ??
MUSIC_61 = 23
ATMOS_712 = 33
ATMOS_504 = 35
@@ -49,7 +55,7 @@ class SteinbergMetadata:
AURO_13_0 = 41
AURO_13_1 = 42
Steinberg_xpath = "//BWFXML/STEINBERG"
Steinberg_xpath = "./STEINBERG"
@classmethod
def present(cls, xml: ET.ElementTree) -> bool:
@@ -58,53 +64,64 @@ class SteinbergMetadata:
:param xml: an iXML ElementTree
"""
x = xml.find(cls.Steinberg_xpath)
return len(x) > 0
return x is not None
def __init__(self, xml: ET.ElementTree) -> None:
"""
Parse Steinberg iXML data.
:param xml: The entire iXML Tree
"""
self.parsed = xml.find("//BWFXML/STEINBERG")
self.parsed = xml.find(self.Steinberg_xpath)
@property
def audio_speaker_arrangement(self) -> Optional[AudioSpeakerArrangement]:
"""
`AudioSpeakerArrangement` property
"""
val = self.parsed.find("./ATTR_LIST/ATTR[NAME/text() = 'AudioSpeakerArrangement']/VALUE/text()")
if len(val) > 0:
return type(self).AudioSpeakerArrangement(int(val[0]))
else:
return None
val = self.parsed.find(
"./ATTR_LIST/ATTR[NAME = 'AudioSpeakerArrangement']/VALUE")
if val is not None:
return type(self).AudioSpeakerArrangement(int(val.text))
@property
def sample_format_size(self) -> Optional[int]:
"""
AudioSampleFormatSize
"""
pass
val = self.parsed.find(
"./ATTR_LIST/ATTR[NAME = 'AudioSampleFormatSize']/VALUE")
if val is not None:
return int(val.text)
@property
def media_company(self) -> Optional[str]:
"""
MediaCompany
"""
pass
val = self.parsed.find(
"./ATTR_LIST/ATTR[NAME = 'MediaCompany']/VALUE")
if val is not None:
return val.text
@property
def media_drop_frames(self) -> Optional[bool]:
"""
MediaDropFrames
"""
pass
val = self.parsed.find(
"./ATTR_LIST/ATTR[NAME = 'MediaDropFrames']/VALUE")
if val is not None:
return val.text == "1"
@property
def media_duration(self) -> Optional[float]:
"""
MediaDuration
"""
pass
val = self.parsed.find(
"./ATTR_LIST/ATTR[NAME = 'MediaDuration']/VALUE")
if val is not None:
return float(val.text)
@property
def media_start_time(self) -> Optional[float]:
@@ -139,6 +156,7 @@ class WavIXMLFormat:
"""
iXML recorder metadata.
"""
def __init__(self, xml):
"""
Parse iXML.
@@ -147,13 +165,13 @@ class WavIXMLFormat:
self.source = xml
xml_bytes = io.BytesIO(xml)
parser = ET.XMLParser(recover=True)
self.parsed : ET.ElementTree = ET.parse(xml_bytes, parser=parser)
self.parsed: ET.ElementTree = ET.parse(xml_bytes, parser=parser)
def _get_text_value(self, xpath) -> Optional[str]:
e = self.parsed.find("./" + xpath)
if e is not None:
return e.text
else:
else:
return None
def xml_str(self) -> str:
@@ -175,10 +193,13 @@ class WavIXMLFormat:
"""
for track in self.parsed.find("./TRACK_LIST").iter():
if track.tag == 'TRACK':
yield IXMLTrack(channel_index=track.xpath('string(CHANNEL_INDEX/text())'),
interleave_index=track.xpath('string(INTERLEAVE_INDEX/text())'),
name=track.xpath('string(NAME/text())'),
function=track.xpath('string(FUNCTION/text())'))
yield IXMLTrack(
channel_index=track.xpath('string(CHANNEL_INDEX/text())'),
interleave_index=track.xpath(
'string(INTERLEAVE_INDEX/text())'),
name=track.xpath('string(NAME/text())'),
function=track.xpath('string(FUNCTION/text())')
)
@property
def project(self) -> Optional[str]:
@@ -195,7 +216,7 @@ class WavIXMLFormat:
return self._get_text_value("SCENE")
@property
def take(self) -> Optional[str]:
def take(self) -> Optional[str]:
"""
Take number.
"""
@@ -212,7 +233,8 @@ class WavIXMLFormat:
def family_uid(self) -> Optional[str]:
"""
The globally-unique ID for this file family. This may be in the format
of a GUID, or an EBU Rec 9 source identifier, or some other dumb number.
of a GUID, or an EBU Rec 9 source identifier, or some other dumb
number.
"""
return self._get_text_value("FILE_SET/FAMILY_UID")
@@ -234,11 +256,8 @@ class WavIXMLFormat:
return None
def to_dict(self):
return dict(track_list=list(map(lambda x: x._asdict(), self.track_list)),
project=self.project,
scene=self.scene,
take=self.take,
tape=self.tape,
family_uid=self.family_uid,
family_name=self.family_name
)
return dict(
track_list=list(map(lambda x: x._asdict(), self.track_list)),
project=self.project, scene=self.scene, take=self.take,
tape=self.tape, family_uid=self.family_uid,
family_name=self.family_name)

View File

@@ -1,9 +1,7 @@
#-*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
import struct
import os
from collections import namedtuple
from typing import Optional, Generator, Any
from typing import Optional, Generator, Any, NamedTuple
import pathlib
@@ -13,82 +11,94 @@ from .wave_bext_reader import WavBextReader
from .wave_info_reader import WavInfoChunkReader
from .wave_adm_reader import WavADMReader
from .wave_dbmd_reader import WavDolbyMetadataReader
from .wave_cues_reader import WavCuesReader
#: Calculated statistics about the audio data.
WavDataDescriptor = namedtuple('WavDataDescriptor', 'byte_count frame_count')
class WavDataDescriptor(NamedTuple):
byte_count: int
frame_count: int
#: The format of the audio samples.
WavAudioFormat = namedtuple('WavAudioFormat',
'audio_format channel_count sample_rate byte_rate block_align bits_per_sample')
class WavAudioFormat(NamedTuple):
audio_format: int
channel_count: int
sample_rate: int
byte_rate: int
block_align: int
bits_per_sample: int
class WavInfoReader:
"""
Parse a WAV audio file for metadata.
"""
def __init__(self, path, info_encoding='latin_1', bext_encoding='ascii'):
"""
Create a new reader object.
:param path:
A pathlike object or IO to the wav file you wish to probe or a
:param path:
A pathlike object or IO to the wav file you wish to probe or a
file handle to an open file.
: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 info_encoding:
The text encoding of the ``INFO``, ``LABL`` and other RIFF-defined
metadata fields.
:param bext_encoding:
: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 weirdo.
"""
self.info_encoding = info_encoding
self.bext_encoding = bext_encoding
#: Wave audio data format.
self.fmt :Optional[WavAudioFormat] = None
self.fmt: Optional[WavAudioFormat] = None
#: Statistics of the `data` section.
self.data :Optional[WavDataDescriptor] = None
self.data: Optional[WavDataDescriptor] = None
#: Broadcast-Wave metadata.
self.bext :Optional[WavBextReader] = None
self.bext: Optional[WavBextReader] = None
#: iXML metadata.
self.ixml :Optional[WavIXMLFormat] = None
self.ixml: Optional[WavIXMLFormat] = None
#: ADM Audio Definiton Model metadata.
self.adm :Optional[WavADMReader]= None
self.adm: Optional[WavADMReader] = None
#: Dolby bitstream metadata.
self.dolby :Optional[WavDolbyMetadataReader] = None
self.dolby: Optional[WavDolbyMetadataReader] = None
#: RIFF INFO metadata.
self.info :Optional[WavInfoChunkReader]= None
self.info: Optional[WavInfoChunkReader] = None
#: RIFF cues markers, labels, and notes.
self.cues: Optional[WavCuesReader] = None
if hasattr(path, 'read'):
self.get_wav_info(path)
self.url = 'about:blank'
self.path = repr(path)
else:
absolute_path = os.path.abspath(path)
#: `file://` url for the file.
self.url: pathlib.Path = pathlib.Path(absolute_path).as_uri()
self.url: str = pathlib.Path(absolute_path).as_uri()
self.path = absolute_path
with open(path, 'rb') as f:
self.get_wav_info(f)
with open(path, 'rb') as path:
self.get_wav_info(path)
def get_wav_info(self, wavfile):
chunks = parse_chunk(wavfile)
assert type(chunks) is ListChunkDescriptor
self.main_list = chunks.children
wavfile.seek(0)
@@ -96,44 +106,49 @@ class WavInfoReader:
self.fmt = self._get_format(wavfile)
self.bext = self._get_bext(wavfile, encoding=self.bext_encoding)
self.ixml = self._get_ixml(wavfile)
self.adm = self._get_adm(wavfile)
self.adm = self._get_adm(wavfile)
self.info = self._get_info(wavfile, encoding=self.info_encoding)
self.dolby = self._get_dbmd(wavfile)
self.cues = self._get_cue(wavfile)
self.data = self._describe_data()
def _find_chunk_data(self, ident, from_stream, default_none=False):
top_chunks = (chunk for chunk in self.main_list if type(chunk) is ChunkDescriptor and chunk.ident == ident)
chunk_descriptor = next(top_chunks, None) if default_none else next(top_chunks)
return chunk_descriptor.read_data(from_stream) if chunk_descriptor else None
def _find_chunk_data(self, ident, from_stream,
default_none=False) -> Optional[bytes]:
top_chunks = (chunk for chunk in self.main_list
if type(chunk) is ChunkDescriptor and
chunk.ident == ident)
chunk_descriptor = next(top_chunks, None) \
if default_none else next(top_chunks)
return chunk_descriptor.read_data(from_stream) \
if chunk_descriptor else None
def _find_list_chunk(self, signature) -> Optional[ListChunkDescriptor]:
top_chunks = (chunk for chunk in self.main_list
if type(chunk) is ListChunkDescriptor and
chunk.signature == signature)
return next(top_chunks, None)
def _describe_data(self):
data_chunk = next(c for c in self.main_list if type(c) is ChunkDescriptor and c.ident == b'data')
data_chunk = next(c for c in self.main_list
if type(c) is ChunkDescriptor and c.ident == b'data')
return WavDataDescriptor(byte_count=data_chunk.length,
frame_count=int(data_chunk.length / self.fmt.block_align))
assert isinstance(self.fmt, WavAudioFormat)
return WavDataDescriptor(
byte_count=data_chunk.length,
frame_count=int(data_chunk.length / self.fmt.block_align))
def _get_format(self, f):
fmt_data = self._find_chunk_data(b'fmt ', f)
assert fmt_data is not None, "Fmt data not found, not a valid wav file"
# The format chunk is
# audio_format U16
# channel_count U16
# sample_rate U32 Note an integer
# byte_rate U32 == SampleRate * NumChannels * BitsPerSample/8
# block_align U16 == NumChannels * BitsPerSample/8
# bits_per_sampl U16
packstring = "<HHIIHH"
rest_starts = struct.calcsize(packstring)
unpacked = struct.unpack(packstring, fmt_data[:rest_starts])
# 0x0001 WAVE_FORMAT_PCM PCM
# 0x0003 WAVE_FORMAT_IEEE_FLOAT IEEE float
# 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
# https://sno.phy.queensu.ca/~phil/exiftool/TagNames/RIFF.html
return WavAudioFormat(audio_format=unpacked[0],
channel_count=unpacked[1],
sample_rate=unpacked[2],
@@ -143,7 +158,8 @@ class WavInfoReader:
)
def _get_info(self, f, encoding):
finder = (chunk.signature for chunk in self.main_list if type(chunk) is ListChunkDescriptor)
finder = (chunk.signature for chunk in self.main_list
if type(chunk) is ListChunkDescriptor)
if b'INFO' in finder:
return WavInfoChunkReader(f, encoding)
@@ -155,26 +171,50 @@ class WavInfoReader:
def _get_adm(self, f):
axml = self._find_chunk_data(b'axml', f, default_none=True)
chna = self._find_chunk_data(b'chna', f, default_none=True)
return WavADMReader(axml_data=axml, chna_data=chna) if axml and chna else None
return WavADMReader(axml_data=axml, chna_data=chna) \
if axml and chna else None
def _get_dbmd(self, f):
dbmd_data = self._find_chunk_data(b'dbmd', f, default_none=True)
return WavDolbyMetadataReader(dbmd_data=dbmd_data) if dbmd_data else None
return WavDolbyMetadataReader(dbmd_data=dbmd_data) \
if dbmd_data else None
def _get_ixml(self, f):
ixml_data = self._find_chunk_data(b'iXML', f, default_none=True)
return WavIXMLFormat(ixml_data.rstrip(b'\0')) if ixml_data else None
def walk(self) -> Generator[str,str,Any]: #FIXME: this should probably be named "iter()"
def _get_cue(self, f):
cue = next((cue_chunk for cue_chunk in self.main_list if
type(cue_chunk) is ChunkDescriptor and
cue_chunk.ident == b'cue '), None)
adtl = self._find_list_chunk(b'adtl')
labls = []
ltxts = []
notes = []
if adtl is not None:
labls = [c for c in adtl.children
if type(c) is ChunkDescriptor and c.ident == b'labl']
ltxts = [c for c in adtl.children
if type(c) is ChunkDescriptor and c.ident == b'ltxt']
notes = [c for c in adtl.children
if type(c) is ChunkDescriptor and c.ident == b'note']
return WavCuesReader.read_all(f, cue, labls, ltxts, notes,
fallback_encoding=self.info_encoding)
# FIXME: this should probably be named "iter()"
def walk(self) -> Generator[str, str, Any]:
"""
Walk all of the available metadata fields.
:yields: tuples of the *scope*, *key*, and *value* of
each metadatum. The *scope* value will be one of
"fmt", "data", "ixml", "bext", "info", "dolby", or "adm".
"fmt", "data", "ixml", "bext", "info", "dolby", "cues" or "adm".
"""
scopes = ('fmt', 'data', 'ixml', 'bext', 'info', 'adm', 'dolby')
scopes = ('fmt', 'data', 'ixml', 'bext', 'info', 'adm', 'cues',
'dolby')
for scope in scopes:
if scope in ['fmt', 'data']:
@@ -183,9 +223,12 @@ class WavInfoReader:
yield scope, field, attr.__getattribute__(field)
else:
dict = self.__getattribute__(scope).to_dict() if self.__getattribute__(scope) else {}
dict = self.__getattribute__(scope).to_dict(
) if self.__getattribute__(scope) else {}
for key in dict.keys():
yield scope, key, dict[key]
def __repr__(self):
return 'WavInfoReader({}, {}, {})'.format(self.path, self.info_encoding, self.bext_encoding)
return 'WavInfoReader({}, {}, {})'.format(self.path,
self.info_encoding,
self.bext_encoding)

View File

@@ -9,23 +9,24 @@ import sys
def main():
parser = OptionParser()
parser.usage = "wavfind [--scene=SCENE] [--take=TAKE] [--desc=DESC] <PATH> +"
parser.usage = ("wavfind [--scene=SCENE] [--take=TAKE] [--desc=DESC] "
"<PATH> +")
primaries = OptionGroup(parser, title="Search Predicates",
description="Argument values can be globs, and are logically-AND'ed.")
description="Argument values can be globs, "
"and are logically-AND'ed.")
primaries.add_option("--scene",
help='Search for this scene',
metavar='SCENE')
primaries.add_option("--scene",
help='Search for this scene',
metavar='SCENE')
primaries.add_option("--take",
help='Search for this take',
metavar='TAKE')
help='Search for this take',
metavar='TAKE')
primaries.add_option("--desc",
help='Search descriptions',
metavar='DESC')
help='Search descriptions',
metavar='DESC')
(options, args) = parser.parse_args(sys.argv)