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