gst: Store more basic type GTypes in variables
[platform/upstream/gstreamer.git] / gst / gstmessage.h
1 /* GStreamer
2  * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
3  *
4  * gstmessage.h: Header for GstMessage subsystem
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef __GST_MESSAGE_H__
23 #define __GST_MESSAGE_H__
24
25 G_BEGIN_DECLS
26
27 typedef struct _GstMessage GstMessage;
28
29 /**
30  * GstMessageType:
31  * @GST_MESSAGE_UNKNOWN: an undefined message
32  * @GST_MESSAGE_EOS: end-of-stream reached in a pipeline. The application will
33  * only receive this message in the PLAYING state and every time it sets a
34  * pipeline to PLAYING that is in the EOS state. The application can perform a
35  * flushing seek in the pipeline, which will undo the EOS state again.
36  * @GST_MESSAGE_ERROR: an error occurred. When the application receives an error
37  * message it should stop playback of the pipeline and not assume that more
38  * data will be played.
39  * @GST_MESSAGE_WARNING: a warning occurred.
40  * @GST_MESSAGE_INFO: an info message occurred
41  * @GST_MESSAGE_TAG: a tag was found.
42  * @GST_MESSAGE_BUFFERING: the pipeline is buffering. When the application
43  * receives a buffering message in the PLAYING state for a non-live pipeline it
44  * must PAUSE the pipeline until the buffering completes, when the percentage
45  * field in the message is 100%. For live pipelines, no action must be
46  * performed and the buffering percentage can be used to inform the user about
47  * the progress.
48  * @GST_MESSAGE_STATE_CHANGED: a state change happened
49  * @GST_MESSAGE_STATE_DIRTY: an element changed state in a streaming thread.
50  * This message is deprecated.
51  * @GST_MESSAGE_STEP_DONE: a stepping operation finished.
52  * @GST_MESSAGE_CLOCK_PROVIDE: an element notifies its capability of providing
53  *                             a clock. This message is used internally and
54  *                             never forwarded to the application.
55  * @GST_MESSAGE_CLOCK_LOST: The current clock as selected by the pipeline became
56  *                          unusable. The pipeline will select a new clock on
57  *                          the next PLAYING state change. The application
58  *                          should set the pipeline to PAUSED and back to
59  *                          PLAYING when this message is received.
60  * @GST_MESSAGE_NEW_CLOCK: a new clock was selected in the pipeline.
61  * @GST_MESSAGE_STRUCTURE_CHANGE: the structure of the pipeline changed. This
62  * message is used internally and never forwarded to the application.
63  * @GST_MESSAGE_STREAM_STATUS: status about a stream, emitted when it starts,
64  *                             stops, errors, etc..
65  * @GST_MESSAGE_APPLICATION: message posted by the application, possibly
66  *                           via an application-specific element.
67  * @GST_MESSAGE_ELEMENT: element-specific message, see the specific element's
68  *                       documentation
69  * @GST_MESSAGE_SEGMENT_START: pipeline started playback of a segment. This
70  * message is used internally and never forwarded to the application.
71  * @GST_MESSAGE_SEGMENT_DONE: pipeline completed playback of a segment. This
72  * message is forwarded to the application after all elements that posted
73  * @GST_MESSAGE_SEGMENT_START posted a GST_MESSAGE_SEGMENT_DONE message.
74  * @GST_MESSAGE_DURATION_CHANGED: The duration of a pipeline changed. The
75  * application can get the new duration with a duration query.
76  * @GST_MESSAGE_ASYNC_START: Posted by elements when they start an ASYNC
77  * #GstStateChange. This message is not forwarded to the application but is used
78  * internally.
79  * @GST_MESSAGE_ASYNC_DONE: Posted by elements when they complete an ASYNC
80  * #GstStateChange. The application will only receive this message from the toplevel
81  * pipeline.
82  * @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The
83  * application should recalculate and distribute a new latency.
84  * @GST_MESSAGE_REQUEST_STATE: Posted by elements when they want the pipeline to
85  * change state. This message is a suggestion to the application which can
86  * decide to perform the state change on (part of) the pipeline.
87  * @GST_MESSAGE_STEP_START: A stepping operation was started.
88  * @GST_MESSAGE_QOS: A buffer was dropped or an element changed its processing
89  * strategy for Quality of Service reasons.
90  * @GST_MESSAGE_PROGRESS: A progress message.
91  * @GST_MESSAGE_TOC: A new table of contents (TOC) was found or previously found TOC
92  * was updated.
93  * @GST_MESSAGE_RESET_TIME: Message to request resetting the pipeline's
94  *     running time from the pipeline. This is an internal message which
95  *     applications will likely never receive.
96  * @GST_MESSAGE_STREAM_START: Message indicating start of a new stream. Useful
97  *     e.g. when using playbin in gapless playback mode, to get notified when
98  *     the next title actually starts playing (which will be some time after
99  *     the URI for the next title has been set).
100  * @GST_MESSAGE_NEED_CONTEXT: Message indicating that an element wants a specific context (Since 1.2)
101  * @GST_MESSAGE_HAVE_CONTEXT: Message indicating that an element created a context (Since 1.2)
102  * @GST_MESSAGE_EXTENDED: Message is an extended message type (see below).
103  *     These extended message IDs can't be used directly with mask-based API
104  *     like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still
105  *     filter for GST_MESSAGE_EXTENDED and then check the result for the
106  *     specific type. (Since 1.4)
107  * @GST_MESSAGE_DEVICE_ADDED: Message indicating a #GstDevice was added to
108  *     a #GstDeviceMonitor (Since 1.4)
109  * @GST_MESSAGE_DEVICE_REMOVED: Message indicating a #GstDevice was removed
110  *     from a #GstDeviceMonitor (Since 1.4)
111  * @GST_MESSAGE_ANY: mask for all of the above messages.
112  *
113  * The different message types that are available.
114  */
115 /* NOTE: keep in sync with quark registration in gstmessage.c
116  * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings.
117  */
118 /* FIXME: 2.0: Make it NOT flags, just a regular 1,2,3,4.. enumeration */
119 typedef enum
120 {
121   GST_MESSAGE_UNKNOWN           = 0,
122   GST_MESSAGE_EOS               = (1 << 0),
123   GST_MESSAGE_ERROR             = (1 << 1),
124   GST_MESSAGE_WARNING           = (1 << 2),
125   GST_MESSAGE_INFO              = (1 << 3),
126   GST_MESSAGE_TAG               = (1 << 4),
127   GST_MESSAGE_BUFFERING         = (1 << 5),
128   GST_MESSAGE_STATE_CHANGED     = (1 << 6),
129   GST_MESSAGE_STATE_DIRTY       = (1 << 7),
130   GST_MESSAGE_STEP_DONE         = (1 << 8),
131   GST_MESSAGE_CLOCK_PROVIDE     = (1 << 9),
132   GST_MESSAGE_CLOCK_LOST        = (1 << 10),
133   GST_MESSAGE_NEW_CLOCK         = (1 << 11),
134   GST_MESSAGE_STRUCTURE_CHANGE  = (1 << 12),
135   GST_MESSAGE_STREAM_STATUS     = (1 << 13),
136   GST_MESSAGE_APPLICATION       = (1 << 14),
137   GST_MESSAGE_ELEMENT           = (1 << 15),
138   GST_MESSAGE_SEGMENT_START     = (1 << 16),
139   GST_MESSAGE_SEGMENT_DONE      = (1 << 17),
140   GST_MESSAGE_DURATION_CHANGED  = (1 << 18),
141   GST_MESSAGE_LATENCY           = (1 << 19),
142   GST_MESSAGE_ASYNC_START       = (1 << 20),
143   GST_MESSAGE_ASYNC_DONE        = (1 << 21),
144   GST_MESSAGE_REQUEST_STATE     = (1 << 22),
145   GST_MESSAGE_STEP_START        = (1 << 23),
146   GST_MESSAGE_QOS               = (1 << 24),
147   GST_MESSAGE_PROGRESS          = (1 << 25),
148   GST_MESSAGE_TOC               = (1 << 26),
149   GST_MESSAGE_RESET_TIME        = (1 << 27),
150   GST_MESSAGE_STREAM_START      = (1 << 28),
151   GST_MESSAGE_NEED_CONTEXT      = (1 << 29),
152   GST_MESSAGE_HAVE_CONTEXT      = (1 << 30),
153   GST_MESSAGE_EXTENDED          = (1 << 31),
154   GST_MESSAGE_DEVICE_ADDED      = GST_MESSAGE_EXTENDED + 1,
155   GST_MESSAGE_DEVICE_REMOVED    = GST_MESSAGE_EXTENDED + 2,
156   GST_MESSAGE_ANY               = ~0
157 } GstMessageType;
158
159 #include <gst/gstminiobject.h>
160 #include <gst/gstobject.h>
161 #include <gst/gstelement.h>
162 #include <gst/gsttaglist.h>
163 #include <gst/gststructure.h>
164 #include <gst/gstquery.h>
165 #include <gst/gsttoc.h>
166 #include <gst/gstdevice.h>
167
168 GST_EXPORT GType _gst_message_type;
169
170 #define GST_TYPE_MESSAGE                         (_gst_message_type)
171 #define GST_IS_MESSAGE(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE))
172 #define GST_MESSAGE_CAST(obj)                    ((GstMessage*)(obj))
173 #define GST_MESSAGE(obj)                         (GST_MESSAGE_CAST(obj))
174
175 /* the lock is used to handle the synchronous handling of messages,
176  * the emiting thread is block until the handling thread processed
177  * the message using this mutex/cond pair */
178 #define GST_MESSAGE_GET_LOCK(message)   (&GST_MESSAGE_CAST(message)->lock)
179 #define GST_MESSAGE_LOCK(message)       g_mutex_lock(GST_MESSAGE_GET_LOCK(message))
180 #define GST_MESSAGE_UNLOCK(message)     g_mutex_unlock(GST_MESSAGE_GET_LOCK(message))
181 #define GST_MESSAGE_GET_COND(message)   (&GST_MESSAGE_CAST(message)->cond)
182 #define GST_MESSAGE_WAIT(message)       g_cond_wait(GST_MESSAGE_GET_COND(message),GST_MESSAGE_GET_LOCK(message))
183 #define GST_MESSAGE_SIGNAL(message)     g_cond_signal(GST_MESSAGE_GET_COND(message))
184
185 /**
186  * GST_MESSAGE_TYPE:
187  * @message: a #GstMessage
188  *
189  * Get the #GstMessageType of @message.
190  */
191 #define GST_MESSAGE_TYPE(message)       (GST_MESSAGE_CAST(message)->type)
192 /**
193  * GST_MESSAGE_TYPE_IS_EXTENDED:
194  * @message: a #GstMessage
195  *
196  * Check if the message is in the extended message group
197  * (Since 1.4)
198  */
199 #define GST_MESSAGE_TYPE_IS_EXTENDED(message)       (!!(GST_MESSAGE_CAST(message)->type & GST_MESSAGE_EXTENDED))
200
201 /**
202  * GST_MESSAGE_TYPE_NAME:
203  * @message: a #GstMessage
204  *
205  * Get a constant string representation of the #GstMessageType of @message.
206  */
207 #define GST_MESSAGE_TYPE_NAME(message)  gst_message_type_get_name(GST_MESSAGE_TYPE(message))
208 /**
209  * GST_MESSAGE_TIMESTAMP:
210  * @message: a #GstMessage
211  *
212  * Get the timestamp of @message. This is the timestamp when the message
213  * was created.
214  */
215 #define GST_MESSAGE_TIMESTAMP(message)  (GST_MESSAGE_CAST(message)->timestamp)
216 /**
217  * GST_MESSAGE_SRC:
218  * @message: a #GstMessage
219  *
220  * Get the object that posted @message.
221  */
222 #define GST_MESSAGE_SRC(message)        (GST_MESSAGE_CAST(message)->src)
223
224 /**
225  * GST_MESSAGE_SEQNUM:
226  * @message: a #GstMessage
227  *
228  * Get the sequence number of @message.
229  */
230 #define GST_MESSAGE_SEQNUM(message)     (GST_MESSAGE_CAST(message)->seqnum)
231
232 /**
233  * GST_MESSAGE_SRC_NAME:
234  * @message: a #GstMessage
235  *
236  * Get the name of the object that posted @message. Returns "(NULL)" if
237  * the message has no source object set.
238  */
239 #define GST_MESSAGE_SRC_NAME(message)   (GST_MESSAGE_SRC(message) ? \
240     GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
241
242 /**
243  * GstStructureChangeType:
244  * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
245  * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
246  *
247  * The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
248  */
249 typedef enum {
250   GST_STRUCTURE_CHANGE_TYPE_PAD_LINK   = 0,
251   GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1
252 } GstStructureChangeType;
253
254 /**
255  * GstStreamStatusType:
256  * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created.
257  * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function
258  * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function
259  * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed
260  * @GST_STREAM_STATUS_TYPE_START: a thread is started
261  * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
262  * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
263  *
264  * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
265  * application of new streaming threads and their status.
266  */
267 typedef enum {
268   GST_STREAM_STATUS_TYPE_CREATE   = 0,
269   GST_STREAM_STATUS_TYPE_ENTER    = 1,
270   GST_STREAM_STATUS_TYPE_LEAVE    = 2,
271   GST_STREAM_STATUS_TYPE_DESTROY  = 3,
272
273   GST_STREAM_STATUS_TYPE_START    = 8,
274   GST_STREAM_STATUS_TYPE_PAUSE    = 9,
275   GST_STREAM_STATUS_TYPE_STOP     = 10
276 } GstStreamStatusType;
277
278 /**
279  * GstProgressType:
280  * @GST_PROGRESS_TYPE_START: A new task started.
281  * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues.
282  * @GST_PROGRESS_TYPE_COMPLETE: A task completed.
283  * @GST_PROGRESS_TYPE_CANCELED: A task was canceled.
284  * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also
285  *          posted on the bus.
286  *
287  * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
288  * application of the status of asynchronous tasks.
289  */
290 typedef enum {
291   GST_PROGRESS_TYPE_START    = 0,
292   GST_PROGRESS_TYPE_CONTINUE = 1,
293   GST_PROGRESS_TYPE_COMPLETE = 2,
294   GST_PROGRESS_TYPE_CANCELED = 3,
295   GST_PROGRESS_TYPE_ERROR    = 4
296 } GstProgressType;
297
298 /**
299  * GstMessage:
300  * @mini_object: the parent structure
301  * @type: the #GstMessageType of the message
302  * @timestamp: the timestamp of the message
303  * @src: the src of the message
304  * @seqnum: the sequence number of the message
305  *
306  * A #GstMessage.
307  */
308 struct _GstMessage
309 {
310   GstMiniObject   mini_object;
311
312   /*< public > *//* with COW */
313   GstMessageType  type;
314   guint64         timestamp;
315   GstObject      *src;
316   guint32         seqnum;
317
318   /*< private >*//* with MESSAGE_LOCK */
319   GMutex          lock;                 /* lock and cond for async delivery */
320   GCond           cond;
321 };
322
323 GType           gst_message_get_type            (void);
324
325 const gchar*    gst_message_type_get_name       (GstMessageType type);
326 GQuark          gst_message_type_to_quark       (GstMessageType type);
327
328 /* refcounting */
329 /**
330  * gst_message_ref:
331  * @msg: the message to ref
332  *
333  * Convenience macro to increase the reference count of the message.
334  *
335  * Returns: @msg (for convenience when doing assignments)
336  */
337 #ifdef _FOOL_GTK_DOC_
338 G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);
339 #endif
340
341 static inline GstMessage *
342 gst_message_ref (GstMessage * msg)
343 {
344   return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg));
345 }
346
347 /**
348  * gst_message_unref:
349  * @msg: the message to unref
350  *
351  * Convenience macro to decrease the reference count of the message, possibly
352  * freeing it.
353  */
354 #ifdef _FOOL_GTK_DOC_
355 G_INLINE_FUNC void gst_message_unref (GstMessage * msg);
356 #endif
357
358 static inline void
359 gst_message_unref (GstMessage * msg)
360 {
361   gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg));
362 }
363
364 /* copy message */
365 /**
366  * gst_message_copy:
367  * @msg: the message to copy
368  *
369  * Creates a copy of the message. Returns a copy of the message.
370  *
371  * Returns: (transfer full): a new copy of @msg.
372  *
373  * MT safe
374  */
375 #ifdef _FOOL_GTK_DOC_
376 G_INLINE_FUNC GstMessage * gst_message_copy (const GstMessage * msg);
377 #endif
378
379 static inline GstMessage *
380 gst_message_copy (const GstMessage * msg)
381 {
382   return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg)));
383 }
384
385 /**
386  * gst_message_is_writable:
387  * @msg: a #GstMessage
388  *
389  * Tests if you can safely write into a message's structure or validly
390  * modify the seqnum and timestamp fields.
391  */
392 #define         gst_message_is_writable(msg)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (msg))
393 /**
394  * gst_message_make_writable:
395  * @msg: (transfer full): the message to make writable
396  *
397  * Checks if a message is writable. If not, a writable copy is made and
398  * returned.
399  *
400  * Returns: (transfer full): a message (possibly a duplicate) that is writable.
401  *
402  * MT safe
403  */
404 #define         gst_message_make_writable(msg)  GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
405 /**
406  * gst_message_replace:
407  * @old_message: (inout) (transfer full): pointer to a pointer to a #GstMessage
408  *     to be replaced.
409  * @new_message: (allow-none) (transfer none): pointer to a #GstMessage that will
410  *     replace the message pointed to by @old_message.
411  *
412  * Modifies a pointer to a #GstMessage to point to a different #GstMessage. The
413  * modification is done atomically (so this is useful for ensuring thread safety
414  * in some cases), and the reference counts are updated appropriately (the old
415  * message is unreffed, the new one is reffed).
416  *
417  * Either @new_message or the #GstMessage pointed to by @old_message may be %NULL.
418  *
419  * Returns: %TRUE if @new_message was different from @old_message
420  */
421 #ifdef _FOOL_GTK_DOC_
422 G_INLINE_FUNC gboolean gst_message_replace (GstMessage **old_message, GstMessage *new_message);
423 #endif
424
425 static inline gboolean
426 gst_message_replace (GstMessage **old_message, GstMessage *new_message)
427 {
428   return gst_mini_object_replace ((GstMiniObject **) old_message, (GstMiniObject *) new_message);
429 }
430
431
432 /* custom messages */
433 GstMessage *    gst_message_new_custom          (GstMessageType type,
434                                                  GstObject    * src,
435                                                  GstStructure * structure) G_GNUC_MALLOC;
436 const GstStructure *
437                 gst_message_get_structure       (GstMessage *message);
438
439 gboolean        gst_message_has_name            (GstMessage *message, const gchar *name);
440
441 /* identifiers for events and messages */
442 guint32         gst_message_get_seqnum          (GstMessage *message);
443 void            gst_message_set_seqnum          (GstMessage *message, guint32 seqnum);
444
445 /* EOS */
446 GstMessage *    gst_message_new_eos             (GstObject * src) G_GNUC_MALLOC;
447
448 /* ERROR */
449
450 GstMessage *    gst_message_new_error           (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
451 void            gst_message_parse_error         (GstMessage *message, GError **gerror, gchar **debug);
452
453 /* WARNING */
454 GstMessage *    gst_message_new_warning         (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
455 void            gst_message_parse_warning       (GstMessage *message, GError **gerror, gchar **debug);
456
457 /* INFO */
458 GstMessage *    gst_message_new_info            (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
459 void            gst_message_parse_info          (GstMessage *message, GError **gerror, gchar **debug);
460
461 /* TAG */
462 GstMessage *    gst_message_new_tag             (GstObject * src, GstTagList * tag_list) G_GNUC_MALLOC;
463 void            gst_message_parse_tag           (GstMessage *message, GstTagList **tag_list);
464
465 /* BUFFERING */
466 GstMessage *    gst_message_new_buffering         (GstObject * src, gint percent) G_GNUC_MALLOC;
467 void            gst_message_parse_buffering       (GstMessage *message, gint *percent);
468 void            gst_message_set_buffering_stats   (GstMessage *message, GstBufferingMode mode,
469                                                    gint avg_in, gint avg_out,
470                                                    gint64 buffering_left);
471 void            gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode,
472                                                    gint *avg_in, gint *avg_out,
473                                                    gint64 *buffering_left);
474
475 /* STATE_CHANGED */
476 GstMessage *    gst_message_new_state_changed   (GstObject * src, GstState oldstate,
477                                                  GstState newstate, GstState pending) G_GNUC_MALLOC;
478 void            gst_message_parse_state_changed (GstMessage *message, GstState *oldstate,
479                                                  GstState *newstate, GstState *pending);
480
481 /* STATE_DIRTY */
482 GstMessage *    gst_message_new_state_dirty     (GstObject * src) G_GNUC_MALLOC;
483
484 /* STEP_DONE */
485 GstMessage *    gst_message_new_step_done       (GstObject * src, GstFormat format, guint64 amount,
486                                                  gdouble rate, gboolean flush, gboolean intermediate,
487                                                  guint64 duration, gboolean eos) G_GNUC_MALLOC;
488 void            gst_message_parse_step_done     (GstMessage * message, GstFormat *format, guint64 *amount,
489                                                  gdouble *rate, gboolean *flush, gboolean *intermediate,
490                                                  guint64 *duration, gboolean *eos);
491 /* CLOCK_PROVIDE */
492 GstMessage *    gst_message_new_clock_provide   (GstObject * src, GstClock *clock, gboolean ready) G_GNUC_MALLOC;
493 void            gst_message_parse_clock_provide (GstMessage *message, GstClock **clock,
494                                                  gboolean *ready);
495
496 /* CLOCK_LOST */
497 GstMessage *    gst_message_new_clock_lost      (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
498 void            gst_message_parse_clock_lost    (GstMessage *message, GstClock **clock);
499
500 /* NEW_CLOCK */
501 GstMessage *    gst_message_new_new_clock       (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
502 void            gst_message_parse_new_clock     (GstMessage *message, GstClock **clock);
503
504 /* APPLICATION */
505 GstMessage *    gst_message_new_application     (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
506
507 /* ELEMENT */
508 GstMessage *    gst_message_new_element         (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
509
510 /* SEGMENT_START */
511 GstMessage *    gst_message_new_segment_start   (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
512 void            gst_message_parse_segment_start (GstMessage *message, GstFormat *format,
513                                                  gint64 *position);
514
515 /* SEGMENT_DONE */
516 GstMessage *    gst_message_new_segment_done    (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
517 void            gst_message_parse_segment_done  (GstMessage *message, GstFormat *format,
518                                                  gint64 *position);
519
520 /* DURATION_CHANGED */
521 GstMessage *    gst_message_new_duration_changed (GstObject * src) G_GNUC_MALLOC;
522
523 /* LATENCY */
524 GstMessage *    gst_message_new_latency         (GstObject * src) G_GNUC_MALLOC;
525
526 /* ASYNC_START */
527 GstMessage *    gst_message_new_async_start     (GstObject * src) G_GNUC_MALLOC;
528
529 /* ASYNC_DONE */
530 GstMessage *    gst_message_new_async_done      (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC;
531 void            gst_message_parse_async_done    (GstMessage *message, GstClockTime *running_time);
532
533 /* STRUCTURE CHANGE */
534 GstMessage *    gst_message_new_structure_change   (GstObject * src, GstStructureChangeType type,
535                                                     GstElement *owner, gboolean busy) G_GNUC_MALLOC;
536 void            gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type,
537                                                     GstElement **owner, gboolean *busy);
538
539 /* STREAM STATUS */
540 GstMessage *    gst_message_new_stream_status        (GstObject * src, GstStreamStatusType type,
541                                                       GstElement *owner) G_GNUC_MALLOC;
542 void            gst_message_parse_stream_status      (GstMessage *message, GstStreamStatusType *type,
543                                                       GstElement **owner);
544 void            gst_message_set_stream_status_object (GstMessage *message, const GValue *object);
545 const GValue *  gst_message_get_stream_status_object (GstMessage *message);
546
547 /* REQUEST_STATE */
548 GstMessage *    gst_message_new_request_state   (GstObject * src, GstState state) G_GNUC_MALLOC;
549 void            gst_message_parse_request_state (GstMessage * message, GstState *state);
550
551 /* STEP_START */
552 GstMessage *    gst_message_new_step_start      (GstObject * src, gboolean active, GstFormat format,
553                                                  guint64 amount, gdouble rate, gboolean flush,
554                                                  gboolean intermediate) G_GNUC_MALLOC;
555 void            gst_message_parse_step_start    (GstMessage * message, gboolean *active, GstFormat *format,
556                                                  guint64 *amount, gdouble *rate, gboolean *flush,
557                                                  gboolean *intermediate);
558
559 /* QOS */
560 GstMessage *    gst_message_new_qos             (GstObject * src, gboolean live, guint64 running_time,
561                                                  guint64 stream_time, guint64 timestamp, guint64 duration) G_GNUC_MALLOC;
562 void            gst_message_set_qos_values      (GstMessage * message, gint64 jitter, gdouble proportion,
563                                                  gint quality);
564 void            gst_message_set_qos_stats       (GstMessage * message, GstFormat format, guint64 processed,
565                                                  guint64 dropped);
566 void            gst_message_parse_qos           (GstMessage * message, gboolean * live, guint64 * running_time,
567                                                  guint64 * stream_time, guint64 * timestamp, guint64 * duration);
568 void            gst_message_parse_qos_values    (GstMessage * message, gint64 * jitter, gdouble * proportion,
569                                                  gint * quality);
570 void            gst_message_parse_qos_stats     (GstMessage * message, GstFormat * format, guint64 * processed,
571                                                  guint64 * dropped);
572 /* PROGRESS */
573 GstMessage *    gst_message_new_progress           (GstObject * src, GstProgressType type, const gchar *code,
574                                                     const gchar *text) G_GNUC_MALLOC;
575 void            gst_message_parse_progress         (GstMessage * message, GstProgressType * type, gchar ** code,
576                                                     gchar ** text);
577
578 /* TOC */
579 GstMessage *    gst_message_new_toc             (GstObject *src, GstToc *toc, gboolean updated);
580 void            gst_message_parse_toc           (GstMessage *message, GstToc **toc, gboolean *updated);
581
582 /* RESET_TIME */
583 GstMessage *    gst_message_new_reset_time      (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC;
584 void            gst_message_parse_reset_time    (GstMessage *message, GstClockTime *running_time);
585
586 /* STREAM_START */
587 GstMessage *    gst_message_new_stream_start    (GstObject * src) G_GNUC_MALLOC;
588
589 void            gst_message_set_group_id        (GstMessage *message, guint group_id);
590 gboolean        gst_message_parse_group_id      (GstMessage *message, guint *group_id);
591
592 /* NEED_CONTEXT */
593 GstMessage *    gst_message_new_need_context    (GstObject * src, const gchar * context_type) G_GNUC_MALLOC;
594 gboolean        gst_message_parse_context_type  (GstMessage * message, const gchar ** context_type);
595
596 /* HAVE_CONTEXT */
597 GstMessage *    gst_message_new_have_context    (GstObject * src, GstContext *context) G_GNUC_MALLOC;
598 void            gst_message_parse_have_context  (GstMessage *message, GstContext **context);
599
600 /* DEVICE_ADDED */
601 GstMessage *    gst_message_new_device_added    (GstObject * src, GstDevice * device) G_GNUC_MALLOC;
602 void            gst_message_parse_device_added  (GstMessage * message, GstDevice ** device);
603
604 /* DEVICE_REMOVED */
605 GstMessage *    gst_message_new_device_removed    (GstObject * src, GstDevice * device) G_GNUC_MALLOC;
606 void            gst_message_parse_device_removed  (GstMessage * message, GstDevice ** device);
607
608
609 G_END_DECLS
610
611 #endif /* __GST_MESSAGE_H__ */