gstmessage.c 51.6 KB
Newer Older
Wim Taymans's avatar
Wim Taymans committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* GStreamer
 * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
 *
 * gstmessage.c: GstMessage subsystem
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
21

22 23
/**
 * SECTION:gstmessage
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
24 25
 * @short_description: Lightweight objects to signal the application of
 *                     pipeline events
26
 * @see_also: #GstBus, #GstMiniObject, #GstElement
27
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
28
 * Messages are implemented as a subclass of #GstMiniObject with a generic
29 30 31 32
 * #GstStructure as the content. This allows for writing custom messages without
 * requiring an API change while allowing a wide range of different types
 * of messages.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
33 34
 * Messages are posted by objects in the pipeline and are passed to the
 * application using the #GstBus.
35 36 37 38 39 40 41 42 43 44 45 46 47 48

 * The basic use pattern of posting a message on a #GstBus is as follows:
 *
 * <example>
 * <title>Posting a #GstMessage</title>
 *   <programlisting>
 *    gst_bus_post (bus, gst_message_new_eos());
 *   </programlisting>
 * </example>
 *
 * A #GstElement usually posts messages on the bus provided by the parent
 * container using gst_element_post_message().
 *
 * Last reviewed on 2005-11-09 (0.9.4)
49
 */
Wim Taymans's avatar
Wim Taymans committed
50 51 52


#include "gst_private.h"
53
#include <string.h>             /* memcpy */
54
#include "gsterror.h"
55
#include "gstenumtypes.h"
Wim Taymans's avatar
Wim Taymans committed
56 57
#include "gstinfo.h"
#include "gstmessage.h"
58
#include "gsttaglist.h"
59
#include "gstutils.h"
60
#include "gstquark.h"
Wim Taymans's avatar
Wim Taymans committed
61 62


63 64
#define GST_MESSAGE_SEQNUM(e) ((GstMessage*)e)->abidata.ABI.seqnum

65 66
static void gst_message_finalize (GstMessage * message);
static GstMessage *_gst_message_copy (GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
67

68 69
static GstMiniObjectClass *parent_class = NULL;

Wim Taymans's avatar
Wim Taymans committed
70 71 72 73 74
void
_gst_message_initialize (void)
{
  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

75 76 77
  /* the GstMiniObject types need to be class_ref'd once before it can be
   * done from multiple threads;
   * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
78
  g_type_class_ref (gst_message_get_type ());
Wim Taymans's avatar
Wim Taymans committed
79 80
}

81 82
typedef struct
{
83 84
  const gint type;
  const gchar *name;
85 86 87 88 89 90 91 92 93 94 95 96
  GQuark quark;
} GstMessageQuarks;

static GstMessageQuarks message_quarks[] = {
  {GST_MESSAGE_UNKNOWN, "unknown", 0},
  {GST_MESSAGE_EOS, "eos", 0},
  {GST_MESSAGE_ERROR, "error", 0},
  {GST_MESSAGE_WARNING, "warning", 0},
  {GST_MESSAGE_INFO, "info", 0},
  {GST_MESSAGE_TAG, "tag", 0},
  {GST_MESSAGE_BUFFERING, "buffering", 0},
  {GST_MESSAGE_STATE_CHANGED, "state-changed", 0},
97
  {GST_MESSAGE_STATE_DIRTY, "state-dirty", 0},
98
  {GST_MESSAGE_STEP_DONE, "step-done", 0},
Wim Taymans's avatar
Wim Taymans committed
99 100
  {GST_MESSAGE_CLOCK_PROVIDE, "clock-provide", 0},
  {GST_MESSAGE_CLOCK_LOST, "clock-lost", 0},
101 102 103 104
  {GST_MESSAGE_NEW_CLOCK, "new-clock", 0},
  {GST_MESSAGE_STRUCTURE_CHANGE, "structure-change", 0},
  {GST_MESSAGE_STREAM_STATUS, "stream-status", 0},
  {GST_MESSAGE_APPLICATION, "application", 0},
Wim Taymans's avatar
Wim Taymans committed
105
  {GST_MESSAGE_ELEMENT, "element", 0},
106 107
  {GST_MESSAGE_SEGMENT_START, "segment-start", 0},
  {GST_MESSAGE_SEGMENT_DONE, "segment-done", 0},
108
  {GST_MESSAGE_DURATION, "duration", 0},
109
  {GST_MESSAGE_LATENCY, "latency", 0},
110 111
  {GST_MESSAGE_ASYNC_START, "async-start", 0},
  {GST_MESSAGE_ASYNC_DONE, "async-done", 0},
112
  {GST_MESSAGE_REQUEST_STATE, "request-state", 0},
Wim Taymans's avatar
Wim Taymans committed
113
  {GST_MESSAGE_STEP_START, "step-start", 0},
114 115 116
  {0, NULL, 0}
};

Stefan Kost's avatar
Stefan Kost committed
117 118 119 120 121 122
/**
 * gst_message_type_get_name:
 * @type: the message type
 *
 * Get a printable name for the given message type. Do not modify or free.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
123
 * Returns: a reference to the static name of the message.
Stefan Kost's avatar
Stefan Kost committed
124
 */
125 126 127 128 129 130 131 132 133 134 135 136
const gchar *
gst_message_type_get_name (GstMessageType type)
{
  gint i;

  for (i = 0; message_quarks[i].name; i++) {
    if (type == message_quarks[i].type)
      return message_quarks[i].name;
  }
  return "unknown";
}

Stefan Kost's avatar
Stefan Kost committed
137 138 139 140 141 142 143 144
/**
 * gst_message_type_to_quark:
 * @type: the message type
 *
 * Get the unique quark for the given message type.
 *
 * Returns: the quark associated with the message type
 */
145 146 147 148 149 150 151 152 153 154 155 156
GQuark
gst_message_type_to_quark (GstMessageType type)
{
  gint i;

  for (i = 0; message_quarks[i].name; i++) {
    if (type == message_quarks[i].type)
      return message_quarks[i].quark;
  }
  return 0;
}

157 158 159 160 161 162 163 164
#define _do_init \
{ \
  gint i; \
  \
  for (i = 0; message_quarks[i].name; i++) { \
    message_quarks[i].quark = \
        g_quark_from_static_string (message_quarks[i].name); \
  } \
165
}
Wim Taymans's avatar
Wim Taymans committed
166

167 168 169
G_DEFINE_TYPE_WITH_CODE (GstMessage, gst_message, GST_TYPE_MINI_OBJECT,
    _do_init);

170
static void
171
gst_message_class_init (GstMessageClass * klass)
172
{
173
  parent_class = g_type_class_peek_parent (klass);
Wim Taymans's avatar
Wim Taymans committed
174

175 176
  klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_message_copy;
  klass->mini_object_class.finalize =
177 178
      (GstMiniObjectFinalizeFunction) gst_message_finalize;
}
Wim Taymans's avatar
Wim Taymans committed
179

180
static void
181
gst_message_init (GstMessage * message)
182
{
183
  GST_CAT_LOG (GST_CAT_MESSAGE, "new message %p", message);
Wim Taymans's avatar
Wim Taymans committed
184
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
185 186 187
}

static void
188
gst_message_finalize (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
189
{
190
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
191

192
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p", message);
193

Wim Taymans's avatar
Wim Taymans committed
194
  if (GST_MESSAGE_SRC (message)) {
195
    gst_object_unref (GST_MESSAGE_SRC (message));
Wim Taymans's avatar
Wim Taymans committed
196
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
197 198 199 200 201 202 203 204
  }

  if (message->lock) {
    GST_MESSAGE_LOCK (message);
    GST_MESSAGE_SIGNAL (message);
    GST_MESSAGE_UNLOCK (message);
  }

205 206
  if (message->structure) {
    gst_structure_set_parent_refcount (message->structure, NULL);
Wim Taymans's avatar
Wim Taymans committed
207
    gst_structure_free (message->structure);
208
  }
209

210
/*   GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (message)); */
Wim Taymans's avatar
Wim Taymans committed
211 212
}

213 214
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
215
{
216 217
  GstMessage *copy;

218
  GST_CAT_LOG (GST_CAT_MESSAGE, "copy message %p", message);
219 220 221

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

Wim Taymans's avatar
Wim Taymans committed
222
  /* FIXME, need to copy relevant data from the miniobject. */
223 224
  //memcpy (copy, message, sizeof (GstMessage));

Wim Taymans's avatar
Wim Taymans committed
225 226 227 228
  GST_MESSAGE_GET_LOCK (copy) = GST_MESSAGE_GET_LOCK (message);
  GST_MESSAGE_COND (copy) = GST_MESSAGE_COND (message);
  GST_MESSAGE_TYPE (copy) = GST_MESSAGE_TYPE (message);
  GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
229
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
230 231

  if (GST_MESSAGE_SRC (message)) {
232
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
233 234 235 236 237
  }

  if (message->structure) {
    copy->structure = gst_structure_copy (message->structure);
    gst_structure_set_parent_refcount (copy->structure,
238
        &copy->mini_object.refcount);
239 240 241
  }

  return copy;
Wim Taymans's avatar
Wim Taymans committed
242 243
}

Wim Taymans's avatar
Wim Taymans committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * gst_message_new_custom:
 * @type: The #GstMessageType to distinguish messages
 * @src: The object originating the message.
 * @structure: The structure for the message. The message will take ownership of
 * the structure.
 *
 * Create a new custom-typed message. This can be used for anything not
 * handled by other message-specific functions to pass a message to the
 * app. The structure field can be NULL.
 *
 * Returns: The new message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_custom (GstMessageType type, GstObject * src,
    GstStructure * structure)
Wim Taymans's avatar
Wim Taymans committed
262 263 264
{
  GstMessage *message;

265
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
266

267 268
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
269
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
270

271
  message->type = type;
272 273 274 275 276

  if (src)
    gst_object_ref (src);
  message->src = src;

Wim Taymans's avatar
Wim Taymans committed
277 278 279 280 281
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
282

283 284
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();

Wim Taymans's avatar
Wim Taymans committed
285 286 287
  return message;
}

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
/**
 * gst_message_get_seqnum:
 * @message: A #GstMessage.
 *
 * Retrieve the sequence number of a message.
 *
 * Messages have ever-incrementing sequence numbers, which may also be set
 * explicitly via gst_message_set_seqnum(). Sequence numbers are typically used
 * to indicate that a message corresponds to some other set of messages or
 * events, for example a SEGMENT_DONE message corresponding to a SEEK event. It
 * is considered good practice to make this correspondence when possible, though
 * it is not required.
 *
 * Note that events and messages share the same sequence number incrementor;
 * two events or messages will never not have the same sequence number unless
 * that correspondence was made explicitly.
 *
 * Returns: The message's sequence number.
 *
 * MT safe.
308 309
 *
 * Since: 0.10.22
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
 */
guint32
gst_message_get_seqnum (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), -1);

  return GST_MESSAGE_SEQNUM (message);
}

/**
 * gst_message_set_seqnum:
 * @message: A #GstMessage.
 * @seqnum: A sequence number.
 *
 * Set the sequence number of a message.
 *
 * This function might be called by the creator of a message to indicate that
 * the message relates to other messages or events. See gst_message_get_seqnum()
 * for more information.
 *
 * MT safe.
331 332
 *
 * Since: 0.10.22
333 334 335 336 337 338 339 340 341
 */
void
gst_message_set_seqnum (GstMessage * message, guint32 seqnum)
{
  g_return_if_fail (GST_IS_MESSAGE (message));

  GST_MESSAGE_SEQNUM (message) = seqnum;
}

Wim Taymans's avatar
Wim Taymans committed
342 343
/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
344
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
345
 *
346 347 348
 * Create a new eos message. This message is generated and posted in
 * the sink elements of a GstBin. The bin will only forward the EOS
 * message to the application if all sinks have posted an EOS message.
Wim Taymans's avatar
Wim Taymans committed
349 350 351 352 353 354 355 356 357 358
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
359
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
360 361 362 363 364 365 366 367

  return message;
}

/**
 * gst_message_new_error:
 * @src: The object originating the message.
 * @error: The GError for this message.
368
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
369
 *
370
 * Create a new error message. The message will copy @error and
371
 * @debug. This message is posted by element when a fatal event
372 373
 * occured. The pipeline will probably (partially) stop. The application
 * receiving this message should stop the pipeline.
Wim Taymans's avatar
Wim Taymans committed
374 375 376 377 378 379
 *
 * Returns: The new error message.
 *
 * MT safe.
 */
GstMessage *
380
gst_message_new_error (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
381 382
{
  GstMessage *message;
383
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
384

385
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ERROR),
386 387 388
      GST_QUARK (GERROR), GST_TYPE_G_ERROR, error,
      GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ERROR, src, structure);
Wim Taymans's avatar
Wim Taymans committed
389 390 391 392 393 394 395 396

  return message;
}

/**
 * gst_message_new_warning:
 * @src: The object originating the message.
 * @error: The GError for this message.
397
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
398
 *
399
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
400 401 402 403 404 405 406
 * @debug.
 *
 * Returns: The new warning message.
 *
 * MT safe.
 */
GstMessage *
407
gst_message_new_warning (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
408 409
{
  GstMessage *message;
410
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
411

412
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_WARNING),
413 414 415
      GST_QUARK (GERROR), GST_TYPE_G_ERROR, error,
      GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
  message = gst_message_new_custom (GST_MESSAGE_WARNING, src, structure);
Wim Taymans's avatar
Wim Taymans committed
416 417 418 419

  return message;
}

420 421 422 423
/**
 * gst_message_new_info:
 * @src: The object originating the message.
 * @error: The GError for this message.
424
 * @debug: A debugging string.
425 426 427 428 429
 *
 * Create a new info message. The message will make copies of @error and
 * @debug.
 *
 * MT safe.
430
 *
Stefan Kost's avatar
Stefan Kost committed
431 432
 * Returns: The new info message.
 *
433
 * Since: 0.10.12
434 435
 */
GstMessage *
436
gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
437 438
{
  GstMessage *message;
439
  GstStructure *structure;
440

441 442 443
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_INFO),
      GST_QUARK (GERROR), GST_TYPE_G_ERROR, error,
      GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
444
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
445 446 447 448

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
449 450 451 452 453 454
/**
 * gst_message_new_tag:
 * @src: The object originating the message.
 * @tag_list: The tag list for the message.
 *
 * Create a new tag message. The message will take ownership of the tag list.
455
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
456 457 458 459 460 461 462 463 464 465
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

466 467
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
468 469
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
470 471 472 473

  return message;
}

474 475 476 477 478 479 480 481 482
/**
 * gst_message_new_tag_full:
 * @src: The object originating the message.
 * @pad: The originating pad for the tag.
 * @tag_list: The tag list for the message.
 *
 * Create a new tag message. The message will take ownership of the tag list.
 * The message is posted by elements that discovered a new taglist.
 *
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
483 484
 * MT safe.
 *
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
 * Returns: The new tag message.
 *
 * Since: 0.10.24
 */
GstMessage *
gst_message_new_tag_full (GstObject * src, GstPad * pad, GstTagList * tag_list)
{
  GstMessage *message;
  GstStructure *s;

  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);
  g_return_val_if_fail (pad == NULL || GST_IS_PAD (pad), NULL);

  s = (GstStructure *) tag_list;
  if (pad)
    gst_structure_set (s, "source-pad", GST_TYPE_PAD, pad, NULL);

  message = gst_message_new_custom (GST_MESSAGE_TAG, src, s);

  return message;
}

507 508 509 510 511 512 513 514 515
/**
 * gst_message_new_buffering:
 * @src: The object originating the message.
 * @percent: The buffering percent
 *
 * Create a new buffering message. This message can be posted by an element that
 * needs to buffer data before it can continue processing. @percent should be a
 * value between 0 and 100. A value of 100 means that the buffering completed.
 *
Wim Taymans's avatar
Wim Taymans committed
516 517 518 519 520 521 522
 * When @percent is < 100 the application should PAUSE a PLAYING pipeline. When
 * @percent is 100, the application can set the pipeline (back) to PLAYING.
 * The application must be prepared to receive BUFFERING messages in the
 * PREROLLING state and may only set the pipeline to PLAYING after receiving a
 * message with @percent set to 100, which can happen after the pipeline
 * completed prerolling. 
 *
523
 * MT safe.
524
 *
Stefan Kost's avatar
Stefan Kost committed
525 526
 * Returns: The new buffering message.
 *
527
 * Since: 0.10.11
528 529 530 531 532
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;
533
  GstStructure *structure;
534 535 536

  g_return_val_if_fail (percent >= 0 && percent <= 100, NULL);

537
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_BUFFERING),
538 539 540 541
      GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, percent,
      GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, GST_BUFFERING_STREAM,
      GST_QUARK (AVG_IN_RATE), G_TYPE_INT, -1,
      GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, -1,
542 543
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
      GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
544
  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
545 546 547 548

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
549
/**
Stefan Kost's avatar
Stefan Kost committed
550
 * gst_message_new_state_changed:
551 552 553 554
 * @src: the object originating the message
 * @oldstate: the previous state
 * @newstate: the new (current) state
 * @pending: the pending (target) state
Wim Taymans's avatar
Wim Taymans committed
555
 *
556 557
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
558 559 560 561 562 563
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
564
gst_message_new_state_changed (GstObject * src,
565
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
566 567
{
  GstMessage *message;
568
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
569

570
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STATE),
571 572 573 574
      GST_QUARK (OLD_STATE), GST_TYPE_STATE, (gint) oldstate,
      GST_QUARK (NEW_STATE), GST_TYPE_STATE, (gint) newstate,
      GST_QUARK (PENDING_STATE), GST_TYPE_STATE, (gint) pending, NULL);
  message = gst_message_new_custom (GST_MESSAGE_STATE_CHANGED, src, structure);
Wim Taymans's avatar
Wim Taymans committed
575 576 577 578

  return message;
}

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
/**
 * gst_message_new_state_dirty:
 * @src: the object originating the message
 *
 * Create a state dirty message. This message is posted whenever an element
 * changed its state asynchronously and is used internally to update the
 * states of container objects.
 *
 * Returns: The new state dirty message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_state_dirty (GstObject * src)
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_STATE_DIRTY, src, NULL);

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
601 602 603
/**
 * gst_message_new_clock_provide:
 * @src: The object originating the message.
604
 * @clock: The clock it provides
Wim Taymans's avatar
Wim Taymans committed
605 606
 * @ready: TRUE if the sender can provide a clock
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
607
 * Create a clock provide message. This message is posted whenever an
Wim Taymans's avatar
Wim Taymans committed
608 609 610
 * element is ready to provide a clock or lost its ability to provide
 * a clock (maybe because it paused or became EOS).
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
611
 * This message is mainly used internally to manage the clock
Wim Taymans's avatar
Wim Taymans committed
612 613 614 615 616 617 618
 * selection.
 *
 * Returns: The new provide clock message.
 *
 * MT safe.
 */
GstMessage *
619 620
gst_message_new_clock_provide (GstObject * src, GstClock * clock,
    gboolean ready)
Wim Taymans's avatar
Wim Taymans committed
621 622
{
  GstMessage *message;
623
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
624

625
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_PROVIDE),
626 627 628
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock,
      GST_QUARK (READY), G_TYPE_BOOLEAN, ready, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_PROVIDE, src, structure);
629

Wim Taymans's avatar
Wim Taymans committed
630 631 632
  return message;
}

633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
/**
 * gst_message_new_clock_lost:
 * @src: The object originating the message.
 * @clock: the clock that was lost
 *
 * Create a clock lost message. This message is posted whenever the
 * clock is not valid anymore.
 *
 * If this message is posted by the pipeline, the pipeline will
 * select a new clock again when it goes to PLAYING. It might therefore
 * be needed to set the pipeline to PAUSED and PLAYING again.
 *
 * Returns: The new clock lost message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_clock_lost (GstObject * src, GstClock * clock)
{
  GstMessage *message;
653
  GstStructure *structure;
654

655
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_LOST),
656 657
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
658 659 660 661

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
/**
 * gst_message_new_new_clock:
 * @src: The object originating the message.
 * @clock: the new selected clock
 *
 * Create a new clock message. This message is posted whenever the
 * pipeline selectes a new clock for the pipeline.
 *
 * Returns: The new new clock message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_new_clock (GstObject * src, GstClock * clock)
{
  GstMessage *message;
678
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
679

680
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_NEW_CLOCK),
681 682
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_NEW_CLOCK, src, structure);
Wim Taymans's avatar
Wim Taymans committed
683 684 685 686

  return message;
}

687 688 689 690 691 692 693 694 695 696 697
/**
 * gst_message_new_structure_change:
 * @src: The object originating the message.
 * @type: The change type.
 * @owner: The owner element of @src.
 * @busy: Whether the structure change is busy.
 *
 * Create a new structure change message. This message is posted when the
 * structure of a pipeline is in the process of being changed, for example
 * when pads are linked or unlinked.
 *
698
 * @src should be the sinkpad that unlinked or linked.
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
 *
 * Returns: The new structure change message.
 *
 * MT safe.
 *
 * Since: 0.10.22.
 */
GstMessage *
gst_message_new_structure_change (GstObject * src, GstStructureChangeType type,
    GstElement * owner, gboolean busy)
{
  GstMessage *message;
  GstStructure *structure;

  g_return_val_if_fail (GST_IS_PAD (src), NULL);
714
  // g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SINK, NULL);
715 716
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

717
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STRUCTURE_CHANGE),
718 719 720 721 722 723 724 725 726 727
      GST_QUARK (TYPE), GST_TYPE_STRUCTURE_CHANGE_TYPE, type,
      GST_QUARK (OWNER), GST_TYPE_ELEMENT, owner,
      GST_QUARK (BUSY), G_TYPE_BOOLEAN, busy, NULL);

  message = gst_message_new_custom (GST_MESSAGE_STRUCTURE_CHANGE, src,
      structure);

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
728
/**
729 730
 * gst_message_new_segment_start:
 * @src: The object originating the message.
731 732
 * @format: The format of the position being played
 * @position: The position of the segment being played
733 734 735 736 737 738 739 740 741 742 743
 *
 * Create a new segment message. This message is posted by elements that
 * start playback of a segment as a result of a segment seek. This message
 * is not received by the application but is used for maintenance reasons in
 * container elements.
 *
 * Returns: The new segment start message.
 *
 * MT safe.
 */
GstMessage *
744 745
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
746 747
{
  GstMessage *message;
748
  GstStructure *structure;
749

750
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_START),
751 752 753
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_START, src, structure);
754 755 756 757 758 759 760

  return message;
}

/**
 * gst_message_new_segment_done:
 * @src: The object originating the message.
761 762
 * @format: The format of the position being done
 * @position: The position of the segment being done
763 764 765 766 767 768 769 770 771 772 773
 *
 * Create a new segment done message. This message is posted by elements that
 * finish playback of a segment as a result of a segment seek. This message
 * is received by the application after all elements that posted a segment_start
 * have posted the segment_done.
 *
 * Returns: The new segment done message.
 *
 * MT safe.
 */
GstMessage *
774 775
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
776 777
{
  GstMessage *message;
778
  GstStructure *structure;
779

780
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_DONE),
781 782 783
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_DONE, src, structure);
784 785 786 787

  return message;
}

788 789 790 791 792 793 794 795 796
/**
 * gst_message_new_application:
 * @src: The object originating the message.
 * @structure: The structure for the message. The message will take ownership of
 * the structure.
 *
 * Create a new application-typed message. GStreamer will never create these
 * messages; they are a gift from us to you. Enjoy.
 *
Stefan Kost's avatar
Stefan Kost committed
797 798
 * Returns: The new application message.
 *
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
 * MT safe.
 */
GstMessage *
gst_message_new_application (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_APPLICATION, src, structure);
}

/**
 * gst_message_new_element:
 * @src: The object originating the message.
 * @structure: The structure for the message. The message will take ownership of
 * the structure.
 *
 * Create a new element-specific message. This is meant as a generic way of
 * allowing one-way communication from an element to an application, for example
 * "the firewire cable was unplugged". The format of the message should be
 * documented in the element's documentation. The structure field can be NULL.
 *
Stefan Kost's avatar
Stefan Kost committed
818 819
 * Returns: The new element message.
 *
820 821 822 823 824 825 826 827
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

828 829 830 831 832 833 834 835 836
/**
 * gst_message_new_duration:
 * @src: The object originating the message.
 * @format: The format of the duration
 * @duration: The new duration 
 *
 * Create a new duration message. This message is posted by elements that
 * know the duration of a stream in a specific format. This message
 * is received by bins and is used to calculate the total duration of a
837 838 839 840
 * pipeline. Elements may post a duration message with a duration of
 * GST_CLOCK_TIME_NONE to indicate that the duration has changed and the 
 * cached duration should be discarded. The new duration can then be 
 * retrieved via a query.
841 842 843 844 845 846 847 848 849
 *
 * Returns: The new duration message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
{
  GstMessage *message;
850
  GstStructure *structure;
851

852
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_DURATION),
853 854 855
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
  message = gst_message_new_custom (GST_MESSAGE_DURATION, src, structure);
856 857 858 859

  return message;
}

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
/**
 * gst_message_new_async_start:
 * @src: The object originating the message.
 * @new_base_time: if a new base_time should be set on the element
 *
 * This message is posted by elements when they start an ASYNC state change. 
 * @new_base_time is set to TRUE when the element lost its state when it was
 * PLAYING.
 *
 * Returns: The new async_start message. 
 *
 * MT safe.
 *
 * Since: 0.10.13
 */
GstMessage *
gst_message_new_async_start (GstObject * src, gboolean new_base_time)
{
  GstMessage *message;
879
  GstStructure *structure;
880

881
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ASYNC_START),
882 883
      GST_QUARK (NEW_BASE_TIME), G_TYPE_BOOLEAN, new_base_time, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, structure);
884 885 886 887 888 889 890 891

  return message;
}

/**
 * gst_message_new_async_done:
 * @src: The object originating the message.
 *
Stefan Kost's avatar
Stefan Kost committed
892 893
 * The message is posted when elements completed an ASYNC state change.
 *
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
 * Returns: The new async_done message.
 *
 * MT safe.
 *
 * Since: 0.10.13
 */
GstMessage *
gst_message_new_async_done (GstObject * src)
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_ASYNC_DONE, src, NULL);

  return message;
}

910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
/**
 * gst_message_new_latency:
 * @src: The object originating the message.
 *
 * This message can be posted by elements when their latency requirements have
 * changed.
 *
 * Returns: The new latency message. 
 *
 * MT safe.
 *
 * Since: 0.10.12
 */
GstMessage *
gst_message_new_latency (GstObject * src)
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_LATENCY, src, NULL);

  return message;
}

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
/**
 * gst_message_new_request_state:
 * @src: The object originating the message.
 * @state: The new requested state
 *
 * This message can be posted by elements when they want to have their state
 * changed. A typical use case would be an audio server that wants to pause the
 * pipeline because a higher priority stream is being played.
 *
 * Returns: The new requst state message. 
 *
 * MT safe.
 *
 * Since: 0.10.23
 */
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
{
  GstMessage *message;
  GstStructure *structure;

954
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_REQUEST_STATE),
955 956 957 958 959 960
      GST_QUARK (NEW_STATE), GST_TYPE_STATE, (gint) state, NULL);
  message = gst_message_new_custom (GST_MESSAGE_REQUEST_STATE, src, structure);

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
961 962 963 964 965 966
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
967
 * Returns: The structure of the message. The structure is still
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
968
 * owned by the message, which means that you should not free it and
969
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
970 971 972 973 974 975 976
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
977

Wim Taymans's avatar
Wim Taymans committed
978 979 980 981 982 983
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
Stefan Kost's avatar
Stefan Kost committed
984
 * @tag_list: Return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
985 986 987 988 989 990 991 992 993
 *
 * Extracts the tag list from the GstMessage. The tag list returned in the
 * output argument is a copy; the caller must free it when done.
 *
 * MT safe.
 */
void
gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
{
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
  GstStructure *ret;

  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
  g_return_if_fail (tag_list != NULL);

  ret = gst_structure_copy (message->structure);
  gst_structure_remove_field (ret, "source-pad");

  *tag_list = (GstTagList *) ret;
}

/**
 * gst_message_parse_tag_full:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
 * @pad: Location where the originating pad is stored, unref after usage
 * @tag_list: Return location for the tag-list.
 *
 * Extracts the tag list from the GstMessage. The tag list returned in the
 * output argument is a copy; the caller must free it when done.
 *
 * MT safe.
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
1016 1017
 *
 * Since: 0.10.24
1018 1019 1020 1021 1022 1023 1024
 */
void
gst_message_parse_tag_full (GstMessage * message, GstPad ** pad,
    GstTagList ** tag_list)
{
  GstStructure *ret;

Wim Taymans's avatar
Wim Taymans committed
1025 1026
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1027
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
1028

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
  ret = gst_structure_copy (message->structure);

  if (gst_structure_has_field (ret, "source-pad") && pad) {
    const GValue *v;

    v = gst_structure_get_value (ret, "source-pad");
    if (v && G_VALUE_HOLDS (v, GST_TYPE_PAD))
      *pad = g_value_dup_object (v);
    else
      *pad = NULL;
  } else if (pad) {
    *pad = NULL;
  }
  gst_structure_remove_field (ret, "source-pad");

  *tag_list = (GstTagList *) ret;
Wim Taymans's avatar
Wim Taymans committed
1045
}
1046 1047 1048 1049 1050 1051

/**
 * gst_message_parse_buffering:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
 * @percent: Return location for the percent.
 *
Wim Taymans's avatar
Wim Taymans committed
1052 1053
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
1054 1055
 *
 * MT safe.
1056 1057
 *
 * Since: 0.10.11
1058 1059 1060 1061 1062 1063 1064 1065
 */
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);

  if (percent)
1066 1067
    *percent = g_value_get_int (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUFFER_PERCENT)));
1068
}
Wim Taymans's avatar
Wim Taymans committed
1069

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
/**
 * gst_message_set_buffering_stats:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
 * @mode: a buffering mode 
 * @avg_in: the average input rate
 * @avg_out: the average output rate
 * @buffering_left: amount of buffering time left in milliseconds
 *
 * Configures the buffering stats values in @message.
 *
 * Since: 0.10.20
 */
void
gst_message_set_buffering_stats (GstMessage * message, GstBufferingMode mode,
    gint avg_in, gint avg_out, gint64 buffering_left)
{
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);

  gst_structure_id_set (message->structure,
      GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, mode,
      GST_QUARK (AVG_IN_RATE), G_TYPE_INT, avg_in,
      GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, avg_out,
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, buffering_left, NULL);
}

/**
 * gst_message_parse_buffering_stats:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
 * @mode: a buffering mode 
 * @avg_in: the average input rate
 * @avg_out: the average output rate
 * @buffering_left: amount of buffering time left in milliseconds.
 *
 * Extracts the buffering stats values from @message.
 *
 * Since: 0.10.20
 */
void
gst_message_parse_buffering_stats (GstMessage * message,
    GstBufferingMode * mode, gint * avg_in, gint * avg_out,
    gint64 * buffering_left)
{
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);

  if (mode)
    *mode = g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUFFERING_MODE)));
  if (avg_in)
    *avg_in = g_value_get_int (gst_structure_id_get_value (message->structure,
            GST_QUARK (AVG_IN_RATE)));
  if (avg_out)
    *avg_out = g_value_get_int (gst_structure_id_get_value (message->structure,
            GST_QUARK (AVG_OUT_RATE)));
  if (buffering_left)
    *buffering_left =
        g_value_get_int64 (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUFFERING_LEFT)));
}

Wim Taymans's avatar
Wim Taymans committed
1129
/**
1130
 * gst_message_parse_state_changed:
1131
 * @message: a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED
1132 1133 1134
 * @oldstate: the previous state, or NULL
 * @newstate: the new (current) state, or NULL
 * @pending: the pending (target) state, or NULL
Wim Taymans's avatar
Wim Taymans committed
1135 1136 1137 1138 1139 1140
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
1141
gst_message_parse_state_changed (GstMessage * message,
1142
    GstState * oldstate, GstState * newstate, GstState * pending)
Wim Taymans's avatar
Wim Taymans committed
1143 1144 1145 1146
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);

1147
  if (oldstate)
1148 1149 1150
    *oldstate =
        g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (OLD_STATE)));
1151
  if (newstate)
1152 1153 1154
    *newstate =
        g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (NEW_STATE)));
1155
  if (pending)
1156 1157
    *pending = g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (PENDING_STATE)));
Wim Taymans's avatar
Wim Taymans committed
1158 1159
}

Wim Taymans's avatar
Wim Taymans committed
1160 1161 1162
/**
 * gst_message_parse_clock_provide:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.
1163 1164
 * @clock: A pointer to  hold a clock object.
 * @ready: A pointer to hold the ready flag.
Wim Taymans's avatar
Wim Taymans committed
1165
 *
1166 1167
 * Extracts the clock and ready flag from the GstMessage.
 * The clock object returned remains valid until the message is freed.
Wim Taymans's avatar
Wim Taymans committed
1168 1169 1170 1171
 *
 * MT safe.
 */
void
1172 1173
gst_message_parse_clock_provide (GstMessage * message, GstClock ** clock,
    gboolean * ready)
Wim Taymans's avatar
Wim Taymans committed
1174
{
1175 1176
  const GValue *clock_gvalue;

Wim Taymans's avatar
Wim Taymans committed
1177 1178 1179
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_PROVIDE);

1180 1181
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
1182 1183 1184
  g_return_if_fail (clock_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (clock_gvalue) == GST_TYPE_CLOCK);

Wim Taymans's avatar
Wim Taymans committed
1185
  if (ready)
1186 1187 1188
    *ready =
        g_value_get_boolean (gst_structure_id_get_value (message->structure,
            GST_QUARK (READY)));
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
  if (clock)
    *clock = (GstClock *) g_value_get_object (clock_gvalue);
}

/**
 * gst_message_parse_clock_lost:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_LOST.
 * @clock: A pointer to hold the lost clock
 *
 * Extracts the lost clock from the GstMessage.
 * The clock object returned remains valid until the message is freed.
 *
 * MT safe.
 */
void
gst_message_parse_clock_lost (GstMessage * message, GstClock ** clock)
{
  const GValue *clock_gvalue;

  g_return_if_fail (GST_IS_MESSAGE (message));
1209
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_LOST);
1210

1211 1212
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
1213 1214 1215 1216 1217
  g_return_if_fail (clock_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (clock_gvalue) == GST_TYPE_CLOCK);

  if (clock)
    *clock = (GstClock *) g_value_get_object (clock_gvalue);
Wim Taymans's avatar
Wim Taymans committed
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
}

/**
 * gst_message_parse_new_clock:
 * @message: A valid #GstMessage of type GST_MESSAGE_NEW_CLOCK.
 * @clock: A pointer to hold the selected new clock
 *
 * Extracts the new clock from the GstMessage.
 * The clock object returned remains valid until the message is freed.
 *
 * MT safe.
 */
void
gst_message_parse_new_clock (GstMessage * message, GstClock ** clock)
{
  const GValue *clock_gvalue;

  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_NEW_CLOCK);

1238 1239
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
Wim Taymans's avatar
Wim Taymans committed
1240 1241 1242 1243