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 FFmpeg.
   5  *
   6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 ffmpeg_intro Introduction
  33  *
  34  * This document describes the usage of the different libraries
  35  * provided by FFmpeg.
  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 libpostproc post processing library
  43  * @li @subpage libswscale  color conversion and scaling library
  44  */
  45
  46 /**
  47  * @defgroup lavu Common utility functions
  48  *
  49  * @brief
  50  * libavutil contains the code shared across all the other FFmpeg
  51  * libraries
  52  *
  53  * @note In order to use the functions provided by avutil you must include
  54  * the specific header.
  55  *
  56  * @{
  57  *
  58  * @defgroup lavu_crypto Crypto and Hashing
  59  *
  60  * @{
  61  * @}
  62  *
  63  * @defgroup lavu_math Maths
  64  * @{
  65  *
  66  * @}
  67  *
  68  * @defgroup lavu_string String Manipulation
  69  *
  70  * @{
  71  *
  72  * @}
  73  *
  74  * @defgroup lavu_mem Memory Management
  75  *
  76  * @{
  77  *
  78  * @}
  79  *
  80  * @defgroup lavu_data Data Structures
  81  * @{
  82  *
  83  * @}
  84  *
  85  * @defgroup lavu_audio Audio related
  86  *
  87  * @{
  88  *
  89  * @}
  90  *
  91  * @defgroup lavu_error Error Codes
  92  *
  93  * @{
  94  *
  95  * @}
  96  *
  97  * @defgroup lavu_misc Other
  98  *
  99  * @{
 100  *
 101  * @defgroup lavu_internal Internal
 102  *
 103  * Not exported functions, for internal usage only
 104  *
 105  * @{
 106  *
 107  * @}
 108  */
 109
 110
 111 /**
 112  * @addtogroup lavu_ver
 113  * @{
 114  */
 115
 116 /**
 117  * Return the LIBAVUTIL_VERSION_INT constant.
 118  */
 119 unsigned avutil_version(void);
 120
 121 /**
 122  * Return the libavutil build-time configuration.
 123  */
 124 const char *avutil_configuration(void);
 125
 126 /**
 127  * Return the libavutil license.
 128  */
 129 const char *avutil_license(void);
 130
 131 /**
 132  * @}
 133  */
 134
 135 /**
 136  * @addtogroup lavu_media Media Type
 137  * @brief Media Type
 138  */
 139
 140 enum AVMediaType {
 141     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
 142     AVMEDIA_TYPE_VIDEO,
 143     AVMEDIA_TYPE_AUDIO,
 144     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
 145     AVMEDIA_TYPE_SUBTITLE,
 146     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
 147     AVMEDIA_TYPE_NB
 148 };
 149
 150 /**
 151  * Return a string describing the media_type enum, NULL if media_type
 152  * is unknown.
 153  */
 154 const char *av_get_media_type_string(enum AVMediaType media_type);
 155
 156 /**
 157  * @defgroup lavu_const Constants
 158  * @{
 159  *
 160  * @defgroup lavu_enc Encoding specific
 161  *
 162  * @note those definition should move to avcodec
 163  * @{
 164  */
 165
 166 #define FF_LAMBDA_SHIFT 7
 167 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
 168 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
 169 #define FF_LAMBDA_MAX (256*128-1)
 170
 171 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
 172
 173 /**
 174  * @}
 175  * @defgroup lavu_time Timestamp specific
 176  *
 177  * FFmpeg internal timebase and timestamp definitions
 178  *
 179  * @{
 180  */
 181
 182 /**
 183  * @brief Undefined timestamp value
 184  *
 185  * Usually reported by demuxer that work on containers that do not provide
 186  * either pts or dts.
 187  */
 188
 189 #define AV_NOPTS_VALUE          ((int64_t)UINT64_C(0x8000000000000000))
 190
 191 /**
 192  * Internal time base represented as integer
 193  */
 194
 195 #define AV_TIME_BASE            1000000
 196
 197 /**
 198  * Internal time base represented as fractional value
 199  */
 200
 201 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
 202
 203 /**
 204  * @}
 205  * @}
 206  * @defgroup lavu_picture Image related
 207  *
 208  * AVPicture types, pixel formats and basic image planes manipulation.
 209  *
 210  * @{
 211  */
 212
 213 enum AVPictureType {
 214     AV_PICTURE_TYPE_NONE = 0, ///< Undefined
 215     AV_PICTURE_TYPE_I,     ///< Intra
 216     AV_PICTURE_TYPE_P,     ///< Predicted
 217     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
 218     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
 219     AV_PICTURE_TYPE_SI,    ///< Switching Intra
 220     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
 221     AV_PICTURE_TYPE_BI,    ///< BI type
 222 };
 223
 224 /**
 225  * Return a single letter to describe the given picture type
 226  * pict_type.
 227  *
 228  * @param[in] pict_type the picture type @return a single character
 229  * representing the picture type, '?' if pict_type is unknown
 230  */
 231 char av_get_picture_type_char(enum AVPictureType pict_type);
 232
 233 /**
 234  * @}
 235  */
 236
 237 #include "common.h"
 238 #include "error.h"
 239 #include "version.h"
 240 #include "mathematics.h"
 241 #include "rational.h"
 242 #include "intfloat_readwrite.h"
 243 #include "log.h"
 244 #include "pixfmt.h"
 245
 246 /**
 247  * Return x default pointer in case p is NULL.
 248  */
 249 static inline void *av_x_if_null(const void *p, const void *x)
 250 {
 251     return (void *)(intptr_t)(p ? p : x);
 252 }
 253
 254 /**
 255  * @}
 256  * @}
 257  */
 258
 259 #endif /* AVUTIL_AVUTIL_H */