IVIDTRANSCODE_OutArgs Struct Reference
[XDM IVIDTRANSCODE Video Transcoder Interface]

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

#include <ividtranscode.h>

Collaboration diagram for IVIDTRANSCODE_OutArgs:

[legend]

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
XDAS_Int32	bitsConsumed
XDAS_Int32	bitsGenerated [2]
XDAS_Int32	decodedPictureType
XDAS_Int32	decodedPictureStructure
XDAS_Int32	encodedPictureType [2]
XDAS_Int32	encodedPictureStructure [2]
XDAS_Int32	decodedHeight
XDAS_Int32	decodedWidth
XDAS_Int32	outputID [2]
XDAS_Int32	inputFrameSkipTranscodeFlag [2]
XDM1_SingleBufDesc	encodedBuf [2]
XDAS_Int32	outBufsInUseFlag

---

Detailed Description

Defines the run time output arguments 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 size parameter.

The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IVIDTRANSCODE_Fxns::process()

---

Field Documentation

XDAS_Int32 IVIDTRANSCODE_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 IVIDTRANSCODE_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 IVIDTRANSCODE_OutArgs::bitsConsumed

Number of bits consumed during the IVIDTRANSCODE_Fxns.process() call.

XDAS_Int32 IVIDTRANSCODE_OutArgs::bitsGenerated[2]

Number of bits generated during the IVIDTRANSCODE_Fxns.process() call for each transcode output.

XDAS_Int32 IVIDTRANSCODE_OutArgs::decodedPictureType

Type of the decoded picture.

See also:

IVIDEO_PictureType

XDAS_Int32 IVIDTRANSCODE_OutArgs::decodedPictureStructure

Structure of the decoded picture.

See also:

IVIDEO_ContentType

XDAS_Int32 IVIDTRANSCODE_OutArgs::encodedPictureType[2]

Type of the encoded picture for each transcode output.

See also:

IVIDEO_PictureType

XDAS_Int32 IVIDTRANSCODE_OutArgs::encodedPictureStructure[2]

Structure of the encoded picture for each transcode output.

See also:

IVIDEO_ContentType

XDAS_Int32 IVIDTRANSCODE_OutArgs::decodedHeight

Decoded frame height

XDAS_Int32 IVIDTRANSCODE_OutArgs::decodedWidth

Decoded frame width

XDAS_Int32 IVIDTRANSCODE_OutArgs::outputID[2]

This is the ID of the encoded buffer for each output. This field is also used by the client to identify the outBufs supplied with the IVIDTRANSCODE_Fxns.process() call that can be reused.

Remarks:

This will be set to zero when there is no encoded buffer for passing to client application.

See also:

IVIDTRANSCODE_InArgs::inputID.

XDAS_Int32 IVIDTRANSCODE_OutArgs::inputFrameSkipTranscodeFlag[2]

Flag to indicate if the current frame was skipped in specific transcode outputs.

Remarks:

Possible values XDAS_TRUE, XDAS_FALSE

XDM1_SingleBufDesc IVIDTRANSCODE_OutArgs::encodedBuf[2]

When outputID for a specific transcode output is non-zero, the corresponding encoded buffer related information is populated here.

XDAS_Int32 IVIDTRANSCODE_OutArgs::outBufsInUseFlag

Flag to indicate that the outBufs provided with the IVIDTRANSCODE_Fxns.process() call are in use. No outBufs are required to be supplied with the next IVIDTRANSCODE_Fxns.process() call.

Remarks:

Possible values XDAS_TRUE, XDAS_FALSE

---

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

• ividtranscode.h