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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, 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. It will also implement a default behavour for managing
  33  * seek events (see gst_element_seek()).
  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 stream time for the elements. The stream
  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 stream 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. This default behaviour can be changed with the
  72  * gst_pipeline_set_new_stream_time() method.
  73  *
  74  * When sending a flushing seek event to a GstPipeline (see
  75  * gst_element_seek()), it will make sure that the pipeline is properly
  76  * PAUSED and resumed as well as set the new stream time to 0 when the
  77  * seek succeeded.
  78  *
  79  * Last reviewed on 2006-03-12 (0.10.5)
  80  */
  81
  82 #include "gst_private.h"
  83 #include "gsterror.h"
  84 #include "gst-i18n-lib.h"
  85
  86 #include "gstpipeline.h"
  87 #include "gstinfo.h"
  88 #include "gstsystemclock.h"
  89
  90 GST_DEBUG_CATEGORY_STATIC (pipeline_debug);
  91 #define GST_CAT_DEFAULT pipeline_debug
  92
  93 static const GstElementDetails gst_pipeline_details =
  94 GST_ELEMENT_DETAILS ("Pipeline object",
  95     "Generic/Bin",
  96     "Complete pipeline object",
  97     "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
  98
  99 /* Pipeline signals and args */
 100 enum
 101 {
 102   /* FILL ME */
 103   LAST_SIGNAL
 104 };
 105
 106 #define DEFAULT_DELAY           0
 107 #define DEFAULT_AUTO_FLUSH_BUS  TRUE
 108
 109 enum
 110 {
 111   PROP_0,
 112   PROP_DELAY,
 113   PROP_AUTO_FLUSH_BUS
 114 };
 115
 116 #define GST_PIPELINE_GET_PRIVATE(obj)  \
 117    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PIPELINE, GstPipelinePrivate))
 118
 119 struct _GstPipelinePrivate
 120 {
 121   /* with LOCK */
 122   gboolean auto_flush_bus;
 123
 124   /* when we need to update stream_time or clock when going back to
 125    * PLAYING*/
 126   gboolean update_stream_time;
 127   gboolean update_clock;
 128 };
 129
 130
 131 static void gst_pipeline_base_init (gpointer g_class);
 132 static void gst_pipeline_class_init (gpointer g_class, gpointer class_data);
 133 static void gst_pipeline_init (GTypeInstance * instance, gpointer g_class);
 134
 135 static void gst_pipeline_dispose (GObject * object);
 136 static void gst_pipeline_set_property (GObject * object, guint prop_id,
 137     const GValue * value, GParamSpec * pspec);
 138 static void gst_pipeline_get_property (GObject * object, guint prop_id,
 139     GValue * value, GParamSpec * pspec);
 140
 141 static GstClock *gst_pipeline_provide_clock_func (GstElement * element);
 142 static GstStateChangeReturn gst_pipeline_change_state (GstElement * element,
 143     GstStateChange transition);
 144
 145 static void gst_pipeline_handle_message (GstBin * bin, GstMessage * message);
 146
 147 static GstBinClass *parent_class = NULL;
 148
 149 /* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
 150
 151 GType
 152 gst_pipeline_get_type (void)
 153 {
 154   static GType pipeline_type = 0;
 155
 156   if (G_UNLIKELY (pipeline_type == 0)) {
 157     static const GTypeInfo pipeline_info = {
 158       sizeof (GstPipelineClass),
 159       gst_pipeline_base_init,
 160       NULL,
 161       (GClassInitFunc) gst_pipeline_class_init,
 162       NULL,
 163       NULL,
 164       sizeof (GstPipeline),
 165       0,
 166       gst_pipeline_init,
 167       NULL
 168     };
 169
 170     pipeline_type =
 171         g_type_register_static (GST_TYPE_BIN, "GstPipeline", &pipeline_info, 0);
 172
 173     GST_DEBUG_CATEGORY_INIT (pipeline_debug, "pipeline", GST_DEBUG_BOLD,
 174         "debugging info for the 'pipeline' container element");
 175   }
 176   return pipeline_type;
 177 }
 178
 179 static void
 180 gst_pipeline_base_init (gpointer g_class)
 181 {
 182   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 183
 184   gst_element_class_set_details (gstelement_class, &gst_pipeline_details);
 185 }
 186
 187 static void
 188 gst_pipeline_class_init (gpointer g_class, gpointer class_data)
 189 {
 190   GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
 191   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 192   GstBinClass *gstbin_class = GST_BIN_CLASS (g_class);
 193   GstPipelineClass *klass = GST_PIPELINE_CLASS (g_class);
 194
 195   parent_class = g_type_class_peek_parent (klass);
 196
 197   g_type_class_add_private (klass, sizeof (GstPipelinePrivate));
 198
 199   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pipeline_set_property);
 200   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pipeline_get_property);
 201
 202   /**
 203    * GstPipeline:delay
 204    *
 205    * The expected delay needed for elements to spin up to the
 206    * PLAYING state expressed in nanoseconds.
 207    * see gst_pipeline_set_delay() for more information on this option.
 208    *
 209    * Since: 0.10.5
 210    **/
 211   g_object_class_install_property (gobject_class, PROP_DELAY,
 212       g_param_spec_uint64 ("delay", "Delay",
 213           "Expected delay needed for elements "
 214           "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
 215           G_PARAM_READWRITE));
 216
 217   /**
 218    * GstPipeline:auto-flush-bus:
 219    *
 220    * Whether or not to automatically flush all messages on the
 221    * pipeline's bus when going from READY to NULL state. Please see
 222    * gst_pipeline_set_auto_flush_bus() for more information on this option.
 223    *
 224    * Since: 0.10.4
 225    **/
 226   g_object_class_install_property (gobject_class, PROP_AUTO_FLUSH_BUS,
 227       g_param_spec_boolean ("auto-flush-bus", "Auto Flush Bus",
 228           "Whether to automatically flush the pipeline's bus when going "
 229           "from READY into NULL state", DEFAULT_AUTO_FLUSH_BUS,
 230           G_PARAM_READWRITE));
 231
 232   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pipeline_dispose);
 233
 234   gstelement_class->change_state =
 235       GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
 236   gstelement_class->provide_clock =
 237       GST_DEBUG_FUNCPTR (gst_pipeline_provide_clock_func);
 238
 239   gstbin_class->handle_message =
 240       GST_DEBUG_FUNCPTR (gst_pipeline_handle_message);
 241 }
 242
 243 static void
 244 gst_pipeline_init (GTypeInstance * instance, gpointer g_class)
 245 {
 246   GstPipeline *pipeline = GST_PIPELINE (instance);
 247   GstBus *bus;
 248
 249   pipeline->priv = GST_PIPELINE_GET_PRIVATE (pipeline);
 250
 251   /* set default property values */
 252   pipeline->priv->auto_flush_bus = DEFAULT_AUTO_FLUSH_BUS;
 253   pipeline->delay = DEFAULT_DELAY;
 254
 255   /* create and set a default bus */
 256   bus = gst_bus_new ();
 257 #if 0
 258   /* FIXME, disabled for 0.10.5 release as it caused to many regressions */
 259   /* Start our bus in flushing if appropriate */
 260   if (pipeline->priv->auto_flush_bus)
 261     gst_bus_set_flushing (bus, TRUE);
 262 #endif
 263
 264   gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
 265   GST_DEBUG_OBJECT (pipeline, "set bus %" GST_PTR_FORMAT " on pipeline", bus);
 266   gst_object_unref (bus);
 267 }
 268
 269 static void
 270 gst_pipeline_dispose (GObject * object)
 271 {
 272   GstPipeline *pipeline = GST_PIPELINE (object);
 273   GstClock **clock_p = &pipeline->fixed_clock;
 274
 275   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
 276
 277   /* clear and unref any fixed clock */
 278   gst_object_replace ((GstObject **) clock_p, NULL);
 279
 280   G_OBJECT_CLASS (parent_class)->dispose (object);
 281 }
 282
 283 static void
 284 gst_pipeline_set_property (GObject * object, guint prop_id,
 285     const GValue * value, GParamSpec * pspec)
 286 {
 287   GstPipeline *pipeline = GST_PIPELINE (object);
 288
 289   switch (prop_id) {
 290     case PROP_DELAY:
 291       gst_pipeline_set_delay (pipeline, g_value_get_uint64 (value));
 292       break;
 293     case PROP_AUTO_FLUSH_BUS:
 294       gst_pipeline_set_auto_flush_bus (pipeline, g_value_get_boolean (value));
 295       break;
 296     default:
 297       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 298       break;
 299   }
 300 }
 301
 302 static void
 303 gst_pipeline_get_property (GObject * object, guint prop_id,
 304     GValue * value, GParamSpec * pspec)
 305 {
 306   GstPipeline *pipeline = GST_PIPELINE (object);
 307
 308   switch (prop_id) {
 309     case PROP_DELAY:
 310       g_value_set_uint64 (value, gst_pipeline_get_delay (pipeline));
 311       break;
 312     case PROP_AUTO_FLUSH_BUS:
 313       g_value_set_boolean (value, gst_pipeline_get_auto_flush_bus (pipeline));
 314       break;
 315     default:
 316       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 317       break;
 318   }
 319 }
 320
 321 /* set the stream time to 0 */
 322 static void
 323 reset_stream_time (GstPipeline * pipeline)
 324 {
 325   GST_OBJECT_LOCK (pipeline);
 326   if (pipeline->stream_time != GST_CLOCK_TIME_NONE) {
 327     GST_DEBUG_OBJECT (pipeline, "reset stream_time to 0");
 328     pipeline->stream_time = 0;
 329     pipeline->priv->update_stream_time = TRUE;
 330   } else {
 331     GST_DEBUG_OBJECT (pipeline, "application asked to not reset stream_time");
 332   }
 333   GST_OBJECT_UNLOCK (pipeline);
 334 }
 335
 336 /**
 337  * gst_pipeline_new:
 338  * @name: name of new pipeline
 339  *
 340  * Create a new pipeline with the given name.
 341  *
 342  * Returns: newly created GstPipeline
 343  *
 344  * MT safe.
 345  */
 346 GstElement *
 347 gst_pipeline_new (const gchar * name)
 348 {
 349   return gst_element_factory_make ("pipeline", name);
 350 }
 351
 352 /* MT safe */
 353 static GstStateChangeReturn
 354 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
 355 {
 356   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
 357   GstPipeline *pipeline = GST_PIPELINE (element);
 358   GstClock *clock;
 359
 360   switch (transition) {
 361     case GST_STATE_CHANGE_NULL_TO_READY:
 362       GST_OBJECT_LOCK (element);
 363       if (element->bus)
 364         gst_bus_set_flushing (element->bus, FALSE);
 365       GST_OBJECT_UNLOCK (element);
 366       break;
 367     case GST_STATE_CHANGE_READY_TO_PAUSED:
 368       GST_OBJECT_LOCK (element);
 369       pipeline->priv->update_clock = TRUE;
 370       GST_OBJECT_UNLOCK (element);
 371       break;
 372     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 373     {
 374       GstClockTime new_base_time;
 375       GstQuery *query;
 376       GstClockTime min_latency, max_latency;
 377       GstClockTime start_time, stream_time, delay;
 378       gboolean new_clock, update_stream_time, update_clock;
 379       gboolean res;
 380       GstClock *cur_clock;
 381
 382       GST_DEBUG_OBJECT (element, "selecting clock and base_time");
 383
 384       GST_OBJECT_LOCK (element);
 385       cur_clock = element->clock;
 386       if (cur_clock)
 387         gst_object_ref (cur_clock);
 388       stream_time = pipeline->stream_time;
 389       update_stream_time = pipeline->priv->update_stream_time;
 390       update_clock = pipeline->priv->update_clock;
 391       pipeline->priv->update_stream_time = FALSE;
 392       pipeline->priv->update_clock = FALSE;
 393       delay = pipeline->delay;
 394       GST_OBJECT_UNLOCK (element);
 395
 396       /* stream time changed, either with a PAUSED or a flush, we need to check
 397        * if there is a new clock & update the base time */
 398       if (update_stream_time) {
 399         GST_DEBUG_OBJECT (pipeline, "Need to update stream_time");
 400
 401         /* when going to PLAYING, select a clock when needed. If we just got
 402          * flushed, we don't reselect the clock. */
 403         if (update_clock) {
 404           GST_DEBUG_OBJECT (pipeline, "Need to update clock.");
 405           clock = gst_element_provide_clock (element);
 406         } else {
 407           GST_DEBUG_OBJECT (pipeline,
 408               "Don't need to update clock, using old clock.");
 409           clock = gst_object_ref (cur_clock);
 410         }
 411
 412         new_clock = (clock != cur_clock);
 413
 414         if (clock) {
 415           start_time = gst_clock_get_time (clock);
 416         } else {
 417           GST_DEBUG ("no clock, using base time of NONE");
 418           start_time = GST_CLOCK_TIME_NONE;
 419           new_base_time = GST_CLOCK_TIME_NONE;
 420         }
 421
 422         if (new_clock) {
 423           /* now distribute the clock (which could be NULL). If some
 424            * element refuses the clock, this will return FALSE and
 425            * we effectively fail the state change. */
 426           if (!gst_element_set_clock (element, clock))
 427             goto invalid_clock;
 428
 429           /* if we selected and distributed a new clock, let the app
 430            * know about it */
 431           gst_element_post_message (element,
 432               gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
 433         }
 434
 435         if (clock)
 436           gst_object_unref (clock);
 437
 438         if (stream_time != GST_CLOCK_TIME_NONE
 439             && start_time != GST_CLOCK_TIME_NONE) {
 440           new_base_time = start_time - stream_time + delay;
 441           GST_DEBUG_OBJECT (element,
 442               "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 443               ", base_time %" GST_TIME_FORMAT,
 444               GST_TIME_ARGS (stream_time), GST_TIME_ARGS (start_time),
 445               GST_TIME_ARGS (new_base_time));
 446         } else
 447           new_base_time = GST_CLOCK_TIME_NONE;
 448
 449         if (new_base_time != GST_CLOCK_TIME_NONE)
 450           gst_element_set_base_time (element, new_base_time);
 451         else
 452           GST_DEBUG_OBJECT (pipeline,
 453               "NOT adjusting base_time because stream_time is NONE");
 454       } else {
 455         GST_DEBUG_OBJECT (pipeline,
 456             "NOT adjusting base_time because we selected one before");
 457       }
 458
 459       if (cur_clock)
 460         gst_object_unref (cur_clock);
 461
 462       /* determine latency in this pipeline */
 463       GST_DEBUG_OBJECT (element, "querying pipeline latency");
 464       query = gst_query_new_latency ();
 465       if (gst_element_query (element, query)) {
 466         gboolean live;
 467
 468         gst_query_parse_latency (query, &live, &min_latency, &max_latency);
 469
 470         GST_DEBUG_OBJECT (element,
 471             "configuring min latency %" GST_TIME_FORMAT ", max latency %"
 472             GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
 473             GST_TIME_ARGS (max_latency), live);
 474
 475         /* configure latency on elements */
 476         res =
 477             gst_element_send_event (element,
 478             gst_event_new_latency (min_latency));
 479         if (res) {
 480           GST_INFO_OBJECT (element, "configured latency of %" GST_TIME_FORMAT,
 481               GST_TIME_ARGS (min_latency));
 482         } else {
 483           GST_WARNING_OBJECT (element,
 484               "failed to configure latency of %" GST_TIME_FORMAT,
 485               GST_TIME_ARGS (min_latency));
 486           GST_ELEMENT_WARNING (element, CORE, CLOCK, (NULL),
 487               ("Failed to configure latency of %" GST_TIME_FORMAT,
 488                   GST_TIME_ARGS (min_latency)));
 489         }
 490       } else {
 491         /* this is not a real problem, we just don't configure any latency. */
 492         GST_WARNING_OBJECT (element, "failed to query pipeline latency");
 493       }
 494       gst_query_unref (query);
 495       break;
 496     }
 497     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 498       break;
 499     case GST_STATE_CHANGE_PAUSED_TO_READY:
 500     case GST_STATE_CHANGE_READY_TO_NULL:
 501       break;
 502   }
 503
 504   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 505
 506   switch (transition) {
 507     case GST_STATE_CHANGE_NULL_TO_READY:
 508       break;
 509     case GST_STATE_CHANGE_READY_TO_PAUSED:
 510     {
 511       reset_stream_time (pipeline);
 512       break;
 513     }
 514     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 515       break;
 516     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 517       GST_OBJECT_LOCK (element);
 518       if ((clock = element->clock)) {
 519         GstClockTime now;
 520
 521         gst_object_ref (clock);
 522         GST_OBJECT_UNLOCK (element);
 523
 524         /* calculate the time when we stopped */
 525         now = gst_clock_get_time (clock);
 526         gst_object_unref (clock);
 527
 528         GST_OBJECT_LOCK (element);
 529         /* store the current stream time */
 530         if (pipeline->stream_time != GST_CLOCK_TIME_NONE) {
 531           pipeline->stream_time = now - element->base_time;
 532           /* we went to PAUSED, when going to PLAYING select clock and new
 533            * base_time */
 534           pipeline->priv->update_stream_time = TRUE;
 535           pipeline->priv->update_clock = TRUE;
 536         }
 537
 538         GST_DEBUG_OBJECT (element,
 539             "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 540             ", base_time %" GST_TIME_FORMAT,
 541             GST_TIME_ARGS (pipeline->stream_time), GST_TIME_ARGS (now),
 542             GST_TIME_ARGS (element->base_time));
 543       }
 544       GST_OBJECT_UNLOCK (element);
 545       break;
 546     case GST_STATE_CHANGE_PAUSED_TO_READY:
 547       break;
 548     case GST_STATE_CHANGE_READY_TO_NULL:
 549       GST_OBJECT_LOCK (element);
 550       if (element->bus) {
 551         if (pipeline->priv->auto_flush_bus) {
 552           gst_bus_set_flushing (element->bus, TRUE);
 553         } else {
 554           GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
 555         }
 556       }
 557       GST_OBJECT_UNLOCK (element);
 558       break;
 559   }
 560   return result;
 561
 562   /* ERRORS */
 563 invalid_clock:
 564   {
 565     /* we generate this error when the selected clock was not
 566      * accepted by some element */
 567     GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
 568         (_("Selected clock cannot be used in pipeline.")),
 569         ("Pipeline cannot operate with selected clock"));
 570     GST_DEBUG_OBJECT (pipeline,
 571         "Pipeline cannot operate with selected clock %p", clock);
 572     if (clock)
 573       gst_object_unref (clock);
 574     return GST_STATE_CHANGE_FAILURE;
 575   }
 576 }
 577
 578 static void
 579 gst_pipeline_handle_message (GstBin * bin, GstMessage * message)
 580 {
 581   GstPipeline *pipeline = GST_PIPELINE_CAST (bin);
 582
 583   switch (GST_MESSAGE_TYPE (message)) {
 584     case GST_MESSAGE_ASYNC_START:
 585     {
 586       gboolean new_base_time;
 587
 588       gst_message_parse_async_start (message, &new_base_time);
 589
 590       /* reset our stream time if we need to distribute a new base_time to the
 591        * children. */
 592       if (new_base_time)
 593         reset_stream_time (pipeline);
 594
 595       break;
 596     }
 597     default:
 598       break;
 599   }
 600   GST_BIN_CLASS (parent_class)->handle_message (bin, message);
 601 }
 602
 603
 604 /**
 605  * gst_pipeline_get_bus:
 606  * @pipeline: a #GstPipeline
 607  *
 608  * Gets the #GstBus of @pipeline.
 609  *
 610  * Returns: a #GstBus, unref after usage.
 611  *
 612  * MT safe.
 613  */
 614 GstBus *
 615 gst_pipeline_get_bus (GstPipeline * pipeline)
 616 {
 617   return gst_element_get_bus (GST_ELEMENT (pipeline));
 618 }
 619
 620 /**
 621  * gst_pipeline_set_new_stream_time:
 622  * @pipeline: a #GstPipeline
 623  * @time: the new stream time to set
 624  *
 625  * Set the new stream time of @pipeline to @time. The stream time is used to
 626  * set the base time on the elements (see gst_element_set_base_time())
 627  * in the PAUSED->PLAYING state transition.
 628  *
 629  * Setting @time to #GST_CLOCK_TIME_NONE will disable the pipeline's management
 630  * of element base time. The application will then be responsible for
 631  * performing base time distribution. This is sometimes useful if you want to
 632  * synchronize capture from multiple pipelines, and you can also ensure that the
 633  * pipelines have the same clock.
 634  *
 635  * MT safe.
 636  */
 637 void
 638 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
 639 {
 640   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 641
 642   GST_OBJECT_LOCK (pipeline);
 643   pipeline->stream_time = time;
 644   pipeline->priv->update_stream_time = TRUE;
 645   GST_OBJECT_UNLOCK (pipeline);
 646
 647   GST_DEBUG_OBJECT (pipeline, "set new stream_time to %" GST_TIME_FORMAT,
 648       GST_TIME_ARGS (time));
 649
 650   if (time == GST_CLOCK_TIME_NONE)
 651     GST_DEBUG_OBJECT (pipeline, "told not to adjust base_time");
 652 }
 653
 654 /**
 655  * gst_pipeline_get_last_stream_time:
 656  * @pipeline: a #GstPipeline
 657  *
 658  * Gets the last stream time of @pipeline. If the pipeline is PLAYING,
 659  * the returned time is the stream time used to configure the element's
 660  * base time in the PAUSED->PLAYING state. If the pipeline is PAUSED, the
 661  * returned time is the stream time when the pipeline was paused.
 662  *
 663  * This function returns #GST_CLOCK_TIME_NONE if the pipeline was
 664  * configured to not handle the management of the element's base time
 665  * (see gst_pipeline_set_new_stream_time()).
 666  *
 667  * Returns: a #GstClockTime.
 668  *
 669  * MT safe.
 670  */
 671 GstClockTime
 672 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
 673 {
 674   GstClockTime result;
 675
 676   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 677
 678   GST_OBJECT_LOCK (pipeline);
 679   result = pipeline->stream_time;
 680   GST_OBJECT_UNLOCK (pipeline);
 681
 682   return result;
 683 }
 684
 685 static GstClock *
 686 gst_pipeline_provide_clock_func (GstElement * element)
 687 {
 688   GstClock *clock = NULL;
 689   GstPipeline *pipeline = GST_PIPELINE (element);
 690
 691   /* if we have a fixed clock, use that one */
 692   GST_OBJECT_LOCK (pipeline);
 693   if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
 694     clock = pipeline->fixed_clock;
 695     if (clock)
 696       gst_object_ref (clock);
 697     GST_OBJECT_UNLOCK (pipeline);
 698
 699     GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
 700         clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 701   } else {
 702     GST_OBJECT_UNLOCK (pipeline);
 703     /* let the parent bin select a clock */
 704     clock =
 705         GST_ELEMENT_CLASS (parent_class)->
 706         provide_clock (GST_ELEMENT (pipeline));
 707     /* no clock, use a system clock */
 708     if (!clock) {
 709       clock = gst_system_clock_obtain ();
 710
 711       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
 712           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 713     } else {
 714       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
 715           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 716     }
 717   }
 718   return clock;
 719 }
 720
 721 /**
 722  * gst_pipeline_get_clock:
 723  * @pipeline: a #GstPipeline
 724  *
 725  * Gets the current clock used by @pipeline.
 726  *
 727  * Returns: a #GstClock, unref after usage.
 728  */
 729 GstClock *
 730 gst_pipeline_get_clock (GstPipeline * pipeline)
 731 {
 732   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
 733
 734   return gst_pipeline_provide_clock_func (GST_ELEMENT (pipeline));
 735 }
 736
 737
 738 /**
 739  * gst_pipeline_use_clock:
 740  * @pipeline: a #GstPipeline
 741  * @clock: the clock to use
 742  *
 743  * Force @pipeline to use the given @clock. The pipeline will
 744  * always use the given clock even if new clock providers are added
 745  * to this pipeline.
 746  *
 747  * If @clock is NULL all clocking will be disabled which will make
 748  * the pipeline run as fast as possible.
 749  *
 750  * MT safe.
 751  */
 752 void
 753 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
 754 {
 755   GstClock **clock_p;
 756
 757   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 758
 759   GST_OBJECT_LOCK (pipeline);
 760   GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 761
 762   clock_p = &pipeline->fixed_clock;
 763   gst_object_replace ((GstObject **) clock_p, (GstObject *) clock);
 764   GST_OBJECT_UNLOCK (pipeline);
 765
 766   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
 767       (clock ? GST_OBJECT_NAME (clock) : "nil"));
 768 }
 769
 770 /**
 771  * gst_pipeline_set_clock:
 772  * @pipeline: a #GstPipeline
 773  * @clock: the clock to set
 774  *
 775  * Set the clock for @pipeline. The clock will be distributed
 776  * to all the elements managed by the pipeline.
 777  *
 778  * Returns: TRUE if the clock could be set on the pipeline. FALSE if
 779  *   some element did not accept the clock.
 780  *
 781  * MT safe.
 782  */
 783 gboolean
 784 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
 785 {
 786   g_return_val_if_fail (pipeline != NULL, FALSE);
 787   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 788
 789   return GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT (pipeline),
 790       clock);
 791 }
 792
 793 /**
 794  * gst_pipeline_auto_clock:
 795  * @pipeline: a #GstPipeline
 796  *
 797  * Let @pipeline select a clock automatically. This is the default
 798  * behaviour.
 799  *
 800  * Use this function if you previous forced a fixed clock with
 801  * gst_pipeline_use_clock() and want to restore the default
 802  * pipeline clock selection algorithm.
 803  *
 804  * MT safe.
 805  */
 806 void
 807 gst_pipeline_auto_clock (GstPipeline * pipeline)
 808 {
 809   GstClock **clock_p;
 810
 811   g_return_if_fail (pipeline != NULL);
 812   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 813
 814   GST_OBJECT_LOCK (pipeline);
 815   GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 816
 817   clock_p = &pipeline->fixed_clock;
 818   gst_object_replace ((GstObject **) clock_p, NULL);
 819   GST_OBJECT_UNLOCK (pipeline);
 820
 821   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");
 822 }
 823
 824 /**
 825  * gst_pipeline_set_delay:
 826  * @pipeline: a #GstPipeline
 827  * @delay: the delay
 828  *
 829  * Set the expected delay needed for all elements to perform the
 830  * PAUSED to PLAYING state change. @delay will be added to the
 831  * base time of the elements so that they wait an additional @delay
 832  * amount of time before starting to process buffers and cannot be
 833  * #GST_CLOCK_TIME_NONE.
 834  *
 835  * This option is used for tuning purposes and should normally not be
 836  * used.
 837  *
 838  * MT safe.
 839  *
 840  * Since: 0.10.5
 841  */
 842 void
 843 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
 844 {
 845   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 846   g_return_if_fail (delay != GST_CLOCK_TIME_NONE);
 847
 848   GST_OBJECT_LOCK (pipeline);
 849   pipeline->delay = delay;
 850   GST_OBJECT_UNLOCK (pipeline);
 851 }
 852
 853 /**
 854  * gst_pipeline_get_delay:
 855  * @pipeline: a #GstPipeline
 856  *
 857  * Get the configured delay (see gst_pipeline_set_delay()).
 858  *
 859  * Returns: The configured delay.
 860  *
 861  * MT safe.
 862  *
 863  * Since: 0.10.5
 864  */
 865 GstClockTime
 866 gst_pipeline_get_delay (GstPipeline * pipeline)
 867 {
 868   GstClockTime res;
 869
 870   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 871
 872   GST_OBJECT_LOCK (pipeline);
 873   res = pipeline->delay;
 874   GST_OBJECT_UNLOCK (pipeline);
 875
 876   return res;
 877 }
 878
 879 /**
 880  * gst_pipeline_set_auto_flush_bus:
 881  * @pipeline: a #GstPipeline
 882  * @auto_flush: whether or not to automatically flush the bus when
 883  * the pipeline goes from READY to NULL state
 884  *
 885  * Usually, when a pipeline goes from READY to NULL state, it automatically
 886  * flushes all pending messages on the bus, which is done for refcounting
 887  * purposes, to break circular references.
 888  *
 889  * This means that applications that update state using (async) bus messages
 890  * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
 891  * not get to see messages when the pipeline is shut down, because they might
 892  * be flushed before they can be dispatched in the main thread. This behaviour
 893  * can be disabled using this function.
 894  *
 895  * It is important that all messages on the bus are handled when the
 896  * automatic flushing is disabled else memory leaks will be introduced.
 897  *
 898  * MT safe.
 899  *
 900  * Since: 0.10.4
 901  */
 902 void
 903 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
 904 {
 905   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 906
 907   GST_OBJECT_LOCK (pipeline);
 908   pipeline->priv->auto_flush_bus = auto_flush;
 909   GST_OBJECT_UNLOCK (pipeline);
 910 }
 911
 912 /**
 913  * gst_pipeline_get_auto_flush_bus:
 914  * @pipeline: a #GstPipeline
 915  *
 916  * Check if @pipeline will automatically flush messages when going to
 917  * the NULL state.
 918  *
 919  * Returns: whether the pipeline will automatically flush its bus when
 920  * going from READY to NULL state or not.
 921  *
 922  * MT safe.
 923  *
 924  * Since: 0.10.4
 925  */
 926 gboolean
 927 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
 928 {
 929   gboolean res;
 930
 931   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 932
 933   GST_OBJECT_LOCK (pipeline);
 934   res = pipeline->priv->auto_flush_bus;
 935   GST_OBJECT_UNLOCK (pipeline);
 936
 937   return res;
 938 }