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 40.4 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
4
 *                    2005 Wim Taymans <wim@fluendo.com>
5
 *
6
 * gstevent.c: GstEvent subsystem
7 8 9 10 11 12 13 14 15 16 17 18 19 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"
Benjamin Otte's avatar
Benjamin Otte committed
87

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

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

  GstStructure *structure;
} GstEventImpl;

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

99 100
typedef struct
{
101 102
  const gint type;
  const gchar *name;
103 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},
  {GST_EVENT_EOS, "eos", 0},
Wim Taymans's avatar
Wim Taymans committed
111
  {GST_EVENT_CAPS, "caps", 0},
Wim Taymans's avatar
Wim Taymans committed
112
  {GST_EVENT_SEGMENT, "segment", 0},
113
  {GST_EVENT_TAG, "tag", 0},
114
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
115
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
116 117 118
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
119
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
120
  {GST_EVENT_STEP, "step", 0},
121
  {GST_EVENT_RECONFIGURE, "reconfigure", 0},
122 123 124
  {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
125
  {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
126 127 128
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

129 130 131
  {0, NULL, 0}
};

132
GST_DEFINE_MINI_OBJECT_TYPE (GstEvent, gst_event);
Wim Taymans's avatar
Wim Taymans committed
133

134
void
135
_priv_gst_event_initialize (void)
136 137
{
  gint i;
138

Wim Taymans's avatar
Wim Taymans committed
139
  _gst_event_type = gst_event_get_type ();
Wim Taymans's avatar
Wim Taymans committed
140

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

189 190 191 192 193 194 195 196 197 198 199 200 201
/**
 * 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;

202
  ret = type & ((1 << GST_EVENT_STICKY_SHIFT) - 1);
203 204 205 206

  return ret;
}

207
static void
208
_gst_event_free (GstEvent * event)
209
{
Wim Taymans's avatar
Wim Taymans committed
210 211
  GstStructure *s;

212 213 214
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

215
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
216
      GST_EVENT_TYPE_NAME (event));
Wim Taymans's avatar
Wim Taymans committed
217

Wim Taymans's avatar
Wim Taymans committed
218 219 220 221 222
  s = GST_EVENT_STRUCTURE (event);

  if (s) {
    gst_structure_set_parent_refcount (s, NULL);
    gst_structure_free (s);
223
  }
224

Wim Taymans's avatar
Wim Taymans committed
225
  g_slice_free1 (GST_MINI_OBJECT_SIZE (event), event);
226 227
}

228 229 230
static void gst_event_init (GstEventImpl * event, gsize size,
    GstEventType type);

231
static GstEvent *
232
_gst_event_copy (GstEvent * event)
233
{
Wim Taymans's avatar
Wim Taymans committed
234 235
  GstEventImpl *copy;
  GstStructure *s;
236

237 238 239
  copy = g_slice_new0 (GstEventImpl);

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

Wim Taymans's avatar
Wim Taymans committed
241
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
242
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
243

Wim Taymans's avatar
Wim Taymans committed
244 245 246
  s = GST_EVENT_STRUCTURE (event);
  if (s) {
    GST_EVENT_STRUCTURE (copy) = gst_structure_copy (s);
Wim Taymans's avatar
Wim Taymans committed
247 248
    gst_structure_set_parent_refcount (GST_EVENT_STRUCTURE (copy),
        &copy->event.mini_object.refcount);
249
  }
Wim Taymans's avatar
Wim Taymans committed
250
  return GST_EVENT_CAST (copy);
251 252
}

Wim Taymans's avatar
Wim Taymans committed
253
static void
Wim Taymans's avatar
Wim Taymans committed
254
gst_event_init (GstEventImpl * event, gsize size, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
255
{
Wim Taymans's avatar
Wim Taymans committed
256
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type, size);
Wim Taymans's avatar
Wim Taymans committed
257

Wim Taymans's avatar
Wim Taymans committed
258 259
  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
260 261 262 263 264 265

  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
266 267
static GstEvent *
gst_event_new (GstEventType type)
268
{
Wim Taymans's avatar
Wim Taymans committed
269
  GstEventImpl *event;
270

Wim Taymans's avatar
Wim Taymans committed
271
  event = g_slice_new0 (GstEventImpl);
272

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
273 274
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
275

Wim Taymans's avatar
Wim Taymans committed
276
  gst_event_init (event, sizeof (GstEventImpl), type);
277

Wim Taymans's avatar
Wim Taymans committed
278
  return GST_EVENT_CAST (event);
279 280
}

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

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

Wim Taymans's avatar
Wim Taymans committed
312
    GST_EVENT_STRUCTURE (event) = structure;
Wim Taymans's avatar
Wim Taymans committed
313
  }
314
  return event;
Wim Taymans's avatar
Wim Taymans committed
315 316 317 318 319 320 321 322

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

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

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

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
398
  return gst_structure_has_name (GST_EVENT_STRUCTURE (event), name);
399 400
}

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
563 564
/**
 * gst_event_new_caps:
565
 * @caps: (transfer none): a #GstCaps
Wim Taymans's avatar
Wim Taymans committed
566 567
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
Wim Taymans's avatar
Wim Taymans committed
568
 * synchronized with the buffer flow and contains the format of the buffers
Wim Taymans's avatar
Wim Taymans committed
569 570 571 572 573 574 575 576 577
 * 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
578 579
  g_return_val_if_fail (caps != NULL, NULL);
  g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
580

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

583
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
584
      gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Wim Taymans's avatar
Wim Taymans committed
585 586 587 588 589 590 591 592 593 594
          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
 *
595 596
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
597 598 599 600
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
601 602
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
603 604 605
  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
606
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
607 608 609 610
  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
611 612
}

613
/**
Wim Taymans's avatar
Wim Taymans committed
614
 * gst_event_new_segment:
615
 * @segment: (transfer none): a #GstSegment
616
 *
Wim Taymans's avatar
Wim Taymans committed
617 618 619
 * 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
620 621
 *
 * The newsegment event marks the range of buffers to be processed. All
622
 * data not within the segment range is not to be processed. This can be
623
 * used intelligently by plugins to apply more efficient methods of skipping
624 625
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
626
 *
627
 * The time value of the segment is used in conjunction with the start
Wim Taymans's avatar
Wim Taymans committed
628 629 630
 * 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
631
 * @start. @time cannot be -1.
632
 *
633
 * @start cannot be -1, @stop can be -1. If there
Wim Taymans's avatar
Wim Taymans committed
634
 * is a valid @stop given, it must be greater or equal the @start, including
635
 * when the indicated playback @rate is < 0.
636 637
 *
 * The @applied_rate value provides information about any rate adjustment that
Wim Taymans's avatar
Wim Taymans committed
638 639 640 641 642
 * 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
643
 * with @rate of 1.0 and @applied_rate of 2.0
644
 *
Wim Taymans's avatar
Wim Taymans committed
645 646
 * After a newsegment event, the buffer stream time is calculated with:
 *
647
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
648
 *
Wim Taymans's avatar
Wim Taymans committed
649
 * Returns: (transfer full): the new SEGMENT event.
650
 */
651
GstEvent *
652
gst_event_new_segment (const GstSegment * segment)
653
{
654 655
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
656
  g_return_val_if_fail (segment != NULL, NULL);
657 658 659
  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);
660

661
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
662 663 664
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
665
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
666
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
667 668

  return event;
Wim Taymans's avatar
Wim Taymans committed
669
}
670

Wim Taymans's avatar
Wim Taymans committed
671
/**
672 673 674
 * 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
675
 *
676 677 678
 * 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
679
 */
680 681
void
gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
Wim Taymans's avatar
Wim Taymans committed
682
{
Wim Taymans's avatar
Wim Taymans committed
683
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
684

685 686
  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
687

688 689 690 691 692
  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
693 694 695
}

/**
696
 * gst_event_copy_segment:
Wim Taymans's avatar
Wim Taymans committed
697
 * @event: The event to parse
698
 * @segment: a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
699
 *
700 701
 * Parses a segment @event and copies the #GstSegment into the location
 * given by @segment.
Wim Taymans's avatar
Wim Taymans committed
702 703
 */
void
704
gst_event_copy_segment (GstEvent * event, GstSegment * segment)
Wim Taymans's avatar
Wim Taymans committed
705 706 707
{
  const GstSegment *src;

708 709
  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
710

711 712 713 714
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
715
}
716

717 718
/**
 * gst_event_new_tag:
719 720
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
721 722
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
723
 *
724
 * Returns: (transfer full): a new #GstEvent
725
 */
Wim Taymans's avatar
Wim Taymans committed
726 727 728 729
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
730

Wim Taymans's avatar
Wim Taymans committed
731
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
732 733
}

734 735 736
/**
 * gst_event_parse_tag:
 * @event: a tag event
737
 * @taglist: (out) (transfer none): pointer to metadata list
738 739
 *
 * Parses a tag @event and stores the results in the given @taglist location.
740 741 742
 * 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.
743
 */
Wim Taymans's avatar
Wim Taymans committed
744 745 746 747 748
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);
749

Wim Taymans's avatar
Wim Taymans committed
750
  if (taglist)
Wim Taymans's avatar
Wim Taymans committed
751
    *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
752 753
}

754 755
/* buffersize event */
/**
756
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
757 758 759 760
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
761 762 763 764
 *
 * 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
765
 * When the @async flag is set, a thread boundary is preferred.
766
 *
767
 * Returns: (transfer full): a new #GstEvent
768 769
 */
GstEvent *
770
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
771 772
    gint64 maxsize, gboolean async)
{
773 774 775
  GstEvent *event;
  GstStructure *structure;

776
  GST_CAT_INFO (GST_CAT_EVENT,
777 778
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
779
      minsize, maxsize, async);
780

Wim Taymans's avatar
Wim Taymans committed
781
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
782 783 784 785 786 787 788
      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;
789 790
}

Stefan Kost's avatar
Stefan Kost committed
791
/**
792
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
793
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
794 795 796 797
 * @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
798 799 800
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
801
void
802
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
803 804 805 806 807 808
    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);
809

Wim Taymans's avatar
Wim Taymans committed
810
  structure = GST_EVENT_STRUCTURE (event);
811
  if (format)
812
    *format = (GstFormat)
813 814
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
815 816
  if (minsize)
    *minsize =
817 818
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
819 820
  if (maxsize)
    *maxsize =
821 822
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
823
  if (async)
824 825 826
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
827 828
}

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

888 889 890
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

891
  GST_CAT_LOG (GST_CAT_EVENT,
Wim Taymans's avatar
Wim Taymans committed
892 893
      "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
      ", timestamp %" GST_TIME_FORMAT, type, proportion,
894
      diff, GST_TIME_ARGS (timestamp));
895

Wim Taymans's avatar
Wim Taymans committed
896
  structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
897 898 899 900 901
      GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
      GST_QUARK (PROPORTION), G_TYPE_DOUBLE, proportion,
      GST_QUARK (DIFF), G_TYPE_INT64, diff,
      GST_QUARK (TIMESTAMP), G_TYPE_UINT64, timestamp, NULL);
  event = gst_event_new_custom (GST_EVENT_QOS, structure);
902 903

  return event;
Wim Taymans's avatar
Wim Taymans committed
904
}
905

Wim Taymans's avatar
Wim Taymans committed
906 907 908
/**
 * gst_event_parse_qos:
 * @event: The event to query
Wim Taymans's avatar
Wim Taymans committed
909 910 911 912 913 914
 * @type: (out): A pointer to store the QoS type in
 * @proportion: (out): A pointer to store the proportion in
 * @diff: (out): A pointer to store the diff in
 * @timestamp: (out): A pointer to store the timestamp in
 *
 * Get the type, proportion, diff and timestamp in the qos event. See
Wim Taymans's avatar
Wim Taymans committed
915
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
916 917
 */
void
Wim Taymans's avatar
Wim Taymans committed
918
gst_event_parse_qos (GstEvent * event, GstQOSType * type,
Wim Taymans's avatar
Wim Taymans committed
919
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
920
{
921 922
  const GstStructure *structure;

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

926
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
927
  if (type)
928
    *type = (GstQOSType)
929 930
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (TYPE)));
Wim Taymans's avatar
Wim Taymans committed
931
  if (proportion)
932 933 934
    *proportion =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (PROPORTION)));
Wim Taymans's avatar
Wim Taymans committed
935
  if (diff)
936 937 938
    *diff =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (DIFF)));
Wim Taymans's avatar
Wim Taymans committed
939
  if (timestamp)
940 941 942
    *timestamp =
        g_value_get_uint64 (gst_structure_id_get_value (structure,
            GST_QUARK (TIMESTAMP)));
943
}
944 945

/**
Wim Taymans's avatar
Wim Taymans committed
946 947 948
 * gst_event_new_seek:
 * @rate: The new playback rate
 * @format: The format of the seek values
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
949
 * @flags: The optional seek flags
950 951
 * @start_type: The type and flags for the new start position
 * @start: The value of the new start position
Wim Taymans's avatar
Wim Taymans committed
952 953 954 955 956
 * @stop_type: The type and flags for the new stop position
 * @stop: The value of the new stop position
 *
 * Allocate a new seek event with the given parameters.
 *