Documentation updates
[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", 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", 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",
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",
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",
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",
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",
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",
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",
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",
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");
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) == realsrc);
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)");
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");
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   gst_caps_debug (gst_pad_get_caps (GST_PAD_CAST (realsrc)), "caps of newly connected src pad");
744
745   return TRUE;
746 }
747
748 /**
749  * gst_pad_connect:
750  * @srcpad: the source pad to connect
751  * @sinkpad: the sink pad to connect
752  *
753  * Connects the source pad to the sink pad.
754  *
755  * Returns: TRUE if the pad could be connected, FALSE otherwise
756  */
757 gboolean
758 gst_pad_connect (GstPad *srcpad, GstPad *sinkpad)
759 {
760   return gst_pad_connect_filtered (srcpad, sinkpad, NULL);
761 }
762
763 /**
764  * gst_pad_set_parent:
765  * @pad: the pad to set the parent
766  * @parent: the object to set the parent to
767  *
768  * Sets the parent object of a pad.
769  */
770 void
771 gst_pad_set_parent (GstPad *pad,
772                     GstObject *parent)
773 {
774   g_return_if_fail (pad != NULL);
775   g_return_if_fail (GST_IS_PAD (pad));
776   g_return_if_fail (GST_PAD_PARENT (pad) == NULL);
777   g_return_if_fail (parent != NULL);
778   g_return_if_fail (GST_IS_OBJECT (parent));
779   g_return_if_fail ((gpointer)pad != (gpointer)parent);
780
781   gst_object_set_parent (GST_OBJECT (pad), parent);
782 }
783
784 /**
785  * gst_pad_get_parent:
786  * @pad: the pad to get the parent from
787  *
788  * Get the parent object of this pad.
789  *
790  * Returns: the parent object
791  */
792 GstElement*
793 gst_pad_get_parent (GstPad *pad)
794 {
795   g_return_val_if_fail (pad != NULL, NULL);
796   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
797
798   return GST_PAD_PARENT (pad);
799 }
800
801 /**
802  * gst_pad_get_padtemplate:
803  * @pad: the pad to get the padtemplate from
804  *
805  * Get the padtemplate object of this pad.
806  *
807  * Returns: the padtemplate object
808  */
809 GstPadTemplate*
810 gst_pad_get_padtemplate (GstPad *pad)
811 {
812   g_return_val_if_fail (pad != NULL, NULL);
813   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
814
815   return GST_PAD_PADTEMPLATE (pad); 
816 }
817
818
819 /**
820  * gst_pad_set_sched:
821  * @pad: the pad to set the scheduler for
822  * @sched: The scheduler to set
823  *
824  * Set the scheduler for the pad
825  */
826 void
827 gst_pad_set_sched (GstPad *pad, GstScheduler *sched)
828 {
829   g_return_if_fail (pad != NULL);
830   g_return_if_fail (GST_IS_PAD (pad));
831  
832   GST_RPAD_SCHED(pad) = sched;
833 }
834  
835 /**
836  * gst_pad_get_sched:
837  * @pad: the pad to get the scheduler from
838  *
839  * Get the scheduler of the pad
840  *
841  * Returns: the scheduler of the pad.
842  */
843 GstScheduler*
844 gst_pad_get_sched (GstPad *pad)
845 {
846   g_return_val_if_fail (pad != NULL, NULL);
847   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
848  
849   return GST_RPAD_SCHED(pad);
850 }
851
852 /**
853  * gst_pad_unset_sched:
854  * @pad: the pad to unset the scheduler for
855  *
856  * Unset the scheduler for the pad
857  */
858 void
859 gst_pad_unset_sched (GstPad *pad)
860 {
861   g_return_if_fail (pad != NULL);
862   g_return_if_fail (GST_IS_PAD (pad));
863  
864   GST_RPAD_SCHED(pad) = NULL;
865 }
866  
867 /**
868  * gst_pad_get_real_parent:
869  * @pad: the pad to get the parent from
870  *
871  * Get the real parent object of this pad. If the pad
872  * is a ghostpad, the actual owner of the real pad is
873  * returned, as opposed to the gst_pad_get_parent().
874  *
875  * Returns: the parent object
876  */
877 GstElement*
878 gst_pad_get_real_parent (GstPad *pad)
879 {
880   g_return_val_if_fail (pad != NULL, NULL);
881   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
882
883   return GST_PAD_PARENT (GST_PAD (GST_PAD_REALIZE (pad)));
884 }
885
886 /**
887  * gst_pad_add_ghost_pad:
888  * @pad: the pad to set the ghost parent
889  * @ghostpad: the ghost pad to add
890  *
891  * Add a ghost pad to a pad.
892  */
893 void
894 gst_pad_add_ghost_pad (GstPad *pad,
895                        GstPad *ghostpad)
896 {
897   GstRealPad *realpad;
898
899   g_return_if_fail (pad != NULL);
900   g_return_if_fail (GST_IS_PAD (pad));
901   g_return_if_fail (ghostpad != NULL);
902   g_return_if_fail (GST_IS_GHOST_PAD (ghostpad));
903
904   realpad = GST_PAD_REALIZE (pad);
905
906   realpad->ghostpads = g_list_prepend (realpad->ghostpads, ghostpad);
907 }
908
909
910 /**
911  * gst_pad_remove_ghost_pad:
912  * @pad: the pad to remove the ghost parent
913  * @ghostpad: the ghost pad to remove from the pad
914  *
915  * Remove a ghost pad from a pad.
916  */
917 void
918 gst_pad_remove_ghost_pad (GstPad *pad,
919                           GstPad *ghostpad)
920 {
921   GstRealPad *realpad;
922
923   g_return_if_fail (pad != NULL);
924   g_return_if_fail (GST_IS_PAD (pad));
925   g_return_if_fail (ghostpad != NULL);
926   g_return_if_fail (GST_IS_GHOST_PAD (ghostpad));
927
928   realpad = GST_PAD_REALIZE (pad);
929
930   realpad->ghostpads = g_list_remove (realpad->ghostpads, ghostpad);
931 }
932
933 /**
934  * gst_pad_get_ghost_pad_list:
935  * @pad: the pad to get the ghost parents from
936  *
937  * Get the ghost parents of this pad.
938  *
939  * Returns: a GList of ghost pads
940  */
941 GList*
942 gst_pad_get_ghost_pad_list (GstPad *pad)
943 {
944   g_return_val_if_fail (pad != NULL, NULL);
945   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
946
947   return GST_PAD_REALIZE(pad)->ghostpads;
948 }
949
950 /* an internal caps negotiation helper function does:
951  * 
952  * 1. optinally calls the pad connect function with the provided caps
953  * 2. deal with the result code of the connect function
954  * 3. set fixed caps on the pad.
955  */
956 static GstPadConnectReturn
957 gst_pad_try_set_caps_func (GstRealPad *pad, GstCaps *caps, gboolean notify)
958 {
959   GstCaps *oldcaps;
960   GstPadTemplate *template;
961   GstElement *parent = GST_PAD_PARENT (pad);
962
963   /* thomas: FIXME: is this the right result to return ? */
964   g_return_val_if_fail (pad != NULL, GST_PAD_CONNECT_REFUSED);
965   g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_CONNECT_REFUSED);
966   
967   /* if this pad has a parent and the parent is not READY, delay the
968    * negotiation */
969   if (parent && GST_STATE (parent) < GST_STATE_READY)
970   {
971     GST_DEBUG (GST_CAT_CAPS, "parent %s of pad %s:%s is not ready",
972                GST_ELEMENT_NAME (parent), GST_DEBUG_PAD_NAME (pad));
973     return GST_PAD_CONNECT_DELAYED;
974   }
975           
976   GST_INFO (GST_CAT_CAPS, "trying to set caps %p on pad %s:%s",
977             caps, GST_DEBUG_PAD_NAME (pad));
978   
979   if ((template = gst_pad_get_padtemplate (GST_PAD_CAST (pad)))) {
980     if (!gst_caps_intersect (caps, gst_padtemplate_get_caps (template))) {
981       GST_INFO (GST_CAT_CAPS, "caps did not intersect with %s:%s's padtemplate",
982                 GST_DEBUG_PAD_NAME (pad));
983       gst_caps_debug (gst_padtemplate_get_caps (template),
984                       "pad template caps that did not agree with caps");
985       return GST_PAD_CONNECT_REFUSED;
986     }
987     /* given that the caps are fixed, we know that their intersection with the
988      * padtemplate caps is the same as caps itself */
989   }
990
991   /* we need to notify the connect function */
992   if (notify && GST_RPAD_CONNECTFUNC (pad)) {
993     GstPadConnectReturn res;
994     gchar *debug_string;
995
996     GST_INFO (GST_CAT_CAPS, "calling connect function on pad %s:%s",
997             GST_DEBUG_PAD_NAME (pad));
998
999     /* call the connect function */
1000     res = GST_RPAD_CONNECTFUNC (pad) (GST_PAD (pad), caps);
1001
1002     switch (res) {
1003       case GST_PAD_CONNECT_REFUSED:
1004         debug_string = "REFUSED";
1005         break;
1006       case GST_PAD_CONNECT_OK:
1007         debug_string = "OK";
1008         break;
1009       case GST_PAD_CONNECT_DONE:
1010         debug_string = "DONE";
1011         break;
1012       case GST_PAD_CONNECT_DELAYED:
1013         debug_string = "DELAYED";
1014         break;
1015       default:
1016         g_warning ("unknown return code from connect function of pad %s:%s %d",
1017             GST_DEBUG_PAD_NAME (pad), res);
1018         return GST_PAD_CONNECT_REFUSED;
1019     }
1020
1021     GST_INFO (GST_CAT_CAPS, "got reply %s (%d) from connect function on pad %s:%s",
1022             debug_string, res, GST_DEBUG_PAD_NAME (pad));
1023
1024     /* done means the connect function called another caps negotiate function
1025      * on this pad that succeeded, we dont need to continue */
1026     if (res == GST_PAD_CONNECT_DONE) {
1027       GST_INFO (GST_CAT_CAPS, "pad %s:%s is done", GST_DEBUG_PAD_NAME (pad));
1028       return GST_PAD_CONNECT_DONE;
1029     }
1030     if (res == GST_PAD_CONNECT_REFUSED) {
1031       GST_INFO (GST_CAT_CAPS, "pad %s:%s doesn't accept caps",
1032                     GST_DEBUG_PAD_NAME (pad));
1033       return GST_PAD_CONNECT_REFUSED;
1034     }
1035   }
1036   /* we can only set caps on the pad if they are fixed */
1037   if (GST_CAPS_IS_FIXED (caps)) {
1038
1039     GST_INFO (GST_CAT_CAPS, "setting caps on pad %s:%s",
1040               GST_DEBUG_PAD_NAME (pad));
1041     /* if we got this far all is ok, remove the old caps, set the new one */
1042     oldcaps = GST_PAD_CAPS (pad);
1043     if (caps) gst_caps_ref (caps);
1044     GST_PAD_CAPS (pad) = caps;
1045     if (oldcaps) gst_caps_unref (oldcaps);
1046   }
1047   else {
1048     GST_INFO (GST_CAT_CAPS, "caps are not fixed on pad %s:%s, not setting them yet",
1049               GST_DEBUG_PAD_NAME (pad));
1050   }
1051
1052   return GST_PAD_CONNECT_OK;
1053 }
1054
1055 /**
1056  * gst_pad_try_set_caps:
1057  * @pad: the pad to try to set the caps on
1058  * @caps: the caps to set
1059  *
1060  * Try to set the caps on the given pad.
1061  *
1062  * Returns: TRUE if the caps could be set
1063  */
1064 gboolean
1065 gst_pad_try_set_caps (GstPad *pad, GstCaps *caps)
1066 {
1067   GstRealPad *peer, *realpad;
1068
1069   realpad = GST_PAD_REALIZE (pad);
1070   peer = GST_RPAD_PEER (realpad);
1071
1072   GST_INFO (GST_CAT_CAPS, "trying to set caps %p on pad %s:%s",
1073             caps, GST_DEBUG_PAD_NAME (realpad));
1074
1075   gst_caps_debug (caps, "caps that we are trying to set");
1076
1077   /* setting non fixed caps on a pad is not allowed */
1078   if (!GST_CAPS_IS_FIXED (caps)) {
1079   GST_INFO (GST_CAT_CAPS, "trying to set unfixed caps on pad %s:%s, not allowed",
1080                   GST_DEBUG_PAD_NAME (realpad));
1081     g_warning ("trying to set non fixed caps on pad %s:%s, not allowed",
1082             GST_DEBUG_PAD_NAME (realpad));
1083     gst_caps_debug (caps, "unfixed caps");
1084     return FALSE;
1085   }
1086
1087   /* if we have a peer try to set the caps, notifying the peerpad
1088    * if it has a connect function */
1089   if (peer && (gst_pad_try_set_caps_func (peer, caps, TRUE) != GST_PAD_CONNECT_OK))
1090   {
1091     GST_INFO (GST_CAT_CAPS, "tried to set caps on peerpad %s:%s but couldn't",
1092               GST_DEBUG_PAD_NAME (peer));
1093     return FALSE;
1094   }
1095
1096   /* then try to set our own caps, we don't need to be notified */
1097   if (gst_pad_try_set_caps_func (realpad, caps, FALSE) != GST_PAD_CONNECT_OK)
1098   {
1099     GST_INFO (GST_CAT_CAPS, "tried to set own caps on pad %s:%s but couldn't",
1100               GST_DEBUG_PAD_NAME (realpad));
1101     return FALSE;
1102   }
1103   GST_INFO (GST_CAT_CAPS, "succeeded setting caps %p on pad %s:%s",
1104             caps, GST_DEBUG_PAD_NAME (realpad));
1105   g_assert (GST_PAD_CAPS (pad));
1106                           
1107   return TRUE;
1108 }
1109
1110 /* this is a caps negotiation convenience routine, it performs:
1111  *
1112  * 1. optionally clear any pad caps
1113  * 2. calculate the intersection between the two pad tamplate/getcaps caps
1114  * 3. calculate the intersection with the (optional) filtercaps.
1115  * 4. store the intersection in the pad filter
1116  * 5. store the app filtercaps in the pad appfilter.
1117  * 6. start the caps negotiation.
1118  */
1119 static gboolean
1120 gst_pad_try_reconnect_filtered_func (GstRealPad *srcpad, GstRealPad *sinkpad, GstCaps *filtercaps, gboolean clear)
1121 {
1122   GstCaps *srccaps, *sinkcaps;
1123   GstCaps *intersection = NULL;
1124   GstRealPad *realsrc, *realsink;
1125
1126   realsrc = GST_PAD_REALIZE (srcpad);
1127   realsink = GST_PAD_REALIZE (sinkpad);
1128
1129   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1130   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1131
1132   /* optinally clear the caps */
1133   if (clear) {
1134     GST_INFO (GST_CAT_PADS, "reconnect filtered %s:%s and %s:%s, clearing caps",
1135         GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1136
1137     GST_PAD_CAPS (GST_PAD (realsrc)) = NULL;
1138     GST_PAD_CAPS (GST_PAD (realsink)) = NULL;
1139   }
1140   else {
1141     GST_INFO (GST_CAT_PADS, "reconnect filtered %s:%s and %s:%s",
1142         GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1143   }
1144
1145   srccaps = gst_pad_get_caps (GST_PAD (realsrc));
1146   GST_INFO (GST_CAT_PADS, "dumping caps of pad %s:%s", GST_DEBUG_PAD_NAME (realsrc));
1147   gst_caps_debug (srccaps, "caps of src pad (pre-reconnect)");
1148   sinkcaps = gst_pad_get_caps (GST_PAD (realsink));
1149   GST_INFO (GST_CAT_PADS, "dumping caps of pad %s:%s", GST_DEBUG_PAD_NAME (realsink));
1150   gst_caps_debug (sinkcaps, "caps of sink pad (pre-reconnect)");
1151
1152   /* first take the intersection of the pad caps */
1153   intersection = gst_caps_intersect (srccaps, sinkcaps);
1154
1155   /* if we have no intersection but one of the caps was not NULL.. */
1156   if (!intersection && (srccaps || sinkcaps)) {
1157     /* the intersection is NULL but the pad caps were not both NULL,
1158      * this means they have no common format */
1159     GST_INFO (GST_CAT_PADS, "pads %s:%s and %s:%s have no common type",
1160          GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1161     return FALSE;
1162   } else if (intersection) {
1163     GST_INFO (GST_CAT_PADS, "pads %s:%s and %s:%s intersected to %s caps",
1164          GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink), 
1165          ((intersection && GST_CAPS_IS_FIXED (intersection)) ? "fixed" : "variable"));
1166
1167     /* then filter this against the app filter */
1168     if (filtercaps) {
1169       GstCaps *filtered_intersection = gst_caps_intersect (intersection, filtercaps);
1170
1171       /* get rid of the old intersection here */
1172       gst_caps_unref (intersection);
1173
1174       if (!filtered_intersection) {
1175         GST_INFO (GST_CAT_PADS, "filtered connection between pads %s:%s and %s:%s is empty",
1176              GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1177         return FALSE;
1178       }
1179       intersection = filtered_intersection;
1180
1181       /* keep a reference to the app caps */
1182       GST_RPAD_APPFILTER (realsink) = filtercaps;
1183       GST_RPAD_APPFILTER (realsrc) = filtercaps;
1184     }
1185   }
1186   GST_DEBUG (GST_CAT_CAPS, "setting filter for connection to:");
1187   gst_caps_debug (intersection, "filter for connection");
1188
1189   /* both the app filter and the filter, while stored on both peer pads, are the
1190      equal to the same thing on both */
1191   GST_RPAD_FILTER (realsrc) = intersection; 
1192   GST_RPAD_FILTER (realsink) = intersection; 
1193
1194   return gst_pad_perform_negotiate (GST_PAD (realsrc), GST_PAD (realsink));
1195 }
1196
1197 /**
1198  * gst_pad_perform_negotiate:
1199  * @srcpad: a srcpad
1200  * @sinkpad: a sinkpad 
1201  *
1202  * Try to negotiate the pads.
1203  *
1204  * Returns: a boolean indicating the pad succesfully negotiated.
1205  */
1206 gboolean
1207 gst_pad_perform_negotiate (GstPad *srcpad, GstPad *sinkpad) 
1208 {
1209   GstCaps *intersection, *filtered_intersection;
1210   GstRealPad *realsrc, *realsink;
1211   GstCaps *srccaps, *sinkcaps, *filter;
1212
1213   g_return_val_if_fail (srcpad != NULL, FALSE);
1214   g_return_val_if_fail (sinkpad != NULL, FALSE);
1215   
1216   realsrc = GST_PAD_REALIZE (srcpad);
1217   realsink = GST_PAD_REALIZE (sinkpad);
1218     
1219   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1220   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1221
1222   filter = GST_RPAD_APPFILTER (realsrc);
1223   if (filter) {
1224     GST_INFO (GST_CAT_PADS, "dumping filter for connection %s:%s-%s:%s",
1225               GST_DEBUG_PAD_NAME (realsrc), GST_DEBUG_PAD_NAME (realsink));
1226     gst_caps_debug (filter, "connection filter caps");
1227   }
1228
1229   /* calculate the new caps here */
1230   srccaps = gst_pad_get_caps (GST_PAD (realsrc));
1231   GST_INFO (GST_CAT_PADS, "dumping caps of pad %s:%s", GST_DEBUG_PAD_NAME (realsrc));
1232   gst_caps_debug (srccaps, "src caps, awaiting negotiation, after applying filter");
1233   sinkcaps = gst_pad_get_caps (GST_PAD (realsink));
1234   GST_INFO (GST_CAT_PADS, "dumping caps of pad %s:%s", GST_DEBUG_PAD_NAME (realsink));
1235   gst_caps_debug (sinkcaps, "sink caps, awaiting negotiation, after applying filter");
1236   intersection = gst_caps_intersect (srccaps, sinkcaps);
1237   filtered_intersection = gst_caps_intersect (intersection, filter);
1238   if (filtered_intersection) {
1239     gst_caps_unref (intersection);
1240     intersection = filtered_intersection;
1241   }
1242
1243   /* no negotiation is performed if the pads have filtercaps */
1244   if (intersection) {
1245     GstPadConnectReturn res;
1246
1247     res = gst_pad_try_set_caps_func (realsrc, intersection, TRUE);
1248     if (res == GST_PAD_CONNECT_REFUSED) 
1249       return FALSE;
1250     if (res == GST_PAD_CONNECT_DONE) 
1251       return TRUE;
1252
1253     res = gst_pad_try_set_caps_func (realsink, intersection, TRUE);
1254     if (res == GST_PAD_CONNECT_REFUSED) 
1255       return FALSE;
1256     if (res == GST_PAD_CONNECT_DONE) 
1257       return TRUE;
1258   }
1259   return TRUE;
1260 }
1261
1262 /**
1263  * gst_pad_try_reconnect_filtered:
1264  * @srcpad: the source"pad to reconnect
1265  * @sinkpad: the sink pad to reconnect
1266  * @filtercaps: the capabilities to use in the reconnectiong
1267  *
1268  * Try to reconnect this pad and its peer with the specified caps
1269  *
1270  * Returns: a boolean indicating the peer pad could accept the caps.
1271  */
1272 gboolean
1273 gst_pad_try_reconnect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps)
1274 {
1275   GstRealPad *realsrc, *realsink;
1276
1277   g_return_val_if_fail (srcpad != NULL, FALSE);
1278   g_return_val_if_fail (sinkpad != NULL, FALSE);
1279
1280   realsrc = GST_PAD_REALIZE (srcpad);
1281   realsink = GST_PAD_REALIZE (sinkpad);
1282
1283   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1284   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1285   
1286   return gst_pad_try_reconnect_filtered_func (realsrc, realsink, filtercaps, TRUE);
1287 }
1288
1289 /**
1290  * gst_pad_reconnect_filtered:
1291  * @srcpad: the source"pad to reconnect
1292  * @sinkpad: the sink pad to reconnect
1293  * @filtercaps: the capabilities to use in the reconnectiong
1294  *
1295  * Try to reconnect this pad and its peer with the specified caps. 
1296  *
1297  * Returns: a boolean indicating the peer pad could accept the caps.
1298  *    if FALSE is returned, the pads are disconnected.
1299  */
1300 gboolean
1301 gst_pad_reconnect_filtered (GstPad *srcpad, GstPad *sinkpad, GstCaps *filtercaps)
1302 {
1303   GstRealPad *realsrc, *realsink;
1304
1305   g_return_val_if_fail (srcpad != NULL, FALSE);
1306   g_return_val_if_fail (sinkpad != NULL, FALSE);
1307
1308   realsrc = GST_PAD_REALIZE (srcpad);
1309   realsink = GST_PAD_REALIZE (sinkpad);
1310
1311   g_return_val_if_fail (GST_RPAD_PEER (realsrc) != NULL, FALSE);
1312   g_return_val_if_fail (GST_RPAD_PEER (realsink) == realsrc, FALSE);
1313   
1314   if (!gst_pad_try_reconnect_filtered_func (realsrc, realsink, filtercaps, TRUE)) {
1315     gst_pad_disconnect (srcpad, GST_PAD (GST_PAD_PEER (srcpad)));
1316     return FALSE;
1317   }
1318   return TRUE;
1319 }
1320
1321 /**
1322  * gst_pad_proxy_connect:
1323  * @pad: the pad to proxy to
1324  * @caps: the capabilities to use in the proxying
1325  *
1326  * Proxy the connect function to the specified pad.
1327  *
1328  * Returns: a boolean indicating the peer pad could accept the caps.
1329  */
1330 GstPadConnectReturn
1331 gst_pad_proxy_connect (GstPad *pad, GstCaps *caps)
1332 {
1333   GstRealPad *peer, *realpad;
1334
1335   realpad = GST_PAD_REALIZE (pad);
1336
1337   peer = GST_RPAD_PEER (realpad);
1338
1339   GST_INFO (GST_CAT_CAPS, "proxy connect to pad %s:%s",
1340             GST_DEBUG_PAD_NAME (realpad));
1341
1342   if (peer && gst_pad_try_set_caps_func (peer, caps, TRUE) < 0)
1343     return GST_PAD_CONNECT_REFUSED;
1344   if (gst_pad_try_set_caps_func (realpad, caps, FALSE) < 0)
1345     return GST_PAD_CONNECT_REFUSED;
1346
1347   return GST_PAD_CONNECT_OK;
1348 }
1349
1350 /**
1351  * gst_pad_get_caps:
1352  * @pad: the pad to get the capabilities from
1353  *
1354  * Get the capabilities of this pad.
1355  *
1356  * Returns: the capabilities of this pad
1357  */
1358 GstCaps*
1359 gst_pad_get_caps (GstPad *pad)
1360 {
1361   GstRealPad *realpad;
1362
1363   g_return_val_if_fail (pad != NULL, NULL);
1364   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1365
1366   realpad = GST_PAD_REALIZE (pad);
1367
1368   GST_DEBUG (GST_CAT_CAPS, "get pad caps of %s:%s (%p)",
1369             GST_DEBUG_PAD_NAME (realpad), realpad);
1370
1371   if (GST_PAD_CAPS (realpad)) {
1372     GST_DEBUG (GST_CAT_CAPS, "using pad real caps");
1373     return GST_PAD_CAPS (realpad);
1374   }
1375   else if GST_RPAD_GETCAPSFUNC (realpad) {
1376     GST_DEBUG (GST_CAT_CAPS, "using pad get function");
1377     return GST_RPAD_GETCAPSFUNC (realpad) (GST_PAD_CAST (realpad), NULL);
1378   }
1379   else if (GST_PAD_PADTEMPLATE (realpad)) {
1380     GST_DEBUG (GST_CAT_CAPS, "using pad template");
1381     return GST_PADTEMPLATE_CAPS (GST_PAD_PADTEMPLATE (realpad));
1382   }
1383   GST_DEBUG (GST_CAT_CAPS, "pad has no caps");
1384
1385   return NULL;
1386 }
1387
1388 /**
1389  * gst_pad_get_padtemplate_caps:
1390  * @pad: the pad to get the capabilities from
1391  *
1392  * Get the capabilities of this pad.
1393  *
1394  * Returns: a list of the capabilities of this pad
1395  */
1396 GstCaps*
1397 gst_pad_get_padtemplate_caps (GstPad *pad)
1398 {
1399   g_return_val_if_fail (pad != NULL, NULL);
1400   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1401
1402   if (GST_PAD_PADTEMPLATE (pad))
1403     return GST_PADTEMPLATE_CAPS (GST_PAD_PADTEMPLATE (pad));
1404
1405   return NULL;
1406 }
1407
1408
1409 /**
1410  * gst_padtemplate_get_caps_by_name:
1411  * @templ: the padtemplate to get the capabilities from
1412  * @name: the name of the capability to get
1413  *
1414  * Get the capability with the given name from this padtemplate.
1415  *
1416  * Returns: a capability or NULL if not found
1417  */
1418 GstCaps*
1419 gst_padtemplate_get_caps_by_name (GstPadTemplate *templ, const gchar *name)
1420 {
1421   GstCaps *caps;
1422
1423   g_return_val_if_fail (templ != NULL, NULL);
1424
1425   caps = GST_PADTEMPLATE_CAPS (templ);
1426   if (!caps) 
1427     return NULL;
1428
1429   return gst_caps_get_by_name (caps, name);
1430 }
1431
1432 /**
1433  * gst_pad_check_compatibility:
1434  * @srcpad: the srcpad to check
1435  * @sinkpad: the sinkpad to check against
1436  *
1437  * Check if two pads have compatible capabilities.
1438  *
1439  * Returns: TRUE if they are compatible or the capabilities
1440  * could not be checked
1441  */
1442 gboolean
1443 gst_pad_check_compatibility (GstPad *srcpad, GstPad *sinkpad)
1444 {
1445   g_return_val_if_fail (srcpad != NULL, FALSE);
1446   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1447   g_return_val_if_fail (sinkpad != NULL, FALSE);
1448   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1449
1450   if (GST_PAD_CAPS (srcpad) && GST_PAD_CAPS (sinkpad)) {
1451     if (!gst_caps_check_compatibility (GST_PAD_CAPS (srcpad), GST_PAD_CAPS (sinkpad))) {
1452       return FALSE;
1453     }
1454     else {
1455       return TRUE;
1456     }
1457   }
1458   else {
1459     GST_DEBUG (GST_CAT_PADS, "could not check capabilities of pads (%s:%s) and (%s:%s) %p %p",
1460                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad), 
1461                     GST_PAD_CAPS (srcpad), GST_PAD_CAPS (sinkpad));
1462     return TRUE;
1463   }
1464 }
1465
1466 /**
1467  * gst_pad_get_peer:
1468  * @pad: the pad to get the peer from
1469  *
1470  * Get the peer pad of this pad.
1471  *
1472  * Returns: the peer pad
1473  */
1474 GstPad*
1475 gst_pad_get_peer (GstPad *pad)
1476 {
1477   g_return_val_if_fail (pad != NULL, NULL);
1478   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1479
1480   return GST_PAD (GST_PAD_PEER (pad));
1481 }
1482
1483 /**
1484  * gst_pad_get_allowed_caps:
1485  * @pad: the pad to get the allowed caps from
1486  *
1487  * Get the caps of the allowed media types that can
1488  * go through this pad.
1489  *
1490  * Returns: the allowed caps, newly allocated
1491  */
1492 GstCaps*
1493 gst_pad_get_allowed_caps (GstPad *pad)
1494 {
1495   g_return_val_if_fail (pad != NULL, NULL);
1496   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1497
1498   GST_DEBUG (GST_CAT_PROPERTIES, "get allowed caps of %s:%s", GST_DEBUG_PAD_NAME (pad));
1499
1500   return gst_caps_copy (GST_RPAD_FILTER (pad));
1501 }
1502
1503 /**
1504  * gst_pad_recalc_allowed_caps:
1505  * @pad: the pad to recaculate the caps of
1506  *
1507  * Attempt to reconnect the pad to its peer through its filter, 
1508  * set with gst_pad_[re]connect_filtered. This function is useful when a
1509  * plugin has new capabilities on a pad and wants to notify the peer.
1510  *
1511  * Returns: TRUE on success, FALSE otherwise.
1512  */
1513 gboolean
1514 gst_pad_recalc_allowed_caps (GstPad *pad)
1515 {
1516   GstRealPad *peer;
1517
1518   g_return_val_if_fail (pad != NULL, FALSE);
1519   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1520
1521   GST_DEBUG (GST_CAT_PROPERTIES, "set allowed caps of %s:%s", GST_DEBUG_PAD_NAME (pad));
1522
1523   peer = GST_RPAD_PEER (pad);
1524   if (peer)
1525     return gst_pad_try_reconnect_filtered (pad, GST_PAD (peer), GST_RPAD_APPFILTER (pad));
1526
1527   return TRUE;
1528 }
1529
1530 /**
1531  * gst_pad_get_bufferpool:
1532  * @pad: the pad to get the bufferpool from
1533  *
1534  * Get the bufferpool of the peer pad of the given
1535  * pad.
1536  *
1537  * Returns: The GstBufferPool or NULL.
1538  */
1539 GstBufferPool*          
1540 gst_pad_get_bufferpool (GstPad *pad)
1541 {
1542   GstRealPad *peer;
1543
1544   g_return_val_if_fail (pad != NULL, NULL);
1545   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1546    
1547   peer = GST_RPAD_PEER (pad);
1548
1549   if (!peer)
1550     return NULL;
1551
1552   GST_DEBUG_ENTER ("(%s:%s)", GST_DEBUG_PAD_NAME (pad));
1553
1554   if (peer->bufferpoolfunc) {
1555     GST_DEBUG (GST_CAT_PADS, "calling bufferpoolfunc &%s (@%p) of peer pad %s:%s",
1556       GST_DEBUG_FUNCPTR_NAME (peer->bufferpoolfunc), &peer->bufferpoolfunc, GST_DEBUG_PAD_NAME (((GstPad*) peer)));
1557     return (peer->bufferpoolfunc) (((GstPad*) peer));
1558   } else {
1559     GST_DEBUG (GST_CAT_PADS, "no bufferpoolfunc for peer pad %s:%s at %p",
1560                     GST_DEBUG_PAD_NAME (((GstPad*) peer)), &peer->bufferpoolfunc);
1561     return NULL;
1562   }
1563 }
1564
1565 static void
1566 gst_real_pad_dispose (GObject *object)
1567 {
1568   GstPad *pad = GST_PAD (object);
1569   
1570   /* No connected pad can ever be disposed.
1571    * It has to have a parent to be connected and a parent would hold a reference */
1572   g_assert (GST_PAD_PEER (pad) == NULL);
1573
1574   GST_DEBUG (GST_CAT_REFCOUNTING, "dispose %s:%s", GST_DEBUG_PAD_NAME(pad));
1575
1576   if (GST_PAD_PADTEMPLATE (pad)){
1577     GST_DEBUG (GST_CAT_REFCOUNTING, "unreffing padtemplate'%s'", GST_OBJECT_NAME (GST_PAD_PADTEMPLATE (pad)));
1578     gst_object_unref (GST_OBJECT (GST_PAD_PADTEMPLATE (pad)));
1579     GST_PAD_PADTEMPLATE (pad) = NULL;
1580   }
1581   
1582   /* we destroy the ghostpads, because they are nothing without the real pad  */
1583   if (GST_REAL_PAD (pad)->ghostpads) {
1584     GList *orig, *ghostpads;
1585
1586     orig = ghostpads = g_list_copy (GST_REAL_PAD (pad)->ghostpads);
1587
1588     while (ghostpads) {
1589       GstPad *ghostpad = GST_PAD (ghostpads->data);
1590
1591       if (GST_IS_ELEMENT (GST_OBJECT_PARENT (ghostpad))){
1592         GST_DEBUG (GST_CAT_REFCOUNTING, "removing ghost pad from element '%s'", 
1593                         GST_OBJECT_NAME (GST_OBJECT_PARENT (ghostpad)));
1594
1595         gst_element_remove_ghost_pad (GST_ELEMENT (GST_OBJECT_PARENT (ghostpad)), GST_PAD (ghostpad));
1596       }
1597       ghostpads = g_list_next (ghostpads);
1598     }
1599     g_list_free (orig);
1600     g_list_free (GST_REAL_PAD(pad)->ghostpads);
1601   }
1602
1603   if (GST_IS_ELEMENT (GST_OBJECT_PARENT (pad))){
1604     GST_DEBUG (GST_CAT_REFCOUNTING, "removing pad from element '%s'",
1605                     GST_OBJECT_NAME (GST_OBJECT (GST_ELEMENT (GST_OBJECT_PARENT (pad)))));
1606     
1607     gst_element_remove_pad (GST_ELEMENT (GST_OBJECT_PARENT (pad)), pad);
1608   }
1609   
1610   G_OBJECT_CLASS (real_pad_parent_class)->dispose (object);
1611 }
1612
1613
1614 #ifndef GST_DISABLE_LOADSAVE
1615 /**
1616  * gst_pad_load_and_connect:
1617  * @self: the XML node to read the description from
1618  * @parent: the element that has the pad
1619  *
1620  * Read the pad definition from the XML node and connect the given pad
1621  * in element to a pad of an element up in the hierarchy.
1622  */
1623 void
1624 gst_pad_load_and_connect (xmlNodePtr self,
1625                           GstObject *parent)
1626 {
1627   xmlNodePtr field = self->xmlChildrenNode;
1628   GstPad *pad = NULL, *targetpad;
1629   guchar *peer = NULL;
1630   gchar **split;
1631   GstElement *target;
1632   GstObject *grandparent;
1633
1634   while (field) {
1635     if (!strcmp (field->name, "name")) {
1636       pad = gst_element_get_pad (GST_ELEMENT (parent), xmlNodeGetContent (field));
1637     }
1638     else if (!strcmp(field->name, "peer")) {
1639       peer = xmlNodeGetContent (field);
1640     }
1641     field = field->next;
1642   }
1643   g_return_if_fail (pad != NULL);
1644
1645   if (peer == NULL) return;
1646
1647   split = g_strsplit (peer, ".", 2);
1648
1649   g_return_if_fail (split[0] != NULL);
1650   g_return_if_fail (split[1] != NULL);
1651
1652   grandparent = gst_object_get_parent (parent);
1653
1654   if (grandparent && GST_IS_BIN (grandparent)) {
1655     target = gst_bin_get_by_name_recurse_up (GST_BIN (grandparent), split[0]);
1656   }
1657   else
1658     goto cleanup;
1659
1660   if (target == NULL) goto cleanup;
1661
1662   targetpad = gst_element_get_pad (target, split[1]);
1663
1664   if (targetpad == NULL) goto cleanup;
1665
1666   gst_pad_connect (pad, targetpad);
1667
1668 cleanup:
1669   g_strfreev (split);
1670 }
1671
1672 /**
1673  * gst_pad_save_thyself:
1674  * @pad: the pad to save
1675  * @parent: the parent XML node to save the description in
1676  *
1677  * Saves the pad into an xml representation
1678  *
1679  * Returns: the xml representation of the pad
1680  */
1681 static xmlNodePtr
1682 gst_pad_save_thyself (GstObject *object,
1683                       xmlNodePtr parent)
1684 {
1685   GstRealPad *realpad;
1686   GstPad *peer;
1687
1688   g_return_val_if_fail (GST_IS_REAL_PAD (object), NULL);
1689
1690   realpad = GST_REAL_PAD(object);
1691
1692   xmlNewChild(parent,NULL,"name", GST_PAD_NAME (realpad));
1693   if (GST_RPAD_PEER(realpad) != NULL) {
1694     peer = GST_PAD(GST_RPAD_PEER(realpad));
1695     /* first check to see if the peer's parent's parent is the same */
1696     /* we just save it off */
1697     xmlNewChild(parent,NULL,"peer",g_strdup_printf("%s.%s",
1698                     GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer)));
1699   } else
1700     xmlNewChild(parent,NULL,"peer","");
1701
1702   return parent;
1703 }
1704
1705 /**
1706  * gst_pad_ghost_save_thyself:
1707  * @pad: the pad to save
1708  * @bin: the bin
1709  * @parent: the parent XML node to save the description in
1710  *
1711  * Saves the ghost pad into an xml representation.
1712  *
1713  * Returns: the xml representation of the pad
1714  */
1715 xmlNodePtr
1716 gst_pad_ghost_save_thyself (GstPad *pad,
1717                             GstElement *bin,
1718                             xmlNodePtr parent)
1719 {
1720   xmlNodePtr self;
1721
1722   g_return_val_if_fail (GST_IS_GHOST_PAD (pad), NULL);
1723
1724   self = xmlNewChild (parent, NULL, "ghostpad", NULL);
1725   xmlNewChild (self, NULL, "name", GST_PAD_NAME (pad));
1726   xmlNewChild (self, NULL, "parent", GST_OBJECT_NAME (GST_PAD_PARENT (pad)));
1727
1728   /* FIXME FIXME FIXME! */
1729
1730   return self;
1731 }
1732 #endif /* GST_DISABLE_LOADSAVE */
1733
1734 #ifndef gst_pad_push
1735 /**
1736  * gst_pad_push:
1737  * @pad: the pad to push
1738  * @buf: the buffer to push
1739  *
1740  * Push a buffer to the peer of the pad.
1741  */
1742 void 
1743 gst_pad_push (GstPad *pad, GstBuffer *buf) 
1744 {
1745   GstRealPad *peer = GST_RPAD_PEER (pad);
1746
1747   GST_DEBUG_ENTER ("(%s:%s)", GST_DEBUG_PAD_NAME (pad));
1748
1749   g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC);
1750
1751   if (!peer) {
1752     g_warning ("push on pad %s:%s but it is unconnected", GST_DEBUG_PAD_NAME (pad));
1753   }
1754   else {
1755     if (peer->chainhandler) {
1756       if (buf) {
1757         GST_DEBUG (GST_CAT_DATAFLOW, "calling chainhandler &%s of peer pad %s:%s",
1758             GST_DEBUG_FUNCPTR_NAME (peer->chainhandler), GST_DEBUG_PAD_NAME (GST_PAD (peer)));
1759         (peer->chainhandler) (GST_PAD_CAST (peer), buf);
1760         return;
1761       }
1762       else {
1763         g_warning ("trying to push a NULL buffer on pad %s:%s", GST_DEBUG_PAD_NAME (peer));
1764         return;
1765       }
1766     } 
1767     else {
1768       g_warning ("(internal error) push on pad %s:%s but it has no chainhandler", GST_DEBUG_PAD_NAME (peer));
1769     }
1770   }
1771   /* clean up the mess here */
1772   if (buf != NULL) {
1773     if (GST_IS_BUFFER (buf))
1774       gst_buffer_unref (buf);
1775     else
1776       gst_event_free (GST_EVENT (buf));
1777   }
1778 }
1779 #endif
1780
1781 #ifndef gst_pad_pull
1782 /**
1783  * gst_pad_pull:
1784  * @pad: the pad to pull
1785  *
1786  * Pull a buffer from the peer pad.
1787  *
1788  * Returns: a new buffer from the peer pad.
1789  */
1790 GstBuffer*
1791 gst_pad_pull (GstPad *pad) 
1792 {
1793   GstRealPad *peer = GST_RPAD_PEER(pad);
1794   
1795   GST_DEBUG_ENTER("(%s:%s)",GST_DEBUG_PAD_NAME(pad));
1796
1797   g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK, NULL);
1798
1799   if (!peer) {
1800     gst_element_error (GST_PAD_PARENT (pad), 
1801                     "pull on pad %s:%s but it was unconnected", 
1802                     GST_ELEMENT_NAME (GST_PAD_PARENT (pad)), GST_PAD_NAME (pad),
1803                     NULL);
1804   }
1805   else {
1806     if (peer->gethandler) {
1807       GstBuffer *buf;
1808
1809       GST_DEBUG (GST_CAT_DATAFLOW, "calling gethandler %s of peer pad %s:%s",
1810         GST_DEBUG_FUNCPTR_NAME (peer->gethandler), GST_DEBUG_PAD_NAME (peer));
1811
1812       buf = (peer->gethandler) (GST_PAD_CAST (peer));
1813       if (buf)
1814         return buf;
1815       /* no null buffers allowed */
1816       gst_element_error (GST_PAD_PARENT (pad), 
1817                     "NULL buffer during pull on %s:%s", GST_DEBUG_PAD_NAME (pad), NULL);
1818           
1819     } else {
1820       gst_element_error (GST_PAD_PARENT (pad), 
1821                     "(internal error) pull on pad %s:%s but the peer pad %s:%s has no gethandler", 
1822                     GST_DEBUG_PAD_NAME (pad), GST_DEBUG_PAD_NAME (peer),
1823                     NULL);
1824     }
1825   }
1826   return NULL;
1827 }
1828 #endif
1829
1830 #ifndef gst_pad_pullregion
1831 /**
1832  * gst_pad_pullregion:
1833  * @pad: the pad to pull the region from
1834  * @type: the regiontype
1835  * @offset: the offset/start of the buffer to pull
1836  * @len: the length of the buffer to pull
1837  *
1838  * Pull a buffer region from the peer pad. The region to pull can be 
1839  * specified with a offset/lenght pair or with a start/legnth time
1840  * indicator as specified by the type parameter.
1841  *
1842  * Returns: a new buffer from the peer pad with data in the specified
1843  * region.
1844  */
1845 GstBuffer*
1846 gst_pad_pullregion (GstPad *pad, GstRegionType type, guint64 offset, guint64 len) 
1847 {
1848   GstRealPad *peer;
1849   GstBuffer *result = NULL;
1850   
1851   g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK, NULL);
1852
1853   do {
1854     peer = GST_RPAD_PEER(pad);
1855     g_return_val_if_fail (peer != NULL, NULL);
1856
1857     if (result) 
1858       gst_buffer_unref (result);
1859
1860     GST_DEBUG_ENTER("(%s:%s,%d,%lld,%lld)",GST_DEBUG_PAD_NAME(pad),type,offset,len);
1861
1862     if (peer->pullregionfunc) {
1863       GST_DEBUG (GST_CAT_DATAFLOW, "calling pullregionfunc &%s of peer pad %s:%s",
1864           GST_DEBUG_FUNCPTR_NAME (peer->pullregionfunc), GST_DEBUG_PAD_NAME(GST_PAD_CAST (peer)));
1865       result = (peer->pullregionfunc) (GST_PAD_CAST (peer), type, offset, len);
1866     } else {
1867       GST_DEBUG (GST_CAT_DATAFLOW,"no pullregionfunc");
1868       result = NULL;
1869       break;
1870     }
1871   }
1872   /* FIXME */
1873   while (result && !(GST_BUFFER_OFFSET (result) == offset && 
1874            GST_BUFFER_SIZE (result) == len));
1875
1876   return result;
1877 }
1878 #endif
1879
1880 /**
1881  * gst_pad_peek:
1882  * @pad: the pad to peek
1883  *
1884  * Peek for a buffer from the peer pad.
1885  *
1886  * Returns: a from the peer pad or NULL if the peer has no buffer.
1887  */
1888 GstBuffer*
1889 gst_pad_peek (GstPad *pad)
1890 {
1891   g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK, NULL);
1892
1893   return GST_RPAD_BUFPEN (GST_RPAD_PEER (pad));
1894 }
1895
1896 /**
1897  * gst_pad_select:
1898  * @padlist: A list of pads 
1899  *
1900  * Wait for a buffer on the list of pads.
1901  *
1902  * Returns: The pad that has a buffer available, use 
1903  * #gst_pad_pull to get the buffer.
1904  */
1905 GstPad*
1906 gst_pad_select (GList *padlist)
1907 {
1908   GstPad *pad;
1909
1910   pad = gst_scheduler_pad_select (GST_PAD_PARENT (padlist->data)->sched, padlist);
1911
1912   return pad;
1913 }
1914
1915 /**
1916  * gst_pad_selectv:
1917  * @pad: The first pad to perform the select on 
1918  * @...: More pads
1919  *
1920  * Wait for a buffer on the given of pads.
1921  *
1922  * Returns: The pad that has a buffer available, use 
1923  * #gst_pad_pull to get the buffer.
1924  */
1925 GstPad*
1926 gst_pad_selectv (GstPad *pad, ...)
1927 {
1928   GstPad *result;
1929   GList *padlist = NULL;
1930   va_list var_args;
1931
1932   if (pad == NULL)
1933     return NULL;
1934
1935   va_start (var_args, pad);
1936
1937   while (pad) {
1938     padlist = g_list_prepend (padlist, pad);
1939     pad = va_arg (var_args, GstPad *);
1940   }
1941   result = gst_pad_select (padlist);
1942   g_list_free (padlist);
1943
1944   va_end (var_args);
1945   
1946   return result;
1947 }
1948
1949 /************************************************************************
1950  *
1951  * templates
1952  *
1953  */
1954 static void             gst_padtemplate_class_init      (GstPadTemplateClass *klass);
1955 static void             gst_padtemplate_init            (GstPadTemplate *templ);
1956
1957 enum {
1958   TEMPL_PAD_CREATED,
1959   /* FILL ME */
1960   TEMPL_LAST_SIGNAL
1961 };
1962
1963 static GstObject *padtemplate_parent_class = NULL;
1964 static guint gst_padtemplate_signals[TEMPL_LAST_SIGNAL] = { 0 };
1965
1966 GType
1967 gst_padtemplate_get_type (void)
1968 {
1969   static GType padtemplate_type = 0;
1970
1971   if (!padtemplate_type) {
1972     static const GTypeInfo padtemplate_info = {
1973       sizeof(GstPadTemplateClass),
1974       NULL,
1975       NULL,
1976       (GClassInitFunc)gst_padtemplate_class_init,
1977       NULL,
1978       NULL,
1979       sizeof(GstPadTemplate),
1980       32,
1981       (GInstanceInitFunc)gst_padtemplate_init,
1982       NULL
1983     };
1984     padtemplate_type = g_type_register_static(GST_TYPE_OBJECT, "GstPadTemplate", &padtemplate_info, 0);
1985   }
1986   return padtemplate_type;
1987 }
1988
1989 static void
1990 gst_padtemplate_class_init (GstPadTemplateClass *klass)
1991 {
1992   GObjectClass *gobject_class;
1993   GstObjectClass *gstobject_class;
1994
1995   gobject_class = (GObjectClass*)klass;
1996   gstobject_class = (GstObjectClass*)klass;
1997
1998   padtemplate_parent_class = g_type_class_ref(GST_TYPE_OBJECT);
1999
2000   gst_padtemplate_signals[TEMPL_PAD_CREATED] =
2001     g_signal_new ("pad_created", G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST,
2002                     G_STRUCT_OFFSET (GstPadTemplateClass, pad_created), NULL, NULL,
2003                     gst_marshal_VOID__POINTER, G_TYPE_NONE, 1,
2004                     G_TYPE_POINTER);
2005
2006
2007   gstobject_class->path_string_separator = "*";
2008 }
2009
2010 static void
2011 gst_padtemplate_init (GstPadTemplate *templ)
2012 {
2013 }
2014
2015 /* ALWAYS padtemplates cannot have conversion specifications, it doesn't make
2016  * sense.
2017  * SOMETIMES padtemplates can do whatever they want, they are provided by the
2018  * element.
2019  * REQUEST padtemplates can be reverse-parsed (the user asks for 'sink1', the
2020  * 'sink%d' template is automatically selected), so we need to restrict their
2021  * naming.
2022  */
2023 static gboolean
2024 name_is_valid (const gchar *name, GstPadPresence presence)
2025 {
2026   const gchar *str;
2027   
2028   if (presence == GST_PAD_ALWAYS) {
2029     if (strchr (name, '%')) {
2030       g_warning ("invalid name template %s: conversion specifications are not"
2031                  " allowed for GST_PAD_ALWAYS padtemplates", name);
2032       return FALSE;
2033     }
2034   } else if (presence == GST_PAD_REQUEST) {
2035     if ((str = strchr (name, '%')) && strchr (str + 1, '%')) {
2036       g_warning ("invalid name template %s: only one conversion specification"
2037                  " allowed in GST_PAD_REQUEST padtemplate", name);
2038       return FALSE;
2039     }
2040     if (str && (*(str+1) != 's' && *(str+1) != 'd')) {
2041       g_warning ("invalid name template %s: conversion specification must be of"
2042                  " type '%%d' or '%%s' for GST_PAD_REQUEST padtemplate", name);
2043       return FALSE;
2044     }
2045     if (str && (*(str+2) != '\0')) {
2046       g_warning ("invalid name template %s: conversion specification must appear"
2047                  " at the end of the GST_PAD_REQUEST padtemplate name", name);
2048       return FALSE;
2049     }
2050   }
2051   
2052   return TRUE;
2053 }
2054
2055 /**
2056  * gst_padtemplate_new:
2057  * @name_template: the name template
2058  * @direction: the direction for the template
2059  * @presence: the presence of the pad
2060  * @caps: a list of capabilities for the template
2061  * @...: more capabilities
2062  *
2063  * Creates a new padtemplate from the given arguments.
2064  *
2065  * Returns: the new padtemplate
2066  */
2067 GstPadTemplate*
2068 gst_padtemplate_new (gchar *name_template,
2069                      GstPadDirection direction, GstPadPresence presence,
2070                      GstCaps *caps, ...)
2071 {
2072   GstPadTemplate *new;
2073   va_list var_args;
2074   GstCaps *thecaps = NULL;
2075
2076   g_return_val_if_fail (name_template != NULL, NULL);
2077
2078   if (!name_is_valid (name_template, presence))
2079     return NULL;
2080
2081   new = g_object_new(gst_padtemplate_get_type () ,NULL);
2082
2083   GST_PADTEMPLATE_NAME_TEMPLATE (new) = name_template;
2084   GST_PADTEMPLATE_DIRECTION (new) = direction;
2085   GST_PADTEMPLATE_PRESENCE (new) = presence;
2086
2087   va_start (var_args, caps);
2088
2089   while (caps) {
2090     new->fixed &= caps->fixed;
2091     thecaps = gst_caps_append (thecaps, caps);
2092     caps = va_arg (var_args, GstCaps*);
2093   }
2094   va_end (var_args);
2095   
2096   GST_PADTEMPLATE_CAPS (new) = thecaps;
2097
2098   return new;
2099 }
2100
2101 /**
2102  * gst_padtemplate_get_caps:
2103  * @templ: the padtemplate to use
2104  *
2105  * Get the capabilities of the padtemplate
2106  *
2107  * Returns: a GstCaps*
2108  */
2109 GstCaps*
2110 gst_padtemplate_get_caps (GstPadTemplate *templ)
2111 {
2112   g_return_val_if_fail (templ != NULL, NULL);
2113
2114   return GST_PADTEMPLATE_CAPS (templ);
2115 }
2116
2117 #ifndef GST_DISABLE_LOADSAVE
2118 /**
2119  * gst_padtemplate_save_thyself:
2120  * @templ: the padtemplate to save
2121  * @parent: the parent XML tree
2122  *
2123  * Saves the padtemplate into XML.
2124  *
2125  * Returns: the new XML tree
2126  */
2127 xmlNodePtr
2128 gst_padtemplate_save_thyself (GstPadTemplate *templ, xmlNodePtr parent)
2129 {
2130   xmlNodePtr subtree;
2131   guchar *presence;
2132
2133   GST_DEBUG (GST_CAT_XML,"saving padtemplate %s", templ->name_template);
2134
2135   xmlNewChild(parent,NULL,"nametemplate", templ->name_template);
2136   xmlNewChild(parent,NULL,"direction", (templ->direction == GST_PAD_SINK? "sink":"src"));
2137
2138   switch (templ->presence) {
2139     case GST_PAD_ALWAYS:
2140       presence = "always";
2141       break;
2142     case GST_PAD_SOMETIMES:
2143       presence = "sometimes";
2144       break;
2145     case GST_PAD_REQUEST:
2146       presence = "request";
2147       break;
2148     default:
2149       presence = "unknown";
2150       break;
2151   }
2152   xmlNewChild(parent,NULL,"presence", presence);
2153
2154   if (GST_PADTEMPLATE_CAPS (templ)) {
2155     subtree = xmlNewChild (parent, NULL, "caps", NULL);
2156     gst_caps_save_thyself (GST_PADTEMPLATE_CAPS (templ), subtree);
2157   }
2158
2159   return parent;
2160 }
2161
2162 /**
2163  * gst_padtemplate_load_thyself:
2164  * @parent: the source XML tree
2165  *
2166  * Loads a padtemplate from the XML tree.
2167  *
2168  * Returns: the new padtemplate
2169  */
2170 GstPadTemplate*
2171 gst_padtemplate_load_thyself (xmlNodePtr parent)
2172 {
2173   xmlNodePtr field = parent->xmlChildrenNode;
2174   GstPadTemplate *factory;
2175   gchar *name_template = NULL;
2176   GstPadDirection direction = GST_PAD_UNKNOWN;
2177   GstPadPresence presence = GST_PAD_ALWAYS;
2178   GstCaps *caps = NULL;
2179
2180   while (field) {
2181     if (!strcmp(field->name, "nametemplate")) {
2182       name_template = xmlNodeGetContent(field);
2183     }
2184     if (!strcmp(field->name, "direction")) {
2185       gchar *value = xmlNodeGetContent(field);
2186
2187       if (!strcmp(value, "sink")) {
2188         direction = GST_PAD_SINK;
2189       }
2190       else if (!strcmp(value, "src")) {
2191         direction = GST_PAD_SRC;
2192       }
2193       g_free (value);
2194     }
2195     if (!strcmp(field->name, "presence")) {
2196       gchar *value = xmlNodeGetContent(field);
2197
2198       if (!strcmp(value, "always")) {
2199         presence = GST_PAD_ALWAYS;
2200       }
2201       else if (!strcmp(value, "sometimes")) {
2202         presence = GST_PAD_SOMETIMES;
2203       }
2204       else if (!strcmp(value, "request")) {
2205         presence = GST_PAD_REQUEST;
2206       }
2207       g_free (value);
2208     }
2209     else if (!strcmp(field->name, "caps")) {
2210       caps = gst_caps_load_thyself (field);
2211     }
2212     field = field->next;
2213   }
2214
2215   factory = gst_padtemplate_new (name_template, direction, presence, caps, NULL);
2216
2217   return factory;
2218 }
2219 #endif /* !GST_DISABLE_LOADSAVE */
2220
2221
2222 /**
2223  * gst_pad_set_element_private:
2224  * @pad: the pad to set the private data to
2225  * @priv: The private data to attach to the pad
2226  *
2227  * Set the given private data pointer to the pad. This
2228  * function can only be used by the element that own the
2229  * pad.
2230  */
2231 void
2232 gst_pad_set_element_private (GstPad *pad, gpointer priv)
2233 {
2234   pad->element_private = priv;
2235 }
2236
2237 /**
2238  * gst_pad_get_element_private:
2239  * @pad: the pad to get the private data of
2240  *
2241  * Get the private data of a pad. The private data can
2242  * only be set by the parent element of this pad.
2243  *
2244  * Returns: a pointer to the private data.
2245  */
2246 gpointer
2247 gst_pad_get_element_private (GstPad *pad)
2248 {
2249   return pad->element_private;
2250 }
2251
2252
2253 /***** ghost pads *****/
2254 GType _gst_ghost_pad_type = 0;
2255
2256 static void     gst_ghost_pad_class_init         (GstGhostPadClass *klass);
2257 static void     gst_ghost_pad_init               (GstGhostPad *pad);
2258
2259 static GstPad *ghost_pad_parent_class = NULL;
2260 /* static guint gst_ghost_pad_signals[LAST_SIGNAL] = { 0 }; */
2261
2262 GType
2263 gst_ghost_pad_get_type (void) 
2264 {
2265   if (!_gst_ghost_pad_type) {
2266     static const GTypeInfo pad_info = {
2267       sizeof (GstGhostPadClass),
2268       NULL,
2269       NULL,
2270       (GClassInitFunc) gst_ghost_pad_class_init,
2271       NULL,
2272       NULL,
2273       sizeof(GstGhostPad),
2274       8,
2275       (GInstanceInitFunc) gst_ghost_pad_init,
2276       NULL
2277     };
2278     _gst_ghost_pad_type = g_type_register_static (GST_TYPE_PAD, "GstGhostPad", &pad_info, 0);
2279   }
2280   return _gst_ghost_pad_type;
2281 }
2282
2283 static void
2284 gst_ghost_pad_class_init (GstGhostPadClass *klass)
2285 {
2286   GObjectClass *gobject_class;
2287
2288   gobject_class = (GObjectClass*) klass;
2289
2290   ghost_pad_parent_class = g_type_class_ref (GST_TYPE_PAD);
2291 }
2292
2293 static void
2294 gst_ghost_pad_init (GstGhostPad *pad)
2295 {
2296   pad->realpad = NULL;
2297 }
2298
2299 /**
2300  * gst_ghost_pad_new:
2301  * @name: name of the new ghost pad
2302  * @pad: the pad to create a ghost pad of
2303  *
2304  * Create a new ghost pad associated with the given pad.
2305  *
2306  * Returns: new ghost pad
2307  */
2308 GstPad*
2309 gst_ghost_pad_new (gchar *name,
2310                    GstPad *pad)
2311 {
2312   GstGhostPad *ghostpad;
2313   GstRealPad *realpad;
2314
2315   g_return_val_if_fail (name != NULL, NULL);
2316   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2317
2318   ghostpad = g_object_new (gst_ghost_pad_get_type () ,NULL);
2319   gst_pad_set_name (GST_PAD (ghostpad), name);
2320
2321   realpad = (GstRealPad *) pad;
2322
2323   while (!GST_IS_REAL_PAD (realpad)) {
2324     realpad = GST_PAD_REALIZE (realpad);
2325   }
2326   GST_GPAD_REALPAD (ghostpad) = realpad;
2327   GST_PAD_PADTEMPLATE (ghostpad) = GST_PAD_PADTEMPLATE (pad);
2328
2329   /* add ourselves to the real pad's list of ghostpads */
2330   gst_pad_add_ghost_pad (pad, GST_PAD (ghostpad));
2331
2332   /* FIXME need to ref the real pad here... ? */
2333
2334   GST_DEBUG (GST_CAT_PADS, "created ghost pad \"%s\"", name);
2335
2336   return GST_PAD (ghostpad);
2337 }
2338
2339 static void 
2340 gst_pad_event_default_dispatch (GstPad *pad, GstElement *element, GstEvent *event)
2341 {
2342   GList *pads = element->pads;
2343
2344   while (pads) {
2345     GstPad *eventpad = GST_PAD (pads->data);
2346     pads = g_list_next (pads);
2347
2348     /* for all pads in the opposite direction that are connected */
2349     if (GST_PAD_DIRECTION (eventpad) != GST_PAD_DIRECTION (pad) && GST_PAD_IS_CONNECTED (eventpad)) {
2350       if (GST_PAD_DIRECTION (eventpad) == GST_PAD_SRC) {
2351         gst_pad_push (eventpad, GST_BUFFER (gst_event_copy (event)));
2352       }
2353       else {
2354         GstPad *peerpad = GST_PAD_CAST (GST_RPAD_PEER (eventpad));
2355
2356         gst_pad_send_event (peerpad, gst_event_copy (event));
2357       }
2358     }
2359   }
2360 }
2361
2362 /**
2363  * gst_pad_event_default:
2364  * @pad: the pad to operate on
2365  * @event: the event to handle
2366  *
2367  * Invoke the default event handler for the given pad.
2368  */
2369 void 
2370 gst_pad_event_default (GstPad *pad, GstEvent *event)
2371 {
2372   GstElement *element = GST_PAD_PARENT (pad);
2373
2374   g_signal_emit (G_OBJECT (pad), gst_real_pad_signals[REAL_EVENT_RECEIVED], 0, event);
2375  
2376   switch (GST_EVENT_TYPE (event)) {
2377     case GST_EVENT_EOS:
2378       gst_element_set_eos (element);
2379       gst_pad_event_default_dispatch (pad, element, event);
2380       /* we have to try to schedule another element because this one is disabled */
2381       gst_element_yield (element);
2382       break;
2383     case GST_EVENT_FLUSH:
2384     default:
2385       gst_pad_event_default_dispatch (pad, element, event);
2386       break;
2387   }
2388 }
2389
2390 /**
2391  * gst_pad_send_event:
2392  * @pad: the pad to send the event to
2393  * @event: the event to send to the pad.
2394  *
2395  * Send the event to the pad.
2396  *
2397  * Returns: TRUE if the event was handled.
2398  */
2399 gboolean
2400 gst_pad_send_event (GstPad *pad, GstEvent *event)
2401 {
2402   gboolean handled = FALSE;
2403
2404   g_return_val_if_fail (event, FALSE);
2405
2406   if (GST_EVENT_SRC (event) == NULL)
2407     GST_EVENT_SRC (event) = gst_object_ref (GST_OBJECT (pad));
2408
2409   GST_DEBUG (GST_CAT_EVENT, "have event %d on pad %s:%s",
2410                   GST_EVENT_TYPE (event), GST_DEBUG_PAD_NAME (pad));
2411
2412   if (GST_RPAD_EVENTFUNC (pad))
2413     handled = GST_RPAD_EVENTFUNC (pad) (pad, event);
2414   else {
2415     GST_DEBUG(GST_CAT_EVENT, "there's no event function for pad %s:%s", GST_DEBUG_PAD_NAME (pad));
2416   }
2417
2418   if (!handled) {
2419     GST_DEBUG(GST_CAT_EVENT, "proceeding with default event behavior here");
2420     gst_pad_event_default (pad, event);
2421     handled = TRUE;
2422   }
2423
2424   return handled;
2425 }
2426