gst/gstevent.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstevent.h: Header for GstEvent subsystem
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24
  25 #ifndef __GST_EVENT_H__
  26 #define __GST_EVENT_H__
  27
  28 #include <gst/gstminiobject.h>
  29 #include <gst/gstformat.h>
  30 #include <gst/gstobject.h>
  31 #include <gst/gstclock.h>
  32 #include <gst/gststructure.h>
  33 #include <gst/gsttaglist.h>
  34
  35 G_BEGIN_DECLS
  36
  37 /**
  38  * GstEventTypeFlags:
  39  * @GST_EVENT_TYPE_UPSTREAM:   Set if the event can travel upstream.
  40  * @GST_EVENT_TYPE_DOWNSTREAM: Set if the event can travel downstream.
  41  * @GST_EVENT_TYPE_SERIALIZED: Set if the event should be serialized with data
  42  *                             flow.
  43  *
  44  * #GstEventTypeFlags indicate the aspects of the different #GstEventType
  45  * values. You can get the type flags of a #GstEventType with the
  46  * gst_event_type_get_flags() function.
  47  */
  48 typedef enum {
  49   GST_EVENT_TYPE_UPSTREAM       = 1 << 0,
  50   GST_EVENT_TYPE_DOWNSTREAM     = 1 << 1,
  51   GST_EVENT_TYPE_SERIALIZED     = 1 << 2
  52 } GstEventTypeFlags;
  53
  54 /**
  55  * GST_EVENT_TYPE_BOTH:
  56  *
  57  * The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.
  58  */
  59 #define GST_EVENT_TYPE_BOTH \
  60     (GST_EVENT_TYPE_UPSTREAM | GST_EVENT_TYPE_DOWNSTREAM)
  61
  62 #define GST_EVENT_TYPE_SHIFT    4
  63
  64 /**
  65  * GST_EVENT_MAKE_TYPE:
  66  * @num: the event number to create
  67  * @flags: the event flags
  68  *
  69  * when making custom event types, use this macro with the num and
  70  * the given flags
  71  */
  72 #define GST_EVENT_MAKE_TYPE(num,flags) \
  73     (((num) << GST_EVENT_TYPE_SHIFT) | (flags))
  74
  75 #define FLAG(name) GST_EVENT_TYPE_##name
  76
  77 /**
  78  * GstEventType:
  79  * @GST_EVENT_UNKNOWN: unknown event.
  80  * @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
  81  *                 from the pipeline and unblock all streaming threads.
  82  * @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
  83  *                 running-time of the pipeline.
  84  * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
  85  *                 without a NEWSEGMENT event.
  86  * @GST_EVENT_NEWSEGMENT: 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_QOS: A quality message. Used to indicate to upstream elements
  97  *                 that the downstream elements are being starved of or
  98  *                 flooded with data.
  99  * @GST_EVENT_SEEK: A request for a new playback position and rate.
 100  * @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
 101  *                        user requests, such as mouse or keyboard movements,
 102  *                        to upstream elements.
 103  * @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
 104  *                     the latency information to adjust their synchronisation.
 105  *                     Since: 0.10.12
 106  * @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
 107  *                  execute the step operation. Since: 0.10.24
 108  * @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
 109  * @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
 110  *                        data flow.
 111  * @GST_EVENT_CUSTOM_DOWNSTREAM_OOB: Custom out-of-band downstream event.
 112  * @GST_EVENT_CUSTOM_BOTH: Custom upstream or downstream event.
 113  *                         In-band when travelling downstream.
 114  * @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.
 115  *
 116  * #GstEventType lists the standard event types that can be sent in a pipeline.
 117  *
 118  * The custom event types can be used for private messages between elements
 119  * that can't be expressed using normal
 120  * GStreamer buffer passing semantics. Custom events carry an arbitrary
 121  * #GstStructure.
 122  * Specific custom events are distinguished by the name of the structure.
 123  */
 124 /* NOTE: keep in sync with quark registration in gstevent.c */
 125 typedef enum {
 126   GST_EVENT_UNKNOWN               = GST_EVENT_MAKE_TYPE (0, 0),
 127   /* bidirectional events */
 128   GST_EVENT_FLUSH_START           = GST_EVENT_MAKE_TYPE (1, FLAG(BOTH)),
 129   GST_EVENT_FLUSH_STOP            = GST_EVENT_MAKE_TYPE (2, FLAG(BOTH) | FLAG(SERIALIZED)),
 130   /* downstream serialized events */
 131   GST_EVENT_EOS                   = GST_EVENT_MAKE_TYPE (5, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 132   GST_EVENT_NEWSEGMENT            = GST_EVENT_MAKE_TYPE (6, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 133   GST_EVENT_TAG                   = GST_EVENT_MAKE_TYPE (7, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 134   GST_EVENT_BUFFERSIZE            = GST_EVENT_MAKE_TYPE (8, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 135   GST_EVENT_SINK_MESSAGE          = GST_EVENT_MAKE_TYPE (9, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 136   /* upstream events */
 137   GST_EVENT_QOS                   = GST_EVENT_MAKE_TYPE (15, FLAG(UPSTREAM)),
 138   GST_EVENT_SEEK                  = GST_EVENT_MAKE_TYPE (16, FLAG(UPSTREAM)),
 139   GST_EVENT_NAVIGATION            = GST_EVENT_MAKE_TYPE (17, FLAG(UPSTREAM)),
 140   GST_EVENT_LATENCY               = GST_EVENT_MAKE_TYPE (18, FLAG(UPSTREAM)),
 141   GST_EVENT_STEP                  = GST_EVENT_MAKE_TYPE (19, FLAG(UPSTREAM)),
 142
 143   /* custom events start here */
 144   GST_EVENT_CUSTOM_UPSTREAM       = GST_EVENT_MAKE_TYPE (32, FLAG(UPSTREAM)),
 145   GST_EVENT_CUSTOM_DOWNSTREAM     = GST_EVENT_MAKE_TYPE (32, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 146   GST_EVENT_CUSTOM_DOWNSTREAM_OOB = GST_EVENT_MAKE_TYPE (32, FLAG(DOWNSTREAM)),
 147   GST_EVENT_CUSTOM_BOTH           = GST_EVENT_MAKE_TYPE (32, FLAG(BOTH) | FLAG(SERIALIZED)),
 148   GST_EVENT_CUSTOM_BOTH_OOB       = GST_EVENT_MAKE_TYPE (32, FLAG(BOTH))
 149 } GstEventType;
 150 #undef FLAG
 151
 152 /**
 153  * GST_EVENT_TRACE_NAME:
 154  *
 155  * The name used for memory allocation tracing
 156  */
 157 #define GST_EVENT_TRACE_NAME    "GstEvent"
 158
 159 typedef struct _GstEvent GstEvent;
 160 typedef struct _GstEventClass GstEventClass;
 161
 162 #define GST_TYPE_EVENT                  (gst_event_get_type())
 163 #define GST_IS_EVENT(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_EVENT))
 164 #define GST_IS_EVENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_EVENT))
 165 #define GST_EVENT_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_EVENT, GstEventClass))
 166 #define GST_EVENT(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_EVENT, GstEvent))
 167 #define GST_EVENT_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_EVENT, GstEventClass))
 168 #define GST_EVENT_CAST(obj)             ((GstEvent *)(obj))
 169
 170 /**
 171  * GST_EVENT_TYPE:
 172  * @event: the event to query
 173  *
 174  * Get the #GstEventType of the event.
 175  */
 176 #define GST_EVENT_TYPE(event)           (GST_EVENT_CAST(event)->type)
 177
 178 /**
 179  * GST_EVENT_TYPE_NAME:
 180  * @event: the event to query
 181  *
 182  * Get a constant string representation of the #GstEventType of the event.
 183  */
 184 #define GST_EVENT_TYPE_NAME(event)      (gst_event_type_get_name(GST_EVENT_TYPE(event)))
 185
 186 /**
 187  * GST_EVENT_TIMESTAMP:
 188  * @event: the event to query
 189  *
 190  * Get the #GstClockTime timestamp of the event. This is the time when the event
 191  * was created.
 192  */
 193 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
 194
 195 /**
 196  * GST_EVENT_SRC:
 197  * @event: the event to query
 198  *
 199  * The source #GstObject that generated this event.
 200  */
 201 #define GST_EVENT_SRC(event)            (GST_EVENT_CAST(event)->src)
 202
 203 /**
 204  * GST_EVENT_IS_UPSTREAM:
 205  * @ev: the event to query
 206  *
 207  * Check if an event can travel upstream.
 208  */
 209 #define GST_EVENT_IS_UPSTREAM(ev)       !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
 210 /**
 211  * GST_EVENT_IS_DOWNSTREAM:
 212  * @ev: the event to query
 213  *
 214  * Check if an event can travel downstream.
 215  */
 216 #define GST_EVENT_IS_DOWNSTREAM(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
 217 /**
 218  * GST_EVENT_IS_SERIALIZED:
 219  * @ev: the event to query
 220  *
 221  * Check if an event is serialized with the data stream.
 222  */
 223 #define GST_EVENT_IS_SERIALIZED(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
 224
 225 /**
 226  * gst_event_replace:
 227  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
 228  *     to be replaced.
 229  * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
 230  *     replace the event pointed to by @old_event.
 231  *
 232  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
 233  * modification is done atomically (so this is useful for ensuring thread safety
 234  * in some cases), and the reference counts are updated appropriately (the old
 235  * event is unreffed, the new one is reffed).
 236  *
 237  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
 238  *
 239  * Since: 0.10.3
 240  */
 241 #define         gst_event_replace(old_event,new_event) \
 242     gst_mini_object_replace ((GstMiniObject **)(old_event), GST_MINI_OBJECT_CAST (new_event))
 243
 244 /**
 245  * GstSeekType:
 246  * @GST_SEEK_TYPE_NONE: no change in position is required
 247  * @GST_SEEK_TYPE_CUR: change relative to currently configured segment. This
 248  *    can't be used to seek relative to the current playback position - do a
 249  *    position query, calculate the desired position and then do an absolute
 250  *    position seek instead if that's what you want to do.
 251  * @GST_SEEK_TYPE_SET: absolute position is requested
 252  * @GST_SEEK_TYPE_END: relative position to duration is requested
 253  *
 254  * The different types of seek events. When constructing a seek event with
 255  * gst_event_new_seek(), a format, a seek method and optional flags are to
 256  * be provided. The seek event is then inserted into the graph with
 257  * gst_pad_send_event() or gst_element_send_event().
 258  */
 259 typedef enum {
 260   /* one of these */
 261   GST_SEEK_TYPE_NONE            = 0,
 262   GST_SEEK_TYPE_CUR             = 1,
 263   GST_SEEK_TYPE_SET             = 2,
 264   GST_SEEK_TYPE_END             = 3
 265 } GstSeekType;
 266
 267 /**
 268  * GstSeekFlags:
 269  * @GST_SEEK_FLAG_NONE: no flag
 270  * @GST_SEEK_FLAG_FLUSH: flush pipeline
 271  * @GST_SEEK_FLAG_ACCURATE: accurate position is requested, this might
 272  *                     be considerably slower for some formats.
 273  * @GST_SEEK_FLAG_KEY_UNIT: seek to the nearest keyframe. This might be
 274  *                     faster but less accurate.
 275  * @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
 276  * @GST_SEEK_FLAG_SKIP: when doing fast foward or fast reverse playback, allow
 277  *                     elements to skip frames instead of generating all
 278  *                     frames. Since 0.10.22.
 279  *
 280  * Flags to be used with gst_element_seek() or gst_event_new_seek(). All flags
 281  * can be used together.
 282  *
 283  * A non flushing seek might take some time to perform as the currently
 284  * playing data in the pipeline will not be cleared.
 285  *
 286  * An accurate seek might be slower for formats that don't have any indexes
 287  * or timestamp markers in the stream. Specifying this flag might require a
 288  * complete scan of the file in those cases.
 289  *
 290  * When performing a segment seek: after the playback of the segment completes,
 291  * no EOS will be emmited by the element that performed the seek, but a
 292  * #GST_MESSAGE_SEGMENT_DONE message will be posted on the bus by the element.
 293  * When this message is posted, it is possible to send a new seek event to
 294  * continue playback. With this seek method it is possible to perform seemless
 295  * looping or simple linear editing.
 296  *
 297  * When doing fast forward (rate > 1.0) or fast reverse (rate < -1.0) trickmode
 298  * playback, the @GST_SEEK_FLAG_SKIP flag can be used to instruct decoders
 299  * and demuxers to adjust the playback rate by skipping frames. This can improve
 300  * performance and decrease CPU usage because not all frames need to be decoded.
 301  */
 302 typedef enum {
 303   GST_SEEK_FLAG_NONE            = 0,
 304   GST_SEEK_FLAG_FLUSH           = (1 << 0),
 305   GST_SEEK_FLAG_ACCURATE        = (1 << 1),
 306   GST_SEEK_FLAG_KEY_UNIT        = (1 << 2),
 307   GST_SEEK_FLAG_SEGMENT         = (1 << 3),
 308   GST_SEEK_FLAG_SKIP            = (1 << 4)
 309 } GstSeekFlags;
 310
 311 /**
 312  * GstEvent:
 313  * @mini_object: the parent structure
 314  * @type: the #GstEventType of the event
 315  * @timestamp: the timestamp of the event
 316  * @src: the src of the event
 317  * @structure: the #GstStructure containing the event info.
 318  *
 319  * A #GstEvent.
 320  */
 321 struct _GstEvent {
 322   GstMiniObject mini_object;
 323
 324   /*< public >*/ /* with COW */
 325   GstEventType  type;
 326   guint64       timestamp;
 327   GstObject     *src;
 328
 329   GstStructure  *structure;
 330
 331   /*< private >*/
 332   union {
 333     guint32 seqnum;
 334     gpointer _gst_reserved;
 335   } abidata;
 336 };
 337
 338 struct _GstEventClass {
 339   GstMiniObjectClass mini_object_class;
 340
 341   /*< private >*/
 342   gpointer _gst_reserved[GST_PADDING];
 343 };
 344
 345 const gchar*    gst_event_type_get_name         (GstEventType type);
 346 GQuark          gst_event_type_to_quark         (GstEventType type);
 347 GstEventTypeFlags
 348                 gst_event_type_get_flags        (GstEventType type);
 349
 350
 351 GType           gst_event_get_type              (void);
 352
 353 /* refcounting */
 354 /**
 355  * gst_event_ref:
 356  * @event: The event to refcount
 357  *
 358  * Increase the refcount of this event.
 359  *
 360  * Returns: (transfer full): @event (for convenience when doing assignments)
 361  */
 362 #ifdef _FOOL_GTK_DOC_
 363 G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
 364 #endif
 365
 366 static inline GstEvent *
 367 gst_event_ref (GstEvent * event)
 368 {
 369   return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
 370 }
 371
 372 /**
 373  * gst_event_unref:
 374  * @event: (transfer full): the event to refcount
 375  *
 376  * Decrease the refcount of an event, freeing it if the refcount reaches 0.
 377  */
 378 #ifdef _FOOL_GTK_DOC_
 379 G_INLINE_FUNC void gst_event_unref (GstEvent * event);
 380 #endif
 381
 382 static inline void
 383 gst_event_unref (GstEvent * event)
 384 {
 385   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
 386 }
 387
 388 /* copy event */
 389 /**
 390  * gst_event_copy:
 391  * @event: The event to copy
 392  *
 393  * Copy the event using the event specific copy function.
 394  *
 395  * Returns: (transfer full): the new event
 396  */
 397 #ifdef _FOOL_GTK_DOC_
 398 G_INLINE_FUNC GstEvent * gst_event_copy (const GstEvent * event);
 399 #endif
 400
 401 static inline GstEvent *
 402 gst_event_copy (const GstEvent * event)
 403 {
 404   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
 405 }
 406
 407
 408 /* custom event */
 409 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure);
 410
 411 const GstStructure *
 412                 gst_event_get_structure         (GstEvent *event);
 413
 414 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
 415
 416 /* identifiers for events and messages */
 417 guint32         gst_event_get_seqnum            (GstEvent *event);
 418 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
 419
 420 /* flush events */
 421 GstEvent *      gst_event_new_flush_start       (void);
 422 GstEvent *      gst_event_new_flush_stop        (void);
 423
 424 /* EOS event */
 425 GstEvent *      gst_event_new_eos               (void);
 426
 427 /* newsegment events */
 428 GstEvent*       gst_event_new_new_segment       (gboolean update, gdouble rate,
 429                                                  GstFormat format,
 430                                                  gint64 start, gint64 stop,
 431                                                  gint64 position);
 432 GstEvent*       gst_event_new_new_segment_full  (gboolean update, gdouble rate,
 433                                                  gdouble applied_rate,
 434                                                  GstFormat format,
 435                                                  gint64 start, gint64 stop,
 436                                                  gint64 position);
 437 void            gst_event_parse_new_segment     (GstEvent *event,
 438                                                  gboolean *update,
 439                                                  gdouble *rate,
 440                                                  GstFormat *format,
 441                                                  gint64 *start, gint64 *stop,
 442                                                  gint64 *position);
 443 void            gst_event_parse_new_segment_full (GstEvent *event,
 444                                                  gboolean *update,
 445                                                  gdouble *rate,
 446                                                  gdouble *applied_rate,
 447                                                  GstFormat *format,
 448                                                  gint64 *start, gint64 *stop,
 449                                                  gint64 *position);
 450
 451 /* tag event */
 452 GstEvent*       gst_event_new_tag               (GstTagList *taglist);
 453 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
 454
 455 /* buffer */
 456 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
 457                                                  gboolean async);
 458 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
 459                                                  gint64 *maxsize, gboolean *async);
 460
 461 /* QOS events */
 462 GstEvent*       gst_event_new_qos               (gdouble proportion, GstClockTimeDiff diff,
 463                                                  GstClockTime timestamp);
 464 void            gst_event_parse_qos             (GstEvent *event, gdouble *proportion, GstClockTimeDiff *diff,
 465                                                  GstClockTime *timestamp);
 466 /* seek event */
 467 GstEvent*       gst_event_new_seek              (gdouble rate, GstFormat format, GstSeekFlags flags,
 468                                                  GstSeekType start_type, gint64 start,
 469                                                  GstSeekType stop_type, gint64 stop);
 470 void            gst_event_parse_seek            (GstEvent *event, gdouble *rate, GstFormat *format,
 471                                                  GstSeekFlags *flags,
 472                                                  GstSeekType *start_type, gint64 *start,
 473                                                  GstSeekType *stop_type, gint64 *stop);
 474 /* navigation event */
 475 GstEvent*       gst_event_new_navigation        (GstStructure *structure);
 476
 477 /* latency event */
 478 GstEvent*       gst_event_new_latency           (GstClockTime latency);
 479 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
 480
 481 /* step event */
 482 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
 483                                                  gboolean flush, gboolean intermediate);
 484 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
 485                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
 486
 487 G_END_DECLS
 488
 489 #endif /* __GST_EVENT_H__ */