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_codec_impl_top.h"
  26
  27 /*!\name 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  */
  33 extern vpx_codec_iface_t  vpx_codec_vp8_dx_algo;
  34 extern vpx_codec_iface_t* vpx_codec_vp8_dx(void);
  35 /*!@} - end algorithm interface member group*/
  36
  37 /* Include controls common to both the encoder and decoder */
  38 #include "vp8.h"
  39
  40
  41 /*!\brief VP8 decoder control functions
  42  *
  43  * This set of macros define the control functions available for the VP8
  44  * decoder interface.
  45  *
  46  * \sa #vpx_codec_control
  47  */
  48 enum vp8_dec_control_id
  49 {
  50     /** control function to get info on which reference frames were updated
  51      *  by the last decode
  52      */
  53     VP8D_GET_LAST_REF_UPDATES = VP8_DECODER_CTRL_ID_START,
  54
  55     /** check if the indicated frame is corrupted */
  56     VP8D_GET_FRAME_CORRUPTED,
  57
  58     VP8_DECODER_CTRL_ID_MAX
  59 } ;
  60
  61
  62 /*!\brief VP8 decoder control function parameter type
  63  *
  64  * Defines the data types that VP8D control functions take. Note that
  65  * additional common controls are defined in vp8.h
  66  *
  67  */
  68
  69
  70 VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES,   int *)
  71 VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED,    int *)
  72
  73
  74 /*! @} - end defgroup vp8_decoder */
  75
  76
  77 #include "vpx_codec_impl_bottom.h"
  78 #endif