API Reference
4-80
of the extended data structure. Depending on the value set for the size
field, the algorithm uses either basic or extended parameters.
║
Preconditions
The following conditions must be true prior to calling this function; otherwise, its operation is
undefined.
control()
can only be called after a successful return from
algInit()
and
algActivate().
If algorithm uses DMA resources,
control()
can only be called after a
successful return from
DMAN3_init().
handle
must be a valid handle for the algorithm’s instance object.
params must not be NULL and must point to a valid
IVIDENC2_DynamicParams
structure.
status must not be NULL and must point to a valid
IVIDENC2_Status
structure.
If a buffer is provided in the
status->data
field, it must be physically
contiguous and owned by the calling application.
║
Postconditions
The following conditions are true immediately after returning from this function.
If the control operation is successful, the return value from this operation is
equal to
IALG_EOK;
otherwise it is equal to either
IALG_EFAIL
or an
algorithm specific return value. If status or handle is NULL then codec
returns
IALG_EFAIL
If the control command is not recognized or some parameters to act upon
are not supported, the return value from this operation is not equal to
XDM_EUNSUPPORTED
.
The algorithm should not modify the contents of params. That is, the data
pointed to by this parameter must be treated as read-only.
If a buffer was provided in the
status->data
field, it is owned by the
calling application.
║
Example
See test application file, TestAppEncoder.c available in the \Client\Test\Src sub-directory.
║
See Also
algInit(),
algActivate(),
process()
4.4.4
Data Processing API
Data processing API is used for processing the input data.
║
Name
algActivate()
– initialize scratch memory buffers prior to processing.
║
Synopsis
void algActivate(IALG_Handle handle);
