gstevent.c 67.4 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
 *
 * 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
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
20 21
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
22
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
23

24 25
/**
 * SECTION:gstevent
26
 * @title: GstEvent
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
27 28
 * @short_description: Structure describing events that are passed up and down
 *                     a pipeline
29 30
 * @see_also: #GstPad, #GstElement
 *
Wim Taymans's avatar
Wim Taymans committed
31
 * The event class provides factory methods to construct events for sending
Stefan Kost's avatar
Stefan Kost committed
32
 * and functions to query (parse) received events.
33
 *
34 35
 * Events are usually created with gst_event_new_*() which takes event-type
 * specific parameters as arguments.
36 37
 * 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().
38 39
 * The event should be unreffed with gst_event_unref() if it has not been sent.
 *
Wim Taymans's avatar
Wim Taymans committed
40
 * Events that have been received can be parsed with their respective
41
 * gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.
42
 *
Wim Taymans's avatar
Wim Taymans committed
43 44
 * 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,
Wim Taymans's avatar
Wim Taymans committed
45 46
 * others only upstream. Some events can travel both upstream and downstream.
 *
47 48 49
 * 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
50
 *
Wim Taymans's avatar
Wim Taymans committed
51 52
 * Most of the event API is used inside plugins. Applications usually only
 * construct and use seek events.
53
 * To do that gst_event_new_seek() is used to create a seek event. It takes
Piotr Fusik's avatar
Piotr Fusik committed
54
 * the needed parameters to specify seeking time and mode.
55
 * |[<!-- language="C" -->
Wim Taymans's avatar
Wim Taymans committed
56 57 58 59 60
 *   GstEvent *event;
 *   gboolean result;
 *   ...
 *   // construct a seek event to play the media from second 2 to 5, flush
 *   // the pipeline to decrease latency.
61 62
 *   event = gst_event_new_seek (1.0,
 *      GST_FORMAT_TIME,
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
63 64 65
 *      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
66 67 68 69 70
 *   ...
 *   result = gst_element_send_event (pipeline, event);
 *   if (!result)
 *     g_warning ("seek failed");
 *   ...
71
 * ]|
72
 */
Wim Taymans's avatar
Wim Taymans committed
73

74

75
#include "gst_private.h"
76
#include <string.h>             /* memcpy */
77 78

#include "gstinfo.h"
79
#include "gstevent.h"
Wim Taymans's avatar
Wim Taymans committed
80
#include "gstenumtypes.h"
81
#include "gstutils.h"
82
#include "gstquark.h"
83
#include "gstvalue.h"
Benjamin Otte's avatar
Benjamin Otte committed
84

Wim Taymans's avatar
Wim Taymans committed
85
GType _gst_event_type = 0;
86

Wim Taymans's avatar
Wim Taymans committed
87 88 89 90 91
typedef struct
{
  GstEvent event;

  GstStructure *structure;
92
  gint64 running_time_offset;
Wim Taymans's avatar
Wim Taymans committed
93 94
} GstEventImpl;

95
#define GST_EVENT_STRUCTURE(e)  (((GstEventImpl *)(e))->structure)
Wim Taymans's avatar
Wim Taymans committed
96

97 98
typedef struct
{
99 100
  const gint type;
  const gchar *name;
101 102 103 104 105 106 107
  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},
108
  {GST_EVENT_SELECT_STREAMS, "select-streams", 0},
Wim Taymans's avatar
Wim Taymans committed
109
  {GST_EVENT_STREAM_START, "stream-start", 0},
110
  {GST_EVENT_STREAM_COLLECTION, "stream-collection", 0},
Wim Taymans's avatar
Wim Taymans committed
111
  {GST_EVENT_CAPS, "caps", 0},
Wim Taymans's avatar
Wim Taymans committed
112
  {GST_EVENT_SEGMENT, "segment", 0},
113
  {GST_EVENT_TAG, "tag", 0},
114
  {GST_EVENT_TOC, "toc", 0},
115
  {GST_EVENT_PROTECTION, "protection", 0},
116
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
117
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
Wim Taymans's avatar
Wim Taymans committed
118 119
  {GST_EVENT_EOS, "eos", 0},
  {GST_EVENT_SEGMENT_DONE, "segment-done", 0},
120
  {GST_EVENT_GAP, "gap", 0},
121 122 123
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
124
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
125
  {GST_EVENT_STEP, "step", 0},
126
  {GST_EVENT_RECONFIGURE, "reconfigure", 0},
127
  {GST_EVENT_TOC_SELECT, "toc-select", 0},
128 129 130
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
Wim Taymans's avatar
Wim Taymans committed
131
  {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
132 133
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},
134
  {GST_EVENT_STREAM_GROUP_DONE, "stream-group-done", 0},
135

136 137 138
  {0, NULL, 0}
};

139
GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
Wim Taymans's avatar
Wim Taymans committed
140

141
void
142
_priv_gst_event_initialize (void)
143 144
{
  gint i;
145

Wim Taymans's avatar
Wim Taymans committed
146
  _gst_event_type = gst_event_get_type ();
Wim Taymans's avatar
Wim Taymans committed
147

148 149 150 151 152 153 154 155
  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
156 157 158 159 160 161
/**
 * 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
162
 * Returns: a reference to the static name of the event.
Stefan Kost's avatar
Stefan Kost committed
163
 */
164 165 166 167 168 169 170 171 172 173 174 175
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
176 177 178 179 180 181 182 183
/**
 * 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
 */
184 185 186 187 188 189 190 191 192 193 194 195
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;
}

196 197 198 199 200 201 202 203 204 205 206 207 208
/**
 * 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;

209
  ret = type & ((1 << GST_EVENT_NUM_SHIFT) - 1);
210 211 212 213

  return ret;
}

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

219 220 221
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

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

Wim Taymans's avatar
Wim Taymans committed
225 226 227 228 229
  s = GST_EVENT_STRUCTURE (event);

  if (s) {
    gst_structure_set_parent_refcount (s, NULL);
    gst_structure_free (s);
230
  }
231 232 233
#ifdef USE_POISONING
  memset (event, 0xff, sizeof (GstEventImpl));
#endif
234

235
  g_slice_free1 (sizeof (GstEventImpl), event);
236 237
}

238
static void gst_event_init (GstEventImpl * event, GstEventType type);
239

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

246 247
  copy = g_slice_new0 (GstEventImpl);

248
  gst_event_init (copy, GST_EVENT_TYPE (event));
249

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

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

  ((GstEventImpl *) copy)->running_time_offset =
      ((GstEventImpl *) event)->running_time_offset;

Wim Taymans's avatar
Wim Taymans committed
265
  return GST_EVENT_CAST (copy);
266 267
}

Wim Taymans's avatar
Wim Taymans committed
268
static void
269
gst_event_init (GstEventImpl * event, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
270
{
271
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), 0, _gst_event_type,
272 273
      (GstMiniObjectCopyFunction) _gst_event_copy, NULL,
      (GstMiniObjectFreeFunction) _gst_event_free);
Wim Taymans's avatar
Wim Taymans committed
274 275 276 277

  GST_EVENT_TYPE (event) = type;
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
  GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
278
  event->running_time_offset = 0;
Wim Taymans's avatar
Wim Taymans committed
279 280
}

281

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

  event = g_slice_new0 (GstEventImpl);

  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
310

Wim Taymans's avatar
Wim Taymans committed
311
  if (structure) {
Wim Taymans's avatar
Wim Taymans committed
312
    /* structure must not have a parent */
Wim Taymans's avatar
Wim Taymans committed
313
    if (!gst_structure_set_parent_refcount (structure,
Wim Taymans's avatar
Wim Taymans committed
314
            &event->event.mini_object.refcount))
Wim Taymans's avatar
Wim Taymans committed
315 316
      goto had_parent;

Wim Taymans's avatar
Wim Taymans committed
317
  }
318
  gst_event_init (event, type);
Wim Taymans's avatar
Wim Taymans committed
319 320 321 322

  GST_EVENT_STRUCTURE (event) = structure;

  return GST_EVENT_CAST (event);
Wim Taymans's avatar
Wim Taymans committed
323 324 325 326

  /* ERRORS */
had_parent:
  {
327
    g_slice_free1 (sizeof (GstEventImpl), event);
Wim Taymans's avatar
Wim Taymans committed
328 329 330
    g_warning ("structure is already owned by another object");
    return NULL;
  }
331 332
}

333
/**
Wim Taymans's avatar
Wim Taymans committed
334 335
 * gst_event_get_structure:
 * @event: The #GstEvent.
336
 *
Wim Taymans's avatar
Wim Taymans committed
337
 * Access the structure of the event.
338
 *
339 340 341
 * Returns: (transfer none) (nullable): 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.
Wim Taymans's avatar
Wim Taymans committed
342 343
 *
 * MT safe.
344
 */
Wim Taymans's avatar
Wim Taymans committed
345 346
const GstStructure *
gst_event_get_structure (GstEvent * event)
347
{
Wim Taymans's avatar
Wim Taymans committed
348
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
349

350
  return GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
351 352 353 354 355 356 357 358
}

/**
 * gst_event_writable_structure:
 * @event: The #GstEvent.
 *
 * Get a writable version of the structure.
 *
359 360 361 362 363
 * Returns: (transfer none): The structure of the event. The structure
 * is still owned by the event, which means that you should not free
 * it and that the pointer becomes invalid when you free the event.
 * This function checks if @event is writable and will never return
 * %NULL.
Wim Taymans's avatar
Wim Taymans committed
364 365 366 367 368 369 370 371 372 373 374
 *
 * MT safe.
 */
GstStructure *
gst_event_writable_structure (GstEvent * event)
{
  GstStructure *structure;

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

375
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
376

377
  if (structure == NULL) {
Wim Taymans's avatar
Wim Taymans committed
378
    structure =
Wim Taymans's avatar
Wim Taymans committed
379
        gst_structure_new_id_empty (gst_event_type_to_quark (GST_EVENT_TYPE
380 381 382 383
            (event)));
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    GST_EVENT_STRUCTURE (event) = structure;
  }
Wim Taymans's avatar
Wim Taymans committed
384
  return structure;
385
}
386

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
/**
 * 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.
 */
gboolean
gst_event_has_name (GstEvent * event, const gchar * name)
{
  g_return_val_if_fail (GST_IS_EVENT (event), FALSE);

Wim Taymans's avatar
Wim Taymans committed
402
  if (GST_EVENT_STRUCTURE (event) == NULL)
403 404
    return FALSE;

Wim Taymans's avatar
Wim Taymans committed
405
  return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
406 407
}

408 409 410 411 412 413 414 415 416 417 418 419 420 421
/**
 * 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;
422
 * two events or messages will never have the same sequence number unless
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
 * that correspondence was made explicitly.
 *
 * Returns: The event's sequence number.
 *
 * MT safe.
 */
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.
 */
void
gst_event_set_seqnum (GstEvent * event, guint32 seqnum)
{
  g_return_if_fail (GST_IS_EVENT (event));
454
  g_return_if_fail (seqnum != GST_SEQNUM_INVALID);
455
  g_return_if_fail (gst_event_is_writable (event));
456 457 458

  GST_EVENT_SEQNUM (event) = seqnum;
}
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503

/**
 * gst_event_get_running_time_offset:
 * @event: A #GstEvent.
 *
 * Retrieve the accumulated running time offset of the event.
 *
 * Events passing through #GstPads that have a running time
 * offset set via gst_pad_set_offset() will get their offset
 * adjusted according to the pad's offset.
 *
 * If the event contains any information that related to the
 * running time, this information will need to be updated
 * before usage with this offset.
 *
 * Returns: The event's running time offset
 *
 * MT safe.
 *
 * Since: 1.4
 */
gint64
gst_event_get_running_time_offset (GstEvent * event)
{
  g_return_val_if_fail (GST_IS_EVENT (event), 0);

  return ((GstEventImpl *) event)->running_time_offset;
}

/**
 * gst_event_set_running_time_offset:
 * @event: A #GstEvent.
 * @offset: A the new running time offset
 *
 * Set the running time offset of a event. See
 * gst_event_get_running_time_offset() for more information.
 *
 * MT safe.
 *
 * Since: 1.4
 */
void
gst_event_set_running_time_offset (GstEvent * event, gint64 offset)
{
  g_return_if_fail (GST_IS_EVENT (event));
504
  g_return_if_fail (gst_event_is_writable (event));
505 506 507

  ((GstEventImpl *) event)->running_time_offset = offset;
}
508

Wim Taymans's avatar
Wim Taymans committed
509
/**
Wim Taymans's avatar
Wim Taymans committed
510 511
 * gst_event_new_flush_start:
 *
512
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
513
 * upstream and downstream and travels out-of-bounds with the dataflow.
514 515
 *
 * It marks pads as being flushing and will make them return
516
 * #GST_FLOW_FLUSHING when used for data flow with gst_pad_push(),
517 518
 * gst_pad_chain(), gst_pad_get_range() and gst_pad_pull_range().
 * Any event (except a #GST_EVENT_FLUSH_STOP) received
519
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
520
 *
521 522
 * 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
523
 *
524 525
 * 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
526
 *
527
 * Returns: (transfer full): a new flush start event.
Wim Taymans's avatar
Wim Taymans committed
528
 */
529
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
530
gst_event_new_flush_start (void)
531
{
Wim Taymans's avatar
Wim Taymans committed
532
  return gst_event_new_custom (GST_EVENT_FLUSH_START, NULL);
533 534
}

535
/**
Wim Taymans's avatar
Wim Taymans committed
536
 * gst_event_new_flush_stop:
537
 * @reset_time: if time should be reset
Wim Taymans's avatar
Wim Taymans committed
538
 *
539
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
540
 * upstream and downstream and travels serialized with the dataflow.
541
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
542
 * pads accept data again.
543
 *
Wim Taymans's avatar
Wim Taymans committed
544
 * Elements can process this event synchronized with the dataflow since
545
 * the preceding FLUSH_START event stopped the dataflow.
546
 *
Wim Taymans's avatar
Wim Taymans committed
547 548 549
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
550
 * Returns: (transfer full): a new flush stop event.
551
 */
552
GstEvent *
553
gst_event_new_flush_stop (gboolean reset_time)
554
{
555 556 557 558 559
  GstEvent *event;

  GST_CAT_INFO (GST_CAT_EVENT, "creating flush stop %d", reset_time);

  event = gst_event_new_custom (GST_EVENT_FLUSH_STOP,
Wim Taymans's avatar
Wim Taymans committed
560
      gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
          GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL));

  return event;
}

/**
 * gst_event_parse_flush_stop:
 * @event: The event to parse
 * @reset_time: (out): if time should be reset
 *
 * Parse the FLUSH_STOP event and retrieve the @reset_time member.
 */
void
gst_event_parse_flush_stop (GstEvent * event, gboolean * reset_time)
{
  GstStructure *structure;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP);

  structure = GST_EVENT_STRUCTURE (event);
  if (G_LIKELY (reset_time))
    *reset_time =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (RESET_TIME)));
586 587
}

588 589
/**
 * gst_event_new_select_streams:
590
 * @streams: (element-type utf8) (transfer none): the list of streams to
591 592 593 594 595 596 597 598
 * activate
 *
 * Allocate a new select-streams event.
 *
 * The select-streams event requests the specified @streams to be activated.
 *
 * The list of @streams corresponds to the "Stream ID" of each stream to be
 * activated. Those ID can be obtained via the #GstStream objects present
599
 * in #GST_EVENT_STREAM_START, #GST_EVENT_STREAM_COLLECTION or
600
 * #GST_MESSAGE_STREAM_COLLECTION.
601
 *
602 603 604 605
 * Note: The list of @streams can not be empty.
 *
 * Returns: (transfer full): a new select-streams event or %NULL in case of
 * an error (like an empty streams list).
606 607
 *
 * Since: 1.10
608 609 610 611 612 613 614 615 616
 */
GstEvent *
gst_event_new_select_streams (GList * streams)
{
  GstEvent *event;
  GValue val = G_VALUE_INIT;
  GstStructure *struc;
  GList *tmpl;

617 618
  g_return_val_if_fail (streams != NULL, NULL);

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
  GST_CAT_INFO (GST_CAT_EVENT, "Creating new select-streams event");
  struc = gst_structure_new_id_empty (GST_QUARK (EVENT_SELECT_STREAMS));
  g_value_init (&val, GST_TYPE_LIST);
  /* Fill struc with streams */
  for (tmpl = streams; tmpl; tmpl = tmpl->next) {
    GValue strval = G_VALUE_INIT;
    const gchar *str = (const gchar *) tmpl->data;
    g_value_init (&strval, G_TYPE_STRING);
    g_value_set_string (&strval, str);
    gst_value_list_append_and_take_value (&val, &strval);
  }
  gst_structure_id_take_value (struc, GST_QUARK (STREAMS), &val);
  event = gst_event_new_custom (GST_EVENT_SELECT_STREAMS, struc);

  return event;
}

/**
 * gst_event_parse_select_streams:
 * @event: The event to parse
639
 * @streams: (out) (element-type utf8) (transfer full): the streams
640 641
 *
 * Parse the SELECT_STREAMS event and retrieve the contained streams.
642 643
 *
 * Since: 1.10
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
 */
void
gst_event_parse_select_streams (GstEvent * event, GList ** streams)
{
  GstStructure *structure;
  GList *res = NULL;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SELECT_STREAMS);

  structure = GST_EVENT_STRUCTURE (event);
  if (G_LIKELY (streams)) {
    const GValue *vlist =
        gst_structure_id_get_value (structure, GST_QUARK (STREAMS));
    guint i, sz = gst_value_list_get_size (vlist);
    for (i = 0; i < sz; i++) {
      const GValue *strv = gst_value_list_get_value (vlist, i);
      res = g_list_append (res, g_value_dup_string (strv));
    }
    *streams = res;
  }
}


668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
/**
 * gst_event_new_stream_group_done:
 * @group_id: the group id of the stream group which is ending
 *
 * Create a new Stream Group Done event. The stream-group-done event can
 * only travel downstream synchronized with the buffer flow. Elements
 * that receive the event on a pad should handle it mostly like EOS,
 * and emit any data or pending buffers that would depend on more data
 * arriving and unblock, since there won't be any more data.
 *
 * This event is followed by EOS at some point in the future, and is
 * generally used when switching pads - to unblock downstream so that
 * new pads can be exposed before sending EOS on the existing pads.
 *
 * Returns: (transfer full): the new stream-group-done event.
 *
 * Since: 1.10
 */
GstEvent *
gst_event_new_stream_group_done (guint group_id)
{
  GstStructure *s;

  s = gst_structure_new_id (GST_QUARK (EVENT_STREAM_GROUP_DONE),
      GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id, NULL);

  return gst_event_new_custom (GST_EVENT_STREAM_GROUP_DONE, s);
}

/**
 * gst_event_parse_stream_group_done:
 * @event: a stream-group-done event.
 * @group_id: (out): address of variable to store the group id into
 *
 * Parse a stream-group-done @event and store the result in the given
 * @group_id location.
 *
 * Since: 1.10
 */
void
gst_event_parse_stream_group_done (GstEvent * event, guint * group_id)
{
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_GROUP_DONE);

  if (group_id) {
    gst_structure_id_get (GST_EVENT_STRUCTURE (event),
        GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id, NULL);
  }
}

Wim Taymans's avatar
Wim Taymans committed
719
/**
Wim Taymans's avatar
Wim Taymans committed
720
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
721
 *
Wim Taymans's avatar
Wim Taymans committed
722 723
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
Wim Taymans's avatar
Wim Taymans committed
724
 * event on a pad can return #GST_FLOW_EOS as a #GstFlowReturn
725
 * when data after the EOS event arrives.
Wim Taymans's avatar
Wim Taymans committed
726
 *
Jan Schmidt's avatar
Jan Schmidt committed
727
 * The EOS event will travel down to the sink elements in the pipeline
728
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
729
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
730
 *
731
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
732 733
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
734
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
735
 *
736
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
737
 */
Wim Taymans's avatar
Wim Taymans committed
738 739
GstEvent *
gst_event_new_eos (void)
740
{
Wim Taymans's avatar
Wim Taymans committed
741
  return gst_event_new_custom (GST_EVENT_EOS, NULL);
742 743
}

744 745
/**
 * gst_event_new_gap:
746 747
 * @timestamp: the start time (pts) of the gap
 * @duration: the duration of the gap
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
 *
 * Create a new GAP event. A gap event can be thought of as conceptually
 * equivalent to a buffer to signal that there is no data for a certain
 * amount of time. This is useful to signal a gap to downstream elements
 * which may wait for data, such as muxers or mixers or overlays, especially
 * for sparse streams such as subtitle streams.
 *
 * Returns: (transfer full): the new GAP event.
 */
GstEvent *
gst_event_new_gap (GstClockTime timestamp, GstClockTime duration)
{
  GstEvent *event;

  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);

  GST_CAT_TRACE (GST_CAT_EVENT, "creating gap %" GST_TIME_FORMAT " - "
      "%" GST_TIME_FORMAT " (duration: %" GST_TIME_FORMAT ")",
766 767
      GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
      GST_TIME_ARGS (duration));
768 769 770 771 772 773 774 775 776 777 778

  event = gst_event_new_custom (GST_EVENT_GAP,
      gst_structure_new_id (GST_QUARK (EVENT_GAP),
          GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
          GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL));

  return event;
}

/**
 * gst_event_parse_gap:
Wim Taymans's avatar
Wim Taymans committed
779
 * @event: a #GstEvent of type #GST_EVENT_GAP
780 781
 * @timestamp: (out) (allow-none): location where to store the
 *     start time (pts) of the gap, or %NULL
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
 * @duration: (out) (allow-none): location where to store the duration of
 *     the gap, or %NULL
 *
 * Extract timestamp and duration from a new GAP event.
 */
void
gst_event_parse_gap (GstEvent * event, GstClockTime * timestamp,
    GstClockTime * duration)
{
  GstStructure *structure;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_GAP);

  structure = GST_EVENT_STRUCTURE (event);
  gst_structure_id_get (structure,
      GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
      GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL);
}

Wim Taymans's avatar
Wim Taymans committed
802 803
/**
 * gst_event_new_caps:
804
 * @caps: (transfer none): a #GstCaps
Wim Taymans's avatar
Wim Taymans committed
805 806
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
Wim Taymans's avatar
Wim Taymans committed
807
 * synchronized with the buffer flow and contains the format of the buffers
Wim Taymans's avatar
Wim Taymans committed
808 809
 * that will follow after the event.
 *
810
 * Returns: (transfer full) (nullable): the new CAPS event.
Wim Taymans's avatar
Wim Taymans committed
811 812 813 814 815 816
 */
GstEvent *
gst_event_new_caps (GstCaps * caps)
{
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
817 818
  g_return_val_if_fail (caps != NULL, NULL);
  g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
819

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

822
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
823
      gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Wim Taymans's avatar
Wim Taymans committed
824 825 826 827 828 829 830 831
          GST_QUARK (CAPS), GST_TYPE_CAPS, caps, NULL));

  return event;
}

/**
 * gst_event_parse_caps:
 * @event: The event to parse
Wim Taymans's avatar
Wim Taymans committed
832
 * @caps: (out) (transfer none): A pointer to the caps
Wim Taymans's avatar
Wim Taymans committed
833
 *
834 835
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
836 837 838 839
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
840 841
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
842 843 844
  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
845
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
846 847 848 849
  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
850 851
}

852
/**
Wim Taymans's avatar
Wim Taymans committed
853
 * gst_event_new_segment:
854
 * @segment: (transfer none): a #GstSegment
855
 *
Wim Taymans's avatar
Wim Taymans committed
856 857 858
 * Create a new SEGMENT event for @segment. The segment event can only travel
 * downstream synchronized with the buffer flow and contains timing information
 * and playback properties for the buffers that will follow.
Wim Taymans's avatar
Wim Taymans committed
859
 *
860
 * The segment event marks the range of buffers to be processed. All
861
 * data not within the segment range is not to be processed. This can be
862
 * used intelligently by plugins to apply more efficient methods of skipping
863 864
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
865
 *
866
 * The time value of the segment is used in conjunction with the start
Wim Taymans's avatar
Wim Taymans committed
867 868 869
 * value to convert the buffer timestamps into the stream time. This is
 * usually done in sinks to report the current stream_time.
 * @time represents the stream_time of a buffer carrying a timestamp of
870
 * @start. @time cannot be -1.
871
 *
872
 * @start cannot be -1, @stop can be -1. If there
Wim Taymans's avatar
Wim Taymans committed
873
 * is a valid @stop given, it must be greater or equal the @start, including
874
 * when the indicated playback @rate is < 0.
875 876
 *
 * The @applied_rate value provides information about any rate adjustment that
Wim Taymans's avatar
Wim Taymans committed
877 878 879 880
 * 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
881
 * incoming timestamps and buffer content by half and output a segment event
882
 * with @rate of 1.0 and @applied_rate of 2.0
883
 *
884
 * After a segment event, the buffer stream time is calculated with:
Wim Taymans's avatar
Wim Taymans committed
885
 *
886
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
887
 *
888
 * Returns: (transfer full) (nullable): the new SEGMENT event.
889
 */
890
GstEvent *
891
gst_event_new_segment (const GstSegment * segment)
892
{
893 894
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
895
  g_return_val_if_fail (segment != NULL, NULL);
896 897 898
  g_return_val_if_fail (segment->rate != 0.0, NULL);
  g_return_val_if_fail (segment->applied_rate != 0.0, NULL);
  g_return_val_if_fail (segment->format != GST_FORMAT_UNDEFINED, NULL);
899

900
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
901 902 903
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
904
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
905
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
906 907

  return event;
Wim Taymans's avatar
Wim Taymans committed
908
}
909

Wim Taymans's avatar
Wim Taymans committed
910
/**
911 912 913
 * gst_event_parse_segment:
 * @event: The event to parse
 * @segment: (out) (transfer none): a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
914
 *
915 916 917
 * Parses a segment @event and stores the result in the given @segment location.
 * @segment remains valid only until the @event is freed. Don't modify the segment
 * and make a copy if you want to modify it or store it for later use.
Wim Taymans's avatar
Wim Taymans committed
918
 */
919 920
void
gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
Wim Taymans's avatar
Wim Taymans committed
921
{
Wim Taymans's avatar
Wim Taymans committed
922
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
923

924 925
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
Wim Taymans's avatar
Wim Taymans committed
926

927 928 929 930 931
  if (segment) {
    structure = GST_EVENT_STRUCTURE (event);
    *segment = g_value_get_boxed (gst_structure_id_get_value (structure,
            GST_QUARK (SEGMENT)));
  }
Wim Taymans's avatar
Wim Taymans committed
932 933 934
}

/**
935
 * gst_event_copy_segment:
Wim Taymans's avatar
Wim Taymans committed
936
 * @event: The event to parse
937
 * @segment: a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
938
 *
939 940
 * Parses a segment @event and copies the #GstSegment into the location
 * given by @segment.
Wim Taymans's avatar
Wim Taymans committed
941 942
 */
void
943
gst_event_copy_segment (GstEvent * event, GstSegment * segment)
Wim Taymans's avatar
Wim Taymans committed
944 945 946
{
  const GstSegment *src;

947 948
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT);
Wim Taymans's avatar
Wim Taymans committed
949

950 951 952 953
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
954
}
955

956 957
/**
 * gst_event_new_tag:
958 959
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
960 961
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
962
 *
963 964 965 966 967
 * The scope of the taglist specifies if the taglist applies to the
 * complete medium or only to this specific stream. As the tag event
 * is a sticky event, elements should merge tags received from
 * upstream with a given scope with their own tags with the same
 * scope and create a new tag event from it.
968
 *
969
 * Returns: (transfer full): a new #GstEvent
970
 */
Wim Taymans's avatar
Wim Taymans committed
971
GstEvent *
972
gst_event_new_tag (GstTagList * taglist)
Wim Taymans's avatar
Wim Taymans committed
973
{
974 975
  GstStructure *s;
  GValue val = G_VALUE_INIT;
976
  const gchar *names[] = { "GstTagList-stream", "GstTagList-global" };
977

Wim Taymans's avatar
Wim Taymans committed
978
  g_return_val_if_fail (taglist != NULL, NULL);
979

980
  s = gst_structure_new_empty (names[gst_tag_list_get_scope (taglist)]);
981 982 983 984
  g_value_init (&val, GST_TYPE_TAG_LIST);
  g_value_take_boxed (&val, taglist);
  gst_structure_id_take_value (s, GST_QUARK (TAGLIST), &val);
  return gst_event_new_custom (GST_EVENT_TAG, s);
985 986
}

987 988 989
/**
 * gst_event_parse_tag:
 * @event: a tag event
990
 * @taglist: (out) (transfer none): pointer to metadata list
991 992
 *
 * Parses a tag @event and stores the results in the given @taglist location.
993 994 995
 * 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.
996
 */
Wim Taymans's avatar
Wim Taymans committed
997 998 999
void
gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
{
1000 1001
  const GValue *val;

Wim Taymans's avatar
Wim Taymans committed
1002 1003
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
1004

1005 1006 1007
  val = gst_structure_id_get_value (GST_EVENT_STRUCTURE (event),
      GST_QUARK (TAGLIST));

Wim Taymans's avatar
Wim Taymans committed
1008
  if (taglist)
1009
    *taglist = (GstTagList *) g_value_get_boxed (val);
Wim Taymans's avatar
Wim Taymans committed
1010 1011
}

1012 1013
/* buffersize event */
/**
1014
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
1015 1016 1017 1018
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
1019 1020 1021 1022
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
Piotr Fusik's avatar
Piotr Fusik committed
1023
 * When the @async flag is set, a thread boundary is preferred.
1024
 *
1025
 * Returns: (transfer full): a new #GstEvent
1026 1027
 */
GstEvent *
1028
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
1029 1030
    gint64 maxsize, gboolean async)
{
1031 1032 1033
  GstEvent *event;
  GstStructure *structure;

1034
  GST_CAT_INFO (GST_CAT_EVENT,
1035 1036
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
1037
      minsize, maxsize, async);
1038

Wim Taymans's avatar
Wim Taymans committed
1039
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
1040 1041 1042 1043 1044 1045 1046
      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;
1047 1048
}

Stefan Kost's avatar
Stefan Kost committed
1049
/**
1050
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
1051
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
1052 1053 1054 1055
 * @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
1056 1057 1058
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
1059
void
1060
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
1061 1062 1063 1064 1065 1066
    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);
1067

Wim Taymans's avatar
Wim Taymans committed
1068
  structure = GST_EVENT_STRUCTURE (event);
1069
  if (format)
1070
    *format = (GstFormat)
1071 1072
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
1073 1074
  if (minsize)
    *minsize =
1075 1076
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
1077 1078
  if (maxsize)
    *maxsize =
1079 1080
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
1081
  if (async)
1082 1083 1084
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
1085 1086
}

1087
/**
Wim Taymans's avatar
Wim Taymans committed
1088
 * gst_event_new_qos:
Wim Taymans's avatar
Wim Taymans committed
1089 1090 1091 1092 1093
 * @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
1094 1095 1096
 * 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
1097 1098 1099 1100 1101 1102 1103
 * 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
1104
 * receiving buffers fast enough and thus has to drop late buffers.
Wim Taymans's avatar
Wim Taymans committed
1105 1106
 * #GST_QOS_TYPE_THROTTLE is used when the datarate is artificially limited
 * by the application, for example to reduce power consumption.
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
 *
 * @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
1121 1122
 * indicates how late the buffer with @timestamp was. When throttling is
 * enabled, @diff will be set to the requested throttling interval.
1123
 *
1124
 * @timestamp is the timestamp of the last buffer that cause the element
1125 1126
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
1127 1128
 *
 * The upstream element can use the @diff and @timestamp values to decide
1129
 * whether to process more buffers. For positive @diff, all buffers with
1130
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
1131 1132
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
1133 1134 1135
 *
 * 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
1136
 *
1137
 * Returns: (transfer full) (nullable): a new QOS event.
1138
 */
Thomas Vander Stichele's avatar