AOMedia Codec SDK: aom/aom_decoder.h File Reference

AOMedia Codec SDK

Data Structures | Macros | Typedefs | Functions
aom_decoder.h File Reference
Common Algorithm Interface » Decoder Algorithm Interface

Describes the decoder algorithm interface to applications. More...

`#include "aom/aom_codec.h"`
`#include "aom/aom_frame_buffer.h"`
Include dependency graph for aom_decoder.h:

Go to the source code of this file.

## Data Structures
struct | aom_codec_stream_info
| Stream properties. More...
struct | aom_codec_dec_cfg
| Initialization Configurations. More...

## Macros
#define | AOM_DECODER_ABI_VERSION
| Current ABI version number.
#define | AOM_CODEC_CAP_PUT_SLICE 0x10000
| Decoder capabilities bitfield. More...
#define | AOM_CODEC_CAP_PUT_FRAME 0x20000
#define | AOM_CODEC_CAP_POSTPROC 0x40000
#define | AOM_CODEC_CAP_INPUT_FRAGMENTS 0x100000
| Can receive encoded frames one fragment at a time.
#define | AOM_CODEC_CAP_FRAME_THREADING 0x200000
| Initialization-time Feature Enabling. More...
#define | AOM_CODEC_CAP_EXTERNAL_FRAME_BUFFER 0x400000
#define | AOM_CODEC_USE_POSTPROC 0x10000
#define | AOM_CODEC_USE_INPUT_FRAGMENTS 0x40000
| The input frame should be passed to the decoder one fragment at a time.
#define | aom_codec_dec_init(ctx, iface, cfg, flags) aom_codec_dec_init_ver(ctx, iface, cfg, flags, AOM_DECODER_ABI_VERSION)
| Convenience macro for aom_codec_dec_init_ver() More...

## Typedefs
typedef struct aom_codec_stream_info | aom_codec_stream_info_t
| Stream properties. More...
typedef struct aom_codec_dec_cfg | aom_codec_dec_cfg_t
| Initialization Configurations. More...
typedef void(* | aom_codec_put_frame_cb_fn_t) (void *user_priv, const aom_image_t *img)
| put frame callback prototype More...
typedef void(* | aom_codec_put_slice_cb_fn_t) (void *user_priv, const aom_image_t *img, const aom_image_rect_t *valid, const aom_image_rect_t *update)
| put slice callback prototype More...

## 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. More...
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. More...
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. More...
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. More...
aom_image_t * | aom_codec_get_frame (aom_codec_ctx_t *ctx, aom_codec_iter_t *iter)
| Decoded frames iterator. More...
aom_codec_err_t | aom_codec_register_put_frame_cb (aom_codec_ctx_t *ctx, aom_codec_put_frame_cb_fn_t cb, void *user_priv)
| Register for notification of frame completion. More...
aom_codec_err_t | aom_codec_register_put_slice_cb (aom_codec_ctx_t *ctx, aom_codec_put_slice_cb_fn_t cb, void *user_priv)
| Register for notification of slice completion. More...
aom_codec_err_t | aom_codec_set_frame_buffer_functions (aom_codec_ctx_t *ctx, aom_get_frame_buffer_cb_fn_t cb_get, aom_release_frame_buffer_cb_fn_t cb_release, void *cb_priv)
| Pass in external frame buffers for the decoder to use. More...

## Detailed Description

Describes the decoder algorithm interface to applications.

This file describes the interface between an application and a video decoder algorithm.