git.sesse.net Git - ffmpeg/blob - libavutil/avutil.h

   1 /*
   2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav is free software; you can redistribute it and/or
   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  *
  11  * Libav is distributed in the hope that it will be useful,
  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
  17  * License along with Libav; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVUTIL_AVUTIL_H
  22 #define AVUTIL_AVUTIL_H
  23
  24 /**
  25  * @file
  26  * external API header
  27  */
  28
  29 /**
  30  * @mainpage
  31  *
  32  * @section libav_intro Introduction
  33  *
  34  * This document describes the usage of the different libraries
  35  * provided by Libav.
  36  *
  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  * @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.
  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_log Logging Facility
 131  *
 132  * @{
 133  *
 134  * @}
 135  *
 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  * @}
 147  */
 148
 149
 150 /**
 151  * @defgroup preproc_misc Preprocessor String Macros
 152  *
 153  * String manipulation macros
 154  *
 155  * @{
 156  */
 157
 158 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
 159 #define AV_TOSTRING(s) #s
 160
 161 #define AV_GLUE(a, b) a ## b
 162 #define AV_JOIN(a, b) AV_GLUE(a, b)
 163
 164 #define AV_PRAGMA(s) _Pragma(#s)
 165
 166 /**
 167  * @}
 168  */
 169
 170 /**
 171  * @defgroup version_utils Library Version Macros
 172  *
 173  * Useful to check and match library version in order to maintain
 174  * backward compatibility.
 175  *
 176  * @{
 177  */
 178
 179 #define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
 180 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
 181 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
 182
 183 /**
 184  * @}
 185  */
 186
 187 /**
 188  * @addtogroup lavu_ver
 189  * @{
 190  */
 191
 192 /**
 193  * Return the LIBAVUTIL_VERSION_INT constant.
 194  */
 195 unsigned avutil_version(void);
 196
 197 /**
 198  * Return the libavutil build-time configuration.
 199  */
 200 const char *avutil_configuration(void);
 201
 202 /**
 203  * Return the libavutil license.
 204  */
 205 const char *avutil_license(void);
 206
 207 /**
 208  * @}
 209  */
 210
 211 /**
 212  * @addtogroup lavu_media Media Type
 213  * @brief Media Type
 214  */
 215
 216 enum AVMediaType {
 217     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
 218     AVMEDIA_TYPE_VIDEO,
 219     AVMEDIA_TYPE_AUDIO,
 220     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
 221     AVMEDIA_TYPE_SUBTITLE,
 222     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
 223     AVMEDIA_TYPE_NB
 224 };
 225
 226 /**
 227  * @defgroup lavu_const Constants
 228  * @{
 229  *
 230  * @defgroup lavu_enc Encoding specific
 231  *
 232  * @note those definition should move to avcodec
 233  * @{
 234  */
 235
 236 #define FF_LAMBDA_SHIFT 7
 237 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
 238 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
 239 #define FF_LAMBDA_MAX (256*128-1)
 240
 241 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
 242
 243 /**
 244  * @}
 245  * @defgroup lavu_time Timestamp specific
 246  *
 247  * Libav internal timebase and timestamp definitions
 248  *
 249  * @{
 250  */
 251
 252 /**
 253  * @brief Undefined timestamp value
 254  *
 255  * Usually reported by demuxer that work on containers that do not provide
 256  * either pts or dts.
 257  */
 258
 259 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
 260
 261 /**
 262  * Internal time base represented as integer
 263  */
 264
 265 #define AV_TIME_BASE            1000000
 266
 267 /**
 268  * Internal time base represented as fractional value
 269  */
 270
 271 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
 272
 273 /**
 274  * @}
 275  * @}
 276  * @defgroup lavu_picture Image related
 277  *
 278  * AVPicture types, pixel formats and basic image planes manipulation.
 279  *
 280  * @{
 281  */
 282
 283 enum AVPictureType {
 284     AV_PICTURE_TYPE_I = 1, ///< Intra
 285     AV_PICTURE_TYPE_P,     ///< Predicted
 286     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
 287     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
 288     AV_PICTURE_TYPE_SI,    ///< Switching Intra
 289     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
 290     AV_PICTURE_TYPE_BI,    ///< BI type
 291 };
 292
 293 /**
 294  * Return a single letter to describe the given picture type
 295  * pict_type.
 296  *
 297  * @param[in] pict_type the picture type @return a single character
 298  * representing the picture type, '?' if pict_type is unknown
 299  */
 300 char av_get_picture_type_char(enum AVPictureType pict_type);
 301
 302 /**
 303  * @}
 304  */
 305
 306 #include "error.h"
 307 #include "version.h"
 308
 309 /**
 310  * @}
 311  * @}
 312  */
 313
 314 #endif /* AVUTIL_AVUTIL_H */