/* * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at> * * This file is part of Libav. * * Libav is free software; you can redistribute it and/or * 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. * * Libav is distributed in the hope that it will be useful, * 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 * License along with Libav; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef AVUTIL_AVUTIL_H #define AVUTIL_AVUTIL_H /** * @file * external API header */ /** * @mainpage * * @section libav_intro Introduction * * This document describes the usage of the different libraries * provided by Libav. * * @li @ref libavc "libavcodec" encoding/decoding library * @li @ref lavfi "libavfilter" graph-based frame editing library * @li @ref libavf "libavformat" I/O and muxing/demuxing library * @li @ref lavd "libavdevice" special devices muxing/demuxing library * @li @ref lavu "libavutil" common utility library * @li @ref lavr "libavresample" audio resampling, format conversion and mixing * @li @ref libsws "libswscale" color conversion and scaling library * * @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. */ /** * @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_log Logging Facility * * @{ * * @} * * @defgroup lavu_misc Other * * @{ * * @defgroup lavu_internal Internal * * Not exported functions, for internal usage only * * @{ * * @} * * @defgroup preproc_misc Preprocessor String Macros * * @{ * * @} */ /** * @addtogroup lavu_ver * @{ */ /** * Return the LIBAVUTIL_VERSION_INT constant. */ unsigned avutil_version(void); /** * Return the libavutil build-time configuration. */ const char *avutil_configuration(void); /** * Return the libavutil license. */ const char *avutil_license(void); /** * @} */ /** * @addtogroup lavu_media Media Type * @brief Media Type */ enum AVMediaType { AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA AVMEDIA_TYPE_VIDEO, AVMEDIA_TYPE_AUDIO, AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous AVMEDIA_TYPE_SUBTITLE, AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse AVMEDIA_TYPE_NB }; /** * @defgroup lavu_const Constants * @{ * * @defgroup lavu_enc Encoding specific * * @note those definition should move to avcodec * @{ */ #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 /** * @} * @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. */ #define AV_NOPTS_VALUE INT64_C(0x8000000000000000) /** * Internal time base represented as integer */ #define AV_TIME_BASE 1000000 /** * Internal time base represented as fractional value */ #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE} /** * @} * @} * @defgroup lavu_picture Image related * * AVPicture types, pixel formats and basic image planes manipulation. * * @{ */ 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); /** * @} */ #include "error.h" #include "rational.h" #include "version.h" #include "macros.h" /** * Return the fractional representation of the internal time base. */ AVRational av_get_time_base_q(void); /** * @} * @} */ #endif /* AVUTIL_AVUTIL_H */