Classes | Public Types | Public Member Functions | Static Public Member Functions
FilterProperties Class Reference

Stores a configuration for a set of audio DSP filters. More...

#include "filterProperties.h"

Inheritance diagram for FilterProperties:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

List of all members.

Classes

struct  FilterConfig

Public Types

typedef pvector< FilterConfig > ConfigVector
enum  FilterType {
  FT_lowpass, FT_highpass, FT_echo, FT_flange,
  FT_distort, FT_normalize, FT_parameq, FT_pitchshift,
  FT_chorus, FT_reverb, FT_compress
}

Public Member Functions

void add_chorus (PN_stdfloat drymix, PN_stdfloat wet1, PN_stdfloat wet2, PN_stdfloat wet3, PN_stdfloat delay, PN_stdfloat rate, PN_stdfloat depth, PN_stdfloat feedback)
 Add a chorus filter to the end of the DSP chain.
void add_compress (PN_stdfloat threshold, PN_stdfloat attack, PN_stdfloat release, PN_stdfloat gainmakeup)
 Add a compress filter to the end of the DSP chain.
void add_distort (PN_stdfloat level)
 Add a distort filter to the end of the DSP chain.
void add_echo (PN_stdfloat drymix, PN_stdfloat wetmix, PN_stdfloat delay, PN_stdfloat decayratio)
 Add a echo filter to the end of the DSP chain.
void add_flange (PN_stdfloat drymix, PN_stdfloat wetmix, PN_stdfloat depth, PN_stdfloat rate)
 Add a flange filter to the end of the DSP chain.
void add_highpass (PN_stdfloat cutoff_freq, PN_stdfloat resonance_q)
 Add a highpass filter to the end of the DSP chain.
void add_lowpass (PN_stdfloat cutoff_freq, PN_stdfloat resonance_q)
 Add a lowpass filter to the end of the DSP chain.
void add_normalize (PN_stdfloat fadetime, PN_stdfloat threshold, PN_stdfloat maxamp)
 Add a normalize filter to the end of the DSP chain.
void add_parameq (PN_stdfloat center_freq, PN_stdfloat bandwidth, PN_stdfloat gain)
 Add a parameq filter to the end of the DSP chain.
void add_pitchshift (PN_stdfloat pitch, PN_stdfloat fftsize, PN_stdfloat overlap)
 Add a pitchshift filter to the end of the DSP chain.
void add_reverb (PN_stdfloat drymix, PN_stdfloat wetmix, PN_stdfloat roomsize, PN_stdfloat damp, PN_stdfloat width)
 Add a reverb filter to the end of the DSP chain.
void clear ()
 Removes all DSP postprocessing.
virtual TypeHandle force_init_type ()
const ConfigVector & get_config ()
 Intended for use by AudioManager and AudioSound implementations: allows access to the config vector.
virtual TypeHandle get_type () const

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Detailed Description

Stores a configuration for a set of audio DSP filters.

Definition at line 26 of file filterProperties.h.

Member Function Documentation

void FilterProperties::add_chorus ( PN_stdfloat  drymix,
PN_stdfloat  wet1,
PN_stdfloat  wet2,
PN_stdfloat  wet3,
PN_stdfloat  delay,
PN_stdfloat  rate,
PN_stdfloat  depth,
PN_stdfloat  feedback 
) [inline]

Add a chorus filter to the end of the DSP chain.

Definition at line 112 of file filterProperties.I.

void FilterProperties::add_compress ( PN_stdfloat  threshold,
PN_stdfloat  attack,
PN_stdfloat  release,
PN_stdfloat  gainmakeup 
) [inline]

Add a compress filter to the end of the DSP chain.

Definition at line 132 of file filterProperties.I.

void FilterProperties::add_distort ( PN_stdfloat  level) [inline]

Add a distort filter to the end of the DSP chain.

Definition at line 72 of file filterProperties.I.

void FilterProperties::add_echo ( PN_stdfloat  drymix,
PN_stdfloat  wetmix,
PN_stdfloat  delay,
PN_stdfloat  decayratio 
) [inline]

Add a echo filter to the end of the DSP chain.

Definition at line 52 of file filterProperties.I.

void FilterProperties::add_flange ( PN_stdfloat  drymix,
PN_stdfloat  wetmix,
PN_stdfloat  depth,
PN_stdfloat  rate 
) [inline]

Add a flange filter to the end of the DSP chain.

Definition at line 62 of file filterProperties.I.

void FilterProperties::add_highpass ( PN_stdfloat  cutoff_freq,
PN_stdfloat  resonance_q 
) [inline]

Add a highpass filter to the end of the DSP chain.

Definition at line 42 of file filterProperties.I.

void FilterProperties::add_lowpass ( PN_stdfloat  cutoff_freq,
PN_stdfloat  resonance_q 
) [inline]

Add a lowpass filter to the end of the DSP chain.

Definition at line 32 of file filterProperties.I.

void FilterProperties::add_normalize ( PN_stdfloat  fadetime,
PN_stdfloat  threshold,
PN_stdfloat  maxamp 
) [inline]

Add a normalize filter to the end of the DSP chain.

Definition at line 82 of file filterProperties.I.

void FilterProperties::add_parameq ( PN_stdfloat  center_freq,
PN_stdfloat  bandwidth,
PN_stdfloat  gain 
) [inline]

Add a parameq filter to the end of the DSP chain.

Definition at line 92 of file filterProperties.I.

void FilterProperties::add_pitchshift ( PN_stdfloat  pitch,
PN_stdfloat  fftsize,
PN_stdfloat  overlap 
) [inline]

Add a pitchshift filter to the end of the DSP chain.

Definition at line 102 of file filterProperties.I.

void FilterProperties::add_reverb ( PN_stdfloat  drymix,
PN_stdfloat  wetmix,
PN_stdfloat  roomsize,
PN_stdfloat  damp,
PN_stdfloat  width 
) [inline]

Add a reverb filter to the end of the DSP chain.

Definition at line 122 of file filterProperties.I.

void FilterProperties::clear ( ) [inline]

Removes all DSP postprocessing.

Definition at line 22 of file filterProperties.I.

const FilterProperties::ConfigVector & FilterProperties::get_config ( ) [inline]

Intended for use by AudioManager and AudioSound implementations: allows access to the config vector.

Definition at line 143 of file filterProperties.I.

Referenced by AudioManager::configure_filters(), and AudioSound::configure_filters().

static void FilterProperties::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedReferenceCount.

Definition at line 78 of file filterProperties.h.

References TypedReferenceCount::init_type().

The documentation for this class was generated from the following files: