gstmessage.c 67.8 KB
Newer Older
Wim Taymans's avatar
Wim Taymans committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* GStreamer
 * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
 *
 * gstmessage.c: GstMessage subsystem
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
21

22 23
/**
 * SECTION:gstmessage
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
24 25
 * @short_description: Lightweight objects to signal the application of
 *                     pipeline events
26
 * @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 67 68 69 70 71 72 73
typedef struct
{
  GstMessage message;

  GstStructure *structure;
} GstMessageImpl;

#define GST_MESSAGE_STRUCTURE(m) (((GstMessageImpl *)(m))->structure)

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

112 113 114 115 116 117 118 119 120 121
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 */
122
  gst_message_get_type ();
123 124 125 126 127 128 129

  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
130 131 132 133 134 135
/**
 * 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
136
 * Returns: a reference to the static name of the message.
Stefan Kost's avatar
Stefan Kost committed
137
 */
138 139 140 141 142 143 144 145 146 147 148 149
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
150 151 152 153 154 155 156 157
/**
 * 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
 */
158 159 160 161 162 163 164 165 166 167 168 169
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;
}

170 171
GType
gst_message_get_type (void)
172
{
173 174 175 176
  if (G_UNLIKELY (_gst_message_type == 0)) {
    _gst_message_type = gst_mini_object_register ("GstMessage");
  }
  return _gst_message_type;
177
}
Wim Taymans's avatar
Wim Taymans committed
178 179 180


static void
181
_gst_message_free (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
182
{
183 184
  GstStructure *structure;

185
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
186

187
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p", message);
188

189 190 191
  if (GST_MESSAGE_SRC (message)) {
    gst_object_unref (GST_MESSAGE_SRC (message));
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
192 193 194 195 196 197 198 199
  }

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

200 201 202 203
  structure = GST_MESSAGE_STRUCTURE (message);
  if (structure) {
    gst_structure_set_parent_refcount (structure, NULL);
    gst_structure_free (structure);
204
  }
205

Wim Taymans's avatar
Wim Taymans committed
206
  g_slice_free1 (GST_MINI_OBJECT_SIZE (message), message);
Wim Taymans's avatar
Wim Taymans committed
207 208
}

209 210
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
211
{
212 213
  GstMessageImpl *copy;
  GstStructure *structure;
214

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

217
  copy = g_slice_new0 (GstMessageImpl);
218 219

  gst_mini_object_init (GST_MINI_OBJECT_CAST (copy),
220
      _gst_message_type, sizeof (GstMessageImpl));
221

222 223 224 225
  copy->message.mini_object.copy =
      (GstMiniObjectCopyFunction) _gst_message_copy;
  copy->message.mini_object.free =
      (GstMiniObjectFreeFunction) _gst_message_free;
226

227 228
  GST_MESSAGE_TYPE (copy) = GST_MESSAGE_TYPE (message);
  GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
229
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
230 231
  if (GST_MESSAGE_SRC (message)) {
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
232 233
  }

234 235 236 237 238 239
  GST_MESSAGE_GET_LOCK (copy) = GST_MESSAGE_GET_LOCK (message);
  GST_MESSAGE_COND (copy) = GST_MESSAGE_COND (message);

  structure = GST_MESSAGE_STRUCTURE (message);
  if (structure) {
    copy->structure = gst_structure_copy (structure);
240
    gst_structure_set_parent_refcount (copy->structure,
241
        &copy->message.mini_object.refcount);
242 243
  }

244
  return GST_MESSAGE_CAST (copy);
Wim Taymans's avatar
Wim Taymans committed
245 246
}

Wim Taymans's avatar
Wim Taymans committed
247 248 249 250
/**
 * gst_message_new_custom:
 * @type: The #GstMessageType to distinguish messages
 * @src: The object originating the message.
251 252
 * @structure: (transfer full): the structure for the message. The message
 *     will take ownership of the structure.
Wim Taymans's avatar
Wim Taymans committed
253 254 255 256 257
 *
 * 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.
 *
258
 * Returns: (transfer full): The new message.
Wim Taymans's avatar
Wim Taymans committed
259 260 261 262 263 264
 *
 * MT safe.
 */
GstMessage *
gst_message_new_custom (GstMessageType type, GstObject * src,
    GstStructure * structure)
Wim Taymans's avatar
Wim Taymans committed
265
{
266
  GstMessageImpl *message;
Wim Taymans's avatar
Wim Taymans committed
267

268
  message = g_slice_new0 (GstMessageImpl);
269 270

  gst_mini_object_init (GST_MINI_OBJECT_CAST (message),
271
      _gst_message_type, sizeof (GstMessageImpl));
272

273 274 275 276
  message->message.mini_object.copy =
      (GstMiniObjectCopyFunction) _gst_message_copy;
  message->message.mini_object.free =
      (GstMiniObjectFreeFunction) _gst_message_free;
Wim Taymans's avatar
Wim Taymans committed
277

278 279
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
280
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
281

282
  GST_MESSAGE_TYPE (message) = type;
283 284
  if (src)
    gst_object_ref (src);
285 286 287
  GST_MESSAGE_SRC (message) = src;
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();
288

Wim Taymans's avatar
Wim Taymans committed
289 290
  if (structure) {
    gst_structure_set_parent_refcount (structure,
291
        &message->message.mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
292 293
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
294

295
  return GST_MESSAGE_CAST (message);
Wim Taymans's avatar
Wim Taymans committed
296 297
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
/**
 * 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.
318 319
 *
 * Since: 0.10.22
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
 */
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.
341 342
 *
 * Since: 0.10.22
343 344 345 346 347 348 349 350 351
 */
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
352 353
/**
 * gst_message_new_eos:
354
 * @src: (transfer none): The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
355
 *
356 357 358
 * 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
359
 *
360
 * Returns: (transfer full): The new eos message.
Wim Taymans's avatar
Wim Taymans committed
361 362 363 364 365 366 367 368
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
369
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
370 371 372 373 374 375

  return message;
}

/**
 * gst_message_new_error:
376 377
 * @src: (transfer none): The object originating the message.
 * @error: (transfer none): The GError for this message.
378
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
379
 *
380
 * Create a new error message. The message will copy @error and
381
 * @debug. This message is posted by element when a fatal event
382 383
 * occured. The pipeline will probably (partially) stop. The application
 * receiving this message should stop the pipeline.
Wim Taymans's avatar
Wim Taymans committed
384
 *
385
 * Returns: (transfer full): the new error message.
Wim Taymans's avatar
Wim Taymans committed
386 387 388 389
 *
 * MT safe.
 */
GstMessage *
390
gst_message_new_error (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
391 392
{
  GstMessage *message;
393
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
394

395
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ERROR),
396 397 398
      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
399 400 401 402 403 404

  return message;
}

/**
 * gst_message_new_warning:
405 406
 * @src: (transfer none): The object originating the message.
 * @error: (transfer none): The GError for this message.
407
 * @debug: A debugging string.
Wim Taymans's avatar
Wim Taymans committed
408
 *
409
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
410 411
 * @debug.
 *
412
 * Returns: (transfer full): The new warning message.
Wim Taymans's avatar
Wim Taymans committed
413 414 415 416
 *
 * MT safe.
 */
GstMessage *
417
gst_message_new_warning (GstObject * src, GError * error, const gchar * debug)
Wim Taymans's avatar
Wim Taymans committed
418 419
{
  GstMessage *message;
420
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
421

422
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_WARNING),
423 424 425
      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
426 427 428 429

  return message;
}

430 431
/**
 * gst_message_new_info:
432 433
 * @src: (transfer none): The object originating the message.
 * @error: (transfer none): The GError for this message.
434
 * @debug: A debugging string.
435 436 437 438 439
 *
 * Create a new info message. The message will make copies of @error and
 * @debug.
 *
 * MT safe.
440
 *
441
 * Returns: (transfer full): the new info message.
Stefan Kost's avatar
Stefan Kost committed
442
 *
443
 * Since: 0.10.12
444 445
 */
GstMessage *
446
gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
447 448
{
  GstMessage *message;
449
  GstStructure *structure;
450

451 452 453
  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);
454
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
455 456 457 458

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
459 460
/**
 * gst_message_new_tag:
461 462
 * @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
463 464
 *
 * Create a new tag message. The message will take ownership of the tag list.
465
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
466
 *
467
 * Returns: (transfer full): the new tag message.
Wim Taymans's avatar
Wim Taymans committed
468 469 470 471 472 473 474 475
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

476 477
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
478 479
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
480 481 482 483

  return message;
}

484 485
/**
 * gst_message_new_tag_full:
486 487 488
 * @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.
489 490 491 492
 *
 * 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
493 494
 * MT safe.
 *
495
 * Returns: (transfer full): the new tag message.
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
 *
 * 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;
}

517 518
/**
 * gst_message_new_buffering:
519
 * @src: (transfer none): The object originating the message.
520 521 522 523 524 525
 * @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
526 527 528 529 530 531 532
 * 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. 
 *
533
 * MT safe.
534
 *
535
 * Returns: (transfer full): The new buffering message.
Stefan Kost's avatar
Stefan Kost committed
536
 *
537
 * Since: 0.10.11
538 539 540 541 542
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;
543
  GstStructure *structure;
544 545 546

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

547
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_BUFFERING),
548 549 550 551
      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,
552 553
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
      GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
554
  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
555 556 557 558

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
559
/**
Stefan Kost's avatar
Stefan Kost committed
560
 * gst_message_new_state_changed:
561
 * @src: (transfer none): the object originating the message
562 563 564
 * @oldstate: the previous state
 * @newstate: the new (current) state
 * @pending: the pending (target) state
Wim Taymans's avatar
Wim Taymans committed
565
 *
566 567
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
568
 *
569
 * Returns: (transfer full): the new state change message.
Wim Taymans's avatar
Wim Taymans committed
570 571 572 573
 *
 * MT safe.
 */
GstMessage *
574
gst_message_new_state_changed (GstObject * src,
575
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
576 577
{
  GstMessage *message;
578
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
579

580
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STATE),
581 582 583 584
      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
585 586 587 588

  return message;
}

589 590
/**
 * gst_message_new_state_dirty:
591
 * @src: (transfer none): the object originating the message
592 593 594 595 596
 *
 * 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.
 *
597
 * Returns: (transfer full): the new state dirty message.
598 599 600 601 602 603 604 605 606 607 608 609 610
 *
 * 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
611 612
/**
 * gst_message_new_clock_provide:
613 614
 * @src: (transfer none): the object originating the message.
 * @clock: (transfer none): the clock it provides
Wim Taymans's avatar
Wim Taymans committed
615 616
 * @ready: TRUE if the sender can provide a clock
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
617
 * Create a clock provide message. This message is posted whenever an
Wim Taymans's avatar
Wim Taymans committed
618 619 620
 * 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
621
 * This message is mainly used internally to manage the clock
Wim Taymans's avatar
Wim Taymans committed
622 623
 * selection.
 *
624
 * Returns: (transfer full): the new provide clock message.
Wim Taymans's avatar
Wim Taymans committed
625 626 627 628
 *
 * MT safe.
 */
GstMessage *
629 630
gst_message_new_clock_provide (GstObject * src, GstClock * clock,
    gboolean ready)
Wim Taymans's avatar
Wim Taymans committed
631 632
{
  GstMessage *message;
633
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
634

635
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_PROVIDE),
636 637 638
      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);
639

Wim Taymans's avatar
Wim Taymans committed
640 641 642
  return message;
}

643 644
/**
 * gst_message_new_clock_lost:
645 646
 * @src: (transfer none): the object originating the message.
 * @clock: (transfer none): the clock that was lost
647 648 649 650 651 652 653 654
 *
 * 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.
 *
655
 * Returns: (transfer full): The new clock lost message.
656 657 658 659 660 661 662
 *
 * MT safe.
 */
GstMessage *
gst_message_new_clock_lost (GstObject * src, GstClock * clock)
{
  GstMessage *message;
663
  GstStructure *structure;
664

665
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_LOST),
666 667
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
668 669 670 671

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
672 673
/**
 * gst_message_new_new_clock:
674 675
 * @src: (transfer none): The object originating the message.
 * @clock: (transfer none): the new selected clock
Wim Taymans's avatar
Wim Taymans committed
676 677 678 679
 *
 * Create a new clock message. This message is posted whenever the
 * pipeline selectes a new clock for the pipeline.
 *
680
 * Returns: (transfer full): The new new clock message.
Wim Taymans's avatar
Wim Taymans committed
681 682 683 684 685 686 687
 *
 * MT safe.
 */
GstMessage *
gst_message_new_new_clock (GstObject * src, GstClock * clock)
{
  GstMessage *message;
688
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
689

690
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_NEW_CLOCK),
691 692
      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
693 694 695 696

  return message;
}

697 698
/**
 * gst_message_new_structure_change:
699
 * @src: (transfer none): The object originating the message.
700
 * @type: The change type.
701
 * @owner: (transfer none): The owner element of @src.
702 703 704 705 706 707
 * @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.
 *
708
 * @src should be the sinkpad that unlinked or linked.
709
 *
710
 * Returns: (transfer full): the new structure change message.
711 712 713 714 715 716 717 718 719 720 721 722 723
 *
 * 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
724
  /* g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SINK, NULL); */
725 726
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

727
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STRUCTURE_CHANGE),
728 729 730 731 732 733 734 735 736 737
      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
738
/**
739
 * gst_message_new_segment_start:
740
 * @src: (transfer none): The object originating the message.
741 742
 * @format: The format of the position being played
 * @position: The position of the segment being played
743 744 745 746 747 748
 *
 * 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.
 *
749
 * Returns: (transfer full): the new segment start message.
750 751 752 753
 *
 * MT safe.
 */
GstMessage *
754 755
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
756 757
{
  GstMessage *message;
758
  GstStructure *structure;
759

760
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_START),
761 762 763
      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);
764 765 766 767 768 769

  return message;
}

/**
 * gst_message_new_segment_done:
770
 * @src: (transfer none): the object originating the message.
771 772
 * @format: The format of the position being done
 * @position: The position of the segment being done
773 774 775 776 777 778
 *
 * 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.
 *
779
 * Returns: (transfer full): the new segment done message.
780 781 782 783
 *
 * MT safe.
 */
GstMessage *
784 785
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
786 787
{
  GstMessage *message;
788
  GstStructure *structure;
789

790
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_DONE),
791 792 793
      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);
794 795 796 797

  return message;
}

798 799
/**
 * gst_message_new_application:
800 801 802
 * @src: (transfer none): the object originating the message.
 * @structure: (transfer full): the structure for the message. The message
 *     will take ownership of the structure.
803 804 805 806
 *
 * Create a new application-typed message. GStreamer will never create these
 * messages; they are a gift from us to you. Enjoy.
 *
807
 * Returns: (transfer full): The new application message.
Stefan Kost's avatar
Stefan Kost committed
808
 *
809 810 811 812 813 814 815 816 817 818
 * 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:
819 820 821
 * @src: (transfer none): The object originating the message.
 * @structure: (transfer full): The structure for the message. The message
 *     will take ownership of the structure.
822 823 824 825 826 827
 *
 * 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.
 *
828
 * Returns: (transfer full): The new element message.
Stefan Kost's avatar
Stefan Kost committed
829
 *
830 831 832 833 834 835 836 837
 * MT safe.
 */
GstMessage *
gst_message_new_element (GstObject * src, GstStructure * structure)
{
  return gst_message_new_custom (GST_MESSAGE_ELEMENT, src, structure);
}

838 839
/**
 * gst_message_new_duration:
840
 * @src: (transfer none): The object originating the message.
841 842 843 844 845 846
 * @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
847 848 849 850
 * 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.
851
 *
852
 * Returns: (transfer full): The new duration message.
853 854 855 856 857 858 859
 *
 * MT safe.
 */
GstMessage *
gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
{
  GstMessage *message;
860
  GstStructure *structure;
861

862
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_DURATION),
863 864 865
      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);
866 867 868 869

  return message;
}

870 871
/**
 * gst_message_new_async_start:
872
 * @src: (transfer none): The object originating the message.
873 874 875 876 877 878
 * @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.
 *
879
 * Returns: (transfer full): The new async_start message.
880 881 882 883 884 885 886 887 888
 *
 * MT safe.
 *
 * Since: 0.10.13
 */
GstMessage *
gst_message_new_async_start (GstObject * src, gboolean new_base_time)
{
  GstMessage *message;
889
  GstStructure *structure;
890

891
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ASYNC_START),
892 893
      GST_QUARK (NEW_BASE_TIME), G_TYPE_BOOLEAN, new_base_time, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, structure);
894 895 896 897 898 899

  return message;
}

/**
 * gst_message_new_async_done:
900
 * @src: (transfer none): The object originating the message.
901
 *
Stefan Kost's avatar
Stefan Kost committed
902 903
 * The message is posted when elements completed an ASYNC state change.
 *
904
 * Returns: (transfer full): The new async_done message.
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
 *
 * 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;
}

920 921
/**
 * gst_message_new_latency:
922
 * @src: (transfer none): The object originating the message.
923 924 925 926
 *
 * This message can be posted by elements when their latency requirements have
 * changed.
 *
927
 * Returns: (transfer full): The new latency message.
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
 *
 * 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;
}

943 944
/**
 * gst_message_new_request_state:
945
 * @src: (transfer none): the object originating the message.
946 947 948 949 950 951
 * @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.
 *
952
 * Returns: (transfer full): the new requst state message.
953 954 955 956 957 958 959 960 961 962 963
 *
 * MT safe.
 *
 * Since: 0.10.23
 */
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
{
  GstMessage *message;
  GstStructure *structure;

964
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_REQUEST_STATE),
965 966 967 968 969 970
      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
971 972 973 974 975 976
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
977 978
 * 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
979
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
980 981 982 983 984 985 986
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
987

988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  return GST_MESSAGE_STRUCTURE (message);
}

/**
 * gst_message_has_name:
 * @message: The #GstMessage.
 * @name: name to check
 *
 * Checks if @message has the given @name. This function is usually used to
 * check the name of a custom message.
 *
 * Returns: %TRUE if @name matches the name of the message structure.
 *
 * Since: 0.10.20
 */
gboolean
gst_message_has_name (GstMessage * message, const gchar * name)
{
  GstStructure *structure;

  g_return_val_if_fail (GST_IS_MESSAGE (message), FALSE);

  structure = GST_MESSAGE_STRUCTURE (message);
  if (structure == NULL)
    return FALSE;

  return gst_structure_has_name (structure, name);
Wim Taymans's avatar
Wim Taymans committed
1015 1016 1017 1018 1019
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
1020
 * @tag_list: (out callee-allocates): return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
1021 1022 1023 1024
 *
 * 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.
 *
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
 * 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
1043 1044 1045 1046 1047
 * MT safe.
 */
void
gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
{
1048 1049 1050
  GstStructure *ret;

  g_return_if_fail (GST_IS_MESSAGE (message));
1051
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1052 1053
  g_return_if_fail (tag_list != NULL);

1054
  ret = gst_structure_copy (GST_MESSAGE_STRUCTURE (message));
1055 1056 1057 1058 1059 1060 1061 1062
  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.
1063 1064 1065
 * @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.
1066 1067 1068 1069 1070
 *
 * 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
1071 1072
 *
 * Since: 0.10.24
1073 1074 1075 1076 1077 1078 1079
 */
void
gst_message_parse_tag_full (GstMessage * message, GstPad ** pad,
    GstTagList ** tag_list)
{
  GstStructure *ret;

Wim Taymans's avatar
Wim Taymans committed
1080
  g_return_if_fail (GST_IS_MESSAGE (message));
1081
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1082
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
1083

1084
  ret = gst_structure_copy (GST_MESSAGE_STRUCTURE (message));
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099

  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
1100
}
1101 1102 1103 1104

/**
 * gst_message_parse_buffering:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
1105
 * @percent: (out) (allow-none): Return location for the percent.
1106
 *
Wim Taymans's avatar
Wim Taymans committed
1107 1108
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
1109 1110
 *
 * MT safe.
1111 1112
 *
 * Since: 0.10.11
1113 1114 1115 1116 1117
 */
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
1118
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);