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