CSL  5.2
csl::RtpReceiver Class Reference

#include <RtpReceiver.h>

+ Inheritance diagram for csl::RtpReceiver:

List of all members.

Public Member Functions

 RtpReceiver (unsigned chans=1)
 Default constructor initializes an RtpReceiver with default 20ms bufSize.
 ~RtpReceiver ()
 Class destructor.
unsigned bufferSize ()
 Accessors used by the reader thread.
unsigned remotePort ()
void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (Exception)
 really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times
void setLocalPort (unsigned localPort)
void setBufferSize (unsigned bufferSize)
bool addRtpSource (char *remoteIP, unsigned short remotePort)
bool removeRtpSource ()
void printError (int rtperr)

Public Attributes

RingBuffer mRtpBuffer
 The ring buffer between the RTP client and the PortAudio object.
Buffer mTmpBuffer
 A temporary buffer used throughout the class.

Protected Member Functions

bool createRtpSession ()
void OnRTPPacket (RTPPacket *pack, const RTPTime &receivetime, const RTPAddress *senderaddress)
void OnRTCPCompoundPacket (RTCPCompoundPacket *pack, const RTPTime &receivetime, const RTPAddress *senderaddress)
void OnSSRCCollision (RTPSourceData *srcdat, const RTPAddress *senderaddress, bool isrtp)
void OnCNAMECollision (RTPSourceData *srcdat, const RTPAddress *senderaddress, const u_int8_t *cname, size_t cnamelength)
void OnNewSource (RTPSourceData *srcdat)
void OnRemoveSource (RTPSourceData *srcdat)
void OnTimeout (RTPSourceData *srcdat)
void OnBYETimeout (RTPSourceData *srcdat)
void OnAPPPacket (RTCPAPPPacket *apppacket, const RTPTime &receivetime, const RTPAddress *senderaddress)
void OnUnknownPacketType (RTCPPacket *rtcppack, const RTPTime &receivetime, const RTPAddress *senderaddress)
void OnUnknownPacketFormat (RTCPPacket *rtcppack, const RTPTime &receivetime, const RTPAddress *senderaddress)
void OnNoteTimeout (RTPSourceData *srcdat)
void OnBYEPacket (RTPSourceData *srcdat)

Protected Attributes

unsigned mNumChans
SynchPthread mRtpMutex
unsigned mBufferFrames
 the size of the RTP ring buffer (in FRAMES)
unsigned long mRemoteIP
unsigned short mRemotePort
unsigned long mLocalIP
unsigned short mLocalPort
RtpBufferState mBufferState
RTPUDPv4TransmissionParams * mTransparams
RTPSessionParams * mSessparams
RTPIPv4Address * mAddress
unsigned mLastPacketNumber
 The ID of the last packet received.

Private Member Functions

unsigned frameRate ()
void setFrameRate (unsigned rate)
 get/set the receiver's frame rate
virtual unsigned numChannels ()
void setNumChannels (unsigned ch)
 get/set the receiver's number of outputs
BufferCopyPolicy copyPolicy ()
void setCopyPolicy (BufferCopyPolicy ch)
 get/set the receiver's buffer copy policy
virtual void nextBuffer (Buffer &outputBuffer) throw (CException)
 get a buffer of Frames – this is the core CSL "pull" function; the given buffer can be written into, and a changed() message is sent.
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this)
virtual bool isActive ()
 query whether I'm currently active (Envelopes can go inactive)
void addOutput (UnitGenerator *ugen)
 add to or return the UGen vector of outputs
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
void handleFanOut (Buffer &outputBuffer) throw (CException)
virtual void setValue (sample theValue)
 set/get the value (not allowed in the abstract, useful for static values)
virtual sample value ()
virtual void dump ()
 pretty-print the receiver
virtual void trigger ()
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer
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)

Private Attributes

unsigned mFrameRate
 trigger ignored here
unsigned mNumChannels
 my "expected" number of output channels
BufferCopyPolicy mCopyPolicy
 the policy I use if asked for more or fewer channels
UGenVector mOutputs
 the vector of my output UGens
unsigned mNumOutputs
 the number of outputs
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out)
unsigned mSequence
 the highest-seen buffer seq number

Detailed Description

Definition at line 58 of file RtpReceiver.h.


Constructor & Destructor Documentation

RtpReceiver::RtpReceiver ( unsigned  chans = 1)

Default constructor initializes an RtpReceiver with default 20ms bufSize.

Definition at line 18 of file RtpReceiver.cpp.

References createRtpSession(), error(), csl::kLogError, csl::logMsg(), mSessparams, and mTransparams.

RtpReceiver::~RtpReceiver ( )

Class destructor.

Definition at line 50 of file RtpReceiver.cpp.

References mAddress, mSessparams, and mTransparams.


Member Function Documentation

unsigned csl::RtpReceiver::bufferSize ( )
inline

Accessors used by the reader thread.

Definition at line 67 of file RtpReceiver.h.

References mBufferFrames.

unsigned csl::RtpReceiver::remotePort ( )
inline

Definition at line 68 of file RtpReceiver.h.

References mRemotePort.

Referenced by addRtpSource().

void RtpReceiver::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
) throw (Exception)
virtual

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

Reimplemented from csl::UnitGenerator.

Definition at line 131 of file RtpReceiver.cpp.

References csl::kBuffering.

void csl::RtpReceiver::setLocalPort ( unsigned  localPort)
void csl::RtpReceiver::setBufferSize ( unsigned  bufferSize)
bool RtpReceiver::addRtpSource ( char *  remoteIP,
unsigned short  remotePort 
)

Definition at line 84 of file RtpReceiver.cpp.

References mAddress, mRemoteIP, mRemotePort, printError(), and remotePort().

bool RtpReceiver::removeRtpSource ( )

Definition at line 106 of file RtpReceiver.cpp.

References mAddress.

void RtpReceiver::printError ( int  rtperr)

Definition at line 112 of file RtpReceiver.cpp.

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

Referenced by addRtpSource(), and createRtpSession().

bool RtpReceiver::createRtpSession ( )
protected
void CslRtpSession::OnRTPPacket ( RTPPacket *  pack,
const RTPTime &  receivetime,
const RTPAddress *  senderaddress 
)
protectedinherited
void CslRtpSession::OnRTCPCompoundPacket ( RTCPCompoundPacket *  pack,
const RTPTime &  receivetime,
const RTPAddress *  senderaddress 
)
protectedinherited

Definition at line 58 of file CslRtpSession.cpp.

void CslRtpSession::OnSSRCCollision ( RTPSourceData *  srcdat,
const RTPAddress *  senderaddress,
bool  isrtp 
)
protectedinherited

Definition at line 234 of file CslRtpSession.cpp.

void CslRtpSession::OnCNAMECollision ( RTPSourceData *  srcdat,
const RTPAddress *  senderaddress,
const u_int8_t *  cname,
size_t  cnamelength 
)
protectedinherited

Definition at line 238 of file CslRtpSession.cpp.

void CslRtpSession::OnNewSource ( RTPSourceData *  srcdat)
protectedinherited

Definition at line 244 of file CslRtpSession.cpp.

void CslRtpSession::OnRemoveSource ( RTPSourceData *  srcdat)
protectedinherited

Definition at line 253 of file CslRtpSession.cpp.

void CslRtpSession::OnTimeout ( RTPSourceData *  srcdat)
protectedinherited

Definition at line 260 of file CslRtpSession.cpp.

void CslRtpSession::OnBYETimeout ( RTPSourceData *  srcdat)
protectedinherited

Definition at line 267 of file CslRtpSession.cpp.

void CslRtpSession::OnAPPPacket ( RTCPAPPPacket *  apppacket,
const RTPTime &  receivetime,
const RTPAddress *  senderaddress 
)
protectedinherited

Definition at line 274 of file CslRtpSession.cpp.

void CslRtpSession::OnUnknownPacketType ( RTCPPacket *  rtcppack,
const RTPTime &  receivetime,
const RTPAddress *  senderaddress 
)
protectedinherited

Definition at line 282 of file CslRtpSession.cpp.

void CslRtpSession::OnUnknownPacketFormat ( RTCPPacket *  rtcppack,
const RTPTime &  receivetime,
const RTPAddress *  senderaddress 
)
protectedinherited

Definition at line 289 of file CslRtpSession.cpp.

void CslRtpSession::OnNoteTimeout ( RTPSourceData *  srcdat)
protectedinherited

Definition at line 296 of file CslRtpSession.cpp.

void CslRtpSession::OnBYEPacket ( RTPSourceData *  srcdat)
protectedinherited

Definition at line 303 of file CslRtpSession.cpp.

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

get/set the receiver's frame rate

Definition at line 226 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by m3_header().

void csl::UnitGenerator::setNumChannels ( unsigned  ch)
inlineinherited
BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )
inlineinherited

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

virtual bool csl::UnitGenerator::isActive ( )
inlinevirtualinherited
UGenVector csl::UnitGenerator::outputs ( )
inlineinherited

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )
inlinevirtualinherited

Definition at line 254 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 549 of file CSL_Core.cpp.

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

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

virtual sample csl::UnitGenerator::value ( )
inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 261 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 513 of file CSL_Core.cpp.

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

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

unsigned csl::RtpReceiver::mNumChans
protected

Definition at line 83 of file RtpReceiver.h.

SynchPthread csl::RtpReceiver::mRtpMutex
protected

Definition at line 84 of file RtpReceiver.h.

unsigned csl::RtpReceiver::mBufferFrames
protected

the size of the RTP ring buffer (in FRAMES)

Definition at line 85 of file RtpReceiver.h.

Referenced by bufferSize().

unsigned long csl::RtpReceiver::mRemoteIP
protected

Definition at line 87 of file RtpReceiver.h.

Referenced by addRtpSource().

unsigned short csl::RtpReceiver::mRemotePort
protected

Definition at line 88 of file RtpReceiver.h.

Referenced by addRtpSource(), and remotePort().

unsigned long csl::RtpReceiver::mLocalIP
protected

Definition at line 89 of file RtpReceiver.h.

unsigned short csl::RtpReceiver::mLocalPort
protected

Definition at line 90 of file RtpReceiver.h.

Referenced by createRtpSession().

RtpBufferState csl::RtpReceiver::mBufferState
protected

Definition at line 92 of file RtpReceiver.h.

RTPUDPv4TransmissionParams* csl::RtpReceiver::mTransparams
protected

Definition at line 94 of file RtpReceiver.h.

Referenced by createRtpSession(), RtpReceiver(), and ~RtpReceiver().

RTPSessionParams* csl::RtpReceiver::mSessparams
protected

Definition at line 95 of file RtpReceiver.h.

Referenced by createRtpSession(), RtpReceiver(), and ~RtpReceiver().

RTPIPv4Address* csl::RtpReceiver::mAddress
protected

Definition at line 96 of file RtpReceiver.h.

Referenced by addRtpSource(), removeRtpSource(), and ~RtpReceiver().

unsigned csl::RtpReceiver::mLastPacketNumber
protected

The ID of the last packet received.

Definition at line 98 of file RtpReceiver.h.

RingBuffer csl::CslRtpSession::mRtpBuffer
inherited

The ring buffer between the RTP client and the PortAudio object.

Definition at line 56 of file CslRtpSession.h.

Referenced by csl::CslRtpSession::OnRTPPacket().

Buffer csl::CslRtpSession::mTmpBuffer
inherited

A temporary buffer used throughout the class.

Definition at line 57 of file CslRtpSession.h.

Referenced by csl::CslRtpSession::CslRtpSession(), csl::CslRtpSession::OnRTPPacket(), and csl::CslRtpSession::~CslRtpSession().

unsigned csl::UnitGenerator::mNumChannels
protectedinherited
BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 269 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 271 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 272 of file CSL_Core.h.

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

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 273 of file CSL_Core.h.


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