gstmessage.c 40.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 64
#define GST_MESSAGE_SEQNUM(e) ((GstMessage*)e)->abidata.ABI.seqnum

65 66 67 68
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
69

70 71
static GstMiniObjectClass *parent_class = NULL;

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

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

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

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

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

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

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

157 158
GType
gst_message_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
159
{
160 161 162
  static GType _gst_message_type;

  if (G_UNLIKELY (_gst_message_type == 0)) {
163
    gint i;
164 165 166 167 168 169 170 171 172 173 174 175
    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
176

177 178
    _gst_message_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
        "GstMessage", &message_info, 0);
179 180 181 182 183

    for (i = 0; message_quarks[i].name; i++) {
      message_quarks[i].quark =
          g_quark_from_static_string (message_quarks[i].name);
    }
184 185 186
  }
  return _gst_message_type;
}
Wim Taymans's avatar
Wim Taymans committed
187

188 189 190 191
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
192

193 194
  parent_class = g_type_class_peek_parent (g_class);

195 196 197 198 199
  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
200

201 202 203 204 205
static void
gst_message_init (GTypeInstance * instance, gpointer g_class)
{
  GstMessage *message = GST_MESSAGE (instance);

206
  GST_CAT_LOG (GST_CAT_MESSAGE, "new message %p", message);
Wim Taymans's avatar
Wim Taymans committed
207
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
208 209 210
}

static void
211
gst_message_finalize (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
212
{
213
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
214

215
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p", message);
216

Wim Taymans's avatar
Wim Taymans committed
217
  if (GST_MESSAGE_SRC (message)) {
218
    gst_object_unref (GST_MESSAGE_SRC (message));
Wim Taymans's avatar
Wim Taymans committed
219
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
220 221 222 223 224 225 226 227
  }

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

228 229
  if (message->structure) {
    gst_structure_set_parent_refcount (message->structure, NULL);
Wim Taymans's avatar
Wim Taymans committed
230
    gst_structure_free (message->structure);
231
  }
232 233

  GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (message));
Wim Taymans's avatar
Wim Taymans committed
234 235
}

236 237
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
238
{
239 240
  GstMessage *copy;

241
  GST_CAT_LOG (GST_CAT_MESSAGE, "copy message %p", message);
242 243 244

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
248 249 250 251
  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);
252
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
253 254

  if (GST_MESSAGE_SRC (message)) {
255
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
256 257 258 259 260
  }

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

  return copy;
Wim Taymans's avatar
Wim Taymans committed
265 266
}

Wim Taymans's avatar
Wim Taymans committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
/**
 * 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
285 286 287
{
  GstMessage *message;

288
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
289

290 291
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
292
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
293

294
  message->type = type;
295 296 297 298 299

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

Wim Taymans's avatar
Wim Taymans committed
300 301 302 303 304
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
305

306 307
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();

Wim Taymans's avatar
Wim Taymans committed
308 309 310
  return message;
}

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/**
 * 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.
 *
 * Since: 0.10.22
 *
 * MT safe.
 */
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.
 *
 * Since: 0.10.22
 *
 * MT safe.
 */
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
365 366
/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
367
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
368
 *
369 370 371
 * 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
372 373 374 375 376 377 378 379 380 381
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
382
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
383 384 385 386 387 388 389 390

  return message;
}

/**
 * gst_message_new_error:
 * @src: The object originating the message.
 * @error: The GError for this message.
391
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
392
 *
393
 * Create a new error message. The message will copy @error and
394
 * @debug. This message is posted by element when a fatal event
395 396
 * occured. The pipeline will probably (partially) stop. The application
 * receiving this message should stop the pipeline.
Wim Taymans's avatar
Wim Taymans committed
397 398 399 400 401 402
 *
 * Returns: The new error message.
 *
 * MT safe.
 */
GstMessage *
403
gst_message_new_error (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
404 405
{
  GstMessage *message;
406
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
407

408 409 410 411 412
  structure = gst_structure_empty_new ("GstMessageError");
  gst_structure_id_set (structure,
      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
413 414 415 416 417 418 419 420

  return message;
}

/**
 * gst_message_new_warning:
 * @src: The object originating the message.
 * @error: The GError for this message.
421
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
422
 *
423
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
424 425 426 427 428 429 430
 * @debug.
 *
 * Returns: The new warning message.
 *
 * MT safe.
 */
GstMessage *
431
gst_message_new_warning (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
432 433
{
  GstMessage *message;
434
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
435

436 437 438 439 440
  structure = gst_structure_empty_new ("GstMessageWarning");
  gst_structure_id_set (structure,
      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
441 442 443 444

  return message;
}

445 446 447 448
/**
 * gst_message_new_info:
 * @src: The object originating the message.
 * @error: The GError for this message.
449
 * @debug: A debugging string.
450 451 452 453 454 455 456 457 458 459 460
 *
 * Create a new info message. The message will make copies of @error and
 * @debug.
 *
 * Returns: The new info message.
 *
 * Since: 0.10.12
 *
 * MT safe.
 */
GstMessage *
461
gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
462 463
{
  GstMessage *message;
464
  GstStructure *structure;
465

466 467 468 469
  structure = gst_structure_empty_new ("GstMessageInfo");
  gst_structure_id_set (structure, GST_QUARK (GERROR), GST_TYPE_G_ERROR,
      error, GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
470 471 472 473

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
474 475 476 477 478 479
/**
 * 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.
480
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
481 482 483 484 485 486 487 488 489 490
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

491 492
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
493 494
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
495 496 497 498

  return message;
}

499 500 501 502 503 504 505 506 507
/**
 * 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
508 509 510 511 512 513 514
 * 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. 
 *
515 516 517 518 519 520 521 522 523 524
 * Returns: The new buffering message.
 *
 * Since: 0.10.11
 *
 * MT safe.
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;
525
  GstStructure *structure;
526 527 528

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

529 530 531 532 533 534
  structure = gst_structure_empty_new ("GstMessageBuffering");
  gst_structure_id_set (structure,
      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,
535 536
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
      GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
537
  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
538 539 540 541

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
542
/**
Stefan Kost's avatar
Stefan Kost committed
543
 * gst_message_new_state_changed:
544 545 546 547
 * @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
548
 *
549 550
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
551 552 553 554 555 556
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
557
gst_message_new_state_changed (GstObject * src,
558
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
559 560
{
  GstMessage *message;
561
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
562

563 564 565 566 567 568
  structure = gst_structure_empty_new ("GstMessageState");
  gst_structure_id_set (structure,
      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
569 570 571 572

  return message;
}

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

619 620 621 622 623
  structure = gst_structure_empty_new ("GstMessageClockProvide");
  gst_structure_id_set (structure,
      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);
624

Wim Taymans's avatar
Wim Taymans committed
625 626 627
  return message;
}

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
/**
 * 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;
648
  GstStructure *structure;
649

650 651 652 653
  structure = gst_structure_empty_new ("GstMessageClockLost");
  gst_structure_id_set (structure,
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
654 655 656 657

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
/**
 * 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;
674
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
675

676 677 678 679
  structure = gst_structure_empty_new ("GstMessageNewClock");
  gst_structure_id_set (structure,
      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
680 681 682 683

  return message;
}

684 685 686 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 715 716 717 718 719 720 721 722 723 724 725
/**
 * 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.
 *
 * @src should be the srcpad that unlinked or linked.
 *
 * 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);
  g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SRC, NULL);
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

  structure = gst_structure_empty_new ("GstMessageStructureChange");
  gst_structure_id_set (structure,
      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
726
/**
727 728
 * gst_message_new_segment_start:
 * @src: The object originating the message.
729 730
 * @format: The format of the position being played
 * @position: The position of the segment being played
731 732 733 734 735 736 737 738 739 740 741
 *
 * 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 *
742 743
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
744 745
{
  GstMessage *message;
746
  GstStructure *structure;
747

748 749 750 751 752
  structure = gst_structure_empty_new ("GstMessageSegmentStart");
  gst_structure_id_set (structure,
      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);
753 754 755 756 757 758 759

  return message;
}

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

779 780 781 782 783
  structure = gst_structure_empty_new ("GstMessageSegmentDone");
  gst_structure_id_set (structure,
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_DONE, src, structure);
784 785 786 787

  return message;
}

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

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

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

852 853 854 855 856
  structure = gst_structure_empty_new ("GstMessageDuration");
  gst_structure_id_set (structure,
      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);
857 858 859 860

  return message;
}

861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
/**
 * 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;
880
  GstStructure *structure;
881

882 883 884 885
  structure = gst_structure_empty_new ("GstMessageAsyncStart");
  gst_structure_id_set (structure,
      GST_QUARK (NEW_BASE_TIME), G_TYPE_BOOLEAN, new_base_time, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, structure);
886 887 888 889 890 891 892 893

  return message;
}

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

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

Wim Taymans's avatar
Wim Taymans committed
935 936 937 938 939 940
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
941
 * Returns: The structure of the message. The structure is still
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
942
 * owned by the message, which means that you should not free it and
943
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
944 945 946 947 948 949 950
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
951

Wim Taymans's avatar
Wim Taymans committed
952 953 954 955 956 957
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
Stefan Kost's avatar
Stefan Kost committed
958
 * @tag_list: Return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
959 960 961 962 963 964 965 966 967 968 969
 *
 * 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);
970
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
971 972 973

  *tag_list = (GstTagList *) gst_structure_copy (message->structure);
}
974 975 976 977 978 979

/**
 * 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
980 981
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
982 983 984 985 986 987 988 989 990 991 992 993
 *
 * Since: 0.10.11
 *
 * MT safe.
 */
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);

  if (percent)
994 995
    *percent = g_value_get_int (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUFFER_PERCENT)));
996
}
Wim Taymans's avatar
Wim Taymans committed
997

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
/**
 * gst_message_set_buffering_stats:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
 * @mode: a buffering mode 
 * @avg_in: the average input rate
 * @avg_out: the average output rate
 * @buffering_left: amount of buffering time left in milliseconds
 *
 * Configures the buffering stats values in @message.
 *
 * Since: 0.10.20
 */
void
gst_message_set_buffering_stats (GstMessage * message, GstBufferingMode mode,
    gint avg_in, gint avg_out, gint64 buffering_left)
{
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);

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

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

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

Wim Taymans's avatar
Wim Taymans committed
1057
/**
1058
 * gst_message_parse_state_changed:
1059
 * @message: a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED
1060 1061 1062
 * @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
1063 1064 1065 1066 1067 1068
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
1069
gst_message_parse_state_changed (GstMessage * message,
1070
    GstState * oldstate, GstState * newstate, GstState * pending)
Wim Taymans's avatar
Wim Taymans committed
1071 1072 1073 1074
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);

1075
  if (oldstate)
1076 1077 1078
    *oldstate =
        g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (OLD_STATE)));
1079
  if (newstate)
1080 1081 1082
    *newstate =
        g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (NEW_STATE)));
1083
  if (pending)
1084 1085
    *pending = g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (PENDING_STATE)));
Wim Taymans's avatar
Wim Taymans committed
1086 1087
}

Wim Taymans's avatar
Wim Taymans committed
1088 1089 1090
/**
 * gst_message_parse_clock_provide:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.
1091 1092
 * @clock: A pointer to  hold a clock object.
 * @ready: A pointer to hold the ready flag.
Wim Taymans's avatar
Wim Taymans committed
1093
 *
1094 1095
 * 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
1096 1097 1098 1099
 *
 * MT safe.
 */
void
1100 1101
gst_message_parse_clock_provide (GstMessage * message, GstClock ** clock,
    gboolean * ready)
Wim Taymans's avatar
Wim Taymans committed
1102
{
1103 1104
  const GValue *clock_gvalue;

Wim Taymans's avatar
Wim Taymans committed
1105 1106 1107
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_PROVIDE);

1108 1109
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
1110 1111 1112
  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
1113
  if (ready)
1114 1115 1116
    *ready =
        g_value_get_boolean (gst_structure_id_get_value (message->structure,
            GST_QUARK (READY)));
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
  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));
1137
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_LOST);
1138

1139 1140
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
1141 1142 1143 1144 1145
  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
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
}

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

1166 1167
  clock_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (CLOCK));
Wim Taymans's avatar
Wim Taymans committed
1168 1169 1170 1171 1172 1173 1174
  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);
}

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
/**
 * gst_message_parse_structure_change:
 * @message: A valid #GstMessage of type GST_MESSAGE_STRUCTURE_CHANGE.
 * @type: A pointer to hold the change type
 * @owner: The owner element of the message source
 * @busy: A pointer to hold whether the change is in progress or has been
 * completed
 *
 * Extracts the change type and completion status from the GstMessage.
 *
 * MT safe.
 *
 * Since: 0.10.22
 */
void
gst_message_parse_structure_change (GstMessage * message,
    GstStructureChangeType * type, GstElement ** owner, gboolean * busy)
{
  const GValue *owner_gvalue;

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

  owner_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (OWNER));
  g_return_if_fail (owner_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (owner_gvalue) == GST_TYPE_ELEMENT);

  if (type)
    *type = g_value_get_enum (gst_structure_id_get_value (message->structure,
            GST_QUARK (TYPE)));
  if (owner)
    *owner = (GstElement *) g_value_get_object (owner_gvalue);
  if (busy)
    *busy =
        g_value_get_boolean (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUSY)));
}

Wim Taymans's avatar
Wim Taymans committed
1214 1215 1216
/**
 * gst_message_parse_error:
 * @message: A valid #GstMessage of type GST_MESSAGE_ERROR.
Stefan Kost's avatar
Stefan Kost committed
1217
 * @gerror: Location for the GError
1218
 * @debug: Location for the debug message, or NULL
Wim Taymans's avatar
Wim Taymans committed
1219
 *
Wim Taymans's avatar
Wim Taymans committed
1220
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
1221 1222 1223 1224 1225 1226 1227 1228
 * 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;
1229
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
1230 1231 1232 1233

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

1234 1235
  error_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (GERROR));
Wim Taymans's avatar
Wim Taymans committed
1236
  g_return_if_fail (error_gvalue != NULL);
1237
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
1238

1239
  error_val = (GError *) g_value_get_boxed (error_gvalue);
1240 1241 1242 1243
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;
1244 1245

  if (debug)
1246 1247 1248
    *debug =
        g_value_dup_string (gst_structure_id_get_value (message->structure,
            GST_QUARK (DEBUG)));
Wim Taymans's avatar
Wim Taymans committed
1249 1250 1251 1252 1253
}

/**
 * gst_message_parse_warning:
 * @message: A valid #GstMessage of type GST_MESSAGE_WARNING.
Stefan Kost's avatar
Stefan Kost committed
1254
 * @gerror: Location for the GError
1255
 * @debug: Location for the debug message, or NULL
Wim Taymans's avatar
Wim Taymans committed
1256
 *
Wim Taymans's avatar
Wim Taymans committed
1257
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
1258 1259 1260 1261 1262 1263 1264 1265 1266
 * 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;
1267
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
1268 1269 1270 1271

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

1272 1273
  error_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (GERROR));
Wim Taymans's avatar
Wim Taymans committed
1274
  g_return_if_fail (error_gvalue != NULL);
1275
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
1276

1277
  error_val = (GError *) g_value_get_boxed (error_gvalue);
1278 1279 1280 1281 1282
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

1283
  if (debug)
1284 1285 1286
    *debug =
        g_value_dup_string (gst_structure_id_get_value (message->structure,
            GST_QUARK (DEBUG)));
Wim Taymans's avatar
Wim Taymans committed
1287
}
1288

1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
/**
 * gst_message_parse_info:
 * @message: A valid #GstMessage of type GST_MESSAGE_INFO.
 * @gerror: Location for the GError
 * @debug: Location for the debug message, or NULL
 *
 * Extracts the GError and debug string from the GstMessage. The values returned
 * in the output arguments are copies; the caller must free them when done.
 *
 * MT safe.
 *
 * Since: 0.10.12
 */
void
gst_message_parse_info (GstMessage * message, GError ** gerror, gchar ** debug)
{
  const GValue *error_gvalue;
  GError *error_val;

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

1311 1312
  error_gvalue =
      gst_structure_id_get_value (message->structure, GST_QUARK (GERROR));
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
  g_return_if_fail (error_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);

  error_val = (GError *) g_value_get_boxed (error_gvalue);
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

  if (debug)
1323 1324 1325
    *debug =
        g_value_dup_string (gst_structure_id_get_value (message->structure,
            GST_QUARK (DEBUG)));
1326 1327
}

1328 1329 1330
/**
 * gst_message_parse_segment_start:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.
1331 1332
 * @format: Result location for the format, or NULL
 * @position: Result location for the position, or NULL
1333
 *