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 27.7 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 40
 * 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 
 * gst_event_parse_*() functions.
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-01-24 (0.10.2)
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 94

void
_gst_event_initialize (void)
{
95
  gst_event_get_type ();
96 97
  gst_seek_flags_get_type ();
  gst_seek_type_get_type ();
98 99
}

100 101 102 103 104 105 106 107 108 109 110 111 112 113
typedef struct
{
  gint type;
  gchar *name;
  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},
114
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
115 116 117
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
118 119 120
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
121 122 123
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

124 125 126
  {0, NULL, 0}
};

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

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

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

  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
207 208 209 210

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

213
  return _gst_event_type;
214 215
}

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

221 222 223 224 225
  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
226

227 228 229 230
static void
gst_event_init (GTypeInstance * instance, gpointer g_class)
{
  GstEvent *event;
231

232
  event = GST_EVENT (instance);
Wim Taymans's avatar
Wim Taymans committed
233

234
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
235 236
}

237
static void
238
gst_event_finalize (GstEvent * event)
239
{
240 241 242
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

243
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
244
      GST_EVENT_TYPE_NAME (event));
Wim Taymans's avatar
Wim Taymans committed
245

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

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

Wim Taymans's avatar
Wim Taymans committed
261
  copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
262

Wim Taymans's avatar
Wim Taymans committed
263 264
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
265

Wim Taymans's avatar
Wim Taymans committed
266 267 268 269 270 271 272
  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,
        &event->mini_object.refcount);
273 274
  }
  return copy;
275 276
}

Wim Taymans's avatar
Wim Taymans committed
277 278
static GstEvent *
gst_event_new (GstEventType type)
279
{
Wim Taymans's avatar
Wim Taymans committed
280
  GstEvent *event;
281

Wim Taymans's avatar
Wim Taymans committed
282
  event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
283

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
284 285
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s %d", event,
      gst_event_type_get_name (type), type);
286

Wim Taymans's avatar
Wim Taymans committed
287 288 289
  event->type = type;
  event->src = NULL;
  event->structure = NULL;
290

Wim Taymans's avatar
Wim Taymans committed
291
  return event;
292 293
}

294
/**
Wim Taymans's avatar
Wim Taymans committed
295
 * gst_event_new_custom:
296
 * @type: The type of the new event
Wim Taymans's avatar
Wim Taymans committed
297 298
 * @structure: The structure for the event. The event will take ownership of
 * the structure.
299
 *
Wim Taymans's avatar
Wim Taymans committed
300 301 302
 * 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.
303
 *
Wim Taymans's avatar
Wim Taymans committed
304 305 306 307 308 309 310 311
 * 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.
312
 */
313
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
314
gst_event_new_custom (GstEventType type, GstStructure * structure)
315 316 317
{
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
318 319 320 321 322
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
323
  return event;
324 325
}

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

Wim Taymans's avatar
Wim Taymans committed
343
  return event->structure;
344
}
345

Wim Taymans's avatar
Wim Taymans committed
346
/**
Wim Taymans's avatar
Wim Taymans committed
347 348 349 350 351 352 353
 * gst_event_new_flush_start:
 *
 * Allocate a new flush start event. The flush start event can be send
 * upstream and downstream and travels out-of-bounds with the dataflow.
 * It marks pads as being in a WRONG_STATE to process more data.
 *
 * Elements unlock and blocking functions and exit their streaming functions
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
354
 * as fast as possible.
Wim Taymans's avatar
Wim Taymans committed
355
 *
Wim Taymans's avatar
Wim Taymans committed
356 357
 * This event is typically generated after a seek to minimize the latency
 * after the seek.
Wim Taymans's avatar
Wim Taymans committed
358
 *
Wim Taymans's avatar
Wim Taymans committed
359
 * Returns: A new flush start event.
Wim Taymans's avatar
Wim Taymans committed
360
 */
361
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
362
gst_event_new_flush_start (void)
363
{
Wim Taymans's avatar
Wim Taymans committed
364
  return gst_event_new (GST_EVENT_FLUSH_START);
365 366
}

367
/**
Wim Taymans's avatar
Wim Taymans committed
368 369 370 371 372 373
 * gst_event_new_flush_stop:
 *
 * Allocate a new flush stop event. The flush start event can be send
 * upstream and downstream and travels out-of-bounds with the dataflow.
 * It is typically send after sending a FLUSH_START event to make the
 * pads accept data again.
374
 *
Wim Taymans's avatar
Wim Taymans committed
375 376
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
377
 *
Wim Taymans's avatar
Wim Taymans committed
378 379 380 381
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
 * Returns: A new flush stop event.
382
 */
383
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
384
gst_event_new_flush_stop (void)
385
{
Wim Taymans's avatar
Wim Taymans committed
386
  return gst_event_new (GST_EVENT_FLUSH_STOP);
387 388
}

Wim Taymans's avatar
Wim Taymans committed
389
/**
Wim Taymans's avatar
Wim Taymans committed
390
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
391
 *
Wim Taymans's avatar
Wim Taymans committed
392 393 394 395
 * Create a new EOS event. The eos event can only travel downstream
 * synchronized with the buffer flow. Elements that receive the EOS
 * event on a pad can return UNEXPECTED as a GstFlowReturn when data
 * after the EOS event arrives.
Wim Taymans's avatar
Wim Taymans committed
396
 *
Jan Schmidt's avatar
Jan Schmidt committed
397 398 399
 * The EOS event will travel down to the sink elements in the pipeline
 * which will then post the GST_MESSAGE_EOS on the bus after they have
 * finished playing any buffered data.
Wim Taymans's avatar
Wim Taymans committed
400 401 402 403 404
 *
 * When all sinks have posted an EOS message, the EOS message is
 * forwarded to the application.
 *
 * Returns: The new EOS event.
Wim Taymans's avatar
Wim Taymans committed
405
 */
Wim Taymans's avatar
Wim Taymans committed
406 407
GstEvent *
gst_event_new_eos (void)
408
{
Wim Taymans's avatar
Wim Taymans committed
409
  return gst_event_new (GST_EVENT_EOS);
410 411
}

412
/**
413
 * gst_event_new_new_segment:
414
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
415 416
 * @rate: a new rate for playback
 * @format: The format of the segment values
417 418 419
 * @start: the start value of the segment
 * @stop: the stop value of the segment
 * @position: stream position
Wim Taymans's avatar
Wim Taymans committed
420
 *
421 422 423 424
 * 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
425 426
 *
 * Returns: A new newsegment event.
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
 */
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
472 473
 *
 * The newsegment event marks the range of buffers to be processed. All
474
 * data not within the segment range is not to be processed. This can be
475
 * used intelligently by plugins to apply more efficient methods of skipping
476
 * unneeded packets.
477
 *
478 479 480 481 482
 * 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.
483
 *
484
 * @start cannot be -1, @stop can be -1. If there
485 486 487 488 489 490 491 492 493 494
 * is a valid @stop given, it must be greater or equal the @start, including 
 * when the indicated playback @rate is < 0
 *
 * 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
495
 *
Wim Taymans's avatar
Wim Taymans committed
496 497
 * After a newsegment event, the buffer stream time is calculated with:
 *
498
 *   position + (TIMESTAMP(buf) - start) * ABS (rate * applied_rate)
Wim Taymans's avatar
Wim Taymans committed
499 500
 *
 * Returns: A new newsegment event.
501 502
 *
 * Since: 0.10.6
503
 */
504
GstEvent *
505 506 507
gst_event_new_new_segment_full (gboolean update, gdouble rate,
    gdouble applied_rate, GstFormat format, gint64 start, gint64 stop,
    gint64 position)
508
{
509
  g_return_val_if_fail (rate != 0.0, NULL);
510
  g_return_val_if_fail (applied_rate != 0.0, NULL);
511

512 513
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
514
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
515
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
516 517 518
        ", position %" GST_TIME_FORMAT,
        update, rate, GST_TIME_ARGS (start),
        GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
519 520
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
521
        "creating newsegment update %d, rate %lf, format %d, "
522 523
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", position %"
        G_GINT64_FORMAT, update, rate, format, start, stop, position);
524
  }
525

526 527 528 529
  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);
530

Wim Taymans's avatar
Wim Taymans committed
531
  return gst_event_new_custom (GST_EVENT_NEWSEGMENT,
532 533 534
      gst_structure_new ("GstEventNewsegment",
          "update", G_TYPE_BOOLEAN, update,
          "rate", G_TYPE_DOUBLE, rate,
535
          "applied_rate", G_TYPE_DOUBLE, applied_rate,
Wim Taymans's avatar
Wim Taymans committed
536
          "format", GST_TYPE_FORMAT, format,
537 538 539
          "start", G_TYPE_INT64, start,
          "stop", G_TYPE_INT64, stop,
          "position", G_TYPE_INT64, position, NULL));
Wim Taymans's avatar
Wim Taymans committed
540
}
541

Wim Taymans's avatar
Wim Taymans committed
542
/**
543
 * gst_event_parse_new_segment_full:
Wim Taymans's avatar
Wim Taymans committed
544
 * @event: The event to query
545
 * @update: A pointer to the update flag of the segment
Wim Taymans's avatar
Wim Taymans committed
546
 * @rate: A pointer to the rate of the segment
547
 * @applied_rate: A pointer to the applied_rate of the segment
Wim Taymans's avatar
Wim Taymans committed
548
 * @format: A pointer to the format of the newsegment values
549 550 551
 * @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
552
 *
553 554 555 556 557
 * 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
558 559
 */
void
560 561 562
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
563 564
{
  const GstStructure *structure;
565

Wim Taymans's avatar
Wim Taymans committed
566 567 568 569
  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);
570
  if (G_LIKELY (update))
571 572
    *update =
        g_value_get_boolean (gst_structure_get_value (structure, "update"));
573
  if (G_LIKELY (rate))
Wim Taymans's avatar
Wim Taymans committed
574
    *rate = g_value_get_double (gst_structure_get_value (structure, "rate"));
575 576 577 578 579
  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
580
    *format = g_value_get_enum (gst_structure_get_value (structure, "format"));
581
  if (G_LIKELY (start))
582
    *start = g_value_get_int64 (gst_structure_get_value (structure, "start"));
583
  if (G_LIKELY (stop))
584
    *stop = g_value_get_int64 (gst_structure_get_value (structure, "stop"));
585
  if (G_LIKELY (position))
586 587
    *position =
        g_value_get_int64 (gst_structure_get_value (structure, "position"));
Wim Taymans's avatar
Wim Taymans committed
588
}
589

590 591 592 593 594
/**
 * gst_event_new_tag:
 * @taglist: metadata list
 *
 * Generates a metadata tag event from the given @taglist.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
595
 *
596 597
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
598 599 600 601 602
GstEvent *
gst_event_new_tag (GstTagList * taglist)
{
  g_return_val_if_fail (taglist != NULL, NULL);
  return gst_event_new_custom (GST_EVENT_TAG, (GstStructure *) taglist);
603 604
}

605 606 607 608 609 610 611
/**
 * 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
612 613 614 615 616 617 618 619 620
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);
  if (taglist)
    *taglist = (GstTagList *) event->structure;
}

621 622
/* buffersize event */
/**
623
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
624 625 626 627
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
628 629 630 631 632 633 634 635 636
 *
 * Create a new buffersize event. The event is sent downstream and notifies
 * elements that they should provide a buffer of the specified dimensions.
 *
 * When the async flag is set, a thread boundary is prefered.
 *
 * Returns: a new #GstEvent
 */
GstEvent *
637
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
638 639 640 641 642 643 644 645 646 647 648 649 650 651
    gint64 maxsize, gboolean async)
{
  GST_CAT_INFO (GST_CAT_EVENT,
      "creating buffersize format %d, minsize %" G_GINT64_FORMAT
      ", maxsize %" G_GINT64_FORMAT ", async %d", format,
      minsize, maxsize, async);
  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
652
/**
653
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
654 655 656 657 658 659 660 661
 * @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.
 */
662
void
663
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    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);
  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"));
}

683
/**
Wim Taymans's avatar
Wim Taymans committed
684 685 686 687 688 689 690 691
 * 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
692
 * high/low CPU load or other resource usage such as network performance.
Wim Taymans's avatar
Wim Taymans committed
693
 *
694
 * @proportion is the requested adjustment in datarate, 1.0 is the normal
Wim Taymans's avatar
Wim Taymans committed
695 696
 * datarate, 0.75 means increase datarate by 75%, 1.5 is 150%. Negative
 * values request a slow down, so -0.75 means a decrease by 75%.
697
 *
698
 * @diff is the difference against the clock in stream time of the last
Wim Taymans's avatar
Wim Taymans committed
699
 * buffer that caused the element to generate the QOS event.
700
 *
701 702 703 704 705 706 707 708 709 710 711 712 713
 * @timestamp is the timestamp of the last buffer that cause the element
 * to generate the QOS event. 
 *
 * The upstream element can use the @diff and @timestamp values to decide
 * whether to process more buffers. All buffers with timestamp <=
 * @timestamp + @diff will certainly arrive late in the sink as well. 
 *
 * The @proportion value is generally computed based on more long
 * term statistics about the stream quality and can be used in various ways
 * such as lowering or increasing processing quality.
 *
 * 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
714 715
 *
 * Returns: A new QOS event.
716
 */
717
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
718 719
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
720
{
721
  GST_CAT_INFO (GST_CAT_EVENT,
722
      "creating qos proportion %lf, diff %" G_GINT64_FORMAT
723
      ", timestamp %" GST_TIME_FORMAT, proportion,
724
      diff, GST_TIME_ARGS (timestamp));
725

Wim Taymans's avatar
Wim Taymans committed
726 727 728 729 730 731
  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));
}
732

Wim Taymans's avatar
Wim Taymans committed
733 734 735 736 737 738 739 740 741 742 743 744 745 746
/**
 * 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
 *
 * Get the proportion, diff and timestamp in the qos event.
 */
void
gst_event_parse_qos (GstEvent * event, gdouble * proportion,
    GstClockTimeDiff * diff, GstClockTime * timestamp)
{
  const GstStructure *structure;
747

Wim Taymans's avatar
Wim Taymans committed
748 749 750 751 752 753 754 755 756 757 758
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_QOS);
  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"));
759
}
760 761

/**
Wim Taymans's avatar
Wim Taymans committed
762 763 764
 * 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
765
 * @flags: The optional seek flags
Wim Taymans's avatar
Wim Taymans committed
766 767 768 769 770 771 772
 * @cur_type: The type and flags for the new current position
 * @cur: The value of the new current position
 * @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.
 *
773
 * The seek event configures playback of the pipeline from
Wim Taymans's avatar
Wim Taymans committed
774
 * @cur to @stop at the speed given in @rate, also called a segment.
Wim Taymans's avatar
Wim Taymans committed
775
 * The @cur and @stop values are expressed in format @format.
776
 *
Wim Taymans's avatar
Wim Taymans committed
777 778 779
 * 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
 * rate is not allowed.
780
 *
Wim Taymans's avatar
Wim Taymans committed
781
 * @cur_type and @stop_type specify how to adjust the current and stop
Wim Taymans's avatar
Wim Taymans committed
782 783 784
 * time, relative or absolute. A type of #GST_SEEK_TYPE_NONE means that
 * the position should not be updated. The currently configured playback
 * segment can be queried with #GST_QUERY_SEGMENT.
Wim Taymans's avatar
Wim Taymans committed
785
 *
786 787 788 789 790 791
 * Note that updating the @cur position will actually move the current
 * playback pointer to that new position. It is not possible to seek 
 * relative to the current playing position, to do this, pause the pipeline,
 * get the current position and perform a GST_SEEK_TYPE_SET to the desired
 * position.
 *
Wim Taymans's avatar
Wim Taymans committed
792
 * Returns: A new seek event.
793 794
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
795 796
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
    GstSeekType cur_type, gint64 cur, GstSeekType stop_type, gint64 stop)
797
{
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating seek rate %lf, format TIME, flags %d, "
        "cur_type %d, cur %" GST_TIME_FORMAT ", "
        "stop_type %d, stop %" GST_TIME_FORMAT,
        rate, flags, cur_type, GST_TIME_ARGS (cur),
        stop_type, GST_TIME_ARGS (stop));
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating seek rate %lf, format %d, flags %d, "
        "cur_type %d, cur %" G_GINT64_FORMAT ", "
        "stop_type %d, stop %" G_GINT64_FORMAT,
        rate, format, flags, cur_type, cur, stop_type, stop);
  }

Wim Taymans's avatar
Wim Taymans committed
813 814 815 816 817 818 819 820 821
  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,
          "cur_type", GST_TYPE_SEEK_TYPE, cur_type,
          "cur", G_TYPE_INT64, cur,
          "stop_type", GST_TYPE_SEEK_TYPE, stop_type,
          "stop", G_TYPE_INT64, stop, NULL));
}
822

823 824 825 826 827 828 829 830 831 832 833 834 835
/**
 * 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
 * @cur_type: result location for the #GstSeekType of the current position
 * @cur: result location for the current postion expressed in @format
 * @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
836
void
837 838 839
gst_event_parse_seek (GstEvent * event, gdouble * rate,
    GstFormat * format, GstSeekFlags * flags, GstSeekType * cur_type,
    gint64 * cur, GstSeekType * stop_type, gint64 * stop)
Wim Taymans's avatar
Wim Taymans committed
840 841
{
  const GstStructure *structure;
842

Wim Taymans's avatar
Wim Taymans committed
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
  g_return_if_fail (GST_IS_EVENT (event));
  g_return_if_fail (GST_EVENT_TYPE (event) == GST_EVENT_SEEK);
  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"));
  if (cur_type)
    *cur_type =
        g_value_get_enum (gst_structure_get_value (structure, "cur_type"));
  if (cur)
    *cur = g_value_get_int64 (gst_structure_get_value (structure, "cur"));
  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"));
}

864 865 866 867 868 869 870 871
/**
 * gst_event_new_navigation:
 * @structure: description of the event
 *
 * Create a new navigation event from the given description.
 *
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
872 873 874 875 876
GstEvent *
gst_event_new_navigation (GstStructure * structure)
{
  g_return_val_if_fail (structure != NULL, NULL);
  return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
877
}