IVideoPicture.h

/*******************************************************************************
 * Copyright (c) 2024, 2026, Olivier Ayache.  All rights reserved.
 *
 * This file is part of AVPKit.
 *
 * AVPKit is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AVPKit is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with AVPKit.  If not, see <http://www.gnu.org/licenses/>.
 *******************************************************************************/
 
#ifndef IVIDEOPICTURE_H_
#define IVIDEOPICTURE_H_
 
#include <com/avpkit/core/AVPKit.h>
#include <com/avpkit/core/IMediaData.h>
#include <com/avpkit/core/IPixelFormat.h>
#include <com/avpkit/ferry/IBuffer.h>
#include <com/avpkit/core/IRational.h>
 
namespace com { namespace avpkit { namespace core
{
 
  class VS_API_AVPKIT IVideoPicture : public IMediaData
  {
  public:
    virtual bool isKeyFrame()=0;
    
    virtual void setKeyFrame(bool aIsKey)=0;
    
    virtual bool isComplete()=0;
    
    virtual int32_t getSize()=0;
        
    virtual int getWidth()=0;
    
    virtual int getHeight()=0;
 
    virtual IPixelFormat::Type getPixelType()=0;
    
    virtual int64_t getPts()=0;
    
    virtual void setPts(int64_t value)=0;
    
    virtual int getQuality()=0;
    
    virtual void setQuality(int newQuality)=0;    
 
    virtual int getDataLineSize(int lineNo)=0;
    
    virtual void setComplete(bool aIsComplete, IPixelFormat::Type format,
        int width, int height, int64_t pts)=0;
 
    virtual bool copy(IVideoPicture* srcPicture)=0;
    
    virtual void render(bool drop = false, int64_t timeStamp = -1)=0;
    
#ifndef SWIG
    virtual void* getOpaqueData()=0;
#endif
    
    static IVideoPicture* make(IPixelFormat::Type format, int width, int height);
    
    static IVideoPicture* make(IVideoPicture* src);
 
    /*
     * Added for 3.1
     */
    
    typedef enum {
      DEFAULT_TYPE=0,
      I_TYPE = 1,
      P_TYPE = 2,
      B_TYPE = 3,
      S_TYPE = 4,
      SI_TYPE = 5,
      SP_TYPE = 6,
      BI_TYPE = 7,
    } PictType;
    
    virtual PictType getPictureType()=0;
    virtual void setPictureType(PictType type)=0;
    
    
    typedef enum {
        AV_FRAME_DATA_PANSCAN,
        AV_FRAME_DATA_A53_CC,
        AV_FRAME_DATA_STEREO3D,
        AV_FRAME_DATA_MATRIXENCODING,
        AV_FRAME_DATA_DOWNMIX_INFO,
        AV_FRAME_DATA_REPLAYGAIN,
        AV_FRAME_DATA_DISPLAYMATRIX,
        AV_FRAME_DATA_AFD,
        AV_FRAME_DATA_MOTION_VECTORS,
        AV_FRAME_DATA_SKIP_SAMPLES,
        AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
        AV_FRAME_DATA_MASTERING_DISPLAY_METADATA,
        AV_FRAME_DATA_GOP_TIMECODE,
 
        AV_FRAME_DATA_SPHERICAL,
 
        AV_FRAME_DATA_CONTENT_LIGHT_LEVEL,
 
        AV_FRAME_DATA_ICC_PROFILE,
    } FrameDataType;
 
    virtual void setSideData(FrameDataType type, com::avpkit::ferry::IBuffer* buffer) = 0;
    
    /*
     * Added for 3.1
     */
    
    static IVideoPicture* make(
        com::avpkit::ferry::IBuffer* buffer,
        IPixelFormat::Type format, int width, int height);
 
  protected:
    IVideoPicture();
    virtual ~IVideoPicture();
  };
 
}}}
 
#endif /*IVIDEOPICTURE_H_*/