aom_frame_buffer.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. /*
  2. * Copyright (c) 2016, Alliance for Open Media. All rights reserved
  3. *
  4. * This source code is subject to the terms of the BSD 2 Clause License and
  5. * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
  6. * was not distributed with this source code in the LICENSE file, you can
  7. * obtain it at www.aomedia.org/license/software. If the Alliance for Open
  8. * Media Patent License 1.0 was not distributed with this source code in the
  9. * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
  10. */
  11. #ifndef AOM_AOM_FRAME_BUFFER_H_
  12. #define AOM_AOM_FRAME_BUFFER_H_
  13. /*!\file
  14. * \brief Describes the decoder external frame buffer interface.
  15. */
  16. #ifdef __cplusplus
  17. extern "C" {
  18. #endif
  19. #include "aom/aom_integer.h"
  20. /*!\brief The maximum number of work buffers used by libaom.
  21. * Support maximum 4 threads to decode video in parallel.
  22. * Each thread will use one work buffer.
  23. * TODO(hkuang): Add support to set number of worker threads dynamically.
  24. */
  25. #define AOM_MAXIMUM_WORK_BUFFERS 8
  26. /*!\brief The maximum number of reference buffers that a AV1 encoder may use.
  27. */
  28. #define AOM_MAXIMUM_REF_BUFFERS 8
  29. /*!\brief External frame buffer
  30. *
  31. * This structure holds allocated frame buffers used by the decoder.
  32. */
  33. typedef struct aom_codec_frame_buffer {
  34. uint8_t *data; /**< Pointer to the data buffer */
  35. size_t size; /**< Size of data in bytes */
  36. void *priv; /**< Frame's private data */
  37. } aom_codec_frame_buffer_t;
  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. The callback
  43. * must zero out all the data allocated. Then the callback must set fb->size
  44. * to the allocated size. The application does not need to align the allocated
  45. * data. The callback is triggered when the decoder needs a frame buffer to
  46. * decode a compressed image into. This function may be called more than once
  47. * for every call to aom_codec_decode. The application may set fb->priv to
  48. * some data which will be passed back in the ximage and the release function
  49. * call. |fb| is guaranteed to not be NULL. On success the callback must
  50. * return 0. Any failure the 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 aom_codec_frame_buffer_t
  55. */
  56. typedef int (*aom_get_frame_buffer_cb_fn_t)(void *priv, size_t min_size,
  57. aom_codec_frame_buffer_t *fb);
  58. /*!\brief release frame buffer callback prototype
  59. *
  60. * This callback is invoked by the decoder when the frame buffer is not
  61. * referenced by any other buffers. |fb| is guaranteed to not be NULL. On
  62. * success the callback must return 0. Any failure the callback must return
  63. * a value less than 0.
  64. *
  65. * \param[in] priv Callback's private data
  66. * \param[in] fb Pointer to aom_codec_frame_buffer_t
  67. */
  68. typedef int (*aom_release_frame_buffer_cb_fn_t)(void *priv,
  69. aom_codec_frame_buffer_t *fb);
  70. #ifdef __cplusplus
  71. } // extern "C"
  72. #endif
  73. #endif // AOM_AOM_FRAME_BUFFER_H_