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/gstpadtemplate.h>
  36 #include <gst/gstiterator.h>
  37
  38 G_BEGIN_DECLS
  39
  40 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
  41 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
  42                                                  GstElementFactory))
  43 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
  44                                                  GstElementFactoryClass))
  45 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
  46 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
  47 #define GST_ELEMENT_FACTORY_CAST(obj)           ((GstElementFactory *)(obj))
  48
  49 /**
  50  * GstElementFactory:
  51  *
  52  * The opaque #GstElementFactory data structure.
  53  */
  54 struct _GstElementFactory {
  55   GstPluginFeature      parent;
  56
  57   GType                 type;                   /* unique GType of element or 0 if not loaded */
  58
  59   gpointer              metadata;
  60
  61   GList *               staticpadtemplates;     /* GstStaticPadTemplate list */
  62   guint                 numpadtemplates;
  63
  64   /* URI interface stuff */
  65   guint                 uri_type;
  66   gchar **              uri_protocols;
  67
  68   GList *               interfaces;             /* interface type names this element implements */
  69
  70   /*< private >*/
  71   gpointer _gst_reserved[GST_PADDING];
  72 };
  73
  74 struct _GstElementFactoryClass {
  75   GstPluginFeatureClass parent_class;
  76
  77   gpointer _gst_reserved[GST_PADDING];
  78 };
  79
  80 GType                   gst_element_factory_get_type            (void);
  81
  82 GstElementFactory *     gst_element_factory_find                (const gchar *name);
  83
  84 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
  85
  86 const gchar *           gst_element_factory_get_metadata        (GstElementFactory *factory, const gchar *key);
  87
  88 guint                   gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
  89 const GList *           gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
  90
  91 gint                    gst_element_factory_get_uri_type        (GstElementFactory *factory);
  92 gchar **                gst_element_factory_get_uri_protocols   (GstElementFactory *factory);
  93
  94 gboolean                gst_element_factory_has_interface       (GstElementFactory *factory,
  95                                                                  const gchar *interfacename);
  96
  97 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
  98                                                                  const gchar *name);
  99 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
 100
 101 /* FIXME 0.11: move these two into our private headers */
 102 void                    __gst_element_factory_add_static_pad_template (GstElementFactory *elementfactory,
 103                                                                  GstStaticPadTemplate *templ);
 104 void                    __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
 105                                                                  const gchar *interfacename);
 106 gboolean                gst_element_register                    (GstPlugin *plugin, const gchar *name,
 107                                                                  guint rank, GType type);
 108
 109 /* Factory list functions */
 110
 111 /**
 112  * GstFactoryListType:
 113  * @GST_ELEMENT_FACTORY_TYPE_DECODER: Decoder elements
 114  * @GST_ELEMENT_FACTORY_TYPE_ENCODER: Encoder elements
 115  * @GST_ELEMENT_FACTORY_TYPE_SINK: Sink elements
 116  * @GST_ELEMENT_FACTORY_TYPE_SRC: Source elements
 117  * @GST_ELEMENT_FACTORY_TYPE_MUXER: Muxer elements
 118  * @GST_ELEMENT_FACTORY_TYPE_DEMUXER: Demuxer elements
 119  * @GST_ELEMENT_FACTORY_TYPE_PARSER: Parser elements
 120  * @GST_ELEMENT_FACTORY_TYPE_PAYLOADER: Payloader elements
 121  * @GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER: Depayloader elements
 122  * @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS: Private, do not use
 123  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO: Elements handling video media types
 124  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO: Elements handling audio media types
 125  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE: Elements handling image media types
 126  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE: Elements handling subtitle media types
 127  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA: Elements handling metadata media types
 128  *
 129  * The type of #GstElementFactory to filter.
 130  *
 131  * All @GstFactoryListType up to @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS are exclusive.
 132  *
 133  * If one or more of the MEDIA types are specified, then only elements
 134  * matching the specified media types will be selected.
 135  *
 136  * Since: 0.10.31
 137  */
 138
 139 typedef guint64 GstElementFactoryListType;
 140
 141 #define  GST_ELEMENT_FACTORY_TYPE_DECODER        (G_GUINT64_CONSTANT (1) << 0)
 142 #define  GST_ELEMENT_FACTORY_TYPE_ENCODER        (G_GUINT64_CONSTANT (1) << 1)
 143 #define  GST_ELEMENT_FACTORY_TYPE_SINK           (G_GUINT64_CONSTANT (1) << 2)
 144 #define  GST_ELEMENT_FACTORY_TYPE_SRC            (G_GUINT64_CONSTANT (1) << 3)
 145 #define  GST_ELEMENT_FACTORY_TYPE_MUXER          (G_GUINT64_CONSTANT (1) << 4)
 146 #define  GST_ELEMENT_FACTORY_TYPE_DEMUXER        (G_GUINT64_CONSTANT (1) << 5)
 147 #define  GST_ELEMENT_FACTORY_TYPE_PARSER         (G_GUINT64_CONSTANT (1) << 6)
 148 #define  GST_ELEMENT_FACTORY_TYPE_PAYLOADER      (G_GUINT64_CONSTANT (1) << 7)
 149 #define  GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER    (G_GUINT64_CONSTANT (1) << 8)
 150 #define  GST_ELEMENT_FACTORY_TYPE_FORMATTER      (G_GUINT64_CONSTANT (1) << 9)
 151
 152 #define  GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS   (G_GUINT64_CONSTANT (1) << 48)
 153
 154 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO    (G_GUINT64_CONSTANT (1) << 49)
 155 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO    (G_GUINT64_CONSTANT (1) << 50)
 156 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE    (G_GUINT64_CONSTANT (1) << 51)
 157 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE (G_GUINT64_CONSTANT (1) << 52)
 158 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA (G_GUINT64_CONSTANT (1) << 53)
 159
 160 /**
 161  * GST_ELEMENT_FACTORY_TYPE_ANY:
 162  *
 163  * Elements of any of the defined GST_ELEMENT_FACTORY_LIST types
 164  *
 165  * Since: 0.10.31
 166  */
 167 #define  GST_ELEMENT_FACTORY_TYPE_ANY ((G_GUINT64_CONSTANT (1) << 49) - 1)
 168
 169 /**
 170  * GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY:
 171  *
 172  * Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types
 173  *
 174  * Note: Do not use this if you wish to not filter against any of the defined
 175  * media types. If you wish to do this, simply don't specify any
 176  * GST_ELEMENT_FACTORY_TYPE_MEDIA flag.
 177  *
 178  * Since: 0.10.31
 179  */
 180 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY (~G_GUINT64_CONSTANT (0) << 48)
 181
 182 /**
 183  * GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER:
 184  *
 185  * All encoders handling video or image media types
 186  *
 187  * Since: 0.10.31
 188  */
 189 #define GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 190
 191 /**
 192  * GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER:
 193  *
 194  * All encoders handling audio media types
 195  *
 196  * Since: 0.10.31
 197  */
 198 #define GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
 199
 200 /**
 201  * GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS:
 202  *
 203  * All sinks handling audio, video or image media types
 204  *
 205  * Since: 0.10.31
 206  */
 207 #define GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS (GST_ELEMENT_FACTORY_TYPE_SINK | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
 208
 209 /**
 210  * GST_ELEMENT_FACTORY_TYPE_DECODABLE:
 211  *
 212  * All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)
 213  *
 214  * Since: 0.10.31
 215  */
 216 #define GST_ELEMENT_FACTORY_TYPE_DECODABLE \
 217   (GST_ELEMENT_FACTORY_TYPE_DECODER | GST_ELEMENT_FACTORY_TYPE_DEMUXER | GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER | GST_ELEMENT_FACTORY_TYPE_PARSER)
 218
 219 /* Element klass defines */
 220 #define GST_ELEMENT_FACTORY_KLASS_DECODER               "Decoder"
 221 #define GST_ELEMENT_FACTORY_KLASS_ENCODER               "Encoder"
 222 #define GST_ELEMENT_FACTORY_KLASS_SINK                  "Sink"
 223 #define GST_ELEMENT_FACTORY_KLASS_SRC                   "Source"
 224 #define GST_ELEMENT_FACTORY_KLASS_MUXER                 "Muxer"
 225 #define GST_ELEMENT_FACTORY_KLASS_DEMUXER               "Demuxer"
 226 #define GST_ELEMENT_FACTORY_KLASS_PARSER                "Parser"
 227 #define GST_ELEMENT_FACTORY_KLASS_PAYLOADER             "Payloader"
 228 #define GST_ELEMENT_FACTORY_KLASS_DEPAYLOADER           "Depayloader"
 229 #define GST_ELEMENT_FACTORY_KLASS_FORMATTER             "Formatter"
 230
 231 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_VIDEO           "Video"
 232 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_AUDIO           "Audio"
 233 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_IMAGE           "Image"
 234 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE        "Subtitle"
 235 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_METADATA        "Metadata"
 236
 237 gboolean      gst_element_factory_list_is_type      (GstElementFactory *factory,
 238                                                      GstElementFactoryListType type);
 239
 240 GList *       gst_element_factory_list_get_elements (GstElementFactoryListType type,
 241                                                      GstRank minrank);
 242
 243
 244 GList *       gst_element_factory_list_filter       (GList *list, const GstCaps *caps,
 245                                                      GstPadDirection direction,
 246                                                      gboolean subsetonly);
 247 G_END_DECLS
 248
 249 #endif /* __GST_ELEMENT_FACTORY_H__ */