CSL  5.2
csl::JackIO Class Reference

JackIO is an IO that uses a thread and a timer to call its graph's nextBuffer(); it doesn't do anything with the resulting buffer, but assumes that other objects (observers of the graph) will handle some actual IO. More...

#include <JackIO.h>

+ Inheritance diagram for csl::JackIO:

List of all members.

Public Member Functions

 JackIO ()
 Constructor.
 JackIO (unsigned s_rate, unsigned b_size, int in_device=0, int out_device=0, unsigned in_chans=0, unsigned out_chans=2)
virtual ~JackIO ()
void open () throw (CException)
 open/close start/stop methods
void close () throw (CException)
 open/close start/stop methods
void start () throw (CException)
 start my timer thread
void stop () throw (CException)
 stop the timer thread
virtual void test () throw (CException)
void setRoot (UnitGenerator &root)
 test the IO's graph
void clearRoot ()
 set/clear my graph root generator
void pullInput (Buffer &outBuffer, SampleBuffer out=0) throw (CException)
 get a buffer from the CSL graph
virtual BuffergetInput () throw (CException)
 Get the current input from the sound card.
virtual BuffergetInput (unsigned numFrames, unsigned numChannels) throw (CException)
unsigned getAndIncrementSequence ()
 increment and answer my seq #
void attachObserver (Observer *)
 (possibly notify obersvers on my death)
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
virtual int evaluate (void *argument)

Public Attributes

jack_port_t * mInput_port
jack_port_t * mOutput_port
jack_client_t * mClient
UnitGeneratormGraph
 the root of my client DSP graph, often a mixer or panner
Buffer mInputBuffer
 the most recent input buffer (if it's turned on)
Buffer mOutputBuffer
 the output buffer I use (passed to nextBuffer calls)
SampleBuffer mInputPointer
 the buffer for holding the sound card input (if open)
unsigned * mChannelMap
 the output channel remapping array
unsigned mNumFramesPlayed
 counter of frames I've played
unsigned mSequence
 sequence counter
unsigned mLoggingPeriod
 logging period in seconds
unsigned mNumInChannels
 

inputs


unsigned mNumOutChannels
 

outputs


unsigned mNumRealInChannels
 

physical inputs


unsigned mNumRealOutChannels
 

physical outputs


IO_Status mStatus
 status flag
bool mInterleaved
 flag if IO is interleaved

Protected Member Functions

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

Detailed Description

JackIO is an IO that uses a thread and a timer to call its graph's nextBuffer(); it doesn't do anything with the resulting buffer, but assumes that other objects (observers of the graph) will handle some actual IO.

Definition at line 22 of file JackIO.h.


Constructor & Destructor Documentation

JackIO::JackIO ( )

Constructor.

Definition at line 41 of file JackIO.cpp.

JackIO::JackIO ( unsigned  s_rate,
unsigned  b_size,
int  in_device = 0,
int  out_device = 0,
unsigned  in_chans = 0,
unsigned  out_chans = 2 
)

Definition at line 45 of file JackIO.cpp.

JackIO::~JackIO ( )
virtual

Definition at line 52 of file JackIO.cpp.


Member Function Documentation

void JackIO::open ( ) throw (CException)
virtual

open/close start/stop methods

< open/close start/stop methods

Reimplemented from csl::IO.

Definition at line 66 of file JackIO.cpp.

References jack_shutdown(), JackCallback(), csl::kLogError, csl::logMsg(), mClient, mInput_port, mOutput_port, and ports.

void JackIO::close ( ) throw (CException)
virtual

open/close start/stop methods

Reimplemented from csl::IO.

Definition at line 124 of file JackIO.cpp.

References mClient.

void JackIO::start ( void  ) throw (CException)
virtual

start my timer thread

< start my timer thread

Reimplemented from csl::IO.

Definition at line 128 of file JackIO.cpp.

void JackIO::stop ( void  ) throw (CException)
virtual

stop the timer thread

< stop the timer thread

Reimplemented from csl::IO.

Definition at line 131 of file JackIO.cpp.

virtual void csl::IO::test ( ) throw (CException)
inlinevirtualinherited

Reimplemented in csl::FileIO, and csl::PAIO.

Definition at line 727 of file CSL_Core.h.

void IO::setRoot ( UnitGenerator root)
inherited

test the IO's graph

Definition at line 1249 of file CSL_Core.cpp.

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

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

void IO::clearRoot ( )
inherited

set/clear my graph root generator

Definition at line 1254 of file CSL_Core.cpp.

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

void IO::pullInput ( Buffer outBuffer,
SampleBuffer  out = 0 
) throw (CException)
inherited
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 1358 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 1364 of file CSL_Core.cpp.

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

unsigned IO::getAndIncrementSequence ( )
inherited

increment and answer my seq #

Definition at line 1262 of file CSL_Core.cpp.

References csl::IO::mSequence.

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 765 of file CSL_Core.h.

void Model::attachObserver ( Observer o)
inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 491 of file CGestalt.cpp.

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

Referenced by csl::SpatialPanner::setSpeakerLayout().

void Model::detachObserver ( Observer o)
inherited
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 529 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 259 of file CGestalt.h.


Member Data Documentation

jack_port_t* csl::JackIO::mInput_port

Definition at line 35 of file JackIO.h.

Referenced by JackCallback(), and open().

jack_port_t* csl::JackIO::mOutput_port

Definition at line 36 of file JackIO.h.

Referenced by JackCallback(), and open().

jack_client_t* csl::JackIO::mClient

Definition at line 37 of file JackIO.h.

Referenced by close(), JackCallback(), and open().

Buffer csl::IO::mInputBuffer
inherited
SampleBuffer csl::IO::mInputPointer
inherited

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

Definition at line 742 of file CSL_Core.h.

Referenced by pa_callback().

unsigned* csl::IO::mChannelMap
inherited

the output channel remapping array

Definition at line 743 of file CSL_Core.h.

Referenced by csl::PAIO::initialize().

unsigned csl::IO::mNumFramesPlayed
inherited

counter of frames I've played

Definition at line 745 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 746 of file CSL_Core.h.

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

unsigned csl::IO::mLoggingPeriod
inherited

logging period in seconds

Definition at line 747 of file CSL_Core.h.

unsigned csl::IO::mNumInChannels
inherited

inputs

Definition at line 748 of file CSL_Core.h.

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

unsigned csl::IO::mNumOutChannels
inherited
unsigned csl::IO::mNumRealInChannels
inherited

physical inputs

Definition at line 750 of file CSL_Core.h.

Referenced by csl::PAIO::initialize().

unsigned csl::IO::mNumRealOutChannels
inherited

physical outputs

Definition at line 751 of file CSL_Core.h.

Referenced by csl::PAIO::initialize().

bool csl::IO::mInterleaved
inherited

flag if IO is interleaved

Definition at line 753 of file CSL_Core.h.

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


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