iso::synth::InputUnit Class Reference

audio signal generation unit More...

#include <iso_synth_input_unit.h>

Inherits iso::synth::Unit.

Inherited by iso::synth::CTFUnit, iso::synth::ETAUnit, iso::synth::FMUnit, iso::synth::FTCUnit, iso::synth::InputFile, iso::synth::JackInputUnit, iso::synth::Noise, iso::synth::NoiseH, iso::synth::NoiseI, iso::synth::PinkNoise, iso::synth::PulseUnit, iso::synth::RhythmUnit, iso::synth::SampleUnit, iso::synth::SawtoothUnit, iso::synth::StochasticNoise, iso::synth::TriggerSampleUnit, and iso::synth::WaveTableOscil.

Inheritance diagram for iso::synth::InputUnit:

[legend]Collaboration diagram for iso::synth::InputUnit:

[legend]List of all members.

Public Member Functions
	InputUnit ()
	default constructor
	InputUnit (const String &pName)
	name constructor
	InputUnit (unsigned int pChannelCount)
	parameter based contructor
	InputUnit (const String &pName, unsigned int pChannelCount)
	parameter based contructor
	InputUnit (unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	parameter based contructor
	InputUnit (const String &pName, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate) throw (SynthException)
	name and parameter based contructor
	InputUnit (const Unit &pUnit)
	copy constructor
	InputUnit (const String &pName, const Unit &pUnit)
	name & copy constructor
	InputUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
virtual	~InputUnit ()
	destructor
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
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const InputUnit &pUnit)
	print unit information

---

Detailed Description

audio signal generation unit

generation unit

This class expands the base unit class in that it possesses an output audio port.
This class is the base class for all units that generate audio.
Instances of this class form the end of the process function call chain.
The process function of this base class delivers audio data consisting solely of 0.0 values via it's audio output port.

SwitchPorts:
name: active channelCount: 1 defaultValue: 1.0 resizable: false function: setActive

Created by Daniel Bisig on 6/26/06.
Copyright 2006 Daniel Bisig All rights reserved.

---

Constructor & Destructor Documentation

InputUnit::InputUnit

(

)

default constructor

InputUnit::InputUnit

(

const String &

pName

)

name constructor

Parameters:

pName

unit name

InputUnit::InputUnit

(

unsigned int

pChannelCount

)

parameter based contructor

Parameters:

pChannelCount

number of channels

InputUnit::InputUnit	(	const String &	pName,
		unsigned int	pChannelCount
	)

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels

InputUnit::InputUnit	(	unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate
	)			throw (SynthException)

parameter based contructor

Parameters:

	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate

InputUnit::InputUnit	(	const String &	pName,
		unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate
	)			throw (SynthException)

name and parameter based contructor

Parameters:

	pName	unit name
	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate

InputUnit::InputUnit

(

const Unit &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

InputUnit::InputUnit	(	const String &	pName,
		const Unit &	pUnit
	)

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

constructor copies frameCount, channelCount and rate but not unit name

InputUnit::InputUnit

(

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

InputUnit::~InputUnit

(

)

[virtual]

destructor

---

Member Function Documentation

void InputUnit::process

(

Buffer *

pBuffer

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

fills buffer according to it's function

Reimplemented from iso::synth::Unit.

Reimplemented in iso::synth::JackInputUnit, iso::synth::BLPulseGen, iso::synth::DCSPulseGen, iso::synth::FMUnit, iso::synth::Noise, iso::synth::NoiseH, iso::synth::NoiseI, iso::synth::PinkNoise, iso::synth::StochasticNoise, iso::synth::PulseUnit, iso::synth::RhythmUnit, iso::synth::SawtoothUnit, iso::synth::TriggerSampleUnit, iso::synth::WaveTableOscil, iso::synth::InputFile, iso::synth::SampleUnit, iso::synth::CTFUnit, iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, iso::synth::ETAFadeUnit, iso::synth::ETAUnit, and iso::synth::FTCUnit.

String InputUnit::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::Unit.

Reimplemented in iso::synth::JackInputUnit, iso::synth::BLPulseGen, iso::synth::DCSPulseGen, iso::synth::FMUnit, iso::synth::Noise, iso::synth::NoiseH, iso::synth::NoiseI, iso::synth::PinkNoise, iso::synth::StochasticNoise, iso::synth::PulseUnit, iso::synth::RhythmUnit, iso::synth::SawtoothUnit, iso::synth::TriggerSampleUnit, iso::synth::WaveTableOscil, iso::synth::InputFile, iso::synth::SampleUnit, iso::synth::CTFUnit, iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, iso::synth::ETAFadeUnit, iso::synth::ETAUnit, and iso::synth::FTCUnit.

---

Friends And Related Function Documentation

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

print unit information

---

Member Data Documentation

const String InputUnit::sClassName [static]

default name

Reimplemented from iso::synth::Unit.

Reimplemented in iso::synth::JackInputUnit, iso::synth::BLPulseGen, iso::synth::DCSPulseGen, iso::synth::FMUnit, iso::synth::Noise, iso::synth::NoiseH, iso::synth::NoiseI, iso::synth::PinkNoise, iso::synth::StochasticNoise, iso::synth::PulseUnit, iso::synth::RhythmUnit, iso::synth::SawtoothUnit, iso::synth::TriggerSampleUnit, iso::synth::WaveTableOscil, iso::synth::InputFile, iso::synth::SampleUnit, iso::synth::CTFUnit, iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, iso::synth::ETAFadeUnit, iso::synth::ETAUnit, and iso::synth::FTCUnit.

unsigned int InputUnit::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::Unit.

Reimplemented in iso::synth::JackInputUnit, iso::synth::BLPulseGen, iso::synth::DCSPulseGen, iso::synth::FMUnit, iso::synth::Noise, iso::synth::NoiseH, iso::synth::NoiseI, iso::synth::PinkNoise, iso::synth::StochasticNoise, iso::synth::PulseUnit, iso::synth::RhythmUnit, iso::synth::SawtoothUnit, iso::synth::TriggerSampleUnit, iso::synth::WaveTableOscil, iso::synth::InputFile, iso::synth::SampleUnit, iso::synth::CTFUnit, iso::synth::ETACustomFadeUnit, iso::synth::ETAFadeToValueUnit, iso::synth::ETAFadeUnit, iso::synth::ETAUnit, and iso::synth::FTCUnit.

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/unit/iso_synth_input_unit.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/unit/iso_synth_input_unit.cpp

---