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 typedef struct _GstEvent GstEvent;
  29
  30 #include <gst/gstminiobject.h>
  31 #include <gst/gstformat.h>
  32 #include <gst/gstobject.h>
  33 #include <gst/gstclock.h>
  34 #include <gst/gststructure.h>
  35 #include <gst/gsttaglist.h>
  36 #include <gst/gstsegment.h>
  37 #include <gst/gstsegment.h>
  38 #include <gst/gstmessage.h>
  39
  40 G_BEGIN_DECLS
  41
  42 extern GType _gst_event_type;
  43
  44
  45 #define GST_TYPE_EVENT                  (_gst_event_type)
  46 #define GST_IS_EVENT(obj)               (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_EVENT))
  47 #define GST_EVENT_CAST(obj)             ((GstEvent *)(obj))
  48 #define GST_EVENT(obj)                  (GST_EVENT_CAST(obj))
  49
  50 /**
  51  * GST_EVENT_TRACE_NAME:
  52  *
  53  * The name used for memory allocation tracing
  54  */
  55 #define GST_EVENT_TRACE_NAME    "GstEvent"
  56
  57 /**
  58  * GstEventTypeFlags:
  59  * @GST_EVENT_TYPE_UPSTREAM:   Set if the event can travel upstream.
  60  * @GST_EVENT_TYPE_DOWNSTREAM: Set if the event can travel downstream.
  61  * @GST_EVENT_TYPE_SERIALIZED: Set if the event should be serialized with data
  62  *                             flow.
  63  * @GST_EVENT_TYPE_STICKY:     Set if the event is sticky on the pads.
  64  *
  65  * #GstEventTypeFlags indicate the aspects of the different #GstEventType
  66  * values. You can get the type flags of a #GstEventType with the
  67  * gst_event_type_get_flags() function.
  68  */
  69 typedef enum {
  70   GST_EVENT_TYPE_UPSTREAM       = 1 << 0,
  71   GST_EVENT_TYPE_DOWNSTREAM     = 1 << 1,
  72   GST_EVENT_TYPE_SERIALIZED     = 1 << 2,
  73   GST_EVENT_TYPE_STICKY         = 1 << 3
  74 } GstEventTypeFlags;
  75
  76 /**
  77  * GST_EVENT_TYPE_BOTH:
  78  *
  79  * The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.
  80  */
  81 #define GST_EVENT_TYPE_BOTH \
  82     (GST_EVENT_TYPE_UPSTREAM | GST_EVENT_TYPE_DOWNSTREAM)
  83
  84 #define GST_EVENT_MAX_STICKY    16
  85 #define GST_EVENT_STICKY_SHIFT  8
  86 #define GST_EVENT_NUM_SHIFT     (GST_EVENT_STICKY_SHIFT + 4)
  87
  88 /**
  89  * GST_EVENT_MAKE_TYPE:
  90  * @num: the event number to create
  91  * @idx: the index in the sticky array
  92  * @flags: the event flags
  93  *
  94  * when making custom event types, use this macro with the num and
  95  * the given flags
  96  */
  97 #define GST_EVENT_MAKE_TYPE(num,idx,flags) \
  98     (((num) << GST_EVENT_NUM_SHIFT) | ((idx) << GST_EVENT_STICKY_SHIFT) | (flags))
  99
 100 #define FLAG(name) GST_EVENT_TYPE_##name
 101
 102
 103 #define GST_EVENT_STICKY_IDX_TYPE(type)  (((type) >> GST_EVENT_STICKY_SHIFT) & 0xf)
 104 #define GST_EVENT_STICKY_IDX(ev)         GST_EVENT_STICKY_IDX_TYPE(GST_EVENT_TYPE(ev))
 105
 106 /**
 107  * GstEventType:
 108  * @GST_EVENT_UNKNOWN: unknown event.
 109  * @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
 110  *                 from the pipeline and unblock all streaming threads.
 111  * @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
 112  *                 running-time of the pipeline.
 113  * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
 114  *                 without a SEGMENT event.
 115  * @GST_EVENT_SEGMENT: A new media segment follows in the dataflow. The
 116  *                 segment events contains information for clipping buffers and
 117  *                 converting buffer timestamps to running-time and
 118  *                 stream-time.
 119  * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
 120  * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
 121  *                 used yet.
 122  * @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
 123  *                          send messages that should be emitted in sync with
 124  *                          rendering.
 125  *                          Since: 0.10.26
 126  * @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
 127  *                 that the downstream elements should adjust their processing
 128  *                 rate.
 129  * @GST_EVENT_SEEK: A request for a new playback position and rate.
 130  * @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
 131  *                        user requests, such as mouse or keyboard movements,
 132  *                        to upstream elements.
 133  * @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
 134  *                     the latency information to adjust their synchronisation.
 135  *                     Since: 0.10.12
 136  * @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
 137  *                  execute the step operation. Since: 0.10.24
 138  * @GST_EVENT_RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.
 139  *                         Since: 0.11.0
 140  * @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
 141  * @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
 142  *                        data flow.
 143  * @GST_EVENT_CUSTOM_DOWNSTREAM_OOB: Custom out-of-band downstream event.
 144  * @GST_EVENT_CUSTOM_BOTH: Custom upstream or downstream event.
 145  *                         In-band when travelling downstream.
 146  * @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.
 147  *
 148  * #GstEventType lists the standard event types that can be sent in a pipeline.
 149  *
 150  * The custom event types can be used for private messages between elements
 151  * that can't be expressed using normal
 152  * GStreamer buffer passing semantics. Custom events carry an arbitrary
 153  * #GstStructure.
 154  * Specific custom events are distinguished by the name of the structure.
 155  */
 156 /* NOTE: keep in sync with quark registration in gstevent.c */
 157 typedef enum {
 158   GST_EVENT_UNKNOWN               = GST_EVENT_MAKE_TYPE (0, 0, 0),
 159   /* bidirectional events */
 160   GST_EVENT_FLUSH_START           = GST_EVENT_MAKE_TYPE (1, 0, FLAG(BOTH)),
 161   GST_EVENT_FLUSH_STOP            = GST_EVENT_MAKE_TYPE (2, 0, FLAG(BOTH) | FLAG(SERIALIZED)),
 162   /* downstream serialized events */
 163   GST_EVENT_CAPS                  = GST_EVENT_MAKE_TYPE (5, 1, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 164   GST_EVENT_SEGMENT               = GST_EVENT_MAKE_TYPE (6, 2, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 165   GST_EVENT_TAG                   = GST_EVENT_MAKE_TYPE (7, 3, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 166   GST_EVENT_BUFFERSIZE            = GST_EVENT_MAKE_TYPE (8, 4, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 167   GST_EVENT_SINK_MESSAGE          = GST_EVENT_MAKE_TYPE (9, 5, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 168   GST_EVENT_EOS                   = GST_EVENT_MAKE_TYPE (10, 6, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
 169
 170   /* upstream events */
 171   GST_EVENT_QOS                   = GST_EVENT_MAKE_TYPE (15, 0, FLAG(UPSTREAM)),
 172   GST_EVENT_SEEK                  = GST_EVENT_MAKE_TYPE (16, 0, FLAG(UPSTREAM)),
 173   GST_EVENT_NAVIGATION            = GST_EVENT_MAKE_TYPE (17, 0, FLAG(UPSTREAM)),
 174   GST_EVENT_LATENCY               = GST_EVENT_MAKE_TYPE (18, 0, FLAG(UPSTREAM)),
 175   GST_EVENT_STEP                  = GST_EVENT_MAKE_TYPE (19, 0, FLAG(UPSTREAM)),
 176   GST_EVENT_RECONFIGURE           = GST_EVENT_MAKE_TYPE (20, 0, FLAG(UPSTREAM)),
 177
 178   /* custom events start here */
 179   GST_EVENT_CUSTOM_UPSTREAM       = GST_EVENT_MAKE_TYPE (32, 0, FLAG(UPSTREAM)),
 180   GST_EVENT_CUSTOM_DOWNSTREAM     = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
 181   GST_EVENT_CUSTOM_DOWNSTREAM_OOB = GST_EVENT_MAKE_TYPE (32, 0, FLAG(DOWNSTREAM)),
 182   GST_EVENT_CUSTOM_BOTH           = GST_EVENT_MAKE_TYPE (32, 0, FLAG(BOTH) | FLAG(SERIALIZED)),
 183   GST_EVENT_CUSTOM_BOTH_OOB       = GST_EVENT_MAKE_TYPE (32, 0, FLAG(BOTH))
 184 } GstEventType;
 185 #undef FLAG
 186
 187 /**
 188  * GST_EVENT_TYPE:
 189  * @event: the event to query
 190  *
 191  * Get the #GstEventType of the event.
 192  */
 193 #define GST_EVENT_TYPE(event)           (GST_EVENT_CAST(event)->type)
 194
 195 /**
 196  * GST_EVENT_TYPE_NAME:
 197  * @event: the event to query
 198  *
 199  * Get a constant string representation of the #GstEventType of the event.
 200  */
 201 #define GST_EVENT_TYPE_NAME(event)      (gst_event_type_get_name(GST_EVENT_TYPE(event)))
 202
 203 /**
 204  * GST_EVENT_TIMESTAMP:
 205  * @event: the event to query
 206  *
 207  * Get the #GstClockTime timestamp of the event. This is the time when the event
 208  * was created.
 209  */
 210 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
 211
 212 /**
 213  * GST_EVENT_SEQNUM:
 214  * @event: the event to query
 215  *
 216  * The sequence number of @event.
 217  */
 218 #define GST_EVENT_SEQNUM(event)         (GST_EVENT_CAST(event)->seqnum)
 219
 220 /**
 221  * GST_EVENT_IS_UPSTREAM:
 222  * @ev: the event to query
 223  *
 224  * Check if an event can travel upstream.
 225  */
 226 #define GST_EVENT_IS_UPSTREAM(ev)       !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
 227 /**
 228  * GST_EVENT_IS_DOWNSTREAM:
 229  * @ev: the event to query
 230  *
 231  * Check if an event can travel downstream.
 232  */
 233 #define GST_EVENT_IS_DOWNSTREAM(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
 234 /**
 235  * GST_EVENT_IS_SERIALIZED:
 236  * @ev: the event to query
 237  *
 238  * Check if an event is serialized with the data stream.
 239  */
 240 #define GST_EVENT_IS_SERIALIZED(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
 241 /**
 242  * GST_EVENT_IS_STICKY:
 243  * @ev: the event to query
 244  *
 245  * Check if an event is sticky on the pads.
 246  */
 247 #define GST_EVENT_IS_STICKY(ev)     !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
 248
 249 /**
 250  * gst_event_is_writable:
 251  * @ev: a #GstEvent
 252  *
 253  * Tests if you can safely write data into a event's structure or validly
 254  * modify the seqnum and timestamp field.
 255  */
 256 #define         gst_event_is_writable(ev)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (ev))
 257 /**
 258  * gst_event_make_writable:
 259  * @ev: (transfer full): a #GstEvent
 260  *
 261  * Makes a writable event from the given event. If the source event is
 262  * already writable, this will simply return the same event. A copy will
 263  * otherwise be made using gst_event_copy().
 264  *
 265  * Returns: (transfer full): a writable event which may or may not be the
 266  *     same as @ev
 267  */
 268 #define         gst_event_make_writable(ev)   GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
 269 /**
 270  * gst_event_replace:
 271  * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent
 272  *     to be replaced.
 273  * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
 274  *     replace the event pointed to by @old_event.
 275  *
 276  * Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
 277  * modification is done atomically (so this is useful for ensuring thread safety
 278  * in some cases), and the reference counts are updated appropriately (the old
 279  * event is unreffed, the new one is reffed).
 280  *
 281  * Either @new_event or the #GstEvent pointed to by @old_event may be NULL.
 282  *
 283  * Since: 0.10.3
 284  */
 285 #define         gst_event_replace(old_event,new_event) \
 286     gst_mini_object_replace ((GstMiniObject **)(old_event), GST_MINI_OBJECT_CAST (new_event))
 287
 288 /**
 289  * GstQOSType:
 290  * @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when downstream
 291  *    elements are producing data too quickly and the element can't keep up
 292  *    processing the data. Upstream should reduce their processing rate. This
 293  *    type is also used when buffers arrive early or in time.
 294  * @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when downstream
 295  *    elements are producing data too slowly and need to speed up their processing
 296  *    rate.
 297  * @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
 298  *    application enabled throttling to limit the datarate.
 299  *
 300  * The different types of QoS events that can be given to the
 301  * gst_event_new_qos() method.
 302  *
 303  * Since: 0.10.33
 304  */
 305 typedef enum {
 306   GST_QOS_TYPE_OVERFLOW        = 0,
 307   GST_QOS_TYPE_UNDERFLOW       = 1,
 308   GST_QOS_TYPE_THROTTLE        = 2
 309 } GstQOSType;
 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  *
 317  * A #GstEvent.
 318  */
 319 struct _GstEvent {
 320   GstMiniObject mini_object;
 321
 322   /*< public >*/ /* with COW */
 323   GstEventType  type;
 324   guint64       timestamp;
 325   guint32       seqnum;
 326 };
 327
 328 const gchar*    gst_event_type_get_name         (GstEventType type);
 329 GQuark          gst_event_type_to_quark         (GstEventType type);
 330 GstEventTypeFlags
 331                 gst_event_type_get_flags        (GstEventType type);
 332
 333
 334 /* refcounting */
 335 /**
 336  * gst_event_ref:
 337  * @event: The event to refcount
 338  *
 339  * Increase the refcount of this event.
 340  *
 341  * Returns: (transfer full): @event (for convenience when doing assignments)
 342  */
 343 #ifdef _FOOL_GTK_DOC_
 344 G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
 345 #endif
 346
 347 static inline GstEvent *
 348 gst_event_ref (GstEvent * event)
 349 {
 350   return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
 351 }
 352
 353 /**
 354  * gst_event_unref:
 355  * @event: (transfer full): the event to refcount
 356  *
 357  * Decrease the refcount of an event, freeing it if the refcount reaches 0.
 358  */
 359 #ifdef _FOOL_GTK_DOC_
 360 G_INLINE_FUNC void gst_event_unref (GstEvent * event);
 361 #endif
 362
 363 static inline void
 364 gst_event_unref (GstEvent * event)
 365 {
 366   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
 367 }
 368
 369 /* copy event */
 370 /**
 371  * gst_event_copy:
 372  * @event: The event to copy
 373  *
 374  * Copy the event using the event specific copy function.
 375  *
 376  * Returns: (transfer full): the new event
 377  */
 378 #ifdef _FOOL_GTK_DOC_
 379 G_INLINE_FUNC GstEvent * gst_event_copy (const GstEvent * event);
 380 #endif
 381
 382 static inline GstEvent *
 383 gst_event_copy (const GstEvent * event)
 384 {
 385   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
 386 }
 387
 388
 389 /* custom event */
 390 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure);
 391
 392 const GstStructure *
 393                 gst_event_get_structure         (GstEvent *event);
 394 GstStructure *  gst_event_writable_structure    (GstEvent *event);
 395
 396 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
 397
 398 /* identifiers for events and messages */
 399 guint32         gst_event_get_seqnum            (GstEvent *event);
 400 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
 401
 402 /* flush events */
 403 GstEvent *      gst_event_new_flush_start       (void);
 404 GstEvent *      gst_event_new_flush_stop        (void);
 405
 406 /* EOS event */
 407 GstEvent *      gst_event_new_eos               (void);
 408
 409 /* Caps events */
 410 GstEvent *      gst_event_new_caps              (GstCaps *caps);
 411 void            gst_event_parse_caps            (GstEvent *event, GstCaps **caps);
 412
 413 /* segment event */
 414 GstEvent*       gst_event_new_segment           (GstSegment *segment);
 415 void            gst_event_parse_segment         (GstEvent *event, const GstSegment **segment);
 416 void            gst_event_copy_segment          (GstEvent *event, GstSegment *segment);
 417
 418 /* tag event */
 419 GstEvent*       gst_event_new_tag               (GstTagList *taglist);
 420 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
 421
 422 /* buffer */
 423 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
 424                                                  gboolean async);
 425 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
 426                                                  gint64 *maxsize, gboolean *async);
 427
 428 /* sink message */
 429 GstEvent*       gst_event_new_sink_message      (GstMessage *msg);
 430 void            gst_event_parse_sink_message    (GstEvent *event, GstMessage **msg);
 431
 432 /* QOS events */
 433 GstEvent*       gst_event_new_qos               (GstQOSType type, gdouble proportion,
 434                                                  GstClockTimeDiff diff, GstClockTime timestamp);
 435 void            gst_event_parse_qos             (GstEvent *event, GstQOSType *type,
 436                                                  gdouble *proportion, GstClockTimeDiff *diff,
 437                                                  GstClockTime *timestamp);
 438 /* seek event */
 439 GstEvent*       gst_event_new_seek              (gdouble rate, GstFormat format, GstSeekFlags flags,
 440                                                  GstSeekType start_type, gint64 start,
 441                                                  GstSeekType stop_type, gint64 stop);
 442 void            gst_event_parse_seek            (GstEvent *event, gdouble *rate, GstFormat *format,
 443                                                  GstSeekFlags *flags,
 444                                                  GstSeekType *start_type, gint64 *start,
 445                                                  GstSeekType *stop_type, gint64 *stop);
 446
 447 /* navigation event */
 448 GstEvent*       gst_event_new_navigation        (GstStructure *structure);
 449
 450 /* latency event */
 451 GstEvent*       gst_event_new_latency           (GstClockTime latency);
 452 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
 453
 454 /* step event */
 455 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
 456                                                  gboolean flush, gboolean intermediate);
 457 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
 458                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
 459
 460 /* renegotiate event */
 461 GstEvent*       gst_event_new_reconfigure       (void);
 462
 463 G_END_DECLS
 464
 465 #endif /* __GST_EVENT_H__ */