doc/sdk/_pv_chunk_data_8h_source.html

 // *****************************************************************************

 //

 //     Copyright (c) 2017, Pleora Technologies Inc., All rights reserved.

 //

 // *****************************************************************************


 #ifndef __PVCHUNKDATA_H__

 #define __PVCHUNKDATA_H__


 #include <PvBufferLib.h>

 #include <PvPixelType.h>


 class PV_BUFFER_API IPvChunkData

 {

 public:


     virtual ~IPvChunkData() {}


     virtual void ResetChunks() = 0;


     virtual PvResult AddChunk( uint32_t aID, const uint8_t *aData, uint32_t aLength ) = 0;


     virtual void SetChunkLayoutID( uint32_t aChunkLayoutID ) = 0;


     virtual bool HasChunks() const = 0;


     virtual uint32_t GetChunkCount() = 0;


     virtual PvResult GetChunkIDByIndex( uint32_t aIndex, uint32_t &aID ) = 0;


     virtual uint32_t GetChunkSizeByIndex( uint32_t aIndex ) = 0;


     virtual uint32_t GetChunkSizeByID( uint32_t aID ) = 0;


     virtual const uint8_t *GetChunkRawDataByIndex( uint32_t aIndex ) = 0;


     virtual const uint8_t *GetChunkRawDataByID( uint32_t aID ) = 0;


     virtual uint32_t GetChunkLayoutID() = 0;


     virtual uint32_t GetChunkDataSize() const = 0;


     virtual uint32_t GetChunkDataCapacity() const = 0;


 };


 class PV_BUFFER_API PvChunkData

     : public IPvChunkData

 {

 public:


     virtual ~PvChunkData() {}


     virtual uint64_t GetChunkDataPayloadLength() const = 0;


     virtual PvResult Alloc( uint32_t aMaximumChunkLength ) = 0;


     virtual void Free() = 0;


     virtual PvResult Attach( void * aRawBuffer, uint32_t aMaximumChunkLength ) = 0;


     virtual uint8_t *Detach() = 0;


 };


 #endif

PvPixelType.h

IPvChunkData
Generic chunk data interface.
Definition: PvChunkData.h:18

IPvChunkData::SetChunkLayoutID
virtual void SetChunkLayoutID(uint32_t aChunkLayoutID)=0
Set the chunk data layout ID.

IPvChunkData::GetChunkSizeByIndex
virtual uint32_t GetChunkSizeByIndex(uint32_t aIndex)=0
See PvBuffer::GetChunkSizeByIndex.

IPvChunkData::GetChunkRawDataByIndex
virtual const uint8_t * GetChunkRawDataByIndex(uint32_t aIndex)=0
See PvBuffer::GetChunkRawDataByIndex.

IPvChunkData::AddChunk
virtual PvResult AddChunk(uint32_t aID, const uint8_t *aData, uint32_t aLength)=0
See PvBuffer::AddChunk.

IPvChunkData::GetChunkSizeByID
virtual uint32_t GetChunkSizeByID(uint32_t aID)=0
See PvBuffer::GetChunkSizeByID.

IPvChunkData::GetChunkDataCapacity
virtual uint32_t GetChunkDataCapacity() const =0
Returns the current chunk data capacity.

IPvChunkData::GetChunkRawDataByID
virtual const uint8_t * GetChunkRawDataByID(uint32_t aID)=0
See PvBuffer::GetChunkRawDataByID.

IPvChunkData::ResetChunks
virtual void ResetChunks()=0
See PvBuffer::ResetChunks.

IPvChunkData::GetChunkLayoutID
virtual uint32_t GetChunkLayoutID()=0
Get the chunk data layout ID.

IPvChunkData::GetChunkCount
virtual uint32_t GetChunkCount()=0
See PvBuffer::GetChunkCount.

IPvChunkData::GetChunkIDByIndex
virtual PvResult GetChunkIDByIndex(uint32_t aIndex, uint32_t &aID)=0
See PvBuffer::GetChunkIDByIndex.

IPvChunkData::GetChunkDataSize
virtual uint32_t GetChunkDataSize() const =0
Returns the current chunk data size.

IPvChunkData::HasChunks
virtual bool HasChunks() const =0
Returns true if the buffer has data chunks.

PvChunkData
Raw data interface to a PvBuffer.
Definition: PvChunkData.h:199

PvChunkData::Free
virtual void Free()=0
Frees (de-allocates) the buffer's internal memory.

PvChunkData::Attach
virtual PvResult Attach(void *aRawBuffer, uint32_t aMaximumChunkLength)=0
Attach this PvChunkData to an external memory buffer.

PvChunkData::Alloc
virtual PvResult Alloc(uint32_t aMaximumChunkLength)=0
Allocates memory for this PvChunkData.

PvChunkData::GetChunkDataPayloadLength
virtual uint64_t GetChunkDataPayloadLength() const =0
Get the chunk data payload length specified in the trailer information of this block.

PvChunkData::Detach
virtual uint8_t * Detach()=0
Releases an attached memory buffer.

PvResult
Result information.
Definition: PvResult.h:30