Skip to content

Update butterworth_filter.py #12348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update butterworth_filter.py #12348

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
981fa9b
Update butterworth_filter.py
Aryan-Rajesh-Python Nov 4, 2024
5717e7c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 19 additions & 14 deletions audio_filters/butterworth_filter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
from math import cos, sin, sqrt, tau

from audio_filters.iir_filter import IIRFilter

"""

Check failure on line 4 in audio_filters/butterworth_filter.py

View workflow job for this annotation

GitHub Actions / ruff

Ruff (I001) 

audio_filters/butterworth_filter.py:1:1: I001 Import block is un-sorted or un-formatted
Create 2nd-order IIR filters with Butterworth design.

Code based on https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html
Alternatively you can use scipy.signal.butter, which should yield the same results.
Alternatively, you can use scipy.signal.butter, which should yield the same results.
"""


Expand Down Expand Up @@ -208,27 +207,33 @@

>>> filter = make_highshelf(1000, 48000, 6)
>>> filter.a_coeffs + filter.b_coeffs # doctest: +NORMALIZE_WHITESPACE
[2.2229172136088806, -3.9587208137297303, 1.7841414181566304, 4.295432981120543,
-7.922740859457287, 3.6756456963725253]
[2.2229172136088806, -3.616080374557819, 1.4122939941901636, 0.5690651073937642,
-1.3335115824061685, 0.7666141956641752]
"""
w0 = tau * frequency / samplerate
_sin = sin(w0)
_cos = cos(w0)
alpha = _sin / (2 * q_factor)
big_a = 10 ** (gain_db / 40)
pmc = (big_a + 1) - (big_a - 1) * _cos
ppmc = (big_a + 1) + (big_a - 1) * _cos
mpc = (big_a - 1) - (big_a + 1) * _cos
pmpc = (big_a - 1) + (big_a + 1) * _cos
pmc = (big_a + 1) + (big_a - 1) * _cos
ppmc = (big_a + 1) - (big_a - 1) * _cos
mpc = (big_a - 1) + (big_a + 1) * _cos
pmpc = (big_a - 1) - (big_a + 1) * _cos
aa2 = 2 * sqrt(big_a) * alpha

b0 = big_a * (ppmc + aa2)
b1 = -2 * big_a * pmpc
b2 = big_a * (ppmc - aa2)
a0 = pmc + aa2
a1 = 2 * mpc
a2 = pmc - aa2
b0 = big_a * (pmc - aa2)
b1 = -2 * big_a * mpc
b2 = big_a * (pmc + aa2)
a0 = ppmc - aa2
a1 = 2 * pmpc
a2 = ppmc + aa2

filt = IIRFilter(2)
filt.set_coefficients([a0, a1, a2], [b0, b1, b2])
return filt


if __name__ == "__main__":
import doctest

doctest.testmod()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

from math import cos, sin, sqrt, tau
from audio_filters.iir_filter import IIRFilter

"""
Create 2nd-order IIR filters with Butterworth design.
Code based on https://webaudio.github.io/Audio-EQ-Cookbook/audio-eq-cookbook.html
Alternatively, you can use scipy.signal.butter, which should yield the same results.
"""

def make_highshelf(frequency, samplerate, gain_db, q_factor=0.707):
    """
    Creates a high-shelf filter based on the specified parameters.

    Args:
        frequency (float): Center frequency of the filter.
        samplerate (float): Sampling rate.
        gain_db (float): Gain in decibels.
        q_factor (float): Quality factor.

    Returns:
        IIRFilter: Configured high-shelf filter.

    Examples:
        >>> filter = make_highshelf(1000, 48000, 6)
        >>> filter.a_coeffs  # doctest: +NORMALIZE_WHITESPACE
        [2.2229172136088806, -3.9587208137297303, 1.7841414181566304]
        >>> filter.b_coeffs  # doctest: +NORMALIZE_WHITESPACE
        [4.295432981120543, -7.922740859457287, 3.6756456963725253]
    """
    w0 = tau * frequency / samplerate
    _sin = sin(w0)
    _cos = cos(w0)
    alpha = _sin / (2 * q_factor)
    big_a = 10 ** (gain_db / 40)

    pmc = (big_a + 1) + (big_a - 1) * _cos
    ppmc = (big_a + 1) - (big_a - 1) * _cos
    mpc = (big_a - 1) + (big_a + 1) * _cos
    pmpc = (big_a - 1) - (big_a + 1) * _cos
    aa2 = 2 * sqrt(big_a) * alpha

    b0 = big_a * (ppmc + aa2)
    b1 = -2 * big_a * pmpc
    b2 = big_a * (ppmc - aa2)
    a0 = pmc + aa2
    a1 = -2 * mpc
    a2 = pmc - aa2

    filt = IIRFilter(2)
    filt.set_coefficients([a0, a1, a2], [b0, b1, b2])
    return filt

if __name__ == "__main__":
    import doctest
    doctest.testmod()

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

try to implement these change

Loading