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