doc/sdk/_pv_multi_part_container_8h_source.html

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

 //

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

 //

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


 #ifndef __PVMULTIPARTCONTAINER_H__

 #define __PVMULTIPARTCONTAINER_H__


 #include <PvMultiPartSection.h>


 class PV_BUFFER_API IPvMultiPartContainerReader

 {

 public:


     virtual ~IPvMultiPartContainerReader() {}


     virtual uint32_t GetPartCount() = 0;


     virtual const IPvMultiPartSection *GetPart( uint32_t aIndex ) const = 0;


     virtual IPvMultiPartSection *GetPart( uint32_t aIndex ) = 0;


     virtual const IPvMultiPartSection *operator[]( uint32_t aIndex ) const = 0;


     virtual IPvMultiPartSection *operator[]( uint32_t aIndex ) = 0;


 };


 class PV_BUFFER_API IPvMultiPartContainerWriter

     : public IPvMultiPartContainerReader

 {

 public:


     virtual ~IPvMultiPartContainerWriter() {}


     virtual void Reset() = 0;


     virtual PvResult AddImagePart( PvMultiPartDataType aDataType, uint32_t aWidth, uint32_t aMaxHeight, PvPixelType aPixelType, uint32_t aOffsetX = 0, uint32_t aOffsetY = 0, uint16_t aPaddingX = 0 ) = 0;


     virtual PvResult AddJPEGPart( PvMultiPartDataType aDataType, uint32_t aMaxLength, uint8_t aFlag, uint64_t aTimestampTickFrequency, uint32_t aDataFormat ) = 0;


     virtual PvResult AddChunkPart( uint32_t aMaxLength, uint32_t aChunkLayoutID ) = 0;


     virtual PvResult SetPartIDs( uint32_t aIndex, uint32_t aSourceID, uint32_t aDataPurposeID, uint32_t aRegionID ) = 0;


     virtual PvResult SetPartZoneInfo( uint32_t aIndex, uint8_t aAdditionalZones, uint32_t aZoneDirectionMask ) = 0;


     virtual PvResult AllocAllParts() = 0;


     virtual PvResult AllocPart( uint32_t aIndex ) = 0;


     virtual PvResult AttachPart( uint32_t aIndex, uint8_t *aBuffer, uint64_t aLength ) = 0;


     virtual PvResult SetPartFinalLength( uint32_t aIndex, uint32_t aLength ) = 0;


     virtual PvResult SetPartFinalImageHeight( uint32_t aIndex, uint32_t aHeight ) = 0;


     virtual PvResult Validate() = 0;


 };


 class PV_BUFFER_API IPvMultiPartContainer

     : public IPvMultiPartContainerWriter

 {

 public:


     virtual ~IPvMultiPartContainer() {}


 };


 #endif

PvMultiPartSection.h
Multi-part section interface and enums definition.

PvPixelType
PvPixelType
Definition: PvPixelType.h:58

IPvMultiPartContainer
Interface to a multi-part container.
Definition: PvMultiPartContainer.h:354

IPvMultiPartContainerReader
Interface used to read from a multi-part container.
Definition: PvMultiPartContainer.h:27

IPvMultiPartContainerReader::GetPart
virtual IPvMultiPartSection * GetPart(uint32_t aIndex)=0
Indexed part (section) accessor.

IPvMultiPartContainerReader::operator[]
virtual const IPvMultiPartSection * operator[](uint32_t aIndex) const =0
Indexed part (section) const accessor.

IPvMultiPartContainerReader::GetPartCount
virtual uint32_t GetPartCount()=0
Part count of the multi-part container.

IPvMultiPartContainerReader::GetPart
virtual const IPvMultiPartSection * GetPart(uint32_t aIndex) const =0
Indexed part (section) const accessor.

IPvMultiPartContainerReader::operator[]
virtual IPvMultiPartSection * operator[](uint32_t aIndex)=0
Indexed part (section) accessor.

IPvMultiPartContainerWriter
Interface used to write to a multi-part container.
Definition: PvMultiPartContainer.h:108

IPvMultiPartContainerWriter::Validate
virtual PvResult Validate()=0
Validates the part index and allocated/attached part memory.

IPvMultiPartContainerWriter::SetPartZoneInfo
virtual PvResult SetPartZoneInfo(uint32_t aIndex, uint8_t aAdditionalZones, uint32_t aZoneDirectionMask)=0
Sets the zone info of a part.

IPvMultiPartContainerWriter::SetPartFinalImageHeight
virtual PvResult SetPartFinalImageHeight(uint32_t aIndex, uint32_t aHeight)=0
Sets the final height of an image part.

IPvMultiPartContainerWriter::Reset
virtual void Reset()=0
Resets the multi-part container index to empty - no parts.

IPvMultiPartContainerWriter::AllocAllParts
virtual PvResult AllocAllParts()=0
Allocates memory for all parts defined by the part index of the multi-part container.

IPvMultiPartContainerWriter::SetPartFinalLength
virtual PvResult SetPartFinalLength(uint32_t aIndex, uint32_t aLength)=0
Sets the final length of a part.

IPvMultiPartContainerWriter::AddChunkPart
virtual PvResult AddChunkPart(uint32_t aMaxLength, uint32_t aChunkLayoutID)=0
Adds a chunk data part to the index of a multi-part container.

IPvMultiPartContainerWriter::AddJPEGPart
virtual PvResult AddJPEGPart(PvMultiPartDataType aDataType, uint32_t aMaxLength, uint8_t aFlag, uint64_t aTimestampTickFrequency, uint32_t aDataFormat)=0
Adds a JPEG part to the index of a multi-part container.

IPvMultiPartContainerWriter::SetPartIDs
virtual PvResult SetPartIDs(uint32_t aIndex, uint32_t aSourceID, uint32_t aDataPurposeID, uint32_t aRegionID)=0
Sets the source, data purpose and region IDs of a part.

IPvMultiPartContainerWriter::AllocPart
virtual PvResult AllocPart(uint32_t aIndex)=0
Allocates memory for one of the parts as defined by the index of the part.

IPvMultiPartContainerWriter::AddImagePart
virtual PvResult AddImagePart(PvMultiPartDataType aDataType, uint32_t aWidth, uint32_t aMaxHeight, PvPixelType aPixelType, uint32_t aOffsetX=0, uint32_t aOffsetY=0, uint16_t aPaddingX=0)=0
Adds an image part to the index of a multi-part container.

IPvMultiPartContainerWriter::AttachPart
virtual PvResult AttachPart(uint32_t aIndex, uint8_t *aBuffer, uint64_t aLength)=0
Attaches a part to an external memory buffer.

IPvMultiPartSection
One section (part) of a multi-part container.
Definition: PvMultiPartSection.h:158

PvResult
Result information.
Definition: PvResult.h:30