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 /* configures the inclusion of the debugging subsystem */
  80 @GST_DISABLE_GST_DEBUG_DEFINE@
  81
  82 /* configures the inclusion of the plugin graph xml-serialisation
  83  * (was used in 0.8 by gst-editor)
  84  */
  85 @GST_DISABLE_LOADSAVE_DEFINE@
  86
  87 /* configures the inclusion of the gst-lauch parser */
  88 @GST_DISABLE_PARSE_DEFINE@
  89
  90 /* configures the inclusion of a resource tracing facillity
  91  * (seems to be unused)
  92  */
  93 @GST_DISABLE_TRACE_DEFINE@
  94
  95 /* configures the use of a memory tracer based on the resource tracer
  96  * if TRACE is disabled, ALLOC_TRACE is disabled as well
  97  */
  98 @GST_DISABLE_ALLOC_TRACE_DEFINE@
  99
 100 /* configures the use of the plugin registry
 101  * if one disables this, required plugins need to be loaded and registered
 102  * manualy
 103  */
 104 @GST_DISABLE_REGISTRY_DEFINE@
 105
 106 /* DOES NOT WORK */
 107 @GST_DISABLE_ENUMTYPES_DEFINE@
 108
 109 /* DOES NOT WORK */
 110 @GST_DISABLE_INDEX_DEFINE@
 111
 112 /* DOES NOT WORK */
 113 @GST_DISABLE_PLUGIN_DEFINE@
 114
 115 /* DOES NOT WORK */
 116 @GST_DISABLE_URI_DEFINE@
 117
 118 /* printf extension format */
 119 /**
 120  * GST_PTR_FORMAT:
 121  *
 122  * printf format type used to debug GStreamer types.
 123  * This can only be used on types whose size is >= sizeof(gpointer).
 124  */
 125 @GST_PRINTF_EXTENSION_FORMAT_DEFINE@
 126
 127 /* whether or not the CPU supports unaligned access */
 128 @GST_HAVE_UNALIGNED_ACCESS_DEFINE@
 129
 130 /* whether or not we are using glib 2.8 api, e.g. atomic gobject
 131    refcounting */
 132 @GST_HAVE_GLIB_2_8_DEFINE@
 133
 134 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
 135
 136 #if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )
 137 # include <libxml/parser.h>
 138 #else
 139 # define GST_DISABLE_LOADSAVE_REGISTRY
 140 #endif
 141
 142 /**
 143  * GST_EXPORT:
 144  *
 145  * Export the given variable from the built shared object.
 146  *
 147  * On Windows, this exports the variable from the DLL.
 148  * On other platforms, this gets defined to "extern".
 149  */
 150 /**
 151  * GST_PLUGIN_EXPORT:
 152  *
 153  * Export the plugin's definition.
 154  *
 155  * On Windows, this exports the plugin definition from the DLL.
 156  * On other platforms, this gets defined as a no-op.
 157  */
 158 #if defined(WIN32) && (!defined(__MINGW32__))
 159 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
 160 #ifdef GST_EXPORTS
 161 #define GST_EXPORT __declspec(dllexport) extern
 162 #else
 163 #define GST_EXPORT __declspec(dllimport) extern
 164 #endif
 165 #else /* not WIN32 */
 166 #define GST_PLUGIN_EXPORT
 167 #define GST_EXPORT extern
 168 #endif
 169
 170 #endif /* __GST_CONFIG_H__ */