The PortAudio IO class. More...

#include <PAIO.h>

Inheritance diagram for csl::PAIO:

Public Member Functions
	PAIO (unsigned s_rate=CSL_mFrameRate, unsigned b_size=CSL_mBlockSize, int in_device=-1, int out_device=-1, unsigned in_chans=0, unsigned out_chans=2)

	~PAIO ()
	Destructor. More...

void	open () throw (CException)
	open the IO More...

void	start () throw (CException)
	start the callbacks More...

void	stop () throw (CException)
	stop the callbacks More...

void	close () throw (CException)
	close the IO More...

void	test () throw (CException)
	test the IO's graph More...

virtual void	capture_on (float dur)
	test the IO's graph More...

virtual void	capture_off ()
	end output capture More...

virtual Buffer *	get_capture ()
	answer the capture buffer More...

void	setRoot (UnitGenerator &root)
	set/clear my graph root generator More...

void	clearRoot ()

void	pullInput (Buffer &outBuffer, SampleBuffer out=0) throw (CException)
	get a buffer from the CSL graph More...

virtual Buffer &	getInput () throw (CException)
	Get the current input from the sound card. More...

virtual Buffer &	getInput (unsigned numFrames, unsigned numChannels) throw (CException)

unsigned	getAndIncrementSequence ()
	increment and answer my seq # More...

void	printTimeStatistics (struct timeval tthen, struct timeval tnow, long tsecond, long ttimeSum, long *ttimeVals)

void	attachObserver (Observer *)
	(possibly notify obersvers on my death) More...

void	detachObserver (Observer *)

void	changed (void *argument)
	this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map More...

virtual int	evaluate (void *argument)

Public Attributes
PaStream *	mStream
	the PortAudio stream we play out/get data from More...

UnitGenerator *	mGraph
	the root of my client DSP graph, often a mixer or panner More...

Buffer	mInputBuffer
	the most recent input buffer (if it's turned on) More...

Buffer	mOutputBuffer
	the output buffer I use (passed to nextBuffer calls) More...

Buffer	mCaptureBuffer
	the output buffer I use for capturing output (for testing) More...

SampleBuffer	mInputPointer
	the buffer for holding the sound card input (if open) More...

unsigned *	mChannelMap
	the output channel remapping array More...

unsigned	mNumFramesPlayed
	counter of frames I've played More...

unsigned	mSequence
	sequence counter More...

unsigned	mLoggingPeriod
	logging period in seconds More...

unsigned	mNumInChannels
	inputs More...

unsigned	mNumOutChannels
	outputs More...

unsigned	mNumRealInChannels
	physical inputs More...

unsigned	mNumRealOutChannels
	physical outputs More...

IO_Status	mStatus
	status flag More...

bool	mInterleaved
	flag if IO is interleaved More...

unsigned	mOffset
	used for capture offset More...

struct timeval mThen	mNow
	used for getting the real time More...

long	mTimeVals

long	mThisSec

long	mTimeSum
	for printing run-time statistics More...

float	mUsage
	cpu usage % print the CPU usage message More...

Protected Member Functions
void	handleError (PaError result) throw (CException)
	print the error message More...

void	initialize (unsigned sr, unsigned bs, int is, int os, unsigned ic, unsigned oc)
	Actually initialize PortAudio driver. More...

Protected Attributes
PaStreamParameters *	mInputParameters
	PA IO stream parameters. More...

PaStreamParameters *	mOutputParameters

PaDeviceIndex	mInDev

PaDeviceIndex	mOutDev
	IO device numbers. More...

IODeviceVector	mDevices

float	maxSampEver

Detailed Description

The PortAudio IO class.

Definition at line 21 of file PAIO.h.

Constructor & Destructor Documentation

PAIO::PAIO	(	unsigned	s_rate = `CSL_mFrameRate`,
		unsigned	b_size = `CSL_mBlockSize`,
		int	in_device = `-1`,
		int	out_device = `-1`,
		unsigned	in_chans = `0`,
		unsigned	out_chans = `2`
	)

Definition at line 18 of file PAIO.cpp.

References initialize(), csl::kIONew, and csl::IO::mStatus.

PAIO::~PAIO ( )

Destructor.

Definition at line 25 of file PAIO.cpp.

References close(), csl::kIOOpen, csl::kIORunning, csl::logMsg(), mInputParameters, mOutputParameters, csl::IO::mStatus, and stop().

Member Function Documentation

void PAIO::open	(		)
throw	(	CException
	)

virtual

open the IO

Reimplemented from csl::IO.

Definition at line 79 of file PAIO.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), csl::CGestalt::frameRate(), csl::Buffer::freeBuffers(), csl::kIOInit, csl::kIOOpen, csl::kLogError, csl::logMsg(), csl::Buffer::mAreBuffersAllocated, csl::IO::mInputBuffer, mInputParameters, csl::IO::mOutputBuffer, mOutputParameters, csl::IO::mStatus, mStream, csl::IO::mThisSec, csl::IO::mTimeSum, csl::IO::mTimeVals, and pa_callback().

Referenced by main().

void PAIO::start	(		)
throw	(	CException
	)

virtual

start the callbacks

Reimplemented from csl::IO.

Definition at line 119 of file PAIO.cpp.

References handleError(), csl::kIOOpen, csl::kIORunning, csl::kLogError, csl::logMsg(), csl::IO::mStatus, and mStream.

Referenced by main().

void PAIO::stop	(		)
throw	(	CException
	)

virtual

stop the callbacks

Reimplemented from csl::IO.

Definition at line 138 of file PAIO.cpp.

References handleError(), csl::kIOOpen, csl::kIORunning, csl::kLogError, csl::logMsg(), csl::IO::mStatus, and mStream.

Referenced by main(), and ~PAIO().

void PAIO::close	(		)
throw	(	CException
	)

virtual

close the IO

Reimplemented from csl::IO.

Definition at line 155 of file PAIO.cpp.

References csl::Buffer::freeBuffers(), handleError(), csl::kIOInit, csl::kIOOpen, csl::kLogError, csl::logMsg(), csl::Buffer::mAreBuffersAllocated, csl::IO::mInputBuffer, csl::IO::mOutputBuffer, csl::IO::mStatus, and mStream.

Referenced by main(), and ~PAIO().

void PAIO::test	(		)
throw	(	CException
	)

virtual

test the IO's graph

Reimplemented from csl::IO.

Definition at line 177 of file PAIO.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), csl::kLogError, csl::logMsg(), csl::IO::mGraph, csl::CException::mMessage, csl::UnitGenerator::nextBuffer(), and csl::CGestalt::numOutChannels().

void PAIO::handleError	(	PaError	result	)
throw	(	CException
	)

protected

print the error message

Definition at line 69 of file PAIO.cpp.

References csl::kLogError, and csl::logMsg().

Referenced by close(), start(), and stop().

void PAIO::initialize	(	unsigned	sr,
		unsigned	bs,
		int	is,
		int	os,
		unsigned	ic,
		unsigned	oc
	)

protectedvirtual

Actually initialize PortAudio driver.

Reimplemented from csl::IO.

Definition at line 195 of file PAIO.cpp.

References csl::CGestalt::blockSize(), csl_min, csl::CGestalt::frameRate(), csl::kIOInit, csl::kLogFatal, csl::logMsg(), csl::IO::mChannelMap, mDevices, csl::IODevice::mFrameRates, mInDev, csl::IO::mInputBuffer, mInputParameters, csl::IO::mNumInChannels, csl::IO::mNumOutChannels, csl::IO::mNumRealInChannels, csl::IO::mNumRealOutChannels, mOutDev, csl::IO::mOutputBuffer, mOutputParameters, csl::IO::mStatus, csl::CGestalt::numInChannels(), csl::CGestalt::numOutChannels(), csl::CGestalt::setBlockSize(), csl::CGestalt::setFrameRate(), csl::CGestalt::setNumInChannels(), csl::CGestalt::setNumOutChannels(), and csl::Buffer::setSize().

Referenced by PAIO().

void IO::capture_on ( float dur )

virtualinherited

test the IO's graph

begin output capture

Definition at line 1536 of file CSL_Core.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::frameRateF(), csl::IO::mCaptureBuffer, csl::IO::mNumOutChannels, csl::IO::mOffset, and csl::Buffer::setSize().

Referenced by test_convolution_file().

void IO::capture_off ( )

virtualinherited

end output capture

Definition at line 1544 of file CSL_Core.cpp.

References csl::IO::mCaptureBuffer, and csl::Buffer::setSize().

Referenced by test_convolution_file().

Buffer * IO::get_capture ( )

virtualinherited

answer the capture buffer

Definition at line 1550 of file CSL_Core.cpp.

References csl::IO::mCaptureBuffer.

Referenced by test_convolution_file().

void IO::setRoot ( UnitGenerator & root )

inherited

set/clear my graph root generator

Definition at line 1405 of file CSL_Core.cpp.

References csl::UnitGenerator::addOutput(), and csl::IO::mGraph.

Referenced by main(), oscServer(), playSineMixer(), test_Ambi_horiz(), test_Binaural_horiz(), test_Binaural_vertAxial(), test_Binaural_vertMedian(), test_convolution(), test_convolution_file(), test_SimpleP(), test_VBAP_horiz(), testMultiTap(), testReverb(), testSndFileBank(), testSoundFileTranspose(), testStereoverb(), testStringChorus(), and csl::VSTIO::VSTIO().

void IO::clearRoot ( )

inherited

void IO::pullInput	(	Buffer &	outBuffer,
		SampleBuffer	out = `0`
	)
throw	(	CException
	)

inherited

get a buffer from the CSL graph

Definition at line 1425 of file CSL_Core.cpp.

References GET_TIME, csl::kLogError, csl::logMsg(), and csl::CException::mMessage.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), CSLServerComponent::audioDeviceIOCallback(), CSLMIDIComponent::audioDeviceIOCallback(), CSLAbstComponent::audioDeviceIOCallback(), CSLComponent::audioDeviceIOCallback(), csl::NullIO::FeederFunction(), csl::StdIO::FeederFunction(), JackCallback(), pa_callback(), csl::VSTIO::processReplacing(), and RenderCallback().

Buffer & IO::getInput	(		)
throw	(	CException
	)

virtualinherited

Get the current input from the sound card.

Reimplemented in csl::FileIO, csl::AUIO, csl::AUIO, and csl::NullIO.

Definition at line 1517 of file CSL_Core.cpp.

References csl::IO::mInputBuffer, csl::Buffer::mNumChannels, and csl::Buffer::mNumFrames.

Buffer & IO::getInput	(	unsigned	numFrames,
		unsigned	numChannels
	)
throw	(	CException
	)

virtualinherited

Reimplemented in csl::FileIO, csl::AUIO, csl::AUIO, and csl::NullIO.

Definition at line 1523 of file CSL_Core.cpp.

References csl::Interleaver::deinterleave(), and mNumInChannels.

unsigned IO::getAndIncrementSequence ( )

inherited

increment and answer my seq #

Definition at line 1418 of file CSL_Core.cpp.

References csl::IO::mSequence.

void IO::printTimeStatistics	(	struct timeval *	tthen,
		struct timeval *	tnow,
		long *	tsecond,
		long *	ttimeSum,
		long *	ttimeVals
	)

inherited

Definition at line 1486 of file CSL_Core.cpp.

References csl::CGestalt::blockSize(), csl::CGestalt::frameRateF(), csl::logMsg(), csl::IO::maxSampEver, csl::IO::mLoggingPeriod, csl::IO::mUsage, and SUB_TIMES.

Referenced by csl::FileIO::threadFunction().

void Model::attachObserver ( Observer * o )

inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 502 of file CGestalt.cpp.

References csl::logMsg(), csl::Observer::mKey, and csl::Observer::mPeriod.

Referenced by CSLMIDIComponent::CSLMIDIComponent(), and csl::SpatialPanner::setSpeakerLayout().

void Model::detachObserver ( Observer * o )

inherited

Definition at line 518 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpatialPanner::setSpeakerLayout(), and csl::SpatialPanner::~SpatialPanner().

void Model::changed ( void * argument )

inherited

this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map

Definition at line 540 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpeakerLayout::addSpeaker(), csl::MIDIIn::handleIncomingMidiMessage(), and csl::SpeakerLayout::setDefaultSpeakerLayout().

virtual int csl::Model::evaluate ( void * argument )

inlinevirtualinherited

Reimplemented in csl::MIDIIn.

Definition at line 270 of file CGestalt.h.

Member Data Documentation

PaStream* csl::PAIO::mStream

the PortAudio stream we play out/get data from

Definition at line 35 of file PAIO.h.

Referenced by close(), open(), start(), and stop().

PaStreamParameters* csl::PAIO::mInputParameters

protected

PA IO stream parameters.

Definition at line 38 of file PAIO.h.

Referenced by initialize(), open(), and ~PAIO().

PaStreamParameters* csl::PAIO::mOutputParameters

protected

Definition at line 39 of file PAIO.h.

Referenced by initialize(), open(), and ~PAIO().

PaDeviceIndex csl::PAIO::mInDev

protected

Definition at line 41 of file PAIO.h.

Referenced by initialize().

PaDeviceIndex csl::PAIO::mOutDev

protected

IO device numbers.

Definition at line 41 of file PAIO.h.

Referenced by initialize().

IODeviceVector csl::PAIO::mDevices

protected

Definition at line 42 of file PAIO.h.

Referenced by initialize().

UnitGenerator* csl::IO::mGraph

inherited

the root of my client DSP graph, often a mixer or panner

Definition at line 777 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), CSLServerComponent::audioDeviceIOCallback(), CSLMIDIComponent::audioDeviceIOCallback(), CSLAbstComponent::audioDeviceIOCallback(), CSLComponent::audioDeviceIOCallback(), CSLSignalComponent::audioDeviceIOCallback(), csl::IO::clearRoot(), pa_callback(), csl::VSTIO::processReplacing(), RenderCallback(), csl::VSTIO::setProgramName(), csl::IO::setRoot(), test(), and csl::FileIO::writeNextBuffer().

Buffer csl::IO::mInputBuffer

inherited

the most recent input buffer (if it's turned on)

Definition at line 778 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), CSLAbstComponent::audioDeviceIOCallback(), close(), csl::AUIO::getInput(), csl::NullIO::getInput(), csl::IO::getInput(), initialize(), open(), pa_callback(), and csl::VSTIO::processReplacing().

Buffer csl::IO::mOutputBuffer

inherited

the output buffer I use (passed to nextBuffer calls)

Definition at line 779 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), close(), csl::NullIO::FeederFunction(), csl::StdIO::FeederFunction(), initialize(), JackCallback(), open(), pa_callback(), csl::VSTIO::processReplacing(), and RenderCallback().

Buffer csl::IO::mCaptureBuffer

inherited

the output buffer I use for capturing output (for testing)

Definition at line 780 of file CSL_Core.h.

Referenced by csl::IO::capture_off(), csl::IO::capture_on(), and csl::IO::get_capture().

SampleBuffer csl::IO::mInputPointer

inherited

the buffer for holding the sound card input (if open)

Definition at line 781 of file CSL_Core.h.

Referenced by pa_callback().

unsigned* csl::IO::mChannelMap

inherited

the output channel remapping array

Definition at line 782 of file CSL_Core.h.

Referenced by initialize().

unsigned csl::IO::mNumFramesPlayed

inherited

counter of frames I've played

Definition at line 784 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), pa_callback(), RenderCallback(), csl::AUIO::start(), and csl::FileIO::writeNextBuffer().

unsigned csl::IO::mSequence

inherited

sequence counter

Definition at line 785 of file CSL_Core.h.

Referenced by csl::IO::getAndIncrementSequence().

unsigned csl::IO::mLoggingPeriod

inherited

logging period in seconds

Definition at line 786 of file CSL_Core.h.

Referenced by csl::IO::printTimeStatistics().

unsigned csl::IO::mNumInChannels

inherited

inputs

Definition at line 787 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), initialize(), and pa_callback().

unsigned csl::IO::mNumOutChannels

inherited

outputs

Definition at line 788 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), csl::IO::capture_on(), initialize(), and csl::VSTIO::processReplacing().

unsigned csl::IO::mNumRealInChannels

inherited

physical inputs

Definition at line 789 of file CSL_Core.h.

Referenced by initialize().

unsigned csl::IO::mNumRealOutChannels

inherited

physical outputs

Definition at line 790 of file CSL_Core.h.

Referenced by initialize().

IO_Status csl::IO::mStatus

inherited

status flag

Definition at line 791 of file CSL_Core.h.

Referenced by csl::JUCEIO::audioDeviceIOCallback(), close(), csl::IO::close(), initialize(), JackCallback(), open(), csl::IO::open(), pa_callback(), PAIO(), start(), csl::IO::start(), stop(), csl::IO::stop(), and ~PAIO().

bool csl::IO::mInterleaved

inherited

flag if IO is interleaved

Definition at line 792 of file CSL_Core.h.

Referenced by csl::InOut::InOut(), and csl::VSTIO::VSTIO().

unsigned csl::IO::mOffset

inherited

used for capture offset

Definition at line 793 of file CSL_Core.h.

Referenced by csl::IO::capture_on(), and test_convolution_file().

struct timeval mThen csl::IO::mNow

inherited

used for getting the real time

Definition at line 796 of file CSL_Core.h.

Referenced by csl::FileIO::threadFunction().

long csl::IO::mTimeVals

inherited

Definition at line 797 of file CSL_Core.h.

Referenced by csl::AUIO::open(), csl::FileIO::open(), open(), and csl::FileIO::threadFunction().

long csl::IO::mThisSec

inherited

Definition at line 797 of file CSL_Core.h.

Referenced by csl::AUIO::open(), csl::FileIO::open(), open(), and csl::FileIO::threadFunction().

long csl::IO::mTimeSum

inherited

for printing run-time statistics

Definition at line 797 of file CSL_Core.h.

Referenced by csl::AUIO::open(), csl::FileIO::open(), open(), and csl::FileIO::threadFunction().

float csl::IO::mUsage

inherited

cpu usage % print the CPU usage message

Definition at line 798 of file CSL_Core.h.

Referenced by csl::IO::printTimeStatistics().

float csl::IO::maxSampEver

protectedinherited

Definition at line 805 of file CSL_Core.h.

Referenced by csl::IO::printTimeStatistics().

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

/Content/Code/CSL6/Src/IO/PAIO.h
/Content/Code/CSL6/Src/IO/PAIO.cpp

Public Member Functions

Public Attributes

inputs

outputs

physical inputs

physical outputs

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

inputs

outputs

physical inputs

physical outputs