OPAL  Version 3.10.10
OpalVideoMediaStream Class Reference

#include <mediastrm.h>

Inheritance diagram for OpalVideoMediaStream:
OpalMediaStream

Public Member Functions

Construction
 OpalVideoMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, PVideoInputDevice *inputDevice, PVideoOutputDevice *outputDevice, bool autoDeleteInput=true, bool autoDeleteOutput=true)
 ~OpalVideoMediaStream ()
Overrides of PChannel class
virtual bool InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual PBoolean Open ()
virtual PBoolean ReadData (BYTE *data, PINDEX size, PINDEX &length)
virtual PBoolean WriteData (const BYTE *data, PINDEX length, PINDEX &written)
virtual PBoolean IsSynchronous () const
virtual PBoolean SetDataSize (PINDEX dataSize, PINDEX frameTime)
virtual PVideoInputDevice * GetVideoInputDevice () const
virtual PVideoOutputDevice * GetVideoOutputDevice () const
- Public Member Functions inherited from OpalMediaStream
void PrintOn (ostream &strm) const
virtual OpalMediaFormat GetMediaFormat () const
bool UpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual PBoolean ExecuteCommand (const OpalMediaCommand &command)
virtual PBoolean Start ()
virtual PBoolean Close ()
virtual void OnStartMediaPatch ()
virtual void OnStopMediaPatch (OpalMediaPatch &patch)
virtual PBoolean WritePackets (RTP_DataFrameList &packets)
virtual PBoolean ReadPacket (RTP_DataFrame &packet)
virtual PBoolean WritePacket (RTP_DataFrame &packet)
bool PushPacket (RTP_DataFrame &packet)
PINDEX GetDataSize () const
virtual PBoolean RequiresPatchThread (OpalMediaStream *stream) const
virtual PBoolean RequiresPatchThread () const
virtual bool EnableJitterBuffer (bool enab=true) const
OpalConnectionGetConnection () 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
virtual bool SetPaused (bool pause, bool fromPatch=false)
bool IsOpen () const
virtual PBoolean SetPatch (OpalMediaPatch *patch)
OpalMediaPatchGetPatch () 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
 ~OpalMediaStream ()

Protected Member Functions

virtual void InternalClose ()
- Protected Member Functions inherited from OpalMediaStream
void IncrementTimestamp (PINDEX size)
bool InternalWriteData (const BYTE *data, PINDEX length, PINDEX &written)
 OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Protected Attributes

PVideoInputDevice * m_inputDevice
PVideoOutputDevice * m_outputDevice
bool m_autoDeleteInput
bool m_autoDeleteOutput
PTimeInterval m_lastGrabTime
- Protected Attributes inherited from OpalMediaStream
OpalConnectionconnection
unsigned sessionID
PString identifier
OpalMediaFormat mediaFormat
bool m_paused
bool isSource
bool isOpen
PINDEX defaultDataSize
unsigned timestamp
bool marker
unsigned mismatchedPayloadTypes
PatchPtr m_mediaPatch
RTP_DataFrame::PayloadTypes m_payloadType
unsigned m_frameTime
PINDEX m_frameSize

Additional Inherited Members

- Protected Types inherited from OpalMediaStream
typedef PSafePtr
< OpalMediaPatch,
PSafePtrMultiThreaded > 
PatchPtr

Constructor & Destructor Documentation

OpalVideoMediaStream::OpalVideoMediaStream ( OpalConnection conn,
const OpalMediaFormat mediaFormat,
unsigned  sessionID,
PVideoInputDevice *  inputDevice,
PVideoOutputDevice *  outputDevice,
bool  autoDeleteInput = true,
bool  autoDeleteOutput = true 
)

Construct a new media stream for channel.

Parameters
connConnection that owns the stream
mediaFormatMedia format for stream
sessionIDSession number for stream
inputDeviceDevice to use for video grabbing
outputDeviceDevice to use for video display
autoDeleteInputAutomatically delete PVideoInputDevice
autoDeleteOutputAutomatically delete PVideoOutputDevice
OpalVideoMediaStream::~OpalVideoMediaStream ( )

Delete attached channel if autoDelete enabled.

Member Function Documentation

virtual PVideoInputDevice* OpalVideoMediaStream::GetVideoInputDevice ( ) const
inlinevirtual

Get the input device (e.g. for statistics)

References m_inputDevice.

virtual PVideoOutputDevice* OpalVideoMediaStream::GetVideoOutputDevice ( ) const
inlinevirtual

Get the output device (e.g. for statistics)

References m_outputDevice.

virtual void OpalVideoMediaStream::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 bool OpalVideoMediaStream::InternalUpdateMediaFormat ( const OpalMediaFormat mediaFormat)
virtual

Update the 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. If the formats are different then a OpalMediaFormat::Merge() is performed.

Parameters
mediaFormatNew media format

Reimplemented from OpalMediaStream.

virtual PBoolean OpalVideoMediaStream::IsSynchronous ( ) const
virtual

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

Implements OpalMediaStream.

virtual PBoolean OpalVideoMediaStream::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 OpalVideoMediaStream::ReadData ( BYTE *  data,
PINDEX  size,
PINDEX &  length 
)
virtual

Read raw media data from the source media stream. The default behaviour simply calls ReadPacket() 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.

Parameters
dataData buffer to read to
sizeSize of buffer
lengthLength of data actually read

Reimplemented from OpalMediaStream.

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

Override size of frame header is included

Parameters
dataSizeNew data size (in total)
frameTimeIndividual frame time (if applicable)

Reimplemented from OpalMediaStream.

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

Write raw media data to the sink media stream. The default behaviour calls WritePacket() 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.

Parameters
dataData to write
lengthLength of data to read.
writtenLength of data actually written

Reimplemented from OpalMediaStream.

Field Documentation

bool OpalVideoMediaStream::m_autoDeleteInput
protected
bool OpalVideoMediaStream::m_autoDeleteOutput
protected
PVideoInputDevice* OpalVideoMediaStream::m_inputDevice
protected

Referenced by GetVideoInputDevice().

PTimeInterval OpalVideoMediaStream::m_lastGrabTime
protected
PVideoOutputDevice* OpalVideoMediaStream::m_outputDevice
protected

Referenced by GetVideoOutputDevice().


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