sockep.h

Go to the documentation of this file.

/*
 * sockep.h
 *
 * Media from socket endpoint.
 *
 * Open Phone Abstraction Library (OPAL)
 *
 * Copyright (c) 2018 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 Vox Lucdia Pty. Ltd.
 *
 * Contributor(s): Robert Jongbleod robertj@voxlucida.com.au.
 */

#ifndef OPAL_OPAL_SOCKEP_H
#define OPAL_OPAL_SOCKEP_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <opal_config.h>

#include <ep/localep.h>


class OpalSocketConnection;

#define OPAL_SOCK_PREFIX "sock"

#define OPAL_OPT_SOCK_EP_AUDIO_IP    "audio-ip"
#define OPAL_OPT_SOCK_EP_AUDIO_PORT  "audio-port"
#define OPAL_OPT_SOCK_EP_AUDIO_PROTO "audio-proto"
#define OPAL_OPT_SOCK_EP_AUDIO_CODEC "audio-codec"

#if OPAL_VIDEO

#define OPAL_OPT_SOCK_EP_VIDEO_IP    "video-ip"
#define OPAL_OPT_SOCK_EP_VIDEO_PORT  "video-port"
#define OPAL_OPT_SOCK_EP_VIDEO_PROTO "video-proto"
#define OPAL_OPT_SOCK_EP_VIDEO_CODEC "video"
#define OPAL_OPT_SOCK_EP_FRAME_RATE  "frame-rate"

#endif // OPAL_VIDEO


class OpalSockEndPoint : public OpalLocalEndPoint
{
    PCLASSINFO(OpalSockEndPoint, OpalLocalEndPoint);
  public:
    OpalSockEndPoint(
      OpalManager & manager,  
      const char * prefix = OPAL_SOCK_PREFIX 
    );

    ~OpalSockEndPoint();

    virtual PSafePtr<OpalConnection> MakeConnection(
      OpalCall & call,           
      const PString & party,     
      void * userData = NULL,    
      unsigned int options = 0,  
      OpalConnection::StringOptions * stringOptions  = NULL 
    );


    virtual OpalLocalConnection * CreateConnection(
      OpalCall & call,    
      void * userData,    
      unsigned options,   
      OpalConnection::StringOptions * stringOptions 
    );
};


class OpalSockConnection : public OpalLocalConnection
{
    PCLASSINFO(OpalSockConnection, OpalLocalConnection);
  public:
    OpalSockConnection(
      OpalCall & call,              
      OpalSockEndPoint & endpoint,  
      void * userData,    
      unsigned options = 0,                    
      OpalConnection::StringOptions * stringOptions = NULL 
    );

    ~OpalSockConnection();

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual void OnReleased();

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

    virtual bool OnMediaCommand(
      OpalMediaStream & stream,         
      const OpalMediaCommand & command  
    );

    virtual bool OnOutgoing();

    virtual bool OnIncoming();

    virtual bool OnReadMediaData(
      OpalMediaStream & mediaStream, 
      void * data,                   
      PINDEX size,                   
      PINDEX & length                
    );

    virtual bool OnWriteMediaData(
      const OpalMediaStream & mediaStream,    
      const void * data,                      
      PINDEX length,                          
      PINDEX & written                        
    );


#pragma pack(1)

    struct MediaHeader {
      uint8_t  m_headerSize;
      enum {
        Marker = 0x01,
        Update = 0x02,
        Bitrate = 0x04
      };
      uint8_t  m_flags;
      PUInt16b m_length; // Big endian
    };

    struct MediaBitrate : MediaHeader {
      PUInt32b rate;
    };
#pragma pack()


  protected:
    bool OpenMediaSockets();
    bool OpenMediaSocket(
      PIPSocket * & socket,
      const PString & addrKey,
      const PString & portKey,
      const PCaselessString & protoKey
    );

    OpalSockEndPoint & m_endpoint;
    PIPSocket        * m_audioSocket;
#if OPAL_VIDEO
    PIPSocket        * m_videoSocket;
    PDECLARE_MUTEX(m_writeMutex);
#endif
};

#endif // OPAL_OPAL_SOCKEP_H