Codec Engine Application Programming Interface (API)  ce-w08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
IVIDENC_OutArgs Struct Reference

Defines the run time output arguments for all IVIDENC instance objects. More...

#include <ividenc.h>

Collaboration diagram for IVIDENC_OutArgs:
Collaboration graph

Data Fields

XDAS_Int32 size
XDAS_Int32 extendedError
 Extended error information.
XDAS_Int32 bytesGenerated
XDAS_Int32 encodedFrameType
 Video frame types.
XDAS_Int32 inputFrameSkip
IVIDEO_BufDesc reconBufs

Detailed Description

Defines the run time output arguments for all IVIDENC instance objects.

@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters.  The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Remarks:
The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.
@sa         IVIDENC_Fxns::process()

Field Documentation

XDAS_Int32 IVIDENC_OutArgs::size

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int32 IVIDENC_OutArgs::extendedError

Extended error information.

Remarks:
When an internal error occurs, the algorithm will return an error return value (e.g. EFAIL, EUNSUPPORTED)
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.

See also:
XDM_ErrorBit
XDAS_Int32 IVIDENC_OutArgs::bytesGenerated

Bytes generated by the encode.

XDAS_Int32 IVIDENC_OutArgs::encodedFrameType

Video frame types.

@remarks    For the various @c IVIDEO_xy_FRAME values, this frame type is
            interlaced where both top and bottom fields are
            provided in a single frame.  The first field is an "x"
            frame, the second field is "y" field.

@remarks This enumeration data type should not be used for storage, but rather only for its constant values.

@remarks This enumeration defines a base set of values.  Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures.  These extended enums should be between #XDM_CUSTOMENUMBASE and 0x7FFF.
See also:
XDM_CUSTOMENUMBASE

                                 @sa IVIDEO_FrameType
XDAS_Int32 IVIDENC_OutArgs::inputFrameSkip

Frame Skip Mode. See IVIDEO_SkipMode.

IVIDEO_BufDesc IVIDENC_OutArgs::reconBufs

Reconstruction Frames.


The documentation for this struct was generated from the following file:
Copyright 2013, Texas Instruments Incorporated