diff --git a/docs/source/conf.py b/docs/source/conf.py index 153c318..72e8486 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # @@ -15,15 +14,16 @@ # import importlib import os import sys -sys.path.insert(0, os.path.abspath('../../src')) + +sys.path.insert(0, os.path.abspath("../../src")) sys.path.insert(0, os.path.abspath("../../../src")) print(sys.path) # -- Project information ----------------------------------------------------- -project = u'wavinfo' -copyright = u'2018-2025, Jamie Hardt' -author = u'Jamie Hardt' +project = "wavinfo" +copyright = "2018-2025, Jamie Hardt" +author = "Jamie Hardt" # The short X.Y version version = "4.0" @@ -42,34 +42,34 @@ release = "4.0.0" # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', + "sphinx.ext.autodoc", + "sphinx.ext.todo", + "sphinx.ext.coverage", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = 'en' +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None @@ -80,7 +80,7 @@ pygments_style = None # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -91,7 +91,7 @@ html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -107,7 +107,7 @@ html_static_path = ['_static'] # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'wavinfodoc' +htmlhelp_basename = "wavinfodoc" # -- Options for LaTeX output ------------------------------------------------ @@ -116,15 +116,12 @@ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. # # 'preamble': '', - # Latex figure (float) alignment # # 'figure_align': 'htbp', @@ -134,8 +131,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'wavinfo.tex', u'wavinfo Documentation', - u'Jamie Hardt', 'manual'), + (master_doc, "wavinfo.tex", "wavinfo Documentation", "Jamie Hardt", "manual"), ] @@ -143,10 +139,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'wavinfo', u'wavinfo Documentation', - [author], 1) -] +man_pages = [(master_doc, "wavinfo", "wavinfo Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -155,9 +148,15 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'wavinfo', u'wavinfo Documentation', - author, 'wavinfo', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "wavinfo", + "wavinfo Documentation", + author, + "wavinfo", + "One line description of project.", + "Miscellaneous", + ), ] @@ -176,7 +175,7 @@ epub_title = project # epub_uid = '' # A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] +epub_exclude_files = ["search.html"] # -- Extension configuration ------------------------------------------------- diff --git a/examples/demo.ipynb b/examples/demo.ipynb index 7eaf2b6..cb39ae2 100644 --- a/examples/demo.ipynb +++ b/examples/demo.ipynb @@ -26,7 +26,7 @@ "source": [ "from wavinfo import WavInfoReader\n", "\n", - "path = '../tests/test_files/sounddevices/A101_1.WAV'\n", + "path = \"../tests/test_files/sounddevices/A101_1.WAV\"\n", "\n", "info = WavInfoReader(path)" ] @@ -113,7 +113,12 @@ } ], "source": [ - "(info.fmt.sample_rate, info.fmt.channel_count, info.fmt.block_align, info.fmt.bits_per_sample)" + "(\n", + " info.fmt.sample_rate,\n", + " info.fmt.channel_count,\n", + " info.fmt.block_align,\n", + " info.fmt.bits_per_sample,\n", + ")" ] }, { @@ -271,7 +276,9 @@ ], "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", + "info = WavInfoReader(\n", + " path, info_encoding=\"utf-8\"\n", + ") # 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", diff --git a/pyproject.toml b/pyproject.toml index 3c756db..c7d9909 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,7 @@ dependencies = [ [dependency-groups] dev = [ "pytest>=8.3.5", - "ruff>=0.14.0", + "ruff>=0.16.8", ] doc = [ "sphinx>=7.1.2", @@ -58,15 +58,30 @@ wavinfo = "wavinfo:__main__.main" [tool.pyright] typeCheckingMode = "basic" -[tool.pylint] -max-line-length = 88 -disable = [ - "C0103", # (invalid-name) - "C0114", # (missing-module-docstring) - "C0115", # (missing-class-docstring) - "C0116", # (missing-function-docstring) - "R0903", # (too-few-public-methods) - "R0913", # (too-many-arguments) - "W0105", # (pointless-string-statement) +[tool.ruff] +line-length = 88 +indent-width = 4 + +[tool.ruff.lint] +fixable = ['ALL'] +ignore = [ + 'FA100', #Add `from __future__ import annotations` to simplify `typing.Optional` + 'UP022', # Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE` + 'SIM115', # Use a context manager for opening files + 'UP031', #Use format specifiers instead of percent format + 'C408', # Unnecessary `dict()` call (rewrite as a literal) + 'C417' # Unnecessary `map()` usage (rewrite using a generator expression) ] +# [tool.pylint] +# max-line-length = 88 +# disable = [ +# "C0103", # (invalid-name) +# "C0114", # (missing-module-docstring) +# "C0115", # (missing-class-docstring) +# "C0116", # (missing-function-docstring) +# "R0903", # (too-few-public-methods) +# "R0913", # (too-many-arguments) +# "W0105", # (pointless-string-statement) +# ] + diff --git a/src/wavinfo/__init__.py b/src/wavinfo/__init__.py index 1e4cd8c..fd0ffcc 100644 --- a/src/wavinfo/__init__.py +++ b/src/wavinfo/__init__.py @@ -2,8 +2,7 @@ Probe WAVE Files for iXML, Broadcast-WAVE and other metadata. """ -__all__ = ['WavInfoReader', 'WavInfoEOFError'] +__all__ = ["WavInfoEOFError", "WavInfoReader"] -from .wave_reader import WavInfoReader from .riff_parser import WavInfoEOFError - +from .wave_reader import WavInfoReader diff --git a/src/wavinfo/__main__.py b/src/wavinfo/__main__.py index fe26f3f..43001a4 100644 --- a/src/wavinfo/__main__.py +++ b/src/wavinfo/__main__.py @@ -1,16 +1,16 @@ -from . import WavInfoReader - import datetime -from optparse import OptionParser -import sys -import os -import json -from enum import Enum import importlib.metadata +import json +import os +import sys from base64 import b64encode from cmd import Cmd +from enum import Enum +from optparse import OptionParser from shlex import split -from typing import List, Dict, Union +from typing import Dict, List, Union + +from . import WavInfoReader class MyJSONEncoder(json.JSONEncoder): @@ -18,7 +18,7 @@ class MyJSONEncoder(json.JSONEncoder): if isinstance(o, Enum): return o._name_ elif isinstance(o, bytes): - return 'base64:' + b64encode(o).decode('ascii') + return "base64:" + b64encode(o).decode("ascii") else: return super().default(o) @@ -31,7 +31,11 @@ class MetaBrowser(Cmd): prompt = "(wavinfo) " metadata: Union[List, Dict] - path: List[str] = [] + path: List[str] + + def preloop(self) -> None: + self.path = [] + return super().preloop() @property def cwd(self): @@ -50,7 +54,7 @@ class MetaBrowser(Cmd): if isinstance(val, int): print(f" - {key}: {val}") elif isinstance(val, str): - print(f" - {key}: \"{val}\"") + print(f' - {key}: "{val}"') elif isinstance(val, dict): print(f" - {key}: Dict ({len(val)} keys)") elif isinstance(val, list): @@ -63,7 +67,7 @@ class MetaBrowser(Cmd): print(f" - {key}: Unknown") def do_ls(self, _): - 'List items at the current node: LS' + "List items at the current node: LS" root = self.cwd if isinstance(root, list): @@ -91,10 +95,10 @@ class MetaBrowser(Cmd): else: print(f"Index {argv[0]} does not exist") elif isinstance(self.cwd, dict): - if argv[0] in self.cwd.keys(): + if argv[0] in self.cwd: self.path = self.path + [argv[0]] else: - print(f"Key \"{argv[0]}\" does not exist") + print(f'Key "{argv[0]}" does not exist') if len(self.path) > 0: self.prompt = "(" + "/".join(self.path) + ") " @@ -102,41 +106,40 @@ class MetaBrowser(Cmd): self.prompt = "(wavinfo) " def do_bye(self, _): - 'Exit the interactive browser: BYE' + "Exit the interactive browser: BYE" return True def main(): - version = importlib.metadata.version('wavinfo') + version = importlib.metadata.version("wavinfo") manpath = os.path.dirname(__file__) + "/man" parser = OptionParser() - parser.usage = 'wavinfo (--adm | --ixml) +' + parser.usage = "wavinfo (--adm | --ixml) +" # parser.add_option('--install-manpages', # help="Install manual pages for wavinfo", # default=False, # action='store_true') - parser.add_option('--man', - help="Read the manual and exit.", - default=False, - action='store_true') + parser.add_option( + "--man", help="Read the manual and exit.", default=False, action="store_true" + ) - 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" + ) - parser.add_option('-i', - help='Read metadata with an interactive prompt', - default=False, - action='store_true') + parser.add_option( + "-i", + help="Read metadata with an interactive prompt", + default=False, + action="store_true", + ) (options, args) = parser.parse_args(sys.argv) @@ -149,6 +152,7 @@ def main(): if options.man: import shlex + print("Which man page?") print("1) wavinfo usage") print("7) General info on Wave file metadata") @@ -176,29 +180,30 @@ def main(): raise MissingDataError("ixml") else: ret_dict = { - 'filename': arg, - 'run_date': datetime.datetime.now().isoformat(), - 'application': f"wavinfo {version}", - 'scopes': {} + "filename": arg, + "run_date": datetime.datetime.now( + tz=datetime.timezone.utc + ).isoformat(), + "application": f"wavinfo {version}", + "scopes": {}, } for scope, name, value in this_file.walk(): - if scope not in ret_dict['scopes'].keys(): - ret_dict['scopes'][scope] = {} + if scope not in ret_dict["scopes"]: + ret_dict["scopes"][scope] = {} - ret_dict['scopes'][scope][name] = value + ret_dict["scopes"][scope][name] = value if options.i: interactive_dict.append(ret_dict) else: - json.dump(ret_dict, cls=MyJSONEncoder, fp=sys.stdout, - indent=2) + 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 if len(interactive_dict) > 0: cli = MetaBrowser() diff --git a/src/wavinfo/rf64_parser.py b/src/wavinfo/rf64_parser.py index 5a46961..92d3937 100644 --- a/src/wavinfo/rf64_parser.py +++ b/src/wavinfo/rf64_parser.py @@ -1,6 +1,7 @@ import struct + # from collections import namedtuple -from typing import NamedTuple, Dict +from typing import Dict, NamedTuple from . import riff_parser @@ -10,38 +11,38 @@ class RF64Context(NamedTuple): bigchunk_table: Dict[str, int] -def parse_rf64(stream, signature=b'RF64') -> RF64Context: +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, \ + assert type(ds64_chunk) is riff_parser.ChunkDescriptor, ( f"Expected ds64 chunk here, found {type(ds64_chunk)}" + ) ds64_field_spec = "= 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) for _ in range(length_lookup_table): - bigname, bigsize = struct.unpack_from(chunksize64format, - ds64_data, - offset=ds64_fields_size) + bigname, bigsize = struct.unpack_from( + chunksize64format, ds64_data, offset=ds64_fields_size + ) bigchunk_table[bigname] = bigsize - bigchunk_table[b'data'] = data_size + bigchunk_table[b"data"] = data_size bigchunk_table[signature] = riff_size stream.seek(start, 0) - return RF64Context(sample_count=sample_count, - bigchunk_table=bigchunk_table) + return RF64Context(sample_count=sample_count, bigchunk_table=bigchunk_table) diff --git a/src/wavinfo/riff_parser.py b/src/wavinfo/riff_parser.py index 87ce6d9..ab317b3 100644 --- a/src/wavinfo/riff_parser.py +++ b/src/wavinfo/riff_parser.py @@ -1,7 +1,8 @@ # from optparse import Option import struct -from .rf64_parser import parse_rf64, RF64Context -from typing import NamedTuple, Union, List, Optional +from typing import List, NamedTuple, Optional, Union + +from .rf64_parser import RF64Context, parse_rf64 class WavInfoEOFError(EOFError): @@ -12,7 +13,7 @@ class WavInfoEOFError(EOFError): class ListChunkDescriptor(NamedTuple): signature: bytes - children: List[Union['ChunkDescriptor', 'ListChunkDescriptor']] + children: List[Union["ChunkDescriptor", "ListChunkDescriptor"]] class ChunkDescriptor(NamedTuple): @@ -48,14 +49,15 @@ def parse_chunk(stream, rf64_context=None): if len(ident) != 4 or len(size_bytes) != 4: raise WavInfoEOFError(identifier=ident, chunk_start=header_start) - data_size = struct.unpack(' 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 @@ -91,18 +93,19 @@ class WavBextReader: # umid_str = None - return {'description': self.description, - 'originator': self.originator, - 'originator_ref': self.originator_ref, - 'originator_date': self.originator_date, - 'originator_time': self.originator_time, - 'time_reference': self.time_reference, - 'version': self.version, - 'umid': self.umid, - 'coding_history': self.coding_history, - 'loudness_value': self.loudness_value, - 'loudness_range': self.loudness_range, - 'max_true_peak': self.max_true_peak, - 'max_momentary_loudness': self.max_momentary_loudness, - 'max_shortterm_loudness': self.max_shortterm_loudness - } + return { + "description": self.description, + "originator": self.originator, + "originator_ref": self.originator_ref, + "originator_date": self.originator_date, + "originator_time": self.originator_time, + "time_reference": self.time_reference, + "version": self.version, + "umid": self.umid, + "coding_history": self.coding_history, + "loudness_value": self.loudness_value, + "loudness_range": self.loudness_range, + "max_true_peak": self.max_true_peak, + "max_momentary_loudness": self.max_momentary_loudness, + "max_shortterm_loudness": self.max_shortterm_loudness, + } diff --git a/src/wavinfo/wave_cues_reader.py b/src/wavinfo/wave_cues_reader.py index 9d6cfac..fbe51b5 100644 --- a/src/wavinfo/wave_cues_reader.py +++ b/src/wavinfo/wave_cues_reader.py @@ -7,11 +7,12 @@ 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 +from dataclasses import dataclass +from struct import calcsize, unpack +from typing import Any, Dict, Generator, List, NamedTuple, Optional, Tuple + +from .riff_parser import ChunkDescriptor #: Country Codes used in the RIFF standard to resolve locale. These codes #: appear in CSET and LTXT metadata. @@ -100,6 +101,7 @@ 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 @@ -118,29 +120,37 @@ class CueEntry(NamedTuple): 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)}") + 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]) + 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(" 'WavCuesReader': - + 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) @@ -205,33 +223,31 @@ class WavCuesReader: cues_count = unpack(" Generator[Tuple[int, int], None, None]: """ @@ -242,8 +258,7 @@ class WavCuesReader: for cue in self.cues: yield (cue.name, cue.sample_offset) - def label_and_note(self, cue_ident: int) -> Tuple[Optional[str], - Optional[str]]: + def label_and_note(self, cue_ident: int) -> Tuple[Optional[str], Optional[str]]: """ Get the label and note (extended comment) for a cue. @@ -251,10 +266,10 @@ class WavCuesReader: :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) + 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]: @@ -264,23 +279,22 @@ class WavCuesReader: :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) + 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 + retval[n]["frame"] = t label, note = self.label_and_note(n) r = self.range(n) if label is not None: - retval[n]['label'] = label + retval[n]["label"] = label if note is not None: - retval[n]['note'] = note + retval[n]["note"] = note if r is not None: - retval[n]['length'] = r + retval[n]["length"] = r return retval diff --git a/src/wavinfo/wave_dbmd_reader.py b/src/wavinfo/wave_dbmd_reader.py index e255420..a25563f 100644 --- a/src/wavinfo/wave_dbmd_reader.py +++ b/src/wavinfo/wave_dbmd_reader.py @@ -7,18 +7,18 @@ Unless otherwise stated, all § references here are to .. _EBU Tech 3285 Supplement 6: https://tech.ebu.ch/docs/tech/tech3285s6.pdf """ -from enum import IntEnum, Enum -from struct import unpack -from dataclasses import dataclass, asdict -from typing import List, Tuple, Any, Union - +from dataclasses import asdict, dataclass +from enum import Enum, IntEnum from io import BytesIO +from struct import unpack +from typing import Any, List, Tuple, Union class SegmentType(IntEnum): """ Metadata segment type. """ + EndMarker = 0x0 DolbyE = 0x1 # Reserved2 = 0x2 @@ -29,7 +29,7 @@ class SegmentType(IntEnum): DolbyDigitalPlus = 0x7 AudioInfo = 0x8 DolbyAtmos = 0x9 - DolbyAtmosSupplemental = 0xa + DolbyAtmosSupplemental = 0xA @classmethod def _missing_(cls, val): @@ -82,6 +82,7 @@ class DolbyDigitalPlusMetadata: """ Dolby surround endcoding mode. """ + RESERVED = 0b11 IN_USE = 0b10 NOT_IN_USE = 0b01 @@ -126,6 +127,7 @@ class DolbyDigitalPlusMetadata: Dolby Digital Plus `acmod` field § 4.3.2.3 """ + RESERVED = 0b000 CH_ORD_1_0 = 0b001 "Mono" @@ -163,6 +165,7 @@ class DolbyDigitalPlusMetadata: Dolby Digital Plus `surmixlev` field § 4.3.3.2 """ + DOWN_3DB = 0b00 DOWN_6DB = 0b01 MUTE = 0b10 @@ -174,24 +177,22 @@ class DolbyDigitalPlusMetadata: Per ATSC/A52 § 5.4.2.12, this is not in use and always 0xFF. """ - 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 """ + NOT_INDICATED = 0b00 LARGE_ROOM_X_CURVE = 0b01 SMALL_ROOM_FLAT_CURVE = 0b10 @@ -203,6 +204,7 @@ class DolbyDigitalPlusMetadata: should downmix. § 4.3.8.1 """ + NOT_INDICATED = 0b00 PRO_LOGIC = 0b01 STEREO = 0b10 @@ -213,6 +215,7 @@ class DolbyDigitalPlusMetadata: Dolby Surround-EX mode. `dsurexmod` § 4.3.9.1 """ + NOT_INDICATED = 0b00 NOT_SEX = 0b01 SEX = 0b10 @@ -222,6 +225,7 @@ class DolbyDigitalPlusMetadata: """ `dheadphonmod` § 4.3.9.2 """ + NOT_INDICATED = 0b00 NOT_DOLBY_HEADPHONE = 0b01 DOLBY_HEADPHONE = 0b10 @@ -246,6 +250,7 @@ class DolbyDigitalPlusMetadata: `compr1` RF compression profile § 4.3.10 (fig 42) """ + NONE = 0 FILM_STANDARD = 1 FILM_LIGHT = 2 @@ -341,9 +346,11 @@ class DolbyDigitalPlusMetadata: return b def program_info(b): - return (b & 0x40) > 0, \ - DolbyDigitalPlusMetadata.BitStreamMode(b & 0x38 >> 3), \ - DolbyDigitalPlusMetadata.AudioCodingMode(b & 0x7) + return ( + (b & 0x40) > 0, + DolbyDigitalPlusMetadata.BitStreamMode(b & 0x38 >> 3), + DolbyDigitalPlusMetadata.AudioCodingMode(b & 0x7), + ) def ddplus_reserved1(_): pass @@ -351,39 +358,49 @@ class DolbyDigitalPlusMetadata: def surround_config(b): return ( DolbyDigitalPlusMetadata.CenterDownMixLevel(b & 0x30 >> 4), - DolbyDigitalPlusMetadata.SurroundDownMixLevel(b & 0xc >> 2), - DolbyDigitalPlusMetadata.DolbySurroundEncodingMode(b & 0x3) - ) + DolbyDigitalPlusMetadata.SurroundDownMixLevel(b & 0xC >> 2), + DolbyDigitalPlusMetadata.DolbySurroundEncodingMode(b & 0x3), + ) def dialnorm_info(b): - return (b & 0x80) > 0, b & 0x40 > 0, b & 0x20 > 0, \ - DolbyDigitalPlusMetadata.DialnormLevel(b & 0x1f) + return ( + (b & 0x80) > 0, + b & 0x40 > 0, + b & 0x20 > 0, + DolbyDigitalPlusMetadata.DialnormLevel(b & 0x1F), + ) def langcod(b) -> int: return b def audio_prod_info(b): - return (b & 0x80) > 0, \ - DolbyDigitalPlusMetadata.MixLevel(b & 0x7c >> 2), \ - DolbyDigitalPlusMetadata.RoomType(b & 0x3) + return ( + (b & 0x80) > 0, + DolbyDigitalPlusMetadata.MixLevel(b & 0x7C >> 2), + DolbyDigitalPlusMetadata.RoomType(b & 0x3), + ) # loro_center_downmix_level, loro_surround_downmix_level def ext_bsi1_word1(b): - return DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x38 >> 3), \ - DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x7) + 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), \ - DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x38 >> 3), \ - DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x7) + return ( + DolbyDigitalPlusMetadata.PreferredDownMixMode(b & 0xC0 >> 6), + DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x38 >> 3), + DolbyDigitalPlusMetadata.DownMixLevelToken(b & 0x7), + ) # 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) + return ( + DolbyDigitalPlusMetadata.SurroundEXMode(b & 0x60 >> 5), + DolbyDigitalPlusMetadata.HeadphoneMode(b & 0x18 >> 3), + DolbyDigitalPlusMetadata.ADConverterType(b & 0x4 >> 2), + ) def ddplus_reserved2(_): pass @@ -398,7 +415,7 @@ class DolbyDigitalPlusMetadata: pass def ddplus_info1(b): - return DolbyDigitalPlusMetadata.StreamDependency(b & 0xc >> 2) + return DolbyDigitalPlusMetadata.StreamDependency(b & 0xC >> 2) def ddplus_reserved4(_): pass @@ -412,19 +429,24 @@ 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]) @@ -436,32 +458,34 @@ class DolbyDigitalPlusMetadata: 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) + 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 @@ -488,7 +512,6 @@ class DolbyAtmosMetadata: @classmethod def load(cls, data: bytes): - assert len(data) == cls.SEGMENT_LENGTH # (f"DolbyAtmosMetadata segment is incorrect length, " # f"expected {cls.SEGMENT_LENGTH} actual was {len(data)}") @@ -498,7 +521,7 @@ class DolbyAtmosMetadata: h.seek(32, 1) toolname = h.read(cls.TOOL_NAME_LENGTH) toolname = unpack("%is" % cls.TOOL_NAME_LENGTH, toolname)[0] - toolname = toolname.decode('utf-8').strip('\0') + toolname = toolname.decode("utf-8").strip("\0") vers = h.read(3) major, minor, fix = unpack("BBB", vers) @@ -508,10 +531,11 @@ 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 @@ -531,15 +555,14 @@ class DolbyAtmosSupplementalMetadata: NOT_INDICATED = 0x04 object_count: int - render_modes: List['DolbyAtmosSupplementalMetadata.BinauralRenderMode'] + render_modes: List["DolbyAtmosSupplementalMetadata.BinauralRenderMode"] trim_modes: List[int] - MAGIC = 0xf8726fbd + MAGIC = 0xF8726FBD TRIM_CONFIG_COUNT = 9 @classmethod def load(cls, data: bytes): - trim_modes = [] render_modes = [] @@ -564,9 +587,9 @@ class DolbyAtmosSupplementalMetadata: binaural_mode &= 0x7 render_modes.append(binaural_mode) - return DolbyAtmosSupplementalMetadata(object_count=object_count, - render_modes=render_modes, - trim_modes=trim_modes) + return DolbyAtmosSupplementalMetadata( + object_count=object_count, render_modes=render_modes, trim_modes=trim_modes + ) class WavDolbyMetadataReader: @@ -589,9 +612,9 @@ class WavDolbyMetadataReader: retval = size for b in bs: retval += int(b) - retval &= 0xff + retval &= 0xFF - retval = ((~retval) + 1) & 0xff + retval = ((~retval) + 1) & 0xFF return retval @@ -614,8 +637,9 @@ class WavDolbyMetadataReader: else: seg_size = unpack(" 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]] + 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()) - return dict(dolby_digital_plus=list(ddp), - dolby_atmos=list(atmos)) + return dict(dolby_digital_plus=list(ddp), dolby_atmos=list(atmos)) diff --git a/src/wavinfo/wave_info_reader.py b/src/wavinfo/wave_info_reader.py index 34b9b96..9a9679d 100644 --- a/src/wavinfo/wave_info_reader.py +++ b/src/wavinfo/wave_info_reader.py @@ -1,10 +1,9 @@ -from .riff_parser import parse_chunk, ListChunkDescriptor - from typing import Optional +from .riff_parser import ListChunkDescriptor, parse_chunk + class WavInfoChunkReader: - def __init__(self, f, encoding): self.encoding = encoding @@ -12,56 +11,64 @@ class WavInfoChunkReader: 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.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), - None) + search = next( + ( + (chunk.start, chunk.length) + for chunk in self.info_chunk.children + if chunk.ident == field_ident + ), + None, + ) if search is not None: f.seek(search[0]) data = f.read(search[1]) - return data.decode(self.encoding).rstrip('\0') + return data.decode(self.encoding).rstrip("\0") else: return None @@ -69,26 +76,27 @@ class WavInfoChunkReader: """ A dictionary with all of the key/values read from the INFO scope. """ - return {'copyright': self.copyright, - 'product': self.product, - 'album': self.album, - 'genre': self.genre, - 'artist': self.artist, - 'comment': self.comment, - 'software': self.software, - 'created_date': self.created_date, - 'engineer': self.engineer, - 'keywords': self.keywords, - 'title': self.title, - 'source': self.source, - 'tape': self.tape, - 'commissioned': self.commissioned, - 'archival_location': self.archival_location, - 'subject': self.subject, - 'technician': self.technician - } + return { + "copyright": self.copyright, + "product": self.product, + "album": self.album, + "genre": self.genre, + "artist": self.artist, + "comment": self.comment, + "software": self.software, + "created_date": self.created_date, + "engineer": self.engineer, + "keywords": self.keywords, + "title": self.title, + "source": self.source, + "tape": self.tape, + "commissioned": self.commissioned, + "archival_location": self.archival_location, + "subject": self.subject, + "technician": self.technician, + } def __repr__(self): return_val = self.to_dict() - return_val.update({'encoding': self.encoding}) + return_val.update({"encoding": self.encoding}) return str(return_val) diff --git a/src/wavinfo/wave_ixml_reader.py b/src/wavinfo/wave_ixml_reader.py index 5f3b4df..1b66c59 100644 --- a/src/wavinfo/wave_ixml_reader.py +++ b/src/wavinfo/wave_ixml_reader.py @@ -1,10 +1,13 @@ -from lxml import etree as ET +from __future__ import annotations + import io -# from collections import namedtuple -from typing import Optional from enum import IntEnum + +# from collections import namedtuple from typing import NamedTuple +from lxml import etree as ET + class IXMLTrack(NamedTuple): channel_index: int @@ -22,6 +25,7 @@ class SteinbergMetadata: """ Steinberg speaker format enumeration. """ + MONO = 0 STEREO = 1 LRC = 10 @@ -74,82 +78,75 @@ class SteinbergMetadata: self.parsed = xml.find(self.Steinberg_xpath) @property - def audio_speaker_arrangement(self) -> Optional[AudioSpeakerArrangement]: + def audio_speaker_arrangement(self) -> AudioSpeakerArrangement | None: """ `AudioSpeakerArrangement` property """ val = self.parsed.find( - "./ATTR_LIST/ATTR[NAME = 'AudioSpeakerArrangement']/VALUE") + "./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]: + def sample_format_size(self) -> int | None: """ AudioSampleFormatSize """ - val = self.parsed.find( - "./ATTR_LIST/ATTR[NAME = 'AudioSampleFormatSize']/VALUE") + 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]: + def media_company(self) -> str | None: """ MediaCompany """ - val = self.parsed.find( - "./ATTR_LIST/ATTR[NAME = 'MediaCompany']/VALUE") + 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]: + def media_drop_frames(self) -> bool | None: """ MediaDropFrames """ - val = self.parsed.find( - "./ATTR_LIST/ATTR[NAME = 'MediaDropFrames']/VALUE") + 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]: + def media_duration(self) -> float | None: """ MediaDuration """ - val = self.parsed.find( - "./ATTR_LIST/ATTR[NAME = 'MediaDuration']/VALUE") + 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]: - """ - MediaStartTime - """ - pass + # @property + # def media_start_time(self) -> float | None: + # """ + # MediaStartTime + # """ - @property - def media_track_title(self) -> Optional[str]: - """ - MediaTrackTitle - """ - pass + # @property + # def media_track_title(self) -> str | None: + # """ + # MediaTrackTitle + # """ - @property - def program_name(self) -> Optional[str]: - """ - ProgramName - """ - pass + # @property + # def program_name(self) -> str | None: + # """ + # ProgramName + # """ - @property - def program_version(self) -> Optional[str]: - """ - ProgramVersion - """ - pass + # @property + # def program_version(self) -> str | None: + # """ + # ProgramVersion + # """ class WavIXMLFormat: @@ -167,7 +164,7 @@ class WavIXMLFormat: parser = ET.XMLParser(recover=True) self.parsed: ET.ElementTree = ET.parse(xml_bytes, parser=parser) - def _get_text_value(self, xpath) -> Optional[str]: + def _get_text_value(self, xpath) -> str | None: e = self.parsed.find("./" + xpath) if e is not None: return e.text @@ -192,45 +189,44 @@ class WavIXMLFormat: :yields: `IXMLTrack` for each track. """ for track in self.parsed.find("./TRACK_LIST").iter(): - if track.tag == 'TRACK': + 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())') + 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]: + def project(self) -> str | None: """ The project/film name entered for the recording. """ return self._get_text_value("PROJECT") @property - def scene(self) -> Optional[str]: + def scene(self) -> str | None: """ Scene/slate. """ return self._get_text_value("SCENE") @property - def take(self) -> Optional[str]: + def take(self) -> str | None: """ Take number. """ return self._get_text_value("TAKE") @property - def tape(self) -> Optional[str]: + def tape(self) -> str | None: """ Tape name. """ return self._get_text_value("TAPE") @property - def family_uid(self) -> Optional[str]: + def family_uid(self) -> str | None: """ 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 @@ -239,14 +235,14 @@ class WavIXMLFormat: return self._get_text_value("FILE_SET/FAMILY_UID") @property - def family_name(self) -> Optional[str]: + def family_name(self) -> str | None: """ The name of this file's file family. """ return self._get_text_value("FILE_SET/FAMILY_NAME") @property - def steinberg(self) -> Optional[SteinbergMetadata]: + def steinberg(self) -> SteinbergMetadata | None: """ Steinberg vendor iXML metadata if present. """ @@ -256,8 +252,12 @@ 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 { + "track_list": [x._asdict() for x in 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, + } diff --git a/src/wavinfo/wave_reader.py b/src/wavinfo/wave_reader.py index ca41c80..3691464 100644 --- a/src/wavinfo/wave_reader.py +++ b/src/wavinfo/wave_reader.py @@ -1,18 +1,17 @@ -# -*- coding: utf-8 -*- -import struct +from __future__ import annotations + import os -from typing import Optional, Generator, Any, NamedTuple - import pathlib +import struct +from typing import Any, Generator, NamedTuple - -from .riff_parser import parse_chunk, ChunkDescriptor, ListChunkDescriptor -from .wave_ixml_reader import WavIXMLFormat -from .wave_bext_reader import WavBextReader -from .wave_info_reader import WavInfoChunkReader +from .riff_parser import ChunkDescriptor, ListChunkDescriptor, parse_chunk from .wave_adm_reader import WavADMReader -from .wave_dbmd_reader import WavDolbyMetadataReader +from .wave_bext_reader import WavBextReader from .wave_cues_reader import WavCuesReader +from .wave_dbmd_reader import WavDolbyMetadataReader +from .wave_info_reader import WavInfoChunkReader +from .wave_ixml_reader import WavIXMLFormat from .wave_smpl_reader import WavSmplReader #: Calculated statistics about the audio data. @@ -38,7 +37,7 @@ class WavInfoReader: Parse a WAV audio file for metadata. """ - def __init__(self, path, info_encoding='latin_1', bext_encoding='ascii'): + def __init__(self, path, info_encoding="latin_1", bext_encoding="ascii"): """ Create a new reader object. @@ -60,35 +59,35 @@ class WavInfoReader: self.bext_encoding = bext_encoding #: Wave audio data format. - self.fmt: Optional[WavAudioFormat] = None + self.fmt: WavAudioFormat | None = None #: Statistics of the `data` section. - self.data: Optional[WavDataDescriptor] = None + self.data: WavDataDescriptor | None = None #: Broadcast-Wave metadata. - self.bext: Optional[WavBextReader] = None + self.bext: WavBextReader | None = None #: iXML metadata. - self.ixml: Optional[WavIXMLFormat] = None + self.ixml: WavIXMLFormat | None = None #: ADM Audio Definiton Model metadata. - self.adm: Optional[WavADMReader] = None + self.adm: WavADMReader | None = None #: Dolby bitstream metadata. - self.dolby: Optional[WavDolbyMetadataReader] = None + self.dolby: WavDolbyMetadataReader | None = None #: RIFF INFO metadata. - self.info: Optional[WavInfoChunkReader] = None + self.info: WavInfoChunkReader | None = None #: RIFF cues markers, labels, and notes. - self.cues: Optional[WavCuesReader] = None + self.cues: WavCuesReader | None = None #: Sampler `smpl` metadata - self.smpl: Optional[WavSmplReader] = None + self.smpl: WavSmplReader | None = None - if hasattr(path, 'read'): + if hasattr(path, "read"): self.get_wav_info(path) - self.url = 'about:blank' + self.url = "about:blank" self.path = repr(path) else: @@ -99,8 +98,8 @@ class WavInfoReader: self.path = absolute_path - with open(path, 'rb') as path: - self.get_wav_info(path) + with open(path, "rb") as file: + self.get_wav_info(file) def get_wav_info(self, wavfile): chunks = parse_chunk(wavfile) @@ -119,36 +118,41 @@ class WavInfoReader: self.smpl = self._get_sampler_loops(wavfile) self.data = self._describe_data() - 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) + def _find_chunk_data(self, ident, from_stream, default_none=False) -> bytes | None: + 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) + 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 + 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) + def _find_list_chunk(self, signature) -> ListChunkDescriptor | None: + 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" + ) assert isinstance(self.fmt, WavAudioFormat) return WavDataDescriptor( byte_count=data_chunk.length, - frame_count=int(data_chunk.length / self.fmt.block_align)) + frame_count=int(data_chunk.length / self.fmt.block_align), + ) def _get_format(self, f): - fmt_data = self._find_chunk_data(b'fmt ', 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" packstring = " 0: self.sampler_udata = smpl_data[ - header_size + loop_size * loop_count: - header_size + loop_size * loop_count + sampler_udata_length] + header_size + loop_size * loop_count : header_size + + loop_size * loop_count + + sampler_udata_length + ] def to_dict(self): return { - 'manufactuer': self.manufacturer, - 'product': self.product, - 'sample_period_ns': self.sample_period_ns, - 'midi_note': self.midi_note, - 'midi_pitch_detune_cents': self.midi_pitch_detune_cents, - 'smpte_format': self.smpte_format, - 'smpte_offset': "%02i:%02i:%02i:%02i" % self.smpte_offset, - 'loops': [x.to_dict() for x in self.sample_loops], - 'sampler_user_data': self.sampler_udata, + "manufactuer": self.manufacturer, + "product": self.product, + "sample_period_ns": self.sample_period_ns, + "midi_note": self.midi_note, + "midi_pitch_detune_cents": self.midi_pitch_detune_cents, + "smpte_format": self.smpte_format, + "smpte_offset": "%02i:%02i:%02i:%02i" % self.smpte_offset, + "loops": [x.to_dict() for x in self.sample_loops], + "sampler_user_data": self.sampler_udata, } diff --git a/src/wavinfo/wavfind.py b/src/wavinfo/wavfind.py index 0b2aedf..4181f3e 100644 --- a/src/wavinfo/wavfind.py +++ b/src/wavinfo/wavfind.py @@ -1,34 +1,30 @@ """ +wavfind.py +Under construction! Do Not Use! """ - -from optparse import OptionParser, OptionGroup import sys +from optparse import OptionGroup, OptionParser def main(): parser = OptionParser() - parser.usage = ("wavfind [--scene=SCENE] [--take=TAKE] [--desc=DESC] " - " +") + parser.usage = "wavfind [--scene=SCENE] [--take=TAKE] [--desc=DESC] +" - primaries = OptionGroup(parser, title="Search Predicates", - description="Argument values can be globs, " - "and are logically-AND'ed.") + primaries = OptionGroup( + parser, + title="Search Predicates", + 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') + primaries.add_option("--take", help="Search for this take", metavar="TAKE") - primaries.add_option("--desc", - help='Search descriptions', - metavar='DESC') + primaries.add_option("--desc", help="Search descriptions", metavar="DESC") - (options, args) = parser.parse_args(sys.argv) + (_options, _args) = parser.parse_args(sys.argv) if __name__ == "__main__": diff --git a/tests/__init__.py b/tests/__init__.py index 339ed45..e69de29 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -1,44 +0,0 @@ -from . import test_wave_parsing - -from io import BytesIO -from typing import Generator -import zipfile as zf -import os.path -import os -from contextlib import contextmanager - -# class TestFileLoader: -# """ -# This guy manages the test_files archive. -# """ - -# def __init__(self, test_file_arch_name = 'archive.zip') -> None: -# self.base_path = os.path.join(os.path.dirname(__file__), "test_files") -# self.test_file_arch_name = test_file_arch_name -# self._gather_test_files_into_archive() - -# @property -# def arch_path(self): -# return os.path.join(self.base_path, self.test_file_arch_name) - -# @contextmanager -# def open(self, name) -> Generator[BytesIO]: -# z = zf.ZipFile(self.arch_path, 'r') -# member = z.open(name, 'r') -# try: -# yield member -# finally: -# zf.close() - -# def _gather_test_files_into_archive(self): -# with zf.ZipFile(self.arch_path, 'a') as zip: -# for root, _, files in os.walk(self.base_path): -# for name in files: -# if root == self.base_path and name == self.test_file_arch_name: -# continue -# else: -# p = os.path.join(root, name) -# zip.write(p) -# os.unlink(p) - - diff --git a/tests/test_adm.py b/tests/test_adm.py index 9e9cbb5..7180c7a 100644 --- a/tests/test_adm.py +++ b/tests/test_adm.py @@ -2,8 +2,8 @@ from unittest import TestCase import wavinfo -class TestADMWave(TestCase): +class TestADMWave(TestCase): def setUp(self) -> None: self.protools_adm_wav = "tests/test_files/protools/Test_ADM_ProTools.wav" return super().setUp() @@ -24,7 +24,7 @@ class TestADMWave(TestCase): 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 @@ -32,8 +32,8 @@ class TestADMWave(TestCase): pdict = adm.programme() self.assertIn("programme_id", pdict.keys()) self.assertIn("programme_name", pdict.keys()) - self.assertEqual(pdict['programme_id'], 'APR_1001') - self.assertEqual(pdict['programme_name'], 'Atmos_Master') + self.assertEqual(pdict["programme_id"], "APR_1001") + self.assertEqual(pdict["programme_name"], "Atmos_Master") self.assertIn("contents", pdict.keys()) self.assertEqual(len(pdict["contents"]), 3) @@ -42,13 +42,14 @@ class TestADMWave(TestCase): adm = info.adm assert adm is not None t1 = adm.track_info(0) - self.assertTrue("channel_format_name" in t1.keys()) + assert t1 is not None + self.assertTrue("channel_format_name" in t1) self.assertEqual("RoomCentricLeft", t1["channel_format_name"]) - self.assertTrue("pack_format_name" in t1.keys()) + self.assertTrue("pack_format_name" in t1) self.assertEqual("AtmosCustomPackFormat1", t1["pack_format_name"]) t10 = adm.track_info(10) - self.assertTrue("content_name" in t10.keys()) + assert t10 is not None + self.assertTrue("content_name" in t10) self.assertEqual("Dialog", t10["content_name"]) - diff --git a/tests/test_cue.py b/tests/test_cue.py index 4c5e3fa..4d0a406 100644 --- a/tests/test_cue.py +++ b/tests/test_cue.py @@ -1,11 +1,12 @@ -from unittest import TestCase from glob import glob +from unittest import TestCase import wavinfo + class TestCue(TestCase): def setUp(self) -> None: - self.test_files = glob("tests/test_files/cue_chunks/*.wav") + self.test_files = glob("tests/test_files/cue_chunks/*.wav") return super().setUp() def test_enumerate(self): @@ -14,7 +15,7 @@ class TestCue(TestCase): 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)]) + self.assertEqual(vals, [(1, 29616), (2, 74592), (3, 121200)]) def test_labels_notes(self): file = "tests/test_files/cue_chunks/izotoperx_cues_test.wav" @@ -23,7 +24,7 @@ class TestCue(TestCase): assert w1.cues is not None for name, _ in w1.cues.each_cue(): - self.assertIn(name,[1,2,3]) + self.assertIn(name, [1, 2, 3]) label, note = w1.cues.label_and_note(name) if name == 1: self.assertEqual("Marker 1", label) @@ -35,18 +36,20 @@ class TestCue(TestCase): self.assertIsNotNone(w1.cues) assert w1.cues is not None - self.assertEqual(w1.cues.range(3), 10000) + 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 + 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 = ("Лорем ипсум долор сит амет, тимеам вивендум хас ет, " - "цу адолесценс дефинитионес еам.") + 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] @@ -56,20 +59,16 @@ class TestCue(TestCase): 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 + 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]) + 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") - - - - diff --git a/tests/test_dolby.py b/tests/test_dolby.py index 93793cc..89eb13d 100644 --- a/tests/test_dolby.py +++ b/tests/test_dolby.py @@ -1,7 +1,8 @@ from unittest import TestCase import wavinfo -from wavinfo.wave_dbmd_reader import SegmentType, DolbyDigitalPlusMetadata +from wavinfo.wave_dbmd_reader import DolbyDigitalPlusMetadata, SegmentType + class TestDolby(TestCase): def setUp(self): @@ -10,19 +11,17 @@ 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) + 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) @@ -40,21 +39,23 @@ class TestDolby(TestCase): 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.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) - 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" + ) diff --git a/tests/test_files/adm/test_bwf.wav b/tests/test_files/adm/test_bwf.wav new file mode 100644 index 0000000..e67e02d Binary files /dev/null and b/tests/test_files/adm/test_bwf.wav differ diff --git a/tests/test_main.py b/tests/test_main.py index e1474b0..683c3ba 100644 --- a/tests/test_main.py +++ b/tests/test_main.py @@ -1,34 +1,23 @@ +import glob +import sys 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_empty_argv(self): + with patch.object(sys, "argv", []): + main() 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") + with patch.object(sys, "argv", ["TEST", path]): + main() 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") + with patch.object( + sys, "argv", ["TEST", "--ixml", "tests/test_files/sounddevices/A101_1.WAV"] + ): + main() diff --git a/tests/test_rf64.py b/tests/test_rf64.py index e8f08de..abca12e 100644 --- a/tests/test_rf64.py +++ b/tests/test_rf64.py @@ -1,25 +1,22 @@ # import os.path import gzip from glob import glob -# from typing import Dict, Any, cast +# from typing import Dict, Any, cast from unittest import TestCase # from .utils import all_files, ffprobe - import wavinfo -class TestRf64(TestCase): +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) - diff --git a/tests/test_smpl.py b/tests/test_smpl.py index 0529440..ecec3bf 100644 --- a/tests/test_smpl.py +++ b/tests/test_smpl.py @@ -1,8 +1,9 @@ -from unittest import TestCase from glob import glob +from unittest import TestCase import wavinfo + class TestSmpl(TestCase): def setUp(self) -> None: self.test_files = glob("tests/test_files/smpl/*.wav") diff --git a/tests/test_walk.py b/tests/test_walk.py index 361766a..41d9661 100644 --- a/tests/test_walk.py +++ b/tests/test_walk.py @@ -1,37 +1,35 @@ +import glob import unittest + import wavinfo -import glob class TestWalk(unittest.TestCase): def test_walk_metadata(self): - test_file = 'tests/test_files/protools/PT A101_4.A1.wav' + test_file = "tests/test_files/protools/PT A101_4.A1.wav" info = wavinfo.WavInfoReader(test_file) - tested_data , tested_format = False, False + tested_data, tested_format = False, False for scope, key, value in info.walk(): - if scope == 'fmt': - if key == 'channel_count': + if scope == "fmt" and key == "channel_count": tested_format = True self.assertEqual(value, 2) - if scope == 'data': - if key == 'frame_count': + if scope == "data" and key == "frame_count": tested_data = True self.assertEqual(value, 144140) self.assertTrue(tested_data and tested_format) def test_walk_all(self): - for file in glob.glob('tests/test_files/**/*.wav'): + 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}") - + # try: + for _, _, _ in info.walk(): + pass + # except Exception as e: + # self.fail(f"Failed to walk metadata in file {file}: {e}") -if __name__ == '__main__': + +if __name__ == "__main__": unittest.main() diff --git a/tests/test_wave_parsing.py b/tests/test_wave_parsing.py index 39127cf..1804a84 100644 --- a/tests/test_wave_parsing.py +++ b/tests/test_wave_parsing.py @@ -1,21 +1,21 @@ import os.path from glob import glob -from typing import Dict, Any, cast - +from typing import Any, Dict, cast from unittest import TestCase -from .utils import all_files, ffprobe - import wavinfo +from .utils import all_files, ffprobe + 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__(), + f"WavInfoReader({os.path.abspath(wav_file)}, latin_1, ascii)", + ) self.assertIsNotNone(info) def test_fmt_against_ffprobe(self): @@ -26,31 +26,39 @@ class TestWaveInfo(TestCase): 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'] - )) + 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')) - streams = ffprobe_info['streams'][0] - byte_rate = int(streams['sample_rate']) * \ - streams['channels'] * \ - int(streams['bits_per_sample']) / 8 + 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 + ) 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 = cast(Dict[str,Any], ffprobe(wav_file)) + 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'])) + 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(): @@ -59,65 +67,78 @@ class TestWaveInfo(TestCase): 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']) + if "comment" in ffprobe_info["format"]["tags"]: + self.assertEqual( + info.bext.description, ffprobe_info["format"]["tags"]["comment"] + ) else: - self.assertEqual(info.bext.description, '') + self.assertEqual(info.bext.description, "") - if 'encoded_by' in ffprobe_info['format']['tags']: - self.assertEqual(info.bext.originator, - ffprobe_info['format']['tags']\ - ['encoded_by']) + if "encoded_by" in ffprobe_info["format"]["tags"]: + self.assertEqual( + info.bext.originator, + ffprobe_info["format"]["tags"]["encoded_by"], + ) else: - self.assertEqual(info.bext.originator, '') + 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']) + if "originator_reference" in ffprobe_info["format"]["tags"]: + self.assertEqual( + info.bext.originator_ref, + ffprobe_info["format"]["tags"]["originator_reference"], + ) else: - self.assertEqual(info.bext.originator_ref, '') + self.assertEqual(info.bext.originator_ref, "") # these don't always reflect the bext info - # self.assertEqual(info.bext.originator_date, + # self.assertEqual(info.bext.originator_date, # ffprobe_info['format']['tags']['date']) - # self.assertEqual(info.bext.originator_time, + # 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.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']) + if "coding_history" in ffprobe_info["format"]["tags"]: + self.assertEqual( + info.bext.coding_history, + ffprobe_info["format"]["tags"]["coding_history"], + ) else: - self.assertEqual(info.bext.coding_history, '') + 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(): basename = os.path.basename(wav_file) @@ -125,29 +146,31 @@ class TestWaveInfo(TestCase): 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) - self.assertEqual(e['tape'], info.ixml.tape) - self.assertEqual(e['family_uid'], info.ixml.family_uid) + 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) + self.assertEqual(e["tape"], info.ixml.tape) + self.assertEqual(e["family_uid"], info.ixml.family_uid) for track in info.ixml.track_list: self.assertIsNotNone(track.channel_index) - if basename == 'A101_4.WAV' and track.channel_index == '1': - self.assertEqual(track.name, 'MKH516 A') + if basename == "A101_4.WAV" and track.channel_index == "1": + self.assertEqual(track.name, "MKH516 A") def test_steinberg_ixml(self): - nuendo_files = 'tests/test_files/nuendo/*.wav' + nuendo_files = "tests/test_files/nuendo/*.wav" for file in glob(nuendo_files): info = wavinfo.WavInfoReader(file) - assert info.ixml is not None + 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.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) @@ -159,24 +182,21 @@ class TestWaveInfo(TestCase): self.assertIsNone(info.ixml.steinberg) def test_info_metadata(self): - file_with_metadata = \ - 'tests/test_files/sound_grinder_pro/new_camera bumb 1.wav' + 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') - self.assertEqual(info.product, 'Test Sounds') # album + self.assertEqual(info.title, "camera bumb 1") + self.assertEqual(info.artist, "Jamie Hardt") + self.assertEqual(info.copyright, "© 2010 Jamie Hardt") + self.assertEqual(info.product, "Test Sounds") # album self.assertEqual(info.album, info.product) - self.assertEqual(info.comment, 'Comments') - 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.title, 'camera bumb 1') + self.assertEqual(info.comment, "Comments") + 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.title, "camera bumb 1") self.assertEqual(type(info.to_dict()), dict) self.assertEqual(type(info.__repr__()), str) - diff --git a/tests/test_zoom_f8.py b/tests/test_zoom_f8.py index 5b09dc0..d8be22d 100644 --- a/tests/test_zoom_f8.py +++ b/tests/test_zoom_f8.py @@ -1,12 +1,6 @@ -import os.path -import sys -import json -import subprocess -from subprocess import PIPE - from unittest import TestCase -import wavinfo +# import wavinfo class TestZoomF8(TestCase): diff --git a/tests/utils.py b/tests/utils.py index 17ae284..0e0f847 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -1,38 +1,24 @@ +import json import os.path -import sys import subprocess from subprocess import PIPE -import json -FFPROBE = 'ffprobe' +FFPROBE = "ffprobe" def ffprobe(path): - arguments = [FFPROBE, "-of", "json", - "-show_format", "-show_streams", path] - if int(sys.version[0]) < 3: - process = subprocess.Popen(arguments, stdout=PIPE) - process.wait() - if process.returncode == 0: - output = process.communicate()[0] - if output: - output_str = output.decode('utf-8') - return json.loads(output_str) - else: - return None - else: - 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) - else: - return None + arguments = [FFPROBE, "-of", "json", "-show_format", "-show_streams", path] + process = subprocess.run(arguments, stdin=None, stdout=PIPE, stderr=PIPE, check=True) + if process.returncode == 0: + output_str = process.stdout.decode("utf-8") + return json.loads(output_str) + else: + return None def all_files(): - for dirpath, _, filenames in os.walk('tests/test_files'): + for dirpath, _, filenames in os.walk("tests/test_files"): for filename in filenames: _, ext = os.path.splitext(filename) - if ext in ['.wav', '.WAV']: + if ext in [".wav", ".WAV"]: yield os.path.join(dirpath, filename)