Here's the abstract sound file reader/writer class, a sample player UGen. The concrete subclasses represent sound file APIs, not individual formats. More...

#include <SoundFile.h>

Inheritance diagram for csl::Abst_SoundFile:

Public Member Functions
	Abst_SoundFile (string path, int start=-1, int stop=-1)
	Constructor. Values not passed default to null. More...

	Abst_SoundFile (Abst_SoundFile &otherSndFile)
	Copy constructor – shares sample buffer. More...

	~Abst_SoundFile ()

virtual void	openForRead (bool load=true)=0 throw (CException)

virtual void	openForWrite (SoundFileFormat format=kSoundFileFormatAIFF, unsigned channels=1, unsigned rate=44100, unsigned bitDepth=16)=0 throw (CException)
	Open a file for writing. Default values are some common format. More...

virtual unsigned	seekTo (int position, SeekPosition whence)=0 throw (CException)
	seek to some position relative to "whence" More...

unsigned	seekTo (int position) throw (CException)
	read a buffer from the file (possibly all of it) More...

virtual void	readBufferFromFile (unsigned numFr)=0

virtual void	nextBuffer (Buffer &outB) throw (CException)
	UGen operations are implemented here copy next buffer from file cache. More...

virtual void	writeBuffer (Buffer &inB)=0 throw (CException)
	write a buffer of data into the file More...

virtual void	writeBuffer (Buffer &inB, unsigned fromFrame, unsigned toFrame)=0 throw (CException)

virtual SampleBuffer	buffer (unsigned bufNum)

unsigned	channels () const
	accessors More...

unsigned	duration ()

float	durationInSecs ()
	number of frames in the sound file More...

unsigned	sampleSize ()
	get the bytes-per-sample More...

SoundFileMode	mode ()
	r/w mode More...

unsigned	cacheSize ()
	size in frames of cached portion More...

void	mergeToMono ()
	average all the channels to mono More...

virtual void	setToEnd ()
	set to end position More...

virtual void	trigger ()
	reset to start More...

virtual void	close ()=0
	close file More...

virtual void	freeBuffer ()
	free the file cache More...

void	convertRate (int fromRate, int toRate)
	perform sample-rate conversion More...

bool	isValid ()
	answer if a valid file/buffer More...

bool	isActive ()
	answer if currently active More...

virtual bool	isCached ()
	answer if file is loaded into RAM More...

virtual bool	isCached (unsigned samps)
	answer if file has X samples in RAM More...

virtual void	setPath (string path)
	set file name path string More...

string	path ()
	file name More...

virtual void	dump ()
	log snd file props More...

int	startFrame ()
	get/set start frame More...

void	setStart (int val)

void	setStartSec (float val)

void	setStartRatio (float val)

int	stopFrame ()
	get/set stop frame More...

void	setStop (int val)

void	setStopSec (float val)

void	setStopRatio (float val)

void	setBase (int val)

unsigned int	base ()

double	playbackRate ()
	playback rate (pitch ratio) More...

void	setRate (UnitGenerator &frequency)
	set the receiver's playback rate (pitch ratio) More...

void	setRate (float frequency)

bool	isLooping ()
	get/set looping state More...

void	setIsLooping (bool tLooping)

void	setWaveform (Buffer &wave, bool freeBufs=true)
	plug in waveforms set the interpolation flag More...

void	setInterpolate (InterpolationPolicy whether)

virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times More...

unsigned	frameRate ()

void	setFrameRate (unsigned rate)
	get/set the receiver's frame rate More...

virtual unsigned	numChannels ()

void	setNumChannels (unsigned ch)
	get/set the receiver's number of outputs More...

BufferCopyPolicy	copyPolicy ()

void	setCopyPolicy (BufferCopyPolicy ch)
	get/set the receiver's buffer copy policy More...

virtual bool	isFixed ()
	query whether I'm fixed (StaticVariable overrides this) More...

void	addOutput (UnitGenerator *ugen)
	add to or return the UGen vector of outputs More...

void	removeOutput (UnitGenerator *ugen)

UGenVector	outputs ()

virtual unsigned	numOutputs ()

bool	checkFanOut (Buffer &outputBuffer) throw (CException)
	check for fan-out and copy previous buffer; return true if fanning out More...

void	handleFanOut (Buffer &outputBuffer) throw (CException)

virtual void	setValue (sample theValue)
	set/get the value (not allowed in the abstract, useful for static values) More...

virtual sample	value ()

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)

void	setFrequency (UnitGenerator &frequency)
	Setter accessors. More...

void	setFrequency (float frequency)
	set frequency More...

void	setPhase (float phase)

Port *	getPort (CSL_MAP_KEY name)

void	setScale (UnitGenerator &scale)
	set the receiver's scale member to a UGen or a float More...

void	setScale (float scale)

void	setOffset (UnitGenerator &offset)
	set the receiver's offset member to a UGen or a float More...

void	setOffset (float offset)

void	isScaled ()
	answer whether scale = 1 & offset = 0 More...

virtual void	reset () throw (CException)
	reset-to-zero More...

Static Public Member Functions
static bool	isSndfileName (const char *path)
	Answer whether the given name looks like a snd file. More...

static SoundFileFormat	sndfileNameType (const char *path)
	Answer the snd file type. More...

static const char *	mimeType (const char *path)
	Answer the MIME type based on the file name. More...

Public Attributes
SoundFileMetadata *	mProperties
	the ID3 tags properties More...

InterpolationPolicy	mInterpolate
	whether/how I should interpolate between samples More...

Buffer	mWavetable
	the stored wave form More...

unsigned	mCurrentFrame
	where I currently am in the buffer More...

double	mActualFrame
	where I actually am in the buffer More...

Protected Member Functions
virtual void	initFromSndfile ()=0
	read SF header More...

void	checkBuffer (unsigned numFrames)
	allocate buffer lazily More...

void	checkBuffer (unsigned numChans, unsigned numFrames)

bool	readTags () throw (CException)
	read the ID3 or other tags. Returns true if able to read them. More...

void	fillSine ()
	fill the shared wavetable with 1 cycle of a sine wave More...

void	zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
	utility method to zero out an outputBuffer More...

void	addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
	Plug in a unit generator to the named input slot. More...

void	addInput (CSL_MAP_KEY name, float value)
	Plug in a float to the named input slot. More...

void	pullInput (Port *thePort, unsigned numFrames) throw (CException)
	method to read the control values (in case they're dynamic). this sends nextBuffer() to the input. More...

void	pullInput (Port *thePort, Buffer &theBuffer) throw (CException)

virtual void	writeBuffer (Buffer &inputBuffer, unsigned bufNum) throw (CException)
	write to the receiver More...

Protected Attributes
string	mPath
	file name More...

SoundFileMode	mMode
	r/w mode More...

SoundFileFormat	mFormat
	sf format More...

bool	mIsValid
	is my file valid? More...

bool	mIsLooping
	am i looping start-stop? More...

int	mStart

int	mStop
	starting/ending frames (or -1 if not used) More...

double	mRate
	sample rate ratio More...

unsigned	mNumFrames
	sample frames More...

unsigned	mBytesPerSample
	the # of bytes per sample More...

unsigned	mBase
	starting frame in file of buffer More...

unsigned	mFrameRate
	trigger ignored here More...

unsigned	mNumChannels
	my "expected" number of output channels More...

BufferCopyPolicy	mCopyPolicy
	the policy I use if asked for more or fewer channels More...

UGenVector	mOutputs
	the vector of my output UGens More...

unsigned	mNumOutputs
	the number of outputs More...

Buffer *	mOutputCache
	my past output ring buffer (only used in case of fan-out) More...

unsigned	mSequence
	the highest-seen buffer seq number More...

sample	mPhase
	set phase More...

PortMap	mInputs
	the map of my inputs or controls (used by the mix-in classes) More...

Detailed Description

Here's the abstract sound file reader/writer class, a sample player UGen. The concrete subclasses represent sound file APIs, not individual formats.

The sound file player is actually a powerful sampler, supporting arbitrary transposition using wavetable interpolation or a sample rate convertor; Sound files are seekable and also writeable.

Definition at line 101 of file SoundFile.h.

Constructor & Destructor Documentation

Abst_SoundFile::Abst_SoundFile	(	string	path,
		int	start = `-1`,
		int	stop = `-1`
	)

Constructor. Values not passed default to null.

Copy constructor – shares sample buffer.

Definition at line 111 of file SoundFile.cpp.

Abst_SoundFile::Abst_SoundFile ( Abst_SoundFile & otherSndFile )

Copy constructor – shares sample buffer.

Definition at line 128 of file SoundFile.cpp.

References isCached(), csl::kLogError, csl::logMsg(), csl::Seekable::mCurrentFrame, mPath, csl::WavetableOscillator::mWavetable, path(), setPath(), and csl::WavetableOscillator::setWaveform().

Abst_SoundFile::~Abst_SoundFile ( )

Definition at line 147 of file SoundFile.cpp.

References mProperties.

Member Function Documentation

bool Abst_SoundFile::isSndfileName ( const char * path )

static

Answer whether the given name looks like a snd file.

Answer the snd file type.

Definition at line 44 of file SoundFile.cpp.

References gSndFileExts.

SoundFileFormat Abst_SoundFile::sndfileNameType ( const char * path )

static

Answer the snd file type.

Definition at line 60 of file SoundFile.cpp.

References kSoundFileFormatAIFF, kSoundFileFormatOther, kSoundFileFormatSND, and kSoundFileFormatWAV.

Referenced by mimeType().

const char * Abst_SoundFile::mimeType ( const char * path )

static

Answer the MIME type based on the file name.

open file and get stats; read it if "load"

Definition at line 98 of file SoundFile.cpp.

References kSoundFileFormatAIFF, kSoundFileFormatWAV, and sndfileNameType().

virtual void csl::Abst_SoundFile::openForRead	(	bool	load = `true`	)
throw	(	CException
	)

pure virtual

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

virtual void csl::Abst_SoundFile::openForWrite	(	SoundFileFormat	format = `kSoundFileFormatAIFF`,
		unsigned	channels = `1`,
		unsigned	rate = `44100`,
		unsigned	bitDepth = `16`
	)
throw	(	CException
	)

pure virtual

Open a file for writing. Default values are some common format.

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

virtual unsigned csl::Abst_SoundFile::seekTo	(	int	position,
		SeekPosition	whence
	)
throw	(	CException
	)

pure virtual

seek to some position relative to "whence"

Implements csl::Seekable.

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

Referenced by setStart(), and trigger().

unsigned csl::Abst_SoundFile::seekTo	(	int	position	)
throw	(	CException
	)

inline

read a buffer from the file (possibly all of it)

Definition at line 122 of file SoundFile.h.

References csl::kPositionStart, and seekTo().

Referenced by seekTo().

virtual void csl::Abst_SoundFile::readBufferFromFile ( unsigned numFr )

pure virtual

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

void Abst_SoundFile::nextBuffer	(	Buffer &	outB	)
throw	(	CException
	)

virtual

UGen operations are implemented here copy next buffer from file cache.

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::LSoundFile.

Definition at line 382 of file SoundFile.cpp.

References csl_min, DECLARE_SCALABLE_CONTROLS, LOAD_SCALABLE_CONTROLS, csl::WavetableOscillator::nextBuffer(), and UPDATE_SCALABLE_CONTROLS.

virtual void csl::Abst_SoundFile::writeBuffer	(	Buffer &	inB	)
throw	(	CException
	)

pure virtual

write a buffer of data into the file

Reimplemented from csl::Writeable.

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

virtual void csl::Abst_SoundFile::writeBuffer	(	Buffer &	inB,
		unsigned	fromFrame,
		unsigned	toFrame
	)
throw	(	CException
	)

pure virtual

Implemented in csl::LSoundFile, and csl::JSoundFile.

virtual SampleBuffer csl::Abst_SoundFile::buffer ( unsigned bufNum )

inlinevirtual

Definition at line 134 of file SoundFile.h.

References csl::Buffer::buffer(), and csl::WavetableOscillator::mWavetable.

Referenced by load_filter_data(), csl::Convolver2::setIRFile(), and csl::Convolver::setIRFile().

unsigned Abst_SoundFile::channels ( ) const

accessors

chans

Definition at line 157 of file SoundFile.cpp.

References mIsValid, and csl::UnitGenerator::mNumChannels.

Referenced by csl::SoundCue::channels(), csl::CASoundFile::dump(), dump(), and csl::SoundCue::dump().

unsigned csl::Abst_SoundFile::duration ( )

inlinevirtual

Reimplemented from csl::Seekable.

Definition at line 138 of file SoundFile.h.

References mNumFrames.

Referenced by isCached(), setStart(), setStartRatio(), setStop(), and setStopRatio().

float Abst_SoundFile::durationInSecs ( )

number of frames in the sound file

actual duration of the selected portion in sec

Definition at line 161 of file SoundFile.cpp.

References csl::UnitGenerator::mFrameRate, mIsValid, mStart, and mStop.

Referenced by csl::CASoundFile::dump(), and dump().

unsigned csl::Abst_SoundFile::sampleSize ( )

inline

get the bytes-per-sample

Definition at line 141 of file SoundFile.h.

References mBytesPerSample.

SoundFileMode csl::Abst_SoundFile::mode ( )

inline

r/w mode

Definition at line 142 of file SoundFile.h.

References mMode.

unsigned csl::Abst_SoundFile::cacheSize ( )

inline

size in frames of cached portion

Definition at line 143 of file SoundFile.h.

References csl::Buffer::mNumAlloc, and csl::WavetableOscillator::mWavetable.

void Abst_SoundFile::mergeToMono ( )

average all the channels to mono

Definition at line 208 of file SoundFile.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::buffer(), csl::Buffer::copyFrom(), csl::logMsg(), csl::Buffer::mAreBuffersAllocated, csl::Buffer::mDidIAllocateBuffers, csl::UnitGenerator::mNumChannels, csl::Buffer::mNumFrames, csl::WavetableOscillator::mWavetable, and csl::Buffer::setBuffer().

void Abst_SoundFile::setToEnd ( )

virtual

set to end position

Definition at line 334 of file SoundFile.cpp.

References csl::Seekable::mCurrentFrame, and mStop.

Referenced by csl::CASoundFile::CASoundFile(), and csl::JSoundFile::JSoundFile().

void Abst_SoundFile::trigger ( void )

virtual

reset to start

Reimplemented from csl::UnitGenerator.

Definition at line 322 of file SoundFile.cpp.

References csl::Seekable::mCurrentFrame, mStart, and seekTo().

Referenced by test_convolution().

virtual void csl::Abst_SoundFile::close ( )

pure virtual

close file

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

void Abst_SoundFile::freeBuffer ( )

virtual

free the file cache

Definition at line 165 of file SoundFile.cpp.

References csl::Buffer::freeBuffers(), csl::Buffer::mAreBuffersAllocated, and csl::WavetableOscillator::mWavetable.

Referenced by csl::CASoundFile::close(), csl::JSoundFile::close(), csl::LSoundFile::close(), and csl::LSoundFile::~LSoundFile().

void Abst_SoundFile::convertRate	(	int	fromRate,
		int	toRate
	)

perform sample-rate conversion

Definition at line 236 of file SoundFile.cpp.

References csl::Buffer::convertRate(), csl::UnitGenerator::mFrameRate, csl::Buffer::mNumFrames, mNumFrames, and csl::WavetableOscillator::mWavetable.

bool csl::Abst_SoundFile::isValid ( )

inline

answer if a valid file/buffer

Definition at line 152 of file SoundFile.h.

References mIsValid.

bool Abst_SoundFile::isActive ( )

virtual

answer if currently active

Reimplemented from csl::UnitGenerator.

Definition at line 303 of file SoundFile.cpp.

References csl::Seekable::mCurrentFrame, mIsValid, and mStop.

bool Abst_SoundFile::isCached ( )

virtual

answer if file is loaded into RAM

answer if file has X samples in RAM

Reimplemented in csl::LSoundFile.

Definition at line 309 of file SoundFile.cpp.

References duration(), csl::Buffer::mNumFrames, and csl::WavetableOscillator::mWavetable.

Referenced by Abst_SoundFile().

bool Abst_SoundFile::isCached ( unsigned samps )

virtual

answer if file has X samples in RAM

Reimplemented in csl::LSoundFile.

Definition at line 315 of file SoundFile.cpp.

References csl::Seekable::mCurrentFrame, csl::Buffer::mNumFrames, and csl::WavetableOscillator::mWavetable.

void Abst_SoundFile::setPath ( string path )

virtual

set file name path string

Definition at line 153 of file SoundFile.cpp.

References mPath.

Referenced by Abst_SoundFile().

string csl::Abst_SoundFile::path ( )

inline

file name

Definition at line 158 of file SoundFile.h.

References mPath.

Referenced by Abst_SoundFile(), csl::CASoundFile::dump(), and dump().

void Abst_SoundFile::dump ( void )

virtual

log snd file props

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::CASoundFile.

Definition at line 370 of file SoundFile.cpp.

References channels(), durationInSecs(), csl::UnitGenerator::frameRate(), csl::logMsg(), and path().

int csl::Abst_SoundFile::startFrame ( )

inline

get/set start frame

Definition at line 161 of file SoundFile.h.

References mStart.

void Abst_SoundFile::setStart ( int val )

Definition at line 248 of file SoundFile.cpp.

References duration(), mIsValid, mStart, and seekTo().

Referenced by setStartRatio(), and setStartSec().

void Abst_SoundFile::setStartSec ( float val )

Definition at line 258 of file SoundFile.cpp.

References csl::UnitGenerator::mFrameRate, and setStart().

void Abst_SoundFile::setStartRatio ( float val )

Definition at line 262 of file SoundFile.cpp.

References duration(), and setStart().

int csl::Abst_SoundFile::stopFrame ( )

inline

get/set stop frame

Definition at line 165 of file SoundFile.h.

References mStop.

void Abst_SoundFile::setStop ( int val )

Definition at line 266 of file SoundFile.cpp.

References duration(), and mStop.

Referenced by setStopRatio(), and setStopSec().

void Abst_SoundFile::setStopSec ( float val )

Definition at line 275 of file SoundFile.cpp.

References csl::UnitGenerator::mFrameRate, and setStop().

void Abst_SoundFile::setStopRatio ( float val )

Definition at line 279 of file SoundFile.cpp.

References duration(), and setStop().

void Abst_SoundFile::setBase ( int val )

Definition at line 283 of file SoundFile.cpp.

References mBase.

unsigned int csl::Abst_SoundFile::base ( )

inline

Definition at line 170 of file SoundFile.h.

References mBase.

double csl::Abst_SoundFile::playbackRate ( )

inline

playback rate (pitch ratio)

Definition at line 172 of file SoundFile.h.

References mRate.

void Abst_SoundFile::setRate ( UnitGenerator & frequency )

set the receiver's playback rate (pitch ratio)

Definition at line 289 of file SoundFile.cpp.

References csl::Controllable::addInput(), CSL_RATE, and csl::Controllable::mInputs.

void Abst_SoundFile::setRate ( float frequency )

Definition at line 296 of file SoundFile.cpp.

References csl::logMsg(), and mRate.

bool csl::Abst_SoundFile::isLooping ( )

inline

get/set looping state

Definition at line 176 of file SoundFile.h.

References mIsLooping.

void csl::Abst_SoundFile::setIsLooping ( bool tLooping )

inline

Definition at line 177 of file SoundFile.h.

References mIsLooping.

virtual void csl::Abst_SoundFile::initFromSndfile ( )

protectedpure virtual

read SF header

Implemented in csl::LSoundFile, csl::JSoundFile, and csl::CASoundFile.

void Abst_SoundFile::checkBuffer ( unsigned numFrames )

protected

allocate buffer lazily

Definition at line 172 of file SoundFile.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::freeBuffers(), csl::logMsg(), csl::Buffer::mAreBuffersAllocated, csl::UnitGenerator::mNumChannels, csl::Buffer::mNumFrames, csl::WavetableOscillator::mWavetable, and csl::Buffer::setSize().

Referenced by csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), and csl::LSoundFile::readBufferFromFile().

void Abst_SoundFile::checkBuffer	(	unsigned	numChans,
		unsigned	numFrames
	)

protected

Definition at line 191 of file SoundFile.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::freeBuffers(), csl::logMsg(), csl::Buffer::mAreBuffersAllocated, csl::UnitGenerator::mNumChannels, csl::Buffer::mNumFrames, csl::WavetableOscillator::mWavetable, and csl::Buffer::setSize().

bool Abst_SoundFile::readTags	(		)
throw	(	CException
	)

protected

read the ID3 or other tags. Returns true if able to read them.

Definition at line 340 of file SoundFile.cpp.

References csl::SoundFileMetadata::mAlbum, csl::SoundFileMetadata::mArtist, csl::SoundFileMetadata::mBitRate, csl::SoundFileMetadata::mChannels, csl::SoundFileMetadata::mComment, csl::SoundFileMetadata::mGenre, csl::SoundFileMetadata::mLength, mPath, mProperties, csl::SoundFileMetadata::mSampleRate, csl::SoundFileMetadata::mTitle, csl::SoundFileMetadata::mTrack, and csl::SoundFileMetadata::mYear.

void WavetableOscillator::setWaveform	(	Buffer &	wave,
		bool	freeBufs = `true`
	)

inherited

plug in waveforms set the interpolation flag

Definition at line 76 of file Oscillator.cpp.

References csl::Buffer::buffer(), csl::Buffer::buffers(), csl::Buffer::freeBuffers(), csl::Buffer::mAreBuffersAllocated, csl::Buffer::mAreBuffersZero, csl::Buffer::mDidIAllocateBuffers, csl::Buffer::mIsPopulated, csl::Buffer::mMonoBufferByteSize, csl::Buffer::mNumAlloc, csl::Buffer::mNumChannels, csl::UnitGenerator::mNumChannels, csl::Buffer::mNumFrames, csl::WavetableOscillator::mWavetable, csl::Buffer::setBuffer(), and csl::Buffer::setBuffers().

Referenced by Abst_SoundFile(), and csl::WavetableOscillator::WavetableOscillator().

void csl::WavetableOscillator::setInterpolate ( InterpolationPolicy whether )

inlineinherited

Definition at line 79 of file Oscillator.h.

References csl::WavetableOscillator::mInterpolate.

void WavetableOscillator::nextBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)
throw	(	CException
	)

virtualinherited

really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::CompOrCacheOscillator.

Definition at line 132 of file Oscillator.cpp.

References DECLARE_PHASED_CONTROLS, DECLARE_SCALABLE_CONTROLS, csl::kLinear, csl::kTruncate, LOAD_PHASED_CONTROLS, LOAD_SCALABLE_CONTROLS, csl::logMsg(), mFrameRate, UPDATE_PHASED_CONTROLS, and UPDATE_SCALABLE_CONTROLS.

Referenced by csl::LSoundFile::nextBuffer(), csl::CompOrCacheOscillator::nextBuffer(), and nextBuffer().

void WavetableOscillator::fillSine ( )

protectedinherited

fill the shared wavetable with 1 cycle of a sine wave

Definition at line 112 of file Oscillator.cpp.

References csl::Buffer::allocateBuffers(), csl::Buffer::buffer(), CSL_TWOPI, DEFAULT_WTABLE_SIZE, csl::Buffer::mAreBuffersAllocated, csl::Buffer::mDidIAllocateBuffers, csl::WavetableOscillator::mWavetable, csl::Buffer::setBuffer(), and csl::Buffer::setSize().

unsigned csl::UnitGenerator::frameRate ( )

inlineinherited

Definition at line 249 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by csl::CASoundFile::dump(), dump(), and csl::SoundCue::dump().

void csl::UnitGenerator::setFrameRate ( unsigned rate )

inlineinherited

get/set the receiver's frame rate

Definition at line 250 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

virtual unsigned csl::UnitGenerator::numChannels ( )

inlinevirtualinherited

Reimplemented in csl::Splitter, and csl::Stereoverb.

Definition at line 252 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

Referenced by csl::AmbisonicMixer::addInput(), csl::BlockResizer::BlockResizer(), csl::Port::checkBuffer(), csl::Effect::Effect(), csl::AmbisonicRotator::initialize(), csl::AmbisonicDecoder::initialize(), csl::Mixer::nextBuffer(), csl::Convolver2::setIRFile(), csl::Convolver::setIRFile(), and csl::SpatialSource::SpatialSource().

void csl::UnitGenerator::setNumChannels ( unsigned ch )

inlineinherited

get/set the receiver's number of outputs

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

Referenced by csl::BinauralPanner::BinauralPanner(), csl::Spatializer::Spatializer(), csl::VBAP::speakerLayoutChanged(), and csl::VBAP::VBAP().

BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )

inlineinherited

Definition at line 255 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

void csl::UnitGenerator::setCopyPolicy ( BufferCopyPolicy ch )

inlineinherited

get/set the receiver's buffer copy policy

Definition at line 256 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

Referenced by csl::AmbisonicPanner::AmbisonicPanner(), csl::BinauralPanner::BinauralPanner(), csl::AmbisonicUnitGenerator::initOrder(), csl::Noise::Noise(), csl::PinkNoise::PinkNoise(), csl::Spatializer::Spatializer(), and csl::VBAP::VBAP().

virtual bool csl::UnitGenerator::isFixed ( )

inlinevirtualinherited

query whether I'm fixed (StaticVariable overrides this)

Reimplemented in csl::StaticVariable, and csl::BinaryOp.

Definition at line 271 of file CSL_Core.h.

void UnitGenerator::addOutput ( UnitGenerator * ugen )

inherited

add to or return the UGen vector of outputs

Definition at line 670 of file CSL_Core.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), csl::UnitGenerator::mNumOutputs, csl::UnitGenerator::mOutputCache, and csl::UnitGenerator::mOutputs.

Referenced by csl::Mixer::addInput(), csl::Controllable::addInput(), csl::AmbisonicRotator::initialize(), csl::AmbisonicDecoder::initialize(), csl::AmbisonicEncoder::setInput(), and csl::IO::setRoot().

void UnitGenerator::removeOutput ( UnitGenerator * ugen )

inherited

Definition at line 680 of file CSL_Core.cpp.

References csl::UnitGenerator::mNumOutputs, and csl::UnitGenerator::mOutputs.

Referenced by csl::IO::clearRoot(), csl::AmbisonicEncoder::setInput(), csl::AmbisonicDecoder::~AmbisonicDecoder(), and csl::AmbisonicRotator::~AmbisonicRotator().

UGenVector csl::UnitGenerator::outputs ( )

inlineinherited

Definition at line 277 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )

inlinevirtualinherited

Definition at line 278 of file CSL_Core.h.

References csl::UnitGenerator::mNumOutputs.

bool UnitGenerator::checkFanOut	(	Buffer &	outputBuffer	)
throw	(	CException
	)

inherited

check for fan-out and copy previous buffer; return true if fanning out

Definition at line 699 of file CSL_Core.cpp.

void UnitGenerator::handleFanOut	(	Buffer &	outputBuffer	)
throw	(	CException
	)

inherited

Definition at line 713 of file CSL_Core.cpp.

References csl_max.

virtual void csl::UnitGenerator::setValue ( sample theValue )

inlinevirtualinherited

set/get the value (not allowed in the abstract, useful for static values)

Reimplemented in csl::DynamicVariable, and csl::StaticVariable.

Definition at line 284 of file CSL_Core.h.

virtual sample csl::UnitGenerator::value ( )

inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 285 of file CSL_Core.h.

void UnitGenerator::zeroBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)

protectedinherited

utility method to zero out an outputBuffer

Definition at line 663 of file CSL_Core.cpp.

References csl::Buffer::buffer(), and csl::Buffer::mMonoBufferByteSize.

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.

void Phased::setFrequency ( UnitGenerator & frequency )

inherited

Setter accessors.

set frequency

Definition at line 981 of file CSL_Core.cpp.

References csl::Controllable::addInput(), and CSL_FREQUENCY.

Referenced by csl::AdditiveInstrument::playMIDI(), csl::AdditiveInstrument::playNote(), csl::AdditiveInstrument::playOSC(), csl::KarplusString::setFrequency(), csl::AdditiveInstrument::setParameter(), csl::SquareBL::SquareBL(), test_SHARC(), test_SHARC2(), testRandFreqEnv(), testSplitJoin1(), testSplitJoin2(), testSumOfSines1F(), testSumOfSinesCached(), testSumOfSinesNonCached(), and testSumOfSinesSteps().

void Phased::setFrequency ( float frequency )

inherited

set frequency

Definition at line 985 of file CSL_Core.cpp.

References csl::Controllable::addInput(), and CSL_FREQUENCY.

void csl::Phased::setPhase ( float phase )

inlineinherited

Definition at line 507 of file CSL_Core.h.

References csl::Phased::mPhase.

Port * Controllable::getPort ( CSL_MAP_KEY name )

inherited

Definition at line 920 of file CSL_Core.cpp.

References csl::Controllable::mInputs.

Referenced by csl::FrequencyAmount::getFrequency(), and csl::VSTIO::getParameter().

void Controllable::addInput	(	CSL_MAP_KEY	name,
		UnitGenerator &	ugen
	)

protectedinherited

Plug in a unit generator to the named input slot.

Definition at line 894 of file CSL_Core.cpp.

References csl::UnitGenerator::addOutput(), csl::logMsg(), and csl::Controllable::mInputs.

Referenced by csl::Joiner::addInput(), csl::BinaryOp::BinaryOp(), csl::DistanceSimulator::DistanceSimulator(), csl::Effect::Effect(), csl::InOut::InOut(), csl::Joiner::Joiner(), csl::NtoMPanner::NtoMPanner(), csl::Panner::Panner(), csl::Phased::Phased(), csl::Scalable::Scalable(), csl::FrequencyAmount::setAmount(), csl::FrequencyAmount::setFrequency(), csl::Phased::setFrequency(), csl::Effect::setInput(), csl::Scalable::setOffset(), csl::Panner::setPosition(), setRate(), csl::Scalable::setScale(), csl::NtoMPanner::setX(), csl::NtoMPanner::setY(), and csl::SpatialSource::SpatialSource().

void Controllable::addInput	(	CSL_MAP_KEY	name,
		float	value
	)

protectedinherited

Plug in a float to the named input slot.

Definition at line 906 of file CSL_Core.cpp.

References csl::logMsg(), csl::Controllable::mInputs, and csl::Port::mValue.

void Controllable::pullInput	(	Port *	thePort,
		unsigned	numFrames
	)
throw	(	CException
	)

protectedinherited

method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.

Definition at line 847 of file CSL_Core.cpp.

References csl::kSamples, csl::logMsg(), csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, csl::Buffer::mType, csl::UnitGenerator::nextBuffer(), and csl::Buffer::zeroBuffers().

Referenced by csl::Panner::nextBuffer(), csl::NtoMPanner::nextBuffer(), and csl::Effect::pullInput().

void Controllable::pullInput	(	Port *	thePort,
		Buffer &	theBuffer
	)
throw	(	CException
	)

protectedinherited

Definition at line 879 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().

void Scalable::setScale ( UnitGenerator & scale )

inherited

set the receiver's scale member to a UGen or a float

Definition at line 1039 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_SCALE, and csl::logMsg().

Referenced by createRandFreqEnvPatch(), csl::FancyFMInstrument::FancyFMInstrument(), csl::AdditiveInstrument::init(), csl::SndFileInstrument::initialize(), main(), csl::FMInstrument::parseArgs(), csl::SndFileInstrument::playNote(), csl::SndFileInstrument::playOSC(), csl::AdditiveInstrument::setParameter(), csl::SndFileInstrument::setParameter(), csl::FancyFMInstrument::setParameter(), sosNote(), test_SHARC(), test_SHARC2(), testADSR_FM(), testARSin2(), testComplexEnvelope(), testEnvScale(), testFancy_FM(), testFanMix1(), testFanMix2(), testMultiTap(), testRandFreqEnv(), testReverb(), testSplitJoin1(), testSplitJoin2(), testStereoverb(), testString(), testStringChorus(), testSumOfSines1F(), testSumOfSinesCached(), testSumOfSinesNonCached(), testSumOfSinesSteps(), and testWaveShaper().

void Scalable::setScale ( float scale )

inherited

Definition at line 1046 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_SCALE, and csl::logMsg().

void Scalable::setOffset ( UnitGenerator & offset )

inherited

set the receiver's offset member to a UGen or a float

Definition at line 1053 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void Scalable::setOffset ( float offset )

inherited

Definition at line 1060 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void csl::Scalable::isScaled ( )

inherited

answer whether scale = 1 & offset = 0

void Writeable::writeBuffer	(	Buffer &	inputBuffer,
		unsigned	bufNum
	)
throw	(	CException
	)

protectedvirtualinherited

write to the receiver

Reimplemented in csl::BufferStream, and csl::RingBuffer.

Definition at line 1265 of file CSL_Core.cpp.

void Seekable::reset	(		)
throw	(	CException
	)

virtualinherited

reset-to-zero

Definition at line 1277 of file CSL_Core.cpp.

References csl::kPositionStart, and csl::Seekable::seekTo().

Member Data Documentation

SoundFileMetadata* csl::Abst_SoundFile::mProperties

the ID3 tags properties

Definition at line 179 of file SoundFile.h.

Referenced by readTags(), and ~Abst_SoundFile().

string csl::Abst_SoundFile::mPath

protected

file name

Definition at line 182 of file SoundFile.h.

Referenced by Abst_SoundFile(), csl::CASoundFile::CASoundFile(), csl::LSoundFile::LSoundFile(), csl::LSoundFile::openForReadWrite(), path(), csl::CASoundFile::readBufferFromFile(), readTags(), and setPath().

SoundFileMode csl::Abst_SoundFile::mMode

protected

r/w mode

Definition at line 183 of file SoundFile.h.

Referenced by csl::JSoundFile::close(), csl::LSoundFile::initFromSndfile(), mode(), and csl::LSoundFile::openForReadWrite().

SoundFileFormat csl::Abst_SoundFile::mFormat

protected

sf format

Definition at line 184 of file SoundFile.h.

bool csl::Abst_SoundFile::mIsValid

protected

is my file valid?

Definition at line 185 of file SoundFile.h.

Referenced by channels(), durationInSecs(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), isActive(), isValid(), and setStart().

bool csl::Abst_SoundFile::mIsLooping

protected

am i looping start-stop?

Definition at line 186 of file SoundFile.h.

Referenced by isLooping(), csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), csl::LSoundFile::readBufferFromFile(), and setIsLooping().

int csl::Abst_SoundFile::mStart

protected

Definition at line 187 of file SoundFile.h.

Referenced by csl::SoundCue::duration(), durationInSecs(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::LSoundFile::readBufferFromFile(), setStart(), startFrame(), and trigger().

int csl::Abst_SoundFile::mStop

protected

starting/ending frames (or -1 if not used)

Definition at line 187 of file SoundFile.h.

Referenced by durationInSecs(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), isActive(), csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), csl::LSoundFile::readBufferFromFile(), setStop(), setToEnd(), and stopFrame().

double csl::Abst_SoundFile::mRate

protected

sample rate ratio

Definition at line 188 of file SoundFile.h.

Referenced by playbackRate(), and setRate().

unsigned csl::Abst_SoundFile::mNumFrames

protected

sample frames

Definition at line 189 of file SoundFile.h.

Referenced by convertRate(), duration(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), and csl::LSoundFile::isCached().

unsigned csl::Abst_SoundFile::mBytesPerSample

protected

the # of bytes per sample

Definition at line 190 of file SoundFile.h.

Referenced by csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::CASoundFile::readBufferFromFile(), and sampleSize().

unsigned csl::Abst_SoundFile::mBase

protected

starting frame in file of buffer

Definition at line 191 of file SoundFile.h.

Referenced by base(), csl::LSoundFile::initFromSndfile(), csl::LSoundFile::readBufferFromFile(), and setBase().

InterpolationPolicy csl::WavetableOscillator::mInterpolate

inherited

whether/how I should interpolate between samples

Definition at line 83 of file Oscillator.h.

Referenced by csl::WavetableOscillator::setInterpolate(), and csl::WavetableOscillator::WavetableOscillator().

Buffer csl::WavetableOscillator::mWavetable

inherited

unsigned csl::UnitGenerator::mFrameRate

protectedinherited

trigger ignored here

the frame rate – initialized to be the default by the constructor

Definition at line 288 of file CSL_Core.h.

Referenced by convertRate(), csl::Lorenz::dump(), durationInSecs(), csl::UnitGenerator::frameRate(), csl::Filter::init(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::RandEnvelope::nextSegment(), csl::SquareBL::nextWaveInto(), csl::SumOfSines::nextWaveInto(), csl::DelayLine::setDelayTime(), csl::UnitGenerator::setFrameRate(), setStartSec(), setStopSec(), csl::Butter::setupCoeffs(), csl::Formant::setupCoeffs(), csl::Notch::setupCoeffs(), and csl::Moog::setupCoeffs().

unsigned csl::UnitGenerator::mNumChannels

protectedinherited

my "expected" number of output channels

Definition at line 292 of file CSL_Core.h.

Referenced by csl::AmbisonicMixer::addInput(), csl::Mixer::allocateOpBuffer(), csl::AmbisonicDecoder::asProjection(), csl::AmbisonicDecoder::asPseudoInverse(), csl::BlockResizer::BlockResizer(), channels(), checkBuffer(), csl::FMInstrument::FMInstrument(), csl::GrainPlayer::GrainPlayer(), csl::AdditiveInstrument::init(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::AmbisonicMixer::initialize(), csl::SndFileInstrument::initialize(), csl::AmbisonicRotator::initialize(), csl::AmbisonicEncoder::initialize(), csl::AmbisonicDecoder::initialize(), csl::AmbisonicUnitGenerator::initOrder(), csl::RemoteStream::initPacket(), csl::Joiner::isActive(), csl::Joiner::Joiner(), csl::AmbisonicDecoder::makeInPhase(), csl::AmbisonicDecoder::makeMaxRE(), mergeToMono(), csl::Mixer::Mixer(), csl::UnitGenerator::numChannels(), csl::Panner::Panner(), csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), csl::LSoundFile::readBufferFromFile(), csl::RemoteStream::RemoteStream(), csl::UnitGenerator::setNumChannels(), csl::WavetableOscillator::setWaveform(), csl::Joiner::trigger(), and csl::AmbisonicRotator::~AmbisonicRotator().

BufferCopyPolicy csl::UnitGenerator::mCopyPolicy

protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 293 of file CSL_Core.h.

Referenced by csl::UnitGenerator::copyPolicy(), and csl::UnitGenerator::setCopyPolicy().

UGenVector csl::UnitGenerator::mOutputs

protectedinherited

the vector of my output UGens

Definition at line 294 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::dump(), csl::UnitGenerator::outputs(), and csl::UnitGenerator::removeOutput().

unsigned csl::UnitGenerator::mNumOutputs

protectedinherited

the number of outputs

Definition at line 295 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::numOutputs(), and csl::UnitGenerator::removeOutput().

Buffer* csl::UnitGenerator::mOutputCache

protectedinherited

my past output ring buffer (only used in case of fan-out)

Definition at line 296 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput().

unsigned csl::UnitGenerator::mSequence

protectedinherited

the highest-seen buffer seq number

Definition at line 297 of file CSL_Core.h.

sample csl::Phased::mPhase

protectedinherited

set phase

the actual phase accumulator

Definition at line 507 of file CSL_Core.h.

Referenced by csl::Phased::setPhase().

PortMap csl::Controllable::mInputs

protectedinherited

unsigned csl::Seekable::mCurrentFrame

inherited

where I currently am in the buffer

Definition at line 580 of file CSL_Core.h.

Referenced by Abst_SoundFile(), csl::DelayLine::delayLength(), isActive(), csl::LSoundFile::isCached(), isCached(), csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), csl::LSoundFile::readBufferFromFile(), csl::RingBufferTap::setOffset(), setToEnd(), and trigger().

double csl::Seekable::mActualFrame

inherited

where I actually am in the buffer

Definition at line 583 of file CSL_Core.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

sample frames

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

chans

Member Data Documentation

sample frames