gst/gstpipeline.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2004,2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstpipeline.c: Overall pipeline management element
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstpipeline
  25  * @short_description: Top-level bin with clocking and bus management
  26                        functionality.
  27  * @see_also: #GstElement, #GstBin, #GstClock, #GstBus
  28  *
  29  * A #GstPipeline is a special #GstBin used as the toplevel container for
  30  * the filter graph. The #GstPipeline will manage the selection and
  31  * distribution of a global #GstClock as well as provide a #GstBus to the
  32  * application.
  33  *
  34  * gst_pipeline_new() is used to create a pipeline. when you are done with
  35  * the pipeline, use gst_object_unref() to free its resources including all
  36  * added #GstElement objects (if not otherwise referenced).
  37  *
  38  * Elements are added and removed from the pipeline using the #GstBin
  39  * methods like gst_bin_add() and gst_bin_remove() (see #GstBin).
  40  *
  41  * Before changing the state of the #GstPipeline (see #GstElement) a #GstBus
  42  * can be retrieved with gst_pipeline_get_bus(). This bus can then be
  43  * used to receive #GstMessage from the elements in the pipeline.
  44  *
  45  * By default, a #GstPipeline will automatically flush the pending #GstBus
  46  * messages when going to the NULL state to ensure that no circular
  47  * references exist when no messages are read from the #GstBus. This
  48  * behaviour can be changed with gst_pipeline_set_auto_flush_bus().
  49  *
  50  * When the #GstPipeline performs the PAUSED to PLAYING state change it will
  51  * select a clock for the elements. The clock selection algorithm will by
  52  * default select a clock provided by an element that is most upstream
  53  * (closest to the source). For live pipelines (ones that return
  54  * #GST_STATE_CHANGE_NO_PREROLL from the gst_element_set_state() call) this
  55  * will select the clock provided by the live source. For normal pipelines
  56  * this will select a clock provided by the sinks (most likely the audio
  57  * sink). If no element provides a clock, a default #GstSystemClock is used.
  58  *
  59  * The clock selection can be controlled with the gst_pipeline_use_clock()
  60  * method, which will enforce a given clock on the pipeline. With
  61  * gst_pipeline_auto_clock() the default clock selection algorithm can be
  62  * restored.
  63  *
  64  * A #GstPipeline maintains a running time for the elements. The running
  65  * time is defined as the difference between the current clock time and
  66  * the base time. When the pipeline goes to READY or a flushing seek is
  67  * performed on it, the running time is reset to 0. When the pipeline is
  68  * set from PLAYING to PAUSED, the current clock time is sampled and used to
  69  * configure the base time for the elements when the pipeline is set
  70  * to PLAYING again. The effect is that the running time (as the difference
  71  * between the clock time and the base time) will count how much time was spent
  72  * in the PLAYING state. This default behaviour can be changed with the
  73  * gst_element_set_start_time() method.
  74  */
  75
  76 #include "gst_private.h"
  77 #include "gsterror.h"
  78 #include "gst-i18n-lib.h"
  79
  80 #include "gstpipeline.h"
  81 #include "gstinfo.h"
  82 #include "gstsystemclock.h"
  83 #include "gstutils.h"
  84
  85 GST_DEBUG_CATEGORY_STATIC (pipeline_debug);
  86 #define GST_CAT_DEFAULT pipeline_debug
  87
  88 /* Pipeline signals and args */
  89 enum
  90 {
  91   /* FILL ME */
  92   LAST_SIGNAL
  93 };
  94
  95 #define DEFAULT_DELAY           0
  96 #define DEFAULT_AUTO_FLUSH_BUS  TRUE
  97 #define DEFAULT_LATENCY         GST_CLOCK_TIME_NONE
  98
  99 enum
 100 {
 101   PROP_0,
 102   PROP_DELAY,
 103   PROP_AUTO_FLUSH_BUS,
 104   PROP_LATENCY
 105 };
 106
 107 #define GST_PIPELINE_GET_PRIVATE(obj)  \
 108    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PIPELINE, GstPipelinePrivate))
 109
 110 struct _GstPipelinePrivate
 111 {
 112   /* with LOCK */
 113   gboolean auto_flush_bus;
 114
 115   /* when we need to update stream_time or clock when going back to
 116    * PLAYING*/
 117   GstClockTime last_start_time;
 118   gboolean update_clock;
 119
 120   GstClockTime latency;
 121 };
 122
 123
 124 static void gst_pipeline_dispose (GObject * object);
 125 static void gst_pipeline_set_property (GObject * object, guint prop_id,
 126     const GValue * value, GParamSpec * pspec);
 127 static void gst_pipeline_get_property (GObject * object, guint prop_id,
 128     GValue * value, GParamSpec * pspec);
 129
 130 static GstClock *gst_pipeline_provide_clock_func (GstElement * element);
 131 static GstStateChangeReturn gst_pipeline_change_state (GstElement * element,
 132     GstStateChange transition);
 133
 134 static void gst_pipeline_handle_message (GstBin * bin, GstMessage * message);
 135 static gboolean gst_pipeline_do_latency (GstBin * bin);
 136
 137 /* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
 138
 139 #define _do_init \
 140 { \
 141   GST_DEBUG_CATEGORY_INIT (pipeline_debug, "pipeline", GST_DEBUG_BOLD, \
 142       "debugging info for the 'pipeline' container element"); \
 143 }
 144
 145 #define gst_pipeline_parent_class parent_class
 146 G_DEFINE_TYPE_WITH_CODE (GstPipeline, gst_pipeline, GST_TYPE_BIN, _do_init);
 147
 148 static void
 149 gst_pipeline_class_init (GstPipelineClass * klass)
 150 {
 151   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 152   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 153   GstBinClass *gstbin_class = GST_BIN_CLASS (klass);
 154
 155   g_type_class_add_private (klass, sizeof (GstPipelinePrivate));
 156
 157   gobject_class->set_property = gst_pipeline_set_property;
 158   gobject_class->get_property = gst_pipeline_get_property;
 159
 160   /**
 161    * GstPipeline:delay:
 162    *
 163    * The expected delay needed for elements to spin up to the
 164    * PLAYING state expressed in nanoseconds.
 165    * see gst_pipeline_set_delay() for more information on this option.
 166    **/
 167   g_object_class_install_property (gobject_class, PROP_DELAY,
 168       g_param_spec_uint64 ("delay", "Delay",
 169           "Expected delay needed for elements "
 170           "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
 171           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 172
 173   /**
 174    * GstPipeline:auto-flush-bus:
 175    *
 176    * Whether or not to automatically flush all messages on the
 177    * pipeline's bus when going from READY to NULL state. Please see
 178    * gst_pipeline_set_auto_flush_bus() for more information on this option.
 179    **/
 180   g_object_class_install_property (gobject_class, PROP_AUTO_FLUSH_BUS,
 181       g_param_spec_boolean ("auto-flush-bus", "Auto Flush Bus",
 182           "Whether to automatically flush the pipeline's bus when going "
 183           "from READY into NULL state", DEFAULT_AUTO_FLUSH_BUS,
 184           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 185
 186   /**
 187    * GstPipeline:latency:
 188    *
 189    * Latency to configure on the pipeline. See gst_pipeline_set_latency().
 190    *
 191    * Since: 1.6
 192    **/
 193   g_object_class_install_property (gobject_class, PROP_LATENCY,
 194       g_param_spec_uint64 ("latency", "Latency",
 195           "Latency to configure on the pipeline", 0, G_MAXUINT64,
 196           DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 197
 198   gobject_class->dispose = gst_pipeline_dispose;
 199
 200   gst_element_class_set_static_metadata (gstelement_class, "Pipeline object",
 201       "Generic/Bin",
 202       "Complete pipeline object",
 203       "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
 204
 205   gstelement_class->change_state =
 206       GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
 207   gstelement_class->provide_clock =
 208       GST_DEBUG_FUNCPTR (gst_pipeline_provide_clock_func);
 209   gstbin_class->handle_message =
 210       GST_DEBUG_FUNCPTR (gst_pipeline_handle_message);
 211   gstbin_class->do_latency = GST_DEBUG_FUNCPTR (gst_pipeline_do_latency);
 212 }
 213
 214 static void
 215 gst_pipeline_init (GstPipeline * pipeline)
 216 {
 217   GstBus *bus;
 218
 219   pipeline->priv = GST_PIPELINE_GET_PRIVATE (pipeline);
 220
 221   /* set default property values */
 222   pipeline->priv->auto_flush_bus = DEFAULT_AUTO_FLUSH_BUS;
 223   pipeline->delay = DEFAULT_DELAY;
 224   pipeline->priv->latency = DEFAULT_LATENCY;
 225
 226   /* create and set a default bus */
 227   bus = gst_bus_new ();
 228 #if 0
 229   /* FIXME, disabled for 0.10.5 release as it caused to many regressions */
 230   /* Start our bus in flushing if appropriate */
 231   if (pipeline->priv->auto_flush_bus)
 232     gst_bus_set_flushing (bus, TRUE);
 233 #endif
 234
 235   gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
 236   GST_DEBUG_OBJECT (pipeline, "set bus %" GST_PTR_FORMAT " on pipeline", bus);
 237   gst_object_unref (bus);
 238 }
 239
 240 static void
 241 gst_pipeline_dispose (GObject * object)
 242 {
 243   GstPipeline *pipeline = GST_PIPELINE (object);
 244   GstClock **clock_p = &pipeline->fixed_clock;
 245
 246   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
 247
 248   /* clear and unref any fixed clock */
 249   gst_object_replace ((GstObject **) clock_p, NULL);
 250
 251   G_OBJECT_CLASS (parent_class)->dispose (object);
 252 }
 253
 254 static void
 255 gst_pipeline_set_property (GObject * object, guint prop_id,
 256     const GValue * value, GParamSpec * pspec)
 257 {
 258   GstPipeline *pipeline = GST_PIPELINE (object);
 259
 260   switch (prop_id) {
 261     case PROP_DELAY:
 262       gst_pipeline_set_delay (pipeline, g_value_get_uint64 (value));
 263       break;
 264     case PROP_AUTO_FLUSH_BUS:
 265       gst_pipeline_set_auto_flush_bus (pipeline, g_value_get_boolean (value));
 266       break;
 267     case PROP_LATENCY:
 268       gst_pipeline_set_latency (pipeline, g_value_get_uint64 (value));
 269       break;
 270     default:
 271       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 272       break;
 273   }
 274 }
 275
 276 static void
 277 gst_pipeline_get_property (GObject * object, guint prop_id,
 278     GValue * value, GParamSpec * pspec)
 279 {
 280   GstPipeline *pipeline = GST_PIPELINE (object);
 281
 282   switch (prop_id) {
 283     case PROP_DELAY:
 284       g_value_set_uint64 (value, gst_pipeline_get_delay (pipeline));
 285       break;
 286     case PROP_AUTO_FLUSH_BUS:
 287       g_value_set_boolean (value, gst_pipeline_get_auto_flush_bus (pipeline));
 288       break;
 289     case PROP_LATENCY:
 290       g_value_set_uint64 (value, gst_pipeline_get_latency (pipeline));
 291       break;
 292     default:
 293       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 294       break;
 295   }
 296 }
 297
 298 /* set the start_time to 0, this will cause us to select a new base_time and
 299  * make the running_time start from 0 again. */
 300 static void
 301 reset_start_time (GstPipeline * pipeline, GstClockTime start_time)
 302 {
 303   GST_OBJECT_LOCK (pipeline);
 304   if (GST_ELEMENT_START_TIME (pipeline) != GST_CLOCK_TIME_NONE) {
 305     GST_DEBUG_OBJECT (pipeline, "reset start_time to 0");
 306     GST_ELEMENT_START_TIME (pipeline) = start_time;
 307     pipeline->priv->last_start_time = -1;
 308   } else {
 309     GST_DEBUG_OBJECT (pipeline, "application asked to not reset stream_time");
 310   }
 311   GST_OBJECT_UNLOCK (pipeline);
 312 }
 313
 314 /**
 315  * gst_pipeline_new:
 316  * @name: (allow-none): name of new pipeline
 317  *
 318  * Create a new pipeline with the given name.
 319  *
 320  * Returns: (transfer floating): newly created GstPipeline
 321  *
 322  * MT safe.
 323  */
 324 GstElement *
 325 gst_pipeline_new (const gchar * name)
 326 {
 327   return gst_element_factory_make ("pipeline", name);
 328 }
 329
 330 /* takes a snapshot of the running_time of the pipeline and store this as the
 331  * element start_time. This is the time we will set as the running_time of the
 332  * pipeline when we go to PLAYING next. */
 333 static void
 334 pipeline_update_start_time (GstElement * element)
 335 {
 336   GstPipeline *pipeline = GST_PIPELINE_CAST (element);
 337   GstClock *clock;
 338
 339   GST_OBJECT_LOCK (element);
 340   if ((clock = element->clock)) {
 341     GstClockTime now;
 342
 343     gst_object_ref (clock);
 344     GST_OBJECT_UNLOCK (element);
 345
 346     /* calculate the time when we stopped */
 347     now = gst_clock_get_time (clock);
 348     gst_object_unref (clock);
 349
 350     GST_OBJECT_LOCK (element);
 351     /* store the current running time */
 352     if (GST_ELEMENT_START_TIME (pipeline) != GST_CLOCK_TIME_NONE) {
 353       if (now != GST_CLOCK_TIME_NONE)
 354         GST_ELEMENT_START_TIME (pipeline) = now - element->base_time;
 355       else
 356         GST_WARNING_OBJECT (element,
 357             "Clock %s returned invalid time, can't calculate "
 358             "running_time when going to the PAUSED state",
 359             GST_OBJECT_NAME (clock));
 360
 361       /* we went to PAUSED, when going to PLAYING select clock and new
 362        * base_time */
 363       pipeline->priv->update_clock = TRUE;
 364     }
 365     GST_DEBUG_OBJECT (element,
 366         "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 367         ", base_time %" GST_TIME_FORMAT,
 368         GST_TIME_ARGS (GST_ELEMENT_START_TIME (pipeline)),
 369         GST_TIME_ARGS (now), GST_TIME_ARGS (element->base_time));
 370   }
 371   GST_OBJECT_UNLOCK (element);
 372 }
 373
 374 /* MT safe */
 375 static GstStateChangeReturn
 376 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
 377 {
 378   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
 379   GstPipeline *pipeline = GST_PIPELINE_CAST (element);
 380   GstClock *clock;
 381
 382   switch (transition) {
 383     case GST_STATE_CHANGE_NULL_TO_READY:
 384       GST_OBJECT_LOCK (element);
 385       if (element->bus)
 386         gst_bus_set_flushing (element->bus, FALSE);
 387       GST_OBJECT_UNLOCK (element);
 388       break;
 389     case GST_STATE_CHANGE_READY_TO_PAUSED:
 390       GST_OBJECT_LOCK (element);
 391       pipeline->priv->update_clock = TRUE;
 392       GST_OBJECT_UNLOCK (element);
 393
 394       /* READY to PAUSED starts running_time from 0 */
 395       reset_start_time (pipeline, 0);
 396       break;
 397     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 398     {
 399       GstClockTime now, start_time, last_start_time, delay;
 400       gboolean update_clock;
 401       GstClock *cur_clock;
 402
 403       GST_DEBUG_OBJECT (element, "selecting clock and base_time");
 404
 405       GST_OBJECT_LOCK (element);
 406       cur_clock = element->clock;
 407       if (cur_clock)
 408         gst_object_ref (cur_clock);
 409       /* get the desired running_time of the first buffer aka the start_time */
 410       start_time = GST_ELEMENT_START_TIME (pipeline);
 411       last_start_time = pipeline->priv->last_start_time;
 412       pipeline->priv->last_start_time = start_time;
 413       /* see if we need to update the clock */
 414       update_clock = pipeline->priv->update_clock;
 415       pipeline->priv->update_clock = FALSE;
 416       delay = pipeline->delay;
 417       GST_OBJECT_UNLOCK (element);
 418
 419       /* running time changed, either with a PAUSED or a flush, we need to check
 420        * if there is a new clock & update the base time */
 421       /* only do this for top-level, however */
 422       if (GST_OBJECT_PARENT (element) == NULL &&
 423           (update_clock || last_start_time != start_time)) {
 424         GST_DEBUG_OBJECT (pipeline, "Need to update start_time");
 425
 426         /* when going to PLAYING, select a clock when needed. If we just got
 427          * flushed, we don't reselect the clock. */
 428         if (update_clock) {
 429           GST_DEBUG_OBJECT (pipeline, "Need to update clock.");
 430           clock = gst_element_provide_clock (element);
 431         } else {
 432           GST_DEBUG_OBJECT (pipeline,
 433               "Don't need to update clock, using old clock.");
 434           /* only try to ref if cur_clock is not NULL */
 435           if (cur_clock)
 436             gst_object_ref (cur_clock);
 437           clock = cur_clock;
 438         }
 439
 440         if (clock) {
 441           now = gst_clock_get_time (clock);
 442         } else {
 443           GST_DEBUG_OBJECT (pipeline, "no clock, using base time of NONE");
 444           now = GST_CLOCK_TIME_NONE;
 445         }
 446
 447         if (clock != cur_clock) {
 448           /* now distribute the clock (which could be NULL). If some
 449            * element refuses the clock, this will return FALSE and
 450            * we effectively fail the state change. */
 451           if (!gst_element_set_clock (element, clock))
 452             goto invalid_clock;
 453
 454           /* if we selected and distributed a new clock, let the app
 455            * know about it */
 456           gst_element_post_message (element,
 457               gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
 458         }
 459
 460         if (clock)
 461           gst_object_unref (clock);
 462
 463         if (start_time != GST_CLOCK_TIME_NONE && now != GST_CLOCK_TIME_NONE) {
 464           GstClockTime new_base_time = now - start_time + delay;
 465           GST_DEBUG_OBJECT (element,
 466               "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 467               ", base_time %" GST_TIME_FORMAT,
 468               GST_TIME_ARGS (start_time), GST_TIME_ARGS (now),
 469               GST_TIME_ARGS (new_base_time));
 470
 471           gst_element_set_base_time (element, new_base_time);
 472         } else {
 473           GST_DEBUG_OBJECT (pipeline,
 474               "NOT adjusting base_time because start_time is NONE");
 475         }
 476       } else {
 477         GST_DEBUG_OBJECT (pipeline,
 478             "NOT adjusting base_time because we selected one before");
 479       }
 480
 481       if (cur_clock)
 482         gst_object_unref (cur_clock);
 483       break;
 484     }
 485     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 486     {
 487       /* we take a start_time snapshot before calling the children state changes
 488        * so that they know about when the pipeline PAUSED. */
 489       pipeline_update_start_time (element);
 490       break;
 491     }
 492     case GST_STATE_CHANGE_PAUSED_TO_READY:
 493       reset_start_time (pipeline, 0);
 494       break;
 495     case GST_STATE_CHANGE_READY_TO_NULL:
 496       break;
 497   }
 498
 499   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 500
 501   switch (transition) {
 502     case GST_STATE_CHANGE_NULL_TO_READY:
 503       break;
 504     case GST_STATE_CHANGE_READY_TO_PAUSED:
 505       break;
 506     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 507       break;
 508     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 509     {
 510       /* Take a new snapshot of the start_time after calling the state change on
 511        * all children. This will be the running_time of the pipeline when we go
 512        * back to PLAYING */
 513       pipeline_update_start_time (element);
 514       break;
 515     }
 516     case GST_STATE_CHANGE_PAUSED_TO_READY:
 517       break;
 518     case GST_STATE_CHANGE_READY_TO_NULL:
 519     {
 520       GstBus *bus;
 521       gboolean auto_flush;
 522
 523       /* grab some stuff before we release the lock to flush out the bus */
 524       GST_OBJECT_LOCK (element);
 525       if ((bus = element->bus))
 526         gst_object_ref (bus);
 527       auto_flush = pipeline->priv->auto_flush_bus;
 528       GST_OBJECT_UNLOCK (element);
 529
 530       if (bus) {
 531         if (auto_flush) {
 532           gst_bus_set_flushing (bus, TRUE);
 533         } else {
 534           GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
 535         }
 536         gst_object_unref (bus);
 537       }
 538       break;
 539     }
 540   }
 541   return result;
 542
 543   /* ERRORS */
 544 invalid_clock:
 545   {
 546     /* we generate this error when the selected clock was not
 547      * accepted by some element */
 548     GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
 549         (_("Selected clock cannot be used in pipeline.")),
 550         ("Pipeline cannot operate with selected clock"));
 551     GST_DEBUG_OBJECT (pipeline,
 552         "Pipeline cannot operate with selected clock %p", clock);
 553     if (clock)
 554       gst_object_unref (clock);
 555     return GST_STATE_CHANGE_FAILURE;
 556   }
 557 }
 558
 559 /* intercept the bus messages from our children. We watch for the ASYNC_START
 560  * message with is posted by the elements (sinks) that require a reset of the
 561  * running_time after a flush. ASYNC_START also brings the pipeline back into
 562  * the PAUSED, pending PAUSED state. When the ASYNC_DONE message is received the
 563  * pipeline will redistribute the new base_time and will bring the elements back
 564  * to the desired state of the pipeline. */
 565 static void
 566 gst_pipeline_handle_message (GstBin * bin, GstMessage * message)
 567 {
 568   GstPipeline *pipeline = GST_PIPELINE_CAST (bin);
 569
 570   switch (GST_MESSAGE_TYPE (message)) {
 571     case GST_MESSAGE_RESET_TIME:
 572     {
 573       GstClockTime running_time;
 574
 575       gst_message_parse_reset_time (message, &running_time);
 576
 577       /* reset our running time if we need to distribute a new base_time to the
 578        * children. */
 579       reset_start_time (pipeline, running_time);
 580       break;
 581     }
 582     case GST_MESSAGE_CLOCK_LOST:
 583     {
 584       GstClock *clock;
 585
 586       gst_message_parse_clock_lost (message, &clock);
 587
 588       GST_OBJECT_LOCK (bin);
 589       if (clock == GST_ELEMENT_CAST (bin)->clock) {
 590         GST_DEBUG_OBJECT (bin, "Used clock '%s' got lost",
 591             GST_OBJECT_NAME (clock));
 592         pipeline->priv->update_clock = TRUE;
 593       }
 594       GST_OBJECT_UNLOCK (bin);
 595     }
 596     default:
 597       break;
 598   }
 599   GST_BIN_CLASS (parent_class)->handle_message (bin, message);
 600 }
 601
 602 static gboolean
 603 gst_pipeline_do_latency (GstBin * bin)
 604 {
 605   GstPipeline *pipeline = GST_PIPELINE (bin);
 606   GstQuery *query;
 607   GstClockTime latency;
 608   GstClockTime min_latency, max_latency;
 609   gboolean res;
 610
 611   GST_OBJECT_LOCK (pipeline);
 612   latency = pipeline->priv->latency;
 613   GST_OBJECT_UNLOCK (pipeline);
 614
 615   if (latency == GST_CLOCK_TIME_NONE)
 616     return GST_BIN_CLASS (parent_class)->do_latency (bin);
 617
 618   GST_DEBUG_OBJECT (pipeline, "querying latency");
 619
 620   query = gst_query_new_latency ();
 621   if ((res = gst_element_query (GST_ELEMENT_CAST (pipeline), query))) {
 622     gboolean live;
 623
 624     gst_query_parse_latency (query, &live, &min_latency, &max_latency);
 625
 626     GST_DEBUG_OBJECT (pipeline,
 627         "got min latency %" GST_TIME_FORMAT ", max latency %"
 628         GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
 629         GST_TIME_ARGS (max_latency), live);
 630
 631     if (max_latency < min_latency) {
 632       /* this is an impossible situation, some parts of the pipeline might not
 633        * work correctly. We post a warning for now. */
 634       GST_ELEMENT_WARNING (pipeline, CORE, CLOCK, (NULL),
 635           ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
 636               GST_TIME_FORMAT ". Add queues or other buffering elements.",
 637               GST_TIME_ARGS (max_latency), GST_TIME_ARGS (min_latency)));
 638     }
 639
 640     if (latency < min_latency) {
 641       /* This is a problematic situation as we will most likely drop lots of
 642        * data if we configure a too low latency */
 643       GST_ELEMENT_WARNING (pipeline, CORE, CLOCK, (NULL),
 644           ("Configured latency is lower than detected minimum latency: configured %"
 645               GST_TIME_FORMAT " < min %" GST_TIME_FORMAT,
 646               GST_TIME_ARGS (latency), GST_TIME_ARGS (min_latency)));
 647     }
 648   } else {
 649     /* this is not a real problem, we just don't configure any latency. */
 650     GST_WARNING_OBJECT (pipeline, "failed to query latency");
 651   }
 652   gst_query_unref (query);
 653
 654
 655   /* configure latency on elements */
 656   res =
 657       gst_element_send_event (GST_ELEMENT_CAST (pipeline),
 658       gst_event_new_latency (latency));
 659   if (res) {
 660     GST_INFO_OBJECT (pipeline, "configured latency of %" GST_TIME_FORMAT,
 661         GST_TIME_ARGS (latency));
 662   } else {
 663     GST_WARNING_OBJECT (pipeline,
 664         "did not really configure latency of %" GST_TIME_FORMAT,
 665         GST_TIME_ARGS (latency));
 666   }
 667
 668   return res;
 669 }
 670
 671 /**
 672  * gst_pipeline_get_bus:
 673  * @pipeline: a #GstPipeline
 674  *
 675  * Gets the #GstBus of @pipeline. The bus allows applications to receive
 676  * #GstMessage packets.
 677  *
 678  * Returns: (transfer full): a #GstBus, unref after usage.
 679  *
 680  * MT safe.
 681  */
 682 GstBus *
 683 gst_pipeline_get_bus (GstPipeline * pipeline)
 684 {
 685   return gst_element_get_bus (GST_ELEMENT_CAST (pipeline));
 686 }
 687
 688 static GstClock *
 689 gst_pipeline_provide_clock_func (GstElement * element)
 690 {
 691   GstClock *clock = NULL;
 692   GstPipeline *pipeline = GST_PIPELINE (element);
 693
 694   /* if we have a fixed clock, use that one */
 695   GST_OBJECT_LOCK (pipeline);
 696   if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
 697     clock = pipeline->fixed_clock;
 698     if (clock)
 699       gst_object_ref (clock);
 700     GST_OBJECT_UNLOCK (pipeline);
 701
 702     GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
 703         clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 704   } else {
 705     GST_OBJECT_UNLOCK (pipeline);
 706     /* let the parent bin select a clock */
 707     clock =
 708         GST_ELEMENT_CLASS (parent_class)->provide_clock (GST_ELEMENT
 709         (pipeline));
 710     /* no clock, use a system clock */
 711     if (!clock) {
 712       clock = gst_system_clock_obtain ();
 713
 714       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
 715           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 716     } else {
 717       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
 718           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 719     }
 720   }
 721   return clock;
 722 }
 723
 724 /**
 725  * gst_pipeline_get_clock: (skip)
 726  * @pipeline: a #GstPipeline
 727  *
 728  * Gets the current clock used by @pipeline. Users of object
 729  * oriented languages should use gst_pipeline_get_pipeline_clock()
 730  * to avoid confusion with gst_element_get_clock() which has a different behavior.
 731  *
 732  * Unlike gst_element_get_clock(), this function will always return a
 733  * clock, even if the pipeline is not in the PLAYING state.
 734  *
 735  * Returns: (transfer full): a #GstClock, unref after usage.
 736  */
 737 GstClock *
 738 gst_pipeline_get_clock (GstPipeline * pipeline)
 739 {
 740   return gst_pipeline_get_pipeline_clock (pipeline);
 741 }
 742
 743 /**
 744  * gst_pipeline_get_pipeline_clock:
 745  * @pipeline: a #GstPipeline
 746  *
 747  * Gets the current clock used by @pipeline.
 748  *
 749  * Unlike gst_element_get_clock(), this function will always return a
 750  * clock, even if the pipeline is not in the PLAYING state.
 751  *
 752  * Returns: (transfer full): a #GstClock, unref after usage.
 753  *
 754  * Since: 1.6
 755  */
 756 GstClock *
 757 gst_pipeline_get_pipeline_clock (GstPipeline * pipeline)
 758 {
 759   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
 760
 761   return gst_pipeline_provide_clock_func (GST_ELEMENT_CAST (pipeline));
 762 }
 763
 764
 765 /**
 766  * gst_pipeline_use_clock:
 767  * @pipeline: a #GstPipeline
 768  * @clock: (transfer none) (allow-none): the clock to use
 769  *
 770  * Force @pipeline to use the given @clock. The pipeline will
 771  * always use the given clock even if new clock providers are added
 772  * to this pipeline.
 773  *
 774  * If @clock is %NULL all clocking will be disabled which will make
 775  * the pipeline run as fast as possible.
 776  *
 777  * MT safe.
 778  */
 779 void
 780 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
 781 {
 782   GstClock **clock_p;
 783
 784   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 785
 786   GST_OBJECT_LOCK (pipeline);
 787   GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 788
 789   clock_p = &pipeline->fixed_clock;
 790   gst_object_replace ((GstObject **) clock_p, (GstObject *) clock);
 791   GST_OBJECT_UNLOCK (pipeline);
 792
 793   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
 794       (clock ? GST_OBJECT_NAME (clock) : "nil"));
 795 }
 796
 797 /**
 798  * gst_pipeline_set_clock: (skip)
 799  * @pipeline: a #GstPipeline
 800  * @clock: (transfer none): the clock to set
 801  *
 802  * Set the clock for @pipeline. The clock will be distributed
 803  * to all the elements managed by the pipeline.
 804  *
 805  * Returns: %TRUE if the clock could be set on the pipeline. %FALSE if
 806  *   some element did not accept the clock.
 807  *
 808  * MT safe.
 809  */
 810 gboolean
 811 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
 812 {
 813   g_return_val_if_fail (pipeline != NULL, FALSE);
 814   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 815
 816   return
 817       GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT_CAST (pipeline),
 818       clock);
 819 }
 820
 821 /**
 822  * gst_pipeline_auto_clock:
 823  * @pipeline: a #GstPipeline
 824  *
 825  * Let @pipeline select a clock automatically. This is the default
 826  * behaviour.
 827  *
 828  * Use this function if you previous forced a fixed clock with
 829  * gst_pipeline_use_clock() and want to restore the default
 830  * pipeline clock selection algorithm.
 831  *
 832  * MT safe.
 833  */
 834 void
 835 gst_pipeline_auto_clock (GstPipeline * pipeline)
 836 {
 837   GstClock **clock_p;
 838
 839   g_return_if_fail (pipeline != NULL);
 840   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 841
 842   GST_OBJECT_LOCK (pipeline);
 843   GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 844
 845   clock_p = &pipeline->fixed_clock;
 846   gst_object_replace ((GstObject **) clock_p, NULL);
 847   GST_OBJECT_UNLOCK (pipeline);
 848
 849   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");
 850 }
 851
 852 /**
 853  * gst_pipeline_set_delay:
 854  * @pipeline: a #GstPipeline
 855  * @delay: the delay
 856  *
 857  * Set the expected delay needed for all elements to perform the
 858  * PAUSED to PLAYING state change. @delay will be added to the
 859  * base time of the elements so that they wait an additional @delay
 860  * amount of time before starting to process buffers and cannot be
 861  * #GST_CLOCK_TIME_NONE.
 862  *
 863  * This option is used for tuning purposes and should normally not be
 864  * used.
 865  *
 866  * MT safe.
 867  */
 868 void
 869 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
 870 {
 871   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 872   g_return_if_fail (delay != GST_CLOCK_TIME_NONE);
 873
 874   GST_OBJECT_LOCK (pipeline);
 875   pipeline->delay = delay;
 876   GST_OBJECT_UNLOCK (pipeline);
 877 }
 878
 879 /**
 880  * gst_pipeline_get_delay:
 881  * @pipeline: a #GstPipeline
 882  *
 883  * Get the configured delay (see gst_pipeline_set_delay()).
 884  *
 885  * Returns: The configured delay.
 886  *
 887  * MT safe.
 888  */
 889 GstClockTime
 890 gst_pipeline_get_delay (GstPipeline * pipeline)
 891 {
 892   GstClockTime res;
 893
 894   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 895
 896   GST_OBJECT_LOCK (pipeline);
 897   res = pipeline->delay;
 898   GST_OBJECT_UNLOCK (pipeline);
 899
 900   return res;
 901 }
 902
 903 /**
 904  * gst_pipeline_set_auto_flush_bus:
 905  * @pipeline: a #GstPipeline
 906  * @auto_flush: whether or not to automatically flush the bus when
 907  * the pipeline goes from READY to NULL state
 908  *
 909  * Usually, when a pipeline goes from READY to NULL state, it automatically
 910  * flushes all pending messages on the bus, which is done for refcounting
 911  * purposes, to break circular references.
 912  *
 913  * This means that applications that update state using (async) bus messages
 914  * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
 915  * not get to see messages when the pipeline is shut down, because they might
 916  * be flushed before they can be dispatched in the main thread. This behaviour
 917  * can be disabled using this function.
 918  *
 919  * It is important that all messages on the bus are handled when the
 920  * automatic flushing is disabled else memory leaks will be introduced.
 921  *
 922  * MT safe.
 923  */
 924 void
 925 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
 926 {
 927   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 928
 929   GST_OBJECT_LOCK (pipeline);
 930   pipeline->priv->auto_flush_bus = auto_flush;
 931   GST_OBJECT_UNLOCK (pipeline);
 932 }
 933
 934 /**
 935  * gst_pipeline_get_auto_flush_bus:
 936  * @pipeline: a #GstPipeline
 937  *
 938  * Check if @pipeline will automatically flush messages when going to
 939  * the NULL state.
 940  *
 941  * Returns: whether the pipeline will automatically flush its bus when
 942  * going from READY to NULL state or not.
 943  *
 944  * MT safe.
 945  */
 946 gboolean
 947 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
 948 {
 949   gboolean res;
 950
 951   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 952
 953   GST_OBJECT_LOCK (pipeline);
 954   res = pipeline->priv->auto_flush_bus;
 955   GST_OBJECT_UNLOCK (pipeline);
 956
 957   return res;
 958 }
 959
 960 /**
 961  * gst_pipeline_set_latency:
 962  * @pipeline: a #GstPipeline
 963  * @latency: latency to configure
 964  *
 965  * Sets the latency that should be configured on the pipeline. Setting
 966  * GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum
 967  * latency from the LATENCY query. Setting this is usually not required and
 968  * the pipeline will figure out an appropriate latency automatically.
 969  *
 970  * Setting a too low latency, especially lower than the minimum latency from
 971  * the LATENCY query, will most likely cause the pipeline to fail.
 972  *
 973  * Since: 1.6
 974  */
 975 void
 976 gst_pipeline_set_latency (GstPipeline * pipeline, GstClockTime latency)
 977 {
 978   gboolean changed;
 979
 980   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 981
 982   GST_OBJECT_LOCK (pipeline);
 983   changed = (pipeline->priv->latency != latency);
 984   pipeline->priv->latency = latency;
 985   GST_OBJECT_UNLOCK (pipeline);
 986
 987   if (changed)
 988     gst_bin_recalculate_latency (GST_BIN_CAST (pipeline));
 989 }
 990
 991 /**
 992  * gst_pipeline_get_latency:
 993  * @pipeline: a #GstPipeline
 994  *
 995  * Gets the latency that should be configured on the pipeline. See
 996  * gst_pipeline_set_latency().
 997  *
 998  * Returns: Latency to configure on the pipeline or GST_CLOCK_TIME_NONE
 999  *
1000  * Since: 1.6
1001  */
1002
1003 GstClockTime
1004 gst_pipeline_get_latency (GstPipeline * pipeline)
1005 {
1006   GstClockTime latency;
1007
1008   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
1009
1010   GST_OBJECT_LOCK (pipeline);
1011   latency = pipeline->priv->latency;
1012   GST_OBJECT_UNLOCK (pipeline);
1013
1014   return latency;
1015 }