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