lavu: add timestamp.h header with convenience timestamp utilities
[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 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 /**
48  * @defgroup lavu Common utility functions
49  *
50  * @brief
51  * libavutil contains the code shared across all the other FFmpeg
52  * libraries
53  *
54  * @note In order to use the functions provided by avutil you must include
55  * the specific header.
56  *
57  * @{
58  *
59  * @defgroup lavu_crypto Crypto and Hashing
60  *
61  * @{
62  * @}
63  *
64  * @defgroup lavu_math Maths
65  * @{
66  *
67  * @}
68  *
69  * @defgroup lavu_string String Manipulation
70  *
71  * @{
72  *
73  * @}
74  *
75  * @defgroup lavu_mem Memory Management
76  *
77  * @{
78  *
79  * @}
80  *
81  * @defgroup lavu_data Data Structures
82  * @{
83  *
84  * @}
85  *
86  * @defgroup lavu_audio Audio related
87  *
88  * @{
89  *
90  * @}
91  *
92  * @defgroup lavu_error Error Codes
93  *
94  * @{
95  *
96  * @}
97  *
98  * @defgroup lavu_misc Other
99  *
100  * @{
101  *
102  * @defgroup lavu_internal Internal
103  *
104  * Not exported functions, for internal usage only
105  *
106  * @{
107  *
108  * @}
109  */
110
111
112 /**
113  * @defgroup preproc_misc Preprocessor String Macros
114  *
115  * String manipulation macros
116  *
117  * @{
118  */
119
120 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
121 #define AV_TOSTRING(s) #s
122
123 #define AV_GLUE(a, b) a ## b
124 #define AV_JOIN(a, b) AV_GLUE(a, b)
125
126 #define AV_PRAGMA(s) _Pragma(#s)
127
128 /**
129  * @}
130  */
131
132 /**
133  * @defgroup version_utils Library Version Macros
134  *
135  * Useful to check and match library version in order to maintain
136  * backward compatibility.
137  *
138  * @{
139  */
140
141 #define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
142 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
143 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
144
145 /**
146  * @}
147  *
148  * @defgroup lavu_ver Version and Build diagnostics
149  *
150  * Macros and function useful to check at compiletime and at runtime
151  * which version of libavutil is in use.
152  *
153  * @{
154  */
155
156 #define LIBAVUTIL_VERSION_MAJOR 51
157 #define LIBAVUTIL_VERSION_MINOR 39
158 #define LIBAVUTIL_VERSION_MICRO 100
159
160 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
161                                                LIBAVUTIL_VERSION_MINOR, \
162                                                LIBAVUTIL_VERSION_MICRO)
163 #define LIBAVUTIL_VERSION       AV_VERSION(LIBAVUTIL_VERSION_MAJOR,     \
164                                            LIBAVUTIL_VERSION_MINOR,     \
165                                            LIBAVUTIL_VERSION_MICRO)
166 #define LIBAVUTIL_BUILD         LIBAVUTIL_VERSION_INT
167
168 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
169
170 /**
171  * @}
172  *
173  * @defgroup depr_guards Deprecation guards
174  * Those FF_API_* defines are not part of public API.
175  * They may change, break or disappear at any time.
176  *
177  * They are used mostly internally to mark code that will be removed
178  * on the next major version.
179  *
180  * @{
181  */
182 #ifndef FF_API_OLD_EVAL_NAMES
183 #define FF_API_OLD_EVAL_NAMES (LIBAVUTIL_VERSION_MAJOR < 52)
184 #endif
185 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
186 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
187 #endif
188 #ifndef FF_API_FIND_OPT
189 #define FF_API_FIND_OPT                 (LIBAVUTIL_VERSION_MAJOR < 52)
190 #endif
191 #ifndef FF_API_AV_FIFO_PEEK
192 #define FF_API_AV_FIFO_PEEK             (LIBAVUTIL_VERSION_MAJOR < 52)
193 #endif
194 #ifndef FF_API_OLD_AVOPTIONS
195 #define FF_API_OLD_AVOPTIONS            (LIBAVUTIL_VERSION_MAJOR < 52)
196 #endif
197
198 /**
199  * @}
200  */
201
202 /**
203  * @addtogroup lavu_ver
204  * @{
205  */
206
207 /**
208  * Return the LIBAVUTIL_VERSION_INT constant.
209  */
210 unsigned avutil_version(void);
211
212 /**
213  * Return the libavutil build-time configuration.
214  */
215 const char *avutil_configuration(void);
216
217 /**
218  * Return the libavutil license.
219  */
220 const char *avutil_license(void);
221
222 /**
223  * @}
224  */
225
226 /**
227  * @addtogroup lavu_media Media Type
228  * @brief Media Type
229  */
230
231 enum AVMediaType {
232     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
233     AVMEDIA_TYPE_VIDEO,
234     AVMEDIA_TYPE_AUDIO,
235     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
236     AVMEDIA_TYPE_SUBTITLE,
237     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
238     AVMEDIA_TYPE_NB
239 };
240
241 /**
242  * Return a string describing the media_type enum, NULL if media_type
243  * is unknown.
244  */
245 const char *av_get_media_type_string(enum AVMediaType media_type);
246
247 /**
248  * @defgroup lavu_const Constants
249  * @{
250  *
251  * @defgroup lavu_enc Encoding specific
252  *
253  * @note those definition should move to avcodec
254  * @{
255  */
256
257 #define FF_LAMBDA_SHIFT 7
258 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
259 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
260 #define FF_LAMBDA_MAX (256*128-1)
261
262 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
263
264 /**
265  * @}
266  * @defgroup lavu_time Timestamp specific
267  *
268  * FFmpeg internal timebase and timestamp definitions
269  *
270  * @{
271  */
272
273 /**
274  * @brief Undefined timestamp value
275  *
276  * Usually reported by demuxer that work on containers that do not provide
277  * either pts or dts.
278  */
279
280 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
281
282 /**
283  * Internal time base represented as integer
284  */
285
286 #define AV_TIME_BASE            1000000
287
288 /**
289  * Internal time base represented as fractional value
290  */
291
292 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
293
294 /**
295  * @}
296  * @}
297  * @defgroup lavu_picture Image related
298  *
299  * AVPicture types, pixel formats and basic image planes manipulation.
300  *
301  * @{
302  */
303
304 enum AVPictureType {
305     AV_PICTURE_TYPE_NONE = 0, ///< Undefined
306     AV_PICTURE_TYPE_I,     ///< Intra
307     AV_PICTURE_TYPE_P,     ///< Predicted
308     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
309     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
310     AV_PICTURE_TYPE_SI,    ///< Switching Intra
311     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
312     AV_PICTURE_TYPE_BI,    ///< BI type
313 };
314
315 /**
316  * Return a single letter to describe the given picture type
317  * pict_type.
318  *
319  * @param[in] pict_type the picture type @return a single character
320  * representing the picture type, '?' if pict_type is unknown
321  */
322 char av_get_picture_type_char(enum AVPictureType pict_type);
323
324 /**
325  * @}
326  */
327
328 #include "common.h"
329 #include "error.h"
330 #include "mathematics.h"
331 #include "rational.h"
332 #include "intfloat_readwrite.h"
333 #include "log.h"
334 #include "pixfmt.h"
335
336 /**
337  * Return x default pointer in case p is NULL.
338  */
339 static inline void *av_x_if_null(const void *p, const void *x)
340 {
341     return (void *)(intptr_t)(p ? p : x);
342 }
343
344 /**
345  * @}
346  * @}
347  */
348
349 #endif /* AVUTIL_AVUTIL_H */