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