generic-library/vpx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge changes I33c72799,I3ee8974a,I38a42ed1,Iaad3dc3c into nextgen

Browse Source 
* changes:
  usage.dox: fix doxygen warnings in 1.8.x
  Fix doxygen warning with usage.dox
  Remove obsolete doxygen tags
  Fix comments for doxygen
This commit is contained in:
Yaowu Xu 2015-04-28 21:16:10 +00:00 committed by Gerrit Code Review
commit 5652851391
3 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
libs.doxy_template
View File

@ -415,12 +415,6 @@ MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from the
# version control system). Doxygen will invoke the program by executing (via
@ -715,12 +709,6 @@ HTML_FOOTER =
HTML_STYLESHEET =
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)

11
usage.dox
View File

@ -80,10 +80,13 @@
The available initialization methods are:
\if encoder - #vpx_codec_enc_init (calls vpx_codec_enc_init_ver()) \endif
\if multi-encoder - #vpx_codec_enc_init_multi (calls vpx_codec_enc_init_multi_ver()) \endif
\if decoder - #vpx_codec_dec_init (calls vpx_codec_dec_init_ver()) \endif
\if encoder
\li #vpx_codec_enc_init (calls vpx_codec_enc_init_ver())
\li #vpx_codec_enc_init_multi (calls vpx_codec_enc_init_multi_ver())
\endif
\if decoder
\li #vpx_codec_dec_init (calls vpx_codec_dec_init_ver())
\endif
\section usage_errors Error Handling

24
vpx/vpx_encoder.h
View File

@ -220,6 +220,22 @@ extern "C" {
} vpx_codec_cx_pkt_t; /**< alias for struct vpx_codec_cx_pkt */
/*!\brief Encoder return output buffer callback
*
* This callback function, when registered, returns with packets when each
* spatial layer is encoded.
*/
// putting the definitions here for now. (agrange: find if there
// is a better place for this)
typedef void (* vpx_codec_enc_output_cx_pkt_cb_fn_t)(vpx_codec_cx_pkt_t *pkt,
void *user_data);
/*!\brief Callback function pointer / user data pair storage */
typedef struct vpx_codec_enc_output_cx_cb_pair {
vpx_codec_enc_output_cx_pkt_cb_fn_t output_cx_pkt; /**< Callback function */
void *user_priv; /**< Pointer to private data */
} vpx_codec_priv_output_cx_pkt_cb_pair_t;
/*!\brief Rational Number
*
* This structure holds a fractional value.
@ -721,10 +737,10 @@ extern "C" {
*
*/
typedef struct vpx_svc_parameters {
int max_quantizers[VPX_SS_MAX_LAYERS];
int min_quantizers[VPX_SS_MAX_LAYERS];
int scaling_factor_num[VPX_SS_MAX_LAYERS];
int scaling_factor_den[VPX_SS_MAX_LAYERS];
int max_quantizers[VPX_SS_MAX_LAYERS]; /**< Max Q for each layer */
int min_quantizers[VPX_SS_MAX_LAYERS]; /**< Min Q for each layer */
int scaling_factor_num[VPX_SS_MAX_LAYERS]; /**< Scaling factor-numerator*/
int scaling_factor_den[VPX_SS_MAX_LAYERS]; /**< Scaling factor-denominator*/
} vpx_svc_extra_cfg_t;