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

Defines the creation time parameters for all IVIDTRANSCODE instance objects. More...

#include <ividtranscode.h>

Collaboration diagram for IVIDTRANSCODE_Params:
Collaboration graph

Data Fields

XDAS_Int32 size
XDAS_Int32 numOutputStreams
XDAS_Int32 formatInput
 Video Format types.
XDAS_Int32 formatOutput [2]
 Video Format types.
XDAS_Int32 maxHeightInput
XDAS_Int32 maxWidthInput
XDAS_Int32 maxFrameRateInput
XDAS_Int32 maxBitRateInput
XDAS_Int32 maxHeightOutput [2]
XDAS_Int32 maxWidthOutput [2]
XDAS_Int32 maxFrameRateOutput [2]
XDAS_Int32 maxBitRateOutput [2]
XDAS_Int32 dataEndianness

Detailed Description

Defines the creation time parameters for all IVIDTRANSCODE 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.

Field Documentation

XDAS_Int32 IVIDTRANSCODE_Params::size

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

XDAS_Int32 IVIDTRANSCODE_Params::numOutputStreams

Number of output transcoded streams This allows the possibility of generating more than one transcoded bit-streams from a single incoming bit-stream.

XDAS_Int32 IVIDTRANSCODE_Params::formatInput

Video Format types.

@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_Format

                                 @remarks  This is the video standard of
                                           incoming bit stream.
XDAS_Int32 IVIDTRANSCODE_Params::formatOutput[2]

Video Format types.

@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_Format

                                 @remarks  This array indicates the video
                                           standard for each of the
                                           transcoded bit streams.
XDAS_Int32 IVIDTRANSCODE_Params::maxHeightInput

Maximum video height in pixels.

XDAS_Int32 IVIDTRANSCODE_Params::maxWidthInput

Maximum video width in pixels.

XDAS_Int32 IVIDTRANSCODE_Params::maxFrameRateInput

Maximum frame rate in fps * 1000. For example, if max frame rate is 30 frames per second, set this field to 30000.

XDAS_Int32 IVIDTRANSCODE_Params::maxBitRateInput

Maximum bit rate, bits per second. For example, if bit rate is 10 Mbps, set this field to 10000000

XDAS_Int32 IVIDTRANSCODE_Params::maxHeightOutput[2]

Maximum output video height in pixels for each of the transcoded output.

XDAS_Int32 IVIDTRANSCODE_Params::maxWidthOutput[2]

Maximum output video width in pixels for each of the transcoded output.

XDAS_Int32 IVIDTRANSCODE_Params::maxFrameRateOutput[2]

Maximum frame rate in fps * 1000. for each out the output bitstreams For example, if max frame rate is 30 frames per second, set this field to 30000.

XDAS_Int32 IVIDTRANSCODE_Params::maxBitRateOutput[2]

Maximum bit rate, in bits per second for each of the transcoded bitstreams. For example, if bit rate is 10 Mbps, set this field to 10000000

XDAS_Int32 IVIDTRANSCODE_Params::dataEndianness

Endianness of output data.

                                @sa    XDM_DataFormat

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