2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVUTIL_AVUTIL_H
22 #define AVUTIL_AVUTIL_H
32 * @section ffmpeg_intro Introduction
34 * This document describes the usage of the different libraries
37 * @li @ref libavc "libavcodec" encoding/decoding library
38 * @li @ref lavfi "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 @ref lswr "libswresample" audio resampling, format conversion and mixing
43 * @li @ref lpp "libpostproc" post processing library
44 * @li @ref libsws "libswscale" color conversion and scaling library
46 * @section ffmpeg_versioning Versioning and compatibility
48 * Each of the FFmpeg libraries contains a version.h header, which defines a
49 * major, minor and micro version number with the
50 * <em>LIBRARYNAME_VERSION_{MAJOR,MINOR,MICRO}</em> macros. The major version
51 * number is incremented with backward incompatible changes - e.g. removing
52 * parts of the public API, reordering public struct members, etc. The minor
53 * version number is incremented for backward compatible API changes or major
54 * new features - e.g. adding a new public function or a new decoder. The micro
55 * version number is incremented for smaller changes that a calling program
56 * might still want to check for - e.g. changing behavior in a previously
57 * unspecified situation.
59 * FFmpeg guarantees backward API and ABI compatibility for each library as long
60 * as its major version number is unchanged. This means that no public symbols
61 * will be removed or renamed. Types and names of the public struct members and
62 * values of public macros and enums will remain the same (unless they were
63 * explicitly declared as not part of the public API). Documented behavior will
66 * In other words, any correct program that works with a given FFmpeg snapshot
67 * should work just as well without any changes with any later snapshot with the
68 * same major versions. This applies to both rebuilding the program against new
69 * FFmpeg versions or to replacing the dynamic FFmpeg libraries that a program
72 * However, new public symbols may be added and new members may be appended to
73 * public structs whose size is not part of public ABI (most public structs in
74 * FFmpeg). New macros and enum values may be added. Behavior in undocumented
75 * situations may change slightly (and be documented). All those are accompanied
76 * by an entry in doc/APIchanges and incrementing either the minor or micro
81 * @defgroup lavu Common utility functions
84 * libavutil contains the code shared across all the other FFmpeg
87 * @note In order to use the functions provided by avutil you must include
88 * the specific header.
92 * @defgroup lavu_crypto Crypto and Hashing
97 * @defgroup lavu_math Maths
102 * @defgroup lavu_string String Manipulation
108 * @defgroup lavu_mem Memory Management
114 * @defgroup lavu_data Data Structures
119 * @defgroup lavu_audio Audio related
125 * @defgroup lavu_error Error Codes
131 * @defgroup lavu_log Logging Facility
137 * @defgroup lavu_misc Other
141 * @defgroup lavu_internal Internal
143 * Not exported functions, for internal usage only
149 * @defgroup preproc_misc Preprocessor String Macros
158 * @addtogroup lavu_ver
163 * Return the LIBAVUTIL_VERSION_INT constant.
165 unsigned avutil_version(void);
168 * Return the libavutil build-time configuration.
170 const char *avutil_configuration(void);
173 * Return the libavutil license.
175 const char *avutil_license(void);
182 * @addtogroup lavu_media Media Type
187 AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
190 AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
191 AVMEDIA_TYPE_SUBTITLE,
192 AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
197 * Return a string describing the media_type enum, NULL if media_type
200 const char *av_get_media_type_string(enum AVMediaType media_type);
203 * @defgroup lavu_const Constants
206 * @defgroup lavu_enc Encoding specific
208 * @note those definition should move to avcodec
212 #define FF_LAMBDA_SHIFT 7
213 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
214 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
215 #define FF_LAMBDA_MAX (256*128-1)
217 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
221 * @defgroup lavu_time Timestamp specific
223 * FFmpeg internal timebase and timestamp definitions
229 * @brief Undefined timestamp value
231 * Usually reported by demuxer that work on containers that do not provide
235 #define AV_NOPTS_VALUE ((int64_t)UINT64_C(0x8000000000000000))
238 * Internal time base represented as integer
241 #define AV_TIME_BASE 1000000
244 * Internal time base represented as fractional value
247 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
252 * @defgroup lavu_picture Image related
254 * AVPicture types, pixel formats and basic image planes manipulation.
260 AV_PICTURE_TYPE_NONE = 0, ///< Undefined
261 AV_PICTURE_TYPE_I, ///< Intra
262 AV_PICTURE_TYPE_P, ///< Predicted
263 AV_PICTURE_TYPE_B, ///< Bi-dir predicted
264 AV_PICTURE_TYPE_S, ///< S(GMC)-VOP MPEG4
265 AV_PICTURE_TYPE_SI, ///< Switching Intra
266 AV_PICTURE_TYPE_SP, ///< Switching Predicted
267 AV_PICTURE_TYPE_BI, ///< BI type
271 * Return a single letter to describe the given picture type
274 * @param[in] pict_type the picture type @return a single character
275 * representing the picture type, '?' if pict_type is unknown
277 char av_get_picture_type_char(enum AVPictureType pict_type);
287 #include "mathematics.h"
288 #include "rational.h"
293 * Return x default pointer in case p is NULL.
295 static inline void *av_x_if_null(const void *p, const void *x)
297 return (void *)(intptr_t)(p ? p : x);
301 * Compute the length of an integer list.
303 * @param elsize size in bytes of each list element (only 1, 2, 4 or 8)
304 * @param term list terminator (usually 0 or -1)
305 * @param list pointer to the list
306 * @return length of the list, in elements, not counting the terminator
308 unsigned av_int_list_length_for_size(unsigned elsize,
309 const void *list, uint64_t term) av_pure;
312 * Compute the length of an integer list.
314 * @param term list terminator (usually 0 or -1)
315 * @param list pointer to the list
316 * @return length of the list, in elements, not counting the terminator
318 #define av_int_list_length(list, term) \
319 av_int_list_length_for_size(sizeof(*(list)), list, term)
322 * Open a file using a UTF-8 filename.
323 * The API of this function matches POSIX fopen(), errors are returned through
326 FILE *av_fopen_utf8(const char *path, const char *mode);
333 #endif /* AVUTIL_AVUTIL_H */