iso::synth::WaveTableShaper

iso::synth::WaveTableShaper Class Reference

wavetable shaper More...

#include <iso_synth_wavetable_shaper.h>

Inherits iso::synth::ProcessUnit.

Inheritance diagram for iso::synth::WaveTableShaper:

Inheritance graph
[legend]
Collaboration diagram for iso::synth::WaveTableShaper:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WaveTableShaper (const String &pWaveTableName, InterpolationType pInterpolationType=TRUNCATEINTERPOL)
 parameter based contructor
 WaveTableShaper (const String &pName, const String &pWaveTableName, InterpolationType pInterpolationType=TRUNCATEINTERPOL)
 parameter based contructor
 WaveTableShaper (unsigned int pChannelCount, const String &pWaveTableName, InterpolationType pInterpolationType=TRUNCATEINTERPOL)
 parameter based contructor
 WaveTableShaper (const String &pName, unsigned int pChannelCount, const String &pWaveTableName, InterpolationType pInterpolationType=TRUNCATEINTERPOL)
 parameter based contructor
 WaveTableShaper (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, const String &pWaveTableName, InterpolationType pInterpolationType=TRUNCATEINTERPOL) throw (SynthException)
 parameter based contructor
 WaveTableShaper (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, const String &pWaveTableName, InterpolationType pInterpolationType=TRUNCATEINTERPOL) throw (SynthException)
 name and parameter based contructor
 WaveTableShaper (const WaveTableShaper &pUnit)
 copy constructor
 WaveTableShaper (const String &pName, const WaveTableShaper &pUnit)
 name & copy constructor
 WaveTableShaper (const data::Values &pValues) throw (SynthException)
 values based constructor
 ~WaveTableShaper ()
 destructor
Channel * waveTable ()
 returns wave table
virtual void process (Buffer *pBuffer) throw (SynthException)
 processes buffer
virtual String info (bool pPropagate=false, bool pShowPorts=true) const
 obtain textual unit information

Static Public Attributes

static const String sClassName
 default name

Protected Member Functions

 WaveTableShaper ()
 default constructor
void init ()
 initializes wavetable and control ports

Protected Attributes

ControlPort * mAmplitude
 amplitude control port
ControlPort * mOffset
 offset control port
String mWaveTableName
 wave table name
Channel * mWaveTable
 wave table buffer
InterpolationType mInterpolationType
 interpolation type

Static Protected Attributes

static unsigned int sUnitCount
 total number of units created so far

Friends

std::ostream & operator<< (std::ostream &pOstream, const WaveTableShaper &pUnit)
 print unit information

Detailed Description

wavetable shaper

Created by Daniel Bisig on 7/20/06. Copyright 2006 Daniel Bisig All rights reserved.

Constructor & Destructor Documentation

WaveTableShaper::WaveTableShaper ( const String &  pWaveTableName,
InterpolationType  pInterpolationType = TRUNCATEINTERPOL 
)

parameter based contructor

Parameters:
pWaveTableName name of wavetable or wavetable file
pInterpolationType wavetable interpolation type

WaveTableShaper::WaveTableShaper ( const String &  pName,
const String &  pWaveTableName,
InterpolationType  pInterpolationType = TRUNCATEINTERPOL 
)

parameter based contructor

Parameters:
pName unit name
pWaveTableName name of wavetable or wavetable file
pInterpolationType wavetable interpolation type

WaveTableShaper::WaveTableShaper ( unsigned int  pChannelCount,
const String &  pWaveTableName,
InterpolationType  pInterpolationType = TRUNCATEINTERPOL 
)

parameter based contructor

Parameters:
pChannelCount number of channels
pWaveTableName name of wavetable or wavetable file
pInterpolationType wavetable interpolation type

WaveTableShaper::WaveTableShaper ( const String &  pName,
unsigned int  pChannelCount,
const String &  pWaveTableName,
InterpolationType  pInterpolationType = TRUNCATEINTERPOL 
)

parameter based contructor

Parameters:
pName unit name
pChannelCount number of channels
pWaveTableName name of wavetable or wavetable file
pInterpolationType wavetable interpolation type

WaveTableShaper::WaveTableShaper ( unsigned int  pFrameCount,
unsigned int  pChannelCount,
unsigned int  pRate,
const String &  pWaveTableName,
InterpolationType  pInterpolationType = TRUNCATEINTERPOL 
) throw (SynthException)

parameter based contructor

Parameters:
pFrameCount number of frames
pChannelCount number of channels
pRate samping rate
pWaveTableName name of wavetable or wavetable file
pInterpolationType wavetable interpolation type

WaveTableShaper::WaveTableShaper ( const String &  pName,
unsigned int  pFrameCount,
unsigned int  pChannelCount,
unsigned int  pRate,
const String &  pWaveTableName,
InterpolationType  pInterpolationType = TRUNCATEINTERPOL 
) throw (SynthException)

name and parameter based contructor

Parameters:
pName unit name
pFrameCount number of frames
pChannelCount number of channels
pRate samping rate
pWaveTableName name of wavetable or wavetable file
pInterpolationType wavetable interpolation type

WaveTableShaper::WaveTableShaper ( const WaveTableShaper &  pUnit  ) 

copy constructor

Parameters:
pUnit unit to copy properties from
constructor copies frameCount, channelCount and rate but not unit name

WaveTableShaper::WaveTableShaper ( const String &  pName,
const WaveTableShaper &  pUnit 
)

name & copy constructor

Parameters:
pName unit name
pUnit unit to copy properties from
constructor copies frameCount, channelCount and rate but not unit name

WaveTableShaper::WaveTableShaper ( const data::Values &  pValues  )  throw (SynthException)

values based constructor

Parameters:
pValues unit values
Exceptions:
SynthException failed to create unit
pValues structure & data types: 0: const String& : unit name 1: unsigned int : number of frames 2: unsigned int : number of channels 3: unsigned int : samping rate 4: const String& : wavetable name 5: InterpolationType : interpolation type

WaveTableShaper::~WaveTableShaper (  ) 

destructor

WaveTableShaper::WaveTableShaper (  )  [protected]

default constructor

Member Function Documentation

Channel * WaveTableShaper::waveTable (  ) 

returns wave table

Returns:
wave table

void WaveTableShaper::process ( Buffer *  pBuffer  )  throw (SynthException) [virtual]

processes buffer

Parameters:
pBuffer buffer to process
two step processing procedure:
1. calls process function of all it's input ports
2. as soon as these other processing functions return, it changes the buffer according to it's function

Reimplemented from iso::synth::ProcessUnit.

base::String WaveTableShaper::info ( bool  pPropagate = false,
bool  pShowPorts = true 
) const [virtual]

obtain textual unit information

Parameters:
pPropagate if true, the unit calls the info methods of its input ports
pShowPorts print port information
Returns:
String containing unit information

Reimplemented from iso::synth::ProcessUnit.

void WaveTableShaper::init (  )  [protected]

initializes wavetable and control ports

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  pOstream,
const WaveTableShaper &  pUnit 
) [friend]

print unit information

Member Data Documentation

const base::String WaveTableShaper::sClassName [static]

default name

Reimplemented from iso::synth::ProcessUnit.

unsigned int WaveTableShaper::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::ProcessUnit.

ControlPort* iso::synth::WaveTableShaper::mAmplitude [protected]

amplitude control port

ControlPort* iso::synth::WaveTableShaper::mOffset [protected]

offset control port

String iso::synth::WaveTableShaper::mWaveTableName [protected]

wave table name

Channel* iso::synth::WaveTableShaper::mWaveTable [protected]

wave table buffer

InterpolationType iso::synth::WaveTableShaper::mInterpolationType [protected]

interpolation type

The documentation for this class was generated from the following files:
Generated on Fri Feb 25 14:18:45 2011 for synth by  doxygen 1.5.1