avutil.h 7.25 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8 9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
11
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with Libav; if not, write to the Free Software
18 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef AVUTIL_AVUTIL_H
#define AVUTIL_AVUTIL_H
23 24

/**
25
 * @file
Diego Biurrun's avatar
Diego Biurrun committed
26
 * external API header
27 28
 */

29 30 31 32 33
/**
 * @mainpage
 *
 * @section libav_intro Introduction
 *
34
 * This document describes the usage of the different libraries
35 36
 * provided by Libav.
 *
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 lavr "libavresample" audio resampling, format conversion and mixing
43
 * @li @subpage libswscale  color conversion and scaling library
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
 *
 * @section libav_versioning Versioning and compatibility
 *
 * Each of the Libav libraries contains a version.h header, which defines a
 * major, minor and micro version number with the
 * <em>LIBRARYNAME_VERSION_{MAJOR,MINOR,MICRO}</em> macros. The major version
 * number is incremented with backward incompatible changes - e.g. removing
 * parts of the public API, reordering public struct members, etc. The minor
 * version number is incremented for backward compatible API changes or major
 * new features - e.g. adding a new public function or a new decoder. The micro
 * version number is incremented for smaller changes that a calling program
 * might still want to check for - e.g. changing behavior in a previously
 * unspecified situation.
 *
 * Libav guarantees backward API and ABI compatibility for each library as long
 * as its major version number is unchanged. This means that no public symbols
 * will be removed or renamed. Types and names of the public struct members and
 * values of public macros and enums will remain the same (unless they were
 * explicitly declared as not part of the public API). Documented behavior will
 * not change.
 *
 * In other words, any correct program that works with a given Libav snapshot
 * should work just as well without any changes with any later snapshot with the
 * same major versions. This applies to both rebuilding the program against new
 * Libav versions or to replacing the dynamic Libav libraries that a program
 * links against.
 *
 * However, new public symbols may be added and new members may be appended to
 * public structs whose size is not part of public ABI (most public structs in
 * Libav). New macros and enum values may be added. Behavior in undocumented
 * situations may change slightly (and be documented). All those are accompanied
 * by an entry in doc/APIchanges and incrementing either the minor or micro
 * version number.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
 */

/**
 * @defgroup lavu Common utility functions
 *
 * @brief
 * libavutil contains the code shared across all the other Libav
 * libraries
 *
 * @note In order to use the functions provided by avutil you must include
 * the specific header.
 *
 * @{
 *
 * @defgroup lavu_crypto Crypto and Hashing
 *
 * @{
 * @}
 *
 * @defgroup lavu_math Maths
 * @{
 *
 * @}
 *
 * @defgroup lavu_string String Manipulation
 *
 * @{
 *
 * @}
 *
 * @defgroup lavu_mem Memory Management
 *
 * @{
 *
 * @}
 *
 * @defgroup lavu_data Data Structures
 * @{
 *
 * @}
 *
 * @defgroup lavu_audio Audio related
 *
 * @{
 *
 * @}
 *
 * @defgroup lavu_error Error Codes
 *
 * @{
 *
 * @}
 *
 * @defgroup lavu_misc Other
 *
 * @{
 *
 * @defgroup lavu_internal Internal
 *
 * Not exported functions, for internal usage only
 *
 * @{
 *
 * @}
 */


/**
 * @defgroup preproc_misc Preprocessor String Macros
 *
 * String manipulation macros
 *
 * @{
 */
151 152 153

#define AV_STRINGIFY(s)         AV_TOSTRING(s)
#define AV_TOSTRING(s) #s
154 155 156 157

#define AV_GLUE(a, b) a ## b
#define AV_JOIN(a, b) AV_GLUE(a, b)

158
#define AV_PRAGMA(s) _Pragma(#s)
159

160 161 162 163 164 165 166 167 168 169 170 171 172
/**
 * @}
 */

/**
 * @defgroup version_utils Library Version Macros
 *
 * Useful to check and match library version in order to maintain
 * backward compatibility.
 *
 * @{
 */

173 174 175
#define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
#define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
#define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
176

177 178 179 180 181 182 183 184 185
/**
 * @}
 */

/**
 * @addtogroup lavu_ver
 * @{
 */

186
/**
187
 * Return the LIBAVUTIL_VERSION_INT constant.
188 189
 */
unsigned avutil_version(void);
190

191
/**
192
 * Return the libavutil build-time configuration.
193
 */
194
const char *avutil_configuration(void);
195 196

/**
197
 * Return the libavutil license.
198
 */
199
const char *avutil_license(void);
200

201 202 203 204 205 206 207 208 209
/**
 * @}
 */

/**
 * @addtogroup lavu_media Media Type
 * @brief Media Type
 */

210
enum AVMediaType {
211
    AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
212 213
    AVMEDIA_TYPE_VIDEO,
    AVMEDIA_TYPE_AUDIO,
214
    AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
215
    AVMEDIA_TYPE_SUBTITLE,
216
    AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
217 218 219
    AVMEDIA_TYPE_NB
};

220 221 222 223 224 225 226 227 228 229
/**
 * @defgroup lavu_const Constants
 * @{
 *
 * @defgroup lavu_enc Encoding specific
 *
 * @note those definition should move to avcodec
 * @{
 */

230 231 232 233 234 235 236
#define FF_LAMBDA_SHIFT 7
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
#define FF_LAMBDA_MAX (256*128-1)

#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
/**
 * @}
 * @defgroup lavu_time Timestamp specific
 *
 * Libav internal timebase and timestamp definitions
 *
 * @{
 */

/**
 * @brief Undefined timestamp value
 *
 * Usually reported by demuxer that work on containers that do not provide
 * either pts or dts.
 */

253
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
254 255 256 257 258

/**
 * Internal time base represented as integer
 */

259
#define AV_TIME_BASE            1000000
260 261 262 263 264

/**
 * Internal time base represented as fractional value
 */

265 266
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}

267 268 269 270 271 272 273 274 275 276
/**
 * @}
 * @}
 * @defgroup lavu_picture Image related
 *
 * AVPicture types, pixel formats and basic image planes manipulation.
 *
 * @{
 */

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
enum AVPictureType {
    AV_PICTURE_TYPE_I = 1, ///< Intra
    AV_PICTURE_TYPE_P,     ///< Predicted
    AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
    AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
    AV_PICTURE_TYPE_SI,    ///< Switching Intra
    AV_PICTURE_TYPE_SP,    ///< Switching Predicted
    AV_PICTURE_TYPE_BI,    ///< BI type
};

/**
 * Return a single letter to describe the given picture type
 * pict_type.
 *
 * @param[in] pict_type the picture type @return a single character
 * representing the picture type, '?' if pict_type is unknown
 */
char av_get_picture_type_char(enum AVPictureType pict_type);

296 297 298 299
/**
 * @}
 */

300
#include "error.h"
301
#include "version.h"
302

303 304 305 306 307
/**
 * @}
 * @}
 */

308
#endif /* AVUTIL_AVUTIL_H */