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         /* post PAUSED too when we were READY */
 466         if (current == GST_STATE_READY)
 467           post_paused = TRUE;
 468         break;
 469       case GST_STATE_PAUSED:
 470         basesink->need_preroll = TRUE;
 471         post_paused = TRUE;
 472         break;
 473       case GST_STATE_READY:
 474         goto stopping;
 475       default:
 476         break;
 477     }
 478
 479     if (pending != GST_STATE_VOID_PENDING) {
 480       GST_STATE (basesink) = pending;
 481       GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
 482       GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
 483       GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
 484     }
 485     GST_UNLOCK (basesink);
 486
 487     if (post_paused) {
 488       message = gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
 489           current, next, GST_STATE_VOID_PENDING);
 490       gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
 491     }
 492     if (post_playing) {
 493       message = gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
 494           next, pending, GST_STATE_VOID_PENDING);
 495       gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
 496     }
 497     /* and mark dirty */
 498     if (post_paused || post_playing) {
 499       gst_element_post_message (GST_ELEMENT_CAST (basesink),
 500           gst_message_new_state_dirty (GST_OBJECT_CAST (basesink)));
 501     }
 502
 503     GST_STATE_BROADCAST (basesink);
 504   }
 505   return TRUE;
 506
 507 stopping:
 508   {
 509     /* app is going to READY */
 510     GST_UNLOCK (basesink);
 511     return FALSE;
 512   }
 513 }
 514
 515 /* with STREAM_LOCK */
 516 static GstFlowReturn
 517 gst_base_sink_handle_object (GstBaseSink * basesink, GstPad * pad,
 518     GstMiniObject * obj)
 519 {
 520   gint length;
 521   gboolean have_event;
 522
 523   GST_PREROLL_LOCK (pad);
 524   /* push object on the queue */
 525   GST_DEBUG_OBJECT (basesink, "push %p on preroll_queue", obj);
 526   g_queue_push_tail (basesink->preroll_queue, obj);
 527
 528   have_event = GST_IS_EVENT (obj);
 529   if (have_event) {
 530     GstEvent *event = GST_EVENT (obj);
 531
 532     switch (GST_EVENT_TYPE (obj)) {
 533       case GST_EVENT_EOS:
 534         basesink->preroll_queued++;
 535         basesink->eos = TRUE;
 536         basesink->eos_queued = TRUE;
 537         break;
 538       case GST_EVENT_NEWSEGMENT:
 539       {
 540         gboolean update;
 541         gdouble rate;
 542         GstFormat format;
 543         gint64 segment_start;
 544         gint64 segment_stop;
 545         gint64 segment_time;
 546         GstClockTime duration;
 547
 548
 549         /* the newsegment event is needed to bring the buffer timestamps to the
 550          * stream time and to drop samples outside of the playback segment. */
 551         gst_event_parse_newsegment (event, &update, &rate, &format,
 552             &segment_start, &segment_stop, &segment_time);
 553
 554         basesink->have_newsegment = TRUE;
 555
 556         /* any other format with 0 also gives time 0, the other values are
 557          * invalid as time though. */
 558         if (format != GST_FORMAT_TIME && segment_start == 0) {
 559           GST_DEBUG_OBJECT (basesink,
 560               "non-time newsegment with start 0, coaxing into FORMAT_TIME");
 561           format = GST_FORMAT_TIME;
 562           segment_stop = -1;
 563           segment_time = -1;
 564         }
 565
 566         if (format != GST_FORMAT_TIME) {
 567           GST_DEBUG_OBJECT (basesink,
 568               "received non time %d NEW_SEGMENT %" G_GINT64_FORMAT
 569               " -- %" G_GINT64_FORMAT ", time %" G_GINT64_FORMAT,
 570               format, segment_start, segment_stop, segment_time);
 571
 572           /* this means this sink will not be able to clip or drop samples
 573            * and timestamps have to start from 0. */
 574           basesink->segment_start = -1;
 575           basesink->segment_stop = -1;
 576           basesink->segment_time = -1;
 577           goto done_newsegment;
 578         }
 579         /* check if we really have a new segment or the previous one is
 580          * closed */
 581         if (!update) {
 582           /* the new segment has to be aligned with the old segment.
 583            * We first update the accumulated time of the previous
 584            * segment. the accumulated time is used when syncing to the
 585            * clock. A flush event sets the accumulated time back to 0
 586            */
 587           if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
 588             duration = basesink->segment_stop - basesink->segment_start;
 589           } else if (GST_CLOCK_TIME_IS_VALID (basesink->current_end)) {
 590             /* else use last seen timestamp as segment stop */
 591             duration = basesink->current_end - basesink->segment_start;
 592           } else {
 593             duration = 0;
 594           }
 595         } else {
 596           duration = segment_start - basesink->segment_start;
 597         }
 598
 599         /* use previous rate to calculate duration */
 600         basesink->segment_accum += gst_gdouble_to_guint64 (
 601             (gst_guint64_to_gdouble (duration) / ABS (basesink->segment_rate)));
 602         /* then update the current segment */
 603         basesink->segment_rate = rate;
 604         basesink->segment_start = segment_start;
 605         basesink->segment_stop = segment_stop;
 606         basesink->segment_time = segment_time;
 607
 608         GST_DEBUG_OBJECT (basesink,
 609             "received NEWSEGMENT %" GST_TIME_FORMAT " -- %"
 610             GST_TIME_FORMAT ", time %" GST_TIME_FORMAT ", accum %"
 611             GST_TIME_FORMAT,
 612             GST_TIME_ARGS (basesink->segment_start),
 613             GST_TIME_ARGS (basesink->segment_stop),
 614             GST_TIME_ARGS (basesink->segment_time),
 615             GST_TIME_ARGS (basesink->segment_accum));
 616       done_newsegment:
 617         break;
 618       }
 619       default:
 620         break;
 621     }
 622     basesink->events_queued++;
 623   } else {
 624     GstBuffer *buf = GST_BUFFER (obj);
 625
 626     if (!basesink->have_newsegment) {
 627       GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
 628           (_("Internal data flow problem.")),
 629           ("Received buffer without a new-segment. Cannot sync to clock."));
 630       basesink->have_newsegment = TRUE;
 631       /* this means this sink will not be able to sync to the clock */
 632       basesink->segment_start = -1;
 633       basesink->segment_stop = -1;
 634     }
 635
 636     /* check if the buffer needs to be dropped */
 637     if (TRUE) {
 638       GstClockTime start = -1, end = -1;
 639
 640       /* we don't use the subclassed method as it may not return
 641        * valid values for our purpose here */
 642       gst_base_sink_get_times (basesink, buf, &start, &end);
 643
 644       GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
 645           ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start),
 646           GST_TIME_ARGS (end));
 647
 648       /* need to drop if the timestamp is not between segment_start and
 649        * segment_stop. we check if the complete sample is outside of the
 650        * range since the sink might be able to clip the sample. */
 651       if (GST_CLOCK_TIME_IS_VALID (end) &&
 652           GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) {
 653         if (end <= basesink->segment_start) {
 654           GST_DEBUG_OBJECT (basesink,
 655               "buffer end %" GST_TIME_FORMAT " <= segment start %"
 656               GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (end),
 657               GST_TIME_ARGS (basesink->segment_start));
 658           goto dropping;
 659         }
 660       }
 661       if (GST_CLOCK_TIME_IS_VALID (start) &&
 662           GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
 663         if (basesink->segment_stop <= start) {
 664           GST_DEBUG_OBJECT (basesink,
 665               "buffer start %" GST_TIME_FORMAT " >= segment stop %"
 666               GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (start),
 667               GST_TIME_ARGS (basesink->segment_stop));
 668           goto dropping;
 669         }
 670       }
 671     }
 672     basesink->preroll_queued++;
 673     basesink->buffers_queued++;
 674   }
 675
 676   GST_DEBUG_OBJECT (basesink,
 677       "now %d preroll, %d buffers, %d events on queue",
 678       basesink->preroll_queued,
 679       basesink->buffers_queued, basesink->events_queued);
 680
 681   /* check if we are prerolling */
 682   if (!basesink->need_preroll)
 683     goto no_preroll;
 684
 685   /* there is a buffer queued */
 686   if (basesink->buffers_queued == 1) {
 687     GST_DEBUG_OBJECT (basesink, "do preroll %p", obj);
 688
 689     /* if it's a buffer, we need to call the preroll method */
 690     if (GST_IS_BUFFER (obj)) {
 691       GstBaseSinkClass *bclass;
 692       GstFlowReturn pres;
 693       GstBuffer *buf = GST_BUFFER (obj);
 694
 695       GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
 696           GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
 697
 698       bclass = GST_BASE_SINK_GET_CLASS (basesink);
 699       if (bclass->preroll)
 700         if ((pres = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
 701           goto preroll_failed;
 702     }
 703   }
 704   length = basesink->preroll_queued;
 705   GST_DEBUG_OBJECT (basesink, "prerolled length %d", length);
 706
 707   if (length == 1) {
 708
 709     basesink->have_preroll = TRUE;
 710
 711     /* commit state */
 712     if (!gst_base_sink_commit_state (basesink))
 713       goto stopping;
 714
 715     GST_LOCK (pad);
 716     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
 717       goto flushing;
 718     GST_UNLOCK (pad);
 719
 720     /* it is possible that commiting the state made us go to PLAYING
 721      * now in which case we don't need to block anymore. */
 722     if (!basesink->need_preroll)
 723       goto no_preroll;
 724
 725     length = basesink->preroll_queued;
 726
 727     /* FIXME: a pad probe could have made us lose the buffer, according
 728      * to one of the python tests */
 729     if (length == 0) {
 730       GST_ERROR_OBJECT (basesink,
 731           "preroll_queued dropped from 1 to 0 while committing state change");
 732     }
 733     g_assert (length <= 1);
 734   }
 735
 736   /* see if we need to block now. We cannot block on events, only
 737    * on buffers, the reason is that events can be sent from the
 738    * application thread and we don't want to block there. */
 739   if (length > basesink->preroll_queue_max_len && !have_event) {
 740     /* block until the state changes, or we get a flush, or something */
 741     GST_DEBUG_OBJECT (basesink, "waiting to finish preroll");
 742     GST_PREROLL_WAIT (pad);
 743     GST_DEBUG_OBJECT (basesink, "done preroll");
 744     GST_LOCK (pad);
 745     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
 746       goto flushing;
 747     GST_UNLOCK (pad);
 748   }
 749   GST_PREROLL_UNLOCK (pad);
 750
 751   return GST_FLOW_OK;
 752
 753 no_preroll:
 754   {
 755     GstFlowReturn ret;
 756
 757     GST_DEBUG_OBJECT (basesink, "no preroll needed");
 758     /* maybe it was another sink that blocked in preroll, need to check for
 759        buffers to drain */
 760     basesink->have_preroll = FALSE;
 761     ret = gst_base_sink_preroll_queue_empty (basesink, pad);
 762     GST_PREROLL_UNLOCK (pad);
 763
 764     return ret;
 765   }
 766 dropping:
 767   {
 768     GstBuffer *buf;
 769
 770     buf = GST_BUFFER (g_queue_pop_tail (basesink->preroll_queue));
 771
 772     gst_buffer_unref (buf);
 773     GST_PREROLL_UNLOCK (pad);
 774
 775     return GST_FLOW_OK;
 776   }
 777 flushing:
 778   {
 779     GST_UNLOCK (pad);
 780     gst_base_sink_preroll_queue_flush (basesink, pad);
 781     GST_PREROLL_UNLOCK (pad);
 782     GST_DEBUG_OBJECT (basesink, "pad is flushing");
 783
 784     return GST_FLOW_WRONG_STATE;
 785   }
 786 stopping:
 787   {
 788     GST_PREROLL_UNLOCK (pad);
 789     GST_DEBUG_OBJECT (basesink, "stopping");
 790
 791     return GST_FLOW_WRONG_STATE;
 792   }
 793 preroll_failed:
 794   {
 795     GST_DEBUG_OBJECT (basesink, "preroll failed");
 796     gst_base_sink_preroll_queue_flush (basesink, pad);
 797
 798     GST_DEBUG_OBJECT (basesink, "abort state");
 799     gst_element_abort_state (GST_ELEMENT (basesink));
 800
 801     return GST_FLOW_ERROR;
 802   }
 803 }
 804
 805 static gboolean
 806 gst_base_sink_event (GstPad * pad, GstEvent * event)
 807 {
 808   GstBaseSink *basesink;
 809   gboolean result = TRUE;
 810   GstBaseSinkClass *bclass;
 811
 812   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
 813
 814   bclass = GST_BASE_SINK_GET_CLASS (basesink);
 815
 816   GST_DEBUG_OBJECT (basesink, "event %p", event);
 817
 818   switch (GST_EVENT_TYPE (event)) {
 819     case GST_EVENT_EOS:
 820     {
 821       GstFlowReturn ret;
 822
 823       GST_STREAM_LOCK (pad);
 824       /* EOS also finishes the preroll */
 825       ret =
 826           gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event));
 827       GST_STREAM_UNLOCK (pad);
 828       break;
 829     }
 830     case GST_EVENT_NEWSEGMENT:
 831     {
 832       GstFlowReturn ret;
 833
 834       GST_STREAM_LOCK (pad);
 835       ret =
 836           gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event));
 837       GST_STREAM_UNLOCK (pad);
 838       break;
 839     }
 840     case GST_EVENT_FLUSH_START:
 841       /* make sure we are not blocked on the clock also clear any pending
 842        * eos state. */
 843       if (bclass->event)
 844         bclass->event (basesink, event);
 845
 846       GST_LOCK (basesink);
 847       basesink->flushing = TRUE;
 848       if (basesink->clock_id) {
 849         gst_clock_id_unschedule (basesink->clock_id);
 850       }
 851       GST_UNLOCK (basesink);
 852
 853       GST_PREROLL_LOCK (pad);
 854       /* we need preroll after the flush */
 855       GST_DEBUG_OBJECT (basesink, "flushing, need preroll after flush");
 856       basesink->need_preroll = TRUE;
 857       /* unlock from a possible state change/preroll */
 858       gst_base_sink_preroll_queue_flush (basesink, pad);
 859       GST_PREROLL_UNLOCK (pad);
 860
 861       /* and we need to commit our state again on the next
 862        * prerolled buffer */
 863       GST_STREAM_LOCK (pad);
 864       gst_element_lost_state (GST_ELEMENT (basesink));
 865       GST_STREAM_UNLOCK (pad);
 866       GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
 867       gst_event_unref (event);
 868       break;
 869     case GST_EVENT_FLUSH_STOP:
 870       if (bclass->event)
 871         bclass->event (basesink, event);
 872
 873       /* now we are completely unblocked and the _chain method
 874        * will return */
 875       GST_STREAM_LOCK (pad);
 876       GST_LOCK (basesink);
 877       basesink->flushing = FALSE;
 878       GST_UNLOCK (basesink);
 879       /* we need new segment info after the flush. */
 880       basesink->segment_start = -1;
 881       basesink->segment_stop = -1;
 882       basesink->current_start = -1;
 883       basesink->current_end = -1;
 884       GST_DEBUG_OBJECT (basesink, "reset accum %" GST_TIME_FORMAT,
 885           GST_TIME_ARGS (basesink->segment_accum));
 886       basesink->segment_accum = 0;
 887       GST_STREAM_UNLOCK (pad);
 888
 889       GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
 890       gst_event_unref (event);
 891       break;
 892     default:
 893       gst_event_unref (event);
 894       break;
 895   }
 896   gst_object_unref (basesink);
 897
 898   return result;
 899 }
 900
 901 /* default implementation to calculate the start and end
 902  * timestamps on a buffer, subclasses can override
 903  */
 904 static void
 905 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
 906     GstClockTime * start, GstClockTime * end)
 907 {
 908   GstClockTime timestamp, duration;
 909
 910   timestamp = GST_BUFFER_TIMESTAMP (buffer);
 911   if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
 912
 913     /* get duration to calculate end time */
 914     duration = GST_BUFFER_DURATION (buffer);
 915     if (GST_CLOCK_TIME_IS_VALID (duration)) {
 916       *end = timestamp + duration;
 917     }
 918     *start = timestamp;
 919   }
 920 }
 921
 922 /* with STREAM_LOCK and LOCK*/
 923 static GstClockReturn
 924 gst_base_sink_wait (GstBaseSink * basesink, GstClockTime time)
 925 {
 926   GstClockReturn ret;
 927   GstClockID id;
 928
 929   /* no need to attempt a clock wait if we are flushing */
 930   if (basesink->flushing) {
 931     return GST_CLOCK_UNSCHEDULED;
 932   }
 933
 934   /* clock_id should be NULL outside of this function */
 935   g_assert (basesink->clock_id == NULL);
 936   g_assert (GST_CLOCK_TIME_IS_VALID (time));
 937
 938   id = gst_clock_new_single_shot_id (basesink->clock, time);
 939
 940   basesink->clock_id = id;
 941   /* release the object lock while waiting */
 942   GST_UNLOCK (basesink);
 943
 944   ret = gst_clock_id_wait (id, NULL);
 945
 946   GST_LOCK (basesink);
 947   gst_clock_id_unref (id);
 948   basesink->clock_id = NULL;
 949
 950   return ret;
 951 }
 952
 953 /* perform synchronisation on a buffer
 954  *
 955  * 1) check if we have a clock, if not, do nothing
 956  * 2) calculate the start and end time of the buffer
 957  * 3) create a single shot notification to wait on
 958  *    the clock, save the entry so we can unlock it
 959  * 4) wait on the clock, this blocks
 960  * 5) unref the clockid again
 961  */
 962 static GstClockReturn
 963 gst_base_sink_do_sync (GstBaseSink * basesink, GstBuffer * buffer)
 964 {
 965   GstClockReturn result = GST_CLOCK_OK;
 966   GstClockTime start, end;
 967   GstClockTimeDiff stream_start, stream_end;
 968   GstBaseSinkClass *bclass;
 969   gboolean start_valid, end_valid;
 970
 971   bclass = GST_BASE_SINK_GET_CLASS (basesink);
 972
 973   start = end = -1;
 974   if (bclass->get_times)
 975     bclass->get_times (basesink, buffer, &start, &end);
 976
 977   start_valid = GST_CLOCK_TIME_IS_VALID (start);
 978   end_valid = GST_CLOCK_TIME_IS_VALID (end);
 979
 980   GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
 981       ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
 982
 983   /* if we don't have a timestamp, we don't sync */
 984   if (!start_valid) {
 985     GST_DEBUG_OBJECT (basesink, "start not valid");
 986     goto done;
 987   }
 988
 989   /* save last times seen. */
 990   basesink->current_start = start;
 991   if (end_valid)
 992     basesink->current_end = end;
 993   else
 994     basesink->current_end = start;
 995
 996   if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
 997     /* check if not outside of the segment range, start is
 998      * always valid here. */
 999     if (start > basesink->segment_stop)
1000       goto out_of_segment;
1001   }
1002
1003   /* bring timestamp to stream time using last segment offset. */
1004   if (GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) {
1005     /* check if not outside of the segment range */
1006     if (end_valid && end < basesink->segment_start)
1007       goto out_of_segment;
1008
1009     stream_start = (gint64) start - basesink->segment_start;
1010     stream_end = (gint64) end - basesink->segment_start;
1011   } else {
1012     stream_start = (gint64) start;
1013     stream_end = (gint64) end;
1014   }
1015
1016   /* correct for rate */
1017   if (basesink->segment_rate != 0.0) {
1018     stream_start /= ABS (basesink->segment_rate);
1019     if (end_valid)
1020       stream_end /= ABS (basesink->segment_rate);
1021   }
1022
1023   stream_start += basesink->segment_accum;
1024   if (end_valid)
1025     stream_end += basesink->segment_accum;
1026
1027   /* now do clocking */
1028   if (basesink->clock && basesink->sync) {
1029     GstClockTime base_time;
1030
1031     GST_LOCK (basesink);
1032
1033     base_time = GST_ELEMENT (basesink)->base_time;
1034
1035     GST_LOG_OBJECT (basesink,
1036         "waiting for clock, base time %" GST_TIME_FORMAT
1037         "stream_start %" GST_TIME_FORMAT,
1038         GST_TIME_ARGS (base_time), GST_TIME_ARGS (stream_start));
1039
1040     /* also save end_time of this buffer so that we can wait
1041      * to signal EOS */
1042     if (end_valid)
1043       basesink->end_time = stream_end + base_time;
1044     else
1045       basesink->end_time = GST_CLOCK_TIME_NONE;
1046
1047     result = gst_base_sink_wait (basesink, stream_start + base_time);
1048
1049     GST_UNLOCK (basesink);
1050
1051     GST_LOG_OBJECT (basesink, "clock entry done: %d", result);
1052   } else {
1053     GST_DEBUG_OBJECT (basesink, "no clock, not syncing");
1054   }
1055
1056 done:
1057   return result;
1058
1059 out_of_segment:
1060   {
1061     GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1062     return GST_CLOCK_UNSCHEDULED;
1063   }
1064 }
1065
1066
1067 /* handle an event
1068  *
1069  * 2) render the event
1070  * 3) unref the event
1071  */
1072 static inline gboolean
1073 gst_base_sink_handle_event (GstBaseSink * basesink, GstEvent * event)
1074 {
1075   GstBaseSinkClass *bclass;
1076   gboolean ret;
1077
1078   switch (GST_EVENT_TYPE (event)) {
1079     case GST_EVENT_EOS:
1080       GST_LOCK (basesink);
1081       if (basesink->clock) {
1082         /* wait for last buffer to finish if we have a valid end time */
1083         if (GST_CLOCK_TIME_IS_VALID (basesink->end_time)) {
1084           gst_base_sink_wait (basesink, basesink->end_time);
1085           basesink->end_time = GST_CLOCK_TIME_NONE;
1086         }
1087       }
1088       GST_UNLOCK (basesink);
1089       break;
1090     default:
1091       break;
1092   }
1093
1094   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1095   if (bclass->event)
1096     ret = bclass->event (basesink, event);
1097   else
1098     ret = TRUE;
1099
1100   switch (GST_EVENT_TYPE (event)) {
1101     case GST_EVENT_EOS:
1102       GST_PREROLL_LOCK (basesink->sinkpad);
1103       /* if we are still EOS, we can post the EOS message */
1104       if (basesink->eos) {
1105         /* ok, now we can post the message */
1106         GST_DEBUG_OBJECT (basesink, "Now posting EOS");
1107         gst_element_post_message (GST_ELEMENT (basesink),
1108             gst_message_new_eos (GST_OBJECT (basesink)));
1109         basesink->eos_queued = FALSE;
1110       }
1111       GST_PREROLL_UNLOCK (basesink->sinkpad);
1112       break;
1113     default:
1114       break;
1115   }
1116
1117   GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
1118   gst_event_unref (event);
1119
1120   return ret;
1121 }
1122
1123 /* handle a buffer
1124  *
1125  * 1) first sync on the buffer
1126  * 2) render the buffer
1127  * 3) unref the buffer
1128  */
1129 static inline GstFlowReturn
1130 gst_base_sink_handle_buffer (GstBaseSink * basesink, GstBuffer * buf)
1131 {
1132   GstFlowReturn ret = GST_FLOW_OK;
1133   GstClockReturn status;
1134
1135   status = gst_base_sink_do_sync (basesink, buf);
1136   switch (status) {
1137     case GST_CLOCK_EARLY:
1138       GST_DEBUG_OBJECT (basesink, "buffer too late!, rendering anyway");
1139       /* fallthrough for now */
1140     case GST_CLOCK_OK:
1141     {
1142       GstBaseSinkClass *bclass;
1143
1144       bclass = GST_BASE_SINK_GET_CLASS (basesink);
1145       if (bclass->render)
1146         ret = bclass->render (basesink, buf);
1147       break;
1148     }
1149     default:
1150       GST_DEBUG_OBJECT (basesink, "clock returned %d, not rendering", status);
1151       break;
1152   }
1153
1154   GST_DEBUG_OBJECT (basesink, "buffer unref after render %p", basesink, buf);
1155   gst_buffer_unref (buf);
1156
1157   return ret;
1158 }
1159
1160 static GstFlowReturn
1161 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
1162 {
1163   GstBaseSink *basesink;
1164   GstFlowReturn result;
1165
1166   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1167
1168   if (!(basesink->pad_mode == GST_ACTIVATE_PUSH)) {
1169     GST_LOCK (pad);
1170     g_warning ("Push on pad %s:%s, but it was not activated in push mode",
1171         GST_DEBUG_PAD_NAME (pad));
1172     GST_UNLOCK (pad);
1173     result = GST_FLOW_UNEXPECTED;
1174     goto done;
1175   }
1176
1177   result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf));
1178
1179 done:
1180   gst_object_unref (basesink);
1181
1182   return result;
1183 }
1184
1185 static void
1186 gst_base_sink_loop (GstPad * pad)
1187 {
1188   GstBaseSink *basesink;
1189   GstBuffer *buf = NULL;
1190   GstFlowReturn result;
1191
1192   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1193
1194   g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
1195
1196   result = gst_pad_pull_range (pad, basesink->offset, DEFAULT_SIZE, &buf);
1197   if (result != GST_FLOW_OK)
1198     goto paused;
1199
1200   result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf));
1201   if (result != GST_FLOW_OK)
1202     goto paused;
1203
1204   gst_object_unref (basesink);
1205
1206   /* default */
1207   return;
1208
1209 paused:
1210   {
1211     gst_base_sink_event (pad, gst_event_new_eos ());
1212     gst_object_unref (basesink);
1213     gst_pad_pause_task (pad);
1214     return;
1215   }
1216 }
1217
1218 static gboolean
1219 gst_base_sink_deactivate (GstBaseSink * basesink, GstPad * pad)
1220 {
1221   gboolean result = FALSE;
1222   GstBaseSinkClass *bclass;
1223
1224   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1225
1226   /* step 1, unblock clock sync (if any) or any other blocking thing */
1227   GST_PREROLL_LOCK (pad);
1228   GST_LOCK (basesink);
1229   if (basesink->clock_id) {
1230     gst_clock_id_unschedule (basesink->clock_id);
1231   }
1232   GST_UNLOCK (basesink);
1233
1234   /* unlock any subclasses */
1235   if (bclass->unlock)
1236     bclass->unlock (basesink);
1237
1238   /* flush out the data thread if it's locked in finish_preroll */
1239   GST_DEBUG_OBJECT (basesink,
1240       "flushing out data thread, need preroll to FALSE");
1241   basesink->need_preroll = FALSE;
1242   gst_base_sink_preroll_queue_flush (basesink, pad);
1243   GST_PREROLL_SIGNAL (pad);
1244   GST_PREROLL_UNLOCK (pad);
1245
1246   /* step 2, make sure streaming finishes */
1247   result = gst_pad_stop_task (pad);
1248
1249   return result;
1250 }
1251
1252 static gboolean
1253 gst_base_sink_activate (GstPad * pad)
1254 {
1255   gboolean result = FALSE;
1256   GstBaseSink *basesink;
1257
1258   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1259
1260   GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
1261
1262   if (basesink->can_activate_pull && gst_pad_check_pull_range (pad)
1263       && gst_pad_activate_pull (pad, TRUE)) {
1264     GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
1265     result = TRUE;
1266   } else {
1267     GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
1268     if (gst_pad_activate_push (pad, TRUE)) {
1269       GST_DEBUG_OBJECT (basesink, "Success activating push mode");
1270       result = TRUE;
1271     }
1272   }
1273
1274   if (!result) {
1275     GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
1276   }
1277
1278   gst_object_unref (basesink);
1279
1280   return result;
1281 }
1282
1283 static gboolean
1284 gst_base_sink_activate_push (GstPad * pad, gboolean active)
1285 {
1286   gboolean result;
1287   GstBaseSink *basesink;
1288
1289   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1290
1291   if (active) {
1292     if (!basesink->can_activate_push) {
1293       result = FALSE;
1294       basesink->pad_mode = GST_ACTIVATE_NONE;
1295     } else {
1296       result = TRUE;
1297       basesink->pad_mode = GST_ACTIVATE_PUSH;
1298     }
1299   } else {
1300     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
1301       g_warning ("Internal GStreamer activation error!!!");
1302       result = FALSE;
1303     } else {
1304       result = gst_base_sink_deactivate (basesink, pad);
1305       basesink->pad_mode = GST_ACTIVATE_NONE;
1306     }
1307   }
1308
1309   gst_object_unref (basesink);
1310
1311   return result;
1312 }
1313
1314 /* this won't get called until we implement an activate function */
1315 static gboolean
1316 gst_base_sink_activate_pull (GstPad * pad, gboolean active)
1317 {
1318   gboolean result = FALSE;
1319   GstBaseSink *basesink;
1320
1321   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1322
1323   if (active) {
1324     if (!basesink->can_activate_pull) {
1325       result = FALSE;
1326       basesink->pad_mode = GST_ACTIVATE_NONE;
1327     } else {
1328       GstPad *peer = gst_pad_get_peer (pad);
1329
1330       if (G_UNLIKELY (peer == NULL)) {
1331         g_warning ("Trying to activate pad in pull mode, but no peer");
1332         result = FALSE;
1333         basesink->pad_mode = GST_ACTIVATE_NONE;
1334       } else {
1335         if (gst_pad_activate_pull (peer, TRUE)) {
1336           basesink->have_newsegment = TRUE;
1337           basesink->segment_start = basesink->segment_stop = 0;
1338
1339           /* set the pad mode before starting the task so that it's in the
1340              correct state for the new thread... */
1341           basesink->pad_mode = GST_ACTIVATE_PULL;
1342           result =
1343               gst_pad_start_task (pad, (GstTaskFunction) gst_base_sink_loop,
1344               pad);
1345           /* but if starting the thread fails, set it back */
1346           if (!result)
1347             basesink->pad_mode = GST_ACTIVATE_NONE;
1348         } else {
1349           GST_DEBUG_OBJECT (pad, "Failed to activate peer in pull mode");
1350           result = FALSE;
1351           basesink->pad_mode = GST_ACTIVATE_NONE;
1352         }
1353         gst_object_unref (peer);
1354       }
1355     }
1356   } else {
1357     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
1358       g_warning ("Internal GStreamer activation error!!!");
1359       result = FALSE;
1360     } else {
1361       basesink->have_newsegment = FALSE;
1362       result = gst_base_sink_deactivate (basesink, pad);
1363       basesink->pad_mode = GST_ACTIVATE_NONE;
1364     }
1365   }
1366
1367   gst_object_unref (basesink);
1368
1369   return result;
1370 }
1371
1372 static gboolean
1373 gst_base_sink_send_event (GstElement * element, GstEvent * event)
1374 {
1375   GstPad *pad;
1376   GstBaseSink *basesink = GST_BASE_SINK (element);
1377   gboolean result;
1378
1379   GST_LOCK (element);
1380   pad = basesink->sinkpad;
1381   gst_object_ref (pad);
1382   GST_UNLOCK (element);
1383
1384   result = gst_pad_push_event (pad, event);
1385
1386   gst_object_unref (pad);
1387
1388   return result;
1389 }
1390
1391 static gboolean
1392 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
1393 {
1394   GstPad *peer;
1395   gboolean res = FALSE;
1396
1397   if ((peer = gst_pad_get_peer (sink->sinkpad))) {
1398     res = gst_pad_query (peer, query);
1399     gst_object_unref (peer);
1400   }
1401   return res;
1402 }
1403
1404 static gboolean
1405 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
1406     gint64 * cur)
1407 {
1408   GstClock *clock;
1409   gboolean res = FALSE;
1410
1411   switch (format) {
1412     case GST_FORMAT_TIME:
1413     {
1414       /* we can answer time format */
1415       GST_LOCK (basesink);
1416       if ((clock = GST_ELEMENT_CLOCK (basesink))) {
1417         GstClockTime now;
1418         gint64 segment_time;
1419
1420         gst_object_ref (clock);
1421         GST_UNLOCK (basesink);
1422
1423         now = gst_clock_get_time (clock);
1424
1425         GST_LOCK (basesink);
1426         if (GST_CLOCK_TIME_IS_VALID (basesink->segment_time))
1427           segment_time = basesink->segment_time;
1428         else
1429           segment_time = 0;
1430
1431         *cur = now - GST_ELEMENT_CAST (basesink)->base_time + segment_time;
1432
1433         GST_DEBUG_OBJECT (basesink,
1434             "now %" GST_TIME_FORMAT " + segment_time %" GST_TIME_FORMAT " = %"
1435             GST_TIME_FORMAT, GST_TIME_ARGS (now),
1436             GST_TIME_ARGS (segment_time), GST_TIME_ARGS (*cur));
1437
1438         gst_object_unref (clock);
1439
1440         res = TRUE;
1441       }
1442       GST_UNLOCK (basesink);
1443     }
1444     default:
1445       break;
1446   }
1447   return res;
1448 }
1449
1450 static gboolean
1451 gst_base_sink_query (GstElement * element, GstQuery * query)
1452 {
1453   gboolean res = FALSE;
1454
1455   GstBaseSink *basesink = GST_BASE_SINK (element);
1456
1457   switch (GST_QUERY_TYPE (query)) {
1458     case GST_QUERY_POSITION:
1459     {
1460       gint64 cur = 0;
1461       GstFormat format;
1462       gboolean eos;
1463
1464       GST_PREROLL_LOCK (basesink->sinkpad);
1465       eos = basesink->eos;
1466       GST_PREROLL_UNLOCK (basesink->sinkpad);
1467
1468       if (eos) {
1469         res = gst_base_sink_peer_query (basesink, query);
1470       } else {
1471         gst_query_parse_position (query, &format, NULL);
1472
1473         GST_DEBUG_OBJECT (basesink, "current position format %d", format);
1474
1475         if ((res = gst_base_sink_get_position (basesink, format, &cur))) {
1476           gst_query_set_position (query, format, cur);
1477         } else {
1478           res = gst_base_sink_peer_query (basesink, query);
1479         }
1480       }
1481       break;
1482     }
1483     case GST_QUERY_DURATION:
1484       res = gst_base_sink_peer_query (basesink, query);
1485       break;
1486     case GST_QUERY_LATENCY:
1487       break;
1488     case GST_QUERY_JITTER:
1489       break;
1490     case GST_QUERY_RATE:
1491       //gst_query_set_rate (query, basesink->segment_rate);
1492       res = TRUE;
1493       break;
1494     case GST_QUERY_SEGMENT:
1495     {
1496       /* FIXME, bring start/stop to stream time */
1497       gst_query_set_segment (query, basesink->segment_rate,
1498           GST_FORMAT_TIME, basesink->segment_start, basesink->segment_stop);
1499       break;
1500     }
1501     case GST_QUERY_SEEKING:
1502     case GST_QUERY_CONVERT:
1503     case GST_QUERY_FORMATS:
1504     default:
1505       res = gst_base_sink_peer_query (basesink, query);
1506       break;
1507   }
1508   return res;
1509 }
1510
1511 static GstStateChangeReturn
1512 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
1513 {
1514   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1515   GstBaseSink *basesink = GST_BASE_SINK (element);
1516   GstBaseSinkClass *bclass;
1517
1518   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1519
1520   switch (transition) {
1521     case GST_STATE_CHANGE_NULL_TO_READY:
1522       if (bclass->start)
1523         if (!bclass->start (basesink))
1524           goto start_failed;
1525       break;
1526     case GST_STATE_CHANGE_READY_TO_PAUSED:
1527       /* need to complete preroll before this state change completes, there
1528        * is no data flow in READY so we can safely assume we need to preroll. */
1529       basesink->offset = 0;
1530       GST_PREROLL_LOCK (basesink->sinkpad);
1531       basesink->have_preroll = FALSE;
1532       GST_DEBUG_OBJECT (basesink, "READY to PAUSED, need preroll to FALSE");
1533       basesink->need_preroll = TRUE;
1534       GST_PREROLL_UNLOCK (basesink->sinkpad);
1535       basesink->have_newsegment = FALSE;
1536       basesink->segment_rate = 1.0;
1537       basesink->segment_start = 0;
1538       basesink->segment_stop = 0;
1539       basesink->segment_time = 0;
1540       basesink->segment_accum = 0;
1541       ret = GST_STATE_CHANGE_ASYNC;
1542       break;
1543     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1544       GST_PREROLL_LOCK (basesink->sinkpad);
1545       /* no preroll needed */
1546       basesink->need_preroll = FALSE;
1547
1548       /* if we have EOS, we should empty the queue now as there will
1549        * be no more data received in the chain function.
1550        * FIXME, this could block the state change function too long when
1551        * we are pushing and syncing the buffers, better start a new
1552        * thread to do this. */
1553       if (basesink->eos) {
1554         gboolean do_eos = !basesink->eos_queued;
1555
1556         gst_base_sink_preroll_queue_empty (basesink, basesink->sinkpad);
1557
1558         /* need to post EOS message here if it was not in the preroll queue we
1559          * just emptied. */
1560         if (do_eos) {
1561           GST_DEBUG_OBJECT (basesink, "Now posting EOS");
1562           gst_element_post_message (GST_ELEMENT (basesink),
1563               gst_message_new_eos (GST_OBJECT (basesink)));
1564         }
1565       } else if (!basesink->have_preroll) {
1566         /* queue a commit_state */
1567         basesink->need_preroll = TRUE;
1568         GST_DEBUG_OBJECT (basesink,
1569             "PAUSED to PLAYING, !eos, !have_preroll, need preroll to FALSE");
1570         ret = GST_STATE_CHANGE_ASYNC;
1571         /* we know it's not waiting, no need to signal */
1572       } else {
1573         GST_DEBUG_OBJECT (basesink,
1574             "PAUSED to PLAYING, !eos, have_preroll, need preroll to FALSE");
1575         /* now let it play */
1576         GST_PREROLL_SIGNAL (basesink->sinkpad);
1577       }
1578       GST_PREROLL_UNLOCK (basesink->sinkpad);
1579       break;
1580     default:
1581       break;
1582   }
1583
1584   {
1585     GstStateChangeReturn bret;
1586
1587     bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1588     if (bret == GST_STATE_CHANGE_FAILURE)
1589       goto activate_failed;
1590   }
1591
1592   switch (transition) {
1593     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1594     {
1595       GstBaseSinkClass *bclass;
1596
1597       bclass = GST_BASE_SINK_GET_CLASS (basesink);
1598
1599       GST_PREROLL_LOCK (basesink->sinkpad);
1600       GST_LOCK (basesink);
1601       /* unlock clock wait if any */
1602       if (basesink->clock_id) {
1603         gst_clock_id_unschedule (basesink->clock_id);
1604       }
1605       GST_UNLOCK (basesink);
1606
1607       /* unlock any subclasses */
1608       if (bclass->unlock)
1609         bclass->unlock (basesink);
1610
1611       /* if we don't have a preroll buffer and we have not received EOS,
1612        * we need to wait for a preroll */
1613       GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d",
1614           basesink->have_preroll, basesink->eos);
1615       if (!basesink->have_preroll && !basesink->eos
1616           && GST_STATE_PENDING (basesink) == GST_STATE_PAUSED) {
1617         GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, need preroll to TRUE");
1618         basesink->need_preroll = TRUE;
1619         ret = GST_STATE_CHANGE_ASYNC;
1620       }
1621       GST_PREROLL_UNLOCK (basesink->sinkpad);
1622       break;
1623     }
1624     case GST_STATE_CHANGE_PAUSED_TO_READY:
1625       break;
1626     case GST_STATE_CHANGE_READY_TO_NULL:
1627       if (bclass->stop)
1628         if (!bclass->stop (basesink)) {
1629           GST_WARNING ("failed to stop");
1630         }
1631       break;
1632     default:
1633       break;
1634   }
1635
1636   return ret;
1637
1638   /* ERRORS */
1639 start_failed:
1640   {
1641     GST_DEBUG_OBJECT (basesink, "failed to start");
1642     return GST_STATE_CHANGE_FAILURE;
1643   }
1644 activate_failed:
1645   {
1646     GST_DEBUG_OBJECT (basesink,
1647         "element failed to change states -- activation problem?");
1648     return GST_STATE_CHANGE_FAILURE;
1649   }
1650 }