OpalLineMediaStream Class Reference

#include <lidep.h>

Inheritance diagram for OpalLineMediaStream:

Collaboration diagram for OpalLineMediaStream:

Public Member Functions
	~OpalLineMediaStream ()
Construction
	OpalLineMediaStream (OpalLineConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource, OpalLine &line)
Overrides of OpalMediaStream class
virtual PBoolean	Open ()
virtual PBoolean	ReadPacket (RTP_DataFrame &packet)
virtual PBoolean	WritePacket (RTP_DataFrame &packet)
virtual PBoolean	ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean	SetDataSize (PINDEX dataSize, PINDEX frameTime)
virtual PBoolean	IsSynchronous () const
virtual PBoolean	RequiresPatchThread (OpalMediaStream *stream) const
Member variable access
OpalLine &	GetLine ()
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 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 bool	PushPacket (RTP_DataFrame &packet)
PINDEX	GetDataSize () 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 ()
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
OpalLine &	m_line
bool	m_notUsingRTP
bool	m_useDeblocking
unsigned	m_missedCount
BYTE	m_lastSID [4]
bool	m_lastFrameWasSignal
unsigned	m_directLineNumber
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 data to/from a Line Interface Device.

Constructor & Destructor Documentation

OpalLineMediaStream::OpalLineMediaStream	(	OpalLineConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		PBoolean	isSource,
		OpalLine &	line
	)

Construct a new media stream for Line Interface Devices.

Parameters

conn	Owner connection
mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream
line	LID line to stream to/from

OpalLineMediaStream::~OpalLineMediaStream

(

)

Member Function Documentation

OpalLine& OpalLineMediaStream::GetLine ( )

inline

Get the line being used by this media stream.

References m_line.

virtual void OpalLineMediaStream::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.

virtual PBoolean OpalLineMediaStream::IsSynchronous ( ) const

virtual

Indicate if the media stream is synchronous. Returns true for LID streams.

Implements OpalMediaStream.

virtual PBoolean OpalLineMediaStream::Open ( )

virtual

Open the media stream.

The default behaviour sets the OpalLineInterfaceDevice format and calls Resume() on the associated OpalMediaPatch thread.

Reimplemented from OpalMediaStream.

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

virtual

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

Parameters

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

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLineMediaStream::ReadPacket ( RTP_DataFrame &  packet )

virtual

Read an RTP frame of data from the source media stream. The default behaviour simply calls ReadData() on the data portion of the RTP_DataFrame and sets the frames timestamp and marker from the internal member variables of the media stream class.

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLineMediaStream::RequiresPatchThread ( OpalMediaStream *  stream ) const

virtual

Indicate if the media stream requires a OpalMediaPatch thread (active patch). This is called on the source/sink stream and is passed the sink/source stream that the patch will initially be using. The function could conditionally require the patch thread to execute a thread reading and writing data, or prevent it from doing so as it can do so in hardware in some way.

The default behaviour here determines if both streams are on the same OpalLineInterfaceDevice and returns false if so.

Parameters

stream

Other stream in patch

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLineMediaStream::SetDataSize ( PINDEX  dataSize, PINDEX  frameTime  )

virtual

Set the data size in bytes that is expected to be used. Some media streams can make use of this information to perform optimisations.

The default behaviour does nothing.

Parameters

dataSize	New data size (in total)
frameTime	Individual frame time (if applicable)

Reimplemented from OpalMediaStream.

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

virtual

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

Parameters

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

Reimplemented from OpalMediaStream.

virtual PBoolean OpalLineMediaStream::WritePacket ( RTP_DataFrame &  packet )

virtual

Write an RTP frame of data to the sink media stream. The default behaviour simply calls WriteData() on the data portion of the RTP_DataFrame and and sets the internal timestamp and marker from the member variables of the media stream class.

Reimplemented from OpalMediaStream.

Field Documentation

unsigned OpalLineMediaStream::m_directLineNumber

protected

bool OpalLineMediaStream::m_lastFrameWasSignal

protected

BYTE OpalLineMediaStream::m_lastSID[4]

protected

OpalLine& OpalLineMediaStream::m_line

protected

Referenced by GetLine().

unsigned OpalLineMediaStream::m_missedCount

protected

bool OpalLineMediaStream::m_notUsingRTP

protected

bool OpalLineMediaStream::m_useDeblocking

protected

---

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

• lidep.h