gst/base/gstbasesink.c: Some more debug.
[platform/upstream/gstreamer.git] / gst / base / gstbasesink.c
1 /* GStreamer
2  * Copyright (C) 2005 Wim Taymans <wim@fluendo.com>
3  *
4  * gstbasesink.c:
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 /**
23  * SECTION:gstbasesink
24  * @short_description: Base class for sink elements
25  * @see_also: #GstBaseTransform, #GstBaseSource
26  *
27  * This class is for elements that do output operations.
28  *
29  * <itemizedlist>
30  *   <listitem><para>one sinkpad</para></listitem>
31  *   <listitem><para>handles state changes</para></listitem>
32  *   <listitem><para>pull/push mode</para></listitem>
33  *   <listitem><para>handles seeking/query</para></listitem>
34  *   <listitem><para>handles preroll</para></listitem>
35  *   <listitem><para>EOS handling</para></listitem>
36  * </itemizedlist>
37  */
38
39 #ifdef HAVE_CONFIG_H
40 #  include "config.h"
41 #endif
42
43 #include "gstbasesink.h"
44 #include <gst/gstmarshal.h>
45 #include <gst/gst-i18n-lib.h>
46
47 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
48 #define GST_CAT_DEFAULT gst_base_sink_debug
49
50 /* BaseSink signals and properties */
51 enum
52 {
53   /* FILL ME */
54   SIGNAL_HANDOFF,
55   LAST_SIGNAL
56 };
57
58 #define DEFAULT_SIZE 1024
59 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
60 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
61
62 #define DEFAULT_SYNC TRUE
63
64 enum
65 {
66   PROP_0,
67   PROP_PREROLL_QUEUE_LEN,
68   PROP_SYNC
69 };
70
71 static GstElementClass *parent_class = NULL;
72
73 static void gst_base_sink_base_init (gpointer g_class);
74 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
75 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
76 static void gst_base_sink_finalize (GObject * object);
77
78 GType
79 gst_base_sink_get_type (void)
80 {
81   static GType base_sink_type = 0;
82
83   if (!base_sink_type) {
84     static const GTypeInfo base_sink_info = {
85       sizeof (GstBaseSinkClass),
86       (GBaseInitFunc) gst_base_sink_base_init,
87       NULL,
88       (GClassInitFunc) gst_base_sink_class_init,
89       NULL,
90       NULL,
91       sizeof (GstBaseSink),
92       0,
93       (GInstanceInitFunc) gst_base_sink_init,
94     };
95
96     base_sink_type = g_type_register_static (GST_TYPE_ELEMENT,
97         "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
98   }
99   return base_sink_type;
100 }
101
102 static void gst_base_sink_set_clock (GstElement * element, GstClock * clock);
103
104 static void gst_base_sink_set_property (GObject * object, guint prop_id,
105     const GValue * value, GParamSpec * pspec);
106 static void gst_base_sink_get_property (GObject * object, guint prop_id,
107     GValue * value, GParamSpec * pspec);
108
109 static gboolean gst_base_sink_send_event (GstElement * element,
110     GstEvent * event);
111 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
112
113 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
114 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
115 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
116     guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
117 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
118     GstClockTime * start, GstClockTime * end);
119
120 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
121     GstStateChange transition);
122
123 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
124 static void gst_base_sink_loop (GstPad * pad);
125 static gboolean gst_base_sink_activate (GstPad * pad);
126 static gboolean gst_base_sink_activate_push (GstPad * pad, gboolean active);
127 static gboolean gst_base_sink_activate_pull (GstPad * pad, gboolean active);
128 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
129 static inline GstFlowReturn gst_base_sink_handle_buffer (GstBaseSink * basesink,
130     GstBuffer * buf);
131 static inline gboolean gst_base_sink_handle_event (GstBaseSink * basesink,
132     GstEvent * event);
133
134 static void
135 gst_base_sink_base_init (gpointer g_class)
136 {
137   GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
138       "basesink element");
139 }
140
141 static void
142 gst_base_sink_class_init (GstBaseSinkClass * klass)
143 {
144   GObjectClass *gobject_class;
145   GstElementClass *gstelement_class;
146
147   gobject_class = (GObjectClass *) klass;
148   gstelement_class = (GstElementClass *) klass;
149
150   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
151
152   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_sink_finalize);
153   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property);
154   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_sink_get_property);
155
156   /* FIXME, this next value should be configured using an event from the
157    * upstream element */
158   g_object_class_install_property (G_OBJECT_CLASS (klass),
159       PROP_PREROLL_QUEUE_LEN,
160       g_param_spec_uint ("preroll-queue-len", "preroll-queue-len",
161           "Number of buffers to queue during preroll", 0, G_MAXUINT, 0,
162           G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
163   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SYNC,
164       g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
165           G_PARAM_READWRITE));
166
167   gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_base_sink_set_clock);
168   gstelement_class->change_state =
169       GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
170   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
171   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
172
173   klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
174   klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
175   klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
176   klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
177 }
178
179 static GstCaps *
180 gst_base_sink_pad_getcaps (GstPad * pad)
181 {
182   GstBaseSinkClass *bclass;
183   GstBaseSink *bsink;
184   GstCaps *caps = NULL;
185
186   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
187   bclass = GST_BASE_SINK_GET_CLASS (bsink);
188   if (bclass->get_caps)
189     caps = bclass->get_caps (bsink);
190
191   if (caps == NULL) {
192     GstPadTemplate *pad_template;
193
194     pad_template =
195         gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
196     if (pad_template != NULL) {
197       caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
198     }
199   }
200   gst_object_unref (bsink);
201
202   return caps;
203 }
204
205 static gboolean
206 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
207 {
208   GstBaseSinkClass *bclass;
209   GstBaseSink *bsink;
210   gboolean res = FALSE;
211
212   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
213   bclass = GST_BASE_SINK_GET_CLASS (bsink);
214
215   if (bclass->set_caps)
216     res = bclass->set_caps (bsink, caps);
217
218   gst_object_unref (bsink);
219
220   return res;
221 }
222
223 static GstFlowReturn
224 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
225     GstCaps * caps, GstBuffer ** buf)
226 {
227   GstBaseSinkClass *bclass;
228   GstBaseSink *bsink;
229   GstFlowReturn result = GST_FLOW_OK;
230
231   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
232   bclass = GST_BASE_SINK_GET_CLASS (bsink);
233
234   if (bclass->buffer_alloc)
235     result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
236   else
237     *buf = NULL;                /* fallback in gstpad.c will allocate generic buffer */
238
239   gst_object_unref (bsink);
240
241   return result;
242 }
243
244 static void
245 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
246 {
247   GstPadTemplate *pad_template;
248
249   pad_template =
250       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
251   g_return_if_fail (pad_template != NULL);
252
253   basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
254
255   gst_pad_set_getcaps_function (basesink->sinkpad,
256       GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps));
257   gst_pad_set_setcaps_function (basesink->sinkpad,
258       GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps));
259   gst_pad_set_bufferalloc_function (basesink->sinkpad,
260       GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc));
261   gst_pad_set_activate_function (basesink->sinkpad,
262       GST_DEBUG_FUNCPTR (gst_base_sink_activate));
263   gst_pad_set_activatepush_function (basesink->sinkpad,
264       GST_DEBUG_FUNCPTR (gst_base_sink_activate_push));
265   gst_pad_set_activatepull_function (basesink->sinkpad,
266       GST_DEBUG_FUNCPTR (gst_base_sink_activate_pull));
267   gst_pad_set_event_function (basesink->sinkpad,
268       GST_DEBUG_FUNCPTR (gst_base_sink_event));
269   gst_pad_set_chain_function (basesink->sinkpad,
270       GST_DEBUG_FUNCPTR (gst_base_sink_chain));
271   gst_element_add_pad (GST_ELEMENT (basesink), basesink->sinkpad);
272
273   basesink->pad_mode = GST_ACTIVATE_NONE;
274   GST_PAD_TASK (basesink->sinkpad) = NULL;
275   basesink->preroll_queue = g_queue_new ();
276
277   basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
278   basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
279
280   basesink->sync = DEFAULT_SYNC;
281
282   GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
283 }
284
285 static void
286 gst_base_sink_finalize (GObject * object)
287 {
288   GstBaseSink *basesink;
289
290   basesink = GST_BASE_SINK (object);
291
292   g_queue_free (basesink->preroll_queue);
293
294   G_OBJECT_CLASS (parent_class)->finalize (object);
295 }
296
297 static void
298 gst_base_sink_set_clock (GstElement * element, GstClock * clock)
299 {
300   GstBaseSink *sink;
301
302   sink = GST_BASE_SINK (element);
303
304   sink->clock = clock;
305 }
306
307 static void
308 gst_base_sink_set_property (GObject * object, guint prop_id,
309     const GValue * value, GParamSpec * pspec)
310 {
311   GstBaseSink *sink = GST_BASE_SINK (object);
312
313   switch (prop_id) {
314     case PROP_PREROLL_QUEUE_LEN:
315       /* preroll lock necessary to serialize with finish_preroll */
316       GST_PREROLL_LOCK (sink->sinkpad);
317       sink->preroll_queue_max_len = g_value_get_uint (value);
318       GST_PREROLL_UNLOCK (sink->sinkpad);
319       break;
320     case PROP_SYNC:
321       sink->sync = g_value_get_boolean (value);
322       break;
323     default:
324       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
325       break;
326   }
327 }
328
329 static void
330 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
331     GParamSpec * pspec)
332 {
333   GstBaseSink *sink = GST_BASE_SINK (object);
334
335   GST_LOCK (sink);
336   switch (prop_id) {
337     case PROP_PREROLL_QUEUE_LEN:
338       g_value_set_uint (value, sink->preroll_queue_max_len);
339       break;
340     case PROP_SYNC:
341       g_value_set_boolean (value, sink->sync);
342       break;
343     default:
344       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
345       break;
346   }
347   GST_UNLOCK (sink);
348 }
349
350 static GstCaps *
351 gst_base_sink_get_caps (GstBaseSink * sink)
352 {
353   return NULL;
354 }
355
356 static gboolean
357 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
358 {
359   return TRUE;
360 }
361
362 static GstFlowReturn
363 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
364     GstCaps * caps, GstBuffer ** buf)
365 {
366   *buf = NULL;
367   return GST_FLOW_OK;
368 }
369
370 /* with PREROLL_LOCK */
371 static GstFlowReturn
372 gst_base_sink_preroll_queue_empty (GstBaseSink * basesink, GstPad * pad)
373 {
374   GstMiniObject *obj;
375   GQueue *q = basesink->preroll_queue;
376   GstFlowReturn ret;
377
378   ret = GST_FLOW_OK;
379
380   if (q) {
381     GST_DEBUG_OBJECT (basesink, "emptying queue");
382     while ((obj = g_queue_pop_head (q))) {
383       gboolean is_buffer;
384
385       is_buffer = GST_IS_BUFFER (obj);
386       if (is_buffer) {
387         basesink->preroll_queued--;
388         basesink->buffers_queued--;
389       } else {
390         switch (GST_EVENT_TYPE (obj)) {
391           case GST_EVENT_EOS:
392             basesink->preroll_queued--;
393             break;
394           default:
395             break;
396         }
397         basesink->events_queued--;
398       }
399       /* we release the preroll lock while pushing so that we
400        * can still flush it while blocking on the clock or
401        * inside the element. */
402       GST_PREROLL_UNLOCK (pad);
403
404       if (is_buffer) {
405         GST_DEBUG_OBJECT (basesink, "popped buffer %p", obj);
406         ret = gst_base_sink_handle_buffer (basesink, GST_BUFFER (obj));
407       } else {
408         GST_DEBUG_OBJECT (basesink, "popped event %p", obj);
409         gst_base_sink_handle_event (basesink, GST_EVENT (obj));
410         ret = GST_FLOW_OK;
411       }
412
413       GST_PREROLL_LOCK (pad);
414     }
415     GST_DEBUG_OBJECT (basesink, "queue empty");
416   }
417   return ret;
418 }
419
420 /* with PREROLL_LOCK */
421 static void
422 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
423 {
424   GstMiniObject *obj;
425   GQueue *q = basesink->preroll_queue;
426
427   GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
428   if (q) {
429     while ((obj = g_queue_pop_head (q))) {
430       GST_DEBUG_OBJECT (basesink, "popped %p", obj);
431       gst_mini_object_unref (obj);
432     }
433   }
434   /* we can't have EOS anymore now */
435   basesink->eos = FALSE;
436   basesink->eos_queued = FALSE;
437   basesink->preroll_queued = 0;
438   basesink->buffers_queued = 0;
439   basesink->events_queued = 0;
440   basesink->have_preroll = FALSE;
441   /* and signal any waiters now */
442   GST_PREROLL_SIGNAL (pad);
443 }
444
445 /* with PREROLL_LOCK */
446 static gboolean
447 gst_base_sink_commit_state (GstBaseSink * basesink)
448 {
449   /* commit state and proceed to next pending state */
450   {
451     GstState current, next, pending;
452     GstMessage *message;
453     gboolean post_paused = FALSE;
454     gboolean post_playing = FALSE;
455
456     GST_LOCK (basesink);
457     current = GST_STATE (basesink);
458     next = GST_STATE_NEXT (basesink);
459     pending = GST_STATE_PENDING (basesink);
460
461     switch (pending) {
462       case GST_STATE_PLAYING:
463         basesink->need_preroll = FALSE;
464         post_playing = TRUE;
465         break;
466       case GST_STATE_PAUSED:
467         basesink->need_preroll = TRUE;
468         post_paused = TRUE;
469         break;
470       case GST_STATE_READY:
471         goto stopping;
472       default:
473         break;
474     }
475
476     if (pending != GST_STATE_VOID_PENDING) {
477       GST_STATE (basesink) = pending;
478       GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
479       GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
480       GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
481
482       pending = GST_STATE_VOID_PENDING;
483     }
484     GST_UNLOCK (basesink);
485
486     if (post_paused) {
487       message = gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
488           current, next, GST_STATE_VOID_PENDING);
489       gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
490     }
491     if (post_playing) {
492       message = gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
493           next, pending, GST_STATE_VOID_PENDING);
494       gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
495     }
496     /* and mark dirty */
497     if (post_paused || post_playing) {
498       gst_element_post_message (GST_ELEMENT_CAST (basesink),
499           gst_message_new_state_dirty (GST_OBJECT_CAST (basesink)));
500     }
501
502     GST_STATE_BROADCAST (basesink);
503   }
504   return TRUE;
505
506 stopping:
507   {
508     /* app is going to READY */
509     GST_UNLOCK (basesink);
510     return FALSE;
511   }
512 }
513
514 /* with STREAM_LOCK */
515 static GstFlowReturn
516 gst_base_sink_handle_object (GstBaseSink * basesink, GstPad * pad,
517     GstMiniObject * obj)
518 {
519   gint length;
520   gboolean have_event;
521
522   GST_PREROLL_LOCK (pad);
523   /* push object on the queue */
524   GST_DEBUG_OBJECT (basesink, "push %p on preroll_queue", obj);
525   g_queue_push_tail (basesink->preroll_queue, obj);
526
527   have_event = GST_IS_EVENT (obj);
528   if (have_event) {
529     GstEvent *event = GST_EVENT (obj);
530
531     switch (GST_EVENT_TYPE (obj)) {
532       case GST_EVENT_EOS:
533         basesink->preroll_queued++;
534         basesink->eos = TRUE;
535         basesink->eos_queued = TRUE;
536         break;
537       case GST_EVENT_NEWSEGMENT:
538       {
539         gboolean update;
540         gdouble rate;
541         GstFormat format;
542         gint64 segment_start;
543         gint64 segment_stop;
544         gint64 segment_time;
545         GstClockTime duration;
546
547
548         /* the newsegment event is needed to bring the buffer timestamps to the
549          * stream time and to drop samples outside of the playback segment. */
550         gst_event_parse_newsegment (event, &update, &rate, &format,
551             &segment_start, &segment_stop, &segment_time);
552
553         basesink->have_newsegment = TRUE;
554
555         /* any other format with 0 also gives time 0, the other values are
556          * invalid as time though. */
557         if (format != GST_FORMAT_TIME && segment_start == 0) {
558           GST_DEBUG_OBJECT (basesink,
559               "non-time newsegment with start 0, coaxing into FORMAT_TIME");
560           format = GST_FORMAT_TIME;
561           segment_stop = -1;
562           segment_time = -1;
563         }
564
565         if (format != GST_FORMAT_TIME) {
566           GST_DEBUG_OBJECT (basesink,
567               "received non time %d NEW_SEGMENT %" G_GINT64_FORMAT
568               " -- %" G_GINT64_FORMAT ", time %" G_GINT64_FORMAT,
569               format, segment_start, segment_stop, segment_time);
570
571           /* this means this sink will not be able to clip or drop samples
572            * and timestamps have to start from 0. */
573           basesink->segment_start = -1;
574           basesink->segment_stop = -1;
575           basesink->segment_time = -1;
576           goto done_newsegment;
577         }
578         /* check if we really have a new segment or the previous one is
579          * closed */
580         if (!update) {
581           /* the new segment has to be aligned with the old segment.
582            * We first update the accumulated time of the previous
583            * segment. the accumulated time is used when syncing to the
584            * clock. A flush event sets the accumulated time back to 0
585            */
586           if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
587             duration = basesink->segment_stop - basesink->segment_start;
588           } else if (GST_CLOCK_TIME_IS_VALID (basesink->current_end)) {
589             /* else use last seen timestamp as segment stop */
590             duration = basesink->current_end - basesink->segment_start;
591           } else {
592             duration = 0;
593           }
594         } else {
595           duration = segment_start - basesink->segment_start;
596         }
597
598         /* use previous rate to calculate duration */
599         basesink->segment_accum += gst_gdouble_to_guint64 (
600             (gst_guint64_to_gdouble (duration) / ABS (basesink->segment_rate)));
601         /* then update the current segment */
602         basesink->segment_rate = rate;
603         basesink->segment_start = segment_start;
604         basesink->segment_stop = segment_stop;
605         basesink->segment_time = segment_time;
606
607         GST_DEBUG_OBJECT (basesink,
608             "received NEWSEGMENT %" GST_TIME_FORMAT " -- %"
609             GST_TIME_FORMAT ", time %" GST_TIME_FORMAT ", accum %"
610             GST_TIME_FORMAT,
611             GST_TIME_ARGS (basesink->segment_start),
612             GST_TIME_ARGS (basesink->segment_stop),
613             GST_TIME_ARGS (basesink->segment_time),
614             GST_TIME_ARGS (basesink->segment_accum));
615       done_newsegment:
616         break;
617       }
618       default:
619         break;
620     }
621     basesink->events_queued++;
622   } else {
623     GstBuffer *buf = GST_BUFFER (obj);
624
625     if (!basesink->have_newsegment) {
626       GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
627           (_("Internal data flow problem.")),
628           ("Received buffer without a new-segment. Cannot sync to clock."));
629       basesink->have_newsegment = TRUE;
630       /* this means this sink will not be able to sync to the clock */
631       basesink->segment_start = -1;
632       basesink->segment_stop = -1;
633     }
634
635     /* check if the buffer needs to be dropped */
636     if (TRUE) {
637       GstClockTime start = -1, end = -1;
638
639       /* we don't use the subclassed method as it may not return
640        * valid values for our purpose here */
641       gst_base_sink_get_times (basesink, buf, &start, &end);
642
643       GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
644           ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start),
645           GST_TIME_ARGS (end));
646
647       /* need to drop if the timestamp is not between segment_start and
648        * segment_stop. we check if the complete sample is outside of the
649        * range since the sink might be able to clip the sample. */
650       if (GST_CLOCK_TIME_IS_VALID (end) &&
651           GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) {
652         if (end <= basesink->segment_start) {
653           GST_DEBUG_OBJECT (basesink,
654               "buffer end %" GST_TIME_FORMAT " <= segment start %"
655               GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (end),
656               GST_TIME_ARGS (basesink->segment_start));
657           goto dropping;
658         }
659       }
660       if (GST_CLOCK_TIME_IS_VALID (start) &&
661           GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
662         if (basesink->segment_stop <= start) {
663           GST_DEBUG_OBJECT (basesink,
664               "buffer start %" GST_TIME_FORMAT " >= segment stop %"
665               GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (start),
666               GST_TIME_ARGS (basesink->segment_stop));
667           goto dropping;
668         }
669       }
670     }
671     basesink->preroll_queued++;
672     basesink->buffers_queued++;
673   }
674
675   GST_DEBUG_OBJECT (basesink,
676       "now %d preroll, %d buffers, %d events on queue",
677       basesink->preroll_queued,
678       basesink->buffers_queued, basesink->events_queued);
679
680   /* check if we are prerolling */
681   if (!basesink->need_preroll)
682     goto no_preroll;
683
684   /* there is a buffer queued */
685   if (basesink->buffers_queued == 1) {
686     GST_DEBUG_OBJECT (basesink, "do preroll %p", obj);
687
688     /* if it's a buffer, we need to call the preroll method */
689     if (GST_IS_BUFFER (obj)) {
690       GstBaseSinkClass *bclass;
691       GstFlowReturn pres;
692       GstBuffer *buf = GST_BUFFER (obj);
693
694       GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
695           GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
696
697       bclass = GST_BASE_SINK_GET_CLASS (basesink);
698       if (bclass->preroll)
699         if ((pres = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
700           goto preroll_failed;
701     }
702   }
703   length = basesink->preroll_queued;
704   GST_DEBUG_OBJECT (basesink, "prerolled length %d", length);
705
706   if (length == 1) {
707
708     basesink->have_preroll = TRUE;
709
710     /* commit state */
711     if (!gst_base_sink_commit_state (basesink))
712       goto stopping;
713
714     GST_LOCK (pad);
715     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
716       goto flushing;
717     GST_UNLOCK (pad);
718
719     /* it is possible that commiting the state made us go to PLAYING
720      * now in which case we don't need to block anymore. */
721     if (!basesink->need_preroll)
722       goto no_preroll;
723
724     length = basesink->preroll_queued;
725
726     /* FIXME: a pad probe could have made us lose the buffer, according
727      * to one of the python tests */
728     if (length == 0) {
729       GST_ERROR_OBJECT (basesink,
730           "preroll_queued dropped from 1 to 0 while committing state change");
731     }
732     g_assert (length <= 1);
733   }
734
735   /* see if we need to block now. We cannot block on events, only
736    * on buffers, the reason is that events can be sent from the
737    * application thread and we don't want to block there. */
738   if (length > basesink->preroll_queue_max_len && !have_event) {
739     /* block until the state changes, or we get a flush, or something */
740     GST_DEBUG_OBJECT (basesink, "waiting to finish preroll");
741     GST_PREROLL_WAIT (pad);
742     GST_DEBUG_OBJECT (basesink, "done preroll");
743     GST_LOCK (pad);
744     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
745       goto flushing;
746     GST_UNLOCK (pad);
747   }
748   GST_PREROLL_UNLOCK (pad);
749
750   return GST_FLOW_OK;
751
752 no_preroll:
753   {
754     GstFlowReturn ret;
755
756     GST_DEBUG_OBJECT (basesink, "no preroll needed");
757     /* maybe it was another sink that blocked in preroll, need to check for
758        buffers to drain */
759     basesink->have_preroll = FALSE;
760     ret = gst_base_sink_preroll_queue_empty (basesink, pad);
761     GST_PREROLL_UNLOCK (pad);
762
763     return ret;
764   }
765 dropping:
766   {
767     GstBuffer *buf;
768
769     buf = GST_BUFFER (g_queue_pop_tail (basesink->preroll_queue));
770
771     gst_buffer_unref (buf);
772     GST_PREROLL_UNLOCK (pad);
773
774     return GST_FLOW_OK;
775   }
776 flushing:
777   {
778     GST_UNLOCK (pad);
779     gst_base_sink_preroll_queue_flush (basesink, pad);
780     GST_PREROLL_UNLOCK (pad);
781     GST_DEBUG_OBJECT (basesink, "pad is flushing");
782
783     return GST_FLOW_WRONG_STATE;
784   }
785 stopping:
786   {
787     GST_PREROLL_UNLOCK (pad);
788     GST_DEBUG_OBJECT (basesink, "stopping");
789
790     return GST_FLOW_WRONG_STATE;
791   }
792 preroll_failed:
793   {
794     GST_DEBUG_OBJECT (basesink, "preroll failed");
795     gst_base_sink_preroll_queue_flush (basesink, pad);
796
797     GST_DEBUG_OBJECT (basesink, "abort state");
798     gst_element_abort_state (GST_ELEMENT (basesink));
799
800     return GST_FLOW_ERROR;
801   }
802 }
803
804 static gboolean
805 gst_base_sink_event (GstPad * pad, GstEvent * event)
806 {
807   GstBaseSink *basesink;
808   gboolean result = TRUE;
809   GstBaseSinkClass *bclass;
810
811   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
812
813   bclass = GST_BASE_SINK_GET_CLASS (basesink);
814
815   GST_DEBUG_OBJECT (basesink, "event %p", event);
816
817   switch (GST_EVENT_TYPE (event)) {
818     case GST_EVENT_EOS:
819     {
820       GstFlowReturn ret;
821
822       GST_STREAM_LOCK (pad);
823       /* EOS also finishes the preroll */
824       ret =
825           gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event));
826       GST_STREAM_UNLOCK (pad);
827       break;
828     }
829     case GST_EVENT_NEWSEGMENT:
830     {
831       GstFlowReturn ret;
832
833       GST_STREAM_LOCK (pad);
834       ret =
835           gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event));
836       GST_STREAM_UNLOCK (pad);
837       break;
838     }
839     case GST_EVENT_FLUSH_START:
840       /* make sure we are not blocked on the clock also clear any pending
841        * eos state. */
842       if (bclass->event)
843         bclass->event (basesink, event);
844
845       GST_LOCK (basesink);
846       basesink->flushing = TRUE;
847       if (basesink->clock_id) {
848         gst_clock_id_unschedule (basesink->clock_id);
849       }
850       GST_UNLOCK (basesink);
851
852       GST_PREROLL_LOCK (pad);
853       /* we need preroll after the flush */
854       GST_DEBUG_OBJECT (basesink, "flushing, need preroll after flush");
855       basesink->need_preroll = TRUE;
856       /* unlock from a possible state change/preroll */
857       gst_base_sink_preroll_queue_flush (basesink, pad);
858       GST_PREROLL_UNLOCK (pad);
859
860       /* and we need to commit our state again on the next
861        * prerolled buffer */
862       GST_STREAM_LOCK (pad);
863       gst_element_lost_state (GST_ELEMENT (basesink));
864       GST_STREAM_UNLOCK (pad);
865       GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
866       gst_event_unref (event);
867       break;
868     case GST_EVENT_FLUSH_STOP:
869       if (bclass->event)
870         bclass->event (basesink, event);
871
872       /* now we are completely unblocked and the _chain method
873        * will return */
874       GST_STREAM_LOCK (pad);
875       GST_LOCK (basesink);
876       basesink->flushing = FALSE;
877       GST_UNLOCK (basesink);
878       /* we need new segment info after the flush. */
879       basesink->segment_start = -1;
880       basesink->segment_stop = -1;
881       basesink->current_start = -1;
882       basesink->current_end = -1;
883       GST_DEBUG_OBJECT (basesink, "reset accum %" GST_TIME_FORMAT,
884           GST_TIME_ARGS (basesink->segment_accum));
885       basesink->segment_accum = 0;
886       GST_STREAM_UNLOCK (pad);
887
888       GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
889       gst_event_unref (event);
890       break;
891     default:
892       gst_event_unref (event);
893       break;
894   }
895   gst_object_unref (basesink);
896
897   return result;
898 }
899
900 /* default implementation to calculate the start and end
901  * timestamps on a buffer, subclasses can override
902  */
903 static void
904 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
905     GstClockTime * start, GstClockTime * end)
906 {
907   GstClockTime timestamp, duration;
908
909   timestamp = GST_BUFFER_TIMESTAMP (buffer);
910   if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
911
912     /* get duration to calculate end time */
913     duration = GST_BUFFER_DURATION (buffer);
914     if (GST_CLOCK_TIME_IS_VALID (duration)) {
915       *end = timestamp + duration;
916     }
917     *start = timestamp;
918   }
919 }
920
921 /* with STREAM_LOCK and LOCK*/
922 static GstClockReturn
923 gst_base_sink_wait (GstBaseSink * basesink, GstClockTime time)
924 {
925   GstClockReturn ret;
926   GstClockID id;
927
928   /* no need to attempt a clock wait if we are flushing */
929   if (basesink->flushing) {
930     return GST_CLOCK_UNSCHEDULED;
931   }
932
933   /* clock_id should be NULL outside of this function */
934   g_assert (basesink->clock_id == NULL);
935   g_assert (GST_CLOCK_TIME_IS_VALID (time));
936
937   id = gst_clock_new_single_shot_id (basesink->clock, time);
938
939   basesink->clock_id = id;
940   /* release the object lock while waiting */
941   GST_UNLOCK (basesink);
942
943   ret = gst_clock_id_wait (id, NULL);
944
945   GST_LOCK (basesink);
946   gst_clock_id_unref (id);
947   basesink->clock_id = NULL;
948
949   return ret;
950 }
951
952 /* perform synchronisation on a buffer
953  *
954  * 1) check if we have a clock, if not, do nothing
955  * 2) calculate the start and end time of the buffer
956  * 3) create a single shot notification to wait on
957  *    the clock, save the entry so we can unlock it
958  * 4) wait on the clock, this blocks
959  * 5) unref the clockid again
960  */
961 static GstClockReturn
962 gst_base_sink_do_sync (GstBaseSink * basesink, GstBuffer * buffer)
963 {
964   GstClockReturn result = GST_CLOCK_OK;
965   GstClockTime start, end;
966   GstClockTimeDiff stream_start, stream_end;
967   GstBaseSinkClass *bclass;
968   gboolean start_valid, end_valid;
969
970   bclass = GST_BASE_SINK_GET_CLASS (basesink);
971
972   start = end = -1;
973   if (bclass->get_times)
974     bclass->get_times (basesink, buffer, &start, &end);
975
976   start_valid = GST_CLOCK_TIME_IS_VALID (start);
977   end_valid = GST_CLOCK_TIME_IS_VALID (end);
978
979   GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
980       ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
981
982   /* if we don't have a timestamp, we don't sync */
983   if (!start_valid)
984     goto done;
985
986   /* save last times seen. */
987   basesink->current_start = start;
988   if (end_valid)
989     basesink->current_end = end;
990   else
991     basesink->current_end = start;
992
993   if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
994     /* check if not outside of the segment range, start is
995      * always valid here. */
996     if (start > basesink->segment_stop)
997       goto out_of_segment;
998   }
999
1000   /* bring timestamp to stream time using last segment offset. */
1001   if (GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) {
1002     /* check if not outside of the segment range */
1003     if (end_valid && end < basesink->segment_start)
1004       goto out_of_segment;
1005
1006     stream_start = (gint64) start - basesink->segment_start;
1007     stream_end = (gint64) end - basesink->segment_start;
1008   } else {
1009     stream_start = (gint64) start;
1010     stream_end = (gint64) end;
1011   }
1012
1013   /* correct for rate */
1014   if (basesink->segment_rate != 0.0) {
1015     stream_start /= ABS (basesink->segment_rate);
1016     if (end_valid)
1017       stream_end /= ABS (basesink->segment_rate);
1018   }
1019
1020   stream_start += basesink->segment_accum;
1021   if (end_valid)
1022     stream_end += basesink->segment_accum;
1023
1024   /* now do clocking */
1025   if (basesink->clock && basesink->sync) {
1026     GstClockTime base_time;
1027
1028     GST_LOCK (basesink);
1029
1030     base_time = GST_ELEMENT (basesink)->base_time;
1031
1032     GST_LOG_OBJECT (basesink,
1033         "waiting for clock, base time %" GST_TIME_FORMAT,
1034         GST_TIME_ARGS (base_time));
1035
1036     /* also save end_time of this buffer so that we can wait
1037      * to signal EOS */
1038     if (end_valid)
1039       basesink->end_time = stream_end + base_time;
1040     else
1041       basesink->end_time = GST_CLOCK_TIME_NONE;
1042
1043     result = gst_base_sink_wait (basesink, stream_start + base_time);
1044
1045     GST_UNLOCK (basesink);
1046
1047     GST_LOG_OBJECT (basesink, "clock entry done: %d", result);
1048   }
1049
1050 done:
1051   return result;
1052
1053 out_of_segment:
1054   {
1055     GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1056     return GST_CLOCK_UNSCHEDULED;
1057   }
1058 }
1059
1060
1061 /* handle an event
1062  *
1063  * 2) render the event
1064  * 3) unref the event
1065  */
1066 static inline gboolean
1067 gst_base_sink_handle_event (GstBaseSink * basesink, GstEvent * event)
1068 {
1069   GstBaseSinkClass *bclass;
1070   gboolean ret;
1071
1072   switch (GST_EVENT_TYPE (event)) {
1073     case GST_EVENT_EOS:
1074       GST_LOCK (basesink);
1075       if (basesink->clock) {
1076         /* wait for last buffer to finish if we have a valid end time */
1077         if (GST_CLOCK_TIME_IS_VALID (basesink->end_time)) {
1078           gst_base_sink_wait (basesink, basesink->end_time);
1079           basesink->end_time = GST_CLOCK_TIME_NONE;
1080         }
1081       }
1082       GST_UNLOCK (basesink);
1083       break;
1084     default:
1085       break;
1086   }
1087
1088   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1089   if (bclass->event)
1090     ret = bclass->event (basesink, event);
1091   else
1092     ret = TRUE;
1093
1094   switch (GST_EVENT_TYPE (event)) {
1095     case GST_EVENT_EOS:
1096       GST_PREROLL_LOCK (basesink->sinkpad);
1097       /* if we are still EOS, we can post the EOS message */
1098       if (basesink->eos) {
1099         /* ok, now we can post the message */
1100         GST_DEBUG_OBJECT (basesink, "Now posting EOS");
1101         gst_element_post_message (GST_ELEMENT (basesink),
1102             gst_message_new_eos (GST_OBJECT (basesink)));
1103         basesink->eos_queued = FALSE;
1104       }
1105       GST_PREROLL_UNLOCK (basesink->sinkpad);
1106       break;
1107     default:
1108       break;
1109   }
1110
1111   GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
1112   gst_event_unref (event);
1113
1114   return ret;
1115 }
1116
1117 /* handle a buffer
1118  *
1119  * 1) first sync on the buffer
1120  * 2) render the buffer
1121  * 3) unref the buffer
1122  */
1123 static inline GstFlowReturn
1124 gst_base_sink_handle_buffer (GstBaseSink * basesink, GstBuffer * buf)
1125 {
1126   GstFlowReturn ret = GST_FLOW_OK;
1127   GstClockReturn status;
1128
1129   status = gst_base_sink_do_sync (basesink, buf);
1130   switch (status) {
1131     case GST_CLOCK_EARLY:
1132       GST_DEBUG_OBJECT (basesink, "buffer too late!, rendering anyway");
1133       /* fallthrough for now */
1134     case GST_CLOCK_OK:
1135     {
1136       GstBaseSinkClass *bclass;
1137
1138       bclass = GST_BASE_SINK_GET_CLASS (basesink);
1139       if (bclass->render)
1140         ret = bclass->render (basesink, buf);
1141       break;
1142     }
1143     default:
1144       GST_DEBUG_OBJECT (basesink, "clock returned %d, not rendering", status);
1145       break;
1146   }
1147
1148   GST_DEBUG_OBJECT (basesink, "buffer unref after render %p", basesink, buf);
1149   gst_buffer_unref (buf);
1150
1151   return ret;
1152 }
1153
1154 static GstFlowReturn
1155 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
1156 {
1157   GstBaseSink *basesink;
1158   GstFlowReturn result;
1159
1160   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1161
1162   if (!(basesink->pad_mode == GST_ACTIVATE_PUSH)) {
1163     GST_LOCK (pad);
1164     g_warning ("Push on pad %s:%s, but it was not activated in push mode",
1165         GST_DEBUG_PAD_NAME (pad));
1166     GST_UNLOCK (pad);
1167     result = GST_FLOW_UNEXPECTED;
1168     goto done;
1169   }
1170
1171   result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf));
1172
1173 done:
1174   gst_object_unref (basesink);
1175
1176   return result;
1177 }
1178
1179 static void
1180 gst_base_sink_loop (GstPad * pad)
1181 {
1182   GstBaseSink *basesink;
1183   GstBuffer *buf = NULL;
1184   GstFlowReturn result;
1185
1186   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1187
1188   g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
1189
1190   result = gst_pad_pull_range (pad, basesink->offset, DEFAULT_SIZE, &buf);
1191   if (result != GST_FLOW_OK)
1192     goto paused;
1193
1194   result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf));
1195   if (result != GST_FLOW_OK)
1196     goto paused;
1197
1198   gst_object_unref (basesink);
1199
1200   /* default */
1201   return;
1202
1203 paused:
1204   {
1205     gst_base_sink_event (pad, gst_event_new_eos ());
1206     gst_object_unref (basesink);
1207     gst_pad_pause_task (pad);
1208     return;
1209   }
1210 }
1211
1212 static gboolean
1213 gst_base_sink_deactivate (GstBaseSink * basesink, GstPad * pad)
1214 {
1215   gboolean result = FALSE;
1216   GstBaseSinkClass *bclass;
1217
1218   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1219
1220   /* step 1, unblock clock sync (if any) or any other blocking thing */
1221   GST_PREROLL_LOCK (pad);
1222   GST_LOCK (basesink);
1223   if (basesink->clock_id) {
1224     gst_clock_id_unschedule (basesink->clock_id);
1225   }
1226   GST_UNLOCK (basesink);
1227
1228   /* unlock any subclasses */
1229   if (bclass->unlock)
1230     bclass->unlock (basesink);
1231
1232   /* flush out the data thread if it's locked in finish_preroll */
1233   GST_DEBUG_OBJECT (basesink,
1234       "flushing out data thread, need preroll to FALSE");
1235   basesink->need_preroll = FALSE;
1236   gst_base_sink_preroll_queue_flush (basesink, pad);
1237   GST_PREROLL_SIGNAL (pad);
1238   GST_PREROLL_UNLOCK (pad);
1239
1240   /* step 2, make sure streaming finishes */
1241   result = gst_pad_stop_task (pad);
1242
1243   return result;
1244 }
1245
1246 static gboolean
1247 gst_base_sink_activate (GstPad * pad)
1248 {
1249   gboolean result = FALSE;
1250   GstBaseSink *basesink;
1251
1252   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1253
1254   GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
1255
1256   if (basesink->can_activate_pull && gst_pad_check_pull_range (pad)
1257       && gst_pad_activate_pull (pad, TRUE)) {
1258     GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
1259     result = TRUE;
1260   } else {
1261     GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
1262     if (gst_pad_activate_push (pad, TRUE)) {
1263       GST_DEBUG_OBJECT (basesink, "Success activating push mode");
1264       result = TRUE;
1265     }
1266   }
1267
1268   if (!result) {
1269     GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
1270   }
1271
1272   gst_object_unref (basesink);
1273
1274   return result;
1275 }
1276
1277 static gboolean
1278 gst_base_sink_activate_push (GstPad * pad, gboolean active)
1279 {
1280   gboolean result;
1281   GstBaseSink *basesink;
1282
1283   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1284
1285   if (active) {
1286     if (!basesink->can_activate_push) {
1287       result = FALSE;
1288       basesink->pad_mode = GST_ACTIVATE_NONE;
1289     } else {
1290       result = TRUE;
1291       basesink->pad_mode = GST_ACTIVATE_PUSH;
1292     }
1293   } else {
1294     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
1295       g_warning ("Internal GStreamer activation error!!!");
1296       result = FALSE;
1297     } else {
1298       result = gst_base_sink_deactivate (basesink, pad);
1299       basesink->pad_mode = GST_ACTIVATE_NONE;
1300     }
1301   }
1302
1303   gst_object_unref (basesink);
1304
1305   return result;
1306 }
1307
1308 /* this won't get called until we implement an activate function */
1309 static gboolean
1310 gst_base_sink_activate_pull (GstPad * pad, gboolean active)
1311 {
1312   gboolean result = FALSE;
1313   GstBaseSink *basesink;
1314
1315   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1316
1317   if (active) {
1318     if (!basesink->can_activate_pull) {
1319       result = FALSE;
1320       basesink->pad_mode = GST_ACTIVATE_NONE;
1321     } else {
1322       GstPad *peer = gst_pad_get_peer (pad);
1323
1324       if (G_UNLIKELY (peer == NULL)) {
1325         g_warning ("Trying to activate pad in pull mode, but no peer");
1326         result = FALSE;
1327         basesink->pad_mode = GST_ACTIVATE_NONE;
1328       } else {
1329         if (gst_pad_activate_pull (peer, TRUE)) {
1330           basesink->have_newsegment = TRUE;
1331           basesink->segment_start = basesink->segment_stop = 0;
1332
1333           /* set the pad mode before starting the task so that it's in the
1334              correct state for the new thread... */
1335           basesink->pad_mode = GST_ACTIVATE_PULL;
1336           result =
1337               gst_pad_start_task (pad, (GstTaskFunction) gst_base_sink_loop,
1338               pad);
1339           /* but if starting the thread fails, set it back */
1340           if (!result)
1341             basesink->pad_mode = GST_ACTIVATE_NONE;
1342         } else {
1343           GST_DEBUG_OBJECT (pad, "Failed to activate peer in pull mode");
1344           result = FALSE;
1345           basesink->pad_mode = GST_ACTIVATE_NONE;
1346         }
1347         gst_object_unref (peer);
1348       }
1349     }
1350   } else {
1351     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
1352       g_warning ("Internal GStreamer activation error!!!");
1353       result = FALSE;
1354     } else {
1355       basesink->have_newsegment = FALSE;
1356       result = gst_base_sink_deactivate (basesink, pad);
1357       basesink->pad_mode = GST_ACTIVATE_NONE;
1358     }
1359   }
1360
1361   gst_object_unref (basesink);
1362
1363   return result;
1364 }
1365
1366 static gboolean
1367 gst_base_sink_send_event (GstElement * element, GstEvent * event)
1368 {
1369   GstPad *pad;
1370   GstBaseSink *basesink = GST_BASE_SINK (element);
1371   gboolean result;
1372
1373   GST_LOCK (element);
1374   pad = basesink->sinkpad;
1375   gst_object_ref (pad);
1376   GST_UNLOCK (element);
1377
1378   result = gst_pad_push_event (pad, event);
1379
1380   gst_object_unref (pad);
1381
1382   return result;
1383 }
1384
1385 static gboolean
1386 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
1387 {
1388   GstPad *peer;
1389   gboolean res = FALSE;
1390
1391   if ((peer = gst_pad_get_peer (sink->sinkpad))) {
1392     res = gst_pad_query (peer, query);
1393     gst_object_unref (peer);
1394   }
1395   return res;
1396 }
1397
1398 static gboolean
1399 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
1400     gint64 * cur)
1401 {
1402   GstClock *clock;
1403   gboolean res = FALSE;
1404
1405   switch (format) {
1406     case GST_FORMAT_TIME:
1407     {
1408       /* we can answer time format */
1409       GST_LOCK (basesink);
1410       if ((clock = GST_ELEMENT_CLOCK (basesink))) {
1411         GstClockTime now;
1412         gint64 segment_time;
1413
1414         gst_object_ref (clock);
1415         GST_UNLOCK (basesink);
1416
1417         now = gst_clock_get_time (clock);
1418
1419         GST_LOCK (basesink);
1420         if (GST_CLOCK_TIME_IS_VALID (basesink->segment_time))
1421           segment_time = basesink->segment_time;
1422         else
1423           segment_time = 0;
1424
1425         *cur = now - GST_ELEMENT_CAST (basesink)->base_time + segment_time;
1426
1427         GST_DEBUG_OBJECT (basesink,
1428             "now %" GST_TIME_FORMAT " + segment_time %" GST_TIME_FORMAT " = %"
1429             GST_TIME_FORMAT, GST_TIME_ARGS (now),
1430             GST_TIME_ARGS (segment_time), GST_TIME_ARGS (*cur));
1431
1432         gst_object_unref (clock);
1433
1434         res = TRUE;
1435       }
1436       GST_UNLOCK (basesink);
1437     }
1438     default:
1439       break;
1440   }
1441   return res;
1442 }
1443
1444 static gboolean
1445 gst_base_sink_query (GstElement * element, GstQuery * query)
1446 {
1447   gboolean res = FALSE;
1448
1449   GstBaseSink *basesink = GST_BASE_SINK (element);
1450
1451   switch (GST_QUERY_TYPE (query)) {
1452     case GST_QUERY_POSITION:
1453     {
1454       gint64 cur = 0;
1455       GstFormat format;
1456       gboolean eos;
1457
1458       GST_PREROLL_LOCK (basesink->sinkpad);
1459       eos = basesink->eos;
1460       GST_PREROLL_UNLOCK (basesink->sinkpad);
1461
1462       if (eos) {
1463         res = gst_base_sink_peer_query (basesink, query);
1464       } else {
1465         gst_query_parse_position (query, &format, NULL);
1466
1467         GST_DEBUG_OBJECT (basesink, "current position format %d", format);
1468
1469         if ((res = gst_base_sink_get_position (basesink, format, &cur))) {
1470           gst_query_set_position (query, format, cur);
1471         } else {
1472           res = gst_base_sink_peer_query (basesink, query);
1473         }
1474       }
1475       break;
1476     }
1477     case GST_QUERY_DURATION:
1478       res = gst_base_sink_peer_query (basesink, query);
1479       break;
1480     case GST_QUERY_LATENCY:
1481       break;
1482     case GST_QUERY_JITTER:
1483       break;
1484     case GST_QUERY_RATE:
1485       //gst_query_set_rate (query, basesink->segment_rate);
1486       res = TRUE;
1487       break;
1488     case GST_QUERY_SEGMENT:
1489     {
1490       /* FIXME, bring start/stop to stream time */
1491       gst_query_set_segment (query, basesink->segment_rate,
1492           GST_FORMAT_TIME, basesink->segment_start, basesink->segment_stop);
1493       break;
1494     }
1495     case GST_QUERY_SEEKING:
1496     case GST_QUERY_CONVERT:
1497     case GST_QUERY_FORMATS:
1498     default:
1499       res = gst_base_sink_peer_query (basesink, query);
1500       break;
1501   }
1502   return res;
1503 }
1504
1505 static GstStateChangeReturn
1506 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
1507 {
1508   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1509   GstBaseSink *basesink = GST_BASE_SINK (element);
1510   GstBaseSinkClass *bclass;
1511
1512   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1513
1514   switch (transition) {
1515     case GST_STATE_CHANGE_NULL_TO_READY:
1516       if (bclass->start)
1517         if (!bclass->start (basesink))
1518           goto start_failed;
1519       break;
1520     case GST_STATE_CHANGE_READY_TO_PAUSED:
1521       /* need to complete preroll before this state change completes, there
1522        * is no data flow in READY so we can safely assume we need to preroll. */
1523       basesink->offset = 0;
1524       GST_PREROLL_LOCK (basesink->sinkpad);
1525       basesink->have_preroll = FALSE;
1526       GST_DEBUG_OBJECT (basesink, "READY to PAUSED, need preroll to FALSE");
1527       basesink->need_preroll = TRUE;
1528       GST_PREROLL_UNLOCK (basesink->sinkpad);
1529       basesink->have_newsegment = FALSE;
1530       basesink->segment_rate = 1.0;
1531       basesink->segment_start = 0;
1532       basesink->segment_stop = 0;
1533       basesink->segment_time = 0;
1534       basesink->segment_accum = 0;
1535       ret = GST_STATE_CHANGE_ASYNC;
1536       break;
1537     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1538       GST_PREROLL_LOCK (basesink->sinkpad);
1539       /* no preroll needed */
1540       basesink->need_preroll = FALSE;
1541
1542       /* if we have EOS, we should empty the queue now as there will
1543        * be no more data received in the chain function.
1544        * FIXME, this could block the state change function too long when
1545        * we are pushing and syncing the buffers, better start a new
1546        * thread to do this. */
1547       if (basesink->eos) {
1548         gboolean do_eos = !basesink->eos_queued;
1549
1550         gst_base_sink_preroll_queue_empty (basesink, basesink->sinkpad);
1551
1552         /* need to post EOS message here if it was not in the preroll queue we
1553          * just emptied. */
1554         if (do_eos) {
1555           GST_DEBUG_OBJECT (basesink, "Now posting EOS");
1556           gst_element_post_message (GST_ELEMENT (basesink),
1557               gst_message_new_eos (GST_OBJECT (basesink)));
1558         }
1559       } else if (!basesink->have_preroll) {
1560         /* queue a commit_state */
1561         basesink->need_preroll = TRUE;
1562         GST_DEBUG_OBJECT (basesink,
1563             "PAUSED to PLAYING, !eos, !have_preroll, need preroll to FALSE");
1564         ret = GST_STATE_CHANGE_ASYNC;
1565         /* we know it's not waiting, no need to signal */
1566       } else {
1567         GST_DEBUG_OBJECT (basesink,
1568             "PAUSED to PLAYING, !eos, have_preroll, need preroll to FALSE");
1569         /* now let it play */
1570         GST_PREROLL_SIGNAL (basesink->sinkpad);
1571       }
1572       GST_PREROLL_UNLOCK (basesink->sinkpad);
1573       break;
1574     default:
1575       break;
1576   }
1577
1578   {
1579     GstStateChangeReturn bret;
1580
1581     bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1582     if (bret == GST_STATE_CHANGE_FAILURE)
1583       goto activate_failed;
1584   }
1585
1586   switch (transition) {
1587     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1588     {
1589       GstBaseSinkClass *bclass;
1590
1591       bclass = GST_BASE_SINK_GET_CLASS (basesink);
1592
1593       GST_PREROLL_LOCK (basesink->sinkpad);
1594       GST_LOCK (basesink);
1595       /* unlock clock wait if any */
1596       if (basesink->clock_id) {
1597         gst_clock_id_unschedule (basesink->clock_id);
1598       }
1599       GST_UNLOCK (basesink);
1600
1601       /* unlock any subclasses */
1602       if (bclass->unlock)
1603         bclass->unlock (basesink);
1604
1605       /* if we don't have a preroll buffer and we have not received EOS,
1606        * we need to wait for a preroll */
1607       GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d",
1608           basesink->have_preroll, basesink->eos);
1609       if (!basesink->have_preroll && !basesink->eos
1610           && GST_STATE_PENDING (basesink) == GST_STATE_PAUSED) {
1611         GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, need preroll to TRUE");
1612         basesink->need_preroll = TRUE;
1613         ret = GST_STATE_CHANGE_ASYNC;
1614       }
1615       GST_PREROLL_UNLOCK (basesink->sinkpad);
1616       break;
1617     }
1618     case GST_STATE_CHANGE_PAUSED_TO_READY:
1619       break;
1620     case GST_STATE_CHANGE_READY_TO_NULL:
1621       if (bclass->stop)
1622         if (!bclass->stop (basesink)) {
1623           GST_WARNING ("failed to stop");
1624         }
1625       break;
1626     default:
1627       break;
1628   }
1629
1630   return ret;
1631
1632   /* ERRORS */
1633 start_failed:
1634   {
1635     GST_DEBUG_OBJECT (basesink, "failed to start");
1636     return GST_STATE_CHANGE_FAILURE;
1637   }
1638 activate_failed:
1639   {
1640     GST_DEBUG_OBJECT (basesink,
1641         "element failed to change states -- activation problem?");
1642     return GST_STATE_CHANGE_FAILURE;
1643   }
1644 }