IContainer.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 ICONTAINER_H_
#define ICONTAINER_H_
 
#include <com/avpkit/ferry/RefCounted.h>
#include <com/avpkit/ferry/IBuffer.h>
#include <com/avpkit/core/AVPKit.h>
#include <com/avpkit/core/ICodec.h>
#include <com/avpkit/core/IContainerFormat.h>
#include <com/avpkit/core/IStream.h>
#include <com/avpkit/core/IStreamCoder.h>
#include <com/avpkit/core/IPacket.h>
#include <com/avpkit/core/IProperty.h>
 
namespace com { namespace avpkit { namespace core
{
  class IMetaData;
  
  class VS_API_AVPKIT IContainer : public com::avpkit::ferry::RefCounted
  {
  public:
    typedef enum Type {
      READ,
      WRITE,
    } Type;
 
    virtual int32_t setInputBufferLength(int32_t size)=0;
 
    virtual int32_t getInputBufferLength()=0;
 
    virtual bool isOpened()=0;
 
    virtual bool isHeaderWritten()=0;
 
    virtual int32_t open(const char *url, Type type,
        IContainerFormat* pContainerFormat)=0;
 
    virtual int32_t open(const char *url, Type type,
        IContainerFormat* pContainerFormat,
        bool aStreamsCanBeAddedDynamically,
        bool aQueryStreamMetaData)=0;
    
    virtual IStreamCoder::CodecStandardsCompliance getStandardsCompliance()=0;
 
    virtual int32_t setStandardsCompliance(IStreamCoder::CodecStandardsCompliance compliance)=0;
 
    virtual IContainerFormat *getContainerFormat()=0;
 
    virtual int32_t close(bool dangling=false)=0;
    
    virtual Type getType()=0;
 
    virtual int32_t getNumStreams()=0;
 
    virtual IStream* getStream(int32_t streamIndex)=0;
 
    virtual IStream* addNewStream(int32_t id)=0;
 
    virtual int32_t writeHeader()=0;
 
    virtual int32_t writeTrailer()=0;
 
    virtual int32_t readNextPacket(IPacket *packet)=0;
 
    virtual int32_t writePacket(IPacket *packet, bool forceInterleave)=0;
 
    virtual int32_t writePacket(IPacket *packet)=0;
 
    static IContainer* make();
    protected:
      virtual ~IContainer()=0;
 
    /*
     * Added as of 1.17
     */
    public:
 
    virtual int32_t queryStreamMetaData()=0;
 
    virtual int32_t seekKeyFrame(int32_t streamIndex, int64_t timestamp, int32_t flags)=0;
 
    virtual int64_t getDuration()=0;
 
    virtual int64_t getStartTime()=0;
 
    virtual int64_t getFileSize()=0;
 
    virtual int32_t getBitRate()=0;
    
    /*
     * Added for 1.19
     */
 
    virtual int32_t getNumProperties()=0;
    
    virtual IProperty *getPropertyMetaData(int32_t propertyNo)=0;
 
    virtual IProperty *getPropertyMetaData(const char *name)=0;
    
    virtual int32_t setProperty(const char *name, const char* value)=0;
 
 
    virtual int32_t setProperty(const char* name, double value)=0;
    
    virtual int32_t setProperty(const char* name, int64_t value)=0;
    
    virtual int32_t setProperty(const char* name, bool value)=0;
    
    virtual int32_t setProperty(const char* name, IRational *value)=0;
 
#ifdef SWIG
    %newobject getPropertyAsString(const char*);
    %typemap(newfree) char * "free($1);";
#endif
    virtual char * getPropertyAsString(const char* name)=0;
 
    virtual double getPropertyAsDouble(const char* name)=0;
 
    virtual int64_t getPropertyAsLong(const char* name)=0;
 
    virtual  IRational *getPropertyAsRational(const char* name)=0;
 
    virtual bool getPropertyAsBoolean(const char* name)=0;
 
    typedef enum Flags {
      FLAG_GENPTS=0x0001,
      FLAG_IGNIDX=0x0002,
      FLAG_NONBLOCK=0x0004,
      FLAG_IGNDTS=0x0008,
      FLAG_NOFILLIN=0x0010,
      FLAG_NOPARSE=0x0020,
      FLAG_NOBUFFER=0x0040,
      FLAG_CUSTOM_IO=0x0080,
      FLAG_DISCARD_CORRUPT=0x0100,
      FLAG_FLUSH_PACKETS=0x0200,
      FLAG_BITEXACT=0x0400,
      FLAG_MP4A_LATM=0x8000,
      FLAG_SORT_DTS=0x10000,
      FLAG_PRIV_OPT=0x20000, 
      FLAG_KEEP_SIDE_DATA=0x40000, 
      FLAG_FAST_SEEK=0x80000,
      FLAG_SHORTEST=0x100000,
      FLAG_AUTO_BSF=0x200000
    } Flags;
    
    virtual int32_t getFlags()=0;
 
    virtual void setFlags(int32_t newFlags) = 0;
 
    virtual bool getFlag(Flags flag) = 0;
 
    virtual void setFlag(Flags flag, bool value) = 0;
 
 
    virtual const char* getURL()=0;
    
    virtual int32_t flushPackets()=0;
    
    /*
     * Added for 1.23
     */
    
    virtual int32_t getReadRetryCount()=0;
    
    virtual void setReadRetryCount(int32_t count)=0;
 
    
    /*
     * Added for 3.0
     */
    
    virtual bool canStreamsBeAddedDynamically()=0;
 
    /*
     * Added for 3.1
     */
    
    virtual IMetaData* getMetaData()=0;
    
    virtual void setMetaData(IMetaData* data)=0;
 
    virtual int32_t createSDPData(com::avpkit::ferry::IBuffer* buffer)=0;
    
    /*
     * For 3.3
     */
    
    virtual int32_t setForcedAudioCodec(ICodec::ID id)=0;
    
    virtual int32_t setForcedVideoCodec(ICodec::ID id)=0;
    
    virtual int32_t setForcedSubtitleCodec(ICodec::ID id)=0;
 
    /*
     * Added for 3.4
     */
 
    static const int32_t SEEK_FLAG_BACKWARDS=1;
    static const int32_t SEEK_FLAG_BYTE=2;
    static const int32_t SEEK_FLAG_ANY=4;
    static const int32_t SEEK_FLAG_FRAME=8;
 
    virtual int32_t seekKeyFrame(int32_t streamIndex, int64_t minTimeStamp,
        int64_t targetTimeStamp, int64_t maxTimeStamp, int32_t flags)=0;
 
    virtual int32_t setPreload(int32_t preload)=0;
 
    virtual int32_t getPreload()=0;
 
    virtual int32_t setMaxDelay(int32_t maxdelay)=0;
 
    virtual int32_t getMaxDelay()=0;
 
    /*
     * Added for 5.0
     */
 
    virtual IStream* addNewStream(ICodec::ID id)=0;
    virtual IStream* addNewStream(ICodec* codec)=0;
 
    virtual IStream* addNewStream(IStreamCoder* coder)=0;
 
    virtual int32_t setProperty(IMetaData* valuesToSet, IMetaData* valuesNotFound)=0;
 
    virtual IContainerFormat *getFormat()=0;
 
    virtual int32_t setFormat(IContainerFormat* format)=0;
 
    static IContainer* make(IContainerFormat* format);
 
    virtual int32_t open(const char *url, Type type,
        IContainerFormat* containerFormat,
        bool streamsCanBeAddedDynamically,
        bool queryStreamMetaData,
        IMetaData* options,
        IMetaData* optionsNotSet)=0;
  };
}}}
#endif /*ICONTAINER_H_*/