Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
F
ffmpeg
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
ffmpeg
Commits
4272bb6e
Commit
4272bb6e
authored
Sep 18, 2013
by
Luca Barbato
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doxy: Document avlog
Provide some information for every function and add a group.
parent
a4435f92
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
104 additions
and
10 deletions
+104
-10
avutil.h
libavutil/avutil.h
+6
-0
log.h
libavutil/log.h
+98
-10
No files found.
libavutil/avutil.h
View file @
4272bb6e
...
...
@@ -127,6 +127,12 @@
*
* @}
*
* @defgroup lavu_log Logging Facility
*
* @{
*
* @}
*
* @defgroup lavu_misc Other
*
* @{
...
...
libavutil/log.h
View file @
4272bb6e
...
...
@@ -89,8 +89,19 @@ typedef struct AVClass {
const
struct
AVClass
*
(
*
child_class_next
)(
const
struct
AVClass
*
prev
);
}
AVClass
;
/* av_log API */
/**
* @addtogroup lavu_log
*
* @{
*
* @defgroup lavu_log_constants Logging Constants
*
* @{
*/
/**
* Print no output.
*/
#define AV_LOG_QUIET -8
/**
...
...
@@ -117,7 +128,14 @@ typedef struct AVClass {
*/
#define AV_LOG_WARNING 24
/**
* Standard information.
*/
#define AV_LOG_INFO 32
/**
* Detailed information.
*/
#define AV_LOG_VERBOSE 40
/**
...
...
@@ -125,27 +143,93 @@ typedef struct AVClass {
*/
#define AV_LOG_DEBUG 48
/**
* @}
*/
/**
* 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_vlo
g callback
* stderr. This behavior can be altered by setting a different
loggin
g 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
);
/**
...
...
@@ -170,4 +254,8 @@ const char* av_default_item_name(void* ctx);
#define AV_LOG_SKIP_REPEATED 1
void
av_log_set_flags
(
int
arg
);
/**
* @}
*/
#endif
/* AVUTIL_LOG_H */
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment