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

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

  ret = type & ((1 << GST_EVENT_TYPE_SHIFT) - 1);

  return ret;
}

191 192
GType
gst_event_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
193
{
194 195 196
  if (G_UNLIKELY (_gst_event_type == 0)) {
    _gst_event_type = gst_mini_object_register ("GstEvent");
  }
Wim Taymans's avatar
Wim Taymans committed
197

198
  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

210 211
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
212
    GST_EVENT_SRC (event) = NULL;
213
  }
Wim Taymans's avatar
Wim Taymans committed
214 215 216
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
217
  }
218

219
  g_slice_free (GstEvent, event);
220 221 222 223 224 225 226
}

static GstEvent *
_gst_event_copy (GstEvent * event)
{
  GstEvent *copy;

227 228 229 230 231 232
  copy = g_slice_new0 (GstEvent);

  gst_mini_object_init (GST_MINI_OBJECT_CAST (copy),
      _gst_event_type, sizeof (GstEvent));
  event->mini_object.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
  event->mini_object.free = (GstMiniObjectFreeFunction) _gst_event_free;
233

Wim Taymans's avatar
Wim Taymans committed
234 235
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
236
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
237

Wim Taymans's avatar
Wim Taymans committed
238 239 240 241 242 243
  if (GST_EVENT_SRC (event)) {
    GST_EVENT_SRC (copy) = gst_object_ref (GST_EVENT_SRC (event));
  }
  if (event->structure) {
    copy->structure = gst_structure_copy (event->structure);
    gst_structure_set_parent_refcount (copy->structure,
244
        &copy->mini_object.refcount);
245 246
  }
  return copy;
247 248
}

Wim Taymans's avatar
Wim Taymans committed
249 250
static GstEvent *
gst_event_new (GstEventType type)
251
{
Wim Taymans's avatar
Wim Taymans committed
252
  GstEvent *event;
253

254
  event = g_slice_new0 (GstEvent);
255

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
256 257
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
258

259 260 261 262 263 264 265
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event),
      _gst_event_type, sizeof (GstEvent));

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

  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
266
  GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
267

Wim Taymans's avatar
Wim Taymans committed
268
  return event;
269 270
}

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

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

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

Wim Taymans's avatar
Wim Taymans committed
324
  return event->structure;
325
}
326

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

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

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

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

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

481
/**
482
 * gst_event_new_new_segment:
483
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
484 485
 * @rate: a new rate for playback
 * @format: The format of the segment values
486 487 488
 * @start: the start value of the segment
 * @stop: the stop value of the segment
 * @position: stream position
Wim Taymans's avatar
Wim Taymans committed
489
 *
490 491 492 493
 * 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
494
 *
495
 * Returns: (transfer full): a new newsegment event.
496 497 498 499 500 501 502 503 504 505 506 507
 */
GstEvent *
gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format,
    gint64 start, gint64 stop, gint64 position)
{
  return gst_event_new_new_segment_full (update, rate, 1.0, format, start,
      stop, position);
}

/**
 * gst_event_parse_new_segment:
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
508 509 510 511 512 513
 * @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
 * @position: (out): A pointer to store the stream time in
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
 *
 * Get the update flag, rate, format, start, stop and position in the 
 * 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,
    gint64 * stop, gint64 * position)
{
  gst_event_parse_new_segment_full (event, update, rate, NULL, format, start,
      stop, position);
}

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

582
  g_return_val_if_fail (rate != 0.0, NULL);
583
  g_return_val_if_fail (applied_rate != 0.0, NULL);
584

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

600 601 602 603
  g_return_val_if_fail (position != -1, NULL);
  g_return_val_if_fail (start != -1, NULL);
  if (stop != -1)
    g_return_val_if_fail (start <= stop, NULL);
604

605
  structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
606 607 608 609 610 611 612 613 614 615
      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,
      GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
  event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
616
}
617

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

Wim Taymans's avatar
Wim Taymans committed
642 643 644
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);

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

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

Wim Taymans's avatar
Wim Taymans committed
690
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
691 692
}

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

Wim Taymans's avatar
Wim Taymans committed
709 710 711 712
  if (taglist)
    *taglist = (GstTagList *) event->structure;
}

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

735
  GST_CAT_INFO (GST_CAT_EVENT,
736 737
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
738
      minsize, maxsize, async);
739

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

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

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

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

876 877 878
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

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

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

Wim Taymans's avatar
Wim Taymans committed
894 895 896
/**
 * gst_event_parse_qos:
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
897 898 899
 * @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
900
 *
901 902
 * 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
903 904 905 906
 */
void
gst_event_parse_qos (GstEvent * event, gdouble * proportion,
    GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
{
  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
927 928
{
  const GstStructure *structure;
929

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

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

/**
Wim Taymans's avatar
Wim Taymans committed
953 954 955
 * 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
956
 * @flags: The optional seek flags
957 958
 * @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
959 960 961 962 963
 * @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.
 *
964 965 966
 * 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.
967
 *
Wim Taymans's avatar
Wim Taymans committed
968 969
 * 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
970 971 972
 * rate is not allowed and should be accomplished instead by PAUSING the
 * pipeline.
 *
973 974 975
 * 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. 
976
 *
977
 * @start_type and @stop_type specify how to adjust the currently configured 
978 979 980
 * 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.
981
 *
982
 * When the rate is positive and @start has been updated, playback will start
983 984 985 986 987
 * from the newly configured start position. 
 *
 * For negative rates, playback will start from the newly configured stop
 * position (if any). If the stop position if updated, it must be different from
 * -1 for negative rates.
988 989 990 991
 *
 * It is not possible to seek relative to the current playback position, to do
 * this, PAUSE the pipeline, query the current playback position with
 * #GST_QUERY_POSITION and update the playback segment current position with a
992
 * #GST_SEEK_TYPE_SET to the desired position. 
993
 *
994
 * Returns: (transfer full): a new seek event.
995 996
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
997
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
998
    GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
999
{
1000 1001 1002
  GstEvent *event;
  GstStructure *structure;

1003 1004
  g_return_val_if_fail (rate != 0.0, NULL);

1005 1006 1007
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating seek rate %lf, format TIME, flags %d, "
1008
        "start_type %d, start %" GST_TIME_FORMAT ", "
1009
        "stop_type %d, stop %" GST_TIME_FORMAT,
1010
        rate, flags, start_type, GST_TIME_ARGS (start),
1011 1012 1013
        stop_type, GST_TIME_ARGS (stop));
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
1014
        "creating seek rate %lf, format %s, flags %d, "
1015
        "start_type %d, start %" G_GINT64_FORMAT ", "
1016
        "stop_type %d, stop %" G_GINT64_FORMAT,
1017 1018
        rate, gst_format_get_name (format), flags, start_type, start, stop_type,
        stop);
1019 1020
  }

1021
  structure = gst_structure_id_new (GST_QUARK (EVENT_SEEK),
1022 1023 1024 1025 1026 1027