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 53
 * 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
 * the needed parameters to specity 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

88 89
static void gst_event_finalize (GstEvent * event);
static GstEvent *_gst_event_copy (GstEvent * event);
90

91 92
static GstMiniObjectClass *parent_class = NULL;

93 94 95
void
_gst_event_initialize (void)
{
96 97 98
  g_type_class_ref (gst_event_get_type ());
  g_type_class_ref (gst_seek_flags_get_type ());
  g_type_class_ref (gst_seek_type_get_type ());
99 100
}

101 102
typedef struct
{
103 104
  const gint type;
  const gchar *name;
105 106 107 108 109 110 111 112 113 114
  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},
  {GST_EVENT_NEWSEGMENT, "newsegment", 0},
  {GST_EVENT_TAG, "tag", 0},
115
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
116
  {GST_EVENT_SINK_MESSAGE, "sink-message", 0},
117 118 119
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
120
  {GST_EVENT_LATENCY, "latency", 0},
Sebastian Dröge's avatar
Sebastian Dröge committed
121
  {GST_EVENT_STEP, "step", 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}
};

Stefan Kost's avatar
Stefan Kost committed
131 132 133 134 135 136
/**
 * 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
137
 * Returns: a reference to the static name of the event.
Stefan Kost's avatar
Stefan Kost committed
138
 */
139 140 141 142 143 144 145 146 147 148 149 150
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
151 152 153 154 155 156 157 158
/**
 * 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
 */
159 160 161 162 163 164 165 166 167 168 169 170
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;
}

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/**
 * 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;

  ret = type & ((1 << GST_EVENT_TYPE_SHIFT) - 1);

  return ret;
}

189 190 191 192 193 194 195
#define _do_init \
{ \
  gint i; \
  \
  for (i = 0; event_quarks[i].name; i++) { \
    event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name); \
  } \
196 197
}

198 199
G_DEFINE_TYPE_WITH_CODE (GstEvent, gst_event, GST_TYPE_MINI_OBJECT, _do_init);

200
static void
201
gst_event_class_init (GstEventClass * klass)
Wim Taymans's avatar
Wim Taymans committed
202
{
203
  parent_class = g_type_class_peek_parent (klass);
Wim Taymans's avatar
Wim Taymans committed
204

205 206
  klass->mini_object_class.copy = (GstMiniObjectCopyFunction) _gst_event_copy;
  klass->mini_object_class.finalize =
207 208
      (GstMiniObjectFinalizeFunction) gst_event_finalize;
}
Wim Taymans's avatar
Wim Taymans committed
209

210
static void
211
gst_event_init (GstEvent * event)
212 213
{
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
214 215
}

216
static void
217
gst_event_finalize (GstEvent * event)
218
{
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

225 226
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
227
    GST_EVENT_SRC (event) = NULL;
228
  }
Wim Taymans's avatar
Wim Taymans committed
229 230 231
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
232
  }
233

234
/*   GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (event)); */
235 236 237 238 239 240 241
}

static GstEvent *
_gst_event_copy (GstEvent * event)
{
  GstEvent *copy;

Wim Taymans's avatar
Wim Taymans committed
242
  copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
243

Wim Taymans's avatar
Wim Taymans committed
244 245
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  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 251 252 253
  if (GST_EVENT_SRC (event)) {
    GST_EVENT_SRC (copy) = gst_object_ref (GST_EVENT_SRC (event));
  }
  if (event->structure) {
    copy->structure = gst_structure_copy (event->structure);
    gst_structure_set_parent_refcount (copy->structure,
254
        &copy->mini_object.refcount);
255 256
  }
  return copy;
257 258
}

Wim Taymans's avatar
Wim Taymans committed
259 260
static GstEvent *
gst_event_new (GstEventType type)
261
{
Wim Taymans's avatar
Wim Taymans committed
262
  GstEvent *event;
263

Wim Taymans's avatar
Wim Taymans committed
264
  event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
265

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
266 267
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
268

Wim Taymans's avatar
Wim Taymans committed
269 270 271
  event->type = type;
  event->src = NULL;
  event->structure = NULL;
272
  GST_EVENT_SEQNUM (event) = gst_util_seqnum_next ();
273

Wim Taymans's avatar
Wim Taymans committed
274
  return event;
275 276
}

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

301 302 303 304
  /* structure must not have a parent */
  if (structure)
    g_return_val_if_fail (structure->parent_refcount == NULL, NULL);

Wim Taymans's avatar
Wim Taymans committed
305 306 307 308 309
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
310
  return event;
311 312
}

313
/**
Wim Taymans's avatar
Wim Taymans committed
314 315
 * gst_event_get_structure:
 * @event: The #GstEvent.
316
 *
Wim Taymans's avatar
Wim Taymans committed
317
 * Access the structure of the event.
318
 *
Wim Taymans's avatar
Wim Taymans committed
319 320 321 322 323
 * 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.
324
 */
Wim Taymans's avatar
Wim Taymans committed
325 326
const GstStructure *
gst_event_get_structure (GstEvent * event)
327
{
Wim Taymans's avatar
Wim Taymans committed
328
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
329

Wim Taymans's avatar
Wim Taymans committed
330
  return event->structure;
331
}
332

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
/**
 * 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);

  if (event->structure == NULL)
    return FALSE;

  return gst_structure_has_name (event->structure, name);
}

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/**
 * 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;
 * two events or messages will never not have the same sequence number unless
 * 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;
}

410 411 412 413
/* 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
414
/**
Wim Taymans's avatar
Wim Taymans committed
415 416
 * gst_event_new_flush_start:
 *
417
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
418
 * upstream and downstream and travels out-of-bounds with the dataflow.
419 420 421 422 423
 *
 * 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
424
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
425
 *
426 427
 * 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
428
 *
429 430
 * 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
431
 *
432
 * Returns: (transfer full): a new flush start event.
Wim Taymans's avatar
Wim Taymans committed
433
 */
434
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
435
gst_event_new_flush_start (void)
436
{
Wim Taymans's avatar
Wim Taymans committed
437
  return gst_event_new (GST_EVENT_FLUSH_START);
438 439
}

440
/**
Wim Taymans's avatar
Wim Taymans committed
441 442
 * gst_event_new_flush_stop:
 *
443
 * Allocate a new flush stop event. The flush stop event can be sent
Thiago Santos's avatar
Thiago Santos committed
444
 * upstream and downstream and travels serialized with the dataflow.
445
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
446
 * pads accept data again.
447
 *
Wim Taymans's avatar
Wim Taymans committed
448 449
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
450
 *
Wim Taymans's avatar
Wim Taymans committed
451 452 453
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
454
 * Returns: (transfer full): a new flush stop event.
455
 */
456
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
457
gst_event_new_flush_stop (void)
458
{
Wim Taymans's avatar
Wim Taymans committed
459
  return gst_event_new (GST_EVENT_FLUSH_STOP);
460 461
}

Wim Taymans's avatar
Wim Taymans committed
462
/**
Wim Taymans's avatar
Wim Taymans committed
463
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
464
 *
Wim Taymans's avatar
Wim Taymans committed
465 466
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
467 468
 * 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
469
 *
Jan Schmidt's avatar
Jan Schmidt committed
470
 * The EOS event will travel down to the sink elements in the pipeline
471
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
472
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
473
 *
474
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
475 476
 * forwarded to the application.
 *
Wim Taymans's avatar
Wim Taymans committed
477
 * The EOS event itself will not cause any state transitions of the pipeline.
Stefan Kost's avatar
Stefan Kost committed
478
 *
479
 * Returns: (transfer full): the new EOS event.
Wim Taymans's avatar
Wim Taymans committed
480
 */
Wim Taymans's avatar
Wim Taymans committed
481 482
GstEvent *
gst_event_new_eos (void)
483
{
Wim Taymans's avatar
Wim Taymans committed
484
  return gst_event_new (GST_EVENT_EOS);
485 486
}

487
/**
488
 * gst_event_new_new_segment:
489
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
490 491
 * @rate: a new rate for playback
 * @format: The format of the segment values
492 493 494
 * @start: the start value of the segment
 * @stop: the stop value of the segment
 * @position: stream position
Wim Taymans's avatar
Wim Taymans committed
495
 *
496 497 498 499
 * Allocate a new newsegment event with the given format/values tripplets
 *
 * This method calls gst_event_new_new_segment_full() passing a default
 * value of 1.0 for applied_rate
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
500
 *
501
 * Returns: (transfer full): a new newsegment event.
502 503 504 505 506 507 508 509 510 511 512 513
 */
GstEvent *
gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format,
    gint64 start, gint64 stop, gint64 position)
{
  return gst_event_new_new_segment_full (update, rate, 1.0, format, start,
      stop, position);
}

/**
 * gst_event_parse_new_segment:
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
514 515 516 517 518 519
 * @update: (out): A pointer to the update flag of the segment
 * @rate: (out): A pointer to the rate of the segment
 * @format: (out): A pointer to the format of the newsegment values
 * @start: (out): A pointer to store the start value in
 * @stop: (out): A pointer to store the stop value in
 * @position: (out): A pointer to store the stream time in
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
 *
 * Get the update flag, rate, format, start, stop and position in the 
 * newsegment event. In general, gst_event_parse_new_segment_full() should
 * be used instead of this, to also retrieve the applied_rate value of the
 * segment. See gst_event_new_new_segment_full() for a full description 
 * of the newsegment event.
 */
void
gst_event_parse_new_segment (GstEvent * event, gboolean * update,
    gdouble * rate, GstFormat * format, gint64 * start,
    gint64 * stop, gint64 * position)
{
  gst_event_parse_new_segment_full (event, update, rate, NULL, format, start,
      stop, position);
}

/**
 * gst_event_new_new_segment_full:
 * @update: Whether this segment is an update to a previous one
 * @rate: A new rate for playback
 * @applied_rate: The rate factor which has already been applied
 * @format: The format of the segment values
 * @start: The start value of the segment
 * @stop: The stop value of the segment
 * @position: stream position
 *
 * Allocate a new newsegment event with the given format/values triplets.
Wim Taymans's avatar
Wim Taymans committed
547 548
 *
 * The newsegment event marks the range of buffers to be processed. All
549
 * data not within the segment range is not to be processed. This can be
550
 * used intelligently by plugins to apply more efficient methods of skipping
551 552
 * unneeded data. The valid range is expressed with the @start and @stop
 * values.
553
 *
554 555 556 557 558
 * The position value of the segment is used in conjunction with the start
 * value to convert the buffer timestamps into the stream time. This is 
 * usually done in sinks to report the current stream_time. 
 * @position represents the stream_time of a buffer carrying a timestamp of 
 * @start. @position cannot be -1.
559
 *
560
 * @start cannot be -1, @stop can be -1. If there
561
 * is a valid @stop given, it must be greater or equal the @start, including 
562
 * when the indicated playback @rate is < 0.
563 564 565 566 567 568 569 570
 *
 * The @applied_rate value provides information about any rate adjustment that
 * 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 
 * with @rate of 1.0 and @applied_rate of 2.0
571
 *
Wim Taymans's avatar
Wim Taymans committed
572 573
 * After a newsegment event, the buffer stream time is calculated with:
 *
574
 *   position + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
575
 *
576
 * Returns: (transfer full): a new newsegment event.
577 578
 *
 * Since: 0.10.6
579
 */
580
GstEvent *
581 582 583
gst_event_new_new_segment_full (gboolean update, gdouble rate,
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
    gint64 position)
584
{
585 586 587
  GstEvent *event;
  GstStructure *structure;

588
  g_return_val_if_fail (rate != 0.0, NULL);
589
  g_return_val_if_fail (applied_rate != 0.0, NULL);
590

591 592
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
593
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
594
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
595 596 597
        ", position %" GST_TIME_FORMAT,
        update, rate, GST_TIME_ARGS (start),
        GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
598 599
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
600
        "creating newsegment update %d, rate %lf, format %s, "
601
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", position %"
602 603
        G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
        stop, position);
604
  }
605

606 607 608 609
  g_return_val_if_fail (position != -1, NULL);
  g_return_val_if_fail (start != -1, NULL);
  if (stop != -1)
    g_return_val_if_fail (start <= stop, NULL);
610

611
  structure = gst_structure_id_new (GST_QUARK (EVENT_NEWSEGMENT),
612 613 614 615 616 617 618 619 620 621
      GST_QUARK (UPDATE), G_TYPE_BOOLEAN, update,
      GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
      GST_QUARK (APPLIED_RATE), G_TYPE_DOUBLE, applied_rate,
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (START), G_TYPE_INT64, start,
      GST_QUARK (STOP), G_TYPE_INT64, stop,
      GST_QUARK (POSITION), G_TYPE_INT64, position, NULL);
  event = gst_event_new_custom (GST_EVENT_NEWSEGMENT, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
622
}
623

Wim Taymans's avatar
Wim Taymans committed
624
/**
625
 * gst_event_parse_new_segment_full:
Wim Taymans's avatar
Wim Taymans committed
626
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
627 628 629 630 631 632 633
 * @update: (out): A pointer to the update flag of the segment
 * @rate: (out): A pointer to the rate of the segment
 * @applied_rate: (out): A pointer to the applied_rate of the segment
 * @format: (out): A pointer to the format of the newsegment values
 * @start: (out): A pointer to store the start value in
 * @stop: (out): A pointer to store the stop value in
 * @position: (out): A pointer to store the stream time in
Wim Taymans's avatar
Wim Taymans committed
634
 *
635 636 637 638 639
 * Get the update, rate, applied_rate, format, start, stop and 
 * position in the newsegment event. See gst_event_new_new_segment_full() 
 * for a full description of the newsegment event.
 *
 * Since: 0.10.6
Wim Taymans's avatar
Wim Taymans committed
640 641
 */
void
642 643 644
gst_event_parse_new_segment_full (GstEvent * event, gboolean * update,
    gdouble * rate, gdouble * applied_rate, GstFormat * format,
    gint64 * start, gint64 * stop, gint64 * position)
Wim Taymans's avatar
Wim Taymans committed
645 646
{
  const GstStructure *structure;
647

Wim Taymans's avatar
Wim Taymans committed
648 649 650
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);

651
  structure = event->structure;
652
  if (G_LIKELY (update))
653
    *update =
654 655
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (UPDATE)));
656
  if (G_LIKELY (rate))
657 658 659
    *rate =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (RATE)));
660 661
  if (G_LIKELY (applied_rate))
    *applied_rate =
662 663
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (APPLIED_RATE)));
664
  if (G_LIKELY (format))
665 666 667
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
668
  if (G_LIKELY (start))
669 670 671
    *start =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (START)));
672
  if (G_LIKELY (stop))
673 674 675
    *stop =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (STOP)));
676
  if (G_LIKELY (position))
677
    *position =
678 679
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (POSITION)));
Wim Taymans's avatar
Wim Taymans committed
680
}
681

682 683
/**
 * gst_event_new_tag:
684 685
 * @taglist: (transfer full): metadata list. The event will take ownership
 *     of the taglist.
686 687
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
688
 *
689
 * Returns: (transfer full): a new #GstEvent
690
 */
Wim Taymans's avatar
Wim Taymans committed
691 692 693 694
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
695

Wim Taymans's avatar
Wim Taymans committed
696
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
697 698
}

699 700 701
/**
 * gst_event_parse_tag:
 * @event: a tag event
702
 * @taglist: (out) (transfer none): pointer to metadata list
703 704
 *
 * Parses a tag @event and stores the results in the given @taglist location.
705 706 707
 * 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.
708
 */
Wim Taymans's avatar
Wim Taymans committed
709 710 711 712 713
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);
714

Wim Taymans's avatar
Wim Taymans committed
715 716 717 718
  if (taglist)
    *taglist = (GstTagList *) event->structure;
}

719 720
/* buffersize event */
/**
721
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
722 723 724 725
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
726 727 728 729
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
730
 * When the @async flag is set, a thread boundary is prefered.
731
 *
732
 * Returns: (transfer full): a new #GstEvent
733 734
 */
GstEvent *
735
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
736 737
    gint64 maxsize, gboolean async)
{
738 739 740
  GstEvent *event;
  GstStructure *structure;

741
  GST_CAT_INFO (GST_CAT_EVENT,
742 743
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
744
      minsize, maxsize, async);
745

746
  structure = gst_structure_id_new (GST_QUARK (EVENT_BUFFER_SIZE),
747 748 749 750 751 752 753
      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;
754 755
}

Stefan Kost's avatar
Stefan Kost committed
756
/**
757
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
758
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
759 760 761 762
 * @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
763 764 765
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
766
void
767
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
768 769 770 771 772 773
    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);
774

775
  structure = event->structure;
776
  if (format)
777 778 779
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
780 781
  if (minsize)
    *minsize =
782 783
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
784 785
  if (maxsize)
    *maxsize =
786 787
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
788
  if (async)
789 790 791
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
792 793
}

794
/**
Wim Taymans's avatar
Wim Taymans committed
795 796 797 798 799
 * gst_event_new_qos:
 * @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
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
 * Allocate a new qos event with the given values. This function calls
 * gst_event_new_qos_full() with the type set to #GST_QOS_TYPE_OVERFLOW
 * when diff is negative (buffers are in time) and #GST_QOS_TYPE_UNDERFLOW
 * when @diff is positive (buffers are late).
 *
 * Returns: (transfer full): a new QOS event.
 */
GstEvent *
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
{
  GstQOSType type;

  if (diff <= 0)
    type = GST_QOS_TYPE_OVERFLOW;
  else
    type = GST_QOS_TYPE_UNDERFLOW;

  return gst_event_new_qos_full (type, proportion, diff, timestamp);
}

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

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

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

890
  structure = gst_structure_id_new (GST_QUARK (EVENT_QOS),
Wim Taymans's avatar
Wim Taymans committed
891
      GST_QUARK (TYPE), GST_TYPE_QOS_TYPE, type,
892 893 894 895 896 897
      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);

  return event;
Wim Taymans's avatar
Wim Taymans committed
898
}
899

Wim Taymans's avatar
Wim Taymans committed
900 901 902
/**
 * gst_event_parse_qos:
 * @event: The event to query
Johan Dahlin's avatar
Johan Dahlin committed
903 904 905
 * @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
Wim Taymans's avatar
Wim Taymans committed
906
 *
907 908
 * Get the proportion, diff and timestamp in the qos event. See
 * gst_event_new_qos() for more information about the different QoS values.
Wim Taymans's avatar
Wim Taymans committed
909 910 911 912
 */
void
gst_event_parse_qos (GstEvent * event, gdouble * proportion,
    GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
{
  gst_event_parse_qos_full (event, NULL, proportion, diff, timestamp);
}

/**
 * gst_event_parse_qos_full:
 * @event: The event to query
 * @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
 * gst_event_new_qos_full() for more information about the different QoS values.
 *
 * Since: 0.10.33
 */
void
gst_event_parse_qos_full (GstEvent * event, GstQOSType * type,
    gdouble * proportion, GstClockTimeDiff * diff, GstClockTime * timestamp)
Wim Taymans's avatar
Wim Taymans committed
933 934
{
  const GstStructure *structure;
935

Wim Taymans's avatar
Wim Taymans committed
936 937
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
938

939
  structure = event->structure;
Wim Taymans's avatar
Wim Taymans committed
940 941 942 943
  if (type)
    *type =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (TYPE)));
Wim Taymans's avatar
Wim Taymans committed
944 945
  if (proportion)
    *proportion =
946 947
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (PROPORTION)));
Wim Taymans's avatar
Wim Taymans committed
948
  if (diff)
949 950 951
    *diff =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (DIFF)));
Wim Taymans's avatar
Wim Taymans committed
952 953
  if (timestamp)
    *timestamp =
954 955
        g_value_get_uint64 (gst_structure_id_get_value (structure,
            GST_QUARK (TIMESTAMP)));
956
}
957 958

/**
Wim Taymans's avatar
Wim Taymans committed
959 960 961
 * 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
962
 * @flags: The optional seek flags
963 964
 * @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
965 966 967 968 969
 * @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.
 *
970 971 972
 * 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.
973
 *
Wim Taymans's avatar
Wim Taymans committed
974 975
 * 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
976 977 978
 * rate is not allowed and should be accomplished instead by PAUSING the
 * pipeline.
 *
979 980 981
 * A pipeline has a default playback segment configured with a start
 * position of 0, a stop position of -1 and a rate of 1.0. The currently
 * configured playback segment can be queried with #GST_QUERY_SEGMENT. 
982
 *
983
 * @start_type and @stop_type specify how to adjust the currently configured 
984 985 986
 * start and stop fields in playback segment. Adjustments can be made relative
 * or absolute to the last configured values. A type of #GST_SEEK_TYPE_NONE
 * means that the position should not be updated.
987
 *
988
 * When the rate is positive and @start has been updated, playback will start
989 990 991 992 993
 * from the newly configured start position. 
 *
 * For negative rates, playback will start from the newly configured stop
 * position (if any). If the stop position if updated, it must be different from
 * -1 for negative rates.
994 995 996 997
 *
 * It is not possible to seek relative to the current playback position, to do
 * this, PAUSE the pipeline, query the current playback position with
 * #GST_QUERY_POSITION and update the playback segment current position with a
998
 * #GST_SEEK_TYPE_SET to the desired position. 
999
 *
1000
 * Returns: (transfer full): a new seek event.
1001 1002
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
1003
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
1004
    GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
1005
{
1006 1007 1008
  GstEvent *event;
  GstStructure *structure;

1009 1010
  g_return_val_if_fail (rate != 0.0, NULL);

1011 1012 1013
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating seek rate %lf, format TIME, flags %d, "
1014
        "start_type %d, start %" GST_TIME_FORMAT ", "
1015
        "stop_type %d, stop %" GST_TIME_FORMAT,