gst/gstmessage.h

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