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 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_MAX_STICKY    16
  61 #define GST_EVENT_STICKY_SHIFT  8
  62 #define GST_EVENT_NUM_SHIFT     (GST_EVENT_STICKY_SHIFT + 4)
  63
  64 /**
  65  * GST_EVENT_MAKE_TYPE:
  66  * @num: the event number to create
  67  * @idx: the index in the sticky array
  68  * @flags: the event flags
  69  *
  70  * when making custom event types, use this macro with the num and
  71  * the given flags
  72  */
  73 #define GST_EVENT_MAKE_TYPE(num,idx,flags) \
  74     (((num) << GST_EVENT_NUM_SHIFT) | ((idx) << GST_EVENT_STICKY_SHIFT) | (flags))
  75
  76 #define FLAG(name) GST_EVENT_TYPE_##name
  77
  78 #define GST_EVENT_STICKY_IDX_TYPE(type)  (((type) >> GST_EVENT_STICKY_SHIFT) & 0xf)
  79 #define GST_EVENT_STICKY_IDX(ev)         GST_EVENT_STICKY_IDX_TYPE(GST_EVENT_TYPE(ev))
  80
  81 /**
  82  * GstEventType:
  83  * @GST_EVENT_UNKNOWN: unknown event.
  84  * @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
  85  *                 from the pipeline and unblock all streaming threads.
  86  * @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
  87  *                 running-time of the pipeline.
  88  * @GST_EVENT_CAPS: #GstCaps event. Notify the pad of a new media type.
  89  * @GST_EVENT_SEGMENT: A new media segment follows in the dataflow. The
  90  *                 segment events contains information for clipping buffers and
  91  *                 converting buffer timestamps to running-time and
  92  *                 stream-time.
  93  * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
  94  * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
  95  *                 used yet.
  96  * @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
  97  *                          send messages that should be emitted in sync with
  98  *                          rendering.
  99  *                          Since: 0.10.26
 100  * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
 101  *                 without a SEGMENT event.
 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  *                     Since: 0.10.12
 112  * @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
 113  *                  execute the step operation. Since: 0.10.24
 114  * @GST_EVENT_RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.
 115  *                         Since: 0.11.0
 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, 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_CAPS                  = GST_EVENT_MAKE_TYPE (5, 1, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 141   GST_EVENT_SEGMENT               = GST_EVENT_MAKE_TYPE (6, 2, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 142   GST_EVENT_TAG                   = GST_EVENT_MAKE_TYPE (7, 3, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
 143   GST_EVENT_BUFFERSIZE            = GST_EVENT_MAKE_TYPE (8, 4, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 144   GST_EVENT_SINK_MESSAGE          = GST_EVENT_MAKE_TYPE (9, 5, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
 145   GST_EVENT_EOS                   = GST_EVENT_MAKE_TYPE (10, 6, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 146
 147   /* upstream events */
 148   GST_EVENT_QOS                   = GST_EVENT_MAKE_TYPE (15, 0, FLAG(UPSTREAM)),
 149   GST_EVENT_SEEK                  = GST_EVENT_MAKE_TYPE (16, 0, FLAG(UPSTREAM)),
 150   GST_EVENT_NAVIGATION            = GST_EVENT_MAKE_TYPE (17, 0, FLAG(UPSTREAM)),
 151   GST_EVENT_LATENCY               = GST_EVENT_MAKE_TYPE (18, 0, FLAG(UPSTREAM)),
 152   GST_EVENT_STEP                  = GST_EVENT_MAKE_TYPE (19, 0, FLAG(UPSTREAM)),
 153   GST_EVENT_RECONFIGURE           = GST_EVENT_MAKE_TYPE (20, 0, FLAG(UPSTREAM)),
 154
 155   /* custom events start here */
 156   GST_EVENT_CUSTOM_UPSTREAM          = GST_EVENT_MAKE_TYPE (32, 0, FLAG(UPSTREAM)),
 157   GST_EVENT_CUSTOM_DOWNSTREAM        = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 158   GST_EVENT_CUSTOM_DOWNSTREAM_OOB    = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM)),
 159   GST_EVENT_CUSTOM_DOWNSTREAM_STICKY = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
 160   GST_EVENT_CUSTOM_BOTH              = GST_EVENT_MAKE_TYPE (32, 0, FLAG(BOTH) | FLAG(SERIALIZED)),
 161   GST_EVENT_CUSTOM_BOTH_OOB          = GST_EVENT_MAKE_TYPE (32, 0, FLAG(BOTH))
 162 } GstEventType;
 163 #undef FLAG
 164
 165 #include <gst/gstminiobject.h>
 166 #include <gst/gstformat.h>
 167 #include <gst/gstobject.h>
 168 #include <gst/gstclock.h>
 169 #include <gst/gststructure.h>
 170 #include <gst/gsttaglist.h>
 171 #include <gst/gstsegment.h>
 172 #include <gst/gstsegment.h>
 173 #include <gst/gstmessage.h>
 174
 175 G_BEGIN_DECLS
 176
 177 extern GType _gst_event_type;
 178
 179 #define GST_TYPE_EVENT                  (_gst_event_type)
 180 #define GST_IS_EVENT(obj)               (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_EVENT))
 181 #define GST_EVENT_CAST(obj)             ((GstEvent *)(obj))
 182 #define GST_EVENT(obj)                  (GST_EVENT_CAST(obj))
 183
 184 /**
 185  * GST_EVENT_TRACE_NAME:
 186  *
 187  * The name used for memory allocation tracing
 188  */
 189 #define GST_EVENT_TRACE_NAME    "GstEvent"
 190
 191 /**
 192  * GST_EVENT_TYPE:
 193  * @event: the event to query
 194  *
 195  * Get the #GstEventType of the event.
 196  */
 197 #define GST_EVENT_TYPE(event)           (GST_EVENT_CAST(event)->type)
 198
 199 /**
 200  * GST_EVENT_TYPE_NAME:
 201  * @event: the event to query
 202  *
 203  * Get a constant string representation of the #GstEventType of the event.
 204  */
 205 #define GST_EVENT_TYPE_NAME(event)      (gst_event_type_get_name(GST_EVENT_TYPE(event)))
 206
 207 /**
 208  * GST_EVENT_TIMESTAMP:
 209  * @event: the event to query
 210  *
 211  * Get the #GstClockTime timestamp of the event. This is the time when the event
 212  * was created.
 213  */
 214 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
 215
 216 /**
 217  * GST_EVENT_SEQNUM:
 218  * @event: the event to query
 219  *
 220  * The sequence number of @event.
 221  */
 222 #define GST_EVENT_SEQNUM(event)         (GST_EVENT_CAST(event)->seqnum)
 223
 224 /**
 225  * GST_EVENT_IS_UPSTREAM:
 226  * @ev: the event to query
 227  *
 228  * Check if an event can travel upstream.
 229  */
 230 #define GST_EVENT_IS_UPSTREAM(ev)       !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
 231 /**
 232  * GST_EVENT_IS_DOWNSTREAM:
 233  * @ev: the event to query
 234  *
 235  * Check if an event can travel downstream.
 236  */
 237 #define GST_EVENT_IS_DOWNSTREAM(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
 238 /**
 239  * GST_EVENT_IS_SERIALIZED:
 240  * @ev: the event to query
 241  *
 242  * Check if an event is serialized with the data stream.
 243  */
 244 #define GST_EVENT_IS_SERIALIZED(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
 245 /**
 246  * GST_EVENT_IS_STICKY:
 247  * @ev: the event to query
 248  *
 249  * Check if an event is sticky on the pads.
 250  */
 251 #define GST_EVENT_IS_STICKY(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
 252
 253 /**
 254  * gst_event_is_writable:
 255  * @ev: a #GstEvent
 256  *
 257  * Tests if you can safely write data into a event's structure or validly
 258  * modify the seqnum and timestamp field.
 259  */
 260 #define         gst_event_is_writable(ev)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (ev))
 261 /**
 262  * gst_event_make_writable:
 263  * @ev: (transfer full): a #GstEvent
 264  *
 265  * Makes a writable event from the given event. If the source event is
 266  * already writable, this will simply return the same event. A copy will
 267  * otherwise be made using gst_event_copy().
 268  *
 269  * Returns: (transfer full): a writable event which may or may not be the
 270  *     same as @ev
 271  */
 272 #define         gst_event_make_writable(ev)   GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
 273 /**
 274  * gst_event_replace:
 275  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
 276  *     to be replaced.
 277  * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
 278  *     replace the event pointed to by @old_event.
 279  *
 280  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
 281  * modification is done atomically (so this is useful for ensuring thread safety
 282  * in some cases), and the reference counts are updated appropriately (the old
 283  * event is unreffed, the new one is reffed).
 284  *
 285  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
 286  *
 287  * Returns: TRUE if @new_event was different from @old_event
 288  */
 289 #ifdef _FOOL_GTK_DOC_
 290 G_INLINE_FUNC gboolean gst_event_replace (GstEvent **old_event, GstEvent *new_event);
 291 #endif
 292
 293 static inline gboolean
 294 gst_event_replace (GstEvent **old_event, GstEvent *new_event)
 295 {
 296   return gst_mini_object_replace ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
 297 }
 298
 299 /**
 300  * gst_event_steal:
 301  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
 302  *     to be stolen.
 303  *
 304  * Atomically replace the #GstEvent pointed to by @old_event with NULL and
 305  * return the original event.
 306  *
 307  * Returns: the #GstEvent that was in @old_event
 308  */
 309 #define         gst_event_steal(old_event) \
 310     GST_EVENT_CAST (gst_mini_object_steal ((GstMiniObject **)(old_event)))
 311 /**
 312  * gst_event_take:
 313  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
 314  *     to be stolen.
 315  * @new_event: (allow-none) (transfer full): pointer to a #GstEvent that will
 316  *     replace the event pointed to by @old_event.
 317  *
 318  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. This
 319  * function is similar to gst_event_replace() except that it takes ownership of
 320  * @new_event.
 321  *
 322  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
 323  *
 324  * Returns: TRUE if @new_event was different from @old_event
 325  */
 326 #define         gst_event_take(old_event,new_event) \
 327     gst_mini_object_take ((GstMiniObject **)(old_event), GST_MINI_OBJECT_CAST (new_event))
 328
 329 /**
 330  * GstQOSType:
 331  * @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when downstream
 332  *    elements are producing data too quickly and the element can't keep up
 333  *    processing the data. Upstream should reduce their processing rate. This
 334  *    type is also used when buffers arrive early or in time.
 335  * @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when downstream
 336  *    elements are producing data too slowly and need to speed up their processing
 337  *    rate.
 338  * @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
 339  *    application enabled throttling to limit the datarate.
 340  *
 341  * The different types of QoS events that can be given to the
 342  * gst_event_new_qos() method.
 343  *
 344  * Since: 0.10.33
 345  */
 346 typedef enum {
 347   GST_QOS_TYPE_OVERFLOW        = 0,
 348   GST_QOS_TYPE_UNDERFLOW       = 1,
 349   GST_QOS_TYPE_THROTTLE        = 2
 350 } GstQOSType;
 351
 352 /**
 353  * GstEvent:
 354  * @mini_object: the parent structure
 355  * @type: the #GstEventType of the event
 356  * @timestamp: the timestamp of the event
 357  * @seqnum: the sequence number of the event
 358  *
 359  * A #GstEvent.
 360  */
 361 struct _GstEvent {
 362   GstMiniObject mini_object;
 363
 364   /*< public >*/ /* with COW */
 365   GstEventType  type;
 366   guint64       timestamp;
 367   guint32       seqnum;
 368 };
 369
 370 const gchar*    gst_event_type_get_name         (GstEventType type);
 371 GQuark          gst_event_type_to_quark         (GstEventType type);
 372 GstEventTypeFlags
 373                 gst_event_type_get_flags        (GstEventType type);
 374
 375
 376 /* refcounting */
 377 /**
 378  * gst_event_ref:
 379  * @event: The event to refcount
 380  *
 381  * Increase the refcount of this event.
 382  *
 383  * Returns: (transfer full): @event (for convenience when doing assignments)
 384  */
 385 #ifdef _FOOL_GTK_DOC_
 386 G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
 387 #endif
 388
 389 static inline GstEvent *
 390 gst_event_ref (GstEvent * event)
 391 {
 392   return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
 393 }
 394
 395 /**
 396  * gst_event_unref:
 397  * @event: (transfer full): the event to refcount
 398  *
 399  * Decrease the refcount of an event, freeing it if the refcount reaches 0.
 400  */
 401 #ifdef _FOOL_GTK_DOC_
 402 G_INLINE_FUNC void gst_event_unref (GstEvent * event);
 403 #endif
 404
 405 static inline void
 406 gst_event_unref (GstEvent * event)
 407 {
 408   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
 409 }
 410
 411 /* copy event */
 412 /**
 413  * gst_event_copy:
 414  * @event: The event to copy
 415  *
 416  * Copy the event using the event specific copy function.
 417  *
 418  * Returns: (transfer full): the new event
 419  */
 420 #ifdef _FOOL_GTK_DOC_
 421 G_INLINE_FUNC GstEvent * gst_event_copy (const GstEvent * event);
 422 #endif
 423
 424 static inline GstEvent *
 425 gst_event_copy (const GstEvent * event)
 426 {
 427   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
 428 }
 429
 430 GType           gst_event_get_type              (void);
 431
 432 /* custom event */
 433 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure) G_GNUC_MALLOC;
 434
 435 const GstStructure *
 436                 gst_event_get_structure         (GstEvent *event);
 437 GstStructure *  gst_event_writable_structure    (GstEvent *event);
 438
 439 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
 440
 441 /* identifiers for events and messages */
 442 guint32         gst_event_get_seqnum            (GstEvent *event);
 443 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
 444
 445 /* flush events */
 446 GstEvent *      gst_event_new_flush_start       (void) G_GNUC_MALLOC;
 447
 448 GstEvent *      gst_event_new_flush_stop        (gboolean reset_time) G_GNUC_MALLOC;
 449 void            gst_event_parse_flush_stop      (GstEvent *event, gboolean *reset_time);
 450
 451 /* EOS event */
 452 GstEvent *      gst_event_new_eos               (void) G_GNUC_MALLOC;
 453
 454 /* Caps events */
 455 GstEvent *      gst_event_new_caps              (GstCaps *caps) G_GNUC_MALLOC;
 456 void            gst_event_parse_caps            (GstEvent *event, GstCaps **caps);
 457
 458 /* segment event */
 459 GstEvent*       gst_event_new_segment           (const GstSegment *segment) G_GNUC_MALLOC;
 460 void            gst_event_parse_segment         (GstEvent *event, const GstSegment **segment);
 461 void            gst_event_copy_segment          (GstEvent *event, GstSegment *segment);
 462
 463 /* tag event */
 464 GstEvent*       gst_event_new_tag               (GstTagList *taglist) G_GNUC_MALLOC;
 465 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
 466
 467 /* buffer */
 468 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
 469                                                  gboolean async) G_GNUC_MALLOC;
 470 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
 471                                                  gint64 *maxsize, gboolean *async);
 472
 473 /* sink message */
 474 GstEvent*       gst_event_new_sink_message      (GstMessage *msg) G_GNUC_MALLOC;
 475 void            gst_event_parse_sink_message    (GstEvent *event, GstMessage **msg);
 476
 477 /* QOS events */
 478 GstEvent*       gst_event_new_qos               (GstQOSType type, gdouble proportion,
 479                                                  GstClockTimeDiff diff, GstClockTime timestamp) G_GNUC_MALLOC;
 480 void            gst_event_parse_qos             (GstEvent *event, GstQOSType *type,
 481                                                  gdouble *proportion, GstClockTimeDiff *diff,
 482                                                  GstClockTime *timestamp);
 483 /* seek event */
 484 GstEvent*       gst_event_new_seek              (gdouble rate, GstFormat format, GstSeekFlags flags,
 485                                                  GstSeekType start_type, gint64 start,
 486                                                  GstSeekType stop_type, gint64 stop) G_GNUC_MALLOC;
 487 void            gst_event_parse_seek            (GstEvent *event, gdouble *rate, GstFormat *format,
 488                                                  GstSeekFlags *flags,
 489                                                  GstSeekType *start_type, gint64 *start,
 490                                                  GstSeekType *stop_type, gint64 *stop);
 491
 492 /* navigation event */
 493 GstEvent*       gst_event_new_navigation        (GstStructure *structure) G_GNUC_MALLOC;
 494
 495 /* latency event */
 496 GstEvent*       gst_event_new_latency           (GstClockTime latency) G_GNUC_MALLOC;
 497 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
 498
 499 /* step event */
 500 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
 501                                                  gboolean flush, gboolean intermediate) G_GNUC_MALLOC;
 502 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
 503                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
 504
 505 /* renegotiate event */
 506 GstEvent*       gst_event_new_reconfigure       (void) G_GNUC_MALLOC;
 507
 508 G_END_DECLS
 509
 510 #endif /* __GST_EVENT_H__ */