Commit 8da50732 authored by Anika Treffehn's avatar Anika Treffehn
Browse files

some adjustment and documentation

parent 4578ee8d

README.md

+2 −2
Original line number Diff line number Diff line
@@ -193,8 +193,8 @@ input: 
# preprocessing:

    ### Target format used in rendering from input format; default = null (no rendering)

    # fmt: "7_1_4"

    ### Flag for application of 50Hz high-pass filter; default = false

    # hp50: true

    ### Define mask (HP50 or 20KBP) for input signal filtering; default = null

    # mask: "HP50"

    ### Target sampling rate in Hz for resampling; default = null (no resampling)

    # fs: 16000

    ### Target loudness in LKFS; default = null (no loudness change applied)

examples/TEMPLATE.yml

+2 −2
Original line number Diff line number Diff line
@@ -64,8 +64,8 @@ input: 
# preprocessing:

    ### Target format used in rendering from input format; default = null (no rendering)

    # fmt: "7_1_4"

    ### Define mask (HP50 or 20KBP) for input signal filtering; default = None

    # mask: None

    ### Define mask (HP50 or 20KBP) for input signal filtering; default = null

    # mask: "HP50"

    ### Target sampling rate in Hz for resampling; default = null (no resampling)

    # fs: 16000

    ### Target loudness in LKFS; default = null (no loudness change applied)

ivas_processing_scripts/audiotools/wrappers/filter.py

+6 −4
Original line number Diff line number Diff line
@@ -305,7 +305,7 @@ def kbp20filter_itu( 
    Returns

    -------

    y: np.ndarray

        Output high-pass filtered array

        Output band-pass filtered array

    """



    # set filter type and check if sampling rate is supported
@@ -323,7 +323,7 @@ def kbp20filter_itu( 
        tmp.audio = resample_itu(tmp, 48000)

        tmp.fs = 48000



    # don't apply high-pass filtering to LFE channel

    # don't apply band-pass filtering to LFE channel

    if isinstance(x, ChannelBasedAudio):

        skip_channel = x.lfe_index

    else:
@@ -348,17 +348,19 @@ def maskfilter_itu( 
    mask: str,

) -> np.ndarray:

    """

    mask filter for multi-channel audio array

    Mask filter for multi-channel audio array



    Parameters

    ----------

    x: Audio

        Input audio

    mask: str

        Name of mask to be applied



    Returns

    -------

    y: np.ndarray

        Output high-pass filtered array

        Output filtered array

    """



    if mask == "HP50":

tests/data/test_ISM.yml

+2 −0
Original line number Diff line number Diff line
@@ -71,6 +71,8 @@ input: 
preprocessing:

    ### Target format used in rendering from input format; default = null (no rendering)

    # fmt: "7_1_4"

    ### Define mask (HP50 or 20KBP) for input signal filtering; default = null

    # mask: "HP50"

    ### Target sampling rate in Hz for resampling; default = null (no resampling)

    # fs: 16000

    ### Target loudness in LKFS; default = null (no loudness change applied)

tests/data/test_MC.yml

+2 −0
Original line number Diff line number Diff line
@@ -68,6 +68,8 @@ input: 
preprocessing:

    ### Target format used in rendering from input format; default = null (no rendering)

    fmt: "7_1_4"

    ### Define mask (HP50 or 20KBP) for input signal filtering; default = null

    # mask: "HP50"

    ### Target sampling rate in Hz for resampling; default = null (no resampling)

    fs: 16000

    ### Target loudness in LKFS; default = null (no loudness change applied)