LGPL
[vlc.git] / include / vlc / libvlc_version.h.in
1 /*****************************************************************************
2  * libvlc_version.h
3  *****************************************************************************
4  * Copyright (C) 2010 RĂ©mi Denis-Courmont
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program 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
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 /**
22  * \file
23  * This file defines version macros for LibVLC.
24  * Those macros are primilarly intended for conditional (pre)compilation.
25  * To get the run-time LibVLC version, use libvlc_get_version() instead
26  * (the run-time version may be more recent than build-time one, thanks to
27  * backward binary compatibility).
28  *
29  * \version This header file is available in LibVLC 1.1.4 and higher.
30  */
31
32 #ifndef LIBVLC_VERSION_H
33 # define LIBVLC_VERSION_H 1
34
35 /** LibVLC major version number */
36 # define LIBVLC_VERSION_MAJOR    (@VERSION_MAJOR@)
37
38 /** LibVLC minor version number */
39 # define LIBVLC_VERSION_MINOR    (@VERSION_MINOR@)
40
41 /** LibVLC revision */
42 # define LIBVLC_VERSION_REVISION (@VERSION_REVISION@)
43
44 # define LIBVLC_VERSION_EXTRA    (0)
45
46 /** Makes a single integer from a LibVLC version numbers */
47 # define LIBVLC_VERSION(maj,min,rev,extra) \
48          ((maj << 24) | (min << 16) | (rev << 8) | (extra))
49
50 /** LibVLC full version as a single integer (for comparison) */
51 # define LIBVLC_VERSION_INT \
52          LIBVLC_VERSION(LIBVLC_VERSION_MAJOR, LIBVLC_VERSION_MINOR, \
53                         LIBVLC_VERSION_REVISION, LIBVLC_VERSION_EXTRA)
54
55 #endif