lupy 0.0.1__tar.gz

lupy-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Matthew Reid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lupy-0.0.1/LICENSE-SCIPY

@@ -0,0 +1,30 @@
+Copyright (c) 2001-2002 Enthought, Inc. 2003-2024, SciPy Developers.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above
+   copyright notice, this list of conditions and the following
+   disclaimer in the documentation and/or other materials provided
+   with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

lupy-0.0.1/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: lupy
+Version: 0.0.1
+Summary: Python library for Audio Loudness measurements
+Author-email: Matthew Reid <matt@nomadic-recording.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/nocarryr/lupy
+Project-URL: Documentation, https://lupy-nocarryr.readthedocs.io/
+Keywords: audio,loudness,r128,ebur128,bs1770,bs1771,tech3341,tech3342
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: LICENSE-SCIPY
+Requires-Dist: numpy<=2.4.4
+Requires-Dist: scipy<=1.17.1
+Requires-Dist: typing-extensions; python_version < "3.13"
+Dynamic: license-file
+
+lupy
+####
+
+Python library for `Audio Loudness`_ measurements.
+Yet another implementation of `ITU-R BS.1770`_, `ITU-R BS.1771`_,
+`EBU Tech 3341`_ and `EBU Tech 3342`_.
+
+
+Purpose
+=======
+
+This library provides a way to measure audio loudness and true peak measurements
+validated against the official EBU compliance test materials.
+
+Its design focuses more on real-time processing, using a block-based approach
+suitable for audio engines, rather than offline processing of entire audio files.
+
+
+
+Features
+========
+
+* Historical tracking of all measurements over time
+* Multi-channel audio support
+* Compliance-based validation of measurements
+
+
+Measurement Types
+-----------------
+
+* Integrated Loudness
+* Short-Term Loudness
+* Momentary Loudness
+* Loudness Range (LRA)
+* True Peak
+
+
+
+Compliance
+----------
+
+This library is validated against comprehensive compliance test cases based on
+the official EBU and ITU-R documents:
+
+`EBU Tech 3341`_
+  Integrated, Momentary, Short-Term and True Peak measurements
+
+`EBU Tech 3342`_
+  Loudness Range (LRA) measurements
+
+`ITU-R BS.2217`_
+  Integrated Loudness measurements for various channel configurations
+
+
+
+Installation
+============
+
+Pip
+---
+
+.. code-block:: bash
+
+  $ pip install lupy
+
+
+
+Dependencies
+============
+
+* numpy
+* scipy
+
+
+Project Links
+=============
+
+
+Homepage
+   https://github.com/nocarryr/lupy
+
+PyPI
+   https://pypi.org/project/lupy/
+
+Documentation
+   https://lupy-nocarryr.readthedocs.io/
+
+
+
+License
+=======
+
+This project is licensed under the MIT License - see the `LICENSE`_ file for details.
+
+
+Portions of the code (src/lupy/signalutils) are derived from the Scipy library, which is
+licensed under the BSD License.  See the `LICENSE-SCIPY`_ file for details.
+
+
+.. _Audio Loudness: https://tech.ebu.ch/loudness
+.. _ITU-R BS.1770: https://www.itu.int/rec/R-REC-BS.1770/en
+.. _ITU-R BS.1771: https://www.itu.int/rec/R-REC-BS.1771/en
+.. _EBU Tech 3341: https://tech.ebu.ch/publications/tech3341
+.. _EBU Tech 3342: https://tech.ebu.ch/publications/tech3342
+.. _ITU-R BS.2217: https://www.itu.int/pub/R-REP-BS.2217
+.. _LICENSE: LICENSE
+.. _LICENSE-SCIPY: LICENSE-SCIPY

lupy-0.0.1/README.rst

@@ -0,0 +1,107 @@
+lupy
+####
+
+Python library for `Audio Loudness`_ measurements.
+Yet another implementation of `ITU-R BS.1770`_, `ITU-R BS.1771`_,
+`EBU Tech 3341`_ and `EBU Tech 3342`_.
+
+
+Purpose
+=======
+
+This library provides a way to measure audio loudness and true peak measurements
+validated against the official EBU compliance test materials.
+
+Its design focuses more on real-time processing, using a block-based approach
+suitable for audio engines, rather than offline processing of entire audio files.
+
+
+
+Features
+========
+
+* Historical tracking of all measurements over time
+* Multi-channel audio support
+* Compliance-based validation of measurements
+
+
+Measurement Types
+-----------------
+
+* Integrated Loudness
+* Short-Term Loudness
+* Momentary Loudness
+* Loudness Range (LRA)
+* True Peak
+
+
+
+Compliance
+----------
+
+This library is validated against comprehensive compliance test cases based on
+the official EBU and ITU-R documents:
+
+`EBU Tech 3341`_
+  Integrated, Momentary, Short-Term and True Peak measurements
+
+`EBU Tech 3342`_
+  Loudness Range (LRA) measurements
+
+`ITU-R BS.2217`_
+  Integrated Loudness measurements for various channel configurations
+
+
+
+Installation
+============
+
+Pip
+---
+
+.. code-block:: bash
+
+  $ pip install lupy
+
+
+
+Dependencies
+============
+
+* numpy
+* scipy
+
+
+Project Links
+=============
+
+
+Homepage
+   https://github.com/nocarryr/lupy
+
+PyPI
+   https://pypi.org/project/lupy/
+
+Documentation
+   https://lupy-nocarryr.readthedocs.io/
+
+
+
+License
+=======
+
+This project is licensed under the MIT License - see the `LICENSE`_ file for details.
+
+
+Portions of the code (src/lupy/signalutils) are derived from the Scipy library, which is
+licensed under the BSD License.  See the `LICENSE-SCIPY`_ file for details.
+
+
+.. _Audio Loudness: https://tech.ebu.ch/loudness
+.. _ITU-R BS.1770: https://www.itu.int/rec/R-REC-BS.1770/en
+.. _ITU-R BS.1771: https://www.itu.int/rec/R-REC-BS.1771/en
+.. _EBU Tech 3341: https://tech.ebu.ch/publications/tech3341
+.. _EBU Tech 3342: https://tech.ebu.ch/publications/tech3342
+.. _ITU-R BS.2217: https://www.itu.int/pub/R-REP-BS.2217
+.. _LICENSE: LICENSE
+.. _LICENSE-SCIPY: LICENSE-SCIPY

lupy-0.0.1/pyproject.toml

@@ -0,0 +1,77 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "lupy"
+version = "0.0.1"
+authors = [
+    {name = "Matthew Reid", email = "matt@nomadic-recording.com"}
+]
+description = "Python library for Audio Loudness measurements"
+readme = "README.rst"
+license = "MIT"
+keywords = [
+    "audio", "loudness", "r128", "ebur128",
+    "bs1770", "bs1771", "tech3341", "tech3342"
+]
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Sound/Audio :: Analysis",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "numpy<=2.4.4",
+    "scipy<=1.17.1",
+    "typing-extensions; python_version<'3.13'"
+]
+
+[project.urls]
+Homepage = "https://github.com/nocarryr/lupy"
+Documentation = "https://lupy-nocarryr.readthedocs.io/"
+
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["tests*"]
+
+
+[tool.pytest.ini_options]
+addopts = "-n auto --dist=worksteal --doctest-modules"
+testpaths = ["tests", "src"]
+
+[dependency-groups]
+test = [
+    "pytest",
+    "pytest-xdist",
+    "pytest-codspeed",
+    "mypy>=1.19.1",
+    "scipy-stubs; python_version>='3.10'",
+]
+doc = [
+    "sphinx",
+    "furo",
+]
+dev = [
+    {include-group = "test"},
+    {include-group = "doc"},
+    "ipython",
+    "jupyterlab",
+    "matplotlib",
+]
+
+[tool.mypy]
+packages = "lupy"

lupy-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lupy-0.0.1/src/lupy/__init__.py

@@ -0,0 +1,3 @@
+from .sampling import *
+from .processing import *
+from .meter import *

lupy-0.0.1/src/lupy/arraytypes.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+from typing import Generic
+
+import numpy as np
+import numpy.typing as npt
+
+
+from .types import NumChannelsT
+
+__all__ = (
+    'MeterDtype', 'MeterArray', 'TruePeakDtype', 'TruePeakArray',
+)
+
+
+MeterDtype = np.dtype([
+    ('t', np.float64),
+    ('m', np.float64),
+    ('s', np.float64),
+])
+"""A :term:`structured data type` for loudness results
+
+.. attribute:: t
+    :type: numpy.float64
+
+    The time in seconds for each measurement
+
+.. attribute:: m
+    :type: numpy.float64
+
+    The :term:`Momentary Loudness` at time :attr:`t`
+
+.. attribute:: s
+    :type: numpy.float64
+
+    The :term:`Short-Term Loudness` at time :attr:`t`
+
+"""
+
+class TruePeakDtype(np.void, Generic[NumChannelsT]):
+    """A :term:`structured data type` for true peak results
+
+    .. attribute:: t
+        :type: numpy.float64
+
+        The time in seconds for each measurement
+
+    .. attribute:: tp
+        :type: tuple[numpy.float64, ...]
+
+        The :term:`True Peak` values per channel at time :attr:`t` as a :term:`subarray`
+        of length :obj:`NumChannelsT`
+
+    """
+
+
+class MeterArray(npt.NDArray[np.void]):
+    """Array with dtype :obj:`MeterDtype`
+    """
+    pass
+
+
+class TruePeakArray(npt.NDArray[np.void], Generic[NumChannelsT]):
+    """Array with dtype :obj:`TruePeakDtype`
+    """
+    pass

lupy-0.0.1/src/lupy/arraytypes.pyi

@@ -0,0 +1,48 @@
+# mypy: disable-error-code="override"
+from __future__ import annotations
+
+from typing import Generic, Literal, Any, Self, overload
+
+import numpy as np
+import numpy.typing as npt
+
+from lupy.types import Float1dArray, Float2dArray, NumChannelsT
+
+
+__all__ = (
+    'MeterDtype', 'MeterArray', 'TruePeakDtype', 'TruePeakArray',
+)
+
+MeterDtype = np.dtype([
+    ('t', np.float64),
+    ('m', np.float64),
+    ('s', np.float64),
+])
+
+class TruePeakDtype(np.void, Generic[NumChannelsT]): ... # type: ignore[misc]
+
+
+_MeterArrayFields = Literal['t', 'm', 's']
+
+
+class MeterArray(npt.NDArray[np.void]):
+    @overload
+    def __getitem__(self, key: int|slice[Any, Any, Any]) -> Self: ...
+    @overload
+    def __getitem__(self, key: _MeterArrayFields) -> Float1dArray: ...
+
+    def view(self, dtype: np.dtype|type[npt.NDArray[Any]]) -> Self: ...
+
+
+_TruePeakArrayFields = Literal['t', 'tp']
+
+
+class TruePeakArray(npt.NDArray[np.void], Generic[NumChannelsT]):
+    @overload
+    def __getitem__(self, key: int|slice[Any, Any, Any]) -> Self: ...
+    @overload
+    def __getitem__(self, key: Literal['t']) -> Float1dArray: ...
+    @overload
+    def __getitem__(self, key: Literal['tp']) -> np.ndarray[tuple[int, NumChannelsT], np.dtype[np.float64]]: ...
+
+    def view(self, dtype: np.dtype|type[npt.NDArray[Any]]) -> Self: ...