aarch64: Add assembly support for -fsanitize=hwaddress tagged globals.
[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
c85aad9c 43 * @li @ref libsws "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 *
075acbb6
VG
118 * @defgroup lavu_video Video related
119 *
120 * @{
121 *
122 * @}
123 *
757cd8d8
LB
124 * @defgroup lavu_audio Audio related
125 *
126 * @{
127 *
128 * @}
129 *
130 * @defgroup lavu_error Error Codes
131 *
132 * @{
133 *
134 * @}
135 *
4272bb6e
LB
136 * @defgroup lavu_log Logging Facility
137 *
138 * @{
139 *
140 * @}
141 *
757cd8d8
LB
142 * @defgroup lavu_misc Other
143 *
144 * @{
145 *
146 * @defgroup lavu_internal Internal
147 *
148 * Not exported functions, for internal usage only
149 *
150 * @{
151 *
152 * @}
757cd8d8 153 *
9a4c10e3 154 * @defgroup preproc_misc Preprocessor String Macros
757cd8d8
LB
155 *
156 * @{
9a4c10e3 157 *
757cd8d8
LB
158 * @}
159 */
160
9a4c10e3 161
757cd8d8 162/**
757cd8d8
LB
163 * @addtogroup lavu_ver
164 * @{
165 */
166
167/**
49bd8e4b 168 * Return the LIBAVUTIL_VERSION_INT constant.
7f0026dd
SS
169 */
170unsigned avutil_version(void);
558b86a5 171
c1736936 172/**
1316df7a 173 * Return an informative version string. This usually is the actual release
174 * version number or a git commit description. This string has no fixed format
175 * and can change any time. It should never be parsed by code.
176 */
177const char *av_version_info(void);
178
179/**
49bd8e4b 180 * Return the libavutil build-time configuration.
c1736936 181 */
41600690 182const char *avutil_configuration(void);
c1736936
DB
183
184/**
49bd8e4b 185 * Return the libavutil license.
c1736936 186 */
41600690 187const char *avutil_license(void);
c1736936 188
757cd8d8
LB
189/**
190 * @}
191 */
192
193/**
194 * @addtogroup lavu_media Media Type
195 * @brief Media Type
196 */
197
11491503 198enum AVMediaType {
757cd8d8 199 AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
11491503
SS
200 AVMEDIA_TYPE_VIDEO,
201 AVMEDIA_TYPE_AUDIO,
757cd8d8 202 AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
11491503 203 AVMEDIA_TYPE_SUBTITLE,
757cd8d8 204 AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
11491503
SS
205 AVMEDIA_TYPE_NB
206};
207
757cd8d8
LB
208/**
209 * @defgroup lavu_const Constants
210 * @{
211 *
212 * @defgroup lavu_enc Encoding specific
213 *
214 * @note those definition should move to avcodec
215 * @{
216 */
217
6ed04040
MN
218#define FF_LAMBDA_SHIFT 7
219#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
220#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
221#define FF_LAMBDA_MAX (256*128-1)
222
223#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
224
757cd8d8
LB
225/**
226 * @}
227 * @defgroup lavu_time Timestamp specific
228 *
229 * Libav internal timebase and timestamp definitions
230 *
231 * @{
232 */
233
234/**
235 * @brief Undefined timestamp value
236 *
237 * Usually reported by demuxer that work on containers that do not provide
238 * either pts or dts.
239 */
240
737eb597 241#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
757cd8d8
LB
242
243/**
244 * Internal time base represented as integer
245 */
246
737eb597 247#define AV_TIME_BASE 1000000
757cd8d8
LB
248
249/**
250 * Internal time base represented as fractional value
251 */
252
737eb597
RT
253#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
254
757cd8d8
LB
255/**
256 * @}
257 * @}
258 * @defgroup lavu_picture Image related
259 *
260 * AVPicture types, pixel formats and basic image planes manipulation.
261 *
262 * @{
263 */
264
bebe72f4
SS
265enum AVPictureType {
266 AV_PICTURE_TYPE_I = 1, ///< Intra
267 AV_PICTURE_TYPE_P, ///< Predicted
268 AV_PICTURE_TYPE_B, ///< Bi-dir predicted
41ed7ab4 269 AV_PICTURE_TYPE_S, ///< S(GMC)-VOP MPEG-4
bebe72f4
SS
270 AV_PICTURE_TYPE_SI, ///< Switching Intra
271 AV_PICTURE_TYPE_SP, ///< Switching Predicted
272 AV_PICTURE_TYPE_BI, ///< BI type
273};
274
275/**
276 * Return a single letter to describe the given picture type
277 * pict_type.
278 *
279 * @param[in] pict_type the picture type @return a single character
280 * representing the picture type, '?' if pict_type is unknown
281 */
282char av_get_picture_type_char(enum AVPictureType pict_type);
283
757cd8d8
LB
284/**
285 * @}
286 */
287
60c144f7 288#include "error.h"
502512ea 289#include "rational.h"
86ab7b0f 290#include "version.h"
9a4c10e3 291#include "macros.h"
558b86a5 292
757cd8d8 293/**
b0bdc2a7
MN
294 * Return the fractional representation of the internal time base.
295 */
296AVRational av_get_time_base_q(void);
297
298/**
757cd8d8
LB
299 * @}
300 * @}
301 */
302
98790382 303#endif /* AVUTIL_AVUTIL_H */