FileIO.h – IO using a sound file for storing output sample data. More...

#include <FileIO.h>

Inheritance diagram for csl::FileIO:

Public Member Functions
	FileIO (char *path=NULL)
	< the path name determines the file type, e.g., xx.aiff, zz.snd, or yy.wav More...

	~FileIO ()

void	open () throw (CException)

void	start (float seconds=0) throw (CException)
	seconds is optional. If not passed, starts a background thread, playing and writing, otherwise run for x seconds (so it doesn't return until done). More...

void	stop () throw (CException)

void	close () throw (CException)
	open/close start/stop methods More...

void	test () throw (CException)

Buffer &	getInput () throw (CException)
	test the IO's graph < Get the current input from the sound card More...

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

virtual void	start () throw (CException)

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...

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
bool	mIsPlaying
	whether or not it's playing More...

bool	mIsThreadRunning
	is the background thread running? More...

unsigned	mDuration
	the file's buffer rate; 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	writeNextBuffer ()

virtual void	initialize (unsigned sr, unsigned bs, int is, int os, unsigned ic, unsigned oc)
	initialize overridden in subclasses More...

Static Protected Member Functions
static void *	threadFunction (void *)

Protected Attributes
string	mPath

SoundFile *	mFile

CThread *	mThread

Buffer	mInBuffer

Buffer	mOutBuffer

float	maxSampEver

Detailed Description

FileIO.h – IO using a sound file for storing output sample data.

Definition at line 19 of file FileIO.h.

Constructor & Destructor Documentation

FileIO::FileIO ( char * path = NULL )

< the path name determines the file type, e.g., xx.aiff, zz.snd, or yy.wav

Definition at line 10 of file FileIO.cpp.

References mFile, mPath, and csl::CGestalt::sndFileName().

FileIO::~FileIO ( )

Definition at line 18 of file FileIO.cpp.

References mFile, and mThread.

Member Function Documentation

void FileIO::open	(		)
throw	(	CException
	)

virtual

Reimplemented from csl::IO.

Definition at line 27 of file FileIO.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), csl::CGestalt::frameRate(), csl::Buffer::freeBuffers(), csl::kLogError, kSoundFileFormatAIFF, kSoundFileFormatSND, kSoundFileFormatWAV, csl::logMsg(), csl::CThread::MakeThread(), csl::Buffer::mAreBuffersAllocated, mDuration, mFile, mInBuffer, mOutBuffer, mPath, csl::IO::mThisSec, mThread, csl::IO::mTimeSum, csl::IO::mTimeVals, csl::CGestalt::numOutChannels(), and csl::Buffer::setSize().

void FileIO::start	(	float	seconds = `0`	)
throw	(	CException
	)

seconds is optional. If not passed, starts a background thread, playing and writing, otherwise run for x seconds (so it doesn't return until done).

Definition at line 63 of file FileIO.cpp.

References csl::CGestalt::frameRate(), and csl::logMsg().

void FileIO::stop	(		)
throw	(	CException
	)

virtual

Reimplemented from csl::IO.

Definition at line 77 of file FileIO.cpp.

References mDuration, mIsPlaying, mIsThreadRunning, and csl::sleepUsec().

void FileIO::close	(		)
throw	(	CException
	)

virtual

open/close start/stop methods

Reimplemented from csl::IO.

Definition at line 85 of file FileIO.cpp.

References csl::Buffer::freeBuffers(), csl::Buffer::mAreBuffersAllocated, mFile, mInBuffer, and mOutBuffer.

void csl::FileIO::test	(		)
throw	(	CException
	)

inlinevirtual

Reimplemented from csl::IO.

Definition at line 35 of file FileIO.h.

Buffer& csl::FileIO::getInput	(		)
throw	(	CException
	)

inlinevirtual

test the IO's graph < Get the current input from the sound card

Reimplemented from csl::IO.

Definition at line 37 of file FileIO.h.

References mInBuffer.

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

inlinevirtual

Reimplemented from csl::IO.

Definition at line 38 of file FileIO.h.

void * FileIO::threadFunction ( void * ptr )

staticprotected

Definition at line 106 of file FileIO.cpp.

References GET_TIME, csl::logMsg(), mDuration, mIsPlaying, mIsThreadRunning, csl::IO::mNow, csl::IO::mThisSec, csl::IO::mTimeSum, csl::IO::mTimeVals, csl::IO::printTimeStatistics(), csl::sleepUsec(), and writeNextBuffer().

void FileIO::writeNextBuffer ( )

protected

Definition at line 95 of file FileIO.cpp.

References mFile, csl::IO::mGraph, csl::Buffer::mNumFrames, csl::IO::mNumFramesPlayed, mOutBuffer, csl::UnitGenerator::nextBuffer(), and csl::Buffer::zeroBuffers().

Referenced by threadFunction().

virtual void csl::IO::start	(		)
throw	(	CException
	)

inlinevirtualinherited

Reimplemented in csl::iPhoneIO, csl::StdIO, csl::RemoteIO, csl::CAIO, csl::AUIO, csl::JackIO, csl::NullIO, csl::VSTIO, csl::PAIO, csl::AUIO, and csl::JUCEIO.

Definition at line 761 of file CSL_Core.h.

References csl::kIORunning, and csl::IO::mStatus.

Referenced by CSLAbstComponent::CSLAbstComponent(), CSLComponent::CSLComponent(), oscServer(), and playSineMixer().

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().

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 threadFunction().

virtual void csl::IO::initialize	(	unsigned	sr,
		unsigned	bs,
		int	is,
		int	os,
		unsigned	ic,
		unsigned	oc
	)

inlineprotectedvirtualinherited

initialize overridden in subclasses

Reimplemented in csl::PAIO.

Definition at line 805 of file CSL_Core.h.

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.