From b8617a35e2f6fbf1b26beeb1fa7769fcf1c347c3 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Mon, 25 Nov 2024 10:41:05 -0800 Subject: [PATCH 1/3] Fixing doc dependencies I think --- pyproject.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 19e7eda..a4a19f5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,8 +48,8 @@ wavinfo = 'wavinfo.__main__:main' [tool.poetry.dependencies] python = "^3.8" lxml = "~= 5.3.0" -sphinx_rtd_theme = {version= '>= 1.1.1', optional=true} -sphinx = {version= '>= 5.3.0', optional=true} +sphinx_rtd_theme = {version= '>= 1.1.1', optional=true, extras=['doc']} +sphinx = {version= '>= 5.3.0', optional=true, extras=['doc']} [tool.pyright] typeCheckingMode = "basic" From c6f66b2d6e2f1c4bb6586b551fed96885e139376 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Mon, 25 Nov 2024 10:48:58 -0800 Subject: [PATCH 2/3] Changes to fix docs --- docs/source/conf.py | 9 +++++---- docs/source/references.rst | 2 +- pyproject.toml | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 083c8fe..f540b15 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,24 +12,25 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # +import importlib import os import sys sys.path.insert(0, os.path.abspath('../..')) sys.path.insert(0, os.path.abspath("../../..")) print(sys.path) -import wavinfo +import importlib # -- Project information ----------------------------------------------------- project = u'wavinfo' -copyright = u'2018-2023, Jamie Hardt' +copyright = u'2018-2024, Jamie Hardt' author = u'Jamie Hardt' # The short X.Y version -version = wavinfo.__short_version__ +version = "3.1" # The full version, including alpha/beta/rc tags -release = wavinfo.__version__ +release = importlib.metadata.version("wavinfo") # -- General configuration --------------------------------------------------- diff --git a/docs/source/references.rst b/docs/source/references.rst index 4006cb2..0825069 100644 --- a/docs/source/references.rst +++ b/docs/source/references.rst @@ -39,7 +39,7 @@ iXML Sampler Metadata ---------------- -* `RecordingBlogs.com — Sample chunk (of a Wave file)`_ +* `RecordingBlogs.com — Sample chunk (of a Wave file) `_ RIFF Metadata ------------- diff --git a/pyproject.toml b/pyproject.toml index a4a19f5..19e7eda 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,8 +48,8 @@ wavinfo = 'wavinfo.__main__:main' [tool.poetry.dependencies] python = "^3.8" lxml = "~= 5.3.0" -sphinx_rtd_theme = {version= '>= 1.1.1', optional=true, extras=['doc']} -sphinx = {version= '>= 5.3.0', optional=true, extras=['doc']} +sphinx_rtd_theme = {version= '>= 1.1.1', optional=true} +sphinx = {version= '>= 5.3.0', optional=true} [tool.pyright] typeCheckingMode = "basic" From 299f79aeb3249af00cc3de672e9a7b79f83e1de0 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Mon, 25 Nov 2024 11:05:32 -0800 Subject: [PATCH 3/3] README update and stubbed out docs. --- README.md | 2 ++ docs/source/scopes/smpl.rst | 14 ++++++++++++++ pyproject.toml | 2 +- 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/source/scopes/smpl.rst diff --git a/README.md b/README.md index b9269f9..90c99f2 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ it is not supported, please submit an issue! 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. +* Wave embedded [sampler][smpl] and sample loop metadata. * The [wav format][format] is also parsed, so you can access the basic sample rate and channel count information. @@ -38,6 +39,7 @@ it is not supported, please submit an issue! [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 +[smpl]:https://wavinfo.readthedocs.io/en/latest/scopes/smpl.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 [ebu3285s6]:https://wavinfo.readthedocs.io/en/latest/scopes/dolby.html diff --git a/docs/source/scopes/smpl.rst b/docs/source/scopes/smpl.rst new file mode 100644 index 0000000..bd533c7 --- /dev/null +++ b/docs/source/scopes/smpl.rst @@ -0,0 +1,14 @@ + +Sampler Metadata +================= + +Class Reference +--------------- + +.. automodule:: wavinfo.wave_smpl_reader + +.. autoclass:: wavinfo.wave_smpl_reader.WavSmplReader + :members: + +.. autoclass:: wavinfo.wave_smpl_reader.WaveSmplLoop + :members: diff --git a/pyproject.toml b/pyproject.toml index 19e7eda..511e7ac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "wavinfo" -version = "3.0.1" +version = "3.1.0" description = "Probe WAVE files for all metadata" authors = ["Jamie Hardt "] license = "MIT"