Merge commit '4272bb6ef1533846a788c259cc498562d0704444'
authorMichael Niedermayer <michaelni@gmx.at>
Sun, 6 Oct 2013 09:15:40 +0000 (11:15 +0200)
committerMichael Niedermayer <michaelni@gmx.at>
Sun, 6 Oct 2013 09:16:15 +0000 (11:16 +0200)
* commit '4272bb6ef1533846a788c259cc498562d0704444':
  doxy: Document avlog

Merged-by: Michael Niedermayer <michaelni@gmx.at>
1  2 
libavutil/avutil.h
libavutil/log.h

Simple merge
diff --cc libavutil/log.h
@@@ -104,29 -87,21 +104,40 @@@ typedef struct AVClass 
       * child_class_next iterates over _all possible_ children.
       */
      const struct AVClass* (*child_class_next)(const struct AVClass *prev);
 +
 +    /**
 +     * Category used for visualization (like color)
 +     * This is only set if the category is equal for all objects using this class.
 +     * available since version (51 << 16 | 56 << 8 | 100)
 +     */
 +    AVClassCategory category;
 +
 +    /**
 +     * Callback to return the category.
 +     * available since version (51 << 16 | 59 << 8 | 100)
 +     */
 +    AVClassCategory (*get_category)(void* ctx);
 +
 +    /**
 +     * Callback to return the supported/allowed ranges.
 +     * available since version (52.12)
 +     */
 +    int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
  } AVClass;
  
- /* av_log API */
+ /**
+  * @addtogroup lavu_log
+  *
+  * @{
+  *
+  * @defgroup lavu_log_constants Logging Constants
+  *
+  * @{
+  */
  
+ /**
+  * Print no output.
+  */
  #define AV_LOG_QUIET    -8
  
  /**
   */
  #define AV_LOG_DEBUG    48
  
 +#define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
 +
  /**
+  * @}
+  */
+ /**
   * Send the specified message to the log if the level is less than or equal
   * to the current av_log_level. By default, all logging messages are sent to
-  * stderr. This behavior can be altered by setting a different av_vlog callback
+  * stderr. This behavior can be altered by setting a different logging callback
   * function.
+  * @see av_log_set_callback
   *
   * @param avcl A pointer to an arbitrary struct of which the first field is a
-  * pointer to an AVClass struct.
-  * @param level The importance level of the message, lower values signifying
-  * higher importance.
+  *        pointer to an AVClass struct.
+  * @param level The importance level of the message expressed using a @ref
+  *        lavu_log_constants "Logging Constant".
   * @param fmt The format string (printf-compatible) that specifies how
-  * subsequent arguments are converted to output.
-  * @see av_vlog
+  *        subsequent arguments are converted to output.
   */
  void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
  
- void av_vlog(void *avcl, int level, const char *fmt, va_list);
+ /**
+  * Send the specified message to the log if the level is less than or equal
+  * to the current av_log_level. By default, all logging messages are sent to
+  * stderr. This behavior can be altered by setting a different logging callback
+  * function.
+  * @see av_log_set_callback
+  *
+  * @param avcl A pointer to an arbitrary struct of which the first field is a
+  *        pointer to an AVClass struct.
+  * @param level The importance level of the message expressed using a @ref
+  *        lavu_log_constants "Logging Constant".
+  * @param fmt The format string (printf-compatible) that specifies how
+  *        subsequent arguments are converted to output.
+  * @param vl The arguments referenced by the format string.
+  */
+ void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
+ /**
+  * Get the current log level
+  *
+  * @see lavu_log_constants
+  *
+  * @return Current log level
+  */
  int av_log_get_level(void);
- void av_log_set_level(int);
- void av_log_set_callback(void (*)(void*, int, const char*, va_list));
+ /**
+  * Set the log level
+  *
+  * @see lavu_log_constants
+  *
+  * @param level Logging level
+  */
+ void av_log_set_level(int level);
+ /**
+  * Set the logging callback
+  *
+  * @see av_log_default_callback
+  *
+  * @param callback A logging function with a compatible signature.
+  */
+ void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
+ /**
+  * Default logging callback
+  *
+  * It prints the message to stderr, optionally colorizing it.
+  *
+  * @param avcl A pointer to an arbitrary struct of which the first field is a
+  *        pointer to an AVClass struct.
+  * @param level The importance level of the message expressed using a @ref
+  *        lavu_log_constants "Logging Constant".
+  * @param fmt The format string (printf-compatible) that specifies how
+  *        subsequent arguments are converted to output.
+  * @param ap The arguments referenced by the format string.
+  */
  void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
+ /**
+  * Return the context name
+  *
+  * @param  ctx The AVClass context
+  *
+  * @return The AVClass class_name
+  */
  const char* av_default_item_name(void* ctx);
 +AVClassCategory av_default_get_category(void *ptr);
 +
 +/**
 + * Format a line of log the same way as the default callback.
 + * @param line          buffer to receive the formated line
 + * @param line_size     size of the buffer
 + * @param print_prefix  used to store whether the prefix must be printed;
 + *                      must point to a persistent integer initially set to 1
 + */
 +void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 +                        char *line, int line_size, int *print_prefix);
  
  /**
   * av_dlog macros