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

This structure defines the codec parameters that can be modified after creation via control() calls. More...

#include <ividenc.h>

Collaboration diagram for IVIDENC_DynamicParams:
Collaboration graph

Data Fields

XDAS_Int32 size
XDAS_Int32 inputHeight
XDAS_Int32 inputWidth
XDAS_Int32 refFrameRate
XDAS_Int32 targetFrameRate
XDAS_Int32 targetBitRate
XDAS_Int32 intraFrameInterval
XDAS_Int32 generateHeader
 Encode entire access unit or only header.
XDAS_Int32 captureWidth
XDAS_Int32 forceIFrame

Detailed Description

This structure defines the codec parameters that can be modified after creation via control() calls.

@remarks    It is not necessary that given implementation support all
            dynamic parameters to be configurable at run time.  If a
            particular algorithm does not support run-time updates to
            a parameter that the application is attempting to change
            at runtime, it may indicate this as an error.

@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::control()

Field Documentation

XDAS_Int32 IVIDENC_DynamicParams::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_DynamicParams::inputHeight

Input frame height.

XDAS_Int32 IVIDENC_DynamicParams::inputWidth

Input frame width.

XDAS_Int32 IVIDENC_DynamicParams::refFrameRate

Reference or input frame rate * 1000.

XDAS_Int32 IVIDENC_DynamicParams::targetFrameRate

Target frame rate * 1000.

XDAS_Int32 IVIDENC_DynamicParams::targetBitRate

Target bit rate in bits per second.

XDAS_Int32 IVIDENC_DynamicParams::intraFrameInterval

I frame interval. For example, 30.

XDAS_Int32 IVIDENC_DynamicParams::generateHeader

Encode entire access unit or only header.

@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 XDM_EncMode
XDAS_Int32 IVIDENC_DynamicParams::captureWidth

DEFAULT(0): use imagewidth as pitch else use given capture width for pitch provided it is greater than image width.

XDAS_Int32 IVIDENC_DynamicParams::forceIFrame

Force the current frame to be encoded as an I-frame.


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