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