We are currently experiencing downtime impacting viewing & cloning the Mesa repo, and some GitLab pages returning 503. Please see #freedesktop on IRC for more updates.

gstevent.c 33.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
 *
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"
86
#include "gstquark.h"
Benjamin Otte's avatar
Benjamin Otte committed
87

88 89 90 91
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);
92

93 94
static GstMiniObjectClass *parent_class = NULL;

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

103 104
typedef struct
{
105 106
  const gint type;
  const gchar *name;
107 108 109 110 111 112 113 114 115 116
  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},
117
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
118 119 120
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
121
  {GST_EVENT_LATENCY, "latency", 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
GType
gst_event_get_type (void)
{
192
  static GType _gst_event_type = 0;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
193
  int i;
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

  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
211 212 213 214

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

217
  return _gst_event_type;
218 219
}

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

225 226
  parent_class = g_type_class_peek_parent (g_class);

227 228 229 230 231
  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
232

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

452
/**
453
 * gst_event_new_new_segment:
454
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
455 456
 * @rate: a new rate for playback
 * @format: The format of the segment values
457 458 459
 * @start: the start value of the segment
 * @stop: the stop value of the segment
 * @position: stream position
Wim Taymans's avatar
Wim Taymans committed
460
 *
461 462 463 464
 * 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
465 466
 *
 * Returns: A new newsegment event.
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 511
 */
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
512 513
 *
 * The newsegment event marks the range of buffers to be processed. All
514
 * data not within the segment range is not to be processed. This can be
515
 * used intelligently by plugins to apply more efficient methods of skipping
516
 * unneeded data.
517
 *
518 519 520 521 522
 * 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.
523
 *
524
 * @start cannot be -1, @stop can be -1. If there
525
 * is a valid @stop given, it must be greater or equal the @start, including 
526
 * when the indicated playback @rate is < 0.
527 528 529 530 531 532 533 534
 *
 * 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
535
 *
Wim Taymans's avatar
Wim Taymans committed
536 537
 * After a newsegment event, the buffer stream time is calculated with:
 *
538
 *   position + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
539 540
 *
 * Returns: A new newsegment event.
541 542
 *
 * Since: 0.10.6
543
 */
544
GstEvent *
545 546 547
gst_event_new_new_segment_full (gboolean update, gdouble rate,
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
    gint64 position)
548
{
549 550 551
  GstEvent *event;
  GstStructure *structure;

552
  g_return_val_if_fail (rate != 0.0, NULL);
553
  g_return_val_if_fail (applied_rate != 0.0, NULL);
554

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

570 571 572 573
  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);
574

575 576 577 578 579 580 581 582 583 584 585 586
  structure = gst_structure_empty_new ("GstEventNewsegment");
  gst_structure_id_set (structure,
      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
587
}
588

Wim Taymans's avatar
Wim Taymans committed
589
/**
590
 * gst_event_parse_new_segment_full:
Wim Taymans's avatar
Wim Taymans committed
591
 * @event: The event to query
592
 * @update: A pointer to the update flag of the segment
Wim Taymans's avatar
Wim Taymans committed
593
 * @rate: A pointer to the rate of the segment
594
 * @applied_rate: A pointer to the applied_rate of the segment
Wim Taymans's avatar
Wim Taymans committed
595
 * @format: A pointer to the format of the newsegment values
596 597 598
 * @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
599
 *
600 601 602 603 604
 * 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
605 606
 */
void
607 608 609
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
610 611
{
  const GstStructure *structure;
612

Wim Taymans's avatar
Wim Taymans committed
613 614 615 616
  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);
617
  if (G_LIKELY (update))
618
    *update =
619 620
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (UPDATE)));
621
  if (G_LIKELY (rate))
622 623 624
    *rate =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (RATE)));
625 626
  if (G_LIKELY (applied_rate))
    *applied_rate =
627 628
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (APPLIED_RATE)));
629
  if (G_LIKELY (format))
630 631 632
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
633
  if (G_LIKELY (start))
634 635 636
    *start =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (START)));
637
  if (G_LIKELY (stop))
638 639 640
    *stop =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (STOP)));
641
  if (G_LIKELY (position))
642
    *position =
643 644
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (POSITION)));
Wim Taymans's avatar
Wim Taymans committed
645
}
646

647 648
/**
 * gst_event_new_tag:
649
 * @taglist: metadata list. The event will take ownership of @taglist.
650 651
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
652
 *
653 654
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
655 656 657 658
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
659

Wim Taymans's avatar
Wim Taymans committed
660
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
661 662
}

663 664 665 666 667 668 669
/**
 * 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
670 671 672 673 674
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);
675

Wim Taymans's avatar
Wim Taymans committed
676 677 678 679
  if (taglist)
    *taglist = (GstTagList *) event->structure;
}

680 681
/* buffersize event */
/**
682
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
683 684 685 686
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
687 688 689 690
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
691
 * When the @async flag is set, a thread boundary is prefered.
692 693 694 695
 *
 * Returns: a new #GstEvent
 */
GstEvent *
696
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
697 698
    gint64 maxsize, gboolean async)
{
699 700 701
  GstEvent *event;
  GstStructure *structure;

702
  GST_CAT_INFO (GST_CAT_EVENT,
703 704
      "creating buffersize format %s, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", gst_format_get_name (format),
705
      minsize, maxsize, async);
706

707 708 709 710 711 712 713 714 715
  structure = gst_structure_empty_new ("GstEventBufferSize");
  gst_structure_id_set (structure,
      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;
716 717
}

Stefan Kost's avatar
Stefan Kost committed
718
/**
719
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
720 721 722 723 724 725 726 727
 * @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.
 */
728
void
729
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
730 731 732 733 734 735
    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);
736

737 738
  structure = gst_event_get_structure (event);
  if (format)
739 740 741
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
742 743
  if (minsize)
    *minsize =
744 745
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MINSIZE)));
746 747
  if (maxsize)
    *maxsize =
748 749
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (MAXSIZE)));
750
  if (async)
751 752 753
    *async =
        g_value_get_boolean (gst_structure_id_get_value (structure,
            GST_QUARK (ASYNC)));
754 755
}

756
/**
Wim Taymans's avatar
Wim Taymans committed
757 758 759 760 761 762 763 764
 * 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
765
 * high/low CPU load or other resource usage such as network performance.
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
 * 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.
782
 *
783
 * @timestamp is the timestamp of the last buffer that cause the element
784 785
 * to generate the QOS event. It is expressed in running time and thus an ever
 * increasing value.
786 787
 *
 * The upstream element can use the @diff and @timestamp values to decide
788 789
 * whether to process more buffers. For possitive @diff, all buffers with
 * timestamp <= @timestamp + @diff will certainly arrive late in the sink
790 791
 * as well. A (negative) @diff value so that @timestamp + @diff would yield a
 * result smaller than 0 is not allowed.
792 793 794
 *
 * 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
795 796
 *
 * Returns: A new QOS event.
797
 */
798
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
799 800
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
801
{
802 803 804
  GstEvent *event;
  GstStructure *structure;

805 806 807
  /* diff must be positive or timestamp + diff must be positive */
  g_return_val_if_fail (diff >= 0 || -diff <= timestamp, NULL);

808
  GST_CAT_INFO (GST_CAT_EVENT,
809
      "creating qos proportion %lf, diff %" G_GINT64_FORMAT
810
      ", timestamp %" GST_TIME_FORMAT, proportion,
811
      diff, GST_TIME_ARGS (timestamp));
812

813 814 815 816 817 818 819 820
  structure = gst_structure_empty_new ("GstEventQOS");
  gst_structure_id_set (structure,
      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
821
}
822

Wim Taymans's avatar
Wim Taymans committed
823 824 825 826 827 828 829
/**
 * 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
 *
830 831
 * 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
832 833 834 835 836 837
 */
void
gst_event_parse_qos (GstEvent * event, gdouble * proportion,
    GstClockTimeDiff * diff, GstClockTime * timestamp)
{
  const GstStructure *structure;
838

Wim Taymans's avatar
Wim Taymans committed
839 840
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
841

Wim Taymans's avatar
Wim Taymans committed
842 843 844
  structure = gst_event_get_structure (event);
  if (proportion)
    *proportion =
845 846
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (PROPORTION)));
Wim Taymans's avatar
Wim Taymans committed
847
  if (diff)
848 849 850
    *diff =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (DIFF)));
Wim Taymans's avatar
Wim Taymans committed
851 852
  if (timestamp)
    *timestamp =
853 854
        g_value_get_uint64 (gst_structure_id_get_value (structure,
            GST_QUARK (TIMESTAMP)));
855
}
856 857

/**
Wim Taymans's avatar
Wim Taymans committed
858 859 860
 * 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
861
 * @flags: The optional seek flags
862 863
 * @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
864 865 866 867 868
 * @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.
 *
869 870 871
 * 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.
872
 *
Wim Taymans's avatar
Wim Taymans committed
873 874
 * 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
875 876 877
 * rate is not allowed and should be accomplished instead by PAUSING the
 * pipeline.
 *
878 879 880
 * 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. 
881
 *
882
 * @start_type and @stop_type specify how to adjust the currently configured 
883 884 885
 * 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.
886
 *
887
 * When the rate is positive and @start has been updated, playback will start
888 889 890 891 892
 * 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.
893 894 895 896
 *
 * 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
897
 * #GST_SEEK_TYPE_SET to the desired position. 
898
 *
Wim Taymans's avatar
Wim Taymans committed
899
 * Returns: A new seek event.
900 901
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
902
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
903
    GstSeekType start_type, gint64 start, GstSeekType stop_type, gint64 stop)
904
{
905 906 907
  GstEvent *event;
  GstStructure *structure;

908 909
  g_return_val_if_fail (rate != 0.0, NULL);

910 911 912
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating seek rate %lf, format TIME, flags %d, "
913
        "start_type %d, start %" GST_TIME_FORMAT ", "
914
        "stop_type %d, stop %" GST_TIME_FORMAT,
915
        rate, flags, start_type, GST_TIME_ARGS (start),
916 917 918
        stop_type, GST_TIME_ARGS (stop));
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
919
        "creating seek rate %lf, format %s, flags %d, "
920
        "start_type %d, start %" G_GINT64_FORMAT ", "
921
        "stop_type %d, stop %" G_GINT64_FORMAT,
922 923
        rate, gst_format_get_name (format), flags, start_type, start, stop_type,
        stop);
924 925
  }

926 927 928 929 930 931 932 933 934 935 936 937
  structure = gst_structure_empty_new ("GstEventSeek");
  gst_structure_id_set (structure,
      GST_QUARK (RATE), G_TYPE_DOUBLE, rate,
      GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
      GST_QUARK (FLAGS), GST_TYPE_SEEK_FLAGS, flags,
      GST_QUARK (CUR_TYPE), GST_TYPE_SEEK_TYPE, start_type,
      GST_QUARK (CUR), G_TYPE_INT64, start,
      GST_QUARK (STOP_TYPE), GST_TYPE_SEEK_TYPE, stop_type,
      GST_QUARK (STOP), G_TYPE_INT64, stop, NULL);
  event = gst_event_new_custom (GST_EVENT_SEEK, structure);

  return event;
Wim Taymans's avatar
Wim Taymans committed
938
}
939

940 941 942 943 944 945
/**
 * 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
946 947
 * @start_type: result location for the #GstSeekType of the start position
 * @start: result location for the start postion expressed in @format
948 949 950 951 952
 * @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
953
void
954
gst_event_parse_seek (GstEvent * event, gdouble * rate,
955 956
    GstFormat * format, GstSeekFlags * flags, GstSeekType * start_type,
    gint64 * start, GstSeekType * stop_type, gint64 * stop)
Wim Taymans's avatar
Wim Taymans committed
957 958
{
  const GstStructure *structure;
959

Wim Taymans's avatar
Wim Taymans committed
960 961
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
962

Wim Taymans's avatar
Wim Taymans committed
963 964
  structure = gst_event_get_structure (event);
  if (rate)
965 966 967
    *rate =
        g_value_get_double (gst_structure_id_get_value (structure,
            GST_QUARK (RATE)));
Wim Taymans's avatar
Wim Taymans committed
968
  if (format)
969 970 971
    *format =
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (FORMAT)));
Wim Taymans's avatar
Wim Taymans committed
972
  if (flags)
973 974 975
    *flags =
        g_value_get_flags (gst_structure_id_get_value (structure,
            GST_QUARK (FLAGS)));
976 977
  if (start_type)
    *start_type =
978 979
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (CUR_TYPE)));
980
  if (start)
981 982 983
    *start =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (CUR)));
Wim Taymans's avatar
Wim Taymans committed
984 985
  if (stop_type)
    *stop_type =
986 987
        g_value_get_enum (gst_structure_id_get_value (structure,
            GST_QUARK (STOP_TYPE)));
Wim Taymans's avatar
Wim Taymans committed
988
  if (stop)
989 990 991
    *stop =
        g_value_get_int64 (gst_structure_id_get_value (structure,
            GST_QUARK (STOP)));