functional.rst

.. role:: hidden
    :class: hidden-section

torchaudio.functional
=====================

.. currentmodule:: torchaudio.functional

Functions to perform common audio operations.

:hidden:`spectrogram`
~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: spectrogram

:hidden:`amplitude_to_DB`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: amplitude_to_DB

:hidden:`create_fb_matrix`
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: create_fb_matrix

:hidden:`create_dct`
~~~~~~~~~~~~~~~~~~~~

.. autofunction:: create_dct

:hidden:`mu_law_encoding`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: mu_law_encoding

:hidden:`mu_law_decoding`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: mu_law_decoding

:hidden:`complex_norm`
~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: complex_norm

:hidden:`angle`
~~~~~~~~~~~~~~~

.. autofunction:: angle

:hidden:`magphase`
~~~~~~~~~~~~~~~~~~

.. autofunction:: magphase

:hidden:`phase_vocoder`
~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: phase_vocoder

:hidden:`lfilter`
~~~~~~~~~~~~~~~~~

.. autofunction:: lfilter

:hidden:`biquad`
~~~~~~~~~~~~~~~~

.. autofunction:: biquad

:hidden:`lowpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: lowpass_biquad

:hidden:`highpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: highpass_biquad

:hidden:`allpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: allpass_biquad

:hidden:`equalizer_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: equalizer_biquad

:hidden:`bandpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: bandpass_biquad

:hidden:`bandreject_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: bandreject_biquad

:hidden:`band_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: band_biquad

:hidden:`treble_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: treble_biquad

:hidden:`bass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: bass_biquad

:hidden:`deemph_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: deemph_biquad

:hidden:`riaa_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: riaa_biquad

:hidden:`contrast`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: contrast

:hidden:`dcshift`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: dcshift

:hidden:`overdrive`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: overdrive

:hidden:`phaser`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: phaser

:hidden:`flanger`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: flanger

:hidden:`mask_along_axis`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: mask_along_axis

:hidden:`mask_along_axis_iid`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: mask_along_axis_iid

:hidden:`compute_deltas`
~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: compute_deltas

:hidden:`detect_pitch_frequency`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: detect_pitch_frequency

:hidden:`sliding_window_cmn`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: sliding_window_cmn

:hidden:`vad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: vad