gstreamer/gst-libs/gst/insertbin/gstinsertbin.h

130 lines
3.9 KiB
C
Raw Normal View History

/*
* GStreamer
*
* Copyright 2013 Collabora Ltd
* @author: Olivier Crete <olivier.crete@collabora.com>
*
* 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.
*
*/
#ifndef __GST_INSERT_BIN_H__
#define __GST_INSERT_BIN_H__
2013-02-14 09:03:28 +00:00
#ifndef GST_USE_UNSTABLE_API
#warning "The GStreamer insertbin library is unstable API and may change in future."
#warning "You can define GST_USE_UNSTABLE_API to avoid this warning."
#endif
#include <gst/gst.h>
#ifndef GST_INSERT_BIN_API
libs: fix API export/import and 'inconsistent linkage' on MSVC For each lib we build export its own API in headers when we're building it, otherwise import the API from the headers. This fixes linker warnings on Windows when building with MSVC. The problem was that we had defined all GST_*_API decorators unconditionally to GST_EXPORT. This was intentional and only supposed to be temporary, but caused linker warnings because we tell the linker that we want to export all symbols even those from externall DLLs, and when the linker notices that they were in external DLLS and not present locally it warns. What we need to do when building each library is: export the library's own symbols and import all other symbols. To this end we define e.g. BUILDING_GST_FOO and then we define the GST_FOO_API decorator either to export or to import symbols depending on whether BUILDING_GST_FOO is set or not. That way external users of each library API automatically get the import. While we're at it, add new GST_API_EXPORT in config.h and use that for GST_*_API decorators instead of GST_EXPORT. The right export define depends on the toolchain and whether we're using -fvisibility=hidden or not, so it's better to set it to the right thing directly than hard-coding a compiler whitelist in the public header. We put the export define into config.h instead of passing it via the command line to the compiler because it might contain spaces and brackets and in the autotools scenario we'd have to pass that through multiple layers of plumbing and Makefile/shell escaping and we're just not going to be *that* lucky. The export define is only used if we're compiling our lib, not by external users of the lib headers, so it's not a problem to put it into config.h Also, this means all .c files of libs need to include config.h to get the export marker defined, so fix up a few that didn't include config.h. This commit depends on a common submodule commit that makes gst-glib-gen.mak add an #include "config.h" to generated enum/marshal .c files for the autotools build. https://bugzilla.gnome.org/show_bug.cgi?id=797185
2018-09-24 10:52:22 +00:00
# ifdef BUILDING_GST_INSERT_BIN
# define GST_INSERT_BIN_API GST_API_EXPORT /* from config.h */
# else
# define GST_INSERT_BIN_API GST_API_IMPORT
# endif
#endif
G_BEGIN_DECLS
#define GST_TYPE_INSERT_BIN (gst_insert_bin_get_type())
#define GST_INSERT_BIN(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_INSERT_BIN,GstInsertBin))
#define GST_IS_INSERT_BIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_INSERT_BIN))
#define GST_INSERT_BIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass) ,GST_TYPE_INSERT_BIN,GstInsertBinClass))
#define GST_IS_INSERT_BIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass) ,GST_TYPE_INSERT_BIN))
#define GST_INSERT_BIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj) ,GST_TYPE_INSERT_BIN,GstInsertBinClass))
typedef struct _GstInsertBin GstInsertBin;
typedef struct _GstInsertBinClass GstInsertBinClass;
typedef struct _GstInsertBinPrivate GstInsertBinPrivate;
/**
* GstInsertBinCallback:
* @insertbin: A #GstInsertBin
* @element: The #GstElement on which the operation was performed
* @success: %TRUE if the operation was successful
* @user_data: The user data passed
*
* This is the prototype of callbacks to be called when the operation completes.
* It could be called at any time, including as a re-entrant call while the
* operation is requested.
*/
typedef void (*GstInsertBinCallback) (GstInsertBin *insertbin,
GstElement *element,
gboolean success,
gpointer user_data);
/**
* GstInsertBin:
*
* The object structure.
*/
struct _GstInsertBin
{
GstBin parent;
/*< private >*/
GstInsertBinPrivate *priv;
};
/**
* GstInsertBinClass:
*
* The object class structure.
*/
struct _GstInsertBinClass
{
GstBinClass parent_class;
};
GST_INSERT_BIN_API
GType gst_insert_bin_get_type (void);
GST_INSERT_BIN_API
GstElement *gst_insert_bin_new (const gchar * name);
GST_INSERT_BIN_API
void gst_insert_bin_prepend (GstInsertBin * self, GstElement * element,
GstInsertBinCallback callback, gpointer user_data);
GST_INSERT_BIN_API
void gst_insert_bin_append (GstInsertBin * self, GstElement * element,
GstInsertBinCallback callback, gpointer user_data);
GST_INSERT_BIN_API
void gst_insert_bin_insert_before (GstInsertBin * self,
GstElement * element, GstElement * sibling,
GstInsertBinCallback callback, gpointer user_data);
GST_INSERT_BIN_API
void gst_insert_bin_insert_after (GstInsertBin * self,
GstElement * element, GstElement * sibling,
GstInsertBinCallback callback, gpointer user_data);
GST_INSERT_BIN_API
void gst_insert_bin_remove (GstInsertBin * self, GstElement * element,
GstInsertBinCallback callback, gpointer user_data);
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstInsertBin, gst_object_unref)
#endif
G_END_DECLS
#endif /* __GST_INSERT_BIN_H__ */