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 #include "vp8.h"
  13
  14 /*!\defgroup vp8_decoder WebM VP8 Decoder
  15  * \ingroup vp8
  16  *
  17  * @{
  18  */
  19 /*!\file
  20  * \brief Provides definitions for using the VP8 algorithm within the vpx Decoder
  21  *        interface.
  22  */
  23 #ifndef VP8DX_H
  24 #define VP8DX_H
  25 #include "vpx/vpx_codec_impl_top.h"
  26
  27 /*!\brief Algorithm interface for VP8
  28  *
  29  * This interface provides the capability to decode raw VP8 streams, as would
  30  * be found in AVI files and other non-Flash uses.
  31  */
  32 extern vpx_codec_iface_t  vpx_codec_vp8_dx_algo;
  33 extern vpx_codec_iface_t* vpx_codec_vp8_dx(void);
  34
  35 /* Include controls common to both the encoder and decoder */
  36 #include "vp8.h"
  37
  38
  39 /*!\brief VP8 decoder control functions
  40  *
  41  * The set of macros define the control functions of VP8 decoder interface
  42  */
  43 enum vp8d_dec_control_id
  44 {
  45     VP8_DECODER_CTRL_ID_START   = 256,
  46     VP8D_GET_LAST_REF_UPDATES,              /**< control function to get info on which reference frames were updated
  47                                             by the last decode */
  48     VP8D_GET_FRAME_CORRUPTED,               /**< check if the indicated frame is corrupted */
  49     VP8_DECODER_CTRL_ID_MAX
  50 } ;
  51
  52
  53 /*!\brief VP8 encoder control function parameter type
  54  *
  55  * Defines the data types that VP8E control functions take. Note that
  56  * additional common controls are defined in vp8.h
  57  *
  58  */
  59
  60
  61 VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES,   int *)
  62 VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED,    int *)
  63
  64
  65 /*! @} - end defgroup vp8_decoder */
  66
  67
  68 #include "vpx/vpx_codec_impl_bottom.h"
  69 #endif