1 /* GStreamer
2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2004,2005 Wim Taymans <wim@fluendo.com>
4 *
5 * gstconfig.h: GST_DISABLE_* macros for build configuration
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:gstconfig
24 * @short_description: Build configuration options
25 *
26 * This describes the configuration options for GStreamer. When building
27 * GStreamer there are a lot of parts (known internally as "subsystems" ) that
28 * can be disabled for various reasons. The most common reasons are speed and
29 * size, which is important because GStreamer is designed to run on embedded
30 * systems.
31 *
32 * If a subsystem is disabled, most of this changes are done in an API
33 * compatible way, so you don't need to adapt your code in most cases. It is
34 * never done in an ABI compatible way though. So if you want to disable a
35 * suybsystem, you have to rebuild all programs depending on GStreamer, too.
36 *
37 * If a subsystem is disabled in GStreamer, a value is defined in
38 * <gst/gst.h>. You can check this if you do subsystem-specific stuff.
39 * <example>
40 * <title>Doing subsystem specific things</title>
41 * <programlisting>
42 * &hash;ifndef GST_DISABLE_GST_DEBUG
43 * // do stuff specific to the debugging subsystem
44 * &hash;endif // GST_DISABLE_GST_DEBUG
45 * </programlisting>
46 * </example>
47 */
49 #ifndef __GST_CONFIG_H__
50 #define __GST_CONFIG_H__
52 /*** trick gtk-doc into believing these symbols are defined (yes, it's ugly) */
54 #if 0
55 #define GST_DISABLE_LOADSAVE_REGISTRY 1
56 #define GST_DISABLE_GST_DEBUG 1
57 #define GST_DISABLE_LOADSAVE 1
58 #define GST_DISABLE_PARSE 1
59 #define GST_DISABLE_TRACE 1
60 #define GST_DISABLE_ALLOC_TRACE 1
61 #define GST_DISABLE_REGISTRY 1
62 #define GST_DISABLE_PLUGIN 1
63 #define GST_HAVE_GLIB_2_8 1
64 #endif
66 /***** default padding of structures *****/
67 #define GST_PADDING 4
68 #define GST_PADDING_INIT {0}
70 /***** padding for very extensible base classes *****/
71 #define GST_PADDING_LARGE 20
74 /***** disabling of subsystems *****/
76 /* wether or not the debugging subsystem is enabled */
77 /* #undef GST_DISABLE_GST_DEBUG */
79 /* DOES NOT WORK */
80 /* #undef GST_DISABLE_LOADSAVE */
82 /* DOES NOT WORK */
83 /* #undef GST_DISABLE_PARSE */
85 /* DOES NOT WORK */
86 /* #undef GST_DISABLE_TRACE */
88 /* DOES NOT WORK */
89 /* #undef GST_DISABLE_ALLOC_TRACE */
91 /* DOES NOT WORK */
92 /* #undef GST_DISABLE_REGISTRY */
94 /* DOES NOT WORK */
95 /* #undef GST_DISABLE_PLUGIN */
97 /* printf extension format */
98 /**
99 * GST_PTR_FORMAT:
100 *
101 * printf format type used to debug GStreamer types.
102 * This can only be used on types whose size is >= sizeof(gpointer).
103 */
104 #define GST_PTR_FORMAT "p"
106 /**
107 * GST_SEGMENT_FORMAT:
108 *
109 * printf format type used to debug GStreamer segments.
110 * This can only be used on pointers to GstSegment structures.
111 *
112 * Since: 0.10.10
113 */
114 #define GST_SEGMENT_FORMAT "p"
116 /* whether or not GST_PTR_FORMAT or GST_SEGMENT_FORMAT are using
117 * the printf extension mechanism. This is for internal use in our
118 * header files so we know whether we can use G_GNUC_PRINTF or not */
119 #undef GST_USING_PRINTF_EXTENSION
121 /* whether or not the CPU supports unaligned access */
122 #define GST_HAVE_UNALIGNED_ACCESS 1
124 /* whether or not we are using glib 2.8 api, e.g. atomic gobject
125 refcounting */
126 #define GST_HAVE_GLIB_2_8 1
128 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
130 #if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )
131 # include <libxml/parser.h>
132 #else
133 # define GST_DISABLE_LOADSAVE_REGISTRY
134 #endif
136 /**
137 * GST_EXPORT:
138 *
139 * Export the given variable from the built shared object.
140 *
141 * On Windows, this exports the variable from the DLL.
142 * On other platforms, this gets defined to "extern".
143 */
144 /**
145 * GST_PLUGIN_EXPORT:
146 *
147 * Export the plugin's definition.
148 *
149 * On Windows, this exports the plugin definition from the DLL.
150 * On other platforms, this gets defined as a no-op.
151 */
152 #if defined(WIN32) && (!defined(__MINGW32__))
153 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
154 #ifdef GST_EXPORTS
155 #define GST_EXPORT __declspec(dllexport) extern
156 #else
157 #define GST_EXPORT __declspec(dllimport) extern
158 #endif
159 #else /* not WIN32 */
160 #define GST_PLUGIN_EXPORT
161 #define GST_EXPORT extern
162 #endif
164 #endif /* __GST_CONFIG_H__ */