Ienc1

Provides a simple interface to IMGENC1 (XDM 1.0) based algorithms. More...

Typedefs

typedef struct Ienc1_Object * Ienc1_Handle
 Handle through which to reference an Image Encode algorithm.

Functions

Ienc1_Handle Ienc1_create (Engine_Handle hEngine, Char *codecName, IMGENC1_Params *params, IMGENC1_DynamicParams *dynParams)
 Creates an Image Encode (XDM 1.0) algorithm instance.
Int Ienc1_process (Ienc1_Handle hIe, Buffer_Handle hInBuf, Buffer_Handle hOutBuf)
 Encodes an image buffer.
Int Ienc1_delete (Ienc1_Handle hIe)
 Deletes an Image Encode algorithm instance.
IMGENC1_Handle Ienc1_getVisaHandle (Ienc1_Handle hIe)
 Get the IMGENC1 handle from the Ienc1 module instance.
Int32 Ienc1_getInBufSize (Ienc1_Handle hIe)
 Get the input buffer size required by the codec.
Int32 Ienc1_getOutBufSize (Ienc1_Handle hIe)
 Get the output buffer size required by the codec.

Variables

const IMGENC1_Params Ienc1_Params_DEFAULT
 Default XDM parameters for an Image Encode algorithm.
const IMGENC1_DynamicParams Ienc1_DynamicParams_DEFAULT
 Default XDM dynamic parameters for an Image Encode algorithm.

Detailed Description

Provides a simple interface to IMGENC1 (XDM 1.0) based algorithms.


Typedef Documentation

typedef struct Ienc1_Object* Ienc1_Handle

Handle through which to reference an Image Encode algorithm.


Function Documentation

Ienc1_Handle Ienc1_create ( Engine_Handle  hEngine,
Char *  codecName,
IMGENC1_Params *  params,
IMGENC1_DynamicParams *  dynParams 
)

Creates an Image Encode (XDM 1.0) algorithm instance.

Parameters:
[in] hEngine An opened engine containing the algorithm to create.
[in] codecName The name of the algorithm to open. Corresponds to the string name given in the .cfg file.
[in] params XDM parameters to use while creating the codec.
[in] dynParams XDM dynamic parameters to use while creating the codec.
Return values:
Handle for use in subsequent operations (see Ienc1_Handle).
NULL for failure.

Int Ienc1_process ( Ienc1_Handle  hIe,
Buffer_Handle  hInBuf,
Buffer_Handle  hOutBuf 
)

Encodes an image buffer.

Parameters:
[in] hIe The Ienc1_Handle to use for encoding.
[in] hInBuf The Buffer_Handle for the buffer containing the raw data.
[in] hOutBuf The Buffer_Handle for the buffer to fill with encoded data.
Return values:
Dmai_EOK for success.
Negative value for failure, see Dmai.h.
Remarks:
Ienc1_create must be called before this function.

Int Ienc1_delete ( Ienc1_Handle  hIe  ) 

Deletes an Image Encode algorithm instance.

Parameters:
[in] hIe The Ienc1_Handle to delete.
Return values:
Dmai_EOK for success.
Negative value for failure, see Dmai.h.
Remarks:
Ienc1_create must be called before this function.

IMGENC1_Handle Ienc1_getVisaHandle ( Ienc1_Handle  hIe  ) 

Get the IMGENC1 handle from the Ienc1 module instance.

Parameters:
[in] hIe The Ienc1_Handle for which to get the IMGENC1 handle.
Return values:
Handle to the image encode algorithm, see the XDM documentation for IMGENC1.
Remarks:
Ienc1_create must be called before this function.

Int32 Ienc1_getInBufSize ( Ienc1_Handle  hIe  ) 

Get the input buffer size required by the codec.

Parameters:
[in] hIe The Ienc1_Handle for which to get the buffer size.
Return values:
Size in bytes of the input buffer required.
Remarks:
Ienc1_create must be called before this function.

Int32 Ienc1_getOutBufSize ( Ienc1_Handle  hIe  ) 

Get the output buffer size required by the codec.

Parameters:
[in] hIe The Ienc1_Handle for which to get the buffer size.
Return values:
Size in bytes of the output buffer required.
Remarks:
Ienc1_create must be called before this function.


Variable Documentation

const IMGENC1_Params Ienc1_Params_DEFAULT

Default XDM parameters for an Image Encode algorithm.

     size                     = sizeof (IMGENC1_Params),
     maxHeight                = 0,
     maxWidth                 = 0,
     maxScans                 = XDM_DEFAULT, 
     dataEndianness           = XDM_BYTE,
     forceChromaFormat        = XDM_YUV_422P

const IMGENC1_DynamicParams Ienc1_DynamicParams_DEFAULT

Default XDM dynamic parameters for an Image Encode algorithm.

  size                        = sizeof(IMGENC1_DynamicParams),
  numAU                       = XDM_DEFAULT,
  inputChromaFormat           = XDM_YUV_422ILE,
  inputHeight                 = 0, 
  inputWidth                  = 0,
  captureWidth                = 0, 
  generateHeader              = XDM_ENCODE_AU,
  qValue                            = 75


Copyright 2011, Texas Instruments Incorporated