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.
24 * @short_description: Build configuration options
26 * This describes the configuration options for GStreamer. When building
27 * GStreamer there are a lot of parts (known internally as "subsystems" ) that can
28 * be disabled for various reasons. The most common reasons are speed and size,
29 * which is important because GStreamer is designed to run on embedded systems.
31 * If a subsystem is disabled, most of this changes are done in an API compatible
32 * way, so you don't need to adapt your code in most cases. It is never done in an
33 * ABI compatible way though. So if you want to disable a suybsystem, you have to
34 * rebuild all programs depending on GStreamer, too.
36 * If a subsystem is disabled in GStreamer, a value is defined in
37 * <gst/gst.h>. You can check this if you do subsystem-specific stuff.
39 * <title>Doing subsystem specific things</title>
41 * &hash;ifndef GST_DISABLE_GST_DEBUG
42 * // do stuff specific to the debugging subsystem
43 * &hash;endif // GST_DISABLE_GST_DEBUG
48 #ifndef __GST_CONFIG_H__
49 #define __GST_CONFIG_H__
51 /***** trick gtk-doc into believing these symbols are defined (yes, it's ugly) */
54 #define GST_DISABLE_LOADSAVE_REGISTRY 1
55 #define GST_DISABLE_GST_DEBUG 1
56 #define GST_DISABLE_LOADSAVE 1
57 #define GST_DISABLE_PARSE 1
58 #define GST_DISABLE_TRACE 1
59 #define GST_DISABLE_ALLOC_TRACE 1
60 #define GST_DISABLE_REGISTRY 1
61 #define GST_DISABLE_ENUMTYPES 1
62 #define GST_DISABLE_INDEX 1
63 #define GST_DISABLE_PLUGIN 1
64 #define GST_DISABLE_URI 1
67 /***** default padding of structures *****/
69 #define GST_PADDING_INIT {0}
71 /***** disabling of subsystems *****/
73 /* wether or not the debugging subsystem is enabled */
74 @GST_DISABLE_GST_DEBUG_DEFINE@
77 @GST_DISABLE_LOADSAVE_DEFINE@
80 @GST_DISABLE_PARSE_DEFINE@
83 @GST_DISABLE_TRACE_DEFINE@
86 @GST_DISABLE_ALLOC_TRACE_DEFINE@
89 @GST_DISABLE_REGISTRY_DEFINE@
92 @GST_DISABLE_ENUMTYPES_DEFINE@
95 @GST_DISABLE_INDEX_DEFINE@
98 @GST_DISABLE_PLUGIN_DEFINE@
101 @GST_DISABLE_URI_DEFINE@
103 /* printf extension format */
107 * printf format type used to debug GStreamer types.
108 * This can only be used on types whose size is >= sizeof(gpointer).
110 @GST_PRINTF_EXTENSION_FORMAT_DEFINE@
112 /* whether or not the CPU supports unaligned access */
113 @GST_HAVE_UNALIGNED_ACCESS_DEFINE@
115 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
117 #if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )
118 # include <libxml/parser.h>
120 # define GST_DISABLE_LOADSAVE_REGISTRY
126 * Export the given variable from the built shared object.
128 * On Windows, this exports the variable from the DLL.
129 * On other platforms, this gets defined to "extern".
134 * Export the plugin's definition.
136 * On Windows, this exports the plugin definition from the DLL.
137 * On other platforms, this gets defined as a no-op.
140 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
142 #define GST_EXPORT __declspec(dllexport) extern
144 #define GST_EXPORT __declspec(dllimport) extern
146 #else /* not WIN32 */
147 #define GST_PLUGIN_EXPORT
148 #define GST_EXPORT extern
151 #endif /* __GST_CONFIG_H__ */