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
  77  * #GstStateChange. 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
  80  * #GstStateChange. 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 #include <gst/gstquery.h>
 136
 137 /**
 138  * GST_MESSAGE_TRACE_NAME:
 139  *
 140  * The name used for memory allocation tracing
 141  */
 142 #define GST_MESSAGE_TRACE_NAME  "GstMessage"
 143
 144 #define GST_TYPE_MESSAGE                         (gst_message_get_type())
 145 #define GST_IS_MESSAGE(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE))
 146 #define GST_MESSAGE_CAST(obj)                    ((GstMessage*)(obj))
 147 #define GST_MESSAGE(obj)                         (GST_MESSAGE_CAST(obj))
 148
 149 /* the lock is used to handle the synchronous handling of messages,
 150  * the emiting thread is block until the handling thread processed
 151  * the message using this mutex/cond pair */
 152 #define GST_MESSAGE_GET_LOCK(message)   (GST_MESSAGE_CAST(message)->lock)
 153 #define GST_MESSAGE_LOCK(message)       g_mutex_lock(GST_MESSAGE_GET_LOCK(message))
 154 #define GST_MESSAGE_UNLOCK(message)     g_mutex_unlock(GST_MESSAGE_GET_LOCK(message))
 155 #define GST_MESSAGE_COND(message)       (GST_MESSAGE_CAST(message)->cond)
 156 #define GST_MESSAGE_WAIT(message)       g_cond_wait(GST_MESSAGE_COND(message),GST_MESSAGE_GET_LOCK(message))
 157 #define GST_MESSAGE_SIGNAL(message)     g_cond_signal(GST_MESSAGE_COND(message))
 158
 159 /**
 160  * GST_MESSAGE_TYPE:
 161  * @message: a #GstMessage
 162  *
 163  * Get the #GstMessageType of @message.
 164  */
 165 #define GST_MESSAGE_TYPE(message)       (GST_MESSAGE_CAST(message)->type)
 166 /**
 167  * GST_MESSAGE_TYPE_NAME:
 168  * @message: a #GstMessage
 169  *
 170  * Get a constant string representation of the #GstMessageType of @message.
 171  *
 172  * Since: 0.10.4
 173  */
 174 #define GST_MESSAGE_TYPE_NAME(message)  gst_message_type_get_name(GST_MESSAGE_TYPE(message))
 175 /**
 176  * GST_MESSAGE_TIMESTAMP:
 177  * @message: a #GstMessage
 178  *
 179  * Get the timestamp of @message. This is the timestamp when the message
 180  * was created.
 181  */
 182 #define GST_MESSAGE_TIMESTAMP(message)  (GST_MESSAGE_CAST(message)->timestamp)
 183 /**
 184  * GST_MESSAGE_SRC:
 185  * @message: a #GstMessage
 186  *
 187  * Get the object that posted @message.
 188  */
 189 #define GST_MESSAGE_SRC(message)        (GST_MESSAGE_CAST(message)->src)
 190
 191 /**
 192  * GST_MESSAGE_SEQNUM:
 193  * @message: a #GstMessage
 194  *
 195  * Get the sequence number of @message.
 196  */
 197 #define GST_MESSAGE_SEQNUM(message)     (GST_MESSAGE_CAST(message)->seqnum)
 198
 199 /**
 200  * GST_MESSAGE_SRC_NAME:
 201  * @message: a #GstMessage
 202  *
 203  * Get the name of the object that posted @message. Returns "(NULL)" if
 204  * the message has no source object set.
 205  *
 206  * Since: 0.10.24
 207  */
 208 #define GST_MESSAGE_SRC_NAME(message)   (GST_MESSAGE_SRC(message) ? \
 209     GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
 210
 211 /**
 212  * GstStructureChangeType:
 213  * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
 214  * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
 215  *
 216  * The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
 217  *
 218  * Since: 0.10.22
 219  */
 220 typedef enum {
 221   GST_STRUCTURE_CHANGE_TYPE_PAD_LINK   = 0,
 222   GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1
 223 } GstStructureChangeType;
 224
 225 /**
 226  * GstStreamStatusType:
 227  * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created.
 228  * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function
 229  * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function
 230  * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed
 231  * @GST_STREAM_STATUS_TYPE_START: a thread is started
 232  * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
 233  * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
 234  *
 235  * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
 236  * application of new streaming threads and their status.
 237  *
 238  * Since: 0.10.24
 239  */
 240 typedef enum {
 241   GST_STREAM_STATUS_TYPE_CREATE   = 0,
 242   GST_STREAM_STATUS_TYPE_ENTER    = 1,
 243   GST_STREAM_STATUS_TYPE_LEAVE    = 2,
 244   GST_STREAM_STATUS_TYPE_DESTROY  = 3,
 245
 246   GST_STREAM_STATUS_TYPE_START    = 8,
 247   GST_STREAM_STATUS_TYPE_PAUSE    = 9,
 248   GST_STREAM_STATUS_TYPE_STOP     = 10
 249 } GstStreamStatusType;
 250
 251 /**
 252  * GstProgressType:
 253  * @GST_PROGRESS_TYPE_START: A new task started.
 254  * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues.
 255  * @GST_PROGRESS_TYPE_COMPLETE: A task completed.
 256  * @GST_PROGRESS_TYPE_CANCELED: A task was canceled.
 257  * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also
 258  *          posted on the bus.
 259  *
 260  * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
 261  * application of the status of assynchronous tasks.
 262  *
 263  * Since: 0.10.33
 264  */
 265 typedef enum {
 266   GST_PROGRESS_TYPE_START    = 0,
 267   GST_PROGRESS_TYPE_CONTINUE = 1,
 268   GST_PROGRESS_TYPE_COMPLETE = 2,
 269   GST_PROGRESS_TYPE_CANCELED = 3,
 270   GST_PROGRESS_TYPE_ERROR    = 4,
 271 } GstProgressType;
 272
 273 /**
 274  * GstMessage:
 275  * @mini_object: the parent structure
 276  * @type: the #GstMessageType of the message
 277  * @timestamp: the timestamp of the message
 278  * @src: the src of the message
 279  * @seqnum: the sequence number of the message
 280  *
 281  * A #GstMessage.
 282  */
 283 struct _GstMessage
 284 {
 285   GstMiniObject mini_object;
 286
 287   /*< public > *//* with COW */
 288   GstMessageType type;
 289   guint64 timestamp;
 290   GstObject *src;
 291   guint32 seqnum;
 292
 293   /*< private >*//* with MESSAGE_LOCK */
 294   GMutex *lock;                 /* lock and cond for async delivery */
 295   GCond *cond;
 296 };
 297
 298 GType           gst_message_get_type            (void);
 299
 300 const gchar*    gst_message_type_get_name       (GstMessageType type);
 301 GQuark          gst_message_type_to_quark       (GstMessageType type);
 302
 303 /* refcounting */
 304 /**
 305  * gst_message_ref:
 306  * @msg: the message to ref
 307  *
 308  * Convenience macro to increase the reference count of the message.
 309  *
 310  * Returns: @msg (for convenience when doing assignments)
 311  */
 312 #ifdef _FOOL_GTK_DOC_
 313 G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);
 314 #endif
 315
 316 static inline GstMessage *
 317 gst_message_ref (GstMessage * msg)
 318 {
 319   return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg));
 320 }
 321
 322 /**
 323  * gst_message_unref:
 324  * @msg: the message to unref
 325  *
 326  * Convenience macro to decrease the reference count of the message, possibly
 327  * freeing it.
 328  */
 329 #ifdef _FOOL_GTK_DOC_
 330 G_INLINE_FUNC void gst_message_unref (GstMessage * msg);
 331 #endif
 332
 333 static inline void
 334 gst_message_unref (GstMessage * msg)
 335 {
 336   gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg));
 337 }
 338
 339 /* copy message */
 340 /**
 341  * gst_message_copy:
 342  * @msg: the message to copy
 343  *
 344  * Creates a copy of the message. Returns a copy of the message.
 345  *
 346  * Returns: (transfer full): a new copy of @msg.
 347  *
 348  * MT safe
 349  */
 350 #ifdef _FOOL_GTK_DOC_
 351 G_INLINE_FUNC GstMessage * gst_message_copy (const GstMessage * msg);
 352 #endif
 353
 354 static inline GstMessage *
 355 gst_message_copy (const GstMessage * msg)
 356 {
 357   return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg)));
 358 }
 359
 360 /**
 361  * gst_message_is_writable:
 362  * @msg: a #GstMessage
 363  *
 364  * Tests if you can safely write into a message's structure or validly
 365  * modify the seqnum and timestamp fields.
 366  */
 367 #define         gst_message_is_writable(msg)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (msg))
 368 /**
 369  * gst_message_make_writable:
 370  * @msg: (transfer full): the message to make writable
 371  *
 372  * Checks if a message is writable. If not, a writable copy is made and
 373  * returned.
 374  *
 375  * Returns: (transfer full): a message (possibly a duplicate) that is writable.
 376  *
 377  * MT safe
 378  */
 379 #define         gst_message_make_writable(msg)  GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
 380 /**
 381  * gst_message_replace:
 382  * @old_message: (inout) (transfer full): pointer to a pointer to a #GstMessage
 383  *     to be replaced.
 384  * @new_message: (allow-none) (transfer none): pointer to a #GstMessage that will
 385  *     replace the message pointed to by @old_message.
 386  *
 387  * Modifies a pointer to a #GstMessage to point to a different #GstMessage. The
 388  * modification is done atomically (so this is useful for ensuring thread safety
 389  * in some cases), and the reference counts are updated appropriately (the old
 390  * message is unreffed, the new one is reffed).
 391  *
 392  * Either @new_message or the #GstMessage pointed to by @old_message may be NULL.
 393  *
 394  * Returns: TRUE if @new_message was different from @old_message
 395  */
 396 #ifdef _FOOL_GTK_DOC_
 397 G_INLINE_FUNC gboolean gst_message_replace (GstMessage **old_message, GstMessage *new_message);
 398 #endif
 399
 400 static inline gboolean
 401 gst_message_replace (GstMessage **old_message, GstMessage *new_message)
 402 {
 403   return gst_mini_object_replace ((GstMiniObject **) old_message, (GstMiniObject *) new_message);
 404 }
 405
 406
 407 /* custom messages */
 408 GstMessage *    gst_message_new_custom          (GstMessageType type,
 409                                                  GstObject    * src,
 410                                                  GstStructure * structure) G_GNUC_MALLOC;
 411 const GstStructure *
 412                 gst_message_get_structure       (GstMessage *message);
 413
 414 gboolean        gst_message_has_name            (GstMessage *message, const gchar *name);
 415
 416 /* identifiers for events and messages */
 417 guint32         gst_message_get_seqnum          (GstMessage *message);
 418 void            gst_message_set_seqnum          (GstMessage *message, guint32 seqnum);
 419
 420 /* EOS */
 421 GstMessage *    gst_message_new_eos             (GstObject * src) G_GNUC_MALLOC;
 422
 423 /* ERROR */
 424
 425 GstMessage *    gst_message_new_error           (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 426 void            gst_message_parse_error         (GstMessage *message, GError **gerror, gchar **debug);
 427
 428 /* WARNING */
 429 GstMessage *    gst_message_new_warning         (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 430 void            gst_message_parse_warning       (GstMessage *message, GError **gerror, gchar **debug);
 431
 432 /* INFO */
 433 GstMessage *    gst_message_new_info            (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 434 void            gst_message_parse_info          (GstMessage *message, GError **gerror, gchar **debug);
 435
 436 /* TAG */
 437 GstMessage *    gst_message_new_tag             (GstObject * src, GstTagList * tag_list) G_GNUC_MALLOC;
 438 void            gst_message_parse_tag           (GstMessage *message, GstTagList **tag_list);
 439
 440 /* BUFFERING */
 441 GstMessage *    gst_message_new_buffering         (GstObject * src, gint percent) G_GNUC_MALLOC;
 442 void            gst_message_parse_buffering       (GstMessage *message, gint *percent);
 443 void            gst_message_set_buffering_stats   (GstMessage *message, GstBufferingMode mode,
 444                                                    gint avg_in, gint avg_out,
 445                                                    gint64 buffering_left);
 446 void            gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode,
 447                                                    gint *avg_in, gint *avg_out,
 448                                                    gint64 *buffering_left);
 449
 450 /* STATE_CHANGED */
 451 GstMessage *    gst_message_new_state_changed   (GstObject * src, GstState oldstate,
 452                                                  GstState newstate, GstState pending) G_GNUC_MALLOC;
 453 void            gst_message_parse_state_changed (GstMessage *message, GstState *oldstate,
 454                                                  GstState *newstate, GstState *pending);
 455
 456 /* STATE_DIRTY */
 457 GstMessage *    gst_message_new_state_dirty     (GstObject * src) G_GNUC_MALLOC;
 458
 459 /* STEP_DONE */
 460 GstMessage *    gst_message_new_step_done       (GstObject * src, GstFormat format, guint64 amount,
 461                                                  gdouble rate, gboolean flush, gboolean intermediate,
 462                                                  guint64 duration, gboolean eos) G_GNUC_MALLOC;
 463 void            gst_message_parse_step_done     (GstMessage * message, GstFormat *format, guint64 *amount,
 464                                                  gdouble *rate, gboolean *flush, gboolean *intermediate,
 465                                                  guint64 *duration, gboolean *eos);
 466 /* CLOCK_PROVIDE */
 467 GstMessage *    gst_message_new_clock_provide   (GstObject * src, GstClock *clock, gboolean ready) G_GNUC_MALLOC;
 468 void            gst_message_parse_clock_provide (GstMessage *message, GstClock **clock,
 469                                                  gboolean *ready);
 470
 471 /* CLOCK_LOST */
 472 GstMessage *    gst_message_new_clock_lost      (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
 473 void            gst_message_parse_clock_lost    (GstMessage *message, GstClock **clock);
 474
 475 /* NEW_CLOCK */
 476 GstMessage *    gst_message_new_new_clock       (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
 477 void            gst_message_parse_new_clock     (GstMessage *message, GstClock **clock);
 478
 479 /* APPLICATION */
 480 GstMessage *    gst_message_new_application     (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
 481
 482 /* ELEMENT */
 483 GstMessage *    gst_message_new_element         (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
 484
 485 /* SEGMENT_START */
 486 GstMessage *    gst_message_new_segment_start   (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
 487 void            gst_message_parse_segment_start (GstMessage *message, GstFormat *format,
 488                                                  gint64 *position);
 489
 490 /* SEGMENT_DONE */
 491 GstMessage *    gst_message_new_segment_done    (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
 492 void            gst_message_parse_segment_done  (GstMessage *message, GstFormat *format,
 493                                                  gint64 *position);
 494
 495 /* DURATION */
 496 GstMessage *    gst_message_new_duration        (GstObject * src, GstFormat format, gint64 duration) G_GNUC_MALLOC;
 497 void            gst_message_parse_duration      (GstMessage *message, GstFormat *format,
 498                                                  gint64 *duration);
 499
 500 /* LATENCY */
 501 GstMessage *    gst_message_new_latency         (GstObject * src) G_GNUC_MALLOC;
 502
 503 /* ASYNC_START */
 504 GstMessage *    gst_message_new_async_start     (GstObject * src) G_GNUC_MALLOC;
 505
 506 /* ASYNC_DONE */
 507 GstMessage *    gst_message_new_async_done      (GstObject * src, gboolean reset_time) G_GNUC_MALLOC;
 508 void            gst_message_parse_async_done    (GstMessage *message, gboolean *reset_time);
 509
 510 /* STRUCTURE CHANGE */
 511 GstMessage *    gst_message_new_structure_change   (GstObject * src, GstStructureChangeType type,
 512                                                     GstElement *owner, gboolean busy) G_GNUC_MALLOC;
 513 void            gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type,
 514                                                     GstElement **owner, gboolean *busy);
 515
 516 /* STREAM STATUS */
 517 GstMessage *    gst_message_new_stream_status        (GstObject * src, GstStreamStatusType type,
 518                                                       GstElement *owner) G_GNUC_MALLOC;
 519 void            gst_message_parse_stream_status      (GstMessage *message, GstStreamStatusType *type,
 520                                                       GstElement **owner);
 521 void            gst_message_set_stream_status_object (GstMessage *message, const GValue *object);
 522 const GValue *  gst_message_get_stream_status_object (GstMessage *message);
 523
 524 /* REQUEST_STATE */
 525 GstMessage *    gst_message_new_request_state   (GstObject * src, GstState state) G_GNUC_MALLOC;
 526 void            gst_message_parse_request_state (GstMessage * message, GstState *state);
 527
 528 /* STEP_START */
 529 GstMessage *    gst_message_new_step_start      (GstObject * src, gboolean active, GstFormat format,
 530                                                  guint64 amount, gdouble rate, gboolean flush,
 531                                                  gboolean intermediate) G_GNUC_MALLOC;
 532 void            gst_message_parse_step_start    (GstMessage * message, gboolean *active, GstFormat *format,
 533                                                  guint64 *amount, gdouble *rate, gboolean *flush,
 534                                                  gboolean *intermediate);
 535
 536 /* QOS */
 537 GstMessage *    gst_message_new_qos             (GstObject * src, gboolean live, guint64 running_time,
 538                                                  guint64 stream_time, guint64 timestamp, guint64 duration) G_GNUC_MALLOC;
 539 void            gst_message_set_qos_values      (GstMessage * message, gint64 jitter, gdouble proportion,
 540                                                  gint quality);
 541 void            gst_message_set_qos_stats       (GstMessage * message, GstFormat format, guint64 processed,
 542                                                  guint64 dropped);
 543 void            gst_message_parse_qos           (GstMessage * message, gboolean * live, guint64 * running_time,
 544                                                  guint64 * stream_time, guint64 * timestamp, guint64 * duration);
 545 void            gst_message_parse_qos_values    (GstMessage * message, gint64 * jitter, gdouble * proportion,
 546                                                  gint * quality);
 547 void            gst_message_parse_qos_stats     (GstMessage * message, GstFormat * format, guint64 * processed,
 548                                                  guint64 * dropped);
 549 /* PROGRESS */
 550 GstMessage *    gst_message_new_progress           (GstObject * src, GstProgressType type, const gchar *code,
 551                                                     const gchar *text) G_GNUC_MALLOC;
 552 void            gst_message_parse_progress         (GstMessage * message, GstProgressType * type, gchar ** code,
 553                                                     gchar ** text);
 554
 555
 556 G_END_DECLS
 557
 558 #endif /* __GST_MESSAGE_H__ */