Decoder Algorithm Interface
Common Algorithm Interface

## Topics

| External Frame Buffer Functions

## Files

file | aom_decoder.h
| Describes the decoder algorithm interface to applications.

## Data Structures

struct | aom_codec_stream_info
| Initialization-time Feature Enabling. More...
struct | aom_codec_dec_cfg
| Initialization Configurations. More...

## Macros

#define | AOM_DECODER_ABI_VERSION
| Current ABI version number.
#define | AOM_CODEC_CAP_EXTERNAL_FRAME_BUFFER 0x200000
| Decoder capabilities bitfield.
#define | aom_codec_dec_init(ctx, iface, cfg, flags)
| Convenience macro for aom_codec_dec_init_ver().

## Typedefs

typedef struct aom_codec_stream_info | aom_codec_stream_info_t
| Initialization-time Feature Enabling.
typedef struct aom_codec_dec_cfg | aom_codec_dec_cfg_t
| Initialization Configurations.

## Functions

aom_codec_err_t | aom_codec_dec_init_ver (aom_codec_ctx_t *ctx, aom_codec_iface_t *iface, const aom_codec_dec_cfg_t *cfg, aom_codec_flags_t flags, int ver)
| Initialize a decoder instance.
aom_codec_err_t | aom_codec_peek_stream_info (aom_codec_iface_t *iface, const uint8_t *data, size_t data_sz, aom_codec_stream_info_t *si)
| Parse stream info from a buffer.
aom_codec_err_t | aom_codec_get_stream_info (aom_codec_ctx_t *ctx, aom_codec_stream_info_t *si)
| Return information about the current stream.
aom_codec_err_t | aom_codec_decode (aom_codec_ctx_t *ctx, const uint8_t *data, size_t data_sz, void *user_priv)
| Decode data.
aom_image_t * | aom_codec_get_frame (aom_codec_ctx_t *ctx, aom_codec_iter_t *iter)
| Decoded frames iterator.

## Detailed Description

This abstraction allows applications using this decoder to easily support multiple video formats with minimal code duplication. This section describes the interface common to all decoders.

## Macro Definition Documentation

## AOM_CODEC_CAP_EXTERNAL_FRAME_BUFFER

#define AOM_CODEC_CAP_EXTERNAL_FRAME_BUFFER 0x200000

Decoder capabilities bitfield.

Each decoder advertises the capabilities it supports as part of its aom_codec_iface_t interface structure. Capabilities are extra interfaces or functionality, and are not required to be supported by a decoder.

The available flags are specified by AOM_CODEC_CAP_* defines.

Can support external frame buffers

## aom_codec_dec_init

#define aom_codec_dec_init | ( |  | ctx,
|  |  | iface,
|  |  | cfg,
|  |  | flags )

Value:
aom_codec_dec_init_ver(ctx, iface, cfg, flags, AOM_DECODER_ABI_VERSION)
AOM_DECODER_ABI_VERSION
#define AOM_DECODER_ABI_VERSION
Current ABI version number.
Definition aom_decoder.h:44
aom_codec_dec_init_ver
aom_codec_err_t aom_codec_dec_init_ver(aom_codec_ctx_t *ctx, aom_codec_iface_t *iface, const aom_codec_dec_cfg_t *cfg, aom_codec_flags_t flags, int ver)
Initialize a decoder instance.

Convenience macro for aom_codec_dec_init_ver().

Ensures the ABI version parameter is properly set.

## Typedef Documentation

## aom_codec_stream_info_t

typedef struct aom_codec_stream_info aom_codec_stream_info_t

Initialization-time Feature Enabling.

Certain codec features must be known at initialization time, to allow for proper memory allocation.

The available flags are specified by AOM_CODEC_USE_* defines.

Stream properties

This structure is used to query or set properties of the decoded stream.

## aom_codec_dec_cfg_t

typedef struct aom_codec_dec_cfg aom_codec_dec_cfg_t

Initialization Configurations.

This structure is used to pass init time configuration options to the decoder. alias for struct aom_codec_dec_cfg

## Function Documentation

## aom_codec_dec_init_ver()

aom_codec_err_t aom_codec_dec_init_ver | ( | aom_codec_ctx_t * | ctx,
|  | aom_codec_iface_t * | iface,
|  | const aom_codec_dec_cfg_t * | cfg,
|  | aom_codec_flags_t | flags,
|  | int | ver )

Initialize a decoder instance.

Initializes a decoder context using the given interface. Applications should call the aom_codec_dec_init convenience macro instead of this function directly, to ensure that the ABI version number parameter is properly initialized.

If the library was configured with cmake -DCONFIG_MULTITHREAD=0, this call is not thread safe and should be guarded with a lock if being used in a multithreaded context.

On success, aom_codec_destroy() must be used to free resources allocated for the decoder context. If aom_codec_dec_init_ver() fails, it is not necessary to call aom_codec_destroy() on the decoder context.

Parameters

  [in] | ctx | Pointer to this instance's context.
  [in] | iface | Pointer to the algorithm interface to use.
  [in] | cfg | Configuration to use, if known. May be NULL.
  [in] | flags | Bitfield of AOM_CODEC_USE_* flags
  [in] | ver | ABI version number. Must be set to AOM_DECODER_ABI_VERSION

Return values

  AOM_CODEC_OK | The decoder algorithm has been initialized.
  AOM_CODEC_MEM_ERROR | Memory allocation failed.

## aom_codec_peek_stream_info()

aom_codec_err_t aom_codec_peek_stream_info | ( | aom_codec_iface_t * | iface,
|  | const uint8_t * | data,
|  | size_t | data_sz,
|  | aom_codec_stream_info_t * | si )

Parse stream info from a buffer.

Performs high level parsing of the bitstream. Construction of a decoder context is not necessary. Can be used to determine if the bitstream is of the proper format, and to extract information from the stream.

Parameters

  [in] | iface | Pointer to the algorithm interface
  [in] | data | Pointer to a block of data to parse
  [in] | data_sz | Size of the data buffer
  [in,out] | si | Pointer to stream info to update. The is_annexb member MUST be properly initialized. This function sets the rest of the members.

Return values

  AOM_CODEC_OK | Bitstream is parsable and stream information updated.
  AOM_CODEC_INVALID_PARAM | One of the arguments is invalid, for example a NULL pointer.
  AOM_CODEC_UNSUP_BITSTREAM | The decoder didn't recognize the coded data, or the buffer was too short.

## aom_codec_get_stream_info()

aom_codec_err_t aom_codec_get_stream_info | ( | aom_codec_ctx_t * | ctx,
|  | aom_codec_stream_info_t * | si )

Return information about the current stream.

Returns information about the stream that has been parsed during decoding.

Parameters

  [in] | ctx | Pointer to this instance's context
  [in,out] | si | Pointer to stream info to update.

Return values

  AOM_CODEC_OK | Bitstream is parsable and stream information updated.
  AOM_CODEC_INVALID_PARAM | One of the arguments is invalid, for example a NULL pointer.
  AOM_CODEC_UNSUP_BITSTREAM | The decoder couldn't parse the submitted data.

## aom_codec_decode()

aom_codec_err_t aom_codec_decode | ( | aom_codec_ctx_t * | ctx,
|  | const uint8_t * | data,
|  | size_t | data_sz,
|  | void * | user_priv )

Decode data.

Processes a buffer of coded data. Encoded data MUST be passed in DTS (decode time stamp) order. Frames produced will always be in PTS (presentation time stamp) order.

Parameters

  [in] | ctx | Pointer to this instance's context
  [in] | data | Pointer to this block of new coded data.
  [in] | data_sz | Size of the coded data, in bytes.
  [in] | user_priv | Application specific data to associate with this frame.

Returns
  Returns AOM_CODEC_OK if the coded data was processed completely and future pictures can be decoded without error. Otherwise, see the descriptions of the other error codes in aom_codec_err_t for recoverability capabilities.

## aom_codec_get_frame()

aom_image_t * aom_codec_get_frame | ( | aom_codec_ctx_t * | ctx,
|  | aom_codec_iter_t * | iter )

Decoded frames iterator.

Iterates over a list of the frames available for display. The iterator storage should be initialized to NULL to start the iteration. Iteration is complete when this function returns NULL.

The list of available frames becomes valid upon completion of the aom_codec_decode call, and remains valid until the next call to aom_codec_decode.

Parameters

  [in] | ctx | Pointer to this instance's context
  [in,out] | iter | Iterator storage, initialized to NULL

Returns
  Returns a pointer to an image, if one is ready for display. Frames produced will always be in PTS (presentation time stamp) order.