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