/media/libvpx/vpx/vp8.h

http://github.com/zpao/v8monkey · C Header · 130 lines · 55 code · 17 blank · 58 comment · 1 complexity · db2c2b53be12eea6a341e066df5e8f86 MD5 · raw file

  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. /*!\defgroup vp8 VP8
  11. * \ingroup codecs
  12. * VP8 is vpx's newest video compression algorithm that uses motion
  13. * compensated prediction, Discrete Cosine Transform (DCT) coding of the
  14. * prediction error signal and context dependent entropy coding techniques
  15. * based on arithmetic principles. It features:
  16. * - YUV 4:2:0 image format
  17. * - Macro-block based coding (16x16 luma plus two 8x8 chroma)
  18. * - 1/4 (1/8) pixel accuracy motion compensated prediction
  19. * - 4x4 DCT transform
  20. * - 128 level linear quantizer
  21. * - In loop deblocking filter
  22. * - Context-based entropy coding
  23. *
  24. * @{
  25. */
  26. /*!\file
  27. * \brief Provides controls common to both the VP8 encoder and decoder.
  28. */
  29. #ifndef VP8_H
  30. #define VP8_H
  31. #include "vpx_codec_impl_top.h"
  32. /*!\brief Control functions
  33. *
  34. * The set of macros define the control functions of VP8 interface
  35. */
  36. enum vp8_com_control_id
  37. {
  38. VP8_SET_REFERENCE = 1, /**< pass in an external frame into decoder to be used as reference frame */
  39. VP8_COPY_REFERENCE = 2, /**< get a copy of reference frame from the decoder */
  40. VP8_SET_POSTPROC = 3, /**< set the decoder's post processing settings */
  41. VP8_SET_DBG_COLOR_REF_FRAME = 4, /**< set the reference frames to color for each macroblock */
  42. VP8_SET_DBG_COLOR_MB_MODES = 5, /**< set which macro block modes to color */
  43. VP8_SET_DBG_COLOR_B_MODES = 6, /**< set which blocks modes to color */
  44. VP8_SET_DBG_DISPLAY_MV = 7, /**< set which motion vector modes to draw */
  45. VP8_COMMON_CTRL_ID_MAX,
  46. VP8_DECODER_CTRL_ID_START = 256
  47. };
  48. /*!\brief post process flags
  49. *
  50. * The set of macros define VP8 decoder post processing flags
  51. */
  52. enum vp8_postproc_level
  53. {
  54. VP8_NOFILTERING = 0,
  55. VP8_DEBLOCK = 1<<0,
  56. VP8_DEMACROBLOCK = 1<<1,
  57. VP8_ADDNOISE = 1<<2,
  58. VP8_DEBUG_TXT_FRAME_INFO = 1<<3, /**< print frame information */
  59. VP8_DEBUG_TXT_MBLK_MODES = 1<<4, /**< print macro block modes over each macro block */
  60. VP8_DEBUG_TXT_DC_DIFF = 1<<5, /**< print dc diff for each macro block */
  61. VP8_DEBUG_TXT_RATE_INFO = 1<<6 /**< print video rate info (encoder only) */
  62. };
  63. /*!\brief post process flags
  64. *
  65. * This define a structure that describe the post processing settings. For
  66. * the best objective measure (using the PSNR metric) set post_proc_flag
  67. * to VP8_DEBLOCK and deblocking_level to 1.
  68. */
  69. typedef struct vp8_postproc_cfg
  70. {
  71. int post_proc_flag; /**< the types of post processing to be done, should be combination of "vp8_postproc_level" */
  72. int deblocking_level; /**< the strength of deblocking, valid range [0, 16] */
  73. int noise_level; /**< the strength of additive noise, valid range [0, 16] */
  74. } vp8_postproc_cfg_t;
  75. /*!\brief reference frame type
  76. *
  77. * The set of macros define the type of VP8 reference frames
  78. */
  79. typedef enum vpx_ref_frame_type
  80. {
  81. VP8_LAST_FRAME = 1,
  82. VP8_GOLD_FRAME = 2,
  83. VP8_ALTR_FRAME = 4
  84. } vpx_ref_frame_type_t;
  85. /*!\brief reference frame data struct
  86. *
  87. * define the data struct to access vp8 reference frames
  88. */
  89. typedef struct vpx_ref_frame
  90. {
  91. vpx_ref_frame_type_t frame_type; /**< which reference frame */
  92. vpx_image_t img; /**< reference frame data in image format */
  93. } vpx_ref_frame_t;
  94. /*!\brief vp8 decoder control function parameter type
  95. *
  96. * defines the data type for each of VP8 decoder control function requires
  97. */
  98. VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *)
  99. VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *)
  100. VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *)
  101. VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_REF_FRAME, int)
  102. VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_MB_MODES, int)
  103. VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_B_MODES, int)
  104. VPX_CTRL_USE_TYPE(VP8_SET_DBG_DISPLAY_MV, int)
  105. /*! @} - end defgroup vp8 */
  106. #if !defined(VPX_CODEC_DISABLE_COMPAT) || !VPX_CODEC_DISABLE_COMPAT
  107. /* The following definitions are provided for backward compatibility with
  108. * the VP8 1.0.x SDK. USE IN PRODUCTION CODE IS NOT RECOMMENDED.
  109. */
  110. DECLSPEC_DEPRECATED extern vpx_codec_iface_t vpx_codec_vp8_algo DEPRECATED;
  111. #endif
  112. #include "vpx_codec_impl_bottom.h"
  113. #endif