GstEndPoint.h

Go to the documentation of this file.

/*
 * GstEndPoint.h
 *
 * GStreamer support.
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (c) 2013 Vox Lucida Pty. Ltd. and Jonathan M. Henson
 *
 * 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 Jonathan M. Henson
 * jonathan.michael.henson@gmail.com, jonathan.henson@innovisit.com
 *
 * Contributor(s): Robert Jongbloed (robertj@voxlucida.com.au).
 */

#ifndef GSTREAMER_GSTENDPOINT_H
#define GSTREAMER_GSTENDPOINT_H

#include <ep/localep.h>

#include <ptclib/gstreamer.h>

#if OPAL_GSTREAMER

class GstMediaStream;


#define OPAL_GST_STRINTF_FMT "{%s}"
#define OPAL_GST_NAME        "name"
#define OPAL_GST_SAMPLE_RATE "sample-rate"
#define OPAL_GST_PT          "pt"
#define OPAL_GST_MTU         "mtu"
#define OPAL_GST_WIDTH       "width"
#define OPAL_GST_HEIGHT      "height"
#define OPAL_GST_FRAME_RATE  "frame-rate"
#define OPAL_GST_BIT_RATE    "bit-rate"
#define OPAL_GST_BIT_RATE_K  "bit-rate-kbps"
#define OPAL_GST_BLOCK_SIZE  "blocksize"
#define OPAL_GST_LATENCY     "latency"
#define OPAL_GST_REMOTE_IP   "remote-ip"
#define OPAL_GST_REMOTE_PPRT "remote-port"


class GstEndPoint : public OpalLocalEndPoint
{
    PCLASSINFO(GstEndPoint, OpalLocalEndPoint);
  public:
    GstEndPoint(
      OpalManager & manager,
      const char *prefix = "gst"
    );

    virtual ~GstEndPoint();

    virtual OpalMediaFormatList GetMediaFormats() const;

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

    virtual bool BuildPipeline(
      ostream & description,
      const GstMediaStream * audioStream
#if OPAL_VIDEO
      , const GstMediaStream * videoStream
#endif
    );

    /* Configure the pipeline when it is already in NULL state */
    virtual bool ConfigurePipeline(PGstPipeline & pipeline, const GstMediaStream & stream);

    virtual bool BuildAudioSourcePipeline(ostream & desc, const GstMediaStream & stream, int rtpIndex);
    virtual bool BuildAudioSinkPipeline(ostream & desc, const GstMediaStream & stream, int rtpIndex);

    virtual bool OutputRTPSource(ostream & desc, const GstMediaStream & stream, int rtpIndex);
    virtual bool OutputRTPSink(ostream & desc, const GstMediaStream & stream, int rtpIndex);

    bool SetAudioSourceDevice(const PString & elementName);
    virtual bool BuildAudioSourceDevice(ostream & desc, const GstMediaStream & stream);
    const PString & GetAudioSourceDevice() const { return m_audioSourceDevice; }

    bool SetAudioSinkDevice(const PString & elementName);
    const PString & GetAudioSinkDevice() const { return m_audioSinkDevice; }
    virtual bool BuildAudioSinkDevice(ostream & desc, const GstMediaStream & stream);

    bool SetJitterBufferPipeline(const PString & elementName);
    const PString & GetJitterBufferPipeline()   const { return m_jitterBuffer; }
    static const PString & GetPipelineJitterBufferName();
    virtual bool BuildJitterBufferPipeline(ostream & desc, const GstMediaStream & stream);

    bool SetRTPPipeline(const PString & elementName);
    const PString & GetRTPPipeline()   const { return m_rtpbin; }
    static const PString & GetPipelineRTPName();
    virtual bool BuildRTPPipeline(ostream & desc, const GstMediaStream & stream, unsigned index);

    static const PString & GetPipelineAudioSourceName();
    virtual bool BuildAppSource(ostream & desc, const PString & name);

    static const PString & GetPipelineAudioSinkName();
    virtual bool BuildAppSink(ostream & desc, const PString & name, int rtpIndex);

    static const PString & GetPipelineVolumeName();
    virtual bool BuildVolume(ostream & desc, const PString & name);

#if OPAL_VIDEO
    virtual bool BuildVideoSourcePipeline(ostream & desc, const GstMediaStream & stream, int rtpIndex);
    virtual bool BuildVideoSinkPipeline(ostream & desc, const GstMediaStream & stream, int rtpIndex);

    bool SetVideoSourceDevice(const PString & elementName);
    const PString & GetVideoSourceDevice() const { return m_videoSourceDevice; }
    virtual bool BuildVideoSourceDevice(ostream & desc, const GstMediaStream & stream);

    bool SetVideoSinkDevice(const PString & elementName);
    const PString & GetVideoSinkDevice() const { return m_videoSinkDevice; }
    virtual bool BuildVideoSinkDevice(ostream & desc, const GstMediaStream & stream);

    bool SetVideoSourceColourConverter(const PString & elementName);
    const PString & GetVideoSourceColourConverter()   const { return m_videoSourceColourConverter; }

    bool SetVideoSinkColourConverter(const PString & elementName);
    const PString & GetVideoSinkColourConverter()   const { return m_videoSinkColourConverter; }

    static const PString & GetPipelineVideoSourceName();
    static const PString & GetPipelineVideoSinkName();
#endif // OPAL_VIDEO

    struct CodecPipelines {
      PString m_encoder;      
      PString m_packetiser;   
      PString m_decoder;      
      PString m_depacketiser; 
    };

    bool SetMapping(
      const OpalMediaFormat & mediaFormat,  
      const CodecPipelines & info           
    );

    bool GetMapping(
      const OpalMediaFormat & mediaFormat,  
      CodecPipelines & info                 
    ) const;

    virtual bool BuildEncoder(ostream & desc, const GstMediaStream & stream);
    virtual bool BuildDecoder(ostream & desc, const GstMediaStream & stream);

  protected:
    PString m_rtpbin;
    PString m_jitterBuffer;
    PString m_audioSourceDevice;
    PString m_audioSinkDevice;
#if OPAL_VIDEO
    PString m_videoSourceDevice;
    PString m_videoSinkDevice;
    PString m_videoSourceColourConverter;
    PString m_videoSinkColourConverter;
#endif // OPAL_VIDEO

    // Translation table
    typedef map<OpalMediaFormat, CodecPipelines> CodecPipelineMap;

    CodecPipelineMap    m_MediaFormatToGStreamer;
    OpalMediaFormatList m_mediaFormatsAvailable;
};


class GstConnection : public OpalLocalConnection
{
    PCLASSINFO(GstConnection, OpalLocalConnection);
  public:
    GstConnection(
      OpalCall & call,
      GstEndPoint & ep,
      void * /*userData*/,
      unsigned options,
      OpalConnection::StringOptions * stringOptions,
      char tokenPrefix = 'G'
    );

    virtual OpalMediaStream * CreateMediaStream(
      const OpalMediaFormat & mediaFormat,
      unsigned sessionID,
      PBoolean isSource
    );

    virtual PBoolean SetAudioVolume(
      PBoolean source,        
      unsigned percentage     
    );

    virtual PBoolean GetAudioVolume(
      PBoolean source,       
      unsigned & percentage  
    );

    virtual bool SetAudioMute(
      bool source,        
      bool mute           
    );

    virtual bool GetAudioMute(
      bool source,        
      bool & mute         
    );

    virtual bool OpenPipeline(
      PGstPipeline & pipeline,
      const GstMediaStream & stream
    );

    virtual bool ConfigurePipeline(PGstPipeline & pipeline, const GstMediaStream & stream);

  protected:
    GstEndPoint & m_endpoint;
};


class GstMediaStream : public OpalMediaStream
{
    PCLASSINFO(GstMediaStream, OpalMediaStream);
  public:
    GstMediaStream(
      GstConnection & conn,                
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      bool isSource                        
    );
    ~GstMediaStream();

    virtual PBoolean Open();

    virtual PBoolean Start();

    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(
      OpalMediaStream * stream  
    ) const;

    virtual bool RequireMediaTransportThread(
      OpalMediaStream & stream  
    ) const;

    virtual bool SetAudioVolume(
      unsigned percentage     
    );

    virtual bool GetAudioVolume(
      unsigned & percentage  
    );

    virtual bool SetAudioMute(
      bool mute           
    );

    virtual bool GetAudioMute(
      bool & mute         
    );

  protected:
    virtual void InternalClose();
    virtual bool InternalSetPaused(bool pause, bool fromUser, bool fromPatch);

    bool StartPlaying(
      PGstElement::States & state
    );

    // Member variables.
    GstConnection & m_connection;
    PGstPipeline    m_pipeline;
    PGstAppSrc      m_pipeSource; // Must be after m_pipeline so is destroyed before it
    PGstAppSink     m_pipeSink;   // Ditto
    PGstElement     m_pipeVolume;
};


#endif // OPAL_GSTREAMER

#endif // GSTREAMER_GSTENDPOINT_H