DecoderPlugin.h File Reference

Detailed Description

NVIDIA DriveWorks API: Decoder Plugin Interface

Description: This file defines decoder plugin interface for decoding.

Definition in file DecoderPlugin.h.

Go to the source code of this file.

Data Structures
struct	dwDecoderPluginFunctions
	Function Table exposing decoder plugin functions. More...

Typedefs
typedef dwStatus(*	dwDecoderPlugin_decode) (dwCodecPacket *packet, dwDecoderPluginHandle_t handle)
	Decode encoded packet data into a frame. More...
typedef dwStatus(*	dwDecoderPlugin_drain) (void *data, size_t dataSize, dwDecoderPluginHandle_t handle)
	Drains previously queued decode requests. More...
typedef dwStatus(*	dwDecoderPlugin_release) (dwDecoderPluginHandle_t handle)
	Release a decoder managed by the plugin module. More...
typedef dwStatus(*	dwDecoderPlugin_reset) (dwDecoderPluginHandle_t handle)
	Reset a decoder managed by the plugin module. More...
typedef void *	dwDecoderPluginHandle_t
	Decoder plugin handle. More...

---

Data Structure Documentation

dwDecoderPluginFunctions

struct dwDecoderPluginFunctions

Data Fields
dwDecoderPlugin_decode	decode	Decode a packet from input.
dwDecoderPlugin_drain	drain	Return a decoded frame.
dwDecoderPlugin_release	release	Release plugin decoder specified by its handle.
dwDecoderPlugin_reset	reset	Reset plugin decoder specified by its handle.

Typedef Documentation

dwDecoderPlugin_decode

typedef dwStatus(* dwDecoderPlugin_decode) (dwCodecPacket *packet, dwDecoderPluginHandle_t handle)

Decode encoded packet data into a frame.

Parameters

[in]	packet	The pointer to the encoded packet data.
[in]	handle	The handle to a Decoder created previously with the 'dwCodecHeaderPlugin_initializeDecoder' interface.

Returns

DW_INVALID_ARGUMENT if the packet or handle is NULL or invalid
DW_BUFFER_FULL if the decoder is unable to accept any more packets
DW_SUCCESS

Definition at line 82 of file DecoderPlugin.h.

dwDecoderPlugin_drain

typedef dwStatus(* dwDecoderPlugin_drain) (void *data, size_t dataSize, dwDecoderPluginHandle_t handle)

Drains previously queued decode requests.

Parameters

[out]	data	The pointer to the frame data.
[out]	dataSize	Size of data.
[in]	handle	The handle to a Decoder created previously with the 'dwCodecHeaderPlugin_initializeDecoder' interface.

Returns

DW_INVALID_ARGUMENT if the packet or handle is NULL or invalid
DW_NOT_READY if the enqueued frames require further inputs.
DW_NOT_AVAILABLE if there's nothing to be drained.
DW_SUCCESS

Definition at line 96 of file DecoderPlugin.h.

dwDecoderPlugin_release

typedef dwStatus(* dwDecoderPlugin_release) (dwDecoderPluginHandle_t handle)

Release a decoder managed by the plugin module.

Parameters

[in]

handle

The handle to a Decoder created previously with the 'dwCodecHeaderPlugin_initializeDecoder' interface.

Returns

DW_INVALID_ARGUMENT if the handle is NULL or invalid
DW_SUCCESS

Definition at line 60 of file DecoderPlugin.h.

dwDecoderPlugin_reset

typedef dwStatus(* dwDecoderPlugin_reset) (dwDecoderPluginHandle_t handle)

Reset a decoder managed by the plugin module.

Parameters

[in]

handle

The handle to a Decoder created previously with the 'dwCodecHeaderPlugin_initializeDecoder' interface.

Returns

DW_INVALID_ARGUMENT if the handle is NULL or invalid
DW_SUCCESS

Definition at line 70 of file DecoderPlugin.h.

dwDecoderPluginHandle_t

typedef void* dwDecoderPluginHandle_t

Decoder plugin handle.

Definition at line 50 of file DecoderPlugin.h.