gstmessage.c 32.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"
Wim Taymans's avatar
Wim Taymans committed
60 61


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

void
_gst_message_initialize (void)
{
70 71
  gpointer ptr;

Wim Taymans's avatar
Wim Taymans committed
72 73
  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

74
  gst_message_get_type ();
Wim Taymans's avatar
Wim Taymans committed
75

76 77 78 79 80
  /* the GstMiniObject types need to be class_ref'd once before it can be
   * done from multiple threads;
   * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
  ptr = g_type_class_ref (GST_TYPE_MESSAGE);
  g_type_class_unref (ptr);
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 195 196 197
  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
198

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

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

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

213
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p", message);
214

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

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

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

232 233
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
234
{
235 236
  GstMessage *copy;

237
  GST_CAT_LOG (GST_CAT_MESSAGE, "copy message %p", message);
238 239 240

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
244 245 246 247
  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);
248 249

  if (GST_MESSAGE_SRC (message)) {
250
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
251 252 253 254 255
  }

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

  return copy;
Wim Taymans's avatar
Wim Taymans committed
260 261
}

Wim Taymans's avatar
Wim Taymans committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/**
 * 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
280 281 282
{
  GstMessage *message;

283
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
284

285 286
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
287
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
288

289
  message->type = type;
290 291 292 293 294

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

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

  return message;
}

/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
306
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
307
 *
308 309 310
 * 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
311 312 313 314 315 316 317 318 319 320
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
321
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
322 323 324 325 326 327 328 329 330 331

  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.
 *
332
 * Create a new error message. The message will copy @error and
333
 * @debug. This message is posted by element when a fatal event
334 335
 * occured. The pipeline will probably (partially) stop. The application
 * receiving this message should stop the pipeline.
Wim Taymans's avatar
Wim Taymans committed
336 337 338 339 340 341 342 343 344 345
 *
 * 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
346 347 348
  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
349 350 351 352 353 354 355 356 357 358

  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.
 *
359
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
360 361 362 363 364 365 366 367 368 369 370
 * @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
371 372 373
  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
374 375 376 377

  return message;
}

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/**
 * gst_message_new_info:
 * @src: The object originating the message.
 * @error: The GError for this message.
 * @debug: A debugging string for something or other.
 *
 * 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 *
gst_message_new_info (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_INFO, src,
      gst_structure_new ("GstMessageInfo", "gerror", GST_TYPE_G_ERROR, error,
          "debug", G_TYPE_STRING, debug, NULL));

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
405 406 407 408 409 410
/**
 * 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.
411
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
412 413 414 415 416 417 418 419 420 421
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

422 423
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
424 425
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
426 427 428 429

  return message;
}

430 431 432 433 434 435 436 437 438
/**
 * 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
439 440 441 442 443 444 445
 * 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. 
 *
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
 * Returns: The new buffering message.
 *
 * Since: 0.10.11
 *
 * MT safe.
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;

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

  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src,
      gst_structure_new ("GstMessageBuffering",
          "buffer-percent", G_TYPE_INT, percent, NULL));

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
466
/**
Stefan Kost's avatar
Stefan Kost committed
467
 * gst_message_new_state_changed:
468 469 470 471
 * @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
472
 *
473 474
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
475 476 477 478 479 480
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
481
gst_message_new_state_changed (GstObject * src,
482
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
483 484 485
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
486 487
  message = gst_message_new_custom (GST_MESSAGE_STATE_CHANGED, src,
      gst_structure_new ("GstMessageState",
488 489
          "old-state", GST_TYPE_STATE, (gint) oldstate,
          "new-state", GST_TYPE_STATE, (gint) newstate,
Wim Taymans's avatar
Wim Taymans committed
490 491 492 493 494
          "pending-state", GST_TYPE_STATE, (gint) pending, NULL));

  return message;
}

495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
/**
 * 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
517 518 519
/**
 * gst_message_new_clock_provide:
 * @src: The object originating the message.
520
 * @clock: The clock it provides
Wim Taymans's avatar
Wim Taymans committed
521 522
 * @ready: TRUE if the sender can provide a clock
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
523
 * Create a clock provide message. This message is posted whenever an
Wim Taymans's avatar
Wim Taymans committed
524 525 526
 * 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
527
 * This message is mainly used internally to manage the clock
Wim Taymans's avatar
Wim Taymans committed
528 529 530 531 532 533 534
 * selection.
 *
 * Returns: The new provide clock message.
 *
 * MT safe.
 */
GstMessage *
535 536
gst_message_new_clock_provide (GstObject * src, GstClock * clock,
    gboolean ready)
Wim Taymans's avatar
Wim Taymans committed
537 538 539 540 541
{
  GstMessage *message;

  message = gst_message_new_custom (GST_MESSAGE_CLOCK_PROVIDE, src,
      gst_structure_new ("GstMessageClockProvide",
542
          "clock", GST_TYPE_CLOCK, clock,
Wim Taymans's avatar
Wim Taymans committed
543
          "ready", G_TYPE_BOOLEAN, ready, NULL));
544

Wim Taymans's avatar
Wim Taymans committed
545 546 547
  return message;
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
/**
 * 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
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
/**
 * 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
596 597 598 599 600

  return message;
}

/**
601 602
 * gst_message_new_segment_start:
 * @src: The object originating the message.
603 604
 * @format: The format of the position being played
 * @position: The position of the segment being played
605 606 607 608 609 610 611 612 613 614 615
 *
 * 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 *
616 617
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
618 619 620
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
621
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_START, src,
622 623 624
      gst_structure_new ("GstMessageSegmentStart",
          "format", GST_TYPE_FORMAT, format,
          "position", G_TYPE_INT64, position, NULL));
625 626 627 628 629 630 631

  return message;
}

/**
 * gst_message_new_segment_done:
 * @src: The object originating the message.
632 633
 * @format: The format of the position being done
 * @position: The position of the segment being done
634 635 636 637 638 639 640 641 642 643 644
 *
 * 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 *
645 646
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
647 648 649
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
650
  message = gst_message_new_custom (GST_MESSAGE_SEGMENT_DONE, src,
651 652 653
      gst_structure_new ("GstMessageSegmentDone",
          "format", GST_TYPE_FORMAT, format,
          "position", G_TYPE_INT64, position, NULL));
654 655 656 657

  return message;
}

658 659 660 661 662 663 664 665 666
/**
 * 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
667 668
 * Returns: The new application message.
 *
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
 * 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
688 689
 * Returns: The new element message.
 *
690 691 692 693 694 695 696 697
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

698 699 700 701 702 703 704 705 706
/**
 * 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
707 708 709 710
 * 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.
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
 *
 * 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;
}

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 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
/**
 * 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;

  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src,
      gst_structure_new ("GstMessageAsyncStart",
          "new-base-time", G_TYPE_BOOLEAN, new_base_time, NULL));

  return message;
}

/**
 * gst_message_new_async_done:
 * @src: The object originating the message.
 *
 * 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;
}

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
/**
 * 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
799 800 801 802 803 804
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
805
 * Returns: The structure of the message. The structure is still
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
806
 * owned by the message, which means that you should not free it and
807
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
808 809 810 811 812 813 814
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
815

Wim Taymans's avatar
Wim Taymans committed
816 817 818 819 820 821
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
Stefan Kost's avatar
Stefan Kost committed
822
 * @tag_list: Return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
823 824 825 826 827 828 829 830 831 832 833
 *
 * 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);
834
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
835 836 837

  *tag_list = (GstTagList *) gst_structure_copy (message->structure);
}
838 839 840 841 842 843

/**
 * 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
844 845
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
846 847 848 849 850 851 852 853 854 855 856 857 858 859
 *
 * 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)
    gst_structure_get_int (message->structure, "buffer-percent", percent);
}
Wim Taymans's avatar
Wim Taymans committed
860 861

/**
862
 * gst_message_parse_state_changed:
863
 * @message: a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED
864 865 866
 * @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
867 868 869 870 871 872
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
873
gst_message_parse_state_changed (GstMessage * message,
874
    GstState * oldstate, GstState * newstate, GstState * pending)
Wim Taymans's avatar
Wim Taymans committed
875 876 877 878
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);

879
  if (oldstate)
880
    gst_structure_get_enum (message->structure, "old-state",
881 882
        GST_TYPE_STATE, (gint *) oldstate);
  if (newstate)
883
    gst_structure_get_enum (message->structure, "new-state",
884
        GST_TYPE_STATE, (gint *) newstate);
885 886 887
  if (pending)
    gst_structure_get_enum (message->structure, "pending-state",
        GST_TYPE_STATE, (gint *) pending);
Wim Taymans's avatar
Wim Taymans committed
888 889
}

Wim Taymans's avatar
Wim Taymans committed
890 891 892
/**
 * gst_message_parse_clock_provide:
 * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE.
893 894
 * @clock: A pointer to  hold a clock object.
 * @ready: A pointer to hold the ready flag.
Wim Taymans's avatar
Wim Taymans committed
895
 *
896 897
 * 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
898 899 900 901
 *
 * MT safe.
 */
void
902 903
gst_message_parse_clock_provide (GstMessage * message, GstClock ** clock,
    gboolean * ready)
Wim Taymans's avatar
Wim Taymans committed
904
{
905 906
  const GValue *clock_gvalue;

Wim Taymans's avatar
Wim Taymans committed
907 908 909
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_PROVIDE);

910 911 912 913
  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
914 915
  if (ready)
    gst_structure_get_boolean (message->structure, "ready", ready);
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
  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));
936
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_CLOCK_LOST);
937 938 939 940 941 942 943

  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
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
}

/**
 * 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
972 973 974
/**
 * gst_message_parse_error:
 * @message: A valid #GstMessage of type GST_MESSAGE_ERROR.
Stefan Kost's avatar
Stefan Kost committed
975
 * @gerror: Location for the GError
976
 * @debug: Location for the debug message, or NULL
Wim Taymans's avatar
Wim Taymans committed
977
 *
Wim Taymans's avatar
Wim Taymans committed
978
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
979 980 981 982 983 984 985 986
 * 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;
987
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
988 989 990 991 992 993

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

996
  error_val = (GError *) g_value_get_boxed (error_gvalue);
997 998 999 1000
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;
1001 1002 1003

  if (debug)
    *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
Wim Taymans's avatar
Wim Taymans committed
1004 1005 1006 1007 1008
}

/**
 * gst_message_parse_warning:
 * @message: A valid #GstMessage of type GST_MESSAGE_WARNING.
Stefan Kost's avatar
Stefan Kost committed
1009
 * @gerror: Location for the GError
1010
 * @debug: Location for the debug message, or NULL
Wim Taymans's avatar
Wim Taymans committed
1011
 *
Wim Taymans's avatar
Wim Taymans committed
1012
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
1013 1014 1015 1016 1017 1018 1019 1020 1021
 * 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;
1022
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
1023 1024 1025 1026 1027 1028

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

1031
  error_val = (GError *) g_value_get_boxed (error_gvalue);
1032 1033 1034 1035 1036
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

1037 1038
  if (debug)
    *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
Wim Taymans's avatar
Wim Taymans committed
1039
}
1040

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
/**
 * 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);

  error_gvalue = gst_structure_get_value (message->structure, "gerror");
  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)
    *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}

1077 1078 1079
/**
 * gst_message_parse_segment_start:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.
1080 1081
 * @format: Result location for the format, or NULL
 * @position: Result location for the position, or NULL
1082
 *
1083
 * Extracts the position and format from the segment start message.
1084 1085 1086 1087
 *
 * MT safe.
 */
void
1088 1089
gst_message_parse_segment_start (GstMessage * message, GstFormat * format,
    gint64 * position)
1090
{
1091
  const GstStructure *structure;
1092 1093 1094 1095

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

1096 1097 1098 1099 1100 1101
  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"));
1102 1103 1104 1105 1106
}

/**
 * gst_message_parse_segment_done:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE.
1107 1108
 * @format: Result location for the format, or NULL
 * @position: Result location for the position, or NULL
1109
 *
1110
 * Extracts the position and format from the segment start message.
1111 1112 1113 1114
 *
 * MT safe.
 */
void
1115 1116
gst_message_parse_segment_done (GstMessage * message, GstFormat * format,
    gint64 * position)
1117
{
1118
  const GstStructure *structure;
1119 1120 1121 1122

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

1123 1124 1125 1126 1127 1128 1129
  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"));
}
1130

1131 1132 1133
/**
 * gst_message_parse_duration:
 * @message: A valid #GstMessage of type GST_MESSAGE_DURATION.
1134 1135
 * @format: Result location for the format, or NULL
 * @duration: Result location for the duration, or NULL
1136
 *
1137 1138 1139 1140
 * Extracts the duration and format from the duration message. The duration
 * might be GST_CLOCK_TIME_NONE, which indicates that the duration has
 * changed. Applications should always use a query to retrieve the duration
 * of a pipeline.
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
 *
 * 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"));
1159
}
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185

/**
 * gst_message_parse_async_start:
 * @message: A valid #GstMessage of type GST_MESSAGE_ASYNC_DONE.
 * @new_base_time: Result location for the new_base_time or NULL
 *
 * Extract the new_base_time from the async_start message. 
 *
 * MT safe.
 *
 * Since: 0.10.13
 */
void
gst_message_parse_async_start (GstMessage * message, gboolean * new_base_time)
{
  const GstStructure *structure;

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

  structure = gst_message_get_structure (message);
  if (new_base_time)
    *new_base_time =
        g_value_get_boolean (gst_structure_get_value (structure,
            "new-base-time"));
}