tracers: latency: allow for non parented pads to send latency probes
[platform/upstream/gstreamer.git] / 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  * gstelementfactory.h: Header for GstElementFactory
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., 51 Franklin St, Fifth Floor,
20  * Boston, MA 02110-1301, 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 GST_EXPORT
54 GType                   gst_element_factory_get_type            (void);
55
56 GST_EXPORT
57 GstElementFactory *     gst_element_factory_find                (const gchar *name);
58
59 GST_EXPORT
60 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
61
62 GST_EXPORT
63 const gchar *           gst_element_factory_get_metadata        (GstElementFactory *factory, const gchar *key);
64
65 GST_EXPORT
66 gchar **                gst_element_factory_get_metadata_keys   (GstElementFactory *factory);
67
68 GST_EXPORT
69 guint                   gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
70
71 GST_EXPORT
72 const GList *           gst_element_factory_get_static_pad_templates (GstElementFactory *factory);
73
74 GST_EXPORT
75 GstURIType              gst_element_factory_get_uri_type        (GstElementFactory *factory);
76
77 GST_EXPORT
78 const gchar * const *   gst_element_factory_get_uri_protocols   (GstElementFactory *factory);
79
80 GST_EXPORT
81 gboolean                gst_element_factory_has_interface       (GstElementFactory *factory,
82                                                                  const gchar *interfacename);
83 GST_EXPORT
84 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
85                                                                  const gchar *name) G_GNUC_MALLOC;
86 GST_EXPORT
87 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name) G_GNUC_MALLOC;
88
89 GST_EXPORT
90 gboolean                gst_element_register                    (GstPlugin *plugin, const gchar *name,
91                                                                  guint rank, GType type);
92
93 /* Factory list functions */
94
95 /**
96  * GstFactoryListType:
97  * @GST_ELEMENT_FACTORY_TYPE_DECODER: Decoder elements
98  * @GST_ELEMENT_FACTORY_TYPE_ENCODER: Encoder elements
99  * @GST_ELEMENT_FACTORY_TYPE_SINK: Sink elements
100  * @GST_ELEMENT_FACTORY_TYPE_SRC: Source elements
101  * @GST_ELEMENT_FACTORY_TYPE_MUXER: Muxer elements
102  * @GST_ELEMENT_FACTORY_TYPE_DEMUXER: Demuxer elements
103  * @GST_ELEMENT_FACTORY_TYPE_PARSER: Parser elements
104  * @GST_ELEMENT_FACTORY_TYPE_PAYLOADER: Payloader elements
105  * @GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER: Depayloader elements
106  * @GST_ELEMENT_FACTORY_TYPE_DECRYPTOR: Elements handling decryption (Since 1.6)
107  * @GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR: Elements handling encryption (Since 1.6)
108  * @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS: Private, do not use
109  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO: Elements handling video media types
110  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO: Elements handling audio media types
111  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE: Elements handling image media types
112  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE: Elements handling subtitle media types
113  * @GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA: Elements handling metadata media types
114  *
115  * The type of #GstElementFactory to filter.
116  *
117  * All @GstFactoryListType up to @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS are exclusive.
118  *
119  * If one or more of the MEDIA types are specified, then only elements
120  * matching the specified media types will be selected.
121  */
122
123 typedef guint64 GstElementFactoryListType;
124
125 #define  GST_ELEMENT_FACTORY_TYPE_DECODER        ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 0))
126 #define  GST_ELEMENT_FACTORY_TYPE_ENCODER        ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 1))
127 #define  GST_ELEMENT_FACTORY_TYPE_SINK           ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 2))
128 #define  GST_ELEMENT_FACTORY_TYPE_SRC            ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 3))
129 #define  GST_ELEMENT_FACTORY_TYPE_MUXER          ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 4))
130 #define  GST_ELEMENT_FACTORY_TYPE_DEMUXER        ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 5))
131 #define  GST_ELEMENT_FACTORY_TYPE_PARSER         ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 6))
132 #define  GST_ELEMENT_FACTORY_TYPE_PAYLOADER      ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 7))
133 #define  GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER    ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 8))
134 #define  GST_ELEMENT_FACTORY_TYPE_FORMATTER      ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 9))
135 #define  GST_ELEMENT_FACTORY_TYPE_DECRYPTOR      ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 10))
136 #define  GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR      ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 11))
137
138 #define  GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS   ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 48))
139
140 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO    ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 49))
141 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO    ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 50))
142 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE    ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 51))
143 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 52))
144 #define  GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 53))
145
146 /**
147  * GST_ELEMENT_FACTORY_TYPE_ANY: (value 562949953421311) (type GstElementFactoryListType)
148  *
149  * Elements of any of the defined GST_ELEMENT_FACTORY_LIST types
150  */
151 #define  GST_ELEMENT_FACTORY_TYPE_ANY ((GstElementFactoryListType)((G_GUINT64_CONSTANT (1) << 49) - 1))
152
153 /**
154  * GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY: (value 18446462598732840960) (type GstElementFactoryListType)
155  *
156  * Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types
157  *
158  * Note: Do not use this if you wish to not filter against any of the defined
159  * media types. If you wish to do this, simply don't specify any
160  * GST_ELEMENT_FACTORY_TYPE_MEDIA flag.
161  */
162 #define GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY ((GstElementFactoryListType)(~G_GUINT64_CONSTANT (0) << 48))
163
164 /**
165  * GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER: (value 2814749767106562) (type GstElementFactoryListType)
166  *
167  * All encoders handling video or image media types
168  */
169 #define GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER ((GstElementFactoryListType)(GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE))
170
171 /**
172  * GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER: (value 1125899906842626) (type GstElementFactoryListType)
173  *
174  * All encoders handling audio media types
175  */
176 #define GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER ((GstElementFactoryListType)(GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO))
177
178 /**
179  * GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS: (value 3940649673949188) (type GstElementFactoryListType)
180  *
181  * All sinks handling audio, video or image media types
182  */
183 #define GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS ((GstElementFactoryListType)(GST_ELEMENT_FACTORY_TYPE_SINK | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE))
184
185 /**
186  * GST_ELEMENT_FACTORY_TYPE_DECODABLE: (value 353) (type GstElementFactoryListType)
187  *
188  * All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)
189  */
190 #define GST_ELEMENT_FACTORY_TYPE_DECODABLE \
191   ((GstElementFactoryListType)(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))
192
193 /* Element klass defines */
194 #define GST_ELEMENT_FACTORY_KLASS_DECODER               "Decoder"
195 #define GST_ELEMENT_FACTORY_KLASS_ENCODER               "Encoder"
196 #define GST_ELEMENT_FACTORY_KLASS_SINK                  "Sink"
197 #define GST_ELEMENT_FACTORY_KLASS_SRC                   "Source"
198 #define GST_ELEMENT_FACTORY_KLASS_MUXER                 "Muxer"
199 #define GST_ELEMENT_FACTORY_KLASS_DEMUXER               "Demuxer"
200 #define GST_ELEMENT_FACTORY_KLASS_PARSER                "Parser"
201 #define GST_ELEMENT_FACTORY_KLASS_PAYLOADER             "Payloader"
202 #define GST_ELEMENT_FACTORY_KLASS_DEPAYLOADER           "Depayloader"
203 #define GST_ELEMENT_FACTORY_KLASS_FORMATTER             "Formatter"
204 #define GST_ELEMENT_FACTORY_KLASS_DECRYPTOR             "Decryptor"
205 #define GST_ELEMENT_FACTORY_KLASS_ENCRYPTOR             "Encryptor"
206
207 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_VIDEO           "Video"
208 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_AUDIO           "Audio"
209 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_IMAGE           "Image"
210 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE        "Subtitle"
211 #define GST_ELEMENT_FACTORY_KLASS_MEDIA_METADATA        "Metadata"
212
213 GST_EXPORT
214 gboolean      gst_element_factory_list_is_type      (GstElementFactory *factory,
215                                                      GstElementFactoryListType type);
216
217 GST_EXPORT
218 GList *       gst_element_factory_list_get_elements (GstElementFactoryListType type,
219                                                      GstRank minrank) G_GNUC_MALLOC;
220
221
222 GST_EXPORT
223 GList *       gst_element_factory_list_filter       (GList *list, const GstCaps *caps,
224                                                      GstPadDirection direction,
225                                                      gboolean subsetonly) G_GNUC_MALLOC;
226 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
227 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstElementFactory, gst_object_unref)
228 #endif
229
230 G_END_DECLS
231
232 #endif /* __GST_ELEMENT_FACTORY_H__ */