OPAL
Version 3.10.10
|
#include <jitter.h>
Public Member Functions | |
Construction | |
OpalJitterBuffer (unsigned minJitterDelay, unsigned maxJitterDelay, unsigned timeUnits=8, PINDEX packetSize=2048) | |
virtual | ~OpalJitterBuffer () |
Overrides from PObject | |
void | PrintOn (ostream &strm) const |
Operations | |
void | SetDelay (unsigned minJitterDelay, unsigned maxJitterDelay, PINDEX packetSize=2048) |
void | Reset () |
virtual PBoolean | WriteData (const RTP_DataFrame &frame, const PTimeInterval &tick=0) |
virtual PBoolean | ReadData (RTP_DataFrame &frame, const PTimeInterval &tick=0) |
DWORD | GetCurrentJitterDelay () const |
DWORD | GetMinJitterDelay () const |
DWORD | GetMaxJitterDelay () const |
unsigned | GetTimeUnits () const |
DWORD | GetPacketsTooLate () const |
DWORD | GetBufferOverruns () const |
DWORD | GetMaxConsecutiveMarkerBits () const |
void | SetMaxConsecutiveMarkerBits (DWORD max) |
Protected Types | |
enum | { e_SynchronisationStart, e_SynchronisationFill, e_SynchronisationShrink, e_SynchronisationDone } |
typedef std::map< DWORD, RTP_DataFrame > | FrameMap |
Protected Member Functions | |
DWORD | CalculateRequiredTimestamp (DWORD playOutTimestamp) const |
bool | AdjustCurrentJitterDelay (int delta) |
Protected Attributes | |
unsigned | m_timeUnits |
PINDEX | m_packetSize |
DWORD | m_minJitterDelay |
Minimum jitter delay in timestamp units. More... | |
DWORD | m_maxJitterDelay |
Maximum jitter delay in timestamp units. More... | |
int | m_jitterGrowTime |
Amaint to increase jitter delay by when get "late" packet. More... | |
DWORD | m_jitterShrinkPeriod |
int | m_jitterShrinkTime |
Amount to shrink jitter delay by if consistently filled. More... | |
DWORD | m_silenceShrinkPeriod |
Reduce jitter delay is silent for this long. More... | |
int | m_silenceShrinkTime |
Amount to shrink jitter delay by if consistently silent. More... | |
DWORD | m_jitterDriftPeriod |
int | m_currentJitterDelay |
DWORD | m_packetsTooLate |
DWORD | m_bufferOverruns |
DWORD | m_consecutiveMarkerBits |
DWORD | m_maxConsecutiveMarkerBits |
DWORD | m_consecutiveLatePackets |
DWORD | m_averageFrameTime |
DWORD | m_lastTimestamp |
DWORD | m_lastSyncSource |
DWORD | m_bufferFilledTime |
DWORD | m_bufferLowTime |
DWORD | m_bufferEmptiedTime |
int | m_timestampDelta |
enum OpalJitterBuffer:: { ... } | m_synchronisationState |
FrameMap | m_frames |
PMutex | m_bufferMutex |
RTP_JitterBufferAnalyser * | m_analyser |
This is an Abstract jitter buffer, which can be used simply in any application. The user is required to use a descendant of this class, and provide a "OnReadPacket" method, so that network packets can be placed in this class instance
|
protected |
|
protected |
OpalJitterBuffer::OpalJitterBuffer | ( | unsigned | minJitterDelay, |
unsigned | maxJitterDelay, | ||
unsigned | timeUnits = 8 , |
||
PINDEX | packetSize = 2048 |
||
) |
Constructor for this jitter buffer. The size of this buffer can be altered later with the SetDelay method
minJitterDelay | Minimum delay in RTP timestamp units |
maxJitterDelay | Maximum delay in RTP timestamp units |
timeUnits | Time units, usually 8 or 16 |
packetSize | Max RTP packet size |
|
virtual |
Destructor, which closes this down and deletes the internal list of frames
|
protected |
Referenced by SetMaxConsecutiveMarkerBits().
|
protected |
Referenced by SetMaxConsecutiveMarkerBits().
|
inline |
Get total number received packets that overran the jitter buffer.
References m_bufferOverruns.
|
inline |
Get current delay for jitter buffer.
References m_currentJitterDelay.
|
inline |
Get maximum consecutive marker bits before buffer starts to ignore them.
References m_maxConsecutiveMarkerBits.
|
inline |
Get maximum delay for jitter buffer.
References m_maxJitterDelay.
|
inline |
Get minimum delay for jitter buffer.
References m_minJitterDelay.
|
inline |
Get total number received packets too late to go into jitter buffer.
References m_packetsTooLate.
|
inline |
Get time units.
References m_timeUnits.
void OpalJitterBuffer::PrintOn | ( | ostream & | strm | ) | const |
Report the statistics for this jitter instance
|
virtual |
Read a data frame from the jitter buffer. This function never blocks. If no data is available, an RTP packet with zero payload size is returned.
frame | Frame to extract from jitter buffer |
tick | Real time tick for packet removal |
void OpalJitterBuffer::Reset | ( | ) |
Reset jitter buffer.
void OpalJitterBuffer::SetDelay | ( | unsigned | minJitterDelay, |
unsigned | maxJitterDelay, | ||
PINDEX | packetSize = 2048 |
||
) |
Set the maximum delay the jitter buffer will operate to.
minJitterDelay | Minimum delay in RTP timestamp units |
maxJitterDelay | Maximum delay in RTP timestamp units |
packetSize | Max RTP packet size |
|
inline |
Set maximum consecutive marker bits before buffer starts to ignore them.
References AdjustCurrentJitterDelay(), CalculateRequiredTimestamp(), and m_maxConsecutiveMarkerBits.
|
virtual |
Write data frame from the RTP channel.
frame | Frame to feed into jitter buffer |
tick | Real time tick for packet arrival |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by GetBufferOverruns().
|
protected |
|
protected |
|
protected |
Referenced by GetCurrentJitterDelay().
|
protected |
|
protected |
|
protected |
Amaint to increase jitter delay by when get "late" packet.
|
protected |
Period (in timestamp units) over which buffer is consistently filled before shrinking
|
protected |
Amount to shrink jitter delay by if consistently filled.
|
protected |
|
protected |
|
protected |
Referenced by GetMaxConsecutiveMarkerBits(), and SetMaxConsecutiveMarkerBits().
|
protected |
Maximum jitter delay in timestamp units.
Referenced by GetMaxJitterDelay().
|
protected |
Minimum jitter delay in timestamp units.
Referenced by GetMinJitterDelay().
|
protected |
|
protected |
Referenced by GetPacketsTooLate().
|
protected |
Reduce jitter delay is silent for this long.
|
protected |
Amount to shrink jitter delay by if consistently silent.
enum { ... } OpalJitterBuffer::m_synchronisationState |
|
protected |
|
protected |
Referenced by GetTimeUnits().