gstevent.c 41.1 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

88
static GType _gst_event_type = 0;
89

Wim Taymans's avatar
Wim Taymans committed
90 91 92 93 94 95 96 97 98
typedef struct
{
  GstEvent event;

  GstStructure *structure;
} GstEventImpl;

#define GST_EVENT_STRUCTURE(e)  (((GstEventImpl *)(e))->structure)

99 100
typedef struct
{
101 102
  const gint type;
  const gchar *name;
103 104 105 106 107 108 109 110
  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
111
  {GST_EVENT_CAPS, "caps", 0},
112 113
  {GST_EVENT_NEWSEGMENT, "newsegment", 0},
  {GST_EVENT_TAG, "tag", 0},
114
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
115
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
116 117 118
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
119
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
120
  {GST_EVENT_STEP, "step", 0},
121
  {GST_EVENT_RECONFIGURE, "reconfigure", 0},
122 123 124
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
125 126 127
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

128 129 130
  {0, NULL, 0}
};

131 132 133 134
void
_gst_event_initialize (void)
{
  gint i;
135 136

  gst_event_get_type ();
137 138 139 140 141 142 143 144
  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
145 146 147 148 149 150
/**
 * 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
151
 * Returns: a reference to the static name of the event.
Stefan Kost's avatar
Stefan Kost committed
152
 */
153 154 155 156 157 158 159 160 161 162 163 164
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
165 166 167 168 169 170 171 172
/**
 * 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
 */
173 174 175 176 177 178 179 180 181 182 183 184
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;
}

185 186 187 188 189 190 191 192 193 194 195 196 197
/**
 * 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;

198
  ret = type & ((1 << GST_EVENT_STICKY_SHIFT) - 1);
199 200 201 202

  return ret;
}

203 204
GType
gst_event_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
205
{
206 207 208 209
  if (G_UNLIKELY (_gst_event_type == 0)) {
    _gst_event_type = gst_mini_object_register ("GstEvent");
  }
  return _gst_event_type;
Wim Taymans's avatar
Wim Taymans committed
210 211
}

212
static void
213
_gst_event_free (GstEvent * event)
214
{
Wim Taymans's avatar
Wim Taymans committed
215 216
  GstStructure *s;

217 218 219
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

220
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
221
      GST_EVENT_TYPE_NAME (event));
Wim Taymans's avatar
Wim Taymans committed
222

Wim Taymans's avatar
Wim Taymans committed
223 224 225 226 227
  s = GST_EVENT_STRUCTURE (event);

  if (s) {
    gst_structure_set_parent_refcount (s, NULL);
    gst_structure_free (s);
228
  }
229

Wim Taymans's avatar
Wim Taymans committed
230
  g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
231 232
}

Wim Taymans's avatar
Wim Taymans committed
233 234
static void gst_event_init (GstEventImpl * event, gsize size,
    GstEventType type);
Wim Taymans's avatar
Wim Taymans committed
235

236 237 238
static GstEvent *
_gst_event_copy (GstEvent * event)
{
Wim Taymans's avatar
Wim Taymans committed
239 240
  GstEventImpl *copy;
  GstStructure *s;
241

Wim Taymans's avatar
Wim Taymans committed
242
  copy = g_slice_new0 (GstEventImpl);
243

Wim Taymans's avatar
Wim Taymans committed
244
  gst_event_init (copy, sizeof (GstEventImpl), GST_EVENT_TYPE (event));
245

Wim Taymans's avatar
Wim Taymans committed
246
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
247
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
248

Wim Taymans's avatar
Wim Taymans committed
249 250 251 252
  s = GST_EVENT_STRUCTURE (event);
  if (s) {
    GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
    gst_structure_set_parent_refcount (s, &copy->event.mini_object.refcount);
253
  }
Wim Taymans's avatar
Wim Taymans committed
254
  return GST_EVENT_CAST (copy);
255 256
}

Wim Taymans's avatar
Wim Taymans committed
257
static void
Wim Taymans's avatar
Wim Taymans committed
258
gst_event_init (GstEventImpl * event, gsize size, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
259
{
Wim Taymans's avatar
Wim Taymans committed
260
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type, size);
Wim Taymans's avatar
Wim Taymans committed
261

Wim Taymans's avatar
Wim Taymans committed
262 263
  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
264 265 266 267 268 269

  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
270 271
static GstEvent *
gst_event_new (GstEventType type)
272
{
Wim Taymans's avatar
Wim Taymans committed
273
  GstEventImpl *event;
274

Wim Taymans's avatar
Wim Taymans committed
275
  event = g_slice_new0 (GstEventImpl);
276

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
277 278
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
279

Wim Taymans's avatar
Wim Taymans committed
280
  gst_event_init (event, sizeof (GstEventImpl), type);
281

Wim Taymans's avatar
Wim Taymans committed
282
  return GST_EVENT_CAST (event);
283 284
}

285
/**
Wim Taymans's avatar
Wim Taymans committed
286
 * gst_event_new_custom:
287
 * @type: The type of the new event
288 289
 * @structure: (transfer full): the structure for the event. The event will
 *     take ownership of the structure.
290
 *
Wim Taymans's avatar
Wim Taymans committed
291 292 293
 * 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.
294
 *
Wim Taymans's avatar
Wim Taymans committed
295 296 297 298 299 300 301
 * 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.
 *
302
 * Returns: (transfer full): the new custom event.
303
 */
304
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
305
gst_event_new_custom (GstEventType type, GstStructure * structure)
306 307 308
{
  GstEvent *event;

309 310 311 312
  /* structure must not have a parent */
  if (structure)
    g_return_val_if_fail (structure->parent_refcount == NULL, NULL);

Wim Taymans's avatar
Wim Taymans committed
313 314 315
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
Wim Taymans's avatar
Wim Taymans committed
316
    GST_EVENT_STRUCTURE (event) = structure;
Wim Taymans's avatar
Wim Taymans committed
317
  }
318
  return event;
319 320
}

321
/**
Wim Taymans's avatar
Wim Taymans committed
322 323
 * gst_event_get_structure:
 * @event: The #GstEvent.
324
 *
Wim Taymans's avatar
Wim Taymans committed
325
 * Access the structure of the event.
326
 *
Wim Taymans's avatar
Wim Taymans committed
327 328 329 330 331
 * 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.
332
 */
Wim Taymans's avatar
Wim Taymans committed
333 334
const GstStructure *
gst_event_get_structure (GstEvent * event)
335
{
Wim Taymans's avatar
Wim Taymans committed
336
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
337

Wim Taymans's avatar
Wim Taymans committed
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
  return GST_EVENT_STRUCTURE (event);
}

/**
 * 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);

  structure = GST_EVENT_STRUCTURE (event);

  if (structure == NULL) {
    structure =
        gst_structure_id_empty_new (gst_event_type_to_quark (GST_EVENT_TYPE
            (event)));
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    GST_EVENT_STRUCTURE (event) = structure;
  }
  return structure;
372
}
373

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
/**
 * 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
391
  if (GST_EVENT_STRUCTURE (event) == NULL)
392 393
    return FALSE;

Wim Taymans's avatar
Wim Taymans committed
394
  return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
395 396
}

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
/**
 * 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;
}

451 452 453 454
/* 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
455
/**
Wim Taymans's avatar
Wim Taymans committed
456 457
 * gst_event_new_flush_start:
 *
458
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
459
 * upstream and downstream and travels out-of-bounds with the dataflow.
460 461 462 463 464
 *
 * 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
465
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
466
 *
467 468
 * 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
469
 *
470 471
 * 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
472
 *
473
 * Returns: (transfer full): a new flush start event.
Wim Taymans's avatar
Wim Taymans committed
474
 */
475
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
476
gst_event_new_flush_start (void)
477
{
Wim Taymans's avatar
Wim Taymans committed
478
  return gst_event_new (GST_EVENT_FLUSH_START);
479 480
}

481
/**
Wim Taymans's avatar
Wim Taymans committed
482 483
 * gst_event_new_flush_stop:
 *
484
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
485
 * upstream and downstream and travels serialized with the dataflow.
486
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
487
 * pads accept data again.
488
 *
Wim Taymans's avatar
Wim Taymans committed
489 490
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
491
 *
Wim Taymans's avatar
Wim Taymans committed
492 493 494
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
495
 * Returns: (transfer full): a new flush stop event.
496
 */
497
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
498
gst_event_new_flush_stop (void)
499
{
Wim Taymans's avatar
Wim Taymans committed
500
  return gst_event_new (GST_EVENT_FLUSH_STOP);
501 502
}

Wim Taymans's avatar
Wim Taymans committed
503
/**
Wim Taymans's avatar
Wim Taymans committed
504
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
505
 *
Wim Taymans's avatar
Wim Taymans committed
506 507
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
508 509
 * 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
510
 *
Jan Schmidt's avatar
Jan Schmidt committed
511
 * The EOS event will travel down to the sink elements in the pipeline
512
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
513
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
514
 *
515
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
516 517
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
518
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
519
 *
520
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
521
 */
Wim Taymans's avatar
Wim Taymans committed
522 523
GstEvent *
gst_event_new_eos (void)
524
{
Wim Taymans's avatar
Wim Taymans committed
525
  return gst_event_new (GST_EVENT_EOS);
526 527
}

Wim Taymans's avatar
Wim Taymans committed
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
/**
 * 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;

543 544
  g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), NULL);

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

547
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
548 549 550 551 552 553 554 555 556 557 558
      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
 *
559 560
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
561 562 563 564
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
565 566
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
567 568 569
  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
570
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
571 572 573 574
  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
575 576
}

577
/**
578
 * gst_event_new_new_segment:
579 580 581 582 583 584
 * @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
585
 * @time: the time value of the segment
586 587
 *
 * Allocate a new newsegment event with the given format/values triplets.
Wim Taymans's avatar
Wim Taymans committed
588 589
 *
 * The newsegment event marks the range of buffers to be processed. All
590
 * data not within the segment range is not to be processed. This can be
591
 * used intelligently by plugins to apply more efficient methods of skipping
592 593
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
594
 *
595
 * The time value of the segment is used in conjunction with the start
596 597
 * value to convert the buffer timestamps into the stream time. This is 
 * usually done in sinks to report the current stream_time. 
598 599
 * @time represents the stream_time of a buffer carrying a timestamp of 
 * @start. @time cannot be -1.
600
 *
601
 * @start cannot be -1, @stop can be -1. If there
602
 * is a valid @stop given, it must be greater or equal the @start, including 
603
 * when the indicated playback @rate is < 0.
604 605 606 607 608 609 610 611
 *
 * 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
612
 *
Wim Taymans's avatar
Wim Taymans committed
613 614
 * After a newsegment event, the buffer stream time is calculated with:
 *
615
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
616
 *
617
 * Returns: (transfer full): a new newsegment event.
618 619
 *
 * Since: 0.10.6
620
 */
621
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
622
gst_event_new_new_segment (gboolean update, gdouble rate,
623
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
624
    gint64 time)
625
{
626 627 628
  GstEvent *event;
  GstStructure *structure;

629
  g_return_val_if_fail (rate != 0.0, NULL);
630
  g_return_val_if_fail (applied_rate != 0.0, NULL);
631

632 633
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
634
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
635
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
636
        ", time %" GST_TIME_FORMAT,
637
        update, rate, GST_TIME_ARGS (start),
638
        GST_TIME_ARGS (stop), GST_TIME_ARGS (time));
639 640
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
641
        "creating newsegment update %d, rate %lf, format %s, "
642
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", time %"
643
        G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
644
        stop, time);
645
  }
646

647
  g_return_val_if_fail (time != -1, NULL);
648 649 650
  g_return_val_if_fail (start != -1, NULL);
  if (stop != -1)
    g_return_val_if_fail (start <= stop, NULL);
651

652
  structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
653 654 655 656 657 658
      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,
659
      GST_QUARK (TIME), G_TYPE_INT64, time, NULL);
660 661 662
  event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
663
}
664

Wim Taymans's avatar
Wim Taymans committed
665
/**
Wim Taymans's avatar
Wim Taymans committed
666
 * gst_event_parse_new_segment:
Wim Taymans's avatar
Wim Taymans committed
667
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
668 669 670 671 672 673
 * @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
674
 * @time: (out): A pointer to store the time value in
Wim Taymans's avatar
Wim Taymans committed
675
 *
676
 * Get the update, rate, applied_rate, format, start, stop and 
Wim Taymans's avatar
Wim Taymans committed
677
 * time in the newsegment event. See gst_event_new_new_segment() 
678 679 680
 * for a full description of the newsegment event.
 *
 * Since: 0.10.6
Wim Taymans's avatar
Wim Taymans committed
681 682
 */
void
Wim Taymans's avatar
Wim Taymans committed
683
gst_event_parse_new_segment (GstEvent * event, gboolean * update,
684
    gdouble * rate, gdouble * applied_rate, GstFormat * format,
685
    gint64 * start, gint64 * stop, gint64 * time)
Wim Taymans's avatar
Wim Taymans committed
686 687
{
  const GstStructure *structure;
688

Wim Taymans's avatar
Wim Taymans committed
689 690 691
  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
692
  structure = GST_EVENT_STRUCTURE (event);
693
  if (G_LIKELY (update))
694
    *update =
695 696
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (UPDATE)));
697
  if (G_LIKELY (rate))
698 699 700
    *rate =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (RATE)));
701 702
  if (G_LIKELY (applied_rate))
    *applied_rate =
703 704
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (APPLIED_RATE)));
705
  if (G_LIKELY (format))
706 707 708
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
709
  if (G_LIKELY (start))
710 711 712
    *start =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (START)));
713
  if (G_LIKELY (stop))
714 715 716
    *stop =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (STOP)));
717 718
  if (G_LIKELY (time))
    *time =
719
        g_value_get_int64 (gst_structure_id_get_value (structure,
720
            GST_QUARK (TIME)));
Wim Taymans's avatar
Wim Taymans committed
721
}
722

723 724
/**
 * gst_event_new_tag:
725 726
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
727 728
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
729
 *
730
 * Returns: (transfer full): a new #GstEvent
731
 */
Wim Taymans's avatar
Wim Taymans committed
732 733 734 735
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
736

Wim Taymans's avatar
Wim Taymans committed
737
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
738 739
}

740 741 742
/**
 * gst_event_parse_tag:
 * @event: a tag event
743
 * @taglist: (out) (transfer none): pointer to metadata list
744 745
 *
 * Parses a tag @event and stores the results in the given @taglist location.
746 747 748
 * 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.
749
 */
Wim Taymans's avatar
Wim Taymans committed
750 751 752 753 754
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);
755

Wim Taymans's avatar
Wim Taymans committed
756
  if (taglist)
Wim Taymans's avatar
Wim Taymans committed
757
    *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
758 759
}

760 761
/* buffersize event */
/**
762
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
763 764 765 766
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
767 768 769 770
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
771
 * When the @async flag is set, a thread boundary is prefered.
772
 *
773
 * Returns: (transfer full): a new #GstEvent
774 775
 */
GstEvent *
776
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
777 778
    gint64 maxsize, gboolean async)
{
779 780 781
  GstEvent *event;
  GstStructure *structure;

782
  GST_CAT_INFO (GST_CAT_EVENT,
783 784
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
785
      minsize, maxsize, async);
786

787
  structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
788 789 790 791 792 793 794
      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;
795 796
}

Stefan Kost's avatar
Stefan Kost committed
797
/**
798
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
799
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
800 801 802 803
 * @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
804 805 806
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
807
void
808
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
809 810 811 812 813 814
    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);
815

Wim Taymans's avatar
Wim Taymans committed
816
  structure = GST_EVENT_STRUCTURE (event);
817
  if (format)
818 819 820
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
821 822
  if (minsize)
    *minsize =
823 824
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
825 826
  if (maxsize)
    *maxsize =
827 828
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
829
  if (async)
830 831 832
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
833 834
}

835
/**
Wim Taymans's avatar
Wim Taymans committed
836
 * gst_event_new_qos:
Wim Taymans's avatar
Wim Taymans committed
837 838 839 840 841
 * @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
842 843 844
 * 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
845 846 847 848 849 850 851 852 853 854
 * 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.
855 856 857 858 859 860 861 862 863 864 865 866 867 868
 *
 * @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
869 870
 * indicates how late the buffer with @timestamp was. When throttling is
 * enabled, @diff will be set to the requested throttling interval.
871
 *
872
 * @timestamp is the timestamp of the last buffer that cause the element
873 874
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
875 876
 *
 * The upstream element can use the @diff and @timestamp values to decide
877 878
 * whether to process more buffers. For possitive @diff, all buffers with
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
879 880
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
881 882 883
 *
 * 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
884
 *
885
 * Returns: (transfer full): a new QOS event.
886
 */
887
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
888
gst_event_new_qos (GstQOSType type, gdouble proportion,
Wim Taymans's avatar
Wim Taymans committed
889
    GstClockTimeDiff diff, GstClockTime timestamp)
890
{
891 892 893
  GstEvent *event;
  GstStructure *structure;

894 895 896
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

897
  GST_CAT_INFO (GST_CAT_EVENT,
Wim Taymans's avatar
Wim Taymans committed
898 899
      "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
      ", timestamp %" GST_TIME_FORMAT, type, proportion,
900
      diff, GST_TIME_ARGS (timestamp));
901

902
  structure = gst_structure_id_new (GST_QUARK (EVENT_QOS),
Wim Taymans's avatar
Wim Taymans committed
903
      GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
904 905 906 907 908 909
      GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
      GST_QUARK (DIFF), G_TYPE_INT64, diff,
      GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
  event = gst_event_new_custom (GST_EVENT_QOS, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
910
}
911

Wim Taymans's avatar
Wim Taymans committed
912 913 914
/**
 * gst_event_parse_qos:
 * @event: The event to query
Wim Taymans's avatar
Wim Taymans committed
915 916 917 918 919 920
 * @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
921
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
922 923
 */
void
Wim Taymans's avatar
Wim Taymans committed
924
gst_event_parse_qos (GstEvent * event, GstQOSType * type,
Wim Taymans's avatar
Wim Taymans committed
925
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
926 927
{
  const GstStructure *structure;
928

Wim Taymans's avatar
Wim Taymans committed
929 930
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
931

Wim Taymans's avatar
Wim Taymans committed
932
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
933 934 935 936
  if (type)
    *type =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (TYPE)));
Wim Taymans's avatar
Wim Taymans committed
937 938
  if (proportion)
    *proportion =
939 940
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (PROPORTION)));
Wim Taymans's avatar
Wim Taymans committed
941
  if (diff)
942 943 944
    *diff =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (DIFF)));
Wim Taymans's avatar
Wim Taymans committed
945 946
  if (timestamp)
    *timestamp =
947 948
        g_value_get_uint64 (gst_structure_id_get_value (structure,
            GST_QUARK (TIMESTAMP)));
949
}
950 951

/**
Wim Taymans's avatar
Wim Taymans committed
952 953 954
 * gst_event_new_seek:
 * @rate: The new playback rate
 * @format: The format of the seek values
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
955
 * @flags: The optional seek flags
956 957
 * @start_type: The type and flags for the new start position
 * @start: The value of the new start position
Wim Taymans's avatar
Wim Taymans committed
958 959 960 961 962
 * @stop_type: The type and flags for the new stop position
 * @stop: The value of the new stop position
 *
 * Allocate a new seek event with the given parameters.
 *
963 964 965
 * The seek event configures playback of the pipeline between @start to @stop
 * at the speed given in @rate, also called a playback segment.
 * The @start and @stop values are expressed in @format.
966
 *
Wim Taymans's avatar
Wim Taymans committed
967 968
 * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
 * Negatives values means backwards playback. A value of 0.0 for the
969 970 971
 * rate is not allowed and should be accomplished instead by PAUSING the