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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, 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 occured. 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 occured.
  40  * @GST_MESSAGE_INFO: an info message occured
  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: The duration of a pipeline changed. The application
  75  * can get the new duration with a duration query.
  76  * @GST_MESSAGE_ASYNC_START: Posted by elements when they start an ASYNC state
  77  * change. This message is not forwarded to the application but is used
  78  * internally. Since: 0.10.13.
  79  * @GST_MESSAGE_ASYNC_DONE: Posted by elements when they complete an ASYNC state
  80  * change. The application will only receive this message from the toplevel
  81  * pipeline. Since: 0.10.13
  82  * @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The
  83  * application should recalculate and distribute a new latency. Since: 0.10.12
  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. Since: 0.10.23.
  87  * @GST_MESSAGE_STEP_START: A stepping operation was started. Since: 0.10.24
  88  * @GST_MESSAGE_QOS: A buffer was dropped or an element changed its processing
  89  * strategy for Quality of Service reasons. Since: 0.10.29
  90  * @GST_MESSAGE_PROGRESS: A progress message. Since: 0.10.33
  91  * @GST_MESSAGE_ANY: mask for all of the above messages.
  92  *
  93  * The different message types that are available.
  94  */
  95 /* NOTE: keep in sync with quark registration in gstmessage.c
  96  * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings.
  97  */
  98 typedef enum
  99 {
 100   GST_MESSAGE_UNKNOWN           = 0,
 101   GST_MESSAGE_EOS               = (1 << 0),
 102   GST_MESSAGE_ERROR             = (1 << 1),
 103   GST_MESSAGE_WARNING           = (1 << 2),
 104   GST_MESSAGE_INFO              = (1 << 3),
 105   GST_MESSAGE_TAG               = (1 << 4),
 106   GST_MESSAGE_BUFFERING         = (1 << 5),
 107   GST_MESSAGE_STATE_CHANGED     = (1 << 6),
 108   GST_MESSAGE_STATE_DIRTY       = (1 << 7),
 109   GST_MESSAGE_STEP_DONE         = (1 << 8),
 110   GST_MESSAGE_CLOCK_PROVIDE     = (1 << 9),
 111   GST_MESSAGE_CLOCK_LOST        = (1 << 10),
 112   GST_MESSAGE_NEW_CLOCK         = (1 << 11),
 113   GST_MESSAGE_STRUCTURE_CHANGE  = (1 << 12),
 114   GST_MESSAGE_STREAM_STATUS     = (1 << 13),
 115   GST_MESSAGE_APPLICATION       = (1 << 14),
 116   GST_MESSAGE_ELEMENT           = (1 << 15),
 117   GST_MESSAGE_SEGMENT_START     = (1 << 16),
 118   GST_MESSAGE_SEGMENT_DONE      = (1 << 17),
 119   GST_MESSAGE_DURATION          = (1 << 18),
 120   GST_MESSAGE_LATENCY           = (1 << 19),
 121   GST_MESSAGE_ASYNC_START       = (1 << 20),
 122   GST_MESSAGE_ASYNC_DONE        = (1 << 21),
 123   GST_MESSAGE_REQUEST_STATE     = (1 << 22),
 124   GST_MESSAGE_STEP_START        = (1 << 23),
 125   GST_MESSAGE_QOS               = (1 << 24),
 126   GST_MESSAGE_PROGRESS          = (1 << 25),
 127   GST_MESSAGE_ANY               = ~0
 128 } GstMessageType;
 129
 130 #include <gst/gstminiobject.h>
 131 #include <gst/gstobject.h>
 132 #include <gst/gstelement.h>
 133 #include <gst/gsttaglist.h>
 134 #include <gst/gststructure.h>
 135
 136 /**
 137  * GST_MESSAGE_TRACE_NAME:
 138  *
 139  * The name used for memory allocation tracing
 140  */
 141 #define GST_MESSAGE_TRACE_NAME  "GstMessage"
 142
 143 #define GST_TYPE_MESSAGE                         (gst_message_get_type())
 144 #define GST_IS_MESSAGE(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE))
 145 #define GST_MESSAGE_CAST(obj)                    ((GstMessage*)(obj))
 146 #define GST_MESSAGE(obj)                         (GST_MESSAGE_CAST(obj))
 147
 148 /* the lock is used to handle the synchronous handling of messages,
 149  * the emiting thread is block until the handling thread processed
 150  * the message using this mutex/cond pair */
 151 #define GST_MESSAGE_GET_LOCK(message)   (GST_MESSAGE_CAST(message)->lock)
 152 #define GST_MESSAGE_LOCK(message)       g_mutex_lock(GST_MESSAGE_GET_LOCK(message))
 153 #define GST_MESSAGE_UNLOCK(message)     g_mutex_unlock(GST_MESSAGE_GET_LOCK(message))
 154 #define GST_MESSAGE_COND(message)       (GST_MESSAGE_CAST(message)->cond)
 155 #define GST_MESSAGE_WAIT(message)       g_cond_wait(GST_MESSAGE_COND(message),GST_MESSAGE_GET_LOCK(message))
 156 #define GST_MESSAGE_SIGNAL(message)     g_cond_signal(GST_MESSAGE_COND(message))
 157
 158 /**
 159  * GST_MESSAGE_TYPE:
 160  * @message: a #GstMessage
 161  *
 162  * Get the #GstMessageType of @message.
 163  */
 164 #define GST_MESSAGE_TYPE(message)       (GST_MESSAGE_CAST(message)->type)
 165 /**
 166  * GST_MESSAGE_TYPE_NAME:
 167  * @message: a #GstMessage
 168  *
 169  * Get a constant string representation of the #GstMessageType of @message.
 170  *
 171  * Since: 0.10.4
 172  */
 173 #define GST_MESSAGE_TYPE_NAME(message)  gst_message_type_get_name(GST_MESSAGE_TYPE(message))
 174 /**
 175  * GST_MESSAGE_TIMESTAMP:
 176  * @message: a #GstMessage
 177  *
 178  * Get the timestamp of @message. This is the timestamp when the message
 179  * was created.
 180  */
 181 #define GST_MESSAGE_TIMESTAMP(message)  (GST_MESSAGE_CAST(message)->timestamp)
 182 /**
 183  * GST_MESSAGE_SRC:
 184  * @message: a #GstMessage
 185  *
 186  * Get the object that posted @message.
 187  */
 188 #define GST_MESSAGE_SRC(message)        (GST_MESSAGE_CAST(message)->src)
 189
 190 /**
 191  * GST_MESSAGE_SEQNUM:
 192  * @message: a #GstMessage
 193  *
 194  * Get the sequence number of @message.
 195  */
 196 #define GST_MESSAGE_SEQNUM(message)     (GST_MESSAGE_CAST(message)->seqnum)
 197
 198 /**
 199  * GST_MESSAGE_SRC_NAME:
 200  * @message: a #GstMessage
 201  *
 202  * Get the name of the object that posted @message. Returns "(NULL)" if
 203  * the message has no source object set.
 204  *
 205  * Since: 0.10.24
 206  */
 207 #define GST_MESSAGE_SRC_NAME(message)   (GST_MESSAGE_SRC(message) ? \
 208     GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
 209
 210 /**
 211  * GstStructureChangeType:
 212  * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
 213  * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
 214  *
 215  * The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
 216  *
 217  * Since: 0.10.22
 218  */
 219 typedef enum {
 220   GST_STRUCTURE_CHANGE_TYPE_PAD_LINK   = 0,
 221   GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1
 222 } GstStructureChangeType;
 223
 224 /**
 225  * GstStreamStatusType:
 226  * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created.
 227  * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function
 228  * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function
 229  * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed
 230  * @GST_STREAM_STATUS_TYPE_START: a thread is started
 231  * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
 232  * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
 233  *
 234  * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
 235  * application of new streaming threads and their status.
 236  *
 237  * Since: 0.10.24
 238  */
 239 typedef enum {
 240   GST_STREAM_STATUS_TYPE_CREATE   = 0,
 241   GST_STREAM_STATUS_TYPE_ENTER    = 1,
 242   GST_STREAM_STATUS_TYPE_LEAVE    = 2,
 243   GST_STREAM_STATUS_TYPE_DESTROY  = 3,
 244
 245   GST_STREAM_STATUS_TYPE_START    = 8,
 246   GST_STREAM_STATUS_TYPE_PAUSE    = 9,
 247   GST_STREAM_STATUS_TYPE_STOP     = 10
 248 } GstStreamStatusType;
 249
 250 /**
 251  * GstProgressType:
 252  * @GST_PROGRESS_TYPE_START: A new task started.
 253  * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues.
 254  * @GST_PROGRESS_TYPE_COMPLETE: A task completed.
 255  * @GST_PROGRESS_TYPE_CANCELED: A task was canceled.
 256  * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also
 257  *          posted on the bus.
 258  *
 259  * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
 260  * application of the status of assynchronous tasks.
 261  *
 262  * Since: 0.10.33
 263  */
 264 typedef enum {
 265   GST_PROGRESS_TYPE_START    = 0,
 266   GST_PROGRESS_TYPE_CONTINUE = 1,
 267   GST_PROGRESS_TYPE_COMPLETE = 2,
 268   GST_PROGRESS_TYPE_CANCELED = 3,
 269   GST_PROGRESS_TYPE_ERROR    = 4,
 270 } GstProgressType;
 271
 272 /**
 273  * GstMessage:
 274  * @mini_object: the parent structure
 275  * @type: the #GstMessageType of the message
 276  * @timestamp: the timestamp of the message
 277  * @src: the src of the message
 278  * @structure: the #GstStructure containing the message info.
 279  *
 280  * A #GstMessage.
 281  */
 282 struct _GstMessage
 283 {
 284   GstMiniObject mini_object;
 285
 286   /*< private >*//* with MESSAGE_LOCK */
 287   GMutex *lock;                 /* lock and cond for async delivery */
 288   GCond *cond;
 289
 290   /*< public > *//* with COW */
 291   GstMessageType type;
 292   guint64 timestamp;
 293   GstObject *src;
 294   guint32 seqnum;
 295
 296   GstStructure *structure;
 297
 298   /*< private >*/
 299   gpointer _gst_reserved[GST_PADDING];
 300 };
 301
 302 GType           gst_message_get_type            (void);
 303
 304 const gchar*    gst_message_type_get_name       (GstMessageType type);
 305 GQuark          gst_message_type_to_quark       (GstMessageType type);
 306
 307 /* refcounting */
 308 /**
 309  * gst_message_ref:
 310  * @msg: the message to ref
 311  *
 312  * Convenience macro to increase the reference count of the message.
 313  *
 314  * Returns: @msg (for convenience when doing assignments)
 315  */
 316 #ifdef _FOOL_GTK_DOC_
 317 G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);
 318 #endif
 319
 320 static inline GstMessage *
 321 gst_message_ref (GstMessage * msg)
 322 {
 323   return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg));
 324 }
 325
 326 /**
 327  * gst_message_unref:
 328  * @msg: the message to unref
 329  *
 330  * Convenience macro to decrease the reference count of the message, possibly
 331  * freeing it.
 332  */
 333 #ifdef _FOOL_GTK_DOC_
 334 G_INLINE_FUNC void gst_message_unref (GstMessage * msg);
 335 #endif
 336
 337 static inline void
 338 gst_message_unref (GstMessage * msg)
 339 {
 340   gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg));
 341 }
 342
 343 /* copy message */
 344 /**
 345  * gst_message_copy:
 346  * @msg: the message to copy
 347  *
 348  * Creates a copy of the message. Returns a copy of the message.
 349  *
 350  * Returns: (transfer full): a new copy of @msg.
 351  *
 352  * MT safe
 353  */
 354 #ifdef _FOOL_GTK_DOC_
 355 G_INLINE_FUNC GstMessage * gst_message_copy (const GstMessage * msg);
 356 #endif
 357
 358 static inline GstMessage *
 359 gst_message_copy (const GstMessage * msg)
 360 {
 361   return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg)));
 362 }
 363
 364 /**
 365  * gst_message_make_writable:
 366  * @msg: (transfer full): the message to make writable
 367  *
 368  * Checks if a message is writable. If not, a writable copy is made and
 369  * returned.
 370  *
 371  * Returns: (transfer full): a message (possibly a duplicate) that is writable.
 372  *
 373  * MT safe
 374  */
 375 #define         gst_message_make_writable(msg)  GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
 376
 377 /* identifiers for events and messages */
 378 guint32         gst_message_get_seqnum          (GstMessage *message);
 379 void            gst_message_set_seqnum          (GstMessage *message, guint32 seqnum);
 380
 381 /* EOS */
 382 GstMessage *    gst_message_new_eos             (GstObject * src);
 383
 384 /* ERROR */
 385
 386 GstMessage *    gst_message_new_error           (GstObject * src, GError * error, const gchar * debug);
 387 void            gst_message_parse_error         (GstMessage *message, GError **gerror, gchar **debug);
 388
 389 /* WARNING */
 390 GstMessage *    gst_message_new_warning         (GstObject * src, GError * error, const gchar * debug);
 391 void            gst_message_parse_warning       (GstMessage *message, GError **gerror, gchar **debug);
 392
 393 /* INFO */
 394 GstMessage *    gst_message_new_info            (GstObject * src, GError * error, const gchar * debug);
 395 void            gst_message_parse_info          (GstMessage *message, GError **gerror, gchar **debug);
 396
 397 /* TAG */
 398 GstMessage *    gst_message_new_tag             (GstObject * src, GstTagList * tag_list);
 399 GstMessage *    gst_message_new_tag_full        (GstObject * src, GstPad *pad, GstTagList * tag_list);
 400 void            gst_message_parse_tag           (GstMessage *message, GstTagList **tag_list);
 401 void            gst_message_parse_tag_full      (GstMessage *message, GstPad **pad, GstTagList **tag_list);
 402
 403 /* BUFFERING */
 404 GstMessage *    gst_message_new_buffering         (GstObject * src, gint percent);
 405 void            gst_message_parse_buffering       (GstMessage *message, gint *percent);
 406 void            gst_message_set_buffering_stats   (GstMessage *message, GstBufferingMode mode,
 407                                                    gint avg_in, gint avg_out,
 408                                                    gint64 buffering_left);
 409 void            gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode,
 410                                                    gint *avg_in, gint *avg_out,
 411                                                    gint64 *buffering_left);
 412
 413 /* STATE_CHANGED */
 414 GstMessage *    gst_message_new_state_changed   (GstObject * src, GstState oldstate,
 415                                                  GstState newstate, GstState pending);
 416 void            gst_message_parse_state_changed (GstMessage *message, GstState *oldstate,
 417                                                  GstState *newstate, GstState *pending);
 418
 419 /* STATE_DIRTY */
 420 GstMessage *    gst_message_new_state_dirty     (GstObject * src);
 421
 422 /* STEP_DONE */
 423 GstMessage *    gst_message_new_step_done       (GstObject * src, GstFormat format, guint64 amount,
 424                                                  gdouble rate, gboolean flush, gboolean intermediate,
 425                                                  guint64 duration, gboolean eos);
 426 void            gst_message_parse_step_done     (GstMessage * message, GstFormat *format, guint64 *amount,
 427                                                  gdouble *rate, gboolean *flush, gboolean *intermediate,
 428                                                  guint64 *duration, gboolean *eos);
 429 /* CLOCK_PROVIDE */
 430 GstMessage *    gst_message_new_clock_provide   (GstObject * src, GstClock *clock, gboolean ready);
 431 void            gst_message_parse_clock_provide (GstMessage *message, GstClock **clock,
 432                                                  gboolean *ready);
 433
 434 /* CLOCK_LOST */
 435 GstMessage *    gst_message_new_clock_lost      (GstObject * src, GstClock *clock);
 436 void            gst_message_parse_clock_lost    (GstMessage *message, GstClock **clock);
 437
 438 /* NEW_CLOCK */
 439 GstMessage *    gst_message_new_new_clock       (GstObject * src, GstClock *clock);
 440 void            gst_message_parse_new_clock     (GstMessage *message, GstClock **clock);
 441
 442 /* APPLICATION */
 443 GstMessage *    gst_message_new_application     (GstObject * src, GstStructure * structure);
 444
 445 /* ELEMENT */
 446 GstMessage *    gst_message_new_element         (GstObject * src, GstStructure * structure);
 447
 448 /* SEGMENT_START */
 449 GstMessage *    gst_message_new_segment_start   (GstObject * src, GstFormat format, gint64 position);
 450 void            gst_message_parse_segment_start (GstMessage *message, GstFormat *format,
 451                                                  gint64 *position);
 452
 453 /* SEGMENT_DONE */
 454 GstMessage *    gst_message_new_segment_done    (GstObject * src, GstFormat format, gint64 position);
 455 void            gst_message_parse_segment_done  (GstMessage *message, GstFormat *format,
 456                                                  gint64 *position);
 457
 458 /* DURATION */
 459 GstMessage *    gst_message_new_duration        (GstObject * src, GstFormat format, gint64 duration);
 460 void            gst_message_parse_duration      (GstMessage *message, GstFormat *format,
 461                                                  gint64 *duration);
 462
 463 /* LATENCY */
 464 GstMessage *    gst_message_new_latency         (GstObject * src);
 465
 466 /* ASYNC_START */
 467 GstMessage *    gst_message_new_async_start     (GstObject * src, gboolean new_base_time);
 468 void            gst_message_parse_async_start   (GstMessage *message, gboolean *new_base_time);
 469
 470 /* ASYNC_DONE */
 471 GstMessage *    gst_message_new_async_done      (GstObject * src);
 472
 473 /* STRUCTURE CHANGE */
 474 GstMessage *    gst_message_new_structure_change   (GstObject * src, GstStructureChangeType type,
 475                                                     GstElement *owner, gboolean busy);
 476 void            gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type,
 477                                                     GstElement **owner, gboolean *busy);
 478
 479 /* STREAM STATUS */
 480 GstMessage *    gst_message_new_stream_status        (GstObject * src, GstStreamStatusType type,
 481                                                       GstElement *owner);
 482 void            gst_message_parse_stream_status      (GstMessage *message, GstStreamStatusType *type,
 483                                                       GstElement **owner);
 484 void            gst_message_set_stream_status_object (GstMessage *message, const GValue *object);
 485 const GValue *  gst_message_get_stream_status_object (GstMessage *message);
 486
 487 /* REQUEST_STATE */
 488 GstMessage *    gst_message_new_request_state   (GstObject * src, GstState state);
 489 void            gst_message_parse_request_state (GstMessage * message, GstState *state);
 490
 491 /* STEP_START */
 492 GstMessage *    gst_message_new_step_start      (GstObject * src, gboolean active, GstFormat format,
 493                                                  guint64 amount, gdouble rate, gboolean flush,
 494                                                  gboolean intermediate);
 495 void            gst_message_parse_step_start    (GstMessage * message, gboolean *active, GstFormat *format,
 496                                                  guint64 *amount, gdouble *rate, gboolean *flush,
 497                                                  gboolean *intermediate);
 498
 499 /* QOS */
 500 GstMessage *    gst_message_new_qos             (GstObject * src, gboolean live, guint64 running_time,
 501                                                  guint64 stream_time, guint64 timestamp, guint64 duration);
 502 void            gst_message_set_qos_values      (GstMessage * message, gint64 jitter, gdouble proportion,
 503                                                  gint quality);
 504 void            gst_message_set_qos_stats       (GstMessage * message, GstFormat format, guint64 processed,
 505                                                  guint64 dropped);
 506 void            gst_message_parse_qos           (GstMessage * message, gboolean * live, guint64 * running_time,
 507                                                  guint64 * stream_time, guint64 * timestamp, guint64 * duration);
 508 void            gst_message_parse_qos_values    (GstMessage * message, gint64 * jitter, gdouble * proportion,
 509                                                  gint * quality);
 510 void            gst_message_parse_qos_stats     (GstMessage * message, GstFormat * format, guint64 * processed,
 511                                                  guint64 * dropped);
 512 /* PROGRESS */
 513 GstMessage *    gst_message_new_progress           (GstObject * src, GstProgressType type, const gchar *code,
 514                                                     const gchar *text);
 515 void            gst_message_parse_progress         (GstMessage * message, GstProgressType * type, gchar ** code,
 516                                                     gchar ** text);
 517
 518
 519 /* custom messages */
 520 GstMessage *    gst_message_new_custom          (GstMessageType type,
 521                                                  GstObject    * src,
 522                                                  GstStructure * structure);
 523 const GstStructure *  gst_message_get_structure (GstMessage *message);
 524
 525 G_END_DECLS
 526
 527 #endif /* __GST_MESSAGE_H__ */