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

22 23
/**
 * SECTION:gstmessage
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
24 25
 * @short_description: Lightweight objects to signal the application of
 *                     pipeline events
26
 * @see_also: #GstBus, #GstMiniObject, #GstElement
27
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
28
 * Messages are implemented as a subclass of #GstMiniObject with a generic
29 30 31 32
 * #GstStructure as the content. This allows for writing custom messages without
 * requiring an API change while allowing a wide range of different types
 * of messages.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
33 34
 * Messages are posted by objects in the pipeline and are passed to the
 * application using the #GstBus.
35 36 37 38 39 40 41 42 43 44 45 46 47 48

 * The basic use pattern of posting a message on a #GstBus is as follows:
 *
 * <example>
 * <title>Posting a #GstMessage</title>
 *   <programlisting>
 *    gst_bus_post (bus, gst_message_new_eos());
 *   </programlisting>
 * </example>
 *
 * A #GstElement usually posts messages on the bus provided by the parent
 * container using gst_element_post_message().
 *
 * Last reviewed on 2005-11-09 (0.9.4)
49
 */
Wim Taymans's avatar
Wim Taymans committed
50 51 52


#include "gst_private.h"
53
#include <string.h>             /* memcpy */
54
#include "gsterror.h"
55
#include "gstenumtypes.h"
Wim Taymans's avatar
Wim Taymans committed
56 57
#include "gstinfo.h"
#include "gstmessage.h"
58
#include "gsttaglist.h"
59
#include "gstutils.h"
60
#include "gstquark.h"
Wim Taymans's avatar
Wim Taymans committed
61 62


63 64
#define GST_MESSAGE_SEQNUM(e) ((GstMessage*)e)->abidata.ABI.seqnum

65 66
static void gst_message_finalize (GstMessage * message);
static GstMessage *_gst_message_copy (GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
67

68 69
static GstMiniObjectClass *parent_class = NULL;

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

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

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

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

158 159 160 161 162 163 164 165
#define _do_init \
{ \
  gint i; \
  \
  for (i = 0; message_quarks[i].name; i++) { \
    message_quarks[i].quark = \
        g_quark_from_static_string (message_quarks[i].name); \
  } \
166
}
Wim Taymans's avatar
Wim Taymans committed
167

168 169 170
G_DEFINE_TYPE_WITH_CODE (GstMessage, gst_message, GST_TYPE_MINI_OBJECT,
    _do_init);

171
static void
172
gst_message_class_init (GstMessageClass * klass)
173
{
174
  parent_class = g_type_class_peek_parent (klass);
Wim Taymans's avatar
Wim Taymans committed
175

176 177
  klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_message_copy;
  klass->mini_object_class.finalize =
178 179
      (GstMiniObjectFinalizeFunction) gst_message_finalize;
}
Wim Taymans's avatar
Wim Taymans committed
180

181
static void
182
gst_message_init (GstMessage * message)
183
{
184
  GST_CAT_LOG (GST_CAT_MESSAGE, "new message %p", message);
185
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
186 187 188
}

static void
189
gst_message_finalize (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
190
{
191
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
192

193
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p", message);
194

195 196 197
  if (GST_MESSAGE_SRC (message)) {
    gst_object_unref (GST_MESSAGE_SRC (message));
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
198 199 200 201 202 203 204 205
  }

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

206 207
  if (message->structure) {
    gst_structure_set_parent_refcount (message->structure, NULL);
Wim Taymans's avatar
Wim Taymans committed
208
    gst_structure_free (message->structure);
209
  }
210

211
/*   GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (message)); */
Wim Taymans's avatar
Wim Taymans committed
212 213
}

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

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

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
226 227
  GST_MESSAGE_GET_LOCK (copy) = GST_MESSAGE_GET_LOCK (message);
  GST_MESSAGE_COND (copy) = GST_MESSAGE_COND (message);
228 229
  GST_MESSAGE_TYPE (copy) = GST_MESSAGE_TYPE (message);
  GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
230
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
231

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

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

  return copy;
Wim Taymans's avatar
Wim Taymans committed
243 244
}

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

266
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
267

268 269
  GST_CAT_LOG (GST_CAT_MESSAGE, "source %s: creating new message %p %s",
      (src ? GST_OBJECT_NAME (src) : "NULL"), message,
270
      gst_message_type_get_name (type));
Wim Taymans's avatar
Wim Taymans committed
271

272
  message->type = type;
273 274 275 276 277

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

Wim Taymans's avatar
Wim Taymans committed
278 279 280 281 282
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
  }
  message->structure = structure;
Wim Taymans's avatar
Wim Taymans committed
283

284 285
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();

Wim Taymans's avatar
Wim Taymans committed
286 287 288
  return message;
}

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

Wim Taymans's avatar
Wim Taymans committed
360
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
361 362 363 364 365 366

  return message;
}

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

386
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ERROR),
387 388 389
      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
390 391 392 393 394 395

  return message;
}

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

413
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_WARNING),
414 415 416
      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
417 418 419 420

  return message;
}

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

442 443 444
  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);
445
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
446 447 448 449

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
450 451
/**
 * gst_message_new_tag:
452 453
 * @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
454 455
 *
 * Create a new tag message. The message will take ownership of the tag list.
456
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
457
 *
458
 * Returns: (transfer full): the new tag message.
Wim Taymans's avatar
Wim Taymans committed
459 460 461 462 463 464 465 466
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

467 468
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
469 470
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
471 472 473 474

  return message;
}

475 476
/**
 * gst_message_new_tag_full:
477 478 479
 * @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.
480 481 482 483
 *
 * 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
484 485
 * MT safe.
 *
486
 * Returns: (transfer full): the new tag message.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
 *
 * 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;
}

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

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

538
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_BUFFERING),
539 540 541 542
      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,
543 544
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
      GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
545
  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
546 547 548 549

  return message;
}

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

571
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_STATE),
572 573 574 575
      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
576 577 578 579

  return message;
}

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

626
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_PROVIDE),
627 628 629
      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);
630

Wim Taymans's avatar
Wim Taymans committed
631 632 633
  return message;
}

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

656
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_CLOCK_LOST),
657 658
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
659 660 661 662

  return message;
}

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

681
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_NEW_CLOCK),
682 683
      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
684 685 686 687

  return message;
}

688 689
/**
 * gst_message_new_structure_change:
690
 * @src: (transfer none): The object originating the message.
691
 * @type: The change type.
692
 * @owner: (transfer none): The owner element of @src.
693 694 695 696 697 698
 * @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.
 *
699
 * @src should be the sinkpad that unlinked or linked.
700
 *
701
 * Returns: (transfer full): the new structure change message.
702 703 704 705 706 707 708 709 710 711 712 713 714
 *
 * 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
715
  /* g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SINK, NULL); */
716 717
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

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

751
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_START),
752 753 754
      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);
755 756 757 758 759 760

  return message;
}

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

781
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_SEGMENT_DONE),
782 783 784
      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);
785 786 787 788

  return message;
}

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

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

853
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_DURATION),
854 855 856
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
  message = gst_message_new_custom (GST_MESSAGE_DURATION, src, structure);
857 858 859 860

  return message;
}

861 862
/**
 * gst_message_new_async_start:
863
 * @src: (transfer none): The object originating the message.
864 865 866 867 868 869
 * @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.
 *
870
 * Returns: (transfer full): The new async_start message.
871 872 873 874 875 876 877 878 879
 *
 * MT safe.
 *
 * Since: 0.10.13
 */
GstMessage *
gst_message_new_async_start (GstObject * src, gboolean new_base_time)
{
  GstMessage *message;
880
  GstStructure *structure;
881

882
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_ASYNC_START),
883 884
      GST_QUARK (NEW_BASE_TIME), G_TYPE_BOOLEAN, new_base_time, NULL);
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, structure);
885 886 887 888 889 890

  return message;
}

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

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

934 935
/**
 * gst_message_new_request_state:
936
 * @src: (transfer none): the object originating the message.
937 938 939 940 941 942
 * @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.
 *
943
 * Returns: (transfer full): the new requst state message.
944 945 946 947 948 949 950 951 952 953 954
 *
 * MT safe.
 *
 * Since: 0.10.23
 */
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
{
  GstMessage *message;
  GstStructure *structure;

955
  structure = gst_structure_id_new (GST_QUARK (MESSAGE_REQUEST_STATE),
956 957 958 959 960 961
      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
962 963 964 965 966 967
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
968 969
 * 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
970
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
971 972 973 974 975 976 977
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
978

Wim Taymans's avatar
Wim Taymans committed
979 980 981 982 983 984
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
985
 * @tag_list: (out callee-allocates): return location for the tag-list.
Wim Taymans's avatar
Wim Taymans committed
986 987 988 989
 *
 * 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.
 *
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
 * 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
1008 1009 1010 1011 1012
 * MT safe.
 */
void
gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
{
1013 1014 1015
  GstStructure *ret;

  g_return_if_fail (GST_IS_MESSAGE (message));
1016
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
  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.
1028 1029 1030
 * @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.
1031 1032 1033 1034 1035
 *
 * 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
1036 1037
 *
 * Since: 0.10.24
1038 1039 1040 1041 1042 1043 1044
 */
void
gst_message_parse_tag_full (GstMessage * message, GstPad ** pad,
    GstTagList ** tag_list)
{
  GstStructure *ret;

Wim Taymans's avatar
Wim Taymans committed
1045
  g_return_if_fail (GST_IS_MESSAGE (message));
1046
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1047
  g_return_if_fail (tag_list != NULL);
Wim Taymans's avatar
Wim Taymans committed
1048

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
  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
1065
}
1066 1067 1068 1069

/**
 * gst_message_parse_buffering:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
1070
 * @percent: (out) (allow-none): Return location for the percent.
1071
 *
Wim Taymans's avatar
Wim Taymans committed
1072 1073
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().