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