git.sesse.net Git - ffmpeg/blob - libavutil/log.h

   1 /*
   2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVUTIL_LOG_H
  22 #define AVUTIL_LOG_H
  23
  24 #include <stdarg.h>
  25 #include "avutil.h"
  26 #include "attributes.h"
  27 #include "version.h"
  28
  29 typedef enum {
  30     AV_CLASS_CATEGORY_NA = 0,
  31     AV_CLASS_CATEGORY_INPUT,
  32     AV_CLASS_CATEGORY_OUTPUT,
  33     AV_CLASS_CATEGORY_MUXER,
  34     AV_CLASS_CATEGORY_DEMUXER,
  35     AV_CLASS_CATEGORY_ENCODER,
  36     AV_CLASS_CATEGORY_DECODER,
  37     AV_CLASS_CATEGORY_FILTER,
  38     AV_CLASS_CATEGORY_BITSTREAM_FILTER,
  39     AV_CLASS_CATEGORY_SWSCALER,
  40     AV_CLASS_CATEGORY_SWRESAMPLER,
  41     AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT = 40,
  42     AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
  43     AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT,
  44     AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT,
  45     AV_CLASS_CATEGORY_DEVICE_OUTPUT,
  46     AV_CLASS_CATEGORY_DEVICE_INPUT,
  47     AV_CLASS_CATEGORY_NB  ///< not part of ABI/API
  48 }AVClassCategory;
  49
  50 #define AV_IS_INPUT_DEVICE(category) \
  51     (((category) == AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT) || \
  52      ((category) == AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT) || \
  53      ((category) == AV_CLASS_CATEGORY_DEVICE_INPUT))
  54
  55 #define AV_IS_OUTPUT_DEVICE(category) \
  56     (((category) == AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT) || \
  57      ((category) == AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT) || \
  58      ((category) == AV_CLASS_CATEGORY_DEVICE_OUTPUT))
  59
  60 struct AVOptionRanges;
  61
  62 /**
  63  * Describe the class of an AVClass context structure. That is an
  64  * arbitrary struct of which the first field is a pointer to an
  65  * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
  66  */
  67 typedef struct AVClass {
  68     /**
  69      * The name of the class; usually it is the same name as the
  70      * context structure type to which the AVClass is associated.
  71      */
  72     const char* class_name;
  73
  74     /**
  75      * A pointer to a function which returns the name of a context
  76      * instance ctx associated with the class.
  77      */
  78     const char* (*item_name)(void* ctx);
  79
  80     /**
  81      * a pointer to the first option specified in the class if any or NULL
  82      *
  83      * @see av_set_default_options()
  84      */
  85     const struct AVOption *option;
  86
  87     /**
  88      * LIBAVUTIL_VERSION with which this structure was created.
  89      * This is used to allow fields to be added without requiring major
  90      * version bumps everywhere.
  91      */
  92
  93     int version;
  94
  95     /**
  96      * Offset in the structure where log_level_offset is stored.
  97      * 0 means there is no such variable
  98      */
  99     int log_level_offset_offset;
 100
 101     /**
 102      * Offset in the structure where a pointer to the parent context for
 103      * logging is stored. For example a decoder could pass its AVCodecContext
 104      * to eval as such a parent context, which an av_log() implementation
 105      * could then leverage to display the parent context.
 106      * The offset can be NULL.
 107      */
 108     int parent_log_context_offset;
 109
 110     /**
 111      * Return next AVOptions-enabled child or NULL
 112      */
 113     void* (*child_next)(void *obj, void *prev);
 114
 115     /**
 116      * Category used for visualization (like color)
 117      * This is only set if the category is equal for all objects using this class.
 118      * available since version (51 << 16 | 56 << 8 | 100)
 119      */
 120     AVClassCategory category;
 121
 122     /**
 123      * Callback to return the category.
 124      * available since version (51 << 16 | 59 << 8 | 100)
 125      */
 126     AVClassCategory (*get_category)(void* ctx);
 127
 128     /**
 129      * Callback to return the supported/allowed ranges.
 130      * available since version (52.12)
 131      */
 132     int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
 133
 134     /**
 135      * Iterate over the AVClasses corresponding to potential AVOptions-enabled
 136      * children.
 137      *
 138      * @param iter pointer to opaque iteration state. The caller must initialize
 139      *             *iter to NULL before the first call.
 140      * @return AVClass for the next AVOptions-enabled child or NULL if there are
 141      *         no more such children.
 142      *
 143      * @note The difference between child_next and this is that child_next
 144      *       iterates over _already existing_ objects, while child_class_iterate
 145      *       iterates over _all possible_ children.
 146      */
 147     const struct AVClass* (*child_class_iterate)(void **iter);
 148 } AVClass;
 149
 150 /**
 151  * @addtogroup lavu_log
 152  *
 153  * @{
 154  *
 155  * @defgroup lavu_log_constants Logging Constants
 156  *
 157  * @{
 158  */
 159
 160 /**
 161  * Print no output.
 162  */
 163 #define AV_LOG_QUIET    -8
 164
 165 /**
 166  * Something went really wrong and we will crash now.
 167  */
 168 #define AV_LOG_PANIC     0
 169
 170 /**
 171  * Something went wrong and recovery is not possible.
 172  * For example, no header was found for a format which depends
 173  * on headers or an illegal combination of parameters is used.
 174  */
 175 #define AV_LOG_FATAL     8
 176
 177 /**
 178  * Something went wrong and cannot losslessly be recovered.
 179  * However, not all future data is affected.
 180  */
 181 #define AV_LOG_ERROR    16
 182
 183 /**
 184  * Something somehow does not look correct. This may or may not
 185  * lead to problems. An example would be the use of '-vstrict -2'.
 186  */
 187 #define AV_LOG_WARNING  24
 188
 189 /**
 190  * Standard information.
 191  */
 192 #define AV_LOG_INFO     32
 193
 194 /**
 195  * Detailed information.
 196  */
 197 #define AV_LOG_VERBOSE  40
 198
 199 /**
 200  * Stuff which is only useful for libav* developers.
 201  */
 202 #define AV_LOG_DEBUG    48
 203
 204 /**
 205  * Extremely verbose debugging, useful for libav* development.
 206  */
 207 #define AV_LOG_TRACE    56
 208
 209 #define AV_LOG_MAX_OFFSET (AV_LOG_TRACE - AV_LOG_QUIET)
 210
 211 /**
 212  * @}
 213  */
 214
 215 /**
 216  * Sets additional colors for extended debugging sessions.
 217  * @code
 218    av_log(ctx, AV_LOG_DEBUG|AV_LOG_C(134), "Message in purple\n");
 219    @endcode
 220  * Requires 256color terminal support. Uses outside debugging is not
 221  * recommended.
 222  */
 223 #define AV_LOG_C(x) ((x) << 8)
 224
 225 /**
 226  * Send the specified message to the log if the level is less than or equal
 227  * to the current av_log_level. By default, all logging messages are sent to
 228  * stderr. This behavior can be altered by setting a different logging callback
 229  * function.
 230  * @see av_log_set_callback
 231  *
 232  * @param avcl A pointer to an arbitrary struct of which the first field is a
 233  *        pointer to an AVClass struct or NULL if general log.
 234  * @param level The importance level of the message expressed using a @ref
 235  *        lavu_log_constants "Logging Constant".
 236  * @param fmt The format string (printf-compatible) that specifies how
 237  *        subsequent arguments are converted to output.
 238  */
 239 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
 240
 241 /**
 242  * Send the specified message to the log once with the initial_level and then with
 243  * the subsequent_level. By default, all logging messages are sent to
 244  * stderr. This behavior can be altered by setting a different logging callback
 245  * function.
 246  * @see av_log
 247  *
 248  * @param avcl A pointer to an arbitrary struct of which the first field is a
 249  *        pointer to an AVClass struct or NULL if general log.
 250  * @param initial_level importance level of the message expressed using a @ref
 251  *        lavu_log_constants "Logging Constant" for the first occurance.
 252  * @param subsequent_level importance level of the message expressed using a @ref
 253  *        lavu_log_constants "Logging Constant" after the first occurance.
 254  * @param fmt The format string (printf-compatible) that specifies how
 255  *        subsequent arguments are converted to output.
 256  * @param state a variable to keep trak of if a message has already been printed
 257  *        this must be initialized to 0 before the first use. The same state
 258  *        must not be accessed by 2 Threads simultaneously.
 259  */
 260 void av_log_once(void* avcl, int initial_level, int subsequent_level, int *state, const char *fmt, ...) av_printf_format(5, 6);
 261
 262
 263 /**
 264  * Send the specified message to the log if the level is less than or equal
 265  * to the current av_log_level. By default, all logging messages are sent to
 266  * stderr. This behavior can be altered by setting a different logging callback
 267  * function.
 268  * @see av_log_set_callback
 269  *
 270  * @param avcl A pointer to an arbitrary struct of which the first field is a
 271  *        pointer to an AVClass struct.
 272  * @param level The importance level of the message expressed using a @ref
 273  *        lavu_log_constants "Logging Constant".
 274  * @param fmt The format string (printf-compatible) that specifies how
 275  *        subsequent arguments are converted to output.
 276  * @param vl The arguments referenced by the format string.
 277  */
 278 void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
 279
 280 /**
 281  * Get the current log level
 282  *
 283  * @see lavu_log_constants
 284  *
 285  * @return Current log level
 286  */
 287 int av_log_get_level(void);
 288
 289 /**
 290  * Set the log level
 291  *
 292  * @see lavu_log_constants
 293  *
 294  * @param level Logging level
 295  */
 296 void av_log_set_level(int level);
 297
 298 /**
 299  * Set the logging callback
 300  *
 301  * @note The callback must be thread safe, even if the application does not use
 302  *       threads itself as some codecs are multithreaded.
 303  *
 304  * @see av_log_default_callback
 305  *
 306  * @param callback A logging function with a compatible signature.
 307  */
 308 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
 309
 310 /**
 311  * Default logging callback
 312  *
 313  * It prints the message to stderr, optionally colorizing it.
 314  *
 315  * @param avcl A pointer to an arbitrary struct of which the first field is a
 316  *        pointer to an AVClass struct.
 317  * @param level The importance level of the message expressed using a @ref
 318  *        lavu_log_constants "Logging Constant".
 319  * @param fmt The format string (printf-compatible) that specifies how
 320  *        subsequent arguments are converted to output.
 321  * @param vl The arguments referenced by the format string.
 322  */
 323 void av_log_default_callback(void *avcl, int level, const char *fmt,
 324                              va_list vl);
 325
 326 /**
 327  * Return the context name
 328  *
 329  * @param  ctx The AVClass context
 330  *
 331  * @return The AVClass class_name
 332  */
 333 const char* av_default_item_name(void* ctx);
 334 AVClassCategory av_default_get_category(void *ptr);
 335
 336 /**
 337  * Format a line of log the same way as the default callback.
 338  * @param line          buffer to receive the formatted line
 339  * @param line_size     size of the buffer
 340  * @param print_prefix  used to store whether the prefix must be printed;
 341  *                      must point to a persistent integer initially set to 1
 342  */
 343 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 344                         char *line, int line_size, int *print_prefix);
 345
 346 /**
 347  * Format a line of log the same way as the default callback.
 348  * @param line          buffer to receive the formatted line;
 349  *                      may be NULL if line_size is 0
 350  * @param line_size     size of the buffer; at most line_size-1 characters will
 351  *                      be written to the buffer, plus one null terminator
 352  * @param print_prefix  used to store whether the prefix must be printed;
 353  *                      must point to a persistent integer initially set to 1
 354  * @return Returns a negative value if an error occurred, otherwise returns
 355  *         the number of characters that would have been written for a
 356  *         sufficiently large buffer, not including the terminating null
 357  *         character. If the return value is not less than line_size, it means
 358  *         that the log message was truncated to fit the buffer.
 359  */
 360 int av_log_format_line2(void *ptr, int level, const char *fmt, va_list vl,
 361                         char *line, int line_size, int *print_prefix);
 362
 363 /**
 364  * Skip repeated messages, this requires the user app to use av_log() instead of
 365  * (f)printf as the 2 would otherwise interfere and lead to
 366  * "Last message repeated x times" messages below (f)printf messages with some
 367  * bad luck.
 368  * Also to receive the last, "last repeated" line if any, the user app must
 369  * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
 370  */
 371 #define AV_LOG_SKIP_REPEATED 1
 372
 373 /**
 374  * Include the log severity in messages originating from codecs.
 375  *
 376  * Results in messages such as:
 377  * [rawvideo @ 0xDEADBEEF] [error] encode did not produce valid pts
 378  */
 379 #define AV_LOG_PRINT_LEVEL 2
 380
 381 void av_log_set_flags(int arg);
 382 int av_log_get_flags(void);
 383
 384 /**
 385  * @}
 386  */
 387
 388 #endif /* AVUTIL_LOG_H */