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

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

119 120 121
  {0, NULL, 0}
};

122 123 124 125
void
_gst_event_initialize (void)
{
  gint i;
126 127

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

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

189
  ret = type & ((1 << GST_EVENT_STICKY_SHIFT) - 1);
190 191 192 193

  return ret;
}

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
217
  g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
218 219
}

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

222 223 224 225 226
static GstEvent *
_gst_event_copy (GstEvent * event)
{
  GstEvent *copy;

227 228
  copy = g_slice_new0 (GstEvent);

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

Wim Taymans's avatar
Wim Taymans committed
231
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
232
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
233

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

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

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

260
  event = g_slice_new0 (GstEvent);
261

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

Wim Taymans's avatar
Wim Taymans committed
265
  gst_event_init (event, sizeof (GstEvent), type);
266

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

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

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

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

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

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

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/**
 * 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;

495 496
  g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), NULL);

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

499
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
500 501 502 503 504 505 506 507 508 509 510
      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
 *
511 512
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
513 514 515 516
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
517 518
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
519 520 521
  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
522 523 524 525 526
  structure = event->structure;
  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
527 528
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

932
  structure = event->structure;
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
 * pipeline.
 *
972 973 974
 * 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. 
975
 *
976
 * @start_type and @stop_type specify how to adjust the currently configured 
977 978 979
 * 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.
980
 *
981
 * When the rate is positive and @start has been updated, playback will start
982 983 984 985 986
 * 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.
987 988 989 990
 *
 * 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
991
 * #GST_SEEK_TYPE_SET to the desired position. 
992
 *