avutil: fix project name reference in doxy section
[ffmpeg.git] / libavutil / avutil.h
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
21 #ifndef AVUTIL_AVUTIL_H
22 #define AVUTIL_AVUTIL_H
23
24 /**
25  * @file
26  * external API header
27  */
28
29 /*
30  * @mainpage
31  *
32  * @section ffmpeg_intro Introduction
33  *
34  * This document describes the usage of the different libraries
35  * provided by FFmpeg.
36  *
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
44  */
45
46 /**
47  * @defgroup lavu Common utility functions
48  *
49  * @brief
50  * libavutil contains the code shared across all the other FFmpeg
51  * libraries
52  *
53  * @note In order to use the functions provided by avutil you must include
54  * the specific header.
55  *
56  * @{
57  *
58  * @defgroup lavu_crypto Crypto and Hashing
59  *
60  * @{
61  * @}
62  *
63  * @defgroup lavu_math Maths
64  * @{
65  *
66  * @}
67  *
68  * @defgroup lavu_string String Manipulation
69  *
70  * @{
71  *
72  * @}
73  *
74  * @defgroup lavu_mem Memory Management
75  *
76  * @{
77  *
78  * @}
79  *
80  * @defgroup lavu_data Data Structures
81  * @{
82  *
83  * @}
84  *
85  * @defgroup lavu_audio Audio related
86  *
87  * @{
88  *
89  * @}
90  *
91  * @defgroup lavu_error Error Codes
92  *
93  * @{
94  *
95  * @}
96  *
97  * @defgroup lavu_misc Other
98  *
99  * @{
100  *
101  * @defgroup lavu_internal Internal
102  *
103  * Not exported functions, for internal usage only
104  *
105  * @{
106  *
107  * @}
108  */
109
110
111 /**
112  * @defgroup preproc_misc Preprocessor String Macros
113  *
114  * String manipulation macros
115  *
116  * @{
117  */
118
119 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
120 #define AV_TOSTRING(s) #s
121
122 #define AV_GLUE(a, b) a ## b
123 #define AV_JOIN(a, b) AV_GLUE(a, b)
124
125 #define AV_PRAGMA(s) _Pragma(#s)
126
127 /**
128  * @}
129  */
130
131 /**
132  * @defgroup version_utils Library Version Macros
133  *
134  * Useful to check and match library version in order to maintain
135  * backward compatibility.
136  *
137  * @{
138  */
139
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)
143
144 #include "libavutil/version.h"
145
146
147 /**
148  * @}
149  *
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.
153  *
154  * They are used mostly internally to mark code that will be removed
155  * on the next major version.
156  *
157  * @{
158  */
159 #ifndef FF_API_OLD_EVAL_NAMES
160 #define FF_API_OLD_EVAL_NAMES (LIBAVUTIL_VERSION_MAJOR < 52)
161 #endif
162 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
163 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
164 #endif
165 #ifndef FF_API_FIND_OPT
166 #define FF_API_FIND_OPT                 (LIBAVUTIL_VERSION_MAJOR < 52)
167 #endif
168 #ifndef FF_API_AV_FIFO_PEEK
169 #define FF_API_AV_FIFO_PEEK             (LIBAVUTIL_VERSION_MAJOR < 52)
170 #endif
171 #ifndef FF_API_OLD_AVOPTIONS
172 #define FF_API_OLD_AVOPTIONS            (LIBAVUTIL_VERSION_MAJOR < 52)
173 #endif
174
175 /**
176  * @}
177  */
178
179 /**
180  * @addtogroup lavu_ver
181  * @{
182  */
183
184 /**
185  * Return the LIBAVUTIL_VERSION_INT constant.
186  */
187 unsigned avutil_version(void);
188
189 /**
190  * Return the libavutil build-time configuration.
191  */
192 const char *avutil_configuration(void);
193
194 /**
195  * Return the libavutil license.
196  */
197 const char *avutil_license(void);
198
199 /**
200  * @}
201  */
202
203 /**
204  * @addtogroup lavu_media Media Type
205  * @brief Media Type
206  */
207
208 enum AVMediaType {
209     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
210     AVMEDIA_TYPE_VIDEO,
211     AVMEDIA_TYPE_AUDIO,
212     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
213     AVMEDIA_TYPE_SUBTITLE,
214     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
215     AVMEDIA_TYPE_NB
216 };
217
218 /**
219  * Return a string describing the media_type enum, NULL if media_type
220  * is unknown.
221  */
222 const char *av_get_media_type_string(enum AVMediaType media_type);
223
224 /**
225  * @defgroup lavu_const Constants
226  * @{
227  *
228  * @defgroup lavu_enc Encoding specific
229  *
230  * @note those definition should move to avcodec
231  * @{
232  */
233
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)
238
239 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
240
241 /**
242  * @}
243  * @defgroup lavu_time Timestamp specific
244  *
245  * FFmpeg internal timebase and timestamp definitions
246  *
247  * @{
248  */
249
250 /**
251  * @brief Undefined timestamp value
252  *
253  * Usually reported by demuxer that work on containers that do not provide
254  * either pts or dts.
255  */
256
257 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
258
259 /**
260  * Internal time base represented as integer
261  */
262
263 #define AV_TIME_BASE            1000000
264
265 /**
266  * Internal time base represented as fractional value
267  */
268
269 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
270
271 /**
272  * @}
273  * @}
274  * @defgroup lavu_picture Image related
275  *
276  * AVPicture types, pixel formats and basic image planes manipulation.
277  *
278  * @{
279  */
280
281 enum AVPictureType {
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
290 };
291
292 /**
293  * Return a single letter to describe the given picture type
294  * pict_type.
295  *
296  * @param[in] pict_type the picture type @return a single character
297  * representing the picture type, '?' if pict_type is unknown
298  */
299 char av_get_picture_type_char(enum AVPictureType pict_type);
300
301 /**
302  * @}
303  */
304
305 #include "common.h"
306 #include "error.h"
307 #include "mathematics.h"
308 #include "rational.h"
309 #include "intfloat_readwrite.h"
310 #include "log.h"
311 #include "pixfmt.h"
312
313 /**
314  * Return x default pointer in case p is NULL.
315  */
316 static inline void *av_x_if_null(const void *p, const void *x)
317 {
318     return (void *)(intptr_t)(p ? p : x);
319 }
320
321 /**
322  * @}
323  * @}
324  */
325
326 #endif /* AVUTIL_AVUTIL_H */