#include <ividdec2.h>
Collaboration diagram for IVIDDEC2FRONT_Status:
Data Fields | |
XDM_ContextInfo | contextInfo |
XDAS_Int32 | nextPartRequiredFlag |
XDAS_Int32 | partialExtendedError |
IVIDDEC2_Status | fullStatus |
Context info.
Flag indicating whether the next part in the split codec must be called or not.
nextPartRequiredFlag
field is XDAS_TRUE, the application must call the next part in the split codec.
If the control() call returned failure (i.e., something other than IVIDDEC2_EOK), the codec must set this field to XDAS_FALSE. Further information about the failure can be obtained via the partialExtendedError
field.
Extended error information.
The value of each enum is the bit which is set.
Bits 31-16 are reserved. Bits 7-0 are codec and implementation specific.
The algorithm can set multiple bits to 1 based on conditions. e.g. it will set bits XDM_FATALERROR (fatal) and XDM_UNSUPPORTEDPARAM (unsupported params) in case of unsupported run time parameters.
This enumeration data type should not be used for storage, but rather only for its constant values.
Complete status results.
size
parameter.
The size
field must be correctly set by the caller.
The size
field of this structure must be filled by the application before calling control(). This is necessary even if the FRONT codec is unable to complete the request (e.g., the codec sets the nextPartRequiredFlag
to XDAS_TRUE) and further parts of the codec must be called. This size
field indicates to the codec whether any codec-specific extensions are requested.
The fullStatus.size
field should only indicate the size of the [potentially extended] fullStatus
structure.
This field should be used if nextPartRequiredFlag
is XDAS_FALSE.
This struct, with the exception of the size
field, will be populated by the codec. If the control() call returns IVIDDEC2_EOK, the application must inspect the nextPartRequiredFlag
field to determine whether it must call the next part or whether this fullStatus
field contains the complete results of the control() call.
The fullStatus.data
field should not be used to provide buffers to split codecs. In the same way the application provides data buffers to process() via an XDM_Context argument, control() does the same. As a result, the fullStatus.data
field is ignored and unused in this struct.
If control() is called with the XDM_GETVERSION command, the application must provide the buffer into which the codec will place its version string in the context->outBuffers
[0] field.