- Add more --disable options
[platform/upstream/gstreamer.git] / gst / gstelement.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
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_H__
25 #define __GST_ELEMENT_H__
26
27 #include <gst/gstconfig.h>
28 #include <gst/gsttypes.h>
29 #include <gst/gstobject.h>
30 #include <gst/gstpad.h>
31 #include <gst/gstclock.h>
32 #include <gst/gstpluginfeature.h>
33 #include <gst/gstindex.h>
34
35 G_BEGIN_DECLS
36
37 #define GST_NUM_STATES 4
38
39 /* NOTE: this probably should be done with an #ifdef to decide 
40  * whether to safe-cast or to just do the non-checking cast.
41  */
42 #define GST_STATE(obj)                  (GST_ELEMENT(obj)->current_state)
43 #define GST_STATE_PENDING(obj)          (GST_ELEMENT(obj)->pending_state)
44
45 /* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
46 #define GST_STATE_TRANSITION(obj)       ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
47 #define GST_STATE_NULL_TO_READY         ((GST_STATE_NULL<<8) | GST_STATE_READY)
48 #define GST_STATE_READY_TO_PAUSED       ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
49 #define GST_STATE_PAUSED_TO_PLAYING     ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
50 #define GST_STATE_PLAYING_TO_PAUSED     ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
51 #define GST_STATE_PAUSED_TO_READY       ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
52 #define GST_STATE_READY_TO_NULL         ((GST_STATE_READY<<8) | GST_STATE_NULL)
53
54 extern GType _gst_element_type;
55
56 #define GST_TYPE_ELEMENT                (_gst_element_type)
57
58 #define GST_ELEMENT_CAST(obj)           ((GstElement*)(obj))
59 #define GST_ELEMENT_CLASS_CAST(klass)   ((GstElementClass*)(klass))
60 #define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
61 #define GST_IS_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
62 #define GST_ELEMENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
63
64 #ifdef GST_TYPE_PARANOID
65 # define GST_ELEMENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
66 # define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
67 #else
68 # define GST_ELEMENT                    GST_ELEMENT_CAST
69 # define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_CAST
70 #endif
71
72 /* convenience functions */
73 #ifdef G_HAVE_ISO_VARARGS
74 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, ...) \
75         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, __VA_ARGS__);
76 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, ...)    \
77         GST_FORMATS_FUNCTION (GstElement*, functionname, __VA_ARGS__);
78 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, ...) \
79         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, __VA_ARGS__);
80 #elif defined(G_HAVE_GNUC_VARARGS)
81 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, a...) \
82         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, a);
83 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, a...)    \
84         GST_FORMATS_FUNCTION (GstElement*, functionname, a);
85 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, a...) \
86         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, a);
87 #endif
88
89 typedef enum {
90   /* element is complex (for some def.) and generally require a cothread */
91   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
92   /* input and output pads aren't directly coupled to each other
93      examples: queues, multi-output async readers, etc. */
94   GST_ELEMENT_DECOUPLED,
95   /* this element should be placed in a thread if at all possible */
96   GST_ELEMENT_THREAD_SUGGESTED,
97   /* this element, for some reason, has a loop function that performs
98    * an infinite loop without calls to gst_element_yield () */
99   GST_ELEMENT_INFINITE_LOOP,
100   /* there is a new loopfunction ready for placement */
101   GST_ELEMENT_NEW_LOOPFUNC,
102   /* if this element can handle events */
103   GST_ELEMENT_EVENT_AWARE,
104   /* use threadsafe property get/set implementation */
105   GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
106
107   /* private flags that can be used by the scheduler */
108   GST_ELEMENT_SCHEDULER_PRIVATE1,
109   GST_ELEMENT_SCHEDULER_PRIVATE2,
110
111   /* use some padding for future expansion */
112   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 16
113 } GstElementFlags;
114
115 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
116 #define GST_ELEMENT_IS_EOS(obj)                 (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
117 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
118 #define GST_ELEMENT_IS_DECOUPLED(obj)           (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
119
120 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
121 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
122 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
123 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
124 #define GST_ELEMENT_CLOCK(obj)                  (((GstElement*)(obj))->clock)
125 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
126
127 typedef struct _GstElementFactory GstElementFactory;
128 typedef struct _GstElementFactoryClass GstElementFactoryClass;
129
130 typedef void            (*GstElementLoopFunction)       (GstElement *element);
131 typedef void            (*GstElementPreRunFunction)     (GstElement *element);
132 typedef void            (*GstElementPostRunFunction)    (GstElement *element);
133
134 struct _GstElement {
135   GstObject             object;
136
137   /* element state  and scheduling */
138   guint8                current_state;
139   guint8                pending_state;
140   GstElementLoopFunction loopfunc;
141
142   GstScheduler          *sched;
143   gpointer              sched_private;
144
145   /* allocated clock */
146   GstClock              *clock;
147   GstClockTime           base_time;
148
149   /* element pads */
150   guint16               numpads;
151   guint16               numsrcpads;
152   guint16               numsinkpads;
153   GList                 *pads;
154
155   GMutex                *state_mutex;
156   GCond                 *state_cond;
157
158   GstElementPreRunFunction  pre_run_func;
159   GstElementPostRunFunction post_run_func;
160   GAsyncQueue           *prop_value_queue;
161   GMutex                *property_mutex;
162
163   gpointer              dummy[8];
164 };
165
166 struct _GstElementClass {
167   GstObjectClass        parent_class;
168
169   /* the elementfactory that created us */
170   GstElementFactory     *elementfactory;
171   /* templates for our pads */
172   GList                 *padtemplates;
173   gint                  numpadtemplates;
174   
175   /* signal callbacks */
176   void (*state_change)  (GstElement *element, GstElementState old, GstElementState state);
177   void (*new_pad)       (GstElement *element, GstPad *pad);
178   void (*pad_removed)   (GstElement *element, GstPad *pad);
179   void (*error)         (GstElement *element, GstElement *source, gchar *error);
180   void (*eos)           (GstElement *element);
181
182   /* local pointers for get/set */
183   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
184   void (*get_property)  (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
185
186   /* vtable*/
187   gboolean              (*release_locks)        (GstElement *element);
188
189   /* query/convert/events functions */
190   const GstEventMask*   (*get_event_masks)      (GstElement *element);
191   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
192   const GstFormat*      (*get_formats)          (GstElement *element);
193   gboolean              (*convert)              (GstElement *element,
194                                                  GstFormat  src_format,  gint64  src_value,
195                                                  GstFormat *dest_format, gint64 *dest_value);
196   const GstQueryType*   (*get_query_types)      (GstElement *element);
197   gboolean              (*query)                (GstElement *element, GstQueryType type,
198                                                  GstFormat *format, gint64 *value);
199
200   /* change the element state */
201   GstElementStateReturn (*change_state)         (GstElement *element);
202
203   /* request/release pads */
204   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
205   void                  (*release_pad)          (GstElement *element, GstPad *pad);
206
207   /* set/get clocks */
208   GstClock*             (*get_clock)            (GstElement *element);
209   void                  (*set_clock)            (GstElement *element, GstClock *clock);
210
211   /* index */
212   GstIndex*             (*get_index)            (GstElement *element);
213   void                  (*set_index)            (GstElement *element, GstIndex *index);
214
215   /* padding */
216   gpointer              dummy[8];
217 };
218
219 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
220 void                    gst_element_class_install_std_props     (GstElementClass *klass,
221                                                                  const gchar      *first_name, ...);
222
223 #define                 gst_element_default_deep_notify         gst_object_default_deep_notify
224
225 void                    gst_element_default_error               (GObject *object, GstObject *orig, gchar *error);
226
227 GType                   gst_element_get_type            (void);
228 #define                 gst_element_destroy(element)    gst_object_destroy (GST_OBJECT (element))
229
230 void                    gst_element_set_loop_function   (GstElement *element,
231                                                          GstElementLoopFunction loop);
232
233 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT(elem))
234 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
235 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
236 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT(elem),parent)
237
238 /* threadsafe versions of their g_object_* counterparts */
239 void                    gst_element_set                 (GstElement *element, const gchar *first_property_name, ...);
240 void                    gst_element_get                 (GstElement *element, const gchar *first_property_name, ...);
241 void                    gst_element_set_valist          (GstElement *element, const gchar *first_property_name,
242                                                          va_list var_args);
243 void                    gst_element_get_valist          (GstElement *element, const gchar *first_property_name,
244                                                          va_list var_args);
245 void                    gst_element_set_property        (GstElement *element, const gchar *property_name,
246                                                          const GValue   *value);
247 void                    gst_element_get_property        (GstElement *element, const gchar *property_name,
248                                                          GValue *value);
249
250 void                    gst_element_enable_threadsafe_properties        (GstElement *element);
251 void                    gst_element_disable_threadsafe_properties       (GstElement *element);
252 void                    gst_element_set_pending_properties              (GstElement *element);
253
254 /* clocking */
255 gboolean                gst_element_requires_clock      (GstElement *element);
256 gboolean                gst_element_provides_clock      (GstElement *element);
257 GstClock*               gst_element_get_clock           (GstElement *element);
258 void                    gst_element_set_clock           (GstElement *element, GstClock *clock);
259 GstClockReturn          gst_element_clock_wait          (GstElement *element, 
260                                                          GstClockID id, GstClockTimeDiff *jitter);
261  
262 /* indexs */
263 gboolean                gst_element_is_indexable        (GstElement *element);
264 void                    gst_element_set_index           (GstElement *element, GstIndex *index);
265 GstIndex*               gst_element_get_index           (GstElement *element);
266
267
268 gboolean                gst_element_release_locks       (GstElement *element);
269
270 void                    gst_element_yield               (GstElement *element);
271 gboolean                gst_element_interrupt           (GstElement *element);
272 void                    gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
273 GstScheduler*           gst_element_get_scheduler       (GstElement *element);
274
275 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
276 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
277 GstPad *                gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, const gchar *name);
278 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
279
280 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
281 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
282 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
283 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
284
285 const GList*            gst_element_get_pad_list        (GstElement *element);
286 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad);
287 GstPad*                 gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
288                                                          GstCaps *filtercaps);
289
290 GstPadTemplate*         gst_element_get_pad_template            (GstElement *element, const gchar *name);
291 GList*                  gst_element_get_pad_template_list       (GstElement *element);
292 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
293
294 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
295 gboolean                gst_element_link_many   (GstElement *element_1, GstElement *element_2, ...);
296 gboolean                gst_element_link_filtered       (GstElement *src, GstElement *dest,
297                                                          GstCaps *filtercaps);
298 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
299 void                    gst_element_unlink_many         (GstElement *element_1, GstElement *element_2, ...);
300
301 gboolean                gst_element_link_pads   (GstElement *src, const gchar *srcpadname,
302                                                          GstElement *dest, const gchar *destpadname);
303 gboolean                gst_element_link_pads_filtered (GstElement *src, const gchar *srcpadname,
304                                                          GstElement *dest, const gchar *destpadname,
305                                                          GstCaps *filtercaps);
306 void                    gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
307                                                          GstElement *dest, const gchar *destpadname);
308
309 const GstEventMask*     gst_element_get_event_masks     (GstElement *element);
310 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
311 const GstQueryType*     gst_element_get_query_types     (GstElement *element);
312 gboolean                gst_element_query               (GstElement *element, GstQueryType type,
313                                                          GstFormat *format, gint64 *value);
314 const GstFormat*        gst_element_get_formats         (GstElement *element);
315 gboolean                gst_element_convert             (GstElement *element, 
316                                                          GstFormat  src_format,  gint64  src_value,
317                                                          GstFormat *dest_format, gint64 *dest_value);
318
319 void                    gst_element_set_eos             (GstElement *element);
320
321 void                    gst_element_error               (GstElement *element, const gchar *error, ...);
322
323 GstElementState         gst_element_get_state           (GstElement *element);
324 GstElementStateReturn   gst_element_set_state           (GstElement *element, GstElementState state);
325
326 void                    gst_element_wait_state_change   (GstElement *element);
327         
328 const gchar*            gst_element_state_get_name      (GstElementState state);
329
330 GstElementFactory*      gst_element_get_factory         (GstElement *element);
331
332 GstBin*                 gst_element_get_managing_bin    (GstElement *element);
333
334
335 /*
336  *
337  * factories stuff
338  *
339  **/
340 typedef struct _GstElementDetails GstElementDetails;
341
342 struct _GstElementDetails {
343   gchar *longname;              /* long, english name */
344   gchar *klass;                 /* type of element, as hierarchy */
345   gchar *license;               /* license element is under */
346   gchar *description;           /* insights of one form or another */
347   gchar *version;               /* version of the element */
348   gchar *author;                /* who wrote this thing? */
349   gchar *copyright;             /* copyright details (year, etc.) */
350 };
351
352 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
353 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
354                                                  GstElementFactory))
355 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
356                                                  GstElementFactoryClass))
357 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
358 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
359
360 #define GST_ELEMENT_RANK_PRIMARY    256
361 #define GST_ELEMENT_RANK_SECONDARY  128
362 #define GST_ELEMENT_RANK_MARGINAL   64
363 #define GST_ELEMENT_RANK_NONE       0
364
365 struct _GstElementFactory {
366   GstPluginFeature feature;
367
368   GType type;                   /* unique GType of element */
369
370   guint details_dynamic : 1;
371
372   GstElementDetails *details;   /* pointer to details struct */
373
374   GList *padtemplates;
375   guint16 numpadtemplates;
376
377   guint16 rank;                 /* used by autoplug to prioritise elements to try */
378 };
379
380 struct _GstElementFactoryClass {
381   GstPluginFeatureClass parent_class;
382 };
383
384 GType                   gst_element_factory_get_type            (void);
385
386 GstElementFactory*      gst_element_factory_new                 (const gchar *name, GType type,
387                                                                  GstElementDetails *details);
388 GstElementFactory*      gst_element_factory_find                (const gchar *name);
389
390 void                    gst_element_factory_add_pad_template    (GstElementFactory *elementfactory,
391                                                                  GstPadTemplate *templ);
392
393 gboolean                gst_element_factory_can_src_caps        (GstElementFactory *factory,
394                                                                  GstCaps *caps);
395 gboolean                gst_element_factory_can_sink_caps       (GstElementFactory *factory,
396                                                                  GstCaps *caps);
397
398 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
399                                                                  const gchar *name);
400 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
401 GstElement*             gst_element_factory_make_or_warn        (const gchar *factoryname, const gchar *name);
402
403 void                    gst_element_factory_set_rank            (GstElementFactory *factory, guint16 rank);
404
405 G_END_DECLS
406
407
408 #endif /* __GST_ELEMENT_H__ */
409