log.h 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  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. #ifndef AVUTIL_LOG_H
  21. #define AVUTIL_LOG_H
  22. #include <stdarg.h>
  23. #include "avutil.h"
  24. #include "attributes.h"
  25. typedef enum {
  26. AV_CLASS_CATEGORY_NA = 0,
  27. AV_CLASS_CATEGORY_INPUT,
  28. AV_CLASS_CATEGORY_OUTPUT,
  29. AV_CLASS_CATEGORY_MUXER,
  30. AV_CLASS_CATEGORY_DEMUXER,
  31. AV_CLASS_CATEGORY_ENCODER,
  32. AV_CLASS_CATEGORY_DECODER,
  33. AV_CLASS_CATEGORY_FILTER,
  34. AV_CLASS_CATEGORY_BITSTREAM_FILTER,
  35. AV_CLASS_CATEGORY_SWSCALER,
  36. AV_CLASS_CATEGORY_SWRESAMPLER,
  37. AV_CLASS_CATEGORY_NB, ///< not part of ABI/API
  38. } AVClassCategory;
  39. struct AVOptionRanges;
  40. /**
  41. * Describe the class of an AVClass context structure. That is an
  42. * arbitrary struct of which the first field is a pointer to an
  43. * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
  44. */
  45. typedef struct AVClass {
  46. /**
  47. * The name of the class; usually it is the same name as the
  48. * context structure type to which the AVClass is associated.
  49. */
  50. const char* class_name;
  51. /**
  52. * A pointer to a function which returns the name of a context
  53. * instance ctx associated with the class.
  54. */
  55. const char* (*item_name)(void* ctx);
  56. /**
  57. * a pointer to the first option specified in the class if any or NULL
  58. *
  59. * @see av_set_default_options()
  60. */
  61. const struct AVOption *option;
  62. /**
  63. * LIBAVUTIL_VERSION with which this structure was created.
  64. * This is used to allow fields to be added without requiring major
  65. * version bumps everywhere.
  66. */
  67. int version;
  68. /**
  69. * Offset in the structure where log_level_offset is stored.
  70. * 0 means there is no such variable
  71. */
  72. int log_level_offset_offset;
  73. /**
  74. * Offset in the structure where a pointer to the parent context for
  75. * logging is stored. For example a decoder could pass its AVCodecContext
  76. * to eval as such a parent context, which an av_log() implementation
  77. * could then leverage to display the parent context.
  78. * The offset can be NULL.
  79. */
  80. int parent_log_context_offset;
  81. /**
  82. * Return next AVOptions-enabled child or NULL
  83. */
  84. void* (*child_next)(void *obj, void *prev);
  85. /**
  86. * Return an AVClass corresponding to the next potential
  87. * AVOptions-enabled child.
  88. *
  89. * The difference between child_next and this is that
  90. * child_next iterates over _already existing_ objects, while
  91. * child_class_next iterates over _all possible_ children.
  92. */
  93. const struct AVClass* (*child_class_next)(const struct AVClass *prev);
  94. /**
  95. * Category used for visualization (like color)
  96. * This is only set if the category is equal for all objects using this class.
  97. * available since version (51 << 16 | 56 << 8 | 100)
  98. */
  99. AVClassCategory category;
  100. /**
  101. * Callback to return the category.
  102. * available since version (51 << 16 | 59 << 8 | 100)
  103. */
  104. AVClassCategory (*get_category)(void* ctx);
  105. /**
  106. * Callback to return the supported/allowed ranges.
  107. * available since version (52.12)
  108. */
  109. int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
  110. } AVClass;
  111. /* av_log API */
  112. #define AV_LOG_QUIET -8
  113. /**
  114. * Something went really wrong and we will crash now.
  115. */
  116. #define AV_LOG_PANIC 0
  117. /**
  118. * Something went wrong and recovery is not possible.
  119. * For example, no header was found for a format which depends
  120. * on headers or an illegal combination of parameters is used.
  121. */
  122. #define AV_LOG_FATAL 8
  123. /**
  124. * Something went wrong and cannot losslessly be recovered.
  125. * However, not all future data is affected.
  126. */
  127. #define AV_LOG_ERROR 16
  128. /**
  129. * Something somehow does not look correct. This may or may not
  130. * lead to problems. An example would be the use of '-vstrict -2'.
  131. */
  132. #define AV_LOG_WARNING 24
  133. #define AV_LOG_INFO 32
  134. #define AV_LOG_VERBOSE 40
  135. /**
  136. * Stuff which is only useful for libav* developers.
  137. */
  138. #define AV_LOG_DEBUG 48
  139. #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
  140. /**
  141. * Send the specified message to the log if the level is less than or equal
  142. * to the current av_log_level. By default, all logging messages are sent to
  143. * stderr. This behavior can be altered by setting a different av_vlog callback
  144. * function.
  145. *
  146. * @param avcl A pointer to an arbitrary struct of which the first field is a
  147. * pointer to an AVClass struct.
  148. * @param level The importance level of the message, lower values signifying
  149. * higher importance.
  150. * @param fmt The format string (printf-compatible) that specifies how
  151. * subsequent arguments are converted to output.
  152. * @see av_vlog
  153. */
  154. void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
  155. void av_vlog(void *avcl, int level, const char *fmt, va_list);
  156. int av_log_get_level(void);
  157. void av_log_set_level(int);
  158. void av_log_set_callback(void (*)(void*, int, const char*, va_list));
  159. void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
  160. const char* av_default_item_name(void* ctx);
  161. AVClassCategory av_default_get_category(void *ptr);
  162. /**
  163. * Format a line of log the same way as the default callback.
  164. * @param line buffer to receive the formated line
  165. * @param line_size size of the buffer
  166. * @param print_prefix used to store whether the prefix must be printed;
  167. * must point to a persistent integer initially set to 1
  168. */
  169. void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
  170. char *line, int line_size, int *print_prefix);
  171. /**
  172. * av_dlog macros
  173. * Useful to print debug messages that shouldn't get compiled in normally.
  174. */
  175. #ifdef DEBUG
  176. # define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
  177. #else
  178. # define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
  179. #endif
  180. /**
  181. * Skip repeated messages, this requires the user app to use av_log() instead of
  182. * (f)printf as the 2 would otherwise interfere and lead to
  183. * "Last message repeated x times" messages below (f)printf messages with some
  184. * bad luck.
  185. * Also to receive the last, "last repeated" line if any, the user app must
  186. * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
  187. */
  188. #define AV_LOG_SKIP_REPEATED 1
  189. void av_log_set_flags(int arg);
  190. #endif /* AVUTIL_LOG_H */