Merge remote-tracking branch 'qatar/master'
[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 libav_intro Introduction
33  *
34  * This document describe the usage of the different libraries
35  * provided by Libav.
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 lavu "libavutil" common utility library
41  * @li @subpage libpostproc post processing library
42  * @li @subpage libswscale  color conversion and scaling library
43  *
44  */
45
46 /**
47  * @defgroup lavu Common utility functions
48  *
49  * @brief
50  * libavutil contains the code shared across all the other Libav
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 /**
145  * @}
146  *
147  * @defgroup lavu_ver Version and Build diagnostics
148  *
149  * Macros and function useful to check at compiletime and at runtime
150  * which version of libavutil is in use.
151  *
152  * @{
153  */
154
155 #define LIBAVUTIL_VERSION_MAJOR 51
156 #define LIBAVUTIL_VERSION_MINOR 26
157 #define LIBAVUTIL_VERSION_MICRO  0
158
159 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
160                                                LIBAVUTIL_VERSION_MINOR, \
161                                                LIBAVUTIL_VERSION_MICRO)
162 #define LIBAVUTIL_VERSION       AV_VERSION(LIBAVUTIL_VERSION_MAJOR,     \
163                                            LIBAVUTIL_VERSION_MINOR,     \
164                                            LIBAVUTIL_VERSION_MICRO)
165 #define LIBAVUTIL_BUILD         LIBAVUTIL_VERSION_INT
166
167 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
168
169 /**
170  * @}
171  *
172  * @defgroup depr_guards Deprecation guards
173  * Those FF_API_* defines are not part of public API.
174  * They may change, break or disappear at any time.
175  *
176  * They are used mostly internally to mark code that will be removed
177  * on the next major version.
178  *
179  * @{
180  */
181 #ifndef FF_API_OLD_EVAL_NAMES
182 #define FF_API_OLD_EVAL_NAMES (LIBAVUTIL_VERSION_MAJOR < 52)
183 #endif
184 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
185 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
186 #endif
187 #ifndef FF_API_FIND_OPT
188 #define FF_API_FIND_OPT                 (LIBAVUTIL_VERSION_MAJOR < 52)
189 #endif
190 #ifndef FF_API_AV_FIFO_PEEK
191 #define FF_API_AV_FIFO_PEEK             (LIBAVUTIL_VERSION_MAJOR < 52)
192 #endif
193 #ifndef FF_API_OLD_AVOPTIONS
194 #define FF_API_OLD_AVOPTIONS            (LIBAVUTIL_VERSION_MAJOR < 52)
195 #endif
196
197 /**
198  * @}
199  */
200
201 /**
202  * @addtogroup lavu_ver
203  * @{
204  */
205
206 /**
207  * Return the LIBAVUTIL_VERSION_INT constant.
208  */
209 unsigned avutil_version(void);
210
211 /**
212  * Return the libavutil build-time configuration.
213  */
214 const char *avutil_configuration(void);
215
216 /**
217  * Return the libavutil license.
218  */
219 const char *avutil_license(void);
220
221 /**
222  * @}
223  */
224
225 /**
226  * @addtogroup lavu_media Media Type
227  * @brief Media Type
228  */
229
230 enum AVMediaType {
231     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
232     AVMEDIA_TYPE_VIDEO,
233     AVMEDIA_TYPE_AUDIO,
234     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
235     AVMEDIA_TYPE_SUBTITLE,
236     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
237     AVMEDIA_TYPE_NB
238 };
239
240 /**
241  * Return a string describing the media_type enum, NULL if media_type
242  * is unknown.
243  */
244 const char *av_get_media_type_string(enum AVMediaType media_type);
245
246 /**
247  * @defgroup lavu_const Constants
248  * @{
249  *
250  * @defgroup lavu_enc Encoding specific
251  *
252  * @note those definition should move to avcodec
253  * @{
254  */
255
256 #define FF_LAMBDA_SHIFT 7
257 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
258 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
259 #define FF_LAMBDA_MAX (256*128-1)
260
261 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
262
263 /**
264  * @}
265  * @defgroup lavu_time Timestamp specific
266  *
267  * Libav internal timebase and timestamp definitions
268  *
269  * @{
270  */
271
272 /**
273  * @brief Undefined timestamp value
274  *
275  * Usually reported by demuxer that work on containers that do not provide
276  * either pts or dts.
277  */
278
279 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
280
281 /**
282  * Internal time base represented as integer
283  */
284
285 #define AV_TIME_BASE            1000000
286
287 /**
288  * Internal time base represented as fractional value
289  */
290
291 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
292
293 /**
294  * @}
295  * @}
296  * @defgroup lavu_picture Image related
297  *
298  * AVPicture types, pixel formats and basic image planes manipulation.
299  *
300  * @{
301  */
302
303 enum AVPictureType {
304     AV_PICTURE_TYPE_NONE = 0, ///< Undefined
305     AV_PICTURE_TYPE_I,     ///< Intra
306     AV_PICTURE_TYPE_P,     ///< Predicted
307     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
308     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
309     AV_PICTURE_TYPE_SI,    ///< Switching Intra
310     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
311     AV_PICTURE_TYPE_BI,    ///< BI type
312 };
313
314 /**
315  * Return a single letter to describe the given picture type
316  * pict_type.
317  *
318  * @param[in] pict_type the picture type @return a single character
319  * representing the picture type, '?' if pict_type is unknown
320  */
321 char av_get_picture_type_char(enum AVPictureType pict_type);
322
323 /**
324  * @}
325  */
326
327 /**
328  * Return x default pointer in case p is NULL.
329  */
330 static inline const void *av_x_if_null(const void *p, const void *x)
331 {
332     return p ? p : x;
333 }
334
335 #include "common.h"
336 #include "error.h"
337 #include "mathematics.h"
338 #include "rational.h"
339 #include "intfloat_readwrite.h"
340 #include "log.h"
341 #include "pixfmt.h"
342
343 /**
344  * @}
345  * @}
346  */
347
348 #endif /* AVUTIL_AVUTIL_H */