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  * SECTION:gstconfig
  24  * @short_description: Build configuration options
  25  *
  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.
  30  *
  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.
  35  *
  36  * If a subsystem is disabled in GStreamer, a value is defined in
  37  * &lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff.
  38  * <example>
  39  * <title>Doing subsystem specific things</title>
  40  * <programlisting>
  41  * &hash;ifndef GST_DISABLE_GST_DEBUG
  42  * // do stuff specific to the debugging subsystem
  43  * &hash;endif // GST_DISABLE_GST_DEBUG
  44  * </programlisting>
  45  * </example>
  46  */
  47
  48 #ifndef __GST_CONFIG_H__
  49 #define __GST_CONFIG_H__
  50
  51 /***** trick gtk-doc into believing these symbols are defined (yes, it's ugly) */
  52
  53 #if 0
  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
  65 #endif
  66
  67 /***** default padding of structures *****/
  68 #define GST_PADDING             4
  69 #define GST_PADDING_INIT        {0}
  70
  71 /***** disabling of subsystems *****/
  72
  73 /* wether or not the debugging subsystem is enabled */
  74 @GST_DISABLE_GST_DEBUG_DEFINE@
  75
  76 /* DOES NOT WORK */
  77 @GST_DISABLE_LOADSAVE_DEFINE@
  78
  79 /* DOES NOT WORK */
  80 @GST_DISABLE_PARSE_DEFINE@
  81
  82 /* DOES NOT WORK */
  83 @GST_DISABLE_TRACE_DEFINE@
  84
  85 /* DOES NOT WORK */
  86 @GST_DISABLE_ALLOC_TRACE_DEFINE@
  87
  88 /* DOES NOT WORK */
  89 @GST_DISABLE_REGISTRY_DEFINE@
  90
  91 /* DOES NOT WORK */
  92 @GST_DISABLE_ENUMTYPES_DEFINE@
  93
  94 /* DOES NOT WORK */
  95 @GST_DISABLE_INDEX_DEFINE@
  96
  97 /* DOES NOT WORK */
  98 @GST_DISABLE_PLUGIN_DEFINE@
  99
 100 /* DOES NOT WORK */
 101 @GST_DISABLE_URI_DEFINE@
 102
 103 /* printf extension format */
 104 /**
 105  * GST_PTR_FORMAT:
 106  *
 107  * printf format type used to debug GStreamer types.
 108  * This can only be used on types whose size is >= sizeof(gpointer).
 109  */
 110 @GST_PRINTF_EXTENSION_FORMAT_DEFINE@
 111
 112 /* whether or not the CPU supports unaligned access */
 113 @GST_HAVE_UNALIGNED_ACCESS_DEFINE@
 114
 115 /***** Deal with XML stuff, we have to handle both loadsave and registry *****/
 116
 117 #if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )
 118 # include <libxml/parser.h>
 119 #else
 120 # define GST_DISABLE_LOADSAVE_REGISTRY
 121 #endif
 122
 123 /**
 124  * GST_EXPORT:
 125  *
 126  * Export the given variable from the built shared object.
 127  *
 128  * On Windows, this exports the variable from the DLL.
 129  * On other platforms, this gets defined to "extern".
 130  */
 131 /**
 132  * GST_PLUGIN_EXPORT:
 133  *
 134  * Export the plugin's definition.
 135  *
 136  * On Windows, this exports the plugin definition from the DLL.
 137  * On other platforms, this gets defined as a no-op.
 138  */
 139 #if defined(WIN32) && (!defined(__MINGW32__))
 140 #define GST_PLUGIN_EXPORT __declspec(dllexport) extern
 141 #ifdef GST_EXPORTS
 142 #define GST_EXPORT __declspec(dllexport) extern
 143 #else
 144 #define GST_EXPORT __declspec(dllimport) extern
 145 #endif
 146 #else /* not WIN32 */
 147 #define GST_PLUGIN_EXPORT
 148 #define GST_EXPORT extern
 149 #endif
 150
 151 #endif /* __GST_CONFIG_H__ */