1/* GStreamer
2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
4 * 2005 Wim Taymans <wim@fluendo.com>
5 *
6 * gstevent.h: Header for GstEvent subsystem
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
17 *
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
22 */
23
24
25#ifndef __GST_EVENT_H__
26#define __GST_EVENT_H__
27
28typedef struct _GstEvent GstEvent;
29
30/**
31 * GstEventTypeFlags:
32 * @GST_EVENT_TYPE_UPSTREAM: Set if the event can travel upstream.
33 * @GST_EVENT_TYPE_DOWNSTREAM: Set if the event can travel downstream.
34 * @GST_EVENT_TYPE_SERIALIZED: Set if the event should be serialized with data
35 * flow.
36 * @GST_EVENT_TYPE_STICKY: Set if the event is sticky on the pads.
37 * @GST_EVENT_TYPE_STICKY_MULTI: Multiple sticky events can be on a pad, each
38 * identified by the event name.
39 *
40 * #GstEventTypeFlags indicate the aspects of the different #GstEventType
41 * values. You can get the type flags of a #GstEventType with the
42 * gst_event_type_get_flags() function.
43 */
44typedef enum {
45 GST_EVENT_TYPE_UPSTREAM = 1 << 0,
46 GST_EVENT_TYPE_DOWNSTREAM = 1 << 1,
47 GST_EVENT_TYPE_SERIALIZED = 1 << 2,
48 GST_EVENT_TYPE_STICKY = 1 << 3,
49 GST_EVENT_TYPE_STICKY_MULTI = 1 << 4
50} GstEventTypeFlags;
51
52/**
53 * GST_EVENT_TYPE_BOTH: (value 3) (type GstEventTypeFlags)
54 *
55 * The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.
56 */
57#define GST_EVENT_TYPE_BOTH \
58 ((GstEventTypeFlags)(GST_EVENT_TYPE_UPSTREAM | GST_EVENT_TYPE_DOWNSTREAM))
59
60#define GST_EVENT_NUM_SHIFT (8)
61
62/**
63 * GST_EVENT_MAKE_TYPE:
64 * @num: the event number to create
65 * @flags: the event flags
66 *
67 * when making custom event types, use this macro with the num and
68 * the given flags
69 */
70#define GST_EVENT_MAKE_TYPE(num,flags) \
71 (((num) << GST_EVENT_NUM_SHIFT) | (flags))
72
73#define _FLAG(name) GST_EVENT_TYPE_##name
74
75/**
76 * GstEventType:
77 * @GST_EVENT_UNKNOWN: unknown event.
78 * @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
79 * from the pipeline and unblock all streaming threads.
80 * @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
81 * running-time of the pipeline.
82 * @GST_EVENT_SELECT_STREAMS: A request to select one or more streams (Since: 1.10)
83 * @GST_EVENT_STREAM_START: Event to mark the start of a new stream. Sent before any
84 * other serialized event and only sent at the start of a new stream,
85 * not after flushing seeks.
86 * @GST_EVENT_CAPS: #GstCaps event. Notify the pad of a new media type.
87 * @GST_EVENT_SEGMENT: A new media segment follows in the dataflow. The
88 * segment events contains information for clipping buffers and
89 * converting buffer timestamps to running-time and
90 * stream-time.
91 * @GST_EVENT_STREAM_COLLECTION: A new #GstStreamCollection is available (Since: 1.10)
92 * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
93 * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
94 * used yet.
95 * @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
96 * send messages that should be emitted in sync with
97 * rendering.
98 * @GST_EVENT_STREAM_GROUP_DONE: Indicates that there is no more data for
99 * the stream group ID in the message. Sent before EOS
100 * in some instances and should be handled mostly the same. (Since: 1.10)
101 * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
102 * without either a STREAM_START event, or a FLUSH_STOP and a SEGMENT
103 * event.
104 * @GST_EVENT_SEGMENT_DONE: Marks the end of a segment playback.
105 * @GST_EVENT_GAP: Marks a gap in the datastream.
106 * @GST_EVENT_TOC: An event which indicates that a new table of contents (TOC)
107 * was found or updated.
108 * @GST_EVENT_PROTECTION: An event which indicates that new or updated
109 * encryption information has been found in the stream.
110 * @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
111 * that the downstream elements should adjust their processing
112 * rate.
113 * @GST_EVENT_SEEK: A request for a new playback position and rate.
114 * @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
115 * user requests, such as mouse or keyboard movements,
116 * to upstream elements.
117 * @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
118 * the latency information to adjust their synchronisation.
119 * @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
120 * execute the step operation.
121 * @GST_EVENT_RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.
122 * @GST_EVENT_TOC_SELECT: A request for a new playback position based on TOC
123 * entry's UID.
124 * @GST_EVENT_INSTANT_RATE_CHANGE: Notify downstream that a playback rate override
125 * should be applied as soon as possible. (Since: 1.18)
126 * @GST_EVENT_INSTANT_RATE_SYNC_TIME: Sent by the pipeline to notify elements that handle the
127 * instant-rate-change event about the running-time when
128 * the rate multiplier should be applied (or was applied). (Since: 1.18)
129 * @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
130 * @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
131 * data flow.
132 * @GST_EVENT_CUSTOM_DOWNSTREAM_OOB: Custom out-of-band downstream event.
133 * @GST_EVENT_CUSTOM_DOWNSTREAM_STICKY: Custom sticky downstream event.
134 * @GST_EVENT_CUSTOM_BOTH: Custom upstream or downstream event.
135 * In-band when travelling downstream.
136 * @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.
137 *
138 * #GstEventType lists the standard event types that can be sent in a pipeline.
139 *
140 * The custom event types can be used for private messages between elements
141 * that can't be expressed using normal
142 * GStreamer buffer passing semantics. Custom events carry an arbitrary
143 * #GstStructure.
144 * Specific custom events are distinguished by the name of the structure.
145 */
146/* NOTE: keep in sync with quark registration in gstevent.c */
147typedef enum {
148 GST_EVENT_UNKNOWN = GST_EVENT_MAKE_TYPE (0, 0),
149
150 /* bidirectional events */
151 GST_EVENT_FLUSH_START = GST_EVENT_MAKE_TYPE (10, _FLAG(BOTH)),
152 GST_EVENT_FLUSH_STOP = GST_EVENT_MAKE_TYPE (20, _FLAG(BOTH) | _FLAG(SERIALIZED)),
153
154 /* downstream serialized events */
155 GST_EVENT_STREAM_START = GST_EVENT_MAKE_TYPE (40, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY)),
156 GST_EVENT_CAPS = GST_EVENT_MAKE_TYPE (50, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY)),
157 GST_EVENT_SEGMENT = GST_EVENT_MAKE_TYPE (70, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY)),
158 GST_EVENT_STREAM_COLLECTION = GST_EVENT_MAKE_TYPE (75, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY) | _FLAG(STICKY_MULTI)),
159 GST_EVENT_TAG = GST_EVENT_MAKE_TYPE (80, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY) | _FLAG(STICKY_MULTI)),
160 GST_EVENT_BUFFERSIZE = GST_EVENT_MAKE_TYPE (90, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY)),
161 GST_EVENT_SINK_MESSAGE = GST_EVENT_MAKE_TYPE (100, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY) | _FLAG(STICKY_MULTI)),
162 GST_EVENT_STREAM_GROUP_DONE = GST_EVENT_MAKE_TYPE (105, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY)),
163 GST_EVENT_EOS = GST_EVENT_MAKE_TYPE (110, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY)),
164 GST_EVENT_TOC = GST_EVENT_MAKE_TYPE (120, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY) | _FLAG(STICKY_MULTI)),
165 GST_EVENT_PROTECTION = GST_EVENT_MAKE_TYPE (130, _FLAG (DOWNSTREAM) | _FLAG (SERIALIZED) | _FLAG (STICKY) | _FLAG (STICKY_MULTI)),
166
167 /* non-sticky downstream serialized */
168 GST_EVENT_SEGMENT_DONE = GST_EVENT_MAKE_TYPE (150, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED)),
169 GST_EVENT_GAP = GST_EVENT_MAKE_TYPE (160, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED)),
170
171 /* sticky downstream non-serialized */
172 /* FIXME 2.0: change to value 72 and move after the GST_EVENT_SEGMENT event */
173 GST_EVENT_INSTANT_RATE_CHANGE = GST_EVENT_MAKE_TYPE (180, _FLAG(DOWNSTREAM) | _FLAG(STICKY)),
174
175 /* upstream events */
176 GST_EVENT_QOS = GST_EVENT_MAKE_TYPE (190, _FLAG(UPSTREAM)),
177 GST_EVENT_SEEK = GST_EVENT_MAKE_TYPE (200, _FLAG(UPSTREAM)),
178 GST_EVENT_NAVIGATION = GST_EVENT_MAKE_TYPE (210, _FLAG(UPSTREAM)),
179 GST_EVENT_LATENCY = GST_EVENT_MAKE_TYPE (220, _FLAG(UPSTREAM)),
180 GST_EVENT_STEP = GST_EVENT_MAKE_TYPE (230, _FLAG(UPSTREAM)),
181 GST_EVENT_RECONFIGURE = GST_EVENT_MAKE_TYPE (240, _FLAG(UPSTREAM)),
182 GST_EVENT_TOC_SELECT = GST_EVENT_MAKE_TYPE (250, _FLAG(UPSTREAM)),
183 GST_EVENT_SELECT_STREAMS = GST_EVENT_MAKE_TYPE (260, _FLAG(UPSTREAM)),
184 GST_EVENT_INSTANT_RATE_SYNC_TIME = GST_EVENT_MAKE_TYPE (261, _FLAG(UPSTREAM)),
185
186 /* custom events start here */
187 GST_EVENT_CUSTOM_UPSTREAM = GST_EVENT_MAKE_TYPE (270, _FLAG(UPSTREAM)),
188 GST_EVENT_CUSTOM_DOWNSTREAM = GST_EVENT_MAKE_TYPE (280, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED)),
189 GST_EVENT_CUSTOM_DOWNSTREAM_OOB = GST_EVENT_MAKE_TYPE (290, _FLAG(DOWNSTREAM)),
190 GST_EVENT_CUSTOM_DOWNSTREAM_STICKY = GST_EVENT_MAKE_TYPE (300, _FLAG(DOWNSTREAM) | _FLAG(SERIALIZED) | _FLAG(STICKY) | _FLAG(STICKY_MULTI)),
191 GST_EVENT_CUSTOM_BOTH = GST_EVENT_MAKE_TYPE (310, _FLAG(BOTH) | _FLAG(SERIALIZED)),
192 GST_EVENT_CUSTOM_BOTH_OOB = GST_EVENT_MAKE_TYPE (320, _FLAG(BOTH))
193} GstEventType;
194#undef _FLAG
195
196/**
197 * GstStreamFlags:
198 * @GST_STREAM_FLAG_NONE: This stream has no special attributes
199 * @GST_STREAM_FLAG_SPARSE: This stream is a sparse stream (e.g. a subtitle
200 * stream), data may flow only in irregular intervals with large gaps in
201 * between.
202 * @GST_STREAM_FLAG_SELECT: This stream should be selected by default. This
203 * flag may be used by demuxers to signal that a stream should be selected
204 * by default in a playback scenario.
205 * @GST_STREAM_FLAG_UNSELECT: This stream should not be selected by default.
206 * This flag may be used by demuxers to signal that a stream should not
207 * be selected by default in a playback scenario, but only if explicitly
208 * selected by the user (e.g. an audio track for the hard of hearing or
209 * a director's commentary track).
210 *
211 * Since: 1.2
212 */
213typedef enum {
214 GST_STREAM_FLAG_NONE,
215 GST_STREAM_FLAG_SPARSE = (1 << 0),
216 GST_STREAM_FLAG_SELECT = (1 << 1),
217 GST_STREAM_FLAG_UNSELECT = (1 << 2)
218} GstStreamFlags;
219
220#include <gst/gstminiobject.h>
221#include <gst/gstformat.h>
222#include <gst/gstobject.h>
223#include <gst/gstclock.h>
224#include <gst/gststructure.h>
225#include <gst/gsttaglist.h>
226#include <gst/gstsegment.h>
227#include <gst/gstmessage.h>
228#include <gst/gstcontext.h>
229#include <gst/gststreams.h>
230#include <gst/gsttoc.h>
231#include <gst/gststreamcollection.h>
232
233G_BEGIN_DECLS
234
235GST_API GType _gst_event_type;
236
237#define GST_TYPE_EVENT (_gst_event_type)
238#define GST_IS_EVENT(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_EVENT))
239#define GST_EVENT_CAST(obj) ((GstEvent *)(obj))
240#define GST_EVENT(obj) (GST_EVENT_CAST(obj))
241
242/**
243 * GST_EVENT_TYPE:
244 * @event: the event to query
245 *
246 * Get the #GstEventType of the event.
247 */
248#define GST_EVENT_TYPE(event) (GST_EVENT_CAST(event)->type)
249
250/**
251 * GST_EVENT_TYPE_NAME:
252 * @event: the event to query
253 *
254 * Get a constant string representation of the #GstEventType of the event.
255 */
256#define GST_EVENT_TYPE_NAME(event) (gst_event_type_get_name(GST_EVENT_TYPE(event)))
257
258/**
259 * GST_EVENT_TIMESTAMP:
260 * @event: the event to query
261 *
262 * Get the #GstClockTime timestamp of the event. This is the time when the event
263 * was created.
264 */
265/* FIXME 2.0: Remove the GstEvent::timestamp field */
266#define GST_EVENT_TIMESTAMP(event) (GST_EVENT_CAST(event)->timestamp)
267
268/**
269 * GST_EVENT_SEQNUM:
270 * @event: the event to query
271 *
272 * The sequence number of @event.
273 */
274#define GST_EVENT_SEQNUM(event) (GST_EVENT_CAST(event)->seqnum)
275
276/**
277 * GST_EVENT_IS_UPSTREAM:
278 * @ev: the event to query
279 *
280 * Check if an event can travel upstream.
281 */
282#define GST_EVENT_IS_UPSTREAM(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
283/**
284 * GST_EVENT_IS_DOWNSTREAM:
285 * @ev: the event to query
286 *
287 * Check if an event can travel downstream.
288 */
289#define GST_EVENT_IS_DOWNSTREAM(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
290/**
291 * GST_EVENT_IS_SERIALIZED:
292 * @ev: the event to query
293 *
294 * Check if an event is serialized with the data stream.
295 */
296#define GST_EVENT_IS_SERIALIZED(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
297/**
298 * GST_EVENT_IS_STICKY:
299 * @ev: the event to query
300 *
301 * Check if an event is sticky on the pads.
302 */
303#define GST_EVENT_IS_STICKY(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
304
305/**
306 * gst_event_is_writable:
307 * @ev: a #GstEvent
308 *
309 * Tests if you can safely write data into a event's structure or validly
310 * modify the seqnum and timestamp field.
311 */
312#define gst_event_is_writable(ev) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (ev))
313/**
314 * gst_event_make_writable:
315 * @ev: (transfer full): a #GstEvent
316 *
317 * Makes a writable event from the given event. If the source event is
318 * already writable, this will simply return the same event. A copy will
319 * otherwise be made using gst_event_copy().
320 *
321 * Returns: (transfer full): a writable event which may or may not be the
322 * same as @ev
323 */
324#define gst_event_make_writable(ev) GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
325
326#ifndef GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS
327static inline gboolean
328gst_event_replace(GstEvent** old_event, GstEvent* new_event)
329{
330 return gst_mini_object_replace (olddata: (GstMiniObject **) old_event, newdata: (GstMiniObject *) new_event);
331}
332
333static inline GstEvent *
334gst_event_steal (GstEvent **old_event)
335{
336 return GST_EVENT_CAST (gst_mini_object_steal ((GstMiniObject **) old_event));
337}
338
339static inline gboolean
340gst_event_take (GstEvent **old_event, GstEvent *new_event)
341{
342 return gst_mini_object_take (olddata: (GstMiniObject **) old_event, newdata: (GstMiniObject *) new_event);
343}
344#else /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
345GST_API
346gboolean gst_event_replace (GstEvent ** old_event,
347 GstEvent * new_event);
348
349GST_API
350GstEvent * gst_event_steal (GstEvent ** old_event);
351
352GST_API
353gboolean gst_event_take (GstEvent ** old_event,
354 GstEvent *new_event);
355#endif /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
356
357/**
358 * GstQOSType:
359 * @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when upstream
360 * elements are producing data too quickly and the element can't keep up
361 * processing the data. Upstream should reduce their production rate. This
362 * type is also used when buffers arrive early or in time.
363 * @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when upstream
364 * elements are producing data too slowly and need to speed up their
365 * production rate.
366 * @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
367 * application enabled throttling to limit the data rate.
368 *
369 * The different types of QoS events that can be given to the
370 * gst_event_new_qos() method.
371 */
372typedef enum {
373 GST_QOS_TYPE_OVERFLOW = 0,
374 GST_QOS_TYPE_UNDERFLOW = 1,
375 GST_QOS_TYPE_THROTTLE = 2
376} GstQOSType;
377
378/**
379 * GstGapFlags:
380 * @GST_GAP_FLAG_MISSING_DATA: The #GST_EVENT_GAP signals missing data,
381 * for example because of packet loss.
382 *
383 * The different flags that can be set on #GST_EVENT_GAP events. See
384 * gst_event_set_gap_flags() for details.
385 *
386 * Since: 1.20
387 */
388typedef enum {
389 GST_GAP_FLAG_MISSING_DATA = (1<<0),
390} GstGapFlags;
391
392/**
393 * GstEvent:
394 * @mini_object: the parent structure
395 * @type: the #GstEventType of the event
396 * @timestamp: the timestamp of the event
397 * @seqnum: the sequence number of the event
398 *
399 * A #GstEvent.
400 */
401struct _GstEvent {
402 GstMiniObject mini_object;
403
404 /*< public >*/ /* with COW */
405 GstEventType type;
406 /* FIXME 2.0: Remove the GstEvent::timestamp field */
407 guint64 timestamp;
408 guint32 seqnum;
409};
410
411GST_API
412const gchar* gst_event_type_get_name (GstEventType type);
413
414GST_API
415GQuark gst_event_type_to_quark (GstEventType type);
416
417GST_API
418GstEventTypeFlags
419 gst_event_type_get_flags (GstEventType type);
420
421
422GST_API
423guint gst_event_type_to_sticky_ordering (GstEventType type) G_GNUC_CONST;
424
425#ifndef GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS
426/* refcounting */
427static inline GstEvent *
428gst_event_ref (GstEvent * event)
429{
430 return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
431}
432
433static inline void
434gst_event_unref (GstEvent * event)
435{
436 gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
437}
438
439static inline void
440gst_clear_event (GstEvent ** event_ptr)
441{
442 gst_clear_mini_object ((GstMiniObject **) event_ptr);
443}
444
445/* copy event */
446static inline GstEvent *
447gst_event_copy (const GstEvent * event)
448{
449 return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
450}
451#else /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
452GST_API
453GstEvent * gst_event_ref (GstEvent * event);
454
455GST_API
456void gst_event_unref (GstEvent * event);
457
458GST_API
459void gst_clear_event (GstEvent ** event_ptr);
460
461GST_API
462GstEvent * gst_event_copy (const GstEvent * event);
463#endif /* GST_DISABLE_MINIOBJECT_INLINE_FUNCTIONS */
464
465GST_API
466GType gst_event_get_type (void);
467
468/* custom event */
469
470GST_API
471GstEvent* gst_event_new_custom (GstEventType type, GstStructure *structure) G_GNUC_MALLOC;
472
473GST_API
474const GstStructure *
475 gst_event_get_structure (GstEvent *event);
476
477GST_API
478GstStructure * gst_event_writable_structure (GstEvent *event);
479
480GST_API
481gboolean gst_event_has_name (GstEvent *event, const gchar *name);
482
483GST_API
484gboolean gst_event_has_name_id (GstEvent *event, GQuark name);
485
486/* identifiers for events and messages */
487
488GST_API
489guint32 gst_event_get_seqnum (GstEvent *event);
490
491GST_API
492void gst_event_set_seqnum (GstEvent *event, guint32 seqnum);
493
494/* accumulated pad offsets for the event */
495
496GST_API
497gint64 gst_event_get_running_time_offset (GstEvent *event);
498
499GST_API
500void gst_event_set_running_time_offset (GstEvent *event, gint64 offset);
501
502/* Stream start event */
503
504GST_API
505GstEvent * gst_event_new_stream_start (const gchar *stream_id) G_GNUC_MALLOC;
506
507GST_API
508void gst_event_parse_stream_start (GstEvent *event, const gchar **stream_id);
509
510GST_API
511void gst_event_set_stream (GstEvent *event, GstStream *stream);
512
513GST_API
514void gst_event_parse_stream (GstEvent *event, GstStream **stream);
515
516GST_API
517void gst_event_set_stream_flags (GstEvent *event, GstStreamFlags flags);
518
519GST_API
520void gst_event_parse_stream_flags (GstEvent *event, GstStreamFlags *flags);
521
522GST_API
523void gst_event_set_group_id (GstEvent *event, guint group_id);
524
525GST_API
526gboolean gst_event_parse_group_id (GstEvent *event, guint *group_id);
527
528/* flush events */
529
530GST_API
531GstEvent * gst_event_new_flush_start (void) G_GNUC_MALLOC;
532
533GST_API
534GstEvent * gst_event_new_flush_stop (gboolean reset_time) G_GNUC_MALLOC;
535
536GST_API
537void gst_event_parse_flush_stop (GstEvent *event, gboolean *reset_time);
538
539/* Stream collection event */
540
541GST_API
542GstEvent * gst_event_new_stream_collection (GstStreamCollection *collection) G_GNUC_MALLOC;
543
544GST_API
545void gst_event_parse_stream_collection (GstEvent *event, GstStreamCollection **collection);
546
547/* select streams event */
548
549GST_API
550GstEvent * gst_event_new_select_streams (GList *streams);
551
552GST_API
553void gst_event_parse_select_streams (GstEvent *event, GList **streams);
554
555/* stream-group-done event */
556
557GST_API
558GstEvent * gst_event_new_stream_group_done (guint group_id) G_GNUC_MALLOC;
559
560GST_API
561void gst_event_parse_stream_group_done (GstEvent *event, guint *group_id);
562
563/* EOS event */
564
565GST_API
566GstEvent * gst_event_new_eos (void) G_GNUC_MALLOC;
567
568/* GAP event */
569
570GST_API
571GstEvent * gst_event_new_gap (GstClockTime timestamp,
572 GstClockTime duration) G_GNUC_MALLOC;
573GST_API
574void gst_event_parse_gap (GstEvent * event,
575 GstClockTime * timestamp,
576 GstClockTime * duration);
577
578GST_API
579void gst_event_set_gap_flags (GstEvent * event,
580 GstGapFlags flags);
581
582GST_API
583void gst_event_parse_gap_flags (GstEvent * event,
584 GstGapFlags * flags);
585
586/* Caps events */
587
588GST_API
589GstEvent * gst_event_new_caps (GstCaps *caps) G_GNUC_MALLOC;
590
591GST_API
592void gst_event_parse_caps (GstEvent *event, GstCaps **caps);
593
594/* segment event */
595
596GST_API
597GstEvent* gst_event_new_segment (const GstSegment *segment) G_GNUC_MALLOC;
598
599GST_API
600void gst_event_parse_segment (GstEvent *event, const GstSegment **segment);
601
602GST_API
603void gst_event_copy_segment (GstEvent *event, GstSegment *segment);
604
605/* tag event */
606
607GST_API
608GstEvent* gst_event_new_tag (GstTagList *taglist) G_GNUC_MALLOC;
609
610GST_API
611void gst_event_parse_tag (GstEvent *event, GstTagList **taglist);
612
613/* TOC event */
614
615GST_API
616GstEvent* gst_event_new_toc (GstToc *toc, gboolean updated);
617
618GST_API
619void gst_event_parse_toc (GstEvent *event, GstToc **toc, gboolean *updated);
620
621/* Protection event */
622
623GST_API
624GstEvent * gst_event_new_protection (const gchar * system_id, GstBuffer * data, const gchar * origin);
625
626GST_API
627void gst_event_parse_protection (GstEvent * event, const gchar ** system_id,
628 GstBuffer ** data, const gchar ** origin);
629
630/* buffer */
631
632GST_API
633GstEvent * gst_event_new_buffer_size (GstFormat format, gint64 minsize, gint64 maxsize,
634 gboolean async) G_GNUC_MALLOC;
635GST_API
636void gst_event_parse_buffer_size (GstEvent *event, GstFormat *format, gint64 *minsize,
637 gint64 *maxsize, gboolean *async);
638
639/* sink message */
640
641GST_API
642GstEvent* gst_event_new_sink_message (const gchar *name, GstMessage *msg) G_GNUC_MALLOC;
643
644GST_API
645void gst_event_parse_sink_message (GstEvent *event, GstMessage **msg);
646
647/* QOS events */
648
649GST_API
650GstEvent* gst_event_new_qos (GstQOSType type, gdouble proportion,
651 GstClockTimeDiff diff, GstClockTime timestamp) G_GNUC_MALLOC;
652GST_API
653void gst_event_parse_qos (GstEvent *event, GstQOSType *type,
654 gdouble *proportion, GstClockTimeDiff *diff,
655 GstClockTime *timestamp);
656/* seek event */
657
658GST_API
659GstEvent* gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
660 GstSeekType start_type, gint64 start,
661 GstSeekType stop_type, gint64 stop) G_GNUC_MALLOC;
662GST_API
663void gst_event_parse_seek (GstEvent *event, gdouble *rate, GstFormat *format,
664 GstSeekFlags *flags,
665 GstSeekType *start_type, gint64 *start,
666 GstSeekType *stop_type, gint64 *stop);
667
668GST_API
669void gst_event_set_seek_trickmode_interval (GstEvent *event, GstClockTime interval);
670
671GST_API
672void gst_event_parse_seek_trickmode_interval (GstEvent *event, GstClockTime *interval);
673
674/* navigation event */
675
676GST_API
677GstEvent* gst_event_new_navigation (GstStructure *structure) G_GNUC_MALLOC;
678
679/* latency event */
680
681GST_API
682GstEvent* gst_event_new_latency (GstClockTime latency) G_GNUC_MALLOC;
683
684GST_API
685void gst_event_parse_latency (GstEvent *event, GstClockTime *latency);
686
687/* step event */
688
689GST_API
690GstEvent* gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
691 gboolean flush, gboolean intermediate) G_GNUC_MALLOC;
692GST_API
693void gst_event_parse_step (GstEvent *event, GstFormat *format, guint64 *amount,
694 gdouble *rate, gboolean *flush, gboolean *intermediate);
695
696/* renegotiate event */
697
698GST_API
699GstEvent* gst_event_new_reconfigure (void) G_GNUC_MALLOC;
700
701/* TOC select event */
702
703GST_API
704GstEvent* gst_event_new_toc_select (const gchar *uid) G_GNUC_MALLOC;
705
706GST_API
707void gst_event_parse_toc_select (GstEvent *event, gchar **uid);
708
709/* segment-done event */
710
711GST_API
712GstEvent* gst_event_new_segment_done (GstFormat format, gint64 position) G_GNUC_MALLOC;
713
714GST_API
715void gst_event_parse_segment_done (GstEvent *event, GstFormat *format, gint64 *position);
716
717/* instant-rate-change event */
718
719GST_API
720GstEvent * gst_event_new_instant_rate_change (gdouble rate_multiplier, GstSegmentFlags new_flags) G_GNUC_MALLOC;
721
722GST_API
723void gst_event_parse_instant_rate_change (GstEvent *event,
724 gdouble *rate_multiplier, GstSegmentFlags *new_flags);
725
726/* instant-rate-change-sync-time event */
727
728GST_API
729GstEvent * gst_event_new_instant_rate_sync_time (gdouble rate_multiplier,
730 GstClockTime running_time,
731 GstClockTime upstream_running_time) G_GNUC_MALLOC;
732
733GST_API
734void gst_event_parse_instant_rate_sync_time (GstEvent *event,
735 gdouble *rate_multiplier,
736 GstClockTime *running_time,
737 GstClockTime *upstream_running_time);
738
739G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstEvent, gst_event_unref)
740
741G_END_DECLS
742
743#endif /* __GST_EVENT_H__ */
744

source code of include/gstreamer-1.0/gst/gstevent.h