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>
  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_LOADSAVE_REGISTRY 1
  57 #define GST_DISABLE_GST_DEBUG 1
  58 #define GST_DISABLE_LOADSAVE 1
  59 #define GST_DISABLE_PARSE 1
  60 #define GST_DISABLE_TRACE 1
  61 #define GST_DISABLE_ALLOC_TRACE 1
  62 #define GST_DISABLE_REGISTRY 1
  63 #define GST_DISABLE_ENUMTYPES 1
  64 #define GST_DISABLE_INDEX 1
  65 #define GST_DISABLE_PLUGIN 1
  66 #define GST_DISABLE_URI 1
  67 #define GST_HAVE_GLIB_2_8 1
  68 #endif
  69
  70 /***** default padding of structures *****/
  71 #define GST_PADDING             4
  72 #define GST_PADDING_INIT        {0}
  73
  74 /***** padding for very extensible base classes *****/
  75 #define GST_PADDING_LARGE       20
  76
  77 /***** disabling of subsystems *****/
  78
  79 /**
  80  * GST_DISABLE_GST_DEBUG:
  81  *
  82  * Configures the inclusion of the debugging subsystem
  83  */
  84 @GST_DISABLE_GST_DEBUG_DEFINE@
  85
  86 /**
  87  * GST_DISABLE_LOADSAVE:
  88  *
  89  * Configures the inclusion of the plugin graph xml-serialisation
  90  * (was used in 0.8 by gst-editor)
  91  */
  92 @GST_DISABLE_LOADSAVE_DEFINE@
  93
  94 /**
  95  * GST_DISABLE_PARSE:
  96  *
  97  * Configures the inclusion of the gst-lauch parser
  98  */
  99 @GST_DISABLE_PARSE_DEFINE@
 100
 101 /**
 102  * GST_DISABLE_TRACE:
 103  *
 104  * Configures the inclusion of a resource tracing facillity
 105  * (seems to be unused)
 106  */
 107 @GST_DISABLE_TRACE_DEFINE@
 108
 109 /**
 110  * GST_DISABLE_ALLOC_TRACE:
 111  *
 112  * Configures the use of a memory tracer based on the resource tracer
 113  * if TRACE is disabled, ALLOC_TRACE is disabled as well
 114  */
 115 @GST_DISABLE_ALLOC_TRACE_DEFINE@
 116
 117 /**
 118  * GST_DISABLE_REGISTRY:
 119  *
 120  * Configures the use of the plugin registry
 121  * if one disables this, required plugins need to be loaded and registered
 122  * manualy
 123  */
 124 @GST_DISABLE_REGISTRY_DEFINE@
 125
 126 /* FIXME: test and document these! */
 127 /* Configure the use of glib enumtypes (useful for introspection)
 128  * see http://bugzilla.gnome.org/show_bug.cgi?id=342564
 129  */
 130 @GST_DISABLE_ENUMTYPES_DEFINE@
 131 /* Configure the use of indizies for seeking
 132  * (not used in plugins right now)
 133  */
 134 @GST_DISABLE_INDEX_DEFINE@
 135 /* Configures the use of external plugins */
 136 @GST_DISABLE_PLUGIN_DEFINE@
 137 /* Configures the use of uri-handlers */
 138 @GST_DISABLE_URI_DEFINE@
 139
 140 /* printf extension format */
 141 /**
 142  * GST_PTR_FORMAT:
 143  *
 144  * printf format type used to debug GStreamer types.
 145  * This can only be used on types whose size is >= sizeof(gpointer).
 146  */
 147 @GST_PRINTF_EXTENSION_POINTER_FORMAT_DEFINE@
 148 /**
 149  * GST_SEGMENT_FORMAT:
 150  *
 151  * printf format type used to debug GStreamer segments.
 152  * This can only be used on pointers to GstSegment structures.
 153  *
 154  * Since: 0.10.10
 155  */
 156 @GST_PRINTF_EXTENSION_SEGMENT_FORMAT_DEFINE@
 157
 158 /* whether or not GST_PTR_FORMAT or GST_SEGMENT_FORMAT are using
 159  * the printf extension mechanism. This is for internal use in our
 160  * header files so we know whether we can use G_GNUC_PRINTF or not */
 161 @GST_USING_PRINTF_EXTENSION_DEFINE@
 162
 163 /* whether or not the CPU supports unaligned access */
 164 @GST_HAVE_UNALIGNED_ACCESS_DEFINE@
 165
 166 /* whether or not we are using glib 2.8 api, e.g. atomic gobject
 167    refcounting */
 168 @GST_HAVE_GLIB_2_8_DEFINE@
 169
 170 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
 171
 172 #if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )
 173 # include <libxml/parser.h>
 174 #else
 175 # define GST_DISABLE_LOADSAVE_REGISTRY
 176 #endif
 177
 178 /**
 179  * GST_EXPORT:
 180  *
 181  * Export the given variable from the built shared object.
 182  *
 183  * On Windows, this exports the variable from the DLL.
 184  * On other platforms, this gets defined to "extern".
 185  */
 186 /**
 187  * GST_PLUGIN_EXPORT:
 188  *
 189  * Export the plugin's definition.
 190  *
 191  * On Windows, this exports the plugin definition from the DLL.
 192  * On other platforms, this gets defined as a no-op.
 193  */
 194 #ifdef _MSC_VER
 195 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
 196 #ifdef GST_EXPORTS
 197 #define GST_EXPORT __declspec(dllexport) extern
 198 #else
 199 #define GST_EXPORT __declspec(dllimport) extern
 200 #endif
 201 #else /* not _MSC_VER */
 202 #define GST_PLUGIN_EXPORT
 203 #define GST_EXPORT extern
 204 #endif
 205
 206 #endif /* __GST_CONFIG_H__ */