Logo
ApraPipes 1.0
Loading...
Searching...
No Matches
FrameMetadata Class Reference

#include <FrameMetadata.h>

Inheritance diagram for FrameMetadata:
Inheritance graph
Collaboration diagram for FrameMetadata:
Collaboration graph

Public Types

enum  FrameType {
  GENERAL = 0 , ENCODED_IMAGE , RAW_IMAGE , RAW_IMAGE_PLANAR ,
  AUDIO , ARRAY , CHANGE_DETECTION , EDGEDEFECT_ANALYSIS_INFO ,
  PROPS_CHANGE , PAUSE_PLAY , COMMAND , H264_DATA ,
  GPIO , APRA_LINES , LINE , ROI ,
  DEFECTS_INFO , FACEDETECTS_INFO , BMP_IMAGE , MP4_VIDEO_METADATA ,
  HEVC_DATA , MOTION_VECTOR_DATA , OVERLAY_INFO_IMAGE , FACE_LANDMARKS_INFO ,
  TEXT
}
 
enum  MemType { HOST = 1 , HOST_PINNED = 2 , CUDA_DEVICE = 3 , DMABUF = 4 }
 

Public Member Functions

 FrameMetadata (FrameType _frameType)
 
 FrameMetadata (FrameType _frameType, std::string _hint)
 
 FrameMetadata (FrameType _frameType, MemType _memType)
 
virtual ~FrameMetadata ()
 
virtual void reset ()
 
virtual bool isSet ()
 
FrameType getFrameType ()
 
MemType getMemType ()
 
virtual size_t getDataSize ()
 
std::string getHint ()
 
void setHint (std::string _hint)
 
void copyHint (FrameMetadata &metadata)
 
void setData (FrameMetadata &metadata)
 

Static Public Member Functions

static size_t getPaddingLength (size_t length, size_t alignLength)
 

Protected Attributes

FrameType frameType
 
MemType memType
 
std::string hint
 
size_t dataSize = NOT_SET_NUM
 

Member Enumeration Documentation

◆ FrameType

Enumerator
GENERAL 
ENCODED_IMAGE 
RAW_IMAGE 
RAW_IMAGE_PLANAR 
AUDIO 
ARRAY 
CHANGE_DETECTION 
EDGEDEFECT_ANALYSIS_INFO 
PROPS_CHANGE 
PAUSE_PLAY 
COMMAND 
H264_DATA 
GPIO 
APRA_LINES 
LINE 
ROI 
DEFECTS_INFO 
FACEDETECTS_INFO 
BMP_IMAGE 
MP4_VIDEO_METADATA 
HEVC_DATA 
MOTION_VECTOR_DATA 
OVERLAY_INFO_IMAGE 
FACE_LANDMARKS_INFO 
TEXT 

◆ MemType

Enumerator
HOST 
HOST_PINNED 
CUDA_DEVICE 
DMABUF 

Constructor & Destructor Documentation

◆ FrameMetadata() [1/3]

FrameMetadata::FrameMetadata ( FrameType _frameType)
inline

◆ FrameMetadata() [2/3]

FrameMetadata::FrameMetadata ( FrameType _frameType,
std::string _hint )
inline

◆ FrameMetadata() [3/3]

FrameMetadata::FrameMetadata ( FrameType _frameType,
MemType _memType )
inline

◆ ~FrameMetadata()

virtual FrameMetadata::~FrameMetadata ( )
inlinevirtual

Member Function Documentation

◆ copyHint()

void FrameMetadata::copyHint ( FrameMetadata & metadata)
inline
Here is the call graph for this function:

◆ getDataSize()

virtual size_t FrameMetadata::getDataSize ( )
inlinevirtual

Reimplemented in LineMetadata, and ROIMetadata.

◆ getFrameType()

FrameType FrameMetadata::getFrameType ( )
inline

◆ getHint()

std::string FrameMetadata::getHint ( )
inline
Here is the caller graph for this function:

◆ getMemType()

MemType FrameMetadata::getMemType ( )
inline

◆ getPaddingLength()

static size_t FrameMetadata::getPaddingLength ( size_t length,
size_t alignLength )
inlinestatic
Here is the caller graph for this function:

◆ isSet()

virtual bool FrameMetadata::isSet ( )
inlinevirtual

◆ reset()

virtual void FrameMetadata::reset ( )
inlinevirtual

Reimplemented in ArrayMetadata, EncodedImageMetadata, H264Metadata, Mp4VideoMetadata, RawImageMetadata, and RawImagePlanarMetadata.

Here is the caller graph for this function:

◆ setData()

void FrameMetadata::setData ( FrameMetadata & metadata)
inline
Here is the caller graph for this function:

◆ setHint()

void FrameMetadata::setHint ( std::string _hint)
inline
Here is the caller graph for this function:

Member Data Documentation

◆ dataSize

size_t FrameMetadata::dataSize = NOT_SET_NUM
protected

◆ frameType

FrameType FrameMetadata::frameType
protected

◆ hint

std::string FrameMetadata::hint
protected

◆ memType

MemType FrameMetadata::memType
protected

The documentation for this class was generated from the following file: