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