opalpluginmgr.h

Go to the documentation of this file.

/*
 * opalpluginmgr.h
 *
 * OPAL codec plugins handler
 *
 * OPAL Library
 *
 * Copyright (C) 2005-2006 Post Increment
 *
 * 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_CODEC_OPALPLUGINMGR_H
#define OPAL_CODEC_OPALPLUGINMGR_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/object.h>

#include <opal_config.h>

#include <ptlib/pluginmgr.h>
#include <ptlib/pfactory.h>
#include <codec/opalplugin.h>
#include <opal/mediafmt.h>
#include <opal/transcoders.h>

#if OPAL_H323
#include <h323/h323caps.h>
#endif

#if OPAL_VIDEO
#include <codec/vidcodec.h>
#endif



class H323Capability;

class H323StaticPluginCodec
{
  public:
    virtual ~H323StaticPluginCodec() { }
    virtual PluginCodec_GetAPIVersionFunction Get_GetAPIFn() = 0;
    virtual PluginCodec_GetCodecFunction Get_GetCodecFn() = 0;
};

typedef PFactory<H323StaticPluginCodec> H323StaticPluginCodecFactory;



class OpalPluginCodecManager;

PFACTORY_LOAD(OpalPluginCodecManager);

class OpalPluginCodecHandler : public PObject
{
  PCLASSINFO(OpalPluginCodecHandler, PObject);
  public:
    OpalPluginCodecHandler();

    static int GetChannelCount(const PluginCodec_Definition * codeDefn);

    virtual OpalMediaFormatInternal * OnCreateAudioFormat(OpalPluginCodecManager & mgr,
                                            const PluginCodec_Definition * codecDefn,
                                                              const char * fmtName,
                                                              const char * rtpEncodingName,
                                                                  unsigned frameTime,
                                                                  unsigned timeUnits,
                                                                    time_t timeStamp);
    virtual void RegisterAudioTranscoder(const PString & src, const PString & dst, const PluginCodec_Definition * codec, bool isEnc);

#if OPAL_VIDEO
    virtual OpalMediaFormatInternal * OnCreateVideoFormat(OpalPluginCodecManager & mgr,
                                            const PluginCodec_Definition * codecDefn,
                                                              const char * fmtName,
                                                              const char * rtpEncodingName,
                                                                    time_t timeStamp);
    virtual void RegisterVideoTranscoder(const PString & src, const PString & dst, const PluginCodec_Definition * codec, bool isEnc);
#endif

#if OPAL_FAX
    virtual OpalMediaFormatInternal * OnCreateFaxFormat(OpalPluginCodecManager & mgr,
                                          const PluginCodec_Definition * codecDefn,
                                                            const char * fmtName,
                                                            const char * rtpEncodingName,
                                                                unsigned frameTime,
                                                                unsigned timeUnits,
                                                                  time_t timeStamp);
    virtual void RegisterFaxTranscoder(const PString & src, const PString & dst, const PluginCodec_Definition * codec, bool isEnc);
#endif
};


class OpalPluginCodecManager : public PPluginModuleManager
{
  PCLASSINFO(OpalPluginCodecManager, PPluginModuleManager);
  public:
    OpalPluginCodecManager(PPluginManager * pluginMgr = NULL);
    ~OpalPluginCodecManager();

    PFACTORY_GET_SINGLETON(PFactory<PPluginModuleManager>, OpalPluginCodecManager);

    void RegisterStaticCodec(const H323StaticPluginCodecFactory::Key_T & name,
                             PluginCodec_GetAPIVersionFunction getApiVerFn,
                             PluginCodec_GetCodecFunction getCodecFn);

    void OnLoadPlugin(PDynaLink & dll, P_INT_PTR code);

    virtual void OnStartup();

#if OPAL_H323
    H323Capability * CreateCapability(
          const PString & _mediaFormat, 
          const PString & _baseName,
                 unsigned maxFramesPerPacket, 
                 unsigned recommendedFramesPerPacket,
                 unsigned _pluginSubType);
#endif

  protected:
    void RegisterCodecPlugins  (unsigned int count, const PluginCodec_Definition * codecList, OpalPluginCodecHandler * handler);
    void UnregisterCodecPlugins(unsigned int count, const PluginCodec_Definition * codecList, OpalPluginCodecHandler * handler);

    bool AddMediaFormat(
      OpalPluginCodecHandler * handler,
      const PTime & timeNow,
      const PluginCodec_Definition * codecDefn,
      const char * fmtName,
      OpalMediaFormat & mediaFormat
    );
#if OPAL_H323
    void RegisterCapability(const PluginCodec_Definition * codecDefn);
#endif
};



class OpalPluginControl
{
  public:
    OpalPluginControl(const PluginCodec_Definition * def, const char * name);

    bool Exists() const
    {
      return controlDef != NULL;
    }

    int Call(void * parm, unsigned * parmLen, void * context = NULL) const
    {
      return controlDef != NULL ? (*controlDef->control)(codecDef, context, fnName, parm, parmLen) : -1;
    }

    int Call(void * parm, unsigned   parmLen, void * context = NULL) const
    {
      return Call(parm, &parmLen, context);
    }

    const char * GetName() const { return fnName; }

  protected:
    const PluginCodec_Definition  * codecDef;
    const char                    * fnName;
    const PluginCodec_ControlDefn * controlDef;
};



class OpalPluginMediaFormatInternal
{
  public:
    OpalPluginMediaFormatInternal(const PluginCodec_Definition * defn);

    bool AdjustOptions(OpalMediaFormatInternal & fmt, OpalPluginControl & control) const;
    void PopulateOptions(OpalMediaFormatInternal & format);
    void SetOldStyleOption(OpalMediaFormatInternal & format, const PString & _key, const PString & _val, const PString & type);
    bool IsValidForProtocol(const PString & _protocol) const;

    const PluginCodec_Definition * codecDef;
    OpalPluginControl getOptionsControl;
    OpalPluginControl freeOptionsControl;
    OpalPluginControl validForProtocolControl;
    OpalPluginControl toNormalisedControl;
    OpalPluginControl toCustomisedControl;
};


class OpalPluginTranscoder
{
  public:
    OpalPluginTranscoder(const PluginCodec_Definition * defn, bool isEnc);
    ~OpalPluginTranscoder();

    bool UpdateOptions(OpalMediaFormat & fmt);
    bool ExecuteCommand(const OpalMediaCommand & command);
    bool Transcode(const void * from, unsigned * fromLen, void * to, unsigned * toLen, unsigned * flags) const
    {
      return codecDef != NULL && codecDef->codecFunction != NULL &&
            (codecDef->codecFunction)(codecDef, context, from, fromLen, to, toLen, flags) != 0;
    }

  protected:
    bool CreateContext();
    bool SetCodecOption(const PString & optionName, const PString & optionValue);

    const PluginCodec_Definition * codecDef;
    bool   isEncoder;
    void * context;
    unsigned m_maxPayloadSize;

    OpalPluginControl setCodecOptionsControl;
    OpalPluginControl getActiveOptionsControl;
    OpalPluginControl freeOptionsControl;
    OpalPluginControl getOutputDataSizeControl;
    OpalPluginControl getCodecStatistics;
#if PTRACING
    bool m_firstLoggedUpdateOptions[2];
#endif
};



class OpalPluginAudioFormatInternal : public OpalAudioFormatInternal, public OpalPluginMediaFormatInternal
{
  public:
    friend class OpalPluginCodecManager;

    OpalPluginAudioFormatInternal(
      const PluginCodec_Definition * codecDefn,
      const char * fmtName,
      const char * rtpEncodingName,
      unsigned frameTime,
      unsigned timeUnits,
      time_t timeStamp
    );
    virtual PObject * Clone() const;
    virtual bool IsValidForProtocol(const PString & protocol) const;
    virtual bool ToNormalisedOptions();
    virtual bool ToCustomisedOptions();
};


class OpalPluginFramedAudioTranscoder : public OpalFramedTranscoder, public OpalPluginTranscoder
{
  PCLASSINFO(OpalPluginFramedAudioTranscoder, OpalFramedTranscoder);
  public:
    OpalPluginFramedAudioTranscoder(const OpalTranscoderKey & key, const PluginCodec_Definition * codecDefn, bool isEncoder);
    bool UpdateMediaFormats(const OpalMediaFormat & input, const OpalMediaFormat & output);
    PBoolean ExecuteCommand(const OpalMediaCommand & command);
    void GetStatistics(OpalMediaStatistics & statistics) const;
    PBoolean ConvertFrame(const BYTE * input, PINDEX & consumed, BYTE * output, PINDEX & created);
    virtual PBoolean ConvertSilentFrame(BYTE * buffer, PINDEX & created);
    virtual bool AcceptComfortNoise() const { return comfortNoise; }
  protected:
    virtual bool OnCreated(const OpalMediaFormat & srcFormat,
                           const OpalMediaFormat & destFormat,
                           const BYTE * instance, unsigned instanceLen);
    bool comfortNoise;
};


class OpalPluginStreamedAudioTranscoder : public OpalStreamedTranscoder, public OpalPluginTranscoder
{
  PCLASSINFO(OpalPluginStreamedAudioTranscoder, OpalStreamedTranscoder);
  public:
    OpalPluginStreamedAudioTranscoder(const OpalTranscoderKey & key, const PluginCodec_Definition * codec, bool isEncoder);
    bool UpdateMediaFormats(const OpalMediaFormat & input, const OpalMediaFormat & output);
    PBoolean ExecuteCommand(const OpalMediaCommand & command);
    virtual bool AcceptComfortNoise() const { return comfortNoise; }
    virtual int ConvertOne(int from) const;
  protected:
    virtual bool OnCreated(const OpalMediaFormat & srcFormat,
                           const OpalMediaFormat & destFormat,
                           const BYTE * instance, unsigned instanceLen);
    bool comfortNoise;
};



#if OPAL_VIDEO

class OpalPluginVideoFormatInternal : public OpalVideoFormatInternal, public OpalPluginMediaFormatInternal
{
  public:
    OpalPluginVideoFormatInternal(
      const PluginCodec_Definition * codec,
      const char * fmtName,
      const char * rtpEncodingName, 
      time_t timeStamp              
    );
    virtual PObject * Clone() const;
    virtual bool IsValidForProtocol(const PString & protocol) const;
    virtual bool ToNormalisedOptions();
    virtual bool ToCustomisedOptions();
};


class OpalPluginVideoTranscoder : public OpalVideoTranscoder, public OpalPluginTranscoder
{
  PCLASSINFO(OpalPluginVideoTranscoder, OpalVideoTranscoder);
  public:
    OpalPluginVideoTranscoder(const OpalTranscoderKey & key, const PluginCodec_Definition * codec, bool isEncoder);
    ~OpalPluginVideoTranscoder();

#if OPAL_STATISTICS
    virtual void GetStatistics(OpalMediaStatistics & statistics) const;
#endif

    PBoolean ConvertFrames(const RTP_DataFrame & src, RTP_DataFrameList & dstList);
    bool UpdateMediaFormats(const OpalMediaFormat & input, const OpalMediaFormat & output);
    PBoolean ExecuteCommand(const OpalMediaCommand & command);

  protected:
    virtual bool OnCreated(const OpalMediaFormat & srcFormat,
                           const OpalMediaFormat & destFormat,
                           const BYTE * instance, unsigned instanceLen);
    bool EncodeFrames(const RTP_DataFrame & src, RTP_DataFrameList & dstList);
    bool DecodeFrames(const RTP_DataFrame & src, RTP_DataFrameList & dstList);
    bool DecodeFrame(const RTP_DataFrame & src, RTP_DataFrameList & dstList);

    RTP_DataFrame * m_bufferRTP;
    unsigned        m_totalFrames;

    // Check for bad markers, or abd timestamps, work arounds
    enum {
      e_MarkersInitial,
      e_MarkersUnknown,
      e_MarkersPossiblyGood,
      e_MarkersGood,
      e_MarkersPossiblyContinuous,
      e_MarkersContinuous,
      e_MarkersPossiblyMissing,
      e_MarkersMissing
    } m_markersState;
    bool          m_lastPacketMarker;
    RTP_Timestamp m_currentFrameTimestamp;
    RTP_Timestamp m_lastPacketTimestamp;
    RTP_Timestamp m_lastMarkerTimestamp;

#if PTRACING
    unsigned m_consecutiveIntraFrames;
#endif
};

#endif


#if OPAL_FAX

class OpalPluginFaxFormatInternal : public OpalMediaFormatInternal, public OpalPluginMediaFormatInternal
{
  public:
    OpalPluginFaxFormatInternal(
      const PluginCodec_Definition * codec,
      const char * fmtName,
      const char * rtpEncodingName, 
      unsigned frameTime,
      unsigned /*timeUnits*/,           
      time_t timeStamp              
    );
    virtual PObject * Clone() const;
    virtual bool IsValidForProtocol(const PString & protocol) const;
};

#endif // OPAL_FAX


//
//  this is the base class for codecs accessible via the abstract factory functions
//

class OpalFactoryCodec : public PObject {
  PCLASSINFO(OpalFactoryCodec, PObject)
  public:
    virtual const struct PluginCodec_Definition * GetDefinition()
    { return NULL; }

    virtual PString GetInputFormat() const = 0;

    virtual PString GetOutputFormat() const = 0;

    virtual int Encode(const void * from,      
                         unsigned * fromLen,   
                             void * to,        
                                 unsigned * toLen,     
                     unsigned int * flag       
                       ) = 0;  

    virtual unsigned int GetSampleRate() const = 0;

    virtual unsigned int GetBitsPerSec() const = 0;

    virtual unsigned int GetFrameTime() const = 0;

    virtual unsigned int GetSamplesPerFrame() const = 0;

    virtual unsigned int GetBytesPerFrame() const = 0;

    virtual unsigned int GetRecommendedFramesPerPacket() const = 0;

    virtual unsigned int GetMaxFramesPerPacket() const = 0;

    virtual BYTE         GetRTPPayload() const = 0;

    virtual PString      GetSDPFormat() const = 0;
};


template<class TranscoderClass>
class OpalPluginTranscoderFactory : public OpalTranscoderFactory
{
  protected:
    class Worker : public OpalTranscoderFactory::WorkerBase 
    {
      public:
        Worker(const OpalTranscoderKey & key, const PluginCodec_Definition * codec, bool enc)
          : OpalTranscoderFactory::WorkerBase()
          , m_key(key)
          , m_codecDefn(codec)
          , m_isEncoder(enc)
        {
        }

      protected:
        virtual OpalTranscoder * Create(const OpalTranscoderKey &) const
        {
          return new TranscoderClass(m_key, m_codecDefn, m_isEncoder);
        }

        OpalTranscoderKey              m_key;
        const PluginCodec_Definition * m_codecDefn;
        bool                           m_isEncoder;
    };

  public:
    static void Register(const OpalTranscoderKey & key, const PluginCodec_Definition * codec, bool enc)
    {
      Worker * worker = PNEW Worker(key, codec, enc);
      if (!OpalTranscoderFactory::Register(key, worker, true)) {
        delete worker;
        PTRACE(3, "OpalTranscoderFactory worker for " << key.first << '/' << key.second << " already registered.");
      }
    }
};

//
// Helper class for handling plugin capabilities
//

class H323PluginCapabilityInfo
{
  public:
    H323PluginCapabilityInfo(const PluginCodec_Definition * codecDefn, const OpalMediaFormat & mediaFormat);

    //H323PluginCapabilityInfo(const PString & _baseName);

    const PString & GetFormatName() const
    { return m_capabilityFormatName; }

  protected:
    const PluginCodec_Definition * m_codecDefn;
    PString                        m_capabilityFormatName;
};

#if OPAL_H323

//
// Class for handling most audio plugin capabilities
//

class H323AudioPluginCapability : public H323AudioCapability,
                                  public H323PluginCapabilityInfo
{
  PCLASSINFO(H323AudioPluginCapability, H323AudioCapability);
  public:
    H323AudioPluginCapability(const PluginCodec_Definition * codecDefn,
                              const OpalMediaFormat & mediaFormat,
                              unsigned pluginSubType);

    virtual PObject * Clone() const;

    virtual PString GetFormatName() const;

    virtual unsigned GetSubType() const;

  protected:
    unsigned pluginSubType;
};


//
// Class for handling G.723.1 codecs
//

class H323PluginG7231Capability : public H323AudioPluginCapability
{
  PCLASSINFO(H323PluginG7231Capability, H323AudioPluginCapability);
  public:
    H323PluginG7231Capability(const PluginCodec_Definition * codecDefn,
                              const OpalMediaFormat & mediaFormat);

    virtual PObject * Clone() const;
    virtual PBoolean OnSendingPDU(H245_AudioCapability & cap, unsigned packetSize) const;
    virtual PBoolean OnReceivedPDU(const H245_AudioCapability & cap,  unsigned & packetSize);
};


//
// Class for handling non standard audio capabilities
//

class H323CodecPluginNonStandardAudioCapability : public H323NonStandardAudioCapability,
                                                  public H323PluginCapabilityInfo
{
  PCLASSINFO(H323CodecPluginNonStandardAudioCapability, H323NonStandardAudioCapability);
  public:
    H323CodecPluginNonStandardAudioCapability(const PluginCodec_Definition * codecDefn,
                                              const OpalMediaFormat & mediaFormat,
                                              H323NonStandardCapabilityInfo::CompareFuncType compareFunc,
                                              const unsigned char * data, unsigned dataLen);

    H323CodecPluginNonStandardAudioCapability(const PluginCodec_Definition * codecDefn,
                                              const OpalMediaFormat & mediaFormat,
                                              const unsigned char * data, unsigned dataLen);

    virtual PObject * Clone() const;

    virtual PString GetFormatName() const;
};

//
// Class for handling generic audio capabilities
//

class H323CodecPluginGenericAudioCapability : public H323GenericAudioCapability,
                                              public H323PluginCapabilityInfo
{
  PCLASSINFO(H323CodecPluginGenericAudioCapability, H323GenericAudioCapability);
  public:
    H323CodecPluginGenericAudioCapability(const PluginCodec_Definition * codecDefn,
                                          const OpalMediaFormat & mediaFormat,
                                          const PluginCodec_H323GenericCodecData * data);

    virtual PObject * Clone() const;
    virtual PString GetFormatName() const;
};


#if OPAL_VIDEO

//
// Class for handling non standard video capabilities
//

class H323CodecPluginNonStandardVideoCapability : public H323NonStandardVideoCapability,
                                                  public H323PluginCapabilityInfo
{
  PCLASSINFO(H323CodecPluginNonStandardVideoCapability, H323NonStandardVideoCapability);
  public:
    H323CodecPluginNonStandardVideoCapability(const PluginCodec_Definition * codecDefn,
                                              const OpalMediaFormat & mediaFormat,
                                              H323NonStandardCapabilityInfo::CompareFuncType compareFunc,
                                              const unsigned char * data, unsigned dataLen);

    H323CodecPluginNonStandardVideoCapability(const PluginCodec_Definition * codecDefn,
                                              const OpalMediaFormat & mediaFormat,
                                              const unsigned char * data, unsigned dataLen);

    virtual PObject * Clone() const;

    virtual PString GetFormatName() const;
};

//
// Class for handling generic video capabilities
//

class H323CodecPluginGenericVideoCapability : public H323GenericVideoCapability,
                                              public H323PluginCapabilityInfo
{
  PCLASSINFO(H323CodecPluginGenericVideoCapability, H323GenericVideoCapability);
  public:
    H323CodecPluginGenericVideoCapability(const PluginCodec_Definition * codecDefn,
                                          const OpalMediaFormat & mediaFormat,
                                          const PluginCodec_H323GenericCodecData * data);

    virtual PObject * Clone() const;

    virtual PString GetFormatName() const;
};

//
// Class for handling H.261 plugin capabilities
//

class H323H261Capability : public H323VideoCapability
{
    PCLASSINFO(H323H261Capability, H323VideoCapability);
  public:
    H323H261Capability();

    Comparison Compare(const PObject & obj) const;

    virtual PObject * Clone() const;

    virtual PString GetFormatName() const;
    virtual unsigned GetSubType() const;

    virtual PBoolean OnSendingPDU(
      H245_VideoCapability & pdu  
    ) const;

    virtual PBoolean OnSendingPDU(
      H245_VideoMode & pdu
    ) const;

    virtual PBoolean OnReceivedPDU(
      const H245_VideoCapability & pdu  
    );
};


class H323H261PluginCapability : public H323H261Capability,
                                 public H323PluginCapabilityInfo
{
    PCLASSINFO(H323H261PluginCapability, H323VideoCapability);
  public:
    H323H261PluginCapability(const PluginCodec_Definition * codecDefn, const OpalMediaFormat & mediaFormat);

    virtual PObject * Clone() const;
};


//
// Class for handling H.263 plugin capabilities
//

class H323H263Capability : public H323VideoCapability
{
  public:
    H323H263Capability(const PString & variant);

    Comparison Compare(const PObject & obj) const;

    virtual PObject * Clone() const;

    virtual PString GetFormatName() const;
    virtual unsigned GetSubType() const;

    virtual PBoolean OnSendingPDU(
      H245_VideoCapability & pdu  
    ) const;

    virtual PBoolean OnSendingPDU(
      H245_VideoMode & pdu
    ) const;

    virtual PBoolean OnReceivedPDU(
      const H245_VideoCapability & pdu  
    );
    virtual PBoolean IsMatch(
      const PASN_Object & subTypePDU,     
      const PString & mediaPacketization  
    ) const;

  protected:
    PString m_variant;
};

class H323H263PluginCapability : public H323H263Capability,
                                 public H323PluginCapabilityInfo
{
    PCLASSINFO(H323H263PluginCapability, H323VideoCapability);
  public:
    H323H263PluginCapability(const PluginCodec_Definition * codecDefn, const OpalMediaFormat & mediaFormat)
      : H323H263Capability(mediaFormat)
      , H323PluginCapabilityInfo(codecDefn, mediaFormat)
    {
    }
};

#endif // OPAL_VIDEO
#endif // OPAL_H323

#endif // OPAL_CODEC_OPALPLUGINMGR_H