vp8.h 5.3 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
John Koleszar's avatar
John Koleszar committed
3
 *
4
5
6
7
8
9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
John Koleszar's avatar
John Koleszar committed
10
11
 */

Adrian Grange's avatar
Adrian Grange committed
12
/*!\defgroup vp8 AOM
John Koleszar's avatar
John Koleszar committed
13
 * \ingroup codecs
Adrian Grange's avatar
Adrian Grange committed
14
 * AOM is aom's newest video compression algorithm that uses motion
John Koleszar's avatar
John Koleszar committed
15
16
 * 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
17
 * based on arithmetic principles. It features:
John Koleszar's avatar
John Koleszar committed
18
19
20
21
22
23
24
25
26
27
 *  - 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
28
/*!\file
Adrian Grange's avatar
Adrian Grange committed
29
 * \brief Provides controls common to both the AOM encoder and decoder.
John Koleszar's avatar
John Koleszar committed
30
 */
Adrian Grange's avatar
Adrian Grange committed
31
32
#ifndef AOM_AOM_H_
#define AOM_AOM_H_
33

Adrian Grange's avatar
Adrian Grange committed
34
35
#include "./aom_codec.h"
#include "./aom_image.h"
Yaowu Xu's avatar
Yaowu Xu committed
36

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

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

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

/*!\brief post process flags
 *
Adrian Grange's avatar
Adrian Grange committed
68
 * The set of macros define AOM decoder post processing flags
John Koleszar's avatar
John Koleszar committed
69
 */
John Koleszar's avatar
John Koleszar committed
70
enum vp8_postproc_level {
Adrian Grange's avatar
Adrian Grange committed
71
72
73
74
75
76
  AOM_NOFILTERING = 0,
  AOM_DEBLOCK = 1 << 0,
  AOM_DEMACROBLOCK = 1 << 1,
  AOM_ADDNOISE = 1 << 2,
  AOM_DEBUG_TXT_FRAME_INFO = 1 << 3, /**< print frame information */
  AOM_DEBUG_TXT_MBLK_MODES =
clang-format's avatar
clang-format committed
77
      1 << 4, /**< print macro block modes over each macro block */
Adrian Grange's avatar
Adrian Grange committed
78
79
80
  AOM_DEBUG_TXT_DC_DIFF = 1 << 5,   /**< print dc diff for each macro block */
  AOM_DEBUG_TXT_RATE_INFO = 1 << 6, /**< print video rate info (encoder only) */
  AOM_MFQE = 1 << 10
John Koleszar's avatar
John Koleszar committed
81
82
83
84
85
};

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

John Koleszar's avatar
John Koleszar committed
90
typedef struct vp8_postproc_cfg {
clang-format's avatar
clang-format committed
91
92
93
94
  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
95
96
97
98
} vp8_postproc_cfg_t;

/*!\brief reference frame type
 *
Adrian Grange's avatar
Adrian Grange committed
99
 * The set of macros define the type of AOM reference frames
John Koleszar's avatar
John Koleszar committed
100
 */
Adrian Grange's avatar
Adrian Grange committed
101
typedef enum aom_ref_frame_type {
Adrian Grange's avatar
Adrian Grange committed
102
103
104
  AOM_LAST_FRAME = 1,
  AOM_GOLD_FRAME = 2,
  AOM_ALTR_FRAME = 4
Adrian Grange's avatar
Adrian Grange committed
105
} aom_ref_frame_type_t;
John Koleszar's avatar
John Koleszar committed
106
107
108

/*!\brief reference frame data struct
 *
Adrian Grange's avatar
Adrian Grange committed
109
 * Define the data struct to access vp8 reference frames.
John Koleszar's avatar
John Koleszar committed
110
 */
Adrian Grange's avatar
Adrian Grange committed
111
112
113
114
typedef struct aom_ref_frame {
  aom_ref_frame_type_t frame_type; /**< which reference frame */
  aom_image_t img;                 /**< reference frame data in image format */
} aom_ref_frame_t;
John Koleszar's avatar
John Koleszar committed
115

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

125
/*!\cond */
James Zern's avatar
James Zern committed
126
/*!\brief vp8 decoder control function parameter type
John Koleszar's avatar
John Koleszar committed
127
 *
Adrian Grange's avatar
Adrian Grange committed
128
 * defines the data type for each of AOM decoder control function requires
John Koleszar's avatar
John Koleszar committed
129
 */
Adrian Grange's avatar
Adrian Grange committed
130
131
132
133
134
135
136
137
138
139
140
141
142
143
AOM_CTRL_USE_TYPE(AOM_SET_REFERENCE, aom_ref_frame_t *)
#define AOM_CTRL_AOM_SET_REFERENCE
AOM_CTRL_USE_TYPE(AOM_COPY_REFERENCE, aom_ref_frame_t *)
#define AOM_CTRL_AOM_COPY_REFERENCE
AOM_CTRL_USE_TYPE(AOM_SET_POSTPROC, vp8_postproc_cfg_t *)
#define AOM_CTRL_AOM_SET_POSTPROC
AOM_CTRL_USE_TYPE(AOM_SET_DBG_COLOR_REF_FRAME, int)
#define AOM_CTRL_AOM_SET_DBG_COLOR_REF_FRAME
AOM_CTRL_USE_TYPE(AOM_SET_DBG_COLOR_MB_MODES, int)
#define AOM_CTRL_AOM_SET_DBG_COLOR_MB_MODES
AOM_CTRL_USE_TYPE(AOM_SET_DBG_COLOR_B_MODES, int)
#define AOM_CTRL_AOM_SET_DBG_COLOR_B_MODES
AOM_CTRL_USE_TYPE(AOM_SET_DBG_DISPLAY_MV, int)
#define AOM_CTRL_AOM_SET_DBG_DISPLAY_MV
Adrian Grange's avatar
Adrian Grange committed
144
145
AOM_CTRL_USE_TYPE(VP9_GET_REFERENCE, vp9_ref_frame_t *)
#define AOM_CTRL_VP9_GET_REFERENCE
John Koleszar's avatar
John Koleszar committed
146

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

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

Adrian Grange's avatar
Adrian Grange committed
154
#endif  // AOM_AOM_H_