cdfbase.h File Reference

CDF_API_H

CDF_API

Enum CDF_ERRORTYPE

Error codes. These errors should cover most of the common failure cases. However, vendors are free to add additional error messages of their own as long as they follow these rules: 1. Vendor error messages shall be in the range of 0x90000000 to 0x9000FFFF. 2. Vendor error messages shall be defined in a header file provided with the component. No error messages are allowed that are not defined.

EnumeratorValueDescription
CDF_ErrorNone0
CDF_ErrorInsufficientResources0x80001000

There were insufficient resources to perform the requested operation

CDF_ErrorUndefined0x80001001

There was an error, but the cause of the error could not be determined

CDF_ErrorNotFound0x80001003

No feature with the specified name string was found

CDF_ErrorInvalidFeature0x80001004

The feature specified did not have all entry points defined

CDF_ErrorBadParameter0x80001005

One or more parameters were not valid

CDF_ErrorNotImplemented0x80001006

The requested function is not implemented

CDF_ErrorUnderflow0x80001007

The buffer was emptied before the next buffer was ready

CDF_ErrorOverflow0x80001008

The buffer was not available when it was needed

CDF_ErrorHardware0x80001009

The hardware failed to respond as expected

CDF_ErrorInvalidState0x8000100A

The component is in the state CDF_StateInvalid

CDF_ErrorNoMore0x8000100E

No more indicies can be enumerated

CDF_ErrorVersionMismatch0x8000100F

The component detected a version mismatch

CDF_ErrorNotReady0x80001010

The component is not ready to return data at this time

CDF_ErrorTimeout0x80001011

There was a timeout that occurred

CDF_ErrorReadOnly0x80002000

The item is read only

CDF_ErrorNoMemory0x80002001

Memory allocation failed

CDF_ErrorUnsupported0x80002002
CDF_ErrorAlreadyExists0x80002004

Item already exists

CDF_ErrorUnsupportedIDLVersion0x80002005

Unsupported IDL version

CDF_ErrorMemoryLeak0x80002006

Memory leaks detected

CDF_ErrorPermissionDenied0x80002007
CDF_ErrorMax0x7FFFFFFF

Typedef CDF_ERRORTYPE

typedef enum CDF_ERRORTYPECDF_ERRORTYPE

Error codes. These errors should cover most of the common failure cases. However, vendors are free to add additional error messages of their own as long as they follow these rules: 1. Vendor error messages shall be in the range of 0x90000000 to 0x9000FFFF. 2. Vendor error messages shall be defined in a header file provided with the component. No error messages are allowed that are not defined.

CDF_IN

Specifier for function argument. Represents input.

CDF_OUT

Specifier for function argument. Represents output.

CDF_ALLOC

Specifier for function argument. Memory allocation is done inside the function and ownership is tranferred to the client

CDF_REF

Specifier for function argument. The pointer passed should be used only for reading, usually a constant data. The client should not release the memory

CDF_INOUT

Specifier for function argument. Represents input and output. Part of structure will be as input and some will be written with output

Typedef CDF_PTR

typedef void *CDF_PTR

General pointer type

Typedef CDF_STRING

typedef CDF_CHAR *CDF_STRING

Character string type

Typedef CDF_HANDLETYPE

typedef void *CDF_HANDLETYPE

Handle type

Typedef CDF_BOOL

typedef CDF_U32 CDF_BOOL

Boolean type

CDF_TRUE

Indicates the 'true' value for CDF_BOOL

CDF_FALSE

Indicates the 'false' value for CDF_BOOL

CDF_Y

Color channel indexes for YUV, RGB(A) and RAW image formats

CDF_U

CDF_V

CDF_R

CDF_G

CDF_B

CDF_A

CDF_BG

CDF_GR

CDF_RG

CDF_GB

Typedef CDF_SIZET

typedef size_t CDF_SIZET

Typedef CDF_VERSIONTYPE

typedef union CDF_VERSIONTYPECDF_VERSIONTYPE

Version information

Typedef CDF_RECT

typedef struct CDF_RECTCDF_RECT

A two-dimensional rectangle

Typedef CDF_POINT

typedef struct CDF_POINTCDF_POINT

A two-dimensional point

Typedef CDF_SIZE

typedef struct CDF_SIZECDF_SIZE

A two-dimensional size

Typedef CDF_BORDERS

typedef struct CDF_BORDERSCDF_BORDERS

Border area

Enum CDF_COLOR_FORMATTYPE

Color formats

EnumeratorValueDescription
CDF_COLOR_YUV420_8bit_Packed0
YUV420, 8-bit per pixel 
        YYYYUU
        YYYYVV
        YYYYUU
        YYYYVV
CDF_COLOR_YUV420_8bit_Planar1
YUV420, 8-bit per pixel 
        YYYY
        YYYY
        UU
        VV
CDF_COLOR_YUV420_16bit_Packed2

YUV420, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV420_16bit_Planar3

YUV420, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV422_8bit_Packed4
YUV422, 8-bit per pixel 
        YYYYUUVV
        YYYYUUVV
CDF_COLOR_YUV422_8bit_Planar5
YUV422, 8-bit per pixel 
        YYYY
        YYYY
        UU
        UU
        VV
        VV
CDF_COLOR_YUV422_8bit_UYVY_Interleaved6
YUV422, 8-bit per pixel 
        UYVYUYVY
        UYVYUYVY
CDF_COLOR_YUV422_8bit_VYUY_Interleaved7
YUV422, 8-bit per pixel 
        VYUYVYUY
        VYUYVYUY
CDF_COLOR_YUV422_8bit_YUYV_Interleaved8
YUV422, 8-bit per pixel 
        YUYVYUYV
        YUYVYUYV
CDF_COLOR_YUV422_8bit_YVYU_Interleaved9
YUV422, 8-bit per pixel 
        YVYUYVYU
        YVYUYVYU
CDF_COLOR_YUV422_16bit_Packed10

YUV422, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV422_16bit_Planar11

YUV422, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV422_16bit_UYVY_Interleaved12

YUV422, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV422_16bit_VYUY_Interleaved13

YUV422, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV422_16bit_YUYV_Interleaved14

YUV422, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV422_16bit_YVYU_Interleaved15

YUV422, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV444_8bit_Packed16
YUV444, 8-bit per pixel 
        YYYYUUUUVVVV
        YYYYUUUUVVVV
CDF_COLOR_YUV444_8bit_Planar17
YUV444, 8-bit per pixel 
        YYYY
        YYYY
        UUUU
        UUUU
        VVVV
        VVVV
CDF_COLOR_YUV444_8bit_Interleaved18
YUV444, 8-bit per pixel 
        YUVYUVYUVYUV
        YUVYUVYUVYUV
CDF_COLOR_YUV444_16bit_Packed19

YUV444, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV444_16bit_Planar20

YUV444, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_YUV444_16bit_Interleaved21

YUV444, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RGB_8bit_Packed22
RGB, 8-bit per pixel 
        RRRRGGGGBBBB
        RRRRGGGGBBBB
CDF_COLOR_RGB_8bit_Planar23
RGB, 8-bit per pixel 
        RRRR
        RRRR
        GGGG
        GGGG
        BBBB
        BBBB
CDF_COLOR_RGB_8bit_Interleaved24
RGB, 8-bit per pixel 
        RGBRGBRGBRGB
        RGBRGBRGBRGB
CDF_COLOR_RGB_16bit_Packed25

RGB, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RGB_16bit_Planar26

RGB, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RGB_16bit_Interleaved27

RGB, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RGBA_8bit_Packed28
RGBA, 8-bit per pixel 
        RRRRGGGGBBBBAAAA
        RRRRGGGGBBBBAAAA
CDF_COLOR_RGBA_8bit_Planar29
RGBA, 8-bit per pixel 
        RRRR
        RRRR
        GGGG
        GGGG
        BBBB
        BBBB
        AAAA
        AAAA
CDF_COLOR_RGBA_8bit_Interleaved30
RGBA, 8-bit per pixel 
        RGBARGBARGBARGBA
        RGBARGBARGBARGBA
CDF_COLOR_RGBA_16bit_Packed31

RGBA, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RGBA_16bit_Planar32

RGBA, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RGBA_16bit_Interleaved33

RGBA, 16-bit per pixel. Pixel order is similar to the 8-bit counter part

CDF_COLOR_RAW_16bit_GRBG_Interleaved34
RAW CFA data, 16-bit per pixel 
        Gr R  Gr R  Gr R  Gr R 
        B  Gb B  Gb B  Gb B  Gb
        Gr R  Gr R  Gr R  Gr R 
        B  Gb B  Gb B  Gb B  Gb
CDF_COLOR_RAW_16bit_RGGB_Interleaved35
RAW CFA data, 16-bit per pixel 
        R  Gr R  Gr R  Gr R  Gr 
        Gb B  Gb B  Gb B  Gb B  
        R  Gr R  Gr R  Gr R  Gr 
        Gb B  Gb B  Gb B  Gb B
CDF_COLOR_RAW_16bit_BGGR_Interleaved36
RAW CFA data, 16-bit per pixel 
        B  Gb B  Gb B  Gb B  Gb
        Gr R  Gr R  Gr R  Gr R 
        B  Gb B  Gb B  Gb B  Gb
        Gr R  Gr R  Gr R  Gr R
CDF_COLOR_RAW_16bit_GBRG_Interleaved37
RAW CFA data, 16-bit per pixel 
        Gb B  Gb B  Gb B  Gb B  
        R  Gr R  Gr R  Gr R  Gr 
        Gb B  Gb B  Gb B  Gb B  
        R  Gr R  Gr R  Gr R  Gr
CDF_COLOR_RAW_16bit_Planar38
RAW CFA data, 16-bit per pixel 
        R  R  R  R
        R  R  R  R
        Gr Gr Gr Gr
        Gr Gr Gr Gr
        B  B  B  B
        B  B  B  B
        Gb Gb Gb Gb
        Gb Gb Gb Gb
CDF_COLOR_RAW_16bit_Packed39
RAW CFA data, 16-bit per pixel 
        R  R  R  R  Gr Gr Gr Gr  B  B  B  B  Gb Gb Gb Gb
        R  R  R  R  Gr Gr Gr Gr  B  B  B  B  Gb Gb Gb Gb

Typedef CDF_COLOR_FORMATTYPE

typedef enum CDF_COLOR_FORMATTYPECDF_COLOR_FORMATTYPE

Color formats

© Nokia 2005.