gstmessage.c 66.1 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.
Wim Taymans's avatar
Wim Taymans committed
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 65 66 67 68 69 70 71
typedef struct
{
  GstMessage message;

  GstStructure *structure;
} GstMessageImpl;

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

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

Wim Taymans's avatar
Wim Taymans committed
110
static GType _gst_message_type = 0;
111
GST_DEFINE_MINI_OBJECT_TYPE (GstMessage, gst_message);
Wim Taymans's avatar
Wim Taymans committed
112

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

  for (i = 0; message_quarks[i].name; i++) {
    message_quarks[i].quark =
        g_quark_from_static_string (message_quarks[i].name);
  }
Wim Taymans's avatar
Wim Taymans committed
129 130

  _gst_message_type = gst_message_get_type ();
131 132
}

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

Wim Taymans's avatar
Wim Taymans committed
173
static void
174
_gst_message_free (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
175
{
176 177
  GstStructure *structure;

178
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
179

180
  GST_CAT_LOG (GST_CAT_MESSAGE, "finalize message %p, %s from %s", message,
181
      GST_MESSAGE_TYPE_NAME (message), GST_MESSAGE_SRC_NAME (message));
182

183 184 185
  if (GST_MESSAGE_SRC (message)) {
    gst_object_unref (GST_MESSAGE_SRC (message));
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
186 187
  }

Wim Taymans's avatar
Wim Taymans committed
188
  if (message->lock.p) {
Wim Taymans's avatar
Wim Taymans committed
189 190 191 192 193
    GST_MESSAGE_LOCK (message);
    GST_MESSAGE_SIGNAL (message);
    GST_MESSAGE_UNLOCK (message);
  }

194 195 196 197
  structure = GST_MESSAGE_STRUCTURE (message);
  if (structure) {
    gst_structure_set_parent_refcount (structure, NULL);
    gst_structure_free (structure);
198
  }
199

Wim Taymans's avatar
Wim Taymans committed
200
  g_slice_free1 (GST_MINI_OBJECT_SIZE (message), message);
Wim Taymans's avatar
Wim Taymans committed
201 202
}

Wim Taymans's avatar
Wim Taymans committed
203 204 205 206
static void
gst_message_init (GstMessageImpl * message, gsize size, GstMessageType type,
    GstObject * src);

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

213 214 215
  GST_CAT_LOG (GST_CAT_MESSAGE, "copy message %p, %s from %s", message,
      GST_MESSAGE_TYPE_NAME (message),
      GST_OBJECT_NAME (GST_MESSAGE_SRC (message)));
216

217
  copy = g_slice_new0 (GstMessageImpl);
218

Wim Taymans's avatar
Wim Taymans committed
219 220
  gst_message_init (copy, sizeof (GstMessageImpl), GST_MESSAGE_TYPE (message),
      GST_MESSAGE_SRC (message));
221

222
  GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
223
  GST_MESSAGE_SEQNUM (copy) = GST_MESSAGE_SEQNUM (message);
224

225 226
  structure = GST_MESSAGE_STRUCTURE (message);
  if (structure) {
Wim Taymans's avatar
Wim Taymans committed
227 228
    GST_MESSAGE_STRUCTURE (copy) = gst_structure_copy (structure);
    gst_structure_set_parent_refcount (GST_MESSAGE_STRUCTURE (copy),
229
        &copy->message.mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
230 231
  } else {
    GST_MESSAGE_STRUCTURE (copy) = NULL;
232 233
  }

234
  return GST_MESSAGE_CAST (copy);
Wim Taymans's avatar
Wim Taymans committed
235 236
}

Wim Taymans's avatar
Wim Taymans committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
static void
gst_message_init (GstMessageImpl * message, gsize size, GstMessageType type,
    GstObject * src)
{
  gst_mini_object_init (GST_MINI_OBJECT_CAST (message), _gst_message_type,
      size);

  message->message.mini_object.copy =
      (GstMiniObjectCopyFunction) _gst_message_copy;
  message->message.mini_object.free =
      (GstMiniObjectFreeFunction) _gst_message_free;

  GST_MESSAGE_TYPE (message) = type;
  if (src)
    gst_object_ref (src);
  GST_MESSAGE_SRC (message) = src;
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
  GST_MESSAGE_SEQNUM (message) = gst_util_seqnum_next ();
}


Wim Taymans's avatar
Wim Taymans committed
258 259 260 261
/**
 * gst_message_new_custom:
 * @type: The #GstMessageType to distinguish messages
 * @src: The object originating the message.
262 263
 * @structure: (transfer full): the structure for the message. The message
 *     will take ownership of the structure.
Wim Taymans's avatar
Wim Taymans committed
264 265 266 267 268
 *
 * 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.
 *
269
 * Returns: (transfer full): The new message.
Wim Taymans's avatar
Wim Taymans committed
270 271 272 273 274 275
 *
 * MT safe.
 */
GstMessage *
gst_message_new_custom (GstMessageType type, GstObject * src,
    GstStructure * structure)
Wim Taymans's avatar
Wim Taymans committed
276
{
277
  GstMessageImpl *message;
Wim Taymans's avatar
Wim Taymans committed
278

279
  message = g_slice_new0 (GstMessageImpl);
280

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

Wim Taymans's avatar
Wim Taymans committed
285
  if (structure) {
Wim Taymans's avatar
Wim Taymans committed
286 287 288 289
    /* structure must not have a parent */
    if (!gst_structure_set_parent_refcount (structure,
            &message->message.mini_object.refcount))
      goto had_parent;
Wim Taymans's avatar
Wim Taymans committed
290
  }
Wim Taymans's avatar
Wim Taymans committed
291 292 293
  gst_message_init (message, sizeof (GstMessageImpl), type, src);

  GST_MESSAGE_STRUCTURE (message) = 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

  /* ERRORS */
had_parent:
  {
    g_slice_free1 (GST_MINI_OBJECT_SIZE (message), message);
    g_warning ("structure is already owned by another object");
    return NULL;
  }
Wim Taymans's avatar
Wim Taymans committed
304 305
}

306 307 308 309 310 311 312 313 314 315 316 317 318 319
/**
 * 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;
320
 * two events or messages will never have the same sequence number unless
321 322 323 324 325
 * that correspondence was made explicitly.
 *
 * Returns: The message's sequence number.
 *
 * MT safe.
326 327
 *
 * Since: 0.10.22
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
 */
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.
349 350
 *
 * Since: 0.10.22
351 352 353 354 355 356 357 358 359
 */
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
360 361
/**
 * gst_message_new_eos:
362
 * @src: (transfer none): The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
363
 *
364 365 366
 * 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
367
 *
368
 * Returns: (transfer full): The new eos message.
Wim Taymans's avatar
Wim Taymans committed
369 370 371 372 373 374 375 376
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

Wim Taymans's avatar
Wim Taymans committed
377
  message = gst_message_new_custom (GST_MESSAGE_EOS, src, NULL);
Wim Taymans's avatar
Wim Taymans committed
378 379 380 381 382 383

  return message;
}

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

Wim Taymans's avatar
Wim Taymans committed
403
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_ERROR),
404
      GST_QUARK (GERROR), G_TYPE_ERROR, error,
405 406
      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
407 408 409 410 411 412

  return message;
}

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

Wim Taymans's avatar
Wim Taymans committed
430
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_WARNING),
431
      GST_QUARK (GERROR), G_TYPE_ERROR, error,
432 433
      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
434 435 436 437

  return message;
}

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

Wim Taymans's avatar
Wim Taymans committed
459
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_INFO),
460
      GST_QUARK (GERROR), G_TYPE_ERROR, error,
461
      GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
462
  message = gst_message_new_custom (GST_MESSAGE_INFO, src, structure);
463 464 465 466

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
467 468
/**
 * gst_message_new_tag:
469 470
 * @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
471 472
 *
 * Create a new tag message. The message will take ownership of the tag list.
473
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
474
 *
475
 * Returns: (transfer full): the new tag message.
Wim Taymans's avatar
Wim Taymans committed
476 477 478 479 480 481 482 483
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

484 485
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
486 487
  message =
      gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
Wim Taymans's avatar
Wim Taymans committed
488 489 490 491

  return message;
}

492 493
/**
 * gst_message_new_buffering:
494
 * @src: (transfer none): The object originating the message.
495 496 497 498 499 500
 * @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
501 502 503 504 505 506 507
 * 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. 
 *
508
 * MT safe.
509
 *
510
 * Returns: (transfer full): The new buffering message.
Stefan Kost's avatar
Stefan Kost committed
511
 *
512
 * Since: 0.10.11
513 514 515 516 517
 */
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
  GstMessage *message;
518
  GstStructure *structure;
519 520 521

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

Wim Taymans's avatar
Wim Taymans committed
522
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_BUFFERING),
523 524 525 526
      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,
527 528
      GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
      GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
529
  message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
530 531 532 533

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
534
/**
Stefan Kost's avatar
Stefan Kost committed
535
 * gst_message_new_state_changed:
536
 * @src: (transfer none): the object originating the message
537 538 539
 * @oldstate: the previous state
 * @newstate: the new (current) state
 * @pending: the pending (target) state
Wim Taymans's avatar
Wim Taymans committed
540
 *
541 542
 * Create a state change message. This message is posted whenever an element
 * changed its state.
Wim Taymans's avatar
Wim Taymans committed
543
 *
544
 * Returns: (transfer full): the new state change message.
Wim Taymans's avatar
Wim Taymans committed
545 546 547 548
 *
 * MT safe.
 */
GstMessage *
549
gst_message_new_state_changed (GstObject * src,
550
    GstState oldstate, GstState newstate, GstState pending)
Wim Taymans's avatar
Wim Taymans committed
551 552
{
  GstMessage *message;
553
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
554

Wim Taymans's avatar
Wim Taymans committed
555
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_STATE),
556 557 558 559
      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
560 561 562 563

  return message;
}

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

Wim Taymans's avatar
Wim Taymans committed
610
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_CLOCK_PROVIDE),
611 612 613
      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);
614

Wim Taymans's avatar
Wim Taymans committed
615 616 617
  return message;
}

618 619
/**
 * gst_message_new_clock_lost:
620 621
 * @src: (transfer none): the object originating the message.
 * @clock: (transfer none): the clock that was lost
622 623 624 625 626 627 628 629
 *
 * 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.
 *
630
 * Returns: (transfer full): The new clock lost message.
631 632 633 634 635 636 637
 *
 * MT safe.
 */
GstMessage *
gst_message_new_clock_lost (GstObject * src, GstClock * clock)
{
  GstMessage *message;
638
  GstStructure *structure;
639

Wim Taymans's avatar
Wim Taymans committed
640
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_CLOCK_LOST),
641 642
      GST_QUARK (CLOCK), GST_TYPE_CLOCK, clock, NULL);
  message = gst_message_new_custom (GST_MESSAGE_CLOCK_LOST, src, structure);
643 644 645 646

  return message;
}

Wim Taymans's avatar
Wim Taymans committed
647 648
/**
 * gst_message_new_new_clock:
649 650
 * @src: (transfer none): The object originating the message.
 * @clock: (transfer none): the new selected clock
Wim Taymans's avatar
Wim Taymans committed
651 652 653 654
 *
 * Create a new clock message. This message is posted whenever the
 * pipeline selectes a new clock for the pipeline.
 *
655
 * Returns: (transfer full): The new new clock message.
Wim Taymans's avatar
Wim Taymans committed
656 657 658 659 660 661 662
 *
 * MT safe.
 */
GstMessage *
gst_message_new_new_clock (GstObject * src, GstClock * clock)
{
  GstMessage *message;
663
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
664

Wim Taymans's avatar
Wim Taymans committed
665
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_NEW_CLOCK),
666 667
      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
668 669 670 671

  return message;
}

672 673
/**
 * gst_message_new_structure_change:
674
 * @src: (transfer none): The object originating the message.
675
 * @type: The change type.
676
 * @owner: (transfer none): The owner element of @src.
677 678 679 680 681 682
 * @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.
 *
683
 * @src should be the sinkpad that unlinked or linked.
684
 *
685
 * Returns: (transfer full): the new structure change message.
686 687 688 689 690 691 692 693 694 695 696 697 698
 *
 * 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
699
  /* g_return_val_if_fail (GST_PAD_DIRECTION (src) == GST_PAD_SINK, NULL); */
700 701
  g_return_val_if_fail (GST_IS_ELEMENT (owner), NULL);

Wim Taymans's avatar
Wim Taymans committed
702
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_STRUCTURE_CHANGE),
703 704 705 706 707 708 709 710 711 712
      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
713
/**
714
 * gst_message_new_segment_start:
715
 * @src: (transfer none): The object originating the message.
716 717
 * @format: The format of the position being played
 * @position: The position of the segment being played
718 719 720 721 722 723
 *
 * 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.
 *
724
 * Returns: (transfer full): the new segment start message.
725 726 727 728
 *
 * MT safe.
 */
GstMessage *
729 730
gst_message_new_segment_start (GstObject * src, GstFormat format,
    gint64 position)
731 732
{
  GstMessage *message;
733
  GstStructure *structure;
734

Wim Taymans's avatar
Wim Taymans committed
735
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_SEGMENT_START),
736 737 738
      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);
739 740 741 742 743 744

  return message;
}

/**
 * gst_message_new_segment_done:
745
 * @src: (transfer none): the object originating the message.
746 747
 * @format: The format of the position being done
 * @position: The position of the segment being done
748 749 750 751 752 753
 *
 * 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.
 *
754
 * Returns: (transfer full): the new segment done message.
755 756 757 758
 *
 * MT safe.
 */
GstMessage *
759 760
gst_message_new_segment_done (GstObject * src, GstFormat format,
    gint64 position)
761 762
{
  GstMessage *message;
763
  GstStructure *structure;
764

Wim Taymans's avatar
Wim Taymans committed
765
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_SEGMENT_DONE),
766 767 768
      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);
769 770 771 772

  return message;
}

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

813 814
/**
 * gst_message_new_duration:
815
 * @src: (transfer none): The object originating the message.
816 817 818 819 820 821
 * @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
822 823 824 825
 * 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.
826
 *
827
 * Returns: (transfer full): The new duration message.
828 829 830 831 832 833 834
 *
 * MT safe.
 */
GstMessage *
gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
{
  GstMessage *message;
835
  GstStructure *structure;
836

Wim Taymans's avatar
Wim Taymans committed
837
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_DURATION),
838 839 840
      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);
841 842 843 844

  return message;
}

845 846
/**
 * gst_message_new_async_start:
847
 * @src: (transfer none): The object originating the message.
848
 *
849
 * This message is posted by elements when they start an ASYNC state change.
850
 *
851
 * Returns: (transfer full): The new async_start message.
852 853 854 855
 *
 * MT safe.
 */
GstMessage *
856
gst_message_new_async_start (GstObject * src)
857 858 859
{
  GstMessage *message;

860
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_START, src, NULL);
861 862 863 864 865 866

  return message;
}

/**
 * gst_message_new_async_done:
867
 * @src: (transfer none): The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
868
 * @reset_time: if the running_time should be reset
869
 *
Stefan Kost's avatar
Stefan Kost committed
870
 * The message is posted when elements completed an ASYNC state change.
Wim Taymans's avatar
Wim Taymans committed
871
 * @reset_time is set to TRUE when the element requests a new running_time
872
 * before going to PLAYING.
Stefan Kost's avatar
Stefan Kost committed
873
 *
874
 * Returns: (transfer full): The new async_done message.
875 876 877 878
 *
 * MT safe.
 */
GstMessage *
Wim Taymans's avatar
Wim Taymans committed
879
gst_message_new_async_done (GstObject * src, gboolean reset_time)
880 881
{
  GstMessage *message;
882
  GstStructure *structure;
883

Wim Taymans's avatar
Wim Taymans committed
884
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_ASYNC_DONE),
Wim Taymans's avatar
Wim Taymans committed
885
      GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL);
886
  message = gst_message_new_custom (GST_MESSAGE_ASYNC_DONE, src, structure);
887 888 889 890

  return message;
}

891 892
/**
 * gst_message_new_latency:
893
 * @src: (transfer none): The object originating the message.
894 895 896 897
 *
 * This message can be posted by elements when their latency requirements have
 * changed.
 *
898
 * Returns: (transfer full): The new latency message.
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
 *
 * 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;
}

914 915
/**
 * gst_message_new_request_state:
916
 * @src: (transfer none): the object originating the message.
917 918 919 920 921 922
 * @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.
 *
923
 * Returns: (transfer full): the new requst state message.
924 925 926 927 928 929 930 931 932 933 934
 *
 * MT safe.
 *
 * Since: 0.10.23
 */
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
{
  GstMessage *message;
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
935
  structure = gst_structure_new_id (GST_QUARK (MESSAGE_REQUEST_STATE),
936 937 938 939 940 941
      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
942 943 944 945 946 947
/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
948 949
 * 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
950
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
951 952 953 954 955 956 957
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
958

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
  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
986 987 988 989 990
}

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

  g_return_if_fail (GST_IS_MESSAGE (message));
1022
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
1023 1024
  g_return_if_fail (tag_list != NULL);

1025
  ret = gst_structure_copy (GST_MESSAGE_STRUCTURE (message));
1026 1027 1028 1029 1030
  gst_structure_remove_field (ret, "source-pad");

  *tag_list = (GstTagList *) ret;
}

1031 1032 1033
/**
 * gst_message_parse_buffering:
 * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
1034
 * @percent: (out) (allow-none): Return location for the percent.
1035
 *
Wim Taymans's avatar
Wim Taymans committed
1036 1037
 * Extracts the buffering percent from the GstMessage. see also
 * gst_message_new_buffering().
1038 1039
 *
 * MT safe.
1040 1041
 *
 * Since: 0.10.11
1042 1043 1044 1045 1046
 */
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
1047
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1048 1049

  if (percent)
1050 1051 1052
    *percent =
        g_value_get_int (gst_structure_id_get_value (GST_MESSAGE_STRUCTURE
            (message), GST_QUARK (BUFFER_PERCENT)));
1053
}
Wim Taymans's avatar
Wim Taymans committed
1054

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
/**
 * 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)
{
1071
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_BUFFERING);
1072

1073
  gst_structure_id_set (GST_MESSAGE_STRUCTURE (message),
1074 1075 1076 1077 1078 1079 1080 1081 1082
      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.
1083 1084