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