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 libav_intro Introduction
34 * This document describes 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
47 * @defgroup lavu Common utility functions
50 * libavutil contains the code shared across all the other FFmpeg
53 * @note In order to use the functions provided by avutil you must include
54 * the specific header.
58 * @defgroup lavu_crypto Crypto and Hashing
63 * @defgroup lavu_math Maths
68 * @defgroup lavu_string String Manipulation
74 * @defgroup lavu_mem Memory Management
80 * @defgroup lavu_data Data Structures
85 * @defgroup lavu_audio Audio related
91 * @defgroup lavu_error Error Codes
97 * @defgroup lavu_misc Other
101 * @defgroup lavu_internal Internal
103 * Not exported functions, for internal usage only
112 * @defgroup preproc_misc Preprocessor String Macros
114 * String manipulation macros
119 #define AV_STRINGIFY(s) AV_TOSTRING(s)
120 #define AV_TOSTRING(s) #s
122 #define AV_GLUE(a, b) a ## b
123 #define AV_JOIN(a, b) AV_GLUE(a, b)
125 #define AV_PRAGMA(s) _Pragma(#s)
132 * @defgroup version_utils Library Version Macros
134 * Useful to check and match library version in order to maintain
135 * backward compatibility.
140 #define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
141 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
142 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
144 #include "libavutil/version.h"
150 * @defgroup depr_guards Deprecation guards
151 * Those FF_API_* defines are not part of public API.
152 * They may change, break or disappear at any time.
154 * They are used mostly internally to mark code that will be removed
155 * on the next major version.
159 #ifndef FF_API_OLD_EVAL_NAMES
160 #define FF_API_OLD_EVAL_NAMES (LIBAVUTIL_VERSION_MAJOR < 52)
162 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
163 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
165 #ifndef FF_API_FIND_OPT
166 #define FF_API_FIND_OPT (LIBAVUTIL_VERSION_MAJOR < 52)
168 #ifndef FF_API_AV_FIFO_PEEK
169 #define FF_API_AV_FIFO_PEEK (LIBAVUTIL_VERSION_MAJOR < 52)
171 #ifndef FF_API_OLD_AVOPTIONS
172 #define FF_API_OLD_AVOPTIONS (LIBAVUTIL_VERSION_MAJOR < 52)
180 * @addtogroup lavu_ver
185 * Return the LIBAVUTIL_VERSION_INT constant.
187 unsigned avutil_version(void);
190 * Return the libavutil build-time configuration.
192 const char *avutil_configuration(void);
195 * Return the libavutil license.
197 const char *avutil_license(void);
204 * @addtogroup lavu_media Media Type
209 AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
212 AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
213 AVMEDIA_TYPE_SUBTITLE,
214 AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
219 * Return a string describing the media_type enum, NULL if media_type
222 const char *av_get_media_type_string(enum AVMediaType media_type);
225 * @defgroup lavu_const Constants
228 * @defgroup lavu_enc Encoding specific
230 * @note those definition should move to avcodec
234 #define FF_LAMBDA_SHIFT 7
235 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
236 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
237 #define FF_LAMBDA_MAX (256*128-1)
239 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
243 * @defgroup lavu_time Timestamp specific
245 * FFmpeg internal timebase and timestamp definitions
251 * @brief Undefined timestamp value
253 * Usually reported by demuxer that work on containers that do not provide
257 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
260 * Internal time base represented as integer
263 #define AV_TIME_BASE 1000000
266 * Internal time base represented as fractional value
269 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
274 * @defgroup lavu_picture Image related
276 * AVPicture types, pixel formats and basic image planes manipulation.
282 AV_PICTURE_TYPE_NONE = 0, ///< Undefined
283 AV_PICTURE_TYPE_I, ///< Intra
284 AV_PICTURE_TYPE_P, ///< Predicted
285 AV_PICTURE_TYPE_B, ///< Bi-dir predicted
286 AV_PICTURE_TYPE_S, ///< S(GMC)-VOP MPEG4
287 AV_PICTURE_TYPE_SI, ///< Switching Intra
288 AV_PICTURE_TYPE_SP, ///< Switching Predicted
289 AV_PICTURE_TYPE_BI, ///< BI type
293 * Return a single letter to describe the given picture type
296 * @param[in] pict_type the picture type @return a single character
297 * representing the picture type, '?' if pict_type is unknown
299 char av_get_picture_type_char(enum AVPictureType pict_type);
307 #include "mathematics.h"
308 #include "rational.h"
309 #include "intfloat_readwrite.h"
314 * Return x default pointer in case p is NULL.
316 static inline void *av_x_if_null(const void *p, const void *x)
318 return (void *)(intptr_t)(p ? p : x);
326 #endif /* AVUTIL_AVUTIL_H */