functional_flanger {torchaudio}

Flanger Effect (functional)

Description

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

Usage

functional_flanger(
  waveform,
  sample_rate,
  delay = 0,
  depth = 2,
  regen = 0,
  width = 71,
  speed = 0.5,
  phase = 25,
  modulation = "sinusoidal",
  interpolation = "linear"
)

Arguments

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): desired delay in milliseconds(ms). Allowed range of values are 0 to 30

depth

(float): desired delay depth in milliseconds(ms). Allowed range of values are 0 to 10

regen

(float): desired regen(feeback gain) in dB. Allowed range of values are -95 to 95

width

(float): desired width(delay gain) in dB. Allowed range of values are 0 to 100

speed

(float): modulation speed in Hz. Allowed range of values are 0.1 to 10

phase

(float): percentage phase-shift for multi-channel. Allowed range of values are 0 to 100

modulation

(str): Use either "sinusoidal" or "triangular" modulation. (Default: sinusoidal)

interpolation

(str): Use either "linear" or "quadratic" for delay-line interpolation. (Default: linear)

Value

tensor: Waveform of dimension of ⁠(..., channel, time)⁠

References

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

• Scott Lehman, Effects Explained, https://web.archive.org/web/20051125072557/http://www.harmony-central.com/Effects/effects-explained.html