3e94a23ca39014decc900f63761557af71cddd55
[ffmpeg.git] / libavutil / version.h
1 /*
2  * copyright (c) 2003 Fabrice Bellard
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 /**
22  * @file
23  * @ingroup lavu
24  * Libavutil version macros
25  */
26
27 #ifndef AVUTIL_VERSION_H
28 #define AVUTIL_VERSION_H
29
30 #include "macros.h"
31
32 /**
33  * @addtogroup version_utils
34  *
35  * Useful to check and match library version in order to maintain
36  * backward compatibility.
37  *
38  * @{
39  */
40
41 #define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
42 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
43 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
44
45 /**
46  * Extract version components from the full ::AV_VERSION_INT int as returned
47  * by functions like ::avformat_version() and ::avcodec_version()
48  */
49 #define AV_VERSION_MAJOR(a) ((a) >> 16)
50 #define AV_VERSION_MINOR(a) (((a) & 0x00FF00) >> 8)
51 #define AV_VERSION_MICRO(a) ((a) & 0xFF)
52
53 /**
54  * @}
55  */
56
57 /**
58  * @defgroup lavu_ver Version and Build diagnostics
59  *
60  * Macros and function useful to check at compiletime and at runtime
61  * which version of libavutil is in use.
62  *
63  * @{
64  */
65
66 #define LIBAVUTIL_VERSION_MAJOR  55
67 #define LIBAVUTIL_VERSION_MINOR  29
68 #define LIBAVUTIL_VERSION_MICRO 100
69
70 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
71                                                LIBAVUTIL_VERSION_MINOR, \
72                                                LIBAVUTIL_VERSION_MICRO)
73 #define LIBAVUTIL_VERSION       AV_VERSION(LIBAVUTIL_VERSION_MAJOR,     \
74                                            LIBAVUTIL_VERSION_MINOR,     \
75                                            LIBAVUTIL_VERSION_MICRO)
76 #define LIBAVUTIL_BUILD         LIBAVUTIL_VERSION_INT
77
78 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
79
80 /**
81  * @defgroup lavu_depr_guards Deprecation Guards
82  * FF_API_* defines may be placed below to indicate public API that will be
83  * dropped at a future version bump. The defines themselves are not part of
84  * the public API and may change, break or disappear at any time.
85  *
86  * @note, when bumping the major version it is recommended to manually
87  * disable each FF_API_* in its own commit instead of disabling them all
88  * at once through the bump. This improves the git bisect-ability of the change.
89  *
90  * @{
91  */
92
93 #ifndef FF_API_VDPAU
94 #define FF_API_VDPAU                    (LIBAVUTIL_VERSION_MAJOR < 56)
95 #endif
96 #ifndef FF_API_XVMC
97 #define FF_API_XVMC                     (LIBAVUTIL_VERSION_MAJOR < 56)
98 #endif
99 #ifndef FF_API_OPT_TYPE_METADATA
100 #define FF_API_OPT_TYPE_METADATA        (LIBAVUTIL_VERSION_MAJOR < 56)
101 #endif
102 #ifndef FF_API_DLOG
103 #define FF_API_DLOG                     (LIBAVUTIL_VERSION_MAJOR < 56)
104 #endif
105 #ifndef FF_API_VAAPI
106 #define FF_API_VAAPI                    (LIBAVUTIL_VERSION_MAJOR < 56)
107 #endif
108 #ifndef FF_API_FRAME_QP
109 #define FF_API_FRAME_QP                 (LIBAVUTIL_VERSION_MAJOR < 56)
110 #endif
111 #ifndef FF_API_PLUS1_MINUS1
112 #define FF_API_PLUS1_MINUS1             (LIBAVUTIL_VERSION_MAJOR < 56)
113 #endif
114 #ifndef FF_API_ERROR_FRAME
115 #define FF_API_ERROR_FRAME              (LIBAVUTIL_VERSION_MAJOR < 56)
116 #endif
117 #ifndef FF_API_CRC_BIG_TABLE
118 #define FF_API_CRC_BIG_TABLE            (LIBAVUTIL_VERSION_MAJOR < 56)
119 #endif
120
121
122 /**
123  * @}
124  * @}
125  */
126
127 #endif /* AVUTIL_VERSION_H */