gstmessage.c 25.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.
 */
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 27
 * @see_also: #GstBus,#GstMiniObject
 *
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
 */
Wim Taymans's avatar
Wim Taymans committed
36 37 38 39

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

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


48 49 50 51
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
52 53 54 55

void
_gst_message_initialize (void)
{
56 57
  gpointer ptr;

Wim Taymans's avatar
Wim Taymans committed
58 59
  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

60
  gst_message_get_type ();
Wim Taymans's avatar
Wim Taymans committed
61

62 63 64 65 66
  /* 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
67 68
}

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
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
86 87
  {GST_MESSAGE_CLOCK_PROVIDE, "clock-provide", 0},
  {GST_MESSAGE_CLOCK_LOST, "clock-lost", 0},
88 89 90 91
  {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
92
  {GST_MESSAGE_ELEMENT, "element", 0},
93 94
  {GST_MESSAGE_SEGMENT_START, "segment-start", 0},
  {GST_MESSAGE_SEGMENT_DONE, "segment-done", 0},
95
  {GST_MESSAGE_DURATION, "duration", 0},
96 97 98
  {0, NULL, 0}
};

Stefan Kost's avatar
Stefan Kost committed
99 100 101 102 103 104
/**
 * 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
105
 * Returns: a reference to the static name of the message.
Stefan Kost's avatar
Stefan Kost committed
106
 */
107 108 109 110 111 112 113 114 115 116 117 118
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
119 120 121 122 123 124 125 126
/**
 * 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
 */
127 128 129 130 131 132 133 134 135 136 137 138
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;
}

139 140
GType
gst_message_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
141
{
142 143 144
  static GType _gst_message_type;

  if (G_UNLIKELY (_gst_message_type == 0)) {
145
    gint i;
146 147 148 149 150 151 152 153 154 155 156 157
    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
158

159 160
    _gst_message_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
        "GstMessage", &message_info, 0);
161 162 163 164 165

    for (i = 0; message_quarks[i].name; i++) {
      message_quarks[i].quark =
          g_quark_from_static_string (message_quarks[i].name);
    }
166 167 168
  }
  return _gst_message_type;
}
Wim Taymans's avatar
Wim Taymans committed
169

170 171 172 173
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
174

175 176 177 178 179
  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
180

181 182 183 184 185
static void
gst_message_init (GTypeInstance * instance, gpointer g_class)
{
  GstMessage *message = GST_MESSAGE (instance);

186
  GST_CAT_LOG (GST_CAT_MESSAGE, "new message %p", message);
Wim Taymans's avatar
Wim Taymans committed
187
  GST_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

Wim Taymans's avatar
Wim Taymans committed
197
  if (GST_MESSAGE_SRC (message)) {
198
    gst_object_unref (GST_MESSAGE_SRC (message));
Wim Taymans's avatar
Wim Taymans committed
199
    GST_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
  }
Wim Taymans's avatar
Wim Taymans committed
212 213
}

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

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

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
226 227 228 229
  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);
230 231

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

  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
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
  GST_CAT_LOG (GST_CAT_MESSAGE, "creating new message %p %s", message,
268
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
269

270
  message->type = type;
Wim Taymans's avatar
Wim Taymans committed
271
  if (src) {
272
    message->src = gst_object_ref (src);
273
    GST_CAT_DEBUG_OBJECT (GST_CAT_MESSAGE, src, "message source");
274
  } else {
275
    message->src = NULL;
276
    GST_CAT_DEBUG (GST_CAT_MESSAGE, "NULL message source");
Wim Taymans's avatar
Wim Taymans committed
277
  }
Wim Taymans's avatar
Wim Taymans committed
278 279 280 281 282
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
283 284 285 286 287 288

  return message;
}

/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
289
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
290
 *
291 292 293
 * 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
294 295 296 297 298 299 300 301 302 303
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
304
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
305 306 307 308 309 310 311 312 313 314

  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.
 *
315
 * Create a new error message. The message will copy @error and
316
 * @debug. This message is posted by element when a fatal event
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
317
 * occured. The pipeline will probably (partially) stop.
Wim Taymans's avatar
Wim Taymans committed
318 319 320 321 322 323 324 325 326 327
 *
 * 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
328 329 330
  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
331 332 333 334 335 336 337 338 339 340

  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.
 *
341
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
342 343 344 345 346 347 348 349 350 351 352
 * @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
353 354 355
  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
356 357 358 359 360 361 362 363 364 365

  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.
366
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
367 368 369 370 371 372 373 374 375 376
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

377 378
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
379 380
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
381 382 383 384 385

  return message;
}

/**
Stefan Kost's avatar
Stefan Kost committed
386
 * gst_message_new_state_changed:
387
 * @src: the object originating the message
388
 * @async: if this is a state change from a streaming thread
389 390 391
 * @oldstate: the previous state
 * @newstate: the new (current) state
 * @pending: the pending (target) state
Wim Taymans's avatar
Wim Taymans committed
392
 *
393 394
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
395 396 397 398 399 400
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
401
gst_message_new_state_changed (GstObject * src, gboolean async,
402
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
403 404 405
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
406 407
  message = gst_message_new_custom (GST_MESSAGE_STATE_CHANGED, src,
      gst_structure_new ("GstMessageState",
408
          "async", G_TYPE_BOOLEAN, async,
409 410
          "old-state", GST_TYPE_STATE, (gint) oldstate,
          "new-state", GST_TYPE_STATE, (gint) newstate,
Wim Taymans's avatar
Wim Taymans committed
411 412 413 414 415 416 417 418
          "pending-state", GST_TYPE_STATE, (gint) pending, NULL));

  return message;
}

/**
 * gst_message_new_clock_provide:
 * @src: The object originating the message.
419
 * @clock: The clock it provides
Wim Taymans's avatar
Wim Taymans committed
420 421
 * @ready: TRUE if the sender can provide a clock
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
422
 * Create a clock provide message. This message is posted whenever an
Wim Taymans's avatar
Wim Taymans committed
423 424 425
 * 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
426
 * This message is mainly used internally to manage the clock
Wim Taymans's avatar
Wim Taymans committed
427 428 429 430 431 432 433
 * selection.
 *
 * Returns: The new provide clock message.
 *
 * MT safe.
 */
GstMessage *
434 435
gst_message_new_clock_provide (GstObject * src, GstClock * clock,
    gboolean ready)
Wim Taymans's avatar
Wim Taymans committed
436 437 438 439 440
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_CLOCK_PROVIDE, src,
      gst_structure_new ("GstMessageClockProvide",
441
          "clock", GST_TYPE_CLOCK, clock,
Wim Taymans's avatar
Wim Taymans committed
442
          "ready", G_TYPE_BOOLEAN, ready, NULL));
443

Wim Taymans's avatar
Wim Taymans committed
444 445 446
  return message;
}

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
/**
 * 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
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/**
 * 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
495 496 497 498 499

  return message;
}

/**
500 501
 * gst_message_new_segment_start:
 * @src: The object originating the message.
502 503
 * @format: The format of the position being played
 * @position: The position of the segment being played
504 505 506 507 508 509 510 511 512 513 514
 *
 * 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 *
515 516
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
517 518 519
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
520
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_START, src,
521 522 523
      gst_structure_new ("GstMessageSegmentStart",
          "format", GST_TYPE_FORMAT, format,
          "position", G_TYPE_INT64, position, NULL));
524 525 526 527 528 529 530

  return message;
}

/**
 * gst_message_new_segment_done:
 * @src: The object originating the message.
531 532
 * @format: The format of the position being done
 * @position: The position of the segment being done
533 534 535 536 537 538 539 540 541 542 543
 *
 * 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 *
544 545
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
546 547 548
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
549
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_DONE, src,
550 551 552
      gst_structure_new ("GstMessageSegmentDone",
          "format", GST_TYPE_FORMAT, format,
          "position", G_TYPE_INT64, position, NULL));
553 554 555 556

  return message;
}

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.
 *
Stefan Kost's avatar
Stefan Kost committed
566 567
 * Returns: The new application message.
 *
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
 * 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
587 588
 * Returns: The new element message.
 *
589 590 591 592 593 594 595 596
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/**
 * 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
 * pipeline.
 *
 * Returns: The new duration message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_DURATION, src,
      gst_structure_new ("GstMessageDuration",
          "format", GST_TYPE_FORMAT, format,
          "duration", G_TYPE_INT64, duration, NULL));

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
625 626 627 628 629 630
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
631
 * Returns: The structure of the message. The structure is still
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
632
 * owned by the message, which means that you should not free it and
633
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
634 635 636 637 638 639 640
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
641

Wim Taymans's avatar
Wim Taymans committed
642 643 644 645 646 647
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
Stefan Kost's avatar
Stefan Kost committed
648
 * @tag_list: Return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
 *
 * 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);
}

/**
665
 * gst_message_parse_state_changed:
666
 * @message: a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED
667
 * @async: is this an async state change
668 669 670
 * @oldstate: the previous state
 * @newstate: the new (current) state
 * @pending: the pending (target) state
Wim Taymans's avatar
Wim Taymans committed
671 672 673 674 675 676
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
677 678
gst_message_parse_state_changed (GstMessage * message, gboolean * async,
    GstState * oldstate, GstState * newstate, GstState * pending)
Wim Taymans's avatar
Wim Taymans committed
679 680 681 682
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);

683 684
  if (async)
    gst_structure_get_boolean (message->structure, "async", async);
685
  if (oldstate)
686
    gst_structure_get_enum (message->structure, "old-state",
687 688
        GST_TYPE_STATE, (gint *) oldstate);
  if (newstate)
689
    gst_structure_get_enum (message->structure, "new-state",
690
        GST_TYPE_STATE, (gint *) newstate);
691 692 693
  if (pending)
    gst_structure_get_enum (message->structure, "pending-state",
        GST_TYPE_STATE, (gint *) pending);
Wim Taymans's avatar
Wim Taymans committed
694 695
}

Wim Taymans's avatar
Wim Taymans committed
696 697 698
/**
 * gst_message_parse_clock_provide:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.
699 700
 * @clock: A pointer to  hold a clock object.
 * @ready: A pointer to hold the ready flag.
Wim Taymans's avatar
Wim Taymans committed
701
 *
702 703
 * 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
704 705 706 707
 *
 * MT safe.
 */
void
708 709
gst_message_parse_clock_provide (GstMessage * message, GstClock ** clock,
    gboolean * ready)
Wim Taymans's avatar
Wim Taymans committed
710
{
711 712
  const GValue *clock_gvalue;

Wim Taymans's avatar
Wim Taymans committed
713 714 715
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_PROVIDE);

716 717 718 719
  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
720 721
  if (ready)
    gst_structure_get_boolean (message->structure, "ready", ready);
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
  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
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
}

/**
 * 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
778 779 780
/**
 * gst_message_parse_error:
 * @message: A valid #GstMessage of type GST_MESSAGE_ERROR.
Stefan Kost's avatar
Stefan Kost committed
781 782
 * @gerror: Location for the GError
 * @debug: Location for the debug message
Wim Taymans's avatar
Wim Taymans committed
783
 *
Wim Taymans's avatar
Wim Taymans committed
784
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
785 786 787 788 789 790 791 792
 * 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;
793
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
794 795 796 797 798 799

  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);
800
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
801

802
  error_val = (GError *) g_value_get_boxed (error_gvalue);
803 804 805 806
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;
Wim Taymans's avatar
Wim Taymans committed
807 808 809 810 811 812
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}

/**
 * gst_message_parse_warning:
 * @message: A valid #GstMessage of type GST_MESSAGE_WARNING.
Stefan Kost's avatar
Stefan Kost committed
813 814
 * @gerror: Location for the GError
 * @debug: Location for the debug message
Wim Taymans's avatar
Wim Taymans committed
815
 *
Wim Taymans's avatar
Wim Taymans committed
816
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
817 818 819 820 821 822 823 824 825
 * 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;
826
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
827 828 829 830 831 832

  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);
833
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
834

835
  error_val = (GError *) g_value_get_boxed (error_gvalue);
836 837 838 839 840
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

Wim Taymans's avatar
Wim Taymans committed
841 842
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}
843 844 845 846

/**
 * gst_message_parse_segment_start:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.
847 848
 * @format: Result location for the format
 * @position: Result location for the position
849
 *
850
 * Extracts the position and format from the segment start message.
851 852 853 854
 *
 * MT safe.
 */
void
855 856
gst_message_parse_segment_start (GstMessage * message, GstFormat * format,
    gint64 * position)
857
{
858
  const GstStructure *structure;
859 860 861 862

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

863 864 865 866 867 868
  structure = gst_message_get_structure (message);
  if (format)
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
  if (position)
    *position =
        g_value_get_int64 (gst_structure_get_value (structure, "position"));
869 870 871 872 873
}

/**
 * gst_message_parse_segment_done:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE.
874 875
 * @format: Result location for the format
 * @position: Result location for the position
876
 *
877
 * Extracts the position and format from the segment start message.
878 879 880 881
 *
 * MT safe.
 */
void
882 883
gst_message_parse_segment_done (GstMessage * message, GstFormat * format,
    gint64 * position)
884
{
885
  const GstStructure *structure;
886 887 888 889

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

890 891 892 893 894 895 896
  structure = gst_message_get_structure (message);
  if (format)
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
  if (position)
    *position =
        g_value_get_int64 (gst_structure_get_value (structure, "position"));
}
897

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
/**
 * gst_message_parse_duration:
 * @message: A valid #GstMessage of type GST_MESSAGE_DURATION.
 * @format: Result location for the format
 * @duration: Result location for the duration
 *
 * Extracts the duration and format from the duration message.
 *
 * MT safe.
 */
void
gst_message_parse_duration (GstMessage * message, GstFormat * format,
    gint64 * duration)
{
  const GstStructure *structure;

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

  structure = gst_message_get_structure (message);
  if (format)
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
  if (duration)
    *duration =
        g_value_get_int64 (gst_structure_get_value (structure, "duration"));
923
}