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

#include <ividenc2.h>

Collaboration diagram for IVIDENC2_Params:

Detailed Description

Defines the creation time parameters for all IVIDENC2 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 IVIDENC2_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 IVIDENC2_Params::encodingPreset

Encoding preset.

XDAS_Int32 IVIDENC2_Params::rateControlPreset

Video rate control presets.

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

XDAS_Int32 IVIDENC2_Params::maxHeight

Maximum video height in pixels.

XDAS_Int32 IVIDENC2_Params::maxWidth

Maximum video width in pixels.

XDAS_Int32 IVIDENC2_Params::dataEndianness

Endianness of output data.

                                @sa    XDM_DataFormat

XDAS_Int32 IVIDENC2_Params::maxInterFrameInterval

I to P frame distance. e.g. = 1 if no B frames, 2 to insert one B frame.

Remarks:: This is used for setting the maximum number of B frames between two refererence frames.

XDAS_Int32 IVIDENC2_Params::maxBitRate

Maximum Bit-rate for encoding in bits per second

XDAS_Int32 IVIDENC2_Params::minBitRate

Minumum Bit-rate for encoding in bits per second

XDAS_Int32 IVIDENC2_Params::inputChromaFormat

Chroma format for the input buffer.

                                @sa XDM_ChromaFormat

XDAS_Int32 IVIDENC2_Params::inputContentType

Video content type of the buffer being encoded.

See also:: IVIDEO_ContentType

XDAS_Int32 IVIDENC2_Params::operatingMode

Video coding mode of operation.

                                @sa IVIDEO_OperatingMode

XDAS_Int32 IVIDENC2_Params::profile

Profile indicator of video codec

                                @remarks   Only one default value
                                           (#IVIDENC2_DEFAULTPROFILE) is
                                           defined by XDM for this field.
                                           The reason for not
                                           defining further values
                                           is to keep profile values as
                                           defined by video codec
                                           standards.

                                @sa IVIDENC2_Status.profile

XDAS_Int32 IVIDENC2_Params::level

Level indicator of video codec

                                @remarks   Only one default value
                                           (#IVIDENC2_DEFAULTLEVEL) is
                                           defined by XDM for this field.
                                           The reason for not
                                           defining further values
                                           is to keep profile values as
                                           defined by video codec
                                           standards.

                                @sa IVIDENC2_Status.level

XDAS_Int32 IVIDENC2_Params::inputDataMode

Input data mode.

                                @remarks   If a subframe mode is provided,
                                           the application must call
                                           IVIDENC2_Fxns::control() with
                                           #XDM_SETPARAMS id prior to
                                           #IVIDENC2_Fxns::process() to
                                           set the
                                           IVIDENC2_DynamicParams::getDataFxn
                                           and
                                           IVIDENC2_DynamicParams::getDataHandle.
                                           Else, the alg can return
                                           error.

                                @sa IVIDEO_DataMode

XDAS_Int32 IVIDENC2_Params::outputDataMode

Output data mode.

                                @remarks   If a subframe mode is provided,
                                           the application must call
                                           IVIDENC2_Fxns::control() with
                                           #XDM_SETPARAMS id prior to
                                           #IVIDENC2_Fxns::process() to
                                           set the
                                           IVIDENC2_DynamicParams::putDataFxn,
                                           IVIDENC2_DynamicParams::putDataHandle
                                           (and optionally
                                           IVIDENC2_DynamicParams::getBufferFxn,
                                           and
                                           IVIDENC2_DynamicParams::getBufferHandle).
                                           Else, the alg can return
                                           error.

                                @sa IVIDEO_DataMode

XDAS_Int32 IVIDENC2_Params::numInputDataUnits

Number of input slices/rows.

                                @remarks  Units depend on the
                                          @c inputDataMode, like number of
                                          slices/rows/blocks etc.

                                @remarks  Ignored if @c inputDataMode
                                          is set to full frame mode.

XDAS_Int32 IVIDENC2_Params::numOutputDataUnits

Number of output slices/rows.

                                @remarks  Units depend on the
                                          @c outputDataMode, like number of
                                          slices/rows/blocks etc.

                                @remarks  Ignored if @c outputDataMode
                                          is set to full frame mode.

XDAS_Int32 IVIDENC2_Params::metadataType[3]

Type of each metadata plane.

See also:: IVIDEO_MetadataType

The documentation for this struct was generated from the following file:

cetools/packages/ti/xdais/dm/ividenc2.h

Data Fields
XDAS_Int32	size
XDAS_Int32	encodingPreset
XDAS_Int32	rateControlPreset
	Video rate control presets.
XDAS_Int32	maxHeight
XDAS_Int32	maxWidth
XDAS_Int32	dataEndianness
XDAS_Int32	maxInterFrameInterval
XDAS_Int32	maxBitRate
XDAS_Int32	minBitRate
XDAS_Int32	inputChromaFormat
XDAS_Int32	inputContentType
XDAS_Int32	operatingMode
XDAS_Int32	profile
XDAS_Int32	level
XDAS_Int32	inputDataMode
XDAS_Int32	outputDataMode
XDAS_Int32	numInputDataUnits
XDAS_Int32	numOutputDataUnits
XDAS_Int32	metadataType [3]

Data Fields

Detailed Description

Field Documentation