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