gstmessage.c 51.7 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
#define GST_MESSAGE_SEQNUM(e) ((GstMessage*)e)->abidata.ABI.seqnum
64 65 66
#define MESSAGE_SRC(m) ((m)->src)
#define MESSAGE_TYPE(m) ((m)->type)
#define MESSAGE_TIMESTAMP(m) ((m)->timestamp)
67

68 69
static void gst_message_finalize (GstMessage * message);
static GstMessage *_gst_message_copy (GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
70

71 72
static GstMiniObjectClass *parent_class = NULL;

Wim Taymans's avatar
Wim Taymans committed
73 74 75 76 77
void
_gst_message_initialize (void)
{
  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

78 79 80
  /* 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 */
81
  g_type_class_ref (gst_message_get_type ());
Wim Taymans's avatar
Wim Taymans committed
82 83
}

84 85
typedef struct
{
86 87
  const gint type;
  const gchar *name;
88 89 90 91 92 93 94 95 96 97 98 99
  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},
100
  {GST_MESSAGE_STATE_DIRTY, "state-dirty", 0},
101
  {GST_MESSAGE_STEP_DONE, "step-done", 0},
Wim Taymans's avatar
Wim Taymans committed
102 103
  {GST_MESSAGE_CLOCK_PROVIDE, "clock-provide", 0},
  {GST_MESSAGE_CLOCK_LOST, "clock-lost", 0},
104 105 106 107
  {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
108
  {GST_MESSAGE_ELEMENT, "element", 0},
109 110
  {GST_MESSAGE_SEGMENT_START, "segment-start", 0},
  {GST_MESSAGE_SEGMENT_DONE, "segment-done", 0},
111
  {GST_MESSAGE_DURATION, "duration", 0},
112
  {GST_MESSAGE_LATENCY, "latency", 0},
113 114
  {GST_MESSAGE_ASYNC_START, "async-start", 0},
  {GST_MESSAGE_ASYNC_DONE, "async-done", 0},
115
  {GST_MESSAGE_REQUEST_STATE, "request-state", 0},
Wim Taymans's avatar
Wim Taymans committed
116
  {GST_MESSAGE_STEP_START, "step-start", 0},
117 118 119
  {0, NULL, 0}
};

Stefan Kost's avatar
Stefan Kost committed
120 121 122 123 124 125
/**
 * 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
126
 * Returns: a reference to the static name of the message.
Stefan Kost's avatar
Stefan Kost committed
127
 */
128 129 130 131 132 133 134 135 136 137 138 139
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
140 141 142 143 144 145 146 147
/**
 * 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
 */
148 149 150 151 152 153 154 155 156 157 158 159
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;
}

160 161 162 163 164 165 166 167
#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); \
  } \
168
}
Wim Taymans's avatar
Wim Taymans committed
169

170 171 172
G_DEFINE_TYPE_WITH_CODE (GstMessage, gst_message, GST_TYPE_MINI_OBJECT,
    _do_init);

173
static void
174
gst_message_class_init (GstMessageClass * klass)
175
{
176
  parent_class = g_type_class_peek_parent (klass);
Wim Taymans's avatar
Wim Taymans committed
177

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

183
static void
184
gst_message_init (GstMessage * message)
185
{
186
  GST_CAT_LOG (GST_CAT_MESSAGE, "new message %p", message);
187
  MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
188 189 190
}

static void
191
gst_message_finalize (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
192
{
193
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
194

195
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p", message);
196

197 198 199
  if (MESSAGE_SRC (message)) {
    gst_object_unref (MESSAGE_SRC (message));
    MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
200 201 202 203 204 205 206 207
  }

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

208 209
  if (message->structure) {
    gst_structure_set_parent_refcount (message->structure, NULL);
Wim Taymans's avatar
Wim Taymans committed
210
    gst_structure_free (message->structure);
211
  }
212

213
/*   GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (message)); */
Wim Taymans's avatar
Wim Taymans committed
214 215
}

216 217
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
218
{
219 220
  GstMessage *copy;

221 222
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);

223
  GST_CAT_LOG (GST_CAT_MESSAGE, "copy message %p", message);
224 225 226

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
230 231
  GST_MESSAGE_GET_LOCK (copy) = GST_MESSAGE_GET_LOCK (message);
  GST_MESSAGE_COND (copy) = GST_MESSAGE_COND (message);
232 233
  MESSAGE_TYPE (copy) = MESSAGE_TYPE (message);
  MESSAGE_TIMESTAMP (copy) = MESSAGE_TIMESTAMP (message);
234
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
235

236 237
  if (MESSAGE_SRC (message)) {
    MESSAGE_SRC (copy) = gst_object_ref (MESSAGE_SRC (message));
238 239 240 241 242
  }

  if (message->structure) {
    copy->structure = gst_structure_copy (message->structure);
    gst_structure_set_parent_refcount (copy->structure,
243
        &copy->mini_object.refcount);
244 245 246
  }

  return copy;
Wim Taymans's avatar
Wim Taymans committed
247 248
}

Wim Taymans's avatar
Wim Taymans committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
/**
 * 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
267 268 269
{
  GstMessage *message;

270
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
271

272 273
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
274
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
275

276
  message->type = type;
277 278 279 280 281

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

Wim Taymans's avatar
Wim Taymans committed
282 283 284 285 286
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
287

288 289
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();

Wim Taymans's avatar
Wim Taymans committed
290 291 292
  return message;
}

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
/**
 * 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.
313 314
 *
 * Since: 0.10.22
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
 */
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.
336 337
 *
 * Since: 0.10.22
338 339 340 341 342 343 344 345 346
 */
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
347 348
/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
349
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
350
 *
351 352 353
 * 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
354 355 356 357 358 359 360 361 362 363
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
364
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
365 366 367 368 369 370 371 372

  return message;
}

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

390
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ERROR),
391 392 393
      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
394 395 396 397 398 399 400 401

  return message;
}

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

417
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_WARNING),
418 419 420
      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
421 422 423 424

  return message;
}

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

446 447 448
  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);
449
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
450 451 452 453

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
454 455 456 457 458 459
/**
 * 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.
460
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
461 462 463 464 465 466 467 468 469 470
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

471 472
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
473 474
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
475 476 477 478

  return message;
}

479 480 481 482 483 484 485 486 487
/**
 * 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
488 489
 * MT safe.
 *
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
 * 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;
}

512 513 514 515 516 517 518 519 520
/**
 * 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
521 522 523 524 525 526 527
 * 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. 
 *
528
 * MT safe.
529
 *
Stefan Kost's avatar
Stefan Kost committed
530 531
 * Returns: The new buffering message.
 *
532
 * Since: 0.10.11
533 534 535 536 537
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;
538
  GstStructure *structure;
539 540 541

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

542
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_BUFFERING),
543 544 545 546
      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,
547 548
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
      GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
549
  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
550 551 552 553

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
554
/**
Stefan Kost's avatar
Stefan Kost committed
555
 * gst_message_new_state_changed:
556 557 558 559
 * @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
560
 *
561 562
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
563 564 565 566 567 568
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
569
gst_message_new_state_changed (GstObject * src,
570
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
571 572
{
  GstMessage *message;
573
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
574

575
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STATE),
576 577 578 579
      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
580 581 582 583

  return message;
}

584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
/**
 * 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
606 607 608
/**
 * gst_message_new_clock_provide:
 * @src: The object originating the message.
609
 * @clock: The clock it provides
Wim Taymans's avatar
Wim Taymans committed
610 611
 * @ready: TRUE if the sender can provide a clock
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
612
 * Create a clock provide message. This message is posted whenever an
Wim Taymans's avatar
Wim Taymans committed
613 614 615
 * 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
616
 * This message is mainly used internally to manage the clock
Wim Taymans's avatar
Wim Taymans committed
617 618 619 620 621 622 623
 * selection.
 *
 * Returns: The new provide clock message.
 *
 * MT safe.
 */
GstMessage *
624 625
gst_message_new_clock_provide (GstObject * src, GstClock * clock,
    gboolean ready)
Wim Taymans's avatar
Wim Taymans committed
626 627
{
  GstMessage *message;
628
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
629

630
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_PROVIDE),
631 632 633
      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);
634

Wim Taymans's avatar
Wim Taymans committed
635 636 637
  return message;
}

638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
/**
 * 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;
658
  GstStructure *structure;
659

660
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_LOST),
661 662
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
663 664 665 666

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
/**
 * 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;
683
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
684

685
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_NEW_CLOCK),
686 687
      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
688 689 690 691

  return message;
}

692 693 694 695 696 697 698 699 700 701 702
/**
 * 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.
 *
703
 * @src should be the sinkpad that unlinked or linked.
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
 *
 * 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);
Jan Schmidt's avatar
Jan Schmidt committed
719
  /* g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SINK, NULL); */
720 721
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

722
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STRUCTURE_CHANGE),
723 724 725 726 727 728 729 730 731 732
      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
733
/**
734 735
 * gst_message_new_segment_start:
 * @src: The object originating the message.
736 737
 * @format: The format of the position being played
 * @position: The position of the segment being played
738 739 740 741 742 743 744 745 746 747 748
 *
 * 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 *
749 750
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
751 752
{
  GstMessage *message;
753
  GstStructure *structure;
754

755
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_START),
756 757 758
      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);
759 760 761 762 763 764 765

  return message;
}

/**
 * gst_message_new_segment_done:
 * @src: The object originating the message.
766 767
 * @format: The format of the position being done
 * @position: The position of the segment being done
768 769 770 771 772 773 774 775 776 777 778
 *
 * 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 *
779 780
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
781 782
{
  GstMessage *message;
783
  GstStructure *structure;
784

785
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_DONE),
786 787 788
      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);
789 790 791 792

  return message;
}

793 794 795 796 797 798 799 800 801
/**
 * 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
802 803
 * Returns: The new application message.
 *
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
 * 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
823 824
 * Returns: The new element message.
 *
825 826 827 828 829 830 831 832
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

833 834 835 836 837 838 839 840 841
/**
 * 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
842 843 844 845
 * 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.
846 847 848 849 850 851 852 853 854
 *
 * Returns: The new duration message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
{
  GstMessage *message;
855
  GstStructure *structure;
856

857
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_DURATION),
858 859 860
      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);
861 862 863 864

  return message;
}

865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
/**
 * 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;
884
  GstStructure *structure;
885

886
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ASYNC_START),
887 888
      GST_QUARK (NEW_BASE_TIME), G_TYPE_BOOLEAN, new_base_time, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, structure);
889 890 891 892 893 894 895 896

  return message;
}

/**
 * gst_message_new_async_done:
 * @src: The object originating the message.
 *
Stefan Kost's avatar
Stefan Kost committed
897 898
 * The message is posted when elements completed an ASYNC state change.
 *
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
 * 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;
}

915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
/**
 * 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;
}

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
/**
 * 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;

959
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_REQUEST_STATE),
960 961 962 963 964 965
      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
966 967 968 969 970 971
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
972
 * Returns: The structure of the message. The structure is still
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
973
 * owned by the message, which means that you should not free it and
974
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
975 976 977 978 979 980 981
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
982

Wim Taymans's avatar
Wim Taymans committed
983 984 985 986 987 988
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
Stefan Kost's avatar
Stefan Kost committed
989
 * @tag_list: Return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
990 991 992 993 994 995 996 997 998
 *
 * 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)
{
999 1000 1001
  GstStructure *ret;

  g_return_if_fail (GST_IS_MESSAGE (message));
1002
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  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
1021 1022
 *
 * Since: 0.10.24
1023 1024 1025 1026 1027 1028 1029
 */
void
gst_message_parse_tag_full (GstMessage * message, GstPad ** pad,
    GstTagList ** tag_list)
{
  GstStructure *ret;

Wim Taymans's avatar
Wim Taymans committed
1030
  g_return_if_fail (GST_IS_MESSAGE (message));
1031
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1032
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
1033

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
  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
1050
}
1051 1052 1053 1054 1055 1056

/**
 * 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
1057 1058
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
1059 1060
 *
 * MT safe.
1061 1062
 *
 * Since: 0.10.11
1063 1064 1065 1066 1067
 */
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
1068
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1069 1070

  if (percent)
1071 1072
    *percent = g_value_get_int (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUFFER_PERCENT)));
1073
}
Wim Taymans's avatar
Wim Taymans committed
1074

1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
/**
 * 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)
{
1091
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
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

  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)
{
1117
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

  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
1134
/**
1135
 * gst_message_parse_state_changed:
1136
 * @message: a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED
1137 1138 1139
 * @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
1140 1141 1142 1143 1144 1145
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
1146
gst_message_parse_state_changed (GstMessage * message,
1147
    GstState * oldstate, GstState * newstate, GstState * pending)
Wim Taymans's avatar
Wim Taymans committed
1148 1149
{
  g_return_if_fail (GST_IS_MESSAGE (message));
1150
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);
Wim Taymans's avatar
Wim Taymans committed
1151

1152
  if (oldstate)
1153 1154 1155
    *oldstate =
        g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (OLD_STATE)));
1156
  if (newstate)
1157 1158 1159
    *newstate =
        g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (NEW_STATE)));
1160
  if (pending)
1161 1162
    *pending = g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (PENDING_STATE)));
Wim Taymans's avatar
Wim Taymans committed
1163 1164
}

Wim Taymans's avatar
Wim Taymans committed
1165 1166 1167
/**
 * gst_message_parse_clock_provide:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.
1168 1169
 * @clock: A pointer to  hold a clock object.
 * @ready: A pointer to hold the ready flag.
Wim Taymans's avatar
Wim Taymans committed
1170
 *
1171 1172
 * 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
1173 1174 1175 1176
 *
 * MT safe.
 */
void
1177 1178
gst_message_parse_clock_provide (GstMessage * message, GstClock ** clock,
    gboolean * ready)
Wim Taymans's avatar
Wim Taymans committed
1179
{
1180 1181
  const GValue *clock_gvalue;

Wim Taymans's avatar
Wim Taymans committed
1182
  g_return_if_fail (GST_IS_MESSAGE (message));
1183
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_PROVIDE);
Wim Taymans's avatar
Wim Taymans committed
1184

1185 1186
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
1187 1188 1189
  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
1190
  if (ready)
1191 1192 1193
    *ready =
        g_value_get_boolean (gst_structure_id_get_value (message->structure,
            GST_QUARK (READY)));
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
  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));
1214
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_LOST);
1215

1216 1217
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
1218 1219 1220 1221 1222
  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
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
}

/**
 * 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));
1241
  g_return_if_fail (MESSAGE_TYPE (message) == GST_MESSAGE_NEW_CLOCK);
Wim Taymans's avatar
Wim Taymans committed
1242

1243 1244
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
Wim Taymans's avatar
Wim Taymans committed
1245 1246 1247 1248 1249 1250 1251
  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);
}

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262