CSL  5.2
csl::RtpSender Class Reference

#include <RtpSender.h>

+ Inheritance diagram for csl::RtpSender:

List of all members.

Public Member Functions

 RtpSender (unsigned chans=1)
 ~RtpSender ()
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
bool createRtpSession ()
bool addRtpDestination (char *remoteIP, unsigned short remotePort)
bool removeRtpDestination ()
void printError (int rtperr)
virtual bool isActive ()
 am I active?
void setInput (UnitGenerator &inp)
 set the receiver's input generator
void setInline ()
 set the Effect to be inline
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)
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
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)
PortgetPort (CSL_MAP_KEY name)

Public Attributes

bool isInline
 whether to use input or buffer as source
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

void pullInput (Buffer &outputBuffer) throw (CException)
void pullInput (unsigned numFrames) throw (CException)
 trigger passed on here
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.
void pullInput (Port *thePort, Buffer &theBuffer) throw (CException)
virtual void trigger ()
 trigger passed on here get the input port
PortinPort ()
virtual void dump ()
 pretty-print the receiver's input/controls map
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer
void addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
 Plug in a unit generator to the named input slot.
void addInput (CSL_MAP_KEY name, float value)
 Plug in a float to the named input slot.
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
unsigned mRemotePort
 The network port I send to.
unsigned mLocalPort
 The network port I listen on.
unsigned mRemoteIP
 The IP address of the client in host byte order.
unsigned mLocalIP
 My IP address in host byte order.
string mCName
 The CName of my computer.
string mEmail
 My email I want registered with RTP.
int mLastPacketNumber
 The RTP ID of the last packet sent (or -1 if none)
int mPayloadType
 The RTP payload type we are sending.
RTPUDPv4TransmissionParams * mTransparams
RTPSessionParams * mSessparams
RTPIPv4Address * mAddress
SampleBuffer mInputPtr
 A pointer to my input's data. method to read the input value.
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
PortMap mInputs
 the map of my inputs or controls (used by the mix-in classes)

Detailed Description

Definition at line 31 of file RtpSender.h.


Constructor & Destructor Documentation

RtpSender::RtpSender ( unsigned  chans = 1)
RtpSender::~RtpSender ( )

Definition at line 50 of file RtpSender.cpp.

References mAddress, mSessparams, and mTransparams.


Member Function Documentation

void RtpSender::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 126 of file RtpSender.cpp.

References csl::Port::mBuffer, and csl::Buffer::monoBuffer().

bool RtpSender::createRtpSession ( )
bool RtpSender::addRtpDestination ( char *  remoteIP,
unsigned short  remotePort 
)

Definition at line 82 of file RtpSender.cpp.

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

bool RtpSender::removeRtpDestination ( )

Definition at line 104 of file RtpSender.cpp.

References mAddress.

void RtpSender::printError ( int  rtperr)

Definition at line 110 of file RtpSender.cpp.

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

Referenced by addRtpDestination(), and createRtpSession().

bool Effect::isActive ( )
virtualinherited

am I active?

Reimplemented from csl::UnitGenerator.

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

Definition at line 951 of file CSL_Core.cpp.

References CSL_INPUT, csl::Port::isActive(), and csl::Controllable::mInputs.

Referenced by csl::Stereoverb::isActive().

void Effect::setInput ( UnitGenerator inp)
inherited

set the receiver's input generator

Definition at line 958 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_INPUT, csl::Effect::isInline, and csl::logMsg().

void csl::Effect::setInline ( )
inlineinherited

set the Effect to be inline

Definition at line 446 of file CSL_Core.h.

References csl::Effect::isInline.

void Effect::pullInput ( unsigned  numFrames) throw (CException)
protectedinherited

trigger passed on here

Definition at line 983 of file CSL_Core.cpp.

References csl::Buffer::buffer(), CSL_INPUT, csl::logMsg(), csl::Port::mBuffer, and csl::Controllable::pullInput().

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 695 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 727 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().

void Effect::trigger ( void  )
protectedvirtualinherited

trigger passed on here get the input port

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::Joiner.

Definition at line 994 of file CSL_Core.cpp.

References CSL_INPUT, and csl::Controllable::mInputs.

Port* csl::Effect::inPort ( )
inlineprotectedinherited

Definition at line 455 of file CSL_Core.h.

References CSL_INPUT, and csl::Controllable::mInputs.

Referenced by csl::BinaryOp::dump(), and csl::BinaryOp::inputIsFixed().

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.

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.

void Controllable::dump ( void  )
protectedvirtualinherited
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.

Port * Controllable::getPort ( CSL_MAP_KEY  name)
inherited
void Controllable::addInput ( CSL_MAP_KEY  name,
float  value 
)
protectedinherited

Plug in a float to the named input slot.

Definition at line 754 of file CSL_Core.cpp.

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

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.


Member Data Documentation

unsigned csl::RtpSender::mNumChans
protected

Definition at line 47 of file RtpSender.h.

SynchPthread csl::RtpSender::mRtpMutex
protected

Definition at line 48 of file RtpSender.h.

unsigned csl::RtpSender::mBufferFrames
protected

Definition at line 50 of file RtpSender.h.

unsigned csl::RtpSender::mRemotePort
protected

The network port I send to.

Definition at line 52 of file RtpSender.h.

Referenced by addRtpDestination().

unsigned csl::RtpSender::mLocalPort
protected

The network port I listen on.

Definition at line 53 of file RtpSender.h.

Referenced by createRtpSession().

unsigned csl::RtpSender::mRemoteIP
protected

The IP address of the client in host byte order.

Definition at line 54 of file RtpSender.h.

Referenced by addRtpDestination().

unsigned csl::RtpSender::mLocalIP
protected

My IP address in host byte order.

Definition at line 55 of file RtpSender.h.

string csl::RtpSender::mCName
protected

The CName of my computer.

Definition at line 56 of file RtpSender.h.

string csl::RtpSender::mEmail
protected

My email I want registered with RTP.

Definition at line 57 of file RtpSender.h.

int csl::RtpSender::mLastPacketNumber
protected

The RTP ID of the last packet sent (or -1 if none)

Definition at line 58 of file RtpSender.h.

Referenced by RtpSender().

int csl::RtpSender::mPayloadType
protected

The RTP payload type we are sending.

Definition at line 59 of file RtpSender.h.

Referenced by RtpSender().

RTPUDPv4TransmissionParams* csl::RtpSender::mTransparams
protected

Definition at line 61 of file RtpSender.h.

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

RTPSessionParams* csl::RtpSender::mSessparams
protected

Definition at line 62 of file RtpSender.h.

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

RTPIPv4Address* csl::RtpSender::mAddress
protected

Definition at line 63 of file RtpSender.h.

Referenced by addRtpDestination(), removeRtpDestination(), and ~RtpSender().

bool csl::Effect::isInline
inherited

whether to use input or buffer as source

Definition at line 445 of file CSL_Core.h.

Referenced by csl::Effect::Effect(), csl::Effect::setInline(), and csl::Effect::setInput().

SampleBuffer csl::Effect::mInputPtr
protectedinherited

A pointer to my input's data. method to read the input value.

Definition at line 449 of file CSL_Core.h.

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.

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


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