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>
6 * gstevent.c: GstEvent subsystem
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.
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.
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.
26 * @short_description: Structure describing events that are passed up and down
28 * @see_also: #GstPad, #GstElement
30 * The event class provides factory methods to construct events for sending
31 * and functions to query (parse) received events.
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.
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.
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.
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.
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.
55 * <title>performing a seek on a pipeline</title>
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,
64 * GST_SEEK_FLAG_FLUSH,
65 * GST_SEEK_TYPE_SET, 2 * GST_SECOND,
66 * GST_SEEK_TYPE_SET, 5 * GST_SECOND);
68 * result = gst_element_send_event (pipeline, event);
70 * g_warning ("seek failed");
75 * Last reviewed on 2006-09-6 (0.10.10)
79 #include "gst_private.h"
80 #include <string.h> /* memcpy */
84 #include "gstenumtypes.h"
88 #define GST_EVENT_SEQNUM(e) ((GstEvent*)e)->abidata.seqnum
90 static void gst_event_finalize (GstEvent * event);
91 static GstEvent *_gst_event_copy (GstEvent * event);
93 static GstMiniObjectClass *parent_class = NULL;
96 _gst_event_initialize (void)
98 g_type_class_ref (gst_event_get_type ());
99 g_type_class_ref (gst_seek_flags_get_type ());
100 g_type_class_ref (gst_seek_type_get_type ());
110 static GstEventQuarks event_quarks[] = {
111 {GST_EVENT_UNKNOWN, "unknown", 0},
112 {GST_EVENT_FLUSH_START, "flush-start", 0},
113 {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
114 {GST_EVENT_EOS, "eos", 0},
115 {GST_EVENT_NEWSEGMENT, "newsegment", 0},
116 {GST_EVENT_TAG, "tag", 0},
117 {GST_EVENT_BUFFERSIZE, "buffersize", 0},
118 {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
119 {GST_EVENT_QOS, "qos", 0},
120 {GST_EVENT_SEEK, "seek", 0},
121 {GST_EVENT_NAVIGATION, "navigation", 0},
122 {GST_EVENT_LATENCY, "latency", 0},
123 {GST_EVENT_STEP, "step", 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_BOTH, "custom-both", 0},
128 {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},
134 * gst_event_type_get_name:
135 * @type: the event type
137 * Get a printable name for the given event type. Do not modify or free.
139 * Returns: a reference to the static name of the event.
142 gst_event_type_get_name (GstEventType type)
146 for (i = 0; event_quarks[i].name; i++) {
147 if (type == event_quarks[i].type)
148 return event_quarks[i].name;
154 * gst_event_type_to_quark:
155 * @type: the event type
157 * Get the unique quark for the given event type.
159 * Returns: the quark associated with the event type
162 gst_event_type_to_quark (GstEventType type)
166 for (i = 0; event_quarks[i].name; i++) {
167 if (type == event_quarks[i].type)
168 return event_quarks[i].quark;
174 * gst_event_type_get_flags:
175 * @type: a #GstEventType
177 * Gets the #GstEventTypeFlags associated with @type.
179 * Returns: a #GstEventTypeFlags.
182 gst_event_type_get_flags (GstEventType type)
184 GstEventTypeFlags ret;
186 ret = type & ((1 << GST_EVENT_TYPE_SHIFT) - 1);
195 for (i = 0; event_quarks[i].name; i++) { \
196 event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name); \
200 G_DEFINE_TYPE_WITH_CODE (GstEvent, gst_event, GST_TYPE_MINI_OBJECT, _do_init);
203 gst_event_class_init (GstEventClass * klass)
205 parent_class = g_type_class_peek_parent (klass);
207 klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
208 klass->mini_object_class.finalize =
209 (GstMiniObjectFinalizeFunction) gst_event_finalize;
213 gst_event_init (GstEvent * event)
215 GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
219 gst_event_finalize (GstEvent * event)
221 g_return_if_fail (event != NULL);
222 g_return_if_fail (GST_IS_EVENT (event));
224 GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
225 GST_EVENT_TYPE_NAME (event));
227 if (GST_EVENT_SRC (event)) {
228 gst_object_unref (GST_EVENT_SRC (event));
229 GST_EVENT_SRC (event) = NULL;
231 if (event->structure) {
232 gst_structure_set_parent_refcount (event->structure, NULL);
233 gst_structure_free (event->structure);
236 /* GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (event)); */
240 _gst_event_copy (GstEvent * event)
244 copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
246 GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
247 GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
248 GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
250 if (GST_EVENT_SRC (event)) {
251 GST_EVENT_SRC (copy) = gst_object_ref (GST_EVENT_SRC (event));
253 if (event->structure) {
254 copy->structure = gst_structure_copy (event->structure);
255 gst_structure_set_parent_refcount (copy->structure,
256 ©->mini_object.refcount);
262 gst_event_new (GstEventType type)
266 event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
268 GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
269 gst_event_type_get_name (type), type);
273 event->structure = NULL;
274 GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
280 * gst_event_new_custom:
281 * @type: The type of the new event
282 * @structure: (transfer full): the structure for the event. The event will
283 * take ownership of the structure.
285 * Create a new custom-typed event. This can be used for anything not
286 * handled by other event-specific functions to pass an event to another
289 * Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
290 * assigning a free number and filling in the correct direction and
291 * serialization flags.
293 * New custom events can also be created by subclassing the event type if
296 * Returns: (transfer full): the new custom event.
299 gst_event_new_custom (GstEventType type, GstStructure * structure)
303 /* structure must not have a parent */
305 g_return_val_if_fail (structure->parent_refcount == NULL, NULL);
307 event = gst_event_new (type);
309 gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
310 event->structure = structure;
316 * gst_event_get_structure:
317 * @event: The #GstEvent.
319 * Access the structure of the event.
321 * Returns: The structure of the event. The structure is still
322 * owned by the event, which means that you should not free it and
323 * that the pointer becomes invalid when you free the event.
328 gst_event_get_structure (GstEvent * event)
330 g_return_val_if_fail (GST_IS_EVENT (event), NULL);
332 return event->structure;
336 * gst_event_has_name:
337 * @event: The #GstEvent.
338 * @name: name to check
340 * Checks if @event has the given @name. This function is usually used to
341 * check the name of a custom event.
343 * Returns: %TRUE if @name matches the name of the event structure.
348 gst_event_has_name (GstEvent * event, const gchar * name)
350 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
352 if (event->structure == NULL)
355 return gst_structure_has_name (event->structure, name);
359 * gst_event_get_seqnum:
360 * @event: A #GstEvent.
362 * Retrieve the sequence number of a event.
364 * Events have ever-incrementing sequence numbers, which may also be set
365 * explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
366 * indicate that a event corresponds to some other set of events or messages,
367 * for example an EOS event corresponding to a SEEK event. It is considered good
368 * practice to make this correspondence when possible, though it is not
371 * Note that events and messages share the same sequence number incrementor;
372 * two events or messages will never not have the same sequence number unless
373 * that correspondence was made explicitly.
375 * Returns: The event's sequence number.
382 gst_event_get_seqnum (GstEvent * event)
384 g_return_val_if_fail (GST_IS_EVENT (event), -1);
386 return GST_EVENT_SEQNUM (event);
390 * gst_event_set_seqnum:
391 * @event: A #GstEvent.
392 * @seqnum: A sequence number.
394 * Set the sequence number of a event.
396 * This function might be called by the creator of a event to indicate that the
397 * event relates to other events or messages. See gst_event_get_seqnum() for
405 gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
407 g_return_if_fail (GST_IS_EVENT (event));
409 GST_EVENT_SEQNUM (event) = seqnum;
412 /* FIXME 0.11: It would be nice to have flush events
413 * that don't reset the running time in the sinks
417 * gst_event_new_flush_start:
419 * Allocate a new flush start event. The flush start event can be sent
420 * upstream and downstream and travels out-of-bounds with the dataflow.
422 * It marks pads as being flushing and will make them return
423 * #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
424 * gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
425 * gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
426 * on a flushing pad will return %FALSE immediately.
428 * Elements should unlock any blocking functions and exit their streaming
429 * functions as fast as possible when this event is received.
431 * This event is typically generated after a seek to flush out all queued data
432 * in the pipeline so that the new media is played as soon as possible.
434 * Returns: (transfer full): a new flush start event.
437 gst_event_new_flush_start (void)
439 return gst_event_new (GST_EVENT_FLUSH_START);
443 * gst_event_new_flush_stop:
445 * Allocate a new flush stop event. The flush stop event can be sent
446 * upstream and downstream and travels serialized with the dataflow.
447 * It is typically sent after sending a FLUSH_START event to make the
448 * pads accept data again.
450 * Elements can process this event synchronized with the dataflow since
451 * the preceeding FLUSH_START event stopped the dataflow.
453 * This event is typically generated to complete a seek and to resume
456 * Returns: (transfer full): a new flush stop event.
459 gst_event_new_flush_stop (void)
461 return gst_event_new (GST_EVENT_FLUSH_STOP);
467 * Create a new EOS event. The eos event can only travel downstream
468 * synchronized with the buffer flow. Elements that receive the EOS
469 * event on a pad can return #GST_FLOW_UNEXPECTED as a #GstFlowReturn
470 * when data after the EOS event arrives.
472 * The EOS event will travel down to the sink elements in the pipeline
473 * which will then post the #GST_MESSAGE_EOS on the bus after they have
474 * finished playing any buffered data.
476 * When all sinks have posted an EOS message, an EOS message is
477 * forwarded to the application.
479 * The EOS event itself will not cause any state transitions of the pipeline.
481 * Returns: (transfer full): the new EOS event.
484 gst_event_new_eos (void)
486 return gst_event_new (GST_EVENT_EOS);
490 * gst_event_new_new_segment:
491 * @update: is this segment an update to a previous one
492 * @rate: a new rate for playback
493 * @format: The format of the segment values
494 * @start: the start value of the segment
495 * @stop: the stop value of the segment
496 * @position: stream position
498 * Allocate a new newsegment event with the given format/values tripplets
500 * This method calls gst_event_new_new_segment_full() passing a default
501 * value of 1.0 for applied_rate
503 * Returns: (transfer full): a new newsegment event.
506 gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format,
507 gint64 start, gint64 stop, gint64 position)
509 return gst_event_new_new_segment_full (update, rate, 1.0, format, start,
514 * gst_event_parse_new_segment:
515 * @event: The event to query
516 * @update: (out): A pointer to the update flag of the segment
517 * @rate: (out): A pointer to the rate of the segment
518 * @format: (out): A pointer to the format of the newsegment values
519 * @start: (out): A pointer to store the start value in
520 * @stop: (out): A pointer to store the stop value in
521 * @position: (out): A pointer to store the stream time in
523 * Get the update flag, rate, format, start, stop and position in the
524 * newsegment event. In general, gst_event_parse_new_segment_full() should
525 * be used instead of this, to also retrieve the applied_rate value of the
526 * segment. See gst_event_new_new_segment_full() for a full description
527 * of the newsegment event.
530 gst_event_parse_new_segment (GstEvent * event, gboolean * update,
531 gdouble * rate, GstFormat * format, gint64 * start,
532 gint64 * stop, gint64 * position)
534 gst_event_parse_new_segment_full (event, update, rate, NULL, format, start,
539 * gst_event_new_new_segment_full:
540 * @update: Whether this segment is an update to a previous one
541 * @rate: A new rate for playback
542 * @applied_rate: The rate factor which has already been applied
543 * @format: The format of the segment values
544 * @start: The start value of the segment
545 * @stop: The stop value of the segment
546 * @position: stream position
548 * Allocate a new newsegment event with the given format/values triplets.
550 * The newsegment event marks the range of buffers to be processed. All
551 * data not within the segment range is not to be processed. This can be
552 * used intelligently by plugins to apply more efficient methods of skipping
553 * unneeded data. The valid range is expressed with the @start and @stop
556 * The position value of the segment is used in conjunction with the start
557 * value to convert the buffer timestamps into the stream time. This is
558 * usually done in sinks to report the current stream_time.
559 * @position represents the stream_time of a buffer carrying a timestamp of
560 * @start. @position cannot be -1.
562 * @start cannot be -1, @stop can be -1. If there
563 * is a valid @stop given, it must be greater or equal the @start, including
564 * when the indicated playback @rate is < 0.
566 * The @applied_rate value provides information about any rate adjustment that
567 * has already been made to the timestamps and content on the buffers of the
568 * stream. (@rate * @applied_rate) should always equal the rate that has been
569 * requested for playback. For example, if an element has an input segment
570 * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
571 * incoming timestamps and buffer content by half and output a newsegment event
572 * with @rate of 1.0 and @applied_rate of 2.0
574 * After a newsegment event, the buffer stream time is calculated with:
576 * position + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
578 * Returns: (transfer full): a new newsegment event.
583 gst_event_new_new_segment_full (gboolean update, gdouble rate,
584 gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
588 GstStructure *structure;
590 g_return_val_if_fail (rate != 0.0, NULL);
591 g_return_val_if_fail (applied_rate != 0.0, NULL);
593 if (format == GST_FORMAT_TIME) {
594 GST_CAT_INFO (GST_CAT_EVENT,
595 "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
596 "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
597 ", position %" GST_TIME_FORMAT,
598 update, rate, GST_TIME_ARGS (start),
599 GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
601 GST_CAT_INFO (GST_CAT_EVENT,
602 "creating newsegment update %d, rate %lf, format %s, "
603 "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", position %"
604 G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
608 g_return_val_if_fail (position != -1, NULL);
609 g_return_val_if_fail (start != -1, NULL);
611 g_return_val_if_fail (start <= stop, NULL);
613 structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
614 GST_QUARK (UPDATE), G_TYPE_BOOLEAN, update,
615 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
616 GST_QUARK (APPLIED_RATE), G_TYPE_DOUBLE, applied_rate,
617 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
618 GST_QUARK (START), G_TYPE_INT64, start,
619 GST_QUARK (STOP), G_TYPE_INT64, stop,
620 GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
621 event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);
627 * gst_event_parse_new_segment_full:
628 * @event: The event to query
629 * @update: (out): A pointer to the update flag of the segment
630 * @rate: (out): A pointer to the rate of the segment
631 * @applied_rate: (out): A pointer to the applied_rate of the segment
632 * @format: (out): A pointer to the format of the newsegment values
633 * @start: (out): A pointer to store the start value in
634 * @stop: (out): A pointer to store the stop value in
635 * @position: (out): A pointer to store the stream time in
637 * Get the update, rate, applied_rate, format, start, stop and
638 * position in the newsegment event. See gst_event_new_new_segment_full()
639 * for a full description of the newsegment event.
644 gst_event_parse_new_segment_full (GstEvent * event, gboolean * update,
645 gdouble * rate, gdouble * applied_rate, GstFormat * format,
646 gint64 * start, gint64 * stop, gint64 * position)
648 const GstStructure *structure;
650 g_return_if_fail (GST_IS_EVENT (event));
651 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);
653 structure = event->structure;
654 if (G_LIKELY (update))
656 g_value_get_boolean (gst_structure_id_get_value (structure,
657 GST_QUARK (UPDATE)));
660 g_value_get_double (gst_structure_id_get_value (structure,
662 if (G_LIKELY (applied_rate))
664 g_value_get_double (gst_structure_id_get_value (structure,
665 GST_QUARK (APPLIED_RATE)));
666 if (G_LIKELY (format))
668 g_value_get_enum (gst_structure_id_get_value (structure,
669 GST_QUARK (FORMAT)));
670 if (G_LIKELY (start))
672 g_value_get_int64 (gst_structure_id_get_value (structure,
676 g_value_get_int64 (gst_structure_id_get_value (structure,
678 if (G_LIKELY (position))
680 g_value_get_int64 (gst_structure_id_get_value (structure,
681 GST_QUARK (POSITION)));
686 * @taglist: (transfer full): metadata list. The event will take ownership
689 * Generates a metadata tag event from the given @taglist.
691 * Returns: (transfer full): a new #GstEvent
694 gst_event_new_tag (GstTagList * taglist)
696 g_return_val_if_fail (taglist != NULL, NULL);
698 return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
702 * gst_event_parse_tag:
703 * @event: a tag event
704 * @taglist: (out) (transfer none): pointer to metadata list
706 * Parses a tag @event and stores the results in the given @taglist location.
707 * No reference to the taglist will be returned, it remains valid only until
708 * the @event is freed. Don't modify or free the taglist, make a copy if you
709 * want to modify it or store it for later use.
712 gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
714 g_return_if_fail (GST_IS_EVENT (event));
715 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
718 *taglist = (GstTagList *) event->structure;
721 /* buffersize event */
723 * gst_event_new_buffer_size:
724 * @format: buffer format
725 * @minsize: minimum buffer size
726 * @maxsize: maximum buffer size
727 * @async: thread behavior
729 * Create a new buffersize event. The event is sent downstream and notifies
730 * elements that they should provide a buffer of the specified dimensions.
732 * When the @async flag is set, a thread boundary is prefered.
734 * Returns: (transfer full): a new #GstEvent
737 gst_event_new_buffer_size (GstFormat format, gint64 minsize,
738 gint64 maxsize, gboolean async)
741 GstStructure *structure;
743 GST_CAT_INFO (GST_CAT_EVENT,
744 "creating buffersize format %s, minsize %" G_GINT64_FORMAT
745 ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
746 minsize, maxsize, async);
748 structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
749 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
750 GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
751 GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
752 GST_QUARK (ASYNC), G_TYPE_BOOLEAN, async, NULL);
753 event = gst_event_new_custom (GST_EVENT_BUFFERSIZE, structure);
759 * gst_event_parse_buffer_size:
760 * @event: The event to query
761 * @format: (out): A pointer to store the format in
762 * @minsize: (out): A pointer to store the minsize in
763 * @maxsize: (out): A pointer to store the maxsize in
764 * @async: (out): A pointer to store the async-flag in
766 * Get the format, minsize, maxsize and async-flag in the buffersize event.
769 gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
770 gint64 * minsize, gint64 * maxsize, gboolean * async)
772 const GstStructure *structure;
774 g_return_if_fail (GST_IS_EVENT (event));
775 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_BUFFERSIZE);
777 structure = event->structure;
780 g_value_get_enum (gst_structure_id_get_value (structure,
781 GST_QUARK (FORMAT)));
784 g_value_get_int64 (gst_structure_id_get_value (structure,
785 GST_QUARK (MINSIZE)));
788 g_value_get_int64 (gst_structure_id_get_value (structure,
789 GST_QUARK (MAXSIZE)));
792 g_value_get_boolean (gst_structure_id_get_value (structure,
798 * @proportion: the proportion of the qos message
799 * @diff: The time difference of the last Clock sync
800 * @timestamp: The timestamp of the buffer
802 * Allocate a new qos event with the given values. This function calls
803 * gst_event_new_qos_full() with the type set to #GST_QOS_TYPE_OVERFLOW
804 * when diff is negative (buffers are in time) and #GST_QOS_TYPE_UNDERFLOW
805 * when @diff is positive (buffers are late).
807 * Returns: (transfer full): a new QOS event.
810 gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
811 GstClockTime timestamp)
816 type = GST_QOS_TYPE_OVERFLOW;
818 type = GST_QOS_TYPE_UNDERFLOW;
820 return gst_event_new_qos_full (type, proportion, diff, timestamp);
824 * gst_event_new_qos_full:
825 * @type: the QoS type
826 * @proportion: the proportion of the qos message
827 * @diff: The time difference of the last Clock sync
828 * @timestamp: The timestamp of the buffer
830 * Allocate a new qos event with the given values.
831 * The QOS event is generated in an element that wants an upstream
832 * element to either reduce or increase its rate because of
833 * high/low CPU load or other resource usage such as network performance or
834 * throttling. Typically sinks generate these events for each buffer
837 * @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
838 * used when a buffer arrived in time or when the sink cannot keep up with
839 * the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
840 * receiving buffers fast enough and thus has to drop late buffers.
841 * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
842 * by the application, for example to reduce power consumption.
844 * @proportion indicates the real-time performance of the streaming in the
845 * element that generated the QoS event (usually the sink). The value is
846 * generally computed based on more long term statistics about the streams
847 * timestamps compared to the clock.
848 * A value < 1.0 indicates that the upstream element is producing data faster
849 * than real-time. A value > 1.0 indicates that the upstream element is not
850 * producing data fast enough. 1.0 is the ideal @proportion value. The
851 * proportion value can safely be used to lower or increase the quality of
854 * @diff is the difference against the clock in running time of the last
855 * buffer that caused the element to generate the QOS event. A negative value
856 * means that the buffer with @timestamp arrived in time. A positive value
857 * indicates how late the buffer with @timestamp was. When throttling is
858 * enabled, @diff will be set to the requested throttling interval.
860 * @timestamp is the timestamp of the last buffer that cause the element
861 * to generate the QOS event. It is expressed in running time and thus an ever
864 * The upstream element can use the @diff and @timestamp values to decide
865 * whether to process more buffers. For possitive @diff, all buffers with
866 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
867 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
868 * result smaller than 0 is not allowed.
870 * The application can use general event probes to intercept the QoS
871 * event and implement custom application specific QoS handling.
873 * Returns: (transfer full): a new QOS event.
878 gst_event_new_qos_full (GstQOSType type, gdouble proportion,
879 GstClockTimeDiff diff, GstClockTime timestamp)
882 GstStructure *structure;
884 /* diff must be positive or timestamp + diff must be positive */
885 g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);
887 GST_CAT_INFO (GST_CAT_EVENT,
888 "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
889 ", timestamp %" GST_TIME_FORMAT, type, proportion,
890 diff, GST_TIME_ARGS (timestamp));
892 structure = gst_structure_id_new (GST_QUARK (EVENT_QOS),
893 GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
894 GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
895 GST_QUARK (DIFF), G_TYPE_INT64, diff,
896 GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
897 event = gst_event_new_custom (GST_EVENT_QOS, structure);
903 * gst_event_parse_qos:
904 * @event: The event to query
905 * @proportion: (out): A pointer to store the proportion in
906 * @diff: (out): A pointer to store the diff in
907 * @timestamp: (out): A pointer to store the timestamp in
909 * Get the proportion, diff and timestamp in the qos event. See
910 * gst_event_new_qos() for more information about the different QoS values.
913 gst_event_parse_qos (GstEvent * event, gdouble * proportion,
914 GstClockTimeDiff * diff, GstClockTime * timestamp)
916 gst_event_parse_qos_full (event, NULL, proportion, diff, timestamp);
920 * gst_event_parse_qos_full:
921 * @event: The event to query
922 * @type: (out): A pointer to store the QoS type in
923 * @proportion: (out): A pointer to store the proportion in
924 * @diff: (out): A pointer to store the diff in
925 * @timestamp: (out): A pointer to store the timestamp in
927 * Get the type, proportion, diff and timestamp in the qos event. See
928 * gst_event_new_qos_full() for more information about the different QoS values.
933 gst_event_parse_qos_full (GstEvent * event, GstQOSType * type,
934 gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
936 const GstStructure *structure;
938 g_return_if_fail (GST_IS_EVENT (event));
939 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
941 structure = event->structure;
944 g_value_get_enum (gst_structure_id_get_value (structure,
948 g_value_get_double (gst_structure_id_get_value (structure,
949 GST_QUARK (PROPORTION)));
952 g_value_get_int64 (gst_structure_id_get_value (structure,
956 g_value_get_uint64 (gst_structure_id_get_value (structure,
957 GST_QUARK (TIMESTAMP)));
961 * gst_event_new_seek:
962 * @rate: The new playback rate
963 * @format: The format of the seek values
964 * @flags: The optional seek flags
965 * @start_type: The type and flags for the new start position
966 * @start: The value of the new start position
967 * @stop_type: The type and flags for the new stop position
968 * @stop: The value of the new stop position
970 * Allocate a new seek event with the given parameters.
972 * The seek event configures playback of the pipeline between @start to @stop
973 * at the speed given in @rate, also called a playback segment.
974 * The @start and @stop values are expressed in @format.
976 * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
977 * Negatives values means backwards playback. A value of 0.0 for the
978 * rate is not allowed and should be accomplished instead by PAUSING the
981 * A pipeline has a default playback segment configured with a start
982 * position of 0, a stop position of -1 and a rate of 1.0. The currently
983 * configured playback segment can be queried with #GST_QUERY_SEGMENT.
985 * @start_type and @stop_type specify how to adjust the currently configured
986 * start and stop fields in playback segment. Adjustments can be made relative
987 * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
988 * means that the position should not be updated.
990 * When the rate is positive and @start has been updated, playback will start
991 * from the newly configured start position.
993 * For negative rates, playback will start from the newly configured stop
994 * position (if any). If the stop position if updated, it must be different from
995 * -1 for negative rates.
997 * It is not possible to seek relative to the current playback position, to do
998 * this, PAUSE the pipeline, query the current playback position with
999 * #GST_QUERY_POSITION and update the playback segment current position with a
1000 * #GST_SEEK_TYPE_SET to the desired position.
1002 * Returns: (transfer full): a new seek event.
1005 gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
1006 GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
1009 GstStructure *structure;
1011 g_return_val_if_fail (rate != 0.0, NULL);
1013 if (format == GST_FORMAT_TIME) {
1014 GST_CAT_INFO (GST_CAT_EVENT,
1015 "creating seek rate %lf, format TIME, flags %d, "
1016 "start_type %d, start %" GST_TIME_FORMAT ", "
1017 "stop_type %d, stop %" GST_TIME_FORMAT,
1018 rate, flags, start_type, GST_TIME_ARGS (start),
1019 stop_type, GST_TIME_ARGS (stop));
1021 GST_CAT_INFO (GST_CAT_EVENT,
1022 "creating seek rate %lf, format %s, flags %d, "
1023 "start_type %d, start %" G_GINT64_FORMAT ", "
1024 "stop_type %d, stop %" G_GINT64_FORMAT,
1025 rate, gst_format_get_name (format), flags, start_type, start, stop_type,
1029 structure = gst_structure_id_new (GST_QUARK (EVENT_SEEK),
1030 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1031 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1032 GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
1033 GST_QUARK (CUR_TYPE), GST_TYPE_SEEK_TYPE, start_type,
1034 GST_QUARK (CUR), G_TYPE_INT64, start,
1035 GST_QUARK (STOP_TYPE), GST_TYPE_SEEK_TYPE, stop_type,
1036 GST_QUARK (STOP), G_TYPE_INT64, stop, NULL);
1037 event = gst_event_new_custom (GST_EVENT_SEEK, structure);
1043 * gst_event_parse_seek:
1044 * @event: a seek event
1045 * @rate: (out): result location for the rate
1046 * @format: (out): result location for the stream format
1047 * @flags: (out): result location for the #GstSeekFlags
1048 * @start_type: (out): result location for the #GstSeekType of the start position
1049 * @start: (out): result location for the start postion expressed in @format
1050 * @stop_type: (out): result location for the #GstSeekType of the stop position
1051 * @stop: (out): result location for the stop postion expressed in @format
1053 * Parses a seek @event and stores the results in the given result locations.
1056 gst_event_parse_seek (GstEvent * event, gdouble * rate,
1057 GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
1058 gint64 * start, GstSeekType * stop_type, gint64 * stop)
1060 const GstStructure *structure;
1062 g_return_if_fail (GST_IS_EVENT (event));
1063 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
1065 structure = event->structure;
1068 g_value_get_double (gst_structure_id_get_value (structure,
1072 g_value_get_enum (gst_structure_id_get_value (structure,
1073 GST_QUARK (FORMAT)));
1076 g_value_get_flags (gst_structure_id_get_value (structure,
1077 GST_QUARK (FLAGS)));
1080 g_value_get_enum (gst_structure_id_get_value (structure,
1081 GST_QUARK (CUR_TYPE)));
1084 g_value_get_int64 (gst_structure_id_get_value (structure,
1088 g_value_get_enum (gst_structure_id_get_value (structure,
1089 GST_QUARK (STOP_TYPE)));
1092 g_value_get_int64 (gst_structure_id_get_value (structure,
1097 * gst_event_new_navigation:
1098 * @structure: (transfer full): description of the event. The event will take
1099 * ownership of the structure.
1101 * Create a new navigation event from the given description.
1103 * Returns: (transfer full): a new #GstEvent
1106 gst_event_new_navigation (GstStructure * structure)
1108 g_return_val_if_fail (structure != NULL, NULL);
1110 return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
1114 * gst_event_new_latency:
1115 * @latency: the new latency value
1117 * Create a new latency event. The event is sent upstream from the sinks and
1118 * notifies elements that they should add an additional @latency to the
1119 * running time before synchronising against the clock.
1121 * The latency is mostly used in live sinks and is always expressed in
1124 * Returns: (transfer full): a new #GstEvent
1129 gst_event_new_latency (GstClockTime latency)
1132 GstStructure *structure;
1134 GST_CAT_INFO (GST_CAT_EVENT,
1135 "creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));
1137 structure = gst_structure_id_new (GST_QUARK (EVENT_LATENCY),
1138 GST_QUARK (LATENCY), G_TYPE_UINT64, latency, NULL);
1139 event = gst_event_new_custom (GST_EVENT_LATENCY, structure);
1145 * gst_event_parse_latency:
1146 * @event: The event to query
1147 * @latency: (out): A pointer to store the latency in.
1149 * Get the latency in the latency event.
1154 gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
1156 g_return_if_fail (GST_IS_EVENT (event));
1157 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_LATENCY);
1161 g_value_get_uint64 (gst_structure_id_get_value (event->structure,
1162 GST_QUARK (LATENCY)));
1166 * gst_event_new_step:
1167 * @format: the format of @amount
1168 * @amount: the amount of data to step
1169 * @rate: the step rate
1170 * @flush: flushing steps
1171 * @intermediate: intermediate steps
1173 * Create a new step event. The purpose of the step event is to instruct a sink
1174 * to skip @amount (expressed in @format) of media. It can be used to implement
1175 * stepping through the video frame by frame or for doing fast trick modes.
1177 * A rate of <= 0.0 is not allowed, pause the pipeline or reverse the playback
1178 * direction of the pipeline to get the same effect.
1180 * The @flush flag will clear any pending data in the pipeline before starting
1181 * the step operation.
1183 * The @intermediate flag instructs the pipeline that this step operation is
1184 * part of a larger step operation.
1186 * Returns: (transfer full): a new #GstEvent
1191 gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
1192 gboolean flush, gboolean intermediate)
1195 GstStructure *structure;
1197 g_return_val_if_fail (rate > 0.0, NULL);
1199 GST_CAT_INFO (GST_CAT_EVENT, "creating step event");
1201 structure = gst_structure_id_new (GST_QUARK (EVENT_STEP),
1202 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1203 GST_QUARK (AMOUNT), G_TYPE_UINT64, amount,
1204 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1205 GST_QUARK (FLUSH), G_TYPE_BOOLEAN, flush,
1206 GST_QUARK (INTERMEDIATE), G_TYPE_BOOLEAN, intermediate, NULL);
1207 event = gst_event_new_custom (GST_EVENT_STEP, structure);
1213 * gst_event_parse_step:
1214 * @event: The event to query
1215 * @format: (out) (allow-none): a pointer to store the format in
1216 * @amount: (out) (allow-none): a pointer to store the amount in
1217 * @rate: (out) (allow-none): a pointer to store the rate in
1218 * @flush: (out) (allow-none): a pointer to store the flush boolean in
1219 * @intermediate: (out) (allow-none): a pointer to store the intermediate
1222 * Parse the step event.
1227 gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
1228 gdouble * rate, gboolean * flush, gboolean * intermediate)
1230 const GstStructure *structure;
1232 g_return_if_fail (GST_IS_EVENT (event));
1233 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STEP);
1235 structure = event->structure;
1237 *format = g_value_get_enum (gst_structure_id_get_value (structure,
1238 GST_QUARK (FORMAT)));
1240 *amount = g_value_get_uint64 (gst_structure_id_get_value (structure,
1241 GST_QUARK (AMOUNT)));
1243 *rate = g_value_get_double (gst_structure_id_get_value (structure,
1246 *flush = g_value_get_boolean (gst_structure_id_get_value (structure,
1247 GST_QUARK (FLUSH)));
1249 *intermediate = g_value_get_boolean (gst_structure_id_get_value (structure,
1250 GST_QUARK (INTERMEDIATE)));
1254 * gst_event_new_sink_message:
1255 * @msg: (transfer none): the #GstMessage to be posted
1257 * Create a new sink-message event. The purpose of the sink-message event is
1258 * to instruct a sink to post the message contained in the event synchronized
1261 * Returns: (transfer full): a new #GstEvent
1265 /* FIXME 0.11: take ownership of msg for consistency? */
1267 gst_event_new_sink_message (GstMessage * msg)
1270 GstStructure *structure;
1272 g_return_val_if_fail (msg != NULL, NULL);
1274 GST_CAT_INFO (GST_CAT_EVENT, "creating sink-message event");
1276 structure = gst_structure_id_new (GST_QUARK (EVENT_SINK_MESSAGE),
1277 GST_QUARK (MESSAGE), GST_TYPE_MESSAGE, msg, NULL);
1278 event = gst_event_new_custom (GST_EVENT_SINK_MESSAGE, structure);
1284 * gst_event_parse_sink_message:
1285 * @event: The event to query
1286 * @msg: (out) (transfer full): a pointer to store the #GstMessage in.
1288 * Parse the sink-message event. Unref @msg after usage.
1293 gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
1295 g_return_if_fail (GST_IS_EVENT (event));
1296 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE);
1300 GST_MESSAGE (gst_value_dup_mini_object (gst_structure_id_get_value
1301 (event->structure, GST_QUARK (MESSAGE))));