Group algorithm interfaces to avoid undocumented warning from doxygen and provide basic documentation for CQ level & cpuused.
Unified · Split
| @@ -24,13 +24,15 @@ · 23 unmodified lines | ||
| 24 | 24 | #define VP8CX_H |
| 25 | 25 | #include "vpx/vpx_codec_impl_top.h" |
| 26 | 26 | |
| 27 | −/*!\brief Algorithm interface for VP8 | |
| 27 | +/*!\name Algorithm interface for VP8 | |
| 28 | 28 | * |
| 29 | 29 | * This interface provides the capability to encode raw VP8 streams, as would |
| 30 | 30 | * be found in AVI files. |
| 31 | + * @{ | |
| 31 | 32 | */ |
| 32 | 33 | extern vpx_codec_iface_t vpx_codec_vp8_cx_algo; |
| 33 | 34 | extern vpx_codec_iface_t* vpx_codec_vp8_cx(void); |
| 35 | +/*!@} - end algorithm interface member group*/ | |
| 34 | 36 | |
| 35 | 37 | |
| 36 | 38 | /* |
| @@ -114,7 +116,10 @@ extern vpx_codec_iface_t* vpx_codec_vp8_cx(void); · 77 unmodified lines | ||
| 114 | 116 | |
| 115 | 117 | /*!\brief VP8 encoder control functions |
| 116 | 118 | * |
| 117 | − * The set of macros define the control functions of VP8 encoder interface | |
| 119 | + * This set of macros define the control functions available for the VP8 | |
| 120 | + * encoder interface. | |
| 121 | + * | |
| 122 | + * \sa #vpx_codec_control | |
| 118 | 123 | */ |
| 119 | 124 | enum vp8e_enc_control_id |
| 120 | 125 | { |
| @@ -124,7 +129,18 @@ enum vp8e_enc_control_id · 3 unmodified lines | ||
| 124 | 129 | VP8E_SET_ROI_MAP, /**< control function to pass an ROI map to encoder */ |
| 125 | 130 | VP8E_SET_ACTIVEMAP, /**< control function to pass an Active map to encoder */ |
| 126 | 131 | VP8E_SET_SCALEMODE = 11, /**< control function to set encoder scaling mode */ |
| 127 | − VP8E_SET_CPUUSED = 13, /**< control function to set vp8 encoder cpuused */ | |
| 132 | + /*!\brief control function to set vp8 encoder cpuused | |
| 133 | + * | |
| 134 | + * Changes in this value influences, among others, the encoder's selection | |
| 135 | + * of motion estimation methods. Values greater than 0 will increase encoder | |
| 136 | + * speed at the expense of quality. | |
| 137 | + * The full set of adjustments can be found in | |
| 138 | + * onyx_if.c:vp8_set_speed_features(). | |
| 139 | + * \todo List highlights of the changes at various levels. | |
| 140 | + * | |
| 141 | + * \note Valid range: -16..16 or {-16..-4, 4..16} w/CONFIG_REALTIME_ONLY | |
| 142 | + */ | |
| 143 | + VP8E_SET_CPUUSED = 13, | |
| 128 | 144 | VP8E_SET_ENABLEAUTOALTREF, /**< control function to enable vp8 to automatic set and use altref frame */ |
| 129 | 145 | VP8E_SET_NOISE_SENSITIVITY, /**< control function to set noise sensitivity */ |
| 130 | 146 | VP8E_SET_SHARPNESS, /**< control function to set sharpness */ |
| @@ -141,7 +157,13 @@ enum vp8e_enc_control_id · 10 unmodified lines | ||
| 141 | 157 | VP8E_SET_ARNR_STRENGTH , /**< control function to set the filter strength for the arf */ |
| 142 | 158 | VP8E_SET_ARNR_TYPE , /**< control function to set the type of filter to use for the arf*/ |
| 143 | 159 | VP8E_SET_TUNING, /**< control function to set visual tuning */ |
| 144 | − VP8E_SET_CQ_LEVEL, /**< control function to set constrained quality level */ | |
| 160 | + /*!\brief control function to set constrained quality level | |
| 161 | + * | |
| 162 | + * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be | |
| 163 | + * set to #VPX_CQ. | |
| 164 | + * \note Valid range: 0..63 | |
| 165 | + */ | |
| 166 | + VP8E_SET_CQ_LEVEL, | |
| 145 | 167 | }; |
| 146 | 168 | |
| 147 | 169 | /*!\brief vpx 1-D scaling mode |
| @@ -24,13 +24,15 @@ · 23 unmodified lines | ||
| 24 | 24 | #define VP8DX_H |
| 25 | 25 | #include "vpx/vpx_codec_impl_top.h" |
| 26 | 26 | |
| 27 | −/*!\brief Algorithm interface for VP8 | |
| 27 | +/*!\name Algorithm interface for VP8 | |
| 28 | 28 | * |
| 29 | 29 | * This interface provides the capability to decode raw VP8 streams, as would |
| 30 | 30 | * be found in AVI files and other non-Flash uses. |
| 31 | + * @{ | |
| 31 | 32 | */ |
| 32 | 33 | extern vpx_codec_iface_t vpx_codec_vp8_dx_algo; |
| 33 | 34 | extern vpx_codec_iface_t* vpx_codec_vp8_dx(void); |
| 35 | +/*!@} - end algorithm interface member group*/ | |
| 34 | 36 | |
| 35 | 37 | /* Include controls common to both the encoder and decoder */ |
| 36 | 38 | #include "vp8.h" |
| @@ -38,7 +40,10 @@ extern vpx_codec_iface_t* vpx_codec_vp8_dx(void); · 1 unmodified line | ||
| 38 | 40 | |
| 39 | 41 | /*!\brief VP8 decoder control functions |
| 40 | 42 | * |
| 41 | − * The set of macros define the control functions of VP8 decoder interface | |
| 43 | + * This set of macros define the control functions available for the VP8 | |
| 44 | + * decoder interface. | |
| 45 | + * | |
| 46 | + * \sa #vpx_codec_control | |
| 42 | 47 | */ |
| 43 | 48 | enum vp8d_dec_control_id |
| 44 | 49 | { |