gstmessage.c 15.6 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 21 22 23 24
/* 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.
 */

#include <string.h>             /* memcpy */

#include "gst_private.h"
25
#include "gsterror.h"
Wim Taymans's avatar
Wim Taymans committed
26 27 28 29
#include "gstinfo.h"
#include "gstmemchunk.h"
#include "gstmessage.h"
#include "gsttag.h"
30
#include "gstutils.h"
Wim Taymans's avatar
Wim Taymans committed
31 32


33 34 35 36
static void gst_message_init (GTypeInstance * instance, gpointer g_class);
static void gst_message_class_init (gpointer g_class, gpointer class_data);
static void gst_message_finalize (GstMessage * message);
static GstMessage *_gst_message_copy (GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
37

38

Wim Taymans's avatar
Wim Taymans committed
39 40 41
void
_gst_message_initialize (void)
{
42 43
  gpointer ptr;

Wim Taymans's avatar
Wim Taymans committed
44 45
  GST_CAT_INFO (GST_CAT_GST_INIT, "init messages");

46
  gst_message_get_type ();
Wim Taymans's avatar
Wim Taymans committed
47

48 49 50 51 52
  /* the GstMiniObject types need to be class_ref'd once before it can be
   * done from multiple threads;
   * see http://bugzilla.gnome.org/show_bug.cgi?id=304551 */
  ptr = g_type_class_ref (GST_TYPE_MESSAGE);
  g_type_class_unref (ptr);
Wim Taymans's avatar
Wim Taymans committed
53 54
}

55 56
GType
gst_message_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
57
{
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  static GType _gst_message_type;

  if (G_UNLIKELY (_gst_message_type == 0)) {
    static const GTypeInfo message_info = {
      sizeof (GstMessageClass),
      NULL,
      NULL,
      gst_message_class_init,
      NULL,
      NULL,
      sizeof (GstMessage),
      0,
      gst_message_init,
      NULL
    };
Wim Taymans's avatar
Wim Taymans committed
73

74 75 76 77 78
    _gst_message_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
        "GstMessage", &message_info, 0);
  }
  return _gst_message_type;
}
Wim Taymans's avatar
Wim Taymans committed
79

80 81 82 83
static void
gst_message_class_init (gpointer g_class, gpointer class_data)
{
  GstMessageClass *message_class = GST_MESSAGE_CLASS (g_class);
Wim Taymans's avatar
Wim Taymans committed
84

85 86 87 88 89
  message_class->mini_object_class.copy =
      (GstMiniObjectCopyFunction) _gst_message_copy;
  message_class->mini_object_class.finalize =
      (GstMiniObjectFinalizeFunction) gst_message_finalize;
}
Wim Taymans's avatar
Wim Taymans committed
90

91 92 93 94 95
static void
gst_message_init (GTypeInstance * instance, gpointer g_class)
{
  GstMessage *message = GST_MESSAGE (instance);

96
  GST_CAT_INFO (GST_CAT_MESSAGE, "new message %p", message);
Wim Taymans's avatar
Wim Taymans committed
97
  GST_MESSAGE_TIMESTAMP (message) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
98 99 100
}

static void
101
gst_message_finalize (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
102
{
103
  g_return_if_fail (message != NULL);
Wim Taymans's avatar
Wim Taymans committed
104

105 106
  GST_CAT_INFO (GST_CAT_MESSAGE, "finalize message %p", message);

Wim Taymans's avatar
Wim Taymans committed
107
  if (GST_MESSAGE_SRC (message)) {
108
    gst_object_unref (GST_MESSAGE_SRC (message));
Wim Taymans's avatar
Wim Taymans committed
109
    GST_MESSAGE_SRC (message) = NULL;
Wim Taymans's avatar
Wim Taymans committed
110 111 112 113 114 115 116 117
  }

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

118 119
  if (message->structure) {
    gst_structure_set_parent_refcount (message->structure, NULL);
Wim Taymans's avatar
Wim Taymans committed
120
    gst_structure_free (message->structure);
121
  }
Wim Taymans's avatar
Wim Taymans committed
122 123
}

124 125
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
126
{
127 128 129 130 131 132
  GstMessage *copy;

  GST_CAT_INFO (GST_CAT_MESSAGE, "copy message %p", message);

  copy = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);

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

Wim Taymans's avatar
Wim Taymans committed
136 137 138 139
  GST_MESSAGE_GET_LOCK (copy) = GST_MESSAGE_GET_LOCK (message);
  GST_MESSAGE_COND (copy) = GST_MESSAGE_COND (message);
  GST_MESSAGE_TYPE (copy) = GST_MESSAGE_TYPE (message);
  GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
140 141

  if (GST_MESSAGE_SRC (message)) {
142
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
143 144 145 146 147 148 149 150 151
  }

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

  return copy;
Wim Taymans's avatar
Wim Taymans committed
152 153
}

154
static GstMessage *
155
gst_message_new (GstMessageType type, GstObject * src)
Wim Taymans's avatar
Wim Taymans committed
156 157 158
{
  GstMessage *message;

159
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
160 161 162

  GST_CAT_INFO (GST_CAT_MESSAGE, "creating new message %p %d", message, type);

163
  message->type = type;
Wim Taymans's avatar
Wim Taymans committed
164
  if (src) {
165
    message->src = gst_object_ref (src);
166
    GST_CAT_DEBUG_OBJECT (GST_CAT_MESSAGE, src, "message source");
167
  } else {
168
    message->src = NULL;
169
    GST_CAT_DEBUG (GST_CAT_MESSAGE, "NULL message source");
Wim Taymans's avatar
Wim Taymans committed
170
  }
171
  message->structure = NULL;
Wim Taymans's avatar
Wim Taymans committed
172 173 174 175 176 177

  return message;
}

/**
 * gst_message_new_eos:
Stefan Kost's avatar
Stefan Kost committed
178
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
179
 *
180 181 182
 * 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
183 184 185 186 187 188 189 190 191 192
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

193
  message = gst_message_new (GST_MESSAGE_EOS, src);
Wim Taymans's avatar
Wim Taymans committed
194 195 196 197 198 199 200 201 202 203

  return message;
}

/**
 * gst_message_new_error:
 * @src: The object originating the message.
 * @error: The GError for this message.
 * @debug: A debugging string for something or other.
 *
204
 * Create a new error message. The message will copy @error and
205 206
 * @debug. This message is posted by element when a fatal event
 * occured. The pipeline will probably (partially) stop. 
Wim Taymans's avatar
Wim Taymans committed
207 208 209 210 211 212 213 214 215 216 217
 *
 * Returns: The new error message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_error (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;
  GstStructure *s;

218
  message = gst_message_new (GST_MESSAGE_ERROR, src);
219 220
  /* gst_structure_new takes copies of the types passed in */
  s = gst_structure_new ("GstMessageError", "gerror", GST_TYPE_G_ERROR, error,
Wim Taymans's avatar
Wim Taymans committed
221
      "debug", G_TYPE_STRING, debug, NULL);
222
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
223 224 225 226 227 228 229 230 231 232 233
  message->structure = s;

  return message;
}

/**
 * gst_message_new_warning:
 * @src: The object originating the message.
 * @error: The GError for this message.
 * @debug: A debugging string for something or other.
 *
234
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
235 236 237 238 239 240 241 242 243 244 245 246
 * @debug.
 *
 * Returns: The new warning message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_warning (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;
  GstStructure *s;

247
  message = gst_message_new (GST_MESSAGE_WARNING, src);
248 249
  /* gst_structure_new takes copies of the types passed in */
  s = gst_structure_new ("GstMessageWarning", "gerror", GST_TYPE_G_ERROR, error,
Wim Taymans's avatar
Wim Taymans committed
250
      "debug", G_TYPE_STRING, debug, NULL);
251
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
252 253 254 255 256 257 258 259 260 261 262
  message->structure = s;

  return message;
}

/**
 * gst_message_new_tag:
 * @src: The object originating the message.
 * @tag_list: The tag list for the message.
 *
 * Create a new tag message. The message will take ownership of the tag list.
263
 * The message is posted by elements that discovered a new taglist.
Wim Taymans's avatar
Wim Taymans committed
264 265 266 267 268 269 270 271 272 273
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

274 275
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

276
  message = gst_message_new (GST_MESSAGE_TAG, src);
277
  gst_structure_set_parent_refcount (tag_list, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
278 279 280 281 282 283 284 285 286 287 288
  message->structure = tag_list;

  return message;
}

/**
 * gst_message_new_state_change:
 * @src: The object originating the message.
 * @old: The previous state.
 * @new: The new (current) state.
 *
289 290
 * Create a state change message. This message is posted whenever an element changed
 * its state.
Wim Taymans's avatar
Wim Taymans committed
291 292 293 294 295 296 297 298 299 300 301 302
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_state_changed (GstObject * src, GstElementState old,
    GstElementState new)
{
  GstMessage *message;
  GstStructure *s;

303
  message = gst_message_new (GST_MESSAGE_STATE_CHANGED, src);
304

305
  s = gst_structure_new ("GstMessageState", "old-state", G_TYPE_INT, (gint) old,
306
      "new-state", G_TYPE_INT, (gint) new, NULL);
307
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
308 309 310 311 312 313
  message->structure = s;

  return message;
}

/**
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
 * gst_message_new_segment_start:
 * @src: The object originating the message.
 * @timestamp: The timestamp of the segment being played
 *
 * Create a new segment message. This message is posted by elements that
 * start playback of a segment as a result of a segment seek. This message
 * is not received by the application but is used for maintenance reasons in
 * container elements.
 *
 * Returns: The new segment start message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_segment_start (GstObject * src, GstClockTime timestamp)
{
  GstMessage *message;
  GstStructure *s;

333
  message = gst_message_new (GST_MESSAGE_SEGMENT_START, src);
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362

  s = gst_structure_new ("GstMessageSegmentStart", "timestamp", G_TYPE_INT64,
      (gint64) timestamp, NULL);
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
  message->structure = s;

  return message;
}

/**
 * gst_message_new_segment_done:
 * @src: The object originating the message.
 * @timestamp: The timestamp of the segment being played
 *
 * Create a new segment done message. This message is posted by elements that
 * finish playback of a segment as a result of a segment seek. This message
 * is received by the application after all elements that posted a segment_start
 * have posted the segment_done.
 *
 * Returns: The new segment done message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_segment_done (GstObject * src, GstClockTime timestamp)
{
  GstMessage *message;
  GstStructure *s;

363
  message = gst_message_new (GST_MESSAGE_SEGMENT_DONE, src);
364 365 366 367 368 369 370 371 372 373 374

  s = gst_structure_new ("GstMessageSegmentDone", "timestamp", G_TYPE_INT64,
      (gint64) timestamp, NULL);
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
  message->structure = s;

  return message;
}

/**
 * gst_message_new_custom:
Stefan Kost's avatar
Stefan Kost committed
375
 * @type: The #GstMessageType to distinguish messages
376
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
377 378 379
 * @structure: The structure for the message. The message will take ownership of
 * the structure.
 *
380 381
 * 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
Wim Taymans's avatar
Wim Taymans committed
382
 * app. The structure field can be NULL.
Wim Taymans's avatar
Wim Taymans committed
383 384 385 386 387 388
 *
 * Returns: The new message.
 *
 * MT safe.
 */
GstMessage *
389
gst_message_new_custom (GstMessageType type, GstObject * src,
390
    GstStructure * structure)
Wim Taymans's avatar
Wim Taymans committed
391 392 393
{
  GstMessage *message;

394
  message = gst_message_new (type, src);
Wim Taymans's avatar
Wim Taymans committed
395 396 397 398 399
  if (structure) {
    gst_structure_set_parent_refcount (structure,
        &message->mini_object.refcount);
    message->structure = structure;
  }
Wim Taymans's avatar
Wim Taymans committed
400 401 402 403 404 405 406 407 408
  return message;
}

/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
409 410 411
 * Returns: The structure of the message. The structure is still
 * owned by the message, which means that you should not free it and 
 * that the pointer becomes invalid when you free the message.
Wim Taymans's avatar
Wim Taymans committed
412 413 414 415 416 417 418
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
419

Wim Taymans's avatar
Wim Taymans committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
  return message->structure;
}

/**
 * gst_message_parse_tag:
 * @message: A valid #GstMessage of type GST_MESSAGE_TAG.
 *
 * Extracts the tag list from the GstMessage. The tag list returned in the
 * output argument is a copy; the caller must free it when done.
 *
 * MT safe.
 */
void
gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);

  *tag_list = (GstTagList *) gst_structure_copy (message->structure);
}

/**
442
 * gst_message_parse_state_changed:
Wim Taymans's avatar
Wim Taymans committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
 * @message: A valid #GstMessage of type GST_MESSAGE_STATE_CHANGED.
 *
 * Extracts the old and new states from the GstMessage.
 *
 * MT safe.
 */
void
gst_message_parse_state_changed (GstMessage * message, GstElementState * old,
    GstElementState * new)
{
  g_return_if_fail (GST_IS_MESSAGE (message));
  g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STATE_CHANGED);

  if (!gst_structure_get_int (message->structure, "old-state", (gint *) old))
    g_assert_not_reached ();
  if (!gst_structure_get_int (message->structure, "new-state", (gint *) new))
    g_assert_not_reached ();
}

/**
 * gst_message_parse_error:
 * @message: A valid #GstMessage of type GST_MESSAGE_ERROR.
 *
Wim Taymans's avatar
Wim Taymans committed
466
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
467 468 469 470 471 472 473 474
 * in the output arguments are copies; the caller must free them when done.
 *
 * MT safe.
 */
void
gst_message_parse_error (GstMessage * message, GError ** gerror, gchar ** debug)
{
  const GValue *error_gvalue;
475
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
476 477 478 479 480 481

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

  error_gvalue = gst_structure_get_value (message->structure, "gerror");
  g_return_if_fail (error_gvalue != NULL);
482
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
483

484
  error_val = (GError *) g_value_get_boxed (error_gvalue);
485 486 487 488
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;
Wim Taymans's avatar
Wim Taymans committed
489 490 491 492 493 494 495
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}

/**
 * gst_message_parse_warning:
 * @message: A valid #GstMessage of type GST_MESSAGE_WARNING.
 *
Wim Taymans's avatar
Wim Taymans committed
496
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
497 498 499 500 501 502 503 504 505
 * in the output arguments are copies; the caller must free them when done.
 *
 * MT safe.
 */
void
gst_message_parse_warning (GstMessage * message, GError ** gerror,
    gchar ** debug)
{
  const GValue *error_gvalue;
506
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
507 508 509 510 511 512

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

  error_gvalue = gst_structure_get_value (message->structure, "gerror");
  g_return_if_fail (error_gvalue != NULL);
513
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
514

515
  error_val = (GError *) g_value_get_boxed (error_gvalue);
516 517 518 519 520
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

Wim Taymans's avatar
Wim Taymans committed
521 522
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570

/**
 * gst_message_parse_segment_start:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.
 *
 * Extracts the timestamp from the segment start message.
 *
 * MT safe.
 */
void
gst_message_parse_segment_start (GstMessage * message, GstClockTime * timestamp)
{
  const GValue *time_gvalue;

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

  time_gvalue = gst_structure_get_value (message->structure, "timstamp");
  g_return_if_fail (time_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (time_gvalue) == G_TYPE_INT64);

  if (timestamp)
    *timestamp = (GstClockTime) g_value_get_int64 (time_gvalue);
}

/**
 * gst_message_parse_segment_done:
 * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE.
 *
 * Extracts the timestamp from the segment done message.
 *
 * MT safe.
 */
void
gst_message_parse_segment_done (GstMessage * message, GstClockTime * timestamp)
{
  const GValue *time_gvalue;

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

  time_gvalue = gst_structure_get_value (message->structure, "timstamp");
  g_return_if_fail (time_gvalue != NULL);
  g_return_if_fail (G_VALUE_TYPE (time_gvalue) == G_TYPE_INT64);

  if (timestamp)
    *timestamp = (GstClockTime) g_value_get_int64 (time_gvalue);
}