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 

   147 /**

   148  * @addtogroup lavu_ver

   149  * @{

   150  */

   151 

   152 /**

   153  * Return the LIBAVUTIL_VERSION_INT constant.

   154  */

   155 unsigned avutil_version(void);

   156 

   157 /**

   158  * Return the libavutil build-time configuration.

   159  */

   160 const char *avutil_configuration(void);

   161 

   162 /**

   163  * Return the libavutil license.

   164  */

   165 const char *avutil_license(void);

   166 

   167 /**

   168  * @}

   169  */

   170 

   171 /**

   172  * @addtogroup lavu_media Media Type

   173  * @brief Media Type

   174  */

   175 

   176 enum AVMediaType {

   177     AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA

   178     AVMEDIA_TYPE_VIDEO,

   179     AVMEDIA_TYPE_AUDIO,

   180     AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous

   181     AVMEDIA_TYPE_SUBTITLE,

   182     AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse

   183     AVMEDIA_TYPE_NB

   184 };

   185 

   186 /**

   187  * @defgroup lavu_const Constants

   188  * @{

   189  *

   190  * @defgroup lavu_enc Encoding specific

   191  *

   192  * @note those definition should move to avcodec

   193  * @{

   194  */

   195 

   196 #define FF_LAMBDA_SHIFT 7

   197 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)

   198 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda

   199 #define FF_LAMBDA_MAX (256*128-1)

   200 

   201 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove

   202 

   203 /**

   204  * @}

   205  * @defgroup lavu_time Timestamp specific

   206  *

   207  * Libav internal timebase and timestamp definitions

   208  *

   209  * @{

   210  */

   211 

   212 /**

   213  * @brief Undefined timestamp value

   214  *

   215  * Usually reported by demuxer that work on containers that do not provide

   216  * either pts or dts.

   217  */

   218 

   219 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)

   220 

   221 /**

   222  * Internal time base represented as integer

   223  */

   224 

   225 #define AV_TIME_BASE            1000000

   226 

   227 /**

   228  * Internal time base represented as fractional value

   229  */

   230 

   231 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}

   232 

   233 /**

   234  * @}

   235  * @}

   236  * @defgroup lavu_picture Image related

   237  *

   238  * AVPicture types, pixel formats and basic image planes manipulation.

   239  *

   240  * @{

   241  */

   242 

   243 enum AVPictureType {

   244     AV_PICTURE_TYPE_I = 1, ///< Intra

   245     AV_PICTURE_TYPE_P,     ///< Predicted

   246     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted

   247     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4

   248     AV_PICTURE_TYPE_SI,    ///< Switching Intra

   249     AV_PICTURE_TYPE_SP,    ///< Switching Predicted

   250     AV_PICTURE_TYPE_BI,    ///< BI type

   251 };

   252 

   253 /**

   254  * Return a single letter to describe the given picture type

   255  * pict_type.

   256  *

   257  * @param[in] pict_type the picture type @return a single character

   258  * representing the picture type, '?' if pict_type is unknown

   259  */

   260 char av_get_picture_type_char(enum AVPictureType pict_type);

   261 

   262 /**

   263  * @}

   264  */

   265 

   266 #include "error.h"

   267 #include "version.h"

   268 

   269 /**

   270  * @}

   271  * @}

   272  */

   273 

   274 #endif /* AVUTIL_AVUTIL_H */