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