2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstpad.h: Header for GstPad object
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.
27 #include <gst/gstconfig.h>
29 #include <gst/gstobject.h>
30 #include <gst/gstbuffer.h>
31 #include <gst/gstcaps.h>
32 #include <gst/gstevent.h>
37 extern GType _gst_pad_type;
38 extern GType _gst_real_pad_type;
39 extern GType _gst_ghost_pad_type;
41 #define GST_TYPE_PARANOID
46 #define GST_TYPE_PAD (_gst_pad_type)
48 #define GST_PAD_CAST(obj) ((GstPad*)(obj))
49 #define GST_PAD_CLASS_CAST(klass) ((GstPadClass*)(klass))
50 #define GST_IS_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
51 #define GST_IS_PAD_FAST(obj) (G_OBJECT_TYPE(obj) == GST_TYPE_REAL_PAD || \
52 G_OBJECT_TYPE(obj) == GST_TYPE_GHOST_PAD)
53 #define GST_IS_PAD_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
55 #ifdef GST_TYPE_PARANOID
56 # define GST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
57 # define GST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
59 # define GST_PAD GST_PAD_CAST
60 # define GST_PAD_CLASS GST_PAD_CLASS_CAST
66 #define GST_TYPE_REAL_PAD (_gst_real_pad_type)
68 #define GST_REAL_PAD_CAST(obj) ((GstRealPad*)(obj))
69 #define GST_REAL_PAD_CLASS_CAST(klass) ((GstRealPadClass*)(klass))
70 #define GST_IS_REAL_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_REAL_PAD))
71 #define GST_IS_REAL_PAD_FAST(obj) (G_OBJECT_TYPE(obj) == GST_TYPE_REAL_PAD)
72 #define GST_IS_REAL_PAD_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_REAL_PAD))
74 #ifdef GST_TYPE_PARANOID
75 # define GST_REAL_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_REAL_PAD, GstRealPad))
76 # define GST_REAL_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_REAL_PAD, GstRealPadClass))
78 # define GST_REAL_PAD GST_REAL_PAD_CAST
79 # define GST_REAL_PAD_CLASS GST_REAL_PAD_CLASS_CAST
85 #define GST_TYPE_GHOST_PAD (_gst_ghost_pad_type)
87 #define GST_GHOST_PAD_CAST(obj) ((GstGhostPad*)(obj))
88 #define GST_GHOST_PAD_CLASS_CAST(klass) ((GstGhostPadClass*)(klass))
89 #define GST_IS_GHOST_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_GHOST_PAD))
90 #define GST_IS_GHOST_PAD_FAST(obj) (G_OBJECT_TYPE(obj) == GST_TYPE_GHOST_PAD)
91 #define GST_IS_GHOST_PAD_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GHOST_PAD))
93 #ifdef GST_TYPE_PARANOID
94 # define GST_GHOST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GHOST_PAD, GstGhostPad))
95 # define GST_GHOST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GHOST_PAD, GstGhostPadClass))
97 # define GST_GHOST_PAD GST_GHOST_PAD_CAST
98 # define GST_GHOST_PAD_CLASS GST_GHOST_PAD_CLASS_CAST
102 /*typedef struct _GstPad GstPad; */
103 /*typedef struct _GstPadClass GstPadClass;*/
104 typedef struct _GstRealPad GstRealPad;
105 typedef struct _GstRealPadClass GstRealPadClass;
106 typedef struct _GstGhostPad GstGhostPad;
107 typedef struct _GstGhostPadClass GstGhostPadClass;
108 /*typedef struct _GstPadTemplate GstPadTemplate;*/
109 /*typedef struct _GstPadTemplateClass GstPadTemplateClass;*/
113 GST_PAD_CONNECT_REFUSED = -1,
114 GST_PAD_CONNECT_DELAYED = 0,
115 GST_PAD_CONNECT_OK = 1,
116 GST_PAD_CONNECT_DONE = 2
117 } GstPadConnectReturn;
120 GST_PAD_QUERY_NONE = 0,
122 GST_PAD_QUERY_POSITION,
123 GST_PAD_QUERY_LATENCY,
124 GST_PAD_QUERY_JITTER,
125 GST_PAD_QUERY_SEGMENT_END
128 /* this defines the functions used to chain buffers
129 * pad is the sink pad (so the same chain function can be used for N pads)
130 * buf is the buffer being passed */
131 typedef void (*GstPadChainFunction) (GstPad *pad,GstBuffer *buf);
132 typedef GstBuffer* (*GstPadGetFunction) (GstPad *pad);
133 typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstEvent *event);
134 typedef gboolean (*GstPadConvertFunction) (GstPad *pad,
135 GstFormat src_format, gint64 src_value,
136 GstFormat *dest_format, gint64 *dest_value);
137 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstPadQueryType type,
138 GstFormat *format, gint64 *value);
139 typedef GList* (*GstPadIntConnFunction) (GstPad *pad);
140 typedef const GstFormat* (*GstPadFormatsFunction) (GstPad *pad);
141 typedef const GstEventMask* (*GstPadEventMaskFunction) (GstPad *pad);
142 typedef const GstPadQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
144 typedef GstPadConnectReturn (*GstPadConnectFunction) (GstPad *pad, GstCaps *caps);
145 typedef GstCaps* (*GstPadGetCapsFunction) (GstPad *pad, GstCaps *caps);
146 typedef GstBufferPool* (*GstPadBufferPoolFunction) (GstPad *pad);
148 typedef gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
157 GST_PAD_DISABLED = GST_OBJECT_FLAG_LAST,
160 GST_PAD_FLAG_LAST = GST_OBJECT_FLAG_LAST + 4
166 gpointer element_private;
168 GstPadTemplate *padtemplate; /* the template for this pad */
171 struct _GstPadClass {
172 GstObjectClass parent_class;
178 /* the pad cpabilities */
182 GstPadGetCapsFunction getcapsfunc;
184 GstPadDirection direction;
187 gpointer sched_private;
189 GstPadConnectFunction connectfunc;
194 /* data transport functions */
195 GstPadChainFunction chainfunc;
196 GstPadChainFunction chainhandler;
197 GstPadGetFunction getfunc;
198 GstPadGetFunction gethandler;
199 GstPadEventFunction eventfunc;
200 GstPadEventFunction eventhandler;
201 GstPadEventMaskFunction eventmaskfunc;
205 /* query/convert/formats functions */
206 GstPadConvertFunction convertfunc;
207 GstPadQueryFunction queryfunc;
208 GstPadFormatsFunction formatsfunc;
209 GstPadQueryTypeFunction querytypefunc;
210 GstPadIntConnFunction intconnfunc;
212 GstPadBufferPoolFunction bufferpoolfunc;
215 struct _GstRealPadClass {
216 GstPadClass parent_class;
218 /* signal callbacks */
219 void (*set_active) (GstPad *pad, gboolean active);
220 void (*caps_changed) (GstPad *pad, GstCaps *newcaps);
221 void (*caps_nego_failed) (GstPad *pad);
222 void (*connected) (GstPad *pad, GstPad *peer);
223 void (*disconnected) (GstPad *pad, GstPad *peer);
224 void (*event_received) (GstPad *pad, GstEvent *event);
226 void (*eos) (GstPad *pad);
229 struct _GstGhostPad {
235 struct _GstGhostPadClass {
236 GstPadClass parent_class;
240 /***** helper macros *****/
242 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
243 #define GST_PAD_PARENT(pad) ((GstElement *)(GST_OBJECT_PARENT(pad)))
244 #define GST_PAD_ELEMENT_PRIVATE(pad) (((GstPad *)(pad))->element_private)
245 #define GST_PAD_PAD_TEMPLATE(pad) (((GstPad *)(pad))->padtemplate)
248 #define GST_RPAD_DIRECTION(pad) (((GstRealPad *)(pad))->direction)
249 #define GST_RPAD_CAPS(pad) (((GstRealPad *)(pad))->caps)
250 #define GST_RPAD_FILTER(pad) (((GstRealPad *)(pad))->filter)
251 #define GST_RPAD_APPFILTER(pad) (((GstRealPad *)(pad))->appfilter)
252 #define GST_RPAD_PEER(pad) (((GstRealPad *)(pad))->peer)
253 #define GST_RPAD_BUFPEN(pad) (((GstRealPad *)(pad))->bufpen)
254 #define GST_RPAD_SCHED(pad) (((GstRealPad *)(pad))->sched)
255 #define GST_RPAD_CHAINFUNC(pad) (((GstRealPad *)(pad))->chainfunc)
256 #define GST_RPAD_CHAINHANDLER(pad) (((GstRealPad *)(pad))->chainhandler)
257 #define GST_RPAD_GETFUNC(pad) (((GstRealPad *)(pad))->getfunc)
258 #define GST_RPAD_GETHANDLER(pad) (((GstRealPad *)(pad))->gethandler)
259 #define GST_RPAD_EVENTFUNC(pad) (((GstRealPad *)(pad))->eventfunc)
260 #define GST_RPAD_EVENTHANDLER(pad) (((GstRealPad *)(pad))->eventhandler)
261 #define GST_RPAD_CONVERTFUNC(pad) (((GstRealPad *)(pad))->convertfunc)
262 #define GST_RPAD_QUERYFUNC(pad) (((GstRealPad *)(pad))->queryfunc)
263 #define GST_RPAD_INTCONNFUNC(pad) (((GstRealPad *)(pad))->intconnfunc)
264 #define GST_RPAD_FORMATSFUNC(pad) (((GstRealPad *)(pad))->formatsfunc)
265 #define GST_RPAD_QUERYTYPEFUNC(pad) (((GstRealPad *)(pad))->querytypefunc)
266 #define GST_RPAD_EVENTMASKFUNC(pad) (((GstRealPad *)(pad))->eventmaskfunc)
268 #define GST_RPAD_EVENT_MASKS(pad) (((GstRealPad *)(pad))->event_masks)
269 #define GST_RPAD_QUERY_TYPES(pad) (((GstRealPad *)(pad))->query_types)
271 #define GST_RPAD_CONNECTFUNC(pad) (((GstRealPad *)(pad))->connectfunc)
272 #define GST_RPAD_GETCAPSFUNC(pad) (((GstRealPad *)(pad))->getcapsfunc)
273 #define GST_RPAD_BUFFERPOOLFUNC(pad) (((GstRealPad *)(pad))->bufferpoolfunc)
276 #define GST_GPAD_REALPAD(pad) (((GstGhostPad *)(pad))->realpad)
279 #define GST_PAD_REALIZE(pad) (GST_IS_REAL_PAD(pad) ? ((GstRealPad *)(pad)) : GST_GPAD_REALPAD(pad))
280 #define GST_PAD_DIRECTION(pad) GST_RPAD_DIRECTION(GST_PAD_REALIZE(pad))
281 #define GST_PAD_CAPS(pad) GST_RPAD_CAPS(GST_PAD_REALIZE(pad))
282 #define GST_PAD_PEER(pad) GST_PAD_CAST(GST_RPAD_PEER(GST_PAD_REALIZE(pad)))
284 /* Some check functions (unused?) */
285 #define GST_PAD_IS_CONNECTED(pad) (GST_PAD_PEER(pad) != NULL)
286 #define GST_PAD_IS_ACTIVE(pad) (!GST_FLAG_IS_SET(pad, GST_PAD_DISABLED))
287 #define GST_PAD_IS_USABLE(pad) (GST_PAD_IS_CONNECTED (pad) && \
288 GST_PAD_IS_ACTIVE(pad) && GST_PAD_IS_ACTIVE(GST_PAD_PEER (pad)))
289 #define GST_PAD_CAN_PULL(pad) (GST_IS_REAL_PAD(pad) && GST_REAL_PAD(pad)->gethandler != NULL)
290 #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
291 #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
293 /***** PadTemplate *****/
294 #define GST_TYPE_PAD_TEMPLATE (gst_pad_template_get_type ())
295 #define GST_PAD_TEMPLATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
296 #define GST_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
297 #define GST_IS_PAD_TEMPLATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
298 #define GST_IS_PAD_TEMPLATE_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
306 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ) (((GstPadTemplate *)(templ))->name_template)
307 #define GST_PAD_TEMPLATE_DIRECTION(templ) (((GstPadTemplate *)(templ))->direction)
308 #define GST_PAD_TEMPLATE_PRESENCE(templ) (((GstPadTemplate *)(templ))->presence)
309 #define GST_PAD_TEMPLATE_CAPS(templ) (((GstPadTemplate *)(templ))->caps)
310 #define GST_PAD_TEMPLATE_FIXED(templ) (((GstPadTemplate *)(templ))->fixed)
312 #define GST_PAD_TEMPLATE_IS_FIXED(templ) (GST_PAD_TEMPLATE_FIXED(templ) == TRUE)
314 struct _GstPadTemplate {
317 gchar *name_template;
318 GstPadDirection direction;
319 GstPadPresence presence;
324 struct _GstPadTemplateClass {
325 GstObjectClass parent_class;
327 /* signal callbacks */
328 void (*pad_created) (GstPadTemplate *templ, GstPad *pad);
331 /* CR1: the space after 'a' is necessary because of preprocessing in gcc */
332 #define GST_PAD_TEMPLATE_NEW(padname, dir, pres, a...) \
333 gst_pad_template_new ( \
340 #define GST_PAD_TEMPLATE_FACTORY(name, padname, dir, pres, a...) \
341 static GstPadTemplate* \
344 static GstPadTemplate *templ = NULL; \
346 templ = GST_PAD_TEMPLATE_NEW ( \
355 #define GST_PAD_TEMPLATE_GET(fact) (fact)()
357 GType gst_pad_get_type (void);
358 GType gst_real_pad_get_type (void);
359 GType gst_ghost_pad_get_type (void);
362 GstPad* gst_pad_new (const gchar *name, GstPadDirection direction);
363 #define gst_pad_destroy(pad) gst_object_destroy (GST_OBJECT (pad))
364 GstPad* gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name);
365 GstPad* gst_pad_custom_new (GType type, const gchar *name, GstPadDirection direction);
366 GstPad* gst_pad_custom_new_from_template (GType type, GstPadTemplate *templ, const gchar *name);
368 void gst_pad_set_name (GstPad *pad, const gchar *name);
369 const gchar* gst_pad_get_name (GstPad *pad);
371 GstPadDirection gst_pad_get_direction (GstPad *pad);
373 void gst_pad_set_active (GstPad *pad, gboolean active);
374 gboolean gst_pad_is_active (GstPad *pad);
376 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
377 gpointer gst_pad_get_element_private (GstPad *pad);
379 void gst_pad_set_parent (GstPad *pad, GstObject *parent);
380 GstElement* gst_pad_get_parent (GstPad *pad);
381 GstElement* gst_pad_get_real_parent (GstPad *pad);
383 void gst_pad_set_scheduler (GstPad *pad, GstScheduler *sched);
384 GstScheduler* gst_pad_get_scheduler (GstPad *pad);
385 void gst_pad_unset_scheduler (GstPad *pad);
387 void gst_pad_add_ghost_pad (GstPad *pad, GstPad *ghostpad);
388 void gst_pad_remove_ghost_pad (GstPad *pad, GstPad *ghostpad);
389 GList* gst_pad_get_ghost_pad_list (GstPad *pad);
391 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
393 void gst_pad_set_bufferpool_function (GstPad *pad, GstPadBufferPoolFunction bufpool);
394 GstBufferPool* gst_pad_get_bufferpool (GstPad *pad);
396 /* data passing setup functions */
397 void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain);
398 void gst_pad_set_get_function (GstPad *pad, GstPadGetFunction get);
399 void gst_pad_set_event_function (GstPad *pad, GstPadEventFunction event);
400 void gst_pad_set_event_mask_function (GstPad *pad, GstPadEventMaskFunction mask_func);
401 const GstEventMask* gst_pad_get_event_masks (GstPad *pad);
402 const GstEventMask* gst_pad_get_event_masks_default (GstPad *pad);
403 gboolean gst_pad_handles_event (GstPad *pad, GstEventMask *mask);
405 /* pad connections */
406 void gst_pad_set_connect_function (GstPad *pad, GstPadConnectFunction connect);
407 gboolean gst_pad_can_connect (GstPad *srcpad, GstPad *sinkpad);
408 gboolean gst_pad_can_connect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps);
410 gboolean gst_pad_connect (GstPad *srcpad, GstPad *sinkpad);
411 gboolean gst_pad_connect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps);
412 void gst_pad_disconnect (GstPad *srcpad, GstPad *sinkpad);
414 GstPad* gst_pad_get_peer (GstPad *pad);
416 /* capsnego functions */
417 GstCaps* gst_pad_get_caps (GstPad *pad);
418 GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
419 gboolean gst_pad_try_set_caps (GstPad *pad, GstCaps *caps);
420 gboolean gst_pad_check_compatibility (GstPad *srcpad, GstPad *sinkpad);
422 void gst_pad_set_getcaps_function (GstPad *pad, GstPadGetCapsFunction getcaps);
423 GstPadConnectReturn gst_pad_proxy_connect (GstPad *pad, GstCaps *caps);
424 gboolean gst_pad_reconnect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps);
425 gboolean gst_pad_perform_negotiate (GstPad *srcpad, GstPad *sinkpad);
426 gboolean gst_pad_try_reconnect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps);
427 GstCaps* gst_pad_get_allowed_caps (GstPad *pad);
428 gboolean gst_pad_recalc_allowed_caps (GstPad *pad);
430 /* data passing functions */
431 void gst_pad_push (GstPad *pad, GstBuffer *buf);
432 GstBuffer* gst_pad_pull (GstPad *pad);
433 gboolean gst_pad_send_event (GstPad *pad, GstEvent *event);
434 gboolean gst_pad_event_default (GstPad *pad, GstEvent *event);
435 GstBuffer* gst_pad_peek (GstPad *pad);
436 GstPad* gst_pad_select (GList *padlist);
437 GstPad* gst_pad_selectv (GstPad *pad, ...);
440 /* convert/query/format functions */
441 void gst_pad_set_formats_function (GstPad *pad, GstPadFormatsFunction format);
442 gboolean gst_pad_handles_format (GstPad *pad, GstFormat format);
443 const GstFormat* gst_pad_get_formats (GstPad *pad);
444 const GstFormat* gst_pad_get_formats_default (GstPad *pad);
446 void gst_pad_set_convert_function (GstPad *pad, GstPadConvertFunction convert);
447 gboolean gst_pad_convert (GstPad *pad,
448 GstFormat src_format, gint64 src_value,
449 GstFormat *dest_format, gint64 *dest_value);
450 gboolean gst_pad_convert_default (GstPad *pad,
451 GstFormat src_format, gint64 src_value,
452 GstFormat *dest_format, gint64 *dest_value);
454 void gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query);
455 void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_function);
456 const GstPadQueryType* gst_pad_get_query_types (GstPad *pad);
457 const GstPadQueryType* gst_pad_get_query_types_default (GstPad *pad);
458 gboolean gst_pad_query (GstPad *pad, GstPadQueryType type,
459 GstFormat *format, gint64 *value);
460 gboolean gst_pad_query_default (GstPad *pad, GstPadQueryType type,
461 GstFormat *format, gint64 *value);
463 void gst_pad_set_internal_connection_function(GstPad *pad, GstPadIntConnFunction intconn);
464 GList* gst_pad_get_internal_connections (GstPad *pad);
465 GList* gst_pad_get_internal_connections_default (GstPad *pad);
467 /* misc helper functions */
468 gboolean gst_pad_dispatcher (GstPad *pad, GstPadDispatcherFunction dispatch,
472 #ifndef GST_DISABLE_LOADSAVE
473 void gst_pad_load_and_connect (xmlNodePtr self, GstObject *parent);
478 GstPad* gst_ghost_pad_new (gchar *name,GstPad *pad);
481 /* templates and factories */
482 GType gst_pad_template_get_type (void);
484 GstPadTemplate* gst_pad_template_new (const gchar *name_template,
485 GstPadDirection direction, GstPadPresence presence,
488 GstCaps* gst_pad_template_get_caps (GstPadTemplate *templ);
489 GstCaps* gst_pad_template_get_caps_by_name (GstPadTemplate *templ, const gchar *name);
491 xmlNodePtr gst_pad_ghost_save_thyself (GstPad *pad,
498 #endif /* __GST_PAD_H__ */