gstevent.c 40.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 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},
125 126 127
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

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

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

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

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

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

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

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

  return ret;
}

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

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

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

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

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

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

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

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

236 237 238
  copy = g_slice_new0 (GstEventImpl);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

324
/**
Wim Taymans's avatar
Wim Taymans committed
325 326
 * gst_event_get_structure:
 * @event: The #GstEvent.
327
 *
Wim Taymans's avatar
Wim Taymans committed
328
 * Access the structure of the event.
329
 *
Wim Taymans's avatar
Wim Taymans committed
330 331 332 333 334
 * Returns: The structure of the event. The structure is still
 * owned by the event, which means that you should not free it and
 * that the pointer becomes invalid when you free the event.
 *
 * MT safe.
335
 */
Wim Taymans's avatar
Wim Taymans committed
336 337
const GstStructure *
gst_event_get_structure (GstEvent * event)
338
{
Wim Taymans's avatar
Wim Taymans committed
339
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
340

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Wim Taymans's avatar
Wim Taymans committed
655
  g_return_val_if_fail (segment != NULL, NULL);
656

657
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
658 659 660
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
661
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
662
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
663 664

  return event;
Wim Taymans's avatar
Wim Taymans committed
665
}
666

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

681 682
  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
683

684 685 686 687 688
  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
689 690 691
}

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

704 705
  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
706

707 708 709 710
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
711
}
712

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

Wim Taymans's avatar
Wim Taymans committed
727
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
728 729
}

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

Wim Taymans's avatar
Wim Taymans committed
746
  if (taglist)
Wim Taymans's avatar
Wim Taymans committed
747
    *taglist = (GstTagList *) GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
748 749
}

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

772
  GST_CAT_INFO (GST_CAT_EVENT,
773 774
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
775
      minsize, maxsize, async);
776

Wim Taymans's avatar
Wim Taymans committed
777
  structure = gst_structure_new_id (GST_QUARK (EVENT_BUFFER_SIZE),
778 779 780 781 782 783 784
      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;
785 786
}

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

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

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

884 885 886
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

887
  GST_CAT_INFO (GST_CAT_EVENT,
Wim Taymans's avatar
Wim Taymans committed
888 889
      "creating qos type %d, proportion %lf, diff %" G_GINT64_FORMAT
      ", timestamp %" GST_TIME_FORMAT, type, proportion,
890
      diff, GST_TIME_ARGS (timestamp));
891

Wim Taymans's avatar
Wim Taymans committed
892
  structure = gst_structure_new_id (GST_QUARK (EVENT_QOS),
893 894 895 896 897
      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);
898 899

  return event;
Wim Taymans's avatar
Wim Taymans committed
900
}
901

Wim Taymans's avatar
Wim Taymans committed
902 903 904
/**
 * gst_event_parse_qos:
 * @event: The event to query
Wim Taymans's avatar
Wim Taymans committed
905 906 907 908 909 910
 * @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
911
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
912 913
 */
void
Wim Taymans's avatar
Wim Taymans committed
914
gst_event_parse_qos (GstEvent * event, GstQOSType * type,
Wim Taymans's avatar
Wim Taymans committed
915
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
916
{
917 918
  const GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
919 920
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
921

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

/**
Wim Taymans's avatar
Wim Taymans committed
942 943 944
 * 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
945
 * @flags: The optional seek flags
946 947
 * @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
948 949 950 951 952
 * @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.
 *
953 954 955
 * The seek event configures playback of the pipeline between @start to @stop
 * at the speed given in @rate, also called a playback segment.
 * The @start and @stop values are expressed in @format.
956
 *
Wim Taymans's avatar
Wim Taymans committed
957 958
 * A @rate of 1.0 means normal playback rate, 2.0 means double speed.
 * Negatives values means backwards playback. A value of 0.0 for the
Wim Taymans's avatar