vp8.h 5.18 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
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
7
 *  in the file PATENTS.  All contributing project authors may
8
 *  be found in the AUTHORS file in the root of the source tree.
John Koleszar's avatar
John Koleszar committed
9 10 11 12 13 14 15
 */

/*!\defgroup vp8 VP8
 * \ingroup codecs
 * VP8 is vpx's newest video compression algorithm that uses motion
 * compensated prediction, Discrete Cosine Transform (DCT) coding of the
 * prediction error signal and context dependent entropy coding techniques
James Zern's avatar
James Zern committed
16
 * based on arithmetic principles. It features:
John Koleszar's avatar
John Koleszar committed
17 18 19 20 21 22 23 24 25 26
 *  - YUV 4:2:0 image format
 *  - Macro-block based coding (16x16 luma plus two 8x8 chroma)
 *  - 1/4 (1/8) pixel accuracy motion compensated prediction
 *  - 4x4 DCT transform
 *  - 128 level linear quantizer
 *  - In loop deblocking filter
 *  - Context-based entropy coding
 *
 * @{
 */
James Zern's avatar
James Zern committed
27
/*!\file
John Koleszar's avatar
John Koleszar committed
28 29
 * \brief Provides controls common to both the VP8 encoder and decoder.
 */
James Zern's avatar
James Zern committed
30 31
#ifndef VPX_VP8_H_
#define VPX_VP8_H_
32

Yaowu Xu's avatar
Yaowu Xu committed
33 34 35
#include "./vpx_codec.h"
#include "./vpx_image.h"

36 37 38
#ifdef __cplusplus
extern "C" {
#endif
John Koleszar's avatar
John Koleszar committed
39 40 41 42 43

/*!\brief Control functions
 *
 * The set of macros define the control functions of VP8 interface
 */
John Koleszar's avatar
John Koleszar committed
44
enum vp8_com_control_id {
clang-format's avatar
clang-format committed
45 46 47 48 49 50 51 52 53 54
  VP8_SET_REFERENCE =
      1, /**< pass in an external frame into decoder to be used as reference
            frame */
  VP8_COPY_REFERENCE = 2, /**< get a copy of reference frame from the decoder */
  VP8_SET_POSTPROC = 3,   /**< set the decoder's post processing settings  */
  VP8_SET_DBG_COLOR_REF_FRAME =
      4, /**< set the reference frames to color for each macroblock */
  VP8_SET_DBG_COLOR_MB_MODES = 5, /**< set which macro block modes to color */
  VP8_SET_DBG_COLOR_B_MODES = 6,  /**< set which blocks modes to color */
  VP8_SET_DBG_DISPLAY_MV = 7,     /**< set which motion vector modes to draw */
John Koleszar's avatar
John Koleszar committed
55 56 57 58 59

  /* TODO(jkoleszar): The encoder incorrectly reuses some of these values (5+)
   * for its control ids. These should be migrated to something like the
   * VP8_DECODER_CTRL_ID_START range next time we're ready to break the ABI.
   */
clang-format's avatar
clang-format committed
60
  VP9_GET_REFERENCE = 128, /**< get a pointer to a reference frame */
John Koleszar's avatar
John Koleszar committed
61
  VP8_COMMON_CTRL_ID_MAX,
clang-format's avatar
clang-format committed
62
  VP8_DECODER_CTRL_ID_START = 256
John Koleszar's avatar
John Koleszar committed
63 64 65 66 67 68
};

/*!\brief post process flags
 *
 * The set of macros define VP8 decoder post processing flags
 */
John Koleszar's avatar
John Koleszar committed
69
enum vp8_postproc_level {
clang-format's avatar
clang-format committed
70 71 72 73 74 75 76 77 78 79
  VP8_NOFILTERING = 0,
  VP8_DEBLOCK = 1 << 0,
  VP8_DEMACROBLOCK = 1 << 1,
  VP8_ADDNOISE = 1 << 2,
  VP8_DEBUG_TXT_FRAME_INFO = 1 << 3, /**< print frame information */
  VP8_DEBUG_TXT_MBLK_MODES =
      1 << 4, /**< print macro block modes over each macro block */
  VP8_DEBUG_TXT_DC_DIFF = 1 << 5,   /**< print dc diff for each macro block */
  VP8_DEBUG_TXT_RATE_INFO = 1 << 6, /**< print video rate info (encoder only) */
  VP8_MFQE = 1 << 10
John Koleszar's avatar
John Koleszar committed
80 81 82 83 84
};

/*!\brief post process flags
 *
 * This define a structure that describe the post processing settings. For
James Zern's avatar
James Zern committed
85
 * the best objective measure (using the PSNR metric) set post_proc_flag
John Koleszar's avatar
John Koleszar committed
86 87 88
 * to VP8_DEBLOCK and deblocking_level to 1.
 */

John Koleszar's avatar
John Koleszar committed
89
typedef struct vp8_postproc_cfg {
clang-format's avatar
clang-format committed
90 91 92 93
  int post_proc_flag;   /**< the types of post processing to be done, should be
                           combination of "vp8_postproc_level" */
  int deblocking_level; /**< the strength of deblocking, valid range [0, 16] */
  int noise_level; /**< the strength of additive noise, valid range [0, 16] */
John Koleszar's avatar
John Koleszar committed
94 95 96 97 98 99
} vp8_postproc_cfg_t;

/*!\brief reference frame type
 *
 * The set of macros define the type of VP8 reference frames
 */
John Koleszar's avatar
John Koleszar committed
100 101 102 103
typedef enum vpx_ref_frame_type {
  VP8_LAST_FRAME = 1,
  VP8_GOLD_FRAME = 2,
  VP8_ALTR_FRAME = 4
John Koleszar's avatar
John Koleszar committed
104 105 106 107
} vpx_ref_frame_type_t;

/*!\brief reference frame data struct
 *
Adrian Grange's avatar
Adrian Grange committed
108
 * Define the data struct to access vp8 reference frames.
John Koleszar's avatar
John Koleszar committed
109
 */
John Koleszar's avatar
John Koleszar committed
110
typedef struct vpx_ref_frame {
clang-format's avatar
clang-format committed
111 112
  vpx_ref_frame_type_t frame_type; /**< which reference frame */
  vpx_image_t img;                 /**< reference frame data in image format */
John Koleszar's avatar
John Koleszar committed
113 114
} vpx_ref_frame_t;

Adrian Grange's avatar
Adrian Grange committed
115 116 117 118
/*!\brief VP9 specific reference frame data struct
 *
 * Define the data struct to access vp9 reference frames.
 */
John Koleszar's avatar
John Koleszar committed
119
typedef struct vp9_ref_frame {
clang-format's avatar
clang-format committed
120 121
  int idx;         /**< frame index to get (input) */
  vpx_image_t img; /**< img structure to populate (output) */
John Koleszar's avatar
John Koleszar committed
122
} vp9_ref_frame_t;
John Koleszar's avatar
John Koleszar committed
123

124
/*!\cond */
James Zern's avatar
James Zern committed
125
/*!\brief vp8 decoder control function parameter type
John Koleszar's avatar
John Koleszar committed
126
 *
127
 * defines the data type for each of VP8 decoder control function requires
John Koleszar's avatar
John Koleszar committed
128
 */
clang-format's avatar
clang-format committed
129
VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *)
130
#define VPX_CTRL_VP8_SET_REFERENCE
clang-format's avatar
clang-format committed
131
VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *)
132
#define VPX_CTRL_VP8_COPY_REFERENCE
clang-format's avatar
clang-format committed
133
VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *)
134
#define VPX_CTRL_VP8_SET_POSTPROC
135
VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_REF_FRAME, int)
136
#define VPX_CTRL_VP8_SET_DBG_COLOR_REF_FRAME
clang-format's avatar
clang-format committed
137
VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_MB_MODES, int)
138
#define VPX_CTRL_VP8_SET_DBG_COLOR_MB_MODES
clang-format's avatar
clang-format committed
139
VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_B_MODES, int)
140
#define VPX_CTRL_VP8_SET_DBG_COLOR_B_MODES
clang-format's avatar
clang-format committed
141
VPX_CTRL_USE_TYPE(VP8_SET_DBG_DISPLAY_MV, int)
142
#define VPX_CTRL_VP8_SET_DBG_DISPLAY_MV
clang-format's avatar
clang-format committed
143
VPX_CTRL_USE_TYPE(VP9_GET_REFERENCE, vp9_ref_frame_t *)
144
#define VPX_CTRL_VP9_GET_REFERENCE
John Koleszar's avatar
John Koleszar committed
145

146
/*!\endcond */
John Koleszar's avatar
John Koleszar committed
147 148
/*! @} - end defgroup vp8 */

149 150 151 152
#ifdef __cplusplus
}  // extern "C"
#endif

James Zern's avatar
James Zern committed
153
#endif  // VPX_VP8_H_