gstmessage.c 65.3 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
static GType _gst_message_type = 0;
Wim Taymans's avatar
Wim Taymans committed
64

65 66
typedef struct
{
67 68
  const gint type;
  const gchar *name;
69 70 71 72 73 74 75 76 77 78 79 80
  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},
81
  {GST_MESSAGE_STATE_DIRTY, "state-dirty", 0},
82
  {GST_MESSAGE_STEP_DONE, "step-done", 0},
Wim Taymans's avatar
Wim Taymans committed
83 84
  {GST_MESSAGE_CLOCK_PROVIDE, "clock-provide", 0},
  {GST_MESSAGE_CLOCK_LOST, "clock-lost", 0},
85 86 87 88
  {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
89
  {GST_MESSAGE_ELEMENT, "element", 0},
90 91
  {GST_MESSAGE_SEGMENT_START, "segment-start", 0},
  {GST_MESSAGE_SEGMENT_DONE, "segment-done", 0},
92
  {GST_MESSAGE_DURATION, "duration", 0},
93
  {GST_MESSAGE_LATENCY, "latency", 0},
94 95
  {GST_MESSAGE_ASYNC_START, "async-start", 0},
  {GST_MESSAGE_ASYNC_DONE, "async-done", 0},
96
  {GST_MESSAGE_REQUEST_STATE, "request-state", 0},
Wim Taymans's avatar
Wim Taymans committed
97
  {GST_MESSAGE_STEP_START, "step-start", 0},
98
  {GST_MESSAGE_QOS, "qos", 0},
Wim Taymans's avatar
Wim Taymans committed
99
  {GST_MESSAGE_PROGRESS, "progress", 0},
100 101 102
  {0, NULL, 0}
};

103 104 105 106 107 108 109 110 111 112
void
_gst_message_initialize (void)
{
  gint i;

  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

  /* 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 */
113
  gst_message_get_type ();
114 115 116 117 118 119 120

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

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

161 162
GType
gst_message_get_type (void)
163
{
164 165 166 167
  if (G_UNLIKELY (_gst_message_type == 0)) {
    _gst_message_type = gst_mini_object_register ("GstMessage");
  }
  return _gst_message_type;
168
}
Wim Taymans's avatar
Wim Taymans committed
169 170 171


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

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
194
  g_slice_free1 (GST_MINI_OBJECT_SIZE (message), message);
Wim Taymans's avatar
Wim Taymans committed
195 196
}

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

202
  GST_CAT_LOG (GST_CAT_MESSAGE, "copy message %p", message);
203

204 205 206 207
  copy = g_slice_new0 (GstMessage);

  gst_mini_object_init (GST_MINI_OBJECT_CAST (copy),
      _gst_message_type, sizeof (GstMessage));
208

209 210
  copy->mini_object.copy = (GstMiniObjectCopyFunction) _gst_message_copy;
  copy->mini_object.free = (GstMiniObjectFreeFunction) _gst_message_free;
211

Wim Taymans's avatar
Wim Taymans committed
212 213
  GST_MESSAGE_GET_LOCK (copy) = GST_MESSAGE_GET_LOCK (message);
  GST_MESSAGE_COND (copy) = GST_MESSAGE_COND (message);
214 215
  GST_MESSAGE_TYPE (copy) = GST_MESSAGE_TYPE (message);
  GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
216
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
217

218 219
  if (GST_MESSAGE_SRC (message)) {
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
220 221 222 223 224
  }

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

  return copy;
Wim Taymans's avatar
Wim Taymans committed
229 230
}

Wim Taymans's avatar
Wim Taymans committed
231 232 233 234
/**
 * gst_message_new_custom:
 * @type: The #GstMessageType to distinguish messages
 * @src: The object originating the message.
235 236
 * @structure: (transfer full): the structure for the message. The message
 *     will take ownership of the structure.
Wim Taymans's avatar
Wim Taymans committed
237 238 239 240 241
 *
 * 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.
 *
242
 * Returns: (transfer full): The new message.
Wim Taymans's avatar
Wim Taymans committed
243 244 245 246 247 248
 *
 * MT safe.
 */
GstMessage *
gst_message_new_custom (GstMessageType type, GstObject * src,
    GstStructure * structure)
Wim Taymans's avatar
Wim Taymans committed
249 250 251
{
  GstMessage *message;

252 253 254 255 256 257 258
  message = g_slice_new0 (GstMessage);

  gst_mini_object_init (GST_MINI_OBJECT_CAST (message),
      _gst_message_type, sizeof (GstMessage));

  message->mini_object.copy = (GstMiniObjectCopyFunction) _gst_message_copy;
  message->mini_object.free = (GstMiniObjectFreeFunction) _gst_message_free;
Wim Taymans's avatar
Wim Taymans committed
259

260 261
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
262
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
263

264
  message->type = type;
265 266 267 268 269

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

Wim Taymans's avatar
Wim Taymans committed
270 271 272 273 274
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
275

276
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
277 278
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();

Wim Taymans's avatar
Wim Taymans committed
279 280 281
  return message;
}

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
/**
 * gst_message_get_seqnum:
 * @message: A #GstMessage.
 *
 * Retrieve the sequence number of a message.
 *
 * Messages have ever-incrementing sequence numbers, which may also be set
 * explicitly via gst_message_set_seqnum(). Sequence numbers are typically used
 * to indicate that a message corresponds to some other set of messages or
 * events, for example a SEGMENT_DONE message corresponding to a SEEK event. It
 * is considered good practice to make this correspondence when possible, though
 * it is not required.
 *
 * Note that events and messages share the same sequence number incrementor;
 * two events or messages will never not have the same sequence number unless
 * that correspondence was made explicitly.
 *
 * Returns: The message's sequence number.
 *
 * MT safe.
302 303
 *
 * Since: 0.10.22
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
 */
guint32
gst_message_get_seqnum (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), -1);

  return GST_MESSAGE_SEQNUM (message);
}

/**
 * gst_message_set_seqnum:
 * @message: A #GstMessage.
 * @seqnum: A sequence number.
 *
 * Set the sequence number of a message.
 *
 * This function might be called by the creator of a message to indicate that
 * the message relates to other messages or events. See gst_message_get_seqnum()
 * for more information.
 *
 * MT safe.
325 326
 *
 * Since: 0.10.22
327 328 329 330 331 332 333 334 335
 */
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
336 337
/**
 * gst_message_new_eos:
338
 * @src: (transfer none): The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
339
 *
340 341 342
 * 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
343
 *
344
 * Returns: (transfer full): The new eos message.
Wim Taymans's avatar
Wim Taymans committed
345 346 347 348 349 350 351 352
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
353
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
354 355 356 357 358 359

  return message;
}

/**
 * gst_message_new_error:
360 361
 * @src: (transfer none): The object originating the message.
 * @error: (transfer none): The GError for this message.
362
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
363
 *
364
 * Create a new error message. The message will copy @error and
365
 * @debug. This message is posted by element when a fatal event
366 367
 * occured. The pipeline will probably (partially) stop. The application
 * receiving this message should stop the pipeline.
Wim Taymans's avatar
Wim Taymans committed
368
 *
369
 * Returns: (transfer full): the new error message.
Wim Taymans's avatar
Wim Taymans committed
370 371 372 373
 *
 * MT safe.
 */
GstMessage *
374
gst_message_new_error (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
375 376
{
  GstMessage *message;
377
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
378

379
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ERROR),
380 381 382
      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
383 384 385 386 387 388

  return message;
}

/**
 * gst_message_new_warning:
389 390
 * @src: (transfer none): The object originating the message.
 * @error: (transfer none): The GError for this message.
391
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
392
 *
393
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
394 395
 * @debug.
 *
396
 * Returns: (transfer full): The new warning message.
Wim Taymans's avatar
Wim Taymans committed
397 398 399 400
 *
 * MT safe.
 */
GstMessage *
401
gst_message_new_warning (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
402 403
{
  GstMessage *message;
404
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
405

406
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_WARNING),
407 408 409
      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
410 411 412 413

  return message;
}

414 415
/**
 * gst_message_new_info:
416 417
 * @src: (transfer none): The object originating the message.
 * @error: (transfer none): The GError for this message.
418
 * @debug: A debugging string.
419 420 421 422 423
 *
 * Create a new info message. The message will make copies of @error and
 * @debug.
 *
 * MT safe.
424
 *
425
 * Returns: (transfer full): the new info message.
Stefan Kost's avatar
Stefan Kost committed
426
 *
427
 * Since: 0.10.12
428 429
 */
GstMessage *
430
gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
431 432
{
  GstMessage *message;
433
  GstStructure *structure;
434

435 436 437
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_INFO),
      GST_QUARK (GERROR), GST_TYPE_G_ERROR, error,
      GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
438
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
439 440 441 442

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
443 444
/**
 * gst_message_new_tag:
445 446
 * @src: (transfer none): The object originating the message.
 * @tag_list: (transfer full): the tag list for the message.
Wim Taymans's avatar
Wim Taymans committed
447 448
 *
 * Create a new tag message. The message will take ownership of the tag list.
449
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
450
 *
451
 * Returns: (transfer full): the new tag message.
Wim Taymans's avatar
Wim Taymans committed
452 453 454 455 456 457 458 459
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

460 461
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
462 463
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
464 465 466 467

  return message;
}

468 469
/**
 * gst_message_new_tag_full:
470 471 472
 * @src: (transfer none): the object originating the message.
 * @pad: (transfer none): the originating pad for the tag.
 * @tag_list: (transfer full): the tag list for the message.
473 474 475 476
 *
 * Create a new tag message. The message will take ownership of the tag list.
 * The message is posted by elements that discovered a new taglist.
 *
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
477 478
 * MT safe.
 *
479
 * Returns: (transfer full): the new tag message.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
 *
 * Since: 0.10.24
 */
GstMessage *
gst_message_new_tag_full (GstObject * src, GstPad * pad, GstTagList * tag_list)
{
  GstMessage *message;
  GstStructure *s;

  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);
  g_return_val_if_fail (pad == NULL || GST_IS_PAD (pad), NULL);

  s = (GstStructure *) tag_list;
  if (pad)
    gst_structure_set (s, "source-pad", GST_TYPE_PAD, pad, NULL);

  message = gst_message_new_custom (GST_MESSAGE_TAG, src, s);

  return message;
}

501 502
/**
 * gst_message_new_buffering:
503
 * @src: (transfer none): The object originating the message.
504 505 506 507 508 509
 * @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
510 511 512 513 514 515 516
 * 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. 
 *
517
 * MT safe.
518
 *
519
 * Returns: (transfer full): The new buffering message.
Stefan Kost's avatar
Stefan Kost committed
520
 *
521
 * Since: 0.10.11
522 523 524 525 526
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;
527
  GstStructure *structure;
528 529 530

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

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

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
543
/**
Stefan Kost's avatar
Stefan Kost committed
544
 * gst_message_new_state_changed:
545
 * @src: (transfer none): the object originating the message
546 547 548
 * @oldstate: the previous state
 * @newstate: the new (current) state
 * @pending: the pending (target) state
Wim Taymans's avatar
Wim Taymans committed
549
 *
550 551
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
552
 *
553
 * Returns: (transfer full): the new state change message.
Wim Taymans's avatar
Wim Taymans committed
554 555 556 557
 *
 * MT safe.
 */
GstMessage *
558
gst_message_new_state_changed (GstObject * src,
559
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
560 561
{
  GstMessage *message;
562
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
563

564
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STATE),
565 566 567 568
      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
/**
 * gst_message_new_state_dirty:
575
 * @src: (transfer none): the object originating the message
576 577 578 579 580
 *
 * 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.
 *
581
 * Returns: (transfer full): the new state dirty message.
582 583 584 585 586 587 588 589 590 591 592 593 594
 *
 * 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
/**
 * gst_message_new_clock_provide:
597 598
 * @src: (transfer none): the object originating the message.
 * @clock: (transfer none): 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
 * selection.
 *
608
 * Returns: (transfer full): the new provide clock message.
Wim Taymans's avatar
Wim Taymans committed
609 610 611 612
 *
 * 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
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_PROVIDE),
620 621 622
      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);
623

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

627 628
/**
 * gst_message_new_clock_lost:
629 630
 * @src: (transfer none): the object originating the message.
 * @clock: (transfer none): the clock that was lost
631 632 633 634 635 636 637 638
 *
 * 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.
 *
639
 * Returns: (transfer full): The new clock lost message.
640 641 642 643 644 645 646
 *
 * MT safe.
 */
GstMessage *
gst_message_new_clock_lost (GstObject * src, GstClock * clock)
{
  GstMessage *message;
647
  GstStructure *structure;
648

649
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_LOST),
650 651
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
652 653 654 655

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
656 657
/**
 * gst_message_new_new_clock:
658 659
 * @src: (transfer none): The object originating the message.
 * @clock: (transfer none): the new selected clock
Wim Taymans's avatar
Wim Taymans committed
660 661 662 663
 *
 * Create a new clock message. This message is posted whenever the
 * pipeline selectes a new clock for the pipeline.
 *
664
 * Returns: (transfer full): The new new clock message.
Wim Taymans's avatar
Wim Taymans committed
665 666 667 668 669 670 671
 *
 * MT safe.
 */
GstMessage *
gst_message_new_new_clock (GstObject * src, GstClock * clock)
{
  GstMessage *message;
672
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
673

674
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_NEW_CLOCK),
675 676
      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
677 678 679 680

  return message;
}

681 682
/**
 * gst_message_new_structure_change:
683
 * @src: (transfer none): The object originating the message.
684
 * @type: The change type.
685
 * @owner: (transfer none): The owner element of @src.
686 687 688 689 690 691
 * @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.
 *
692
 * @src should be the sinkpad that unlinked or linked.
693
 *
694
 * Returns: (transfer full): the new structure change message.
695 696 697 698 699 700 701 702 703 704 705 706 707
 *
 * MT safe.
 *
 * Since: 0.10.22.
 */
GstMessage *
gst_message_new_structure_change (GstObject * src, GstStructureChangeType type,
    GstElement * owner, gboolean busy)
{
  GstMessage *message;
  GstStructure *structure;

  g_return_val_if_fail (GST_IS_PAD (src), NULL);
Jan Schmidt's avatar
Jan Schmidt committed
708
  /* g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SINK, NULL); */
709 710
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

711
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STRUCTURE_CHANGE),
712 713 714 715 716 717 718 719 720 721
      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
722
/**
723
 * gst_message_new_segment_start:
724
 * @src: (transfer none): The object originating the message.
725 726
 * @format: The format of the position being played
 * @position: The position of the segment being played
727 728 729 730 731 732
 *
 * 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.
 *
733
 * Returns: (transfer full): the new segment start message.
734 735 736 737
 *
 * MT safe.
 */
GstMessage *
738 739
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
740 741
{
  GstMessage *message;
742
  GstStructure *structure;
743

744
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_START),
745 746 747
      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);
748 749 750 751 752 753

  return message;
}

/**
 * gst_message_new_segment_done:
754
 * @src: (transfer none): the object originating the message.
755 756
 * @format: The format of the position being done
 * @position: The position of the segment being done
757 758 759 760 761 762
 *
 * 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.
 *
763
 * Returns: (transfer full): the new segment done message.
764 765 766 767
 *
 * MT safe.
 */
GstMessage *
768 769
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
770 771
{
  GstMessage *message;
772
  GstStructure *structure;
773

774
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_DONE),
775 776 777
      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);
778 779 780 781

  return message;
}

782 783
/**
 * gst_message_new_application:
784 785 786
 * @src: (transfer none): the object originating the message.
 * @structure: (transfer full): the structure for the message. The message
 *     will take ownership of the structure.
787 788 789 790
 *
 * Create a new application-typed message. GStreamer will never create these
 * messages; they are a gift from us to you. Enjoy.
 *
791
 * Returns: (transfer full): The new application message.
Stefan Kost's avatar
Stefan Kost committed
792
 *
793 794 795 796 797 798 799 800 801 802
 * 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:
803 804 805
 * @src: (transfer none): The object originating the message.
 * @structure: (transfer full): The structure for the message. The message
 *     will take ownership of the structure.
806 807 808 809 810 811
 *
 * 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.
 *
812
 * Returns: (transfer full): The new element message.
Stefan Kost's avatar
Stefan Kost committed
813
 *
814 815 816 817 818 819 820 821
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

822 823
/**
 * gst_message_new_duration:
824
 * @src: (transfer none): The object originating the message.
825 826 827 828 829 830
 * @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
831 832 833 834
 * 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.
835
 *
836
 * Returns: (transfer full): The new duration message.
837 838 839 840 841 842 843
 *
 * MT safe.
 */
GstMessage *
gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
{
  GstMessage *message;
844
  GstStructure *structure;
845

846
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_DURATION),
847 848 849
      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);
850 851 852 853

  return message;
}

854 855
/**
 * gst_message_new_async_start:
856
 * @src: (transfer none): The object originating the message.
857 858 859 860 861 862
 * @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.
 *
863
 * Returns: (transfer full): The new async_start message.
864 865 866 867 868 869 870 871 872
 *
 * MT safe.
 *
 * Since: 0.10.13
 */
GstMessage *
gst_message_new_async_start (GstObject * src, gboolean new_base_time)
{
  GstMessage *message;
873
  GstStructure *structure;
874

875
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ASYNC_START),
876 877
      GST_QUARK (NEW_BASE_TIME), G_TYPE_BOOLEAN, new_base_time, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, structure);
878 879 880 881 882 883

  return message;
}

/**
 * gst_message_new_async_done:
884
 * @src: (transfer none): The object originating the message.
885
 *
Stefan Kost's avatar
Stefan Kost committed
886 887
 * The message is posted when elements completed an ASYNC state change.
 *
888
 * Returns: (transfer full): The new async_done message.
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
 *
 * 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;
}

904 905
/**
 * gst_message_new_latency:
906
 * @src: (transfer none): The object originating the message.
907 908 909 910
 *
 * This message can be posted by elements when their latency requirements have
 * changed.
 *
911
 * Returns: (transfer full): The new latency message.
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
 *
 * 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;
}

927 928
/**
 * gst_message_new_request_state:
929
 * @src: (transfer none): the object originating the message.
930 931 932 933 934 935
 * @state: The new requested state
 *
 * This message can be posted by elements when they want to have their state
 * changed. A typical use case would be an audio server that wants to pause the
 * pipeline because a higher priority stream is being played.
 *
936
 * Returns: (transfer full): the new requst state message.
937 938 939 940 941 942 943 944 945 946 947
 *
 * MT safe.
 *
 * Since: 0.10.23
 */
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
{
  GstMessage *message;
  GstStructure *structure;

948
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_REQUEST_STATE),
949 950 951 952 953 954
      GST_QUARK (NEW_STATE), GST_TYPE_STATE, (gint) state, NULL);
  message = gst_message_new_custom (GST_MESSAGE_REQUEST_STATE, src, structure);

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
955 956 957 958 959 960
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
961 962
 * Returns: (transfer none): The structure of the message. The structure is
 * still owned by the message, which means that you should not free it and
963
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
964 965 966 967 968 969 970
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
971

Wim Taymans's avatar
Wim Taymans committed
972 973 974 975 976 977
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
978
 * @tag_list: (out callee-allocates): return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
979 980 981 982
 *
 * 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.
 *
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
 * Typical usage of this function might be:
 * |[
 *   ...
 *   switch (GST_MESSAGE_TYPE (msg)) {
 *     case GST_MESSAGE_TAG: {
 *       GstTagList *tags = NULL;
 *       
 *       gst_message_parse_tag (msg, &amp;tags);
 *       g_print ("Got tags from element %s\n", GST_OBJECT_NAME (msg->src));
 *       handle_tags (tags);
 *       gst_tag_list_free (tags);
 *       break;
 *     }
 *     ...
 *   }
 *   ...
 * ]|
 *
Wim Taymans's avatar
Wim Taymans committed
1001 1002 1003 1004 1005
 * MT safe.
 */
void
gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
{
1006 1007 1008
  GstStructure *ret;

  g_return_if_fail (GST_IS_MESSAGE (message));
1009
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  g_return_if_fail (tag_list != NULL);

  ret = gst_structure_copy (message->structure);
  gst_structure_remove_field (ret, "source-pad");

  *tag_list = (GstTagList *) ret;
}

/**
 * gst_message_parse_tag_full:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
1021 1022 1023
 * @pad: (out callee-allocates): location where the originating pad is stored,
 *     unref after usage
 * @tag_list: (out callee-allocates): return location for the tag-list.
1024 1025 1026 1027 1028
 *
 * Extracts the tag list from the GstMessage. The tag list returned in the
 * output argument is a copy; the caller must free it when done.
 *
 * MT safe.
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
1029 1030
 *
 * Since: 0.10.24
1031 1032 1033 1034 1035 1036 1037
 */
void
gst_message_parse_tag_full (GstMessage * message, GstPad ** pad,
    GstTagList ** tag_list)
{
  GstStructure *ret;

Wim Taymans's avatar
Wim Taymans committed
1038
  g_return_if_fail (GST_IS_MESSAGE (message));
1039
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1040
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
1041

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
  ret = gst_structure_copy (message->structure);

  if (gst_structure_has_field (ret, "source-pad") && pad) {
    const GValue *v;

    v = gst_structure_get_value (ret, "source-pad");
    if (v && G_VALUE_HOLDS (v, GST_TYPE_PAD))
      *pad = g_value_dup_object (v);
    else
      *pad = NULL;
  } else if (pad) {
    *pad = NULL;
  }
  gst_structure_remove_field (ret, "source-pad");

  *tag_list = (GstTagList *) ret;
Wim Taymans's avatar
Wim Taymans committed
1058
}
1059 1060 1061 1062

/**
 * gst_message_parse_buffering:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
1063
 * @percent: (out) (allow-none): Return location for the percent.
1064
 *
Wim Taymans's avatar
Wim Taymans committed
1065 1066
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
1067 1068
 *
 * MT safe.
1069 1070
 *
 * Since: 0.10.11
1071 1072 1073 1074 1075
 */
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
1076
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1077 1078

  if (percent)
1079 1080
    *percent = g_value_get_int (gst_structure_id_get_value (message->structure,
            GST_QUARK (BUFFER_PERCENT)));
1081
}
Wim Taymans's avatar
Wim Taymans committed
1082

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
/**
 * 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)
{
1099
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110

  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.
1111 1112 1113 1114 1115
 * @mode: (out) (allow-none): a buffering mode, or NULL
 * @avg_in: (out) (allow-none): the average input rate, or NULL
 * @avg_out: (out) (allow-none): the average output rate, or NULL
 * @buffering_left: (out) (allow-none): amount of buffering time left in
 *     milliseconds, or NULL
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
 *
 * 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)
{
1126
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142

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