2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVUTIL_AVUTIL_H
22 #define AVUTIL_AVUTIL_H
32 * @section ffmpeg_intro Introduction
34 * This document describes the usage of the different libraries
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
47 * @defgroup lavu Common utility functions
50 * libavutil contains the code shared across all the other FFmpeg
53 * @note In order to use the functions provided by avutil you must include
54 * the specific header.
58 * @defgroup lavu_crypto Crypto and Hashing
63 * @defgroup lavu_math Maths
68 * @defgroup lavu_string String Manipulation
74 * @defgroup lavu_mem Memory Management
80 * @defgroup lavu_data Data Structures
85 * @defgroup lavu_audio Audio related
91 * @defgroup lavu_error Error Codes
97 * @defgroup lavu_misc Other
101 * @defgroup lavu_internal Internal
103 * Not exported functions, for internal usage only
112 * @addtogroup lavu_ver
117 * Return the LIBAVUTIL_VERSION_INT constant.
119 unsigned avutil_version(void);
122 * Return the libavutil build-time configuration.
124 const char *avutil_configuration(void);
127 * Return the libavutil license.
129 const char *avutil_license(void);
136 * @addtogroup lavu_media Media Type
141 AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
144 AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
145 AVMEDIA_TYPE_SUBTITLE,
146 AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
151 * Return a string describing the media_type enum, NULL if media_type
154 const char *av_get_media_type_string(enum AVMediaType media_type);
157 * @defgroup lavu_const Constants
160 * @defgroup lavu_enc Encoding specific
162 * @note those definition should move to avcodec
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)
171 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
175 * @defgroup lavu_time Timestamp specific
177 * FFmpeg internal timebase and timestamp definitions
183 * @brief Undefined timestamp value
185 * Usually reported by demuxer that work on containers that do not provide
189 #define AV_NOPTS_VALUE ((int64_t)UINT64_C(0x8000000000000000))
192 * Internal time base represented as integer
195 #define AV_TIME_BASE 1000000
198 * Internal time base represented as fractional value
201 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
206 * @defgroup lavu_picture Image related
208 * AVPicture types, pixel formats and basic image planes manipulation.
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
225 * Return a single letter to describe the given picture type
228 * @param[in] pict_type the picture type @return a single character
229 * representing the picture type, '?' if pict_type is unknown
231 char av_get_picture_type_char(enum AVPictureType pict_type);
240 #include "mathematics.h"
241 #include "rational.h"
242 #include "intfloat_readwrite.h"
247 * Return x default pointer in case p is NULL.
249 static inline void *av_x_if_null(const void *p, const void *x)
251 return (void *)(intptr_t)(p ? p : x);
259 #endif /* AVUTIL_AVUTIL_H */