vp8dx.h 4.92 KB
 John Koleszar committed May 18, 2010 1 ``````/* `````` John Koleszar committed Sep 09, 2010 2 `````` * Copyright (c) 2010 The WebM project authors. All Rights Reserved. `````` John Koleszar committed May 18, 2010 3 `````` * `````` John Koleszar committed Jun 18, 2010 4 `````` * Use of this source code is governed by a BSD-style license `````` John Koleszar committed Jun 04, 2010 5 6 `````` * that can be found in the LICENSE file in the root of the source * tree. An additional intellectual property rights grant can be found `````` John Koleszar committed Jun 18, 2010 7 `````` * in the file PATENTS. All contributing project authors may `````` John Koleszar committed Jun 04, 2010 8 `````` * be found in the AUTHORS file in the root of the source tree. `````` John Koleszar committed May 18, 2010 9 10 11 `````` */ `````` Yaowu Xu committed Jan 15, 2015 12 ``````/*!\defgroup vp8_decoder WebM VP8/VP9 Decoder `````` John Koleszar committed May 18, 2010 13 14 15 16 `````` * \ingroup vp8 * * @{ */ `````` James Zern committed Feb 17, 2011 17 ``````/*!\file `````` Yaowu Xu committed Jan 15, 2015 18 `````` * \brief Provides definitions for using VP8 or VP9 within the vpx Decoder `````` John Koleszar committed May 18, 2010 19 20 `````` * interface. */ `````` James Zern committed Dec 17, 2013 21 22 ``````#ifndef VPX_VP8DX_H_ #define VPX_VP8DX_H_ `````` Dmitry Kovalev committed Sep 30, 2013 23 24 25 26 `````` #ifdef __cplusplus extern "C" { #endif `````` John Koleszar committed May 18, 2010 27 `````` `````` Johann committed Dec 16, 2013 28 29 30 ``````/* Include controls common to both the encoder and decoder */ #include "./vp8.h" `````` James Zern committed Feb 24, 2011 31 ``````/*!\name Algorithm interface for VP8 `````` John Koleszar committed May 18, 2010 32 `````` * `````` Yaowu Xu committed Jan 15, 2015 33 `````` * This interface provides the capability to decode VP8 streams. `````` James Zern committed Feb 24, 2011 34 `````` * @{ `````` John Koleszar committed May 18, 2010 35 `````` */ `````` John Koleszar committed Sep 23, 2010 36 ``````extern vpx_codec_iface_t vpx_codec_vp8_dx_algo; `````` John Koleszar committed Jul 17, 2012 37 ``````extern vpx_codec_iface_t *vpx_codec_vp8_dx(void); `````` Yaowu Xu committed Jan 15, 2015 38 ``````/*!@} - end algorithm interface member group*/ `````` John Koleszar committed Nov 15, 2012 39 `````` `````` Yaowu Xu committed Jan 15, 2015 40 41 42 43 44 ``````/*!\name Algorithm interface for VP9 * * This interface provides the capability to decode VP9 streams. * @{ */ `````` John Koleszar committed Nov 15, 2012 45 46 ``````extern vpx_codec_iface_t vpx_codec_vp9_dx_algo; extern vpx_codec_iface_t *vpx_codec_vp9_dx(void); `````` James Zern committed Feb 24, 2011 47 ``````/*!@} - end algorithm interface member group*/ `````` John Koleszar committed May 18, 2010 48 49 `````` `````` Adrian Grange committed Oct 29, 2013 50 51 ``````/*!\enum vp8_dec_control_id * \brief VP8 decoder control functions `````` Henrik Lundin committed Dec 17, 2010 52 `````` * `````` James Zern committed Feb 24, 2011 53 54 55 56 `````` * This set of macros define the control functions available for the VP8 * decoder interface. * * \sa #vpx_codec_control `````` Henrik Lundin committed Dec 17, 2010 57 `````` */ `````` John Koleszar committed Jul 17, 2012 58 59 60 61 62 63 64 65 66 ``````enum vp8_dec_control_id { /** control function to get info on which reference frames were updated * by the last decode */ VP8D_GET_LAST_REF_UPDATES = VP8_DECODER_CTRL_ID_START, /** check if the indicated frame is corrupted */ VP8D_GET_FRAME_CORRUPTED, `````` John Koleszar committed Nov 06, 2012 67 68 69 70 71 `````` /** control function to get info on which reference frames were used * by the last decode */ VP8D_GET_LAST_REF_USED, `````` Jeff Petkau committed Jun 17, 2013 72 `````` /** decryption function to decrypt encoded buffer data immediately `````` Joey Parrish committed Apr 23, 2014 73 `````` * before decoding. Takes a vpx_decrypt_init, which contains `````` Jeff Petkau committed Jun 17, 2013 74 `````` * a callback function and opaque context pointer. `````` Dmitry Kovalev committed Mar 16, 2013 75 `````` */ `````` Joey Parrish committed Apr 23, 2014 76 77 `````` VPXD_SET_DECRYPTOR, VP8D_SET_DECRYPTOR = VPXD_SET_DECRYPTOR, `````` Dmitry Kovalev committed Mar 16, 2013 78 `````` `````` Adrian Grange committed Feb 13, 2015 79 80 81 82 83 84 85 86 `````` /** control function to get the dimensions that the current frame is decoded * at. This may be different to the intended display size for the frame as * specified in the wrapper or frame header (see VP9D_GET_DISPLAY_SIZE). */ VP9D_GET_FRAME_SIZE, /** control function to get the current frame's intended display dimensions * (as specified in the wrapper or frame header). This may be different to * the decoded dimensions of this frame (see VP9D_GET_FRAME_SIZE). */ `````` Adrian Grange committed Nov 22, 2013 87 88 `````` VP9D_GET_DISPLAY_SIZE, `````` Deb Mukherjee committed Sep 02, 2014 89 90 91 `````` /** control function to get the bit depth of the stream. */ VP9D_GET_BIT_DEPTH, `````` Frank Galligan committed Dec 15, 2014 92 93 94 95 96 97 98 `````` /** control function to set the byte alignment of the planes in the reference * buffers. Valid values are power of 2, from 32 to 1024. A value of 0 sets * legacy alignment. I.e. Y plane is aligned to 32 bytes, U plane directly * follows Y plane, and V plane directly follows U plane. Default value is 0. */ VP9_SET_BYTE_ALIGNMENT, `````` Yaowu Xu committed Jan 15, 2015 99 100 101 102 103 104 105 106 `````` /** control function to invert the decoding order to from right to left. The * function is used in a test to confirm the decoding independence of tile * columns. The function may be used in application where this order * of decoding is desired. * * TODO(yaowu): Rework the unit test that uses this control, and in a future * release, this test-only control shall be removed. */ `````` John Koleszar committed Mar 27, 2013 107 108 `````` VP9_INVERT_TILE_DECODE_ORDER, `````` John Koleszar committed Jul 17, 2012 109 110 `````` VP8_DECODER_CTRL_ID_MAX }; `````` Henrik Lundin committed Dec 17, 2010 111 `````` `````` Joey Parrish committed Apr 23, 2014 112 113 114 115 116 117 ``````/** Decrypt n bytes of data from input -> output, using the decrypt_state * passed in VPXD_SET_DECRYPTOR. */ typedef void (*vpx_decrypt_cb)(void *decrypt_state, const unsigned char *input, unsigned char *output, int count); `````` Adrian Grange committed Oct 29, 2013 118 119 120 121 ``````/*!\brief Structure to hold decryption state * * Defines a structure to hold the decryption state and access function. */ `````` Joey Parrish committed Apr 23, 2014 122 123 124 125 ``````typedef struct vpx_decrypt_init { /*! Decrypt callback. */ vpx_decrypt_cb decrypt_cb; `````` Adrian Grange committed Oct 29, 2013 126 `````` /*! Decryption state. */ `````` Jeff Petkau committed Jun 17, 2013 127 `````` void *decrypt_state; `````` Joey Parrish committed Apr 23, 2014 128 129 130 131 132 133 ``````} vpx_decrypt_init; /*!\brief A deprecated alias for vpx_decrypt_init. */ typedef vpx_decrypt_init vp8_decrypt_init; `````` Jeff Petkau committed Jun 17, 2013 134 `````` `````` John Koleszar committed Mar 04, 2011 135 ``````/*!\brief VP8 decoder control function parameter type `````` Henrik Lundin committed Dec 17, 2010 136 `````` * `````` John Koleszar committed Mar 04, 2011 137 `````` * Defines the data types that VP8D control functions take. Note that `````` Henrik Lundin committed Dec 17, 2010 138 139 140 141 142 `````` * additional common controls are defined in vp8.h * */ `````` Joey Parrish committed Apr 23, 2014 143 144 145 146 147 148 ``````VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES, int *) VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED, int *) VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_USED, int *) VPX_CTRL_USE_TYPE(VPXD_SET_DECRYPTOR, vpx_decrypt_init *) VPX_CTRL_USE_TYPE(VP8D_SET_DECRYPTOR, vpx_decrypt_init *) VPX_CTRL_USE_TYPE(VP9D_GET_DISPLAY_SIZE, int *) `````` Deb Mukherjee committed Sep 02, 2014 149 ``````VPX_CTRL_USE_TYPE(VP9D_GET_BIT_DEPTH, unsigned int *) `````` Adrian Grange committed Feb 13, 2015 150 ``````VPX_CTRL_USE_TYPE(VP9D_GET_FRAME_SIZE, int *) `````` John Koleszar committed Mar 27, 2013 151 ``````VPX_CTRL_USE_TYPE(VP9_INVERT_TILE_DECODE_ORDER, int) `````` Henrik Lundin committed Dec 17, 2010 152 `````` `````` John Koleszar committed May 18, 2010 153 154 ``````/*! @} - end defgroup vp8_decoder */ `````` Dmitry Kovalev committed Sep 30, 2013 155 156 157 ``````#ifdef __cplusplus } // extern "C" #endif `````` John Koleszar committed May 18, 2010 158 `````` `````` James Zern committed Dec 17, 2013 159 ``#endif // VPX_VP8DX_H_``