vidcodec.h

Go to the documentation of this file.

/*
 * vidcodec.h
 *
 * Uncompressed video handler
 *
 * Open Phone Abstraction Library
 *
 * Copyright (c) 2003 Equivalence 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): 
 *
 * $Revision: 31630 $
 * $Author: rjongbloed $
 * $Date: 2014-03-28 11:30:35 +1100 (Fri, 28 Mar 2014) $
 */

#ifndef OPAL_CODEC_VIDCODEC_H
#define OPAL_CODEC_VIDCODEC_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#include <opal/transcoders.h>

#if OPAL_VIDEO

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

#include <codec/opalplugin.h>
#include <codec/known.h>


extern const OpalVideoFormat & GetOpalRGB24();
extern const OpalVideoFormat & GetOpalRGB32();
extern const OpalVideoFormat & GetOpalBGR24();
extern const OpalVideoFormat & GetOpalBGR32();
extern const OpalVideoFormat & GetOpalYUV420P();

#define OpalRGB24   GetOpalRGB24()
#define OpalRGB32   GetOpalRGB32()
#define OpalBGR24   GetOpalBGR24()
#define OpalBGR32   GetOpalBGR32()
#define OpalYUV420P GetOpalYUV420P()

#define OPAL_REGISTER_RAW_VIDEO() \
              GetOpalRGB24(); \
              GetOpalRGB32(); \
              GetOpalBGR24(); \
              GetOpalBGR32(); \
              GetOpalYUV420P()



class OpalVideoTranscoder : public OpalTranscoder
{
    PCLASSINFO(OpalVideoTranscoder, OpalTranscoder);
  public:
    typedef PluginCodec_Video_FrameHeader FrameHeader;

    OpalVideoTranscoder(
      const OpalMediaFormat & inputMediaFormat,  
      const OpalMediaFormat & outputMediaFormat  
    );

    virtual bool UpdateMediaFormats(
      const OpalMediaFormat & inputMediaFormat,  
      const OpalMediaFormat & outputMediaFormat  
    );

    virtual PINDEX GetOptimalDataFrameSize(
      PBoolean input      
    ) const;

    virtual PBoolean ExecuteCommand(
      const OpalMediaCommand & command    
    );

    virtual PBoolean Convert(
      const RTP_DataFrame & input,  
      RTP_DataFrame & output        
    );

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

    static OpalVideoFormat::VideoFrameType GetVideoFrameType(
      const PCaselessString & rtpEncodingName,
      const BYTE * payloadPtr,
      PINDEX payloadSize,
      PBYTEArray & context
    );

    virtual bool HasErrorConcealment() const  { return m_errorConcealment; }
    bool WasLastFrameIFrame() const { return m_lastFrameWasIFrame; }
    void ForceIFrame()              { m_forceIFrame = true; }
    virtual void SendIFrameRequest(unsigned sequenceNumber, unsigned timestamp);
    virtual bool HandleIFrameRequest();

  protected:
    PINDEX m_inDataSize;
    PINDEX m_outDataSize;
    bool   m_errorConcealment;
    bool   m_freezeTillIFrame;
    bool   m_frozenTillIFrame;
    bool   m_forceIFrame;
    bool   m_lastFrameWasIFrame;

    PSimpleTimer  m_throttleRequestIFrameTimer;
    PSimpleTimer  m_throttleSendIFrameTimer;
    PTimeInterval m_lastReceivedIFrameRequest;

    DWORD m_totalFrames;
    DWORD m_keyFrames;
};



OPAL_DEFINE_MEDIA_COMMAND(OpalVideoFreezePicture, "Freeze Picture");

class OpalVideoUpdatePicture : public OpalMediaCommand
{
    PCLASSINFO_WITH_CLONE(OpalVideoUpdatePicture, OpalMediaCommand);
  public:
    virtual PString GetName() const;
};

class OpalVideoPictureLoss : public OpalVideoUpdatePicture
{
    PCLASSINFO_WITH_CLONE(OpalVideoPictureLoss, OpalVideoUpdatePicture);
  public:
    OpalVideoPictureLoss(unsigned sequenceNumber = 0, unsigned timestamp = 0);

    virtual PString GetName() const;

    unsigned GetSequenceNumber() const { return m_sequenceNumber; }
    unsigned GetTimestamp() const { return m_timestamp; }

  protected:
    unsigned m_sequenceNumber;
    unsigned m_timestamp;
};


class OpalTemporalSpatialTradeOff : public OpalMediaCommand
{
    PCLASSINFO_WITH_CLONE(OpalTemporalSpatialTradeOff, OpalMediaCommand);
  public:
    OpalTemporalSpatialTradeOff(int tradeoff) : m_tradeOff(tradeoff) { }

    virtual PString GetName() const;

    enum {
      MaximiseSpatial = 0,
      MaximiseTemporal = 31
    };

    unsigned GetTradeOff() const { return m_tradeOff; }

  protected:
    unsigned m_tradeOff;
};


#endif // OPAL_VIDEO

#endif // OPAL_CODEC_VIDCODEC_H