gst/gstevent.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstevent.c: GstEvent subsystem
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstevent
  26  * @short_description: Structure describing events that are passed up and down
  27  *                     a pipeline
  28  * @see_also: #GstPad, #GstElement
  29  *
  30  * The event class provides factory methods to construct events for sending
  31  * and functions to query (parse) received events.
  32  *
  33  * Events are usually created with gst_event_new_*() which takes event-type
  34  * specific parameters as arguments.
  35  * To send an event application will usually use gst_element_send_event() and
  36  * elements will use gst_pad_send_event() or gst_pad_push_event().
  37  * The event should be unreffed with gst_event_unref() if it has not been sent.
  38  *
  39  * Events that have been received can be parsed with their respective
  40  * gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.
  41  *
  42  * Events are passed between elements in parallel to the data stream. Some events
  43  * are serialized with buffers, others are not. Some events only travel downstream,
  44  * others only upstream. Some events can travel both upstream and downstream.
  45  *
  46  * The events are used to signal special conditions in the datastream such as
  47  * EOS (end of stream) or the start of a new stream-segment.
  48  * Events are also used to flush the pipeline of any pending data.
  49  *
  50  * Most of the event API is used inside plugins. Applications usually only
  51  * construct and use seek events.
  52  * To do that gst_event_new_seek() is used to create a seek event. It takes
  53  * the needed parameters to specity seeking time and mode.
  54  * <example>
  55  * <title>performing a seek on a pipeline</title>
  56  *   <programlisting>
  57  *   GstEvent *event;
  58  *   gboolean result;
  59  *   ...
  60  *   // construct a seek event to play the media from second 2 to 5, flush
  61  *   // the pipeline to decrease latency.
  62  *   event = gst_event_new_seek (1.0,
  63  *      GST_FORMAT_TIME,
  64  *      GST_SEEK_FLAG_FLUSH,
  65  *      GST_SEEK_TYPE_SET, 2 * GST_SECOND,
  66  *      GST_SEEK_TYPE_SET, 5 * GST_SECOND);
  67  *   ...
  68  *   result = gst_element_send_event (pipeline, event);
  69  *   if (!result)
  70  *     g_warning ("seek failed");
  71  *   ...
  72  *   </programlisting>
  73  * </example>
  74  *
  75  * Last reviewed on 2006-09-6 (0.10.10)
  76  */
  77
  78
  79 #include "gst_private.h"
  80 #include <string.h>             /* memcpy */
  81
  82 #include "gstinfo.h"
  83 #include "gstevent.h"
  84 #include "gstenumtypes.h"
  85 #include "gstutils.h"
  86 #include "gstquark.h"
  87
  88 GType _gst_event_type = 0;
  89
  90 typedef struct
  91 {
  92   GstQOSType type;
  93   gdouble proportion;
  94   gint64 diff;
  95   GstClockTime timestamp;
  96 } GstEventQOSData;
  97
  98 typedef struct
  99 {
 100   GstEvent event;
 101
 102   GstStructure *structure;
 103
 104   union
 105   {
 106     GstEventQOSData qos;
 107   };
 108 } GstEventImpl;
 109
 110 #define GST_EVENT_STRUCTURE(e)        (((GstEventImpl *)(e))->structure)
 111 #define GST_EVENT_IMPL(e,data,field)  (((GstEventImpl *)(e))->data.field)
 112
 113 typedef struct
 114 {
 115   const gint type;
 116   const gchar *name;
 117   GQuark quark;
 118 } GstEventQuarks;
 119
 120 static GstEventQuarks event_quarks[] = {
 121   {GST_EVENT_UNKNOWN, "unknown", 0},
 122   {GST_EVENT_FLUSH_START, "flush-start", 0},
 123   {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
 124   {GST_EVENT_EOS, "eos", 0},
 125   {GST_EVENT_CAPS, "caps", 0},
 126   {GST_EVENT_NEWSEGMENT, "newsegment", 0},
 127   {GST_EVENT_TAG, "tag", 0},
 128   {GST_EVENT_BUFFERSIZE, "buffersize", 0},
 129   {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
 130   {GST_EVENT_QOS, "qos", 0},
 131   {GST_EVENT_SEEK, "seek", 0},
 132   {GST_EVENT_NAVIGATION, "navigation", 0},
 133   {GST_EVENT_LATENCY, "latency", 0},
 134   {GST_EVENT_STEP, "step", 0},
 135   {GST_EVENT_RECONFIGURE, "reconfigure", 0},
 136   {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
 137   {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
 138   {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
 139   {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
 140   {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},
 141
 142   {0, NULL, 0}
 143 };
 144
 145 void
 146 _gst_event_initialize (void)
 147 {
 148   gint i;
 149
 150   _gst_event_type = gst_mini_object_register ("GstEvent");
 151
 152   g_type_class_ref (gst_seek_flags_get_type ());
 153   g_type_class_ref (gst_seek_type_get_type ());
 154
 155   for (i = 0; event_quarks[i].name; i++) {
 156     event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name);
 157   }
 158 }
 159
 160 /**
 161  * gst_event_type_get_name:
 162  * @type: the event type
 163  *
 164  * Get a printable name for the given event type. Do not modify or free.
 165  *
 166  * Returns: a reference to the static name of the event.
 167  */
 168 const gchar *
 169 gst_event_type_get_name (GstEventType type)
 170 {
 171   gint i;
 172
 173   for (i = 0; event_quarks[i].name; i++) {
 174     if (type == event_quarks[i].type)
 175       return event_quarks[i].name;
 176   }
 177   return "unknown";
 178 }
 179
 180 /**
 181  * gst_event_type_to_quark:
 182  * @type: the event type
 183  *
 184  * Get the unique quark for the given event type.
 185  *
 186  * Returns: the quark associated with the event type
 187  */
 188 GQuark
 189 gst_event_type_to_quark (GstEventType type)
 190 {
 191   gint i;
 192
 193   for (i = 0; event_quarks[i].name; i++) {
 194     if (type == event_quarks[i].type)
 195       return event_quarks[i].quark;
 196   }
 197   return 0;
 198 }
 199
 200 /**
 201  * gst_event_type_get_flags:
 202  * @type: a #GstEventType
 203  *
 204  * Gets the #GstEventTypeFlags associated with @type.
 205  *
 206  * Returns: a #GstEventTypeFlags.
 207  */
 208 GstEventTypeFlags
 209 gst_event_type_get_flags (GstEventType type)
 210 {
 211   GstEventTypeFlags ret;
 212
 213   ret = type & ((1 << GST_EVENT_STICKY_SHIFT) - 1);
 214
 215   return ret;
 216 }
 217
 218 static void
 219 _gst_event_free (GstEvent * event)
 220 {
 221   GstStructure *s;
 222
 223   g_return_if_fail (event != NULL);
 224   g_return_if_fail (GST_IS_EVENT (event));
 225
 226   GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
 227       GST_EVENT_TYPE_NAME (event));
 228
 229   s = GST_EVENT_STRUCTURE (event);
 230
 231   if (s) {
 232     gst_structure_set_parent_refcount (s, NULL);
 233     gst_structure_free (s);
 234   }
 235
 236   g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
 237 }
 238
 239 static GstEvent *
 240 _gst_event_copy (GstEventImpl * event)
 241 {
 242   GstEventImpl *copy;
 243   GstStructure *s;
 244
 245   copy = g_slice_dup (GstEventImpl, event);
 246   gst_mini_object_init (GST_MINI_OBJECT_CAST (copy), _gst_event_type,
 247       sizeof (GstEventImpl));
 248
 249   GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
 250   GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
 251   GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
 252
 253   s = GST_EVENT_STRUCTURE (event);
 254   if (s) {
 255     GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
 256     gst_structure_set_parent_refcount (GST_EVENT_STRUCTURE (copy),
 257         &copy->event.mini_object.refcount);
 258   }
 259   return GST_EVENT_CAST (copy);
 260 }
 261
 262 static void
 263 gst_event_init (GstEventImpl * event, gsize size, GstEventType type)
 264 {
 265   gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type, size);
 266
 267   event->event.mini_object.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
 268   event->event.mini_object.free = (GstMiniObjectFreeFunction) _gst_event_free;
 269
 270   GST_EVENT_TYPE (event) = type;
 271   GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
 272   GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
 273 }
 274
 275 static GstEvent *
 276 gst_event_new (GstEventType type)
 277 {
 278   GstEventImpl *event;
 279
 280   event = g_slice_new0 (GstEventImpl);
 281
 282   GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
 283       gst_event_type_get_name (type), type);
 284
 285   gst_event_init (event, sizeof (GstEventImpl), type);
 286
 287   return GST_EVENT_CAST (event);
 288 }
 289
 290 /**
 291  * gst_event_new_custom:
 292  * @type: The type of the new event
 293  * @structure: (transfer full): the structure for the event. The event will
 294  *     take ownership of the structure.
 295  *
 296  * Create a new custom-typed event. This can be used for anything not
 297  * handled by other event-specific functions to pass an event to another
 298  * element.
 299  *
 300  * Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
 301  * assigning a free number and filling in the correct direction and
 302  * serialization flags.
 303  *
 304  * New custom events can also be created by subclassing the event type if
 305  * needed.
 306  *
 307  * Returns: (transfer full): the new custom event.
 308  */
 309 GstEvent *
 310 gst_event_new_custom (GstEventType type, GstStructure * structure)
 311 {
 312   GstEvent *event;
 313
 314   /* structure must not have a parent */
 315   event = gst_event_new (type);
 316   if (structure) {
 317     if (!gst_structure_set_parent_refcount (structure,
 318             &event->mini_object.refcount))
 319       goto had_parent;
 320
 321     GST_EVENT_STRUCTURE (event) = structure;
 322   }
 323   return event;
 324
 325   /* ERRORS */
 326 had_parent:
 327   {
 328     gst_event_unref (event);
 329     g_warning ("structure is already owned by another object");
 330     return NULL;
 331   }
 332 }
 333
 334 static inline GstStructure *
 335 add_structure (GstEvent * event, GQuark name)
 336 {
 337   GstStructure *structure;
 338
 339   structure = gst_structure_id_empty_new (name);
 340   gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
 341   /* FIXME, concurrent access can make us leak this */
 342   GST_EVENT_STRUCTURE (event) = structure;
 343
 344   return structure;
 345 }
 346
 347 static GstStructure *
 348 update_structure (GstEvent * event)
 349 {
 350   GstStructure *structure;
 351
 352   structure = GST_EVENT_STRUCTURE (event);
 353   switch (GST_EVENT_TYPE (event)) {
 354     case GST_EVENT_QOS:
 355     {
 356       if (structure == NULL)
 357         structure = add_structure (event, GST_QUARK (EVENT_QOS));
 358
 359       gst_structure_id_set (structure,
 360           GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, GST_EVENT_IMPL (event, qos,
 361               type), GST_QUARK (PROPORTION), G_TYPE_DOUBLE,
 362           GST_EVENT_IMPL (event, qos, proportion), GST_QUARK (DIFF),
 363           G_TYPE_INT64, GST_EVENT_IMPL (event, qos, diff),
 364           GST_QUARK (TIMESTAMP), G_TYPE_UINT64, GST_EVENT_IMPL (event, qos,
 365               timestamp), NULL);
 366       break;
 367     }
 368     default:
 369       break;
 370   }
 371   return structure;
 372 }
 373
 374 /**
 375  * gst_event_get_structure:
 376  * @event: The #GstEvent.
 377  *
 378  * Access the structure of the event.
 379  *
 380  * Returns: The structure of the event. The structure is still
 381  * owned by the event, which means that you should not free it and
 382  * that the pointer becomes invalid when you free the event.
 383  *
 384  * MT safe.
 385  */
 386 const GstStructure *
 387 gst_event_get_structure (GstEvent * event)
 388 {
 389   g_return_val_if_fail (GST_IS_EVENT (event), NULL);
 390
 391   return update_structure (event);
 392 }
 393
 394 /**
 395  * gst_event_writable_structure:
 396  * @event: The #GstEvent.
 397  *
 398  * Get a writable version of the structure.
 399  *
 400  * Returns: The structure of the event. The structure is still
 401  * owned by the event, which means that you should not free it and
 402  * that the pointer becomes invalid when you free the event.
 403  * This function checks if @event is writable and will never return NULL.
 404  *
 405  * MT safe.
 406  */
 407 GstStructure *
 408 gst_event_writable_structure (GstEvent * event)
 409 {
 410   GstStructure *structure;
 411
 412   g_return_val_if_fail (GST_IS_EVENT (event), NULL);
 413   g_return_val_if_fail (gst_event_is_writable (event), NULL);
 414
 415   structure = update_structure (event);
 416
 417   if (structure == NULL)
 418     structure =
 419         add_structure (event, gst_event_type_to_quark (GST_EVENT_TYPE (event)));
 420
 421   return structure;
 422 }
 423
 424 /**
 425  * gst_event_has_name:
 426  * @event: The #GstEvent.
 427  * @name: name to check
 428  *
 429  * Checks if @event has the given @name. This function is usually used to
 430  * check the name of a custom event.
 431  *
 432  * Returns: %TRUE if @name matches the name of the event structure.
 433  *
 434  * Since: 0.10.20
 435  */
 436 gboolean
 437 gst_event_has_name (GstEvent * event, const gchar * name)
 438 {
 439   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
 440
 441   if (GST_EVENT_STRUCTURE (event) == NULL)
 442     return FALSE;
 443
 444   return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
 445 }
 446
 447 /**
 448  * gst_event_get_seqnum:
 449  * @event: A #GstEvent.
 450  *
 451  * Retrieve the sequence number of a event.
 452  *
 453  * Events have ever-incrementing sequence numbers, which may also be set
 454  * explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
 455  * indicate that a event corresponds to some other set of events or messages,
 456  * for example an EOS event corresponding to a SEEK event. It is considered good
 457  * practice to make this correspondence when possible, though it is not
 458  * required.
 459  *
 460  * Note that events and messages share the same sequence number incrementor;
 461  * two events or messages will never not have the same sequence number unless
 462  * that correspondence was made explicitly.
 463  *
 464  * Returns: The event's sequence number.
 465  *
 466  * MT safe.
 467  *
 468  * Since: 0.10.22
 469  */
 470 guint32
 471 gst_event_get_seqnum (GstEvent * event)
 472 {
 473   g_return_val_if_fail (GST_IS_EVENT (event), -1);
 474
 475   return GST_EVENT_SEQNUM (event);
 476 }
 477
 478 /**
 479  * gst_event_set_seqnum:
 480  * @event: A #GstEvent.
 481  * @seqnum: A sequence number.
 482  *
 483  * Set the sequence number of a event.
 484  *
 485  * This function might be called by the creator of a event to indicate that the
 486  * event relates to other events or messages. See gst_event_get_seqnum() for
 487  * more information.
 488  *
 489  * MT safe.
 490  *
 491  * Since: 0.10.22
 492  */
 493 void
 494 gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
 495 {
 496   g_return_if_fail (GST_IS_EVENT (event));
 497
 498   GST_EVENT_SEQNUM (event) = seqnum;
 499 }
 500
 501 /* FIXME 0.11: It would be nice to have flush events
 502  * that don't reset the running time in the sinks
 503  */
 504
 505 /**
 506  * gst_event_new_flush_start:
 507  *
 508  * Allocate a new flush start event. The flush start event can be sent
 509  * upstream and downstream and travels out-of-bounds with the dataflow.
 510  *
 511  * It marks pads as being flushing and will make them return
 512  * #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
 513  * gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
 514  * gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
 515  * on a flushing pad will return %FALSE immediately.
 516  *
 517  * Elements should unlock any blocking functions and exit their streaming
 518  * functions as fast as possible when this event is received.
 519  *
 520  * This event is typically generated after a seek to flush out all queued data
 521  * in the pipeline so that the new media is played as soon as possible.
 522  *
 523  * Returns: (transfer full): a new flush start event.
 524  */
 525 GstEvent *
 526 gst_event_new_flush_start (void)
 527 {
 528   return gst_event_new (GST_EVENT_FLUSH_START);
 529 }
 530
 531 /**
 532  * gst_event_new_flush_stop:
 533  *
 534  * Allocate a new flush stop event. The flush stop event can be sent
 535  * upstream and downstream and travels serialized with the dataflow.
 536  * It is typically sent after sending a FLUSH_START event to make the
 537  * pads accept data again.
 538  *
 539  * Elements can process this event synchronized with the dataflow since
 540  * the preceeding FLUSH_START event stopped the dataflow.
 541  *
 542  * This event is typically generated to complete a seek and to resume
 543  * dataflow.
 544  *
 545  * Returns: (transfer full): a new flush stop event.
 546  */
 547 GstEvent *
 548 gst_event_new_flush_stop (void)
 549 {
 550   return gst_event_new (GST_EVENT_FLUSH_STOP);
 551 }
 552
 553 /**
 554  * gst_event_new_eos:
 555  *
 556  * Create a new EOS event. The eos event can only travel downstream
 557  * synchronized with the buffer flow. Elements that receive the EOS
 558  * event on a pad can return #GST_FLOW_UNEXPECTED as a #GstFlowReturn
 559  * when data after the EOS event arrives.
 560  *
 561  * The EOS event will travel down to the sink elements in the pipeline
 562  * which will then post the #GST_MESSAGE_EOS on the bus after they have
 563  * finished playing any buffered data.
 564  *
 565  * When all sinks have posted an EOS message, an EOS message is
 566  * forwarded to the application.
 567  *
 568  * The EOS event itself will not cause any state transitions of the pipeline.
 569  *
 570  * Returns: (transfer full): the new EOS event.
 571  */
 572 GstEvent *
 573 gst_event_new_eos (void)
 574 {
 575   return gst_event_new (GST_EVENT_EOS);
 576 }
 577
 578 /**
 579  * gst_event_new_caps:
 580  * @caps: a #GstCaps
 581  *
 582  * Create a new CAPS event for @caps. The caps event can only travel downstream
 583  * synchronized with the buffer flow and contain the format of the buffers
 584  * that will follow after the event.
 585  *
 586  * Returns: (transfer full): the new CAPS event.
 587  */
 588 GstEvent *
 589 gst_event_new_caps (GstCaps * caps)
 590 {
 591   GstEvent *event;
 592
 593   g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), NULL);
 594
 595   GST_CAT_INFO (GST_CAT_EVENT, "creating caps event %" GST_PTR_FORMAT, caps);
 596
 597   event = gst_event_new_custom (GST_EVENT_CAPS,
 598       gst_structure_id_new (GST_QUARK (EVENT_CAPS),
 599           GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));
 600
 601   return event;
 602 }
 603
 604 /**
 605  * gst_event_parse_caps:
 606  * @event: The event to parse
 607  * @caps: (out): A pointer to the caps
 608  *
 609  * Get the caps from @event. The caps remains valid as long as @event remains
 610  * valid.
 611  */
 612 void
 613 gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
 614 {
 615   GstStructure *structure;
 616
 617   g_return_if_fail (GST_IS_EVENT (event));
 618   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_CAPS);
 619
 620   structure = GST_EVENT_STRUCTURE (event);
 621   if (G_LIKELY (caps))
 622     *caps =
 623         g_value_get_boxed (gst_structure_id_get_value (structure,
 624             GST_QUARK (CAPS)));
 625 }
 626
 627 /**
 628  * gst_event_new_new_segment:
 629  * @update: Whether this segment is an update to a previous one
 630  * @rate: A new rate for playback
 631  * @applied_rate: The rate factor which has already been applied
 632  * @format: The format of the segment values
 633  * @start: The start value of the segment
 634  * @stop: The stop value of the segment
 635  * @time: the time value of the segment
 636  *
 637  * Allocate a new newsegment event with the given format/values triplets.
 638  *
 639  * The newsegment event marks the range of buffers to be processed. All
 640  * data not within the segment range is not to be processed. This can be
 641  * used intelligently by plugins to apply more efficient methods of skipping
 642  * unneeded data. The valid range is expressed with the @start and @stop
 643  * values.
 644  *
 645  * The time value of the segment is used in conjunction with the start
 646  * value to convert the buffer timestamps into the stream time. This is
 647  * usually done in sinks to report the current stream_time.
 648  * @time represents the stream_time of a buffer carrying a timestamp of
 649  * @start. @time cannot be -1.
 650  *
 651  * @start cannot be -1, @stop can be -1. If there
 652  * is a valid @stop given, it must be greater or equal the @start, including
 653  * when the indicated playback @rate is < 0.
 654  *
 655  * The @applied_rate value provides information about any rate adjustment that
 656  * has already been made to the timestamps and content on the buffers of the
 657  * stream. (@rate * @applied_rate) should always equal the rate that has been
 658  * requested for playback. For example, if an element has an input segment
 659  * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
 660  * incoming timestamps and buffer content by half and output a newsegment event
 661  * with @rate of 1.0 and @applied_rate of 2.0
 662  *
 663  * After a newsegment event, the buffer stream time is calculated with:
 664  *
 665  *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
 666  *
 667  * Returns: (transfer full): a new newsegment event.
 668  *
 669  * Since: 0.10.6
 670  */
 671 GstEvent *
 672 gst_event_new_new_segment (gboolean update, gdouble rate,
 673     gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
 674     gint64 time)
 675 {
 676   GstEvent *event;
 677   GstStructure *structure;
 678
 679   g_return_val_if_fail (rate != 0.0, NULL);
 680   g_return_val_if_fail (applied_rate != 0.0, NULL);
 681
 682   if (format == GST_FORMAT_TIME) {
 683     GST_CAT_INFO (GST_CAT_EVENT,
 684         "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
 685         "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
 686         ", time %" GST_TIME_FORMAT,
 687         update, rate, GST_TIME_ARGS (start),
 688         GST_TIME_ARGS (stop), GST_TIME_ARGS (time));
 689   } else {
 690     GST_CAT_INFO (GST_CAT_EVENT,
 691         "creating newsegment update %d, rate %lf, format %s, "
 692         "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", time %"
 693         G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
 694         stop, time);
 695   }
 696
 697   g_return_val_if_fail (time != -1, NULL);
 698   g_return_val_if_fail (start != -1, NULL);
 699   if (stop != -1)
 700     g_return_val_if_fail (start <= stop, NULL);
 701
 702   structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
 703       GST_QUARK (UPDATE), G_TYPE_BOOLEAN, update,
 704       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
 705       GST_QUARK (APPLIED_RATE), G_TYPE_DOUBLE, applied_rate,
 706       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 707       GST_QUARK (START), G_TYPE_INT64, start,
 708       GST_QUARK (STOP), G_TYPE_INT64, stop,
 709       GST_QUARK (TIME), G_TYPE_INT64, time, NULL);
 710   event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);
 711
 712   return event;
 713 }
 714
 715 /**
 716  * gst_event_parse_new_segment:
 717  * @event: The event to query
 718  * @update: (out): A pointer to the update flag of the segment
 719  * @rate: (out): A pointer to the rate of the segment
 720  * @applied_rate: (out): A pointer to the applied_rate of the segment
 721  * @format: (out): A pointer to the format of the newsegment values
 722  * @start: (out): A pointer to store the start value in
 723  * @stop: (out): A pointer to store the stop value in
 724  * @time: (out): A pointer to store the time value in
 725  *
 726  * Get the update, rate, applied_rate, format, start, stop and
 727  * time in the newsegment event. See gst_event_new_new_segment()
 728  * for a full description of the newsegment event.
 729  *
 730  * Since: 0.10.6
 731  */
 732 void
 733 gst_event_parse_new_segment (GstEvent * event, gboolean * update,
 734     gdouble * rate, gdouble * applied_rate, GstFormat * format,
 735     gint64 * start, gint64 * stop, gint64 * time)
 736 {
 737   const GstStructure *structure;
 738
 739   g_return_if_fail (GST_IS_EVENT (event));
 740   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);
 741
 742   structure = GST_EVENT_STRUCTURE (event);
 743   if (G_LIKELY (update))
 744     *update =
 745         g_value_get_boolean (gst_structure_id_get_value (structure,
 746             GST_QUARK (UPDATE)));
 747   if (G_LIKELY (rate))
 748     *rate =
 749         g_value_get_double (gst_structure_id_get_value (structure,
 750             GST_QUARK (RATE)));
 751   if (G_LIKELY (applied_rate))
 752     *applied_rate =
 753         g_value_get_double (gst_structure_id_get_value (structure,
 754             GST_QUARK (APPLIED_RATE)));
 755   if (G_LIKELY (format))
 756     *format =
 757         g_value_get_enum (gst_structure_id_get_value (structure,
 758             GST_QUARK (FORMAT)));
 759   if (G_LIKELY (start))
 760     *start =
 761         g_value_get_int64 (gst_structure_id_get_value (structure,
 762             GST_QUARK (START)));
 763   if (G_LIKELY (stop))
 764     *stop =
 765         g_value_get_int64 (gst_structure_id_get_value (structure,
 766             GST_QUARK (STOP)));
 767   if (G_LIKELY (time))
 768     *time =
 769         g_value_get_int64 (gst_structure_id_get_value (structure,
 770             GST_QUARK (TIME)));
 771 }
 772
 773 /**
 774  * gst_event_new_tag:
 775  * @taglist: (transfer full): metadata list. The event will take ownership
 776  *     of the taglist.
 777  *
 778  * Generates a metadata tag event from the given @taglist.
 779  *
 780  * Returns: (transfer full): a new #GstEvent
 781  */
 782 GstEvent *
 783 gst_event_new_tag (GstTagList * taglist)
 784 {
 785   g_return_val_if_fail (taglist != NULL, NULL);
 786
 787   return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
 788 }
 789
 790 /**
 791  * gst_event_parse_tag:
 792  * @event: a tag event
 793  * @taglist: (out) (transfer none): pointer to metadata list
 794  *
 795  * Parses a tag @event and stores the results in the given @taglist location.
 796  * No reference to the taglist will be returned, it remains valid only until
 797  * the @event is freed. Don't modify or free the taglist, make a copy if you
 798  * want to modify it or store it for later use.
 799  */
 800 void
 801 gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
 802 {
 803   g_return_if_fail (GST_IS_EVENT (event));
 804   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
 805
 806   if (taglist)
 807     *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
 808 }
 809
 810 /* buffersize event */
 811 /**
 812  * gst_event_new_buffer_size:
 813  * @format: buffer format
 814  * @minsize: minimum buffer size
 815  * @maxsize: maximum buffer size
 816  * @async: thread behavior
 817  *
 818  * Create a new buffersize event. The event is sent downstream and notifies
 819  * elements that they should provide a buffer of the specified dimensions.
 820  *
 821  * When the @async flag is set, a thread boundary is prefered.
 822  *
 823  * Returns: (transfer full): a new #GstEvent
 824  */
 825 GstEvent *
 826 gst_event_new_buffer_size (GstFormat format, gint64 minsize,
 827     gint64 maxsize, gboolean async)
 828 {
 829   GstEvent *event;
 830   GstStructure *structure;
 831
 832   GST_CAT_INFO (GST_CAT_EVENT,
 833       "creating buffersize format %s, minsize %" G_GINT64_FORMAT
 834       ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
 835       minsize, maxsize, async);
 836
 837   structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
 838       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
 839       GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
 840       GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
 841       GST_QUARK (ASYNC), G_TYPE_BOOLEAN, async, NULL);
 842   event = gst_event_new_custom (GST_EVENT_BUFFERSIZE, structure);
 843
 844   return event;
 845 }
 846
 847 /**
 848  * gst_event_parse_buffer_size:
 849  * @event: The event to query
 850  * @format: (out): A pointer to store the format in
 851  * @minsize: (out): A pointer to store the minsize in
 852  * @maxsize: (out): A pointer to store the maxsize in
 853  * @async: (out): A pointer to store the async-flag in
 854  *
 855  * Get the format, minsize, maxsize and async-flag in the buffersize event.
 856  */
 857 void
 858 gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
 859     gint64 * minsize, gint64 * maxsize, gboolean * async)
 860 {
 861   const GstStructure *structure;
 862
 863   g_return_if_fail (GST_IS_EVENT (event));
 864   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_BUFFERSIZE);
 865
 866   structure = GST_EVENT_STRUCTURE (event);
 867   if (format)
 868     *format =
 869         g_value_get_enum (gst_structure_id_get_value (structure,
 870             GST_QUARK (FORMAT)));
 871   if (minsize)
 872     *minsize =
 873         g_value_get_int64 (gst_structure_id_get_value (structure,
 874             GST_QUARK (MINSIZE)));
 875   if (maxsize)
 876     *maxsize =
 877         g_value_get_int64 (gst_structure_id_get_value (structure,
 878             GST_QUARK (MAXSIZE)));
 879   if (async)
 880     *async =
 881         g_value_get_boolean (gst_structure_id_get_value (structure,
 882             GST_QUARK (ASYNC)));
 883 }
 884
 885 /**
 886  * gst_event_new_qos:
 887  * @type: the QoS type
 888  * @proportion: the proportion of the qos message
 889  * @diff: The time difference of the last Clock sync
 890  * @timestamp: The timestamp of the buffer
 891  *
 892  * Allocate a new qos event with the given values.
 893  * The QOS event is generated in an element that wants an upstream
 894  * element to either reduce or increase its rate because of
 895  * high/low CPU load or other resource usage such as network performance or
 896  * throttling. Typically sinks generate these events for each buffer
 897  * they receive.
 898  *
 899  * @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
 900  * used when a buffer arrived in time or when the sink cannot keep up with
 901  * the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
 902  * receiving buffers fast enough and thus has to drop late buffers.
 903  * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
 904  * by the application, for example to reduce power consumption.
 905  *
 906  * @proportion indicates the real-time performance of the streaming in the
 907  * element that generated the QoS event (usually the sink). The value is
 908  * generally computed based on more long term statistics about the streams
 909  * timestamps compared to the clock.
 910  * A value < 1.0 indicates that the upstream element is producing data faster
 911  * than real-time. A value > 1.0 indicates that the upstream element is not
 912  * producing data fast enough. 1.0 is the ideal @proportion value. The
 913  * proportion value can safely be used to lower or increase the quality of
 914  * the element.
 915  *
 916  * @diff is the difference against the clock in running time of the last
 917  * buffer that caused the element to generate the QOS event. A negative value
 918  * means that the buffer with @timestamp arrived in time. A positive value
 919  * indicates how late the buffer with @timestamp was. When throttling is
 920  * enabled, @diff will be set to the requested throttling interval.
 921  *
 922  * @timestamp is the timestamp of the last buffer that cause the element
 923  * to generate the QOS event. It is expressed in running time and thus an ever
 924  * increasing value.
 925  *
 926  * The upstream element can use the @diff and @timestamp values to decide
 927  * whether to process more buffers. For possitive @diff, all buffers with
 928  * timestamp <= @timestamp + @diff will certainly arrive late in the sink
 929  * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 930  * result smaller than 0 is not allowed.
 931  *
 932  * The application can use general event probes to intercept the QoS
 933  * event and implement custom application specific QoS handling.
 934  *
 935  * Returns: (transfer full): a new QOS event.
 936  */
 937 GstEvent *
 938 gst_event_new_qos (GstQOSType type, gdouble proportion,
 939     GstClockTimeDiff diff, GstClockTime timestamp)
 940 {
 941   GstEvent *event;
 942
 943   /* diff must be positive or timestamp + diff must be positive */
 944   g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);
 945
 946   GST_CAT_INFO (GST_CAT_EVENT,
 947       "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
 948       ", timestamp %" GST_TIME_FORMAT, type, proportion,
 949       diff, GST_TIME_ARGS (timestamp));
 950
 951   event = gst_event_new (GST_EVENT_QOS);
 952
 953   GST_EVENT_IMPL (event, qos, type) = type;
 954   GST_EVENT_IMPL (event, qos, proportion) = proportion;
 955   GST_EVENT_IMPL (event, qos, diff) = diff;
 956   GST_EVENT_IMPL (event, qos, timestamp) = timestamp;
 957
 958   return event;
 959 }
 960
 961 /**
 962  * gst_event_parse_qos:
 963  * @event: The event to query
 964  * @type: (out): A pointer to store the QoS type in
 965  * @proportion: (out): A pointer to store the proportion in
 966  * @diff: (out): A pointer to store the diff in
 967  * @timestamp: (out): A pointer to store the timestamp in
 968  *
 969  * Get the type, proportion, diff and timestamp in the qos event. See
 970  * gst_event_new_qos() for more information about the different QoS values.
 971  */
 972 void
 973 gst_event_parse_qos (GstEvent * event, GstQOSType * type,
 974     gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
 975 {
 976   g_return_if_fail (GST_IS_EVENT (event));
 977   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
 978
 979   if (type)
 980     *type = GST_EVENT_IMPL (event, qos, type);
 981   if (proportion)
 982     *proportion = GST_EVENT_IMPL (event, qos, proportion);
 983   if (diff)
 984     *diff = GST_EVENT_IMPL (event, qos, diff);
 985   if (timestamp)
 986     *timestamp = GST_EVENT_IMPL (event, qos, timestamp);
 987 }
 988
 989 /**
 990  * gst_event_new_seek:
 991  * @rate: The new playback rate
 992  * @format: The format of the seek values
 993  * @flags: The optional seek flags
 994  * @start_type: The type and flags for the new start position
 995  * @start: The value of the new start position
 996  * @stop_type: The type and flags for the new stop position
 997  * @stop: The value of the new stop position
 998  *
 999  * Allocate a new seek event with the given parameters.
1000  *
1001  * The seek event configures playback of the pipeline between @start to @stop
1002  * at the speed given in @rate, also called a playback segment.
1003  * The @start and @stop values are expressed in @format.
1004  *
1005  * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
1006  * Negatives values means backwards playback. A value of 0.0 for the
1007  * rate is not allowed and should be accomplished instead by PAUSING the
1008  * pipeline.
1009  *
1010  * A pipeline has a default playback segment configured with a start
1011  * position of 0, a stop position of -1 and a rate of 1.0. The currently
1012  * configured playback segment can be queried with #GST_QUERY_SEGMENT.
1013  *
1014  * @start_type and @stop_type specify how to adjust the currently configured
1015  * start and stop fields in playback segment. Adjustments can be made relative
1016  * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
1017  * means that the position should not be updated.
1018  *
1019  * When the rate is positive and @start has been updated, playback will start
1020  * from the newly configured start position.
1021  *
1022  * For negative rates, playback will start from the newly configured stop
1023  * position (if any). If the stop position if updated, it must be different from
1024  * -1 for negative rates.
1025  *
1026  * It is not possible to seek relative to the current playback position, to do
1027  * this, PAUSE the pipeline, query the current playback position with
1028  * #GST_QUERY_POSITION and update the playback segment current position with a
1029  * #GST_SEEK_TYPE_SET to the desired position.
1030  *
1031  * Returns: (transfer full): a new seek event.
1032  */
1033 GstEvent *
1034 gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
1035     GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
1036 {
1037   GstEvent *event;
1038   GstStructure *structure;
1039
1040   g_return_val_if_fail (rate != 0.0, NULL);
1041
1042   if (format == GST_FORMAT_TIME) {
1043     GST_CAT_INFO (GST_CAT_EVENT,
1044         "creating seek rate %lf, format TIME, flags %d, "
1045         "start_type %d, start %" GST_TIME_FORMAT ", "
1046         "stop_type %d, stop %" GST_TIME_FORMAT,
1047         rate, flags, start_type, GST_TIME_ARGS (start),
1048         stop_type, GST_TIME_ARGS (stop));
1049   } else {
1050     GST_CAT_INFO (GST_CAT_EVENT,
1051         "creating seek rate %lf, format %s, flags %d, "
1052         "start_type %d, start %" G_GINT64_FORMAT ", "
1053         "stop_type %d, stop %" G_GINT64_FORMAT,
1054         rate, gst_format_get_name (format), flags, start_type, start, stop_type,
1055         stop);
1056   }
1057
1058   structure = gst_structure_id_new (GST_QUARK (EVENT_SEEK),
1059       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1060       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1061       GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
1062       GST_QUARK (CUR_TYPE), GST_TYPE_SEEK_TYPE, start_type,
1063       GST_QUARK (CUR), G_TYPE_INT64, start,
1064       GST_QUARK (STOP_TYPE), GST_TYPE_SEEK_TYPE, stop_type,
1065       GST_QUARK (STOP), G_TYPE_INT64, stop, NULL);
1066   event = gst_event_new_custom (GST_EVENT_SEEK, structure);
1067
1068   return event;
1069 }
1070
1071 /**
1072  * gst_event_parse_seek:
1073  * @event: a seek event
1074  * @rate: (out): result location for the rate
1075  * @format: (out): result location for the stream format
1076  * @flags:  (out): result location for the #GstSeekFlags
1077  * @start_type: (out): result location for the #GstSeekType of the start position
1078  * @start: (out): result location for the start postion expressed in @format
1079  * @stop_type:  (out): result location for the #GstSeekType of the stop position
1080  * @stop: (out): result location for the stop postion expressed in @format
1081  *
1082  * Parses a seek @event and stores the results in the given result locations.
1083  */
1084 void
1085 gst_event_parse_seek (GstEvent * event, gdouble * rate,
1086     GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
1087     gint64 * start, GstSeekType * stop_type, gint64 * stop)
1088 {
1089   const GstStructure *structure;
1090
1091   g_return_if_fail (GST_IS_EVENT (event));
1092   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
1093
1094   structure = GST_EVENT_STRUCTURE (event);
1095   if (rate)
1096     *rate =
1097         g_value_get_double (gst_structure_id_get_value (structure,
1098             GST_QUARK (RATE)));
1099   if (format)
1100     *format =
1101         g_value_get_enum (gst_structure_id_get_value (structure,
1102             GST_QUARK (FORMAT)));
1103   if (flags)
1104     *flags =
1105         g_value_get_flags (gst_structure_id_get_value (structure,
1106             GST_QUARK (FLAGS)));
1107   if (start_type)
1108     *start_type =
1109         g_value_get_enum (gst_structure_id_get_value (structure,
1110             GST_QUARK (CUR_TYPE)));
1111   if (start)
1112     *start =
1113         g_value_get_int64 (gst_structure_id_get_value (structure,
1114             GST_QUARK (CUR)));
1115   if (stop_type)
1116     *stop_type =
1117         g_value_get_enum (gst_structure_id_get_value (structure,
1118             GST_QUARK (STOP_TYPE)));
1119   if (stop)
1120     *stop =
1121         g_value_get_int64 (gst_structure_id_get_value (structure,
1122             GST_QUARK (STOP)));
1123 }
1124
1125 /**
1126  * gst_event_new_navigation:
1127  * @structure: (transfer full): description of the event. The event will take
1128  *     ownership of the structure.
1129  *
1130  * Create a new navigation event from the given description.
1131  *
1132  * Returns: (transfer full): a new #GstEvent
1133  */
1134 GstEvent *
1135 gst_event_new_navigation (GstStructure * structure)
1136 {
1137   g_return_val_if_fail (structure != NULL, NULL);
1138
1139   return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
1140 }
1141
1142 /**
1143  * gst_event_new_latency:
1144  * @latency: the new latency value
1145  *
1146  * Create a new latency event. The event is sent upstream from the sinks and
1147  * notifies elements that they should add an additional @latency to the
1148  * running time before synchronising against the clock.
1149  *
1150  * The latency is mostly used in live sinks and is always expressed in
1151  * the time format.
1152  *
1153  * Returns: (transfer full): a new #GstEvent
1154  *
1155  * Since: 0.10.12
1156  */
1157 GstEvent *
1158 gst_event_new_latency (GstClockTime latency)
1159 {
1160   GstEvent *event;
1161   GstStructure *structure;
1162
1163   GST_CAT_INFO (GST_CAT_EVENT,
1164       "creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));
1165
1166   structure = gst_structure_id_new (GST_QUARK (EVENT_LATENCY),
1167       GST_QUARK (LATENCY), G_TYPE_UINT64, latency, NULL);
1168   event = gst_event_new_custom (GST_EVENT_LATENCY, structure);
1169
1170   return event;
1171 }
1172
1173 /**
1174  * gst_event_parse_latency:
1175  * @event: The event to query
1176  * @latency: (out): A pointer to store the latency in.
1177  *
1178  * Get the latency in the latency event.
1179  *
1180  * Since: 0.10.12
1181  */
1182 void
1183 gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
1184 {
1185   g_return_if_fail (GST_IS_EVENT (event));
1186   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_LATENCY);
1187
1188   if (latency)
1189     *latency =
1190         g_value_get_uint64 (gst_structure_id_get_value (GST_EVENT_STRUCTURE
1191             (event), GST_QUARK (LATENCY)));
1192 }
1193
1194 /**
1195  * gst_event_new_step:
1196  * @format: the format of @amount
1197  * @amount: the amount of data to step
1198  * @rate: the step rate
1199  * @flush: flushing steps
1200  * @intermediate: intermediate steps
1201  *
1202  * Create a new step event. The purpose of the step event is to instruct a sink
1203  * to skip @amount (expressed in @format) of media. It can be used to implement
1204  * stepping through the video frame by frame or for doing fast trick modes.
1205  *
1206  * A rate of <= 0.0 is not allowed, pause the pipeline or reverse the playback
1207  * direction of the pipeline to get the same effect.
1208  *
1209  * The @flush flag will clear any pending data in the pipeline before starting
1210  * the step operation.
1211  *
1212  * The @intermediate flag instructs the pipeline that this step operation is
1213  * part of a larger step operation.
1214  *
1215  * Returns: (transfer full): a new #GstEvent
1216  *
1217  * Since: 0.10.24
1218  */
1219 GstEvent *
1220 gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
1221     gboolean flush, gboolean intermediate)
1222 {
1223   GstEvent *event;
1224   GstStructure *structure;
1225
1226   g_return_val_if_fail (rate > 0.0, NULL);
1227
1228   GST_CAT_INFO (GST_CAT_EVENT, "creating step event");
1229
1230   structure = gst_structure_id_new (GST_QUARK (EVENT_STEP),
1231       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1232       GST_QUARK (AMOUNT), G_TYPE_UINT64, amount,
1233       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1234       GST_QUARK (FLUSH), G_TYPE_BOOLEAN, flush,
1235       GST_QUARK (INTERMEDIATE), G_TYPE_BOOLEAN, intermediate, NULL);
1236   event = gst_event_new_custom (GST_EVENT_STEP, structure);
1237
1238   return event;
1239 }
1240
1241 /**
1242  * gst_event_parse_step:
1243  * @event: The event to query
1244  * @format: (out) (allow-none): a pointer to store the format in
1245  * @amount: (out) (allow-none): a pointer to store the amount in
1246  * @rate: (out) (allow-none): a pointer to store the rate in
1247  * @flush: (out) (allow-none): a pointer to store the flush boolean in
1248  * @intermediate: (out) (allow-none): a pointer to store the intermediate
1249  *     boolean in
1250  *
1251  * Parse the step event.
1252  *
1253  * Since: 0.10.24
1254  */
1255 void
1256 gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
1257     gdouble * rate, gboolean * flush, gboolean * intermediate)
1258 {
1259   const GstStructure *structure;
1260
1261   g_return_if_fail (GST_IS_EVENT (event));
1262   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STEP);
1263
1264   structure = GST_EVENT_STRUCTURE (event);
1265   if (format)
1266     *format = g_value_get_enum (gst_structure_id_get_value (structure,
1267             GST_QUARK (FORMAT)));
1268   if (amount)
1269     *amount = g_value_get_uint64 (gst_structure_id_get_value (structure,
1270             GST_QUARK (AMOUNT)));
1271   if (rate)
1272     *rate = g_value_get_double (gst_structure_id_get_value (structure,
1273             GST_QUARK (RATE)));
1274   if (flush)
1275     *flush = g_value_get_boolean (gst_structure_id_get_value (structure,
1276             GST_QUARK (FLUSH)));
1277   if (intermediate)
1278     *intermediate = g_value_get_boolean (gst_structure_id_get_value (structure,
1279             GST_QUARK (INTERMEDIATE)));
1280 }
1281
1282 /**
1283  * gst_event_new_reconfigure:
1284
1285  * Create a new reconfigure event. The purpose of the reconfingure event is
1286  * to travel upstream and make elements renegotiate their caps or reconfigure
1287  * their buffer pools. This is useful when changing properties on elements
1288  * or changing the topology of the pipeline.
1289  *
1290  * Returns: (transfer full): a new #GstEvent
1291  *
1292  * Since: 0.10.34
1293  */
1294 GstEvent *
1295 gst_event_new_reconfigure (void)
1296 {
1297   GstEvent *event;
1298
1299   GST_CAT_INFO (GST_CAT_EVENT, "creating reconfigure event");
1300
1301   event = gst_event_new_custom (GST_EVENT_RECONFIGURE, NULL);
1302
1303   return event;
1304 }
1305
1306 /**
1307  * gst_event_new_sink_message:
1308  * @msg: (transfer none): the #GstMessage to be posted
1309  *
1310  * Create a new sink-message event. The purpose of the sink-message event is
1311  * to instruct a sink to post the message contained in the event synchronized
1312  * with the stream.
1313  *
1314  * Returns: (transfer full): a new #GstEvent
1315  *
1316  * Since: 0.10.26
1317  */
1318 /* FIXME 0.11: take ownership of msg for consistency? */
1319 GstEvent *
1320 gst_event_new_sink_message (GstMessage * msg)
1321 {
1322   GstEvent *event;
1323   GstStructure *structure;
1324
1325   g_return_val_if_fail (msg != NULL, NULL);
1326
1327   GST_CAT_INFO (GST_CAT_EVENT, "creating sink-message event");
1328
1329   structure = gst_structure_id_new (GST_QUARK (EVENT_SINK_MESSAGE),
1330       GST_QUARK (MESSAGE), GST_TYPE_MESSAGE, msg, NULL);
1331   event = gst_event_new_custom (GST_EVENT_SINK_MESSAGE, structure);
1332
1333   return event;
1334 }
1335
1336 /**
1337  * gst_event_parse_sink_message:
1338  * @event: The event to query
1339  * @msg: (out) (transfer full): a pointer to store the #GstMessage in.
1340  *
1341  * Parse the sink-message event. Unref @msg after usage.
1342  *
1343  * Since: 0.10.26
1344  */
1345 void
1346 gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
1347 {
1348   const GstStructure *structure;
1349
1350   g_return_if_fail (GST_IS_EVENT (event));
1351   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE);
1352
1353   structure = GST_EVENT_STRUCTURE (event);
1354   if (msg)
1355     *msg =
1356         GST_MESSAGE (g_value_dup_boxed (gst_structure_id_get_value
1357             (structure, GST_QUARK (MESSAGE))));
1358 }