rtp_stream.h

Go to the documentation of this file.

/*
 * rtp_stream.h
 *
 * Media Stream classes
 *
 * Open Phone Abstraction Library (OPAL)
 *
 * Copyright (C) 2014 Vox Lucida Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Open Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_RTP_RTP_STREAM_H
#define OPAL_RTP_RTP_STREAM_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#include <opal/mediastrm.h>


class OpalRTPSession;
class OpalRTPConnection;
class OpalMediaStatistics;


class OpalRTPMediaStream : public OpalMediaStream
{
    PCLASSINFO(OpalRTPMediaStream, OpalMediaStream);
  public:
    OpalRTPMediaStream(
      OpalRTPConnection & conn,            
      const OpalMediaFormat & mediaFormat, 
      bool isSource,                       
      OpalRTPSession & rtpSession          
    );

    ~OpalRTPMediaStream();

    virtual PBoolean Open();

    virtual bool IsOpen() const;

    virtual bool IsEstablished() const;

    virtual PBoolean Start();

    virtual void OnStartMediaPatch();

    virtual bool SetMediaPassThrough(
      OpalMediaStream & otherStream,  
      bool bypass                     
    );

    virtual PBoolean ReadPacket(
      RTP_DataFrame & packet
    );

    virtual PBoolean WritePacket(
      RTP_DataFrame & packet
    );

    virtual PBoolean SetDataSize(
      PINDEX dataSize,  
      PINDEX frameTime  
    );

    virtual PBoolean IsSynchronous() const;

    virtual PBoolean RequiresPatchThread() const;

    virtual PBoolean SetPatch(
      OpalMediaPatch * patch  
    );

    virtual OpalRTPSession & GetRtpSession() const
    { return m_rtpSession; }

    virtual void GetJitterBufferDelay(OpalJitterBuffer::Init & info) const;

    virtual void SetJitterBufferDelay(const OpalJitterBuffer::Init & info);

#if OPAL_STATISTICS
    virtual void GetStatistics(OpalMediaStatistics & statistics, bool fromPatch = false) const;
#endif


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

    virtual PString GetPatchThreadName() const;

    RTP_SyncSourceId SetSyncSource() const { return m_syncSource; }
    void SetSyncSource(RTP_SyncSourceId ssrc);

    const PTimeInterval & GetReadTimeout() const { return m_readTimeout; }
    void SetReadTimeout(const PTimeInterval & t);

    void SetRewriteHeaders(bool v) { m_rewriteHeaders = v; }

#if OPAL_VIDEO

    void SetVideoUpdateThrottleTime(const PTimeInterval & time) { m_videoUpdateThrottleTime = time; }

    void SetPictureLossThrottleTime(const PTimeInterval & time) { m_pictureLossThrottleTime = time; }
#endif

protected:
    virtual void InternalClose();
    virtual bool InternalSetJitterBuffer(const OpalJitterBuffer::Init & init);
    virtual bool InternalUpdateMediaFormat(const OpalMediaFormat & mediaFormat);
    virtual bool InternalSetPaused(bool pause, bool fromUser, bool fromPatch);
    virtual bool InternalExecuteCommand(const OpalMediaCommand & command);

    OpalRTPSession    & m_rtpSession;
    bool                m_rewriteHeaders;
    RTP_SyncSourceId    m_syncSource;
    unsigned            m_notifierPriority;
    OpalMediaStreamPtr  m_passThruStream;
    OpalJitterBuffer  * m_jitterBuffer;
    PTimeInterval       m_readTimeout;

#if OPAL_VIDEO
    bool          m_forceIntraFrameFlag;
    PSimpleTimer  m_forceIntraFrameTimer;
    PSimpleTimer  m_videoUpdateThrottleTimer;
    PTimeInterval m_videoUpdateThrottleTime;
    PSimpleTimer  m_pictureLossThrottleTimer;
    PTimeInterval m_pictureLossThrottleTime;
#endif

    PDECLARE_RTPDataNotifier(OpalRTPMediaStream, OnReceivedPacket);
    OpalRTPSession::DataNotifier m_receiveNotifier;

#if OPAL_JITTER_BUFFER_LATENCY_CHECK
    PTimeInterval m_jbLatencyAccumulator;
    unsigned      m_jbLatencySampleCount;
#endif

    PTRACE_THROTTLE(m_throttleWriteData,3,500);
    PTRACE_THROTTLE(m_throttleSendReport,3,500);
};



#endif //OPAL_RTP_RTP_STREAM_H


// End of File ///////////////////////////////////////////////////////////////