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_STREAM_COLLECTION: Message indicating a new #GstStreamCollection
 114  *     is available (Since 1.10)
 115  * @GST_MESSAGE_STREAMS_SELECTED: Message indicating the active selection of
 116  *     #GstStreams has changed (Since 1.10)
 117  * @GST_MESSAGE_REDIRECT: Message indicating to request the application to
 118  *     try to play the given URL(s). Useful if for example a HTTP 302/303
 119  *     response is received with a non-HTTP URL inside. (Since 1.10)
 120  * @GST_MESSAGE_ANY: mask for all of the above messages.
 121  *
 122  * The different message types that are available.
 123  */
 124 /* NOTE: keep in sync with quark registration in gstmessage.c
 125  * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings.
 126  */
 127 /* FIXME: 2.0: Make it NOT flags, just a regular 1,2,3,4.. enumeration */
 128 /* FIXME: For GST_MESSAGE_ANY ~0 -> 0xffffffff see
 129  *        https://bugzilla.gnome.org/show_bug.cgi?id=732633
 130  */
 131 typedef enum
 132 {
 133   GST_MESSAGE_UNKNOWN           = 0,
 134   GST_MESSAGE_EOS               = (1 << 0),
 135   GST_MESSAGE_ERROR             = (1 << 1),
 136   GST_MESSAGE_WARNING           = (1 << 2),
 137   GST_MESSAGE_INFO              = (1 << 3),
 138   GST_MESSAGE_TAG               = (1 << 4),
 139   GST_MESSAGE_BUFFERING         = (1 << 5),
 140   GST_MESSAGE_STATE_CHANGED     = (1 << 6),
 141   GST_MESSAGE_STATE_DIRTY       = (1 << 7),
 142   GST_MESSAGE_STEP_DONE         = (1 << 8),
 143   GST_MESSAGE_CLOCK_PROVIDE     = (1 << 9),
 144   GST_MESSAGE_CLOCK_LOST        = (1 << 10),
 145   GST_MESSAGE_NEW_CLOCK         = (1 << 11),
 146   GST_MESSAGE_STRUCTURE_CHANGE  = (1 << 12),
 147   GST_MESSAGE_STREAM_STATUS     = (1 << 13),
 148   GST_MESSAGE_APPLICATION       = (1 << 14),
 149   GST_MESSAGE_ELEMENT           = (1 << 15),
 150   GST_MESSAGE_SEGMENT_START     = (1 << 16),
 151   GST_MESSAGE_SEGMENT_DONE      = (1 << 17),
 152   GST_MESSAGE_DURATION_CHANGED  = (1 << 18),
 153   GST_MESSAGE_LATENCY           = (1 << 19),
 154   GST_MESSAGE_ASYNC_START       = (1 << 20),
 155   GST_MESSAGE_ASYNC_DONE        = (1 << 21),
 156   GST_MESSAGE_REQUEST_STATE     = (1 << 22),
 157   GST_MESSAGE_STEP_START        = (1 << 23),
 158   GST_MESSAGE_QOS               = (1 << 24),
 159   GST_MESSAGE_PROGRESS          = (1 << 25),
 160   GST_MESSAGE_TOC               = (1 << 26),
 161   GST_MESSAGE_RESET_TIME        = (1 << 27),
 162   GST_MESSAGE_STREAM_START      = (1 << 28),
 163   GST_MESSAGE_NEED_CONTEXT      = (1 << 29),
 164   GST_MESSAGE_HAVE_CONTEXT      = (1 << 30),
 165   GST_MESSAGE_EXTENDED          = (gint) (1u << 31),
 166   GST_MESSAGE_DEVICE_ADDED      = GST_MESSAGE_EXTENDED + 1,
 167   GST_MESSAGE_DEVICE_REMOVED    = GST_MESSAGE_EXTENDED + 2,
 168   GST_MESSAGE_PROPERTY_NOTIFY   = GST_MESSAGE_EXTENDED + 3,
 169   GST_MESSAGE_STREAM_COLLECTION = GST_MESSAGE_EXTENDED + 4,
 170   GST_MESSAGE_STREAMS_SELECTED  = GST_MESSAGE_EXTENDED + 5,
 171   GST_MESSAGE_REDIRECT          = GST_MESSAGE_EXTENDED + 6,
 172   GST_MESSAGE_ANY               = (gint) (0xffffffff)
 173 } GstMessageType;
 174
 175 #include <gst/gstminiobject.h>
 176 #include <gst/gstobject.h>
 177 #include <gst/gstelement.h>
 178 #include <gst/gsttaglist.h>
 179 #include <gst/gststructure.h>
 180 #include <gst/gstquery.h>
 181 #include <gst/gsttoc.h>
 182 #include <gst/gstdevice.h>
 183 #include <gst/gststreamcollection.h>
 184
 185 GST_EXPORT GType _gst_message_type;
 186
 187 #define GST_TYPE_MESSAGE                         (_gst_message_type)
 188 #define GST_IS_MESSAGE(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE))
 189 #define GST_MESSAGE_CAST(obj)                    ((GstMessage*)(obj))
 190 #define GST_MESSAGE(obj)                         (GST_MESSAGE_CAST(obj))
 191
 192 /* the lock is used to handle the synchronous handling of messages,
 193  * the emiting thread is block until the handling thread processed
 194  * the message using this mutex/cond pair */
 195 #define GST_MESSAGE_GET_LOCK(message)   (&GST_MESSAGE_CAST(message)->lock)
 196 #define GST_MESSAGE_LOCK(message)       g_mutex_lock(GST_MESSAGE_GET_LOCK(message))
 197 #define GST_MESSAGE_UNLOCK(message)     g_mutex_unlock(GST_MESSAGE_GET_LOCK(message))
 198 #define GST_MESSAGE_GET_COND(message)   (&GST_MESSAGE_CAST(message)->cond)
 199 #define GST_MESSAGE_WAIT(message)       g_cond_wait(GST_MESSAGE_GET_COND(message),GST_MESSAGE_GET_LOCK(message))
 200 #define GST_MESSAGE_SIGNAL(message)     g_cond_signal(GST_MESSAGE_GET_COND(message))
 201
 202 /**
 203  * GST_MESSAGE_TYPE:
 204  * @message: a #GstMessage
 205  *
 206  * Get the #GstMessageType of @message.
 207  */
 208 #define GST_MESSAGE_TYPE(message)       (GST_MESSAGE_CAST(message)->type)
 209 /**
 210  * GST_MESSAGE_TYPE_IS_EXTENDED:
 211  * @message: a #GstMessage
 212  *
 213  * Check if the message is in the extended message group
 214  * Since: 1.4
 215  */
 216 #define GST_MESSAGE_TYPE_IS_EXTENDED(message)       (!!(GST_MESSAGE_CAST(message)->type & GST_MESSAGE_EXTENDED))
 217
 218 /**
 219  * GST_MESSAGE_TYPE_NAME:
 220  * @message: a #GstMessage
 221  *
 222  * Get a constant string representation of the #GstMessageType of @message.
 223  */
 224 #define GST_MESSAGE_TYPE_NAME(message)  gst_message_type_get_name(GST_MESSAGE_TYPE(message))
 225 /**
 226  * GST_MESSAGE_TIMESTAMP:
 227  * @message: a #GstMessage
 228  *
 229  * Get the timestamp of @message. This is the timestamp when the message
 230  * was created.
 231  */
 232 #define GST_MESSAGE_TIMESTAMP(message)  (GST_MESSAGE_CAST(message)->timestamp)
 233 /**
 234  * GST_MESSAGE_SRC:
 235  * @message: a #GstMessage
 236  *
 237  * Get the object that posted @message.
 238  */
 239 #define GST_MESSAGE_SRC(message)        (GST_MESSAGE_CAST(message)->src)
 240
 241 /**
 242  * GST_MESSAGE_SEQNUM:
 243  * @message: a #GstMessage
 244  *
 245  * Get the sequence number of @message.
 246  */
 247 #define GST_MESSAGE_SEQNUM(message)     (GST_MESSAGE_CAST(message)->seqnum)
 248
 249 /**
 250  * GST_MESSAGE_SRC_NAME:
 251  * @message: a #GstMessage
 252  *
 253  * Get the name of the object that posted @message. Returns "(NULL)" if
 254  * the message has no source object set.
 255  */
 256 #define GST_MESSAGE_SRC_NAME(message)   (GST_MESSAGE_SRC(message) ? \
 257     GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
 258
 259 /**
 260  * GstStructureChangeType:
 261  * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
 262  * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
 263  *
 264  * The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
 265  */
 266 typedef enum {
 267   GST_STRUCTURE_CHANGE_TYPE_PAD_LINK   = 0,
 268   GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1
 269 } GstStructureChangeType;
 270
 271 /**
 272  * GstStreamStatusType:
 273  * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created.
 274  * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function
 275  * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function
 276  * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed
 277  * @GST_STREAM_STATUS_TYPE_START: a thread is started
 278  * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
 279  * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
 280  *
 281  * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
 282  * application of new streaming threads and their status.
 283  */
 284 typedef enum {
 285   GST_STREAM_STATUS_TYPE_CREATE   = 0,
 286   GST_STREAM_STATUS_TYPE_ENTER    = 1,
 287   GST_STREAM_STATUS_TYPE_LEAVE    = 2,
 288   GST_STREAM_STATUS_TYPE_DESTROY  = 3,
 289
 290   GST_STREAM_STATUS_TYPE_START    = 8,
 291   GST_STREAM_STATUS_TYPE_PAUSE    = 9,
 292   GST_STREAM_STATUS_TYPE_STOP     = 10
 293 } GstStreamStatusType;
 294
 295 /**
 296  * GstProgressType:
 297  * @GST_PROGRESS_TYPE_START: A new task started.
 298  * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues.
 299  * @GST_PROGRESS_TYPE_COMPLETE: A task completed.
 300  * @GST_PROGRESS_TYPE_CANCELED: A task was canceled.
 301  * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also
 302  *          posted on the bus.
 303  *
 304  * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
 305  * application of the status of asynchronous tasks.
 306  */
 307 typedef enum {
 308   GST_PROGRESS_TYPE_START    = 0,
 309   GST_PROGRESS_TYPE_CONTINUE = 1,
 310   GST_PROGRESS_TYPE_COMPLETE = 2,
 311   GST_PROGRESS_TYPE_CANCELED = 3,
 312   GST_PROGRESS_TYPE_ERROR    = 4
 313 } GstProgressType;
 314
 315 /**
 316  * GstMessage:
 317  * @mini_object: the parent structure
 318  * @type: the #GstMessageType of the message
 319  * @timestamp: the timestamp of the message
 320  * @src: the src of the message
 321  * @seqnum: the sequence number of the message
 322  *
 323  * A #GstMessage.
 324  */
 325 struct _GstMessage
 326 {
 327   GstMiniObject   mini_object;
 328
 329   /*< public > *//* with COW */
 330   GstMessageType  type;
 331   guint64         timestamp;
 332   GstObject      *src;
 333   guint32         seqnum;
 334
 335   /*< private >*//* with MESSAGE_LOCK */
 336   GMutex          lock;                 /* lock and cond for async delivery */
 337   GCond           cond;
 338 };
 339
 340 GType           gst_message_get_type            (void);
 341
 342 const gchar*    gst_message_type_get_name       (GstMessageType type);
 343 GQuark          gst_message_type_to_quark       (GstMessageType type);
 344
 345 /* refcounting */
 346 /**
 347  * gst_message_ref:
 348  * @msg: the message to ref
 349  *
 350  * Convenience macro to increase the reference count of the message.
 351  *
 352  * Returns: @msg (for convenience when doing assignments)
 353  */
 354 static inline GstMessage *
 355 gst_message_ref (GstMessage * msg)
 356 {
 357   return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg));
 358 }
 359
 360 /**
 361  * gst_message_unref:
 362  * @msg: the message to unref
 363  *
 364  * Convenience macro to decrease the reference count of the message, possibly
 365  * freeing it.
 366  */
 367 static inline void
 368 gst_message_unref (GstMessage * msg)
 369 {
 370   gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg));
 371 }
 372
 373 /* copy message */
 374 /**
 375  * gst_message_copy:
 376  * @msg: the message to copy
 377  *
 378  * Creates a copy of the message. Returns a copy of the message.
 379  *
 380  * Returns: (transfer full): a new copy of @msg.
 381  *
 382  * MT safe
 383  */
 384 static inline GstMessage *
 385 gst_message_copy (const GstMessage * msg)
 386 {
 387   return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg)));
 388 }
 389
 390 /**
 391  * gst_message_is_writable:
 392  * @msg: a #GstMessage
 393  *
 394  * Tests if you can safely write into a message's structure or validly
 395  * modify the seqnum and timestamp fields.
 396  */
 397 #define         gst_message_is_writable(msg)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (msg))
 398 /**
 399  * gst_message_make_writable:
 400  * @msg: (transfer full): the message to make writable
 401  *
 402  * Checks if a message is writable. If not, a writable copy is made and
 403  * returned.
 404  *
 405  * Returns: (transfer full): a message (possibly a duplicate) that is writable.
 406  *
 407  * MT safe
 408  */
 409 #define         gst_message_make_writable(msg)  GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
 410 /**
 411  * gst_message_replace:
 412  * @old_message: (inout) (transfer full) (nullable): pointer to a
 413  *     pointer to a #GstMessage to be replaced.
 414  * @new_message: (allow-none) (transfer none): pointer to a #GstMessage that will
 415  *     replace the message pointed to by @old_message.
 416  *
 417  * Modifies a pointer to a #GstMessage to point to a different #GstMessage. The
 418  * modification is done atomically (so this is useful for ensuring thread safety
 419  * in some cases), and the reference counts are updated appropriately (the old
 420  * message is unreffed, the new one is reffed).
 421  *
 422  * Either @new_message or the #GstMessage pointed to by @old_message may be %NULL.
 423  *
 424  * Returns: %TRUE if @new_message was different from @old_message
 425  */
 426 static inline gboolean
 427 gst_message_replace (GstMessage **old_message, GstMessage *new_message)
 428 {
 429   return gst_mini_object_replace ((GstMiniObject **) old_message, (GstMiniObject *) new_message);
 430 }
 431
 432
 433 /* custom messages */
 434 GstMessage *    gst_message_new_custom          (GstMessageType type,
 435                                                  GstObject    * src,
 436                                                  GstStructure * structure) G_GNUC_MALLOC;
 437 const GstStructure *
 438                 gst_message_get_structure       (GstMessage *message);
 439
 440 gboolean        gst_message_has_name            (GstMessage *message, const gchar *name);
 441
 442 /* identifiers for events and messages */
 443 guint32         gst_message_get_seqnum          (GstMessage *message);
 444 void            gst_message_set_seqnum          (GstMessage *message, guint32 seqnum);
 445
 446 /* EOS */
 447 GstMessage *    gst_message_new_eos             (GstObject * src) G_GNUC_MALLOC;
 448
 449 /* ERROR */
 450
 451 GstMessage *    gst_message_new_error           (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 452 GstMessage *    gst_message_new_error_with_details (GstObject * src, GError * error, const gchar * debug, GstStructure * details) G_GNUC_MALLOC;
 453 void            gst_message_parse_error         (GstMessage *message, GError **gerror, gchar **debug);
 454 void            gst_message_parse_error_details (GstMessage *message, const GstStructure **structure);
 455
 456 /* WARNING */
 457 GstMessage *    gst_message_new_warning         (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 458 GstMessage *    gst_message_new_warning_with_details (GstObject * src, GError * error, const gchar * debug, GstStructure * details) G_GNUC_MALLOC;
 459 void            gst_message_parse_warning       (GstMessage *message, GError **gerror, gchar **debug);
 460 void            gst_message_parse_warning_details (GstMessage *message, const GstStructure **structure);
 461
 462 /* INFO */
 463 GstMessage *    gst_message_new_info            (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 464 GstMessage *    gst_message_new_info_with_details (GstObject * src, GError * error, const gchar * debug, GstStructure * details) G_GNUC_MALLOC;
 465 void            gst_message_parse_info          (GstMessage *message, GError **gerror, gchar **debug);
 466 void            gst_message_parse_info_details  (GstMessage *message, const GstStructure **structure);
 467
 468 /* TAG */
 469 GstMessage *    gst_message_new_tag             (GstObject * src, GstTagList * tag_list) G_GNUC_MALLOC;
 470 void            gst_message_parse_tag           (GstMessage *message, GstTagList **tag_list);
 471
 472 /* BUFFERING */
 473 GstMessage *    gst_message_new_buffering         (GstObject * src, gint percent) G_GNUC_MALLOC;
 474 void            gst_message_parse_buffering       (GstMessage *message, gint *percent);
 475 void            gst_message_set_buffering_stats   (GstMessage *message, GstBufferingMode mode,
 476                                                    gint avg_in, gint avg_out,
 477                                                    gint64 buffering_left);
 478 void            gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode,
 479                                                    gint *avg_in, gint *avg_out,
 480                                                    gint64 *buffering_left);
 481
 482 /* STATE_CHANGED */
 483 GstMessage *    gst_message_new_state_changed   (GstObject * src, GstState oldstate,
 484                                                  GstState newstate, GstState pending) G_GNUC_MALLOC;
 485 void            gst_message_parse_state_changed (GstMessage *message, GstState *oldstate,
 486                                                  GstState *newstate, GstState *pending);
 487
 488 /* STATE_DIRTY */
 489 GstMessage *    gst_message_new_state_dirty     (GstObject * src) G_GNUC_MALLOC;
 490
 491 /* STEP_DONE */
 492 GstMessage *    gst_message_new_step_done       (GstObject * src, GstFormat format, guint64 amount,
 493                                                  gdouble rate, gboolean flush, gboolean intermediate,
 494                                                  guint64 duration, gboolean eos) G_GNUC_MALLOC;
 495 void            gst_message_parse_step_done     (GstMessage * message, GstFormat *format, guint64 *amount,
 496                                                  gdouble *rate, gboolean *flush, gboolean *intermediate,
 497                                                  guint64 *duration, gboolean *eos);
 498 /* CLOCK_PROVIDE */
 499 GstMessage *    gst_message_new_clock_provide   (GstObject * src, GstClock *clock, gboolean ready) G_GNUC_MALLOC;
 500 void            gst_message_parse_clock_provide (GstMessage *message, GstClock **clock,
 501                                                  gboolean *ready);
 502
 503 /* CLOCK_LOST */
 504 GstMessage *    gst_message_new_clock_lost      (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
 505 void            gst_message_parse_clock_lost    (GstMessage *message, GstClock **clock);
 506
 507 /* NEW_CLOCK */
 508 GstMessage *    gst_message_new_new_clock       (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
 509 void            gst_message_parse_new_clock     (GstMessage *message, GstClock **clock);
 510
 511 /* APPLICATION */
 512 GstMessage *    gst_message_new_application     (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
 513
 514 /* ELEMENT */
 515 GstMessage *    gst_message_new_element         (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
 516
 517 /* SEGMENT_START */
 518 GstMessage *    gst_message_new_segment_start   (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
 519 void            gst_message_parse_segment_start (GstMessage *message, GstFormat *format,
 520                                                  gint64 *position);
 521
 522 /* SEGMENT_DONE */
 523 GstMessage *    gst_message_new_segment_done    (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
 524 void            gst_message_parse_segment_done  (GstMessage *message, GstFormat *format,
 525                                                  gint64 *position);
 526
 527 /* DURATION_CHANGED */
 528 GstMessage *    gst_message_new_duration_changed (GstObject * src) G_GNUC_MALLOC;
 529
 530 /* LATENCY */
 531 GstMessage *    gst_message_new_latency         (GstObject * src) G_GNUC_MALLOC;
 532
 533 /* ASYNC_START */
 534 GstMessage *    gst_message_new_async_start     (GstObject * src) G_GNUC_MALLOC;
 535
 536 /* ASYNC_DONE */
 537 GstMessage *    gst_message_new_async_done      (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC;
 538 void            gst_message_parse_async_done    (GstMessage *message, GstClockTime *running_time);
 539
 540 /* STRUCTURE CHANGE */
 541 GstMessage *    gst_message_new_structure_change   (GstObject * src, GstStructureChangeType type,
 542                                                     GstElement *owner, gboolean busy) G_GNUC_MALLOC;
 543 void            gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type,
 544                                                     GstElement **owner, gboolean *busy);
 545
 546 /* STREAM STATUS */
 547 GstMessage *    gst_message_new_stream_status        (GstObject * src, GstStreamStatusType type,
 548                                                       GstElement *owner) G_GNUC_MALLOC;
 549 void            gst_message_parse_stream_status      (GstMessage *message, GstStreamStatusType *type,
 550                                                       GstElement **owner);
 551 void            gst_message_set_stream_status_object (GstMessage *message, const GValue *object);
 552 const GValue *  gst_message_get_stream_status_object (GstMessage *message);
 553
 554 /* REQUEST_STATE */
 555 GstMessage *    gst_message_new_request_state   (GstObject * src, GstState state) G_GNUC_MALLOC;
 556 void            gst_message_parse_request_state (GstMessage * message, GstState *state);
 557
 558 /* STEP_START */
 559 GstMessage *    gst_message_new_step_start      (GstObject * src, gboolean active, GstFormat format,
 560                                                  guint64 amount, gdouble rate, gboolean flush,
 561                                                  gboolean intermediate) G_GNUC_MALLOC;
 562 void            gst_message_parse_step_start    (GstMessage * message, gboolean *active, GstFormat *format,
 563                                                  guint64 *amount, gdouble *rate, gboolean *flush,
 564                                                  gboolean *intermediate);
 565
 566 /* QOS */
 567 GstMessage *    gst_message_new_qos             (GstObject * src, gboolean live, guint64 running_time,
 568                                                  guint64 stream_time, guint64 timestamp, guint64 duration) G_GNUC_MALLOC;
 569 void            gst_message_set_qos_values      (GstMessage * message, gint64 jitter, gdouble proportion,
 570                                                  gint quality);
 571 void            gst_message_set_qos_stats       (GstMessage * message, GstFormat format, guint64 processed,
 572                                                  guint64 dropped);
 573 void            gst_message_parse_qos           (GstMessage * message, gboolean * live, guint64 * running_time,
 574                                                  guint64 * stream_time, guint64 * timestamp, guint64 * duration);
 575 void            gst_message_parse_qos_values    (GstMessage * message, gint64 * jitter, gdouble * proportion,
 576                                                  gint * quality);
 577 void            gst_message_parse_qos_stats     (GstMessage * message, GstFormat * format, guint64 * processed,
 578                                                  guint64 * dropped);
 579 /* PROGRESS */
 580 GstMessage *    gst_message_new_progress           (GstObject * src, GstProgressType type, const gchar *code,
 581                                                     const gchar *text) G_GNUC_MALLOC;
 582 void            gst_message_parse_progress         (GstMessage * message, GstProgressType * type, gchar ** code,
 583                                                     gchar ** text);
 584
 585 /* TOC */
 586 GstMessage *    gst_message_new_toc             (GstObject *src, GstToc *toc, gboolean updated);
 587 void            gst_message_parse_toc           (GstMessage *message, GstToc **toc, gboolean *updated);
 588
 589 /* RESET_TIME */
 590 GstMessage *    gst_message_new_reset_time      (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC;
 591 void            gst_message_parse_reset_time    (GstMessage *message, GstClockTime *running_time);
 592
 593 /* STREAM_START */
 594 GstMessage *    gst_message_new_stream_start    (GstObject * src) G_GNUC_MALLOC;
 595
 596 void            gst_message_set_group_id        (GstMessage *message, guint group_id);
 597 gboolean        gst_message_parse_group_id      (GstMessage *message, guint *group_id);
 598
 599 /* NEED_CONTEXT */
 600 GstMessage *    gst_message_new_need_context    (GstObject * src, const gchar * context_type) G_GNUC_MALLOC;
 601 gboolean        gst_message_parse_context_type  (GstMessage * message, const gchar ** context_type);
 602
 603 /* HAVE_CONTEXT */
 604 GstMessage *    gst_message_new_have_context    (GstObject * src, GstContext *context) G_GNUC_MALLOC;
 605 void            gst_message_parse_have_context  (GstMessage *message, GstContext **context);
 606
 607 /* DEVICE_ADDED */
 608 GstMessage *    gst_message_new_device_added    (GstObject * src, GstDevice * device) G_GNUC_MALLOC;
 609 void            gst_message_parse_device_added  (GstMessage * message, GstDevice ** device);
 610
 611 /* DEVICE_REMOVED */
 612 GstMessage *    gst_message_new_device_removed    (GstObject * src, GstDevice * device) G_GNUC_MALLOC;
 613 void            gst_message_parse_device_removed  (GstMessage * message, GstDevice ** device);
 614
 615 /* PROPERTY_NOTIFY */
 616 GstMessage *    gst_message_new_property_notify   (GstObject * src, const gchar * property_name, GValue * val) G_GNUC_MALLOC;
 617 void            gst_message_parse_property_notify (GstMessage * message, GstObject ** object, const gchar ** property_name, const GValue ** property_value);
 618
 619 /* STREAM_COLLECTION */
 620 GstMessage *    gst_message_new_stream_collection   (GstObject * src, GstStreamCollection * collection) G_GNUC_MALLOC;
 621 void            gst_message_parse_stream_collection (GstMessage *message, GstStreamCollection **collection);
 622
 623 /* STREAMS_SELECTED */
 624 GstMessage *    gst_message_new_streams_selected (GstObject *src, GstStreamCollection *collection);
 625 void            gst_message_streams_selected_add (GstMessage *message, GstStream *stream);
 626 void            gst_message_parse_streams_selected (GstMessage * message, GstStreamCollection **collection);
 627 guint           gst_message_streams_selected_get_size (GstMessage * message);
 628 GstStream      *gst_message_streams_selected_get_stream (GstMessage *message, guint idx);
 629
 630 /* REDIRECT */
 631 GstMessage *    gst_message_new_redirect             (GstObject * src, const gchar * location, GstTagList * tag_list, const GstStructure * entry_struct) G_GNUC_MALLOC;
 632 void            gst_message_add_redirect_entry       (GstMessage * message, const gchar * location, GstTagList * tag_list, const GstStructure * entry_struct);
 633 void            gst_message_parse_redirect_entry     (GstMessage * message, gsize entry_index, const gchar ** location, GstTagList ** tag_list, const GstStructure ** entry_struct);
 634 gsize           gst_message_get_num_redirect_entries (GstMessage * message);
 635
 636 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 637 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstMessage, gst_message_unref)
 638 #endif
 639
 640 G_END_DECLS
 641
 642 #endif /* __GST_MESSAGE_H__ */