#include <mediastrm.h>

Inheritance diagram for OpalRawMediaStream:

Collaboration diagram for OpalRawMediaStream:

Public Member Functions
Overrides of OpalMediaStream class
virtual PBoolean	ReadData (BYTE *data, PINDEX size, PINDEX &length)

virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)

PChannel *	GetChannel ()

bool	SetChannel (PChannel *channel, bool autoDelete=true)

virtual unsigned	GetAverageSignalLevel ()

Public Member Functions inherited from OpalMediaStream
virtual PString	GetPatchThreadName () const

virtual bool	InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)

virtual bool	InternalSetPaused (bool pause, bool fromUser, bool fromPatch)

virtual bool	InternalExecuteCommand (const OpalMediaCommand &command)

void	PrintOn (ostream &strm) const

virtual OpalMediaFormat	GetMediaFormat () const

virtual bool	SetMediaFormat (const OpalMediaFormat &mediaFormat)

bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat, bool mergeOnly=false)

bool	ExecuteCommand (const OpalMediaCommand &command) const

virtual PBoolean	Open ()

virtual bool	IsOpen () const

virtual bool	IsEstablished () const

virtual PBoolean	Start ()

virtual PBoolean	Close ()

virtual void	OnStartMediaPatch ()

virtual void	OnStopMediaPatch (OpalMediaPatch &patch)

virtual bool	SetMediaPassThrough (OpalMediaStream &otherStream, bool bypass)

virtual PBoolean	WritePackets (RTP_DataFrameList &packets)

virtual PBoolean	ReadPacket (RTP_DataFrame &packet)

virtual PBoolean	WritePacket (RTP_DataFrame &packet)

virtual bool	PushPacket (RTP_DataFrame &packet)

virtual PBoolean	SetDataSize (PINDEX dataSize, PINDEX frameTime)

PINDEX	GetDataSize () const

virtual PBoolean	IsSynchronous () const =0

virtual PBoolean	RequiresPatchThread (OpalMediaStream *stream) const

virtual PBoolean	RequiresPatchThread () const

virtual bool	RequireMediaTransportThread (OpalMediaStream &stream) const

virtual bool	EnableJitterBuffer (bool enab=true)

OpalConnection &	GetConnection () const

bool	IsSource () const

bool	IsSink () const

unsigned	GetSessionID () const

void	SetSessionID (unsigned id)

PString	GetID () const

unsigned	GetTimestamp () const

void	SetTimestamp (unsigned ts)

bool	GetMarker () const

void	SetMarker (bool m)

bool	IsPaused () const

bool	SetPaused (bool pause)

virtual PBoolean	SetPatch (OpalMediaPatch *patch)

OpalMediaPatchPtr	GetPatch () const

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

bool	RemoveFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const

virtual void	GetStatistics (OpalMediaStatistics &statistics, bool fromPatch=false) const

	P_DECLARE_BITWISE_ENUM (Details, 6,(DetailMinimum, DetailEOL, DetailNAT, DetailSecured, DetailFEC, DetailAudio, DetailAddresses))

virtual void	PrintDetail (ostream &strm, const char *prefix=NULL, Details details=Details::All()) const

	~OpalMediaStream ()

Protected Member Functions
virtual void	InternalClose ()

	PDECLARE_MUTEX (m_channelMutex)

	PDECLARE_MUTEX (m_averagingMutex)

void	CollectAverage (const BYTE *buffer, PINDEX size)

Construction
	OpalRawMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource, PChannel *channel, bool autoDelete)

	~OpalRawMediaStream ()

Protected Member Functions inherited from OpalMediaStream
OpalMediaPatchPtr	InternalSetPatchPart1 (OpalMediaPatch *newPatch)

void	InternalSetPatchPart2 (const OpalMediaPatchPtr &oldPatch)

virtual bool	InternalSetJitterBuffer (const OpalJitterBuffer::Init &init)

	OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Protected Attributes
PChannel *	m_channel

bool	m_autoDelete

PBYTEArray	m_silence

PUInt64	m_averageSignalSum

unsigned	m_averageSignalSamples

Protected Attributes inherited from OpalMediaStream
OpalConnection &	m_connection

unsigned	m_sessionID

WORD	m_sequenceNumber

RTP_SyncSourceId	m_syncSourceId

PString	m_identifier

OpalMediaFormat	m_mediaFormat

atomic< bool >	m_paused

bool	m_isSource

atomic< bool >	m_isOpen

PINDEX	m_defaultDataSize

unsigned	m_timestamp

bool	m_marker

OpalMediaPatchPtr	m_mediaPatch

RTP_DataFrame::PayloadTypes	m_payloadType

unsigned	m_frameTime

PINDEX	m_frameSize

Additional Inherited Members
Protected Types inherited from OpalMediaStream
typedef OpalMediaPatchPtr	PatchPtr

Detailed Description

This class describes a media stream that transfers PCM-16 data to/from a PChannel.

Constructor & Destructor Documentation

OpalRawMediaStream::OpalRawMediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource,
		PChannel *	channel,
		bool	autoDelete
	)

protected

Construct a new media stream for channel.

Parameters

conn	Connection that owns the stream
mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
channel	I/O channel to stream to/from
autoDelete	Automatically delete channel

OpalRawMediaStream::~OpalRawMediaStream ( )

protected

Delete attached channel if autoDelete enabled.

Member Function Documentation

void OpalRawMediaStream::CollectAverage	(	const BYTE *	buffer,
		PINDEX	size
	)

protected

virtual unsigned OpalRawMediaStream::GetAverageSignalLevel ( )

virtual

Get average signal level in last frame.

PChannel* OpalRawMediaStream::GetChannel ( )

inline

Return the associated PChannel

References m_channel.

virtual void OpalRawMediaStream::InternalClose ( )

protectedvirtual

Close any internal components of the stream. This should be used in preference to overriding the Close() function as it is guaranteed to be called exactly once and avoids race conditions in the shut down sequence of a media stream.

Implements OpalMediaStream.

Reimplemented in OpalIVRMediaStream.

OpalRawMediaStream::PDECLARE_MUTEX ( m_channelMutex )

protected

OpalRawMediaStream::PDECLARE_MUTEX ( m_averagingMutex )

protected

virtual PBoolean OpalRawMediaStream::ReadData	(	BYTE *	data,
		PINDEX	size,
		PINDEX &	length
	)

virtual

Read raw media data from the source media stream. The default behaviour reads from the PChannel object.

Parameters

data	Data buffer to read to
size	Size of buffer
length	Length of data actually read

Reimplemented from OpalMediaStream.

Reimplemented in OpalFileMediaStream.

bool OpalRawMediaStream::SetChannel	(	PChannel *	channel,
		bool	autoDelete = `true`
	)

Set a new channel for raw PCM stream.

Parameters

channel	New channel
autoDelete	Auto delete channel on exit or replacement

virtual PBoolean OpalRawMediaStream::WriteData	(	const BYTE *	data,
		PINDEX	length,
		PINDEX &	written
	)

virtual

Write raw media data to the sink media stream. The default behaviour writes to the PChannel object.

Parameters

data	Data to write
length	Length of data to read.
written	Length of data actually written

Reimplemented from OpalMediaStream.

Reimplemented in OpalFileMediaStream.

Field Documentation

bool OpalRawMediaStream::m_autoDelete

protected

unsigned OpalRawMediaStream::m_averageSignalSamples

protected

PUInt64 OpalRawMediaStream::m_averageSignalSum

protected

PChannel* OpalRawMediaStream::m_channel

protected

Referenced by GetChannel().

PBYTEArray OpalRawMediaStream::m_silence

protected

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

mediastrm.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation