torchaudio.functional.flanger

torchaudio.functional.flanger(waveform: Tensor, sample_rate: int, delay: float = 0.0, depth: float = 2.0, regen: float = 0.0, width: float = 71.0, speed: float = 0.5, phase: float = 25.0, modulation: str = 'sinusoidal', interpolation: str = 'linear') → Tensor

Apply a flanger effect to the audio. Similar to SoX implementation.

Parameters:

• waveform (Tensor) – audio waveform of dimension of (…, channel, time) . Max 4 channels allowed

• sample_rate (int) – sampling rate of the waveform, e.g. 44100 (Hz)

• delay (float, optional) – desired delay in milliseconds(ms) Allowed range of values are 0 to 30

• depth (float, optional) – desired delay depth in milliseconds(ms) Allowed range of values are 0 to 10

• regen (float, optional) – desired regen(feedback gain) in dB Allowed range of values are -95 to 95

• width (float, optional) – desired width(delay gain) in dB Allowed range of values are 0 to 100

• speed (float, optional) – modulation speed in Hz Allowed range of values are 0.1 to 10

• phase (float, optional) – percentage phase-shift for multi-channel Allowed range of values are 0 to 100

• modulation (str, optional) – Use either “sinusoidal” or “triangular” modulation. (Default: sinusoidal)

• interpolation (str, optional) – Use either “linear” or “quadratic” for delay-line interpolation. (Default: linear)

Returns:

Waveform of dimension of (…, channel, time)

Return type:

Tensor

Reference:

• http://sox.sourceforge.net/sox.html

• Scott Lehman, Effects Explained,