vpx/vp8dx.h

   1 /*
   2  *  Copyright (c) 2010 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
  12 /*!\defgroup vp8_decoder WebM VP8/VP9 Decoder
  13  * \ingroup vp8
  14  *
  15  * @{
  16  */
  17 /*!\file
  18  * \brief Provides definitions for using VP8 or VP9 within the vpx Decoder
  19  *        interface.
  20  */
  21 #ifndef VPX_VP8DX_H_
  22 #define VPX_VP8DX_H_
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* Include controls common to both the encoder and decoder */
  29 #include "./vp8.h"
  30
  31 /*!\name Algorithm interface for VP8
  32  *
  33  * This interface provides the capability to decode VP8 streams.
  34  * @{
  35  */
  36 extern vpx_codec_iface_t  vpx_codec_vp8_dx_algo;
  37 extern vpx_codec_iface_t *vpx_codec_vp8_dx(void);
  38 /*!@} - end algorithm interface member group*/
  39
  40 /*!\name Algorithm interface for VP9
  41  *
  42  * This interface provides the capability to decode VP9 streams.
  43  * @{
  44  */
  45 extern vpx_codec_iface_t  vpx_codec_vp9_dx_algo;
  46 extern vpx_codec_iface_t *vpx_codec_vp9_dx(void);
  47 /*!@} - end algorithm interface member group*/
  48
  49
  50 /*!\enum vp8_dec_control_id
  51  * \brief VP8 decoder control functions
  52  *
  53  * This set of macros define the control functions available for the VP8
  54  * decoder interface.
  55  *
  56  * \sa #vpx_codec_control
  57  */
  58 enum vp8_dec_control_id {
  59   /** control function to get info on which reference frames were updated
  60    *  by the last decode
  61    */
  62   VP8D_GET_LAST_REF_UPDATES = VP8_DECODER_CTRL_ID_START,
  63
  64   /** check if the indicated frame is corrupted */
  65   VP8D_GET_FRAME_CORRUPTED,
  66
  67   /** control function to get info on which reference frames were used
  68    *  by the last decode
  69    */
  70   VP8D_GET_LAST_REF_USED,
  71
  72   /** decryption function to decrypt encoded buffer data immediately
  73    * before decoding. Takes a vpx_decrypt_init, which contains
  74    * a callback function and opaque context pointer.
  75    */
  76   VPXD_SET_DECRYPTOR,
  77   VP8D_SET_DECRYPTOR = VPXD_SET_DECRYPTOR,
  78
  79   /** control function to get the dimensions that the current frame is decoded
  80    * at. This may be different to the intended display size for the frame as
  81    * specified in the wrapper or frame header (see VP9D_GET_DISPLAY_SIZE). */
  82   VP9D_GET_FRAME_SIZE,
  83
  84   /** control function to get the current frame's intended display dimensions
  85    * (as specified in the wrapper or frame header). This may be different to
  86    * the decoded dimensions of this frame (see VP9D_GET_FRAME_SIZE). */
  87   VP9D_GET_DISPLAY_SIZE,
  88
  89   /** control function to get the bit depth of the stream. */
  90   VP9D_GET_BIT_DEPTH,
  91
  92   /** control function to set the byte alignment of the planes in the reference
  93    * buffers. Valid values are power of 2, from 32 to 1024. A value of 0 sets
  94    * legacy alignment. I.e. Y plane is aligned to 32 bytes, U plane directly
  95    * follows Y plane, and V plane directly follows U plane. Default value is 0.
  96    */
  97   VP9_SET_BYTE_ALIGNMENT,
  98
  99   /** control function to invert the decoding order to from right to left. The
 100    * function is used in a test to confirm the decoding independence of tile
 101    * columns. The function may be used in application where this order
 102    * of decoding is desired.
 103    *
 104    * TODO(yaowu): Rework the unit test that uses this control, and in a future
 105    *              release, this test-only control shall be removed.
 106    */
 107   VP9_INVERT_TILE_DECODE_ORDER,
 108
 109   /** control function to set the skip loop filter flag. Valid values are
 110    * integers. The decoder will skip the loop filter when its value is set to
 111    * nonzero. If the loop filter is skipped the decoder may accumulate decode
 112    * artifacts. The default value is 0.
 113    */
 114   VP9_SET_SKIP_LOOP_FILTER,
 115
 116   VP8_DECODER_CTRL_ID_MAX
 117 };
 118
 119 /** Decrypt n bytes of data from input -> output, using the decrypt_state
 120  *  passed in VPXD_SET_DECRYPTOR.
 121  */
 122 typedef void (*vpx_decrypt_cb)(void *decrypt_state, const unsigned char *input,
 123                                unsigned char *output, int count);
 124
 125 /*!\brief Structure to hold decryption state
 126  *
 127  * Defines a structure to hold the decryption state and access function.
 128  */
 129 typedef struct vpx_decrypt_init {
 130     /*! Decrypt callback. */
 131     vpx_decrypt_cb decrypt_cb;
 132
 133     /*! Decryption state. */
 134     void *decrypt_state;
 135 } vpx_decrypt_init;
 136
 137 /*!\brief A deprecated alias for vpx_decrypt_init.
 138  */
 139 typedef vpx_decrypt_init vp8_decrypt_init;
 140
 141
 142 /*!\brief VP8 decoder control function parameter type
 143  *
 144  * Defines the data types that VP8D control functions take. Note that
 145  * additional common controls are defined in vp8.h
 146  *
 147  */
 148
 149
 150 VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES,    int *)
 151 VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED,     int *)
 152 VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_USED,       int *)
 153 VPX_CTRL_USE_TYPE(VPXD_SET_DECRYPTOR,           vpx_decrypt_init *)
 154 VPX_CTRL_USE_TYPE(VP8D_SET_DECRYPTOR,           vpx_decrypt_init *)
 155 VPX_CTRL_USE_TYPE(VP9D_GET_DISPLAY_SIZE,        int *)
 156 VPX_CTRL_USE_TYPE(VP9D_GET_BIT_DEPTH,           unsigned int *)
 157 VPX_CTRL_USE_TYPE(VP9D_GET_FRAME_SIZE,          int *)
 158 VPX_CTRL_USE_TYPE(VP9_INVERT_TILE_DECODE_ORDER, int)
 159
 160 /*! @} - end defgroup vp8_decoder */
 161
 162 #ifdef __cplusplus
 163 }  // extern "C"
 164 #endif
 165
 166 #endif  // VPX_VP8DX_H_