OpalMediaPatch Class Reference

#include <patch.h>

Inheritance diagram for OpalMediaPatch:


Public Member Functions
Overrides from PObject
void	PrintOn (ostream &strm) const
Operations
virtual void	Start ()
virtual void	Close ()
BOOL	AddSink (OpalMediaStream *stream, const RTP_DataFrame::PayloadMapType &rtpMap)
void	RemoveSink (OpalMediaStream *stream)
OpalMediaStream &	GetSource () const
OpalMediaFormat	GetSinkFormat (PINDEX i=0) const
void	AddFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat())
BOOL	RemoveFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat())
virtual void	FilterFrame (RTP_DataFrame &frame, const OpalMediaFormat &mediaFormat)
virtual BOOL	UpdateMediaFormat (const OpalMediaFormat &mediaFormat, BOOL fromSink)
virtual BOOL	ExecuteCommand (const OpalMediaCommand &command, BOOL fromSink)
virtual void	SetCommandNotifier (const PNotifier &notifier, BOOL fromSink)
virtual BOOL	PushFrame (RTP_DataFrame &)
virtual OpalTranscoder *	GetAndLockSinkTranscoder (PINDEX i=0) const
virtual void	UnLockSinkTranscoder () const
Protected Member Functions
virtual void	Main ()
void	DispatchFrame (RTP_DataFrame &frame)
Protected Attributes
OpalMediaStream &	source
PList< Sink >	sinks
PList< Filter >	filters
Thread *	patchThread
PMutex	patchThreadMutex
PTimedMutex	inUse
Classes
class	Filter
class	Sink
class	Thread

Detailed Description

Media stream "patch cord". This class is the thread of control that transfers data from one "source" OpalMediStream to one or more other "sink" OpalMediStream instances. It may use zero, one or two intermediary software codecs for each sink stream in order to match the media data formats the streams are capabile of doing natively.

Note the thread is not actually started straight away. It is expected that the Start() function is called on the patch when the creator code is ready for it to begin. For example all sink streams have been added.

Constructor & Destructor Documentation

OpalMediaPatch::OpalMediaPatch ( OpalMediaStream & source )

Create a new patch. Note the thread is not started here.

Parameters:

source

Source media stream

OpalMediaPatch::~OpalMediaPatch ( )

Destroy patch.

OpalMediaPatch::OpalMediaPatch ( OpalMediaStream & source )

Create a new patch. Note the thread is not started here.

Parameters:

source

Source media stream

OpalMediaPatch::~OpalMediaPatch ( )

Destroy patch.

Member Function Documentation

void OpalMediaPatch::PrintOn ( ostream & strm ) const

Standard stream print function. The PObject class has a << operator defined that calls this function polymorphically.

Parameters:

strm

Stream to output text representation

virtual void OpalMediaPatch::Start ( ) [virtual]

Start the patch. The default implementation simply starts the patch thread, which in turn calls Main()

Reimplemented in OpalPassiveMediaPatch.

virtual void OpalMediaPatch::Close ( ) [virtual]

Close the patch. This is an internal function that closes all of the sink streams and waits for the the thread to terminate. It is called when the source stream is called.

BOOL OpalMediaPatch::AddSink	(	OpalMediaStream *	stream,
		const RTP_DataFrame::PayloadMapType &	rtpMap
	)

Add another "sink" OpalMediaStream to patch. The stream must not be a ReadOnly media stream for the patch to be able to write to it.

Parameters:

stream	Media stream to add.
rtpMap	Outgoing RTP type map

void OpalMediaPatch::RemoveSink ( OpalMediaStream * stream )

Add existing "sink" OpalMediaStream to patch. If the stream is not a sink of this patch then this function does nothing.

Parameters:

stream

Medai stream to remove

OpalMediaStream& OpalMediaPatch::GetSource ( ) const [inline]

Get the current source stream for patch.

OpalMediaFormat OpalMediaPatch::GetSinkFormat ( PINDEX i = 0 ) const

Get the mediaformat for a sink stream

void OpalMediaPatch::AddFilter	(	const PNotifier &	filter,
		const OpalMediaFormat &	stage = `OpalMediaFormat()`
	)

Add a filter to the media pipeline. Use PDECLARE_NOTIFIER(RTP_DataFrame, YourClass, YourFunction) for the filter function notifier.

BOOL OpalMediaPatch::RemoveFilter	(	const PNotifier &	filter,
		const OpalMediaFormat &	stage = `OpalMediaFormat()`
	)

Remove a filter from the media pipeline.

virtual void OpalMediaPatch::FilterFrame	(	RTP_DataFrame &	frame,
		const OpalMediaFormat &	mediaFormat
	)			`[virtual]`

Filter a frame. Calls all filter functions.

virtual BOOL OpalMediaPatch::UpdateMediaFormat	(	const OpalMediaFormat &	mediaFormat,
		BOOL	fromSink
	)			`[virtual]`

Update the source/sink media format. This can be used to adjust the parameters of a codec at run time. Note you cannot change the basic media format, eg change GSM0610 to G.711, only options for that format, eg 6k3 mode to 5k3 mode in G.723.1.

The default behaviour updates the source/sink media stream and the output side of any relevant transcoders.

Parameters:

mediaFormat	New media format
fromSink	Flag for source or sink

virtual BOOL OpalMediaPatch::ExecuteCommand	(	const OpalMediaCommand &	command,
		BOOL	fromSink
	)			`[virtual]`

Execute the command specified to the transcoder. The commands are highly context sensitive, for example VideoFastUpdate would only apply to a video transcoder.

The default behaviour passes the command on to the source or sinks and the sinks transcoders.

Parameters:

command	Command to execute.
fromSink	Flag for source or sink

virtual void OpalMediaPatch::SetCommandNotifier	(	const PNotifier &	notifier,
		BOOL	fromSink
	)			`[virtual]`

Set a notifier to receive commands generated by the transcoder. The commands are highly context sensitive, for example VideoFastUpdate would only apply to a video transcoder.

The default behaviour passes the command on to the source or sinks and the sinks transcoders.

Parameters: