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