gstmessage.c 11.9 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 25
/* 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"
26
#include "gsterror.h"
Wim Taymans's avatar
Wim Taymans committed
27 28 29 30
#include "gstinfo.h"
#include "gstmemchunk.h"
#include "gstmessage.h"
#include "gsttag.h"
31
#include "gstutils.h"
Wim Taymans's avatar
Wim Taymans committed
32 33


34 35 36 37
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
38

39

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

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

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

49 50 51 52 53
  /* 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
54 55
}

56 57
GType
gst_message_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
58
{
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  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
74

75 76 77 78 79
    _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
80

81 82 83 84
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
85

86 87 88 89 90
  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
91

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

  message->timestamp = 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 108 109 110 111 112 113 114 115 116
  if (GST_MESSAGE_SRC (message)) {
    gst_object_unref (GST_MESSAGE_SRC (message));
  }

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

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

123 124
static GstMessage *
_gst_message_copy (GstMessage * message)
Wim Taymans's avatar
Wim Taymans committed
125
{
126 127 128 129 130 131
  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
132
  /* FIXME, need to copy relevant data from the miniobject. */
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
  //memcpy (copy, message, sizeof (GstMessage));

  copy->lock = message->lock;
  copy->cond = message->cond;
  copy->type = message->type;
  copy->timestamp = message->timestamp;

  if (GST_MESSAGE_SRC (message)) {
    GST_MESSAGE_SRC (copy) = gst_object_ref (GST_MESSAGE_SRC (message));
  }

  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
151 152 153 154 155 156 157 158 159 160 161 162
}

/**
 * gst_message_new:
 * @type: The type of the new message
 *
 * Allocate a new message of the given type.
 *
 * Returns: A new message.
 *
 * MT safe.
 */
163
static GstMessage *
Wim Taymans's avatar
Wim Taymans committed
164 165 166 167
gst_message_new (GstMessageType type, GstObject * src)
{
  GstMessage *message;

168
  message = (GstMessage *) gst_mini_object_new (GST_TYPE_MESSAGE);
Wim Taymans's avatar
Wim Taymans committed
169 170 171

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

172
  message->type = type;
Wim Taymans's avatar
Wim Taymans committed
173
  if (src) {
174
    message->src = gst_object_ref (src);
175
    GST_CAT_DEBUG_OBJECT (GST_CAT_MESSAGE, src, "message source");
176
  } else {
177
    message->src = NULL;
178
    GST_CAT_DEBUG (GST_CAT_MESSAGE, "NULL message source");
Wim Taymans's avatar
Wim Taymans committed
179
  }
180
  message->structure = NULL;
Wim Taymans's avatar
Wim Taymans committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

  return message;
}

/**
 * gst_message_new_eos:
 *
 * Create a new eos message.
 *
 * Returns: The new eos message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_eos (GstObject * src)
{
  GstMessage *message;

  message = gst_message_new (GST_MESSAGE_EOS, src);

  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.
 *
210
 * Create a new error message. The message will copy @error and
Wim Taymans's avatar
Wim Taymans committed
211 212 213 214 215 216 217 218 219 220 221 222 223
 * @debug.
 *
 * Returns: The new error message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_error (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;
  GstStructure *s;

  message = gst_message_new (GST_MESSAGE_ERROR, src);
224 225
  /* 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
226
      "debug", G_TYPE_STRING, debug, NULL);
227
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
228 229 230 231 232 233 234 235 236 237 238
  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.
 *
239
 * Create a new warning message. The message will make copies of @error and
Wim Taymans's avatar
Wim Taymans committed
240 241 242 243 244 245 246 247 248 249 250 251 252
 * @debug.
 *
 * Returns: The new warning message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_warning (GstObject * src, GError * error, gchar * debug)
{
  GstMessage *message;
  GstStructure *s;

  message = gst_message_new (GST_MESSAGE_WARNING, src);
253 254
  /* 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
255
      "debug", G_TYPE_STRING, debug, NULL);
256
  gst_structure_set_parent_refcount (s, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
  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.
 *
 * Returns: The new tag message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
  GstMessage *message;

278 279
  g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);

Wim Taymans's avatar
Wim Taymans committed
280
  message = gst_message_new (GST_MESSAGE_TAG, src);
281
  gst_structure_set_parent_refcount (tag_list, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
  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.
 *
 * Create a state change message.
 *
 * Returns: The new state change message.
 *
 * MT safe.
 */
GstMessage *
gst_message_new_state_changed (GstObject * src, GstElementState old,
    GstElementState new)
{
  GstMessage *message;
  GstStructure *s;

  message = gst_message_new (GST_MESSAGE_STATE_CHANGED, src);
307

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

  return message;
}

/**
317
 * gst_message_new_cistom:
318
 * @src: The object originating the message.
Wim Taymans's avatar
Wim Taymans committed
319 320 321
 * @structure: The structure for the message. The message will take ownership of
 * the structure.
 *
322 323 324
 * 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.
Wim Taymans's avatar
Wim Taymans committed
325 326 327 328 329 330
 *
 * Returns: The new message.
 *
 * MT safe.
 */
GstMessage *
331 332
gst_message_new_custom (GstMessageType type, GstObject * src,
    GstStructure * structure)
Wim Taymans's avatar
Wim Taymans committed
333 334 335
{
  GstMessage *message;

336 337
  g_return_val_if_fail (GST_IS_STRUCTURE (structure), NULL);

338
  message = gst_message_new (type, src);
339
  gst_structure_set_parent_refcount (structure, &message->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
340 341 342 343 344 345 346 347 348 349 350
  message->structure = structure;

  return message;
}

/**
 * gst_message_get_structure:
 * @message: The #GstMessage.
 *
 * Access the structure of the message.
 *
351 352 353
 * 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
354 355 356 357 358 359 360
 *
 * MT safe.
 */
const GstStructure *
gst_message_get_structure (GstMessage * message)
{
  g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
361

Wim Taymans's avatar
Wim Taymans committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
  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);
}

/**
 * gst_message_parse_tag:
 * @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
408
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
409 410 411 412 413 414 415 416
 * 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;
417
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
418 419 420 421 422 423

  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);
424
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
425

426
  error_val = (GError *) g_value_get_boxed (error_gvalue);
427 428 429 430
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;
Wim Taymans's avatar
Wim Taymans committed
431 432 433 434 435 436 437
  *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
438
 * Extracts the GError and debug string from the GstMessage. The values returned
Wim Taymans's avatar
Wim Taymans committed
439 440 441 442 443 444 445 446 447
 * 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;
448
  GError *error_val;
Wim Taymans's avatar
Wim Taymans committed
449 450 451 452 453 454

  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);
455
  g_return_if_fail (G_VALUE_TYPE (error_gvalue) == GST_TYPE_G_ERROR);
Wim Taymans's avatar
Wim Taymans committed
456

457
  error_val = (GError *) g_value_get_boxed (error_gvalue);
458 459 460 461 462
  if (error_val)
    *gerror = g_error_copy (error_val);
  else
    *gerror = NULL;

Wim Taymans's avatar
Wim Taymans committed
463 464
  *debug = g_strdup (gst_structure_get_string (message->structure, "debug"));
}