gst/base/gstbasesink.c

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