mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-25 03:01:03 +00:00
71f3a6f0f7
Since everything GstXML related has been deprecated, we can now skip the libxml includes from the public headers when GST_DISABLE_DEPRECATED is defined. See #463435.
233 lines
6.9 KiB
C
233 lines
6.9 KiB
C
/* 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., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, 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
|
|
* suybsystem, you have to rebuild all programs depending on GStreamer, too.
|
|
*
|
|
* If a subsystem is disabled in GStreamer, a value is defined in
|
|
* <gst/gst.h>. 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_LOADSAVE 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_DISABLE_XML 1
|
|
#define GST_DISABLE_LOADSAVE_REGISTRY 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_LOADSAVE:
|
|
*
|
|
* Configures the inclusion of the plugin graph xml-serialisation
|
|
* (was used in 0.8 by gst-editor)
|
|
*/
|
|
@GST_DISABLE_LOADSAVE_DEFINE@
|
|
|
|
/**
|
|
* GST_DISABLE_PARSE:
|
|
*
|
|
* Configures the inclusion of the gst-lauch parser
|
|
*/
|
|
@GST_DISABLE_PARSE_DEFINE@
|
|
|
|
/**
|
|
* GST_DISABLE_TRACE:
|
|
*
|
|
* Configures the inclusion of a resource tracing facillity
|
|
* (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@
|
|
|
|
/**
|
|
* GST_DISABLE_XML:
|
|
*
|
|
* Configures the use libxml2. This setting is derived from the settings of
|
|
* %GST_DISABLE_LOADSAVE and %GST_DISABLE_REGISTRY (in the xml registry case).
|
|
*/
|
|
@GST_DISABLE_XML_DEFINE@
|
|
|
|
/* FIXME: test and document these! */
|
|
/* Configures the use of external plugins */
|
|
@GST_DISABLE_PLUGIN_DEFINE@
|
|
|
|
/* printf extension format */
|
|
/**
|
|
* GST_PTR_FORMAT:
|
|
*
|
|
* printf format type used to debug GStreamer types.
|
|
* This can only be used on types whose size is >= sizeof(gpointer).
|
|
*/
|
|
@GST_PRINTF_EXTENSION_POINTER_FORMAT_DEFINE@
|
|
/**
|
|
* GST_SEGMENT_FORMAT:
|
|
*
|
|
* printf format type used to debug GStreamer segments.
|
|
* This can only be used on pointers to GstSegment structures.
|
|
*
|
|
* Since: 0.10.10
|
|
*/
|
|
@GST_PRINTF_EXTENSION_SEGMENT_FORMAT_DEFINE@
|
|
|
|
/* whether or not GST_PTR_FORMAT or GST_SEGMENT_FORMAT are using
|
|
* the printf extension mechanism. This is for internal use in our
|
|
* header files so we know whether we can use G_GNUC_PRINTF or not */
|
|
@GST_USING_PRINTF_EXTENSION_DEFINE@
|
|
|
|
/* GST_DISABLE_PRINTF_EXTENSION:
|
|
*
|
|
* Define this to debug your debug log messages and make gcc spew warnings
|
|
* if printf format string and arguments don't match up (this is usually
|
|
* not the case when libc and gcc are used because printf format warnings
|
|
* have to be disabled when the printf extension mechanism is in use).
|
|
*
|
|
* Note that using this option disables 'pretty logging' of GStreamer objects
|
|
* like caps, tags, structures, events, pads etc., so that only their address
|
|
* will be printed in the log.
|
|
*
|
|
* This define only disables use of the special registered printf format
|
|
* extensions in the code compiled with it defined. It does not stop
|
|
* GStreamer from registering these extensions in the first place if it
|
|
* was compiled against a libc that supports this.
|
|
*
|
|
* (not official API)
|
|
*/
|
|
#ifdef GST_DISABLE_PRINTF_EXTENSION
|
|
#undef GST_PTR_FORMAT
|
|
#define GST_PTR_FORMAT "p"
|
|
#undef GST_SEGMENT_FORMAT
|
|
#define GST_SEGMENT_FORMAT "p"
|
|
#undef GST_USING_PRINTF_EXTENSION
|
|
#endif
|
|
|
|
/* whether or not the CPU supports unaligned access */
|
|
@GST_HAVE_UNALIGNED_ACCESS_DEFINE@
|
|
|
|
/* FIXME: 0.11 (remove)
|
|
* whether or not we are using glib 2.8 api, e.g. atomic gobject
|
|
* refcounting */
|
|
@GST_HAVE_GLIB_2_8_DEFINE@
|
|
|
|
/***** Deal with XML stuff, we have to handle both loadsave and registry *****/
|
|
/* FIXME: move include to where we need it */
|
|
/*#if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )*/
|
|
#ifndef GST_DISABLE_XML
|
|
#ifndef GST_DISABLE_DEPRECATED
|
|
# include <libxml/parser.h>
|
|
#endif
|
|
#else
|
|
/* FIXME: 0.11 (replace by GST_DISABLE_XML) */
|
|
# define GST_DISABLE_LOADSAVE_REGISTRY
|
|
#endif
|
|
|
|
/**
|
|
* 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
|
|
#define GST_EXPORT extern
|
|
#endif
|
|
|
|
#endif /* __GST_CONFIG_H__ */
|