event: add SELECT and UNSELECT stream flags for stream-start event
[platform/upstream/gstreamer.git] / gst / gstevent.h
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
28 typedef 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  */
44 typedef 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:
54  *
55  * The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.
56  */
57 #define GST_EVENT_TYPE_BOTH \
58     (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_STREAM_START: Event to mark the start of a new stream. Sent before any
83  *                 other serialized event and only sent at the start of a new stream,
84  *                 not after flushing seeks.
85  * @GST_EVENT_CAPS: #GstCaps event. Notify the pad of a new media type.
86  * @GST_EVENT_SEGMENT: A new media segment follows in the dataflow. The
87  *                 segment events contains information for clipping buffers and
88  *                 converting buffer timestamps to running-time and
89  *                 stream-time.
90  * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
91  * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
92  *                 used yet.
93  * @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
94  *                          send messages that should be emitted in sync with
95  *                          rendering.
96  * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
97  *                 without a SEGMENT event.
98  * @GST_EVENT_SEGMENT_DONE: Marks the end of a segment playback.
99  * @GST_EVENT_GAP: Marks a gap in the datastream.
100  * @GST_EVENT_TOC: An event which indicates that a new table of contents (TOC)
101  *                 was found or updated.
102  * @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
103  *                 that the downstream elements should adjust their processing
104  *                 rate.
105  * @GST_EVENT_SEEK: A request for a new playback position and rate.
106  * @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
107  *                        user requests, such as mouse or keyboard movements,
108  *                        to upstream elements.
109  * @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
110  *                     the latency information to adjust their synchronisation.
111  * @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
112  *                  execute the step operation.
113  * @GST_EVENT_RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.
114  * @GST_EVENT_TOC_SELECT: A request for a new playback position based on TOC
115  *                        entry's UID.
116  * @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
117  * @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
118  *                        data flow.
119  * @GST_EVENT_CUSTOM_DOWNSTREAM_OOB: Custom out-of-band downstream event.
120  * @GST_EVENT_CUSTOM_DOWNSTREAM_STICKY: Custom sticky downstream event.
121  * @GST_EVENT_CUSTOM_BOTH: Custom upstream or downstream event.
122  *                         In-band when travelling downstream.
123  * @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.
124  *
125  * #GstEventType lists the standard event types that can be sent in a pipeline.
126  *
127  * The custom event types can be used for private messages between elements
128  * that can't be expressed using normal
129  * GStreamer buffer passing semantics. Custom events carry an arbitrary
130  * #GstStructure.
131  * Specific custom events are distinguished by the name of the structure.
132  */
133 /* NOTE: keep in sync with quark registration in gstevent.c */
134 typedef enum {
135   GST_EVENT_UNKNOWN               = GST_EVENT_MAKE_TYPE (0, 0),
136
137   /* bidirectional events */
138   GST_EVENT_FLUSH_START           = GST_EVENT_MAKE_TYPE (10, FLAG(BOTH)),
139   GST_EVENT_FLUSH_STOP            = GST_EVENT_MAKE_TYPE (20, FLAG(BOTH) | FLAG(SERIALIZED)),
140
141   /* downstream serialized events */
142   GST_EVENT_STREAM_START          = GST_EVENT_MAKE_TYPE (40, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
143   GST_EVENT_CAPS                  = GST_EVENT_MAKE_TYPE (50, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
144   GST_EVENT_SEGMENT               = GST_EVENT_MAKE_TYPE (70, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
145   GST_EVENT_TAG                   = GST_EVENT_MAKE_TYPE (80, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
146   GST_EVENT_BUFFERSIZE            = GST_EVENT_MAKE_TYPE (90, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
147   GST_EVENT_SINK_MESSAGE          = GST_EVENT_MAKE_TYPE (100, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
148   GST_EVENT_EOS                   = GST_EVENT_MAKE_TYPE (110, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
149   GST_EVENT_TOC                   = GST_EVENT_MAKE_TYPE (120, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
150   GST_EVENT_CONTEXT               = GST_EVENT_MAKE_TYPE (130, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
151
152   /* non-sticky downstream serialized */
153   GST_EVENT_SEGMENT_DONE          = GST_EVENT_MAKE_TYPE (150, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
154   GST_EVENT_GAP                   = GST_EVENT_MAKE_TYPE (160, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
155
156   /* upstream events */
157   GST_EVENT_QOS                   = GST_EVENT_MAKE_TYPE (190, FLAG(UPSTREAM)),
158   GST_EVENT_SEEK                  = GST_EVENT_MAKE_TYPE (200, FLAG(UPSTREAM)),
159   GST_EVENT_NAVIGATION            = GST_EVENT_MAKE_TYPE (210, FLAG(UPSTREAM)),
160   GST_EVENT_LATENCY               = GST_EVENT_MAKE_TYPE (220, FLAG(UPSTREAM)),
161   GST_EVENT_STEP                  = GST_EVENT_MAKE_TYPE (230, FLAG(UPSTREAM)),
162   GST_EVENT_RECONFIGURE           = GST_EVENT_MAKE_TYPE (240, FLAG(UPSTREAM)),
163   GST_EVENT_TOC_SELECT            = GST_EVENT_MAKE_TYPE (250, FLAG(UPSTREAM)),
164
165   /* custom events start here */
166   GST_EVENT_CUSTOM_UPSTREAM          = GST_EVENT_MAKE_TYPE (270, FLAG(UPSTREAM)),
167   GST_EVENT_CUSTOM_DOWNSTREAM        = GST_EVENT_MAKE_TYPE (280, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
168   GST_EVENT_CUSTOM_DOWNSTREAM_OOB    = GST_EVENT_MAKE_TYPE (290, FLAG(DOWNSTREAM)),
169   GST_EVENT_CUSTOM_DOWNSTREAM_STICKY = GST_EVENT_MAKE_TYPE (300, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
170   GST_EVENT_CUSTOM_BOTH              = GST_EVENT_MAKE_TYPE (310, FLAG(BOTH) | FLAG(SERIALIZED)),
171   GST_EVENT_CUSTOM_BOTH_OOB          = GST_EVENT_MAKE_TYPE (320, FLAG(BOTH))
172 } GstEventType;
173 #undef FLAG
174
175 #include <gst/gstminiobject.h>
176 #include <gst/gstformat.h>
177 #include <gst/gstobject.h>
178 #include <gst/gstclock.h>
179 #include <gst/gststructure.h>
180 #include <gst/gsttaglist.h>
181 #include <gst/gstsegment.h>
182 #include <gst/gstsegment.h>
183 #include <gst/gstmessage.h>
184 #include <gst/gstcontext.h>
185
186 G_BEGIN_DECLS
187
188 GST_EXPORT GType _gst_event_type;
189
190 #define GST_TYPE_EVENT                  (_gst_event_type)
191 #define GST_IS_EVENT(obj)               (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_EVENT))
192 #define GST_EVENT_CAST(obj)             ((GstEvent *)(obj))
193 #define GST_EVENT(obj)                  (GST_EVENT_CAST(obj))
194
195 /**
196  * GST_EVENT_TYPE:
197  * @event: the event to query
198  *
199  * Get the #GstEventType of the event.
200  */
201 #define GST_EVENT_TYPE(event)           (GST_EVENT_CAST(event)->type)
202
203 /**
204  * GST_EVENT_TYPE_NAME:
205  * @event: the event to query
206  *
207  * Get a constant string representation of the #GstEventType of the event.
208  */
209 #define GST_EVENT_TYPE_NAME(event)      (gst_event_type_get_name(GST_EVENT_TYPE(event)))
210
211 /**
212  * GST_EVENT_TIMESTAMP:
213  * @event: the event to query
214  *
215  * Get the #GstClockTime timestamp of the event. This is the time when the event
216  * was created.
217  */
218 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
219
220 /**
221  * GST_EVENT_SEQNUM:
222  * @event: the event to query
223  *
224  * The sequence number of @event.
225  */
226 #define GST_EVENT_SEQNUM(event)         (GST_EVENT_CAST(event)->seqnum)
227
228 /**
229  * GST_EVENT_IS_UPSTREAM:
230  * @ev: the event to query
231  *
232  * Check if an event can travel upstream.
233  */
234 #define GST_EVENT_IS_UPSTREAM(ev)       !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
235 /**
236  * GST_EVENT_IS_DOWNSTREAM:
237  * @ev: the event to query
238  *
239  * Check if an event can travel downstream.
240  */
241 #define GST_EVENT_IS_DOWNSTREAM(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
242 /**
243  * GST_EVENT_IS_SERIALIZED:
244  * @ev: the event to query
245  *
246  * Check if an event is serialized with the data stream.
247  */
248 #define GST_EVENT_IS_SERIALIZED(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
249 /**
250  * GST_EVENT_IS_STICKY:
251  * @ev: the event to query
252  *
253  * Check if an event is sticky on the pads.
254  */
255 #define GST_EVENT_IS_STICKY(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
256
257 /**
258  * gst_event_is_writable:
259  * @ev: a #GstEvent
260  *
261  * Tests if you can safely write data into a event's structure or validly
262  * modify the seqnum and timestamp field.
263  */
264 #define         gst_event_is_writable(ev)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (ev))
265 /**
266  * gst_event_make_writable:
267  * @ev: (transfer full): a #GstEvent
268  *
269  * Makes a writable event from the given event. If the source event is
270  * already writable, this will simply return the same event. A copy will
271  * otherwise be made using gst_event_copy().
272  *
273  * Returns: (transfer full): a writable event which may or may not be the
274  *     same as @ev
275  */
276 #define         gst_event_make_writable(ev)   GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
277 /**
278  * gst_event_replace:
279  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
280  *     to be replaced.
281  * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
282  *     replace the event pointed to by @old_event.
283  *
284  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
285  * modification is done atomically (so this is useful for ensuring thread safety
286  * in some cases), and the reference counts are updated appropriately (the old
287  * event is unreffed, the new one is reffed).
288  *
289  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
290  *
291  * Returns: TRUE if @new_event was different from @old_event
292  */
293 #ifdef _FOOL_GTK_DOC_
294 G_INLINE_FUNC gboolean gst_event_replace (GstEvent **old_event, GstEvent *new_event);
295 #endif
296
297 static inline gboolean
298 gst_event_replace (GstEvent **old_event, GstEvent *new_event)
299 {
300   return gst_mini_object_replace ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
301 }
302
303 /**
304  * gst_event_steal:
305  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
306  *     to be stolen.
307  *
308  * Atomically replace the #GstEvent pointed to by @old_event with NULL and
309  * return the original event.
310  *
311  * Returns: the #GstEvent that was in @old_event
312  */
313 #ifdef _FOOL_GTK_DOC_
314 G_INLINE_FUNC GstEvent * gst_event_steal (GstEvent **old_event);
315 #endif
316
317 static inline GstEvent *
318 gst_event_steal (GstEvent **old_event)
319 {
320   return GST_EVENT_CAST (gst_mini_object_steal ((GstMiniObject **) old_event));
321 }
322
323 /**
324  * gst_event_take:
325  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
326  *     to be stolen.
327  * @new_event: (allow-none) (transfer full): pointer to a #GstEvent that will
328  *     replace the event pointed to by @old_event.
329  *
330  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. This
331  * function is similar to gst_event_replace() except that it takes ownership of
332  * @new_event.
333  *
334  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
335  *
336  * Returns: TRUE if @new_event was different from @old_event
337  */
338 #ifdef _FOOL_GTK_DOC_
339 G_INLINE_FUNC gboolean gst_event_take (GstEvent **old_event, GstEvent *new_event);
340 #endif
341
342 static inline gboolean
343 gst_event_take (GstEvent **old_event, GstEvent *new_event)
344 {
345   return gst_mini_object_take ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
346 }
347
348 /**
349  * GstQOSType:
350  * @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when downstream
351  *    elements are producing data too quickly and the element can't keep up
352  *    processing the data. Upstream should reduce their processing rate. This
353  *    type is also used when buffers arrive early or in time.
354  * @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when downstream
355  *    elements are producing data too slowly and need to speed up their processing
356  *    rate.
357  * @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
358  *    application enabled throttling to limit the datarate.
359  *
360  * The different types of QoS events that can be given to the
361  * gst_event_new_qos() method.
362  */
363 typedef enum {
364   GST_QOS_TYPE_OVERFLOW        = 0,
365   GST_QOS_TYPE_UNDERFLOW       = 1,
366   GST_QOS_TYPE_THROTTLE        = 2
367 } GstQOSType;
368
369 /**
370  * GstStreamFlags:
371  * @GST_STREAM_FLAG_NONE: This stream has no special attributes
372  * @GST_STREAM_FLAG_SPARSE: This stream is a sparse stream (e.g. a subtitle
373  *    stream), data may flow only in irregular intervals with large gaps in
374  *    between.
375  * @GST_STREAM_FLAG_SELECT: This stream should be selected by default. This
376  *    flag may be used by demuxers to signal that a stream should be selected
377  *    by default in a playback scenario.
378  * @GST_STREAM_FLAG_UNSELECT: This stream should not be selected by default.
379  *    This flag may be used by demuxers to signal that a stream should not
380  *    be selected by default in a playback scenario, but only if explicitly
381  *    selected by the user (e.g. an audio track for the hard of hearing or
382  *    a director's commentary track).
383  *
384  * Since: 1.2
385  */
386 typedef enum {
387   GST_STREAM_FLAG_NONE,
388   GST_STREAM_FLAG_SPARSE       = (1 << 0),
389   GST_STREAM_FLAG_SELECT       = (1 << 1),
390   GST_STREAM_FLAG_UNSELECT     = (1 << 2)
391 } GstStreamFlags;
392
393 /**
394  * GstEvent:
395  * @mini_object: the parent structure
396  * @type: the #GstEventType of the event
397  * @timestamp: the timestamp of the event
398  * @seqnum: the sequence number of the event
399  *
400  * A #GstEvent.
401  */
402 struct _GstEvent {
403   GstMiniObject mini_object;
404
405   /*< public >*/ /* with COW */
406   GstEventType  type;
407   guint64       timestamp;
408   guint32       seqnum;
409 };
410
411 const gchar*    gst_event_type_get_name         (GstEventType type);
412 GQuark          gst_event_type_to_quark         (GstEventType type);
413 GstEventTypeFlags
414                 gst_event_type_get_flags        (GstEventType type);
415
416
417 /* refcounting */
418 /**
419  * gst_event_ref:
420  * @event: The event to refcount
421  *
422  * Increase the refcount of this event.
423  *
424  * Returns: (transfer full): @event (for convenience when doing assignments)
425  */
426 #ifdef _FOOL_GTK_DOC_
427 G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
428 #endif
429
430 static inline GstEvent *
431 gst_event_ref (GstEvent * event)
432 {
433   return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
434 }
435
436 /**
437  * gst_event_unref:
438  * @event: (transfer full): the event to refcount
439  *
440  * Decrease the refcount of an event, freeing it if the refcount reaches 0.
441  */
442 #ifdef _FOOL_GTK_DOC_
443 G_INLINE_FUNC void gst_event_unref (GstEvent * event);
444 #endif
445
446 static inline void
447 gst_event_unref (GstEvent * event)
448 {
449   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
450 }
451
452 /* copy event */
453 /**
454  * gst_event_copy:
455  * @event: The event to copy
456  *
457  * Copy the event using the event specific copy function.
458  *
459  * Returns: (transfer full): the new event
460  */
461 #ifdef _FOOL_GTK_DOC_
462 G_INLINE_FUNC GstEvent * gst_event_copy (const GstEvent * event);
463 #endif
464
465 static inline GstEvent *
466 gst_event_copy (const GstEvent * event)
467 {
468   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
469 }
470
471 GType           gst_event_get_type              (void);
472
473 /* custom event */
474 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure) G_GNUC_MALLOC;
475
476 const GstStructure *
477                 gst_event_get_structure         (GstEvent *event);
478 GstStructure *  gst_event_writable_structure    (GstEvent *event);
479
480 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
481
482 /* identifiers for events and messages */
483 guint32         gst_event_get_seqnum            (GstEvent *event);
484 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
485
486 /* Stream start event */
487 GstEvent *      gst_event_new_stream_start      (const gchar *stream_id) G_GNUC_MALLOC;
488 void            gst_event_parse_stream_start    (GstEvent *event, const gchar **stream_id);
489
490 void            gst_event_set_stream_flags      (GstEvent *event, GstStreamFlags flags);
491 void            gst_event_parse_stream_flags    (GstEvent *event, GstStreamFlags *flags);
492
493 /* flush events */
494 GstEvent *      gst_event_new_flush_start       (void) G_GNUC_MALLOC;
495
496 GstEvent *      gst_event_new_flush_stop        (gboolean reset_time) G_GNUC_MALLOC;
497 void            gst_event_parse_flush_stop      (GstEvent *event, gboolean *reset_time);
498
499 /* EOS event */
500 GstEvent *      gst_event_new_eos               (void) G_GNUC_MALLOC;
501
502 /* GAP event */
503 GstEvent *      gst_event_new_gap               (GstClockTime   timestamp,
504                                                  GstClockTime   duration) G_GNUC_MALLOC;
505
506 void            gst_event_parse_gap             (GstEvent     * event,
507                                                  GstClockTime * timestamp,
508                                                  GstClockTime * duration);
509
510 /* Caps events */
511 GstEvent *      gst_event_new_caps              (GstCaps *caps) G_GNUC_MALLOC;
512 void            gst_event_parse_caps            (GstEvent *event, GstCaps **caps);
513
514 /* segment event */
515 GstEvent*       gst_event_new_segment           (const GstSegment *segment) G_GNUC_MALLOC;
516 void            gst_event_parse_segment         (GstEvent *event, const GstSegment **segment);
517 void            gst_event_copy_segment          (GstEvent *event, GstSegment *segment);
518
519 /* tag event */
520 GstEvent*       gst_event_new_tag               (GstTagList *taglist) G_GNUC_MALLOC;
521 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
522
523 /* TOC event */
524 GstEvent*      gst_event_new_toc                (GstToc *toc, gboolean updated);
525 void           gst_event_parse_toc              (GstEvent *event, GstToc **toc, gboolean *updated);
526
527
528 /* buffer */
529 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
530                                                  gboolean async) G_GNUC_MALLOC;
531 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
532                                                  gint64 *maxsize, gboolean *async);
533
534 /* sink message */
535 GstEvent*       gst_event_new_sink_message      (const gchar *name, GstMessage *msg) G_GNUC_MALLOC;
536 void            gst_event_parse_sink_message    (GstEvent *event, GstMessage **msg);
537
538 /* QOS events */
539 GstEvent*       gst_event_new_qos               (GstQOSType type, gdouble proportion,
540                                                  GstClockTimeDiff diff, GstClockTime timestamp) G_GNUC_MALLOC;
541 void            gst_event_parse_qos             (GstEvent *event, GstQOSType *type,
542                                                  gdouble *proportion, GstClockTimeDiff *diff,
543                                                  GstClockTime *timestamp);
544 /* seek event */
545 GstEvent*       gst_event_new_seek              (gdouble rate, GstFormat format, GstSeekFlags flags,
546                                                  GstSeekType start_type, gint64 start,
547                                                  GstSeekType stop_type, gint64 stop) G_GNUC_MALLOC;
548 void            gst_event_parse_seek            (GstEvent *event, gdouble *rate, GstFormat *format,
549                                                  GstSeekFlags *flags,
550                                                  GstSeekType *start_type, gint64 *start,
551                                                  GstSeekType *stop_type, gint64 *stop);
552
553 /* navigation event */
554 GstEvent*       gst_event_new_navigation        (GstStructure *structure) G_GNUC_MALLOC;
555
556 /* latency event */
557 GstEvent*       gst_event_new_latency           (GstClockTime latency) G_GNUC_MALLOC;
558 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
559
560 /* step event */
561 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
562                                                  gboolean flush, gboolean intermediate) G_GNUC_MALLOC;
563 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
564                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
565
566 /* renegotiate event */
567 GstEvent*       gst_event_new_reconfigure       (void) G_GNUC_MALLOC;
568
569 /* TOC select event */
570 GstEvent*       gst_event_new_toc_select        (const gchar *uid) G_GNUC_MALLOC;
571 void            gst_event_parse_toc_select      (GstEvent *event, gchar **uid);
572
573 /* segment-done event */
574 GstEvent*       gst_event_new_segment_done      (GstFormat format, gint64 position) G_GNUC_MALLOC;
575 void            gst_event_parse_segment_done    (GstEvent *event, GstFormat *format, gint64 *position);
576
577 /* context */
578 GstEvent*       gst_event_new_context           (GstContext * context) G_GNUC_MALLOC;
579 void            gst_event_parse_context         (GstEvent *event, GstContext **context);
580
581 G_END_DECLS
582
583 #endif /* __GST_EVENT_H__ */