mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-24 10:41:04 +00:00
219c0c1947
Original commit message from CVS: * docs/gst/gstreamer-sections.txt: ultral33t func10ns deserve to appear in the docs actualy * docs/gst/tmpl/.cvsignore: * docs/gst/tmpl/gstcompat.sgml: * docs/gst/tmpl/gstconfig.sgml: * gst/check/gstcheck.c: * gst/gstcompat.h: * gst/gstconfig.h.in: inlined more docs
151 lines
4.3 KiB
C
151 lines
4.3 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>
|
|
* <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_LOADSAVE_REGISTRY 1
|
|
#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_ENUMTYPES 1
|
|
#define GST_DISABLE_INDEX 1
|
|
#define GST_DISABLE_PLUGIN 1
|
|
#define GST_DISABLE_URI 1
|
|
#endif
|
|
|
|
/***** default padding of structures *****/
|
|
#define GST_PADDING 4
|
|
#define GST_PADDING_INIT {0}
|
|
|
|
/***** disabling of subsystems *****/
|
|
|
|
/* wether or not the debugging subsystem is enabled */
|
|
@GST_DISABLE_GST_DEBUG_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_LOADSAVE_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_PARSE_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_TRACE_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_ALLOC_TRACE_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_REGISTRY_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_ENUMTYPES_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_INDEX_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_PLUGIN_DEFINE@
|
|
|
|
/* DOES NOT WORK */
|
|
@GST_DISABLE_URI_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_FORMAT_DEFINE@
|
|
|
|
/* whether or not the CPU supports unaligned access */
|
|
@GST_HAVE_UNALIGNED_ACCESS_DEFINE@
|
|
|
|
/***** Deal with XML stuff, we have to handle both loadsave and registry *****/
|
|
|
|
#if (! (defined(GST_DISABLE_LOADSAVE) && defined(GST_DISABLE_REGISTRY)) )
|
|
# include <libxml/parser.h>
|
|
#else
|
|
# 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 WIN32
|
|
#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 WIN32 */
|
|
#define GST_PLUGIN_EXPORT
|
|
#define GST_EXPORT extern
|
|
#endif
|
|
|
|
#endif /* __GST_CONFIG_H__ */
|