gst/gstelementfactory.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *               2000,2004 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstelement.h: Header for GstElement
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_ELEMENT_FACTORY_H__
  25 #define __GST_ELEMENT_FACTORY_H__
  26
  27 typedef struct _GstElementFactory GstElementFactory;
  28 typedef struct _GstElementFactoryClass GstElementFactoryClass;
  29
  30 #include <gst/gstconfig.h>
  31 #include <gst/gstelement.h>
  32 #include <gst/gstobject.h>
  33 #include <gst/gstplugin.h>
  34 #include <gst/gstpluginfeature.h>
  35 #include <gst/gstiterator.h>
  36
  37 G_BEGIN_DECLS
  38
  39 typedef struct _GstElementDetails GstElementDetails;
  40
  41 /**
  42  * GstElementDetails:
  43  * @longname: long, english name
  44  * @klass: type of element, as hierarchy
  45  * @description: what the element is about
  46  * @author: who wrote this thing?
  47  *
  48  * This struct defines the public information about a #GstElement. It contains
  49  * meta-data about the element that is mostly for the benefit of editors.
  50  */
  51 /* FIXME: need translatable stuff in here (how handle in registry)? */
  52 struct _GstElementDetails
  53 {
  54   /*< public > */
  55   gchar *longname;
  56   gchar *klass;
  57   gchar *description;
  58   gchar *author;
  59
  60   /*< private > */
  61   gpointer _gst_reserved[GST_PADDING];
  62 };
  63
  64 /**
  65  * GST_ELEMENT_DETAILS:
  66  * @longname: long, english name
  67  * @klass: type of element, as hierarchy
  68  * @description: what the element is about
  69  * @author: who wrote this thing?
  70  *
  71  * Macro to initialize #GstElementDetails.
  72  */
  73 #define GST_ELEMENT_DETAILS(longname,klass,description,author)          \
  74   { longname, klass, description, author, {0} }
  75
  76 /**
  77  * GST_IS_ELEMENT_DETAILS:
  78  * @details: the #GstElementDetails to check
  79  *
  80  * Tests if element details are initialized.
  81  */
  82 /* FIXME: what about adding '&& (*__gst_reserved==NULL)' */
  83 #define GST_IS_ELEMENT_DETAILS(details) (                                       \
  84   (details) && ((details)->longname != NULL) && ((details)->klass != NULL)      \
  85   && ((details)->description != NULL) && ((details)->author != NULL))
  86
  87 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
  88 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
  89                                                  GstElementFactory))
  90 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
  91                                                  GstElementFactoryClass))
  92 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
  93 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
  94
  95 struct _GstElementFactory {
  96   GstPluginFeature      parent;
  97
  98   GType                 type;                   /* unique GType of element or 0 if not loaded */
  99
 100   GstElementDetails     details;
 101
 102   GList *               staticpadtemplates;
 103   guint                 numpadtemplates;
 104
 105   /* URI interface stuff */
 106   guint                 uri_type;
 107   gchar **              uri_protocols;
 108
 109   GList *               interfaces;             /* interfaces this element implements */
 110
 111   gpointer _gst_reserved[GST_PADDING];
 112 };
 113
 114 struct _GstElementFactoryClass {
 115   GstPluginFeatureClass parent_class;
 116
 117   gpointer _gst_reserved[GST_PADDING];
 118 };
 119
 120 GType                   gst_element_factory_get_type            (void);
 121
 122 GstElementFactory *     gst_element_factory_find                (const gchar *name);
 123
 124 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
 125 G_CONST_RETURN gchar *  gst_element_factory_get_longname        (GstElementFactory *factory);
 126 G_CONST_RETURN gchar *  gst_element_factory_get_klass           (GstElementFactory *factory);
 127 G_CONST_RETURN gchar *  gst_element_factory_get_description     (GstElementFactory *factory);
 128 G_CONST_RETURN gchar *  gst_element_factory_get_author          (GstElementFactory *factory);
 129 guint                   gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
 130 G_CONST_RETURN GList *  gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
 131 gint                    gst_element_factory_get_uri_type        (GstElementFactory *factory);
 132 gchar **                gst_element_factory_get_uri_protocols   (GstElementFactory *factory);
 133
 134 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
 135                                                                  const gchar *name);
 136 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
 137
 138 void                    __gst_element_factory_add_static_pad_template (GstElementFactory *elementfactory,
 139                                                                  GstStaticPadTemplate *templ);
 140 void                    __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
 141                                                                  const gchar *interfacename);
 142 gboolean                gst_element_register                    (GstPlugin *plugin, const gchar *name,
 143                                                                  guint rank, GType type);
 144
 145
 146
 147 G_END_DECLS
 148
 149 #endif /* __GST_ELEMENT_FACTORY_H__ */