src/third_party/libvpx/source/libvpx/vpx/vpx_frame_buffer.h

   1 /*
   2  *  Copyright (c) 2014 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10
  11 #ifndef VPX_VPX_FRAME_BUFFER_H_
  12 #define VPX_VPX_FRAME_BUFFER_H_
  13
  14 #ifdef __cplusplus
  15 extern "C" {
  16 #endif
  17
  18 #include "./vpx_integer.h"
  19
  20 /*!\brief The maximum number of work buffers used by libvpx.
  21  */
  22 #define VPX_MAXIMUM_WORK_BUFFERS 1
  23
  24 /*!\brief The maximum number of reference buffers that a VP9 encoder may use.
  25  */
  26 #define VP9_MAXIMUM_REF_BUFFERS 8
  27
  28 /*!\brief External frame buffer
  29  *
  30  * This structure holds allocated frame buffers used by the decoder.
  31  */
  32 typedef struct vpx_codec_frame_buffer {
  33   uint8_t *data;  /**< Pointer to the data buffer */
  34   size_t size;  /**< Size of data in bytes */
  35   void *priv;  /**< Frame's private data */
  36 } vpx_codec_frame_buffer_t;
  37
  38 /*!\brief get frame buffer callback prototype
  39  *
  40  * This callback is invoked by the decoder to retrieve data for the frame
  41  * buffer in order for the decode call to complete. The callback must
  42  * allocate at least min_size in bytes and assign it to fb->data. Then the
  43  * callback must set fb->size to the allocated size. The application does not
  44  * need to align the allocated data. The callback is triggered when the
  45  * decoder needs a frame buffer to decode a compressed image into. This
  46  * function may be called more than once for every call to vpx_codec_decode.
  47  * The application may set fb->priv to some data which will be passed
  48  * back in the ximage and the release function call. |fb| is guaranteed to
  49  * not be NULL. On success the callback must return 0. Any failure the
  50  * callback must return a value less than 0.
  51  *
  52  * \param[in] priv         Callback's private data
  53  * \param[in] new_size     Size in bytes needed by the buffer
  54  * \param[in,out] fb       Pointer to vpx_codec_frame_buffer_t
  55  */
  56 typedef int (*vpx_get_frame_buffer_cb_fn_t)(
  57     void *priv, size_t min_size, vpx_codec_frame_buffer_t *fb);
  58
  59 /*!\brief release frame buffer callback prototype
  60  *
  61  * This callback is invoked by the decoder when the frame buffer is not
  62  * referenced by any other buffers. |fb| is guaranteed to not be NULL. On
  63  * success the callback must return 0. Any failure the callback must return
  64  * a value less than 0.
  65  *
  66  * \param[in] priv         Callback's private data
  67  * \param[in] fb           Pointer to vpx_codec_frame_buffer_t
  68  */
  69 typedef int (*vpx_release_frame_buffer_cb_fn_t)(
  70     void *priv, vpx_codec_frame_buffer_t *fb);
  71
  72 #ifdef __cplusplus
  73 }  // extern "C"
  74 #endif
  75
  76 #endif  // VPX_VPX_FRAME_BUFFER_H_