CSL  6.0
csl::RemoteStream Class Reference

RemoteStream class. More...

#include <RemoteStream.h>

+ Inheritance diagram for csl::RemoteStream:

Public Member Functions

 RemoteStream (char *clientName, unsigned short clientPort, unsigned ch, unsigned bufSize)
 Constructor. More...
 
 ~RemoteStream ()
 
sample ** ioBuffers ()
 Accessors used by the reader thread. More...
 
int socket ()
 
unsigned short requestSize ()
 
unsigned bufferSwitch ()
 
unsigned bufferIndex ()
 
unsigned bufferSize ()
 
sem_t * semaphore ()
 
void nextBuffer (Buffer &outputBuffer) throw (CException)
 Get a buffer of frames. 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 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...
 
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this) More...
 
virtual bool isActive ()
 query whether I'm currently active (Envelopes can go inactive) 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 ()
 
virtual void dump ()
 pretty-print the receiver More...
 
virtual void trigger ()
 
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)
 

Protected Member Functions

int initSockets (char *serverName, unsigned short serverPort)
 
void initPacket ()
 
virtual int connectToServer ()
 
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer More...
 

Protected Attributes

unsigned mBufferSize
 the size of the input ring buffer (in FRAMES) More...
 
samplemIoBuffers [2]
 My IO buffers (2 for dbl-buffering; mBufferSize frames in size) More...
 
unsigned mCurrentBuffer
 current IO buffer in use More...
 
unsigned mCurrentFrame
 current position in buffer More...
 
int mSocket
 The socket I send to. More...
 
CSL_RS_MSG mHeader
 The request packet header. More...
 
struct sockaddr_in mServerAddr
 Socket addresses for the remote server and for me. More...
 
sem_t * mServerSemaphore
 Semaphore to trigger call to server for samples. 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...
 
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out) More...
 
unsigned mSequence
 the highest-seen buffer seq number More...
 

Detailed Description

RemoteStream class.

Definition at line 100 of file RemoteStream.h.

Constructor & Destructor Documentation

RemoteStream::RemoteStream ( char *  clientName,
unsigned short  clientPort,
unsigned  ch,
unsigned  bufSize 
)
RemoteStream::~RemoteStream ( )

Definition at line 142 of file RemoteStream.cpp.

References closesocket, mIoBuffers, and mSocket.

Member Function Documentation

sample** csl::RemoteStream::ioBuffers ( )
inline

Accessors used by the reader thread.

Definition at line 107 of file RemoteStream.h.

References mIoBuffers.

int csl::RemoteStream::socket ( )
inline

Definition at line 108 of file RemoteStream.h.

References mSocket.

Referenced by initSockets().

unsigned short csl::RemoteStream::requestSize ( )
inline

Definition at line 109 of file RemoteStream.h.

unsigned csl::RemoteStream::bufferSwitch ( )
inline

Definition at line 110 of file RemoteStream.h.

References mCurrentBuffer.

unsigned csl::RemoteStream::bufferIndex ( )
inline

Definition at line 111 of file RemoteStream.h.

References mCurrentFrame.

unsigned csl::RemoteStream::bufferSize ( )
inline

Definition at line 112 of file RemoteStream.h.

References mBufferSize.

sem_t* csl::RemoteStream::semaphore ( )
inline

Definition at line 113 of file RemoteStream.h.

References mServerSemaphore.

void RemoteStream::nextBuffer ( Buffer outputBuffer)
throw (CException
)
virtual

Get a buffer of frames.

Reimplemented from csl::UnitGenerator.

Definition at line 152 of file RemoteStream.cpp.

References RS_PACKET_SIZE.

int RemoteStream::initSockets ( char *  serverName,
unsigned short  serverPort 
)
protected

Definition at line 66 of file RemoteStream.cpp.

References csl::logMsg(), mBufferSize, mServerAddr, mServerSemaphore, mSocket, and socket().

Referenced by RemoteStream().

int RemoteStream::connectToServer ( )
protectedvirtual
unsigned csl::UnitGenerator::frameRate ( )
inlineinherited
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.

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

virtual bool csl::UnitGenerator::isActive ( )
inlinevirtualinherited
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.

virtual void csl::UnitGenerator::trigger ( void  )
inlinevirtualinherited
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
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

unsigned csl::RemoteStream::mBufferSize
protected

the size of the input ring buffer (in FRAMES)

Definition at line 119 of file RemoteStream.h.

Referenced by bufferSize(), initPacket(), initSockets(), and RemoteStream().

sample* csl::RemoteStream::mIoBuffers[2]
protected

My IO buffers (2 for dbl-buffering; mBufferSize frames in size)

Definition at line 120 of file RemoteStream.h.

Referenced by connectToServer(), initPacket(), ioBuffers(), RemoteStream(), and ~RemoteStream().

unsigned csl::RemoteStream::mCurrentBuffer
protected

current IO buffer in use

Definition at line 121 of file RemoteStream.h.

Referenced by bufferSwitch(), and RemoteStream().

unsigned csl::RemoteStream::mCurrentFrame
protected

current position in buffer

Definition at line 122 of file RemoteStream.h.

Referenced by bufferIndex(), and RemoteStream().

int csl::RemoteStream::mSocket
protected

The socket I send to.

Definition at line 125 of file RemoteStream.h.

Referenced by connectToServer(), initSockets(), RemoteStream(), socket(), and ~RemoteStream().

CSL_RS_MSG csl::RemoteStream::mHeader
protected

The request packet header.

Definition at line 126 of file RemoteStream.h.

Referenced by initPacket().

struct sockaddr_in csl::RemoteStream::mServerAddr
protected

Socket addresses for the remote server and for me.

Definition at line 127 of file RemoteStream.h.

Referenced by connectToServer(), and initSockets().

sem_t* csl::RemoteStream::mServerSemaphore
protected

Semaphore to trigger call to server for samples.

Definition at line 128 of file RemoteStream.h.

Referenced by initSockets(), RemoteStream(), and semaphore().

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


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