IStream.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 ISTREAM_H_
#define ISTREAM_H_
#include <com/avpkit/ferry/RefCounted.h>
#include <com/avpkit/core/AVPKit.h>
#define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
namespace com { namespace avpkit { namespace core
{
  class IStreamCoder;
  class IContainer;
  class IRational;
  class IMetaData;
  class IPacket;
  class IIndexEntry;
  
  class VS_API_AVPKIT IStream : public com::avpkit::ferry::RefCounted
  {
  public:
    typedef enum Direction {
      INBOUND,
      OUTBOUND,
    } Direction;
    
    virtual Direction getDirection()=0;
    virtual int getIndex()=0;
 
    virtual int getId()=0;
 
    virtual IStreamCoder * getStreamCoder()=0;
 
    virtual IRational * getFrameRate()=0;
 
    virtual IRational * getTimeBase()=0;
 
    virtual int64_t getStartTime()=0;
 
    virtual int64_t getDuration()=0;
 
    virtual int64_t getCurrentDts()=0;
 
    virtual int getNumIndexEntries()=0;
 
    virtual int64_t getNumFrames()=0;
    
  protected:
    virtual ~IStream()=0;
    IStream();
  public:
 
    virtual IRational* getSampleAspectRatio()=0;
    virtual void setSampleAspectRatio(IRational* newRatio)=0;
 
    virtual const char* getLanguage()=0;
 
    virtual void setLanguage(const char* language)=0;
    
    virtual IContainer* getContainer()=0;
    
    /*
     * Added for 1.22
     */
    
    virtual int32_t setStreamCoder(IStreamCoder *newCoder)=0;
    
    /*
     * Added for 3.0
     */
    
    typedef enum ParseType {
      PARSE_NONE,
      PARSE_FULL,       
      PARSE_HEADERS,    
      PARSE_TIMESTAMPS, 
      PARSE_FULL_ONCE,  
      PARSE_FULL_RAW,       
    } ParseType;
    
    virtual IStream::ParseType getParseType()=0;
    
    virtual void setParseType(ParseType type)=0;
    
    virtual int setBitstreamFilter(const char* name)=0;
 
    /*
     * Added for 3.1
     */
    
   virtual IMetaData* getMetaData()=0;
    
   virtual void setMetaData(IMetaData* data)=0;
 
   /*
    * Added for 3.2
    */
   
   virtual int32_t stampOutputPacket(IPacket* packet)=0;
    
 
   virtual int32_t setStreamCoder(IStreamCoder *newCoder, bool assumeOnlyStream)=0;
 
   /*
    * Added for 3.4
    */
   virtual IIndexEntry* findTimeStampEntryInIndex(
       int64_t wantedTimeStamp, int32_t flags)=0;
 
   virtual int32_t findTimeStampPositionInIndex(
       int64_t wantedTimeStamp, int32_t flags)=0;
 
   virtual IIndexEntry* getIndexEntry(int32_t position)=0;
 
   virtual int32_t addIndexEntry(IIndexEntry* entry)=0;
 
   virtual void setId(int32_t id) = 0;
  };
}}}
 
#endif /*ISTREAM_H_*/