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 /* FIXME: need translatable stuff in here (how handle in registry)? */
  42 struct _GstElementDetails
  43 {
  44   /*< public > */
  45   gchar *longname;              /* long, english name */
  46   gchar *klass;                 /* type of element, as hierarchy */
  47   gchar *description;           /* insights of one form or another */
  48   gchar *author;                /* who wrote this thing? */
  49
  50   /*< private > */
  51   gpointer _gst_reserved[GST_PADDING];
  52 };
  53
  54 #define GST_ELEMENT_DETAILS(longname,klass,description,author)          \
  55   { longname, klass, description, author, {0} }
  56 #define GST_IS_ELEMENT_DETAILS(details) (                                       \
  57   (details) && ((details)->longname != NULL) && ((details)->klass != NULL)      \
  58   && ((details)->description != NULL) && ((details)->author != NULL))
  59
  60 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
  61 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
  62                                                  GstElementFactory))
  63 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
  64                                                  GstElementFactoryClass))
  65 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
  66 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
  67
  68 struct _GstElementFactory {
  69   GstPluginFeature      parent;
  70
  71   GType                 type;                   /* unique GType of element or 0 if not loaded */
  72
  73   GstElementDetails     details;
  74
  75   GList *               staticpadtemplates;
  76   guint                 numpadtemplates;
  77
  78   /* URI interface stuff */
  79   guint                 uri_type;
  80   gchar **              uri_protocols;
  81
  82   GList *               interfaces;             /* interfaces this element implements */
  83
  84   gpointer _gst_reserved[GST_PADDING];
  85 };
  86
  87 struct _GstElementFactoryClass {
  88   GstPluginFeatureClass parent_class;
  89
  90   gpointer _gst_reserved[GST_PADDING];
  91 };
  92
  93 GType                   gst_element_factory_get_type            (void);
  94
  95 GstElementFactory *     gst_element_factory_find                (const gchar *name);
  96
  97 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
  98 G_CONST_RETURN gchar *  gst_element_factory_get_longname        (GstElementFactory *factory);
  99 G_CONST_RETURN gchar *  gst_element_factory_get_klass           (GstElementFactory *factory);
 100 G_CONST_RETURN gchar *  gst_element_factory_get_description     (GstElementFactory *factory);
 101 G_CONST_RETURN gchar *  gst_element_factory_get_author          (GstElementFactory *factory);
 102 guint                   gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
 103 G_CONST_RETURN GList *  gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
 104 guint                   gst_element_factory_get_uri_type        (GstElementFactory *factory);
 105 gchar **                gst_element_factory_get_uri_protocols   (GstElementFactory *factory);
 106
 107 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
 108                                                                  const gchar *name);
 109 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
 110
 111 void                    __gst_element_factory_add_static_pad_template (GstElementFactory *elementfactory,
 112                                                                  GstStaticPadTemplate *templ);
 113 void                    __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
 114                                                                  const gchar *interfacename);
 115 gboolean                gst_element_register                    (GstPlugin *plugin, const gchar *name,
 116                                                                  guint rank, GType type);
 117
 118
 119
 120 G_END_DECLS
 121
 122 #endif /* __GST_ELEMENT_FACTORY_H__ */