gstevent.c 49.6 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
 * 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
Piotr Fusik's avatar
Piotr Fusik committed
53
 * the needed parameters to specify 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"
87
#include "gstvalue.h"
Benjamin Otte's avatar
Benjamin Otte committed
88

Wim Taymans's avatar
Wim Taymans committed
89
GType _gst_event_type = 0;
90

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

  GstStructure *structure;
} GstEventImpl;

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

100 101
typedef struct
{
102 103
  const gint type;
  const gchar *name;
104 105 106 107 108 109 110
  GQuark quark;
} GstEventQuarks;

static GstEventQuarks event_quarks[] = {
  {GST_EVENT_UNKNOWN, "unknown", 0},
  {GST_EVENT_FLUSH_START, "flush-start", 0},
  {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
Wim Taymans's avatar
Wim Taymans committed
111
  {GST_EVENT_STREAM_START, "stream-start", 0},
Wim Taymans's avatar
Wim Taymans committed
112
  {GST_EVENT_CAPS, "caps", 0},
Wim Taymans's avatar
Wim Taymans committed
113
  {GST_EVENT_STREAM_CONFIG, "stream-config", 0},
Wim Taymans's avatar
Wim Taymans committed
114
  {GST_EVENT_SEGMENT, "segment", 0},
115
  {GST_EVENT_TAG, "tag", 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 128 129
  {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
130
  {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
131 132 133
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

134 135 136
  {0, NULL, 0}
};

137
GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
Wim Taymans's avatar
Wim Taymans committed
138

139
void
140
_priv_gst_event_initialize (void)
141 142
{
  gint i;
143

Wim Taymans's avatar
Wim Taymans committed
144
  _gst_event_type = gst_event_get_type ();
Wim Taymans's avatar
Wim Taymans committed
145

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

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

207
  ret = type & ((1 << GST_EVENT_NUM_SHIFT) - 1);
208 209 210 211

  return ret;
}

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

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

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

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

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

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

233 234 235
static void gst_event_init (GstEventImpl * event, gsize size,
    GstEventType type);

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

242 243 244
  copy = g_slice_new0 (GstEventImpl);

  gst_event_init (copy, sizeof (GstEventImpl), GST_EVENT_TYPE (event));
245

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

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

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

Wim Taymans's avatar
Wim Taymans committed
263 264
  event->event.mini_object.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
  event->event.mini_object.free = (GstMiniObjectFreeFunction) _gst_event_free;
Wim Taymans's avatar
Wim Taymans committed
265 266 267 268 269 270

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

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

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

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
317
    GST_EVENT_STRUCTURE (event) = structure;
Wim Taymans's avatar
Wim Taymans committed
318
  }
319
  return event;
Wim Taymans's avatar
Wim Taymans committed
320 321 322 323 324 325 326 327

  /* ERRORS */
had_parent:
  {
    gst_event_unref (event);
    g_warning ("structure is already owned by another object");
    return NULL;
  }
328 329
}

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

347
  return GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
}

/**
 * gst_event_writable_structure:
 * @event: The #GstEvent.
 *
 * Get a writable version of the structure.
 *
 * Returns: The structure of the event. The structure is still
 * owned by the event, which means that you should not free it and
 * that the pointer becomes invalid when you free the event.
 * This function checks if @event is writable and will never return NULL.
 *
 * MT safe.
 */
GstStructure *
gst_event_writable_structure (GstEvent * event)
{
  GstStructure *structure;

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

371
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
372

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

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
/**
 * gst_event_has_name:
 * @event: The #GstEvent.
 * @name: name to check
 *
 * Checks if @event has the given @name. This function is usually used to
 * check the name of a custom event.
 *
 * Returns: %TRUE if @name matches the name of the event structure.
 *
 * Since: 0.10.20
 */
gboolean
gst_event_has_name (GstEvent * event, const gchar * name)
{
  g_return_val_if_fail (GST_IS_EVENT (event), FALSE);

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

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

406 407 408 409 410 411 412 413 414 415 416 417 418 419
/**
 * 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;
420
 * two events or messages will never have the same sequence number unless
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
 * 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;
}

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

490
/**
Wim Taymans's avatar
Wim Taymans committed
491
 * gst_event_new_flush_stop:
492
 * @reset_time: if time should be reset
Wim Taymans's avatar
Wim Taymans committed
493
 *
494
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
495
 * upstream and downstream and travels serialized with the dataflow.
496
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
497
 * pads accept data again.
498
 *
Wim Taymans's avatar
Wim Taymans committed
499 500
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
501
 *
Wim Taymans's avatar
Wim Taymans committed
502 503 504
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
505
 * Returns: (transfer full): a new flush stop event.
506
 */
507
GstEvent *
508
gst_event_new_flush_stop (gboolean reset_time)
509
{
510 511 512 513 514
  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
515
      gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
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
          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)));
541 542
}

Wim Taymans's avatar
Wim Taymans committed
543
/**
Wim Taymans's avatar
Wim Taymans committed
544
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
545
 *
Wim Taymans's avatar
Wim Taymans committed
546 547
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
548 549
 * 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
550
 *
Jan Schmidt's avatar
Jan Schmidt committed
551
 * The EOS event will travel down to the sink elements in the pipeline
552
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
553
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
554
 *
555
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
556 557
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
558
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
559
 *
560
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
561
 */
Wim Taymans's avatar
Wim Taymans committed
562 563
GstEvent *
gst_event_new_eos (void)
564
{
Wim Taymans's avatar
Wim Taymans committed
565
  return gst_event_new (GST_EVENT_EOS);
566 567
}

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/**
 * gst_event_new_gap:
 * @timestamp: the start time (pts) of a gap
 * @duration: the duration of the gap, or %GST_CLOCK_TIME_NONE
 *
 * 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 ")",
      GST_TIME_ARGS (timestamp),
      GST_TIME_ARGS (GST_CLOCK_TIME_IS_VALID (duration) ? (timestamp +
              duration) : GST_CLOCK_TIME_NONE), GST_TIME_ARGS (duration));

  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:
 * @timestamp: (out): location where to store the start time (pts) of the gap
 * @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
625 626
/**
 * gst_event_new_caps:
627
 * @caps: (transfer none): a #GstCaps
Wim Taymans's avatar
Wim Taymans committed
628 629
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
Wim Taymans's avatar
Wim Taymans committed
630
 * synchronized with the buffer flow and contains the format of the buffers
Wim Taymans's avatar
Wim Taymans committed
631 632 633 634 635 636 637 638 639
 * that will follow after the event.
 *
 * Returns: (transfer full): the new CAPS event.
 */
GstEvent *
gst_event_new_caps (GstCaps * caps)
{
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
640 641
  g_return_val_if_fail (caps != NULL, NULL);
  g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
642

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

645
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
646
      gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Wim Taymans's avatar
Wim Taymans committed
647 648 649 650 651 652 653 654 655 656
          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
 *
657 658
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
659 660 661 662
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
663 664
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
665 666 667
  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
668
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
669 670 671 672
  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
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 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
/**
 * gst_event_new_stream_config:
 * @flags: the stream config flags
 *
 * Create a new STREAM CONFIG event. The stream config event travels
 * downstream synchronized with the buffer flow and contains stream
 * configuration information for the stream, such as stream-headers
 * or codec-data. It is optional and should be sent after the CAPS
 * event.
 *
 * Returns: (transfer full): the new STREAM CONFIG event.
 */
GstEvent *
gst_event_new_stream_config (GstStreamConfigFlags flags)
{
  GstEvent *event;

  GST_CAT_INFO (GST_CAT_EVENT, "creating stream info event, flags=0x%x", flags);

  event = gst_event_new_custom (GST_EVENT_STREAM_CONFIG,
      gst_structure_new_id (GST_QUARK (EVENT_STREAM_CONFIG),
          GST_QUARK (FLAGS), GST_TYPE_STREAM_CONFIG_FLAGS, flags, NULL));

  return event;
}

/**
 * gst_event_parse_stream_config:
 * @event: The event to parse
 * @flags: (out): a pointer to a variable to store the stream config flags
 *
 * Get the stream config flags from @event.
 */
void
gst_event_parse_stream_config (GstEvent * event, GstStreamConfigFlags * flags)
{
  GstStructure *structure;

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

  structure = GST_EVENT_STRUCTURE (event);
  if (G_LIKELY (flags != NULL)) {
    *flags =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FLAGS)));
  }
}

/**
 * gst_event_set_stream_config_codec_data:
 * @event: a stream config event
 * @buf: a #GstBuffer with codec data
 *
 * Set codec data on the stream info event to signal out of bound setup data
 * to downstream elements. Unlike stream headers, codec data contains data
 * that is required to interpret the data stream, but is not valid as-is
 * inside the data stream and thus can't just be prepended to or inserted
 * into the data stream.
 */
void
gst_event_set_stream_config_codec_data (GstEvent * event, GstBuffer * buf)
{
  GstStructure *s;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
  g_return_if_fail (GST_IS_BUFFER (buf) && gst_buffer_get_size (buf) > 0);

  s = GST_EVENT_STRUCTURE (event);
  gst_structure_id_set (s, GST_QUARK (CODEC_DATA), GST_TYPE_BUFFER, buf, NULL);
}

/**
 * gst_event_set_stream_config_codec_data:
 * @event: a stream config event
 * @buf: (transfer none): location where to store the #GstBuffer with codec data
 *
 * Extracts the codec data buffer from the stream info event. Will store
 * %NULL in @buf if the event contains no codec data. The buffer returned
 * will remain valid as long as @event remains valid. The caller should
 * acquire a referenceto to @buf if needed.
 */
void
gst_event_parse_stream_config_codec_data (GstEvent * event, GstBuffer ** buf)
{
  const GValue *val;
  GstStructure *s;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
  g_return_if_fail (buf != NULL);

  s = GST_EVENT_STRUCTURE (event);
  val = gst_structure_id_get_value (s, GST_QUARK (CODEC_DATA));
  if (val != NULL)
    *buf = g_value_get_boxed (val);
  else
    *buf = NULL;
}

/**
 * gst_event_add_stream_config_header:
 * @event: a stream config event
 * @buf: a #GstBuffer with stream header data
 *
 * Adds a stream header to the stream info event to signal stream headers to
 * to downstream elements such as multifilesink, tcpserversink etc. Stream
 * headers can be and should usually be prepended to the data stream at any
 * point in the stream (which requires a streamable format), e.g. to a new
 * client connecting, or when starting a new file segment. stream header
 * buffers will all be used together in the order they were added to the
 * stream config event. Stream headers are sent as buffers at the beginning
 * of the data flow in addition to the stream config event. Elements that
 * care about stream headers need to make sure that they don't insert or
 * interpret these header buffers twice if they interpret them.
 */
void
gst_event_add_stream_config_header (GstEvent * event, GstBuffer * buf)
{
  GstStructure *s;
  GValue buf_val = { 0, };
  GValue *val;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
  g_return_if_fail (GST_IS_BUFFER (buf) && gst_buffer_get_size (buf) > 0);

  g_value_init (&buf_val, GST_TYPE_BUFFER);
  g_value_set_boxed (&buf_val, buf);

  s = GST_EVENT_STRUCTURE (event);
  val = (GValue *) gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));
  if (val == NULL) {
    GValue new_array = { 0, };

    g_value_init (&new_array, GST_TYPE_ARRAY);
    gst_value_array_append_value (&new_array, &buf_val);
    gst_structure_id_take_value (s, GST_QUARK (STREAM_HEADERS), &new_array);
  } else {
    gst_value_array_append_value (val, &buf_val);
  }
  g_value_unset (&buf_val);
}

/**
 * gst_event_get_n_stream_config_headers:
 * @event: a stream config event
 *
 * Extract the number of stream header buffers.
 *
 * Returns: the number of stream header buffers attached to the stream info
 * @event.
 */
guint
gst_event_get_n_stream_config_headers (GstEvent * event)
{
  const GValue *val;
  GstStructure *s;
  guint num = 0;

  g_return_val_if_fail (GST_IS_EVENT (event), 0);
  g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG, 0);

  s = GST_EVENT_STRUCTURE (event);
  val = gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));

  if (val != NULL)
    num = gst_value_array_get_size (val);

  return num;
}

/**
 * gst_event_parse_nth_stream_config_header:
 * @event: a stream config event
 * @index: number of the stream header to retrieve
 * @buf: location where to store the n-th stream header #GstBuffer
 *
 * Retrieves the n-th stream header buffer attached to the stream config
 * event and stores it in @buf. Will store %NULL in @buf if there is no such
 * stream header.
 */
void
gst_event_parse_nth_stream_config_header (GstEvent * event, guint index,
    GstBuffer ** buf)
{
  const GValue *val, *buf_val;
  GstStructure *s;
  GstBuffer *ret = NULL;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
  g_return_if_fail (buf != NULL);

  s = GST_EVENT_STRUCTURE (event);
  val = gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));

  if (val != NULL) {
    buf_val = gst_value_array_get_value (val, index);
    if (buf_val != NULL)
      ret = g_value_get_boxed (buf_val);
  }

  *buf = ret;
}

882
/**
Wim Taymans's avatar
Wim Taymans committed
883
 * gst_event_new_segment:
884
 * @segment: (transfer none): a #GstSegment
885
 *
Wim Taymans's avatar
Wim Taymans committed
886 887 888
 * 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
889 890
 *
 * The newsegment event marks the range of buffers to be processed. All
891
 * data not within the segment range is not to be processed. This can be
892
 * used intelligently by plugins to apply more efficient methods of skipping
893 894
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
895
 *
896
 * The time value of the segment is used in conjunction with the start
Wim Taymans's avatar
Wim Taymans committed
897 898 899
 * 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
900
 * @start. @time cannot be -1.
901
 *
902
 * @start cannot be -1, @stop can be -1. If there
Wim Taymans's avatar
Wim Taymans committed
903
 * is a valid @stop given, it must be greater or equal the @start, including
904
 * when the indicated playback @rate is < 0.
905 906
 *
 * The @applied_rate value provides information about any rate adjustment that
Wim Taymans's avatar
Wim Taymans committed
907 908 909 910 911
 * 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
912
 * with @rate of 1.0 and @applied_rate of 2.0
913
 *
Wim Taymans's avatar
Wim Taymans committed
914 915
 * After a newsegment event, the buffer stream time is calculated with:
 *
916
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
917
 *
Wim Taymans's avatar
Wim Taymans committed
918
 * Returns: (transfer full): the new SEGMENT event.
919
 */
920
GstEvent *
921
gst_event_new_segment (const GstSegment * segment)
922
{
923 924
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
925
  g_return_val_if_fail (segment != NULL, NULL);
926 927 928
  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);
929

930
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
931 932 933
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
934
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
935
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
936 937

  return event;
Wim Taymans's avatar
Wim Taymans committed
938
}
939

Wim Taymans's avatar
Wim Taymans committed
940
/**
941 942 943
 * 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
944
 *
945 946 947
 * 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
948
 */
949 950
void
gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
Wim Taymans's avatar
Wim Taymans committed
951
{
Wim Taymans's avatar
Wim Taymans committed
952
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
953

954 955
  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
956

957 958 959 960 961
  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
962 963 964
}

/**
965
 * gst_event_copy_segment:
Wim Taymans's avatar
Wim Taymans committed
966
 * @event: The event to parse
967
 * @segment: a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
968
 *
969 970
 * Parses a segment @event and copies the #GstSegment into the location
 * given by @segment.
Wim Taymans's avatar
Wim Taymans committed
971 972
 */
void
973
gst_event_copy_segment (GstEvent * event, GstSegment * segment)
Wim Taymans's avatar
Wim Taymans committed
974 975 976
{
  const GstSegment *src;

977 978
  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
979

980 981 982 983
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
984
}
985

986 987
/**
 * gst_event_new_tag:
988 989
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
990 991
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
992
 *
993
 * Returns: (transfer full): a new #GstEvent
994
 */
Wim Taymans's avatar
Wim Taymans committed
995 996 997 998
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
999

Wim Taymans's avatar
Wim Taymans committed
1000
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
1001 1002
}

1003 1004 1005
/**
 * gst_event_parse_tag:
 * @event: a tag event
1006
 * @taglist: (out) (transfer none): pointer to metadata list
1007 1008
 *
 * Parses a tag @event and stores the results in the given @taglist location.
1009 1010 1011
 * 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.
1012
 */
Wim Taymans's avatar
Wim Taymans committed
1013 1014 1015 1016 1017
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);
1018

Wim Taymans's avatar
Wim Taymans committed
1019
  if (taglist)
Wim Taymans's avatar
Wim Taymans committed
1020
    *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
1021 1022
}

1023 1024
/* buffersize event */
/**
1025
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
1026 1027 1028 1029
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
1030 1031 1032 1033
 *
 * 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
1034
 * When the @async flag is set, a thread boundary is preferred.
1035
 *
1036
 * Returns: (transfer full): a new #GstEvent
1037 1038
 */
GstEvent *
1039
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
1040 1041
    gint64 maxsize, gboolean async)
{
1042 1043 1044
  GstEvent *event;
  GstStructure *structure;

1045
  GST_CAT_INFO (GST_CAT_EVENT,
1046 1047
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
1048
      minsize, maxsize, async);
1049

Wim Taymans's avatar
Wim Taymans committed
1050
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
1051 1052 1053 1054 1055 1056 1057
      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;
1058 1059
}

Stefan Kost's avatar
Stefan Kost committed
1060
/**
1061
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
1062
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
1063 1064 1065 1066
 * @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
1067 1068 1069
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
1070
void
1071
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
1072 1073 1074 1075 1076 1077
    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);
1078

Wim Taymans's avatar
Wim Taymans committed
1079
  structure = GST_EVENT_STRUCTURE (event);
1080
  if (format)
1081
    *format = (GstFormat)
1082 1083
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
1084 1085
  if (minsize)
    *minsize =
1086 1087
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
1088 1089
  if (maxsize)
    *maxsize =
1090 1091
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
1092
  if (async)
1093 1094 1095
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
1096 1097
}

1098
/**
Wim Taymans's avatar
Wim Taymans committed
1099
 * gst_event_new_qos:
Wim Taymans's avatar
Wim Taymans committed
1100 1101 1102 1103 1104
 * @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
1105 1106 1107
 * 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
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
 * 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.
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
 *
 * @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
1132 1133
 * indicates how late the buffer with @timestamp was. When throttling is
 * enabled, @diff will be set to the requested throttling interval.