gstevent.c 53.2 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
4
 *                    2005 Wim Taymans <wim@fluendo.com>
5
 *
6
 * gstevent.c: GstEvent subsystem
7 8 9 10 11 12 13 14 15 16 17 18 19 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
 * The event should be unreffed with gst_event_unref() if it has not been sent.
 *
Wim Taymans's avatar
Wim Taymans committed
39
 * Events that have been received can be parsed with their respective
40
 * gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.
41
 *
Wim Taymans's avatar
Wim Taymans committed
42 43
 * Events are passed between elements in parallel to the data stream. Some events
 * are serialized with buffers, others are not. Some events only travel downstream,
Wim Taymans's avatar
Wim Taymans committed
44 45
 * others only upstream. Some events can travel both upstream and downstream.
 *
46 47 48
 * The events are used to signal special conditions in the datastream such as
 * EOS (end of stream) or the start of a new stream-segment.
 * Events are also used to flush the pipeline of any pending data.
Wim Taymans's avatar
Wim Taymans committed
49
 *
Wim Taymans's avatar
Wim Taymans committed
50 51
 * Most of the event API is used inside plugins. Applications usually only
 * construct and use seek events.
52
 * To do that gst_event_new_seek() is used to create a seek event. It takes
Piotr Fusik's avatar
Piotr Fusik committed
53
 * the needed parameters to specify seeking time and mode.
Wim Taymans's avatar
Wim Taymans committed
54 55 56 57 58 59 60 61 62 63
 * <example>
 * <title>performing a seek on a pipeline</title>
 *   <programlisting>
 *   GstEvent *event;
 *   gboolean result;
 *   ...
 *   // construct a seek event to play the media from second 2 to 5, flush
 *   // the pipeline to decrease latency.
 *   event = gst_event_new_seek (1.0, 
 *      GST_FORMAT_TIME, 
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
64 65 66
 *      GST_SEEK_FLAG_FLUSH,
 *      GST_SEEK_TYPE_SET, 2 * GST_SECOND,
 *      GST_SEEK_TYPE_SET, 5 * GST_SECOND);
Wim Taymans's avatar
Wim Taymans committed
67 68 69 70 71 72 73
 *   ...
 *   result = gst_element_send_event (pipeline, event);
 *   if (!result)
 *     g_warning ("seek failed");
 *   ...
 *   </programlisting>
 * </example>
Wim Taymans's avatar
Wim Taymans committed
74
 *
Wim Taymans's avatar
Wim Taymans committed
75
 * Last reviewed on 2012-03-28 (0.11.3)
76
 */
Wim Taymans's avatar
Wim Taymans committed
77

78

79
#include "gst_private.h"
80
#include <string.h>             /* memcpy */
81 82

#include "gstinfo.h"
83
#include "gstevent.h"
Wim Taymans's avatar
Wim Taymans committed
84
#include "gstenumtypes.h"
85
#include "gstutils.h"
86
#include "gstquark.h"
87
#include "gstvalue.h"
Benjamin Otte's avatar
Benjamin Otte committed
88

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

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

  GstStructure *structure;
} GstEventImpl;

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

100 101
typedef struct
{
102 103
  const gint type;
  const gchar *name;
104 105 106 107 108 109 110
  GQuark quark;
} GstEventQuarks;

static GstEventQuarks event_quarks[] = {
  {GST_EVENT_UNKNOWN, "unknown", 0},
  {GST_EVENT_FLUSH_START, "flush-start", 0},
  {GST_EVENT_FLUSH_STOP, "flush-stop", 0},
Wim Taymans's avatar
Wim Taymans committed
111
  {GST_EVENT_STREAM_START, "stream-start", 0},
Wim Taymans's avatar
Wim Taymans committed
112
  {GST_EVENT_CAPS, "caps", 0},
Wim Taymans's avatar
Wim Taymans committed
113
  {GST_EVENT_STREAM_CONFIG, "stream-config", 0},
Wim Taymans's avatar
Wim Taymans committed
114
  {GST_EVENT_SEGMENT, "segment", 0},
115
  {GST_EVENT_TAG, "tag", 0},
116
  {GST_EVENT_TOC, "toc", 0},
117
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
118
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
Wim Taymans's avatar
Wim Taymans committed
119 120
  {GST_EVENT_EOS, "eos", 0},
  {GST_EVENT_SEGMENT_DONE, "segment-done", 0},
121
  {GST_EVENT_GAP, "gap", 0},
122 123 124
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
125
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
126
  {GST_EVENT_STEP, "step", 0},
127
  {GST_EVENT_RECONFIGURE, "reconfigure", 0},
128
  {GST_EVENT_TOC_SELECT, "toc-select", 0},
129 130 131
  {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
132
  {GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, "custom-downstream-sticky", 0},
133 134 135
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

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

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

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

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

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

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

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

  return ret;
}

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

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

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

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

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

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

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

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

243 244
  copy = g_slice_new0 (GstEventImpl);

245
  gst_event_init (copy, GST_EVENT_TYPE (event));
246

Wim Taymans's avatar
Wim Taymans committed
247
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
248
  GST_EVENT_SEQNUM (copy) = GST_EVENT_SEQNUM (event);
249

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

Wim Taymans's avatar
Wim Taymans committed
261
static void
262
gst_event_init (GstEventImpl * event, GstEventType type)
Wim Taymans's avatar
Wim Taymans committed
263
{
264
  gst_mini_object_init (GST_MINI_OBJECT_CAST (event), _gst_event_type);
Wim Taymans's avatar
Wim Taymans committed
265

Wim Taymans's avatar
Wim Taymans committed
266 267
  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
268 269 270 271 272 273

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

274

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

  event = g_slice_new0 (GstEventImpl);

  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
303

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

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

  GST_EVENT_STRUCTURE (event) = structure;

  return GST_EVENT_CAST (event);
Wim Taymans's avatar
Wim Taymans committed
316 317 318 319

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

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

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

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

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

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

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

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

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

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

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

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

560 561
/**
 * gst_event_new_gap:
562 563
 * @timestamp: the start time (pts) of the gap
 * @duration: the duration of the gap
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
 *
 * Create a new GAP event. A gap event can be thought of as conceptually
 * equivalent to a buffer to signal that there is no data for a certain
 * amount of time. This is useful to signal a gap to downstream elements
 * which may wait for data, such as muxers or mixers or overlays, especially
 * for sparse streams such as subtitle streams.
 *
 * Returns: (transfer full): the new GAP event.
 */
GstEvent *
gst_event_new_gap (GstClockTime timestamp, GstClockTime duration)
{
  GstEvent *event;

  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
579
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (duration), NULL);
580 581 582

  GST_CAT_TRACE (GST_CAT_EVENT, "creating gap %" GST_TIME_FORMAT " - "
      "%" GST_TIME_FORMAT " (duration: %" GST_TIME_FORMAT ")",
583 584
      GST_TIME_ARGS (timestamp), GST_TIME_ARGS (timestamp + duration),
      GST_TIME_ARGS (duration));
585 586 587 588 589 590 591 592 593 594 595

  event = gst_event_new_custom (GST_EVENT_GAP,
      gst_structure_new_id (GST_QUARK (EVENT_GAP),
          GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
          GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL));

  return event;
}

/**
 * gst_event_parse_gap:
Wim Taymans's avatar
Wim Taymans committed
596
 * @event: a #GstEvent of type #GST_EVENT_GAP
597 598
 * @timestamp: (out) (allow-none): location where to store the
 *     start time (pts) of the gap, or %NULL
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
 * @duration: (out) (allow-none): location where to store the duration of
 *     the gap, or %NULL
 *
 * Extract timestamp and duration from a new GAP event.
 */
void
gst_event_parse_gap (GstEvent * event, GstClockTime * timestamp,
    GstClockTime * duration)
{
  GstStructure *structure;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_GAP);

  structure = GST_EVENT_STRUCTURE (event);
  gst_structure_id_get (structure,
      GST_QUARK (TIMESTAMP), GST_TYPE_CLOCK_TIME, timestamp,
      GST_QUARK (DURATION), GST_TYPE_CLOCK_TIME, duration, NULL);
}

Wim Taymans's avatar
Wim Taymans committed
619 620
/**
 * gst_event_new_caps:
621
 * @caps: (transfer none): a #GstCaps
Wim Taymans's avatar
Wim Taymans committed
622 623
 *
 * Create a new CAPS event for @caps. The caps event can only travel downstream
Wim Taymans's avatar
Wim Taymans committed
624
 * synchronized with the buffer flow and contains the format of the buffers
Wim Taymans's avatar
Wim Taymans committed
625 626 627 628 629 630 631 632 633
 * 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
634 635
  g_return_val_if_fail (caps != NULL, NULL);
  g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
636

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

639
  event = gst_event_new_custom (GST_EVENT_CAPS,
Wim Taymans's avatar
Wim Taymans committed
640
      gst_structure_new_id (GST_QUARK (EVENT_CAPS),
Wim Taymans's avatar
Wim Taymans committed
641 642 643 644 645 646 647 648 649 650
          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
 *
651 652
 * Get the caps from @event. The caps remains valid as long as @event remains
 * valid.
Wim Taymans's avatar
Wim Taymans committed
653 654 655 656
 */
void
gst_event_parse_caps (GstEvent * event, GstCaps ** caps)
{
Wim Taymans's avatar
Wim Taymans committed
657 658
  GstStructure *structure;

Wim Taymans's avatar
Wim Taymans committed
659 660 661
  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
662
  structure = GST_EVENT_STRUCTURE (event);
Wim Taymans's avatar
Wim Taymans committed
663 664 665 666
  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
667 668
}

669 670 671 672 673 674 675
/**
 * gst_event_new_stream_config:
 * @flags: the stream config flags
 *
 * Create a new STREAM CONFIG event. The stream config event travels
 * downstream synchronized with the buffer flow and contains stream
 * configuration information for the stream, such as stream-headers
676
 * or setup-data. It is optional and should be sent after the CAPS
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
 * event.
 *
 * Returns: (transfer full): the new STREAM CONFIG event.
 */
GstEvent *
gst_event_new_stream_config (GstStreamConfigFlags flags)
{
  GstEvent *event;

  GST_CAT_INFO (GST_CAT_EVENT, "creating stream info event, flags=0x%x", flags);

  event = gst_event_new_custom (GST_EVENT_STREAM_CONFIG,
      gst_structure_new_id (GST_QUARK (EVENT_STREAM_CONFIG),
          GST_QUARK (FLAGS), GST_TYPE_STREAM_CONFIG_FLAGS, flags, NULL));

  return event;
}

/**
 * gst_event_parse_stream_config:
 * @event: The event to parse
 * @flags: (out): a pointer to a variable to store the stream config flags
 *
 * Get the stream config flags from @event.
 */
void
gst_event_parse_stream_config (GstEvent * event, GstStreamConfigFlags * flags)
{
  GstStructure *structure;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);

  structure = GST_EVENT_STRUCTURE (event);
  if (G_LIKELY (flags != NULL)) {
    *flags =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FLAGS)));
  }
}

/**
719
 * gst_event_set_stream_config_setup_data:
720
 * @event: a stream config event
721
 * @buf: a #GstBuffer with setup data
722
 *
723 724
 * Set setup data on the stream info event to signal out of bound setup data
 * to downstream elements. Unlike stream headers, setup data contains data
725 726 727 728 729
 * that is required to interpret the data stream, but is not valid as-is
 * inside the data stream and thus can't just be prepended to or inserted
 * into the data stream.
 */
void
730
gst_event_set_stream_config_setup_data (GstEvent * event, GstBuffer * buf)
731 732 733 734 735 736 737 738
{
  GstStructure *s;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
  g_return_if_fail (GST_IS_BUFFER (buf) && gst_buffer_get_size (buf) > 0);

  s = GST_EVENT_STRUCTURE (event);
739
  gst_structure_id_set (s, GST_QUARK (SETUP_DATA), GST_TYPE_BUFFER, buf, NULL);
740 741 742
}

/**
Wim Taymans's avatar
Wim Taymans committed
743
 * gst_event_parse_stream_config_setup_data:
744
 * @event: a stream config event
745
 * @buf: (out) (transfer none): location where to store the #GstBuffer with setup data
746
 *
747 748
 * Extracts the setup data buffer from the stream info event. Will store
 * %NULL in @buf if the event contains no setup data. The buffer returned
749
 * will remain valid as long as @event remains valid. The caller should
750
 * acquire a reference to to @buf if needed.
751 752 753
 *
 * Returns: TRUE if @event contained setup data and @buf has been set,
 *     otherwise FALSE.
754
 */
755
gboolean
756
gst_event_parse_stream_config_setup_data (GstEvent * event, GstBuffer ** buf)
757 758 759 760
{
  const GValue *val;
  GstStructure *s;

761 762 763 764
  g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
  g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG,
      FALSE);
  g_return_val_if_fail (buf != NULL, FALSE);
765 766

  s = GST_EVENT_STRUCTURE (event);
767
  val = gst_structure_id_get_value (s, GST_QUARK (SETUP_DATA));
768 769 770 771
  if (val != NULL)
    *buf = g_value_get_boxed (val);
  else
    *buf = NULL;
772 773

  return (*buf != NULL);
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
}

/**
 * gst_event_add_stream_config_header:
 * @event: a stream config event
 * @buf: a #GstBuffer with stream header data
 *
 * Adds a stream header to the stream info event to signal stream headers to
 * to downstream elements such as multifilesink, tcpserversink etc. Stream
 * headers can be and should usually be prepended to the data stream at any
 * point in the stream (which requires a streamable format), e.g. to a new
 * client connecting, or when starting a new file segment. stream header
 * buffers will all be used together in the order they were added to the
 * stream config event. Stream headers are sent as buffers at the beginning
 * of the data flow in addition to the stream config event. Elements that
 * care about stream headers need to make sure that they don't insert or
 * interpret these header buffers twice if they interpret them.
 */
void
gst_event_add_stream_config_header (GstEvent * event, GstBuffer * buf)
{
  GstStructure *s;
  GValue buf_val = { 0, };
  GValue *val;

  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG);
  g_return_if_fail (GST_IS_BUFFER (buf) && gst_buffer_get_size (buf) > 0);

  g_value_init (&buf_val, GST_TYPE_BUFFER);
  g_value_set_boxed (&buf_val, buf);

  s = GST_EVENT_STRUCTURE (event);
  val = (GValue *) gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));
  if (val == NULL) {
    GValue new_array = { 0, };

    g_value_init (&new_array, GST_TYPE_ARRAY);
    gst_value_array_append_value (&new_array, &buf_val);
    gst_structure_id_take_value (s, GST_QUARK (STREAM_HEADERS), &new_array);
  } else {
    gst_value_array_append_value (val, &buf_val);
  }
  g_value_unset (&buf_val);
}

/**
 * gst_event_get_n_stream_config_headers:
 * @event: a stream config event
 *
 * Extract the number of stream header buffers.
 *
 * Returns: the number of stream header buffers attached to the stream info
 * @event.
 */
guint
gst_event_get_n_stream_config_headers (GstEvent * event)
{
  const GValue *val;
  GstStructure *s;
  guint num = 0;

  g_return_val_if_fail (GST_IS_EVENT (event), 0);
  g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG, 0);

  s = GST_EVENT_STRUCTURE (event);
  val = gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));

  if (val != NULL)
    num = gst_value_array_get_size (val);

  return num;
}

/**
 * gst_event_parse_nth_stream_config_header:
 * @event: a stream config event
 * @index: number of the stream header to retrieve
852 853
 * @buf: (out) (transfer none): location where to store the n-th stream
 *     header #GstBuffer
854 855 856 857
 *
 * Retrieves the n-th stream header buffer attached to the stream config
 * event and stores it in @buf. Will store %NULL in @buf if there is no such
 * stream header.
858 859 860
 *
 * Returns: TRUE if @event contained a stream header at @index and @buf has
 *    been set, otherwise FALSE.
861
 */
862
gboolean
863 864 865 866 867 868 869
gst_event_parse_nth_stream_config_header (GstEvent * event, guint index,
    GstBuffer ** buf)
{
  const GValue *val, *buf_val;
  GstStructure *s;
  GstBuffer *ret = NULL;

870 871 872 873
  g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
  g_return_val_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_CONFIG,
      FALSE);
  g_return_val_if_fail (buf != NULL, FALSE);
874 875 876 877 878 879 880 881 882 883 884

  s = GST_EVENT_STRUCTURE (event);
  val = gst_structure_id_get_value (s, GST_QUARK (STREAM_HEADERS));

  if (val != NULL) {
    buf_val = gst_value_array_get_value (val, index);
    if (buf_val != NULL)
      ret = g_value_get_boxed (buf_val);
  }

  *buf = ret;
885
  return (ret != NULL);
886 887
}

888
/**
Wim Taymans's avatar
Wim Taymans committed
889
 * gst_event_new_segment:
890
 * @segment: (transfer none): a #GstSegment
891
 *
Wim Taymans's avatar
Wim Taymans committed
892 893 894
 * 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
895 896
 *
 * The newsegment event marks the range of buffers to be processed. All
897
 * data not within the segment range is not to be processed. This can be
898
 * used intelligently by plugins to apply more efficient methods of skipping
899 900
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
901
 *
902
 * The time value of the segment is used in conjunction with the start
Wim Taymans's avatar
Wim Taymans committed
903 904 905
 * 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
906
 * @start. @time cannot be -1.
907
 *
908
 * @start cannot be -1, @stop can be -1. If there
Wim Taymans's avatar
Wim Taymans committed
909
 * is a valid @stop given, it must be greater or equal the @start, including
910
 * when the indicated playback @rate is < 0.
911 912
 *
 * The @applied_rate value provides information about any rate adjustment that
Wim Taymans's avatar
Wim Taymans committed
913 914 915 916 917
 * 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
918
 * with @rate of 1.0 and @applied_rate of 2.0
919
 *
Wim Taymans's avatar
Wim Taymans committed
920 921
 * After a newsegment event, the buffer stream time is calculated with:
 *
922
 *   time + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
923
 *
Wim Taymans's avatar
Wim Taymans committed
924
 * Returns: (transfer full): the new SEGMENT event.
925
 */
926
GstEvent *
927
gst_event_new_segment (const GstSegment * segment)
928
{
929 930
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
931
  g_return_val_if_fail (segment != NULL, NULL);
932 933 934
  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);
935

936
  GST_CAT_INFO (GST_CAT_EVENT, "creating segment event %" GST_SEGMENT_FORMAT,
Wim Taymans's avatar
Wim Taymans committed
937 938 939
      segment);

  event = gst_event_new_custom (GST_EVENT_SEGMENT,
Wim Taymans's avatar
Wim Taymans committed
940
      gst_structure_new_id (GST_QUARK (EVENT_SEGMENT),
Wim Taymans's avatar
Wim Taymans committed
941
          GST_QUARK (SEGMENT), GST_TYPE_SEGMENT, segment, NULL));
942 943

  return event;
Wim Taymans's avatar
Wim Taymans committed
944
}
945

Wim Taymans's avatar
Wim Taymans committed
946
/**
947 948 949
 * 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
950
 *
951 952 953
 * 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
954
 */
955 956
void
gst_event_parse_segment (GstEvent * event, const GstSegment ** segment)
Wim Taymans's avatar
Wim Taymans committed
957
{
Wim Taymans's avatar
Wim Taymans committed
958
  GstStructure *structure;
Wim Taymans's avatar
Wim Taymans committed
959

960 961
  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
962

963 964 965 966 967
  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
968 969 970
}

/**
971
 * gst_event_copy_segment:
Wim Taymans's avatar
Wim Taymans committed
972
 * @event: The event to parse
973
 * @segment: a pointer to a #GstSegment
Wim Taymans's avatar
Wim Taymans committed
974
 *
975 976
 * Parses a segment @event and copies the #GstSegment into the location
 * given by @segment.
Wim Taymans's avatar
Wim Taymans committed
977 978
 */
void
979
gst_event_copy_segment (GstEvent * event, GstSegment * segment)
Wim Taymans's avatar
Wim Taymans committed
980 981 982
{
  const GstSegment *src;

983 984
  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
985

986 987 988 989
  if (segment) {
    gst_event_parse_segment (event, &src);
    gst_segment_copy_into (src, segment);
  }
Wim Taymans's avatar
Wim Taymans committed
990
}
991

992 993
/**
 * gst_event_new_tag:
994
 * @name: (transfer none): the name of the event
995 996
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
997 998
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
999
 *
1000 1001 1002
 * Since the TAG event has the %GST_EVENT_TYPE_STICKY_MULTI flag set, the
 * @name will be used to keep track of multiple tag events.
 *
1003
 * Returns: (transfer full): a new #GstEvent
1004
 */
Wim Taymans's avatar
Wim Taymans committed
1005
GstEvent *
1006
gst_event_new_tag (const gchar * name, GstTagList * taglist)
Wim Taymans's avatar
Wim Taymans committed
1007
{
1008 1009 1010
  GstStructure *s;
  GValue val = G_VALUE_INIT;

Wim Taymans's avatar
Wim Taymans committed
1011
  g_return_val_if_fail (taglist != NULL, NULL);
1012

1013
  s = gst_structure_new_empty (name);
1014 1015 1016 1017
  g_value_init (&val, GST_TYPE_TAG_LIST);
  g_value_take_boxed (&val, taglist);
  gst_structure_id_take_value (s, GST_QUARK (TAGLIST), &val);
  return gst_event_new_custom (GST_EVENT_TAG, s);
1018 1019
}

1020 1021 1022
/**
 * gst_event_parse_tag:
 * @event: a tag event
1023
 * @taglist: (out) (transfer none): pointer to metadata list
1024 1025
 *
 * Parses a tag @event and stores the results in the given @taglist location.
1026 1027 1028
 * 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.
1029
 */
Wim Taymans's avatar
Wim Taymans committed
1030 1031 1032
void
gst_event_parse_tag (GstEvent * event, GstTagList ** taglist)
{
1033 1034
  const GValue *val;

Wim Taymans's avatar
Wim Taymans committed
1035 1036
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_TAG);
1037

1038 1039 1040
  val = gst_structure_id_get_value (GST_EVENT_STRUCTURE (event),
      GST_QUARK (TAGLIST));

Wim Taymans's avatar
Wim Taymans committed
1041
  if (taglist)
1042
    *taglist = (GstTagList *) g_value_get_boxed (val);
Wim Taymans's avatar
Wim Taymans committed
1043 1044
}

1045 1046
/* buffersize event */
/**