event: add new CAPS 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., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24
25 #ifndef __GST_EVENT_H__
26 #define __GST_EVENT_H__
27
28 #include <gst/gstminiobject.h>
29 #include <gst/gstformat.h>
30 #include <gst/gstobject.h>
31 #include <gst/gstclock.h>
32 #include <gst/gststructure.h>
33 #include <gst/gsttaglist.h>
34
35 G_BEGIN_DECLS
36
37 /**
38  * GstEventTypeFlags:
39  * @GST_EVENT_TYPE_UPSTREAM:   Set if the event can travel upstream.
40  * @GST_EVENT_TYPE_DOWNSTREAM: Set if the event can travel downstream.
41  * @GST_EVENT_TYPE_SERIALIZED: Set if the event should be serialized with data
42  *                             flow.
43  * @GST_EVENT_TYPE_STICKY:     Set if the event is sticky on the pads.
44  *
45  * #GstEventTypeFlags indicate the aspects of the different #GstEventType
46  * values. You can get the type flags of a #GstEventType with the
47  * gst_event_type_get_flags() function.
48  */
49 typedef enum {
50   GST_EVENT_TYPE_UPSTREAM       = 1 << 0,
51   GST_EVENT_TYPE_DOWNSTREAM     = 1 << 1,
52   GST_EVENT_TYPE_SERIALIZED     = 1 << 2,
53   GST_EVENT_TYPE_STICKY         = 1 << 3
54 } GstEventTypeFlags;
55
56 /**
57  * GST_EVENT_TYPE_BOTH:
58  *
59  * The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.
60  */
61 #define GST_EVENT_TYPE_BOTH \
62     (GST_EVENT_TYPE_UPSTREAM | GST_EVENT_TYPE_DOWNSTREAM)
63
64 #define GST_EVENT_MAX_STICKY    16
65 #define GST_EVENT_STICKY_SHIFT  8
66 #define GST_EVENT_NUM_SHIFT     (GST_EVENT_STICKY_SHIFT + 4)
67
68 /**
69  * GST_EVENT_MAKE_TYPE:
70  * @num: the event number to create
71  * @idx: the index in the sticky array
72  * @flags: the event flags
73  *
74  * when making custom event types, use this macro with the num and
75  * the given flags
76  */
77 #define GST_EVENT_MAKE_TYPE(num,idx,flags) \
78     (((num) << GST_EVENT_NUM_SHIFT) | ((idx) << GST_EVENT_STICKY_SHIFT) | (flags))
79
80 #define FLAG(name) GST_EVENT_TYPE_##name
81
82
83 #define GST_EVENT_STICKY_IDX(ev)  ((GST_EVENT_TYPE(ev) >> GST_EVENT_STICKY_SHIFT) & 0xf)
84
85 /**
86  * GstEventType:
87  * @GST_EVENT_UNKNOWN: unknown event.
88  * @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
89  *                 from the pipeline and unblock all streaming threads.
90  * @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
91  *                 running-time of the pipeline.
92  * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
93  *                 without a NEWSEGMENT event.
94  * @GST_EVENT_NEWSEGMENT: A new media segment follows in the dataflow. The
95  *                 segment events contains information for clipping buffers and
96  *                 converting buffer timestamps to running-time and
97  *                 stream-time.
98  * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
99  * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
100  *                 used yet.
101  * @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
102  *                          send messages that should be emitted in sync with
103  *                          rendering.
104  *                          Since: 0.10.26
105  * @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
106  *                 that the downstream elements should adjust their processing
107  *                 rate.
108  * @GST_EVENT_SEEK: A request for a new playback position and rate.
109  * @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
110  *                        user requests, such as mouse or keyboard movements,
111  *                        to upstream elements.
112  * @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
113  *                     the latency information to adjust their synchronisation.
114  *                     Since: 0.10.12
115  * @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
116  *                  execute the step operation. Since: 0.10.24
117  * @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
118  * @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
119  *                        data flow.
120  * @GST_EVENT_CUSTOM_DOWNSTREAM_OOB: Custom out-of-band 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, 0),
136   /* bidirectional events */
137   GST_EVENT_FLUSH_START           = GST_EVENT_MAKE_TYPE (1, 0, FLAG(BOTH)),
138   GST_EVENT_FLUSH_STOP            = GST_EVENT_MAKE_TYPE (2, 0, FLAG(BOTH) | FLAG(SERIALIZED)),
139   /* downstream serialized events */
140   GST_EVENT_EOS                   = GST_EVENT_MAKE_TYPE (5, 0, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
141   GST_EVENT_CAPS                  = GST_EVENT_MAKE_TYPE (6, 5, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
142   GST_EVENT_NEWSEGMENT            = GST_EVENT_MAKE_TYPE (7, 1, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
143   GST_EVENT_TAG                   = GST_EVENT_MAKE_TYPE (8, 2, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
144   GST_EVENT_BUFFERSIZE            = GST_EVENT_MAKE_TYPE (9, 3, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
145   GST_EVENT_SINK_MESSAGE          = GST_EVENT_MAKE_TYPE (10, 4, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
146   /* upstream events */
147   GST_EVENT_QOS                   = GST_EVENT_MAKE_TYPE (15, 0, FLAG(UPSTREAM)),
148   GST_EVENT_SEEK                  = GST_EVENT_MAKE_TYPE (16, 0, FLAG(UPSTREAM)),
149   GST_EVENT_NAVIGATION            = GST_EVENT_MAKE_TYPE (17, 0, FLAG(UPSTREAM)),
150   GST_EVENT_LATENCY               = GST_EVENT_MAKE_TYPE (18, 0, FLAG(UPSTREAM)),
151   GST_EVENT_STEP                  = GST_EVENT_MAKE_TYPE (19, 0, FLAG(UPSTREAM)),
152
153   /* custom events start here */
154   GST_EVENT_CUSTOM_UPSTREAM       = GST_EVENT_MAKE_TYPE (32, 0, FLAG(UPSTREAM)),
155   GST_EVENT_CUSTOM_DOWNSTREAM     = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
156   GST_EVENT_CUSTOM_DOWNSTREAM_OOB = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM)),
157   GST_EVENT_CUSTOM_BOTH           = GST_EVENT_MAKE_TYPE (32, 0, FLAG(BOTH) | FLAG(SERIALIZED)),
158   GST_EVENT_CUSTOM_BOTH_OOB       = GST_EVENT_MAKE_TYPE (32, 0, FLAG(BOTH))
159 } GstEventType;
160 #undef FLAG
161
162 /**
163  * GST_EVENT_TRACE_NAME:
164  *
165  * The name used for memory allocation tracing
166  */
167 #define GST_EVENT_TRACE_NAME    "GstEvent"
168
169 typedef struct _GstEvent GstEvent;
170
171 #define GST_TYPE_EVENT                  (gst_event_get_type())
172 #define GST_IS_EVENT(obj)               (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_EVENT))
173 #define GST_EVENT(obj)                  ((GstEvent *)(obj))
174 #define GST_EVENT_CAST(obj)             ((GstEvent *)(obj))
175
176 /**
177  * GST_EVENT_TYPE:
178  * @event: the event to query
179  *
180  * Get the #GstEventType of the event.
181  */
182 #define GST_EVENT_TYPE(event)           (GST_EVENT_CAST(event)->type)
183
184 /**
185  * GST_EVENT_TYPE_NAME:
186  * @event: the event to query
187  *
188  * Get a constant string representation of the #GstEventType of the event.
189  */
190 #define GST_EVENT_TYPE_NAME(event)      (gst_event_type_get_name(GST_EVENT_TYPE(event)))
191
192 /**
193  * GST_EVENT_TIMESTAMP:
194  * @event: the event to query
195  *
196  * Get the #GstClockTime timestamp of the event. This is the time when the event
197  * was created.
198  */
199 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
200
201 /**
202  * GST_EVENT_SEQNUM:
203  * @event: the event to query
204  *
205  * The sequence number of @event.
206  */
207 #define GST_EVENT_SEQNUM(event)         (GST_EVENT_CAST(event)->seqnum)
208
209 /**
210  * GST_EVENT_IS_UPSTREAM:
211  * @ev: the event to query
212  *
213  * Check if an event can travel upstream.
214  */
215 #define GST_EVENT_IS_UPSTREAM(ev)       !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
216 /**
217  * GST_EVENT_IS_DOWNSTREAM:
218  * @ev: the event to query
219  *
220  * Check if an event can travel downstream.
221  */
222 #define GST_EVENT_IS_DOWNSTREAM(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
223 /**
224  * GST_EVENT_IS_SERIALIZED:
225  * @ev: the event to query
226  *
227  * Check if an event is serialized with the data stream.
228  */
229 #define GST_EVENT_IS_SERIALIZED(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
230 /**
231  * GST_EVENT_IS_STICKY:
232  * @ev: the event to query
233  *
234  * Check if an event is sticky on the pads.
235  */
236 #define GST_EVENT_IS_STICKY(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
237
238 /**
239  * gst_event_replace:
240  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
241  *     to be replaced.
242  * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
243  *     replace the event pointed to by @old_event.
244  *
245  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
246  * modification is done atomically (so this is useful for ensuring thread safety
247  * in some cases), and the reference counts are updated appropriately (the old
248  * event is unreffed, the new one is reffed).
249  *
250  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
251  *
252  * Since: 0.10.3
253  */
254 #define         gst_event_replace(old_event,new_event) \
255     gst_mini_object_replace ((GstMiniObject **)(old_event), GST_MINI_OBJECT_CAST (new_event))
256
257 /**
258  * GstSeekType:
259  * @GST_SEEK_TYPE_NONE: no change in position is required
260  * @GST_SEEK_TYPE_CUR: change relative to currently configured segment. This
261  *    can't be used to seek relative to the current playback position - do a
262  *    position query, calculate the desired position and then do an absolute
263  *    position seek instead if that's what you want to do.
264  * @GST_SEEK_TYPE_SET: absolute position is requested
265  * @GST_SEEK_TYPE_END: relative position to duration is requested
266  *
267  * The different types of seek events. When constructing a seek event with
268  * gst_event_new_seek(), a format, a seek method and optional flags are to
269  * be provided. The seek event is then inserted into the graph with
270  * gst_pad_send_event() or gst_element_send_event().
271  */
272 typedef enum {
273   /* one of these */
274   GST_SEEK_TYPE_NONE            = 0,
275   GST_SEEK_TYPE_CUR             = 1,
276   GST_SEEK_TYPE_SET             = 2,
277   GST_SEEK_TYPE_END             = 3
278 } GstSeekType;
279
280 /**
281  * GstSeekFlags:
282  * @GST_SEEK_FLAG_NONE: no flag
283  * @GST_SEEK_FLAG_FLUSH: flush pipeline
284  * @GST_SEEK_FLAG_ACCURATE: accurate position is requested, this might
285  *                     be considerably slower for some formats.
286  * @GST_SEEK_FLAG_KEY_UNIT: seek to the nearest keyframe. This might be
287  *                     faster but less accurate.
288  * @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
289  * @GST_SEEK_FLAG_SKIP: when doing fast foward or fast reverse playback, allow
290  *                     elements to skip frames instead of generating all
291  *                     frames. Since 0.10.22.
292  *
293  * Flags to be used with gst_element_seek() or gst_event_new_seek(). All flags
294  * can be used together.
295  *
296  * A non flushing seek might take some time to perform as the currently
297  * playing data in the pipeline will not be cleared.
298  *
299  * An accurate seek might be slower for formats that don't have any indexes
300  * or timestamp markers in the stream. Specifying this flag might require a
301  * complete scan of the file in those cases.
302  *
303  * When performing a segment seek: after the playback of the segment completes,
304  * no EOS will be emmited by the element that performed the seek, but a
305  * #GST_MESSAGE_SEGMENT_DONE message will be posted on the bus by the element.
306  * When this message is posted, it is possible to send a new seek event to
307  * continue playback. With this seek method it is possible to perform seemless
308  * looping or simple linear editing.
309  *
310  * When doing fast forward (rate > 1.0) or fast reverse (rate < -1.0) trickmode
311  * playback, the @GST_SEEK_FLAG_SKIP flag can be used to instruct decoders
312  * and demuxers to adjust the playback rate by skipping frames. This can improve
313  * performance and decrease CPU usage because not all frames need to be decoded.
314  *
315  * Also see part-seeking.txt in the GStreamer design documentation for more
316  * details on the meaning of these flags and the behaviour expected of
317  * elements that handle them.
318  */
319 typedef enum {
320   GST_SEEK_FLAG_NONE            = 0,
321   GST_SEEK_FLAG_FLUSH           = (1 << 0),
322   GST_SEEK_FLAG_ACCURATE        = (1 << 1),
323   GST_SEEK_FLAG_KEY_UNIT        = (1 << 2),
324   GST_SEEK_FLAG_SEGMENT         = (1 << 3),
325   GST_SEEK_FLAG_SKIP            = (1 << 4)
326 } GstSeekFlags;
327
328 /**
329  * GstQOSType:
330  * @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when downstream
331  *    elements are producing data too quickly and the element can't keep up
332  *    processing the data. Upstream should reduce their processing rate. This
333  *    type is also used when buffers arrive early or in time.
334  * @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when downstream
335  *    elements are producing data too slowly and need to speed up their processing
336  *    rate. 
337  * @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
338  *    application enabled throttling to limit the datarate.
339  *
340  * The different types of QoS events that can be given to the 
341  * gst_event_new_qos_full() method. 
342  *
343  * Since: 0.10.33
344  */
345 typedef enum {
346   GST_QOS_TYPE_OVERFLOW        = 0,
347   GST_QOS_TYPE_UNDERFLOW       = 1,
348   GST_QOS_TYPE_THROTTLE        = 2
349 } GstQOSType;
350
351 /**
352  * GstEvent:
353  * @mini_object: the parent structure
354  * @type: the #GstEventType of the event
355  * @timestamp: the timestamp of the event
356  * @structure: the #GstStructure containing the event info.
357  *
358  * A #GstEvent.
359  */
360 struct _GstEvent {
361   GstMiniObject mini_object;
362
363   /*< public >*/ /* with COW */
364   GstEventType  type;
365   guint64       timestamp;
366   guint32       seqnum;
367
368   GstStructure  *structure;
369
370   /*< private >*/
371   gpointer _gst_reserved[GST_PADDING];
372 };
373
374 const gchar*    gst_event_type_get_name         (GstEventType type);
375 GQuark          gst_event_type_to_quark         (GstEventType type);
376 GstEventTypeFlags
377                 gst_event_type_get_flags        (GstEventType type);
378
379
380 GType           gst_event_get_type              (void);
381
382 /* refcounting */
383 /**
384  * gst_event_ref:
385  * @event: The event to refcount
386  *
387  * Increase the refcount of this event.
388  *
389  * Returns: (transfer full): @event (for convenience when doing assignments)
390  */
391 #ifdef _FOOL_GTK_DOC_
392 G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
393 #endif
394
395 static inline GstEvent *
396 gst_event_ref (GstEvent * event)
397 {
398   return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
399 }
400
401 /**
402  * gst_event_unref:
403  * @event: (transfer full): the event to refcount
404  *
405  * Decrease the refcount of an event, freeing it if the refcount reaches 0.
406  */
407 #ifdef _FOOL_GTK_DOC_
408 G_INLINE_FUNC void gst_event_unref (GstEvent * event);
409 #endif
410
411 static inline void
412 gst_event_unref (GstEvent * event)
413 {
414   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
415 }
416
417 /* copy event */
418 /**
419  * gst_event_copy:
420  * @event: The event to copy
421  *
422  * Copy the event using the event specific copy function.
423  *
424  * Returns: (transfer full): the new event
425  */
426 #ifdef _FOOL_GTK_DOC_
427 G_INLINE_FUNC GstEvent * gst_event_copy (const GstEvent * event);
428 #endif
429
430 static inline GstEvent *
431 gst_event_copy (const GstEvent * event)
432 {
433   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
434 }
435
436
437 /* custom event */
438 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure);
439
440 const GstStructure *
441                 gst_event_get_structure         (GstEvent *event);
442
443 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
444
445 /* identifiers for events and messages */
446 guint32         gst_event_get_seqnum            (GstEvent *event);
447 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
448
449 /* flush events */
450 GstEvent *      gst_event_new_flush_start       (void);
451 GstEvent *      gst_event_new_flush_stop        (void);
452
453 /* EOS event */
454 GstEvent *      gst_event_new_eos               (void);
455
456 /* Caps events */
457 GstEvent *      gst_event_new_caps              (GstCaps *caps);
458 void            gst_event_parse_caps            (GstEvent *event, GstCaps **caps);
459
460 /* newsegment events */
461 GstEvent*       gst_event_new_new_segment       (gboolean update, gdouble rate,
462                                                  GstFormat format,
463                                                  gint64 start, gint64 stop,
464                                                  gint64 time);
465 GstEvent*       gst_event_new_new_segment_full  (gboolean update, gdouble rate,
466                                                  gdouble applied_rate,
467                                                  GstFormat format,
468                                                  gint64 start, gint64 stop,
469                                                  gint64 time);
470 void            gst_event_parse_new_segment     (GstEvent *event,
471                                                  gboolean *update,
472                                                  gdouble *rate,
473                                                  GstFormat *format,
474                                                  gint64 *start, gint64 *stop,
475                                                  gint64 *time);
476 void            gst_event_parse_new_segment_full (GstEvent *event,
477                                                  gboolean *update,
478                                                  gdouble *rate,
479                                                  gdouble *applied_rate,
480                                                  GstFormat *format,
481                                                  gint64 *start, gint64 *stop,
482                                                  gint64 *time);
483
484 /* tag event */
485 GstEvent*       gst_event_new_tag               (GstTagList *taglist);
486 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
487
488 /* buffer */
489 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
490                                                  gboolean async);
491 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
492                                                  gint64 *maxsize, gboolean *async);
493
494 /* QOS events */
495 GstEvent*       gst_event_new_qos               (gdouble proportion, GstClockTimeDiff diff,
496                                                  GstClockTime timestamp);
497 GstEvent*       gst_event_new_qos_full          (GstQOSType type, gdouble proportion,
498                                                  GstClockTimeDiff diff, GstClockTime timestamp);
499 void            gst_event_parse_qos             (GstEvent *event, gdouble *proportion, GstClockTimeDiff *diff,
500                                                  GstClockTime *timestamp);
501 void            gst_event_parse_qos_full        (GstEvent *event, GstQOSType *type,
502                                                  gdouble *proportion, GstClockTimeDiff *diff,
503                                                  GstClockTime *timestamp);
504 /* seek event */
505 GstEvent*       gst_event_new_seek              (gdouble rate, GstFormat format, GstSeekFlags flags,
506                                                  GstSeekType start_type, gint64 start,
507                                                  GstSeekType stop_type, gint64 stop);
508 void            gst_event_parse_seek            (GstEvent *event, gdouble *rate, GstFormat *format,
509                                                  GstSeekFlags *flags,
510                                                  GstSeekType *start_type, gint64 *start,
511                                                  GstSeekType *stop_type, gint64 *stop);
512 /* navigation event */
513 GstEvent*       gst_event_new_navigation        (GstStructure *structure);
514
515 /* latency event */
516 GstEvent*       gst_event_new_latency           (GstClockTime latency);
517 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
518
519 /* step event */
520 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
521                                                  gboolean flush, gboolean intermediate);
522 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
523                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
524
525 G_END_DECLS
526
527 #endif /* __GST_EVENT_H__ */