Packet.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 PACKET_H_
#define PACKET_H_
 
#include <com/avpkit/ferry/RefPointer.h>
#include <com/avpkit/core/IPacket.h>
#include <com/avpkit/core/FfmpegIncludes.h>
#include <com/avpkit/ferry/IBuffer.h>
 
namespace com { namespace avpkit { namespace core
{
  class Packet : public IPacket
  {
  public:
    /* The default make() method doesn't add a payload */
    VS_JNIUTILS_REFCOUNTED_OBJECT(Packet);
  public:
    /* This make allocates a default payload of size payloadSize */
    static Packet* make(int32_t payloadSize);
    /* This make a packet that just wraps a given IBuffer */
    static Packet* make(com::avpkit::ferry::IBuffer* buffer);
    /* This makes a packet wrapping the buffer in another packet and copying
     * it's settings
     */
    static Packet* make(Packet* packet, bool);
  public:
    // IMediaData
    virtual int64_t getTimeStamp() { return getDts(); }
    virtual void setTimeStamp(int64_t aTimeStamp) { setDts(aTimeStamp); }
    virtual bool isKey() { return isKeyPacket(); }
    virtual IRational* getTimeBase() { return mTimeBase.get(); }
    virtual void setTimeBase(IRational *aBase) { mTimeBase.reset(aBase, true); }
    
    // IPacket
    virtual void reset();
 
    virtual int64_t getPts();
    virtual int64_t getDts();
    virtual int32_t getSize();
    virtual int32_t getMaxSize();
 
    virtual int32_t getStreamIndex();
    virtual int32_t getFlags();
    virtual bool isKeyPacket();
    virtual int64_t getDuration();
    virtual int64_t getPosition();
    virtual com::avpkit::ferry::IBuffer* getData();
    virtual int32_t allocateNewPayload(int32_t payloadSize);
    virtual bool isComplete();
    
    virtual void setKeyPacket(bool keyPacket);
    virtual void setFlags(int32_t flags);
    virtual void setPts(int64_t pts);
    virtual void setDts(int64_t dts);
    virtual void setComplete(bool complete, int32_t size);
    virtual void setStreamIndex(int32_t streamIndex);
    virtual void setDuration(int64_t duration);
    virtual void setPosition(int64_t position);
    virtual void setData(com::avpkit::ferry::IBuffer* buffer);
 
    AVPacket *getAVPacket() { return mPacket; }
    /*
     * Unfortunately people can do a getAVPacket() and have
     * FFMPEG update the buffers without us knowing.  When
     * that happens, we need them to tell us so we can update
     * our own buffer state.
     */
    void wrapAVPacket(AVPacket* pkt);
    void wrapBuffer(com::avpkit::ferry::IBuffer *buffer);
    // Used by the IBuffer to free buffers.
    static void freeAVBuffer(void *buf, void *closure);
 
  protected:
    Packet();
    virtual ~Packet();
  private:
    AVPacket* mPacket;
    com::avpkit::ferry::RefPointer<com::avpkit::ferry::IBuffer> mBuffer;
    com::avpkit::ferry::RefPointer<IRational> mTimeBase;
    bool mIsComplete;
  };
 
}}}
 
#endif /*PACKET_H_*/