VIDTRANSCODE - Video Transcoder Interface

Defines
#define	VIDTRANSCODE_EOK   IVIDTRANSCODE_EOK
#define	VIDTRANSCODE_EFAIL   IVIDTRANSCODE_EFAIL
#define	VIDTRANSCODE_EUNSUPPORTED   IVIDTRANSCODE_EUNSUPPORTED
#define	VIDTRANSCODE_ETIMEOUT   VISA_ETIMEOUT
#define	VIDTRANSCODE_FOREVER   VISA_FOREVER
#define	VIDTRANSCODE_VISATYPE   "ti.sdo.ce.vidtranscode.IVIDTRANSCODE"
	The VISA type.
Typedefs
typedef VISA_Handle	VIDTRANSCODE_Handle
	Opaque handle to a VIDTRANSCODE codec.
typedef struct IVIDTRANSCODE_Params	VIDTRANSCODE_Params
typedef IVIDTRANSCODE_InArgs	VIDTRANSCODE_InArgs
typedef IVIDTRANSCODE_OutArgs	VIDTRANSCODE_OutArgs
typedef IVIDTRANSCODE_Cmd	VIDTRANSCODE_Cmd
typedef IVIDTRANSCODE_DynamicParams	VIDTRANSCODE_DynamicParams
typedef IVIDTRANSCODE_Status	VIDTRANSCODE_Status
Functions
Int32	VIDTRANSCODE_control (VIDTRANSCODE_Handle handle, VIDTRANSCODE_Cmd id, VIDTRANSCODE_DynamicParams *params, VIDTRANSCODE_Status *status)
	Execute the control() method in this instance of a video transcoder algorithm.
VIDTRANSCODE_Handle	VIDTRANSCODE_create (Engine_Handle e, String name, VIDTRANSCODE_Params *params)
	Create an instance of a video transcoder algorithm.
Void	VIDTRANSCODE_delete (VIDTRANSCODE_Handle handle)
	Delete the instance of a video transcoder algorithm.
Int32	VIDTRANSCODE_process (VIDTRANSCODE_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDTRANSCODE_InArgs *inArgs, VIDTRANSCODE_OutArgs *outArgs)
	Execute the process() method in this instance of a video transcoder algorithm.
XDAS_Int32	VIDTRANSCODE_processAsync (VIDTRANSCODE_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, IVIDTRANSCODE_InArgs *inArgs, IVIDTRANSCODE_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a video transcoder algorithm.
XDAS_Int32	VIDTRANSCODE_processWait (VIDTRANSCODE_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, IVIDTRANSCODE_InArgs *inArgs, IVIDTRANSCODE_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of VIDTRANSCODE_processAsync() in this instance of an video transcoder algorithm.

---

Detailed Description

This is the VIDANALYTICS video transcoder interface. Several of the data types in this API are specified by the XDM IVIDTRANSCODE interface; please see the XDM documentation for those details.

---

Define Documentation

#define VIDTRANSCODE_EOK   IVIDTRANSCODE_EOK

Success.

#define VIDTRANSCODE_EFAIL   IVIDTRANSCODE_EFAIL

General failure.

#define VIDTRANSCODE_EUNSUPPORTED   IVIDTRANSCODE_EUNSUPPORTED

Request is unsupported.

Timeout occurred.

#define VIDTRANSCODE_ETIMEOUT   VISA_ETIMEOUT

Special value for timeout parameter indicating never timeout.

#define VIDTRANSCODE_FOREVER   VISA_FOREVER

#define VIDTRANSCODE_VISATYPE   "ti.sdo.ce.vidtranscode.IVIDTRANSCODE"

The VISA type.

---

Typedef Documentation

typedef VISA_Handle VIDTRANSCODE_Handle

Opaque handle to a VIDTRANSCODE codec.

typedef struct IVIDTRANSCODE_Params VIDTRANSCODE_Params

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

typedef IVIDTRANSCODE_InArgs VIDTRANSCODE_InArgs

Defines the input arguments for all IVIDTRANSCODE instance process function.

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()

typedef IVIDTRANSCODE_OutArgs VIDTRANSCODE_OutArgs

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()

typedef IVIDTRANSCODE_Cmd VIDTRANSCODE_Cmd

Defines the control commands for the IVIDTRANSCODE module.

Remarks:

This ID can be extended in IMOD interface for additional controls.

See also:

XDM_CmdId

IVIDTRANSCODE_Fxns::control()

typedef IVIDTRANSCODE_DynamicParams VIDTRANSCODE_DynamicParams

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

Remarks:

It is not necessary that a 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.

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

typedef IVIDTRANSCODE_Status VIDTRANSCODE_Status

Defines instance status parameters.

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

---

Function Documentation

Int32 VIDTRANSCODE_control	(	VIDTRANSCODE_Handle	handle,
		VIDTRANSCODE_Cmd	id,
		VIDTRANSCODE_DynamicParams *	params,
		VIDTRANSCODE_Status *	status
	)

Execute the control() method in this instance of a video transcoder algorithm.

Parameters:

[in]	handle	Handle to a created video transcoder instance.
[in]	id	Command id for xDM control operation.
[in]	params	Runtime control parameters used for the video transcoder.
[out]	status	Status info returned by the video transcoder instance.

Precondition:

handle is a valid (non-NULL) video transcoder handle and the video transcoder is in the created state.

Return values:

VIDTRANSCODE_EOK	Success.
VIDTRANSCODE_EFAIL	Failure.
VIDTRANSCODE_EUNSUPPORTED	Unsupported request.

Remarks:

This is a blocking call, and will return after the control command has been executed.

See also:

VIDTRANSCODE_create()

VIDTRANSCODE_delete()

IVIDTRANSCODE_Fxns::control()

VIDTRANSCODE_Handle VIDTRANSCODE_create	(	Engine_Handle	e,
		String	name,
		VIDTRANSCODE_Params *	params
	)

Create an instance of a video transcoder algorithm.

Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDTRANSCODE_create()) or explicitly serialize access to a shared handle.

Parameters:

[in]	e	Handle to an opened engine.
[in]	name	String identifier of the type of video transcoder. to create.
[in]	params	Creation parameters.

Return values:

NULL	An error has occurred.
non-NULL	The handle to the newly created video transcoder instance.

Remarks:

params is optional. If it's not supplied, codec-specific default params will be used.

Depending on the configuration of the engine opened, this call may create a local or remote instance of the video transcoder.

In general, name is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated, to be overridden. This optional argument string is of the form ":priority", ":priority:flag", or "::flag".

priority is the new priority to create the codec with.

The flag must be either 0 or 1, and if 1, all memory allocated for the codec will be in the heap that corresponds to IALG_EXTERNAL. If flag is 0, the memory for the codec will be allocated from the heaps it has requested. For example, if a codec named "mp3" has been configured into the system, setting name to "mp3:4" would cause the codec to be created at priority 4, instead of whatever priority was configured. This feature is useful if more than one instance of the codec are to be created at different priorities.

The flag can be used to prevent the codec from using any internal memory, for example, if it is to be run at the same time as another codec that must use internal memory, and there is insufficient internal memory for both.

See also:

Engine_open()

VIDTRANSCODE_delete()

Void VIDTRANSCODE_delete

(

VIDTRANSCODE_Handle

handle )

Delete the instance of a video transcoder algorithm.

Parameters:

[in]

handle

Handle to a created video transcoder instance.

Remarks:

Depending on the configuration of the engine opened, this call may delete a local or remote instance of the video transcoder.

Precondition:

handle is a valid (non-NULL) handle which is in the created state.

Postcondition:

All resources allocated as part of the VIDTRANSCODE_create() operation (memory, DMA channels, etc.) are freed.

See also:

VIDTRANSCODE_create()

Int32 VIDTRANSCODE_process	(	VIDTRANSCODE_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		VIDTRANSCODE_InArgs *	inArgs,
		VIDTRANSCODE_OutArgs *	outArgs
	)

Execute the process() method in this instance of a video transcoder algorithm.

Parameters:

[in]	handle	Handle to a created video transcoder instance.
[in]	inBufs	A buffer descriptor containing input buffers.
[out]	outBufs	A buffer descriptor containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:

handle is a valid (non-NULL) video transcoder handle and the video transcoder is in the created state.

Return values:

VIDTRANSCODE_EOK	Success.
VIDTRANSCODE_EFAIL	Failure.
VIDTRANSCODE_EUNSUPPORTED	Unsupported request.

Remarks:

Since the VIDTRANSCODE transcoder contains support for asynchronous buffer submission and retrieval, this API becomes known as synchronous in nature.

This is a blocking call, and will return after the data has been encoded.

The buffers supplied to VIDTRANSCODE_process() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.

See also:

VIDTRANSCODE_create()

VIDTRANSCODE_delete()

VIDTRANSCODE_control()

VIDTRANSCODE_processAsync()

VIDTRANSCODE_processWait()

IVIDTRANSCODE_Fxns::process()

XDAS_Int32 VIDTRANSCODE_processAsync	(	VIDTRANSCODE_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		IVIDTRANSCODE_InArgs *	inArgs,
		IVIDTRANSCODE_OutArgs *	outArgs
	)

Perform asynchronous submission to this instance of a video transcoder algorithm.

Parameters:

[in]	handle	Handle to a created video transcoder instance.
[in]	inBufs	A buffer descriptor containing input buffers.
[out]	outBufs	A buffer descriptor containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.

Precondition:

handle is a valid (non-NULL) video transcoder handle and the video transcoder is in the created state.

Return values:

VIDTRANSCODE_EOK	Success.
VIDTRANSCODE_EFAIL	Failure.
VIDTRANSCODE_EUNSUPPORTED	Unsupported request.

Remarks:

This API is the asynchronous counterpart to the process() method. It allows for buffer and argument submission without waiting for retrieval. A response is retrieved using the VIDTRANSCODE_processWait() API.

The buffers supplied to VIDTRANSCODE_processAsync() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.

See also:

VIDTRANSCODE_create()

VIDTRANSCODE_delete()

VIDTRANSCODE_control()

VIDTRANSCODE_process()

VIDTRANSCODE_processWait()

IVIDTRANSCODE_Fxns::process()

XDAS_Int32 VIDTRANSCODE_processWait	(	VIDTRANSCODE_Handle	handle,
		XDM1_BufDesc *	inBufs,
		XDM_BufDesc *	outBufs,
		IVIDTRANSCODE_InArgs *	inArgs,
		IVIDTRANSCODE_OutArgs *	outArgs,
		UInt	timeout
	)

Wait for a return message from a previous invocation of VIDTRANSCODE_processAsync() in this instance of an video transcoder algorithm.

Parameters:

[in]	handle	Handle to a created video transcoder instance.
[in]	inBufs	A buffer descriptor containing input buffers.
[out]	outBufs	A buffer descriptor containing output buffers.
[in]	inArgs	Input Arguments.
[out]	outArgs	Output Arguments.
[in]	timeout	Amount of "time" to wait (from 0 -> VIDTRANSCODE_FOREVER)

Precondition:

handle is a valid (non-NULL) video transcoder handle and the video transcoder is in the created state.

Return values:

VIDTRANSCODE_EOK	Success.
VIDTRANSCODE_EFAIL	Failure.
VIDTRANSCODE_EUNSUPPORTED	Unsupported request.
VIDTRANSCODE_ETIMEOUT	Operation timed out.

Remarks:

This is a blocking call, and will return after the data has been decoded.

"Polling" is supported by using a timeout of 0. Waiting forever is supported by using a timeout of VIDTRANSCODE_FOREVER.

There must have previously been an invocation of the VIDTRANSCODE_processAsync() API.

The buffers supplied to VIDTRANSCODE_processAsync() may have constraints put on them. For example, in dual-processor, shared memory architectures, where the codec is running on a remote processor, the buffers may need to be physically contiguous. Additionally, the remote processor may place restrictions on buffer alignment.

See also:

VIDTRANSCODE_create()

VIDTRANSCODE_delete()

VIDTRANSCODE_control()

VIDTRANSCODE_process()

VIDTRANSCODE_processAsync()