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 specify 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"
89 GType _gst_event_type = 0;
95 GstStructure *structure;
98 #define GST_EVENT_STRUCTURE(e) (((GstEventImpl *)(e))->structure)
107 static GstEventQuarks event_quarks[] = {
108 {GST_EVENT_UNKNOWN, "unknown", 0},
109 {GST_EVENT_FLUSH_START, "flush-start", 0},
110 {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
111 {GST_EVENT_STREAM_START, "stream-start", 0},
112 {GST_EVENT_CAPS, "caps", 0},
113 {GST_EVENT_STREAM_CONFIG, "stream-config", 0},
114 {GST_EVENT_SEGMENT, "segment", 0},
115 {GST_EVENT_TAG, "tag", 0},
116 {GST_EVENT_BUFFERSIZE, "buffersize", 0},
117 {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
118 {GST_EVENT_EOS, "eos", 0},
119 {GST_EVENT_SEGMENT_DONE, "segment-done", 0},
120 {GST_EVENT_GAP, "gap", 0},
121 {GST_EVENT_QOS, "qos", 0},
122 {GST_EVENT_SEEK, "seek", 0},
123 {GST_EVENT_NAVIGATION, "navigation", 0},
124 {GST_EVENT_LATENCY, "latency", 0},
125 {GST_EVENT_STEP, "step", 0},
126 {GST_EVENT_RECONFIGURE, "reconfigure", 0},
127 {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
128 {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
129 {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
130 {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
131 {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
132 {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},
137 GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
140 _priv_gst_event_initialize (void)
144 _gst_event_type = gst_event_get_type ();
146 g_type_class_ref (gst_seek_flags_get_type ());
147 g_type_class_ref (gst_seek_type_get_type ());
149 for (i = 0; event_quarks[i].name; i++) {
150 event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name);
155 * gst_event_type_get_name:
156 * @type: the event type
158 * Get a printable name for the given event type. Do not modify or free.
160 * Returns: a reference to the static name of the event.
163 gst_event_type_get_name (GstEventType type)
167 for (i = 0; event_quarks[i].name; i++) {
168 if (type == event_quarks[i].type)
169 return event_quarks[i].name;
175 * gst_event_type_to_quark:
176 * @type: the event type
178 * Get the unique quark for the given event type.
180 * Returns: the quark associated with the event type
183 gst_event_type_to_quark (GstEventType type)
187 for (i = 0; event_quarks[i].name; i++) {
188 if (type == event_quarks[i].type)
189 return event_quarks[i].quark;
195 * gst_event_type_get_flags:
196 * @type: a #GstEventType
198 * Gets the #GstEventTypeFlags associated with @type.
200 * Returns: a #GstEventTypeFlags.
203 gst_event_type_get_flags (GstEventType type)
205 GstEventTypeFlags ret;
207 ret = type & ((1 << GST_EVENT_NUM_SHIFT) - 1);
213 _gst_event_free (GstEvent * event)
217 g_return_if_fail (event != NULL);
218 g_return_if_fail (GST_IS_EVENT (event));
220 GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
221 GST_EVENT_TYPE_NAME (event));
223 s = GST_EVENT_STRUCTURE (event);
226 gst_structure_set_parent_refcount (s, NULL);
227 gst_structure_free (s);
230 g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
233 static void gst_event_init (GstEventImpl * event, gsize size,
237 _gst_event_copy (GstEvent * event)
242 copy = g_slice_new0 (GstEventImpl);
244 gst_event_init (copy, sizeof (GstEventImpl), GST_EVENT_TYPE (event));
246 GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
247 GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
249 s = GST_EVENT_STRUCTURE (event);
251 GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
252 gst_structure_set_parent_refcount (GST_EVENT_STRUCTURE (copy),
253 ©->event.mini_object.refcount);
255 return GST_EVENT_CAST (copy);
259 gst_event_init (GstEventImpl * event, gsize size, GstEventType type)
261 gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type, size);
263 event->event.mini_object.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
264 event->event.mini_object.free = (GstMiniObjectFreeFunction) _gst_event_free;
266 GST_EVENT_TYPE (event) = type;
267 GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
268 GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
272 gst_event_new (GstEventType type)
276 event = g_slice_new0 (GstEventImpl);
278 GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
279 gst_event_type_get_name (type), type);
281 gst_event_init (event, sizeof (GstEventImpl), type);
283 return GST_EVENT_CAST (event);
287 * gst_event_new_custom:
288 * @type: The type of the new event
289 * @structure: (transfer full): the structure for the event. The event will
290 * take ownership of the structure.
292 * Create a new custom-typed event. This can be used for anything not
293 * handled by other event-specific functions to pass an event to another
296 * Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
297 * assigning a free number and filling in the correct direction and
298 * serialization flags.
300 * New custom events can also be created by subclassing the event type if
303 * Returns: (transfer full): the new custom event.
306 gst_event_new_custom (GstEventType type, GstStructure * structure)
310 /* structure must not have a parent */
311 event = gst_event_new (type);
313 if (!gst_structure_set_parent_refcount (structure,
314 &event->mini_object.refcount))
317 GST_EVENT_STRUCTURE (event) = structure;
324 gst_event_unref (event);
325 g_warning ("structure is already owned by another object");
331 * gst_event_get_structure:
332 * @event: The #GstEvent.
334 * Access the structure of the event.
336 * Returns: The structure of the event. The structure is still
337 * owned by the event, which means that you should not free it and
338 * that the pointer becomes invalid when you free the event.
343 gst_event_get_structure (GstEvent * event)
345 g_return_val_if_fail (GST_IS_EVENT (event), NULL);
347 return GST_EVENT_STRUCTURE (event);
351 * gst_event_writable_structure:
352 * @event: The #GstEvent.
354 * Get a writable version of the structure.
356 * Returns: The structure of the event. The structure is still
357 * owned by the event, which means that you should not free it and
358 * that the pointer becomes invalid when you free the event.
359 * This function checks if @event is writable and will never return NULL.
364 gst_event_writable_structure (GstEvent * event)
366 GstStructure *structure;
368 g_return_val_if_fail (GST_IS_EVENT (event), NULL);
369 g_return_val_if_fail (gst_event_is_writable (event), NULL);
371 structure = GST_EVENT_STRUCTURE (event);
373 if (structure == NULL) {
375 gst_structure_new_id_empty (gst_event_type_to_quark (GST_EVENT_TYPE
377 gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
378 GST_EVENT_STRUCTURE (event) = structure;
384 * gst_event_has_name:
385 * @event: The #GstEvent.
386 * @name: name to check
388 * Checks if @event has the given @name. This function is usually used to
389 * check the name of a custom event.
391 * Returns: %TRUE if @name matches the name of the event structure.
396 gst_event_has_name (GstEvent * event, const gchar * name)
398 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
400 if (GST_EVENT_STRUCTURE (event) == NULL)
403 return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
407 * gst_event_get_seqnum:
408 * @event: A #GstEvent.
410 * Retrieve the sequence number of a event.
412 * Events have ever-incrementing sequence numbers, which may also be set
413 * explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
414 * indicate that a event corresponds to some other set of events or messages,
415 * for example an EOS event corresponding to a SEEK event. It is considered good
416 * practice to make this correspondence when possible, though it is not
419 * Note that events and messages share the same sequence number incrementor;
420 * two events or messages will never have the same sequence number unless
421 * that correspondence was made explicitly.
423 * Returns: The event's sequence number.
430 gst_event_get_seqnum (GstEvent * event)
432 g_return_val_if_fail (GST_IS_EVENT (event), -1);
434 return GST_EVENT_SEQNUM (event);
438 * gst_event_set_seqnum:
439 * @event: A #GstEvent.
440 * @seqnum: A sequence number.
442 * Set the sequence number of a event.
444 * This function might be called by the creator of a event to indicate that the
445 * event relates to other events or messages. See gst_event_get_seqnum() for
453 gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
455 g_return_if_fail (GST_IS_EVENT (event));
457 GST_EVENT_SEQNUM (event) = seqnum;
460 /* FIXME 0.11: It would be nice to have flush events
461 * that don't reset the running time in the sinks
465 * gst_event_new_flush_start:
467 * Allocate a new flush start event. The flush start event can be sent
468 * upstream and downstream and travels out-of-bounds with the dataflow.
470 * It marks pads as being flushing and will make them return
471 * #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
472 * gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
473 * gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
474 * on a flushing pad will return %FALSE immediately.
476 * Elements should unlock any blocking functions and exit their streaming
477 * functions as fast as possible when this event is received.
479 * This event is typically generated after a seek to flush out all queued data
480 * in the pipeline so that the new media is played as soon as possible.
482 * Returns: (transfer full): a new flush start event.
485 gst_event_new_flush_start (void)
487 return gst_event_new (GST_EVENT_FLUSH_START);
491 * gst_event_new_flush_stop:
492 * @reset_time: if time should be reset
494 * Allocate a new flush stop event. The flush stop event can be sent
495 * upstream and downstream and travels serialized with the dataflow.
496 * It is typically sent after sending a FLUSH_START event to make the
497 * pads accept data again.
499 * Elements can process this event synchronized with the dataflow since
500 * the preceeding FLUSH_START event stopped the dataflow.
502 * This event is typically generated to complete a seek and to resume
505 * Returns: (transfer full): a new flush stop event.
508 gst_event_new_flush_stop (gboolean reset_time)
512 GST_CAT_INFO (GST_CAT_EVENT, "creating flush stop %d", reset_time);
514 event = gst_event_new_custom (GST_EVENT_FLUSH_STOP,
515 gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
516 GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL));
522 * gst_event_parse_flush_stop:
523 * @event: The event to parse
524 * @reset_time: (out): if time should be reset
526 * Parse the FLUSH_STOP event and retrieve the @reset_time member.
529 gst_event_parse_flush_stop (GstEvent * event, gboolean * reset_time)
531 GstStructure *structure;
533 g_return_if_fail (GST_IS_EVENT (event));
534 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP);
536 structure = GST_EVENT_STRUCTURE (event);
537 if (G_LIKELY (reset_time))
539 g_value_get_boolean (gst_structure_id_get_value (structure,
540 GST_QUARK (RESET_TIME)));
546 * Create a new EOS event. The eos event can only travel downstream
547 * synchronized with the buffer flow. Elements that receive the EOS
548 * event on a pad can return #GST_FLOW_UNEXPECTED as a #GstFlowReturn
549 * when data after the EOS event arrives.
551 * The EOS event will travel down to the sink elements in the pipeline
552 * which will then post the #GST_MESSAGE_EOS on the bus after they have
553 * finished playing any buffered data.
555 * When all sinks have posted an EOS message, an EOS message is
556 * forwarded to the application.
558 * The EOS event itself will not cause any state transitions of the pipeline.
560 * Returns: (transfer full): the new EOS event.
563 gst_event_new_eos (void)
565 return gst_event_new (GST_EVENT_EOS);
570 * @timestamp: the start time (pts) of the gap
571 * @duration: the duration of the gap
573 * Create a new GAP event. A gap event can be thought of as conceptually
574 * equivalent to a buffer to signal that there is no data for a certain
575 * amount of time. This is useful to signal a gap to downstream elements
576 * which may wait for data, such as muxers or mixers or overlays, especially
577 * for sparse streams such as subtitle streams.
579 * Returns: (transfer full): the new GAP event.
582 gst_event_new_gap (GstClockTime timestamp, GstClockTime duration)
586 g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
587 g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (duration), NULL);
589 GST_CAT_TRACE (GST_CAT_EVENT, "creating gap %" GST_TIME_FORMAT " - "
590 "%" GST_TIME_FORMAT " (duration: %" GST_TIME_FORMAT ")",
591 GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
592 GST_TIME_ARGS (duration));
594 event = gst_event_new_custom (GST_EVENT_GAP,
595 gst_structure_new_id (GST_QUARK (EVENT_GAP),
596 GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
597 GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL));
603 * gst_event_parse_gap:
604 * @timestamp: (out) (allow-none): location where to store the
605 * start time (pts) of the gap, or %NULL
606 * @duration: (out) (allow-none): location where to store the duration of
609 * Extract timestamp and duration from a new GAP event.
612 gst_event_parse_gap (GstEvent * event, GstClockTime * timestamp,
613 GstClockTime * duration)
615 GstStructure *structure;
617 g_return_if_fail (GST_IS_EVENT (event));
618 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_GAP);
620 structure = GST_EVENT_STRUCTURE (event);
621 gst_structure_id_get (structure,
622 GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
623 GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL);
627 * gst_event_new_caps:
628 * @caps: (transfer none): a #GstCaps
630 * Create a new CAPS event for @caps. The caps event can only travel downstream
631 * synchronized with the buffer flow and contains the format of the buffers
632 * that will follow after the event.
634 * Returns: (transfer full): the new CAPS event.
637 gst_event_new_caps (GstCaps * caps)
641 g_return_val_if_fail (caps != NULL, NULL);
642 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
644 GST_CAT_INFO (GST_CAT_EVENT, "creating caps event %" GST_PTR_FORMAT, caps);
646 event = gst_event_new_custom (GST_EVENT_CAPS,
647 gst_structure_new_id (GST_QUARK (EVENT_CAPS),
648 GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));
654 * gst_event_parse_caps:
655 * @event: The event to parse
656 * @caps: (out): A pointer to the caps
658 * Get the caps from @event. The caps remains valid as long as @event remains
662 gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
664 GstStructure *structure;
666 g_return_if_fail (GST_IS_EVENT (event));
667 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_CAPS);
669 structure = GST_EVENT_STRUCTURE (event);
672 g_value_get_boxed (gst_structure_id_get_value (structure,
677 * gst_event_new_stream_config:
678 * @flags: the stream config flags
680 * Create a new STREAM CONFIG event. The stream config event travels
681 * downstream synchronized with the buffer flow and contains stream
682 * configuration information for the stream, such as stream-headers
683 * or codec-data. It is optional and should be sent after the CAPS
686 * Returns: (transfer full): the new STREAM CONFIG event.
689 gst_event_new_stream_config (GstStreamConfigFlags flags)
693 GST_CAT_INFO (GST_CAT_EVENT, "creating stream info event, flags=0x%x", flags);
695 event = gst_event_new_custom (GST_EVENT_STREAM_CONFIG,
696 gst_structure_new_id (GST_QUARK (EVENT_STREAM_CONFIG),
697 GST_QUARK (FLAGS), GST_TYPE_STREAM_CONFIG_FLAGS, flags, NULL));
703 * gst_event_parse_stream_config:
704 * @event: The event to parse
705 * @flags: (out): a pointer to a variable to store the stream config flags
707 * Get the stream config flags from @event.
710 gst_event_parse_stream_config (GstEvent * event, GstStreamConfigFlags * flags)
712 GstStructure *structure;
714 g_return_if_fail (GST_IS_EVENT (event));
715 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
717 structure = GST_EVENT_STRUCTURE (event);
718 if (G_LIKELY (flags != NULL)) {
720 g_value_get_enum (gst_structure_id_get_value (structure,
726 * gst_event_set_stream_config_codec_data:
727 * @event: a stream config event
728 * @buf: a #GstBuffer with codec data
730 * Set codec data on the stream info event to signal out of bound setup data
731 * to downstream elements. Unlike stream headers, codec data contains data
732 * that is required to interpret the data stream, but is not valid as-is
733 * inside the data stream and thus can't just be prepended to or inserted
734 * into the data stream.
737 gst_event_set_stream_config_codec_data (GstEvent * event, GstBuffer * buf)
741 g_return_if_fail (GST_IS_EVENT (event));
742 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
743 g_return_if_fail (GST_IS_BUFFER (buf) && gst_buffer_get_size (buf) > 0);
745 s = GST_EVENT_STRUCTURE (event);
746 gst_structure_id_set (s, GST_QUARK (CODEC_DATA), GST_TYPE_BUFFER, buf, NULL);
750 * gst_event_set_stream_config_codec_data:
751 * @event: a stream config event
752 * @buf: (out) (transfer none): location where to store the #GstBuffer with codec data
754 * Extracts the codec data buffer from the stream info event. Will store
755 * %NULL in @buf if the event contains no codec data. The buffer returned
756 * will remain valid as long as @event remains valid. The caller should
757 * acquire a referenceto to @buf if needed.
760 gst_event_parse_stream_config_codec_data (GstEvent * event, GstBuffer ** buf)
765 g_return_if_fail (GST_IS_EVENT (event));
766 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
767 g_return_if_fail (buf != NULL);
769 s = GST_EVENT_STRUCTURE (event);
770 val = gst_structure_id_get_value (s, GST_QUARK (CODEC_DATA));
772 *buf = g_value_get_boxed (val);
778 * gst_event_add_stream_config_header:
779 * @event: a stream config event
780 * @buf: a #GstBuffer with stream header data
782 * Adds a stream header to the stream info event to signal stream headers to
783 * to downstream elements such as multifilesink, tcpserversink etc. Stream
784 * headers can be and should usually be prepended to the data stream at any
785 * point in the stream (which requires a streamable format), e.g. to a new
786 * client connecting, or when starting a new file segment. stream header
787 * buffers will all be used together in the order they were added to the
788 * stream config event. Stream headers are sent as buffers at the beginning
789 * of the data flow in addition to the stream config event. Elements that
790 * care about stream headers need to make sure that they don't insert or
791 * interpret these header buffers twice if they interpret them.
794 gst_event_add_stream_config_header (GstEvent * event, GstBuffer * buf)
797 GValue buf_val = { 0, };
800 g_return_if_fail (GST_IS_EVENT (event));
801 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
802 g_return_if_fail (GST_IS_BUFFER (buf) && gst_buffer_get_size (buf) > 0);
804 g_value_init (&buf_val, GST_TYPE_BUFFER);
805 g_value_set_boxed (&buf_val, buf);
807 s = GST_EVENT_STRUCTURE (event);
808 val = (GValue *) gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));
810 GValue new_array = { 0, };
812 g_value_init (&new_array, GST_TYPE_ARRAY);
813 gst_value_array_append_value (&new_array, &buf_val);
814 gst_structure_id_take_value (s, GST_QUARK (STREAM_HEADERS), &new_array);
816 gst_value_array_append_value (val, &buf_val);
818 g_value_unset (&buf_val);
822 * gst_event_get_n_stream_config_headers:
823 * @event: a stream config event
825 * Extract the number of stream header buffers.
827 * Returns: the number of stream header buffers attached to the stream info
831 gst_event_get_n_stream_config_headers (GstEvent * event)
837 g_return_val_if_fail (GST_IS_EVENT (event), 0);
838 g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG, 0);
840 s = GST_EVENT_STRUCTURE (event);
841 val = gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));
844 num = gst_value_array_get_size (val);
850 * gst_event_parse_nth_stream_config_header:
851 * @event: a stream config event
852 * @index: number of the stream header to retrieve
853 * @buf: (out) (transfer none): location where to store the n-th stream
856 * Retrieves the n-th stream header buffer attached to the stream config
857 * event and stores it in @buf. Will store %NULL in @buf if there is no such
861 gst_event_parse_nth_stream_config_header (GstEvent * event, guint index,
864 const GValue *val, *buf_val;
866 GstBuffer *ret = NULL;
868 g_return_if_fail (GST_IS_EVENT (event));
869 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
870 g_return_if_fail (buf != NULL);
872 s = GST_EVENT_STRUCTURE (event);
873 val = gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));
876 buf_val = gst_value_array_get_value (val, index);
878 ret = g_value_get_boxed (buf_val);
885 * gst_event_new_segment:
886 * @segment: (transfer none): a #GstSegment
888 * Create a new SEGMENT event for @segment. The segment event can only travel
889 * downstream synchronized with the buffer flow and contains timing information
890 * and playback properties for the buffers that will follow.
892 * The newsegment event marks the range of buffers to be processed. All
893 * data not within the segment range is not to be processed. This can be
894 * used intelligently by plugins to apply more efficient methods of skipping
895 * unneeded data. The valid range is expressed with the @start and @stop
898 * The time value of the segment is used in conjunction with the start
899 * value to convert the buffer timestamps into the stream time. This is
900 * usually done in sinks to report the current stream_time.
901 * @time represents the stream_time of a buffer carrying a timestamp of
902 * @start. @time cannot be -1.
904 * @start cannot be -1, @stop can be -1. If there
905 * is a valid @stop given, it must be greater or equal the @start, including
906 * when the indicated playback @rate is < 0.
908 * The @applied_rate value provides information about any rate adjustment that
909 * has already been made to the timestamps and content on the buffers of the
910 * stream. (@rate * @applied_rate) should always equal the rate that has been
911 * requested for playback. For example, if an element has an input segment
912 * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
913 * incoming timestamps and buffer content by half and output a newsegment event
914 * with @rate of 1.0 and @applied_rate of 2.0
916 * After a newsegment event, the buffer stream time is calculated with:
918 * time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
920 * Returns: (transfer full): the new SEGMENT event.
923 gst_event_new_segment (const GstSegment * segment)
927 g_return_val_if_fail (segment != NULL, NULL);
928 g_return_val_if_fail (segment->rate != 0.0, NULL);
929 g_return_val_if_fail (segment->applied_rate != 0.0, NULL);
930 g_return_val_if_fail (segment->format != GST_FORMAT_UNDEFINED, NULL);
932 GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
935 event = gst_event_new_custom (GST_EVENT_SEGMENT,
936 gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
937 GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
943 * gst_event_parse_segment:
944 * @event: The event to parse
945 * @segment: (out) (transfer none): a pointer to a #GstSegment
947 * Parses a segment @event and stores the result in the given @segment location.
948 * @segment remains valid only until the @event is freed. Don't modify the segment
949 * and make a copy if you want to modify it or store it for later use.
952 gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
954 GstStructure *structure;
956 g_return_if_fail (GST_IS_EVENT (event));
957 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
960 structure = GST_EVENT_STRUCTURE (event);
961 *segment = g_value_get_boxed (gst_structure_id_get_value (structure,
962 GST_QUARK (SEGMENT)));
967 * gst_event_copy_segment:
968 * @event: The event to parse
969 * @segment: a pointer to a #GstSegment
971 * Parses a segment @event and copies the #GstSegment into the location
975 gst_event_copy_segment (GstEvent * event, GstSegment * segment)
977 const GstSegment *src;
979 g_return_if_fail (GST_IS_EVENT (event));
980 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
983 gst_event_parse_segment (event, &src);
984 gst_segment_copy_into (src, segment);
990 * @taglist: (transfer full): metadata list. The event will take ownership
993 * Generates a metadata tag event from the given @taglist.
995 * Returns: (transfer full): a new #GstEvent
998 gst_event_new_tag (GstTagList * taglist)
1000 g_return_val_if_fail (taglist != NULL, NULL);
1002 return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
1006 * gst_event_parse_tag:
1007 * @event: a tag event
1008 * @taglist: (out) (transfer none): pointer to metadata list
1010 * Parses a tag @event and stores the results in the given @taglist location.
1011 * No reference to the taglist will be returned, it remains valid only until
1012 * the @event is freed. Don't modify or free the taglist, make a copy if you
1013 * want to modify it or store it for later use.
1016 gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
1018 g_return_if_fail (GST_IS_EVENT (event));
1019 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
1022 *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
1025 /* buffersize event */
1027 * gst_event_new_buffer_size:
1028 * @format: buffer format
1029 * @minsize: minimum buffer size
1030 * @maxsize: maximum buffer size
1031 * @async: thread behavior
1033 * Create a new buffersize event. The event is sent downstream and notifies
1034 * elements that they should provide a buffer of the specified dimensions.
1036 * When the @async flag is set, a thread boundary is preferred.
1038 * Returns: (transfer full): a new #GstEvent
1041 gst_event_new_buffer_size (GstFormat format, gint64 minsize,
1042 gint64 maxsize, gboolean async)
1045 GstStructure *structure;
1047 GST_CAT_INFO (GST_CAT_EVENT,
1048 "creating buffersize format %s, minsize %" G_GINT64_FORMAT
1049 ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
1050 minsize, maxsize, async);
1052 structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
1053 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1054 GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
1055 GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
1056 GST_QUARK (ASYNC), G_TYPE_BOOLEAN, async, NULL);
1057 event = gst_event_new_custom (GST_EVENT_BUFFERSIZE, structure);
1063 * gst_event_parse_buffer_size:
1064 * @event: The event to query
1065 * @format: (out): A pointer to store the format in
1066 * @minsize: (out): A pointer to store the minsize in
1067 * @maxsize: (out): A pointer to store the maxsize in
1068 * @async: (out): A pointer to store the async-flag in
1070 * Get the format, minsize, maxsize and async-flag in the buffersize event.
1073 gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
1074 gint64 * minsize, gint64 * maxsize, gboolean * async)
1076 const GstStructure *structure;
1078 g_return_if_fail (GST_IS_EVENT (event));
1079 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_BUFFERSIZE);
1081 structure = GST_EVENT_STRUCTURE (event);
1083 *format = (GstFormat)
1084 g_value_get_enum (gst_structure_id_get_value (structure,
1085 GST_QUARK (FORMAT)));
1088 g_value_get_int64 (gst_structure_id_get_value (structure,
1089 GST_QUARK (MINSIZE)));
1092 g_value_get_int64 (gst_structure_id_get_value (structure,
1093 GST_QUARK (MAXSIZE)));
1096 g_value_get_boolean (gst_structure_id_get_value (structure,
1097 GST_QUARK (ASYNC)));
1101 * gst_event_new_qos:
1102 * @type: the QoS type
1103 * @proportion: the proportion of the qos message
1104 * @diff: The time difference of the last Clock sync
1105 * @timestamp: The timestamp of the buffer
1107 * Allocate a new qos event with the given values.
1108 * The QOS event is generated in an element that wants an upstream
1109 * element to either reduce or increase its rate because of
1110 * high/low CPU load or other resource usage such as network performance or
1111 * throttling. Typically sinks generate these events for each buffer
1114 * @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
1115 * used when a buffer arrived in time or when the sink cannot keep up with
1116 * the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
1117 * receiving buffers fast enough and thus has to drop late buffers.
1118 * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
1119 * by the application, for example to reduce power consumption.
1121 * @proportion indicates the real-time performance of the streaming in the
1122 * element that generated the QoS event (usually the sink). The value is
1123 * generally computed based on more long term statistics about the streams
1124 * timestamps compared to the clock.
1125 * A value < 1.0 indicates that the upstream element is producing data faster
1126 * than real-time. A value > 1.0 indicates that the upstream element is not
1127 * producing data fast enough. 1.0 is the ideal @proportion value. The
1128 * proportion value can safely be used to lower or increase the quality of
1131 * @diff is the difference against the clock in running time of the last
1132 * buffer that caused the element to generate the QOS event. A negative value
1133 * means that the buffer with @timestamp arrived in time. A positive value
1134 * indicates how late the buffer with @timestamp was. When throttling is
1135 * enabled, @diff will be set to the requested throttling interval.
1137 * @timestamp is the timestamp of the last buffer that cause the element
1138 * to generate the QOS event. It is expressed in running time and thus an ever
1141 * The upstream element can use the @diff and @timestamp values to decide
1142 * whether to process more buffers. For possitive @diff, all buffers with
1143 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
1144 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
1145 * result smaller than 0 is not allowed.
1147 * The application can use general event probes to intercept the QoS
1148 * event and implement custom application specific QoS handling.
1150 * Returns: (transfer full): a new QOS event.
1153 gst_event_new_qos (GstQOSType type, gdouble proportion,
1154 GstClockTimeDiff diff, GstClockTime timestamp)
1157 GstStructure *structure;
1159 /* diff must be positive or timestamp + diff must be positive */
1160 g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);
1162 GST_CAT_LOG (GST_CAT_EVENT,
1163 "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
1164 ", timestamp %" GST_TIME_FORMAT, type, proportion,
1165 diff, GST_TIME_ARGS (timestamp));
1167 structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
1168 GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
1169 GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
1170 GST_QUARK (DIFF), G_TYPE_INT64, diff,
1171 GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
1172 event = gst_event_new_custom (GST_EVENT_QOS, structure);
1178 * gst_event_parse_qos:
1179 * @event: The event to query
1180 * @type: (out): A pointer to store the QoS type in
1181 * @proportion: (out): A pointer to store the proportion in
1182 * @diff: (out): A pointer to store the diff in
1183 * @timestamp: (out): A pointer to store the timestamp in
1185 * Get the type, proportion, diff and timestamp in the qos event. See
1186 * gst_event_new_qos() for more information about the different QoS values.
1189 gst_event_parse_qos (GstEvent * event, GstQOSType * type,
1190 gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
1192 const GstStructure *structure;
1194 g_return_if_fail (GST_IS_EVENT (event));
1195 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
1197 structure = GST_EVENT_STRUCTURE (event);
1199 *type = (GstQOSType)
1200 g_value_get_enum (gst_structure_id_get_value (structure,
1204 g_value_get_double (gst_structure_id_get_value (structure,
1205 GST_QUARK (PROPORTION)));
1208 g_value_get_int64 (gst_structure_id_get_value (structure,
1212 g_value_get_uint64 (gst_structure_id_get_value (structure,
1213 GST_QUARK (TIMESTAMP)));
1217 * gst_event_new_seek:
1218 * @rate: The new playback rate
1219 * @format: The format of the seek values
1220 * @flags: The optional seek flags
1221 * @start_type: The type and flags for the new start position
1222 * @start: The value of the new start position
1223 * @stop_type: The type and flags for the new stop position
1224 * @stop: The value of the new stop position
1226 * Allocate a new seek event with the given parameters.
1228 * The seek event configures playback of the pipeline between @start to @stop
1229 * at the speed given in @rate, also called a playback segment.
1230 * The @start and @stop values are expressed in @format.
1232 * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
1233 * Negatives values means backwards playback. A value of 0.0 for the
1234 * rate is not allowed and should be accomplished instead by PAUSING the
1237 * A pipeline has a default playback segment configured with a start
1238 * position of 0, a stop position of -1 and a rate of 1.0. The currently
1239 * configured playback segment can be queried with #GST_QUERY_SEGMENT.
1241 * @start_type and @stop_type specify how to adjust the currently configured
1242 * start and stop fields in playback segment. Adjustments can be made relative
1243 * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
1244 * means that the position should not be updated.
1246 * When the rate is positive and @start has been updated, playback will start
1247 * from the newly configured start position.
1249 * For negative rates, playback will start from the newly configured stop
1250 * position (if any). If the stop position if updated, it must be different from
1251 * -1 for negative rates.
1253 * It is not possible to seek relative to the current playback position, to do
1254 * this, PAUSE the pipeline, query the current playback position with
1255 * #GST_QUERY_POSITION and update the playback segment current position with a
1256 * #GST_SEEK_TYPE_SET to the desired position.
1258 * Returns: (transfer full): a new seek event.
1261 gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
1262 GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
1265 GstStructure *structure;
1267 g_return_val_if_fail (rate != 0.0, NULL);
1269 if (format == GST_FORMAT_TIME) {
1270 GST_CAT_INFO (GST_CAT_EVENT,
1271 "creating seek rate %lf, format TIME, flags %d, "
1272 "start_type %d, start %" GST_TIME_FORMAT ", "
1273 "stop_type %d, stop %" GST_TIME_FORMAT,
1274 rate, flags, start_type, GST_TIME_ARGS (start),
1275 stop_type, GST_TIME_ARGS (stop));
1277 GST_CAT_INFO (GST_CAT_EVENT,
1278 "creating seek rate %lf, format %s, flags %d, "
1279 "start_type %d, start %" G_GINT64_FORMAT ", "
1280 "stop_type %d, stop %" G_GINT64_FORMAT,
1281 rate, gst_format_get_name (format), flags, start_type, start, stop_type,
1285 structure = gst_structure_new_id (GST_QUARK (EVENT_SEEK),
1286 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1287 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1288 GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
1289 GST_QUARK (CUR_TYPE), GST_TYPE_SEEK_TYPE, start_type,
1290 GST_QUARK (CUR), G_TYPE_INT64, start,
1291 GST_QUARK (STOP_TYPE), GST_TYPE_SEEK_TYPE, stop_type,
1292 GST_QUARK (STOP), G_TYPE_INT64, stop, NULL);
1293 event = gst_event_new_custom (GST_EVENT_SEEK, structure);
1299 * gst_event_parse_seek:
1300 * @event: a seek event
1301 * @rate: (out): result location for the rate
1302 * @format: (out): result location for the stream format
1303 * @flags: (out): result location for the #GstSeekFlags
1304 * @start_type: (out): result location for the #GstSeekType of the start position
1305 * @start: (out): result location for the start postion expressed in @format
1306 * @stop_type: (out): result location for the #GstSeekType of the stop position
1307 * @stop: (out): result location for the stop postion expressed in @format
1309 * Parses a seek @event and stores the results in the given result locations.
1312 gst_event_parse_seek (GstEvent * event, gdouble * rate,
1313 GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
1314 gint64 * start, GstSeekType * stop_type, gint64 * stop)
1316 const GstStructure *structure;
1318 g_return_if_fail (GST_IS_EVENT (event));
1319 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
1321 structure = GST_EVENT_STRUCTURE (event);
1324 g_value_get_double (gst_structure_id_get_value (structure,
1327 *format = (GstFormat)
1328 g_value_get_enum (gst_structure_id_get_value (structure,
1329 GST_QUARK (FORMAT)));
1331 *flags = (GstSeekFlags)
1332 g_value_get_flags (gst_structure_id_get_value (structure,
1333 GST_QUARK (FLAGS)));
1335 *start_type = (GstSeekType)
1336 g_value_get_enum (gst_structure_id_get_value (structure,
1337 GST_QUARK (CUR_TYPE)));
1340 g_value_get_int64 (gst_structure_id_get_value (structure,
1343 *stop_type = (GstSeekType)
1344 g_value_get_enum (gst_structure_id_get_value (structure,
1345 GST_QUARK (STOP_TYPE)));
1348 g_value_get_int64 (gst_structure_id_get_value (structure,
1353 * gst_event_new_navigation:
1354 * @structure: (transfer full): description of the event. The event will take
1355 * ownership of the structure.
1357 * Create a new navigation event from the given description.
1359 * Returns: (transfer full): a new #GstEvent
1362 gst_event_new_navigation (GstStructure * structure)
1364 g_return_val_if_fail (structure != NULL, NULL);
1366 return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
1370 * gst_event_new_latency:
1371 * @latency: the new latency value
1373 * Create a new latency event. The event is sent upstream from the sinks and
1374 * notifies elements that they should add an additional @latency to the
1375 * running time before synchronising against the clock.
1377 * The latency is mostly used in live sinks and is always expressed in
1380 * Returns: (transfer full): a new #GstEvent
1385 gst_event_new_latency (GstClockTime latency)
1388 GstStructure *structure;
1390 GST_CAT_INFO (GST_CAT_EVENT,
1391 "creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));
1393 structure = gst_structure_new_id (GST_QUARK (EVENT_LATENCY),
1394 GST_QUARK (LATENCY), G_TYPE_UINT64, latency, NULL);
1395 event = gst_event_new_custom (GST_EVENT_LATENCY, structure);
1401 * gst_event_parse_latency:
1402 * @event: The event to query
1403 * @latency: (out): A pointer to store the latency in.
1405 * Get the latency in the latency event.
1410 gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
1412 g_return_if_fail (GST_IS_EVENT (event));
1413 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_LATENCY);
1417 g_value_get_uint64 (gst_structure_id_get_value (GST_EVENT_STRUCTURE
1418 (event), GST_QUARK (LATENCY)));
1422 * gst_event_new_step:
1423 * @format: the format of @amount
1424 * @amount: the amount of data to step
1425 * @rate: the step rate
1426 * @flush: flushing steps
1427 * @intermediate: intermediate steps
1429 * Create a new step event. The purpose of the step event is to instruct a sink
1430 * to skip @amount (expressed in @format) of media. It can be used to implement
1431 * stepping through the video frame by frame or for doing fast trick modes.
1433 * A rate of <= 0.0 is not allowed. Pause the pipeline, for the effect of rate
1434 * = 0.0 or first reverse the direction of playback using a seek event to get
1435 * the same effect as rate < 0.0.
1437 * The @flush flag will clear any pending data in the pipeline before starting
1438 * the step operation.
1440 * The @intermediate flag instructs the pipeline that this step operation is
1441 * part of a larger step operation.
1443 * Returns: (transfer full): a new #GstEvent
1448 gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
1449 gboolean flush, gboolean intermediate)
1452 GstStructure *structure;
1454 g_return_val_if_fail (rate > 0.0, NULL);
1456 GST_CAT_INFO (GST_CAT_EVENT, "creating step event");
1458 structure = gst_structure_new_id (GST_QUARK (EVENT_STEP),
1459 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1460 GST_QUARK (AMOUNT), G_TYPE_UINT64, amount,
1461 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1462 GST_QUARK (FLUSH), G_TYPE_BOOLEAN, flush,
1463 GST_QUARK (INTERMEDIATE), G_TYPE_BOOLEAN, intermediate, NULL);
1464 event = gst_event_new_custom (GST_EVENT_STEP, structure);
1470 * gst_event_parse_step:
1471 * @event: The event to query
1472 * @format: (out) (allow-none): a pointer to store the format in
1473 * @amount: (out) (allow-none): a pointer to store the amount in
1474 * @rate: (out) (allow-none): a pointer to store the rate in
1475 * @flush: (out) (allow-none): a pointer to store the flush boolean in
1476 * @intermediate: (out) (allow-none): a pointer to store the intermediate
1479 * Parse the step event.
1484 gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
1485 gdouble * rate, gboolean * flush, gboolean * intermediate)
1487 const GstStructure *structure;
1489 g_return_if_fail (GST_IS_EVENT (event));
1490 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STEP);
1492 structure = GST_EVENT_STRUCTURE (event);
1495 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1496 GST_QUARK (FORMAT)));
1498 *amount = g_value_get_uint64 (gst_structure_id_get_value (structure,
1499 GST_QUARK (AMOUNT)));
1501 *rate = g_value_get_double (gst_structure_id_get_value (structure,
1504 *flush = g_value_get_boolean (gst_structure_id_get_value (structure,
1505 GST_QUARK (FLUSH)));
1507 *intermediate = g_value_get_boolean (gst_structure_id_get_value (structure,
1508 GST_QUARK (INTERMEDIATE)));
1512 * gst_event_new_reconfigure:
1514 * Create a new reconfigure event. The purpose of the reconfingure event is
1515 * to travel upstream and make elements renegotiate their caps or reconfigure
1516 * their buffer pools. This is useful when changing properties on elements
1517 * or changing the topology of the pipeline.
1519 * Returns: (transfer full): a new #GstEvent
1524 gst_event_new_reconfigure (void)
1528 GST_CAT_INFO (GST_CAT_EVENT, "creating reconfigure event");
1530 event = gst_event_new_custom (GST_EVENT_RECONFIGURE, NULL);
1536 * gst_event_new_sink_message:
1537 * @msg: (transfer none): the #GstMessage to be posted
1539 * Create a new sink-message event. The purpose of the sink-message event is
1540 * to instruct a sink to post the message contained in the event synchronized
1543 * Returns: (transfer full): a new #GstEvent
1547 /* FIXME 0.11: take ownership of msg for consistency? */
1549 gst_event_new_sink_message (GstMessage * msg)
1552 GstStructure *structure;
1554 g_return_val_if_fail (msg != NULL, NULL);
1556 GST_CAT_INFO (GST_CAT_EVENT, "creating sink-message event");
1558 structure = gst_structure_new_id (GST_QUARK (EVENT_SINK_MESSAGE),
1559 GST_QUARK (MESSAGE), GST_TYPE_MESSAGE, msg, NULL);
1560 event = gst_event_new_custom (GST_EVENT_SINK_MESSAGE, structure);
1566 * gst_event_parse_sink_message:
1567 * @event: The event to query
1568 * @msg: (out) (transfer full): a pointer to store the #GstMessage in.
1570 * Parse the sink-message event. Unref @msg after usage.
1575 gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
1577 const GstStructure *structure;
1579 g_return_if_fail (GST_IS_EVENT (event));
1580 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE);
1582 structure = GST_EVENT_STRUCTURE (event);
1585 GST_MESSAGE (g_value_dup_boxed (gst_structure_id_get_value
1586 (structure, GST_QUARK (MESSAGE))));
1590 * gst_event_new_stream_start
1592 * Create a new STREAM_START event. The stream start event can only
1593 * travel downstream synchronized with the buffer flow. It is expected
1594 * to be the first event that is sent for a new stream.
1596 * Source elements, demuxers and other elements that create new streams
1597 * are supposed to send this event as the first event of a new stream. It
1598 * should not be send after a flushing seek or in similar situations
1599 * and is used to mark the beginning of a new logical stream. Elements
1600 * combining multiple streams must ensure that this event is only forwarded
1601 * downstream once and not for every single input stream.
1603 * Returns: (transfer full): the new STREAM_START event.
1606 gst_event_new_stream_start (void)
1608 return gst_event_new (GST_EVENT_STREAM_START);