blob: e0e0ea6f6a37a408131ef98992a88268d4c46ea8 [file] [log] [blame]
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001/* 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
Sebastian Dröge01f23672013-07-14 10:55:08 +020020 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020022 */
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 *
Olivier Naudan54399762012-04-13 09:08:41 -040039 * Events that have been received can be parsed with their respective
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020040 * 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,
Olivier Naudan54399762012-04-13 09:08:41 -040044 * others only upstream. Some events can travel both upstream and downstream.
45 *
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020046 * 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 *
Olivier Naudan54399762012-04-13 09:08:41 -040050 * Most of the event API is used inside plugins. Applications usually only
51 * construct and use seek events.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020052 * 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.
Sebastian Dröge68fc3102016-02-19 10:52:06 +020054 * |[<!-- language="C" -->
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020055 * GstEvent *event;
56 * gboolean result;
57 * ...
58 * // construct a seek event to play the media from second 2 to 5, flush
59 * // the pipeline to decrease latency.
60 * event = gst_event_new_seek (1.0,
61 * GST_FORMAT_TIME,
62 * GST_SEEK_FLAG_FLUSH,
63 * GST_SEEK_TYPE_SET, 2 * GST_SECOND,
64 * GST_SEEK_TYPE_SET, 5 * GST_SECOND);
65 * ...
66 * result = gst_element_send_event (pipeline, event);
67 * if (!result)
68 * g_warning ("seek failed");
69 * ...
Sebastian Dröge71fa7952014-05-03 17:39:29 +020070 * ]|
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020071 */
72
73
74#include "gst_private.h"
75#include <string.h> /* memcpy */
76
77#include "gstinfo.h"
78#include "gstevent.h"
79#include "gstenumtypes.h"
80#include "gstutils.h"
81#include "gstquark.h"
Olivier Naudan54399762012-04-13 09:08:41 -040082#include "gstvalue.h"
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020083
84GType _gst_event_type = 0;
85
86typedef struct
87{
88 GstEvent event;
89
90 GstStructure *structure;
Sebastian Dröge71fa7952014-05-03 17:39:29 +020091 gint64 running_time_offset;
Nicolas Dechesnebeb43202011-09-30 00:54:14 +020092} GstEventImpl;
93
94#define GST_EVENT_STRUCTURE(e) (((GstEventImpl *)(e))->structure)
95
96typedef struct
97{
98 const gint type;
99 const gchar *name;
100 GQuark quark;
101} GstEventQuarks;
102
103static GstEventQuarks event_quarks[] = {
104 {GST_EVENT_UNKNOWN, "unknown", 0},
105 {GST_EVENT_FLUSH_START, "flush-start", 0},
106 {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
Olivier Naudan54399762012-04-13 09:08:41 -0400107 {GST_EVENT_STREAM_START, "stream-start", 0},
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200108 {GST_EVENT_CAPS, "caps", 0},
109 {GST_EVENT_SEGMENT, "segment", 0},
110 {GST_EVENT_TAG, "tag", 0},
Olivier Naudan54399762012-04-13 09:08:41 -0400111 {GST_EVENT_TOC, "toc", 0},
Sebastian Drögef6697b22015-05-13 13:17:48 +0300112 {GST_EVENT_PROTECTION, "protection", 0},
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200113 {GST_EVENT_BUFFERSIZE, "buffersize", 0},
114 {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
Olivier Naudan54399762012-04-13 09:08:41 -0400115 {GST_EVENT_EOS, "eos", 0},
116 {GST_EVENT_SEGMENT_DONE, "segment-done", 0},
117 {GST_EVENT_GAP, "gap", 0},
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200118 {GST_EVENT_QOS, "qos", 0},
119 {GST_EVENT_SEEK, "seek", 0},
120 {GST_EVENT_NAVIGATION, "navigation", 0},
121 {GST_EVENT_LATENCY, "latency", 0},
122 {GST_EVENT_STEP, "step", 0},
123 {GST_EVENT_RECONFIGURE, "reconfigure", 0},
Olivier Naudan54399762012-04-13 09:08:41 -0400124 {GST_EVENT_TOC_SELECT, "toc-select", 0},
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200125 {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
126 {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
127 {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
Olivier Naudan54399762012-04-13 09:08:41 -0400128 {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200129 {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
130 {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},
131
132 {0, NULL, 0}
133};
134
135GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
136
137void
138_priv_gst_event_initialize (void)
139{
140 gint i;
141
142 _gst_event_type = gst_event_get_type ();
143
144 g_type_class_ref (gst_seek_flags_get_type ());
145 g_type_class_ref (gst_seek_type_get_type ());
146
147 for (i = 0; event_quarks[i].name; i++) {
148 event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name);
149 }
150}
151
152/**
153 * gst_event_type_get_name:
154 * @type: the event type
155 *
156 * Get a printable name for the given event type. Do not modify or free.
157 *
158 * Returns: a reference to the static name of the event.
159 */
160const gchar *
161gst_event_type_get_name (GstEventType type)
162{
163 gint i;
164
165 for (i = 0; event_quarks[i].name; i++) {
166 if (type == event_quarks[i].type)
167 return event_quarks[i].name;
168 }
169 return "unknown";
170}
171
172/**
173 * gst_event_type_to_quark:
174 * @type: the event type
175 *
176 * Get the unique quark for the given event type.
177 *
178 * Returns: the quark associated with the event type
179 */
180GQuark
181gst_event_type_to_quark (GstEventType type)
182{
183 gint i;
184
185 for (i = 0; event_quarks[i].name; i++) {
186 if (type == event_quarks[i].type)
187 return event_quarks[i].quark;
188 }
189 return 0;
190}
191
192/**
193 * gst_event_type_get_flags:
194 * @type: a #GstEventType
195 *
196 * Gets the #GstEventTypeFlags associated with @type.
197 *
198 * Returns: a #GstEventTypeFlags.
199 */
200GstEventTypeFlags
201gst_event_type_get_flags (GstEventType type)
202{
203 GstEventTypeFlags ret;
204
Olivier Naudan54399762012-04-13 09:08:41 -0400205 ret = type & ((1 << GST_EVENT_NUM_SHIFT) - 1);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200206
207 return ret;
208}
209
210static void
211_gst_event_free (GstEvent * event)
212{
213 GstStructure *s;
214
215 g_return_if_fail (event != NULL);
216 g_return_if_fail (GST_IS_EVENT (event));
217
218 GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
219 GST_EVENT_TYPE_NAME (event));
220
221 s = GST_EVENT_STRUCTURE (event);
222
223 if (s) {
224 gst_structure_set_parent_refcount (s, NULL);
225 gst_structure_free (s);
226 }
227
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200228 g_slice_free1 (sizeof (GstEventImpl), event);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200229}
230
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200231static void gst_event_init (GstEventImpl * event, GstEventType type);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200232
233static GstEvent *
234_gst_event_copy (GstEvent * event)
235{
236 GstEventImpl *copy;
237 GstStructure *s;
238
239 copy = g_slice_new0 (GstEventImpl);
240
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200241 gst_event_init (copy, GST_EVENT_TYPE (event));
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200242
243 GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
244 GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
245
246 s = GST_EVENT_STRUCTURE (event);
247 if (s) {
248 GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
249 gst_structure_set_parent_refcount (GST_EVENT_STRUCTURE (copy),
250 &copy->event.mini_object.refcount);
Olivier Naudan54399762012-04-13 09:08:41 -0400251 } else {
252 GST_EVENT_STRUCTURE (copy) = NULL;
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200253 }
Sebastian Dröge71fa7952014-05-03 17:39:29 +0200254
255 ((GstEventImpl *) copy)->running_time_offset =
256 ((GstEventImpl *) event)->running_time_offset;
257
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200258 return GST_EVENT_CAST (copy);
259}
260
261static void
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200262gst_event_init (GstEventImpl * event, GstEventType type)
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200263{
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200264 gst_mini_object_init (GST_MINI_OBJECT_CAST (event), 0, _gst_event_type,
265 (GstMiniObjectCopyFunction) _gst_event_copy, NULL,
266 (GstMiniObjectFreeFunction) _gst_event_free);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200267
268 GST_EVENT_TYPE (event) = type;
269 GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
270 GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
Sebastian Dröge71fa7952014-05-03 17:39:29 +0200271 event->running_time_offset = 0;
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200272}
273
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200274
275/**
276 * gst_event_new_custom:
277 * @type: The type of the new event
278 * @structure: (transfer full): the structure for the event. The event will
279 * take ownership of the structure.
280 *
281 * Create a new custom-typed event. This can be used for anything not
282 * handled by other event-specific functions to pass an event to another
283 * element.
284 *
285 * Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
286 * assigning a free number and filling in the correct direction and
287 * serialization flags.
288 *
289 * New custom events can also be created by subclassing the event type if
290 * needed.
291 *
292 * Returns: (transfer full): the new custom event.
293 */
294GstEvent *
295gst_event_new_custom (GstEventType type, GstStructure * structure)
296{
Olivier Naudan54399762012-04-13 09:08:41 -0400297 GstEventImpl *event;
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200298
Olivier Naudan54399762012-04-13 09:08:41 -0400299 event = g_slice_new0 (GstEventImpl);
300
301 GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
302 gst_event_type_get_name (type), type);
303
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200304 if (structure) {
Olivier Naudan54399762012-04-13 09:08:41 -0400305 /* structure must not have a parent */
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200306 if (!gst_structure_set_parent_refcount (structure,
Olivier Naudan54399762012-04-13 09:08:41 -0400307 &event->event.mini_object.refcount))
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200308 goto had_parent;
309
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200310 }
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200311 gst_event_init (event, type);
Olivier Naudan54399762012-04-13 09:08:41 -0400312
313 GST_EVENT_STRUCTURE (event) = structure;
314
315 return GST_EVENT_CAST (event);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200316
317 /* ERRORS */
318had_parent:
319 {
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200320 g_slice_free1 (sizeof (GstEventImpl), event);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200321 g_warning ("structure is already owned by another object");
322 return NULL;
323 }
324}
325
326/**
327 * gst_event_get_structure:
328 * @event: The #GstEvent.
329 *
330 * Access the structure of the event.
331 *
332 * Returns: The structure of the event. The structure is still
333 * owned by the event, which means that you should not free it and
334 * that the pointer becomes invalid when you free the event.
335 *
336 * MT safe.
337 */
338const GstStructure *
339gst_event_get_structure (GstEvent * event)
340{
341 g_return_val_if_fail (GST_IS_EVENT (event), NULL);
342
343 return GST_EVENT_STRUCTURE (event);
344}
345
346/**
347 * gst_event_writable_structure:
348 * @event: The #GstEvent.
349 *
350 * Get a writable version of the structure.
351 *
Sebastian Dröge5856dec2014-06-22 17:18:02 +0200352 * Returns: (transfer none): The structure of the event. The structure
353 * is still owned by the event, which means that you should not free
354 * it and that the pointer becomes invalid when you free the event.
355 * This function checks if @event is writable and will never return
356 * %NULL.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200357 *
358 * MT safe.
359 */
360GstStructure *
361gst_event_writable_structure (GstEvent * event)
362{
363 GstStructure *structure;
364
365 g_return_val_if_fail (GST_IS_EVENT (event), NULL);
366 g_return_val_if_fail (gst_event_is_writable (event), NULL);
367
368 structure = GST_EVENT_STRUCTURE (event);
369
370 if (structure == NULL) {
371 structure =
Olivier Naudan54399762012-04-13 09:08:41 -0400372 gst_structure_new_id_empty (gst_event_type_to_quark (GST_EVENT_TYPE
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200373 (event)));
374 gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
375 GST_EVENT_STRUCTURE (event) = structure;
376 }
377 return structure;
378}
379
380/**
381 * gst_event_has_name:
382 * @event: The #GstEvent.
383 * @name: name to check
384 *
385 * Checks if @event has the given @name. This function is usually used to
386 * check the name of a custom event.
387 *
388 * Returns: %TRUE if @name matches the name of the event structure.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200389 */
390gboolean
391gst_event_has_name (GstEvent * event, const gchar * name)
392{
393 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
394
395 if (GST_EVENT_STRUCTURE (event) == NULL)
396 return FALSE;
397
398 return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
399}
400
401/**
402 * gst_event_get_seqnum:
403 * @event: A #GstEvent.
404 *
405 * Retrieve the sequence number of a event.
406 *
407 * Events have ever-incrementing sequence numbers, which may also be set
408 * explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
409 * indicate that a event corresponds to some other set of events or messages,
410 * for example an EOS event corresponding to a SEEK event. It is considered good
411 * practice to make this correspondence when possible, though it is not
412 * required.
413 *
414 * Note that events and messages share the same sequence number incrementor;
415 * two events or messages will never have the same sequence number unless
416 * that correspondence was made explicitly.
417 *
418 * Returns: The event's sequence number.
419 *
420 * MT safe.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200421 */
422guint32
423gst_event_get_seqnum (GstEvent * event)
424{
425 g_return_val_if_fail (GST_IS_EVENT (event), -1);
426
427 return GST_EVENT_SEQNUM (event);
428}
429
430/**
431 * gst_event_set_seqnum:
432 * @event: A #GstEvent.
433 * @seqnum: A sequence number.
434 *
435 * Set the sequence number of a event.
436 *
437 * This function might be called by the creator of a event to indicate that the
438 * event relates to other events or messages. See gst_event_get_seqnum() for
439 * more information.
440 *
441 * MT safe.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200442 */
443void
444gst_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
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200451/**
Sebastian Dröge71fa7952014-05-03 17:39:29 +0200452 * gst_event_get_running_time_offset:
453 * @event: A #GstEvent.
454 *
455 * Retrieve the accumulated running time offset of the event.
456 *
457 * Events passing through #GstPads that have a running time
458 * offset set via gst_pad_set_offset() will get their offset
459 * adjusted according to the pad's offset.
460 *
461 * If the event contains any information that related to the
462 * running time, this information will need to be updated
463 * before usage with this offset.
464 *
465 * Returns: The event's running time offset
466 *
467 * MT safe.
468 *
469 * Since: 1.4
470 */
471gint64
472gst_event_get_running_time_offset (GstEvent * event)
473{
474 g_return_val_if_fail (GST_IS_EVENT (event), 0);
475
476 return ((GstEventImpl *) event)->running_time_offset;
477}
478
479/**
480 * gst_event_set_running_time_offset:
481 * @event: A #GstEvent.
482 * @offset: A the new running time offset
483 *
484 * Set the running time offset of a event. See
485 * gst_event_get_running_time_offset() for more information.
486 *
487 * MT safe.
488 *
489 * Since: 1.4
490 */
491void
492gst_event_set_running_time_offset (GstEvent * event, gint64 offset)
493{
494 g_return_if_fail (GST_IS_EVENT (event));
495
496 ((GstEventImpl *) event)->running_time_offset = offset;
497}
498
499/**
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200500 * gst_event_new_flush_start:
501 *
502 * Allocate a new flush start event. The flush start event can be sent
503 * upstream and downstream and travels out-of-bounds with the dataflow.
504 *
505 * It marks pads as being flushing and will make them return
Olivier Naudan54399762012-04-13 09:08:41 -0400506 * #GST_FLOW_FLUSHING when used for data flow with gst_pad_push(),
507 * gst_pad_chain(), gst_pad_get_range() and gst_pad_pull_range().
508 * Any event (except a #GST_EVENT_FLUSH_STOP) received
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200509 * on a flushing pad will return %FALSE immediately.
510 *
511 * Elements should unlock any blocking functions and exit their streaming
512 * functions as fast as possible when this event is received.
513 *
514 * This event is typically generated after a seek to flush out all queued data
515 * in the pipeline so that the new media is played as soon as possible.
516 *
517 * Returns: (transfer full): a new flush start event.
518 */
519GstEvent *
520gst_event_new_flush_start (void)
521{
Olivier Naudan54399762012-04-13 09:08:41 -0400522 return gst_event_new_custom (GST_EVENT_FLUSH_START, NULL);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200523}
524
525/**
526 * gst_event_new_flush_stop:
527 * @reset_time: if time should be reset
528 *
529 * Allocate a new flush stop event. The flush stop event can be sent
530 * upstream and downstream and travels serialized with the dataflow.
531 * It is typically sent after sending a FLUSH_START event to make the
532 * pads accept data again.
533 *
534 * Elements can process this event synchronized with the dataflow since
Sebastian Dröge71fa7952014-05-03 17:39:29 +0200535 * the preceding FLUSH_START event stopped the dataflow.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200536 *
537 * This event is typically generated to complete a seek and to resume
538 * dataflow.
539 *
540 * Returns: (transfer full): a new flush stop event.
541 */
542GstEvent *
543gst_event_new_flush_stop (gboolean reset_time)
544{
545 GstEvent *event;
546
547 GST_CAT_INFO (GST_CAT_EVENT, "creating flush stop %d", reset_time);
548
549 event = gst_event_new_custom (GST_EVENT_FLUSH_STOP,
Olivier Naudan54399762012-04-13 09:08:41 -0400550 gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200551 GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL));
552
553 return event;
554}
555
556/**
557 * gst_event_parse_flush_stop:
558 * @event: The event to parse
559 * @reset_time: (out): if time should be reset
560 *
561 * Parse the FLUSH_STOP event and retrieve the @reset_time member.
562 */
563void
564gst_event_parse_flush_stop (GstEvent * event, gboolean * reset_time)
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_FLUSH_STOP);
570
571 structure = GST_EVENT_STRUCTURE (event);
572 if (G_LIKELY (reset_time))
573 *reset_time =
574 g_value_get_boolean (gst_structure_id_get_value (structure,
575 GST_QUARK (RESET_TIME)));
576}
577
578/**
579 * gst_event_new_eos:
580 *
581 * Create a new EOS event. The eos event can only travel downstream
582 * synchronized with the buffer flow. Elements that receive the EOS
Olivier Naudan54399762012-04-13 09:08:41 -0400583 * event on a pad can return #GST_FLOW_EOS as a #GstFlowReturn
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200584 * when data after the EOS event arrives.
585 *
586 * The EOS event will travel down to the sink elements in the pipeline
587 * which will then post the #GST_MESSAGE_EOS on the bus after they have
588 * finished playing any buffered data.
589 *
590 * When all sinks have posted an EOS message, an EOS message is
591 * forwarded to the application.
592 *
593 * The EOS event itself will not cause any state transitions of the pipeline.
594 *
595 * Returns: (transfer full): the new EOS event.
596 */
597GstEvent *
598gst_event_new_eos (void)
599{
Olivier Naudan54399762012-04-13 09:08:41 -0400600 return gst_event_new_custom (GST_EVENT_EOS, NULL);
601}
602
603/**
604 * gst_event_new_gap:
605 * @timestamp: the start time (pts) of the gap
606 * @duration: the duration of the gap
607 *
608 * Create a new GAP event. A gap event can be thought of as conceptually
609 * equivalent to a buffer to signal that there is no data for a certain
610 * amount of time. This is useful to signal a gap to downstream elements
611 * which may wait for data, such as muxers or mixers or overlays, especially
612 * for sparse streams such as subtitle streams.
613 *
614 * Returns: (transfer full): the new GAP event.
615 */
616GstEvent *
617gst_event_new_gap (GstClockTime timestamp, GstClockTime duration)
618{
619 GstEvent *event;
620
621 g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
Olivier Naudan54399762012-04-13 09:08:41 -0400622
623 GST_CAT_TRACE (GST_CAT_EVENT, "creating gap %" GST_TIME_FORMAT " - "
624 "%" GST_TIME_FORMAT " (duration: %" GST_TIME_FORMAT ")",
625 GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
626 GST_TIME_ARGS (duration));
627
628 event = gst_event_new_custom (GST_EVENT_GAP,
629 gst_structure_new_id (GST_QUARK (EVENT_GAP),
630 GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
631 GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL));
632
633 return event;
634}
635
636/**
637 * gst_event_parse_gap:
638 * @event: a #GstEvent of type #GST_EVENT_GAP
639 * @timestamp: (out) (allow-none): location where to store the
640 * start time (pts) of the gap, or %NULL
641 * @duration: (out) (allow-none): location where to store the duration of
642 * the gap, or %NULL
643 *
644 * Extract timestamp and duration from a new GAP event.
645 */
646void
647gst_event_parse_gap (GstEvent * event, GstClockTime * timestamp,
648 GstClockTime * duration)
649{
650 GstStructure *structure;
651
652 g_return_if_fail (GST_IS_EVENT (event));
653 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_GAP);
654
655 structure = GST_EVENT_STRUCTURE (event);
656 gst_structure_id_get (structure,
657 GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
658 GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200659}
660
661/**
662 * gst_event_new_caps:
Olivier Naudan54399762012-04-13 09:08:41 -0400663 * @caps: (transfer none): a #GstCaps
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200664 *
665 * Create a new CAPS event for @caps. The caps event can only travel downstream
666 * synchronized with the buffer flow and contains the format of the buffers
667 * that will follow after the event.
668 *
669 * Returns: (transfer full): the new CAPS event.
670 */
671GstEvent *
672gst_event_new_caps (GstCaps * caps)
673{
674 GstEvent *event;
675
676 g_return_val_if_fail (caps != NULL, NULL);
677 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
678
679 GST_CAT_INFO (GST_CAT_EVENT, "creating caps event %" GST_PTR_FORMAT, caps);
680
681 event = gst_event_new_custom (GST_EVENT_CAPS,
Olivier Naudan54399762012-04-13 09:08:41 -0400682 gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200683 GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));
684
685 return event;
686}
687
688/**
689 * gst_event_parse_caps:
690 * @event: The event to parse
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200691 * @caps: (out) (transfer none): A pointer to the caps
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200692 *
693 * Get the caps from @event. The caps remains valid as long as @event remains
694 * valid.
695 */
696void
697gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
698{
699 GstStructure *structure;
700
701 g_return_if_fail (GST_IS_EVENT (event));
702 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_CAPS);
703
704 structure = GST_EVENT_STRUCTURE (event);
705 if (G_LIKELY (caps))
706 *caps =
707 g_value_get_boxed (gst_structure_id_get_value (structure,
708 GST_QUARK (CAPS)));
709}
710
711/**
712 * gst_event_new_segment:
Olivier Naudan54399762012-04-13 09:08:41 -0400713 * @segment: (transfer none): a #GstSegment
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200714 *
715 * Create a new SEGMENT event for @segment. The segment event can only travel
716 * downstream synchronized with the buffer flow and contains timing information
717 * and playback properties for the buffers that will follow.
718 *
Sebastian Dröge570fd492015-03-16 19:05:29 +0100719 * The segment event marks the range of buffers to be processed. All
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200720 * data not within the segment range is not to be processed. This can be
721 * used intelligently by plugins to apply more efficient methods of skipping
722 * unneeded data. The valid range is expressed with the @start and @stop
723 * values.
724 *
725 * The time value of the segment is used in conjunction with the start
726 * value to convert the buffer timestamps into the stream time. This is
727 * usually done in sinks to report the current stream_time.
728 * @time represents the stream_time of a buffer carrying a timestamp of
729 * @start. @time cannot be -1.
730 *
731 * @start cannot be -1, @stop can be -1. If there
732 * is a valid @stop given, it must be greater or equal the @start, including
733 * when the indicated playback @rate is < 0.
734 *
735 * The @applied_rate value provides information about any rate adjustment that
736 * has already been made to the timestamps and content on the buffers of the
737 * stream. (@rate * @applied_rate) should always equal the rate that has been
738 * requested for playback. For example, if an element has an input segment
739 * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust
Sebastian Dröge570fd492015-03-16 19:05:29 +0100740 * incoming timestamps and buffer content by half and output a segment event
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200741 * with @rate of 1.0 and @applied_rate of 2.0
742 *
Sebastian Dröge570fd492015-03-16 19:05:29 +0100743 * After a segment event, the buffer stream time is calculated with:
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200744 *
745 * time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
746 *
747 * Returns: (transfer full): the new SEGMENT event.
748 */
749GstEvent *
Olivier Naudan54399762012-04-13 09:08:41 -0400750gst_event_new_segment (const GstSegment * segment)
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200751{
752 GstEvent *event;
753
754 g_return_val_if_fail (segment != NULL, NULL);
Olivier Naudan54399762012-04-13 09:08:41 -0400755 g_return_val_if_fail (segment->rate != 0.0, NULL);
756 g_return_val_if_fail (segment->applied_rate != 0.0, NULL);
757 g_return_val_if_fail (segment->format != GST_FORMAT_UNDEFINED, NULL);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200758
759 GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
760 segment);
761
762 event = gst_event_new_custom (GST_EVENT_SEGMENT,
Olivier Naudan54399762012-04-13 09:08:41 -0400763 gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200764 GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
765
766 return event;
767}
768
769/**
770 * gst_event_parse_segment:
771 * @event: The event to parse
772 * @segment: (out) (transfer none): a pointer to a #GstSegment
773 *
774 * Parses a segment @event and stores the result in the given @segment location.
775 * @segment remains valid only until the @event is freed. Don't modify the segment
776 * and make a copy if you want to modify it or store it for later use.
777 */
778void
779gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
780{
781 GstStructure *structure;
782
783 g_return_if_fail (GST_IS_EVENT (event));
784 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
785
786 if (segment) {
787 structure = GST_EVENT_STRUCTURE (event);
788 *segment = g_value_get_boxed (gst_structure_id_get_value (structure,
789 GST_QUARK (SEGMENT)));
790 }
791}
792
793/**
794 * gst_event_copy_segment:
795 * @event: The event to parse
796 * @segment: a pointer to a #GstSegment
797 *
798 * Parses a segment @event and copies the #GstSegment into the location
799 * given by @segment.
800 */
801void
802gst_event_copy_segment (GstEvent * event, GstSegment * segment)
803{
804 const GstSegment *src;
805
806 g_return_if_fail (GST_IS_EVENT (event));
807 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
808
809 if (segment) {
810 gst_event_parse_segment (event, &src);
811 gst_segment_copy_into (src, segment);
812 }
813}
814
815/**
816 * gst_event_new_tag:
817 * @taglist: (transfer full): metadata list. The event will take ownership
818 * of the taglist.
819 *
820 * Generates a metadata tag event from the given @taglist.
821 *
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200822 * The scope of the taglist specifies if the taglist applies to the
823 * complete medium or only to this specific stream. As the tag event
824 * is a sticky event, elements should merge tags received from
825 * upstream with a given scope with their own tags with the same
826 * scope and create a new tag event from it.
Sebastian Drögebed72df2012-06-08 09:16:25 +0200827 *
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200828 * Returns: (transfer full): a new #GstEvent
829 */
830GstEvent *
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200831gst_event_new_tag (GstTagList * taglist)
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200832{
Sebastian Drögebed72df2012-06-08 09:16:25 +0200833 GstStructure *s;
834 GValue val = G_VALUE_INIT;
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200835 const gchar *names[] = { "GstTagList-stream", "GstTagList-global" };
Sebastian Drögebed72df2012-06-08 09:16:25 +0200836
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200837 g_return_val_if_fail (taglist != NULL, NULL);
838
Sebastian Dröged1f921c2012-08-08 18:10:27 +0200839 s = gst_structure_new_empty (names[gst_tag_list_get_scope (taglist)]);
Sebastian Drögebed72df2012-06-08 09:16:25 +0200840 g_value_init (&val, GST_TYPE_TAG_LIST);
841 g_value_take_boxed (&val, taglist);
842 gst_structure_id_take_value (s, GST_QUARK (TAGLIST), &val);
843 return gst_event_new_custom (GST_EVENT_TAG, s);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200844}
845
846/**
847 * gst_event_parse_tag:
848 * @event: a tag event
849 * @taglist: (out) (transfer none): pointer to metadata list
850 *
851 * Parses a tag @event and stores the results in the given @taglist location.
852 * No reference to the taglist will be returned, it remains valid only until
853 * the @event is freed. Don't modify or free the taglist, make a copy if you
854 * want to modify it or store it for later use.
855 */
856void
857gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
858{
Sebastian Drögebed72df2012-06-08 09:16:25 +0200859 const GValue *val;
860
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200861 g_return_if_fail (GST_IS_EVENT (event));
862 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
863
Sebastian Drögebed72df2012-06-08 09:16:25 +0200864 val = gst_structure_id_get_value (GST_EVENT_STRUCTURE (event),
865 GST_QUARK (TAGLIST));
866
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200867 if (taglist)
Sebastian Drögebed72df2012-06-08 09:16:25 +0200868 *taglist = (GstTagList *) g_value_get_boxed (val);
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200869}
870
871/* buffersize event */
872/**
873 * gst_event_new_buffer_size:
874 * @format: buffer format
875 * @minsize: minimum buffer size
876 * @maxsize: maximum buffer size
877 * @async: thread behavior
878 *
879 * Create a new buffersize event. The event is sent downstream and notifies
880 * elements that they should provide a buffer of the specified dimensions.
881 *
882 * When the @async flag is set, a thread boundary is preferred.
883 *
884 * Returns: (transfer full): a new #GstEvent
885 */
886GstEvent *
887gst_event_new_buffer_size (GstFormat format, gint64 minsize,
888 gint64 maxsize, gboolean async)
889{
890 GstEvent *event;
891 GstStructure *structure;
892
893 GST_CAT_INFO (GST_CAT_EVENT,
894 "creating buffersize format %s, minsize %" G_GINT64_FORMAT
895 ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
896 minsize, maxsize, async);
897
Olivier Naudan54399762012-04-13 09:08:41 -0400898 structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200899 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
900 GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
901 GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
902 GST_QUARK (ASYNC), G_TYPE_BOOLEAN, async, NULL);
903 event = gst_event_new_custom (GST_EVENT_BUFFERSIZE, structure);
904
905 return event;
906}
907
908/**
909 * gst_event_parse_buffer_size:
910 * @event: The event to query
911 * @format: (out): A pointer to store the format in
912 * @minsize: (out): A pointer to store the minsize in
913 * @maxsize: (out): A pointer to store the maxsize in
914 * @async: (out): A pointer to store the async-flag in
915 *
916 * Get the format, minsize, maxsize and async-flag in the buffersize event.
917 */
918void
919gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
920 gint64 * minsize, gint64 * maxsize, gboolean * async)
921{
922 const GstStructure *structure;
923
924 g_return_if_fail (GST_IS_EVENT (event));
925 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_BUFFERSIZE);
926
927 structure = GST_EVENT_STRUCTURE (event);
928 if (format)
929 *format = (GstFormat)
930 g_value_get_enum (gst_structure_id_get_value (structure,
931 GST_QUARK (FORMAT)));
932 if (minsize)
933 *minsize =
934 g_value_get_int64 (gst_structure_id_get_value (structure,
935 GST_QUARK (MINSIZE)));
936 if (maxsize)
937 *maxsize =
938 g_value_get_int64 (gst_structure_id_get_value (structure,
939 GST_QUARK (MAXSIZE)));
940 if (async)
941 *async =
942 g_value_get_boolean (gst_structure_id_get_value (structure,
943 GST_QUARK (ASYNC)));
944}
945
946/**
947 * gst_event_new_qos:
948 * @type: the QoS type
949 * @proportion: the proportion of the qos message
950 * @diff: The time difference of the last Clock sync
951 * @timestamp: The timestamp of the buffer
952 *
953 * Allocate a new qos event with the given values.
954 * The QOS event is generated in an element that wants an upstream
955 * element to either reduce or increase its rate because of
956 * high/low CPU load or other resource usage such as network performance or
957 * throttling. Typically sinks generate these events for each buffer
958 * they receive.
959 *
960 * @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
961 * used when a buffer arrived in time or when the sink cannot keep up with
962 * the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
963 * receiving buffers fast enough and thus has to drop late buffers.
964 * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
965 * by the application, for example to reduce power consumption.
966 *
967 * @proportion indicates the real-time performance of the streaming in the
968 * element that generated the QoS event (usually the sink). The value is
969 * generally computed based on more long term statistics about the streams
970 * timestamps compared to the clock.
971 * A value < 1.0 indicates that the upstream element is producing data faster
972 * than real-time. A value > 1.0 indicates that the upstream element is not
973 * producing data fast enough. 1.0 is the ideal @proportion value. The
974 * proportion value can safely be used to lower or increase the quality of
975 * the element.
976 *
977 * @diff is the difference against the clock in running time of the last
978 * buffer that caused the element to generate the QOS event. A negative value
979 * means that the buffer with @timestamp arrived in time. A positive value
980 * indicates how late the buffer with @timestamp was. When throttling is
981 * enabled, @diff will be set to the requested throttling interval.
982 *
983 * @timestamp is the timestamp of the last buffer that cause the element
984 * to generate the QOS event. It is expressed in running time and thus an ever
985 * increasing value.
986 *
987 * The upstream element can use the @diff and @timestamp values to decide
Sebastian Dröge71fa7952014-05-03 17:39:29 +0200988 * whether to process more buffers. For positive @diff, all buffers with
Nicolas Dechesnebeb43202011-09-30 00:54:14 +0200989 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
990 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
991 * result smaller than 0 is not allowed.
992 *
993 * The application can use general event probes to intercept the QoS
994 * event and implement custom application specific QoS handling.
995 *
996 * Returns: (transfer full): a new QOS event.
997 */
998GstEvent *
999gst_event_new_qos (GstQOSType type, gdouble proportion,
1000 GstClockTimeDiff diff, GstClockTime timestamp)
1001{
1002 GstEvent *event;
1003 GstStructure *structure;
1004
1005 /* diff must be positive or timestamp + diff must be positive */
1006 g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);
1007
Olivier Naudan54399762012-04-13 09:08:41 -04001008 GST_CAT_LOG (GST_CAT_EVENT,
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001009 "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
1010 ", timestamp %" GST_TIME_FORMAT, type, proportion,
1011 diff, GST_TIME_ARGS (timestamp));
1012
Olivier Naudan54399762012-04-13 09:08:41 -04001013 structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001014 GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
1015 GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
1016 GST_QUARK (DIFF), G_TYPE_INT64, diff,
1017 GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
1018 event = gst_event_new_custom (GST_EVENT_QOS, structure);
1019
1020 return event;
1021}
1022
1023/**
1024 * gst_event_parse_qos:
1025 * @event: The event to query
1026 * @type: (out): A pointer to store the QoS type in
1027 * @proportion: (out): A pointer to store the proportion in
1028 * @diff: (out): A pointer to store the diff in
1029 * @timestamp: (out): A pointer to store the timestamp in
1030 *
1031 * Get the type, proportion, diff and timestamp in the qos event. See
1032 * gst_event_new_qos() for more information about the different QoS values.
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001033 *
1034 * @timestamp will be adjusted for any pad offsets of pads it was passing through.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001035 */
1036void
1037gst_event_parse_qos (GstEvent * event, GstQOSType * type,
1038 gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
1039{
1040 const GstStructure *structure;
1041
1042 g_return_if_fail (GST_IS_EVENT (event));
1043 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
1044
1045 structure = GST_EVENT_STRUCTURE (event);
1046 if (type)
1047 *type = (GstQOSType)
1048 g_value_get_enum (gst_structure_id_get_value (structure,
1049 GST_QUARK (TYPE)));
1050 if (proportion)
1051 *proportion =
1052 g_value_get_double (gst_structure_id_get_value (structure,
1053 GST_QUARK (PROPORTION)));
1054 if (diff)
1055 *diff =
1056 g_value_get_int64 (gst_structure_id_get_value (structure,
1057 GST_QUARK (DIFF)));
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001058 if (timestamp) {
1059 gint64 offset = gst_event_get_running_time_offset (event);
Sebastian Dröged4ab9492015-12-24 12:50:24 +01001060 GstClockTimeDiff diff_ =
1061 g_value_get_int64 (gst_structure_id_get_value (structure,
1062 GST_QUARK (DIFF)));
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001063
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001064 *timestamp =
1065 g_value_get_uint64 (gst_structure_id_get_value (structure,
1066 GST_QUARK (TIMESTAMP)));
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001067 /* Catch underflows */
1068 if (*timestamp > -offset)
1069 *timestamp += offset;
1070 else
1071 *timestamp = 0;
Sebastian Dröged4ab9492015-12-24 12:50:24 +01001072
1073 /* Make sure that timestamp + diff is always >= 0. Because
1074 * of the running time offset this might not be true */
1075 if (diff_ < 0 && *timestamp < -diff_)
1076 *timestamp = (GstClockTime) - diff_;
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001077 }
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001078}
1079
1080/**
1081 * gst_event_new_seek:
1082 * @rate: The new playback rate
1083 * @format: The format of the seek values
1084 * @flags: The optional seek flags
1085 * @start_type: The type and flags for the new start position
1086 * @start: The value of the new start position
1087 * @stop_type: The type and flags for the new stop position
1088 * @stop: The value of the new stop position
1089 *
1090 * Allocate a new seek event with the given parameters.
1091 *
1092 * The seek event configures playback of the pipeline between @start to @stop
1093 * at the speed given in @rate, also called a playback segment.
1094 * The @start and @stop values are expressed in @format.
1095 *
1096 * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
1097 * Negatives values means backwards playback. A value of 0.0 for the
1098 * rate is not allowed and should be accomplished instead by PAUSING the
1099 * pipeline.
1100 *
1101 * A pipeline has a default playback segment configured with a start
1102 * position of 0, a stop position of -1 and a rate of 1.0. The currently
1103 * configured playback segment can be queried with #GST_QUERY_SEGMENT.
1104 *
1105 * @start_type and @stop_type specify how to adjust the currently configured
1106 * start and stop fields in playback segment. Adjustments can be made relative
1107 * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
1108 * means that the position should not be updated.
1109 *
1110 * When the rate is positive and @start has been updated, playback will start
1111 * from the newly configured start position.
1112 *
1113 * For negative rates, playback will start from the newly configured stop
Sebastian Drögebed72df2012-06-08 09:16:25 +02001114 * position (if any). If the stop position is updated, it must be different from
1115 * -1 (#GST_CLOCK_TIME_NONE) for negative rates.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001116 *
1117 * It is not possible to seek relative to the current playback position, to do
1118 * this, PAUSE the pipeline, query the current playback position with
1119 * #GST_QUERY_POSITION and update the playback segment current position with a
Sebastian Drögebed72df2012-06-08 09:16:25 +02001120 * #GST_SEEK_TYPE_SET to the desired position.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001121 *
1122 * Returns: (transfer full): a new seek event.
1123 */
1124GstEvent *
1125gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
1126 GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
1127{
1128 GstEvent *event;
1129 GstStructure *structure;
1130
1131 g_return_val_if_fail (rate != 0.0, NULL);
1132
1133 if (format == GST_FORMAT_TIME) {
1134 GST_CAT_INFO (GST_CAT_EVENT,
1135 "creating seek rate %lf, format TIME, flags %d, "
1136 "start_type %d, start %" GST_TIME_FORMAT ", "
1137 "stop_type %d, stop %" GST_TIME_FORMAT,
1138 rate, flags, start_type, GST_TIME_ARGS (start),
1139 stop_type, GST_TIME_ARGS (stop));
1140 } else {
1141 GST_CAT_INFO (GST_CAT_EVENT,
1142 "creating seek rate %lf, format %s, flags %d, "
1143 "start_type %d, start %" G_GINT64_FORMAT ", "
1144 "stop_type %d, stop %" G_GINT64_FORMAT,
1145 rate, gst_format_get_name (format), flags, start_type, start, stop_type,
1146 stop);
1147 }
1148
Olivier Naudan54399762012-04-13 09:08:41 -04001149 structure = gst_structure_new_id (GST_QUARK (EVENT_SEEK),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001150 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1151 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1152 GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
1153 GST_QUARK (CUR_TYPE), GST_TYPE_SEEK_TYPE, start_type,
1154 GST_QUARK (CUR), G_TYPE_INT64, start,
1155 GST_QUARK (STOP_TYPE), GST_TYPE_SEEK_TYPE, stop_type,
1156 GST_QUARK (STOP), G_TYPE_INT64, stop, NULL);
1157 event = gst_event_new_custom (GST_EVENT_SEEK, structure);
1158
1159 return event;
1160}
1161
1162/**
1163 * gst_event_parse_seek:
1164 * @event: a seek event
1165 * @rate: (out): result location for the rate
1166 * @format: (out): result location for the stream format
1167 * @flags: (out): result location for the #GstSeekFlags
1168 * @start_type: (out): result location for the #GstSeekType of the start position
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001169 * @start: (out): result location for the start position expressed in @format
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001170 * @stop_type: (out): result location for the #GstSeekType of the stop position
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001171 * @stop: (out): result location for the stop position expressed in @format
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001172 *
1173 * Parses a seek @event and stores the results in the given result locations.
1174 */
1175void
1176gst_event_parse_seek (GstEvent * event, gdouble * rate,
1177 GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
1178 gint64 * start, GstSeekType * stop_type, gint64 * stop)
1179{
1180 const GstStructure *structure;
1181
1182 g_return_if_fail (GST_IS_EVENT (event));
1183 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
1184
1185 structure = GST_EVENT_STRUCTURE (event);
1186 if (rate)
1187 *rate =
1188 g_value_get_double (gst_structure_id_get_value (structure,
1189 GST_QUARK (RATE)));
1190 if (format)
1191 *format = (GstFormat)
1192 g_value_get_enum (gst_structure_id_get_value (structure,
1193 GST_QUARK (FORMAT)));
1194 if (flags)
1195 *flags = (GstSeekFlags)
1196 g_value_get_flags (gst_structure_id_get_value (structure,
1197 GST_QUARK (FLAGS)));
1198 if (start_type)
1199 *start_type = (GstSeekType)
1200 g_value_get_enum (gst_structure_id_get_value (structure,
1201 GST_QUARK (CUR_TYPE)));
1202 if (start)
1203 *start =
1204 g_value_get_int64 (gst_structure_id_get_value (structure,
1205 GST_QUARK (CUR)));
1206 if (stop_type)
1207 *stop_type = (GstSeekType)
1208 g_value_get_enum (gst_structure_id_get_value (structure,
1209 GST_QUARK (STOP_TYPE)));
1210 if (stop)
1211 *stop =
1212 g_value_get_int64 (gst_structure_id_get_value (structure,
1213 GST_QUARK (STOP)));
1214}
1215
1216/**
1217 * gst_event_new_navigation:
1218 * @structure: (transfer full): description of the event. The event will take
1219 * ownership of the structure.
1220 *
1221 * Create a new navigation event from the given description.
1222 *
1223 * Returns: (transfer full): a new #GstEvent
1224 */
1225GstEvent *
1226gst_event_new_navigation (GstStructure * structure)
1227{
1228 g_return_val_if_fail (structure != NULL, NULL);
1229
1230 return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
1231}
1232
1233/**
1234 * gst_event_new_latency:
1235 * @latency: the new latency value
1236 *
1237 * Create a new latency event. The event is sent upstream from the sinks and
1238 * notifies elements that they should add an additional @latency to the
1239 * running time before synchronising against the clock.
1240 *
1241 * The latency is mostly used in live sinks and is always expressed in
1242 * the time format.
1243 *
1244 * Returns: (transfer full): a new #GstEvent
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001245 */
1246GstEvent *
1247gst_event_new_latency (GstClockTime latency)
1248{
1249 GstEvent *event;
1250 GstStructure *structure;
1251
1252 GST_CAT_INFO (GST_CAT_EVENT,
1253 "creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));
1254
Olivier Naudan54399762012-04-13 09:08:41 -04001255 structure = gst_structure_new_id (GST_QUARK (EVENT_LATENCY),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001256 GST_QUARK (LATENCY), G_TYPE_UINT64, latency, NULL);
1257 event = gst_event_new_custom (GST_EVENT_LATENCY, structure);
1258
1259 return event;
1260}
1261
1262/**
1263 * gst_event_parse_latency:
1264 * @event: The event to query
1265 * @latency: (out): A pointer to store the latency in.
1266 *
1267 * Get the latency in the latency event.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001268 */
1269void
1270gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
1271{
1272 g_return_if_fail (GST_IS_EVENT (event));
1273 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_LATENCY);
1274
1275 if (latency)
1276 *latency =
1277 g_value_get_uint64 (gst_structure_id_get_value (GST_EVENT_STRUCTURE
1278 (event), GST_QUARK (LATENCY)));
1279}
1280
1281/**
1282 * gst_event_new_step:
1283 * @format: the format of @amount
1284 * @amount: the amount of data to step
1285 * @rate: the step rate
1286 * @flush: flushing steps
1287 * @intermediate: intermediate steps
1288 *
1289 * Create a new step event. The purpose of the step event is to instruct a sink
1290 * to skip @amount (expressed in @format) of media. It can be used to implement
1291 * stepping through the video frame by frame or for doing fast trick modes.
1292 *
Olivier Naudan54399762012-04-13 09:08:41 -04001293 * A rate of <= 0.0 is not allowed. Pause the pipeline, for the effect of rate
1294 * = 0.0 or first reverse the direction of playback using a seek event to get
1295 * the same effect as rate < 0.0.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001296 *
1297 * The @flush flag will clear any pending data in the pipeline before starting
1298 * the step operation.
1299 *
1300 * The @intermediate flag instructs the pipeline that this step operation is
1301 * part of a larger step operation.
1302 *
1303 * Returns: (transfer full): a new #GstEvent
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001304 */
1305GstEvent *
1306gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
1307 gboolean flush, gboolean intermediate)
1308{
1309 GstEvent *event;
1310 GstStructure *structure;
1311
1312 g_return_val_if_fail (rate > 0.0, NULL);
1313
1314 GST_CAT_INFO (GST_CAT_EVENT, "creating step event");
1315
Olivier Naudan54399762012-04-13 09:08:41 -04001316 structure = gst_structure_new_id (GST_QUARK (EVENT_STEP),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001317 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1318 GST_QUARK (AMOUNT), G_TYPE_UINT64, amount,
1319 GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
1320 GST_QUARK (FLUSH), G_TYPE_BOOLEAN, flush,
1321 GST_QUARK (INTERMEDIATE), G_TYPE_BOOLEAN, intermediate, NULL);
1322 event = gst_event_new_custom (GST_EVENT_STEP, structure);
1323
1324 return event;
1325}
1326
1327/**
1328 * gst_event_parse_step:
1329 * @event: The event to query
1330 * @format: (out) (allow-none): a pointer to store the format in
1331 * @amount: (out) (allow-none): a pointer to store the amount in
1332 * @rate: (out) (allow-none): a pointer to store the rate in
1333 * @flush: (out) (allow-none): a pointer to store the flush boolean in
1334 * @intermediate: (out) (allow-none): a pointer to store the intermediate
1335 * boolean in
1336 *
1337 * Parse the step event.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001338 */
1339void
1340gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
1341 gdouble * rate, gboolean * flush, gboolean * intermediate)
1342{
1343 const GstStructure *structure;
1344
1345 g_return_if_fail (GST_IS_EVENT (event));
1346 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STEP);
1347
1348 structure = GST_EVENT_STRUCTURE (event);
1349 if (format)
1350 *format =
1351 (GstFormat) g_value_get_enum (gst_structure_id_get_value (structure,
1352 GST_QUARK (FORMAT)));
1353 if (amount)
1354 *amount = g_value_get_uint64 (gst_structure_id_get_value (structure,
1355 GST_QUARK (AMOUNT)));
1356 if (rate)
1357 *rate = g_value_get_double (gst_structure_id_get_value (structure,
1358 GST_QUARK (RATE)));
1359 if (flush)
1360 *flush = g_value_get_boolean (gst_structure_id_get_value (structure,
1361 GST_QUARK (FLUSH)));
1362 if (intermediate)
1363 *intermediate = g_value_get_boolean (gst_structure_id_get_value (structure,
1364 GST_QUARK (INTERMEDIATE)));
1365}
1366
1367/**
1368 * gst_event_new_reconfigure:
1369
Sebastian Dröge71fa7952014-05-03 17:39:29 +02001370 * Create a new reconfigure event. The purpose of the reconfigure event is
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001371 * to travel upstream and make elements renegotiate their caps or reconfigure
1372 * their buffer pools. This is useful when changing properties on elements
1373 * or changing the topology of the pipeline.
1374 *
1375 * Returns: (transfer full): a new #GstEvent
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001376 */
1377GstEvent *
1378gst_event_new_reconfigure (void)
1379{
1380 GstEvent *event;
1381
1382 GST_CAT_INFO (GST_CAT_EVENT, "creating reconfigure event");
1383
1384 event = gst_event_new_custom (GST_EVENT_RECONFIGURE, NULL);
1385
1386 return event;
1387}
1388
1389/**
1390 * gst_event_new_sink_message:
Sebastian Drögebed72df2012-06-08 09:16:25 +02001391 * @name: a name for the event
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001392 * @msg: (transfer none): the #GstMessage to be posted
1393 *
1394 * Create a new sink-message event. The purpose of the sink-message event is
1395 * to instruct a sink to post the message contained in the event synchronized
1396 * with the stream.
1397 *
Sebastian Drögebed72df2012-06-08 09:16:25 +02001398 * @name is used to store multiple sticky events on one pad.
1399 *
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001400 * Returns: (transfer full): a new #GstEvent
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001401 */
Sebastian Dröge570fd492015-03-16 19:05:29 +01001402/* FIXME 2.0: take ownership of msg for consistency? */
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001403GstEvent *
Sebastian Drögebed72df2012-06-08 09:16:25 +02001404gst_event_new_sink_message (const gchar * name, GstMessage * msg)
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001405{
1406 GstEvent *event;
1407 GstStructure *structure;
1408
1409 g_return_val_if_fail (msg != NULL, NULL);
1410
1411 GST_CAT_INFO (GST_CAT_EVENT, "creating sink-message event");
1412
Sebastian Drögebed72df2012-06-08 09:16:25 +02001413 structure = gst_structure_new_id (g_quark_from_string (name),
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001414 GST_QUARK (MESSAGE), GST_TYPE_MESSAGE, msg, NULL);
1415 event = gst_event_new_custom (GST_EVENT_SINK_MESSAGE, structure);
1416
1417 return event;
1418}
1419
1420/**
1421 * gst_event_parse_sink_message:
1422 * @event: The event to query
1423 * @msg: (out) (transfer full): a pointer to store the #GstMessage in.
1424 *
1425 * Parse the sink-message event. Unref @msg after usage.
Nicolas Dechesnebeb43202011-09-30 00:54:14 +02001426 */
1427void
1428gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
1429{
1430 const GstStructure *structure;
1431
1432 g_return_if_fail (GST_IS_EVENT (event));
1433 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE);
1434
1435 structure = GST_EVENT_STRUCTURE (event);
1436 if (msg)
1437 *msg =
1438 GST_MESSAGE (g_value_dup_boxed (gst_structure_id_get_value
1439 (structure, GST_QUARK (MESSAGE))));
1440}
Olivier Naudan54399762012-04-13 09:08:41 -04001441
1442/**
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001443 * gst_event_new_stream_start:
1444 * @stream_id: Identifier for this stream
Olivier Naudan54399762012-04-13 09:08:41 -04001445 *
1446 * Create a new STREAM_START event. The stream start event can only
1447 * travel downstream synchronized with the buffer flow. It is expected
1448 * to be the first event that is sent for a new stream.
1449 *
1450 * Source elements, demuxers and other elements that create new streams
1451 * are supposed to send this event as the first event of a new stream. It
Sebastian Dröge570fd492015-03-16 19:05:29 +01001452 * should not be sent after a flushing seek or in similar situations
Olivier Naudan54399762012-04-13 09:08:41 -04001453 * and is used to mark the beginning of a new logical stream. Elements
1454 * combining multiple streams must ensure that this event is only forwarded
1455 * downstream once and not for every single input stream.
1456 *
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001457 * The @stream_id should be a unique string that consists of the upstream
1458 * stream-id, / as separator and a unique stream-id for this specific
1459 * stream. A new stream-id should only be created for a stream if the upstream
1460 * stream is split into (potentially) multiple new streams, e.g. in a demuxer,
1461 * but not for every single element in the pipeline.
Sebastian Drögee0655f92012-09-14 09:01:22 +02001462 * gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be
Sebastian Dröge432d5632016-03-01 16:55:43 +02001463 * used to create a stream-id. There are no particular semantics for the
1464 * stream-id, though it should be deterministic (to support stream matching)
1465 * and it might be used to order streams (besides any information conveyed by
1466 * stream flags).
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001467 *
Olivier Naudan54399762012-04-13 09:08:41 -04001468 * Returns: (transfer full): the new STREAM_START event.
1469 */
1470GstEvent *
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001471gst_event_new_stream_start (const gchar * stream_id)
Olivier Naudan54399762012-04-13 09:08:41 -04001472{
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001473 GstStructure *s;
1474
1475 g_return_val_if_fail (stream_id != NULL, NULL);
1476
1477 s = gst_structure_new_id (GST_QUARK (EVENT_STREAM_START),
Sebastian Dröge01f23672013-07-14 10:55:08 +02001478 GST_QUARK (STREAM_ID), G_TYPE_STRING, stream_id,
1479 GST_QUARK (FLAGS), GST_TYPE_STREAM_FLAGS, GST_STREAM_FLAG_NONE, NULL);
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001480
1481 return gst_event_new_custom (GST_EVENT_STREAM_START, s);
1482}
1483
1484/**
1485 * gst_event_parse_stream_start:
1486 * @event: a stream-start event.
Sebastian Dröge654e0682012-12-19 10:22:18 +01001487 * @stream_id: (out) (transfer none): pointer to store the stream-id
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001488 *
Sebastian Drögee0655f92012-09-14 09:01:22 +02001489 * Parse a stream-id @event and store the result in the given @stream_id
1490 * location. The string stored in @stream_id must not be modified and will
1491 * remain valid only until @event gets freed. Make a copy if you want to
1492 * modify it or store it for later use.
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001493 */
1494void
1495gst_event_parse_stream_start (GstEvent * event, const gchar ** stream_id)
1496{
1497 const GstStructure *structure;
Sebastian Drögee0655f92012-09-14 09:01:22 +02001498 const GValue *val;
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001499
1500 g_return_if_fail (event != NULL);
1501 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1502
1503 structure = gst_event_get_structure (event);
Sebastian Drögee0655f92012-09-14 09:01:22 +02001504 val = gst_structure_id_get_value (structure, GST_QUARK (STREAM_ID));
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001505
1506 if (stream_id)
Sebastian Drögee0655f92012-09-14 09:01:22 +02001507 *stream_id = g_value_get_string (val);
Olivier Naudan54399762012-04-13 09:08:41 -04001508}
1509
1510/**
Sebastian Dröge01f23672013-07-14 10:55:08 +02001511 * gst_event_set_stream_flags:
1512 * @event: a stream-start event
1513 * @flags: the stream flags to set
1514 *
1515 * Since: 1.2
1516 */
1517void
1518gst_event_set_stream_flags (GstEvent * event, GstStreamFlags flags)
1519{
1520 g_return_if_fail (event != NULL);
1521 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1522 g_return_if_fail (gst_event_is_writable (event));
1523
1524 gst_structure_id_set (GST_EVENT_STRUCTURE (event),
1525 GST_QUARK (FLAGS), GST_TYPE_STREAM_FLAGS, flags, NULL);
1526}
1527
1528/**
1529 * gst_event_parse_stream_flags:
1530 * @event: a stream-start event
1531 * @flags: (out): address of variable where to store the stream flags
1532 *
1533 * Since: 1.2
1534 */
1535void
1536gst_event_parse_stream_flags (GstEvent * event, GstStreamFlags * flags)
1537{
1538 g_return_if_fail (event != NULL);
1539 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1540
1541 if (flags) {
1542 gst_structure_id_get (GST_EVENT_STRUCTURE (event),
1543 GST_QUARK (FLAGS), GST_TYPE_STREAM_FLAGS, flags, NULL);
1544 }
1545}
1546
1547/**
Sebastian Drögeab458c22013-07-30 08:18:47 +02001548 * gst_event_set_group_id:
1549 * @event: a stream-start event
1550 * @group_id: the group id to set
1551 *
1552 * All streams that have the same group id are supposed to be played
1553 * together, i.e. all streams inside a container file should have the
1554 * same group id but different stream ids. The group id should change
1555 * each time the stream is started, resulting in different group ids
1556 * each time a file is played for example.
1557 *
1558 * Use gst_util_group_id_next() to get a new group id.
1559 *
1560 * Since: 1.2
1561 */
1562void
1563gst_event_set_group_id (GstEvent * event, guint group_id)
1564{
1565 g_return_if_fail (event != NULL);
1566 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START);
1567 g_return_if_fail (gst_event_is_writable (event));
1568
1569 gst_structure_id_set (GST_EVENT_STRUCTURE (event),
1570 GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id, NULL);
1571}
1572
1573/**
1574 * gst_event_parse_group_id:
1575 * @event: a stream-start event
1576 * @group_id: (out): address of variable where to store the group id
1577 *
1578 * Returns: %TRUE if a group id was set on the event and could be parsed,
1579 * %FALSE otherwise.
1580 *
1581 * Since: 1.2
1582 */
1583gboolean
1584gst_event_parse_group_id (GstEvent * event, guint * group_id)
1585{
1586 g_return_val_if_fail (event != NULL, FALSE);
1587 g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START,
1588 FALSE);
1589
1590 if (group_id) {
1591 return gst_structure_id_get (GST_EVENT_STRUCTURE (event),
1592 GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id, NULL);
1593 }
1594
1595 return TRUE;
1596}
1597
1598/**
Olivier Naudan54399762012-04-13 09:08:41 -04001599 * gst_event_new_toc:
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001600 * @toc: (transfer none): #GstToc structure.
Olivier Naudan54399762012-04-13 09:08:41 -04001601 * @updated: whether @toc was updated or not.
1602 *
1603 * Generate a TOC event from the given @toc. The purpose of the TOC event is to
1604 * inform elements that some kind of the TOC was found.
1605 *
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001606 * Returns: (transfer full): a new #GstEvent.
Olivier Naudan54399762012-04-13 09:08:41 -04001607 */
1608GstEvent *
1609gst_event_new_toc (GstToc * toc, gboolean updated)
1610{
1611 GstStructure *toc_struct;
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001612 GQuark id;
Olivier Naudan54399762012-04-13 09:08:41 -04001613
1614 g_return_val_if_fail (toc != NULL, NULL);
1615
1616 GST_CAT_INFO (GST_CAT_EVENT, "creating toc event");
1617
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001618 /* need different structure names so sticky_multi event stuff on pads
1619 * works, i.e. both TOC events are kept around */
1620 if (gst_toc_get_scope (toc) == GST_TOC_SCOPE_GLOBAL)
1621 id = GST_QUARK (EVENT_TOC_GLOBAL);
1622 else
1623 id = GST_QUARK (EVENT_TOC_CURRENT);
Olivier Naudan54399762012-04-13 09:08:41 -04001624
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001625 toc_struct = gst_structure_new_id (id,
1626 GST_QUARK (TOC), GST_TYPE_TOC, toc,
1627 GST_QUARK (UPDATED), G_TYPE_BOOLEAN, updated, NULL);
1628
1629 return gst_event_new_custom (GST_EVENT_TOC, toc_struct);
Olivier Naudan54399762012-04-13 09:08:41 -04001630}
1631
1632/**
1633 * gst_event_parse_toc:
1634 * @event: a TOC event.
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001635 * @toc: (out) (transfer full): pointer to #GstToc structure.
Olivier Naudan54399762012-04-13 09:08:41 -04001636 * @updated: (out): pointer to store TOC updated flag.
1637 *
1638 * Parse a TOC @event and store the results in the given @toc and @updated locations.
Olivier Naudan54399762012-04-13 09:08:41 -04001639 */
1640void
1641gst_event_parse_toc (GstEvent * event, GstToc ** toc, gboolean * updated)
1642{
1643 const GstStructure *structure;
1644
1645 g_return_if_fail (event != NULL);
1646 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TOC);
1647 g_return_if_fail (toc != NULL);
1648
1649 structure = gst_event_get_structure (event);
Olivier Naudan54399762012-04-13 09:08:41 -04001650
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001651 gst_structure_id_get (structure,
1652 GST_QUARK (TOC), GST_TYPE_TOC, toc,
1653 GST_QUARK (UPDATED), G_TYPE_BOOLEAN, updated, NULL);
Olivier Naudan54399762012-04-13 09:08:41 -04001654}
1655
1656/**
1657 * gst_event_new_toc_select:
1658 * @uid: UID in the TOC to start playback from.
1659 *
1660 * Generate a TOC select event with the given @uid. The purpose of the
1661 * TOC select event is to start playback based on the TOC's entry with the
1662 * given @uid.
1663 *
1664 * Returns: a new #GstEvent.
Olivier Naudan54399762012-04-13 09:08:41 -04001665 */
1666GstEvent *
1667gst_event_new_toc_select (const gchar * uid)
1668{
1669 GstStructure *structure;
1670
1671 g_return_val_if_fail (uid != NULL, NULL);
1672
1673 GST_CAT_INFO (GST_CAT_EVENT, "creating toc select event for UID: %s", uid);
1674
1675 structure = gst_structure_new_id (GST_QUARK (EVENT_TOC_SELECT),
1676 GST_QUARK (UID), G_TYPE_STRING, uid, NULL);
1677
1678 return gst_event_new_custom (GST_EVENT_TOC_SELECT, structure);
1679}
1680
1681/**
1682 * gst_event_parse_toc_select:
1683 * @event: a TOC select event.
Sebastian Dröge570fd492015-03-16 19:05:29 +01001684 * @uid: (out) (transfer full) (allow-none): storage for the selection UID.
Olivier Naudan54399762012-04-13 09:08:41 -04001685 *
1686 * Parse a TOC select @event and store the results in the given @uid location.
Olivier Naudan54399762012-04-13 09:08:41 -04001687 */
1688void
1689gst_event_parse_toc_select (GstEvent * event, gchar ** uid)
1690{
1691 const GstStructure *structure;
1692 const GValue *val;
1693
1694 g_return_if_fail (event != NULL);
1695 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TOC_SELECT);
1696
1697 structure = gst_event_get_structure (event);
1698 val = gst_structure_id_get_value (structure, GST_QUARK (UID));
1699
1700 if (uid != NULL)
1701 *uid = g_strdup (g_value_get_string (val));
1702
1703}
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001704
1705/**
Sebastian Dröge76ff7f12015-06-24 23:03:12 +02001706 * gst_event_new_protection:
1707 * @system_id: (transfer none): a string holding a UUID that uniquely
1708 * identifies a protection system.
1709 * @data: (transfer none): a #GstBuffer holding protection system specific
1710 * information. The reference count of the buffer will be incremented by one.
1711 * @origin: a string indicating where the protection
1712 * information carried in the event was extracted from. The allowed values
1713 * of this string will depend upon the protection scheme.
1714 *
1715 * Creates a new event containing information specific to a particular
1716 * protection system (uniquely identified by @system_id), by which that
1717 * protection system can acquire key(s) to decrypt a protected stream.
Sebastian Drögef6697b22015-05-13 13:17:48 +03001718 *
1719 * In order for a decryption element to decrypt media
1720 * protected using a specific system, it first needs all the
1721 * protection system specific information necessary to acquire the decryption
1722 * key(s) for that stream. The functions defined here enable this information
1723 * to be passed in events from elements that extract it
1724 * (e.g., ISOBMFF demuxers, MPEG DASH demuxers) to protection decrypter
1725 * elements that use it.
1726 *
1727 * Events containing protection system specific information are created using
1728 * #gst_event_new_protection, and they can be parsed by downstream elements
1729 * using #gst_event_parse_protection.
1730 *
1731 * In Common Encryption, protection system specific information may be located
1732 * within ISOBMFF files, both in movie (moov) boxes and movie fragment (moof)
1733 * boxes; it may also be contained in ContentProtection elements within MPEG
1734 * DASH MPDs. The events created by #gst_event_new_protection contain data
1735 * identifying from which of these locations the encapsulated protection system
1736 * specific information originated. This origin information is required as
1737 * some protection systems use different encodings depending upon where the
1738 * information originates.
1739 *
Sebastian Dröge76ff7f12015-06-24 23:03:12 +02001740 * The events returned by gst_event_new_protection() are implemented
Sebastian Drögef6697b22015-05-13 13:17:48 +03001741 * in such a way as to ensure that the most recently-pushed protection info
1742 * event of a particular @origin and @system_id will
1743 * be stuck to the output pad of the sending element.
1744 *
Sebastian Drögef6697b22015-05-13 13:17:48 +03001745 * Returns: a #GST_EVENT_PROTECTION event, if successful; %NULL
1746 * if unsuccessful.
1747 *
1748 * Since: 1.6
1749 */
1750GstEvent *
1751gst_event_new_protection (const gchar * system_id,
1752 GstBuffer * data, const gchar * origin)
1753{
1754 gchar *event_name;
1755 GstEvent *event;
1756 GstStructure *s;
1757
1758 g_return_val_if_fail (system_id != NULL, NULL);
1759 g_return_val_if_fail (data != NULL, NULL);
1760
1761 event_name =
1762 g_strconcat ("GstProtectionEvent", origin ? "-" : "",
1763 origin ? origin : "", "-", system_id, NULL);
1764
1765 GST_CAT_INFO (GST_CAT_EVENT, "creating protection event %s", event_name);
1766
1767 s = gst_structure_new (event_name, "data", GST_TYPE_BUFFER, data,
1768 "system_id", G_TYPE_STRING, system_id, NULL);
1769 if (origin)
1770 gst_structure_set (s, "origin", G_TYPE_STRING, origin, NULL);
1771 event = gst_event_new_custom (GST_EVENT_PROTECTION, s);
1772
1773 g_free (event_name);
1774 return event;
1775}
1776
1777/**
1778 * gst_event_parse_protection:
1779 * @event: a #GST_EVENT_PROTECTION event.
1780 * @system_id: (out) (allow-none) (transfer none): pointer to store the UUID
1781 * string uniquely identifying a content protection system.
1782 * @data: (out) (allow-none) (transfer none): pointer to store a #GstBuffer
1783 * holding protection system specific information.
1784 * @origin: (allow-none) (transfer none): pointer to store a value that
1785 * indicates where the protection information carried by @event was extracted
1786 * from.
1787 *
1788 * Parses an event containing protection system specific information and stores
1789 * the results in @system_id, @data and @origin. The data stored in @system_id,
1790 * @origin and @data are valid until @event is released.
1791 *
1792 * Since: 1.6
1793 */
1794void
1795gst_event_parse_protection (GstEvent * event, const gchar ** system_id,
1796 GstBuffer ** data, const gchar ** origin)
1797{
1798 const GstStructure *s;
1799
1800 g_return_if_fail (event != NULL);
1801 g_return_if_fail (GST_IS_EVENT (event));
1802 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_PROTECTION);
1803
1804 s = gst_event_get_structure (event);
1805
1806 if (origin)
1807 *origin = gst_structure_get_string (s, "origin");
1808
1809 if (system_id)
1810 *system_id = gst_structure_get_string (s, "system_id");
1811
1812 if (data) {
1813 const GValue *value = gst_structure_get_value (s, "data");
1814 *data = gst_value_get_buffer (value);
1815 }
1816}
1817
1818/**
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001819 * gst_event_new_segment_done:
1820 * @format: The format of the position being done
1821 * @position: The position of the segment being done
1822 *
1823 * Create a new segment-done event. This event is sent by elements that
1824 * finish playback of a segment as a result of a segment seek.
1825 *
1826 * Returns: (transfer full): a new #GstEvent
1827 */
1828GstEvent *
1829gst_event_new_segment_done (GstFormat format, gint64 position)
1830{
1831 GstEvent *event;
1832 GstStructure *structure;
1833
1834 GST_CAT_INFO (GST_CAT_EVENT, "creating segment-done event");
1835
1836 structure = gst_structure_new_id (GST_QUARK (EVENT_SEGMENT_DONE),
1837 GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
1838 GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
1839
1840 event = gst_event_new_custom (GST_EVENT_SEGMENT_DONE, structure);
1841
1842 return event;
1843}
1844
1845/**
1846 * gst_event_parse_segment_done:
1847 * @event: A valid #GstEvent of type GST_EVENT_SEGMENT_DONE.
Sebastian Dröge5856dec2014-06-22 17:18:02 +02001848 * @format: (out) (allow-none): Result location for the format, or %NULL
1849 * @position: (out) (allow-none): Result location for the position, or %NULL
Sebastian Dröged1f921c2012-08-08 18:10:27 +02001850 *
1851 * Extracts the position and format from the segment done message.
1852 *
1853 */
1854void
1855gst_event_parse_segment_done (GstEvent * event, GstFormat * format,
1856 gint64 * position)
1857{
1858 const GstStructure *structure;
1859 const GValue *val;
1860
1861 g_return_if_fail (event != NULL);
1862 g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT_DONE);
1863
1864 structure = gst_event_get_structure (event);
1865
1866 val = gst_structure_id_get_value (structure, GST_QUARK (FORMAT));
1867 if (format != NULL)
1868 *format = g_value_get_enum (val);
1869
1870 val = gst_structure_id_get_value (structure, GST_QUARK (POSITION));
1871 if (position != NULL)
1872 *position = g_value_get_int64 (val);
1873}