Merge remote-tracking branch 'origin/0.10'
[platform/upstream/gstreamer.git] / gst / gstversion.h.in
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstversion.h: Version information for GStreamer
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22 /**
23  * SECTION:gstversion
24  * @short_description: GStreamer version macros.
25  *
26  * Use the GST_VERSION_* macros e.g. when defining own plugins. The GStreamer
27  * runtime checks if these plugin and core version match and refuses to use a
28  * plugin compiled against a different version of GStreamer.
29  * You can also use the macros to keep the GStreamer version information in
30  * your application.
31  *
32  * Use the gst_version() function if you want to know which version of
33  * GStreamer you are currently linked against.
34  *
35  * The version macros get defined by including "gst/gst.h".
36  */
37
38 #ifndef __GST_VERSION_H__
39 #define __GST_VERSION_H__
40
41 G_BEGIN_DECLS
42
43 /**
44  * GST_VERSION_MAJOR:
45  *
46  * The major version of GStreamer at compile time:
47  */
48 #define GST_VERSION_MAJOR (@GST_VERSION_MAJOR@)
49 /**
50  * GST_VERSION_MINOR:
51  *
52  * The minor version of GStreamer at compile time:
53  */
54 #define GST_VERSION_MINOR (@GST_VERSION_MINOR@)
55 /**
56  * GST_VERSION_MICRO:
57  *
58  * The micro version of GStreamer at compile time:
59  */
60 #define GST_VERSION_MICRO (@GST_VERSION_MICRO@)
61 /**
62  * GST_VERSION_NANO:
63  *
64  * The nano version of GStreamer at compile time:
65  * Actual releases have 0, GIT versions have 1, prerelease versions have 2-...
66  */
67 #define GST_VERSION_NANO (@GST_VERSION_NANO@)
68
69 /**
70  * GST_CHECK_VERSION:
71  * @major: a number indicating the major version
72  * @minor: a number indicating the minor version
73  * @micro: a number indicating the micro version
74  *
75  * Check whether a GStreamer version equal to or greater than
76  * major.minor.micro is present.
77  *
78  * Since: 0.10.18
79  */
80 #define GST_CHECK_VERSION(major,minor,micro)    \
81     (GST_VERSION_MAJOR > (major) || \
82      (GST_VERSION_MAJOR == (major) && GST_VERSION_MINOR > (minor)) || \
83      (GST_VERSION_MAJOR == (major) && GST_VERSION_MINOR == (minor) && \
84       GST_VERSION_MICRO >= (micro)) || \
85      (GST_VERSION_MAJOR == (major) && GST_VERSION_MINOR == (minor) && \
86       GST_VERSION_MICRO + 1 == (micro) && GST_VERSION_NANO > 0))
87
88 G_END_DECLS
89
90 #endif /* __GST_VERSION_H__ */