media/libvpx/vpx/vp8.h@b8a032363ba2 (annotated)
media/libvpx/vpx/vp8.h
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* |
| michael@0 | 2 | * Copyright (c) 2010 The WebM project authors. All Rights Reserved. |
| michael@0 | 3 | * |
| michael@0 | 4 | * Use of this source code is governed by a BSD-style license |
| michael@0 | 5 | * that can be found in the LICENSE file in the root of the source |
| michael@0 | 6 | * tree. An additional intellectual property rights grant can be found |
| michael@0 | 7 | * in the file PATENTS. All contributing project authors may |
| michael@0 | 8 | * be found in the AUTHORS file in the root of the source tree. |
| michael@0 | 9 | */ |
| michael@0 | 10 | |
| michael@0 | 11 | /*!\defgroup vp8 VP8 |
| michael@0 | 12 | * \ingroup codecs |
| michael@0 | 13 | * VP8 is vpx's newest video compression algorithm that uses motion |
| michael@0 | 14 | * compensated prediction, Discrete Cosine Transform (DCT) coding of the |
| michael@0 | 15 | * prediction error signal and context dependent entropy coding techniques |
| michael@0 | 16 | * based on arithmetic principles. It features: |
| michael@0 | 17 | * - YUV 4:2:0 image format |
| michael@0 | 18 | * - Macro-block based coding (16x16 luma plus two 8x8 chroma) |
| michael@0 | 19 | * - 1/4 (1/8) pixel accuracy motion compensated prediction |
| michael@0 | 20 | * - 4x4 DCT transform |
| michael@0 | 21 | * - 128 level linear quantizer |
| michael@0 | 22 | * - In loop deblocking filter |
| michael@0 | 23 | * - Context-based entropy coding |
| michael@0 | 24 | * |
| michael@0 | 25 | * @{ |
| michael@0 | 26 | */ |
| michael@0 | 27 | /*!\file |
| michael@0 | 28 | * \brief Provides controls common to both the VP8 encoder and decoder. |
| michael@0 | 29 | */ |
| michael@0 | 30 | #ifndef VP8_H |
| michael@0 | 31 | #define VP8_H |
| michael@0 | 32 | |
| michael@0 | 33 | #include "./vpx_codec.h" |
| michael@0 | 34 | #include "./vpx_image.h" |
| michael@0 | 35 | |
| michael@0 | 36 | #ifdef __cplusplus |
| michael@0 | 37 | extern "C" { |
| michael@0 | 38 | #endif |
| michael@0 | 39 | |
| michael@0 | 40 | /*!\brief Control functions |
| michael@0 | 41 | * |
| michael@0 | 42 | * The set of macros define the control functions of VP8 interface |
| michael@0 | 43 | */ |
| michael@0 | 44 | enum vp8_com_control_id { |
| michael@0 | 45 | VP8_SET_REFERENCE = 1, /**< pass in an external frame into decoder to be used as reference frame */ |
| michael@0 | 46 | VP8_COPY_REFERENCE = 2, /**< get a copy of reference frame from the decoder */ |
| michael@0 | 47 | VP8_SET_POSTPROC = 3, /**< set the decoder's post processing settings */ |
| michael@0 | 48 | VP8_SET_DBG_COLOR_REF_FRAME = 4, /**< set the reference frames to color for each macroblock */ |
| michael@0 | 49 | VP8_SET_DBG_COLOR_MB_MODES = 5, /**< set which macro block modes to color */ |
| michael@0 | 50 | VP8_SET_DBG_COLOR_B_MODES = 6, /**< set which blocks modes to color */ |
| michael@0 | 51 | VP8_SET_DBG_DISPLAY_MV = 7, /**< set which motion vector modes to draw */ |
| michael@0 | 52 | |
| michael@0 | 53 | /* TODO(jkoleszar): The encoder incorrectly reuses some of these values (5+) |
| michael@0 | 54 | * for its control ids. These should be migrated to something like the |
| michael@0 | 55 | * VP8_DECODER_CTRL_ID_START range next time we're ready to break the ABI. |
| michael@0 | 56 | */ |
| michael@0 | 57 | VP9_GET_REFERENCE = 128, /**< get a pointer to a reference frame */ |
| michael@0 | 58 | VP8_COMMON_CTRL_ID_MAX, |
| michael@0 | 59 | VP8_DECODER_CTRL_ID_START = 256 |
| michael@0 | 60 | }; |
| michael@0 | 61 | |
| michael@0 | 62 | /*!\brief post process flags |
| michael@0 | 63 | * |
| michael@0 | 64 | * The set of macros define VP8 decoder post processing flags |
| michael@0 | 65 | */ |
| michael@0 | 66 | enum vp8_postproc_level { |
| michael@0 | 67 | VP8_NOFILTERING = 0, |
| michael@0 | 68 | VP8_DEBLOCK = 1 << 0, |
| michael@0 | 69 | VP8_DEMACROBLOCK = 1 << 1, |
| michael@0 | 70 | VP8_ADDNOISE = 1 << 2, |
| michael@0 | 71 | VP8_DEBUG_TXT_FRAME_INFO = 1 << 3, /**< print frame information */ |
| michael@0 | 72 | VP8_DEBUG_TXT_MBLK_MODES = 1 << 4, /**< print macro block modes over each macro block */ |
| michael@0 | 73 | VP8_DEBUG_TXT_DC_DIFF = 1 << 5, /**< print dc diff for each macro block */ |
| michael@0 | 74 | VP8_DEBUG_TXT_RATE_INFO = 1 << 6, /**< print video rate info (encoder only) */ |
| michael@0 | 75 | VP8_MFQE = 1 << 10 |
| michael@0 | 76 | }; |
| michael@0 | 77 | |
| michael@0 | 78 | /*!\brief post process flags |
| michael@0 | 79 | * |
| michael@0 | 80 | * This define a structure that describe the post processing settings. For |
| michael@0 | 81 | * the best objective measure (using the PSNR metric) set post_proc_flag |
| michael@0 | 82 | * to VP8_DEBLOCK and deblocking_level to 1. |
| michael@0 | 83 | */ |
| michael@0 | 84 | |
| michael@0 | 85 | typedef struct vp8_postproc_cfg { |
| michael@0 | 86 | int post_proc_flag; /**< the types of post processing to be done, should be combination of "vp8_postproc_level" */ |
| michael@0 | 87 | int deblocking_level; /**< the strength of deblocking, valid range [0, 16] */ |
| michael@0 | 88 | int noise_level; /**< the strength of additive noise, valid range [0, 16] */ |
| michael@0 | 89 | } vp8_postproc_cfg_t; |
| michael@0 | 90 | |
| michael@0 | 91 | /*!\brief reference frame type |
| michael@0 | 92 | * |
| michael@0 | 93 | * The set of macros define the type of VP8 reference frames |
| michael@0 | 94 | */ |
| michael@0 | 95 | typedef enum vpx_ref_frame_type { |
| michael@0 | 96 | VP8_LAST_FRAME = 1, |
| michael@0 | 97 | VP8_GOLD_FRAME = 2, |
| michael@0 | 98 | VP8_ALTR_FRAME = 4 |
| michael@0 | 99 | } vpx_ref_frame_type_t; |
| michael@0 | 100 | |
| michael@0 | 101 | /*!\brief reference frame data struct |
| michael@0 | 102 | * |
| michael@0 | 103 | * Define the data struct to access vp8 reference frames. |
| michael@0 | 104 | */ |
| michael@0 | 105 | typedef struct vpx_ref_frame { |
| michael@0 | 106 | vpx_ref_frame_type_t frame_type; /**< which reference frame */ |
| michael@0 | 107 | vpx_image_t img; /**< reference frame data in image format */ |
| michael@0 | 108 | } vpx_ref_frame_t; |
| michael@0 | 109 | |
| michael@0 | 110 | /*!\brief VP9 specific reference frame data struct |
| michael@0 | 111 | * |
| michael@0 | 112 | * Define the data struct to access vp9 reference frames. |
| michael@0 | 113 | */ |
| michael@0 | 114 | typedef struct vp9_ref_frame { |
| michael@0 | 115 | int idx; /**< frame index to get (input) */ |
| michael@0 | 116 | vpx_image_t img; /**< img structure to populate (output) */ |
| michael@0 | 117 | } vp9_ref_frame_t; |
| michael@0 | 118 | |
| michael@0 | 119 | /*!\brief vp8 decoder control function parameter type |
| michael@0 | 120 | * |
| michael@0 | 121 | * defines the data type for each of VP8 decoder control function requires |
| michael@0 | 122 | */ |
| michael@0 | 123 | VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *) |
| michael@0 | 124 | VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *) |
| michael@0 | 125 | VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *) |
| michael@0 | 126 | VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_REF_FRAME, int) |
| michael@0 | 127 | VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_MB_MODES, int) |
| michael@0 | 128 | VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_B_MODES, int) |
| michael@0 | 129 | VPX_CTRL_USE_TYPE(VP8_SET_DBG_DISPLAY_MV, int) |
| michael@0 | 130 | VPX_CTRL_USE_TYPE(VP9_GET_REFERENCE, vp9_ref_frame_t *) |
| michael@0 | 131 | |
| michael@0 | 132 | /*! @} - end defgroup vp8 */ |
| michael@0 | 133 | |
| michael@0 | 134 | #ifdef __cplusplus |
| michael@0 | 135 | } // extern "C" |
| michael@0 | 136 | #endif |
| michael@0 | 137 | |
| michael@0 | 138 | #endif |
