gst/gstconfig.h.in

   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 /**
  24  * SECTION:gstconfig
  25  * @short_description: Build configuration options
  26  *
  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
  31  * systems.
  32  *
  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.
  37  *
  38  * If a subsystem is disabled in GStreamer, a value is defined in
  39  * &lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff.
  40  * <example id="example-gstconfig">
  41  * <title>Doing subsystem specific things</title>
  42  * <programlisting>
  43  * &hash;ifndef GST_DISABLE_GST_DEBUG
  44  * // do stuff specific to the debugging subsystem
  45  * &hash;endif // GST_DISABLE_GST_DEBUG
  46  * </programlisting>
  47  * </example>
  48  */
  49
  50 #ifndef __GST_CONFIG_H__
  51 #define __GST_CONFIG_H__
  52
  53 /* trick gtk-doc into believing these symbols are defined (yes, it's ugly) */
  54
  55 #if 0
  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
  66 #endif
  67
  68 /***** default padding of structures *****/
  69 #define GST_PADDING             4
  70 #define GST_PADDING_INIT        { NULL }
  71
  72 /***** padding for very extensible base classes *****/
  73 #define GST_PADDING_LARGE       20
  74
  75 /***** disabling of subsystems *****/
  76
  77 /**
  78  * GST_DISABLE_GST_DEBUG:
  79  *
  80  * Configures the inclusion of the debugging subsystem
  81  */
  82 @GST_DISABLE_GST_DEBUG_DEFINE@
  83
  84 /**
  85  * GST_DISABLE_LOADSAVE:
  86  *
  87  * Configures the inclusion of the plugin graph xml-serialisation
  88  * (was used in 0.8 by gst-editor)
  89  */
  90 @GST_DISABLE_LOADSAVE_DEFINE@
  91
  92 /**
  93  * GST_DISABLE_PARSE:
  94  *
  95  * Configures the inclusion of the gst-lauch parser
  96  */
  97 @GST_DISABLE_PARSE_DEFINE@
  98
  99 /**
 100  * GST_DISABLE_TRACE:
 101  *
 102  * Configures the inclusion of a resource tracing facillity
 103  * (seems to be unused)
 104  */
 105 @GST_DISABLE_TRACE_DEFINE@
 106
 107 /**
 108  * GST_DISABLE_ALLOC_TRACE:
 109  *
 110  * Configures the use of a memory tracer based on the resource tracer
 111  * if TRACE is disabled, ALLOC_TRACE is disabled as well
 112  */
 113 @GST_DISABLE_ALLOC_TRACE_DEFINE@
 114
 115 /**
 116  * GST_DISABLE_REGISTRY:
 117  *
 118  * Configures the use of the plugin registry.
 119  * If one disables this, required plugins need to be loaded and registered
 120  * manually
 121  */
 122 @GST_DISABLE_REGISTRY_DEFINE@
 123
 124 /**
 125  * GST_DISABLE_XML:
 126  *
 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).
 129  */
 130 @GST_DISABLE_XML_DEFINE@
 131
 132 /* FIXME: test and document these! */
 133 /* Configures the use of external plugins */
 134 @GST_DISABLE_PLUGIN_DEFINE@
 135
 136 /* printf extension format */
 137 /**
 138  * GST_PTR_FORMAT:
 139  *
 140  * printf format type used to debug GStreamer types.
 141  * This can only be used on types whose size is >= sizeof(gpointer).
 142  */
 143 @GST_PRINTF_EXTENSION_POINTER_FORMAT_DEFINE@
 144 /**
 145  * GST_SEGMENT_FORMAT:
 146  *
 147  * printf format type used to debug GStreamer segments.
 148  * This can only be used on pointers to GstSegment structures.
 149  *
 150  * Since: 0.10.10
 151  */
 152 @GST_PRINTF_EXTENSION_SEGMENT_FORMAT_DEFINE@
 153
 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@
 158
 159 /* GST_DISABLE_PRINTF_EXTENSION:
 160  *
 161  * Define this to debug your debug log messages and make gcc spew warnings
 162  * if printf format string and arguments don't match up (this is usually
 163  * not the case when libc and gcc are used because printf format warnings
 164  * have to be disabled when the printf extension mechanism is in use).
 165  *
 166  * Note that using this option disables 'pretty logging' of GStreamer objects
 167  * like caps, tags, structures, events, pads etc., so that only their address
 168  * will be printed in the log.
 169  *
 170  * This define only disables use of the special registered printf format
 171  * extensions in the code compiled with it defined. It does not stop
 172  * GStreamer from registering these extensions in the first place if it
 173  * was compiled against a libc that supports this.
 174  *
 175  * (not official API)
 176  */
 177 /* If GLib is not using the system printf, we can't use the registered
 178  * extensions because the GLib-internal printf won't know how to parse them */
 179 #if defined(GST_DISABLE_PRINTF_EXTENSION) || !defined(GLIB_USING_SYSTEM_PRINTF)
 180   #undef GST_PTR_FORMAT
 181   #define GST_PTR_FORMAT "p"
 182   #undef GST_SEGMENT_FORMAT
 183   #define GST_SEGMENT_FORMAT "p"
 184   #undef GST_USING_PRINTF_EXTENSION
 185 #endif
 186
 187 /* whether or not the CPU supports unaligned access */
 188 @GST_HAVE_UNALIGNED_ACCESS_DEFINE@
 189
 190 /* FIXME: 0.11 (remove)
 191  * whether or not we are using glib 2.8 api, e.g. atomic gobject
 192  * refcounting */
 193 @GST_HAVE_GLIB_2_8_DEFINE@
 194
 195 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
 196 /* FIXME: move include to where we need it */
 197 /*#if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )*/
 198 #ifndef GST_DISABLE_XML
 199 #else
 200   /* FIXME: 0.11 (replace by GST_DISABLE_XML) */
 201 # define GST_DISABLE_LOADSAVE_REGISTRY
 202 #endif
 203
 204 /**
 205  * GST_EXPORT:
 206  *
 207  * Export the given variable from the built shared object.
 208  *
 209  * On Windows, this exports the variable from the DLL.
 210  * On other platforms, this gets defined to "extern".
 211  */
 212 /**
 213  * GST_PLUGIN_EXPORT:
 214  *
 215  * Export the plugin's definition.
 216  *
 217  * On Windows, this exports the plugin definition from the DLL.
 218  * On other platforms, this gets defined as a no-op.
 219  */
 220 #ifdef _MSC_VER
 221 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
 222 #ifdef GST_EXPORTS
 223 #define GST_EXPORT __declspec(dllexport) extern
 224 #else
 225 #define GST_EXPORT __declspec(dllimport) extern
 226 #endif
 227 #else /* not _MSC_VER */
 228 #define GST_PLUGIN_EXPORT
 229 #define GST_EXPORT extern
 230 #endif
 231
 232 #endif /* __GST_CONFIG_H__ */