biquad 0.3__py3-none-any.whl → 0.5__py3-none-any.whl

biquad/peak.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 peak(biquad):
     Peaking EQ filter.
     """
 
-    def __init__(self, sr, gain=6, *, f=None, q=1):
+    def __init__(self, sr, f=None, g=6, q=1):
         """
         Create a new filter instance.
 
@@ -25,22 +25,21 @@ class peak(biquad):
         ----------
         sr : int or float
             Sample rate in hertz.
-        gain : int or float, optional
-            Filter peak gain value in decibel.
         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.gain = gain
-        self.amp = 10 ** (gain / 40)
+        self.g = __gain__(g, 40)
 
-        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.
 
@@ -50,6 +49,8 @@ class peak(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.
 
@@ -67,22 +68,23 @@ class peak(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, 40), x.shape)
+        q = __resize__(self.q if q is None else q, x.shape)
 
         sr = self.sr
-        amp = self.amp
 
-        self.__filter__(ba, xy, x, y, f, q, sr, amp)
+        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, amp):
+    def __filter__(ba, xy, x, y, f, g, q, sr):
 
         rs = 2 * numpy.pi / sr
 
@@ -93,21 +95,19 @@ class peak(biquad):
             cosw = numpy.cos(w)
             sinw = numpy.sin(w)
 
-            c = -(2 * cosw)
-            p = sinw / (2 * q[i])
-
-            m = p * amp
-            d = p / amp
+            alpha = sinw / (+2 * q[i])
+            beta  = cosw * (-2)
+            gamma = 1 / g[i]
 
             # update b
-            ba[0, 0] = 1 + m
-            ba[0, 1] =     c
-            ba[0, 2] = 1 - m
+            ba[0, 0] = gamma + alpha
+            ba[0, 1] = gamma * beta
+            ba[0, 2] = gamma - alpha
 
             # update a
-            ba[1, 0] = 1 + d
-            ba[1, 1] =     c
-            ba[1, 2] = 1 - d
+            ba[1, 0] = 1 + alpha * gamma
+            ba[1, 1] =     beta
+            ba[1, 2] = 1 - alpha * gamma
 
             # update y
-            __df1__(ba, xy, x, y, i)
+            __df1__(g[i], ba, xy, x, y, i)

{biquad-0.3.dist-info → biquad-0.5.dist-info}/METADATA

@@ -1,88 +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
-Requires-Dist: numba
-Requires-Dist: numpy
-
-# 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.dist-info/RECORD

@@ -0,0 +1,15 @@
+biquad/__init__.py,sha256=lJlcLKlrtWmWduV82lyu7l6C4BEWo_d_yko4tXPsxEs,1421
+biquad/allpass.py,sha256=T9iANDZ-xutExvC8HzBxInT1t0Ns_FUUhzuu3mWpdHk,2813
+biquad/bandpass.py,sha256=n3A3Fgo_b1-ijqh2bp2vQiC4FpxN-vJc-U8gplUjV8Y,3141
+biquad/biquad.py,sha256=0F1A2ITPOi5K53v4b6ZZrCOj1vhW1yJ5N_ctsY7LIa8,7299
+biquad/highpass.py,sha256=xZEZAZ5b50kzs_0yvMAekykrRXiFjxXS3Gv-DB-V5p0,2826
+biquad/highshelf.py,sha256=OefPSr9_sp7wi8iAM_WGY-QwUf63VMmqvUuX7ZuxU5g,3050
+biquad/lowpass.py,sha256=PT02sbclZWVG8IdV7OmlbsTDzHhp2FdLMEKCMkacaKA,2824
+biquad/lowshelf.py,sha256=neHqS1pfz0AcO9SgLn6R1iX5eKI-_-Ly6jseCqGTt6s,3048
+biquad/notch.py,sha256=Cl_aja0m_JMLS6jP5Exo5YsE0N5fB54BmH54k6_hbBQ,2784
+biquad/peak.py,sha256=Rodqhlgr0r63gE5luht5uBN24iczaQ84qPzM4hpoPI0,2905
+biquad-0.5.dist-info/licenses/LICENSE,sha256=JRS0dwoeKyDdxU93F1NzI806Zua2CgWaew0T77hhh1M,1090
+biquad-0.5.dist-info/METADATA,sha256=frNBOBNFGTpZ0ixzcxbiVywwUhzgBueHmlWgDEAbt0Q,3683
+biquad-0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+biquad-0.5.dist-info/top_level.txt,sha256=OMpggdHRsGUakoTOYGPJ7qbs8EHjfoB6UqpcKSflty8,7
+biquad-0.5.dist-info/RECORD,,

{biquad-0.3.dist-info → biquad-0.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{biquad-0.3.dist-info → biquad-0.5.dist-info/licenses}/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/plot.py

@@ -1,96 +0,0 @@
-"""
-Copyright (c) 2023 Juergen Hock
-
-SPDX-License-Identifier: MIT
-
-Source: https://github.com/jurihock/biquad
-"""
-
-import numpy
-
-
-def __abs__(x, db=False):
-
-    if db:
-        with numpy.errstate(divide='ignore', invalid='ignore'):
-            return 20 * numpy.log10(numpy.abs(x))
-    else:
-        return numpy.abs(x)
-
-
-def __arg__(x, wrap=None):
-
-    if wrap is None:
-        return numpy.angle(x)
-    elif wrap:
-        return (numpy.angle(x) + numpy.pi) % (2 * numpy.pi) - numpy.pi
-    else:
-        return numpy.unwrap(numpy.angle(x))
-
-
-class plot:
-
-    def __init__(self, w, h):
-
-        self.w = w
-        self.h = h
-
-    def frequency(self, xlim=None, ylim=None):
-
-        import matplotlib.pyplot as pyplot
-
-        def lim():
-
-            if xlim is not None:
-                if isinstance(xlim, (list, tuple)):
-                    pyplot.xlim(xlim)
-                else:
-                    pyplot.xlim(0, xlim)
-
-            if ylim is not None:
-                if isinstance(ylim, (list, tuple)):
-                    pyplot.ylim(ylim)
-                else:
-                    pyplot.ylim(ylim, 0)
-            else:
-                pyplot.ylim(-110, numpy.maximum(10, y.max()))
-
-        x, y = self.w, __abs__(self.h, db=True)
-
-        pyplot.plot(x, y)
-        pyplot.xlabel('Hz')
-        pyplot.ylabel('dB')
-
-        lim()
-
-        return pyplot
-
-    def phase(self, xlim=None, ylim=None):
-
-        import matplotlib.pyplot as pyplot
-
-        def lim():
-
-            if xlim is not None:
-                if isinstance(xlim, (list, tuple)):
-                    pyplot.xlim(xlim)
-                else:
-                    pyplot.xlim(0, xlim)
-
-            if ylim is not None:
-                if isinstance(ylim, (list, tuple)):
-                    pyplot.ylim(ylim)
-                else:
-                    pyplot.ylim(-ylim, +ylim)
-            else:
-                pyplot.ylim(-numpy.pi, +numpy.pi)
-
-        x, y = self.w, __arg__(self.h, wrap=True)
-
-        pyplot.plot(x, y)
-        pyplot.xlabel('Hz')
-        pyplot.ylabel('rad')
-
-        lim()
-
-        return pyplot

biquad-0.3.dist-info/RECORD

@@ -1,16 +0,0 @@
-biquad/__init__.py,sha256=m8pno1TqDKeAnydyV58xRs6VU7Ji54gzOQpIMZ92th8,1366
-biquad/allpass.py,sha256=ftBPy6C0FZ-eWFel4je6Yt__49oF7Xw8fVL-7sXRans,2464
-biquad/bandpass.py,sha256=IcADoJHoiEIPeKuNXvFIrbxEm-4I2IgCeoLl6lAz0cE,2782
-biquad/biquad.py,sha256=Z-7VSkR2seMRhxCrpUVrnNwrodFcgknNJdCFMCi2eu8,4937
-biquad/highpass.py,sha256=toAud4xe_IiXJWH3XZAOi13xBw2SOcGbDc8q3GXgYRA,2488
-biquad/highshelf.py,sha256=uTzFtPSNDBl-hcmKtQpOd-khuAjin1LPLbxDyhuhRtw,2766
-biquad/lowpass.py,sha256=wD1juxQhHjfE_auYNaATkhoA-5tj7t7HtBOUogahbD8,2486
-biquad/lowshelf.py,sha256=4wEePModCtxZLkOYni-DMEgv2XLlr_mcw68fjMsAPBc,2764
-biquad/notch.py,sha256=eeoByEyuqrrf8Qdw1ByH3PL9H9SfJTKgMkphfyan8Dk,2443
-biquad/peak.py,sha256=c8d6J8zMrjgneD47Yz-hn0Gt5EUhjreTL4G8xzTaD5c,2705
-biquad/plot.py,sha256=lcIEmY3B8nbOXqV6viQt787-sh4wRa66XbaeftTs0wU,2089
-biquad-0.3.dist-info/LICENSE,sha256=zGdw_6DxFbsP_zfw5mVFVtwkpdfZ2nFql_XpjwBZ7ps,1069
-biquad-0.3.dist-info/METADATA,sha256=8h9I-U2HM9T914VRXVe_oUwUKbfohXggmxzwqd7J8eQ,2514
-biquad-0.3.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-biquad-0.3.dist-info/top_level.txt,sha256=OMpggdHRsGUakoTOYGPJ7qbs8EHjfoB6UqpcKSflty8,7
-biquad-0.3.dist-info/RECORD,,