Texas Instruments H.264 High Profile Encoder, Руководство пользователя

Страница: 123 / 139

4-79
4.4.3 Control API
Control API is used for controlling the functioning of the algorithm instance during run-time. This is
done by changing the status of the controllable parameters of the algorithm during run-time. These
controllable parameters are defined in the
Status
data structure (see section 4.2 for details).
║ Name
control()
– change run time parameters and query the status
║ Synopsis
XDAS_Int32 (*control) (IVIDENC2_Handle handle,
IVIDENC2_Cmd id, IVIDENC2_DynamicParams *params,
IVIDENC2_Status *status);
║ Arguments
IVIDENC2_Handle handle; /* algorithm instance handle */
IVIDENC2_Cmd id; /* algorithm specific control commands*/
IVIDENC2_DynamicParams *params
/*
algorithm run time parameters
*/
IVIDENC2_Status *status
/*
algorithm instance status parameters */
║
Return Value
IALG_EOK; /* status indicating success */
IALG_EFAIL; /* status indicating failure */
XDM_EUNSUPPORTED; /* status indicating parameters not
supported*/
║
Description
This function changes the run time parameters of an algorithm instance and queries the algorithm’s
status. control()
must only be called after a successful
call to algInit()
and must never
be called after a call
to algFree()
.
The first argument to
control()
is a handle to an algorithm instance.
The second argument is an algorithm specific control command. See
XDM_CmdId
enumeration for
details.
The third and fourth arguments are pointers to the
IVIDENC2_DynamicParams
and
IVIDENC2_Status
data structures respectively.
Note:
If you are using extended data structures, the third and fourth arguments
must be pointers to the extended
DynamicParams
and
Status
data
structures respectively. Also, ensure that the
size
field is set to the size