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