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