cdfbuffer.h File Reference

Enum CDF_COLOR_CLASSTYPE

Color format class type

EnumeratorValueDescription
CDF_COLOR_ClassYUV420

YUV 4:2:0

CDF_COLOR_ClassYUV422

YUV 4:2:2

CDF_COLOR_ClassYUV444

YUV 4:4:4

CDF_COLOR_ClassRGB

Red, green, blue

CDF_COLOR_ClassRGBA

Red, green, blue, alpha

CDF_COLOR_ClassRAW

Raw Bayer

Typedef CDF_COLOR_CLASSTYPE

typedef enum CDF_COLOR_CLASSTYPECDF_COLOR_CLASSTYPE

Color format class type

Enum CDF_COLOR_DIVISIONTYPE

Color format division type

EnumeratorValueDescription
CDF_COLOR_DivisionPlanar

Planar format

CDF_COLOR_DivisionPacked

Packed format

CDF_COLOR_DivisionInterleaved

Interleaved format

Typedef CDF_COLOR_DIVISIONTYPE

typedef enum CDF_COLOR_DIVISIONTYPECDF_COLOR_DIVISIONTYPE

Color format division type

Typedef CDF_COLOR_FORMATINFOTYPE

typedef struct CDF_COLOR_FORMATINFOTYPECDF_COLOR_FORMATINFOTYPE

Color format info type

Enum CDF_FRAMEBUFFER_CONTROLTYPE

Frame buffer control

EnumeratorValueDescription
CDF_FRAMEBUFFER_ControlEndOfFrame0x1

Last piece of frame. Next piece will be start of next frame.

CDF_FRAMEBUFFER_ControlEndOfSequence0x2

Last frame in sequence. Features should go back to initial state after this frame.

CDF_FRAMEBUFFER_ControlReserved0x4

Frame buffer is reserved by framework and cannot be released. May happen if with multiframe features which require more frames to produce output frame and need previous frames.

CDF_FRAMEBUFFER_ControlReadOnly0x8

Frame buffer is read only. Can be used with input frames only.

Typedef CDF_FRAMEBUFFER_CONTROLTYPE

typedef enum CDF_FRAMEBUFFER_CONTROLTYPECDF_FRAMEBUFFER_CONTROLTYPE

Frame buffer control

Typedef CDF_FRAMEBUFFERHANDLE

typedef struct CDF_FRAMEBUFFERTYPE *CDF_FRAMEBUFFERHANDLE

Typedef CDF_FRAMEBUFFERTYPE

typedef struct CDF_FRAMEBUFFERTYPECDF_FRAMEBUFFERTYPE

Frame buffer

CDF_FrameBuffer_Create ( CDF_FRAMEBUFFERHANDLE * )

IMPORT_C CDF_ERRORTYPECDF_FrameBuffer_Create(CDF_FRAMEBUFFERHANDLE *phFrameBuffer)

Creates frame buffer handle.

Return Value
Error code

CDF_FrameBuffer_Destroy ( CDF_FRAMEBUFFERHANDLE )

IMPORT_C voidCDF_FrameBuffer_Destroy(CDF_FRAMEBUFFERHANDLEhFrameBuffer)

Destroys frame buffer handle.

CDF_FrameBuffer_IsControlSet ( const CDF_FRAMEBUFFERHANDLE, const CDF_FRAMEBUFFER_CONTROLTYPE )

IMPORT_C CDF_BOOLCDF_FrameBuffer_IsControlSet(const CDF_FRAMEBUFFERHANDLEhFrameBuffer,
const CDF_FRAMEBUFFER_CONTROLTYPEeControl
)

Checks if control bit is set in frame buffer

Return Value
Boolean if bit is set or not

CDF_FrameBuffer_SetControl ( CDF_FRAMEBUFFERHANDLE, const CDF_FRAMEBUFFER_CONTROLTYPE )

IMPORT_C voidCDF_FrameBuffer_SetControl(CDF_FRAMEBUFFERHANDLEhFrameBuffer,
const CDF_FRAMEBUFFER_CONTROLTYPEeControl
)

Sets control bit in frame buffer.

CDF_FrameBuffer_UnsetControl ( CDF_FRAMEBUFFERHANDLE, const CDF_FRAMEBUFFER_CONTROLTYPE )

IMPORT_C voidCDF_FrameBuffer_UnsetControl(CDF_FRAMEBUFFERHANDLEhFrameBuffer,
const CDF_FRAMEBUFFER_CONTROLTYPEeControl
)

Unsets control bit of frame buffer.

CDF_FrameBuffer_SetStride ( CDF_FRAMEBUFFERHANDLE )

IMPORT_C CDF_ERRORTYPECDF_FrameBuffer_SetStride(CDF_FRAMEBUFFERHANDLEhFrameBuffer)

Sets frame stride sizes based on frame resolution and color format.

Return Value
Error code

CDF_FrameBuffer_AllocateBuffer ( CDF_FRAMEBUFFERHANDLE )

IMPORT_C CDF_ERRORTYPECDF_FrameBuffer_AllocateBuffer(CDF_FRAMEBUFFERHANDLEhFrameBuffer)

Allocates frame data buffers. Frame resolution and color format must be set.

Return Value
Error code

CDF_FrameBuffer_FreeBuffer ( CDF_FRAMEBUFFERHANDLE )

IMPORT_C CDF_ERRORTYPECDF_FrameBuffer_FreeBuffer(CDF_FRAMEBUFFERHANDLEhFrameBuffer)

Frees frame data buffers. Only data buffers are freed, handle remains.

Return Value
Error code

CDF_GetImageSizePerComponent ( const CDF_SIZE, const CDF_COLOR_FORMATTYPE, CDF_SIZET *, CDF_U32 * )

IMPORT_C CDF_ERRORTYPECDF_GetImageSizePerComponent(const CDF_SIZEresolution,
const CDF_COLOR_FORMATTYPEeColorFormat,
CDF_SIZET *pnStrides,
CDF_U32 *pnHeights
)

Gets image stride lengths and heights based on resolution and color format.

Return Value
Error code

CDF_GetColorFormatInfo ( const CDF_COLOR_FORMATTYPE, CDF_COLOR_FORMATINFOTYPE * )

IMPORT_C CDF_ERRORTYPECDF_GetColorFormatInfo(const CDF_COLOR_FORMATTYPEeColorFormat,
CDF_COLOR_FORMATINFOTYPE *pInfo
)

Gets color format information.

Return Value
Error code