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