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