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