FFmpeg
Data Structures | Enumerations | Functions
iirfilter.h File Reference
#include <stddef.h>

Go to the source code of this file.

Data Structures

struct  FFIIRFilterContext
 

Enumerations

enum  IIRFilterType {
  FF_FILTER_TYPE_BESSEL, FF_FILTER_TYPE_BIQUAD, FF_FILTER_TYPE_BUTTERWORTH, FF_FILTER_TYPE_CHEBYSHEV,
  FF_FILTER_TYPE_ELLIPTIC
}
 
enum  IIRFilterMode { FF_FILTER_MODE_LOWPASS, FF_FILTER_MODE_HIGHPASS, FF_FILTER_MODE_BANDPASS, FF_FILTER_MODE_BANDSTOP }
 

Functions

void ff_iir_filter_init (FFIIRFilterContext *f)
 Initialize FFIIRFilterContext. More...
 
void ff_iir_filter_init_mips (FFIIRFilterContext *f)
 
struct FFIIRFilterCoeffsff_iir_filter_init_coeffs (void *avc, enum IIRFilterType filt_type, enum IIRFilterMode filt_mode, int order, float cutoff_ratio, float stopband, float ripple)
 Initialize filter coefficients. More...
 
struct FFIIRFilterStateff_iir_filter_init_state (int order)
 Create new filter state. More...
 
void ff_iir_filter_free_coeffsp (struct FFIIRFilterCoeffs **coeffs)
 Free filter coefficients. More...
 
void ff_iir_filter_free_statep (struct FFIIRFilterState **state)
 Free and zero filter state. More...
 

Detailed Description

IIR filter interface

Definition in file iirfilter.h.

Enumeration Type Documentation

◆ IIRFilterType

Enumerator
FF_FILTER_TYPE_BESSEL 
FF_FILTER_TYPE_BIQUAD 
FF_FILTER_TYPE_BUTTERWORTH 
FF_FILTER_TYPE_CHEBYSHEV 
FF_FILTER_TYPE_ELLIPTIC 

Definition at line 35 of file iirfilter.h.

◆ IIRFilterMode

Enumerator
FF_FILTER_MODE_LOWPASS 
FF_FILTER_MODE_HIGHPASS 
FF_FILTER_MODE_BANDPASS 
FF_FILTER_MODE_BANDSTOP 

Definition at line 43 of file iirfilter.h.

Function Documentation

◆ ff_iir_filter_init()

void ff_iir_filter_init ( FFIIRFilterContext f)

Initialize FFIIRFilterContext.

Definition at line 320 of file iirfilter.c.

Referenced by ff_psy_preprocess_init().

◆ ff_iir_filter_init_mips()

void ff_iir_filter_init_mips ( FFIIRFilterContext f)

Definition at line 203 of file iirfilter_mips.c.

Referenced by ff_iir_filter_init().

◆ ff_iir_filter_init_coeffs()

struct FFIIRFilterCoeffs* ff_iir_filter_init_coeffs ( void *  avc,
enum IIRFilterType  filt_type,
enum IIRFilterMode  filt_mode,
int  order,
float  cutoff_ratio,
float  stopband,
float  ripple 
)

Initialize filter coefficients.

Parameters
avca pointer to an arbitrary struct of which the first field is a pointer to an AVClass struct
filt_typefilter type (e.g. Butterworth)
filt_modefilter mode (e.g. lowpass)
orderfilter order
cutoff_ratiocutoff to input frequency ratio
stopbandstopband to input frequency ratio (used by bandpass and bandstop filter modes)
rippleripple factor (used only in Chebyshev filters)
Returns
pointer to filter coefficients structure or NULL if filter cannot be created

Definition at line 166 of file iirfilter.c.

Referenced by ff_psy_preprocess_init(), and main().

◆ ff_iir_filter_init_state()

struct FFIIRFilterState* ff_iir_filter_init_state ( int  order)

Create new filter state.

Parameters
orderfilter order
Returns
pointer to new filter state or NULL if state creation fails

Definition at line 205 of file iirfilter.c.

Referenced by ff_psy_preprocess_init(), and main().

◆ ff_iir_filter_free_coeffsp()

void ff_iir_filter_free_coeffsp ( struct FFIIRFilterCoeffs **  coeffs)

Free filter coefficients.

Parameters
coeffspointer allocated with ff_iir_filter_init_coeffs()

Definition at line 310 of file iirfilter.c.

Referenced by ff_iir_filter_init_coeffs(), ff_psy_preprocess_end(), and main().

◆ ff_iir_filter_free_statep()

void ff_iir_filter_free_statep ( struct FFIIRFilterState **  state)

Free and zero filter state.

Parameters
statepointer to pointer allocated with ff_iir_filter_init_state()

Definition at line 305 of file iirfilter.c.

Referenced by ff_psy_preprocess_end(), and main().