Merge commit '1316df7aa98c4784f190d107206d0bb12c590b89'
[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 @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
45  *
46  * @section ffmpeg_versioning Versioning and compatibility
47  *
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.
58  *
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
64  * not change.
65  *
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
70  * links against.
71  *
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
77  * version number.
78  */
79
80 /**
81  * @defgroup lavu Common utility functions
82  *
83  * @brief
84  * libavutil contains the code shared across all the other FFmpeg
85  * libraries
86  *
87  * @note In order to use the functions provided by avutil you must include
88  * the specific header.
89  *
90  * @{
91  *
92  * @defgroup lavu_crypto Crypto and Hashing
93  *
94  * @{
95  * @}
96  *
97  * @defgroup lavu_math Maths
98  * @{
99  *
100  * @}
101  *
102  * @defgroup lavu_string String Manipulation
103  *
104  * @{
105  *
106  * @}
107  *
108  * @defgroup lavu_mem Memory Management
109  *
110  * @{
111  *
112  * @}
113  *
114  * @defgroup lavu_data Data Structures
115  * @{
116  *
117  * @}
118  *
119  * @defgroup lavu_audio Audio related
120  *
121  * @{
122  *
123  * @}
124  *
125  * @defgroup lavu_error Error Codes
126  *
127  * @{
128  *
129  * @}
130  *
131  * @defgroup lavu_log Logging Facility
132  *
133  * @{
134  *
135  * @}
136  *
137  * @defgroup lavu_misc Other
138  *
139  * @{
140  *
141  * @defgroup lavu_internal Internal
142  *
143  * Not exported functions, for internal usage only
144  *
145  * @{
146  *
147  * @}
148  *
149  * @defgroup preproc_misc Preprocessor String Macros
150  *
151  * @{
152  *
153  * @}
154  *
155  * @defgroup version_utils Library Version Macros
156  *
157  * @{
158  *
159  * @}
160  */
161
162
163 /**
164  * @addtogroup lavu_ver
165  * @{
166  */
167
168 /**
169  * Return the LIBAVUTIL_VERSION_INT constant.
170  */
171 unsigned avutil_version(void);
172
173 /**
174  * Return an informative version string. This usually is the actual release
175  * version number or a git commit description. This string has no fixed format
176  * and can change any time. It should never be parsed by code.
177  */
178 const char *av_version_info(void);
179
180 /**
181  * Return the libavutil build-time configuration.
182  */
183 const char *avutil_configuration(void);
184
185 /**
186  * Return the libavutil license.
187  */
188 const char *avutil_license(void);
189
190 /**
191  * @}
192  */
193
194 /**
195  * @addtogroup lavu_media Media Type
196  * @brief Media Type
197  */
198
199 enum AVMediaType {
200     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
201     AVMEDIA_TYPE_VIDEO,
202     AVMEDIA_TYPE_AUDIO,
203     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
204     AVMEDIA_TYPE_SUBTITLE,
205     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
206     AVMEDIA_TYPE_NB
207 };
208
209 /**
210  * Return a string describing the media_type enum, NULL if media_type
211  * is unknown.
212  */
213 const char *av_get_media_type_string(enum AVMediaType media_type);
214
215 /**
216  * @defgroup lavu_const Constants
217  * @{
218  *
219  * @defgroup lavu_enc Encoding specific
220  *
221  * @note those definition should move to avcodec
222  * @{
223  */
224
225 #define FF_LAMBDA_SHIFT 7
226 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
227 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
228 #define FF_LAMBDA_MAX (256*128-1)
229
230 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
231
232 /**
233  * @}
234  * @defgroup lavu_time Timestamp specific
235  *
236  * FFmpeg internal timebase and timestamp definitions
237  *
238  * @{
239  */
240
241 /**
242  * @brief Undefined timestamp value
243  *
244  * Usually reported by demuxer that work on containers that do not provide
245  * either pts or dts.
246  */
247
248 #define AV_NOPTS_VALUE          ((int64_t)UINT64_C(0x8000000000000000))
249
250 /**
251  * Internal time base represented as integer
252  */
253
254 #define AV_TIME_BASE            1000000
255
256 /**
257  * Internal time base represented as fractional value
258  */
259
260 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
261
262 /**
263  * @}
264  * @}
265  * @defgroup lavu_picture Image related
266  *
267  * AVPicture types, pixel formats and basic image planes manipulation.
268  *
269  * @{
270  */
271
272 enum AVPictureType {
273     AV_PICTURE_TYPE_NONE = 0, ///< Undefined
274     AV_PICTURE_TYPE_I,     ///< Intra
275     AV_PICTURE_TYPE_P,     ///< Predicted
276     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
277     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
278     AV_PICTURE_TYPE_SI,    ///< Switching Intra
279     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
280     AV_PICTURE_TYPE_BI,    ///< BI type
281 };
282
283 /**
284  * Return a single letter to describe the given picture type
285  * pict_type.
286  *
287  * @param[in] pict_type the picture type @return a single character
288  * representing the picture type, '?' if pict_type is unknown
289  */
290 char av_get_picture_type_char(enum AVPictureType pict_type);
291
292 /**
293  * @}
294  */
295
296 #include "common.h"
297 #include "error.h"
298 #include "rational.h"
299 #include "version.h"
300 #include "macros.h"
301 #include "mathematics.h"
302 #include "log.h"
303 #include "pixfmt.h"
304
305 /**
306  * Return x default pointer in case p is NULL.
307  */
308 static inline void *av_x_if_null(const void *p, const void *x)
309 {
310     return (void *)(intptr_t)(p ? p : x);
311 }
312
313 /**
314  * Compute the length of an integer list.
315  *
316  * @param elsize  size in bytes of each list element (only 1, 2, 4 or 8)
317  * @param term    list terminator (usually 0 or -1)
318  * @param list    pointer to the list
319  * @return  length of the list, in elements, not counting the terminator
320  */
321 unsigned av_int_list_length_for_size(unsigned elsize,
322                                      const void *list, uint64_t term) av_pure;
323
324 /**
325  * Compute the length of an integer list.
326  *
327  * @param term  list terminator (usually 0 or -1)
328  * @param list  pointer to the list
329  * @return  length of the list, in elements, not counting the terminator
330  */
331 #define av_int_list_length(list, term) \
332     av_int_list_length_for_size(sizeof(*(list)), list, term)
333
334 /**
335  * Open a file using a UTF-8 filename.
336  * The API of this function matches POSIX fopen(), errors are returned through
337  * errno.
338  */
339 FILE *av_fopen_utf8(const char *path, const char *mode);
340
341 /**
342  * Return the fractional representation of the internal time base.
343  */
344 AVRational av_get_time_base_q(void);
345
346 /**
347  * @}
348  * @}
349  */
350
351 #endif /* AVUTIL_AVUTIL_H */