History

documentation: minor updates to vp8 (en|de)coder

Group algorithm interfaces to avoid undocumented warning from doxygen and provide basic documentation for CQ level & cpuused.

James Zern committed 15 years ago

Commit 8e17e821 parent d53492b2 files · +33 −6Browse files

Unified · Split

2 files
  1. vpx/vp8cx.h +26 −4
  2. vpx/vp8dx.h +7 −2
vpx/vp8cx.h+26−4
@@ -24,13 +24,15 @@ · 23 unmodified lines
24#define VP8CX_H24#define VP8CX_H
25#include "vpx/vpx_codec_impl_top.h"25#include "vpx/vpx_codec_impl_top.h"
26 26
27/*!\brief Algorithm interface for VP827/*!\name Algorithm interface for VP8
28 *28 *
29 * This interface provides the capability to encode raw VP8 streams, as would29 * This interface provides the capability to encode raw VP8 streams, as would
30 * be found in AVI files.30 * be found in AVI files.
31 * @{
31 */32 */
32extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;33extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
33extern vpx_codec_iface_t* vpx_codec_vp8_cx(void);34extern 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/*!\brief VP8 encoder control functions117/*!\brief VP8 encoder control functions
116 *118 *
117 * The set of macros define the control functions of VP8 encoder interface119 * This set of macros define the control functions available for the VP8
120 * encoder interface.
121 *
122 * \sa #vpx_codec_control
118 */123 */
119enum vp8e_enc_control_id124enum vp8e_enc_control_id
120{125{
@@ -124,7 +129,18 @@ enum vp8e_enc_control_id · 3 unmodified lines
124 VP8E_SET_ROI_MAP, /**< control function to pass an ROI map to encoder */129 VP8E_SET_ROI_MAP, /**< control function to pass an ROI map to encoder */
125 VP8E_SET_ACTIVEMAP, /**< control function to pass an Active map to encoder */130 VP8E_SET_ACTIVEMAP, /**< control function to pass an Active map to encoder */
126 VP8E_SET_SCALEMODE = 11, /**< control function to set encoder scaling mode */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 VP8E_SET_ENABLEAUTOALTREF, /**< control function to enable vp8 to automatic set and use altref frame */144 VP8E_SET_ENABLEAUTOALTREF, /**< control function to enable vp8 to automatic set and use altref frame */
129 VP8E_SET_NOISE_SENSITIVITY, /**< control function to set noise sensitivity */145 VP8E_SET_NOISE_SENSITIVITY, /**< control function to set noise sensitivity */
130 VP8E_SET_SHARPNESS, /**< control function to set sharpness */146 VP8E_SET_SHARPNESS, /**< control function to set sharpness */
@@ -141,7 +157,13 @@ enum vp8e_enc_control_id · 10 unmodified lines
141 VP8E_SET_ARNR_STRENGTH , /**< control function to set the filter strength for the arf */157 VP8E_SET_ARNR_STRENGTH , /**< control function to set the filter strength for the arf */
142 VP8E_SET_ARNR_TYPE , /**< control function to set the type of filter to use for the arf*/158 VP8E_SET_ARNR_TYPE , /**< control function to set the type of filter to use for the arf*/
143 VP8E_SET_TUNING, /**< control function to set visual tuning */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/*!\brief vpx 1-D scaling mode169/*!\brief vpx 1-D scaling mode
vpx/vp8dx.h+7−2
@@ -24,13 +24,15 @@ · 23 unmodified lines
24#define VP8DX_H24#define VP8DX_H
25#include "vpx/vpx_codec_impl_top.h"25#include "vpx/vpx_codec_impl_top.h"
26 26
27/*!\brief Algorithm interface for VP827/*!\name Algorithm interface for VP8
28 *28 *
29 * This interface provides the capability to decode raw VP8 streams, as would29 * This interface provides the capability to decode raw VP8 streams, as would
30 * be found in AVI files and other non-Flash uses.30 * be found in AVI files and other non-Flash uses.
31 * @{
31 */32 */
32extern vpx_codec_iface_t vpx_codec_vp8_dx_algo;33extern vpx_codec_iface_t vpx_codec_vp8_dx_algo;
33extern vpx_codec_iface_t* vpx_codec_vp8_dx(void);34extern vpx_codec_iface_t* vpx_codec_vp8_dx(void);
35/*!@} - end algorithm interface member group*/
34 36
35/* Include controls common to both the encoder and decoder */37/* Include controls common to both the encoder and decoder */
36#include "vp8.h"38#include "vp8.h"
@@ -38,7 +40,10 @@ extern vpx_codec_iface_t* vpx_codec_vp8_dx(void); · 1 unmodified line
38 40
39/*!\brief VP8 decoder control functions41/*!\brief VP8 decoder control functions
40 *42 *
41 * The set of macros define the control functions of VP8 decoder interface43 * This set of macros define the control functions available for the VP8
44 * decoder interface.
45 *
46 * \sa #vpx_codec_control
42 */47 */
43enum vp8d_dec_control_id48enum vp8d_dec_control_id
44{49{

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t