6c32787743973a10b6889416de9472c9dce17e24
[ffmpeg.git] / 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 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
31 #define AV_TOSTRING(s) #s
32
33 #define AV_GLUE(a, b) a ## b
34 #define AV_JOIN(a, b) AV_GLUE(a, b)
35
36 #define AV_PRAGMA(s) _Pragma(#s)
37
38 #define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
39 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
40 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
41
42 #define LIBAVUTIL_VERSION_MAJOR 51
43 #define LIBAVUTIL_VERSION_MINOR 24
44 #define LIBAVUTIL_VERSION_MICRO  0
45
46 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
47                                                LIBAVUTIL_VERSION_MINOR, \
48                                                LIBAVUTIL_VERSION_MICRO)
49 #define LIBAVUTIL_VERSION       AV_VERSION(LIBAVUTIL_VERSION_MAJOR,     \
50                                            LIBAVUTIL_VERSION_MINOR,     \
51                                            LIBAVUTIL_VERSION_MICRO)
52 #define LIBAVUTIL_BUILD         LIBAVUTIL_VERSION_INT
53
54 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
55
56 /**
57  * Those FF_API_* defines are not part of public API.
58  * They may change, break or disappear at any time.
59  */
60 #ifndef FF_API_OLD_EVAL_NAMES
61 #define FF_API_OLD_EVAL_NAMES (LIBAVUTIL_VERSION_MAJOR < 52)
62 #endif
63 #ifndef FF_API_GET_BITS_PER_SAMPLE_FMT
64 #define FF_API_GET_BITS_PER_SAMPLE_FMT (LIBAVUTIL_VERSION_MAJOR < 52)
65 #endif
66 #ifndef FF_API_FIND_OPT
67 #define FF_API_FIND_OPT                 (LIBAVUTIL_VERSION_MAJOR < 52)
68 #endif
69 #ifndef FF_API_AV_FIFO_PEEK
70 #define FF_API_AV_FIFO_PEEK             (LIBAVUTIL_VERSION_MAJOR < 52)
71 #endif
72 #ifndef FF_API_OLD_AVOPTIONS
73 #define FF_API_OLD_AVOPTIONS            (LIBAVUTIL_VERSION_MAJOR < 52)
74 #endif
75
76 /**
77  * Return the LIBAVUTIL_VERSION_INT constant.
78  */
79 unsigned avutil_version(void);
80
81 /**
82  * Return the libavutil build-time configuration.
83  */
84 const char *avutil_configuration(void);
85
86 /**
87  * Return the libavutil license.
88  */
89 const char *avutil_license(void);
90
91 enum AVMediaType {
92     AVMEDIA_TYPE_UNKNOWN = -1,
93     AVMEDIA_TYPE_VIDEO,
94     AVMEDIA_TYPE_AUDIO,
95     AVMEDIA_TYPE_DATA,
96     AVMEDIA_TYPE_SUBTITLE,
97     AVMEDIA_TYPE_ATTACHMENT,
98     AVMEDIA_TYPE_NB
99 };
100
101 /**
102  * Return a string describing the media_type enum, NULL if media_type
103  * is unknown.
104  */
105 const char *av_get_media_type_string(enum AVMediaType media_type);
106
107 #define FF_LAMBDA_SHIFT 7
108 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
109 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
110 #define FF_LAMBDA_MAX (256*128-1)
111
112 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
113
114 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
115 #define AV_TIME_BASE            1000000
116 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
117
118 enum AVPictureType {
119     AV_PICTURE_TYPE_NONE = 0, ///< Undefined
120     AV_PICTURE_TYPE_I,     ///< Intra
121     AV_PICTURE_TYPE_P,     ///< Predicted
122     AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
123     AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
124     AV_PICTURE_TYPE_SI,    ///< Switching Intra
125     AV_PICTURE_TYPE_SP,    ///< Switching Predicted
126     AV_PICTURE_TYPE_BI,    ///< BI type
127 };
128
129 /**
130  * Return a single letter to describe the given picture type
131  * pict_type.
132  *
133  * @param[in] pict_type the picture type @return a single character
134  * representing the picture type, '?' if pict_type is unknown
135  */
136 char av_get_picture_type_char(enum AVPictureType pict_type);
137
138 /**
139  * Return x default pointer in case p is NULL.
140  */
141 static inline const void *av_x_if_null(const void *p, const void *x)
142 {
143     return p ? p : x;
144 }
145
146 #include "common.h"
147 #include "error.h"
148 #include "mathematics.h"
149 #include "rational.h"
150 #include "intfloat_readwrite.h"
151 #include "log.h"
152 #include "pixfmt.h"
153
154 #endif /* AVUTIL_AVUTIL_H */