We are currently experiencing downtime impacting viewing & cloning the Mesa repo, and some GitLab pages returning 503. Please see #freedesktop on IRC for more updates.

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

90 91
typedef struct
{
92 93
  const gint type;
  const gchar *name;
94 95 96 97 98 99 100 101 102 103
  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},
  {GST_EVENT_NEWSEGMENT, "newsegment", 0},
  {GST_EVENT_TAG, "tag", 0},
104
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
105
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
106 107 108
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
109
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
110
  {GST_EVENT_STEP, "step", 0},
111 112 113
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
114 115 116
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

117 118 119
  {0, NULL, 0}
};

120 121 122 123
void
_gst_event_initialize (void)
{
  gint i;
124 125

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

174 175 176 177 178 179 180 181 182 183 184 185 186
/**
 * 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;

187
  ret = type & ((1 << GST_EVENT_STICKY_SHIFT) - 1);
188 189 190 191

  return ret;
}

192 193
GType
gst_event_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
194
{
195 196 197 198
  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
199 200
}

201
static void
202
_gst_event_free (GstEvent * event)
203
{
204 205 206
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

207
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
208
      GST_EVENT_TYPE_NAME (event));
Wim Taymans's avatar
Wim Taymans committed
209

Wim Taymans's avatar
Wim Taymans committed
210 211 212
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
213
  }
214

Wim Taymans's avatar
Wim Taymans committed
215
  g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
216 217
}

Wim Taymans's avatar
Wim Taymans committed
218
static void gst_event_init (GstEvent * event, gsize size, GstEventType type);
Wim Taymans's avatar
Wim Taymans committed
219

220 221 222 223 224
static GstEvent *
_gst_event_copy (GstEvent * event)
{
  GstEvent *copy;

225 226
  copy = g_slice_new0 (GstEvent);

Wim Taymans's avatar
Wim Taymans committed
227
  gst_event_init (copy, sizeof (GstEvent), GST_EVENT_TYPE (event));
228

Wim Taymans's avatar
Wim Taymans committed
229
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
230
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
231

Wim Taymans's avatar
Wim Taymans committed
232 233 234
  if (event->structure) {
    copy->structure = gst_structure_copy (event->structure);
    gst_structure_set_parent_refcount (copy->structure,
235
        &copy->mini_object.refcount);
236 237
  }
  return copy;
238 239
}

Wim Taymans's avatar
Wim Taymans committed
240
static void
Wim Taymans's avatar
Wim Taymans committed
241
gst_event_init (GstEvent * event, gsize size, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
242
{
Wim Taymans's avatar
Wim Taymans committed
243
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type, size);
Wim Taymans's avatar
Wim Taymans committed
244 245 246 247 248 249 250 251 252

  event->mini_object.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
  event->mini_object.free = (GstMiniObjectFreeFunction) _gst_event_free;

  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
253 254
static GstEvent *
gst_event_new (GstEventType type)
255
{
Wim Taymans's avatar
Wim Taymans committed
256
  GstEvent *event;
257

258
  event = g_slice_new0 (GstEvent);
259

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
260 261
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
262

Wim Taymans's avatar
Wim Taymans committed
263
  gst_event_init (event, sizeof (GstEvent), type);
264

Wim Taymans's avatar
Wim Taymans committed
265
  return event;
266 267
}

268
/**
Wim Taymans's avatar
Wim Taymans committed
269
 * gst_event_new_custom:
270
 * @type: The type of the new event
271 272
 * @structure: (transfer full): the structure for the event. The event will
 *     take ownership of the structure.
273
 *
Wim Taymans's avatar
Wim Taymans committed
274 275 276
 * 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.
277
 *
Wim Taymans's avatar
Wim Taymans committed
278 279 280 281 282 283 284
 * 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.
 *
285
 * Returns: (transfer full): the new custom event.
286
 */
287
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
288
gst_event_new_custom (GstEventType type, GstStructure * structure)
289 290 291
{
  GstEvent *event;

292 293 294 295
  /* 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
296 297 298 299 300
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
301
  return event;
302 303
}

304
/**
Wim Taymans's avatar
Wim Taymans committed
305 306
 * gst_event_get_structure:
 * @event: The #GstEvent.
307
 *
Wim Taymans's avatar
Wim Taymans committed
308
 * Access the structure of the event.
309
 *
Wim Taymans's avatar
Wim Taymans committed
310 311 312 313 314
 * 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.
315
 */
Wim Taymans's avatar
Wim Taymans committed
316 317
const GstStructure *
gst_event_get_structure (GstEvent * event)
318
{
Wim Taymans's avatar
Wim Taymans committed
319
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
320

Wim Taymans's avatar
Wim Taymans committed
321
  return event->structure;
322
}
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
/**
 * 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);

  if (event->structure == NULL)
    return FALSE;

  return gst_structure_has_name (event->structure, name);
}

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

401 402 403 404
/* 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
405
/**
Wim Taymans's avatar
Wim Taymans committed
406 407
 * gst_event_new_flush_start:
 *
408
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
409
 * upstream and downstream and travels out-of-bounds with the dataflow.
410 411 412 413 414
 *
 * 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
415
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
416
 *
417 418
 * 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
419
 *
420 421
 * 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
422
 *
423
 * Returns: (transfer full): a new flush start event.
Wim Taymans's avatar
Wim Taymans committed
424
 */
425
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
426
gst_event_new_flush_start (void)
427
{
Wim Taymans's avatar
Wim Taymans committed
428
  return gst_event_new (GST_EVENT_FLUSH_START);
429 430
}

431
/**
Wim Taymans's avatar
Wim Taymans committed
432 433
 * gst_event_new_flush_stop:
 *
434
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
435
 * upstream and downstream and travels serialized with the dataflow.
436
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
437
 * pads accept data again.
438
 *
Wim Taymans's avatar
Wim Taymans committed
439 440
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
441
 *
Wim Taymans's avatar
Wim Taymans committed
442 443 444
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
445
 * Returns: (transfer full): a new flush stop event.
446
 */
447
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
448
gst_event_new_flush_stop (void)
449
{
Wim Taymans's avatar
Wim Taymans committed
450
  return gst_event_new (GST_EVENT_FLUSH_STOP);
451 452
}

Wim Taymans's avatar
Wim Taymans committed
453
/**
Wim Taymans's avatar
Wim Taymans committed
454
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
455
 *
Wim Taymans's avatar
Wim Taymans committed
456 457
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
458 459
 * 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
460
 *
Jan Schmidt's avatar
Jan Schmidt committed
461
 * The EOS event will travel down to the sink elements in the pipeline
462
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
463
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
464
 *
465
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
466 467
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
468
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
469
 *
470
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
471
 */
Wim Taymans's avatar
Wim Taymans committed
472 473
GstEvent *
gst_event_new_eos (void)
474
{
Wim Taymans's avatar
Wim Taymans committed
475
  return gst_event_new (GST_EVENT_EOS);
476 477
}

478
/**
479
 * gst_event_new_new_segment:
480
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
481 482
 * @rate: a new rate for playback
 * @format: The format of the segment values
483 484
 * @start: the start value of the segment
 * @stop: the stop value of the segment
485
 * @time: the time value of the segment
Wim Taymans's avatar
Wim Taymans committed
486
 *
487 488 489 490
 * Allocate a new newsegment event with the given format/values tripplets
 *
 * This method calls gst_event_new_new_segment_full() passing a default
 * value of 1.0 for applied_rate
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
491
 *
492
 * Returns: (transfer full): a new newsegment event.
493 494 495
 */
GstEvent *
gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format,
496
    gint64 start, gint64 stop, gint64 time)
497 498
{
  return gst_event_new_new_segment_full (update, rate, 1.0, format, start,
499
      stop, time);
500 501 502 503 504
}

/**
 * gst_event_parse_new_segment:
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
505 506 507 508 509
 * @update: (out): A pointer to the update flag of the segment
 * @rate: (out): A pointer to the 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
510
 * @time: (out): A pointer to store the time value in
511
 *
512
 * Get the update flag, rate, format, start, stop and time in the 
513 514 515 516 517 518 519 520
 * newsegment event. In general, gst_event_parse_new_segment_full() should
 * be used instead of this, to also retrieve the applied_rate value of the
 * segment. See gst_event_new_new_segment_full() for a full description 
 * of the newsegment event.
 */
void
gst_event_parse_new_segment (GstEvent * event, gboolean * update,
    gdouble * rate, GstFormat * format, gint64 * start,
521
    gint64 * stop, gint64 * time)
522 523
{
  gst_event_parse_new_segment_full (event, update, rate, NULL, format, start,
524
      stop, time);
525 526 527 528 529 530 531 532 533 534
}

/**
 * gst_event_new_new_segment_full:
 * @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
535
 * @time: the time value of the segment
536 537
 *
 * Allocate a new newsegment event with the given format/values triplets.
Wim Taymans's avatar
Wim Taymans committed
538 539
 *
 * The newsegment event marks the range of buffers to be processed. All
540
 * data not within the segment range is not to be processed. This can be
541
 * used intelligently by plugins to apply more efficient methods of skipping
542 543
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
544
 *
545
 * The time value of the segment is used in conjunction with the start
546 547
 * value to convert the buffer timestamps into the stream time. This is 
 * usually done in sinks to report the current stream_time. 
548 549
 * @time represents the stream_time of a buffer carrying a timestamp of 
 * @start. @time cannot be -1.
550
 *
551
 * @start cannot be -1, @stop can be -1. If there
552
 * is a valid @stop given, it must be greater or equal the @start, including 
553
 * when the indicated playback @rate is < 0.
554 555 556 557 558 559 560 561
 *
 * 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
562
 *
Wim Taymans's avatar
Wim Taymans committed
563 564
 * After a newsegment event, the buffer stream time is calculated with:
 *
565
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
566
 *
567
 * Returns: (transfer full): a new newsegment event.
568 569
 *
 * Since: 0.10.6
570
 */
571
GstEvent *
572 573
gst_event_new_new_segment_full (gboolean update, gdouble rate,
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
574
    gint64 time)
575
{
576 577 578
  GstEvent *event;
  GstStructure *structure;

579
  g_return_val_if_fail (rate != 0.0, NULL);
580
  g_return_val_if_fail (applied_rate != 0.0, NULL);
581

582 583
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
584
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
585
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
586
        ", time %" GST_TIME_FORMAT,
587
        update, rate, GST_TIME_ARGS (start),
588
        GST_TIME_ARGS (stop), GST_TIME_ARGS (time));
589 590
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
591
        "creating newsegment update %d, rate %lf, format %s, "
592
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", time %"
593
        G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
594
        stop, time);
595
  }
596

597
  g_return_val_if_fail (time != -1, NULL);
598 599 600
  g_return_val_if_fail (start != -1, NULL);
  if (stop != -1)
    g_return_val_if_fail (start <= stop, NULL);
601

602
  structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
603 604 605 606 607 608
      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,
609
      GST_QUARK (TIME), G_TYPE_INT64, time, NULL);
610 611 612
  event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
613
}
614

Wim Taymans's avatar
Wim Taymans committed
615
/**
616
 * gst_event_parse_new_segment_full:
Wim Taymans's avatar
Wim Taymans committed
617
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
618 619 620 621 622 623
 * @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
624
 * @time: (out): A pointer to store the time value in
Wim Taymans's avatar
Wim Taymans committed
625
 *
626
 * Get the update, rate, applied_rate, format, start, stop and 
627
 * time in the newsegment event. See gst_event_new_new_segment_full() 
628 629 630
 * for a full description of the newsegment event.
 *
 * Since: 0.10.6
Wim Taymans's avatar
Wim Taymans committed
631 632
 */
void
633 634
gst_event_parse_new_segment_full (GstEvent * event, gboolean * update,
    gdouble * rate, gdouble * applied_rate, GstFormat * format,
635
    gint64 * start, gint64 * stop, gint64 * time)
Wim Taymans's avatar
Wim Taymans committed
636 637
{
  const GstStructure *structure;
638

Wim Taymans's avatar
Wim Taymans committed
639 640 641
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);

642
  structure = event->structure;
643
  if (G_LIKELY (update))
644
    *update =
645 646
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (UPDATE)));
647
  if (G_LIKELY (rate))
648 649 650
    *rate =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (RATE)));
651 652
  if (G_LIKELY (applied_rate))
    *applied_rate =
653 654
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (APPLIED_RATE)));
655
  if (G_LIKELY (format))
656 657 658
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
659
  if (G_LIKELY (start))
660 661 662
    *start =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (START)));
663
  if (G_LIKELY (stop))
664 665 666
    *stop =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (STOP)));
667 668
  if (G_LIKELY (time))
    *time =
669
        g_value_get_int64 (gst_structure_id_get_value (structure,
670
            GST_QUARK (TIME)));
Wim Taymans's avatar
Wim Taymans committed
671
}
672

673 674
/**
 * gst_event_new_tag:
675 676
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
677 678
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
679
 *
680
 * Returns: (transfer full): a new #GstEvent
681
 */
Wim Taymans's avatar
Wim Taymans committed
682 683 684 685
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
686

Wim Taymans's avatar
Wim Taymans committed
687
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
688 689
}

690 691 692
/**
 * gst_event_parse_tag:
 * @event: a tag event
693
 * @taglist: (out) (transfer none): pointer to metadata list
694 695
 *
 * Parses a tag @event and stores the results in the given @taglist location.
696 697 698
 * 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.
699
 */
Wim Taymans's avatar
Wim Taymans committed
700 701 702 703 704
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);
705

Wim Taymans's avatar
Wim Taymans committed
706 707 708 709
  if (taglist)
    *taglist = (GstTagList *) event->structure;
}

710 711
/* buffersize event */
/**
712
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
713 714 715 716
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
717 718 719 720
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
721
 * When the @async flag is set, a thread boundary is prefered.
722
 *
723
 * Returns: (transfer full): a new #GstEvent
724 725
 */
GstEvent *
726
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
727 728
    gint64 maxsize, gboolean async)
{
729 730 731
  GstEvent *event;
  GstStructure *structure;

732
  GST_CAT_INFO (GST_CAT_EVENT,
733 734
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
735
      minsize, maxsize, async);
736

737
  structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
738 739 740 741 742 743 744
      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;
745 746
}

Stefan Kost's avatar
Stefan Kost committed
747
/**
748
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
749
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
750 751 752 753
 * @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
754 755 756
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
757
void
758
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
759 760 761 762 763 764
    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);
765

766
  structure = event->structure;
767
  if (format)
768 769 770
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
771 772
  if (minsize)
    *minsize =
773 774
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
775 776
  if (maxsize)
    *maxsize =
777 778
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
779
  if (async)
780 781 782
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
783 784
}

785
/**
Wim Taymans's avatar
Wim Taymans committed
786 787 788 789 790
 * gst_event_new_qos:
 * @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
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
 * Allocate a new qos event with the given values. This function calls
 * gst_event_new_qos_full() with the type set to #GST_QOS_TYPE_OVERFLOW
 * when diff is negative (buffers are in time) and #GST_QOS_TYPE_UNDERFLOW
 * when @diff is positive (buffers are late).
 *
 * Returns: (transfer full): a new QOS event.
 */
GstEvent *
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
{
  GstQOSType type;

  if (diff <= 0)
    type = GST_QOS_TYPE_OVERFLOW;
  else
    type = GST_QOS_TYPE_UNDERFLOW;

  return gst_event_new_qos_full (type, proportion, diff, timestamp);
}

/**
 * gst_event_new_qos_full:
 * @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
819 820 821
 * 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
822 823 824 825 826 827 828 829 830 831
 * 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.
832 833 834 835 836 837 838 839 840 841 842 843 844 845
 *
 * @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
846 847
 * indicates how late the buffer with @timestamp was. When throttling is
 * enabled, @diff will be set to the requested throttling interval.
848
 *
849
 * @timestamp is the timestamp of the last buffer that cause the element
850 851
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
852 853
 *
 * The upstream element can use the @diff and @timestamp values to decide
854 855
 * whether to process more buffers. For possitive @diff, all buffers with
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
856 857
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
858 859 860
 *
 * 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
861
 *
862
 * Returns: (transfer full): a new QOS event.
Wim Taymans's avatar
Wim Taymans committed
863 864
 *
 * Since: 0.10.33
865
 */
866
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
867 868
gst_event_new_qos_full (GstQOSType type, gdouble proportion,
    GstClockTimeDiff diff, GstClockTime timestamp)
869
{
870 871 872
  GstEvent *event;
  GstStructure *structure;

873 874 875
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

876
  GST_CAT_INFO (GST_CAT_EVENT,
Wim Taymans's avatar
Wim Taymans committed
877 878
      "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
      ", timestamp %" GST_TIME_FORMAT, type, proportion,
879
      diff, GST_TIME_ARGS (timestamp));
880

881
  structure = gst_structure_id_new (GST_QUARK (EVENT_QOS),
Wim Taymans's avatar
Wim Taymans committed
882
      GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
883 884 885 886 887 888
      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
889
}
890

Wim Taymans's avatar
Wim Taymans committed
891 892 893
/**
 * gst_event_parse_qos:
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
894 895 896
 * @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
Wim Taymans's avatar
Wim Taymans committed
897
 *
898 899
 * Get the proportion, diff and timestamp in the qos event. See
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
900 901 902 903
 */
void
gst_event_parse_qos (GstEvent * event, gdouble * proportion,
    GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
{
  gst_event_parse_qos_full (event, NULL, proportion, diff, timestamp);
}

/**
 * gst_event_parse_qos_full:
 * @event: The event to query
 * @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
 * gst_event_new_qos_full() for more information about the different QoS values.
 *
 * Since: 0.10.33
 */
void
gst_event_parse_qos_full (GstEvent * event, GstQOSType * type,
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
924 925
{
  const GstStructure *structure;
926

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

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

/**
Wim Taymans's avatar
Wim Taymans committed
950 951 952
 * 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
953
 * @flags: The optional seek flags
954 955
 * @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
956 957 958 959 960
 * @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.
 *
961 962 963
 * 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.
964
 *
Wim Taymans's avatar
Wim Taymans committed
965 966
 * 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
967 968 969
 * rate is not allowed and should be accomplished instead by PAUSING the
 * pipeline.
 *
970 971 972
 * A pipeline has a default playback segment configured with a start
 * position of 0, a stop position of -1 and a rate of 1.0. The currently
 * configured playback segment can be queried with #GST_QUERY_SEGMENT. 
973
 *
974
 * @start_type and @stop_type specify how to adjust the currently configured 
975 976 977
 * start and stop fields in playback segment. Adjustments can be made relative
 * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
 * means that the position should not be updated.
978
 *
979
 * When the rate is positive and @start has been updated, playback will start
980 981 982 983