2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000,2004 Wim Taymans <wim@fluendo.com>
5 * gstelement.h: Header for GstElement
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.
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.
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.
24 #ifndef __GST_ELEMENT_FACTORY_H__
25 #define __GST_ELEMENT_FACTORY_H__
27 typedef struct _GstElementFactory GstElementFactory;
28 typedef struct _GstElementFactoryClass GstElementFactoryClass;
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>
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,\
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))
52 * The opaque #GstElementFactory data structure.
54 struct _GstElementFactory {
55 GstPluginFeature parent;
57 GType type; /* unique GType of element or 0 if not loaded */
61 GList * staticpadtemplates; /* GstStaticPadTemplate list */
62 guint numpadtemplates;
64 /* URI interface stuff */
66 gchar ** uri_protocols;
68 GList * interfaces; /* interface type names this element implements */
71 gpointer _gst_reserved[GST_PADDING];
74 struct _GstElementFactoryClass {
75 GstPluginFeatureClass parent_class;
77 gpointer _gst_reserved[GST_PADDING];
80 GType gst_element_factory_get_type (void);
82 GstElementFactory * gst_element_factory_find (const gchar *name);
84 GType gst_element_factory_get_element_type (GstElementFactory *factory);
86 const gchar * gst_element_factory_get_metadata (GstElementFactory *factory, const gchar *key);
88 guint gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
89 const GList * gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
91 gint gst_element_factory_get_uri_type (GstElementFactory *factory);
92 gchar ** gst_element_factory_get_uri_protocols (GstElementFactory *factory);
94 gboolean gst_element_factory_has_interface (GstElementFactory *factory,
95 const gchar *interfacename);
97 GstElement* gst_element_factory_create (GstElementFactory *factory,
99 GstElement* gst_element_factory_make (const gchar *factoryname, const gchar *name);
101 gboolean gst_element_register (GstPlugin *plugin, const gchar *name,
102 guint rank, GType type);
104 /* Factory list functions */
107 * GstFactoryListType:
108 * @GST_ELEMENT_FACTORY_TYPE_DECODER: Decoder elements
109 * @GST_ELEMENT_FACTORY_TYPE_ENCODER: Encoder elements
110 * @GST_ELEMENT_FACTORY_TYPE_SINK: Sink elements
111 * @GST_ELEMENT_FACTORY_TYPE_SRC: Source elements
112 * @GST_ELEMENT_FACTORY_TYPE_MUXER: Muxer elements
113 * @GST_ELEMENT_FACTORY_TYPE_DEMUXER: Demuxer elements
114 * @GST_ELEMENT_FACTORY_TYPE_PARSER: Parser elements
115 * @GST_ELEMENT_FACTORY_TYPE_PAYLOADER: Payloader elements
116 * @GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER: Depayloader elements
117 * @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS: Private, do not use
118 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO: Elements handling video media types
119 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO: Elements handling audio media types
120 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE: Elements handling image media types
121 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE: Elements handling subtitle media types
122 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA: Elements handling metadata media types
124 * The type of #GstElementFactory to filter.
126 * All @GstFactoryListType up to @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS are exclusive.
128 * If one or more of the MEDIA types are specified, then only elements
129 * matching the specified media types will be selected.
134 typedef guint64 GstElementFactoryListType;
136 #define GST_ELEMENT_FACTORY_TYPE_DECODER (G_GUINT64_CONSTANT (1) << 0)
137 #define GST_ELEMENT_FACTORY_TYPE_ENCODER (G_GUINT64_CONSTANT (1) << 1)
138 #define GST_ELEMENT_FACTORY_TYPE_SINK (G_GUINT64_CONSTANT (1) << 2)
139 #define GST_ELEMENT_FACTORY_TYPE_SRC (G_GUINT64_CONSTANT (1) << 3)
140 #define GST_ELEMENT_FACTORY_TYPE_MUXER (G_GUINT64_CONSTANT (1) << 4)
141 #define GST_ELEMENT_FACTORY_TYPE_DEMUXER (G_GUINT64_CONSTANT (1) << 5)
142 #define GST_ELEMENT_FACTORY_TYPE_PARSER (G_GUINT64_CONSTANT (1) << 6)
143 #define GST_ELEMENT_FACTORY_TYPE_PAYLOADER (G_GUINT64_CONSTANT (1) << 7)
144 #define GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER (G_GUINT64_CONSTANT (1) << 8)
145 #define GST_ELEMENT_FACTORY_TYPE_FORMATTER (G_GUINT64_CONSTANT (1) << 9)
147 #define GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS (G_GUINT64_CONSTANT (1) << 48)
149 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO (G_GUINT64_CONSTANT (1) << 49)
150 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO (G_GUINT64_CONSTANT (1) << 50)
151 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE (G_GUINT64_CONSTANT (1) << 51)
152 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE (G_GUINT64_CONSTANT (1) << 52)
153 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA (G_GUINT64_CONSTANT (1) << 53)
156 * GST_ELEMENT_FACTORY_TYPE_ANY:
158 * Elements of any of the defined GST_ELEMENT_FACTORY_LIST types
162 #define GST_ELEMENT_FACTORY_TYPE_ANY ((G_GUINT64_CONSTANT (1) << 49) - 1)
165 * GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY:
167 * Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types
169 * Note: Do not use this if you wish to not filter against any of the defined
170 * media types. If you wish to do this, simply don't specify any
171 * GST_ELEMENT_FACTORY_TYPE_MEDIA flag.
175 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY (~G_GUINT64_CONSTANT (0) << 48)
178 * GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER:
180 * All encoders handling video or image media types
184 #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 * GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER:
189 * All encoders handling audio media types
193 #define GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
196 * GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS:
198 * All sinks handling audio, video or image media types
202 #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 * GST_ELEMENT_FACTORY_TYPE_DECODABLE:
207 * All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)
211 #define GST_ELEMENT_FACTORY_TYPE_DECODABLE \
212 (GST_ELEMENT_FACTORY_TYPE_DECODER | GST_ELEMENT_FACTORY_TYPE_DEMUXER | GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER | GST_ELEMENT_FACTORY_TYPE_PARSER)
214 /* Element klass defines */
215 #define GST_ELEMENT_FACTORY_KLASS_DECODER "Decoder"
216 #define GST_ELEMENT_FACTORY_KLASS_ENCODER "Encoder"
217 #define GST_ELEMENT_FACTORY_KLASS_SINK "Sink"
218 #define GST_ELEMENT_FACTORY_KLASS_SRC "Source"
219 #define GST_ELEMENT_FACTORY_KLASS_MUXER "Muxer"
220 #define GST_ELEMENT_FACTORY_KLASS_DEMUXER "Demuxer"
221 #define GST_ELEMENT_FACTORY_KLASS_PARSER "Parser"
222 #define GST_ELEMENT_FACTORY_KLASS_PAYLOADER "Payloader"
223 #define GST_ELEMENT_FACTORY_KLASS_DEPAYLOADER "Depayloader"
224 #define GST_ELEMENT_FACTORY_KLASS_FORMATTER "Formatter"
226 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_VIDEO "Video"
227 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_AUDIO "Audio"
228 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_IMAGE "Image"
229 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE "Subtitle"
230 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_METADATA "Metadata"
232 gboolean gst_element_factory_list_is_type (GstElementFactory *factory,
233 GstElementFactoryListType type);
235 GList * gst_element_factory_list_get_elements (GstElementFactoryListType type,
239 GList * gst_element_factory_list_filter (GList *list, const GstCaps *caps,
240 GstPadDirection direction,
241 gboolean subsetonly);
244 #endif /* __GST_ELEMENT_FACTORY_H__ */