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 @subpage 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 @subpage libswscale  color conversion and scaling library
  43  */
  44
  45 /**
  46  * @defgroup lavu Common utility functions
  47  *
  48  * @brief
  49  * libavutil contains the code shared across all the other Libav
  50  * libraries
  51  *
  52  * @note In order to use the functions provided by avutil you must include
  53  * the specific header.
  54  *
  55  * @{
  56  *
  57  * @defgroup lavu_crypto Crypto and Hashing
  58  *
  59  * @{
  60  * @}
  61  *
  62  * @defgroup lavu_math Maths
  63  * @{
  64  *
  65  * @}
  66  *
  67  * @defgroup lavu_string String Manipulation
  68  *
  69  * @{
  70  *
  71  * @}
  72  *
  73  * @defgroup lavu_mem Memory Management
  74  *
  75  * @{
  76  *
  77  * @}
  78  *
  79  * @defgroup lavu_data Data Structures
  80  * @{
  81  *
  82  * @}
  83  *
  84  * @defgroup lavu_audio Audio related
  85  *
  86  * @{
  87  *
  88  * @}
  89  *
  90  * @defgroup lavu_error Error Codes
  91  *
  92  * @{
  93  *
  94  * @}
  95  *
  96  * @defgroup lavu_misc Other
  97  *
  98  * @{
  99  *
 100  * @defgroup lavu_internal Internal
 101  *
 102  * Not exported functions, for internal usage only
 103  *
 104  * @{
 105  *
 106  * @}
 107  */
 108
 109
 110 /**
 111  * @defgroup preproc_misc Preprocessor String Macros
 112  *
 113  * String manipulation macros
 114  *
 115  * @{
 116  */
 117
 118 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
 119 #define AV_TOSTRING(s) #s
 120
 121 #define AV_GLUE(a, b) a ## b
 122 #define AV_JOIN(a, b) AV_GLUE(a, b)
 123
 124 #define AV_PRAGMA(s) _Pragma(#s)
 125
 126 /**
 127  * @}
 128  */
 129
 130 /**
 131  * @defgroup version_utils Library Version Macros
 132  *
 133  * Useful to check and match library version in order to maintain
 134  * backward compatibility.
 135  *
 136  * @{
 137  */
 138
 139 #define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
 140 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
 141 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
 142
 143 /**
 144  * @}
 145  *
 146  * @defgroup lavu_ver Version and Build diagnostics
 147  *
 148  * Macros and function useful to check at compiletime and at runtime
 149  * which version of libavutil is in use.
 150  *
 151  * @{
 152  */
 153
 154 #define LIBAVUTIL_VERSION_MAJOR 51
 155 #define LIBAVUTIL_VERSION_MINOR 27
 156 #define LIBAVUTIL_VERSION_MICRO  2
 157
 158 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
 159                                                LIBAVUTIL_VERSION_MINOR, \
 160                                                LIBAVUTIL_VERSION_MICRO)
 161 #define LIBAVUTIL_VERSION       AV_VERSION(LIBAVUTIL_VERSION_MAJOR,     \
 162                                            LIBAVUTIL_VERSION_MINOR,     \
 163                                            LIBAVUTIL_VERSION_MICRO)
 164 #define LIBAVUTIL_BUILD         LIBAVUTIL_VERSION_INT
 165
 166 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
 167
 168 /**
 169  * @}
 170  *
 171  * @defgroup depr_guards Deprecation guards
 172  * Those FF_API_* defines are not part of public API.
 173  * They may change, break or disappear at any time.
 174  *
 175  * They are used mostly internally to mark code that will be removed
 176  * on the next major version.
 177  *
 178  * @{
 179  */
 180 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
 181 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
 182 #endif
 183 #ifndef FF_API_FIND_OPT
 184 #define FF_API_FIND_OPT                 (LIBAVUTIL_VERSION_MAJOR < 52)
 185 #endif
 186 #ifndef FF_API_AV_FIFO_PEEK
 187 #define FF_API_AV_FIFO_PEEK             (LIBAVUTIL_VERSION_MAJOR < 52)
 188 #endif
 189 #ifndef FF_API_OLD_AVOPTIONS
 190 #define FF_API_OLD_AVOPTIONS            (LIBAVUTIL_VERSION_MAJOR < 52)
 191 #endif
 192
 193 /**
 194  * @}
 195  */
 196
 197 /**
 198  * @addtogroup lavu_ver
 199  * @{
 200  */
 201
 202 /**
 203  * Return the LIBAVUTIL_VERSION_INT constant.
 204  */
 205 unsigned avutil_version(void);
 206
 207 /**
 208  * Return the libavutil build-time configuration.
 209  */
 210 const char *avutil_configuration(void);
 211
 212 /**
 213  * Return the libavutil license.
 214  */
 215 const char *avutil_license(void);
 216
 217 /**
 218  * @}
 219  */
 220
 221 /**
 222  * @addtogroup lavu_media Media Type
 223  * @brief Media Type
 224  */
 225
 226 enum AVMediaType {
 227     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
 228     AVMEDIA_TYPE_VIDEO,
 229     AVMEDIA_TYPE_AUDIO,
 230     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
 231     AVMEDIA_TYPE_SUBTITLE,
 232     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
 233     AVMEDIA_TYPE_NB
 234 };
 235
 236 /**
 237  * @defgroup lavu_const Constants
 238  * @{
 239  *
 240  * @defgroup lavu_enc Encoding specific
 241  *
 242  * @note those definition should move to avcodec
 243  * @{
 244  */
 245
 246 #define FF_LAMBDA_SHIFT 7
 247 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
 248 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
 249 #define FF_LAMBDA_MAX (256*128-1)
 250
 251 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
 252
 253 /**
 254  * @}
 255  * @defgroup lavu_time Timestamp specific
 256  *
 257  * Libav internal timebase and timestamp definitions
 258  *
 259  * @{
 260  */
 261
 262 /**
 263  * @brief Undefined timestamp value
 264  *
 265  * Usually reported by demuxer that work on containers that do not provide
 266  * either pts or dts.
 267  */
 268
 269 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
 270
 271 /**
 272  * Internal time base represented as integer
 273  */
 274
 275 #define AV_TIME_BASE            1000000
 276
 277 /**
 278  * Internal time base represented as fractional value
 279  */
 280
 281 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
 282
 283 /**
 284  * @}
 285  * @}
 286  * @defgroup lavu_picture Image related
 287  *
 288  * AVPicture types, pixel formats and basic image planes manipulation.
 289  *
 290  * @{
 291  */
 292
 293 enum AVPictureType {
 294     AV_PICTURE_TYPE_I = 1, ///< Intra
 295     AV_PICTURE_TYPE_P,     ///< Predicted
 296     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
 297     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
 298     AV_PICTURE_TYPE_SI,    ///< Switching Intra
 299     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
 300     AV_PICTURE_TYPE_BI,    ///< BI type
 301 };
 302
 303 /**
 304  * Return a single letter to describe the given picture type
 305  * pict_type.
 306  *
 307  * @param[in] pict_type the picture type @return a single character
 308  * representing the picture type, '?' if pict_type is unknown
 309  */
 310 char av_get_picture_type_char(enum AVPictureType pict_type);
 311
 312 /**
 313  * @}
 314  */
 315
 316 #include "common.h"
 317 #include "error.h"
 318
 319 /**
 320  * @}
 321  * @}
 322  */
 323
 324 #endif /* AVUTIL_AVUTIL_H */