gstevent.c 41.8 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
4
 *                    2005 Wim Taymans <wim@fluendo.com>
5
 *
6
 * gstevent.c: GstEvent subsystem
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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
23

24 25
/**
 * SECTION:gstevent
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
26 27
 * @short_description: Structure describing events that are passed up and down
 *                     a pipeline
28 29
 * @see_also: #GstPad, #GstElement
 *
Wim Taymans's avatar
Wim Taymans committed
30
 * The event class provides factory methods to construct events for sending
Stefan Kost's avatar
Stefan Kost committed
31
 * and functions to query (parse) received events.
32
 *
33 34
 * Events are usually created with gst_event_new_*() which takes event-type
 * specific parameters as arguments.
35 36
 * To send an event application will usually use gst_element_send_event() and
 * elements will use gst_pad_send_event() or gst_pad_push_event().
37 38 39
 * The event should be unreffed with gst_event_unref() if it has not been sent.
 *
 * Events that have been received can be parsed with their respective 
40
 * gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.
41
 *
Wim Taymans's avatar
Wim Taymans committed
42 43 44 45
 * Events are passed between elements in parallel to the data stream. Some events
 * are serialized with buffers, others are not. Some events only travel downstream,
 * others only upstream. Some events can travel both upstream and downstream. 
 * 
46 47 48
 * The events are used to signal special conditions in the datastream such as
 * EOS (end of stream) or the start of a new stream-segment.
 * Events are also used to flush the pipeline of any pending data.
Wim Taymans's avatar
Wim Taymans committed
49
 *
50 51 52 53
 * Most of the event API is used inside plugins. Applications usually only 
 * construct and use seek events. 
 * To do that gst_event_new_seek() is used to create a seek event. It takes
 * the needed parameters to specity seeking time and mode.
Wim Taymans's avatar
Wim Taymans committed
54 55 56 57 58 59 60 61 62 63
 * <example>
 * <title>performing a seek on a pipeline</title>
 *   <programlisting>
 *   GstEvent *event;
 *   gboolean result;
 *   ...
 *   // construct a seek event to play the media from second 2 to 5, flush
 *   // the pipeline to decrease latency.
 *   event = gst_event_new_seek (1.0, 
 *      GST_FORMAT_TIME, 
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
64 65 66
 *      GST_SEEK_FLAG_FLUSH,
 *      GST_SEEK_TYPE_SET, 2 * GST_SECOND,
 *      GST_SEEK_TYPE_SET, 5 * GST_SECOND);
Wim Taymans's avatar
Wim Taymans committed
67 68 69 70 71 72 73
 *   ...
 *   result = gst_element_send_event (pipeline, event);
 *   if (!result)
 *     g_warning ("seek failed");
 *   ...
 *   </programlisting>
 * </example>
Wim Taymans's avatar
Wim Taymans committed
74
 *
75
 * Last reviewed on 2006-09-6 (0.10.10)
76
 */
Wim Taymans's avatar
Wim Taymans committed
77

78

79
#include "gst_private.h"
80
#include <string.h>             /* memcpy */
81 82

#include "gstinfo.h"
83
#include "gstevent.h"
Wim Taymans's avatar
Wim Taymans committed
84
#include "gstenumtypes.h"
85
#include "gstutils.h"
86
#include "gstquark.h"
Benjamin Otte's avatar
Benjamin Otte committed
87

Wim Taymans's avatar
Wim Taymans committed
88
GType _gst_event_type = 0;
89

90 91 92 93 94 95 96 97
typedef struct
{
  GstQOSType type;
  gdouble proportion;
  gint64 diff;
  GstClockTime timestamp;
} GstEventQOSData;

Wim Taymans's avatar
Wim Taymans committed
98 99 100 101 102
typedef struct
{
  GstEvent event;

  GstStructure *structure;
103 104 105 106 107

  union
  {
    GstEventQOSData qos;
  };
Wim Taymans's avatar
Wim Taymans committed
108 109
} GstEventImpl;

110 111
#define GST_EVENT_STRUCTURE(e)        (((GstEventImpl *)(e))->structure)
#define GST_EVENT_IMPL(e,data,field)  (((GstEventImpl *)(e))->data.field)
Wim Taymans's avatar
Wim Taymans committed
112

113 114
typedef struct
{
115 116
  const gint type;
  const gchar *name;
117 118 119 120 121 122 123 124
  GQuark quark;
} GstEventQuarks;

static GstEventQuarks event_quarks[] = {
  {GST_EVENT_UNKNOWN, "unknown", 0},
  {GST_EVENT_FLUSH_START, "flush-start", 0},
  {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
  {GST_EVENT_EOS, "eos", 0},
Wim Taymans's avatar
Wim Taymans committed
125
  {GST_EVENT_CAPS, "caps", 0},
126 127
  {GST_EVENT_NEWSEGMENT, "newsegment", 0},
  {GST_EVENT_TAG, "tag", 0},
128
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
129
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
130 131 132
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
133
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
134
  {GST_EVENT_STEP, "step", 0},
135
  {GST_EVENT_RECONFIGURE, "reconfigure", 0},
136 137 138
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
139 140 141
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

142 143 144
  {0, NULL, 0}
};

145 146 147 148
void
_gst_event_initialize (void)
{
  gint i;
149

Wim Taymans's avatar
Wim Taymans committed
150 151
  _gst_event_type = gst_mini_object_register ("GstEvent");

152 153 154 155 156 157 158 159
  g_type_class_ref (gst_seek_flags_get_type ());
  g_type_class_ref (gst_seek_type_get_type ());

  for (i = 0; event_quarks[i].name; i++) {
    event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name);
  }
}

Stefan Kost's avatar
Stefan Kost committed
160 161 162 163 164 165
/**
 * gst_event_type_get_name:
 * @type: the event type
 *
 * Get a printable name for the given event type. Do not modify or free.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
166
 * Returns: a reference to the static name of the event.
Stefan Kost's avatar
Stefan Kost committed
167
 */
168 169 170 171 172 173 174 175 176 177 178 179
const gchar *
gst_event_type_get_name (GstEventType type)
{
  gint i;

  for (i = 0; event_quarks[i].name; i++) {
    if (type == event_quarks[i].type)
      return event_quarks[i].name;
  }
  return "unknown";
}

Stefan Kost's avatar
Stefan Kost committed
180 181 182 183 184 185 186 187
/**
 * gst_event_type_to_quark:
 * @type: the event type
 *
 * Get the unique quark for the given event type.
 *
 * Returns: the quark associated with the event type
 */
188 189 190 191 192 193 194 195 196 197 198 199
GQuark
gst_event_type_to_quark (GstEventType type)
{
  gint i;

  for (i = 0; event_quarks[i].name; i++) {
    if (type == event_quarks[i].type)
      return event_quarks[i].quark;
  }
  return 0;
}

200 201 202 203 204 205 206 207 208 209 210 211 212
/**
 * gst_event_type_get_flags:
 * @type: a #GstEventType
 *
 * Gets the #GstEventTypeFlags associated with @type.
 *
 * Returns: a #GstEventTypeFlags.
 */
GstEventTypeFlags
gst_event_type_get_flags (GstEventType type)
{
  GstEventTypeFlags ret;

213
  ret = type & ((1 << GST_EVENT_STICKY_SHIFT) - 1);
214 215 216 217

  return ret;
}

218
static void
219
_gst_event_free (GstEvent * event)
220
{
Wim Taymans's avatar
Wim Taymans committed
221 222
  GstStructure *s;

223 224 225
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

226
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
227
      GST_EVENT_TYPE_NAME (event));
Wim Taymans's avatar
Wim Taymans committed
228

Wim Taymans's avatar
Wim Taymans committed
229 230 231 232 233
  s = GST_EVENT_STRUCTURE (event);

  if (s) {
    gst_structure_set_parent_refcount (s, NULL);
    gst_structure_free (s);
234
  }
235

Wim Taymans's avatar
Wim Taymans committed
236
  g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
237 238 239
}

static GstEvent *
240
_gst_event_copy (GstEventImpl * event)
241
{
Wim Taymans's avatar
Wim Taymans committed
242 243
  GstEventImpl *copy;
  GstStructure *s;
244

245 246 247
  copy = g_slice_dup (GstEventImpl, event);
  gst_mini_object_init (GST_MINI_OBJECT_CAST (copy), _gst_event_type,
      sizeof (GstEventImpl));
248

249
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
Wim Taymans's avatar
Wim Taymans committed
250
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
251
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
252

Wim Taymans's avatar
Wim Taymans committed
253 254 255
  s = GST_EVENT_STRUCTURE (event);
  if (s) {
    GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
256 257
    gst_structure_set_parent_refcount (GST_EVENT_STRUCTURE (copy),
        &copy->event.mini_object.refcount);
258
  }
Wim Taymans's avatar
Wim Taymans committed
259
  return GST_EVENT_CAST (copy);
260 261
}

Wim Taymans's avatar
Wim Taymans committed
262
static void
Wim Taymans's avatar
Wim Taymans committed
263
gst_event_init (GstEventImpl * event, gsize size, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
264
{
Wim Taymans's avatar
Wim Taymans committed
265
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type, size);
Wim Taymans's avatar
Wim Taymans committed
266

Wim Taymans's avatar
Wim Taymans committed
267 268
  event->event.mini_object.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
  event->event.mini_object.free = (GstMiniObjectFreeFunction) _gst_event_free;
Wim Taymans's avatar
Wim Taymans committed
269 270 271 272 273 274

  GST_EVENT_TYPE (event) = type;
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
  GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
}

Wim Taymans's avatar
Wim Taymans committed
275 276
static GstEvent *
gst_event_new (GstEventType type)
277
{
Wim Taymans's avatar
Wim Taymans committed
278
  GstEventImpl *event;
279

Wim Taymans's avatar
Wim Taymans committed
280
  event = g_slice_new0 (GstEventImpl);
281

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
282 283
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
284

Wim Taymans's avatar
Wim Taymans committed
285
  gst_event_init (event, sizeof (GstEventImpl), type);
286

Wim Taymans's avatar
Wim Taymans committed
287
  return GST_EVENT_CAST (event);
288 289
}

290
/**
Wim Taymans's avatar
Wim Taymans committed
291
 * gst_event_new_custom:
292
 * @type: The type of the new event
293 294
 * @structure: (transfer full): the structure for the event. The event will
 *     take ownership of the structure.
295
 *
Wim Taymans's avatar
Wim Taymans committed
296 297 298
 * Create a new custom-typed event. This can be used for anything not
 * handled by other event-specific functions to pass an event to another
 * element.
299
 *
Wim Taymans's avatar
Wim Taymans committed
300 301 302 303 304 305 306
 * Make sure to allocate an event type with the #GST_EVENT_MAKE_TYPE macro,
 * assigning a free number and filling in the correct direction and
 * serialization flags.
 *
 * New custom events can also be created by subclassing the event type if
 * needed.
 *
307
 * Returns: (transfer full): the new custom event.
308
 */
309
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
310
gst_event_new_custom (GstEventType type, GstStructure * structure)
311 312 313
{
  GstEvent *event;

314
  /* structure must not have a parent */
Wim Taymans's avatar
Wim Taymans committed
315 316
  event = gst_event_new (type);
  if (structure) {
Wim Taymans's avatar
Wim Taymans committed
317 318 319 320
    if (!gst_structure_set_parent_refcount (structure,
            &event->mini_object.refcount))
      goto had_parent;

Wim Taymans's avatar
Wim Taymans committed
321
    GST_EVENT_STRUCTURE (event) = structure;
Wim Taymans's avatar
Wim Taymans committed
322
  }
323
  return event;
Wim Taymans's avatar
Wim Taymans committed
324 325 326 327 328 329 330 331

  /* ERRORS */
had_parent:
  {
    gst_event_unref (event);
    g_warning ("structure is already owned by another object");
    return NULL;
  }
332 333
}

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 363 364 365 366 367 368 369 370 371 372 373
static inline GstStructure *
add_structure (GstEvent * event, GQuark name)
{
  GstStructure *structure;

  structure = gst_structure_id_empty_new (name);
  gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
  /* FIXME, concurrent access can make us leak this */
  GST_EVENT_STRUCTURE (event) = structure;

  return structure;
}

static GstStructure *
update_structure (GstEvent * event)
{
  GstStructure *structure;

  structure = GST_EVENT_STRUCTURE (event);
  switch (GST_EVENT_TYPE (event)) {
    case GST_EVENT_QOS:
    {
      if (structure == NULL)
        structure = add_structure (event, GST_QUARK (EVENT_QOS));

      gst_structure_id_set (structure,
          GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, GST_EVENT_IMPL (event, qos,
              type), GST_QUARK (PROPORTION), G_TYPE_DOUBLE,
          GST_EVENT_IMPL (event, qos, proportion), GST_QUARK (DIFF),
          G_TYPE_INT64, GST_EVENT_IMPL (event, qos, diff),
          GST_QUARK (TIMESTAMP), G_TYPE_UINT64, GST_EVENT_IMPL (event, qos,
              timestamp), NULL);
      break;
    }
    default:
      break;
  }
  return structure;
}

374
/**
Wim Taymans's avatar
Wim Taymans committed
375 376
 * gst_event_get_structure:
 * @event: The #GstEvent.
377
 *
Wim Taymans's avatar
Wim Taymans committed
378
 * Access the structure of the event.
379
 *
Wim Taymans's avatar
Wim Taymans committed
380 381 382 383 384
 * Returns: The structure of the event. The structure is still
 * owned by the event, which means that you should not free it and
 * that the pointer becomes invalid when you free the event.
 *
 * MT safe.
385
 */
Wim Taymans's avatar
Wim Taymans committed
386 387
const GstStructure *
gst_event_get_structure (GstEvent * event)
388
{
Wim Taymans's avatar
Wim Taymans committed
389
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
390

391
  return update_structure (event);
Wim Taymans's avatar
Wim Taymans committed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
}

/**
 * gst_event_writable_structure:
 * @event: The #GstEvent.
 *
 * Get a writable version of the structure.
 *
 * Returns: The structure of the event. The structure is still
 * owned by the event, which means that you should not free it and
 * that the pointer becomes invalid when you free the event.
 * This function checks if @event is writable and will never return NULL.
 *
 * MT safe.
 */
GstStructure *
gst_event_writable_structure (GstEvent * event)
{
  GstStructure *structure;

  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
  g_return_val_if_fail (gst_event_is_writable (event), NULL);

415
  structure = update_structure (event);
Wim Taymans's avatar
Wim Taymans committed
416

417
  if (structure == NULL)
Wim Taymans's avatar
Wim Taymans committed
418
    structure =
419 420
        add_structure (event, gst_event_type_to_quark (GST_EVENT_TYPE (event)));

Wim Taymans's avatar
Wim Taymans committed
421
  return structure;
422
}
423

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
/**
 * gst_event_has_name:
 * @event: The #GstEvent.
 * @name: name to check
 *
 * Checks if @event has the given @name. This function is usually used to
 * check the name of a custom event.
 *
 * Returns: %TRUE if @name matches the name of the event structure.
 *
 * Since: 0.10.20
 */
gboolean
gst_event_has_name (GstEvent * event, const gchar * name)
{
  g_return_val_if_fail (GST_IS_EVENT (event), FALSE);

Wim Taymans's avatar
Wim Taymans committed
441
  if (GST_EVENT_STRUCTURE (event) == NULL)
442 443
    return FALSE;

Wim Taymans's avatar
Wim Taymans committed
444
  return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
445 446
}

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/**
 * gst_event_get_seqnum:
 * @event: A #GstEvent.
 *
 * Retrieve the sequence number of a event.
 *
 * Events have ever-incrementing sequence numbers, which may also be set
 * explicitly via gst_event_set_seqnum(). Sequence numbers are typically used to
 * indicate that a event corresponds to some other set of events or messages,
 * for example an EOS event 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 event's sequence number.
 *
 * MT safe.
 *
 * Since: 0.10.22
 */
guint32
gst_event_get_seqnum (GstEvent * event)
{
  g_return_val_if_fail (GST_IS_EVENT (event), -1);

  return GST_EVENT_SEQNUM (event);
}

/**
 * gst_event_set_seqnum:
 * @event: A #GstEvent.
 * @seqnum: A sequence number.
 *
 * Set the sequence number of a event.
 *
 * This function might be called by the creator of a event to indicate that the
 * event relates to other events or messages. See gst_event_get_seqnum() for
 * more information.
 *
 * MT safe.
 *
 * Since: 0.10.22
 */
void
gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
{
  g_return_if_fail (GST_IS_EVENT (event));

  GST_EVENT_SEQNUM (event) = seqnum;
}

501 502 503 504
/* FIXME 0.11: It would be nice to have flush events
 * that don't reset the running time in the sinks
 */

Wim Taymans's avatar
Wim Taymans committed
505
/**
Wim Taymans's avatar
Wim Taymans committed
506 507
 * gst_event_new_flush_start:
 *
508
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
509
 * upstream and downstream and travels out-of-bounds with the dataflow.
510 511 512 513 514
 *
 * It marks pads as being flushing and will make them return
 * #GST_FLOW_WRONG_STATE when used for data flow with gst_pad_push(),
 * gst_pad_chain(), gst_pad_alloc_buffer(), gst_pad_get_range() and
 * gst_pad_pull_range(). Any event (except a #GST_EVENT_FLUSH_STOP) received
515
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
516
 *
517 518
 * Elements should unlock any blocking functions and exit their streaming
 * functions as fast as possible when this event is received.
Wim Taymans's avatar
Wim Taymans committed
519
 *
520 521
 * This event is typically generated after a seek to flush out all queued data
 * in the pipeline so that the new media is played as soon as possible.
Wim Taymans's avatar
Wim Taymans committed
522
 *
523
 * Returns: (transfer full): a new flush start event.
Wim Taymans's avatar
Wim Taymans committed
524
 */
525
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
526
gst_event_new_flush_start (void)
527
{
Wim Taymans's avatar
Wim Taymans committed
528
  return gst_event_new (GST_EVENT_FLUSH_START);
529 530
}

531
/**
Wim Taymans's avatar
Wim Taymans committed
532 533
 * gst_event_new_flush_stop:
 *
534
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
535
 * upstream and downstream and travels serialized with the dataflow.
536
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
537
 * pads accept data again.
538
 *
Wim Taymans's avatar
Wim Taymans committed
539 540
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
541
 *
Wim Taymans's avatar
Wim Taymans committed
542 543 544
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
545
 * Returns: (transfer full): a new flush stop event.
546
 */
547
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
548
gst_event_new_flush_stop (void)
549
{
Wim Taymans's avatar
Wim Taymans committed
550
  return gst_event_new (GST_EVENT_FLUSH_STOP);
551 552
}

Wim Taymans's avatar
Wim Taymans committed
553
/**
Wim Taymans's avatar
Wim Taymans committed
554
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
555
 *
Wim Taymans's avatar
Wim Taymans committed
556 557
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
558 559
 * event on a pad can return #GST_FLOW_UNEXPECTED as a #GstFlowReturn
 * when data after the EOS event arrives.
Wim Taymans's avatar
Wim Taymans committed
560
 *
Jan Schmidt's avatar
Jan Schmidt committed
561
 * The EOS event will travel down to the sink elements in the pipeline
562
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
563
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
564
 *
565
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
566 567
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
568
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
569
 *
570
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
571
 */
Wim Taymans's avatar
Wim Taymans committed
572 573
GstEvent *
gst_event_new_eos (void)
574
{
Wim Taymans's avatar
Wim Taymans committed
575
  return gst_event_new (GST_EVENT_EOS);
576 577
}

Wim Taymans's avatar
Wim Taymans committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
/**
 * gst_event_new_caps:
 * @caps: a #GstCaps
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
 * synchronized with the buffer flow and contain the format of the buffers
 * that will follow after the event.
 *
 * Returns: (transfer full): the new CAPS event.
 */
GstEvent *
gst_event_new_caps (GstCaps * caps)
{
  GstEvent *event;

593 594
  g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), NULL);

Wim Taymans's avatar
Wim Taymans committed
595 596
  GST_CAT_INFO (GST_CAT_EVENT, "creating caps event %" GST_PTR_FORMAT, caps);

597
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
598 599 600 601 602 603 604 605 606 607 608
      gst_structure_id_new (GST_QUARK (EVENT_CAPS),
          GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));

  return event;
}

/**
 * gst_event_parse_caps:
 * @event: The event to parse
 * @caps: (out): A pointer to the caps
 *
609 610
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
611 612 613 614
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
615 616
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
617 618 619
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_CAPS);

Wim Taymans's avatar
Wim Taymans committed
620
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
621 622 623 624
  if (G_LIKELY (caps))
    *caps =
        g_value_get_boxed (gst_structure_id_get_value (structure,
            GST_QUARK (CAPS)));
Wim Taymans's avatar
Wim Taymans committed
625 626
}

627
/**
628
 * gst_event_new_new_segment:
629 630 631 632 633 634
 * @update: Whether this segment is an update to a previous one
 * @rate: A new rate for playback
 * @applied_rate: The rate factor which has already been applied
 * @format: The format of the segment values
 * @start: The start value of the segment
 * @stop: The stop value of the segment
635
 * @time: the time value of the segment
636 637
 *
 * Allocate a new newsegment event with the given format/values triplets.
Wim Taymans's avatar
Wim Taymans committed
638 639
 *
 * The newsegment event marks the range of buffers to be processed. All
640
 * data not within the segment range is not to be processed. This can be
641
 * used intelligently by plugins to apply more efficient methods of skipping
642 643
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
644
 *
645
 * The time value of the segment is used in conjunction with the start
646 647
 * value to convert the buffer timestamps into the stream time. This is 
 * usually done in sinks to report the current stream_time. 
648 649
 * @time represents the stream_time of a buffer carrying a timestamp of 
 * @start. @time cannot be -1.
650
 *
651
 * @start cannot be -1, @stop can be -1. If there
652
 * is a valid @stop given, it must be greater or equal the @start, including 
653
 * when the indicated playback @rate is < 0.
654 655 656 657 658 659 660 661
 *
 * The @applied_rate value provides information about any rate adjustment that
 * has already been made to the timestamps and content on the buffers of the 
 * stream. (@rate * @applied_rate) should always equal the rate that has been 
 * requested for playback. For example, if an element has an input segment 
 * with intended playback @rate of 2.0 and applied_rate of 1.0, it can adjust 
 * incoming timestamps and buffer content by half and output a newsegment event 
 * with @rate of 1.0 and @applied_rate of 2.0
662
 *
Wim Taymans's avatar
Wim Taymans committed
663 664
 * After a newsegment event, the buffer stream time is calculated with:
 *
665
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
666
 *
667
 * Returns: (transfer full): a new newsegment event.
668 669
 *
 * Since: 0.10.6
670
 */
671
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
672
gst_event_new_new_segment (gboolean update, gdouble rate,
673
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
674
    gint64 time)
675
{
676 677 678
  GstEvent *event;
  GstStructure *structure;

679
  g_return_val_if_fail (rate != 0.0, NULL);
680
  g_return_val_if_fail (applied_rate != 0.0, NULL);
681

682 683
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
684
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
685
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
686
        ", time %" GST_TIME_FORMAT,
687
        update, rate, GST_TIME_ARGS (start),
688
        GST_TIME_ARGS (stop), GST_TIME_ARGS (time));
689 690
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
691
        "creating newsegment update %d, rate %lf, format %s, "
692
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", time %"
693
        G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
694
        stop, time);
695
  }
696

697
  g_return_val_if_fail (time != -1, NULL);
698 699 700
  g_return_val_if_fail (start != -1, NULL);
  if (stop != -1)
    g_return_val_if_fail (start <= stop, NULL);
701

702
  structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
703 704 705 706 707 708
      GST_QUARK (UPDATE), G_TYPE_BOOLEAN, update,
      GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
      GST_QUARK (APPLIED_RATE), G_TYPE_DOUBLE, applied_rate,
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (START), G_TYPE_INT64, start,
      GST_QUARK (STOP), G_TYPE_INT64, stop,
709
      GST_QUARK (TIME), G_TYPE_INT64, time, NULL);
710 711 712
  event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
713
}
714

Wim Taymans's avatar
Wim Taymans committed
715
/**
Wim Taymans's avatar
Wim Taymans committed
716
 * gst_event_parse_new_segment:
Wim Taymans's avatar
Wim Taymans committed
717
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
718 719 720 721 722 723
 * @update: (out): A pointer to the update flag of the segment
 * @rate: (out): A pointer to the rate of the segment
 * @applied_rate: (out): A pointer to the applied_rate of the segment
 * @format: (out): A pointer to the format of the newsegment values
 * @start: (out): A pointer to store the start value in
 * @stop: (out): A pointer to store the stop value in
724
 * @time: (out): A pointer to store the time value in
Wim Taymans's avatar
Wim Taymans committed
725
 *
726
 * Get the update, rate, applied_rate, format, start, stop and 
Wim Taymans's avatar
Wim Taymans committed
727
 * time in the newsegment event. See gst_event_new_new_segment() 
728 729 730
 * for a full description of the newsegment event.
 *
 * Since: 0.10.6
Wim Taymans's avatar
Wim Taymans committed
731 732
 */
void
Wim Taymans's avatar
Wim Taymans committed
733
gst_event_parse_new_segment (GstEvent * event, gboolean * update,
734
    gdouble * rate, gdouble * applied_rate, GstFormat * format,
735
    gint64 * start, gint64 * stop, gint64 * time)
Wim Taymans's avatar
Wim Taymans committed
736 737
{
  const GstStructure *structure;
738

Wim Taymans's avatar
Wim Taymans committed
739 740 741
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);

Wim Taymans's avatar
Wim Taymans committed
742
  structure = GST_EVENT_STRUCTURE (event);
743
  if (G_LIKELY (update))
744
    *update =
745 746
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (UPDATE)));
747
  if (G_LIKELY (rate))
748 749 750
    *rate =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (RATE)));
751 752
  if (G_LIKELY (applied_rate))
    *applied_rate =
753 754
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (APPLIED_RATE)));
755
  if (G_LIKELY (format))
756 757 758
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
759
  if (G_LIKELY (start))
760 761 762
    *start =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (START)));
763
  if (G_LIKELY (stop))
764 765 766
    *stop =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (STOP)));
767 768
  if (G_LIKELY (time))
    *time =
769
        g_value_get_int64 (gst_structure_id_get_value (structure,
770
            GST_QUARK (TIME)));
Wim Taymans's avatar
Wim Taymans committed
771
}
772

773 774
/**
 * gst_event_new_tag:
775 776
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
777 778
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
779
 *
780
 * Returns: (transfer full): a new #GstEvent
781
 */
Wim Taymans's avatar
Wim Taymans committed
782 783 784 785
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
786

Wim Taymans's avatar
Wim Taymans committed
787
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
788 789
}

790 791 792
/**
 * gst_event_parse_tag:
 * @event: a tag event
793
 * @taglist: (out) (transfer none): pointer to metadata list
794 795
 *
 * Parses a tag @event and stores the results in the given @taglist location.
796 797 798
 * No reference to the taglist will be returned, it remains valid only until
 * the @event is freed. Don't modify or free the taglist, make a copy if you
 * want to modify it or store it for later use.
799
 */
Wim Taymans's avatar
Wim Taymans committed
800 801 802 803 804
void
gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
{
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
805

Wim Taymans's avatar
Wim Taymans committed
806
  if (taglist)
Wim Taymans's avatar
Wim Taymans committed
807
    *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
808 809
}

810 811
/* buffersize event */
/**
812
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
813 814 815 816
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
817 818 819 820
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
821
 * When the @async flag is set, a thread boundary is prefered.
822
 *
823
 * Returns: (transfer full): a new #GstEvent
824 825
 */
GstEvent *
826
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
827 828
    gint64 maxsize, gboolean async)
{
829 830 831
  GstEvent *event;
  GstStructure *structure;

832
  GST_CAT_INFO (GST_CAT_EVENT,
833 834
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
835
      minsize, maxsize, async);
836

837
  structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
838 839 840 841 842 843 844
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (MINSIZE), G_TYPE_INT64, minsize,
      GST_QUARK (MAXSIZE), G_TYPE_INT64, maxsize,
      GST_QUARK (ASYNC), G_TYPE_BOOLEAN, async, NULL);
  event = gst_event_new_custom (GST_EVENT_BUFFERSIZE, structure);

  return event;
845 846
}

Stefan Kost's avatar
Stefan Kost committed
847
/**
848
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
849
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
850 851 852 853
 * @format: (out): A pointer to store the format in
 * @minsize: (out): A pointer to store the minsize in
 * @maxsize: (out): A pointer to store the maxsize in
 * @async: (out): A pointer to store the async-flag in
Stefan Kost's avatar
Stefan Kost committed
854 855 856
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
857
void
858
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
859 860 861 862 863 864
    gint64 * minsize, gint64 * maxsize, gboolean * async)
{
  const GstStructure *structure;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_BUFFERSIZE);
865

Wim Taymans's avatar
Wim Taymans committed
866
  structure = GST_EVENT_STRUCTURE (event);
867
  if (format)
868 869 870
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
871 872
  if (minsize)
    *minsize =
873 874
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
875 876
  if (maxsize)
    *maxsize =
877 878
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
879
  if (async)
880 881 882
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
883 884
}

885
/**
Wim Taymans's avatar
Wim Taymans committed
886
 * gst_event_new_qos:
Wim Taymans's avatar
Wim Taymans committed
887 888 889 890 891
 * @type: the QoS type
 * @proportion: the proportion of the qos message
 * @diff: The time difference of the last Clock sync
 * @timestamp: The timestamp of the buffer
 *
Wim Taymans's avatar
Wim Taymans committed
892 893 894
 * Allocate a new qos event with the given values.
 * The QOS event is generated in an element that wants an upstream
 * element to either reduce or increase its rate because of
Wim Taymans's avatar
Wim Taymans committed
895 896 897 898 899 900 901 902 903 904
 * high/low CPU load or other resource usage such as network performance or
 * throttling. Typically sinks generate these events for each buffer
 * they receive.
 *
 * @type indicates the reason for the QoS event. #GST_QOS_TYPE_OVERFLOW is
 * used when a buffer arrived in time or when the sink cannot keep up with
 * the upstream datarate. #GST_QOS_TYPE_UNDERFLOW is when the sink is not
 * receiving buffers fast enough and thus has to drop late buffers. 
 * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
 * by the application, for example to reduce power consumption.
905 906 907 908 909 910 911 912 913 914 915 916 917 918
 *
 * @proportion indicates the real-time performance of the streaming in the
 * element that generated the QoS event (usually the sink). The value is
 * generally computed based on more long term statistics about the streams
 * timestamps compared to the clock.
 * A value < 1.0 indicates that the upstream element is producing data faster
 * than real-time. A value > 1.0 indicates that the upstream element is not
 * producing data fast enough. 1.0 is the ideal @proportion value. The
 * proportion value can safely be used to lower or increase the quality of
 * the element.
 *
 * @diff is the difference against the clock in running time of the last
 * buffer that caused the element to generate the QOS event. A negative value
 * means that the buffer with @timestamp arrived in time. A positive value
Wim Taymans's avatar
Wim Taymans committed
919 920
 * indicates how late the buffer with @timestamp was. When throttling is
 * enabled, @diff will be set to the requested throttling interval.
921
 *
922
 * @timestamp is the timestamp of the last buffer that cause the element
923 924
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
925 926
 *
 * The upstream element can use the @diff and @timestamp values to decide
927 928
 * whether to process more buffers. For possitive @diff, all buffers with
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
929 930
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
931 932 933
 *
 * The application can use general event probes to intercept the QoS
 * event and implement custom application specific QoS handling.
Wim Taymans's avatar
Wim Taymans committed
934
 *
935
 * Returns: (transfer full): a new QOS event.
936
 */
937
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
938
gst_event_new_qos (GstQOSType type, gdouble proportion,
Wim Taymans's avatar
Wim Taymans committed
939
    GstClockTimeDiff diff, GstClockTime timestamp)
940
{
941 942
  GstEvent *event;

943 944 945
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

946
  GST_CAT_INFO (GST_CAT_EVENT,
Wim Taymans's avatar
Wim Taymans committed
947 948
      "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
      ", timestamp %" GST_TIME_FORMAT, type, proportion,
949
      diff, GST_TIME_ARGS (timestamp));
950

951 952 953 954 955 956
  event = gst_event_new (GST_EVENT_QOS);

  GST_EVENT_IMPL (event, qos, type) = type;
  GST_EVENT_IMPL (event, qos, proportion) = proportion;
  GST_EVENT_IMPL (event, qos, diff) = diff;
  GST_EVENT_IMPL (event, qos, timestamp) = timestamp;
957 958

  return event;
Wim Taymans's avatar
Wim Taymans committed
959
}
960

Wim Taymans's avatar
Wim Taymans committed
961 962 963
/**
 * gst_event_parse_qos:
 * @event: The event to query
Wim Taymans's avatar
Wim Taymans committed
964 965 966 967 968 969
 * @type: (out): A pointer to store the QoS type in
 * @proportion: (out): A pointer to store the proportion in
 * @diff: (out): A pointer to store the diff in
 * @timestamp: (out): A pointer to store the timestamp in
 *
 * Get the type, proportion, diff and timestamp in the qos event. See
Wim Taymans's avatar
Wim Taymans committed
970
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
971 972
 */
void
Wim Taymans's avatar
Wim Taymans committed
973
gst_event_parse_qos (GstEvent * event, GstQOSType * type,
Wim Taymans's avatar
Wim Taymans committed
974
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
975 976 977
{
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
978

Wim Taymans's avatar
Wim Taymans committed
979
  if (type)
980
    *type = GST_EVENT_IMPL (event, qos, type);
Wim Taymans's avatar
Wim Taymans committed
981
  if (proportion)
982
    *proportion = GST_EVENT_IMPL (event, qos, proportion);
Wim Taymans's avatar
Wim Taymans committed
983
  if (diff)
984
    *diff = GST_EVENT_IMPL (event, qos, diff);