biquad 0.3__tar.gz → 0.5__tar.gz

{biquad-0.3 → biquad-0.5}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Juergen Hock
-
-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.
+MIT License
+
+Copyright (c) 2023 Juergen Hock
+
+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.

{biquad-0.3/src/python/biquad.egg-info → biquad-0.5}/PKG-INFO

@@ -1,86 +1,103 @@
-Metadata-Version: 2.1
-Name: biquad
-Version: 0.3
-Summary: Collection of alterable digital biquad filters for dynamic audio effect creation
-Home-page: https://github.com/jurihock/biquad
-Author: Juergen Hock
-Author-email: juergen.hock@jurihock.de
-License: MIT
-Keywords: digital,audio,signal,processing,dasp,dafx,effects,filter,equalizer,eq,biquad,frequency,phase,spectrum,algorithms,analysis,synthesis,c,cpp,python
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Education
-Classifier: Intended Audience :: Other Audience
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: C
-Classifier: Programming Language :: C++
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Artistic Software
-Classifier: Topic :: Education
-Classifier: Topic :: Multimedia :: Sound/Audio
-Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
-Classifier: Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# Alterable biquad filters
-
-![language](https://img.shields.io/badge/languages-C%2B%2B%20Python-blue)
-![license](https://img.shields.io/github/license/jurihock/biquad?color=green)
-![pypi](https://img.shields.io/pypi/v/biquad?color=gold)
-
-This is a collection of digital biquad filters whose parameters `frequency` and `quality` can be varied at runtime. Following filter implementations are available:
-
-- Allpass
-- Bandpass
-- Highpass
-- Lowpass
-- Highshelf
-- Lowshelf
-- Notch
-- Peak
-
-## Basic usage
-
-Filter with persistent configuration:
-
-```python
-import biquad
-import numpy as np
-
-# load audio samples somehow
-x, sr = np.zeros(...), 44100
-
-# create a filter of your choice
-f = biquad.bandpass(sr, f=sr/4, q=1)
-
-# process all audio samples
-y = f(x)
-```
-
-Filter with dynamic configuration:
-
-```python
-import biquad
-import numpy as np
-
-# load audio samples somehow
-x, sr = np.zeros(...), 44100
-
-# create a filter of your choice
-f = biquad.bandpass(sr)
-
-# create parameter modifications as you like
-myf = np.linspace(1, sr/4, len(x))
-myq = np.linspace(2,  1/2, len(x))
-
-# process all audio samples
-y = f(x, f=myf, q=myq)
-```
-
-## See also
-
-[Cookbook formulae for audio equalizer biquad filter coefficients](https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html)
+Metadata-Version: 2.4
+Name: biquad
+Version: 0.5
+Summary: Collection of alterable digital biquad filters for dynamic audio effect creation
+Home-page: https://github.com/jurihock/biquad
+Author: Juergen Hock
+Author-email: juergen.hock@jurihock.de
+License: MIT
+Keywords: digital,audio,signal,processing,dasp,dafx,effects,filter,equalizer,eq,biquad,frequency,phase,spectrum,algorithms,analysis,synthesis,c,cpp,python
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Other Audience
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: C
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Artistic Software
+Classifier: Topic :: Education
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numba
+Requires-Dist: numpy
+Provides-Extra: plot
+Requires-Dist: matplotlib; extra == "plot"
+Dynamic: license-file
+
+# Alterable biquad filters
+
+![language](https://img.shields.io/badge/languages-C%2B%2B%20Python-blue)
+![license](https://img.shields.io/github/license/jurihock/biquad?color=green)
+![pypi](https://img.shields.io/pypi/v/biquad?color=gold)
+
+This is a collection of [digital biquad filters](https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html) whose parameters `f` (frequency in *Hz*), `g` (gain in *dB*) and `q` (quality) can be varied at runtime. Following [DF1](https://ccrma.stanford.edu/~jos/fp/Direct_Form_I.html) filter implementations are available:
+
+- Allpass
+- Bandpass
+- Highpass
+- Lowpass
+- Highshelf
+- Lowshelf
+- Notch
+- Peak
+
+## Basic usage
+
+Filter with static configuration:
+
+```python
+import biquad
+import numpy as np
+
+# load audio samples somehow
+x, sr = np.zeros(...), 44100
+
+# create a filter of your choice
+f = biquad.bandpass(sr, f=sr/4, q=1)
+
+# process all audio samples
+y = f(x)
+```
+
+Filter with dynamic configuration:
+
+```python
+import biquad
+import numpy as np
+
+# load audio samples somehow
+x, sr = np.zeros(...), 44100
+
+# create a filter of your choice
+f = biquad.bandpass(sr)
+
+# create parameter modifications as you like
+myf = np.linspace(1, sr/4, len(x))
+myq = np.linspace(2,  1/2, len(x))
+
+# process all audio samples
+y = f(x, f=myf, q=myq)
+```
+
+Keep in mind:
+
+- All filters have a default value for the persistent parameters `g` and `q`, which is set in the particular `__init__` method.
+- Parameter `f` must be set either in the `__init__` or in the `__call__` method.
+- The optional instantaneous parameters `f`, `g` and `q`, if specified in the `__call__` method, override the persistent ones. 
+
+## References
+
+1. <span id="1">[Cookbook formulae for audio EQ biquad filter coefficients](https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html) by Robert Bristow-Johnson</span>
+2. <span id="2">[Introduction to Digital Filters with Audio Applications](https://ccrma.stanford.edu/~jos/filters/filters.html) by Julius O. Smith III</span>
+
+## License
+
+[github.com/jurihock/biquad](https://github.com/jurihock/biquad) is licensed under the terms of the MIT license.
+For details please refer to the accompanying [LICENSE](https://github.com/jurihock/biquad/raw/main/LICENSE) file distributed with it.

biquad-0.5/README.md

@@ -0,0 +1,70 @@
+# Alterable biquad filters
+
+![language](https://img.shields.io/badge/languages-C%2B%2B%20Python-blue)
+![license](https://img.shields.io/github/license/jurihock/biquad?color=green)
+![pypi](https://img.shields.io/pypi/v/biquad?color=gold)
+
+This is a collection of [digital biquad filters](https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html) whose parameters `f` (frequency in *Hz*), `g` (gain in *dB*) and `q` (quality) can be varied at runtime. Following [DF1](https://ccrma.stanford.edu/~jos/fp/Direct_Form_I.html) filter implementations are available:
+
+- Allpass
+- Bandpass
+- Highpass
+- Lowpass
+- Highshelf
+- Lowshelf
+- Notch
+- Peak
+
+## Basic usage
+
+Filter with static configuration:
+
+```python
+import biquad
+import numpy as np
+
+# load audio samples somehow
+x, sr = np.zeros(...), 44100
+
+# create a filter of your choice
+f = biquad.bandpass(sr, f=sr/4, q=1)
+
+# process all audio samples
+y = f(x)
+```
+
+Filter with dynamic configuration:
+
+```python
+import biquad
+import numpy as np
+
+# load audio samples somehow
+x, sr = np.zeros(...), 44100
+
+# create a filter of your choice
+f = biquad.bandpass(sr)
+
+# create parameter modifications as you like
+myf = np.linspace(1, sr/4, len(x))
+myq = np.linspace(2,  1/2, len(x))
+
+# process all audio samples
+y = f(x, f=myf, q=myq)
+```
+
+Keep in mind:
+
+- All filters have a default value for the persistent parameters `g` and `q`, which is set in the particular `__init__` method.
+- Parameter `f` must be set either in the `__init__` or in the `__call__` method.
+- The optional instantaneous parameters `f`, `g` and `q`, if specified in the `__call__` method, override the persistent ones. 
+
+## References
+
+1. <span id="1">[Cookbook formulae for audio EQ biquad filter coefficients](https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html) by Robert Bristow-Johnson</span>
+2. <span id="2">[Introduction to Digital Filters with Audio Applications](https://ccrma.stanford.edu/~jos/filters/filters.html) by Julius O. Smith III</span>
+
+## License
+
+[github.com/jurihock/biquad](https://github.com/jurihock/biquad) is licensed under the terms of the MIT license.
+For details please refer to the accompanying [LICENSE](https://github.com/jurihock/biquad/raw/main/LICENSE) file distributed with it.

{biquad-0.3 → biquad-0.5}/pyproject.toml

@@ -1,3 +1,3 @@
-[build-system]
-requires = ["setuptools>=42", "wheel"]
-build-backend = "setuptools.build_meta"
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"

{biquad-0.3 → biquad-0.5}/setup.cfg

@@ -1,64 +1,68 @@
-[metadata]
-name = biquad
-version = attr: biquad.__version__
-author = Juergen Hock
-author_email = juergen.hock@jurihock.de
-url = https://github.com/jurihock/biquad
-description = Collection of alterable digital biquad filters for dynamic audio effect creation
-long_description = file: README.md
-long_description_content_type = text/markdown
-license = MIT
-license_file = LICENSE
-keywords = 
-	digital
-	audio
-	signal
-	processing
-	dasp
-	dafx
-	effects
-	filter
-	equalizer
-	eq
-	biquad
-	frequency
-	phase
-	spectrum
-	algorithms
-	analysis
-	synthesis
-	c
-	cpp
-	python
-classifiers = 
-	Intended Audience :: Developers
-	Intended Audience :: Education
-	Intended Audience :: Other Audience
-	Intended Audience :: Science/Research
-	License :: OSI Approved :: MIT License
-	Programming Language :: C
-	Programming Language :: C++
-	Programming Language :: Python :: 3
-	Topic :: Artistic Software
-	Topic :: Education
-	Topic :: Multimedia :: Sound/Audio
-	Topic :: Multimedia :: Sound/Audio :: Analysis
-	Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
-	Topic :: Scientific/Engineering
-	Topic :: Software Development :: Libraries
-
-[options]
-package_dir = 
-	= src/python
-packages = 
-	biquad
-python_requires = 
-	>= 3
-install_requires = 
-	numba
-	numpy
-
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[metadata]
+name = biquad
+version = attr: biquad.__version__
+author = Juergen Hock
+author_email = juergen.hock@jurihock.de
+url = https://github.com/jurihock/biquad
+description = Collection of alterable digital biquad filters for dynamic audio effect creation
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = MIT
+license_file = LICENSE
+keywords = 
+	digital
+	audio
+	signal
+	processing
+	dasp
+	dafx
+	effects
+	filter
+	equalizer
+	eq
+	biquad
+	frequency
+	phase
+	spectrum
+	algorithms
+	analysis
+	synthesis
+	c
+	cpp
+	python
+classifiers = 
+	Intended Audience :: Developers
+	Intended Audience :: Education
+	Intended Audience :: Other Audience
+	Intended Audience :: Science/Research
+	License :: OSI Approved :: MIT License
+	Programming Language :: C
+	Programming Language :: C++
+	Programming Language :: Python :: 3
+	Topic :: Artistic Software
+	Topic :: Education
+	Topic :: Multimedia :: Sound/Audio
+	Topic :: Multimedia :: Sound/Audio :: Analysis
+	Topic :: Multimedia :: Sound/Audio :: Sound Synthesis
+	Topic :: Scientific/Engineering
+	Topic :: Software Development :: Libraries
+
+[options]
+package_dir = 
+	= src/python
+packages = 
+	biquad
+python_requires = 
+	>= 3
+install_requires = 
+	numba
+	numpy
+
+[options.extras_require]
+plot = 
+	matplotlib
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

{biquad-0.3 → biquad-0.5}/src/python/biquad/__init__.py

@@ -1,55 +1,55 @@
-__version__ = "0.3"
-
-
-from .allpass   import allpass
-from .bandpass  import bandpass
-from .biquad    import biquad
-from .highpass  import highpass
-from .highshelf import highshelf
-from .lowpass   import lowpass
-from .lowshelf  import lowshelf
-from .notch     import notch
-from .peak      import peak
-
-
-def filter(name, sr, **kwargs):
-    """
-    Create a filter instance of the specified filter name.
-
-    Parameters
-    ----------
-    sr : int or float
-        Sample rate in hertz.
-    f : int or float, optional
-        Persistent filter frequency parameter in hertz.
-    q : int or float, optional
-        Persistent filter quality parameter.
-    """
-
-    name = str(name).lower()
-
-    if name in ['allpass', 'all', 'ap', 'apf']:
-        return allpass(sr, **kwargs)
-
-    if name in ['bandpass', 'band', 'bp', 'bpf']:
-        return bandpass(sr, **kwargs)
-
-    if name in ['highpass', 'high', 'hp', 'hpf']:
-        return highpass(sr, **kwargs)
-
-    if name in ['highshelf', 'hs', 'hsf']:
-        return highshelf(sr, **kwargs)
-
-    if name in ['lowpass', 'low', 'lp', 'lpf']:
-        return lowpass(sr, **kwargs)
-
-    if name in ['lowshelf', 'ls', 'lsf']:
-        return lowshelf(sr, **kwargs)
-
-    if name in ['notch', 'nf']:
-        return notch(sr, **kwargs)
-
-    if name in ['peak', 'pf']:
-        return peak(sr, **kwargs)
-
-    return biquad(sr, **kwargs)
+__version__ = "0.5"
+
+
+from .allpass   import allpass
+from .bandpass  import bandpass
+from .biquad    import biquad
+from .highpass  import highpass
+from .highshelf import highshelf
+from .lowpass   import lowpass
+from .lowshelf  import lowshelf
+from .notch     import notch
+from .peak      import peak
+
+
+def filter(name, sr, **kwargs):
+    """
+    Create a filter instance of the specified filter name.
+
+    Parameters
+    ----------
+    sr : int or float
+        Sample rate in hertz.
+    f : int or float, optional
+        Persistent filter frequency parameter in hertz.
+    q : int or float, optional
+        Persistent filter quality parameter.
+    """
+
+    name = str(name).lower()
+
+    if name in ['allpass', 'all', 'ap', 'apf']:
+        return allpass(sr, **kwargs)
+
+    if name in ['bandpass', 'band', 'bp', 'bpf']:
+        return bandpass(sr, **kwargs)
+
+    if name in ['highpass', 'high', 'hp', 'hpf']:
+        return highpass(sr, **kwargs)
+
+    if name in ['highshelf', 'hs', 'hsf']:
+        return highshelf(sr, **kwargs)
+
+    if name in ['lowpass', 'low', 'lp', 'lpf']:
+        return lowpass(sr, **kwargs)
+
+    if name in ['lowshelf', 'ls', 'lsf']:
+        return lowshelf(sr, **kwargs)
+
+    if name in ['notch', 'nf']:
+        return notch(sr, **kwargs)
+
+    if name in ['peak', 'pf']:
+        return peak(sr, **kwargs)
+
+    return biquad(sr, **kwargs)

{biquad-0.3 → biquad-0.5}/src/python/biquad/allpass.py

@@ -6,7 +6,7 @@ SPDX-License-Identifier: MIT
 Source: https://github.com/jurihock/biquad
 """
 
-from .biquad import biquad, __df1__
+from .biquad import biquad, __df1__, __gain__, __resize__
 
 import numba
 import numpy
@@ -17,7 +17,7 @@ class allpass(biquad):
     Allpass filter (APF).
     """
 
-    def __init__(self, sr, *, f=None, q=1):
+    def __init__(self, sr, f=None, g=0, q=1):
         """
         Create a new filter instance.
 
@@ -27,15 +27,17 @@ class allpass(biquad):
             Sample rate in hertz.
         f : int or float, optional
             Persistent filter frequency parameter in hertz.
+        g : int or float, optional
+            Persistent filter gain parameter in decibel.
         q : int or float, optional
             Persistent filter quality parameter.
         """
 
-        super().__init__(sr=sr, f=f, q=q)
+        super().__init__(sr=sr, f=f, g=g, q=q)
 
-        self.__call__(0, 1) # warmup numba
+        self.__call__(0) # warmup numba
 
-    def __call__(self, x, f=None, q=None):
+    def __call__(self, x, f=None, g=None, q=None):
         """
         Process single or multiple contiguous signal values at once.
 
@@ -45,6 +47,8 @@ class allpass(biquad):
             Filter input data.
         f : scalar or array like, optional
             Instantaneous filter frequency parameter in hertz.
+        g : scalar or array like, optional
+            Instantaneous filter gain parameter in decibel.
         q : scalar or array like, optional
             Instantaneous filter quality parameter.
 
@@ -62,21 +66,23 @@ class allpass(biquad):
         x = numpy.atleast_1d(x)
         y = numpy.zeros(x.shape, x.dtype)
 
-        f = numpy.atleast_1d(self.f if f is None else f)
-        q = numpy.atleast_1d(self.q if q is None else q)
-
-        f = numpy.resize(f, x.shape)
-        q = numpy.resize(q, x.shape)
+        f = __resize__(self.f if f is None else f, x.shape)
+        g = __resize__(self.g if g is None else __gain__(g), x.shape)
+        q = __resize__(self.q if q is None else q, x.shape)
 
         sr = self.sr
 
-        self.__filter__(ba, xy, x, y, f, q, sr)
+        self.__filter__(ba, xy, x, y, f, g, q, sr)
+
+        self.f = f[-1]
+        self.g = g[-1]
+        self.q = q[-1]
 
         return y[0] if scalar else y
 
     @staticmethod
     @numba.jit(nopython=True, fastmath=True)
-    def __filter__(ba, xy, x, y, f, q, sr):
+    def __filter__(ba, xy, x, y, f, g, q, sr):
 
         rs = 2 * numpy.pi / sr
 
@@ -87,18 +93,18 @@ class allpass(biquad):
             cosw = numpy.cos(w)
             sinw = numpy.sin(w)
 
-            c = -(2 * cosw)
-            p = sinw / (2 * q[i])
+            alpha = sinw / (+2 * q[i])
+            beta  = cosw * (-2)
 
             # update b
-            ba[0, 0] = 1 - p
-            ba[0, 1] =     c
-            ba[0, 2] = 1 + p
+            ba[0, 0] = 1 - alpha
+            ba[0, 1] =     beta
+            ba[0, 2] = 1 + alpha
 
             # update a
-            ba[1, 0] = 1 + p
-            ba[1, 1] =     c
-            ba[1, 2] = 1 - p
+            ba[1, 0] = 1 + alpha
+            ba[1, 1] =     beta
+            ba[1, 2] = 1 - alpha
 
             # update y
-            __df1__(ba, xy, x, y, i)
+            __df1__(g[i], ba, xy, x, y, i)