blob: 8460281e91416f2feb98ce90892d2918a51df2e7 [file] [log] [blame]
/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2004,2005 Wim Taymans <wim@fluendo.com>
*
* gstconfig.h: GST_DISABLE_* macros for build configuration
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstconfig
* @short_description: Build configuration options
*
* This describes the configuration options for GStreamer. When building
* GStreamer there are a lot of parts (known internally as "subsystems" ) that
* can be disabled for various reasons. The most common reasons are speed and
* size, which is important because GStreamer is designed to run on embedded
* systems.
*
* If a subsystem is disabled, most of this changes are done in an API
* compatible way, so you don't need to adapt your code in most cases. It is
* never done in an ABI compatible way though. So if you want to disable a
* subsystem, you have to rebuild all programs depending on GStreamer, too.
*
* If a subsystem is disabled in GStreamer, a value is defined in
* &lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff.
* <example id="example-gstconfig">
* <title>Doing subsystem specific things</title>
* <programlisting>
* &hash;ifndef GST_DISABLE_GST_DEBUG
* // do stuff specific to the debugging subsystem
* &hash;endif // GST_DISABLE_GST_DEBUG
* </programlisting>
* </example>
*/
#ifndef __GST_CONFIG_H__
#define __GST_CONFIG_H__
/* trick gtk-doc into believing these symbols are defined (yes, it's ugly) */
#if 0
#define GST_DISABLE_GST_DEBUG 1
#define GST_DISABLE_PARSE 1
#define GST_DISABLE_TRACE 1
#define GST_DISABLE_ALLOC_TRACE 1
#define GST_DISABLE_REGISTRY 1
#define GST_DISABLE_PLUGIN 1
#define GST_HAVE_GLIB_2_8 1
#endif
/***** default padding of structures *****/
#define GST_PADDING 4
#define GST_PADDING_INIT { NULL }
/***** padding for very extensible base classes *****/
#define GST_PADDING_LARGE 20
/***** disabling of subsystems *****/
/**
* GST_DISABLE_GST_DEBUG:
*
* Configures the inclusion of the debugging subsystem
*/
@GST_DISABLE_GST_DEBUG_DEFINE@
/**
* GST_DISABLE_PARSE:
*
* Configures the inclusion of the gst-launch parser
*/
@GST_DISABLE_PARSE_DEFINE@
/**
* GST_DISABLE_TRACE:
*
* Configures the inclusion of a resource tracing facility
* (seems to be unused)
*/
@GST_DISABLE_TRACE_DEFINE@
/**
* GST_DISABLE_ALLOC_TRACE:
*
* Configures the use of a memory tracer based on the resource tracer
* if TRACE is disabled, ALLOC_TRACE is disabled as well
*/
@GST_DISABLE_ALLOC_TRACE_DEFINE@
/**
* GST_DISABLE_REGISTRY:
*
* Configures the use of the plugin registry.
* If one disables this, required plugins need to be loaded and registered
* manually
*/
@GST_DISABLE_REGISTRY_DEFINE@
/* FIXME: test and document these! */
/* Configures the use of external plugins */
@GST_DISABLE_PLUGIN_DEFINE@
/* whether or not the CPU supports unaligned access */
@GST_HAVE_UNALIGNED_ACCESS_DEFINE@
/**
* GST_EXPORT:
*
* Export the given variable from the built shared object.
*
* On Windows, this exports the variable from the DLL.
* On other platforms, this gets defined to "extern".
*/
/**
* GST_PLUGIN_EXPORT:
*
* Export the plugin's definition.
*
* On Windows, this exports the plugin definition from the DLL.
* On other platforms, this gets defined as a no-op.
*/
#ifdef _MSC_VER
#define GST_PLUGIN_EXPORT __declspec(dllexport) extern
#ifdef GST_EXPORTS
#define GST_EXPORT __declspec(dllexport) extern
#else
#define GST_EXPORT __declspec(dllimport) extern
#endif
#else /* not _MSC_VER */
#define GST_PLUGIN_EXPORT
#if (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
#define GST_EXPORT extern __attribute__ ((visibility ("default")))
#else
#define GST_EXPORT extern
#endif
#endif
#endif /* __GST_CONFIG_H__ */