gstevent.c 31.9 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
 *
30 31
 * The event class provides factory methods to construct and functions query
 * (parse) 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"
Benjamin Otte's avatar
Benjamin Otte committed
86

87 88 89 90
static void gst_event_init (GTypeInstance * instance, gpointer g_class);
static void gst_event_class_init (gpointer g_class, gpointer class_data);
static void gst_event_finalize (GstEvent * event);
static GstEvent *_gst_event_copy (GstEvent * event);
91

92 93
static GstMiniObjectClass *parent_class = NULL;

94 95 96
void
_gst_event_initialize (void)
{
97 98 99
  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 ());
100 101
}

102 103
typedef struct
{
104 105
  const gint type;
  const gchar *name;
106 107 108 109 110 111 112 113 114 115
  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},
116
  {GST_EVENT_BUFFERSIZE, "buffersize", 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},
121 122 123
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
124 125 126
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

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

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

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

188 189 190
GType
gst_event_get_type (void)
{
191
  static GType _gst_event_type = 0;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
192
  int i;
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

  if (G_UNLIKELY (_gst_event_type == 0)) {
    static const GTypeInfo event_info = {
      sizeof (GstEventClass),
      NULL,
      NULL,
      gst_event_class_init,
      NULL,
      NULL,
      sizeof (GstEvent),
      0,
      gst_event_init,
      NULL
    };

    _gst_event_type = g_type_register_static (GST_TYPE_MINI_OBJECT,
        "GstEvent", &event_info, 0);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
210 211 212 213

    for (i = 0; event_quarks[i].name; i++) {
      event_quarks[i].quark = g_quark_from_static_string (event_quarks[i].name);
    }
214
  }
215

216
  return _gst_event_type;
217 218
}

219 220
static void
gst_event_class_init (gpointer g_class, gpointer class_data)
Wim Taymans's avatar
Wim Taymans committed
221
{
222
  GstEventClass *event_class = GST_EVENT_CLASS (g_class);
Wim Taymans's avatar
Wim Taymans committed
223

224 225
  parent_class = g_type_class_peek_parent (g_class);

226 227 228 229 230
  event_class->mini_object_class.copy =
      (GstMiniObjectCopyFunction) _gst_event_copy;
  event_class->mini_object_class.finalize =
      (GstMiniObjectFinalizeFunction) gst_event_finalize;
}
Wim Taymans's avatar
Wim Taymans committed
231

232 233 234 235
static void
gst_event_init (GTypeInstance * instance, gpointer g_class)
{
  GstEvent *event;
236

237
  event = GST_EVENT (instance);
Wim Taymans's avatar
Wim Taymans committed
238

239
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
240 241
}

242
static void
243
gst_event_finalize (GstEvent * event)
244
{
245 246 247
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

248
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
249
      GST_EVENT_TYPE_NAME (event));
Wim Taymans's avatar
Wim Taymans committed
250

251 252
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
253
    GST_EVENT_SRC (event) = NULL;
254
  }
Wim Taymans's avatar
Wim Taymans committed
255 256 257
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
258
  }
259 260

  GST_MINI_OBJECT_CLASS (parent_class)->finalize (GST_MINI_OBJECT (event));
261 262 263 264 265 266 267
}

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

Wim Taymans's avatar
Wim Taymans committed
268
  copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
269

Wim Taymans's avatar
Wim Taymans committed
270 271
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
272

Wim Taymans's avatar
Wim Taymans committed
273 274 275 276 277 278
  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,
279
        &copy->mini_object.refcount);
280 281
  }
  return copy;
282 283
}

Wim Taymans's avatar
Wim Taymans committed
284 285
static GstEvent *
gst_event_new (GstEventType type)
286
{
Wim Taymans's avatar
Wim Taymans committed
287
  GstEvent *event;
288

Wim Taymans's avatar
Wim Taymans committed
289
  event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
290

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
291 292
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
293

Wim Taymans's avatar
Wim Taymans committed
294 295 296
  event->type = type;
  event->src = NULL;
  event->structure = NULL;
297

Wim Taymans's avatar
Wim Taymans committed
298
  return event;
299 300
}

301
/**
Wim Taymans's avatar
Wim Taymans committed
302
 * gst_event_new_custom:
303
 * @type: The type of the new event
Wim Taymans's avatar
Wim Taymans committed
304 305
 * @structure: The structure for the event. The event will take ownership of
 * the structure.
306
 *
Wim Taymans's avatar
Wim Taymans committed
307 308 309
 * 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.
310
 *
Wim Taymans's avatar
Wim Taymans committed
311 312 313 314 315 316 317 318
 * 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.
 *
 * Returns: The new custom event.
319
 */
320
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
321
gst_event_new_custom (GstEventType type, GstStructure * structure)
322 323 324
{
  GstEvent *event;

325 326 327 328
  /* 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
329 330 331 332 333
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
334
  return event;
335 336
}

337
/**
Wim Taymans's avatar
Wim Taymans committed
338 339
 * gst_event_get_structure:
 * @event: The #GstEvent.
340
 *
Wim Taymans's avatar
Wim Taymans committed
341
 * Access the structure of the event.
342
 *
Wim Taymans's avatar
Wim Taymans committed
343 344 345 346 347
 * 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.
348
 */
Wim Taymans's avatar
Wim Taymans committed
349 350
const GstStructure *
gst_event_get_structure (GstEvent * event)
351
{
Wim Taymans's avatar
Wim Taymans committed
352
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
353

Wim Taymans's avatar
Wim Taymans committed
354
  return event->structure;
355
}
356

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
/**
 * 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);
}

Wim Taymans's avatar
Wim Taymans committed
380
/**
Wim Taymans's avatar
Wim Taymans committed
381 382
 * gst_event_new_flush_start:
 *
383
 * Allocate a new flush start event. The flush start event can be sent
Wim Taymans's avatar
Wim Taymans committed
384
 * upstream and downstream and travels out-of-bounds with the dataflow.
385 386 387 388 389
 *
 * 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
390
 * on a flushing pad will return %FALSE immediately.
Wim Taymans's avatar
Wim Taymans committed
391
 *
392 393
 * 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
394
 *
395 396
 * 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
397
 *
Wim Taymans's avatar
Wim Taymans committed
398
 * Returns: A new flush start event.
Wim Taymans's avatar
Wim Taymans committed
399
 */
400
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
401
gst_event_new_flush_start (void)
402
{
Wim Taymans's avatar
Wim Taymans committed
403
  return gst_event_new (GST_EVENT_FLUSH_START);
404 405
}

406
/**
Wim Taymans's avatar
Wim Taymans committed
407 408
 * gst_event_new_flush_stop:
 *
409
 * Allocate a new flush stop event. The flush stop event can be sent
Wim Taymans's avatar
Wim Taymans committed
410
 * upstream and downstream and travels out-of-bounds with the dataflow.
411
 * It is typically sent after sending a FLUSH_START event to make the
Wim Taymans's avatar
Wim Taymans committed
412
 * pads accept data again.
413
 *
Wim Taymans's avatar
Wim Taymans committed
414 415
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
416
 *
Wim Taymans's avatar
Wim Taymans committed
417 418 419 420
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
 * Returns: A new flush stop event.
421
 */
422
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
423
gst_event_new_flush_stop (void)
424
{
Wim Taymans's avatar
Wim Taymans committed
425
  return gst_event_new (GST_EVENT_FLUSH_STOP);
426 427
}

Wim Taymans's avatar
Wim Taymans committed
428
/**
Wim Taymans's avatar
Wim Taymans committed
429
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
430
 *
Wim Taymans's avatar
Wim Taymans committed
431 432
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
433 434
 * 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
435
 *
Jan Schmidt's avatar
Jan Schmidt committed
436
 * The EOS event will travel down to the sink elements in the pipeline
437
 * which will then post the #GST_MESSAGE_EOS on the bus after they have
Jan Schmidt's avatar
Jan Schmidt committed
438
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
439
 *
440
 * When all sinks have posted an EOS message, an EOS message is
Wim Taymans's avatar
Wim Taymans committed
441 442 443
 * forwarded to the application.
 *
 * Returns: The new EOS event.
Wim Taymans's avatar
Wim Taymans committed
444
 */
Wim Taymans's avatar
Wim Taymans committed
445 446
GstEvent *
gst_event_new_eos (void)
447
{
Wim Taymans's avatar
Wim Taymans committed
448
  return gst_event_new (GST_EVENT_EOS);
449 450
}

451
/**
452
 * gst_event_new_new_segment:
453
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
454 455
 * @rate: a new rate for playback
 * @format: The format of the segment values
456 457 458
 * @start: the start value of the segment
 * @stop: the stop value of the segment
 * @position: stream position
Wim Taymans's avatar
Wim Taymans committed
459
 *
460 461 462 463
 * 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
464 465
 *
 * Returns: A new newsegment event.
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
 */
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
 * @update: A pointer to the update flag of the segment
 * @rate: A pointer to the rate of the segment
 * @format: A pointer to the format of the newsegment values
 * @start: A pointer to store the start value in
 * @stop: A pointer to store the stop value in
 * @position: A pointer to store the stream time in
 *
 * 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
511 512
 *
 * The newsegment event marks the range of buffers to be processed. All
513
 * data not within the segment range is not to be processed. This can be
514
 * used intelligently by plugins to apply more efficient methods of skipping
515
 * unneeded data.
516
 *
517 518 519 520 521
 * 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.
522
 *
523
 * @start cannot be -1, @stop can be -1. If there
524
 * is a valid @stop given, it must be greater or equal the @start, including 
525
 * when the indicated playback @rate is < 0.
526 527 528 529 530 531 532 533
 *
 * 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
534
 *
Wim Taymans's avatar
Wim Taymans committed
535 536
 * After a newsegment event, the buffer stream time is calculated with:
 *
537
 *   position + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
538 539
 *
 * Returns: A new newsegment event.
540 541
 *
 * Since: 0.10.6
542
 */
543
GstEvent *
544 545 546
gst_event_new_new_segment_full (gboolean update, gdouble rate,
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
    gint64 position)
547
{
548
  g_return_val_if_fail (rate != 0.0, NULL);
549
  g_return_val_if_fail (applied_rate != 0.0, NULL);
550

551 552
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
553
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
554
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
555 556 557
        ", position %" GST_TIME_FORMAT,
        update, rate, GST_TIME_ARGS (start),
        GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
558 559
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
560
        "creating newsegment update %d, rate %lf, format %s, "
561
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", position %"
562 563
        G_GINT64_FORMAT, update, rate, gst_format_get_name (format), start,
        stop, position);
564
  }
565

566 567 568 569
  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);
570

Wim Taymans's avatar
Wim Taymans committed
571
  return gst_event_new_custom (GST_EVENT_NEWSEGMENT,
572 573 574
      gst_structure_new ("GstEventNewsegment",
          "update", G_TYPE_BOOLEAN, update,
          "rate", G_TYPE_DOUBLE, rate,
575
          "applied_rate", G_TYPE_DOUBLE, applied_rate,
Wim Taymans's avatar
Wim Taymans committed
576
          "format", GST_TYPE_FORMAT, format,
577 578 579
          "start", G_TYPE_INT64, start,
          "stop", G_TYPE_INT64, stop,
          "position", G_TYPE_INT64, position, NULL));
Wim Taymans's avatar
Wim Taymans committed
580
}
581

Wim Taymans's avatar
Wim Taymans committed
582
/**
583
 * gst_event_parse_new_segment_full:
Wim Taymans's avatar
Wim Taymans committed
584
 * @event: The event to query
585
 * @update: A pointer to the update flag of the segment
Wim Taymans's avatar
Wim Taymans committed
586
 * @rate: A pointer to the rate of the segment
587
 * @applied_rate: A pointer to the applied_rate of the segment
Wim Taymans's avatar
Wim Taymans committed
588
 * @format: A pointer to the format of the newsegment values
589 590 591
 * @start: A pointer to store the start value in
 * @stop: A pointer to store the stop value in
 * @position: A pointer to store the stream time in
Wim Taymans's avatar
Wim Taymans committed
592
 *
593 594 595 596 597
 * 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
598 599
 */
void
600 601 602
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
603 604
{
  const GstStructure *structure;
605

Wim Taymans's avatar
Wim Taymans committed
606 607 608 609
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT);

  structure = gst_event_get_structure (event);
610
  if (G_LIKELY (update))
611 612
    *update =
        g_value_get_boolean (gst_structure_get_value (structure, "update"));
613
  if (G_LIKELY (rate))
Wim Taymans's avatar
Wim Taymans committed
614
    *rate = g_value_get_double (gst_structure_get_value (structure, "rate"));
615 616 617 618 619
  if (G_LIKELY (applied_rate))
    *applied_rate =
        g_value_get_double (gst_structure_get_value (structure,
            "applied_rate"));
  if (G_LIKELY (format))
Wim Taymans's avatar
Wim Taymans committed
620
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
621
  if (G_LIKELY (start))
622
    *start = g_value_get_int64 (gst_structure_get_value (structure, "start"));
623
  if (G_LIKELY (stop))
624
    *stop = g_value_get_int64 (gst_structure_get_value (structure, "stop"));
625
  if (G_LIKELY (position))
626 627
    *position =
        g_value_get_int64 (gst_structure_get_value (structure, "position"));
Wim Taymans's avatar
Wim Taymans committed
628
}
629

630 631
/**
 * gst_event_new_tag:
632
 * @taglist: metadata list. The event will take ownership of @taglist.
633 634
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
635
 *
636 637
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
638 639 640 641
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
642

Wim Taymans's avatar
Wim Taymans committed
643
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
644 645
}

646 647 648 649 650 651 652
/**
 * gst_event_parse_tag:
 * @event: a tag event
 * @taglist: pointer to metadata list
 *
 * Parses a tag @event and stores the results in the given @taglist location.
 */
Wim Taymans's avatar
Wim Taymans committed
653 654 655 656 657
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);
658

Wim Taymans's avatar
Wim Taymans committed
659 660 661 662
  if (taglist)
    *taglist = (GstTagList *) event->structure;
}

663 664
/* buffersize event */
/**
665
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
666 667 668 669
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
670 671 672 673
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
674
 * When the @async flag is set, a thread boundary is prefered.
675 676 677 678
 *
 * Returns: a new #GstEvent
 */
GstEvent *
679
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
680 681 682
    gint64 maxsize, gboolean async)
{
  GST_CAT_INFO (GST_CAT_EVENT,
683 684
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
685
      minsize, maxsize, async);
686

687 688 689 690 691 692 693 694
  return gst_event_new_custom (GST_EVENT_BUFFERSIZE,
      gst_structure_new ("GstEventBufferSize",
          "format", GST_TYPE_FORMAT, format,
          "minsize", G_TYPE_INT64, minsize,
          "maxsize", G_TYPE_INT64, maxsize,
          "async", G_TYPE_BOOLEAN, async, NULL));
}

Stefan Kost's avatar
Stefan Kost committed
695
/**
696
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
697 698 699 700 701 702 703 704
 * @event: The event to query
 * @format: A pointer to store the format in
 * @minsize: A pointer to store the minsize in
 * @maxsize: A pointer to store the maxsize in
 * @async: A pointer to store the async-flag in
 *
 * Get the format, minsize, maxsize and async-flag in the buffersize event.
 */
705
void
706
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
707 708 709 710 711 712
    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);
713

714 715 716 717 718 719 720 721 722 723 724 725 726
  structure = gst_event_get_structure (event);
  if (format)
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
  if (minsize)
    *minsize =
        g_value_get_int64 (gst_structure_get_value (structure, "minsize"));
  if (maxsize)
    *maxsize =
        g_value_get_int64 (gst_structure_get_value (structure, "maxsize"));
  if (async)
    *async = g_value_get_boolean (gst_structure_get_value (structure, "async"));
}

727
/**
Wim Taymans's avatar
Wim Taymans committed
728 729 730 731 732 733 734 735
 * 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
 *
 * 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
736
 * high/low CPU load or other resource usage such as network performance.
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
 * Typically sinks generate these events for each buffer they receive.
 *
 * @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
 * indicates how late the buffer with @timestamp was.
753
 *
754
 * @timestamp is the timestamp of the last buffer that cause the element
755 756
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
757 758
 *
 * The upstream element can use the @diff and @timestamp values to decide
759 760
 * whether to process more buffers. For possitive @diff, all buffers with
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
761 762
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
763 764 765
 *
 * 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
766 767
 *
 * Returns: A new QOS event.
768
 */
769
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
770 771
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
772
{
773 774 775
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

776
  GST_CAT_INFO (GST_CAT_EVENT,
777
      "creating qos proportion %lf, diff %" G_GINT64_FORMAT
778
      ", timestamp %" GST_TIME_FORMAT, proportion,
779
      diff, GST_TIME_ARGS (timestamp));
780

Wim Taymans's avatar
Wim Taymans committed
781 782 783 784 785 786
  return gst_event_new_custom (GST_EVENT_QOS,
      gst_structure_new ("GstEventQOS",
          "proportion", G_TYPE_DOUBLE, proportion,
          "diff", G_TYPE_INT64, diff,
          "timestamp", G_TYPE_UINT64, timestamp, NULL));
}
787

Wim Taymans's avatar
Wim Taymans committed
788 789 790 791 792 793 794
/**
 * gst_event_parse_qos:
 * @event: The event to query
 * @proportion: A pointer to store the proportion in
 * @diff: A pointer to store the diff in
 * @timestamp: A pointer to store the timestamp in
 *
795 796
 * 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
797 798 799 800 801 802
 */
void
gst_event_parse_qos (GstEvent * event, gdouble * proportion,
    GstClockTimeDiff * diff, GstClockTime * timestamp)
{
  const GstStructure *structure;
803

Wim Taymans's avatar
Wim Taymans committed
804 805
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
806

Wim Taymans's avatar
Wim Taymans committed
807 808 809 810 811 812 813 814 815
  structure = gst_event_get_structure (event);
  if (proportion)
    *proportion =
        g_value_get_double (gst_structure_get_value (structure, "proportion"));
  if (diff)
    *diff = g_value_get_int64 (gst_structure_get_value (structure, "diff"));
  if (timestamp)
    *timestamp =
        g_value_get_uint64 (gst_structure_get_value (structure, "timestamp"));
816
}
817 818

/**
Wim Taymans's avatar
Wim Taymans committed
819 820 821
 * 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
822
 * @flags: The optional seek flags
823 824
 * @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
825 826 827 828 829
 * @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.
 *
830 831 832
 * 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.
833
 *
Wim Taymans's avatar
Wim Taymans committed
834 835
 * 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
836 837 838
 * rate is not allowed and should be accomplished instead by PAUSING the
 * pipeline.
 *
839 840 841
 * 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. 
842
 *
843 844 845 846
 * @start_type and @stop_type specify how to adjust the currently configured 
 * start and stop fields in @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.
847
 *
848
 * When the rate is positive and @start has been updated, playback will start
849 850 851 852 853
 * 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.
854 855 856 857 858
 *
 * 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
 * #GST_SEEK_TYPE_SET to the desired position.
859
 *
Wim Taymans's avatar
Wim Taymans committed
860
 * Returns: A new seek event.
861 862
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
863
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
864
    GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
865
{
866 867
  g_return_val_if_fail (rate != 0.0, NULL);

868 869 870
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating seek rate %lf, format TIME, flags %d, "
871
        "start_type %d, start %" GST_TIME_FORMAT ", "
872
        "stop_type %d, stop %" GST_TIME_FORMAT,
873
        rate, flags, start_type, GST_TIME_ARGS (start),
874 875 876
        stop_type, GST_TIME_ARGS (stop));
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
877
        "creating seek rate %lf, format %s, flags %d, "
878
        "start_type %d, start %" G_GINT64_FORMAT ", "
879
        "stop_type %d, stop %" G_GINT64_FORMAT,
880 881
        rate, gst_format_get_name (format), flags, start_type, start, stop_type,
        stop);
882 883
  }

Wim Taymans's avatar
Wim Taymans committed
884 885 886 887
  return gst_event_new_custom (GST_EVENT_SEEK,
      gst_structure_new ("GstEventSeek", "rate", G_TYPE_DOUBLE, rate,
          "format", GST_TYPE_FORMAT, format,
          "flags", GST_TYPE_SEEK_FLAGS, flags,
888 889
          "cur_type", GST_TYPE_SEEK_TYPE, start_type,
          "cur", G_TYPE_INT64, start,
Wim Taymans's avatar
Wim Taymans committed
890 891 892
          "stop_type", GST_TYPE_SEEK_TYPE, stop_type,
          "stop", G_TYPE_INT64, stop, NULL));
}
893

894 895 896 897 898 899
/**
 * gst_event_parse_seek:
 * @event: a seek event
 * @rate: result location for the rate
 * @format: result location for the stream format
 * @flags:  result location for the #GstSeekFlags
900 901
 * @start_type: result location for the #GstSeekType of the start position
 * @start: result location for the start postion expressed in @format
902 903 904 905 906
 * @stop_type:  result location for the #GstSeekType of the stop position
 * @stop: result location for the stop postion expressed in @format
 *
 * Parses a seek @event and stores the results in the given result locations.
 */
Wim Taymans's avatar
Wim Taymans committed
907
void
908
gst_event_parse_seek (GstEvent * event, gdouble * rate,
909 910
    GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
    gint64 * start, GstSeekType * stop_type, gint64 * stop)
Wim Taymans's avatar
Wim Taymans committed
911 912
{
  const GstStructure *structure;
913

Wim Taymans's avatar
Wim Taymans committed
914 915
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
916

Wim Taymans's avatar
Wim Taymans committed
917 918 919 920 921 922 923
  structure = gst_event_get_structure (event);
  if (rate)
    *rate = g_value_get_double (gst_structure_get_value (structure, "rate"));
  if (format)
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
  if (flags)
    *flags = g_value_get_flags (gst_structure_get_value (structure, "flags"));
924 925
  if (start_type)
    *start_type =
Wim Taymans's avatar
Wim Taymans committed
926
        g_value_get_enum (gst_structure_get_value (structure, "cur_type"));
927 928
  if (start)
    *start = g_value_get_int64 (gst_structure_get_value (structure, "cur"));
Wim Taymans's avatar
Wim Taymans committed
929 930 931 932 933 934 935
  if (stop_type)
    *stop_type =
        g_value_get_enum (gst_structure_get_value (structure, "stop_type"));
  if (stop)
    *stop = g_value_get_int64 (gst_structure_get_value (structure, "stop"));
}

936 937
/**
 * gst_event_new_navigation:
938 939
 * @structure: description of the event. The event will take ownership of the
 *     structure.
940 941 942 943 944
 *
 * Create a new navigation event from the given description.
 *
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
945 946 947 948
GstEvent *
gst_event_new_navigation (GstStructure * structure)
{
  g_return_val_if_fail (structure != NULL, NULL);
949

Wim Taymans's avatar
Wim Taymans committed
950
  return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
951
}
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000

/**
 * gst_event_new_latency:
 * @latency: the new latency value
 *
 * Create a new latency event. The event is sent upstream from the sinks and
 * notifies elements that they should add an additional @latency to the
 * timestamps before synchronising against the clock.
 *
 * The latency is mostly used in live sinks and is always expressed in
 * the time format.
 *
 * Returns: a new #GstEvent
 *
 * Since: 0.10.12
 */
GstEvent *
gst_event_new_latency (GstClockTime latency)
{
  GST_CAT_INFO (GST_CAT_EVENT,
      "creating latency event %" GST_TIME_FORMAT, GST_TIME_ARGS (latency));

  return gst_event_new_custom (GST_EVENT_LATENCY,
      gst_structure_new ("GstEventLatency",
          "latency", G_TYPE_UINT64, latency, NULL));
}

/**
 * gst_event_parse_latency:
 * @event: The event to query
 * @latency: A pointer to store the latency in.
 *
 * Get the latency in the latency event.
 *
 * Since: 0.10.12
 */
void
gst_event_parse_latency (GstEvent * event, GstClockTime * latency)
{
  const GstStructure *structure;

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

  structure = gst_event_get_structure (event);
  if (latency)
    *latency =
        g_value_get_uint64 (gst_structure_get_value (structure, "latency"));
}