granicus.if.org Git - libvpx/blob - vpx/vp8.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 /*!\defgroup vp8 VP8
  12  * \ingroup codecs
  13  * VP8 is vpx's newest video compression algorithm that uses motion
  14  * compensated prediction, Discrete Cosine Transform (DCT) coding of the
  15  * prediction error signal and context dependent entropy coding techniques
  16  * based on arithmetic principles. It features:
  17  *  - YUV 4:2:0 image format
  18  *  - Macro-block based coding (16x16 luma plus two 8x8 chroma)
  19  *  - 1/4 (1/8) pixel accuracy motion compensated prediction
  20  *  - 4x4 DCT transform
  21  *  - 128 level linear quantizer
  22  *  - In loop deblocking filter
  23  *  - Context-based entropy coding
  24  *
  25  * @{
  26  */
  27 /*!\file
  28  * \brief Provides controls common to both the VP8 encoder and decoder.
  29  */
  30 #ifndef VPX_VP8_H_
  31 #define VPX_VP8_H_
  32
  33 #include "./vpx_codec.h"
  34 #include "./vpx_image.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*!\brief Control functions
  41  *
  42  * The set of macros define the control functions of VP8 interface
  43  */
  44 enum vp8_com_control_id {
  45   /*!\brief pass in an external frame into decoder to be used as reference frame
  46    */
  47   VP8_SET_REFERENCE = 1,
  48   VP8_COPY_REFERENCE = 2, /**< get a copy of reference frame from the decoder */
  49   VP8_SET_POSTPROC = 3,   /**< set the decoder's post processing settings  */
  50   VP8_SET_DBG_COLOR_REF_FRAME = 4, /**< \deprecated */
  51   VP8_SET_DBG_COLOR_MB_MODES = 5,  /**< \deprecated */
  52   VP8_SET_DBG_COLOR_B_MODES = 6,   /**< \deprecated */
  53   VP8_SET_DBG_DISPLAY_MV = 7,      /**< \deprecated */
  54
  55   /* TODO(jkoleszar): The encoder incorrectly reuses some of these values (5+)
  56    * for its control ids. These should be migrated to something like the
  57    * VP8_DECODER_CTRL_ID_START range next time we're ready to break the ABI.
  58    */
  59   VP9_GET_REFERENCE = 128, /**< get a pointer to a reference frame */
  60   VP8_COMMON_CTRL_ID_MAX,
  61   VP8_DECODER_CTRL_ID_START = 256
  62 };
  63
  64 /*!\brief post process flags
  65  *
  66  * The set of macros define VP8 decoder post processing flags
  67  */
  68 enum vp8_postproc_level {
  69   VP8_NOFILTERING = 0,
  70   VP8_DEBLOCK = 1 << 0,
  71   VP8_DEMACROBLOCK = 1 << 1,
  72   VP8_ADDNOISE = 1 << 2,
  73   VP8_DEBUG_TXT_FRAME_INFO = 1 << 3, /**< print frame information */
  74   VP8_DEBUG_TXT_MBLK_MODES =
  75       1 << 4, /**< print macro block modes over each macro block */
  76   VP8_DEBUG_TXT_DC_DIFF = 1 << 5,   /**< print dc diff for each macro block */
  77   VP8_DEBUG_TXT_RATE_INFO = 1 << 6, /**< print video rate info (encoder only) */
  78   VP8_MFQE = 1 << 10
  79 };
  80
  81 /*!\brief post process flags
  82  *
  83  * This define a structure that describe the post processing settings. For
  84  * the best objective measure (using the PSNR metric) set post_proc_flag
  85  * to VP8_DEBLOCK and deblocking_level to 1.
  86  */
  87
  88 typedef struct vp8_postproc_cfg {
  89   /*!\brief the types of post processing to be done, should be combination of
  90    * "vp8_postproc_level" */
  91   int post_proc_flag;
  92   int deblocking_level; /**< the strength of deblocking, valid range [0, 16] */
  93   int noise_level; /**< the strength of additive noise, valid range [0, 16] */
  94 } vp8_postproc_cfg_t;
  95
  96 /*!\brief reference frame type
  97  *
  98  * The set of macros define the type of VP8 reference frames
  99  */
 100 typedef enum vpx_ref_frame_type {
 101   VP8_LAST_FRAME = 1,
 102   VP8_GOLD_FRAME = 2,
 103   VP8_ALTR_FRAME = 4
 104 } vpx_ref_frame_type_t;
 105
 106 /*!\brief reference frame data struct
 107  *
 108  * Define the data struct to access vp8 reference frames.
 109  */
 110 typedef struct vpx_ref_frame {
 111   vpx_ref_frame_type_t frame_type; /**< which reference frame */
 112   vpx_image_t img;                 /**< reference frame data in image format */
 113 } vpx_ref_frame_t;
 114
 115 /*!\brief VP9 specific reference frame data struct
 116  *
 117  * Define the data struct to access vp9 reference frames.
 118  */
 119 typedef struct vp9_ref_frame {
 120   int idx;         /**< frame index to get (input) */
 121   vpx_image_t img; /**< img structure to populate (output) */
 122 } vp9_ref_frame_t;
 123
 124 /*!\cond */
 125 /*!\brief vp8 decoder control function parameter type
 126  *
 127  * defines the data type for each of VP8 decoder control function requires
 128  */
 129 VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *)
 130 #define VPX_CTRL_VP8_SET_REFERENCE
 131 VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *)
 132 #define VPX_CTRL_VP8_COPY_REFERENCE
 133 VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *)
 134 #define VPX_CTRL_VP8_SET_POSTPROC
 135 VPX_CTRL_USE_TYPE_DEPRECATED(VP8_SET_DBG_COLOR_REF_FRAME, int)
 136 #define VPX_CTRL_VP8_SET_DBG_COLOR_REF_FRAME
 137 VPX_CTRL_USE_TYPE_DEPRECATED(VP8_SET_DBG_COLOR_MB_MODES, int)
 138 #define VPX_CTRL_VP8_SET_DBG_COLOR_MB_MODES
 139 VPX_CTRL_USE_TYPE_DEPRECATED(VP8_SET_DBG_COLOR_B_MODES, int)
 140 #define VPX_CTRL_VP8_SET_DBG_COLOR_B_MODES
 141 VPX_CTRL_USE_TYPE_DEPRECATED(VP8_SET_DBG_DISPLAY_MV, int)
 142 #define VPX_CTRL_VP8_SET_DBG_DISPLAY_MV
 143 VPX_CTRL_USE_TYPE(VP9_GET_REFERENCE, vp9_ref_frame_t *)
 144 #define VPX_CTRL_VP9_GET_REFERENCE
 145
 146 /*!\endcond */
 147 /*! @} - end defgroup vp8 */
 148
 149 #ifdef __cplusplus
 150 }  // extern "C"
 151 #endif
 152
 153 #endif  // VPX_VP8_H_