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