gstreamer_core/gst/gstelementfactory.h
changeset 0 0e761a78d257
child 8 4a7fac7dd34a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gstreamer_core/gst/gstelementfactory.h	Thu Dec 17 08:53:32 2009 +0200
@@ -0,0 +1,236 @@
+/* GStreamer
+ * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
+ *               2000,2004 Wim Taymans <wim@fluendo.com>
+ *
+ * gstelement.h: Header for GstElement
+ *
+ * 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_ELEMENT_FACTORY_H__
+#define __GST_ELEMENT_FACTORY_H__
+
+typedef struct _GstElementFactory GstElementFactory;
+typedef struct _GstElementFactoryClass GstElementFactoryClass;
+
+#include <gst/gstconfig.h>
+#include <gst/gstelement.h>
+#include <gst/gstobject.h>
+#include <gst/gstplugin.h>
+#include <gst/gstpluginfeature.h>
+#include <gst/gstiterator.h>
+
+G_BEGIN_DECLS
+
+typedef struct _GstElementDetails GstElementDetails;
+
+/**
+ * GstElementDetails:
+ * @longname: long, english name
+ * @klass: string describing the type of element, as an unordered list
+ * separated with slashes ('/'). See draft-klass.txt of the design docs
+ * for more details and common types
+ * @description: what the element is about
+ * @author: who wrote this thing?
+ *
+ * This struct defines the public information about a #GstElement. It contains
+ * meta-data about the element that is mostly for the benefit of editors.
+ *
+ * The @klass member can be used by applications to filter elements based 
+ * on functionality.
+ */
+/* FIXME: need translatable stuff in here (how handle in registry)?
+ * can't we use _N("long name") in element implementations and use _(longname)
+ * in gst_element_factory_get_longname()
+ */
+struct _GstElementDetails
+{
+  /*< public > */
+  gchar *longname;
+  gchar *klass;
+  gchar *description;
+  gchar *author;
+
+  /*< private > */
+  gpointer _gst_reserved[GST_PADDING];
+};
+
+/**
+ * GST_ELEMENT_DETAILS:
+ * @longname: long, english name
+ * @klass: string describing the type of element, as an unordered list
+ * separated with slashes ('/'). See draft-klass.txt of the design docs
+ * for more details and common types
+ * @description: what the element is about
+ * @author: who wrote this element
+ *
+ * Macro to initialize #GstElementDetails.
+ */
+#define GST_ELEMENT_DETAILS(longname,klass,description,author)		\
+  { longname, klass, description, author, {NULL} }
+
+/**
+ * GST_IS_ELEMENT_DETAILS:
+ * @details: the #GstElementDetails to check
+ *
+ * Tests if element details are initialized.
+ */
+/* FIXME: what about adding '&& (*__gst_reserved==NULL)' */
+#define GST_IS_ELEMENT_DETAILS(details) (					\
+  (details) && ((details)->longname != NULL) && ((details)->klass != NULL)	\
+  && ((details)->description != NULL) && ((details)->author != NULL))
+
+#define GST_TYPE_ELEMENT_FACTORY 		(gst_element_factory_get_type())
+#define GST_ELEMENT_FACTORY(obj)  		(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
+						 GstElementFactory))
+#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
+						 GstElementFactoryClass))
+#define GST_IS_ELEMENT_FACTORY(obj) 		(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
+#define GST_IS_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
+#define GST_ELEMENT_FACTORY_CAST(obj)           ((GstElementFactory *)(obj))
+
+/**
+ * GstElementFactory:
+ *
+ * The opaque #GstElementFactory data structure.
+ */
+struct _GstElementFactory {
+  GstPluginFeature	parent;
+
+  GType			type;			/* unique GType of element or 0 if not loaded */
+
+  GstElementDetails	details;
+
+  GList *		staticpadtemplates;
+  guint			numpadtemplates;
+
+  /* URI interface stuff */
+  guint			uri_type;
+  gchar **		uri_protocols;
+
+  GList *		interfaces;		/* interfaces this element implements */
+
+  gpointer _gst_reserved[GST_PADDING];
+};
+
+struct _GstElementFactoryClass {
+  GstPluginFeatureClass parent_class;
+
+  gpointer _gst_reserved[GST_PADDING];
+};
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+
+GType 			gst_element_factory_get_type 		(void);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+
+GstElementFactory *	gst_element_factory_find		(const gchar *name);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+
+GType			gst_element_factory_get_element_type	(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+G_CONST_RETURN gchar *	gst_element_factory_get_longname	(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+G_CONST_RETURN gchar *	gst_element_factory_get_klass		(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+G_CONST_RETURN gchar *	gst_element_factory_get_description  	(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+G_CONST_RETURN gchar *	gst_element_factory_get_author		(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+guint			gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+G_CONST_RETURN GList *	gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gint			gst_element_factory_get_uri_type	(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gchar **		gst_element_factory_get_uri_protocols	(GstElementFactory *factory);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean 		gst_element_factory_has_interface	(GstElementFactory *factory,
+                                                                 const gchar *interfacename);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+
+GstElement*		gst_element_factory_create		(GstElementFactory *factory,
+								 const gchar *name);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+GstElement*		gst_element_factory_make		(const gchar *factoryname, const gchar *name);
+
+/* FIXME 0.11: move these two into our private headers */
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void                    __gst_element_factory_add_static_pad_template (GstElementFactory *elementfactory,
+                                                                 GstStaticPadTemplate *templ);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+void                    __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
+                                                                 const gchar *interfacename);
+#ifdef __SYMBIAN32__
+IMPORT_C
+#endif
+
+gboolean                gst_element_register            	(GstPlugin *plugin, const gchar *name,
+		                                                 guint rank, GType type);
+
+
+
+G_END_DECLS
+
+#endif /* __GST_ELEMENT_FACTORY_H__ */