26
26
* external API header
32
* @section libav_intro Introduction
34
* This document describe the usage of the different libraries
37
* @li @ref libavc "libavcodec" encoding/decoding library
38
* @li @subpage libavfilter graph based frame editing library
39
* @li @ref libavf "libavformat" I/O and muxing/demuxing library
40
* @li @ref lavd "libavdevice" special devices muxing/demuxing library
41
* @li @ref lavu "libavutil" common utility library
42
* @li @subpage libpostproc post processing library
43
* @li @subpage libswscale color conversion and scaling library
48
* @defgroup lavu Common utility functions
51
* libavutil contains the code shared across all the other Libav
54
* @note In order to use the functions provided by avutil you must include
55
* the specific header.
59
* @defgroup lavu_crypto Crypto and Hashing
64
* @defgroup lavu_math Maths
69
* @defgroup lavu_string String Manipulation
75
* @defgroup lavu_mem Memory Management
81
* @defgroup lavu_data Data Structures
86
* @defgroup lavu_audio Audio related
92
* @defgroup lavu_error Error Codes
98
* @defgroup lavu_misc Other
102
* @defgroup lavu_internal Internal
104
* Not exported functions, for internal usage only
113
* @defgroup preproc_misc Preprocessor String Macros
115
* String manipulation macros
30
120
#define AV_STRINGIFY(s) AV_TOSTRING(s)
31
121
#define AV_TOSTRING(s) #s
36
126
#define AV_PRAGMA(s) _Pragma(#s)
133
* @defgroup version_utils Library Version Macros
135
* Useful to check and match library version in order to maintain
136
* backward compatibility.
38
141
#define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
39
142
#define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
40
143
#define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
148
* @defgroup lavu_ver Version and Build diagnostics
150
* Macros and function useful to check at compiletime and at runtime
151
* which version of libavutil is in use.
42
156
#define LIBAVUTIL_VERSION_MAJOR 51
43
#define LIBAVUTIL_VERSION_MINOR 7
157
#define LIBAVUTIL_VERSION_MINOR 21
44
158
#define LIBAVUTIL_VERSION_MICRO 0
46
160
#define LIBAVUTIL_VERSION_INT AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
54
168
#define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
173
* @defgroup depr_guards Deprecation guards
57
174
* Those FF_API_* defines are not part of public API.
58
175
* They may change, break or disappear at any time.
177
* They are used mostly internally to mark code that will be removed
178
* on the next major version.
60
182
#ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
61
183
#define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
63
185
#ifndef FF_API_FIND_OPT
64
186
#define FF_API_FIND_OPT (LIBAVUTIL_VERSION_MAJOR < 52)
188
#ifndef FF_API_AV_FIFO_PEEK
189
#define FF_API_AV_FIFO_PEEK (LIBAVUTIL_VERSION_MAJOR < 52)
191
#ifndef FF_API_OLD_AVOPTIONS
192
#define FF_API_OLD_AVOPTIONS (LIBAVUTIL_VERSION_MAJOR < 52)
200
* @addtogroup lavu_ver
68
205
* Return the LIBAVUTIL_VERSION_INT constant.
80
217
const char *avutil_license(void);
224
* @addtogroup lavu_media Media Type
82
228
enum AVMediaType {
83
AVMEDIA_TYPE_UNKNOWN = -1,
229
AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
84
230
AVMEDIA_TYPE_VIDEO,
85
231
AVMEDIA_TYPE_AUDIO,
232
AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
87
233
AVMEDIA_TYPE_SUBTITLE,
88
AVMEDIA_TYPE_ATTACHMENT,
234
AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
239
* @defgroup lavu_const Constants
242
* @defgroup lavu_enc Encoding specific
244
* @note those definition should move to avcodec
92
248
#define FF_LAMBDA_SHIFT 7
93
249
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
94
250
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
97
253
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
257
* @defgroup lavu_time Timestamp specific
259
* Libav internal timebase and timestamp definitions
265
* @brief Undefined timestamp value
267
* Usually reported by demuxer that work on containers that do not provide
99
271
#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
274
* Internal time base represented as integer
100
277
#define AV_TIME_BASE 1000000
280
* Internal time base represented as fractional value
101
283
#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
288
* @defgroup lavu_picture Image related
290
* AVPicture types, pixel formats and basic image planes manipulation.
103
295
enum AVPictureType {
104
296
AV_PICTURE_TYPE_I = 1, ///< Intra
105
297
AV_PICTURE_TYPE_P, ///< Predicted