2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2004,2005 Wim Taymans <wim@fluendo.com>
5 * gstconfig.h: GST_DISABLE_* macros for build configuration
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.
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.
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.
25 * @short_description: Build configuration options
27 * This describes the configuration options for GStreamer. When building
28 * GStreamer there are a lot of parts (known internally as "subsystems" ) that
29 * can be disabled for various reasons. The most common reasons are speed and
30 * size, which is important because GStreamer is designed to run on embedded
33 * If a subsystem is disabled, most of this changes are done in an API
34 * compatible way, so you don't need to adapt your code in most cases. It is
35 * never done in an ABI compatible way though. So if you want to disable a
36 * suybsystem, you have to rebuild all programs depending on GStreamer, too.
38 * If a subsystem is disabled in GStreamer, a value is defined in
39 * <gst/gst.h>. You can check this if you do subsystem-specific stuff.
40 * <example id="example-gstconfig">
41 * <title>Doing subsystem specific things</title>
43 * &hash;ifndef GST_DISABLE_GST_DEBUG
44 * // do stuff specific to the debugging subsystem
45 * &hash;endif // GST_DISABLE_GST_DEBUG
50 #ifndef __GST_CONFIG_H__
51 #define __GST_CONFIG_H__
53 /* trick gtk-doc into believing these symbols are defined (yes, it's ugly) */
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_DISABLE_XML 1
64 #define GST_DISABLE_LOADSAVE_REGISTRY 1
65 #define GST_HAVE_GLIB_2_8 1
68 /***** default padding of structures *****/
70 #define GST_PADDING_INIT { NULL }
72 /***** padding for very extensible base classes *****/
73 #define GST_PADDING_LARGE 20
75 /***** disabling of subsystems *****/
78 * GST_DISABLE_GST_DEBUG:
80 * Configures the inclusion of the debugging subsystem
82 @GST_DISABLE_GST_DEBUG_DEFINE@
85 * GST_DISABLE_LOADSAVE:
87 * Configures the inclusion of the plugin graph xml-serialisation
88 * (was used in 0.8 by gst-editor)
90 @GST_DISABLE_LOADSAVE_DEFINE@
95 * Configures the inclusion of the gst-lauch parser
97 @GST_DISABLE_PARSE_DEFINE@
102 * Configures the inclusion of a resource tracing facillity
103 * (seems to be unused)
105 @GST_DISABLE_TRACE_DEFINE@
108 * GST_DISABLE_ALLOC_TRACE:
110 * Configures the use of a memory tracer based on the resource tracer
111 * if TRACE is disabled, ALLOC_TRACE is disabled as well
113 @GST_DISABLE_ALLOC_TRACE_DEFINE@
116 * GST_DISABLE_REGISTRY:
118 * Configures the use of the plugin registry.
119 * If one disables this, required plugins need to be loaded and registered
122 @GST_DISABLE_REGISTRY_DEFINE@
127 * Configures the use libxml2. This setting is derived from the settings of
128 * %GST_DISABLE_LOADSAVE and %GST_DISABLE_REGISTRY (in the xml registry case).
130 @GST_DISABLE_XML_DEFINE@
132 /* FIXME: test and document these! */
133 /* Configures the use of external plugins */
134 @GST_DISABLE_PLUGIN_DEFINE@
136 /* printf extension format */
140 * printf format type used to debug GStreamer types.
141 * This can only be used on types whose size is >= sizeof(gpointer).
143 @GST_PRINTF_EXTENSION_POINTER_FORMAT_DEFINE@
145 * GST_SEGMENT_FORMAT:
147 * printf format type used to debug GStreamer segments.
148 * This can only be used on pointers to GstSegment structures.
152 @GST_PRINTF_EXTENSION_SEGMENT_FORMAT_DEFINE@
154 /* whether or not GST_PTR_FORMAT or GST_SEGMENT_FORMAT are using
155 * the printf extension mechanism. This is for internal use in our
156 * header files so we know whether we can use G_GNUC_PRINTF or not */
157 @GST_USING_PRINTF_EXTENSION_DEFINE@
159 /* whether or not the CPU supports unaligned access */
160 @GST_HAVE_UNALIGNED_ACCESS_DEFINE@
162 /* FIXME: 0.11 (remove)
163 * whether or not we are using glib 2.8 api, e.g. atomic gobject
165 @GST_HAVE_GLIB_2_8_DEFINE@
167 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
168 /* FIXME: move include to where we need it */
169 /*#if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )*/
170 #ifndef GST_DISABLE_XML
171 # include <libxml/parser.h>
173 /* FIXME: 0.11 (replace by GST_DISABLE_XML) */
174 # define GST_DISABLE_LOADSAVE_REGISTRY
180 * Export the given variable from the built shared object.
182 * On Windows, this exports the variable from the DLL.
183 * On other platforms, this gets defined to "extern".
188 * Export the plugin's definition.
190 * On Windows, this exports the plugin definition from the DLL.
191 * On other platforms, this gets defined as a no-op.
194 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
196 #define GST_EXPORT __declspec(dllexport) extern
198 #define GST_EXPORT __declspec(dllimport) extern
200 #else /* not _MSC_VER */
201 #define GST_PLUGIN_EXPORT
202 #define GST_EXPORT extern
205 #endif /* __GST_CONFIG_H__ */