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