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 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
 256
 257 /**
 258  * GST_EVENT_SEQNUM:
 259  * @event: the event to query
 260  *
 261  * The sequence number of @event.
 262  */
 263 #define GST_EVENT_SEQNUM(event)         (GST_EVENT_CAST(event)->seqnum)
 264
 265 /**
 266  * GST_EVENT_IS_UPSTREAM:
 267  * @ev: the event to query
 268  *
 269  * Check if an event can travel upstream.
 270  */
 271 #define GST_EVENT_IS_UPSTREAM(ev)       !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
 272 /**
 273  * GST_EVENT_IS_DOWNSTREAM:
 274  * @ev: the event to query
 275  *
 276  * Check if an event can travel downstream.
 277  */
 278 #define GST_EVENT_IS_DOWNSTREAM(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
 279 /**
 280  * GST_EVENT_IS_SERIALIZED:
 281  * @ev: the event to query
 282  *
 283  * Check if an event is serialized with the data stream.
 284  */
 285 #define GST_EVENT_IS_SERIALIZED(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
 286 /**
 287  * GST_EVENT_IS_STICKY:
 288  * @ev: the event to query
 289  *
 290  * Check if an event is sticky on the pads.
 291  */
 292 #define GST_EVENT_IS_STICKY(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
 293
 294 /**
 295  * gst_event_is_writable:
 296  * @ev: a #GstEvent
 297  *
 298  * Tests if you can safely write data into a event's structure or validly
 299  * modify the seqnum and timestamp field.
 300  */
 301 #define         gst_event_is_writable(ev)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (ev))
 302 /**
 303  * gst_event_make_writable:
 304  * @ev: (transfer full): a #GstEvent
 305  *
 306  * Makes a writable event from the given event. If the source event is
 307  * already writable, this will simply return the same event. A copy will
 308  * otherwise be made using gst_event_copy().
 309  *
 310  * Returns: (transfer full): a writable event which may or may not be the
 311  *     same as @ev
 312  */
 313 #define         gst_event_make_writable(ev)   GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
 314 /**
 315  * gst_event_replace:
 316  * @old_event: (inout) (transfer full) (nullable): pointer to a
 317  *     pointer to a #GstEvent to be replaced.
 318  * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
 319  *     replace the event pointed to by @old_event.
 320  *
 321  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
 322  * modification is done atomically (so this is useful for ensuring thread safety
 323  * in some cases), and the reference counts are updated appropriately (the old
 324  * event is unreffed, the new one is reffed).
 325  *
 326  * Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.
 327  *
 328  * Returns: %TRUE if @new_event was different from @old_event
 329  */
 330 static inline gboolean
 331 gst_event_replace (GstEvent **old_event, GstEvent *new_event)
 332 {
 333   return gst_mini_object_replace ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
 334 }
 335
 336 /**
 337  * gst_event_steal:
 338  * @old_event: (inout) (transfer full) (nullable): pointer to a
 339  *     pointer to a #GstEvent to be stolen.
 340  *
 341  * Atomically replace the #GstEvent pointed to by @old_event with %NULL and
 342  * return the original event.
 343  *
 344  * Returns: the #GstEvent that was in @old_event
 345  */
 346 static inline GstEvent *
 347 gst_event_steal (GstEvent **old_event)
 348 {
 349   return GST_EVENT_CAST (gst_mini_object_steal ((GstMiniObject **) old_event));
 350 }
 351
 352 /**
 353  * gst_event_take:
 354  * @old_event: (inout) (transfer full) (nullable): pointer to a
 355  *     pointer to a #GstEvent to be stolen.
 356  * @new_event: (allow-none) (transfer full): pointer to a #GstEvent that will
 357  *     replace the event pointed to by @old_event.
 358  *
 359  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. This
 360  * function is similar to gst_event_replace() except that it takes ownership of
 361  * @new_event.
 362  *
 363  * Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.
 364  *
 365  * Returns: %TRUE if @new_event was different from @old_event
 366  */
 367 static inline gboolean
 368 gst_event_take (GstEvent **old_event, GstEvent *new_event)
 369 {
 370   return gst_mini_object_take ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
 371 }
 372
 373 /**
 374  * GstQOSType:
 375  * @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when upstream
 376  *    elements are producing data too quickly and the element can't keep up
 377  *    processing the data. Upstream should reduce their production rate. This
 378  *    type is also used when buffers arrive early or in time.
 379  * @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when upstream
 380  *    elements are producing data too slowly and need to speed up their
 381  *    production rate.
 382  * @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
 383  *    application enabled throttling to limit the data rate.
 384  *
 385  * The different types of QoS events that can be given to the
 386  * gst_event_new_qos() method.
 387  */
 388 typedef enum {
 389   GST_QOS_TYPE_OVERFLOW        = 0,
 390   GST_QOS_TYPE_UNDERFLOW       = 1,
 391   GST_QOS_TYPE_THROTTLE        = 2
 392 } GstQOSType;
 393
 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 GST_API
 414 const gchar*    gst_event_type_get_name         (GstEventType type);
 415
 416 GST_API
 417 GQuark          gst_event_type_to_quark         (GstEventType type);
 418
 419 GST_API
 420 GstEventTypeFlags
 421                 gst_event_type_get_flags        (GstEventType type);
 422
 423
 424 /* refcounting */
 425 /**
 426  * gst_event_ref:
 427  * @event: The event to refcount
 428  *
 429  * Increase the refcount of this event.
 430  *
 431  * Returns: (transfer full): @event (for convenience when doing assignments)
 432  */
 433 static inline GstEvent *
 434 gst_event_ref (GstEvent * event)
 435 {
 436   return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
 437 }
 438
 439 /**
 440  * gst_event_unref:
 441  * @event: (transfer full): the event to refcount
 442  *
 443  * Decrease the refcount of an event, freeing it if the refcount reaches 0.
 444  */
 445 static inline void
 446 gst_event_unref (GstEvent * event)
 447 {
 448   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
 449 }
 450
 451 /* copy event */
 452 /**
 453  * gst_event_copy:
 454  * @event: The event to copy
 455  *
 456  * Copy the event using the event specific copy function.
 457  *
 458  * Returns: (transfer full): the new event
 459  */
 460 static inline GstEvent *
 461 gst_event_copy (const GstEvent * event)
 462 {
 463   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
 464 }
 465
 466 GST_API
 467 GType           gst_event_get_type              (void);
 468
 469 /* custom event */
 470
 471 GST_API
 472 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure) G_GNUC_MALLOC;
 473
 474 GST_API
 475 const GstStructure *
 476                 gst_event_get_structure         (GstEvent *event);
 477
 478 GST_API
 479 GstStructure *  gst_event_writable_structure    (GstEvent *event);
 480
 481 GST_API
 482 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
 483
 484 /* identifiers for events and messages */
 485
 486 GST_API
 487 guint32         gst_event_get_seqnum            (GstEvent *event);
 488
 489 GST_API
 490 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
 491
 492 /* accumulated pad offsets for the event */
 493
 494 GST_API
 495 gint64          gst_event_get_running_time_offset (GstEvent *event);
 496
 497 GST_API
 498 void            gst_event_set_running_time_offset (GstEvent *event, gint64 offset);
 499
 500 /* Stream start event */
 501
 502 GST_API
 503 GstEvent *      gst_event_new_stream_start      (const gchar *stream_id) G_GNUC_MALLOC;
 504
 505 GST_API
 506 void            gst_event_parse_stream_start    (GstEvent *event, const gchar **stream_id);
 507
 508 GST_API
 509 void            gst_event_set_stream            (GstEvent *event, GstStream *stream);
 510
 511 GST_API
 512 void            gst_event_parse_stream          (GstEvent *event, GstStream **stream);
 513
 514 GST_API
 515 void            gst_event_set_stream_flags      (GstEvent *event, GstStreamFlags flags);
 516
 517 GST_API
 518 void            gst_event_parse_stream_flags    (GstEvent *event, GstStreamFlags *flags);
 519
 520 GST_API
 521 void            gst_event_set_group_id          (GstEvent *event, guint group_id);
 522
 523 GST_API
 524 gboolean        gst_event_parse_group_id        (GstEvent *event, guint *group_id);
 525
 526 /* flush events */
 527
 528 GST_API
 529 GstEvent *      gst_event_new_flush_start       (void) G_GNUC_MALLOC;
 530
 531 GST_API
 532 GstEvent *      gst_event_new_flush_stop        (gboolean reset_time) G_GNUC_MALLOC;
 533
 534 GST_API
 535 void            gst_event_parse_flush_stop      (GstEvent *event, gboolean *reset_time);
 536
 537 /* Stream collection event */
 538
 539 GST_API
 540 GstEvent *      gst_event_new_stream_collection   (GstStreamCollection *collection) G_GNUC_MALLOC;
 541
 542 GST_API
 543 void            gst_event_parse_stream_collection (GstEvent *event, GstStreamCollection **collection);
 544
 545 /* select streams event */
 546
 547 GST_API
 548 GstEvent *      gst_event_new_select_streams    (GList *streams);
 549
 550 GST_API
 551 void            gst_event_parse_select_streams  (GstEvent *event, GList **streams);
 552
 553 /* stream-group-done event */
 554
 555 GST_API
 556 GstEvent *      gst_event_new_stream_group_done (guint group_id) G_GNUC_MALLOC;
 557
 558 GST_API
 559 void            gst_event_parse_stream_group_done (GstEvent *event, guint *group_id);
 560
 561 /* EOS event */
 562
 563 GST_API
 564 GstEvent *      gst_event_new_eos               (void) G_GNUC_MALLOC;
 565
 566 /* GAP event */
 567
 568 GST_API
 569 GstEvent *      gst_event_new_gap               (GstClockTime   timestamp,
 570                                                  GstClockTime   duration) G_GNUC_MALLOC;
 571 GST_API
 572 void            gst_event_parse_gap             (GstEvent     * event,
 573                                                  GstClockTime * timestamp,
 574                                                  GstClockTime * duration);
 575
 576 /* Caps events */
 577
 578 GST_API
 579 GstEvent *      gst_event_new_caps              (GstCaps *caps) G_GNUC_MALLOC;
 580
 581 GST_API
 582 void            gst_event_parse_caps            (GstEvent *event, GstCaps **caps);
 583
 584 /* segment event */
 585
 586 GST_API
 587 GstEvent*       gst_event_new_segment           (const GstSegment *segment) G_GNUC_MALLOC;
 588
 589 GST_API
 590 void            gst_event_parse_segment         (GstEvent *event, const GstSegment **segment);
 591
 592 GST_API
 593 void            gst_event_copy_segment          (GstEvent *event, GstSegment *segment);
 594
 595 /* tag event */
 596
 597 GST_API
 598 GstEvent*       gst_event_new_tag               (GstTagList *taglist) G_GNUC_MALLOC;
 599
 600 GST_API
 601 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
 602
 603 /* TOC event */
 604
 605 GST_API
 606 GstEvent*      gst_event_new_toc                (GstToc *toc, gboolean updated);
 607
 608 GST_API
 609 void           gst_event_parse_toc              (GstEvent *event, GstToc **toc, gboolean *updated);
 610
 611 /* Protection event */
 612
 613 GST_API
 614 GstEvent *     gst_event_new_protection         (const gchar * system_id, GstBuffer * data, const gchar * origin);
 615
 616 GST_API
 617 void           gst_event_parse_protection       (GstEvent * event, const gchar ** system_id,
 618                                                  GstBuffer ** data, const gchar ** origin);
 619
 620 /* buffer */
 621
 622 GST_API
 623 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
 624                                                  gboolean async) G_GNUC_MALLOC;
 625 GST_API
 626 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
 627                                                  gint64 *maxsize, gboolean *async);
 628
 629 /* sink message */
 630
 631 GST_API
 632 GstEvent*       gst_event_new_sink_message      (const gchar *name, GstMessage *msg) G_GNUC_MALLOC;
 633
 634 GST_API
 635 void            gst_event_parse_sink_message    (GstEvent *event, GstMessage **msg);
 636
 637 /* QOS events */
 638
 639 GST_API
 640 GstEvent*       gst_event_new_qos               (GstQOSType type, gdouble proportion,
 641                                                  GstClockTimeDiff diff, GstClockTime timestamp) G_GNUC_MALLOC;
 642 GST_API
 643 void            gst_event_parse_qos             (GstEvent *event, GstQOSType *type,
 644                                                  gdouble *proportion, GstClockTimeDiff *diff,
 645                                                  GstClockTime *timestamp);
 646 /* seek event */
 647
 648 GST_API
 649 GstEvent*       gst_event_new_seek              (gdouble rate, GstFormat format, GstSeekFlags flags,
 650                                                  GstSeekType start_type, gint64 start,
 651                                                  GstSeekType stop_type, gint64 stop) G_GNUC_MALLOC;
 652 GST_API
 653 void            gst_event_parse_seek            (GstEvent *event, gdouble *rate, GstFormat *format,
 654                                                  GstSeekFlags *flags,
 655                                                  GstSeekType *start_type, gint64 *start,
 656                                                  GstSeekType *stop_type, gint64 *stop);
 657
 658 /* navigation event */
 659
 660 GST_API
 661 GstEvent*       gst_event_new_navigation        (GstStructure *structure) G_GNUC_MALLOC;
 662
 663 /* latency event */
 664
 665 GST_API
 666 GstEvent*       gst_event_new_latency           (GstClockTime latency) G_GNUC_MALLOC;
 667
 668 GST_API
 669 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
 670
 671 /* step event */
 672
 673 GST_API
 674 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
 675                                                  gboolean flush, gboolean intermediate) G_GNUC_MALLOC;
 676 GST_API
 677 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
 678                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
 679
 680 /* renegotiate event */
 681
 682 GST_API
 683 GstEvent*       gst_event_new_reconfigure       (void) G_GNUC_MALLOC;
 684
 685 /* TOC select event */
 686
 687 GST_API
 688 GstEvent*       gst_event_new_toc_select        (const gchar *uid) G_GNUC_MALLOC;
 689
 690 GST_API
 691 void            gst_event_parse_toc_select      (GstEvent *event, gchar **uid);
 692
 693 /* segment-done event */
 694
 695 GST_API
 696 GstEvent*       gst_event_new_segment_done      (GstFormat format, gint64 position) G_GNUC_MALLOC;
 697
 698 GST_API
 699 void            gst_event_parse_segment_done    (GstEvent *event, GstFormat *format, gint64 *position);
 700
 701 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 702 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstEvent, gst_event_unref)
 703 #endif
 704
 705 G_END_DECLS
 706
 707 #endif /* __GST_EVENT_H__ */