2 * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
4 * gstmessage.h: Header for GstMessage subsystem
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.
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.
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., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
22 #ifndef __GST_MESSAGE_H__
23 #define __GST_MESSAGE_H__
27 typedef struct _GstMessage GstMessage;
28 typedef struct _GstMessageClass GstMessageClass;
32 * @GST_MESSAGE_UNKNOWN: an undefined message
33 * @GST_MESSAGE_EOS: end-of-stream reached in a pipeline. The application will
34 * only receive this message in the PLAYING state and every time it sets a
35 * pipeline to PLAYING that is in the EOS state. The application can perform a
36 * flushing seek in the pipeline, which will undo the EOS state again.
37 * @GST_MESSAGE_ERROR: an error occured. When the application receives an error
38 * message it should stop playback of the pipeline and not assume that more
39 * data will be played.
40 * @GST_MESSAGE_WARNING: a warning occured.
41 * @GST_MESSAGE_INFO: an info message occured
42 * @GST_MESSAGE_TAG: a tag was found.
43 * @GST_MESSAGE_BUFFERING: the pipeline is buffering. When the application
44 * receives a buffering message in the PLAYING state for a non-live pipeline it
45 * must PAUSE the pipeline until the buffering completes, when the percentage
46 * field in the message is 100%. For live pipelines, no action must be
47 * performed and the buffering percentage can be used to inform the user about
49 * @GST_MESSAGE_STATE_CHANGED: a state change happened
50 * @GST_MESSAGE_STATE_DIRTY: an element changed state in a streaming thread.
51 * This message is deprecated.
52 * @GST_MESSAGE_STEP_DONE: a stepping operation finished.
53 * @GST_MESSAGE_CLOCK_PROVIDE: an element notifies its capability of providing
54 * a clock. This message is used internally and
55 * never forwarded to the application.
56 * @GST_MESSAGE_CLOCK_LOST: The current clock as selected by the pipeline became
57 * unusable. The pipeline will select a new clock on
58 * the next PLAYING state change. The application
59 * should set the pipeline to PAUSED and back to
60 * PLAYING when this message is received.
61 * @GST_MESSAGE_NEW_CLOCK: a new clock was selected in the pipeline.
62 * @GST_MESSAGE_STRUCTURE_CHANGE: the structure of the pipeline changed. This
63 * message is used internally and never forwarded to the application.
64 * @GST_MESSAGE_STREAM_STATUS: status about a stream, emitted when it starts,
65 * stops, errors, etc..
66 * @GST_MESSAGE_APPLICATION: message posted by the application, possibly
67 * via an application-specific element.
68 * @GST_MESSAGE_ELEMENT: element-specific message, see the specific element's
70 * @GST_MESSAGE_SEGMENT_START: pipeline started playback of a segment. This
71 * message is used internally and never forwarded to the application.
72 * @GST_MESSAGE_SEGMENT_DONE: pipeline completed playback of a segment. This
73 * message is forwarded to the application after all elements that posted
74 * @GST_MESSAGE_SEGMENT_START posted a GST_MESSAGE_SEGMENT_DONE message.
75 * @GST_MESSAGE_DURATION: The duration of a pipeline changed. The application
76 * can get the new duration with a duration query.
77 * @GST_MESSAGE_ASYNC_START: Posted by elements when they start an ASYNC
78 * #GstStateChange. This message is not forwarded to the application but is used
79 * internally. Since: 0.10.13.
80 * @GST_MESSAGE_ASYNC_DONE: Posted by elements when they complete an ASYNC
81 * #GstStateChange. The application will only receive this message from the toplevel
82 * pipeline. Since: 0.10.13
83 * @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The
84 * application should recalculate and distribute a new latency. Since: 0.10.12
85 * @GST_MESSAGE_REQUEST_STATE: Posted by elements when they want the pipeline to
86 * change state. This message is a suggestion to the application which can
87 * decide to perform the state change on (part of) the pipeline. Since: 0.10.23.
88 * @GST_MESSAGE_STEP_START: A stepping operation was started. Since: 0.10.24
89 * @GST_MESSAGE_QOS: A buffer was dropped or an element changed its processing
90 * strategy for Quality of Service reasons. Since: 0.10.29
91 * @GST_MESSAGE_PROGRESS: A progress message. Since: 0.10.33
92 * @GST_MESSAGE_ANY: mask for all of the above messages.
94 * The different message types that are available.
96 /* NOTE: keep in sync with quark registration in gstmessage.c
97 * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings.
101 GST_MESSAGE_UNKNOWN = 0,
102 GST_MESSAGE_EOS = (1 << 0),
103 GST_MESSAGE_ERROR = (1 << 1),
104 GST_MESSAGE_WARNING = (1 << 2),
105 GST_MESSAGE_INFO = (1 << 3),
106 GST_MESSAGE_TAG = (1 << 4),
107 GST_MESSAGE_BUFFERING = (1 << 5),
108 GST_MESSAGE_STATE_CHANGED = (1 << 6),
109 GST_MESSAGE_STATE_DIRTY = (1 << 7),
110 GST_MESSAGE_STEP_DONE = (1 << 8),
111 GST_MESSAGE_CLOCK_PROVIDE = (1 << 9),
112 GST_MESSAGE_CLOCK_LOST = (1 << 10),
113 GST_MESSAGE_NEW_CLOCK = (1 << 11),
114 GST_MESSAGE_STRUCTURE_CHANGE = (1 << 12),
115 GST_MESSAGE_STREAM_STATUS = (1 << 13),
116 GST_MESSAGE_APPLICATION = (1 << 14),
117 GST_MESSAGE_ELEMENT = (1 << 15),
118 GST_MESSAGE_SEGMENT_START = (1 << 16),
119 GST_MESSAGE_SEGMENT_DONE = (1 << 17),
120 GST_MESSAGE_DURATION = (1 << 18),
121 GST_MESSAGE_LATENCY = (1 << 19),
122 GST_MESSAGE_ASYNC_START = (1 << 20),
123 GST_MESSAGE_ASYNC_DONE = (1 << 21),
124 GST_MESSAGE_REQUEST_STATE = (1 << 22),
125 GST_MESSAGE_STEP_START = (1 << 23),
126 GST_MESSAGE_QOS = (1 << 24),
127 GST_MESSAGE_PROGRESS = (1 << 25),
131 #include <gst/gstminiobject.h>
132 #include <gst/gstobject.h>
133 #include <gst/gstelement.h>
134 #include <gst/gsttaglist.h>
135 #include <gst/gststructure.h>
138 * GST_MESSAGE_TRACE_NAME:
140 * The name used for memory allocation tracing
142 #define GST_MESSAGE_TRACE_NAME "GstMessage"
144 #define GST_TYPE_MESSAGE (gst_message_get_type())
145 #define GST_IS_MESSAGE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MESSAGE))
146 #define GST_IS_MESSAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MESSAGE))
147 #define GST_MESSAGE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_MESSAGE, GstMessageClass))
148 #define GST_MESSAGE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MESSAGE, GstMessage))
149 #define GST_MESSAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MESSAGE, GstMessageClass))
150 #define GST_MESSAGE_CAST(obj) ((GstMessage*)(obj))
152 /* the lock is used to handle the synchronous handling of messages,
153 * the emiting thread is block until the handling thread processed
154 * the message using this mutex/cond pair */
155 #define GST_MESSAGE_GET_LOCK(message) (GST_MESSAGE_CAST(message)->lock)
156 #define GST_MESSAGE_LOCK(message) g_mutex_lock(GST_MESSAGE_GET_LOCK(message))
157 #define GST_MESSAGE_UNLOCK(message) g_mutex_unlock(GST_MESSAGE_GET_LOCK(message))
158 #define GST_MESSAGE_COND(message) (GST_MESSAGE_CAST(message)->cond)
159 #define GST_MESSAGE_WAIT(message) g_cond_wait(GST_MESSAGE_COND(message),GST_MESSAGE_GET_LOCK(message))
160 #define GST_MESSAGE_SIGNAL(message) g_cond_signal(GST_MESSAGE_COND(message))
164 * @message: a #GstMessage
166 * Get the #GstMessageType of @message.
168 #define GST_MESSAGE_TYPE(message) (GST_MESSAGE_CAST(message)->type)
170 * GST_MESSAGE_TYPE_NAME:
171 * @message: a #GstMessage
173 * Get a constant string representation of the #GstMessageType of @message.
177 #define GST_MESSAGE_TYPE_NAME(message) gst_message_type_get_name(GST_MESSAGE_TYPE(message))
179 * GST_MESSAGE_TIMESTAMP:
180 * @message: a #GstMessage
182 * Get the timestamp of @message. This is the timestamp when the message
185 #define GST_MESSAGE_TIMESTAMP(message) (GST_MESSAGE_CAST(message)->timestamp)
188 * @message: a #GstMessage
190 * Get the object that posted @message.
192 #define GST_MESSAGE_SRC(message) (GST_MESSAGE_CAST(message)->src)
194 * GST_MESSAGE_SRC_NAME:
195 * @message: a #GstMessage
197 * Get the name of the object that posted @message. Returns "(NULL)" if
198 * the message has no source object set.
202 #define GST_MESSAGE_SRC_NAME(message) (GST_MESSAGE_SRC(message) ? \
203 GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
206 * GstStructureChangeType:
207 * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
208 * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
210 * The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
215 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK = 0,
216 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1
217 } GstStructureChangeType;
220 * GstStreamStatusType:
221 * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created.
222 * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function
223 * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function
224 * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed
225 * @GST_STREAM_STATUS_TYPE_START: a thread is started
226 * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
227 * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
229 * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
230 * application of new streaming threads and their status.
235 GST_STREAM_STATUS_TYPE_CREATE = 0,
236 GST_STREAM_STATUS_TYPE_ENTER = 1,
237 GST_STREAM_STATUS_TYPE_LEAVE = 2,
238 GST_STREAM_STATUS_TYPE_DESTROY = 3,
240 GST_STREAM_STATUS_TYPE_START = 8,
241 GST_STREAM_STATUS_TYPE_PAUSE = 9,
242 GST_STREAM_STATUS_TYPE_STOP = 10
243 } GstStreamStatusType;
247 * @GST_PROGRESS_TYPE_START: A new task started.
248 * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues.
249 * @GST_PROGRESS_TYPE_COMPLETE: A task completed.
250 * @GST_PROGRESS_TYPE_CANCELED: A task was canceled.
251 * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also
254 * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
255 * application of the status of assynchronous tasks.
260 GST_PROGRESS_TYPE_START = 0,
261 GST_PROGRESS_TYPE_CONTINUE = 1,
262 GST_PROGRESS_TYPE_COMPLETE = 2,
263 GST_PROGRESS_TYPE_CANCELED = 3,
264 GST_PROGRESS_TYPE_ERROR = 4,
269 * @mini_object: the parent structure
270 * @type: the #GstMessageType of the message
271 * @timestamp: the timestamp of the message
272 * @src: the src of the message
273 * @structure: the #GstStructure containing the message info.
279 GstMiniObject mini_object;
281 /*< private >*//* with MESSAGE_LOCK */
282 GMutex *lock; /* lock and cond for async delivery */
285 /*< public > *//* with COW */
290 GstStructure *structure;
297 /* + 0 to mark ABI change for future greppage */
298 gpointer _gst_reserved[GST_PADDING + 0];
302 struct _GstMessageClass {
303 GstMiniObjectClass mini_object_class;
306 gpointer _gst_reserved[GST_PADDING];
309 GType gst_message_get_type (void);
311 const gchar* gst_message_type_get_name (GstMessageType type);
312 GQuark gst_message_type_to_quark (GstMessageType type);
317 * @msg: the message to ref
319 * Convenience macro to increase the reference count of the message.
321 * Returns: @msg (for convenience when doing assignments)
323 #ifdef _FOOL_GTK_DOC_
324 G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);
327 static inline GstMessage *
328 gst_message_ref (GstMessage * msg)
330 return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg));
335 * @msg: the message to unref
337 * Convenience macro to decrease the reference count of the message, possibly
340 #ifdef _FOOL_GTK_DOC_
341 G_INLINE_FUNC void gst_message_unref (GstMessage * msg);
345 gst_message_unref (GstMessage * msg)
347 gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg));
353 * @msg: the message to copy
355 * Creates a copy of the message. Returns a copy of the message.
357 * Returns: (transfer full): a new copy of @msg.
361 #ifdef _FOOL_GTK_DOC_
362 G_INLINE_FUNC GstMessage * gst_message_copy (const GstMessage * msg);
365 static inline GstMessage *
366 gst_message_copy (const GstMessage * msg)
368 return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg)));
372 * gst_message_make_writable:
373 * @msg: (transfer full): the message to make writable
375 * Checks if a message is writable. If not, a writable copy is made and
378 * Returns: (transfer full): a message (possibly a duplicate) that is writable.
382 #define gst_message_make_writable(msg) GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
384 /* identifiers for events and messages */
385 guint32 gst_message_get_seqnum (GstMessage *message);
386 void gst_message_set_seqnum (GstMessage *message, guint32 seqnum);
389 GstMessage * gst_message_new_eos (GstObject * src) G_GNUC_MALLOC;
393 GstMessage * gst_message_new_error (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
394 void gst_message_parse_error (GstMessage *message, GError **gerror, gchar **debug);
397 GstMessage * gst_message_new_warning (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
398 void gst_message_parse_warning (GstMessage *message, GError **gerror, gchar **debug);
401 GstMessage * gst_message_new_info (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
402 void gst_message_parse_info (GstMessage *message, GError **gerror, gchar **debug);
405 GstMessage * gst_message_new_tag (GstObject * src, GstTagList * tag_list) G_GNUC_MALLOC;
406 GstMessage * gst_message_new_tag_full (GstObject * src, GstPad *pad, GstTagList * tag_list) G_GNUC_MALLOC;
407 void gst_message_parse_tag (GstMessage *message, GstTagList **tag_list);
408 void gst_message_parse_tag_full (GstMessage *message, GstPad **pad, GstTagList **tag_list);
411 GstMessage * gst_message_new_buffering (GstObject * src, gint percent) G_GNUC_MALLOC;
412 void gst_message_parse_buffering (GstMessage *message, gint *percent);
413 void gst_message_set_buffering_stats (GstMessage *message, GstBufferingMode mode,
414 gint avg_in, gint avg_out,
415 gint64 buffering_left);
416 void gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode,
417 gint *avg_in, gint *avg_out,
418 gint64 *buffering_left);
421 GstMessage * gst_message_new_state_changed (GstObject * src, GstState oldstate,
422 GstState newstate, GstState pending) G_GNUC_MALLOC;
423 void gst_message_parse_state_changed (GstMessage *message, GstState *oldstate,
424 GstState *newstate, GstState *pending);
427 GstMessage * gst_message_new_state_dirty (GstObject * src) G_GNUC_MALLOC;
430 GstMessage * gst_message_new_step_done (GstObject * src, GstFormat format, guint64 amount,
431 gdouble rate, gboolean flush, gboolean intermediate,
432 guint64 duration, gboolean eos) G_GNUC_MALLOC;
433 void gst_message_parse_step_done (GstMessage * message, GstFormat *format, guint64 *amount,
434 gdouble *rate, gboolean *flush, gboolean *intermediate,
435 guint64 *duration, gboolean *eos);
437 GstMessage * gst_message_new_clock_provide (GstObject * src, GstClock *clock, gboolean ready) G_GNUC_MALLOC;
438 void gst_message_parse_clock_provide (GstMessage *message, GstClock **clock,
442 GstMessage * gst_message_new_clock_lost (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
443 void gst_message_parse_clock_lost (GstMessage *message, GstClock **clock);
446 GstMessage * gst_message_new_new_clock (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
447 void gst_message_parse_new_clock (GstMessage *message, GstClock **clock);
450 GstMessage * gst_message_new_application (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
453 GstMessage * gst_message_new_element (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
456 GstMessage * gst_message_new_segment_start (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
457 void gst_message_parse_segment_start (GstMessage *message, GstFormat *format,
461 GstMessage * gst_message_new_segment_done (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
462 void gst_message_parse_segment_done (GstMessage *message, GstFormat *format,
466 GstMessage * gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration) G_GNUC_MALLOC;
467 void gst_message_parse_duration (GstMessage *message, GstFormat *format,
471 GstMessage * gst_message_new_latency (GstObject * src) G_GNUC_MALLOC;
474 GstMessage * gst_message_new_async_start (GstObject * src, gboolean new_base_time) G_GNUC_MALLOC;
475 void gst_message_parse_async_start (GstMessage *message, gboolean *new_base_time);
478 GstMessage * gst_message_new_async_done (GstObject * src) G_GNUC_MALLOC;
480 /* STRUCTURE CHANGE */
481 GstMessage * gst_message_new_structure_change (GstObject * src, GstStructureChangeType type,
482 GstElement *owner, gboolean busy) G_GNUC_MALLOC;
483 void gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type,
484 GstElement **owner, gboolean *busy);
487 GstMessage * gst_message_new_stream_status (GstObject * src, GstStreamStatusType type,
488 GstElement *owner) G_GNUC_MALLOC;
489 void gst_message_parse_stream_status (GstMessage *message, GstStreamStatusType *type,
491 void gst_message_set_stream_status_object (GstMessage *message, const GValue *object);
492 const GValue * gst_message_get_stream_status_object (GstMessage *message);
495 GstMessage * gst_message_new_request_state (GstObject * src, GstState state) G_GNUC_MALLOC;
496 void gst_message_parse_request_state (GstMessage * message, GstState *state);
499 GstMessage * gst_message_new_step_start (GstObject * src, gboolean active, GstFormat format,
500 guint64 amount, gdouble rate, gboolean flush,
501 gboolean intermediate) G_GNUC_MALLOC;
502 void gst_message_parse_step_start (GstMessage * message, gboolean *active, GstFormat *format,
503 guint64 *amount, gdouble *rate, gboolean *flush,
504 gboolean *intermediate);
507 GstMessage * gst_message_new_qos (GstObject * src, gboolean live, guint64 running_time,
508 guint64 stream_time, guint64 timestamp, guint64 duration) G_GNUC_MALLOC;
509 void gst_message_set_qos_values (GstMessage * message, gint64 jitter, gdouble proportion,
511 void gst_message_set_qos_stats (GstMessage * message, GstFormat format, guint64 processed,
513 void gst_message_parse_qos (GstMessage * message, gboolean * live, guint64 * running_time,
514 guint64 * stream_time, guint64 * timestamp, guint64 * duration);
515 void gst_message_parse_qos_values (GstMessage * message, gint64 * jitter, gdouble * proportion,
517 void gst_message_parse_qos_stats (GstMessage * message, GstFormat * format, guint64 * processed,
520 GstMessage * gst_message_new_progress (GstObject * src, GstProgressType type, const gchar *code,
521 const gchar *text) G_GNUC_MALLOC;
522 void gst_message_parse_progress (GstMessage * message, GstProgressType * type, gchar ** code,
526 /* custom messages */
527 GstMessage * gst_message_new_custom (GstMessageType type,
529 GstStructure * structure) G_GNUC_MALLOC;
530 const GstStructure * gst_message_get_structure (GstMessage *message);
534 #endif /* __GST_MESSAGE_H__ */