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

gstevent.c 52.2 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
4
 *                    2005 Wim Taymans <wim@fluendo.com>
5
 *
6
 * gstevent.c: GstEvent subsystem
7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * 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
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
 * The event should be unreffed with gst_event_unref() if it has not been sent.
 *
Wim Taymans's avatar
Wim Taymans committed
39
 * 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
 * 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
44 45
 * 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
 *
Wim Taymans's avatar
Wim Taymans committed
50 51
 * Most of the event API is used inside plugins. Applications usually only
 * construct and use seek events.
52
 * 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
 *
Wim Taymans's avatar
Wim Taymans committed
75
 * Last reviewed on 2012-03-28 (0.11.3)
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_SEGMENT, "segment", 0},
114
  {GST_EVENT_TAG, "tag", 0},
115
  {GST_EVENT_TOC, "toc", 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 134
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

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

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

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

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

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

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

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

  return ret;
}

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

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

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

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

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

231
  g_slice_free1 (sizeof (GstEventImpl), event);
232 233
}

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

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
  copy = g_slice_new0 (GstEventImpl);

244
  gst_event_init (copy, 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);
Wim Taymans's avatar
Wim Taymans committed
254 255
  } else {
    GST_EVENT_STRUCTURE (copy) = NULL;
256
  }
Wim Taymans's avatar
Wim Taymans committed
257
  return GST_EVENT_CAST (copy);
258 259
}

Wim Taymans's avatar
Wim Taymans committed
260
static void
261
gst_event_init (GstEventImpl * event, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
262
{
263
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), 0, _gst_event_type,
264 265
      (GstMiniObjectCopyFunction) _gst_event_copy, NULL,
      (GstMiniObjectFreeFunction) _gst_event_free);
Wim Taymans's avatar
Wim Taymans committed
266 267 268 269 270 271

  GST_EVENT_TYPE (event) = type;
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
  GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
}

272

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

Wim Taymans's avatar
Wim Taymans committed
302
  if (structure) {
Wim Taymans's avatar
Wim Taymans committed
303
    /* structure must not have a parent */
Wim Taymans's avatar
Wim Taymans committed
304
    if (!gst_structure_set_parent_refcount (structure,
Wim Taymans's avatar
Wim Taymans committed
305
            &event->event.mini_object.refcount))
Wim Taymans's avatar
Wim Taymans committed
306 307
      goto had_parent;

Wim Taymans's avatar
Wim Taymans committed
308
  }
309
  gst_event_init (event, type);
Wim Taymans's avatar
Wim Taymans committed
310 311 312 313

  GST_EVENT_STRUCTURE (event) = structure;

  return GST_EVENT_CAST (event);
Wim Taymans's avatar
Wim Taymans committed
314 315 316 317

  /* ERRORS */
had_parent:
  {
318
    g_slice_free1 (sizeof (GstEventImpl), event);
Wim Taymans's avatar
Wim Taymans committed
319 320 321
    g_warning ("structure is already owned by another object");
    return NULL;
  }
322 323
}

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

341
  return GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
}

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

365
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
366

367
  if (structure == NULL) {
Wim Taymans's avatar
Wim Taymans committed
368
    structure =
Wim Taymans's avatar
Wim Taymans committed
369
        gst_structure_new_id_empty (gst_event_type_to_quark (GST_EVENT_TYPE
370 371 372 373
            (event)));
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    GST_EVENT_STRUCTURE (event) = structure;
  }
Wim Taymans's avatar
Wim Taymans committed
374
  return structure;
375
}
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
/**
 * 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
392
  if (GST_EVENT_STRUCTURE (event) == NULL)
393 394
    return FALSE;

Wim Taymans's avatar
Wim Taymans committed
395
  return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
396 397
}

398 399 400 401 402 403 404 405 406 407 408 409 410 411
/**
 * 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;
412
 * two events or messages will never have the same sequence number unless
413 414 415 416 417 418 419 420 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
 * 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));

  GST_EVENT_SEQNUM (event) = seqnum;
}

Wim Taymans's avatar
Wim Taymans committed
448
/**
Wim Taymans's avatar
Wim Taymans committed
449 450
 * gst_event_new_flush_start:
 *
451
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
452
 * upstream and downstream and travels out-of-bounds with the dataflow.
453 454
 *
 * It marks pads as being flushing and will make them return
455
 * #GST_FLOW_FLUSHING when used for data flow with gst_pad_push(),
456 457
 * gst_pad_chain(), gst_pad_get_range() and gst_pad_pull_range().
 * Any event (except a #GST_EVENT_FLUSH_STOP) received
458
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
459
 *
460 461
 * 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
462
 *
463 464
 * 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
465
 *
466
 * Returns: (transfer full): a new flush start event.
Wim Taymans's avatar
Wim Taymans committed
467
 */
468
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
469
gst_event_new_flush_start (void)
470
{
Wim Taymans's avatar
Wim Taymans committed
471
  return gst_event_new_custom (GST_EVENT_FLUSH_START, NULL);
472 473
}

474
/**
Wim Taymans's avatar
Wim Taymans committed
475
 * gst_event_new_flush_stop:
476
 * @reset_time: if time should be reset
Wim Taymans's avatar
Wim Taymans committed
477
 *
478
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
479
 * upstream and downstream and travels serialized with the dataflow.
480
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
481
 * pads accept data again.
482
 *
Wim Taymans's avatar
Wim Taymans committed
483 484
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
485
 *
Wim Taymans's avatar
Wim Taymans committed
486 487 488
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
489
 * Returns: (transfer full): a new flush stop event.
490
 */
491
GstEvent *
492
gst_event_new_flush_stop (gboolean reset_time)
493
{
494 495 496 497 498
  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
499
      gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
          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)));
525 526
}

Wim Taymans's avatar
Wim Taymans committed
527
/**
Wim Taymans's avatar
Wim Taymans committed
528
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
529
 *
Wim Taymans's avatar
Wim Taymans committed
530 531
 * 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
532
 * event on a pad can return #GST_FLOW_EOS as a #GstFlowReturn
533
 * when data after the EOS event arrives.
Wim Taymans's avatar
Wim Taymans committed
534
 *
Jan Schmidt's avatar
Jan Schmidt committed
535
 * The EOS event will travel down to the sink elements in the pipeline
536
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
537
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
538
 *
539
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
540 541
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
542
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
543
 *
544
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
545
 */
Wim Taymans's avatar
Wim Taymans committed
546 547
GstEvent *
gst_event_new_eos (void)
548
{
Wim Taymans's avatar
Wim Taymans committed
549
  return gst_event_new_custom (GST_EVENT_EOS, NULL);
550 551
}

552 553
/**
 * gst_event_new_gap:
554 555
 * @timestamp: the start time (pts) of the gap
 * @duration: the duration of the gap
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
 *
 * 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 ")",
574 575
      GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
      GST_TIME_ARGS (duration));
576 577 578 579 580 581 582 583 584 585 586

  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
587
 * @event: a #GstEvent of type #GST_EVENT_GAP
588 589
 * @timestamp: (out) (allow-none): location where to store the
 *     start time (pts) of the gap, or %NULL
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
 * @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
610 611
/**
 * gst_event_new_caps:
612
 * @caps: (transfer none): a #GstCaps
Wim Taymans's avatar
Wim Taymans committed
613 614
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
Wim Taymans's avatar
Wim Taymans committed
615
 * synchronized with the buffer flow and contains the format of the buffers
Wim Taymans's avatar
Wim Taymans committed
616 617 618 619 620 621 622 623 624
 * 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
625 626
  g_return_val_if_fail (caps != NULL, NULL);
  g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
627

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

630
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
631
      gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Wim Taymans's avatar
Wim Taymans committed
632 633 634 635 636 637 638 639
          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
640
 * @caps: (out) (transfer none): A pointer to the caps
Wim Taymans's avatar
Wim Taymans committed
641
 *
642 643
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
644 645 646 647
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
648 649
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
650 651 652
  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
653
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
654 655 656 657
  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
658 659
}

660
/**
Wim Taymans's avatar
Wim Taymans committed
661
 * gst_event_new_segment:
662
 * @segment: (transfer none): a #GstSegment
663
 *
Wim Taymans's avatar
Wim Taymans committed
664 665 666
 * 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
667 668
 *
 * The newsegment event marks the range of buffers to be processed. All
669
 * data not within the segment range is not to be processed. This can be
670
 * used intelligently by plugins to apply more efficient methods of skipping
671 672
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
673
 *
674
 * The time value of the segment is used in conjunction with the start
Wim Taymans's avatar
Wim Taymans committed
675 676 677
 * 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
678
 * @start. @time cannot be -1.
679
 *
680
 * @start cannot be -1, @stop can be -1. If there
Wim Taymans's avatar
Wim Taymans committed
681
 * is a valid @stop given, it must be greater or equal the @start, including
682
 * when the indicated playback @rate is < 0.
683 684
 *
 * The @applied_rate value provides information about any rate adjustment that
Wim Taymans's avatar
Wim Taymans committed
685 686 687 688 689
 * 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
690
 * with @rate of 1.0 and @applied_rate of 2.0
691
 *
Wim Taymans's avatar
Wim Taymans committed
692 693
 * After a newsegment event, the buffer stream time is calculated with:
 *
694
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
695
 *
Wim Taymans's avatar
Wim Taymans committed
696
 * Returns: (transfer full): the new SEGMENT event.
697
 */
698
GstEvent *
699
gst_event_new_segment (const GstSegment * segment)
700
{
701 702
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
703
  g_return_val_if_fail (segment != NULL, NULL);
704 705 706
  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);
707

708
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
709 710 711
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
712
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
713
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
714 715

  return event;
Wim Taymans's avatar
Wim Taymans committed
716
}
717

Wim Taymans's avatar
Wim Taymans committed
718
/**
719 720 721
 * 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
722
 *
723 724 725
 * 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
726
 */
727 728
void
gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
Wim Taymans's avatar
Wim Taymans committed
729
{
Wim Taymans's avatar
Wim Taymans committed
730
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
731

732 733
  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
734

735 736 737 738 739
  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
740 741 742
}

/**
743
 * gst_event_copy_segment:
Wim Taymans's avatar
Wim Taymans committed
744
 * @event: The event to parse
745
 * @segment: a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
746
 *
747 748
 * Parses a segment @event and copies the #GstSegment into the location
 * given by @segment.
Wim Taymans's avatar
Wim Taymans committed
749 750
 */
void
751
gst_event_copy_segment (GstEvent * event, GstSegment * segment)
Wim Taymans's avatar
Wim Taymans committed
752 753 754
{
  const GstSegment *src;

755 756
  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
757

758 759 760 761
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
762
}
763

764 765
/**
 * gst_event_new_tag:
766 767
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
768 769
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
770
 *
771 772 773 774 775
 * 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.
776
 *
777
 * Returns: (transfer full): a new #GstEvent
778
 */
Wim Taymans's avatar
Wim Taymans committed
779
GstEvent *
780
gst_event_new_tag (GstTagList * taglist)
Wim Taymans's avatar
Wim Taymans committed
781
{
782 783
  GstStructure *s;
  GValue val = G_VALUE_INIT;
784
  const gchar *names[] = { "GstTagList-stream", "GstTagList-global" };
785

Wim Taymans's avatar
Wim Taymans committed
786
  g_return_val_if_fail (taglist != NULL, NULL);
787

788
  s = gst_structure_new_empty (names[gst_tag_list_get_scope (taglist)]);
789 790 791 792
  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);
793 794
}

795 796 797
/**
 * gst_event_parse_tag:
 * @event: a tag event
798
 * @taglist: (out) (transfer none): pointer to metadata list
799 800
 *
 * Parses a tag @event and stores the results in the given @taglist location.
801 802 803
 * 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.
804
 */
Wim Taymans's avatar
Wim Taymans committed
805 806 807
void
gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
{
808 809
  const GValue *val;

Wim Taymans's avatar
Wim Taymans committed
810 811
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
812

813 814 815
  val = gst_structure_id_get_value (GST_EVENT_STRUCTURE (event),
      GST_QUARK (TAGLIST));

Wim Taymans's avatar
Wim Taymans committed
816
  if (taglist)
817
    *taglist = (GstTagList *) g_value_get_boxed (val);
Wim Taymans's avatar
Wim Taymans committed
818 819
}

820 821
/* buffersize event */
/**
822
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
823 824 825 826
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
827 828 829 830
 *
 * 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
831
 * When the @async flag is set, a thread boundary is preferred.
832
 *
833
 * Returns: (transfer full): a new #GstEvent
834 835
 */
GstEvent *
836
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
837 838
    gint64 maxsize, gboolean async)
{
839 840 841
  GstEvent *event;
  GstStructure *structure;

842
  GST_CAT_INFO (GST_CAT_EVENT,
843 844
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
845
      minsize, maxsize, async);
846

Wim Taymans's avatar
Wim Taymans committed
847
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
848 849 850 851 852 853 854
      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;
855 856
}

Stefan Kost's avatar
Stefan Kost committed
857
/**
858
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
859
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
860 861 862 863
 * @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
864 865 866
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
867
void
868
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
869 870 871 872 873 874
    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);
875

Wim Taymans's avatar
Wim Taymans committed
876
  structure = GST_EVENT_STRUCTURE (event);
877
  if (format)
878
    *format = (GstFormat)
879 880
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
881 882
  if (minsize)
    *minsize =
883 884
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
885 886
  if (maxsize)
    *maxsize =
887 888
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
889
  if (async)
890 891 892
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
893 894
}

895
/**
Wim Taymans's avatar
Wim Taymans committed
896
 * gst_event_new_qos:
Wim Taymans's avatar
Wim Taymans committed
897 898 899 900 901
 * @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
902 903 904
 * 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
905 906 907 908 909 910 911 912 913 914
 * 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.
915 916 917 918 919 920 921 922 923 924 925 926 927 928
 *
 * @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
929 930
 * indicates how late the buffer with @timestamp was. When throttling is
 * enabled, @diff will be set to the requested throttling interval.
931
 *
932
 * @timestamp is the timestamp of the last buffer that cause the element
933 934
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
935 936
 *
 * The upstream element can use the @diff and @timestamp values to decide
937 938
 * whether to process more buffers. For possitive @diff, all buffers with
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
939 940
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
941 942 943
 *
 * 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
944
 *
945
 * Returns: (transfer full): a new QOS event.
946
 */
947
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
948
gst_event_new_qos (GstQOSType type, gdouble proportion,
Wim Taymans's avatar
Wim Taymans committed
949
    GstClockTimeDiff diff, GstClockTime timestamp)
950
{
951
  GstEvent *event;
952
  GstStructure *structure;
953

954 955 956
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

957
  GST_CAT_LOG (GST_CAT_EVENT,