IVIDENC_Params Struct Reference

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

#include <ividenc.h>

Collaboration diagram for IVIDENC_Params:

Data Fields
XDAS_Int32	size
XDAS_Int32	encodingPreset
XDAS_Int32	rateControlPreset
	Video rate control presets.
XDAS_Int32	maxHeight
XDAS_Int32	maxWidth
XDAS_Int32	maxFrameRate
XDAS_Int32	maxBitRate
XDAS_Int32	dataEndianness
XDAS_Int32	maxInterFrameInterval
XDAS_Int32	inputChromaFormat
XDAS_Int32	inputContentType

---

Detailed Description

Defines the creation time parameters for all IVIDENC instance objects.

Remarks:

The application should set the parameters to 0 to use the algorithm's default values.

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 size parameter.

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 IVIDENC_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 IVIDENC_Params::encodingPreset

Encoding preset.

XDAS_Int32 IVIDENC_Params::rateControlPreset

Video rate control presets.

Remarks:

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

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

See also:

IVIDEO_RateControlPreset

XDAS_Int32 IVIDENC_Params::maxHeight

Maximum height.

XDAS_Int32 IVIDENC_Params::maxWidth

Maximum width.

XDAS_Int32 IVIDENC_Params::maxFrameRate

Maximum frame rate * 1000.

XDAS_Int32 IVIDENC_Params::maxBitRate

Maximum bit rate, bits per second.

XDAS_Int32 IVIDENC_Params::dataEndianness

Endianness of output data.

See also:

XDM_DataFormat

XDAS_Int32 IVIDENC_Params::maxInterFrameInterval

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

XDAS_Int32 IVIDENC_Params::inputChromaFormat

Chroma format for the input buffer.

See also:

XDM_ChromaFormat

XDAS_Int32 IVIDENC_Params::inputContentType

Video content type of the buffer being encoded.

See also:

IVIDEO_ContentType

---

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

• packages/ti/xdais/dm/ividenc.h