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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 #ifndef __GST_ELEMENT_FACTORY_H__
25 #define __GST_ELEMENT_FACTORY_H__
30 * The opaque #GstElementFactory data structure.
32 typedef struct _GstElementFactory GstElementFactory;
33 typedef struct _GstElementFactoryClass GstElementFactoryClass;
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>
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,\
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))
53 GType gst_element_factory_get_type (void);
55 GstElementFactory * gst_element_factory_find (const gchar *name);
57 GType gst_element_factory_get_element_type (GstElementFactory *factory);
59 const gchar * gst_element_factory_get_metadata (GstElementFactory *factory, const gchar *key);
60 gchar ** gst_element_factory_get_metadata_keys (GstElementFactory *factory);
62 guint gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
63 const GList * gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
65 GstURIType gst_element_factory_get_uri_type (GstElementFactory *factory);
66 const gchar * const * gst_element_factory_get_uri_protocols (GstElementFactory *factory);
68 gboolean gst_element_factory_has_interface (GstElementFactory *factory,
69 const gchar *interfacename);
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;
75 gboolean gst_element_register (GstPlugin *plugin, const gchar *name,
76 guint rank, GType type);
78 /* Factory list functions */
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_DECRYPTOR: Elements handling decryption (Since: 1.6)
92 * @GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR: Elements handling encryption (Since: 1.6)
93 * @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS: Private, do not use
94 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO: Elements handling video media types
95 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO: Elements handling audio media types
96 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE: Elements handling image media types
97 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE: Elements handling subtitle media types
98 * @GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA: Elements handling metadata media types
100 * The type of #GstElementFactory to filter.
102 * All @GstFactoryListType up to @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS are exclusive.
104 * If one or more of the MEDIA types are specified, then only elements
105 * matching the specified media types will be selected.
108 typedef guint64 GstElementFactoryListType;
110 #define GST_ELEMENT_FACTORY_TYPE_DECODER (G_GUINT64_CONSTANT (1) << 0)
111 #define GST_ELEMENT_FACTORY_TYPE_ENCODER (G_GUINT64_CONSTANT (1) << 1)
112 #define GST_ELEMENT_FACTORY_TYPE_SINK (G_GUINT64_CONSTANT (1) << 2)
113 #define GST_ELEMENT_FACTORY_TYPE_SRC (G_GUINT64_CONSTANT (1) << 3)
114 #define GST_ELEMENT_FACTORY_TYPE_MUXER (G_GUINT64_CONSTANT (1) << 4)
115 #define GST_ELEMENT_FACTORY_TYPE_DEMUXER (G_GUINT64_CONSTANT (1) << 5)
116 #define GST_ELEMENT_FACTORY_TYPE_PARSER (G_GUINT64_CONSTANT (1) << 6)
117 #define GST_ELEMENT_FACTORY_TYPE_PAYLOADER (G_GUINT64_CONSTANT (1) << 7)
118 #define GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER (G_GUINT64_CONSTANT (1) << 8)
119 #define GST_ELEMENT_FACTORY_TYPE_FORMATTER (G_GUINT64_CONSTANT (1) << 9)
120 #define GST_ELEMENT_FACTORY_TYPE_DECRYPTOR (G_GUINT64_CONSTANT (1) << 10)
121 #define GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR (G_GUINT64_CONSTANT (1) << 11)
123 #define GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS (G_GUINT64_CONSTANT (1) << 48)
125 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO (G_GUINT64_CONSTANT (1) << 49)
126 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO (G_GUINT64_CONSTANT (1) << 50)
127 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE (G_GUINT64_CONSTANT (1) << 51)
128 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE (G_GUINT64_CONSTANT (1) << 52)
129 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA (G_GUINT64_CONSTANT (1) << 53)
132 * GST_ELEMENT_FACTORY_TYPE_ANY:
134 * Elements of any of the defined GST_ELEMENT_FACTORY_LIST types
136 * Value: 562949953421311
137 * Type: GstElementFactoryListType
139 #define GST_ELEMENT_FACTORY_TYPE_ANY ((G_GUINT64_CONSTANT (1) << 49) - 1)
142 * GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY:
144 * Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types
146 * Note: Do not use this if you wish to not filter against any of the defined
147 * media types. If you wish to do this, simply don't specify any
148 * GST_ELEMENT_FACTORY_TYPE_MEDIA flag.
150 * Value: 18446462598732840960
151 * Type: GstElementFactoryListType
153 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY (~G_GUINT64_CONSTANT (0) << 48)
156 * GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER:
158 * All encoders handling video or image media types
160 * Value: 2814749767106562
161 * Type: GstElementFactoryListType
163 #define GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE)
166 * GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER:
168 * All encoders handling audio media types
170 * Value: 1125899906842626
171 * Type: GstElementFactoryListType
173 #define GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
176 * GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS:
178 * All sinks handling audio, video or image media types
180 * Value: 3940649673949188
181 * Type: GstElementFactoryListType
183 #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)
186 * GST_ELEMENT_FACTORY_TYPE_DECODABLE:
188 * All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)
191 * Type: GstElementFactoryListType
193 #define GST_ELEMENT_FACTORY_TYPE_DECODABLE \
194 (GST_ELEMENT_FACTORY_TYPE_DECODER | GST_ELEMENT_FACTORY_TYPE_DEMUXER | GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER | GST_ELEMENT_FACTORY_TYPE_PARSER | GST_ELEMENT_FACTORY_TYPE_DECRYPTOR)
196 /* Element klass defines */
197 #define GST_ELEMENT_FACTORY_KLASS_DECODER "Decoder"
198 #define GST_ELEMENT_FACTORY_KLASS_ENCODER "Encoder"
199 #define GST_ELEMENT_FACTORY_KLASS_SINK "Sink"
200 #define GST_ELEMENT_FACTORY_KLASS_SRC "Source"
201 #define GST_ELEMENT_FACTORY_KLASS_MUXER "Muxer"
202 #define GST_ELEMENT_FACTORY_KLASS_DEMUXER "Demuxer"
203 #define GST_ELEMENT_FACTORY_KLASS_PARSER "Parser"
204 #define GST_ELEMENT_FACTORY_KLASS_PAYLOADER "Payloader"
205 #define GST_ELEMENT_FACTORY_KLASS_DEPAYLOADER "Depayloader"
206 #define GST_ELEMENT_FACTORY_KLASS_FORMATTER "Formatter"
207 #define GST_ELEMENT_FACTORY_KLASS_DECRYPTOR "Decryptor"
208 #define GST_ELEMENT_FACTORY_KLASS_ENCRYPTOR "Encryptor"
210 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_VIDEO "Video"
211 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_AUDIO "Audio"
212 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_IMAGE "Image"
213 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE "Subtitle"
214 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_METADATA "Metadata"
216 gboolean gst_element_factory_list_is_type (GstElementFactory *factory,
217 GstElementFactoryListType type);
219 GList * gst_element_factory_list_get_elements (GstElementFactoryListType type,
220 GstRank minrank) G_GNUC_MALLOC;
223 GList * gst_element_factory_list_filter (GList *list, const GstCaps *caps,
224 GstPadDirection direction,
225 gboolean subsetonly) G_GNUC_MALLOC;
228 #endif /* __GST_ELEMENT_FACTORY_H__ */