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