lavfi doxy: add a page for lavfi.
[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
757cd8d8
LB
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 */
558b86a5 118
558b86a5
LB
119#define AV_STRINGIFY(s) AV_TOSTRING(s)
120#define AV_TOSTRING(s) #s
87fec35d
MR
121
122#define AV_GLUE(a, b) a ## b
123#define AV_JOIN(a, b) AV_GLUE(a, b)
124
d408b77a 125#define AV_PRAGMA(s) _Pragma(#s)
558b86a5 126
757cd8d8
LB
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
800c289a
MR
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)
e97ac1e6 143
757cd8d8
LB
144/**
145 * @}
757cd8d8
LB
146 */
147
148/**
149 * @addtogroup lavu_ver
150 * @{
151 */
152
153/**
49bd8e4b 154 * Return the LIBAVUTIL_VERSION_INT constant.
7f0026dd
SS
155 */
156unsigned avutil_version(void);
558b86a5 157
c1736936 158/**
49bd8e4b 159 * Return the libavutil build-time configuration.
c1736936 160 */
41600690 161const char *avutil_configuration(void);
c1736936
DB
162
163/**
49bd8e4b 164 * Return the libavutil license.
c1736936 165 */
41600690 166const char *avutil_license(void);
c1736936 167
757cd8d8
LB
168/**
169 * @}
170 */
171
172/**
173 * @addtogroup lavu_media Media Type
174 * @brief Media Type
175 */
176
11491503 177enum AVMediaType {
757cd8d8 178 AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
11491503
SS
179 AVMEDIA_TYPE_VIDEO,
180 AVMEDIA_TYPE_AUDIO,
757cd8d8 181 AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
11491503 182 AVMEDIA_TYPE_SUBTITLE,
757cd8d8 183 AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
11491503
SS
184 AVMEDIA_TYPE_NB
185};
186
757cd8d8
LB
187/**
188 * @defgroup lavu_const Constants
189 * @{
190 *
191 * @defgroup lavu_enc Encoding specific
192 *
193 * @note those definition should move to avcodec
194 * @{
195 */
196
6ed04040
MN
197#define FF_LAMBDA_SHIFT 7
198#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
199#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
200#define FF_LAMBDA_MAX (256*128-1)
201
202#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
203
757cd8d8
LB
204/**
205 * @}
206 * @defgroup lavu_time Timestamp specific
207 *
208 * Libav internal timebase and timestamp definitions
209 *
210 * @{
211 */
212
213/**
214 * @brief Undefined timestamp value
215 *
216 * Usually reported by demuxer that work on containers that do not provide
217 * either pts or dts.
218 */
219
737eb597 220#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
757cd8d8
LB
221
222/**
223 * Internal time base represented as integer
224 */
225
737eb597 226#define AV_TIME_BASE 1000000
757cd8d8
LB
227
228/**
229 * Internal time base represented as fractional value
230 */
231
737eb597
RT
232#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
233
757cd8d8
LB
234/**
235 * @}
236 * @}
237 * @defgroup lavu_picture Image related
238 *
239 * AVPicture types, pixel formats and basic image planes manipulation.
240 *
241 * @{
242 */
243
bebe72f4
SS
244enum AVPictureType {
245 AV_PICTURE_TYPE_I = 1, ///< Intra
246 AV_PICTURE_TYPE_P, ///< Predicted
247 AV_PICTURE_TYPE_B, ///< Bi-dir predicted
248 AV_PICTURE_TYPE_S, ///< S(GMC)-VOP MPEG4
249 AV_PICTURE_TYPE_SI, ///< Switching Intra
250 AV_PICTURE_TYPE_SP, ///< Switching Predicted
251 AV_PICTURE_TYPE_BI, ///< BI type
252};
253
254/**
255 * Return a single letter to describe the given picture type
256 * pict_type.
257 *
258 * @param[in] pict_type the picture type @return a single character
259 * representing the picture type, '?' if pict_type is unknown
260 */
261char av_get_picture_type_char(enum AVPictureType pict_type);
262
757cd8d8
LB
263/**
264 * @}
265 */
266
60c144f7 267#include "error.h"
86ab7b0f 268#include "version.h"
558b86a5 269
757cd8d8
LB
270/**
271 * @}
272 * @}
273 */
274
98790382 275#endif /* AVUTIL_AVUTIL_H */