gstmessage.c 22.8 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.
 */
21 22 23 24 25 26 27 28 29 30 31 32 33
/**
 * SECTION:gstmessage
 * @short_description: Lightweight objects to signal the application of pipeline events
 * @see_also: #GstBus,#GstMiniObject
 *
 * Messages are implemented as a subclass of #GstMiniObject with a generic 
 * #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.
 *
 * Messages are posted by objects in the pipeline and are passed to the 
 * application using the #GstBus. 
 */
Wim Taymans's avatar
Wim Taymans committed
34 35 36 37

#include <string.h>             /* memcpy */

#include "gst_private.h"
38
#include "gsterror.h"
39
#include "gstenumtypes.h"
Wim Taymans's avatar
Wim Taymans committed
40 41
#include "gstinfo.h"
#include "gstmessage.h"
42
#include "gsttaglist.h"
43
#include "gstutils.h"
Wim Taymans's avatar
Wim Taymans committed
44 45


46 47 48 49
static void gst_message_init (GTypeInstance * instance, gpointer g_class);
static void gst_message_class_init (gpointer g_class, gpointer class_data);
static void gst_message_finalize (GstMessage * message);
static GstMessage *_gst_message_copy (GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
50 51 52 53

void
_gst_message_initialize (void)
{
54 55
  gpointer ptr;

Wim Taymans's avatar
Wim Taymans committed
56 57
  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

58
  gst_message_get_type ();
Wim Taymans's avatar
Wim Taymans committed
59

60 61 62 63 64
  /* 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 */
  ptr = g_type_class_ref (GST_TYPE_MESSAGE);
  g_type_class_unref (ptr);
Wim Taymans's avatar
Wim Taymans committed
65 66
}

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
typedef struct
{
  gint type;
  gchar *name;
  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},
  {GST_MESSAGE_STEP_DONE, "step-done", 0},
Wim Taymans's avatar
Wim Taymans committed
84 85
  {GST_MESSAGE_CLOCK_PROVIDE, "clock-provide", 0},
  {GST_MESSAGE_CLOCK_LOST, "clock-lost", 0},
86 87 88 89
  {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
90
  {GST_MESSAGE_ELEMENT, "element", 0},
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  {GST_MESSAGE_SEGMENT_START, "segment-start", 0},
  {GST_MESSAGE_SEGMENT_DONE, "segment-done", 0},
  {0, NULL, 0}
};

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";
}

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;
}

120 121
GType
gst_message_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
122
{
123 124 125
  static GType _gst_message_type;

  if (G_UNLIKELY (_gst_message_type == 0)) {
126
    gint i;
127 128 129 130 131 132 133 134 135 136 137 138
    static const GTypeInfo message_info = {
      sizeof (GstMessageClass),
      NULL,
      NULL,
      gst_message_class_init,
      NULL,
      NULL,
      sizeof (GstMessage),
      0,
      gst_message_init,
      NULL
    };
Wim Taymans's avatar
Wim Taymans committed
139

140 141
    _gst_message_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
        "GstMessage", &message_info, 0);
142 143 144 145 146

    for (i = 0; message_quarks[i].name; i++) {
      message_quarks[i].quark =
          g_quark_from_static_string (message_quarks[i].name);
    }
147 148 149
  }
  return _gst_message_type;
}
Wim Taymans's avatar
Wim Taymans committed
150

151 152 153 154
static void
gst_message_class_init (gpointer g_class, gpointer class_data)
{
  GstMessageClass *message_class = GST_MESSAGE_CLASS (g_class);
Wim Taymans's avatar
Wim Taymans committed
155

156 157 158 159 160
  message_class->mini_object_class.copy =
      (GstMiniObjectCopyFunction) _gst_message_copy;
  message_class->mini_object_class.finalize =
      (GstMiniObjectFinalizeFunction) gst_message_finalize;
}
Wim Taymans's avatar
Wim Taymans committed
161

162 163 164 165 166
static void
gst_message_init (GTypeInstance * instance, gpointer g_class)
{
  GstMessage *message = GST_MESSAGE (instance);

167
  GST_CAT_INFO (GST_CAT_MESSAGE, "new message %p", message);
Wim Taymans's avatar
Wim Taymans committed
168
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
169 170 171
}

static void
172
gst_message_finalize (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
173
{
174
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
175

176 177
  GST_CAT_INFO (GST_CAT_MESSAGE, "finalize message %p", message);

Wim Taymans's avatar
Wim Taymans committed
178
  if (GST_MESSAGE_SRC (message)) {
179
    gst_object_unref (GST_MESSAGE_SRC (message));
Wim Taymans's avatar
Wim Taymans committed
180
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
181 182 183 184 185 186 187 188
  }

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

189 190
  if (message->structure) {
    gst_structure_set_parent_refcount (message->structure, NULL);
Wim Taymans's avatar
Wim Taymans committed
191
    gst_structure_free (message->structure);
192
  }
Wim Taymans's avatar
Wim Taymans committed
193 194
}

195 196
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
197
{
198 199 200 201 202 203
  GstMessage *copy;

  GST_CAT_INFO (GST_CAT_MESSAGE, "copy message %p", message);

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
207 208 209 210
  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);
211 212

  if (GST_MESSAGE_SRC (message)) {
213
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
214 215 216 217 218 219 220 221 222
  }

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

  return copy;
Wim Taymans's avatar
Wim Taymans committed
223 224
}

Wim Taymans's avatar
Wim Taymans committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
/**
 * 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
243 244 245
{
  GstMessage *message;

246
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
247

248 249
  GST_CAT_INFO (GST_CAT_MESSAGE, "creating new message %p %s", message,
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
250

251
  message->type = type;
Wim Taymans's avatar
Wim Taymans committed
252
  if (src) {
253
    message->src = gst_object_ref (src);
254
    GST_CAT_DEBUG_OBJECT (GST_CAT_MESSAGE, src, "message source");
255
  } else {
256
    message->src = NULL;
257
    GST_CAT_DEBUG (GST_CAT_MESSAGE, "NULL message source");
Wim Taymans's avatar
Wim Taymans committed
258
  }
Wim Taymans's avatar
Wim Taymans committed
259 260 261 262 263
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
264 265 266 267 268 269

  return message;
}

/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
270
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
271
 *
272 273 274
 * 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
275 276 277 278 279 280 281 282 283 284
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
285
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
286 287 288 289 290 291 292 293 294 295

  return message;
}

/**
 * gst_message_new_error:
 * @src: The object originating the message.
 * @error: The GError for this message.
 * @debug: A debugging string for something or other.
 *
296
 * Create a new error message. The message will copy @error and
297 298
 * @debug. This message is posted by element when a fatal event
 * occured. The pipeline will probably (partially) stop. 
Wim Taymans's avatar
Wim Taymans committed
299 300 301 302 303 304 305 306 307 308
 *
 * Returns: The new error message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_error (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
309 310 311
  message = gst_message_new_custom (GST_MESSAGE_ERROR, src,
      gst_structure_new ("GstMessageError", "gerror", GST_TYPE_G_ERROR, error,
          "debug", G_TYPE_STRING, debug, NULL));
Wim Taymans's avatar
Wim Taymans committed
312 313 314 315 316 317 318 319 320 321

  return message;
}

/**
 * gst_message_new_warning:
 * @src: The object originating the message.
 * @error: The GError for this message.
 * @debug: A debugging string for something or other.
 *
322
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
323 324 325 326 327 328 329 330 331 332 333
 * @debug.
 *
 * Returns: The new warning message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_warning (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
334 335 336
  message = gst_message_new_custom (GST_MESSAGE_WARNING, src,
      gst_structure_new ("GstMessageWarning", "gerror", GST_TYPE_G_ERROR, error,
          "debug", G_TYPE_STRING, debug, NULL));
Wim Taymans's avatar
Wim Taymans committed
337 338 339 340 341 342 343 344 345 346

  return message;
}

/**
 * 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.
347
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
348 349 350 351 352 353 354 355 356 357
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

358 359
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
360 361
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
362 363 364 365 366 367 368 369 370

  return message;
}

/**
 * gst_message_new_state_change:
 * @src: The object originating the message.
 * @old: The previous state.
 * @new: The new (current) state.
371
 * @pending: The pending (target) state.
Wim Taymans's avatar
Wim Taymans committed
372
 *
373 374
 * Create a state change message. This message is posted whenever an element changed
 * its state.
Wim Taymans's avatar
Wim Taymans committed
375 376 377 378 379 380
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
381 382
gst_message_new_state_changed (GstObject * src,
    GstState old, GstState new, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
383 384 385
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
386 387 388 389 390 391 392 393 394 395 396 397
  message = gst_message_new_custom (GST_MESSAGE_STATE_CHANGED, src,
      gst_structure_new ("GstMessageState",
          "old-state", GST_TYPE_STATE, (gint) old,
          "new-state", GST_TYPE_STATE, (gint) new,
          "pending-state", GST_TYPE_STATE, (gint) pending, NULL));

  return message;
}

/**
 * gst_message_new_clock_provide:
 * @src: The object originating the message.
398
 * @clock: The clock it provides
Wim Taymans's avatar
Wim Taymans committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412
 * @ready: TRUE if the sender can provide a clock
 *
 * Create a clock provide message. This message is posted whenever an 
 * element is ready to provide a clock or lost its ability to provide
 * a clock (maybe because it paused or became EOS).
 *
 * This message is mainly used internally to manage the clock 
 * selection.
 *
 * Returns: The new provide clock message.
 *
 * MT safe.
 */
GstMessage *
413 414
gst_message_new_clock_provide (GstObject * src, GstClock * clock,
    gboolean ready)
Wim Taymans's avatar
Wim Taymans committed
415 416 417 418 419
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_CLOCK_PROVIDE, src,
      gst_structure_new ("GstMessageClockProvide",
420
          "clock", GST_TYPE_CLOCK, clock,
Wim Taymans's avatar
Wim Taymans committed
421
          "ready", G_TYPE_BOOLEAN, ready, NULL));
422

Wim Taymans's avatar
Wim Taymans committed
423 424 425
  return message;
}

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
/**
 * 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;

  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src,
      gst_structure_new ("GstMessageClockLost",
          "clock", GST_TYPE_CLOCK, clock, NULL));

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
/**
 * 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;

  message = gst_message_new_custom (GST_MESSAGE_NEW_CLOCK, src,
      gst_structure_new ("GstMessageNewClock",
          "clock", GST_TYPE_CLOCK, clock, NULL));
Wim Taymans's avatar
Wim Taymans committed
474 475 476 477 478

  return message;
}

/**
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
 * gst_message_new_segment_start:
 * @src: The object originating the message.
 * @timestamp: The timestamp of the segment being played
 *
 * 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 *
gst_message_new_segment_start (GstObject * src, GstClockTime timestamp)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
497 498 499
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_START, src,
      gst_structure_new ("GstMessageSegmentStart", "timestamp", G_TYPE_INT64,
          (gint64) timestamp, NULL));
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522

  return message;
}

/**
 * gst_message_new_segment_done:
 * @src: The object originating the message.
 * @timestamp: The timestamp of the segment being played
 *
 * 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 *
gst_message_new_segment_done (GstObject * src, GstClockTime timestamp)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
523 524 525
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_DONE, src,
      gst_structure_new ("GstMessageSegmentDone", "timestamp", G_TYPE_INT64,
          (gint64) timestamp, NULL));
526 527 528 529

  return message;
}

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * 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.
 *
 * 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.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

Wim Taymans's avatar
Wim Taymans committed
566 567 568 569 570 571
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
572 573 574
 * Returns: The structure of the message. The structure is still
 * owned by the message, which means that you should not free it and 
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
575 576 577 578 579 580 581
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
582

Wim Taymans's avatar
Wim Taymans committed
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
 *
 * 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)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);

  *tag_list = (GstTagList *) gst_structure_copy (message->structure);
}

/**
605
 * gst_message_parse_state_changed:
Wim Taymans's avatar
Wim Taymans committed
606
 * @message: A valid #GstMessage of type GST_MESSAGE_STATE_CHANGED.
607 608 609
 * @old: The previous state.
 * @new: The new (current) state.
 * @pending: The pending (target) state.
Wim Taymans's avatar
Wim Taymans committed
610 611 612 613 614 615
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
616
gst_message_parse_state_changed (GstMessage * message, GstState * old,
617
    GstState * new, GstState * pending)
Wim Taymans's avatar
Wim Taymans committed
618 619 620 621
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);

622 623 624 625 626 627 628 629 630
  if (old)
    gst_structure_get_enum (message->structure, "old-state",
        GST_TYPE_STATE, (gint *) old);
  if (new)
    gst_structure_get_enum (message->structure, "new-state",
        GST_TYPE_STATE, (gint *) new);
  if (pending)
    gst_structure_get_enum (message->structure, "pending-state",
        GST_TYPE_STATE, (gint *) pending);
Wim Taymans's avatar
Wim Taymans committed
631 632
}

Wim Taymans's avatar
Wim Taymans committed
633 634 635
/**
 * gst_message_parse_clock_provide:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.
636 637
 * @clock: A pointer to  hold a clock object.
 * @ready: A pointer to hold the ready flag.
Wim Taymans's avatar
Wim Taymans committed
638
 *
639 640
 * 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
641 642 643 644
 *
 * MT safe.
 */
void
645 646
gst_message_parse_clock_provide (GstMessage * message, GstClock ** clock,
    gboolean * ready)
Wim Taymans's avatar
Wim Taymans committed
647
{
648 649
  const GValue *clock_gvalue;

Wim Taymans's avatar
Wim Taymans committed
650 651 652
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_PROVIDE);

653 654 655 656
  clock_gvalue = gst_structure_get_value (message->structure, "clock");
  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
657 658
  if (ready)
    gst_structure_get_boolean (message->structure, "ready", ready);
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  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));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_NEW_CLOCK);

  clock_gvalue = gst_structure_get_value (message->structure, "clock");
  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
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
}

/**
 * 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);

  clock_gvalue = gst_structure_get_value (message->structure, "clock");
  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
715 716 717 718
/**
 * gst_message_parse_error:
 * @message: A valid #GstMessage of type GST_MESSAGE_ERROR.
 *
Wim Taymans's avatar
Wim Taymans committed
719
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
720 721 722 723 724 725 726 727
 * in the output arguments are copies; the caller must free them when done.
 *
 * MT safe.
 */
void
gst_message_parse_error (GstMessage * message, GError ** gerror, gchar ** debug)
{
  const GValue *error_gvalue;
728
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
729 730 731 732 733 734

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

  error_gvalue = gst_structure_get_value (message->structure, "gerror");
  g_return_if_fail (error_gvalue != NULL);
735
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
736

737
  error_val = (GError *) g_value_get_boxed (error_gvalue);
738 739 740 741
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;
Wim Taymans's avatar
Wim Taymans committed
742 743 744 745 746 747 748
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}

/**
 * gst_message_parse_warning:
 * @message: A valid #GstMessage of type GST_MESSAGE_WARNING.
 *
Wim Taymans's avatar
Wim Taymans committed
749
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
750 751 752 753 754 755 756 757 758
 * in the output arguments are copies; the caller must free them when done.
 *
 * MT safe.
 */
void
gst_message_parse_warning (GstMessage * message, GError ** gerror,
    gchar ** debug)
{
  const GValue *error_gvalue;
759
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
760 761 762 763 764 765

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

  error_gvalue = gst_structure_get_value (message->structure, "gerror");
  g_return_if_fail (error_gvalue != NULL);
766
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
767

768
  error_val = (GError *) g_value_get_boxed (error_gvalue);
769 770 771 772 773
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

Wim Taymans's avatar
Wim Taymans committed
774 775
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

/**
 * gst_message_parse_segment_start:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.
 *
 * Extracts the timestamp from the segment start message.
 *
 * MT safe.
 */
void
gst_message_parse_segment_start (GstMessage * message, GstClockTime * timestamp)
{
  const GValue *time_gvalue;

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

  time_gvalue = gst_structure_get_value (message->structure, "timstamp");
  g_return_if_fail (time_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (time_gvalue) == G_TYPE_INT64);

  if (timestamp)
    *timestamp = (GstClockTime) g_value_get_int64 (time_gvalue);
}

/**
 * gst_message_parse_segment_done:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE.
 *
 * Extracts the timestamp from the segment done message.
 *
 * MT safe.
 */
void
gst_message_parse_segment_done (GstMessage * message, GstClockTime * timestamp)
{
  const GValue *time_gvalue;

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

  time_gvalue = gst_structure_get_value (message->structure, "timstamp");
  g_return_if_fail (time_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (time_gvalue) == G_TYPE_INT64);

  if (timestamp)
    *timestamp = (GstClockTime) g_value_get_int64 (time_gvalue);
}