ismindex: Change the duration field to int64_t
[libav.git] / libavutil / avutil.h
CommitLineData
558b86a5
LB
1/*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
2912e87a 4 * This file is part of Libav.
558b86a5 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
558b86a5
LB
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 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
558b86a5
LB
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
2912e87a 17 * License along with Libav; if not, write to the Free Software
558b86a5
LB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
98790382
SS
21#ifndef AVUTIL_AVUTIL_H
22#define AVUTIL_AVUTIL_H
558b86a5
LB
23
24/**
ba87f080 25 * @file
7ce68923 26 * external API header
558b86a5
LB
27 */
28
757cd8d8
LB
29/**
30 * @mainpage
31 *
32 * @section libav_intro Introduction
33 *
cfac648e 34 * This document describes the usage of the different libraries
757cd8d8
LB
35 * provided by Libav.
36 *
e97e5a2e 37 * @li @ref libavc "libavcodec" encoding/decoding library
bc8c1cdc 38 * @li @ref lavfi "libavfilter" graph-based frame editing library
e361b508 39 * @li @ref libavf "libavformat" I/O and muxing/demuxing library
1be32305 40 * @li @ref lavd "libavdevice" special devices muxing/demuxing library
757cd8d8 41 * @li @ref lavu "libavutil" common utility library
01b76019 42 * @li @ref lavr "libavresample" audio resampling, format conversion and mixing
757cd8d8 43 * @li @subpage libswscale color conversion and scaling library
40020e17
AK
44 *
45 * @section libav_versioning Versioning and compatibility
46 *
47 * Each of the Libav libraries contains a version.h header, which defines a
48 * major, minor and micro version number with the
49 * <em>LIBRARYNAME_VERSION_{MAJOR,MINOR,MICRO}</em> macros. The major version
50 * number is incremented with backward incompatible changes - e.g. removing
51 * parts of the public API, reordering public struct members, etc. The minor
52 * version number is incremented for backward compatible API changes or major
53 * new features - e.g. adding a new public function or a new decoder. The micro
54 * version number is incremented for smaller changes that a calling program
55 * might still want to check for - e.g. changing behavior in a previously
56 * unspecified situation.
57 *
58 * Libav guarantees backward API and ABI compatibility for each library as long
59 * as its major version number is unchanged. This means that no public symbols
60 * will be removed or renamed. Types and names of the public struct members and
61 * values of public macros and enums will remain the same (unless they were
62 * explicitly declared as not part of the public API). Documented behavior will
63 * not change.
64 *
65 * In other words, any correct program that works with a given Libav snapshot
66 * should work just as well without any changes with any later snapshot with the
67 * same major versions. This applies to both rebuilding the program against new
68 * Libav versions or to replacing the dynamic Libav libraries that a program
69 * links against.
70 *
71 * However, new public symbols may be added and new members may be appended to
72 * public structs whose size is not part of public ABI (most public structs in
73 * Libav). New macros and enum values may be added. Behavior in undocumented
74 * situations may change slightly (and be documented). All those are accompanied
75 * by an entry in doc/APIchanges and incrementing either the minor or micro
76 * version number.
757cd8d8
LB
77 */
78
79/**
80 * @defgroup lavu Common utility functions
81 *
82 * @brief
83 * libavutil contains the code shared across all the other Libav
84 * libraries
85 *
86 * @note In order to use the functions provided by avutil you must include
87 * the specific header.
88 *
89 * @{
90 *
91 * @defgroup lavu_crypto Crypto and Hashing
92 *
93 * @{
94 * @}
95 *
96 * @defgroup lavu_math Maths
97 * @{
98 *
99 * @}
100 *
101 * @defgroup lavu_string String Manipulation
102 *
103 * @{
104 *
105 * @}
106 *
107 * @defgroup lavu_mem Memory Management
108 *
109 * @{
110 *
111 * @}
112 *
113 * @defgroup lavu_data Data Structures
114 * @{
115 *
116 * @}
117 *
118 * @defgroup lavu_audio Audio related
119 *
120 * @{
121 *
122 * @}
123 *
124 * @defgroup lavu_error Error Codes
125 *
126 * @{
127 *
128 * @}
129 *
130 * @defgroup lavu_misc Other
131 *
132 * @{
133 *
134 * @defgroup lavu_internal Internal
135 *
136 * Not exported functions, for internal usage only
137 *
138 * @{
139 *
140 * @}
141 */
142
143
144/**
145 * @defgroup preproc_misc Preprocessor String Macros
146 *
147 * String manipulation macros
148 *
149 * @{
150 */
558b86a5 151
558b86a5
LB
152#define AV_STRINGIFY(s) AV_TOSTRING(s)
153#define AV_TOSTRING(s) #s
87fec35d
MR
154
155#define AV_GLUE(a, b) a ## b
156#define AV_JOIN(a, b) AV_GLUE(a, b)
157
d408b77a 158#define AV_PRAGMA(s) _Pragma(#s)
558b86a5 159
757cd8d8
LB
160/**
161 * @}
162 */
163
164/**
165 * @defgroup version_utils Library Version Macros
166 *
167 * Useful to check and match library version in order to maintain
168 * backward compatibility.
169 *
170 * @{
171 */
172
800c289a
MR
173#define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
174#define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
175#define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
e97ac1e6 176
757cd8d8
LB
177/**
178 * @}
757cd8d8
LB
179 */
180
181/**
182 * @addtogroup lavu_ver
183 * @{
184 */
185
186/**
49bd8e4b 187 * Return the LIBAVUTIL_VERSION_INT constant.
7f0026dd
SS
188 */
189unsigned avutil_version(void);
558b86a5 190
c1736936 191/**
49bd8e4b 192 * Return the libavutil build-time configuration.
c1736936 193 */
41600690 194const char *avutil_configuration(void);
c1736936
DB
195
196/**
49bd8e4b 197 * Return the libavutil license.
c1736936 198 */
41600690 199const char *avutil_license(void);
c1736936 200
757cd8d8
LB
201/**
202 * @}
203 */
204
205/**
206 * @addtogroup lavu_media Media Type
207 * @brief Media Type
208 */
209
11491503 210enum AVMediaType {
757cd8d8 211 AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
11491503
SS
212 AVMEDIA_TYPE_VIDEO,
213 AVMEDIA_TYPE_AUDIO,
757cd8d8 214 AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
11491503 215 AVMEDIA_TYPE_SUBTITLE,
757cd8d8 216 AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
11491503
SS
217 AVMEDIA_TYPE_NB
218};
219
757cd8d8
LB
220/**
221 * @defgroup lavu_const Constants
222 * @{
223 *
224 * @defgroup lavu_enc Encoding specific
225 *
226 * @note those definition should move to avcodec
227 * @{
228 */
229
6ed04040
MN
230#define FF_LAMBDA_SHIFT 7
231#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
232#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
233#define FF_LAMBDA_MAX (256*128-1)
234
235#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
236
757cd8d8
LB
237/**
238 * @}
239 * @defgroup lavu_time Timestamp specific
240 *
241 * Libav internal timebase and timestamp definitions
242 *
243 * @{
244 */
245
246/**
247 * @brief Undefined timestamp value
248 *
249 * Usually reported by demuxer that work on containers that do not provide
250 * either pts or dts.
251 */
252
737eb597 253#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
757cd8d8
LB
254
255/**
256 * Internal time base represented as integer
257 */
258
737eb597 259#define AV_TIME_BASE 1000000
757cd8d8
LB
260
261/**
262 * Internal time base represented as fractional value
263 */
264
737eb597
RT
265#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
266
757cd8d8
LB
267/**
268 * @}
269 * @}
270 * @defgroup lavu_picture Image related
271 *
272 * AVPicture types, pixel formats and basic image planes manipulation.
273 *
274 * @{
275 */
276
bebe72f4
SS
277enum AVPictureType {
278 AV_PICTURE_TYPE_I = 1, ///< Intra
279 AV_PICTURE_TYPE_P, ///< Predicted
280 AV_PICTURE_TYPE_B, ///< Bi-dir predicted
281 AV_PICTURE_TYPE_S, ///< S(GMC)-VOP MPEG4
282 AV_PICTURE_TYPE_SI, ///< Switching Intra
283 AV_PICTURE_TYPE_SP, ///< Switching Predicted
284 AV_PICTURE_TYPE_BI, ///< BI type
285};
286
287/**
288 * Return a single letter to describe the given picture type
289 * pict_type.
290 *
291 * @param[in] pict_type the picture type @return a single character
292 * representing the picture type, '?' if pict_type is unknown
293 */
294char av_get_picture_type_char(enum AVPictureType pict_type);
295
757cd8d8
LB
296/**
297 * @}
298 */
299
60c144f7 300#include "error.h"
86ab7b0f 301#include "version.h"
558b86a5 302
757cd8d8
LB
303/**
304 * @}
305 * @}
306 */
307
98790382 308#endif /* AVUTIL_AVUTIL_H */