gstevent.c 41.3 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
  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
110
  {GST_EVENT_STREAM_START, "stream-start", 0},
Wim Taymans's avatar
Wim Taymans committed
111
  {GST_EVENT_CAPS, "caps", 0},
Wim Taymans's avatar
Wim Taymans committed
112
  {GST_EVENT_STREAM_CONFIG, "stream-config", 0},
Wim Taymans's avatar
Wim Taymans committed
113
  {GST_EVENT_SEGMENT, "segment", 0},
114
  {GST_EVENT_TAG, "tag", 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 127 128
  {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
129
  {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
130 131 132
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

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

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

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

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

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

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

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

  return ret;
}

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

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

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

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

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

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

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

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

241 242 243
  copy = g_slice_new0 (GstEventImpl);

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
262 263
  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
264 265 266 267 268 269

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

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

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

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

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

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

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

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

  /* ERRORS */
had_parent:
  {
    gst_event_unref (event);
    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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
}

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

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

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

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

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

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

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

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

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
607 608 609
  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
610
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
611 612 613 614
  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
615 616
}

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

Wim Taymans's avatar
Wim Taymans committed
660
  g_return_val_if_fail (segment != NULL, NULL);
661 662 663
  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);
664

665
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
666 667 668
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
669
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
670
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
671 672

  return event;
Wim Taymans's avatar
Wim Taymans committed
673
}
674

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

689 690
  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
691

692 693 694 695 696
  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
697 698 699
}

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

712 713
  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
714

715 716 717 718
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
719
}
720

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

Wim Taymans's avatar
Wim Taymans committed
735
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
736 737
}

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

Wim Taymans's avatar
Wim Taymans committed
754
  if (taglist)
Wim Taymans's avatar
Wim Taymans committed
755
    *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
756 757
}

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

780
  GST_CAT_INFO (GST_CAT_EVENT,
781 782
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
783
      minsize, maxsize, async);
784

Wim Taymans's avatar
Wim Taymans committed
785
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
786 787 788 789 790 791 792
      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;
793 794
}

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

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

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

892 893 894
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

895
  GST_CAT_LOG (GST_CAT_EVENT,
Wim Taymans's avatar
Wim Taymans committed
896 897
      "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
      ", timestamp %" GST_TIME_FORMAT, type, proportion,
898
      diff, GST_TIME_ARGS (timestamp));
899

Wim Taymans's avatar
Wim Taymans committed
900
  structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
901 902 903 904 905
      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);
906 907

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

Wim Taymans's avatar
Wim Taymans committed
910 911 912
/**
 * gst_event_parse_qos:
 * @event: The event to query
Wim Taymans's avatar
Wim Taymans committed
913 914 915 916 917 918
 * @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
919
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
920 921
 */
void
Wim Taymans's avatar
Wim Taymans committed
922
gst_event_parse_qos (GstEvent * event, GstQOSType * type,
Wim Taymans's avatar
Wim Taymans committed
923
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
924
{
925 926
  const GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
927 928
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
929

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

/**
Wim Taymans's avatar
Wim Taymans committed
950 951 952
 * gst_event_new_seek:
 * @rate: The new playback rate
 * @format: The format of the seek values