docs: fix typo in GstEvent docs
[platform/upstream/gstreamer.git] / 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., 51 Franklin St, Fifth Floor,
21  * Boston, MA 02110-1301, 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  * |[
55  *   GstEvent *event;
56  *   gboolean result;
57  *   ...
58  *   // construct a seek event to play the media from second 2 to 5, flush
59  *   // the pipeline to decrease latency.
60  *   event = gst_event_new_seek (1.0, 
61  *      GST_FORMAT_TIME, 
62  *      GST_SEEK_FLAG_FLUSH,
63  *      GST_SEEK_TYPE_SET, 2 * GST_SECOND,
64  *      GST_SEEK_TYPE_SET, 5 * GST_SECOND);
65  *   ...
66  *   result = gst_element_send_event (pipeline, event);
67  *   if (!result)
68  *     g_warning ("seek failed");
69  *   ...
70  * ]|
71  */
72
73
74 #include "gst_private.h"
75 #include <string.h>             /* memcpy */
76
77 #include "gstinfo.h"
78 #include "gstevent.h"
79 #include "gstenumtypes.h"
80 #include "gstutils.h"
81 #include "gstquark.h"
82 #include "gstvalue.h"
83
84 GType _gst_event_type = 0;
85
86 typedef struct
87 {
88   GstEvent event;
89
90   GstStructure *structure;
91   gint64 running_time_offset;
92 } GstEventImpl;
93
94 #define GST_EVENT_STRUCTURE(e)  (((GstEventImpl *)(e))->structure)
95
96 typedef struct
97 {
98   const gint type;
99   const gchar *name;
100   GQuark quark;
101 } GstEventQuarks;
102
103 static GstEventQuarks event_quarks[] = {
104   {GST_EVENT_UNKNOWN, "unknown", 0},
105   {GST_EVENT_FLUSH_START, "flush-start", 0},
106   {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
107   {GST_EVENT_STREAM_START, "stream-start", 0},
108   {GST_EVENT_CAPS, "caps", 0},
109   {GST_EVENT_SEGMENT, "segment", 0},
110   {GST_EVENT_TAG, "tag", 0},
111   {GST_EVENT_TOC, "toc", 0},
112   {GST_EVENT_BUFFERSIZE, "buffersize", 0},
113   {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
114   {GST_EVENT_EOS, "eos", 0},
115   {GST_EVENT_SEGMENT_DONE, "segment-done", 0},
116   {GST_EVENT_GAP, "gap", 0},
117   {GST_EVENT_QOS, "qos", 0},
118   {GST_EVENT_SEEK, "seek", 0},
119   {GST_EVENT_NAVIGATION, "navigation", 0},
120   {GST_EVENT_LATENCY, "latency", 0},
121   {GST_EVENT_STEP, "step", 0},
122   {GST_EVENT_RECONFIGURE, "reconfigure", 0},
123   {GST_EVENT_TOC_SELECT, "toc-select", 0},
124   {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
125   {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
126   {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
127   {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
128   {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
129   {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},
130
131   {0, NULL, 0}
132 };
133
134 GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
135
136 void
137 _priv_gst_event_initialize (void)
138 {
139   gint i;
140
141   _gst_event_type = gst_event_get_type ();
142
143   g_type_class_ref (gst_seek_flags_get_type ());
144   g_type_class_ref (gst_seek_type_get_type ());
145
146   for (i = 0; event_quarks[i].name; i++) {
147     event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name);
148   }
149 }
150
151 /**
152  * gst_event_type_get_name:
153  * @type: the event type
154  *
155  * Get a printable name for the given event type. Do not modify or free.
156  *
157  * Returns: a reference to the static name of the event.
158  */
159 const gchar *
160 gst_event_type_get_name (GstEventType type)
161 {
162   gint i;
163
164   for (i = 0; event_quarks[i].name; i++) {
165     if (type == event_quarks[i].type)
166       return event_quarks[i].name;
167   }
168   return "unknown";
169 }
170
171 /**
172  * gst_event_type_to_quark:
173  * @type: the event type
174  *
175  * Get the unique quark for the given event type.
176  *
177  * Returns: the quark associated with the event type
178  */
179 GQuark
180 gst_event_type_to_quark (GstEventType type)
181 {
182   gint i;
183
184   for (i = 0; event_quarks[i].name; i++) {
185     if (type == event_quarks[i].type)
186       return event_quarks[i].quark;
187   }
188   return 0;
189 }
190
191 /**
192  * gst_event_type_get_flags:
193  * @type: a #GstEventType
194  *
195  * Gets the #GstEventTypeFlags associated with @type.
196  *
197  * Returns: a #GstEventTypeFlags.
198  */
199 GstEventTypeFlags
200 gst_event_type_get_flags (GstEventType type)
201 {
202   GstEventTypeFlags ret;
203
204   ret = type & ((1 << GST_EVENT_NUM_SHIFT) - 1);
205
206   return ret;
207 }
208
209 static void
210 _gst_event_free (GstEvent * event)
211 {
212   GstStructure *s;
213
214   g_return_if_fail (event != NULL);
215   g_return_if_fail (GST_IS_EVENT (event));
216
217   GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
218       GST_EVENT_TYPE_NAME (event));
219
220   s = GST_EVENT_STRUCTURE (event);
221
222   if (s) {
223     gst_structure_set_parent_refcount (s, NULL);
224     gst_structure_free (s);
225   }
226
227   g_slice_free1 (sizeof (GstEventImpl), event);
228 }
229
230 static void gst_event_init (GstEventImpl * event, GstEventType type);
231
232 static GstEvent *
233 _gst_event_copy (GstEvent * event)
234 {
235   GstEventImpl *copy;
236   GstStructure *s;
237
238   copy = g_slice_new0 (GstEventImpl);
239
240   gst_event_init (copy, GST_EVENT_TYPE (event));
241
242   GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
243   GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
244
245   s = GST_EVENT_STRUCTURE (event);
246   if (s) {
247     GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
248     gst_structure_set_parent_refcount (GST_EVENT_STRUCTURE (copy),
249         &copy->event.mini_object.refcount);
250   } else {
251     GST_EVENT_STRUCTURE (copy) = NULL;
252   }
253
254   ((GstEventImpl *) copy)->running_time_offset =
255       ((GstEventImpl *) event)->running_time_offset;
256
257   return GST_EVENT_CAST (copy);
258 }
259
260 static void
261 gst_event_init (GstEventImpl * event, GstEventType type)
262 {
263   gst_mini_object_init (GST_MINI_OBJECT_CAST (event), 0, _gst_event_type,
264       (GstMiniObjectCopyFunction) _gst_event_copy, NULL,
265       (GstMiniObjectFreeFunction) _gst_event_free);
266
267   GST_EVENT_TYPE (event) = type;
268   GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
269   GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
270   event->running_time_offset = 0;
271 }
272
273
274 /**
275  * gst_event_new_custom:
276  * @type: The type of the new event
277  * @structure: (transfer full): the structure for the event. The event will
278  *     take ownership of the structure.
279  *
280  * Create a new custom-typed event. This can be used for anything not
281  * handled by other event-specific functions to pass an event to another
282  * element.
283  *
284  * Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
285  * assigning a free number and filling in the correct direction and
286  * serialization flags.
287  *
288  * New custom events can also be created by subclassing the event type if
289  * needed.
290  *
291  * Returns: (transfer full): the new custom event.
292  */
293 GstEvent *
294 gst_event_new_custom (GstEventType type, GstStructure * structure)
295 {
296   GstEventImpl *event;
297
298   event = g_slice_new0 (GstEventImpl);
299
300   GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
301       gst_event_type_get_name (type), type);
302
303   if (structure) {
304     /* structure must not have a parent */
305     if (!gst_structure_set_parent_refcount (structure,
306             &event->event.mini_object.refcount))
307       goto had_parent;
308
309   }
310   gst_event_init (event, type);
311
312   GST_EVENT_STRUCTURE (event) = structure;
313
314   return GST_EVENT_CAST (event);
315
316   /* ERRORS */
317 had_parent:
318   {
319     g_slice_free1 (sizeof (GstEventImpl), 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: (transfer none): The structure of the event. The structure
352  * is still owned by the event, which means that you should not free
353  * it and that the pointer becomes invalid when you free the event.
354  * This function checks if @event is writable and will never return
355  * %NULL.
356  *
357  * MT safe.
358  */
359 GstStructure *
360 gst_event_writable_structure (GstEvent * event)
361 {
362   GstStructure *structure;
363
364   g_return_val_if_fail (GST_IS_EVENT (event), NULL);
365   g_return_val_if_fail (gst_event_is_writable (event), NULL);
366
367   structure = GST_EVENT_STRUCTURE (event);
368
369   if (structure == NULL) {
370     structure =
371         gst_structure_new_id_empty (gst_event_type_to_quark (GST_EVENT_TYPE
372             (event)));
373     gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
374     GST_EVENT_STRUCTURE (event) = structure;
375   }
376   return structure;
377 }
378
379 /**
380  * gst_event_has_name:
381  * @event: The #GstEvent.
382  * @name: name to check
383  *
384  * Checks if @event has the given @name. This function is usually used to
385  * check the name of a custom event.
386  *
387  * Returns: %TRUE if @name matches the name of the event structure.
388  */
389 gboolean
390 gst_event_has_name (GstEvent * event, const gchar * name)
391 {
392   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
393
394   if (GST_EVENT_STRUCTURE (event) == NULL)
395     return FALSE;
396
397   return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
398 }
399
400 /**
401  * gst_event_get_seqnum:
402  * @event: A #GstEvent.
403  *
404  * Retrieve the sequence number of a event.
405  *
406  * Events have ever-incrementing sequence numbers, which may also be set
407  * explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
408  * indicate that a event corresponds to some other set of events or messages,
409  * for example an EOS event corresponding to a SEEK event. It is considered good
410  * practice to make this correspondence when possible, though it is not
411  * required.
412  *
413  * Note that events and messages share the same sequence number incrementor;
414  * two events or messages will never have the same sequence number unless
415  * that correspondence was made explicitly.
416  *
417  * Returns: The event's sequence number.
418  *
419  * MT safe.
420  */
421 guint32
422 gst_event_get_seqnum (GstEvent * event)
423 {
424   g_return_val_if_fail (GST_IS_EVENT (event), -1);
425
426   return GST_EVENT_SEQNUM (event);
427 }
428
429 /**
430  * gst_event_set_seqnum:
431  * @event: A #GstEvent.
432  * @seqnum: A sequence number.
433  *
434  * Set the sequence number of a event.
435  *
436  * This function might be called by the creator of a event to indicate that the
437  * event relates to other events or messages. See gst_event_get_seqnum() for
438  * more information.
439  *
440  * MT safe.
441  */
442 void
443 gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
444 {
445   g_return_if_fail (GST_IS_EVENT (event));
446
447   GST_EVENT_SEQNUM (event) = seqnum;
448 }
449
450 /**
451  * gst_event_get_running_time_offset:
452  * @event: A #GstEvent.
453  *
454  * Retrieve the accumulated running time offset of the event.
455  *
456  * Events passing through #GstPads that have a running time
457  * offset set via gst_pad_set_offset() will get their offset
458  * adjusted according to the pad's offset.
459  *
460  * If the event contains any information that related to the
461  * running time, this information will need to be updated
462  * before usage with this offset.
463  *
464  * Returns: The event's running time offset
465  *
466  * MT safe.
467  *
468  * Since: 1.4
469  */
470 gint64
471 gst_event_get_running_time_offset (GstEvent * event)
472 {
473   g_return_val_if_fail (GST_IS_EVENT (event), 0);
474
475   return ((GstEventImpl *) event)->running_time_offset;
476 }
477
478 /**
479  * gst_event_set_running_time_offset:
480  * @event: A #GstEvent.
481  * @offset: A the new running time offset
482  *
483  * Set the running time offset of a event. See
484  * gst_event_get_running_time_offset() for more information.
485  *
486  * MT safe.
487  *
488  * Since: 1.4
489  */
490 void
491 gst_event_set_running_time_offset (GstEvent * event, gint64 offset)
492 {
493   g_return_if_fail (GST_IS_EVENT (event));
494
495   ((GstEventImpl *) event)->running_time_offset = offset;
496 }
497
498 /**
499  * gst_event_new_flush_start:
500  *
501  * Allocate a new flush start event. The flush start event can be sent
502  * upstream and downstream and travels out-of-bounds with the dataflow.
503  *
504  * It marks pads as being flushing and will make them return
505  * #GST_FLOW_FLUSHING when used for data flow with gst_pad_push(),
506  * gst_pad_chain(), gst_pad_get_range() and gst_pad_pull_range().
507  * Any event (except a #GST_EVENT_FLUSH_STOP) received
508  * on a flushing pad will return %FALSE immediately.
509  *
510  * Elements should unlock any blocking functions and exit their streaming
511  * functions as fast as possible when this event is received.
512  *
513  * This event is typically generated after a seek to flush out all queued data
514  * in the pipeline so that the new media is played as soon as possible.
515  *
516  * Returns: (transfer full): a new flush start event.
517  */
518 GstEvent *
519 gst_event_new_flush_start (void)
520 {
521   return gst_event_new_custom (GST_EVENT_FLUSH_START, NULL);
522 }
523
524 /**
525  * gst_event_new_flush_stop:
526  * @reset_time: if time should be reset
527  *
528  * Allocate a new flush stop event. The flush stop event can be sent
529  * upstream and downstream and travels serialized with the dataflow.
530  * It is typically sent after sending a FLUSH_START event to make the
531  * pads accept data again.
532  *
533  * Elements can process this event synchronized with the dataflow since
534  * the preceding FLUSH_START event stopped the dataflow.
535  *
536  * This event is typically generated to complete a seek and to resume
537  * dataflow.
538  *
539  * Returns: (transfer full): a new flush stop event.
540  */
541 GstEvent *
542 gst_event_new_flush_stop (gboolean reset_time)
543 {
544   GstEvent *event;
545
546   GST_CAT_INFO (GST_CAT_EVENT, "creating flush stop %d", reset_time);
547
548   event = gst_event_new_custom (GST_EVENT_FLUSH_STOP,
549       gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
550           GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL));
551
552   return event;
553 }
554
555 /**
556  * gst_event_parse_flush_stop:
557  * @event: The event to parse
558  * @reset_time: (out): if time should be reset
559  *
560  * Parse the FLUSH_STOP event and retrieve the @reset_time member.
561  */
562 void
563 gst_event_parse_flush_stop (GstEvent * event, gboolean * reset_time)
564 {
565   GstStructure *structure;
566
567   g_return_if_fail (GST_IS_EVENT (event));
568   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP);
569
570   structure = GST_EVENT_STRUCTURE (event);
571   if (G_LIKELY (reset_time))
572     *reset_time =
573         g_value_get_boolean (gst_structure_id_get_value (structure,
574             GST_QUARK (RESET_TIME)));
575 }
576
577 /**
578  * gst_event_new_eos:
579  *
580  * Create a new EOS event. The eos event can only travel downstream
581  * synchronized with the buffer flow. Elements that receive the EOS
582  * event on a pad can return #GST_FLOW_EOS as a #GstFlowReturn
583  * when data after the EOS event arrives.
584  *
585  * The EOS event will travel down to the sink elements in the pipeline
586  * which will then post the #GST_MESSAGE_EOS on the bus after they have
587  * finished playing any buffered data.
588  *
589  * When all sinks have posted an EOS message, an EOS message is
590  * forwarded to the application.
591  *
592  * The EOS event itself will not cause any state transitions of the pipeline.
593  *
594  * Returns: (transfer full): the new EOS event.
595  */
596 GstEvent *
597 gst_event_new_eos (void)
598 {
599   return gst_event_new_custom (GST_EVENT_EOS, NULL);
600 }
601
602 /**
603  * gst_event_new_gap:
604  * @timestamp: the start time (pts) of the gap
605  * @duration: the duration of the gap
606  *
607  * Create a new GAP event. A gap event can be thought of as conceptually
608  * equivalent to a buffer to signal that there is no data for a certain
609  * amount of time. This is useful to signal a gap to downstream elements
610  * which may wait for data, such as muxers or mixers or overlays, especially
611  * for sparse streams such as subtitle streams.
612  *
613  * Returns: (transfer full): the new GAP event.
614  */
615 GstEvent *
616 gst_event_new_gap (GstClockTime timestamp, GstClockTime duration)
617 {
618   GstEvent *event;
619
620   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
621
622   GST_CAT_TRACE (GST_CAT_EVENT, "creating gap %" GST_TIME_FORMAT " - "
623       "%" GST_TIME_FORMAT " (duration: %" GST_TIME_FORMAT ")",
624       GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
625       GST_TIME_ARGS (duration));
626
627   event = gst_event_new_custom (GST_EVENT_GAP,
628       gst_structure_new_id (GST_QUARK (EVENT_GAP),
629           GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
630           GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL));
631
632   return event;
633 }
634
635 /**
636  * gst_event_parse_gap:
637  * @event: a #GstEvent of type #GST_EVENT_GAP
638  * @timestamp: (out) (allow-none): location where to store the
639  *     start time (pts) of the gap, or %NULL
640  * @duration: (out) (allow-none): location where to store the duration of
641  *     the gap, or %NULL
642  *
643  * Extract timestamp and duration from a new GAP event.
644  */
645 void
646 gst_event_parse_gap (GstEvent * event, GstClockTime * timestamp,
647     GstClockTime * duration)
648 {
649   GstStructure *structure;
650
651   g_return_if_fail (GST_IS_EVENT (event));
652   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_GAP);
653
654   structure = GST_EVENT_STRUCTURE (event);
655   gst_structure_id_get (structure,
656       GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
657       GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL);
658 }
659
660 /**
661  * gst_event_new_caps:
662  * @caps: (transfer none): a #GstCaps
663  *
664  * Create a new CAPS event for @caps. The caps event can only travel downstream
665  * synchronized with the buffer flow and contains the format of the buffers
666  * that will follow after the event.
667  *
668  * Returns: (transfer full): the new CAPS event.
669  */
670 GstEvent *
671 gst_event_new_caps (GstCaps * caps)
672 {
673   GstEvent *event;
674
675   g_return_val_if_fail (caps != NULL, NULL);
676   g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
677
678   GST_CAT_INFO (GST_CAT_EVENT, "creating caps event %" GST_PTR_FORMAT, caps);
679
680   event = gst_event_new_custom (GST_EVENT_CAPS,
681       gst_structure_new_id (GST_QUARK (EVENT_CAPS),
682           GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));
683
684   return event;
685 }
686
687 /**
688  * gst_event_parse_caps:
689  * @event: The event to parse
690  * @caps: (out) (transfer none): A pointer to the caps
691  *
692  * Get the caps from @event. The caps remains valid as long as @event remains
693  * valid.
694  */
695 void
696 gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
697 {
698   GstStructure *structure;
699
700   g_return_if_fail (GST_IS_EVENT (event));
701   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_CAPS);
702
703   structure = GST_EVENT_STRUCTURE (event);
704   if (G_LIKELY (caps))
705     *caps =
706         g_value_get_boxed (gst_structure_id_get_value (structure,
707             GST_QUARK (CAPS)));
708 }
709
710 /**
711  * gst_event_new_segment:
712  * @segment: (transfer none): a #GstSegment
713  *
714  * Create a new SEGMENT event for @segment. The segment event can only travel
715  * downstream synchronized with the buffer flow and contains timing information
716  * and playback properties for the buffers that will follow.
717  *
718  * The segment event marks the range of buffers to be processed. All
719  * data not within the segment range is not to be processed. This can be
720  * used intelligently by plugins to apply more efficient methods of skipping
721  * unneeded data. The valid range is expressed with the @start and @stop
722  * values.
723  *
724  * The time value of the segment is used in conjunction with the start
725  * value to convert the buffer timestamps into the stream time. This is
726  * usually done in sinks to report the current stream_time.
727  * @time represents the stream_time of a buffer carrying a timestamp of
728  * @start. @time cannot be -1.
729  *
730  * @start cannot be -1, @stop can be -1. If there
731  * is a valid @stop given, it must be greater or equal the @start, including
732  * when the indicated playback @rate is < 0.
733  *
734  * The @applied_rate value provides information about any rate adjustment that
735  * has already been made to the timestamps and content on the buffers of the
736  * stream. (@rate * @applied_rate) should always equal the rate that has been
737  * requested for playback. For example, if an element has an input segment
738  * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
739  * incoming timestamps and buffer content by half and output a segment event
740  * with @rate of 1.0 and @applied_rate of 2.0
741  *
742  * After a segment event, the buffer stream time is calculated with:
743  *
744  *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
745  *
746  * Returns: (transfer full): the new SEGMENT event.
747  */
748 GstEvent *
749 gst_event_new_segment (const GstSegment * segment)
750 {
751   GstEvent *event;
752
753   g_return_val_if_fail (segment != NULL, NULL);
754   g_return_val_if_fail (segment->rate != 0.0, NULL);
755   g_return_val_if_fail (segment->applied_rate != 0.0, NULL);
756   g_return_val_if_fail (segment->format != GST_FORMAT_UNDEFINED, NULL);
757
758   GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
759       segment);
760
761   event = gst_event_new_custom (GST_EVENT_SEGMENT,
762       gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
763           GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
764
765   return event;
766 }
767
768 /**
769  * gst_event_parse_segment:
770  * @event: The event to parse
771  * @segment: (out) (transfer none): a pointer to a #GstSegment
772  *
773  * Parses a segment @event and stores the result in the given @segment location.
774  * @segment remains valid only until the @event is freed. Don't modify the segment
775  * and make a copy if you want to modify it or store it for later use.
776  */
777 void
778 gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
779 {
780   GstStructure *structure;
781
782   g_return_if_fail (GST_IS_EVENT (event));
783   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
784
785   if (segment) {
786     structure = GST_EVENT_STRUCTURE (event);
787     *segment = g_value_get_boxed (gst_structure_id_get_value (structure,
788             GST_QUARK (SEGMENT)));
789   }
790 }
791
792 /**
793  * gst_event_copy_segment:
794  * @event: The event to parse
795  * @segment: a pointer to a #GstSegment
796  *
797  * Parses a segment @event and copies the #GstSegment into the location
798  * given by @segment.
799  */
800 void
801 gst_event_copy_segment (GstEvent * event, GstSegment * segment)
802 {
803   const GstSegment *src;
804
805   g_return_if_fail (GST_IS_EVENT (event));
806   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
807
808   if (segment) {
809     gst_event_parse_segment (event, &src);
810     gst_segment_copy_into (src, segment);
811   }
812 }
813
814 /**
815  * gst_event_new_tag:
816  * @taglist: (transfer full): metadata list. The event will take ownership
817  *     of the taglist.
818  *
819  * Generates a metadata tag event from the given @taglist.
820  *
821  * The scope of the taglist specifies if the taglist applies to the
822  * complete medium or only to this specific stream. As the tag event
823  * is a sticky event, elements should merge tags received from
824  * upstream with a given scope with their own tags with the same
825  * scope and create a new tag event from it.
826  *
827  * Returns: (transfer full): a new #GstEvent
828  */
829 GstEvent *
830 gst_event_new_tag (GstTagList * taglist)
831 {
832   GstStructure *s;
833   GValue val = G_VALUE_INIT;
834   const gchar *names[] = { "GstTagList-stream", "GstTagList-global" };
835
836   g_return_val_if_fail (taglist != NULL, NULL);
837
838   s = gst_structure_new_empty (names[gst_tag_list_get_scope (taglist)]);
839   g_value_init (&val, GST_TYPE_TAG_LIST);
840   g_value_take_boxed (&val, taglist);
841   gst_structure_id_take_value (s, GST_QUARK (TAGLIST), &val);
842   return gst_event_new_custom (GST_EVENT_TAG, s);
843 }
844
845 /**
846  * gst_event_parse_tag:
847  * @event: a tag event
848  * @taglist: (out) (transfer none): pointer to metadata list
849  *
850  * Parses a tag @event and stores the results in the given @taglist location.
851  * No reference to the taglist will be returned, it remains valid only until
852  * the @event is freed. Don't modify or free the taglist, make a copy if you
853  * want to modify it or store it for later use.
854  */
855 void
856 gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
857 {
858   const GValue *val;
859
860   g_return_if_fail (GST_IS_EVENT (event));
861   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
862
863   val = gst_structure_id_get_value (GST_EVENT_STRUCTURE (event),
864       GST_QUARK (TAGLIST));
865
866   if (taglist)
867     *taglist = (GstTagList *) g_value_get_boxed (val);
868 }
869
870 /* buffersize event */
871 /**
872  * gst_event_new_buffer_size:
873  * @format: buffer format
874  * @minsize: minimum buffer size
875  * @maxsize: maximum buffer size
876  * @async: thread behavior
877  *
878  * Create a new buffersize event. The event is sent downstream and notifies
879  * elements that they should provide a buffer of the specified dimensions.
880  *
881  * When the @async flag is set, a thread boundary is preferred.
882  *
883  * Returns: (transfer full): a new #GstEvent
884  */
885 GstEvent *
886 gst_event_new_buffer_size (GstFormat format, gint64 minsize,
887     gint64 maxsize, gboolean async)
888 {
889   GstEvent *event;
890   GstStructure *structure;
891
892   GST_CAT_INFO (GST_CAT_EVENT,
893       "creating buffersize format %s, minsize %" G_GINT64_FORMAT
894       ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
895       minsize, maxsize, async);
896
897   structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
898       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
899       GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
900       GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
901       GST_QUARK (ASYNC), G_TYPE_BOOLEAN, async, NULL);
902   event = gst_event_new_custom (GST_EVENT_BUFFERSIZE, structure);
903
904   return event;
905 }
906
907 /**
908  * gst_event_parse_buffer_size:
909  * @event: The event to query
910  * @format: (out): A pointer to store the format in
911  * @minsize: (out): A pointer to store the minsize in
912  * @maxsize: (out): A pointer to store the maxsize in
913  * @async: (out): A pointer to store the async-flag in
914  *
915  * Get the format, minsize, maxsize and async-flag in the buffersize event.
916  */
917 void
918 gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
919     gint64 * minsize, gint64 * maxsize, gboolean * async)
920 {
921   const GstStructure *structure;
922
923   g_return_if_fail (GST_IS_EVENT (event));
924   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_BUFFERSIZE);
925
926   structure = GST_EVENT_STRUCTURE (event);
927   if (format)
928     *format = (GstFormat)
929         g_value_get_enum (gst_structure_id_get_value (structure,
930             GST_QUARK (FORMAT)));
931   if (minsize)
932     *minsize =
933         g_value_get_int64 (gst_structure_id_get_value (structure,
934             GST_QUARK (MINSIZE)));
935   if (maxsize)
936     *maxsize =
937         g_value_get_int64 (gst_structure_id_get_value (structure,
938             GST_QUARK (MAXSIZE)));
939   if (async)
940     *async =
941         g_value_get_boolean (gst_structure_id_get_value (structure,
942             GST_QUARK (ASYNC)));
943 }
944
945 /**
946  * gst_event_new_qos:
947  * @type: the QoS type
948  * @proportion: the proportion of the qos message
949  * @diff: The time difference of the last Clock sync
950  * @timestamp: The timestamp of the buffer
951  *
952  * Allocate a new qos event with the given values.
953  * The QOS event is generated in an element that wants an upstream
954  * element to either reduce or increase its rate because of
955  * high/low CPU load or other resource usage such as network performance or
956  * throttling. Typically sinks generate these events for each buffer
957  * they receive.
958  *
959  * @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
960  * used when a buffer arrived in time or when the sink cannot keep up with
961  * the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
962  * receiving buffers fast enough and thus has to drop late buffers. 
963  * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
964  * by the application, for example to reduce power consumption.
965  *
966  * @proportion indicates the real-time performance of the streaming in the
967  * element that generated the QoS event (usually the sink). The value is
968  * generally computed based on more long term statistics about the streams
969  * timestamps compared to the clock.
970  * A value < 1.0 indicates that the upstream element is producing data faster
971  * than real-time. A value > 1.0 indicates that the upstream element is not
972  * producing data fast enough. 1.0 is the ideal @proportion value. The
973  * proportion value can safely be used to lower or increase the quality of
974  * the element.
975  *
976  * @diff is the difference against the clock in running time of the last
977  * buffer that caused the element to generate the QOS event. A negative value
978  * means that the buffer with @timestamp arrived in time. A positive value
979  * indicates how late the buffer with @timestamp was. When throttling is
980  * enabled, @diff will be set to the requested throttling interval.
981  *
982  * @timestamp is the timestamp of the last buffer that cause the element
983  * to generate the QOS event. It is expressed in running time and thus an ever
984  * increasing value.
985  *
986  * The upstream element can use the @diff and @timestamp values to decide
987  * whether to process more buffers. For positive @diff, all buffers with
988  * timestamp <= @timestamp + @diff will certainly arrive late in the sink
989  * as well. A (negative) @diff value so that @timestamp + @diff would yield a
990  * result smaller than 0 is not allowed.
991  *
992  * The application can use general event probes to intercept the QoS
993  * event and implement custom application specific QoS handling.
994  *
995  * Returns: (transfer full): a new QOS event.
996  */
997 GstEvent *
998 gst_event_new_qos (GstQOSType type, gdouble proportion,
999     GstClockTimeDiff diff, GstClockTime timestamp)
1000 {
1001   GstEvent *event;
1002   GstStructure *structure;
1003
1004   /* diff must be positive or timestamp + diff must be positive */
1005   g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);
1006
1007   GST_CAT_LOG (GST_CAT_EVENT,
1008       "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
1009       ", timestamp %" GST_TIME_FORMAT, type, proportion,
1010       diff, GST_TIME_ARGS (timestamp));
1011
1012   structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
1013       GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
1014       GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
1015       GST_QUARK (DIFF), G_TYPE_INT64, diff,
1016       GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
1017   event = gst_event_new_custom (GST_EVENT_QOS, structure);
1018
1019   return event;
1020 }
1021
1022 /**
1023  * gst_event_parse_qos:
1024  * @event: The event to query
1025  * @type: (out): A pointer to store the QoS type in
1026  * @proportion: (out): A pointer to store the proportion in
1027  * @diff: (out): A pointer to store the diff in
1028  * @timestamp: (out): A pointer to store the timestamp in
1029  *
1030  * Get the type, proportion, diff and timestamp in the qos event. See
1031  * gst_event_new_qos() for more information about the different QoS values.
1032  *
1033  * @timestamp will be adjusted for any pad offsets of pads it was passing through.
1034  */
1035 void
1036 gst_event_parse_qos (GstEvent * event, GstQOSType * type,
1037     gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
1038 {
1039   const GstStructure *structure;
1040
1041   g_return_if_fail (GST_IS_EVENT (event));
1042   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
1043
1044   structure = GST_EVENT_STRUCTURE (event);
1045   if (type)
1046     *type = (GstQOSType)
1047         g_value_get_enum (gst_structure_id_get_value (structure,
1048             GST_QUARK (TYPE)));
1049   if (proportion)
1050     *proportion =
1051         g_value_get_double (gst_structure_id_get_value (structure,
1052             GST_QUARK (PROPORTION)));
1053   if (diff)
1054     *diff =
1055         g_value_get_int64 (gst_structure_id_get_value (structure,
1056             GST_QUARK (DIFF)));
1057   if (timestamp) {
1058     gint64 offset = gst_event_get_running_time_offset (event);
1059
1060     *timestamp =
1061         g_value_get_uint64 (gst_structure_id_get_value (structure,
1062             GST_QUARK (TIMESTAMP)));
1063     /* Catch underflows */
1064     if (*timestamp > -offset)
1065       *timestamp += offset;
1066     else
1067       *timestamp = 0;
1068   }
1069 }
1070
1071 /**
1072  * gst_event_new_seek:
1073  * @rate: The new playback rate
1074  * @format: The format of the seek values
1075  * @flags: The optional seek flags
1076  * @start_type: The type and flags for the new start position
1077  * @start: The value of the new start position
1078  * @stop_type: The type and flags for the new stop position
1079  * @stop: The value of the new stop position
1080  *
1081  * Allocate a new seek event with the given parameters.
1082  *
1083  * The seek event configures playback of the pipeline between @start to @stop
1084  * at the speed given in @rate, also called a playback segment.
1085  * The @start and @stop values are expressed in @format.
1086  *
1087  * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
1088  * Negatives values means backwards playback. A value of 0.0 for the
1089  * rate is not allowed and should be accomplished instead by PAUSING the
1090  * pipeline.
1091  *
1092  * A pipeline has a default playback segment configured with a start
1093  * position of 0, a stop position of -1 and a rate of 1.0. The currently
1094  * configured playback segment can be queried with #GST_QUERY_SEGMENT. 
1095  *
1096  * @start_type and @stop_type specify how to adjust the currently configured 
1097  * start and stop fields in playback segment. Adjustments can be made relative
1098  * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
1099  * means that the position should not be updated.
1100  *
1101  * When the rate is positive and @start has been updated, playback will start
1102  * from the newly configured start position. 
1103  *
1104  * For negative rates, playback will start from the newly configured stop
1105  * position (if any). If the stop position is updated, it must be different from
1106  * -1 (#GST_CLOCK_TIME_NONE) for negative rates.
1107  *
1108  * It is not possible to seek relative to the current playback position, to do
1109  * this, PAUSE the pipeline, query the current playback position with
1110  * #GST_QUERY_POSITION and update the playback segment current position with a
1111  * #GST_SEEK_TYPE_SET to the desired position.
1112  *
1113  * Returns: (transfer full): a new seek event.
1114  */
1115 GstEvent *
1116 gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
1117     GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
1118 {
1119   GstEvent *event;
1120   GstStructure *structure;
1121
1122   g_return_val_if_fail (rate != 0.0, NULL);
1123
1124   if (format == GST_FORMAT_TIME) {
1125     GST_CAT_INFO (GST_CAT_EVENT,
1126         "creating seek rate %lf, format TIME, flags %d, "
1127         "start_type %d, start %" GST_TIME_FORMAT ", "
1128         "stop_type %d, stop %" GST_TIME_FORMAT,
1129         rate, flags, start_type, GST_TIME_ARGS (start),
1130         stop_type, GST_TIME_ARGS (stop));
1131   } else {
1132     GST_CAT_INFO (GST_CAT_EVENT,
1133         "creating seek rate %lf, format %s, flags %d, "
1134         "start_type %d, start %" G_GINT64_FORMAT ", "
1135         "stop_type %d, stop %" G_GINT64_FORMAT,
1136         rate, gst_format_get_name (format), flags, start_type, start, stop_type,
1137         stop);
1138   }
1139
1140   structure = gst_structure_new_id (GST_QUARK (EVENT_SEEK),
1141       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1142       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1143       GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
1144       GST_QUARK (CUR_TYPE), GST_TYPE_SEEK_TYPE, start_type,
1145       GST_QUARK (CUR), G_TYPE_INT64, start,
1146       GST_QUARK (STOP_TYPE), GST_TYPE_SEEK_TYPE, stop_type,
1147       GST_QUARK (STOP), G_TYPE_INT64, stop, NULL);
1148   event = gst_event_new_custom (GST_EVENT_SEEK, structure);
1149
1150   return event;
1151 }
1152
1153 /**
1154  * gst_event_parse_seek:
1155  * @event: a seek event
1156  * @rate: (out): result location for the rate
1157  * @format: (out): result location for the stream format
1158  * @flags:  (out): result location for the #GstSeekFlags
1159  * @start_type: (out): result location for the #GstSeekType of the start position
1160  * @start: (out): result location for the start position expressed in @format
1161  * @stop_type:  (out): result location for the #GstSeekType of the stop position
1162  * @stop: (out): result location for the stop position expressed in @format
1163  *
1164  * Parses a seek @event and stores the results in the given result locations.
1165  */
1166 void
1167 gst_event_parse_seek (GstEvent * event, gdouble * rate,
1168     GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
1169     gint64 * start, GstSeekType * stop_type, gint64 * stop)
1170 {
1171   const GstStructure *structure;
1172
1173   g_return_if_fail (GST_IS_EVENT (event));
1174   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
1175
1176   structure = GST_EVENT_STRUCTURE (event);
1177   if (rate)
1178     *rate =
1179         g_value_get_double (gst_structure_id_get_value (structure,
1180             GST_QUARK (RATE)));
1181   if (format)
1182     *format = (GstFormat)
1183         g_value_get_enum (gst_structure_id_get_value (structure,
1184             GST_QUARK (FORMAT)));
1185   if (flags)
1186     *flags = (GstSeekFlags)
1187         g_value_get_flags (gst_structure_id_get_value (structure,
1188             GST_QUARK (FLAGS)));
1189   if (start_type)
1190     *start_type = (GstSeekType)
1191         g_value_get_enum (gst_structure_id_get_value (structure,
1192             GST_QUARK (CUR_TYPE)));
1193   if (start)
1194     *start =
1195         g_value_get_int64 (gst_structure_id_get_value (structure,
1196             GST_QUARK (CUR)));
1197   if (stop_type)
1198     *stop_type = (GstSeekType)
1199         g_value_get_enum (gst_structure_id_get_value (structure,
1200             GST_QUARK (STOP_TYPE)));
1201   if (stop)
1202     *stop =
1203         g_value_get_int64 (gst_structure_id_get_value (structure,
1204             GST_QUARK (STOP)));
1205 }
1206
1207 /**
1208  * gst_event_new_navigation:
1209  * @structure: (transfer full): description of the event. The event will take
1210  *     ownership of the structure.
1211  *
1212  * Create a new navigation event from the given description.
1213  *
1214  * Returns: (transfer full): a new #GstEvent
1215  */
1216 GstEvent *
1217 gst_event_new_navigation (GstStructure * structure)
1218 {
1219   g_return_val_if_fail (structure != NULL, NULL);
1220
1221   return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
1222 }
1223
1224 /**
1225  * gst_event_new_latency:
1226  * @latency: the new latency value
1227  *
1228  * Create a new latency event. The event is sent upstream from the sinks and
1229  * notifies elements that they should add an additional @latency to the
1230  * running time before synchronising against the clock.
1231  *
1232  * The latency is mostly used in live sinks and is always expressed in
1233  * the time format.
1234  *
1235  * Returns: (transfer full): a new #GstEvent
1236  */
1237 GstEvent *
1238 gst_event_new_latency (GstClockTime latency)
1239 {
1240   GstEvent *event;
1241   GstStructure *structure;
1242
1243   GST_CAT_INFO (GST_CAT_EVENT,
1244       "creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));
1245
1246   structure = gst_structure_new_id (GST_QUARK (EVENT_LATENCY),
1247       GST_QUARK (LATENCY), G_TYPE_UINT64, latency, NULL);
1248   event = gst_event_new_custom (GST_EVENT_LATENCY, structure);
1249
1250   return event;
1251 }
1252
1253 /**
1254  * gst_event_parse_latency:
1255  * @event: The event to query
1256  * @latency: (out): A pointer to store the latency in.
1257  *
1258  * Get the latency in the latency event.
1259  */
1260 void
1261 gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
1262 {
1263   g_return_if_fail (GST_IS_EVENT (event));
1264   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_LATENCY);
1265
1266   if (latency)
1267     *latency =
1268         g_value_get_uint64 (gst_structure_id_get_value (GST_EVENT_STRUCTURE
1269             (event), GST_QUARK (LATENCY)));
1270 }
1271
1272 /**
1273  * gst_event_new_step:
1274  * @format: the format of @amount
1275  * @amount: the amount of data to step
1276  * @rate: the step rate
1277  * @flush: flushing steps
1278  * @intermediate: intermediate steps
1279  *
1280  * Create a new step event. The purpose of the step event is to instruct a sink
1281  * to skip @amount (expressed in @format) of media. It can be used to implement
1282  * stepping through the video frame by frame or for doing fast trick modes.
1283  *
1284  * A rate of <= 0.0 is not allowed. Pause the pipeline, for the effect of rate
1285  * = 0.0 or first reverse the direction of playback using a seek event to get
1286  * the same effect as rate < 0.0.
1287  *
1288  * The @flush flag will clear any pending data in the pipeline before starting
1289  * the step operation.
1290  *
1291  * The @intermediate flag instructs the pipeline that this step operation is
1292  * part of a larger step operation.
1293  *
1294  * Returns: (transfer full): a new #GstEvent
1295  */
1296 GstEvent *
1297 gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
1298     gboolean flush, gboolean intermediate)
1299 {
1300   GstEvent *event;
1301   GstStructure *structure;
1302
1303   g_return_val_if_fail (rate > 0.0, NULL);
1304
1305   GST_CAT_INFO (GST_CAT_EVENT, "creating step event");
1306
1307   structure = gst_structure_new_id (GST_QUARK (EVENT_STEP),
1308       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1309       GST_QUARK (AMOUNT), G_TYPE_UINT64, amount,
1310       GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1311       GST_QUARK (FLUSH), G_TYPE_BOOLEAN, flush,
1312       GST_QUARK (INTERMEDIATE), G_TYPE_BOOLEAN, intermediate, NULL);
1313   event = gst_event_new_custom (GST_EVENT_STEP, structure);
1314
1315   return event;
1316 }
1317
1318 /**
1319  * gst_event_parse_step:
1320  * @event: The event to query
1321  * @format: (out) (allow-none): a pointer to store the format in
1322  * @amount: (out) (allow-none): a pointer to store the amount in
1323  * @rate: (out) (allow-none): a pointer to store the rate in
1324  * @flush: (out) (allow-none): a pointer to store the flush boolean in
1325  * @intermediate: (out) (allow-none): a pointer to store the intermediate
1326  *     boolean in
1327  *
1328  * Parse the step event.
1329  */
1330 void
1331 gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
1332     gdouble * rate, gboolean * flush, gboolean * intermediate)
1333 {
1334   const GstStructure *structure;
1335
1336   g_return_if_fail (GST_IS_EVENT (event));
1337   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STEP);
1338
1339   structure = GST_EVENT_STRUCTURE (event);
1340   if (format)
1341     *format =
1342         (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1343             GST_QUARK (FORMAT)));
1344   if (amount)
1345     *amount = g_value_get_uint64 (gst_structure_id_get_value (structure,
1346             GST_QUARK (AMOUNT)));
1347   if (rate)
1348     *rate = g_value_get_double (gst_structure_id_get_value (structure,
1349             GST_QUARK (RATE)));
1350   if (flush)
1351     *flush = g_value_get_boolean (gst_structure_id_get_value (structure,
1352             GST_QUARK (FLUSH)));
1353   if (intermediate)
1354     *intermediate = g_value_get_boolean (gst_structure_id_get_value (structure,
1355             GST_QUARK (INTERMEDIATE)));
1356 }
1357
1358 /**
1359  * gst_event_new_reconfigure:
1360
1361  * Create a new reconfigure event. The purpose of the reconfigure event is
1362  * to travel upstream and make elements renegotiate their caps or reconfigure
1363  * their buffer pools. This is useful when changing properties on elements
1364  * or changing the topology of the pipeline.
1365  *
1366  * Returns: (transfer full): a new #GstEvent
1367  */
1368 GstEvent *
1369 gst_event_new_reconfigure (void)
1370 {
1371   GstEvent *event;
1372
1373   GST_CAT_INFO (GST_CAT_EVENT, "creating reconfigure event");
1374
1375   event = gst_event_new_custom (GST_EVENT_RECONFIGURE, NULL);
1376
1377   return event;
1378 }
1379
1380 /**
1381  * gst_event_new_sink_message:
1382  * @name: a name for the event
1383  * @msg: (transfer none): the #GstMessage to be posted
1384  *
1385  * Create a new sink-message event. The purpose of the sink-message event is
1386  * to instruct a sink to post the message contained in the event synchronized
1387  * with the stream.
1388  *
1389  * @name is used to store multiple sticky events on one pad.
1390  *
1391  * Returns: (transfer full): a new #GstEvent
1392  */
1393 /* FIXME 2.0: take ownership of msg for consistency? */
1394 GstEvent *
1395 gst_event_new_sink_message (const gchar * name, GstMessage * msg)
1396 {
1397   GstEvent *event;
1398   GstStructure *structure;
1399
1400   g_return_val_if_fail (msg != NULL, NULL);
1401
1402   GST_CAT_INFO (GST_CAT_EVENT, "creating sink-message event");
1403
1404   structure = gst_structure_new_id (g_quark_from_string (name),
1405       GST_QUARK (MESSAGE), GST_TYPE_MESSAGE, msg, NULL);
1406   event = gst_event_new_custom (GST_EVENT_SINK_MESSAGE, structure);
1407
1408   return event;
1409 }
1410
1411 /**
1412  * gst_event_parse_sink_message:
1413  * @event: The event to query
1414  * @msg: (out) (transfer full): a pointer to store the #GstMessage in.
1415  *
1416  * Parse the sink-message event. Unref @msg after usage.
1417  */
1418 void
1419 gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
1420 {
1421   const GstStructure *structure;
1422
1423   g_return_if_fail (GST_IS_EVENT (event));
1424   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE);
1425
1426   structure = GST_EVENT_STRUCTURE (event);
1427   if (msg)
1428     *msg =
1429         GST_MESSAGE (g_value_dup_boxed (gst_structure_id_get_value
1430             (structure, GST_QUARK (MESSAGE))));
1431 }
1432
1433 /**
1434  * gst_event_new_stream_start:
1435  * @stream_id: Identifier for this stream
1436  *
1437  * Create a new STREAM_START event. The stream start event can only
1438  * travel downstream synchronized with the buffer flow. It is expected
1439  * to be the first event that is sent for a new stream.
1440  *
1441  * Source elements, demuxers and other elements that create new streams
1442  * are supposed to send this event as the first event of a new stream. It
1443  * should not be sent after a flushing seek or in similar situations
1444  * and is used to mark the beginning of a new logical stream. Elements
1445  * combining multiple streams must ensure that this event is only forwarded
1446  * downstream once and not for every single input stream.
1447  *
1448  * The @stream_id should be a unique string that consists of the upstream
1449  * stream-id, / as separator and a unique stream-id for this specific
1450  * stream. A new stream-id should only be created for a stream if the upstream
1451  * stream is split into (potentially) multiple new streams, e.g. in a demuxer,
1452  * but not for every single element in the pipeline.
1453  * gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be
1454  * used to create a stream-id.
1455  *
1456  * Returns: (transfer full): the new STREAM_START event.
1457  */
1458 GstEvent *
1459 gst_event_new_stream_start (const gchar * stream_id)
1460 {
1461   GstStructure *s;
1462
1463   g_return_val_if_fail (stream_id != NULL, NULL);
1464
1465   s = gst_structure_new_id (GST_QUARK (EVENT_STREAM_START),
1466       GST_QUARK (STREAM_ID), G_TYPE_STRING, stream_id,
1467       GST_QUARK (FLAGS), GST_TYPE_STREAM_FLAGS, GST_STREAM_FLAG_NONE, NULL);
1468
1469   return gst_event_new_custom (GST_EVENT_STREAM_START, s);
1470 }
1471
1472 /**
1473  * gst_event_parse_stream_start:
1474  * @event: a stream-start event.
1475  * @stream_id: (out) (transfer none): pointer to store the stream-id
1476  *
1477  * Parse a stream-id @event and store the result in the given @stream_id
1478  * location. The string stored in @stream_id must not be modified and will
1479  * remain valid only until @event gets freed. Make a copy if you want to
1480  * modify it or store it for later use.
1481  */
1482 void
1483 gst_event_parse_stream_start (GstEvent * event, const gchar ** stream_id)
1484 {
1485   const GstStructure *structure;
1486   const GValue *val;
1487
1488   g_return_if_fail (event != NULL);
1489   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1490
1491   structure = gst_event_get_structure (event);
1492   val = gst_structure_id_get_value (structure, GST_QUARK (STREAM_ID));
1493
1494   if (stream_id)
1495     *stream_id = g_value_get_string (val);
1496 }
1497
1498 /**
1499  * gst_event_set_stream_flags:
1500  * @event: a stream-start event
1501  * @flags: the stream flags to set
1502  *
1503  * Since: 1.2
1504  */
1505 void
1506 gst_event_set_stream_flags (GstEvent * event, GstStreamFlags flags)
1507 {
1508   g_return_if_fail (event != NULL);
1509   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1510   g_return_if_fail (gst_event_is_writable (event));
1511
1512   gst_structure_id_set (GST_EVENT_STRUCTURE (event),
1513       GST_QUARK (FLAGS), GST_TYPE_STREAM_FLAGS, flags, NULL);
1514 }
1515
1516 /**
1517  * gst_event_parse_stream_flags:
1518  * @event: a stream-start event
1519  * @flags: (out): address of variable where to store the stream flags
1520  *
1521  * Since: 1.2
1522  */
1523 void
1524 gst_event_parse_stream_flags (GstEvent * event, GstStreamFlags * flags)
1525 {
1526   g_return_if_fail (event != NULL);
1527   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1528
1529   if (flags) {
1530     gst_structure_id_get (GST_EVENT_STRUCTURE (event),
1531         GST_QUARK (FLAGS), GST_TYPE_STREAM_FLAGS, flags, NULL);
1532   }
1533 }
1534
1535 /**
1536  * gst_event_set_group_id:
1537  * @event: a stream-start event
1538  * @group_id: the group id to set
1539  *
1540  * All streams that have the same group id are supposed to be played
1541  * together, i.e. all streams inside a container file should have the
1542  * same group id but different stream ids. The group id should change
1543  * each time the stream is started, resulting in different group ids
1544  * each time a file is played for example.
1545  *
1546  * Use gst_util_group_id_next() to get a new group id.
1547  *
1548  * Since: 1.2
1549  */
1550 void
1551 gst_event_set_group_id (GstEvent * event, guint group_id)
1552 {
1553   g_return_if_fail (event != NULL);
1554   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1555   g_return_if_fail (gst_event_is_writable (event));
1556
1557   gst_structure_id_set (GST_EVENT_STRUCTURE (event),
1558       GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id, NULL);
1559 }
1560
1561 /**
1562  * gst_event_parse_group_id:
1563  * @event: a stream-start event
1564  * @group_id: (out): address of variable where to store the group id
1565  *
1566  * Returns: %TRUE if a group id was set on the event and could be parsed,
1567  *   %FALSE otherwise.
1568  *
1569  * Since: 1.2
1570  */
1571 gboolean
1572 gst_event_parse_group_id (GstEvent * event, guint * group_id)
1573 {
1574   g_return_val_if_fail (event != NULL, FALSE);
1575   g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START,
1576       FALSE);
1577
1578   if (group_id) {
1579     return gst_structure_id_get (GST_EVENT_STRUCTURE (event),
1580         GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id, NULL);
1581   }
1582
1583   return TRUE;
1584 }
1585
1586 /**
1587  * gst_event_new_toc:
1588  * @toc: (transfer none): #GstToc structure.
1589  * @updated: whether @toc was updated or not.
1590  *
1591  * Generate a TOC event from the given @toc. The purpose of the TOC event is to
1592  * inform elements that some kind of the TOC was found.
1593  *
1594  * Returns: (transfer full): a new #GstEvent.
1595  */
1596 GstEvent *
1597 gst_event_new_toc (GstToc * toc, gboolean updated)
1598 {
1599   GstStructure *toc_struct;
1600   GQuark id;
1601
1602   g_return_val_if_fail (toc != NULL, NULL);
1603
1604   GST_CAT_INFO (GST_CAT_EVENT, "creating toc event");
1605
1606   /* need different structure names so sticky_multi event stuff on pads
1607    * works, i.e. both TOC events are kept around */
1608   if (gst_toc_get_scope (toc) == GST_TOC_SCOPE_GLOBAL)
1609     id = GST_QUARK (EVENT_TOC_GLOBAL);
1610   else
1611     id = GST_QUARK (EVENT_TOC_CURRENT);
1612
1613   toc_struct = gst_structure_new_id (id,
1614       GST_QUARK (TOC), GST_TYPE_TOC, toc,
1615       GST_QUARK (UPDATED), G_TYPE_BOOLEAN, updated, NULL);
1616
1617   return gst_event_new_custom (GST_EVENT_TOC, toc_struct);
1618 }
1619
1620 /**
1621  * gst_event_parse_toc:
1622  * @event: a TOC event.
1623  * @toc: (out) (transfer full): pointer to #GstToc structure.
1624  * @updated: (out): pointer to store TOC updated flag.
1625  *
1626  * Parse a TOC @event and store the results in the given @toc and @updated locations.
1627  */
1628 void
1629 gst_event_parse_toc (GstEvent * event, GstToc ** toc, gboolean * updated)
1630 {
1631   const GstStructure *structure;
1632
1633   g_return_if_fail (event != NULL);
1634   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TOC);
1635   g_return_if_fail (toc != NULL);
1636
1637   structure = gst_event_get_structure (event);
1638
1639   gst_structure_id_get (structure,
1640       GST_QUARK (TOC), GST_TYPE_TOC, toc,
1641       GST_QUARK (UPDATED), G_TYPE_BOOLEAN, updated, NULL);
1642 }
1643
1644 /**
1645  * gst_event_new_toc_select:
1646  * @uid: UID in the TOC to start playback from.
1647  *
1648  * Generate a TOC select event with the given @uid. The purpose of the
1649  * TOC select event is to start playback based on the TOC's entry with the
1650  * given @uid.
1651  *
1652  * Returns: a new #GstEvent.
1653  */
1654 GstEvent *
1655 gst_event_new_toc_select (const gchar * uid)
1656 {
1657   GstStructure *structure;
1658
1659   g_return_val_if_fail (uid != NULL, NULL);
1660
1661   GST_CAT_INFO (GST_CAT_EVENT, "creating toc select event for UID: %s", uid);
1662
1663   structure = gst_structure_new_id (GST_QUARK (EVENT_TOC_SELECT),
1664       GST_QUARK (UID), G_TYPE_STRING, uid, NULL);
1665
1666   return gst_event_new_custom (GST_EVENT_TOC_SELECT, structure);
1667 }
1668
1669 /**
1670  * gst_event_parse_toc_select:
1671  * @event: a TOC select event.
1672  * @uid: (out) (transfer full) (allow-none): storage for the selection UID.
1673  *
1674  * Parse a TOC select @event and store the results in the given @uid location.
1675  */
1676 void
1677 gst_event_parse_toc_select (GstEvent * event, gchar ** uid)
1678 {
1679   const GstStructure *structure;
1680   const GValue *val;
1681
1682   g_return_if_fail (event != NULL);
1683   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TOC_SELECT);
1684
1685   structure = gst_event_get_structure (event);
1686   val = gst_structure_id_get_value (structure, GST_QUARK (UID));
1687
1688   if (uid != NULL)
1689     *uid = g_strdup (g_value_get_string (val));
1690
1691 }
1692
1693 /**
1694  * gst_event_new_segment_done:
1695  * @format: The format of the position being done
1696  * @position: The position of the segment being done
1697  *
1698  * Create a new segment-done event. This event is sent by elements that
1699  * finish playback of a segment as a result of a segment seek.
1700  *
1701  * Returns: (transfer full): a new #GstEvent
1702  */
1703 GstEvent *
1704 gst_event_new_segment_done (GstFormat format, gint64 position)
1705 {
1706   GstEvent *event;
1707   GstStructure *structure;
1708
1709   GST_CAT_INFO (GST_CAT_EVENT, "creating segment-done event");
1710
1711   structure = gst_structure_new_id (GST_QUARK (EVENT_SEGMENT_DONE),
1712       GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1713       GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
1714
1715   event = gst_event_new_custom (GST_EVENT_SEGMENT_DONE, structure);
1716
1717   return event;
1718 }
1719
1720 /**
1721  * gst_event_parse_segment_done:
1722  * @event: A valid #GstEvent of type GST_EVENT_SEGMENT_DONE.
1723  * @format: (out) (allow-none): Result location for the format, or %NULL
1724  * @position: (out) (allow-none): Result location for the position, or %NULL
1725  *
1726  * Extracts the position and format from the segment done message.
1727  *
1728  */
1729 void
1730 gst_event_parse_segment_done (GstEvent * event, GstFormat * format,
1731     gint64 * position)
1732 {
1733   const GstStructure *structure;
1734   const GValue *val;
1735
1736   g_return_if_fail (event != NULL);
1737   g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT_DONE);
1738
1739   structure = gst_event_get_structure (event);
1740
1741   val = gst_structure_id_get_value (structure, GST_QUARK (FORMAT));
1742   if (format != NULL)
1743     *format = g_value_get_enum (val);
1744
1745   val = gst_structure_id_get_value (structure, GST_QUARK (POSITION));
1746   if (position != NULL)
1747     *position = g_value_get_int64 (val);
1748 }