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): 
 */

#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 OpalIntraFrameControl : public PObject
{
    PCLASSINFO(OpalIntraFrameControl, PObject);
  public:
    static PTimeInterval const DefaultMinThrottle;
    static PTimeInterval const DefaultMaxThrottle;
    static PTimeInterval const DefaultPeriodic;

    OpalIntraFrameControl(
      const PTimeInterval & minThrottle = DefaultMinThrottle, 
      const PTimeInterval & maxThrottle = DefaultMaxThrottle, 
      const PTimeInterval & periodic = DefaultPeriodic        
    );

    void IntraFrameRequest();

    bool RequireIntraFrame();

    void IntraFrameDetected();

    void SetTimes(
      const PTimeInterval & minThrottle, 
      const PTimeInterval & maxThrottle, 
      const PTimeInterval & periodic,    
      const PTimeInterval & retry        
    );

  protected:
    PTimeInterval m_minThrottleTime;
    PTimeInterval m_maxThrottleTime;
    PTimeInterval m_periodicTime;
    PTimeInterval m_retryTime;
    PTimeInterval m_currentThrottleTime;

    enum State
    {
      e_Idle,
      e_Periodic,
      e_Throttled,
      e_Requesting,
      e_Requested
    } m_state;

    unsigned m_stuckCount;

   PDECLARE_MUTEX(m_mutex);
    PTime  m_lastRequest;
    PTimer m_requestTimer;
    PDECLARE_NOTIFIER(PTimer, OpalIntraFrameControl, OnTimedRequest);
};


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

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

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

    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        
    );


    virtual bool HasErrorConcealment() const  { return m_errorConcealment; }

    virtual bool ShouldDropFrame(RTP_Timestamp ts);
    virtual void UpdateFrameDrop(const RTP_DataFrameList & encoded);

    bool WasLastFrameIFrame() const { return m_lastFrameWasIFrame; }
    virtual void SendIFrameRequest(unsigned sequenceNumber, unsigned timestamp);
    virtual bool HandleIFrameRequest();

    void SetEncodingIntraFrameControlTimes(
      const PTimeInterval & minThrottle, 
      const PTimeInterval & maxThrottle, 
      const PTimeInterval & periodic,    
      const PTimeInterval & retry        
    ) { m_encodingIntraFrameControl.SetTimes(minThrottle, maxThrottle, periodic, retry); }

    void SetDecodingIntraFrameControlTimes(
      const PTimeInterval & minThrottle, 
      const PTimeInterval & maxThrottle, 
      const PTimeInterval & periodic,    
      const PTimeInterval & retry        
    ) { m_decodingIntraFrameControl.SetTimes(minThrottle, maxThrottle, periodic, retry); }

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

    unsigned      m_frameDropRate;
    int           m_frameDropBits;
    RTP_Timestamp m_lastTimestamp;
    unsigned      m_framesDropped;

    OpalIntraFrameControl m_encodingIntraFrameControl;
    OpalIntraFrameControl m_decodingIntraFrameControl;
};



OPAL_DEFINE_MEDIA_COMMAND(OpalVideoFreezePicture, "Freeze Picture", OpalMediaType::Video());

class OpalVideoUpdatePicture : public OpalMediaCommand
{
    PCLASSINFO_WITH_CLONE(OpalVideoUpdatePicture, OpalMediaCommand);
  public:
    OpalVideoUpdatePicture(
      unsigned sessionID = 0,          
      unsigned ssrc = 0                
    );
    virtual PString GetName() const;
};

class OpalVideoPictureLoss : public OpalVideoUpdatePicture
{
    PCLASSINFO_WITH_CLONE(OpalVideoPictureLoss, OpalVideoUpdatePicture);
  public:
    OpalVideoPictureLoss(
      unsigned sequenceNumber = 0,
      unsigned timestamp = 0,
      unsigned sessionID = 0,          
      unsigned ssrc = 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(
      unsigned tradeoff,
      unsigned sessionID = 0,          
      unsigned ssrc = 0                
    );

    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