gstevent.c 65.1 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
4
 *                    2005 Wim Taymans <wim@fluendo.com>
5
 *
6
 * gstevent.c: GstEvent subsystem
7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * 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.
54
 * |[<!-- language="C" -->
Wim Taymans's avatar
Wim Taymans committed
55 56 57 58 59 60 61
 *   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
62 63 64
 *      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
65 66 67 68 69
 *   ...
 *   result = gst_element_send_event (pipeline, event);
 *   if (!result)
 *     g_warning ("seek failed");
 *   ...
70
 * ]|
71
 */
Wim Taymans's avatar
Wim Taymans committed
72

73

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

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

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

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

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

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

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

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
  }
257 258 259 260

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

Wim Taymans's avatar
Wim Taymans committed
261
  return GST_EVENT_CAST (copy);
262 263
}

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

  GST_EVENT_TYPE (event) = type;
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
  GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
274
  event->running_time_offset = 0;
Wim Taymans's avatar
Wim Taymans committed
275 276
}

277

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

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

Wim Taymans's avatar
Wim Taymans committed
313
  }
314
  gst_event_init (event, type);
Wim Taymans's avatar
Wim Taymans committed
315 316 317 318

  GST_EVENT_STRUCTURE (event) = structure;

  return GST_EVENT_CAST (event);
Wim Taymans's avatar
Wim Taymans committed
319 320 321 322

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

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

346
  return GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
347 348 349 350 351 352 353 354
}

/**
 * gst_event_writable_structure:
 * @event: The #GstEvent.
 *
 * Get a writable version of the structure.
 *
355 356 357 358 359
 * 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
360 361 362 363 364 365 366 367 368 369 370
 *
 * 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
/**
 * 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
398
  if (GST_EVENT_STRUCTURE (event) == NULL)
399 400
    return FALSE;

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

404 405 406 407 408 409 410 411 412 413 414 415 416 417
/**
 * 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;
418
 * two events or messages will never have the same sequence number unless
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 448 449 450 451 452
 * 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;
}
453 454 455 456 457 458 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

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

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

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

528
/**
Wim Taymans's avatar
Wim Taymans committed
529
 * gst_event_new_flush_stop:
530
 * @reset_time: if time should be reset
Wim Taymans's avatar
Wim Taymans committed
531
 *
532
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
533
 * upstream and downstream and travels serialized with the dataflow.
534
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
535
 * pads accept data again.
536
 *
Wim Taymans's avatar
Wim Taymans committed
537
 * Elements can process this event synchronized with the dataflow since
538
 * the preceding FLUSH_START event stopped the dataflow.
539
 *
Wim Taymans's avatar
Wim Taymans committed
540 541 542
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
543
 * Returns: (transfer full): a new flush stop event.
544
 */
545
GstEvent *
546
gst_event_new_flush_stop (gboolean reset_time)
547
{
548 549 550 551 552
  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
553
      gst_structure_new_id (GST_QUARK (EVENT_FLUSH_STOP),
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
          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)));
579 580
}

581 582
/**
 * gst_event_new_select_streams:
583
 * @streams: (element-type utf8) (transfer none): the list of streams to
584 585 586 587 588 589 590 591 592 593 594 595
 * 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
 * in #GST_EVENT_STREAM_START, #GST_EVENT_STREAM_COLLECTION or 
 * #GST_MESSSAGE_STREAM_COLLECTION.
 *
 * Returns: (transfer full): a new select-streams event.
596 597
 *
 * Since: 1.10
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 625 626
 */
GstEvent *
gst_event_new_select_streams (GList * streams)
{
  GstEvent *event;
  GValue val = G_VALUE_INIT;
  GstStructure *struc;
  GList *tmpl;

  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
627
 * @streams: (out) (element-type utf8) (transfer full): the streams
628 629
 *
 * Parse the SELECT_STREAMS event and retrieve the contained streams.
630 631
 *
 * Since: 1.10
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
 */
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;
  }
}


656 657 658 659 660 661 662 663 664 665 666 667 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
/**
 * 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
707
/**
Wim Taymans's avatar
Wim Taymans committed
708
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
709
 *
Wim Taymans's avatar
Wim Taymans committed
710 711
 * 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
712
 * event on a pad can return #GST_FLOW_EOS as a #GstFlowReturn
713
 * when data after the EOS event arrives.
Wim Taymans's avatar
Wim Taymans committed
714
 *
Jan Schmidt's avatar
Jan Schmidt committed
715
 * The EOS event will travel down to the sink elements in the pipeline
716
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
717
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
718
 *
719
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
720 721
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
722
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
723
 *
724
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
725
 */
Wim Taymans's avatar
Wim Taymans committed
726 727
GstEvent *
gst_event_new_eos (void)
728
{
Wim Taymans's avatar
Wim Taymans committed
729
  return gst_event_new_custom (GST_EVENT_EOS, NULL);
730 731
}

732 733
/**
 * gst_event_new_gap:
734 735
 * @timestamp: the start time (pts) of the gap
 * @duration: the duration of the gap
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
 *
 * 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 ")",
754 755
      GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
      GST_TIME_ARGS (duration));
756 757 758 759 760 761 762 763 764 765 766

  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
767
 * @event: a #GstEvent of type #GST_EVENT_GAP
768 769
 * @timestamp: (out) (allow-none): location where to store the
 *     start time (pts) of the gap, or %NULL
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
 * @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
790 791
/**
 * gst_event_new_caps:
792
 * @caps: (transfer none): a #GstCaps
Wim Taymans's avatar
Wim Taymans committed
793 794
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
Wim Taymans's avatar
Wim Taymans committed
795
 * synchronized with the buffer flow and contains the format of the buffers
Wim Taymans's avatar
Wim Taymans committed
796 797 798 799 800 801 802 803 804
 * 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
805 806
  g_return_val_if_fail (caps != NULL, NULL);
  g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
807

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

810
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
811
      gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Wim Taymans's avatar
Wim Taymans committed
812 813 814 815 816 817 818 819
          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
820
 * @caps: (out) (transfer none): A pointer to the caps
Wim Taymans's avatar
Wim Taymans committed
821
 *
822 823
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
824 825 826 827
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
828 829
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
830 831 832
  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
833
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
834 835 836 837
  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
838 839
}

840
/**
Wim Taymans's avatar
Wim Taymans committed
841
 * gst_event_new_segment:
842
 * @segment: (transfer none): a #GstSegment
843
 *
Wim Taymans's avatar
Wim Taymans committed
844 845 846
 * 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
847
 *
848
 * The segment event marks the range of buffers to be processed. All
849
 * data not within the segment range is not to be processed. This can be
850
 * used intelligently by plugins to apply more efficient methods of skipping
851 852
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
853
 *
854
 * The time value of the segment is used in conjunction with the start
Wim Taymans's avatar
Wim Taymans committed
855 856 857
 * 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
858
 * @start. @time cannot be -1.
859
 *
860
 * @start cannot be -1, @stop can be -1. If there
Wim Taymans's avatar
Wim Taymans committed
861
 * is a valid @stop given, it must be greater or equal the @start, including
862
 * when the indicated playback @rate is < 0.
863 864
 *
 * The @applied_rate value provides information about any rate adjustment that
Wim Taymans's avatar
Wim Taymans committed
865 866 867 868
 * 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
869
 * incoming timestamps and buffer content by half and output a segment event
870
 * with @rate of 1.0 and @applied_rate of 2.0
871
 *
872
 * After a segment event, the buffer stream time is calculated with:
Wim Taymans's avatar
Wim Taymans committed
873
 *
874
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
875
 *
Wim Taymans's avatar
Wim Taymans committed
876
 * Returns: (transfer full): the new SEGMENT event.
877
 */
878
GstEvent *
879
gst_event_new_segment (const GstSegment * segment)
880
{
881 882
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
883
  g_return_val_if_fail (segment != NULL, NULL);
884 885 886
  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);
887

888
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
889 890 891
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
892
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
893
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
894 895

  return event;
Wim Taymans's avatar
Wim Taymans committed
896
}
897

Wim Taymans's avatar
Wim Taymans committed
898
/**
899 900 901
 * 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
902
 *
903 904 905
 * 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
906
 */
907 908
void
gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
Wim Taymans's avatar
Wim Taymans committed
909
{
Wim Taymans's avatar
Wim Taymans committed
910
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
911

912 913
  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
914

915 916 917 918 919
  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
920 921 922
}

/**
923
 * gst_event_copy_segment:
Wim Taymans's avatar
Wim Taymans committed
924
 * @event: The event to parse
925
 * @segment: a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
926
 *
927 928
 * Parses a segment @event and copies the #GstSegment into the location
 * given by @segment.
Wim Taymans's avatar
Wim Taymans committed
929 930
 */
void
931
gst_event_copy_segment (GstEvent * event, GstSegment * segment)
Wim Taymans's avatar
Wim Taymans committed
932 933 934
{
  const GstSegment *src;

935 936
  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
937

938 939 940 941
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
942
}
943

944 945
/**
 * gst_event_new_tag:
946 947
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
948 949
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
950
 *
951 952 953 954 955
 * 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.
956
 *
957
 * Returns: (transfer full): a new #GstEvent
958
 */
Wim Taymans's avatar
Wim Taymans committed
959
GstEvent *
960
gst_event_new_tag (GstTagList * taglist)
Wim Taymans's avatar
Wim Taymans committed
961
{
962 963
  GstStructure *s;
  GValue val = G_VALUE_INIT;
964
  const gchar *names[] = { "GstTagList-stream", "GstTagList-global" };
965

Wim Taymans's avatar
Wim Taymans committed
966
  g_return_val_if_fail (taglist != NULL, NULL);
967

968
  s = gst_structure_new_empty (names[gst_tag_list_get_scope (taglist)]);
969 970 971 972
  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);
973 974
}

975 976 977
/**
 * gst_event_parse_tag:
 * @event: a tag event
978
 * @taglist: (out) (transfer none): pointer to metadata list
979 980
 *
 * Parses a tag @event and stores the results in the given @taglist location.
981 982 983
 * 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.
984
 */
Wim Taymans's avatar
Wim Taymans committed
985 986 987
void
gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
{
988 989
  const GValue *val;

Wim Taymans's avatar
Wim Taymans committed
990 991
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
992

993 994 995
  val = gst_structure_id_get_value (GST_EVENT_STRUCTURE (event),
      GST_QUARK (TAGLIST));

Wim Taymans's avatar
Wim Taymans committed
996
  if (taglist)
997
    *taglist = (GstTagList *) g_value_get_boxed (val);
Wim Taymans's avatar
Wim Taymans committed
998 999
}

1000 1001
/* buffersize event */
/**
1002
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
1003 1004 1005 1006
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
1007 1008 1009 1010
 *
 * 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
1011
 * When the @async flag is set, a thread boundary is preferred.
1012
 *
1013
 * Returns: (transfer full): a new #GstEvent
1014 1015
 */
GstEvent *
1016
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
1017 1018
    gint64 maxsize, gboolean async)
{
1019 1020 1021
  GstEvent *event;
  GstStructure *structure;

1022
  GST_CAT_INFO (GST_CAT_EVENT,
1023 1024
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
1025
      minsize, maxsize, async);
1026

Wim Taymans's avatar
Wim Taymans committed
1027
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
1028 1029 1030 1031 1032 1033 1034
      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;