sdpep.h

Go to the documentation of this file.

/*
 * sdpep.h
 *
 * 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 Post Increment
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_OPAL_SDPEP_H
#define OPAL_OPAL_SDPEP_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_SDP

#include <rtp/rtpep.h>
#include <rtp/rtpconn.h>
#include <sdp/sdp.h>


class OpalSDPConnection;
class OpalSDPHTTPConnection;


#define OPAL_OPT_AV_BUNDLE "AV-Bundle"

#define OPAL_OPT_USE_MEDIA_STREAMS "Use-Media-Stream"

#define OPAL_OPT_MULTI_SSRC "Multi-SSRC"

#define OPAL_OPT_INACTIVE_AUDIO_FLOW "Inactive-Audio-Flow"


class OpalSDPEndPoint : public OpalRTPEndPoint
{
    PCLASSINFO(OpalSDPEndPoint, OpalRTPEndPoint);
  public:
    static const PCaselessString & ContentType();


    OpalSDPEndPoint(
      OpalManager & manager,          
      const PCaselessString & prefix, 
      Attributes attributes           
    );

    ~OpalSDPEndPoint();

    virtual PStringList GetAvailableStringOptions() const;

    virtual SDPSessionDescription * CreateSDP(
      time_t sessionId,
      unsigned version,
      const OpalTransportAddress & address
    );

    void SetHoldTimeout(
      const PTimeInterval & t
    ) { m_holdTimeout = t; }
    const PTimeInterval & GetHoldTimeout() const { return m_holdTimeout; }

  protected:
    PTimeInterval m_holdTimeout;
};



class OpalSDPConnection : public OpalRTPConnection
{
    PCLASSINFO(OpalSDPConnection, OpalRTPConnection);
  public:
  OpalSDPConnection(
    OpalCall & call,                         
    OpalSDPEndPoint & endpoint,              
    const PString & token,                   
    unsigned options = 0,                    
    OpalConnection::StringOptions * stringOptions = NULL     
    );

  ~OpalSDPConnection();

    virtual bool IsNetworkConnection() const { return true; }

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual bool HoldRemote(
      bool placeOnHold  
    );

    virtual bool IsOnHold(
      bool fromRemote  
    ) const;

    bool GetOfferSDP(
      SDPSessionDescription & offer,
      bool offerOpenMediaStreamsOnly = false
    );

    PString GetOfferSDP(
      bool offerOpenMediaStreamsOnly = false
    );

    bool AnswerOfferSDP(
      const SDPSessionDescription & offer,
      SDPSessionDescription & answer
    );

    PString AnswerOfferSDP(
      const PString & offer
    );

    bool HandleAnswerSDP(
      const SDPSessionDescription & answer
    );

    bool HandleAnswerSDP(
      const PString & answer
    );

    SDPSessionDescription * CreateSDP(
      const PString & sdp
    );

    virtual PString GetMediaInterface() = 0;

    virtual OpalTransportAddress GetRemoteMediaAddress() = 0;

  protected:
    virtual bool OnSendOfferSDP(
      SDPSessionDescription & sdpOut,
      bool offerOpenMediaStreamsOnly
    );
    virtual bool OnSendOfferSDPSession(
      unsigned sessionID,
      SDPSessionDescription & sdpOut,
      bool offerOpenMediaStreamOnly
    );
    virtual bool OnSendOfferSDPSession(
      OpalMediaSession * mediaSession,
      SDPMediaDescription * localMedia,
      bool offerOpenMediaStreamOnly,
      RTP_SyncSourceId ssrc
    );

    virtual bool OnSendAnswerSDP(
      const SDPSessionDescription & sdpOffer,
      SDPSessionDescription & sdpAnswer,
      bool transfer = false
    );

    struct BundleMergeInfo;
    virtual SDPMediaDescription * OnSendAnswerSDPSession(
      SDPMediaDescription * incomingMedia,
      unsigned sessionId,
      bool transfer,
      SDPMediaDescription::Direction otherSidesDir,
      BundleMergeInfo & bundleMergeInfo
    );

    virtual bool OnReceivedAnswerSDP(
      const SDPSessionDescription & sdp,
      bool & multipleFormats
    );

    virtual bool OnReceivedAnswerSDPSession(
      const SDPMediaDescription * mediaDescription,
      unsigned sessionId,
      SDPMediaDescription::Direction otherSidesDir,
      bool & multipleFormats,
      BundleMergeInfo & bundleMergeInfo
    );

    virtual bool OnReceivedSDP(
      const SDPSessionDescription & sdp
    );

    virtual void FinaliseRtx(
      const OpalMediaStreamPtr & stream,
      SDPMediaDescription * sdp
    );

    virtual bool SetRemoteMediaFormats(
      const OpalMediaFormatList & formats
    );
    virtual bool SetActiveMediaFormats(
      const OpalMediaFormatList & formats
    );

    virtual OpalMediaSession * SetUpMediaSession(
      const unsigned rtpSessionId,
      const OpalMediaType & mediaType,
      const SDPMediaDescription & mediaDescription,
      OpalTransportAddress & localAddress,
      BundleMergeInfo & bundleMergeInfo
    );

    bool PauseOrCloseMediaStream(OpalMediaStreamPtr & stream, bool changed, bool paused);

    virtual bool AllowMusicOnHold() const;
    void RetryHoldRemote(bool placeOnHold);
    virtual bool OnHoldStateChanged(bool placeOnHold);
    virtual void OnMediaStreamOpenFailed(bool rx);

    OpalSDPEndPoint & m_endpoint;

    OpalMediaFormatList m_remoteFormatList;
    OpalMediaFormatList m_activeFormatList;

    atomic<bool> m_offerPending;
    time_t       m_sdpSessionId;
    unsigned     m_sdpVersion; // Really a sequence number
    unsigned     m_sdpVersionFromRemote;

    enum HoldState {
      eHoldOff,
      eRetrieveInProgress,

      // Order is important!
      eHoldOn,
      eHoldInProgress
    };
    HoldState m_holdToRemote;
    bool      m_holdFromRemote;
};

#endif // OPAL_SDP

#endif // OPAL_OPAL_SDPEP_H