123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364 |
- /*
- * Copyright (c) 2016, Alliance for Open Media. All rights reserved
- *
- * This source code is subject to the terms of the BSD 2 Clause License and
- * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
- * was not distributed with this source code in the LICENSE file, you can
- * obtain it at www.aomedia.org/license/software. If the Alliance for Open
- * Media Patent License 1.0 was not distributed with this source code in the
- * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
- */
- #ifndef AOM_AOM_DECODER_H_
- #define AOM_AOM_DECODER_H_
- /*!\defgroup decoder Decoder Algorithm Interface
- * \ingroup codec
- * 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.
- * @{
- */
- /*!\file
- * \brief Describes the decoder algorithm interface to applications.
- *
- * This file describes the interface between an application and a
- * video decoder algorithm.
- *
- */
- #ifdef __cplusplus
- extern "C" {
- #endif
- #include "aom/aom_codec.h"
- #include "aom/aom_frame_buffer.h"
- /*!\brief Current ABI version number
- *
- * \internal
- * If this file is altered in any way that changes the ABI, this value
- * must be bumped. Examples include, but are not limited to, changing
- * types, removing or reassigning enums, adding/removing/rearranging
- * fields to structures
- */
- #define AOM_DECODER_ABI_VERSION \
- (3 + AOM_CODEC_ABI_VERSION) /**<\hideinitializer*/
- /*! \brief 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.
- */
- #define AOM_CODEC_CAP_PUT_SLICE 0x10000 /**< Will issue put_slice callbacks */
- #define AOM_CODEC_CAP_PUT_FRAME 0x20000 /**< Will issue put_frame callbacks */
- #define AOM_CODEC_CAP_POSTPROC 0x40000 /**< Can postprocess decoded frame */
- /*!\brief Can receive encoded frames one fragment at a time */
- #define AOM_CODEC_CAP_INPUT_FRAGMENTS 0x100000
- /*! \brief 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.
- */
- /*!\brief Can support frame-based multi-threading */
- #define AOM_CODEC_CAP_FRAME_THREADING 0x200000
- /*!brief Can support external frame buffers */
- #define AOM_CODEC_CAP_EXTERNAL_FRAME_BUFFER 0x400000
- #define AOM_CODEC_USE_POSTPROC 0x10000 /**< Postprocess decoded frame */
- /*!\brief The input frame should be passed to the decoder one fragment at a
- * time */
- #define AOM_CODEC_USE_INPUT_FRAGMENTS 0x40000
- /*!\brief Stream properties
- *
- * This structure is used to query or set properties of the decoded
- * stream.
- */
- typedef struct aom_codec_stream_info {
- unsigned int w; /**< Width (or 0 for unknown/default) */
- unsigned int h; /**< Height (or 0 for unknown/default) */
- unsigned int is_kf; /**< Current frame is a keyframe */
- unsigned int number_spatial_layers; /**< Number of spatial layers */
- unsigned int number_temporal_layers; /**< Number of temporal layers */
- unsigned int is_annexb; /**< Is Bitstream in Annex-B format */
- } aom_codec_stream_info_t;
- /* REQUIRED FUNCTIONS
- *
- * The following functions are required to be implemented for all decoders.
- * They represent the base case functionality expected of all decoders.
- */
- /*!\brief Initialization Configurations
- *
- * This structure is used to pass init time configuration options to the
- * decoder.
- */
- typedef struct aom_codec_dec_cfg {
- unsigned int threads; /**< Maximum number of threads to use, default 1 */
- unsigned int w; /**< Width */
- unsigned int h; /**< Height */
- unsigned int allow_lowbitdepth; /**< Allow use of low-bitdepth coding path */
- cfg_options_t cfg; /**< Options defined per config attributes */
- } aom_codec_dec_cfg_t; /**< alias for struct aom_codec_dec_cfg */
- /*!\brief 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 --disable-multithread, this call
- * is not thread safe and should be guarded with a lock if being used
- * in a multithreaded context.
- *
- * \param[in] ctx Pointer to this instance's context.
- * \param[in] iface Pointer to the algorithm interface to use.
- * \param[in] cfg Configuration to use, if known. May be NULL.
- * \param[in] flags Bitfield of AOM_CODEC_USE_* flags
- * \param[in] ver ABI version number. Must be set to
- * AOM_DECODER_ABI_VERSION
- * \retval #AOM_CODEC_OK
- * The decoder algorithm initialized.
- * \retval #AOM_CODEC_MEM_ERROR
- * Memory allocation failed.
- */
- 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);
- /*!\brief Convenience macro for aom_codec_dec_init_ver()
- *
- * Ensures the ABI version parameter is properly set.
- */
- #define aom_codec_dec_init(ctx, iface, cfg, flags) \
- aom_codec_dec_init_ver(ctx, iface, cfg, flags, AOM_DECODER_ABI_VERSION)
- /*!\brief 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.
- *
- * \param[in] iface Pointer to the algorithm interface
- * \param[in] data Pointer to a block of data to parse
- * \param[in] data_sz Size of the data buffer
- * \param[in,out] si Pointer to stream info to update. The is_annexb
- * member \ref MUST be properly initialized. This
- * function sets the rest of the members.
- *
- * \retval #AOM_CODEC_OK
- * Bitstream is parsable and stream information updated.
- * \retval #AOM_CODEC_INVALID_PARAM
- * One of the arguments is invalid, for example a NULL pointer.
- * \retval #AOM_CODEC_UNSUP_BITSTREAM
- * The decoder didn't recognize the coded data, or the
- * buffer was too short.
- */
- 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);
- /*!\brief Return information about the current stream.
- *
- * Returns information about the stream that has been parsed during decoding.
- *
- * \param[in] ctx Pointer to this instance's context
- * \param[in,out] si Pointer to stream info to update.
- *
- * \retval #AOM_CODEC_OK
- * Bitstream is parsable and stream information updated.
- * \retval #AOM_CODEC_INVALID_PARAM
- * One of the arguments is invalid, for example a NULL pointer.
- * \retval #AOM_CODEC_UNSUP_BITSTREAM
- * The decoder couldn't parse the submitted data.
- */
- aom_codec_err_t aom_codec_get_stream_info(aom_codec_ctx_t *ctx,
- aom_codec_stream_info_t *si);
- /*!\brief Decode data
- *
- * Processes a buffer of coded data. If the processing results in a new
- * decoded frame becoming available, PUT_SLICE and PUT_FRAME events may be
- * generated, as appropriate. Encoded data \ref MUST be passed in DTS (decode
- * time stamp) order. Frames produced will always be in PTS (presentation
- * time stamp) order.
- * If the decoder is configured with AOM_CODEC_USE_INPUT_FRAGMENTS enabled,
- * data and data_sz can contain a fragment of the encoded frame. Fragment
- * \#n must contain at least partition \#n, but can also contain subsequent
- * partitions (\#n+1 - \#n+i), and if so, fragments \#n+1, .., \#n+i must
- * be empty. When no more data is available, this function should be called
- * with NULL as data and 0 as data_sz. The memory passed to this function
- * must be available until the frame has been decoded.
- *
- * \param[in] ctx Pointer to this instance's context
- * \param[in] data Pointer to this block of new coded data. If
- * NULL, a AOM_CODEC_CB_PUT_FRAME event is posted
- * for the previously decoded frame.
- * \param[in] data_sz Size of the coded data, in bytes.
- * \param[in] user_priv Application specific data to associate with
- * this frame.
- *
- * \return 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_err_t aom_codec_decode(aom_codec_ctx_t *ctx, const uint8_t *data,
- size_t data_sz, void *user_priv);
- /*!\brief 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.
- *
- * \param[in] ctx Pointer to this instance's context
- * \param[in,out] iter Iterator storage, initialized to NULL
- *
- * \return Returns a pointer to an image, if one is ready for display. Frames
- * produced will always be in PTS (presentation time stamp) order.
- */
- aom_image_t *aom_codec_get_frame(aom_codec_ctx_t *ctx, aom_codec_iter_t *iter);
- /*!\defgroup cap_put_frame Frame-Based Decoding Functions
- *
- * The following functions are required to be implemented for all decoders
- * that advertise the AOM_CODEC_CAP_PUT_FRAME capability. Calling these
- * functions
- * for codecs that don't advertise this capability will result in an error
- * code being returned, usually AOM_CODEC_ERROR
- * @{
- */
- /*!\brief put frame callback prototype
- *
- * This callback is invoked by the decoder to notify the application of
- * the availability of decoded image data.
- */
- typedef void (*aom_codec_put_frame_cb_fn_t)(void *user_priv,
- const aom_image_t *img);
- /*!\brief Register for notification of frame completion.
- *
- * Registers a given function to be called when a decoded frame is
- * available.
- *
- * \param[in] ctx Pointer to this instance's context
- * \param[in] cb Pointer to the callback function
- * \param[in] user_priv User's private data
- *
- * \retval #AOM_CODEC_OK
- * Callback successfully registered.
- * \retval #AOM_CODEC_ERROR
- * Decoder context not initialized, or algorithm not capable of
- * posting slice completion.
- */
- 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);
- /*!@} - end defgroup cap_put_frame */
- /*!\defgroup cap_put_slice Slice-Based Decoding Functions
- *
- * The following functions are required to be implemented for all decoders
- * that advertise the AOM_CODEC_CAP_PUT_SLICE capability. Calling these
- * functions
- * for codecs that don't advertise this capability will result in an error
- * code being returned, usually AOM_CODEC_ERROR
- * @{
- */
- /*!\brief put slice callback prototype
- *
- * This callback is invoked by the decoder to notify the application of
- * the availability of partially decoded image data. The
- */
- 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);
- /*!\brief Register for notification of slice completion.
- *
- * Registers a given function to be called when a decoded slice is
- * available.
- *
- * \param[in] ctx Pointer to this instance's context
- * \param[in] cb Pointer to the callback function
- * \param[in] user_priv User's private data
- *
- * \retval #AOM_CODEC_OK
- * Callback successfully registered.
- * \retval #AOM_CODEC_ERROR
- * Decoder context not initialized, or algorithm not capable of
- * posting slice completion.
- */
- 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);
- /*!@} - end defgroup cap_put_slice*/
- /*!\defgroup cap_external_frame_buffer External Frame Buffer Functions
- *
- * The following section is required to be implemented for all decoders
- * that advertise the AOM_CODEC_CAP_EXTERNAL_FRAME_BUFFER capability.
- * Calling this function for codecs that don't advertise this capability
- * will result in an error code being returned, usually AOM_CODEC_ERROR.
- *
- * \note
- * Currently this only works with AV1.
- * @{
- */
- /*!\brief Pass in external frame buffers for the decoder to use.
- *
- * Registers functions to be called when libaom needs a frame buffer
- * to decode the current frame and a function to be called when libaom does
- * not internally reference the frame buffer. This set function must
- * be called before the first call to decode or libaom will assume the
- * default behavior of allocating frame buffers internally.
- *
- * \param[in] ctx Pointer to this instance's context
- * \param[in] cb_get Pointer to the get callback function
- * \param[in] cb_release Pointer to the release callback function
- * \param[in] cb_priv Callback's private data
- *
- * \retval #AOM_CODEC_OK
- * External frame buffers will be used by libaom.
- * \retval #AOM_CODEC_INVALID_PARAM
- * One or more of the callbacks were NULL.
- * \retval #AOM_CODEC_ERROR
- * Decoder context not initialized, or algorithm not capable of
- * using external frame buffers.
- *
- * \note
- * When decoding AV1, the application may be required to pass in at least
- * #AOM_MAXIMUM_WORK_BUFFERS external frame
- * buffers.
- */
- 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);
- /*!@} - end defgroup cap_external_frame_buffer */
- /*!@} - end defgroup decoder*/
- #ifdef __cplusplus
- }
- #endif
- #endif // AOM_AOM_DECODER_H_
|