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 #include <glib.h>
  26
  27 G_BEGIN_DECLS
  28
  29 typedef struct _GstMessage GstMessage;
  30
  31 /**
  32  * GstMessageType:
  33  * @GST_MESSAGE_UNKNOWN: an undefined message
  34  * @GST_MESSAGE_EOS: end-of-stream reached in a pipeline. The application will
  35  * only receive this message in the PLAYING state and every time it sets a
  36  * pipeline to PLAYING that is in the EOS state. The application can perform a
  37  * flushing seek in the pipeline, which will undo the EOS state again.
  38  * @GST_MESSAGE_ERROR: an error occurred. When the application receives an error
  39  * message it should stop playback of the pipeline and not assume that more
  40  * data will be played.
  41  * @GST_MESSAGE_WARNING: a warning occurred.
  42  * @GST_MESSAGE_INFO: an info message occurred
  43  * @GST_MESSAGE_TAG: a tag was found.
  44  * @GST_MESSAGE_BUFFERING: the pipeline is buffering. When the application
  45  * receives a buffering message in the PLAYING state for a non-live pipeline it
  46  * must PAUSE the pipeline until the buffering completes, when the percentage
  47  * field in the message is 100%. For live pipelines, no action must be
  48  * performed and the buffering percentage can be used to inform the user about
  49  * the progress.
  50  * @GST_MESSAGE_STATE_CHANGED: a state change happened
  51  * @GST_MESSAGE_STATE_DIRTY: an element changed state in a streaming thread.
  52  * This message is deprecated.
  53  * @GST_MESSAGE_STEP_DONE: a stepping operation finished.
  54  * @GST_MESSAGE_CLOCK_PROVIDE: an element notifies its capability of providing
  55  *                             a clock. This message is used internally and
  56  *                             never forwarded to the application.
  57  * @GST_MESSAGE_CLOCK_LOST: The current clock as selected by the pipeline became
  58  *                          unusable. The pipeline will select a new clock on
  59  *                          the next PLAYING state change. The application
  60  *                          should set the pipeline to PAUSED and back to
  61  *                          PLAYING when this message is received.
  62  * @GST_MESSAGE_NEW_CLOCK: a new clock was selected in the pipeline.
  63  * @GST_MESSAGE_STRUCTURE_CHANGE: the structure of the pipeline changed. This
  64  * message is used internally and never forwarded to the application.
  65  * @GST_MESSAGE_STREAM_STATUS: status about a stream, emitted when it starts,
  66  *                             stops, errors, etc..
  67  * @GST_MESSAGE_APPLICATION: message posted by the application, possibly
  68  *                           via an application-specific element.
  69  * @GST_MESSAGE_ELEMENT: element-specific message, see the specific element's
  70  *                       documentation
  71  * @GST_MESSAGE_SEGMENT_START: pipeline started playback of a segment. This
  72  * message is used internally and never forwarded to the application.
  73  * @GST_MESSAGE_SEGMENT_DONE: pipeline completed playback of a segment. This
  74  * message is forwarded to the application after all elements that posted
  75  * @GST_MESSAGE_SEGMENT_START posted a GST_MESSAGE_SEGMENT_DONE message.
  76  * @GST_MESSAGE_DURATION_CHANGED: The duration of a pipeline changed. The
  77  * application can get the new duration with a duration query.
  78  * @GST_MESSAGE_ASYNC_START: Posted by elements when they start an ASYNC
  79  * #GstStateChange. This message is not forwarded to the application but is used
  80  * internally.
  81  * @GST_MESSAGE_ASYNC_DONE: Posted by elements when they complete an ASYNC
  82  * #GstStateChange. The application will only receive this message from the toplevel
  83  * pipeline.
  84  * @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The
  85  * application should recalculate and distribute a new latency.
  86  * @GST_MESSAGE_REQUEST_STATE: Posted by elements when they want the pipeline to
  87  * change state. This message is a suggestion to the application which can
  88  * decide to perform the state change on (part of) the pipeline.
  89  * @GST_MESSAGE_STEP_START: A stepping operation was started.
  90  * @GST_MESSAGE_QOS: A buffer was dropped or an element changed its processing
  91  * strategy for Quality of Service reasons.
  92  * @GST_MESSAGE_PROGRESS: A progress message.
  93  * @GST_MESSAGE_TOC: A new table of contents (TOC) was found or previously found TOC
  94  * was updated.
  95  * @GST_MESSAGE_RESET_TIME: Message to request resetting the pipeline's
  96  *     running time from the pipeline. This is an internal message which
  97  *     applications will likely never receive.
  98  * @GST_MESSAGE_STREAM_START: Message indicating start of a new stream. Useful
  99  *     e.g. when using playbin in gapless playback mode, to get notified when
 100  *     the next title actually starts playing (which will be some time after
 101  *     the URI for the next title has been set).
 102  * @GST_MESSAGE_NEED_CONTEXT: Message indicating that an element wants a specific context (Since 1.2)
 103  * @GST_MESSAGE_HAVE_CONTEXT: Message indicating that an element created a context (Since 1.2)
 104  * @GST_MESSAGE_EXTENDED: Message is an extended message type (see below).
 105  *     These extended message IDs can't be used directly with mask-based API
 106  *     like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still
 107  *     filter for GST_MESSAGE_EXTENDED and then check the result for the
 108  *     specific type. (Since 1.4)
 109  * @GST_MESSAGE_DEVICE_ADDED: Message indicating a #GstDevice was added to
 110  *     a #GstDeviceProvider (Since 1.4)
 111  * @GST_MESSAGE_DEVICE_REMOVED: Message indicating a #GstDevice was removed
 112  *     from a #GstDeviceProvider (Since 1.4)
 113  * @GST_MESSAGE_PROPERTY_NOTIFY: Message indicating a #GObject property has
 114  *     changed (Since 1.10)
 115  * @GST_MESSAGE_STREAM_COLLECTION: Message indicating a new #GstStreamCollection
 116  *     is available (Since 1.10)
 117  * @GST_MESSAGE_STREAMS_SELECTED: Message indicating the active selection of
 118  *     #GstStreams has changed (Since 1.10)
 119  * @GST_MESSAGE_REDIRECT: Message indicating to request the application to
 120  *     try to play the given URL(s). Useful if for example a HTTP 302/303
 121  *     response is received with a non-HTTP URL inside. (Since 1.10)
 122  * @GST_MESSAGE_ANY: mask for all of the above messages.
 123  *
 124  * The different message types that are available.
 125  */
 126 /* NOTE: keep in sync with quark registration in gstmessage.c
 127  * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings.
 128  */
 129 /* FIXME: 2.0: Make it NOT flags, just a regular 1,2,3,4.. enumeration */
 130 /* FIXME: For GST_MESSAGE_ANY ~0 -> 0xffffffff see
 131  *        https://bugzilla.gnome.org/show_bug.cgi?id=732633
 132  */
 133 typedef enum
 134 {
 135   GST_MESSAGE_UNKNOWN           = 0,
 136   GST_MESSAGE_EOS               = (1 << 0),
 137   GST_MESSAGE_ERROR             = (1 << 1),
 138   GST_MESSAGE_WARNING           = (1 << 2),
 139   GST_MESSAGE_INFO              = (1 << 3),
 140   GST_MESSAGE_TAG               = (1 << 4),
 141   GST_MESSAGE_BUFFERING         = (1 << 5),
 142   GST_MESSAGE_STATE_CHANGED     = (1 << 6),
 143   GST_MESSAGE_STATE_DIRTY       = (1 << 7),
 144   GST_MESSAGE_STEP_DONE         = (1 << 8),
 145   GST_MESSAGE_CLOCK_PROVIDE     = (1 << 9),
 146   GST_MESSAGE_CLOCK_LOST        = (1 << 10),
 147   GST_MESSAGE_NEW_CLOCK         = (1 << 11),
 148   GST_MESSAGE_STRUCTURE_CHANGE  = (1 << 12),
 149   GST_MESSAGE_STREAM_STATUS     = (1 << 13),
 150   GST_MESSAGE_APPLICATION       = (1 << 14),
 151   GST_MESSAGE_ELEMENT           = (1 << 15),
 152   GST_MESSAGE_SEGMENT_START     = (1 << 16),
 153   GST_MESSAGE_SEGMENT_DONE      = (1 << 17),
 154   GST_MESSAGE_DURATION_CHANGED  = (1 << 18),
 155   GST_MESSAGE_LATENCY           = (1 << 19),
 156   GST_MESSAGE_ASYNC_START       = (1 << 20),
 157   GST_MESSAGE_ASYNC_DONE        = (1 << 21),
 158   GST_MESSAGE_REQUEST_STATE     = (1 << 22),
 159   GST_MESSAGE_STEP_START        = (1 << 23),
 160   GST_MESSAGE_QOS               = (1 << 24),
 161   GST_MESSAGE_PROGRESS          = (1 << 25),
 162   GST_MESSAGE_TOC               = (1 << 26),
 163   GST_MESSAGE_RESET_TIME        = (1 << 27),
 164   GST_MESSAGE_STREAM_START      = (1 << 28),
 165   GST_MESSAGE_NEED_CONTEXT      = (1 << 29),
 166   GST_MESSAGE_HAVE_CONTEXT      = (1 << 30),
 167   GST_MESSAGE_EXTENDED          = (gint) (1u << 31),
 168   GST_MESSAGE_DEVICE_ADDED      = GST_MESSAGE_EXTENDED + 1,
 169   GST_MESSAGE_DEVICE_REMOVED    = GST_MESSAGE_EXTENDED + 2,
 170   GST_MESSAGE_PROPERTY_NOTIFY   = GST_MESSAGE_EXTENDED + 3,
 171   GST_MESSAGE_STREAM_COLLECTION = GST_MESSAGE_EXTENDED + 4,
 172   GST_MESSAGE_STREAMS_SELECTED  = GST_MESSAGE_EXTENDED + 5,
 173   GST_MESSAGE_REDIRECT          = GST_MESSAGE_EXTENDED + 6,
 174   GST_MESSAGE_ANY               = (gint) (0xffffffff)
 175 } GstMessageType;
 176
 177 #include <gst/gstminiobject.h>
 178 #include <gst/gstobject.h>
 179 #include <gst/gstelement.h>
 180 #include <gst/gsttaglist.h>
 181 #include <gst/gststructure.h>
 182 #include <gst/gstquery.h>
 183 #include <gst/gsttoc.h>
 184 #include <gst/gstdevice.h>
 185 #include <gst/gststreams.h>
 186 #include <gst/gststreamcollection.h>
 187
 188 GST_API GType _gst_message_type;
 189
 190 #define GST_TYPE_MESSAGE                         (_gst_message_type)
 191 #define GST_IS_MESSAGE(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE))
 192 #define GST_MESSAGE_CAST(obj)                    ((GstMessage*)(obj))
 193 #define GST_MESSAGE(obj)                         (GST_MESSAGE_CAST(obj))
 194
 195 /* the lock is used to handle the synchronous handling of messages,
 196  * the emitting thread is blocked until the handling thread processed
 197  * the message using this mutex/cond pair */
 198 #define GST_MESSAGE_GET_LOCK(message)   (&GST_MESSAGE_CAST(message)->lock)
 199 #define GST_MESSAGE_LOCK(message)       g_mutex_lock(GST_MESSAGE_GET_LOCK(message))
 200 #define GST_MESSAGE_UNLOCK(message)     g_mutex_unlock(GST_MESSAGE_GET_LOCK(message))
 201 #define GST_MESSAGE_GET_COND(message)   (&GST_MESSAGE_CAST(message)->cond)
 202 #define GST_MESSAGE_WAIT(message)       g_cond_wait(GST_MESSAGE_GET_COND(message),GST_MESSAGE_GET_LOCK(message))
 203 #define GST_MESSAGE_SIGNAL(message)     g_cond_signal(GST_MESSAGE_GET_COND(message))
 204
 205 /**
 206  * GST_MESSAGE_TYPE:
 207  * @message: a #GstMessage
 208  *
 209  * Get the #GstMessageType of @message.
 210  */
 211 #define GST_MESSAGE_TYPE(message)       (GST_MESSAGE_CAST(message)->type)
 212 /**
 213  * GST_MESSAGE_TYPE_IS_EXTENDED:
 214  * @message: a #GstMessage
 215  *
 216  * Check if the message is in the extended message group
 217  * Since: 1.4
 218  */
 219 #define GST_MESSAGE_TYPE_IS_EXTENDED(message)       (!!(GST_MESSAGE_CAST(message)->type & GST_MESSAGE_EXTENDED))
 220
 221 /**
 222  * GST_MESSAGE_TYPE_NAME:
 223  * @message: a #GstMessage
 224  *
 225  * Get a constant string representation of the #GstMessageType of @message.
 226  */
 227 #define GST_MESSAGE_TYPE_NAME(message)  gst_message_type_get_name(GST_MESSAGE_TYPE(message))
 228 /**
 229  * GST_MESSAGE_TIMESTAMP:
 230  * @message: a #GstMessage
 231  *
 232  * Get the timestamp of @message. This is the timestamp when the message
 233  * was created.
 234  */
 235 #define GST_MESSAGE_TIMESTAMP(message)  (GST_MESSAGE_CAST(message)->timestamp)
 236 /**
 237  * GST_MESSAGE_SRC:
 238  * @message: a #GstMessage
 239  *
 240  * Get the object that posted @message.
 241  */
 242 #define GST_MESSAGE_SRC(message)        (GST_MESSAGE_CAST(message)->src)
 243
 244 /**
 245  * GST_MESSAGE_SEQNUM:
 246  * @message: a #GstMessage
 247  *
 248  * Get the sequence number of @message.
 249  */
 250 #define GST_MESSAGE_SEQNUM(message)     (GST_MESSAGE_CAST(message)->seqnum)
 251
 252 /**
 253  * GST_MESSAGE_SRC_NAME:
 254  * @message: a #GstMessage
 255  *
 256  * Get the name of the object that posted @message. Returns "(NULL)" if
 257  * the message has no source object set.
 258  */
 259 #define GST_MESSAGE_SRC_NAME(message)   (GST_MESSAGE_SRC(message) ? \
 260     GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)")
 261
 262 /**
 263  * GstStructureChangeType:
 264  * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
 265  * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
 266  *
 267  * The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
 268  */
 269 typedef enum {
 270   GST_STRUCTURE_CHANGE_TYPE_PAD_LINK   = 0,
 271   GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1
 272 } GstStructureChangeType;
 273
 274 /**
 275  * GstStreamStatusType:
 276  * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created.
 277  * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function
 278  * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function
 279  * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed
 280  * @GST_STREAM_STATUS_TYPE_START: a thread is started
 281  * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
 282  * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
 283  *
 284  * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
 285  * application of new streaming threads and their status.
 286  */
 287 typedef enum {
 288   GST_STREAM_STATUS_TYPE_CREATE   = 0,
 289   GST_STREAM_STATUS_TYPE_ENTER    = 1,
 290   GST_STREAM_STATUS_TYPE_LEAVE    = 2,
 291   GST_STREAM_STATUS_TYPE_DESTROY  = 3,
 292
 293   GST_STREAM_STATUS_TYPE_START    = 8,
 294   GST_STREAM_STATUS_TYPE_PAUSE    = 9,
 295   GST_STREAM_STATUS_TYPE_STOP     = 10
 296 } GstStreamStatusType;
 297
 298 /**
 299  * GstProgressType:
 300  * @GST_PROGRESS_TYPE_START: A new task started.
 301  * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues.
 302  * @GST_PROGRESS_TYPE_COMPLETE: A task completed.
 303  * @GST_PROGRESS_TYPE_CANCELED: A task was canceled.
 304  * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also
 305  *          posted on the bus.
 306  *
 307  * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
 308  * application of the status of asynchronous tasks.
 309  */
 310 typedef enum {
 311   GST_PROGRESS_TYPE_START    = 0,
 312   GST_PROGRESS_TYPE_CONTINUE = 1,
 313   GST_PROGRESS_TYPE_COMPLETE = 2,
 314   GST_PROGRESS_TYPE_CANCELED = 3,
 315   GST_PROGRESS_TYPE_ERROR    = 4
 316 } GstProgressType;
 317
 318 /**
 319  * GstMessage:
 320  * @mini_object: the parent structure
 321  * @type: the #GstMessageType of the message
 322  * @timestamp: the timestamp of the message
 323  * @src: the src of the message
 324  * @seqnum: the sequence number of the message
 325  *
 326  * A #GstMessage.
 327  */
 328 struct _GstMessage
 329 {
 330   GstMiniObject   mini_object;
 331
 332   /*< public > *//* with COW */
 333   GstMessageType  type;
 334   guint64         timestamp;
 335   GstObject      *src;
 336   guint32         seqnum;
 337
 338   /*< private >*//* with MESSAGE_LOCK */
 339   GMutex          lock;                 /* lock and cond for async delivery */
 340   GCond           cond;
 341 };
 342
 343 #include <gst/gstquery.h>
 344
 345 GST_API
 346 GType           gst_message_get_type            (void);
 347
 348 GST_API
 349 const gchar*    gst_message_type_get_name       (GstMessageType type);
 350
 351 GST_API
 352 GQuark          gst_message_type_to_quark       (GstMessageType type);
 353
 354 /* refcounting */
 355 /**
 356  * gst_message_ref:
 357  * @msg: the message to ref
 358  *
 359  * Convenience macro to increase the reference count of the message.
 360  *
 361  * Returns: @msg (for convenience when doing assignments)
 362  */
 363 static inline GstMessage *
 364 gst_message_ref (GstMessage * msg)
 365 {
 366   return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg));
 367 }
 368
 369 /**
 370  * gst_message_unref:
 371  * @msg: the message to unref
 372  *
 373  * Convenience macro to decrease the reference count of the message, possibly
 374  * freeing it.
 375  */
 376 static inline void
 377 gst_message_unref (GstMessage * msg)
 378 {
 379   gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg));
 380 }
 381
 382 /**
 383  * gst_clear_message: (skip)
 384  * @msg_ptr: a pointer to a #GstMessage reference
 385  *
 386  * Clears a reference to a #GstMessage.
 387  *
 388  * @msg_ptr must not be %NULL.
 389  *
 390  * If the reference is %NULL then this function does nothing. Otherwise, the
 391  * reference count of the message is decreased and the pointer is set to %NULL.
 392  *
 393  * Since: 1.16
 394  */
 395 static inline void
 396 gst_clear_message (GstMessage ** msg_ptr)
 397 {
 398   gst_clear_mini_object ((GstMiniObject **) msg_ptr);
 399 }
 400
 401 /* copy message */
 402 /**
 403  * gst_message_copy:
 404  * @msg: the message to copy
 405  *
 406  * Creates a copy of the message. Returns a copy of the message.
 407  *
 408  * Returns: (transfer full): a new copy of @msg.
 409  *
 410  * MT safe
 411  */
 412 static inline GstMessage *
 413 gst_message_copy (const GstMessage * msg)
 414 {
 415   return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg)));
 416 }
 417
 418 /**
 419  * gst_message_is_writable:
 420  * @msg: a #GstMessage
 421  *
 422  * Tests if you can safely write into a message's structure or validly
 423  * modify the seqnum and timestamp fields.
 424  */
 425 #define         gst_message_is_writable(msg)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (msg))
 426 /**
 427  * gst_message_make_writable:
 428  * @msg: (transfer full): the message to make writable
 429  *
 430  * Checks if a message is writable. If not, a writable copy is made and
 431  * returned.
 432  *
 433  * Returns: (transfer full): a message (possibly a duplicate) that is writable.
 434  *
 435  * MT safe
 436  */
 437 #define         gst_message_make_writable(msg)  GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
 438 /**
 439  * gst_message_replace:
 440  * @old_message: (inout) (transfer full) (nullable): pointer to a
 441  *     pointer to a #GstMessage to be replaced.
 442  * @new_message: (allow-none) (transfer none): pointer to a #GstMessage that will
 443  *     replace the message pointed to by @old_message.
 444  *
 445  * Modifies a pointer to a #GstMessage to point to a different #GstMessage. The
 446  * modification is done atomically (so this is useful for ensuring thread safety
 447  * in some cases), and the reference counts are updated appropriately (the old
 448  * message is unreffed, the new one is reffed).
 449  *
 450  * Either @new_message or the #GstMessage pointed to by @old_message may be %NULL.
 451  *
 452  * Returns: %TRUE if @new_message was different from @old_message
 453  */
 454 static inline gboolean
 455 gst_message_replace (GstMessage **old_message, GstMessage *new_message)
 456 {
 457   return gst_mini_object_replace ((GstMiniObject **) old_message, (GstMiniObject *) new_message);
 458 }
 459
 460 /**
 461  * gst_message_take:
 462  * @old_message: (inout) (transfer full): pointer to a pointer to a #GstMessage
 463  *     to be replaced.
 464  * @new_message: (transfer full) (allow-none): pointer to a #GstMessage that
 465  *     will replace the message pointed to by @old_message.
 466  *
 467  * Modifies a pointer to a #GstMessage to point to a different #GstMessage. This
 468  * function is similar to gst_message_replace() except that it takes ownership
 469  * of @new_message.
 470  *
 471  * Returns: %TRUE if @new_message was different from @old_message
 472  *
 473  * Since: 1.16
 474  */
 475 static inline gboolean
 476 gst_message_take (GstMessage **old_message, GstMessage *new_message)
 477 {
 478   return gst_mini_object_take ((GstMiniObject **) old_message,
 479       (GstMiniObject *) new_message);
 480 }
 481
 482
 483 /* custom messages */
 484
 485 GST_API
 486 GstMessage *    gst_message_new_custom          (GstMessageType type,
 487                                                  GstObject    * src,
 488                                                  GstStructure * structure) G_GNUC_MALLOC;
 489 GST_API
 490 const GstStructure *
 491                 gst_message_get_structure       (GstMessage *message);
 492
 493 GST_API
 494 GstStructure *  gst_message_writable_structure  (GstMessage *message);
 495
 496 GST_API
 497 gboolean        gst_message_has_name            (GstMessage *message, const gchar *name);
 498
 499 /* identifiers for events and messages */
 500
 501 GST_API
 502 guint32         gst_message_get_seqnum          (GstMessage *message);
 503
 504 GST_API
 505 void            gst_message_set_seqnum          (GstMessage *message, guint32 seqnum);
 506
 507 /* EOS */
 508
 509 GST_API
 510 GstMessage *    gst_message_new_eos             (GstObject * src) G_GNUC_MALLOC;
 511
 512 /* ERROR */
 513
 514 GST_API
 515 GstMessage *    gst_message_new_error           (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 516
 517 GST_API
 518 GstMessage *    gst_message_new_error_with_details (GstObject * src, GError * error, const gchar * debug, GstStructure * details) G_GNUC_MALLOC;
 519
 520 GST_API
 521 void            gst_message_parse_error         (GstMessage *message, GError **gerror, gchar **debug);
 522
 523 GST_API
 524 void            gst_message_parse_error_details (GstMessage *message, const GstStructure **structure);
 525
 526 /* WARNING */
 527
 528 GST_API
 529 GstMessage *    gst_message_new_warning         (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 530
 531 GST_API
 532 GstMessage *    gst_message_new_warning_with_details (GstObject * src, GError * error, const gchar * debug, GstStructure * details) G_GNUC_MALLOC;
 533
 534 GST_API
 535 void            gst_message_parse_warning       (GstMessage *message, GError **gerror, gchar **debug);
 536
 537 GST_API
 538 void            gst_message_parse_warning_details (GstMessage *message, const GstStructure **structure);
 539
 540 /* INFO */
 541
 542 GST_API
 543 GstMessage *    gst_message_new_info            (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC;
 544
 545 GST_API
 546 GstMessage *    gst_message_new_info_with_details (GstObject * src, GError * error, const gchar * debug, GstStructure * details) G_GNUC_MALLOC;
 547
 548 GST_API
 549 void            gst_message_parse_info          (GstMessage *message, GError **gerror, gchar **debug);
 550
 551 GST_API
 552 void            gst_message_parse_info_details  (GstMessage *message, const GstStructure **structure);
 553
 554 /* TAG */
 555
 556 GST_API
 557 GstMessage *    gst_message_new_tag             (GstObject * src, GstTagList * tag_list) G_GNUC_MALLOC;
 558
 559 GST_API
 560 void            gst_message_parse_tag           (GstMessage *message, GstTagList **tag_list);
 561
 562 /* BUFFERING */
 563
 564 GST_API
 565 GstMessage *    gst_message_new_buffering         (GstObject * src, gint percent) G_GNUC_MALLOC;
 566
 567 GST_API
 568 void            gst_message_parse_buffering       (GstMessage *message, gint *percent);
 569
 570 GST_API
 571 void            gst_message_set_buffering_stats   (GstMessage *message, GstBufferingMode mode,
 572                                                    gint avg_in, gint avg_out,
 573                                                    gint64 buffering_left);
 574 GST_API
 575 void            gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode,
 576                                                    gint *avg_in, gint *avg_out,
 577                                                    gint64 *buffering_left);
 578
 579 /* STATE_CHANGED */
 580
 581 GST_API
 582 GstMessage *    gst_message_new_state_changed   (GstObject * src, GstState oldstate,
 583                                                  GstState newstate, GstState pending) G_GNUC_MALLOC;
 584 GST_API
 585 void            gst_message_parse_state_changed (GstMessage *message, GstState *oldstate,
 586                                                  GstState *newstate, GstState *pending);
 587
 588 /* STATE_DIRTY */
 589
 590 GST_API
 591 GstMessage *    gst_message_new_state_dirty     (GstObject * src) G_GNUC_MALLOC;
 592
 593 /* STEP_DONE */
 594
 595 GST_API
 596 GstMessage *    gst_message_new_step_done       (GstObject * src, GstFormat format, guint64 amount,
 597                                                  gdouble rate, gboolean flush, gboolean intermediate,
 598                                                  guint64 duration, gboolean eos) G_GNUC_MALLOC;
 599 GST_API
 600 void            gst_message_parse_step_done     (GstMessage * message, GstFormat *format, guint64 *amount,
 601                                                  gdouble *rate, gboolean *flush, gboolean *intermediate,
 602                                                  guint64 *duration, gboolean *eos);
 603 /* CLOCK_PROVIDE */
 604
 605 GST_API
 606 GstMessage *    gst_message_new_clock_provide   (GstObject * src, GstClock *clock, gboolean ready) G_GNUC_MALLOC;
 607
 608 GST_API
 609 void            gst_message_parse_clock_provide (GstMessage *message, GstClock **clock,
 610                                                  gboolean *ready);
 611
 612 /* CLOCK_LOST */
 613
 614 GST_API
 615 GstMessage *    gst_message_new_clock_lost      (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
 616
 617 GST_API
 618 void            gst_message_parse_clock_lost    (GstMessage *message, GstClock **clock);
 619
 620 /* NEW_CLOCK */
 621
 622 GST_API
 623 GstMessage *    gst_message_new_new_clock       (GstObject * src, GstClock *clock) G_GNUC_MALLOC;
 624
 625 GST_API
 626 void            gst_message_parse_new_clock     (GstMessage *message, GstClock **clock);
 627
 628 /* APPLICATION */
 629
 630 GST_API
 631 GstMessage *    gst_message_new_application     (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
 632
 633 /* ELEMENT */
 634
 635 GST_API
 636 GstMessage *    gst_message_new_element         (GstObject * src, GstStructure * structure) G_GNUC_MALLOC;
 637
 638 /* SEGMENT_START */
 639
 640 GST_API
 641 GstMessage *    gst_message_new_segment_start   (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
 642
 643 GST_API
 644 void            gst_message_parse_segment_start (GstMessage *message, GstFormat *format,
 645                                                  gint64 *position);
 646
 647 /* SEGMENT_DONE */
 648
 649 GST_API
 650 GstMessage *    gst_message_new_segment_done    (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC;
 651
 652 GST_API
 653 void            gst_message_parse_segment_done  (GstMessage *message, GstFormat *format,
 654                                                  gint64 *position);
 655
 656 /* DURATION_CHANGED */
 657
 658 GST_API
 659 GstMessage *    gst_message_new_duration_changed (GstObject * src) G_GNUC_MALLOC;
 660
 661 /* LATENCY */
 662
 663 GST_API
 664 GstMessage *    gst_message_new_latency         (GstObject * src) G_GNUC_MALLOC;
 665
 666 /* ASYNC_START */
 667
 668 GST_API
 669 GstMessage *    gst_message_new_async_start     (GstObject * src) G_GNUC_MALLOC;
 670
 671 /* ASYNC_DONE */
 672
 673 GST_API
 674 GstMessage *    gst_message_new_async_done      (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC;
 675
 676 GST_API
 677 void            gst_message_parse_async_done    (GstMessage *message, GstClockTime *running_time);
 678
 679 /* STRUCTURE CHANGE */
 680
 681 GST_API
 682 GstMessage *    gst_message_new_structure_change   (GstObject * src, GstStructureChangeType type,
 683                                                     GstElement *owner, gboolean busy) G_GNUC_MALLOC;
 684 GST_API
 685 void            gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type,
 686                                                     GstElement **owner, gboolean *busy);
 687
 688 /* STREAM STATUS */
 689
 690 GST_API
 691 GstMessage *    gst_message_new_stream_status        (GstObject * src, GstStreamStatusType type,
 692                                                       GstElement *owner) G_GNUC_MALLOC;
 693 GST_API
 694 void            gst_message_parse_stream_status      (GstMessage *message, GstStreamStatusType *type,
 695                                                       GstElement **owner);
 696 GST_API
 697 void            gst_message_set_stream_status_object (GstMessage *message, const GValue *object);
 698
 699 GST_API
 700 const GValue *  gst_message_get_stream_status_object (GstMessage *message);
 701
 702 /* REQUEST_STATE */
 703
 704 GST_API
 705 GstMessage *    gst_message_new_request_state   (GstObject * src, GstState state) G_GNUC_MALLOC;
 706
 707 GST_API
 708 void            gst_message_parse_request_state (GstMessage * message, GstState *state);
 709
 710 /* STEP_START */
 711
 712 GST_API
 713 GstMessage *    gst_message_new_step_start      (GstObject * src, gboolean active, GstFormat format,
 714                                                  guint64 amount, gdouble rate, gboolean flush,
 715                                                  gboolean intermediate) G_GNUC_MALLOC;
 716 GST_API
 717 void            gst_message_parse_step_start    (GstMessage * message, gboolean *active, GstFormat *format,
 718                                                  guint64 *amount, gdouble *rate, gboolean *flush,
 719                                                  gboolean *intermediate);
 720
 721 /* QOS */
 722
 723 GST_API
 724 GstMessage *    gst_message_new_qos             (GstObject * src, gboolean live, guint64 running_time,
 725                                                  guint64 stream_time, guint64 timestamp, guint64 duration) G_GNUC_MALLOC;
 726 GST_API
 727 void            gst_message_set_qos_values      (GstMessage * message, gint64 jitter, gdouble proportion,
 728                                                  gint quality);
 729 GST_API
 730 void            gst_message_set_qos_stats       (GstMessage * message, GstFormat format, guint64 processed,
 731                                                  guint64 dropped);
 732 GST_API
 733 void            gst_message_parse_qos           (GstMessage * message, gboolean * live, guint64 * running_time,
 734                                                  guint64 * stream_time, guint64 * timestamp, guint64 * duration);
 735 GST_API
 736 void            gst_message_parse_qos_values    (GstMessage * message, gint64 * jitter, gdouble * proportion,
 737                                                  gint * quality);
 738 GST_API
 739 void            gst_message_parse_qos_stats     (GstMessage * message, GstFormat * format, guint64 * processed,
 740                                                  guint64 * dropped);
 741 /* PROGRESS */
 742
 743 GST_API
 744 GstMessage *    gst_message_new_progress           (GstObject * src, GstProgressType type, const gchar *code,
 745                                                     const gchar *text) G_GNUC_MALLOC;
 746 GST_API
 747 void            gst_message_parse_progress         (GstMessage * message, GstProgressType * type, gchar ** code,
 748                                                     gchar ** text);
 749
 750 /* TOC */
 751
 752 GST_API
 753 GstMessage *    gst_message_new_toc             (GstObject *src, GstToc *toc, gboolean updated);
 754
 755 GST_API
 756 void            gst_message_parse_toc           (GstMessage *message, GstToc **toc, gboolean *updated);
 757
 758 /* RESET_TIME */
 759
 760 GST_API
 761 GstMessage *    gst_message_new_reset_time      (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC;
 762
 763 GST_API
 764 void            gst_message_parse_reset_time    (GstMessage *message, GstClockTime *running_time);
 765
 766 /* STREAM_START */
 767
 768 GST_API
 769 GstMessage *    gst_message_new_stream_start    (GstObject * src) G_GNUC_MALLOC;
 770
 771 GST_API
 772 void            gst_message_set_group_id        (GstMessage *message, guint group_id);
 773
 774 GST_API
 775 gboolean        gst_message_parse_group_id      (GstMessage *message, guint *group_id);
 776
 777 /* NEED_CONTEXT */
 778
 779 GST_API
 780 GstMessage *    gst_message_new_need_context    (GstObject * src, const gchar * context_type) G_GNUC_MALLOC;
 781
 782 GST_API
 783 gboolean        gst_message_parse_context_type  (GstMessage * message, const gchar ** context_type);
 784
 785 /* HAVE_CONTEXT */
 786
 787 GST_API
 788 GstMessage *    gst_message_new_have_context    (GstObject * src, GstContext *context) G_GNUC_MALLOC;
 789
 790 GST_API
 791 void            gst_message_parse_have_context  (GstMessage *message, GstContext **context);
 792
 793 /* DEVICE_ADDED */
 794
 795 GST_API
 796 GstMessage *    gst_message_new_device_added    (GstObject * src, GstDevice * device) G_GNUC_MALLOC;
 797
 798 GST_API
 799 void            gst_message_parse_device_added  (GstMessage * message, GstDevice ** device);
 800
 801 /* DEVICE_REMOVED */
 802
 803 GST_API
 804 GstMessage *    gst_message_new_device_removed    (GstObject * src, GstDevice * device) G_GNUC_MALLOC;
 805
 806 GST_API
 807 void            gst_message_parse_device_removed  (GstMessage * message, GstDevice ** device);
 808
 809 /* PROPERTY_NOTIFY */
 810
 811 GST_API
 812 GstMessage *    gst_message_new_property_notify   (GstObject * src, const gchar * property_name, GValue * val) G_GNUC_MALLOC;
 813
 814 GST_API
 815 void            gst_message_parse_property_notify (GstMessage * message, GstObject ** object, const gchar ** property_name, const GValue ** property_value);
 816
 817 /* STREAM_COLLECTION */
 818
 819 GST_API
 820 GstMessage *    gst_message_new_stream_collection   (GstObject * src, GstStreamCollection * collection) G_GNUC_MALLOC;
 821
 822 GST_API
 823 void            gst_message_parse_stream_collection (GstMessage *message, GstStreamCollection **collection);
 824
 825 /* STREAMS_SELECTED */
 826
 827 GST_API
 828 GstMessage *    gst_message_new_streams_selected (GstObject *src, GstStreamCollection *collection);
 829
 830 GST_API
 831 void            gst_message_streams_selected_add (GstMessage *message, GstStream *stream);
 832
 833 GST_API
 834 void            gst_message_parse_streams_selected (GstMessage * message, GstStreamCollection **collection);
 835
 836 GST_API
 837 guint           gst_message_streams_selected_get_size (GstMessage * message);
 838
 839 GST_API
 840 GstStream      *gst_message_streams_selected_get_stream (GstMessage *message, guint idx);
 841
 842 /* REDIRECT */
 843
 844 GST_API
 845 GstMessage *    gst_message_new_redirect             (GstObject * src, const gchar * location, GstTagList * tag_list, const GstStructure * entry_struct) G_GNUC_MALLOC;
 846
 847 GST_API
 848 void            gst_message_add_redirect_entry       (GstMessage * message, const gchar * location, GstTagList * tag_list, const GstStructure * entry_struct);
 849
 850 GST_API
 851 void            gst_message_parse_redirect_entry     (GstMessage * message, gsize entry_index, const gchar ** location, GstTagList ** tag_list, const GstStructure ** entry_struct);
 852
 853 GST_API
 854 gsize           gst_message_get_num_redirect_entries (GstMessage * message);
 855
 856 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 857 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstMessage, gst_message_unref)
 858 #endif
 859
 860 G_END_DECLS
 861
 862 #endif /* __GST_MESSAGE_H__ */