many fixes related to dynamic pipelines.
[platform/upstream/gstreamer.git] / gst / gstpad.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstpad.c: Pads for connecting elements together
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 /* #define GST_DEBUG_ENABLED */
24 #include "gst_private.h"
25
26 #include "gstpad.h"
27 #include "gstutils.h"
28 #include "gstelement.h"
29 #include "gsttype.h"
30 #include "gstbin.h"
31 #include "gstscheduler.h"
32 #include "gstevent.h"
33
34 GType _gst_pad_type = 0;
35
36 /***** Start with the base GstPad class *****/
37 static void             gst_pad_class_init              (GstPadClass *klass);
38 static void             gst_pad_init                    (GstPad *pad);
39
40 static gboolean         gst_pad_try_reconnect_filtered_func (GstRealPad *srcpad, GstRealPad *sinkpad, 
41                                                          GstCaps *caps, gboolean clear);
42
43 #ifndef GST_DISABLE_LOADSAVE
44 static xmlNodePtr       gst_pad_save_thyself            (GstObject *object, xmlNodePtr parent);
45 #endif
46
47 static GstObject *pad_parent_class = NULL;
48
49 GType
50 gst_pad_get_type(void) 
51 {
52   if (!_gst_pad_type) {
53     static const GTypeInfo pad_info = {
54       sizeof(GstPadClass),
55       NULL,
56       NULL,
57       (GClassInitFunc)gst_pad_class_init,
58       NULL,
59       NULL,
60       sizeof(GstPad),
61       32,
62       (GInstanceInitFunc)gst_pad_init,
63       NULL
64     };
65     _gst_pad_type = g_type_register_static(GST_TYPE_OBJECT, "GstPad", &pad_info, 0);
66   }
67   return _gst_pad_type;
68 }
69
70 static void
71 gst_pad_class_init (GstPadClass *klass)
72 {
73   pad_parent_class = g_type_class_ref(GST_TYPE_OBJECT);
74 }
75
76 static void
77 gst_pad_init (GstPad *pad)
78 {
79   pad->element_private = NULL;
80
81   pad->padtemplate = NULL;
82 }
83
84
85
86 /***** Then do the Real Pad *****/
87 /* Pad signals and args */
88 enum {
89   REAL_SET_ACTIVE,
90   REAL_CAPS_CHANGED,
91   REAL_CAPS_NEGO_FAILED,
92   REAL_CONNECTED,
93   REAL_DISCONNECTED,
94   REAL_EVENT_RECEIVED,
95   /* FILL ME */
96   REAL_LAST_SIGNAL
97 };
98
99 enum {
100   REAL_ARG_0,
101   REAL_ARG_ACTIVE,
102   /* FILL ME */
103 };
104
105 static void     gst_real_pad_class_init         (GstRealPadClass *klass);
106 static void     gst_real_pad_init               (GstRealPad *pad);
107
108 static void     gst_real_pad_set_property       (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
109 static void     gst_real_pad_get_property       (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
110
111 static void     gst_real_pad_dispose            (GObject *object);
112
113 static void     gst_pad_push_func               (GstPad *pad, GstBuffer *buf);
114
115 GType _gst_real_pad_type = 0;
116
117 static GstPad *real_pad_parent_class = NULL;
118 static guint gst_real_pad_signals[REAL_LAST_SIGNAL] = { 0 };
119
120 GType
121 gst_real_pad_get_type(void) {
122   if (!_gst_real_pad_type) {
123     static const GTypeInfo pad_info = {
124       sizeof(GstRealPadClass),
125       NULL,
126       NULL,
127       (GClassInitFunc)gst_real_pad_class_init,
128       NULL,
129       NULL,
130       sizeof(GstRealPad),
131       32,
132       (GInstanceInitFunc)gst_real_pad_init,
133       NULL
134     };
135     _gst_real_pad_type = g_type_register_static(GST_TYPE_PAD, "GstRealPad", &pad_info, 0);
136   }
137   return _gst_real_pad_type;
138 }
139
140 static void
141 gst_real_pad_class_init (GstRealPadClass *klass)
142 {
143   GObjectClass *gobject_class;
144   GstObjectClass *gstobject_class;
145
146   gobject_class = (GObjectClass*) klass;
147   gstobject_class = (GstObjectClass*) klass;
148
149   real_pad_parent_class = g_type_class_ref (GST_TYPE_PAD);
150
151   gobject_class->dispose  = GST_DEBUG_FUNCPTR (gst_real_pad_dispose);
152   gobject_class->set_property  = GST_DEBUG_FUNCPTR (gst_real_pad_set_property);
153   gobject_class->get_property  = GST_DEBUG_FUNCPTR (gst_real_pad_get_property);
154
155   gst_real_pad_signals[REAL_SET_ACTIVE] =
156     g_signal_new ("set_active", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
157                     G_STRUCT_OFFSET (GstRealPadClass, set_active), NULL, NULL,
158                     gst_marshal_VOID__BOOLEAN, G_TYPE_NONE, 1,
159                     G_TYPE_BOOLEAN);
160   gst_real_pad_signals[REAL_CAPS_CHANGED] =
161     g_signal_new ("caps_changed", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
162                     G_STRUCT_OFFSET (GstRealPadClass, caps_changed), NULL, NULL,
163                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
164                     G_TYPE_POINTER);
165   gst_real_pad_signals[REAL_CAPS_NEGO_FAILED] =
166     g_signal_new ("caps_nego_failed", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
167                     G_STRUCT_OFFSET (GstRealPadClass, caps_nego_failed), NULL, NULL,
168                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
169                     G_TYPE_POINTER);
170   gst_real_pad_signals[REAL_CONNECTED] =
171     g_signal_new ("connected", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
172                     G_STRUCT_OFFSET (GstRealPadClass, connected), NULL, NULL,
173                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
174                     G_TYPE_POINTER);
175   gst_real_pad_signals[REAL_DISCONNECTED] =
176     g_signal_new ("disconnected", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
177                     G_STRUCT_OFFSET (GstRealPadClass, disconnected), NULL, NULL,
178                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
179                     G_TYPE_POINTER);
180   gst_real_pad_signals[REAL_EVENT_RECEIVED] =
181     g_signal_new ("event_received", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
182                     G_STRUCT_OFFSET (GstRealPadClass, event_received), NULL, NULL,
183                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
184                     G_TYPE_POINTER);
185
186 /*  gtk_object_add_arg_type ("GstRealPad::active", G_TYPE_BOOLEAN, */
187 /*                           GTK_ARG_READWRITE, REAL_ARG_ACTIVE); */
188   g_object_class_install_property (G_OBJECT_CLASS (klass), REAL_ARG_ACTIVE,
189     g_param_spec_boolean ("active", "Active", "Whether the pad is active.",
190                           TRUE,G_PARAM_READWRITE));
191
192 #ifndef GST_DISABLE_LOADSAVE
193   gstobject_class->save_thyself = GST_DEBUG_FUNCPTR (gst_pad_save_thyself);
194 #endif
195   gstobject_class->path_string_separator = ".";
196 }
197
198 static void
199 gst_real_pad_init (GstRealPad *pad)
200 {
201   pad->direction = GST_PAD_UNKNOWN;
202   pad->peer = NULL;
203
204   pad->sched = NULL;
205   pad->sched_private = NULL;
206
207   pad->chainfunc = NULL;
208   pad->getfunc = NULL;
209   pad->getregionfunc = NULL;
210
211   pad->chainhandler = GST_DEBUG_FUNCPTR (gst_pad_push_func);
212   pad->gethandler = NULL;
213   pad->pullregionfunc = NULL;
214
215   pad->bufferpoolfunc = NULL;
216   pad->ghostpads = NULL;
217   pad->caps = NULL;
218
219   pad->connectfunc = NULL;
220   pad->getcapsfunc = NULL;
221 }
222
223 static void
224 gst_real_pad_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
225 {
226   g_return_if_fail (GST_IS_PAD (object));
227
228   switch (prop_id) {
229     case REAL_ARG_ACTIVE:
230       if (g_value_get_boolean (value)) {
231         GST_DEBUG (GST_CAT_PADS, "activating pad %s:%s\n", GST_DEBUG_PAD_NAME (object));
232         GST_FLAG_UNSET (object, GST_PAD_DISABLED);
233       } else {
234         GST_DEBUG (GST_CAT_PADS, "de-activating pad %s:%s\n", GST_DEBUG_PAD_NAME (object));
235         GST_FLAG_SET (object, GST_PAD_DISABLED);
236       }
237       g_signal_emit (G_OBJECT (object), gst_real_pad_signals[REAL_SET_ACTIVE], 0,
238                       !GST_FLAG_IS_SET (object, GST_PAD_DISABLED));
239       break;
240     default:
241       break;
242   }
243 }
244
245 static void
246 gst_real_pad_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
247 {
248   /* it's not null if we got it, but it might not be ours */
249   g_return_if_fail (GST_IS_PAD (object));
250
251   switch (prop_id) {
252     case REAL_ARG_ACTIVE:
253       g_value_set_boolean (value, !GST_FLAG_IS_SET (object, GST_PAD_DISABLED));
254       break;
255     default:
256       break;
257   }
258 }
259
260
261 /**
262  * gst_pad_new:
263  * @name: name of new pad
264  * @direction: either GST_PAD_SRC or GST_PAD_SINK
265  *
266  * Create a new pad with given name.
267  *
268  * Returns: new pad
269  */
270 GstPad*
271 gst_pad_new (gchar *name,
272              GstPadDirection direction)
273 {
274   GstRealPad *pad;
275
276   g_return_val_if_fail (name != NULL, NULL);
277   g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
278
279   pad = g_object_new (gst_real_pad_get_type (), NULL);
280   gst_object_set_name (GST_OBJECT (pad), name);
281   GST_RPAD_DIRECTION (pad) = direction;
282
283   return GST_PAD (pad);
284 }
285
286 /**
287  * gst_pad_new_from_template:
288  * @templ: the pad template to use
289  * @name: the name of the element
290  *
291  * Create a new pad with given name from the given template.
292  *
293  * Returns: new pad
294  */
295 GstPad*
296 gst_pad_new_from_template (GstPadTemplate *templ,
297                            gchar *name)
298 {
299   GstPad *pad;
300
301   g_return_val_if_fail (name != NULL, NULL);
302   g_return_val_if_fail (templ != NULL, NULL);
303
304   pad = gst_pad_new (name, templ->direction);
305   
306   gst_object_ref (GST_OBJECT (templ));
307   GST_PAD_PADTEMPLATE (pad) = templ;
308   
309   return pad;
310 }
311
312 /**
313  * gst_pad_get_direction:
314  * @pad: the Pad to get the direction from
315  *
316  * Get the direction of the pad.
317  *
318  * Returns: the direction of the pad
319  */
320 GstPadDirection
321 gst_pad_get_direction (GstPad *pad)
322 {
323   g_return_val_if_fail (pad != NULL, GST_PAD_UNKNOWN);
324   g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
325
326   return GST_PAD_DIRECTION (pad);
327 }
328
329 /**
330  * gst_pad_set_name:
331  * @pad: the pad to set the name of
332  * @name: the name of the pad
333  *
334  * Set the name of a pad.
335  */
336 void
337 gst_pad_set_name (GstPad *pad,
338                   const gchar *name)
339 {
340   g_return_if_fail (pad != NULL);
341   g_return_if_fail (GST_IS_PAD (pad));
342
343   gst_object_set_name (GST_OBJECT (pad), name);
344 }
345
346 /**
347  * gst_pad_get_name:
348  * @pad: the pad to get the name of
349  *
350  * Get the name of a pad.
351  *
352  * Returns: the name of the pad, don't free.
353  */
354 const gchar*
355 gst_pad_get_name (GstPad *pad)
356 {
357   g_return_val_if_fail (pad != NULL, NULL);
358   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
359
360   return GST_OBJECT_NAME (pad);
361 }
362
363 /**
364  * gst_pad_set_chain_function:
365  * @pad: the pad to set the chain function for
366  * @chain: the chain function
367  *
368  * Set the given chain function for the pad.
369  */
370 void 
371 gst_pad_set_chain_function (GstPad *pad,
372                             GstPadChainFunction chain)
373 {
374   g_return_if_fail (pad != NULL);
375   g_return_if_fail (GST_IS_REAL_PAD (pad));
376
377   GST_RPAD_CHAINFUNC(pad) = chain;
378   GST_DEBUG (GST_CAT_PADS, "chainfunc for %s:%s set to %s\n",
379              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (chain));
380 }
381
382 /**
383  * gst_pad_set_get_function:
384  * @pad: the pad to set the get function for
385  * @get: the get function
386  *
387  * Set the given get function for the pad.
388  */
389 void
390 gst_pad_set_get_function (GstPad *pad,
391                           GstPadGetFunction get)
392 {
393   g_return_if_fail (pad != NULL);
394   g_return_if_fail (GST_IS_REAL_PAD (pad));
395
396   GST_RPAD_GETFUNC(pad) = get;
397   GST_DEBUG (GST_CAT_PADS, "getfunc for %s:%s  set to %s\n",
398              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (get));
399 }
400
401 /**
402  * gst_pad_set_event_function:
403  * @pad: the pad to set the event handler for
404  * @event: the event handler
405  *
406  * Set the given event handler for the pad.
407  */
408 void
409 gst_pad_set_event_function (GstPad *pad,
410                             GstPadEventFunction event)
411 {
412   g_return_if_fail (pad != NULL);
413   g_return_if_fail (GST_IS_REAL_PAD (pad));
414
415   GST_RPAD_EVENTFUNC(pad) = event;
416   GST_DEBUG (GST_CAT_PADS, "eventfunc for %s:%s  set to %s\n",
417              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (event));
418 }
419
420 /**
421  * gst_pad_set_getregion_function:
422  * @pad: the pad to set the getregion function for
423  * @getregion: the getregion function
424  *
425  * Set the given getregion function for the pad.
426  */
427 void
428 gst_pad_set_getregion_function (GstPad *pad,
429                                 GstPadGetRegionFunction getregion)
430 {
431   g_return_if_fail (pad != NULL);
432   g_return_if_fail (GST_IS_REAL_PAD (pad));
433
434   GST_RPAD_GETREGIONFUNC(pad) = getregion;
435   GST_DEBUG (GST_CAT_PADS, "getregionfunc for %s:%s set to %s\n",
436              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (getregion));
437 }
438
439 /**
440  * gst_pad_set_connect_function:
441  * @pad: the pad to set the connect function for
442  * @connect: the connect function
443  *
444  * Set the given connect function for the pad. It will be called
445  * when the pad is connected or reconnected with caps.
446  */
447 void
448 gst_pad_set_connect_function (GstPad *pad,
449                               GstPadConnectFunction connect)
450 {
451   g_return_if_fail (pad != NULL);
452   g_return_if_fail (GST_IS_REAL_PAD (pad));
453
454   GST_RPAD_CONNECTFUNC (pad) = connect;
455   GST_DEBUG (GST_CAT_PADS, "connectfunc for %s:%s set to %s\n",
456              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (connect));
457 }
458
459 /**
460  * gst_pad_set_getcaps_function:
461  * @pad: the pad to set the getcaps function for
462  * @getcaps: the getcaps function
463  *
464  * Set the given getcaps function for the pad.
465  */
466 void
467 gst_pad_set_getcaps_function (GstPad *pad,
468                               GstPadGetCapsFunction getcaps)
469 {
470   g_return_if_fail (pad != NULL);
471   g_return_if_fail (GST_IS_REAL_PAD (pad));
472
473   GST_RPAD_GETCAPSFUNC (pad) = getcaps;
474   GST_DEBUG (GST_CAT_PADS, "getcapsfunc for %s:%s set to %s\n",
475              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (getcaps));
476 }
477 /**
478  * gst_pad_set_bufferpool_function:
479  * @pad: the pad to set the bufferpool function for
480  * @bufpool: the bufferpool function
481  *
482  * Set the given bufferpool function for the pad.
483  */
484 void
485 gst_pad_set_bufferpool_function (GstPad *pad,
486                                  GstPadBufferPoolFunction bufpool)
487 {
488   g_return_if_fail (pad != NULL);
489   g_return_if_fail (GST_IS_REAL_PAD (pad));
490
491   GST_RPAD_BUFFERPOOLFUNC (pad) = bufpool;
492   GST_DEBUG (GST_CAT_PADS, "bufferpoolfunc for %s:%s set to %s\n",
493              GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (bufpool));
494 }
495
496 static void
497 gst_pad_push_func(GstPad *pad, GstBuffer *buf)
498 {
499   if (GST_RPAD_CHAINFUNC (GST_RPAD_PEER (pad)) != NULL) {
500     GST_DEBUG (GST_CAT_DATAFLOW, "calling chain function %s\n",
501                GST_DEBUG_FUNCPTR_NAME (GST_RPAD_CHAINFUNC (GST_RPAD_PEER (pad))));
502     (GST_RPAD_CHAINFUNC (GST_RPAD_PEER (pad))) (pad, buf);
503   } else {
504     GST_DEBUG (GST_CAT_DATAFLOW, "default pad_push handler in place, no chain function\n");
505     g_warning ("(internal error) default pad_push in place for pad %s:%s but it has no chain function", 
506                     GST_DEBUG_PAD_NAME (pad));
507   }
508 }
509
510
511 /**
512  * gst_pad_disconnect:
513  * @srcpad: the source pad to disconnect
514  * @sinkpad: the sink pad to disconnect
515  *
516  * Disconnects the source pad from the sink pad.
517  */
518 void
519 gst_pad_disconnect (GstPad *srcpad,
520                     GstPad *sinkpad)
521 {
522   GstRealPad *realsrc, *realsink;
523
524   /* generic checks */
525   g_return_if_fail (srcpad != NULL);
526   g_return_if_fail (GST_IS_PAD (srcpad));
527   g_return_if_fail (sinkpad != NULL);
528   g_return_if_fail (GST_IS_PAD (sinkpad));
529
530   GST_INFO (GST_CAT_ELEMENT_PADS, "disconnecting %s:%s(%p) and %s:%s(%p)",
531             GST_DEBUG_PAD_NAME (srcpad), srcpad, GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
532
533   /* now we need to deal with the real/ghost stuff */
534   realsrc = GST_PAD_REALIZE (srcpad);
535   realsink = GST_PAD_REALIZE (sinkpad);
536
537   g_return_if_fail (GST_RPAD_PEER (realsrc) != NULL);
538   g_return_if_fail (GST_RPAD_PEER (realsink) != NULL);
539
540   if ((GST_RPAD_DIRECTION (realsrc) == GST_PAD_SINK) &&
541       (GST_RPAD_DIRECTION (realsink) == GST_PAD_SRC)) {
542     GstRealPad *temppad;
543
544     temppad = realsrc;
545     realsrc = realsink;
546     realsink = temppad;
547   }
548   g_return_if_fail ((GST_RPAD_DIRECTION (realsrc) == GST_PAD_SRC) &&
549                     (GST_RPAD_DIRECTION (realsink) == GST_PAD_SINK));
550
551   /* first clear peers */
552   GST_RPAD_PEER (realsrc) = NULL;
553   GST_RPAD_PEER (realsink) = NULL;
554
555   /* reset the filters, both filters are refcounted once */
556   if (GST_RPAD_FILTER (realsrc)) {
557     gst_caps_unref (GST_RPAD_FILTER (realsrc));
558     GST_RPAD_FILTER (realsink) = NULL;
559     GST_RPAD_FILTER (realsrc) = NULL;
560   }
561
562   /* now tell the scheduler */
563   if (GST_PAD_PARENT (realsrc)->sched)
564     gst_scheduler_pad_disconnect (GST_PAD_PARENT (realsrc)->sched, (GstPad *)realsrc, (GstPad *)realsink);
565   else if (GST_PAD_PARENT (realsink)->sched)
566     gst_scheduler_pad_disconnect (GST_PAD_PARENT (realsink)->sched, (GstPad *)realsrc, (GstPad *)realsink);
567
568   /* hold a reference, as they can go away in the signal handlers */
569   gst_object_ref (GST_OBJECT (realsrc));
570   gst_object_ref (GST_OBJECT (realsink));
571
572   /* fire off a signal to each of the pads telling them that they've been disconnected */
573   g_signal_emit (G_OBJECT (realsrc), gst_real_pad_signals[REAL_DISCONNECTED], 0, realsink);
574   g_signal_emit (G_OBJECT (realsink), gst_real_pad_signals[REAL_DISCONNECTED], 0, realsrc);
575
576   GST_INFO (GST_CAT_ELEMENT_PADS, "disconnected %s:%s and %s:%s",
577             GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
578
579   gst_object_unref (GST_OBJECT (realsrc));
580   gst_object_unref (GST_OBJECT (realsink));
581 }
582
583 /**
584  * gst_pad_can_connect_filtered:
585  * @srcpad: the source pad to connect
586  * @sinkpad: the sink pad to connect
587  * @filtercaps: the filter caps.
588  *
589  * Checks if the source pad and the sink pad can be connected. 
590  * The filter indicates the media type that should flow trought this connection.
591  *
592  * Returns: TRUE if the pad can be connected, FALSE otherwise
593  */
594 gboolean
595 gst_pad_can_connect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps)
596 {
597   gint num_decoupled = 0;
598   GstRealPad *realsrc, *realsink;
599
600   /* generic checks */
601   g_return_val_if_fail (srcpad != NULL, FALSE);
602   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
603   g_return_val_if_fail (sinkpad != NULL, FALSE);
604   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
605
606   /* now we need to deal with the real/ghost stuff */
607   realsrc = GST_PAD_REALIZE (srcpad);
608   realsink = GST_PAD_REALIZE (sinkpad);
609
610   g_return_val_if_fail (GST_RPAD_PEER (realsrc) == NULL, FALSE);
611   g_return_val_if_fail (GST_RPAD_PEER (realsink) == NULL, FALSE);
612   g_return_val_if_fail (GST_PAD_PARENT (realsrc) != NULL, FALSE);
613   g_return_val_if_fail (GST_PAD_PARENT (realsink) != NULL, FALSE);
614
615   if (realsrc->sched && realsink->sched) {
616     if (GST_FLAG_IS_SET (GST_PAD_PARENT (realsrc), GST_ELEMENT_DECOUPLED))
617       num_decoupled++;
618     if (GST_FLAG_IS_SET (GST_PAD_PARENT (realsink), GST_ELEMENT_DECOUPLED))
619       num_decoupled++;
620
621     if (realsrc->sched != realsink->sched && num_decoupled != 1) {
622       g_warning ("connecting pads with different scheds requires exactly one decoupled element (queue)\n");
623       return FALSE;
624     }
625   }
626   
627   /* check if the directions are compatible */
628   if (!(((GST_RPAD_DIRECTION (realsrc) == GST_PAD_SINK) &&
629          (GST_RPAD_DIRECTION (realsink) == GST_PAD_SRC)) ||
630         ((GST_RPAD_DIRECTION (realsrc) == GST_PAD_SRC) &&
631          (GST_RPAD_DIRECTION (realsink) == GST_PAD_SINK))))
632   {
633     return FALSE;
634   }
635   
636   return TRUE;
637 }
638 /**
639  * gst_pad_can_connect:
640  * @srcpad: the source pad to connect
641  * @sinkpad: the sink pad to connect
642  *
643  * Checks if the source pad can be connected to the sink pad.
644  *
645  * Returns: TRUE if the pads can be connected, FALSE otherwise
646  */
647 gboolean
648 gst_pad_can_connect (GstPad *srcpad, GstPad *sinkpad)
649 {
650   return gst_pad_can_connect_filtered (srcpad, sinkpad, NULL);
651 }
652
653 /**
654  * gst_pad_connect_filtered:
655  * @srcpad: the source pad to connect
656  * @sinkpad: the sink pad to connect
657  * @filtercaps: the filter caps.
658  *
659  * Connects the source pad to the sink pad. The filter indicates the media type
660  * that should flow trought this connection.
661  *
662  * Returns: TRUE if the pad could be connected, FALSE otherwise
663  */
664 gboolean
665 gst_pad_connect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps)
666 {
667   GstRealPad *realsrc, *realsink;
668   gint num_decoupled = 0;
669
670   /* generic checks */
671   g_return_val_if_fail (srcpad != NULL, FALSE);
672   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
673   g_return_val_if_fail (sinkpad != NULL, FALSE);
674   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
675
676   GST_INFO (GST_CAT_PADS, "connecting %s:%s and %s:%s",
677             GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
678
679   /* now we need to deal with the real/ghost stuff */
680   realsrc = GST_PAD_REALIZE (srcpad);
681   realsink = GST_PAD_REALIZE (sinkpad);
682
683   if ((GST_PAD (realsrc) != srcpad) || (GST_PAD (realsink) != sinkpad)) {
684     GST_INFO (GST_CAT_PADS, "*actually* connecting %s:%s and %s:%s",
685               GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
686   }
687
688   g_return_val_if_fail (GST_RPAD_PEER (realsrc) == NULL, FALSE);
689   g_return_val_if_fail (GST_RPAD_PEER (realsink) == NULL, FALSE);
690   g_return_val_if_fail (GST_PAD_PARENT (realsrc) != NULL, FALSE);
691   g_return_val_if_fail (GST_PAD_PARENT (realsink) != NULL, FALSE);
692
693   if (realsrc->sched && realsink->sched) {
694     if (GST_FLAG_IS_SET (GST_PAD_PARENT (realsrc), GST_ELEMENT_DECOUPLED))
695       num_decoupled++;
696     if (GST_FLAG_IS_SET (GST_PAD_PARENT (realsink), GST_ELEMENT_DECOUPLED))
697       num_decoupled++;
698
699     if (realsrc->sched != realsink->sched && num_decoupled != 1) {
700       g_warning ("connecting pads with different scheds requires exactly one decoupled element (queue)\n");
701       return FALSE;
702     }
703   }
704
705   /* check for reversed directions and swap if necessary */
706   if ((GST_RPAD_DIRECTION (realsrc) == GST_PAD_SINK) &&
707       (GST_RPAD_DIRECTION (realsink) == GST_PAD_SRC)) {
708     GstRealPad *temppad;
709
710     temppad = realsrc;
711     realsrc = realsink;
712     realsink = temppad;
713   }
714   g_return_val_if_fail ((GST_RPAD_DIRECTION (realsrc) == GST_PAD_SRC) &&
715                         (GST_RPAD_DIRECTION (realsink) == GST_PAD_SINK), FALSE);
716
717   /* first set peers */
718   GST_RPAD_PEER (realsrc) = realsink;
719   GST_RPAD_PEER (realsink) = realsrc;
720
721   /* try to negotiate the pads, we don't need to clear the caps here */
722   if (!gst_pad_try_reconnect_filtered_func (realsrc, realsink, filtercaps, FALSE)) {
723     GST_DEBUG (GST_CAT_CAPS, "pads cannot connect\n");
724
725     GST_RPAD_PEER (realsrc) = NULL;
726     GST_RPAD_PEER (realsink) = NULL;
727
728     return FALSE;
729   }
730     
731   /* fire off a signal to each of the pads telling them that they've been connected */
732   g_signal_emit (G_OBJECT (realsrc), gst_real_pad_signals[REAL_CONNECTED], 0, realsink);
733   g_signal_emit (G_OBJECT (realsink), gst_real_pad_signals[REAL_CONNECTED], 0, realsrc);
734
735   /* now tell the scheduler(s) */
736   if (realsrc->sched)
737     gst_scheduler_pad_connect (realsrc->sched, (GstPad *)realsrc, (GstPad *)realsink);
738   else if (realsink->sched)
739     gst_scheduler_pad_connect (realsink->sched, (GstPad *)realsrc, (GstPad *)realsink);
740
741   GST_INFO (GST_CAT_PADS, "connected %s:%s and %s:%s",
742             GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
743
744   return TRUE;
745 }
746
747 /**
748  * gst_pad_connect:
749  * @srcpad: the source pad to connect
750  * @sinkpad: the sink pad to connect
751  *
752  * Connects the source pad to the sink pad.
753  *
754  * Returns: TRUE if the pad could be connected, FALSE otherwise
755  */
756 gboolean
757 gst_pad_connect (GstPad *srcpad, GstPad *sinkpad)
758 {
759   return gst_pad_connect_filtered (srcpad, sinkpad, NULL);
760 }
761
762 /**
763  * gst_pad_set_parent:
764  * @pad: the pad to set the parent
765  * @parent: the object to set the parent to
766  *
767  * Sets the parent object of a pad.
768  */
769 void
770 gst_pad_set_parent (GstPad *pad,
771                     GstObject *parent)
772 {
773   g_return_if_fail (pad != NULL);
774   g_return_if_fail (GST_IS_PAD (pad));
775   g_return_if_fail (GST_PAD_PARENT (pad) == NULL);
776   g_return_if_fail (parent != NULL);
777   g_return_if_fail (GST_IS_OBJECT (parent));
778   g_return_if_fail ((gpointer)pad != (gpointer)parent);
779
780   gst_object_set_parent (GST_OBJECT (pad), parent);
781 }
782
783 /**
784  * gst_pad_get_parent:
785  * @pad: the pad to get the parent from
786  *
787  * Get the parent object of this pad.
788  *
789  * Returns: the parent object
790  */
791 GstElement*
792 gst_pad_get_parent (GstPad *pad)
793 {
794   g_return_val_if_fail (pad != NULL, NULL);
795   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
796
797   return GST_PAD_PARENT (pad);
798 }
799
800 /**
801  * gst_pad_get_padtemplate:
802  * @pad: the pad to get the padtemplate from
803  *
804  * Get the padtemplate object of this pad.
805  *
806  * Returns: the padtemplate object
807  */
808 GstPadTemplate*
809 gst_pad_get_padtemplate (GstPad *pad)
810 {
811   g_return_val_if_fail (pad != NULL, NULL);
812   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
813
814   return GST_PAD_PADTEMPLATE (pad); 
815 }
816
817
818 /**
819  * gst_pad_set_sched:
820  * @pad: the pad to set the scheduler for
821  * @sched: The scheduler to set
822  *
823  * Set the scheduler for the pad
824  */
825 void
826 gst_pad_set_sched (GstPad *pad, GstScheduler *sched)
827 {
828   g_return_if_fail (pad != NULL);
829   g_return_if_fail (GST_IS_PAD (pad));
830  
831   GST_RPAD_SCHED(pad) = sched;
832 }
833  
834 /**
835  * gst_pad_get_sched:
836  * @pad: the pad to get the scheduler from
837  *
838  * Get the scheduler of the pad
839  *
840  * Returns: the scheduler of the pad.
841  */
842 GstScheduler*
843 gst_pad_get_sched (GstPad *pad)
844 {
845   g_return_val_if_fail (pad != NULL, NULL);
846   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
847  
848   return GST_RPAD_SCHED(pad);
849 }
850
851 /**
852  * gst_pad_unset_sched:
853  * @pad: the pad to unset the scheduler for
854  *
855  * Unset the scheduler for the pad
856  */
857 void
858 gst_pad_unset_sched (GstPad *pad)
859 {
860   g_return_if_fail (pad != NULL);
861   g_return_if_fail (GST_IS_PAD (pad));
862  
863   GST_RPAD_SCHED(pad) = NULL;
864 }
865  
866 /**
867  * gst_pad_get_real_parent:
868  * @pad: the pad to get the parent from
869  *
870  * Get the real parent object of this pad. If the pad
871  * is a ghostpad, the actual owner of the real pad is
872  * returned, as opposed to the gst_pad_get_parent().
873  *
874  * Returns: the parent object
875  */
876 GstElement*
877 gst_pad_get_real_parent (GstPad *pad)
878 {
879   g_return_val_if_fail (pad != NULL, NULL);
880   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
881
882   return GST_PAD_PARENT (GST_PAD (GST_PAD_REALIZE (pad)));
883 }
884
885 /**
886  * gst_pad_add_ghost_pad:
887  * @pad: the pad to set the ghost parent
888  * @ghostpad: the ghost pad to add
889  *
890  * Add a ghost pad to a pad.
891  */
892 void
893 gst_pad_add_ghost_pad (GstPad *pad,
894                        GstPad *ghostpad)
895 {
896   GstRealPad *realpad;
897
898   g_return_if_fail (pad != NULL);
899   g_return_if_fail (GST_IS_PAD (pad));
900   g_return_if_fail (ghostpad != NULL);
901   g_return_if_fail (GST_IS_GHOST_PAD (ghostpad));
902
903   realpad = GST_PAD_REALIZE (pad);
904
905   realpad->ghostpads = g_list_prepend (realpad->ghostpads, ghostpad);
906 }
907
908
909 /**
910  * gst_pad_remove_ghost_pad:
911  * @pad: the pad to remove the ghost parent
912  * @ghostpad: the ghost pad to remove from the pad
913  *
914  * Remove a ghost pad from a pad.
915  */
916 void
917 gst_pad_remove_ghost_pad (GstPad *pad,
918                           GstPad *ghostpad)
919 {
920   GstRealPad *realpad;
921
922   g_return_if_fail (pad != NULL);
923   g_return_if_fail (GST_IS_PAD (pad));
924   g_return_if_fail (ghostpad != NULL);
925   g_return_if_fail (GST_IS_GHOST_PAD (ghostpad));
926
927   realpad = GST_PAD_REALIZE (pad);
928
929   realpad->ghostpads = g_list_remove (realpad->ghostpads, ghostpad);
930 }
931
932 /**
933  * gst_pad_get_ghost_pad_list:
934  * @pad: the pad to get the ghost parents from
935  *
936  * Get the ghost parents of this pad.
937  *
938  * Returns: a GList of ghost pads
939  */
940 GList*
941 gst_pad_get_ghost_pad_list (GstPad *pad)
942 {
943   g_return_val_if_fail (pad != NULL, NULL);
944   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
945
946   return GST_PAD_REALIZE(pad)->ghostpads;
947 }
948
949 /* an internal caps negotiation helper function does:
950  * 
951  * 1. optinally calls the pad connect function with the provided caps
952  * 2. deal with the result code of the connect function
953  * 3. set fixed caps on the pad.
954  */
955 static GstPadConnectReturn
956 gst_pad_try_set_caps_func (GstRealPad *pad, GstCaps *caps, gboolean notify)
957 {
958   GstCaps *oldcaps;
959   GstElement *parent = GST_PAD_PARENT (pad);
960
961   /* if this pad has a parent and the parent is not READY, delay the
962    * negotiation */
963   if (parent && GST_STATE (parent) < GST_STATE_READY)
964     return GST_PAD_CONNECT_DELAYED;
965           
966   GST_INFO (GST_CAT_CAPS, "trying to set caps %p on pad %s:%s",
967             caps, GST_DEBUG_PAD_NAME (pad));
968
969   /* we need to notify the connect function */
970   if (notify && GST_RPAD_CONNECTFUNC (pad)) {
971     GstPadConnectReturn res;
972     gchar *debug_string;
973
974     GST_INFO (GST_CAT_CAPS, "calling connect function on pad %s:%s",
975             GST_DEBUG_PAD_NAME (pad));
976
977     /* call the connect function */
978     res = GST_RPAD_CONNECTFUNC (pad) (GST_PAD (pad), caps);
979
980     switch (res) {
981       case GST_PAD_CONNECT_REFUSED:
982         debug_string = "REFUSED";
983         break;
984       case GST_PAD_CONNECT_OK:
985         debug_string = "OK";
986         break;
987       case GST_PAD_CONNECT_DONE:
988         debug_string = "DONE";
989         break;
990       case GST_PAD_CONNECT_DELAYED:
991         debug_string = "DELAYED";
992         break;
993       default:
994         g_warning ("unknown return code from connect function of pad %s:%s",
995             GST_DEBUG_PAD_NAME (pad));
996         return GST_PAD_CONNECT_REFUSED;
997     }
998
999     GST_INFO (GST_CAT_CAPS, "got reply %s (%d) from connect function on pad %s:%s",
1000             debug_string, res, GST_DEBUG_PAD_NAME (pad));
1001
1002     /* done means the connect function called another caps negotiate function
1003      * on this pad that succeeded, we dont need to continue */
1004     if (res == GST_PAD_CONNECT_DONE) {
1005       GST_INFO (GST_CAT_CAPS, "pad %s:%s is done", GST_DEBUG_PAD_NAME (pad));
1006       return GST_PAD_CONNECT_DONE;
1007     }
1008     if (res == GST_PAD_CONNECT_REFUSED) {
1009       GST_INFO (GST_CAT_CAPS, "pad %s:%s doesn't accept caps",
1010                     GST_DEBUG_PAD_NAME (pad));
1011       return GST_PAD_CONNECT_REFUSED;
1012     }
1013   }
1014   /* we can only set caps on the pad if they are ficed */
1015   if (GST_CAPS_IS_FIXED (caps)) {
1016
1017     GST_INFO (GST_CAT_CAPS, "setting caps on pad %s:%s",
1018               GST_DEBUG_PAD_NAME (pad));
1019     /* if we got this far all is ok, remove the old caps, set the new one */
1020     oldcaps = GST_PAD_CAPS (pad);
1021     if (caps) gst_caps_ref (caps);
1022     GST_PAD_CAPS (pad) = caps;
1023     if (oldcaps) gst_caps_unref (oldcaps);
1024   }
1025   else {
1026     GST_INFO (GST_CAT_CAPS, "caps are not fixed on pad %s:%s, not setting them yet",
1027               GST_DEBUG_PAD_NAME (pad));
1028   }
1029
1030   return GST_PAD_CONNECT_OK;
1031 }
1032
1033 /**
1034  * gst_pad_try_set_caps:
1035  * @pad: the pad to try to set the caps on
1036  * @caps: the caps to set
1037  *
1038  * Try to set the caps on the given pad.
1039  *
1040  * Returns: TRUE if the caps could be set
1041  */
1042 gboolean
1043 gst_pad_try_set_caps (GstPad *pad, GstCaps *caps)
1044 {
1045   GstCaps *oldcaps;
1046   GstRealPad *peer, *realpad;
1047
1048   realpad = GST_PAD_REALIZE (pad);
1049   peer = GST_RPAD_PEER (realpad);
1050
1051   GST_INFO (GST_CAT_CAPS, "trying to set caps %p on pad %s:%s",
1052             caps, GST_DEBUG_PAD_NAME (realpad));
1053
1054   /* setting non fixed caps on a pad is not allowed */
1055   if (!GST_CAPS_IS_FIXED (caps)) {
1056     g_warning ("trying to set non fixed caps on pad %s:%s",
1057             GST_DEBUG_PAD_NAME (realpad));
1058     gst_caps_debug (caps);
1059     return FALSE;
1060   }
1061   /* if we have a peer try to set the caps, notifying the peerpad
1062    * if it has a connect function */
1063   if (peer && !gst_pad_try_set_caps_func (peer, caps, TRUE))
1064     return FALSE;
1065   /* then try to set our own caps, we don't need to be notified */
1066   if (!gst_pad_try_set_caps_func (realpad, caps, FALSE))
1067     return FALSE;
1068           
1069   return TRUE;
1070 }
1071
1072 /* this is a caps negotiation convenience routine, it performs:
1073  *
1074  * 1. optionally clear any pad caps
1075  * 2. calculate the intersection between the two pad tamplate/getcaps caps
1076  * 3. calculate the intersection with the (optional) filtercaps.
1077  * 4. store the intersection in the pad filter
1078  * 5. store the app filtercaps in the pad appfilter.
1079  * 6. start the caps negotiation.
1080  */
1081 static gboolean
1082 gst_pad_try_reconnect_filtered_func (GstRealPad *srcpad, GstRealPad *sinkpad, GstCaps *filtercaps, gboolean clear)
1083 {
1084   GstCaps *srccaps, *sinkcaps;
1085   GstCaps *intersection = NULL;
1086   GstRealPad *realsrc, *realsink;
1087
1088   realsrc = GST_PAD_REALIZE (srcpad);
1089   realsink = GST_PAD_REALIZE (sinkpad);
1090
1091   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1092   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1093
1094   /* optinally clear the caps */
1095   if (clear) {
1096     GST_INFO (GST_CAT_PADS, "reconnect filtered %s:%s and %s:%s, clearing caps",
1097         GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1098
1099     GST_PAD_CAPS (GST_PAD (realsrc)) = NULL;
1100     GST_PAD_CAPS (GST_PAD (realsink)) = NULL;
1101   }
1102   else {
1103     GST_INFO (GST_CAT_PADS, "reconnect filtered %s:%s and %s:%s",
1104         GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1105   }
1106
1107   srccaps = gst_pad_get_caps (GST_PAD (realsrc));
1108   GST_INFO (GST_CAT_PADS, "dumping caps of pad %s:%s", GST_DEBUG_PAD_NAME (realsrc));
1109   gst_caps_debug (srccaps);
1110   sinkcaps = gst_pad_get_caps (GST_PAD (realsink));
1111   GST_INFO (GST_CAT_PADS, "dumping caps of pad %s:%s", GST_DEBUG_PAD_NAME (realsink));
1112   gst_caps_debug (sinkcaps);
1113
1114   /* first take the intersection of the pad caps */
1115   intersection = gst_caps_intersect (srccaps, sinkcaps);
1116
1117   /* if we have no intersection but one of the caps was not NULL.. */
1118   if (!intersection && (srccaps || sinkcaps )) {
1119     /* the intersection is NULL but the pad caps were not both NULL,
1120      * this means they have no common format */
1121     GST_INFO (GST_CAT_PADS, "pads %s:%s and %s:%s have no common type",
1122          GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1123     return FALSE;
1124   }
1125   else {
1126     GST_INFO (GST_CAT_PADS, "pads %s:%s and %s:%s intersected to %s caps",
1127          GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink), 
1128          ((intersection && GST_CAPS_IS_FIXED (intersection)) ? "fixed" : "variable"));
1129
1130     /* then filter this against the app filter */
1131     if (filtercaps) {
1132       GstCaps *filtered_intersection = gst_caps_intersect (intersection, filtercaps);
1133
1134       /* get rid of the old intersection here */
1135       gst_caps_unref (intersection);
1136
1137       if (!filtered_intersection) {
1138         GST_INFO (GST_CAT_PADS, "filtered connection between pads %s:%s and %s:%s is empty",
1139              GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1140         return FALSE;
1141       }
1142       intersection = filtered_intersection;
1143
1144       /* keep a reference to the app caps */
1145       GST_RPAD_APPFILTER (realsink) = filtercaps;
1146       GST_RPAD_APPFILTER (realsrc) = filtercaps;
1147     }
1148   }
1149   GST_DEBUG (GST_CAT_CAPS, "setting filter for connection to:\n");
1150   gst_caps_debug (intersection);
1151
1152   GST_RPAD_FILTER (realsrc) = intersection; 
1153   GST_RPAD_FILTER (realsink) = intersection; 
1154
1155   return gst_pad_perform_negotiate (GST_PAD (realsrc), GST_PAD (realsink));
1156 }
1157
1158 /**
1159  * gst_pad_perform_negotiate:
1160  * @srcpad: a srcpad
1161  * @sinkpad: a sinkpad 
1162  *
1163  * Try to negotiate the pads.
1164  *
1165  * Returns: a boolean indicating the pad succesfully negotiated.
1166  */
1167 gboolean
1168 gst_pad_perform_negotiate (GstPad *srcpad, GstPad *sinkpad) 
1169 {
1170   GstCaps *intersection;
1171   GstRealPad *realsrc, *realsink;
1172
1173   g_return_val_if_fail (srcpad != NULL, FALSE);
1174   g_return_val_if_fail (sinkpad != NULL, FALSE);
1175   
1176   realsrc = GST_PAD_REALIZE (srcpad);
1177   realsink = GST_PAD_REALIZE (sinkpad);
1178     
1179   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1180   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1181
1182   /* it doesn't matter which filter we take */
1183   intersection = GST_RPAD_FILTER (realsrc);
1184
1185   /* no negotiation is performed it the pads have filtercaps */
1186   if (intersection) {
1187     GstPadConnectReturn res;
1188
1189     res = gst_pad_try_set_caps_func (realsrc, intersection, TRUE);
1190     if (res == GST_PAD_CONNECT_REFUSED) 
1191       return FALSE;
1192     if (res == GST_PAD_CONNECT_DONE) 
1193       return TRUE;
1194
1195     res = gst_pad_try_set_caps_func (realsink, intersection, TRUE);
1196     if (res == GST_PAD_CONNECT_REFUSED) 
1197       return FALSE;
1198     if (res == GST_PAD_CONNECT_DONE) 
1199       return TRUE;
1200   }
1201   return TRUE;
1202 }
1203
1204 /**
1205  * gst_pad_try_reconnect_filtered:
1206  * @pad: the pad to reconnect
1207  * @caps: the capabilities to use in the reconnectiong
1208  *
1209  * Try to reconnect this pad and its peer with the specified caps
1210  *
1211  * Returns: a boolean indicating the peer pad could accept the caps.
1212  */
1213 gboolean
1214 gst_pad_try_reconnect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps)
1215 {
1216   GstRealPad *realsrc, *realsink;
1217
1218   g_return_val_if_fail (srcpad != NULL, FALSE);
1219   g_return_val_if_fail (sinkpad != NULL, FALSE);
1220
1221   realsrc = GST_PAD_REALIZE (srcpad);
1222   realsink = GST_PAD_REALIZE (sinkpad);
1223
1224   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1225   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1226   
1227   return gst_pad_try_reconnect_filtered_func (realsrc, realsink, filtercaps, TRUE);
1228 }
1229
1230 /**
1231  * gst_pad_reconnect_filtered:
1232  * @pad: the pad to reconnect
1233  * @caps: the capabilities to use in the reconnectiong
1234  *
1235  * Try to reconnect this pad and its peer with the specified caps. 
1236  *
1237  * Returns: a boolean indicating the peer pad could accept the caps.
1238  *    if FALSE is returned, the pads are disconnected.
1239  */
1240 gboolean
1241 gst_pad_reconnect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps)
1242 {
1243   GstRealPad *realsrc, *realsink;
1244
1245   g_return_val_if_fail (srcpad != NULL, FALSE);
1246   g_return_val_if_fail (sinkpad != NULL, FALSE);
1247
1248   realsrc = GST_PAD_REALIZE (srcpad);
1249   realsink = GST_PAD_REALIZE (sinkpad);
1250
1251   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1252   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1253   
1254   if (!gst_pad_try_reconnect_filtered_func (realsrc, realsink, filtercaps, TRUE)) {
1255     gst_pad_disconnect (srcpad, GST_PAD (GST_PAD_PEER (srcpad)));
1256     return FALSE;
1257   }
1258   return TRUE;
1259 }
1260
1261 /**
1262  * gst_pad_proxy_connect:
1263  * @pad: the pad to proxy to
1264  * @caps: the capabilities to use in the proxying
1265  *
1266  * Proxy the connect function to the specified pad.
1267  *
1268  * Returns: a boolean indicating the peer pad could accept the caps.
1269  */
1270 GstPadConnectReturn
1271 gst_pad_proxy_connect (GstPad *pad, GstCaps *caps)
1272 {
1273   GstRealPad *peer, *realpad;
1274
1275   realpad = GST_PAD_REALIZE (pad);
1276
1277   peer = GST_RPAD_PEER (realpad);
1278
1279   GST_INFO (GST_CAT_CAPS, "proxy connect to pad %s:%s",
1280             GST_DEBUG_PAD_NAME (realpad));
1281
1282   if (peer && !gst_pad_try_set_caps_func (peer, caps, TRUE))
1283     return GST_PAD_CONNECT_REFUSED;
1284   if (!gst_pad_try_set_caps_func (realpad, caps, FALSE))
1285     return GST_PAD_CONNECT_REFUSED;
1286
1287   return GST_PAD_CONNECT_OK;
1288 }
1289
1290 /**
1291  * gst_pad_get_caps:
1292  * @pad: the pad to get the capabilities from
1293  *
1294  * Get the capabilities of this pad.
1295  *
1296  * Returns: the capabilities of this pad
1297  */
1298 GstCaps*
1299 gst_pad_get_caps (GstPad *pad)
1300 {
1301   GstRealPad *realpad;
1302
1303   g_return_val_if_fail (pad != NULL, NULL);
1304   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1305
1306   realpad = GST_PAD_REALIZE (pad);
1307
1308   GST_DEBUG (GST_CAT_CAPS, "get pad caps of %s:%s (%p)\n",
1309             GST_DEBUG_PAD_NAME (realpad), realpad);
1310
1311   if (GST_PAD_CAPS (realpad)) {
1312     GST_DEBUG (GST_CAT_CAPS, "using pad real caps\n");
1313     return GST_PAD_CAPS (realpad);
1314   }
1315   else if GST_RPAD_GETCAPSFUNC (realpad) {
1316     GST_DEBUG (GST_CAT_CAPS, "using pad get function\n");
1317     return GST_RPAD_GETCAPSFUNC (realpad) (GST_PAD_CAST (realpad), NULL);
1318   }
1319   else if (GST_PAD_PADTEMPLATE (realpad)) {
1320     GST_DEBUG (GST_CAT_CAPS, "using pad template\n");
1321     return GST_PADTEMPLATE_CAPS (GST_PAD_PADTEMPLATE (realpad));
1322   }
1323   GST_DEBUG (GST_CAT_CAPS, "pad has no caps\n");
1324
1325   return NULL;
1326 }
1327
1328 /**
1329  * gst_pad_get_padtemplate_caps:
1330  * @pad: the pad to get the capabilities from
1331  *
1332  * Get the capabilities of this pad.
1333  *
1334  * Returns: a list of the capabilities of this pad
1335  */
1336 GstCaps*
1337 gst_pad_get_padtemplate_caps (GstPad *pad)
1338 {
1339   g_return_val_if_fail (pad != NULL, NULL);
1340   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1341
1342   if (GST_PAD_PADTEMPLATE (pad))
1343     return GST_PADTEMPLATE_CAPS (GST_PAD_PADTEMPLATE (pad));
1344
1345   return NULL;
1346 }
1347
1348
1349 /**
1350  * gst_padtemplate_get_caps_by_name:
1351  * @templ: the padtemplate to get the capabilities from
1352  * @name: the name of the capability to get
1353  *
1354  * Get the capability with the given name from this padtemplate.
1355  *
1356  * Returns: a capability or NULL if not found
1357  */
1358 GstCaps*
1359 gst_padtemplate_get_caps_by_name (GstPadTemplate *templ, const gchar *name)
1360 {
1361   GstCaps *caps;
1362
1363   g_return_val_if_fail (templ != NULL, NULL);
1364
1365   caps = GST_PADTEMPLATE_CAPS (templ);
1366   if (!caps) 
1367     return NULL;
1368
1369   return gst_caps_get_by_name (caps, name);
1370 }
1371
1372 /**
1373  * gst_pad_check_compatibility:
1374  * @srcpad: the srcpad to check
1375  * @sinkpad: the sinkpad to check against
1376  *
1377  * Check if two pads have compatible capabilities.
1378  *
1379  * Returns: TRUE if they are compatible or the capabilities
1380  * could not be checked
1381  */
1382 gboolean
1383 gst_pad_check_compatibility (GstPad *srcpad, GstPad *sinkpad)
1384 {
1385   g_return_val_if_fail (srcpad != NULL, FALSE);
1386   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1387   g_return_val_if_fail (sinkpad != NULL, FALSE);
1388   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1389
1390   if (GST_PAD_CAPS (srcpad) && GST_PAD_CAPS (sinkpad)) {
1391     if (!gst_caps_check_compatibility (GST_PAD_CAPS (srcpad), GST_PAD_CAPS (sinkpad))) {
1392       return FALSE;
1393     }
1394     else {
1395       return TRUE;
1396     }
1397   }
1398   else {
1399     GST_DEBUG (GST_CAT_PADS, "could not check capabilities of pads (%s:%s) and (%s:%s) %p %p\n",
1400                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad), 
1401                     GST_PAD_CAPS (srcpad), GST_PAD_CAPS (sinkpad));
1402     return TRUE;
1403   }
1404 }
1405
1406 /**
1407  * gst_pad_get_peer:
1408  * @pad: the pad to get the peer from
1409  *
1410  * Get the peer pad of this pad.
1411  *
1412  * Returns: the peer pad
1413  */
1414 GstPad*
1415 gst_pad_get_peer (GstPad *pad)
1416 {
1417   g_return_val_if_fail (pad != NULL, NULL);
1418   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1419
1420   return GST_PAD (GST_PAD_PEER (pad));
1421 }
1422
1423 /**
1424  * gst_pad_get_allowed_caps:
1425  * @pad: the pad to get the allowed caps from
1426  *
1427  * Gst the caps of the allowed media types that can
1428  * go through this pad.
1429  *
1430  * Returns: the allowed caps
1431  */
1432 GstCaps*
1433 gst_pad_get_allowed_caps (GstPad *pad)
1434 {
1435   g_return_val_if_fail (pad != NULL, NULL);
1436   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1437
1438   GST_DEBUG (GST_CAT_PROPERTIES, "get allowed caps of %s:%s\n", GST_DEBUG_PAD_NAME (pad));
1439
1440   return gst_caps_copy (GST_RPAD_FILTER (pad));
1441 }
1442
1443 /**
1444  * gst_pad_get_allowed_caps:
1445  * @pad: the pad to get the allowed caps from
1446  *
1447  * Gst the caps of the allowed media types that can
1448  * go through this pad.
1449  *
1450  * Returns: the allowed caps
1451  */
1452 gboolean
1453 gst_pad_recalc_allowed_caps (GstPad *pad)
1454 {
1455   GstRealPad *peer;
1456
1457   g_return_if_fail (pad != NULL);
1458   g_return_if_fail (GST_IS_PAD (pad));
1459
1460   GST_DEBUG (GST_CAT_PROPERTIES, "set allowed caps of %s:%s\n", GST_DEBUG_PAD_NAME (pad));
1461
1462   peer = GST_RPAD_PEER (pad);
1463   if (peer)
1464     gst_pad_try_reconnect_filtered (pad, GST_PAD (peer), GST_RPAD_APPFILTER (pad));
1465 }
1466
1467 /**
1468  * gst_pad_get_bufferpool:
1469  * @pad: the pad to get the bufferpool from
1470  *
1471  * Get the bufferpool of the peer pad of the given
1472  * pad
1473  *
1474  * Returns: The GstBufferPool or NULL.
1475  */
1476 GstBufferPool*          
1477 gst_pad_get_bufferpool (GstPad *pad)
1478 {
1479   GstRealPad *peer;
1480
1481   g_return_val_if_fail (pad != NULL, NULL);
1482   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1483    
1484   peer = GST_RPAD_PEER (pad);
1485
1486   if (!peer)
1487     return NULL;
1488
1489   GST_DEBUG_ENTER ("(%s:%s)", GST_DEBUG_PAD_NAME (pad));
1490
1491   if (peer->bufferpoolfunc) {
1492     GST_DEBUG (GST_CAT_PADS, "calling bufferpoolfunc &%s (@%p) of peer pad %s:%s\n",
1493       GST_DEBUG_FUNCPTR_NAME (peer->bufferpoolfunc), &peer->bufferpoolfunc, GST_DEBUG_PAD_NAME (((GstPad*) peer)));
1494     return (peer->bufferpoolfunc) (((GstPad*) peer));
1495   } else {
1496     GST_DEBUG (GST_CAT_PADS, "no bufferpoolfunc for peer pad %s:%s at %p\n",
1497                     GST_DEBUG_PAD_NAME (((GstPad*) peer)), &peer->bufferpoolfunc);
1498     return NULL;
1499   }
1500 }
1501
1502 static void
1503 gst_real_pad_dispose (GObject *object)
1504 {
1505   GstPad *pad = GST_PAD (object);
1506   
1507   /* No connected pad can ever be disposed.
1508    * It has to have a parent to be connected and a parent would hold a reference */
1509   g_assert (GST_PAD_PEER (pad) == NULL);
1510
1511   GST_DEBUG (GST_CAT_REFCOUNTING, "dispose %s:%s\n", GST_DEBUG_PAD_NAME(pad));
1512
1513   if (GST_PAD_PADTEMPLATE (pad)){
1514     GST_DEBUG (GST_CAT_REFCOUNTING, "unreffing padtemplate'%s'\n", GST_OBJECT_NAME (GST_PAD_PADTEMPLATE (pad)));
1515     gst_object_unref (GST_OBJECT (GST_PAD_PADTEMPLATE (pad)));
1516     GST_PAD_PADTEMPLATE (pad) = NULL;
1517   }
1518   
1519   /* we destroy the ghostpads, because they are nothing without the real pad  */
1520   if (GST_REAL_PAD (pad)->ghostpads) {
1521     GList *orig, *ghostpads;
1522
1523     orig = ghostpads = g_list_copy (GST_REAL_PAD (pad)->ghostpads);
1524
1525     while (ghostpads) {
1526       GstPad *ghostpad = GST_PAD (ghostpads->data);
1527
1528       if (GST_IS_ELEMENT (GST_OBJECT_PARENT (ghostpad))){
1529         GST_DEBUG (GST_CAT_REFCOUNTING, "removing ghost pad from element '%s'\n", 
1530                         GST_OBJECT_NAME (GST_OBJECT_PARENT (ghostpad)));
1531
1532         gst_element_remove_ghost_pad (GST_ELEMENT (GST_OBJECT_PARENT (ghostpad)), GST_PAD (ghostpad));
1533       }
1534       ghostpads = g_list_next (ghostpads);
1535     }
1536     g_list_free (orig);
1537     g_list_free (GST_REAL_PAD(pad)->ghostpads);
1538   }
1539
1540   if (GST_IS_ELEMENT (GST_OBJECT_PARENT (pad))){
1541     GST_DEBUG (GST_CAT_REFCOUNTING, "removing pad from element '%s'\n",
1542                     GST_OBJECT_NAME (GST_OBJECT (GST_ELEMENT (GST_OBJECT_PARENT (pad)))));
1543     
1544     gst_element_remove_pad (GST_ELEMENT (GST_OBJECT_PARENT (pad)), pad);
1545   }
1546   
1547   G_OBJECT_CLASS (real_pad_parent_class)->dispose (object);
1548 }
1549
1550
1551 #ifndef GST_DISABLE_LOADSAVE
1552 /**
1553  * gst_pad_load_and_connect:
1554  * @self: the XML node to read the description from
1555  * @parent: the element that has the pad
1556  *
1557  * Read the pad definition from the XML node and connect the given pad
1558  * in element to a pad of an element up in the hierarchy.
1559  */
1560 void
1561 gst_pad_load_and_connect (xmlNodePtr self,
1562                           GstObject *parent)
1563 {
1564   xmlNodePtr field = self->xmlChildrenNode;
1565   GstPad *pad = NULL, *targetpad;
1566   guchar *peer = NULL;
1567   gchar **split;
1568   GstElement *target;
1569   GstObject *grandparent;
1570
1571   while (field) {
1572     if (!strcmp (field->name, "name")) {
1573       pad = gst_element_get_pad (GST_ELEMENT (parent), xmlNodeGetContent (field));
1574     }
1575     else if (!strcmp(field->name, "peer")) {
1576       peer = xmlNodeGetContent (field);
1577     }
1578     field = field->next;
1579   }
1580   g_return_if_fail (pad != NULL);
1581
1582   if (peer == NULL) return;
1583
1584   split = g_strsplit (peer, ".", 2);
1585
1586   g_return_if_fail (split[0] != NULL);
1587   g_return_if_fail (split[1] != NULL);
1588
1589   grandparent = gst_object_get_parent (parent);
1590
1591   if (grandparent && GST_IS_BIN (grandparent)) {
1592     target = gst_bin_get_by_name_recurse_up (GST_BIN (grandparent), split[0]);
1593   }
1594   else
1595     goto cleanup;
1596
1597   if (target == NULL) goto cleanup;
1598
1599   targetpad = gst_element_get_pad (target, split[1]);
1600
1601   if (targetpad == NULL) goto cleanup;
1602
1603   gst_pad_connect (pad, targetpad);
1604
1605 cleanup:
1606   g_strfreev (split);
1607 }
1608
1609 /**
1610  * gst_pad_save_thyself:
1611  * @pad: the pad to save
1612  * @parent: the parent XML node to save the description in
1613  *
1614  * Saves the pad into an xml representation
1615  *
1616  * Returns: the xml representation of the pad
1617  */
1618 static xmlNodePtr
1619 gst_pad_save_thyself (GstObject *object,
1620                       xmlNodePtr parent)
1621 {
1622   GstRealPad *realpad;
1623   GstPad *peer;
1624
1625   g_return_val_if_fail (GST_IS_REAL_PAD (object), NULL);
1626
1627   realpad = GST_REAL_PAD(object);
1628
1629   xmlNewChild(parent,NULL,"name", GST_PAD_NAME (realpad));
1630   if (GST_RPAD_PEER(realpad) != NULL) {
1631     peer = GST_PAD(GST_RPAD_PEER(realpad));
1632     /* first check to see if the peer's parent's parent is the same */
1633     /* we just save it off */
1634     xmlNewChild(parent,NULL,"peer",g_strdup_printf("%s.%s",
1635                     GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer)));
1636   } else
1637     xmlNewChild(parent,NULL,"peer","");
1638
1639   return parent;
1640 }
1641
1642 /**
1643  * gst_pad_ghost_save_thyself:
1644  * @pad: the pad to save
1645  * @bin: the bin
1646  * @parent: the parent XML node to save the description in
1647  *
1648  * Saves the ghost pad into an xml representation.
1649  *
1650  * Returns: the xml representation of the pad
1651  */
1652 xmlNodePtr
1653 gst_pad_ghost_save_thyself (GstPad *pad,
1654                             GstElement *bin,
1655                             xmlNodePtr parent)
1656 {
1657   xmlNodePtr self;
1658
1659   g_return_val_if_fail (GST_IS_GHOST_PAD (pad), NULL);
1660
1661   self = xmlNewChild (parent, NULL, "ghostpad", NULL);
1662   xmlNewChild (self, NULL, "name", GST_PAD_NAME (pad));
1663   xmlNewChild (self, NULL, "parent", GST_OBJECT_NAME (GST_PAD_PARENT (pad)));
1664
1665   /* FIXME FIXME FIXME! */
1666
1667   return self;
1668 }
1669 #endif /* GST_DISABLE_LOADSAVE */
1670
1671 #ifndef gst_pad_push
1672 /**
1673  * gst_pad_push:
1674  * @pad: the pad to push
1675  * @buf: the buffer to push
1676  *
1677  * Push a buffer to the peer of the pad.
1678  */
1679 void 
1680 gst_pad_push (GstPad *pad, GstBuffer *buf) 
1681 {
1682   GstRealPad *peer = GST_RPAD_PEER (pad);
1683
1684   GST_DEBUG_ENTER ("(%s:%s)", GST_DEBUG_PAD_NAME (pad));
1685
1686   g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC);
1687
1688   if (!peer) {
1689     g_warning ("push on pad %s:%s but it is unconnected", GST_DEBUG_PAD_NAME (pad));
1690   }
1691   else {
1692     if (peer->chainhandler) {
1693       if (buf) {
1694         GST_DEBUG (GST_CAT_DATAFLOW, "calling chainhandler &%s of peer pad %s:%s\n",
1695             GST_DEBUG_FUNCPTR_NAME (peer->chainhandler), GST_DEBUG_PAD_NAME (GST_PAD (peer)));
1696         (peer->chainhandler) (GST_PAD_CAST (peer), buf);
1697         return;
1698       }
1699       else {
1700         g_warning ("trying to push a NULL buffer on pad %s:%s", GST_DEBUG_PAD_NAME (peer));
1701         return;
1702       }
1703     } 
1704     else {
1705       g_warning ("(internal error) push on pad %s:%s but it has no chainhandler", GST_DEBUG_PAD_NAME (peer));
1706     }
1707   }
1708   /* clean up the mess here */
1709   if (buf != NULL) {
1710     if (GST_IS_BUFFER (buf))
1711       gst_buffer_unref (buf);
1712     else
1713       gst_event_free (GST_EVENT (buf));
1714   }
1715 }
1716 #endif
1717
1718 #ifndef gst_pad_pull
1719 /**
1720  * gst_pad_pull:
1721  * @pad: the pad to pull
1722  *
1723  * Pull a buffer from the peer pad.
1724  *
1725  * Returns: a new buffer from the peer pad.
1726  */
1727 GstBuffer*
1728 gst_pad_pull (GstPad *pad) 
1729 {
1730   GstRealPad *peer = GST_RPAD_PEER(pad);
1731   
1732   GST_DEBUG_ENTER("(%s:%s)",GST_DEBUG_PAD_NAME(pad));
1733
1734   g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK, NULL);
1735
1736   if (!peer) {
1737     gst_element_error (GST_PAD_PARENT (pad), 
1738                     "pull on pad %s:%s but it was unconnected", 
1739                     GST_ELEMENT_NAME (GST_PAD_PARENT (pad)), GST_PAD_NAME (pad),
1740                     NULL);
1741   }
1742   else {
1743     if (peer->gethandler) {
1744       GstBuffer *buf;
1745
1746       GST_DEBUG (GST_CAT_DATAFLOW, "calling gethandler %s of peer pad %s:%s\n",
1747         GST_DEBUG_FUNCPTR_NAME (peer->gethandler), GST_DEBUG_PAD_NAME (peer));
1748
1749       buf = (peer->gethandler) (GST_PAD_CAST (peer));
1750       if (buf)
1751         return buf;
1752       /* no null buffers allowed */
1753       gst_element_error (GST_PAD_PARENT (pad), 
1754                     "NULL buffer during pull on %s:%s", GST_DEBUG_PAD_NAME (pad), NULL);
1755           
1756     } else {
1757       gst_element_error (GST_PAD_PARENT (pad), 
1758                     "(internal error) pull on pad %s:%s but the peer pad %s:%s has no gethandler", 
1759                     GST_DEBUG_PAD_NAME (pad), GST_DEBUG_PAD_NAME (peer),
1760                     NULL);
1761     }
1762   }
1763   return NULL;
1764 }
1765 #endif
1766
1767 #ifndef gst_pad_pullregion
1768 /**
1769  * gst_pad_pullregion:
1770  * @pad: the pad to pull the region from
1771  * @type: the regiontype
1772  * @offset: the offset/start of the buffer to pull
1773  * @len: the length of the buffer to pull
1774  *
1775  * Pull a buffer region from the peer pad. The region to pull can be 
1776  * specified with a offset/lenght pair or with a start/legnth time
1777  * indicator as specified by the type parameter.
1778  *
1779  * Returns: a new buffer from the peer pad with data in the specified
1780  * region.
1781  */
1782 GstBuffer*
1783 gst_pad_pullregion (GstPad *pad, GstRegionType type, guint64 offset, guint64 len) 
1784 {
1785   GstRealPad *peer;
1786   GstBuffer *result = NULL;
1787   
1788   g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK, NULL);
1789
1790   do {
1791     peer = GST_RPAD_PEER(pad);
1792     g_return_val_if_fail (peer != NULL, NULL);
1793
1794     if (result) 
1795       gst_buffer_unref (result);
1796
1797     GST_DEBUG_ENTER("(%s:%s,%d,%lld,%lld)",GST_DEBUG_PAD_NAME(pad),type,offset,len);
1798
1799     if (peer->pullregionfunc) {
1800       GST_DEBUG (GST_CAT_DATAFLOW, "calling pullregionfunc &%s of peer pad %s:%s\n",
1801           GST_DEBUG_FUNCPTR_NAME (peer->pullregionfunc), GST_DEBUG_PAD_NAME(GST_PAD_CAST (peer)));
1802       result = (peer->pullregionfunc) (GST_PAD_CAST (peer), type, offset, len);
1803     } else {
1804       GST_DEBUG (GST_CAT_DATAFLOW,"no pullregionfunc\n");
1805       result = NULL;
1806       break;
1807     }
1808   }
1809   /* FIXME */
1810   while (result && !(GST_BUFFER_OFFSET (result) == offset && 
1811            GST_BUFFER_SIZE (result) == len));
1812
1813   return result;
1814 }
1815 #endif
1816
1817 /**
1818  * gst_pad_peek:
1819  * @pad: the pad to peek
1820  *
1821  * Peek for a buffer from the peer pad.
1822  *
1823  * Returns: a from the peer pad or NULL if the peer has no buffer.
1824  */
1825 GstBuffer*
1826 gst_pad_peek (GstPad *pad)
1827 {
1828   g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK, NULL);
1829
1830   return GST_RPAD_BUFPEN (GST_RPAD_PEER (pad));
1831 }
1832
1833 /**
1834  * gst_pad_select:
1835  * @padlist: A list of pads 
1836  *
1837  * Wait for a buffer on the list of pads.
1838  *
1839  * Returns: The pad that has a buffer available, use 
1840  * #gst_pad_pull to get the buffer.
1841  */
1842 GstPad*
1843 gst_pad_select (GList *padlist)
1844 {
1845   GstPad *pad;
1846
1847   pad = gst_scheduler_pad_select (GST_PAD_PARENT (padlist->data)->sched, padlist);
1848
1849   return pad;
1850 }
1851
1852 /**
1853  * gst_pad_selectv:
1854  * @pad: The first pad to perform the select on 
1855  * @...: More pads
1856  *
1857  * Wait for a buffer on the given of pads.
1858  *
1859  * Returns: The pad that has a buffer available, use 
1860  * #gst_pad_pull to get the buffer.
1861  */
1862 GstPad*
1863 gst_pad_selectv (GstPad *pad, ...)
1864 {
1865   GstPad *result;
1866   GList *padlist = NULL;
1867   va_list var_args;
1868
1869   if (pad == NULL)
1870     return NULL;
1871
1872   va_start (var_args, pad);
1873
1874   while (pad) {
1875     padlist = g_list_prepend (padlist, pad);
1876     pad = va_arg (var_args, GstPad *);
1877   }
1878   result = gst_pad_select (padlist);
1879   g_list_free (padlist);
1880
1881   va_end (var_args);
1882   
1883   return result;
1884 }
1885
1886 /************************************************************************
1887  *
1888  * templates
1889  *
1890  */
1891 static void             gst_padtemplate_class_init      (GstPadTemplateClass *klass);
1892 static void             gst_padtemplate_init            (GstPadTemplate *templ);
1893
1894 enum {
1895   TEMPL_PAD_CREATED,
1896   /* FILL ME */
1897   TEMPL_LAST_SIGNAL
1898 };
1899
1900 static GstObject *padtemplate_parent_class = NULL;
1901 static guint gst_padtemplate_signals[TEMPL_LAST_SIGNAL] = { 0 };
1902
1903 GType
1904 gst_padtemplate_get_type (void)
1905 {
1906   static GType padtemplate_type = 0;
1907
1908   if (!padtemplate_type) {
1909     static const GTypeInfo padtemplate_info = {
1910       sizeof(GstPadTemplateClass),
1911       NULL,
1912       NULL,
1913       (GClassInitFunc)gst_padtemplate_class_init,
1914       NULL,
1915       NULL,
1916       sizeof(GstPadTemplate),
1917       32,
1918       (GInstanceInitFunc)gst_padtemplate_init,
1919       NULL
1920     };
1921     padtemplate_type = g_type_register_static(GST_TYPE_OBJECT, "GstPadTemplate", &padtemplate_info, 0);
1922   }
1923   return padtemplate_type;
1924 }
1925
1926 static void
1927 gst_padtemplate_class_init (GstPadTemplateClass *klass)
1928 {
1929   GObjectClass *gobject_class;
1930   GstObjectClass *gstobject_class;
1931
1932   gobject_class = (GObjectClass*)klass;
1933   gstobject_class = (GstObjectClass*)klass;
1934
1935   padtemplate_parent_class = g_type_class_ref(GST_TYPE_OBJECT);
1936
1937   gst_padtemplate_signals[TEMPL_PAD_CREATED] =
1938     g_signal_new ("pad_created", G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST,
1939                     G_STRUCT_OFFSET (GstPadTemplateClass, pad_created), NULL, NULL,
1940                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
1941                     G_TYPE_POINTER);
1942
1943
1944   gstobject_class->path_string_separator = "*";
1945 }
1946
1947 static void
1948 gst_padtemplate_init (GstPadTemplate *templ)
1949 {
1950 }
1951
1952 /**
1953  * gst_padtemplate_new:
1954  * @name_template: the name template
1955  * @direction: the direction for the template
1956  * @presence: the presence of the pad
1957  * @caps: a list of capabilities for the template
1958  * @...: more capabilities
1959  *
1960  * Creates a new padtemplate from the given arguments.
1961  *
1962  * Returns: the new padtemplate
1963  */
1964 GstPadTemplate*
1965 gst_padtemplate_new (gchar *name_template,
1966                      GstPadDirection direction, GstPadPresence presence,
1967                      GstCaps *caps, ...)
1968 {
1969   GstPadTemplate *new;
1970   va_list var_args;
1971   GstCaps *thecaps = NULL;
1972
1973   g_return_val_if_fail (name_template != NULL, NULL);
1974
1975   new = g_object_new(gst_padtemplate_get_type () ,NULL);
1976
1977   GST_PADTEMPLATE_NAME_TEMPLATE (new) = name_template;
1978   GST_PADTEMPLATE_DIRECTION (new) = direction;
1979   GST_PADTEMPLATE_PRESENCE (new) = presence;
1980
1981   va_start (var_args, caps);
1982
1983   while (caps) {
1984     new->fixed &= caps->fixed;
1985     thecaps = gst_caps_append (thecaps, caps);
1986     caps = va_arg (var_args, GstCaps*);
1987   }
1988   va_end (var_args);
1989   
1990   GST_PADTEMPLATE_CAPS (new) = thecaps;
1991
1992   return new;
1993 }
1994
1995 /**
1996  * gst_padtemplate_get_caps:
1997  * @templ: the padtemplate to use
1998  *
1999  * Get the capabilities of the padtemplate
2000  *
2001  * Returns: a GstCaps*
2002  */
2003 GstCaps*
2004 gst_padtemplate_get_caps (GstPadTemplate *templ)
2005 {
2006   g_return_val_if_fail (templ != NULL, NULL);
2007
2008   return GST_PADTEMPLATE_CAPS (templ);
2009 }
2010
2011 #ifndef GST_DISABLE_LOADSAVE
2012 /**
2013  * gst_padtemplate_save_thyself:
2014  * @templ: the padtemplate to save
2015  * @parent: the parent XML tree
2016  *
2017  * Saves the padtemplate into XML.
2018  *
2019  * Returns: the new XML tree
2020  */
2021 xmlNodePtr
2022 gst_padtemplate_save_thyself (GstPadTemplate *templ, xmlNodePtr parent)
2023 {
2024   xmlNodePtr subtree;
2025   guchar *presence;
2026
2027   GST_DEBUG (GST_CAT_XML,"saving padtemplate %s\n", templ->name_template);
2028
2029   xmlNewChild(parent,NULL,"nametemplate", templ->name_template);
2030   xmlNewChild(parent,NULL,"direction", (templ->direction == GST_PAD_SINK? "sink":"src"));
2031
2032   switch (templ->presence) {
2033     case GST_PAD_ALWAYS:
2034       presence = "always";
2035       break;
2036     case GST_PAD_SOMETIMES:
2037       presence = "sometimes";
2038       break;
2039     case GST_PAD_REQUEST:
2040       presence = "request";
2041       break;
2042     default:
2043       presence = "unknown";
2044       break;
2045   }
2046   xmlNewChild(parent,NULL,"presence", presence);
2047
2048   if (GST_PADTEMPLATE_CAPS (templ)) {
2049     subtree = xmlNewChild (parent, NULL, "caps", NULL);
2050     gst_caps_save_thyself (GST_PADTEMPLATE_CAPS (templ), subtree);
2051   }
2052
2053   return parent;
2054 }
2055
2056 /**
2057  * gst_padtemplate_load_thyself:
2058  * @parent: the source XML tree
2059  *
2060  * Loads a padtemplate from the XML tree.
2061  *
2062  * Returns: the new padtemplate
2063  */
2064 GstPadTemplate*
2065 gst_padtemplate_load_thyself (xmlNodePtr parent)
2066 {
2067   xmlNodePtr field = parent->xmlChildrenNode;
2068   GstPadTemplate *factory;
2069   gchar *name_template = NULL;
2070   GstPadDirection direction = GST_PAD_UNKNOWN;
2071   GstPadPresence presence = GST_PAD_ALWAYS;
2072   GstCaps *caps = NULL;
2073
2074   while (field) {
2075     if (!strcmp(field->name, "nametemplate")) {
2076       name_template = xmlNodeGetContent(field);
2077     }
2078     if (!strcmp(field->name, "direction")) {
2079       gchar *value = xmlNodeGetContent(field);
2080
2081       if (!strcmp(value, "sink")) {
2082         direction = GST_PAD_SINK;
2083       }
2084       else if (!strcmp(value, "src")) {
2085         direction = GST_PAD_SRC;
2086       }
2087       g_free (value);
2088     }
2089     if (!strcmp(field->name, "presence")) {
2090       gchar *value = xmlNodeGetContent(field);
2091
2092       if (!strcmp(value, "always")) {
2093         presence = GST_PAD_ALWAYS;
2094       }
2095       else if (!strcmp(value, "sometimes")) {
2096         presence = GST_PAD_SOMETIMES;
2097       }
2098       else if (!strcmp(value, "request")) {
2099         presence = GST_PAD_REQUEST;
2100       }
2101       g_free (value);
2102     }
2103     else if (!strcmp(field->name, "caps")) {
2104       caps = gst_caps_load_thyself (field);
2105     }
2106     field = field->next;
2107   }
2108
2109   factory = gst_padtemplate_new (name_template, direction, presence, caps, NULL);
2110
2111   return factory;
2112 }
2113 #endif /* !GST_DISABLE_LOADSAVE */
2114
2115
2116 /**
2117  * gst_pad_set_element_private:
2118  * @pad: the pad to set the private data to
2119  * @priv: The private data to attach to the pad
2120  *
2121  * Set the given private data pointer to the pad. This
2122  * function can only be used by the element that own the
2123  * pad.
2124  */
2125 void
2126 gst_pad_set_element_private (GstPad *pad, gpointer priv)
2127 {
2128   pad->element_private = priv;
2129 }
2130
2131 /**
2132  * gst_pad_get_element_private:
2133  * @pad: the pad to get the private data of
2134  *
2135  * Get the private data of a pad. The private data can
2136  * only be set by the parent element of this pad.
2137  *
2138  * Returns: a pointer to the private data.
2139  */
2140 gpointer
2141 gst_pad_get_element_private (GstPad *pad)
2142 {
2143   return pad->element_private;
2144 }
2145
2146
2147 /***** ghost pads *****/
2148 GType _gst_ghost_pad_type = 0;
2149
2150 static void     gst_ghost_pad_class_init         (GstGhostPadClass *klass);
2151 static void     gst_ghost_pad_init               (GstGhostPad *pad);
2152
2153 static GstPad *ghost_pad_parent_class = NULL;
2154 /* static guint gst_ghost_pad_signals[LAST_SIGNAL] = { 0 }; */
2155
2156 GType
2157 gst_ghost_pad_get_type(void) {
2158   if (!_gst_ghost_pad_type) {
2159     static const GTypeInfo pad_info = {
2160       sizeof(GstGhostPadClass),
2161       NULL,
2162       NULL,
2163       (GClassInitFunc)gst_ghost_pad_class_init,
2164       NULL,
2165       NULL,
2166       sizeof(GstGhostPad),
2167       8,
2168       (GInstanceInitFunc)gst_ghost_pad_init,
2169       NULL
2170     };
2171     _gst_ghost_pad_type = g_type_register_static(GST_TYPE_PAD, "GstGhostPad", &pad_info, 0);
2172   }
2173   return _gst_ghost_pad_type;
2174 }
2175
2176 static void
2177 gst_ghost_pad_class_init (GstGhostPadClass *klass)
2178 {
2179   GObjectClass *gobject_class;
2180
2181   gobject_class = (GObjectClass*)klass;
2182
2183   ghost_pad_parent_class = g_type_class_ref(GST_TYPE_PAD);
2184 }
2185
2186 static void
2187 gst_ghost_pad_init (GstGhostPad *pad)
2188 {
2189   pad->realpad = NULL;
2190 }
2191
2192 /**
2193  * gst_ghost_pad_new:
2194  * @name: name of the new ghost pad
2195  * @pad: the pad to create a ghost pad of
2196  *
2197  * Create a new ghost pad associated with the given pad.
2198  *
2199  * Returns: new ghost pad
2200  */
2201 GstPad*
2202 gst_ghost_pad_new (gchar *name,
2203                    GstPad *pad)
2204 {
2205   GstGhostPad *ghostpad;
2206
2207   g_return_val_if_fail (name != NULL, NULL);
2208   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2209
2210   ghostpad = g_object_new (gst_ghost_pad_get_type () ,NULL);
2211   gst_pad_set_name (GST_PAD (ghostpad), name);
2212   GST_GPAD_REALPAD (ghostpad) = GST_PAD_REALIZE (pad);
2213   GST_PAD_PADTEMPLATE (ghostpad) = GST_PAD_PADTEMPLATE (pad);
2214
2215   /* add ourselves to the real pad's list of ghostpads */
2216   gst_pad_add_ghost_pad (pad, GST_PAD (ghostpad));
2217
2218   /* FIXME need to ref the real pad here... ? */
2219
2220   GST_DEBUG (GST_CAT_PADS, "created ghost pad \"%s\"\n", name);
2221
2222   return GST_PAD (ghostpad);
2223 }
2224
2225 static void 
2226 gst_pad_event_default_dispatch (GstPad *pad, GstElement *element, GstEvent *event)
2227 {
2228   GList *pads = element->pads;
2229
2230   while (pads) {
2231     GstPad *eventpad = GST_PAD (pads->data);
2232     pads = g_list_next (pads);
2233
2234     /* for all pads in the opposite direction that are connected */
2235     if (GST_PAD_DIRECTION (eventpad) != GST_PAD_DIRECTION (pad) && GST_PAD_IS_CONNECTED (eventpad)) {
2236       if (GST_PAD_DIRECTION (eventpad) == GST_PAD_SRC) {
2237         gst_pad_push (eventpad, GST_BUFFER (gst_event_new (GST_EVENT_TYPE (event))));
2238       }
2239       else {
2240         GstPad *peerpad = GST_PAD_CAST (GST_RPAD_PEER (eventpad));
2241
2242         gst_pad_send_event (peerpad, gst_event_new (GST_EVENT_TYPE (event)));
2243       }
2244     }
2245   }
2246 }
2247
2248 /**
2249  * gst_pad_event_default:
2250  * @pad: the pad to operate on
2251  * @event: the event to handle
2252  *
2253  * Invoke the default event handler for the given pad.
2254  */
2255 void 
2256 gst_pad_event_default (GstPad *pad, GstEvent *event)
2257 {
2258   GstElement *element = GST_PAD_PARENT (pad);
2259
2260   g_signal_emit (G_OBJECT (pad), gst_real_pad_signals[REAL_EVENT_RECEIVED], 0, event);
2261  
2262   switch (GST_EVENT_TYPE (event)) {
2263     case GST_EVENT_EOS:
2264       gst_element_set_eos (element);
2265       gst_pad_event_default_dispatch (pad, element, event);
2266       gst_event_free (event);
2267       /* we have to try to schedule another element because this one is disabled */
2268       gst_element_yield (element);
2269       break;
2270     case GST_EVENT_FLUSH:
2271     default:
2272       gst_pad_event_default_dispatch (pad, element, event);
2273       gst_event_free (event);
2274       break;
2275   }
2276 }
2277
2278 /**
2279  * gst_pad_send_event:
2280  * @pad: the pad to send the event to
2281  * @event: the event to send to the pad.
2282  *
2283  * Send the event to the pad.
2284  *
2285  * Returns: TRUE if the event was handled.
2286  */
2287 gboolean
2288 gst_pad_send_event (GstPad *pad, GstEvent *event)
2289 {
2290   gboolean handled = FALSE;
2291
2292   g_return_val_if_fail (event, FALSE);
2293
2294   if (GST_EVENT_SRC (event) == NULL)
2295     GST_EVENT_SRC (event) = gst_object_ref (GST_OBJECT (pad));
2296
2297   GST_DEBUG (GST_CAT_EVENT, "have event %d on pad %s:%s\n",
2298                   GST_EVENT_TYPE (event), GST_DEBUG_PAD_NAME (pad));
2299
2300   if (GST_RPAD_EVENTFUNC (pad))
2301     handled = GST_RPAD_EVENTFUNC (pad) (pad, event);
2302   else {
2303     GST_DEBUG(GST_CAT_EVENT, "there's no event function for pad %s:%s\n", GST_DEBUG_PAD_NAME (pad));
2304   }
2305
2306   if (!handled) {
2307     GST_DEBUG(GST_CAT_EVENT, "proceeding with default event behavior here\n");
2308     gst_pad_event_default (pad, event);
2309     handled = TRUE;
2310   }
2311
2312   return handled;
2313 }
2314