gstevent.c 21.2 KB
Newer Older
1 2 3 4
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wim.taymans@chello.be>
 *
5
 * gstevent.c: GstEvent subsystem
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * 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.
 */
22 23 24 25 26 27 28
/**
 * SECTION:gstevent
 * @short_description: Structure describing events that are passed up and down a pipeline
 * @see_also: #GstPad, #GstElement
 *
 * The event classes are used to construct and query events.
 *
Wim Taymans's avatar
Wim Taymans committed
29 30 31 32
 * Events are usually created with gst_event_new_*() which takes the extra event 
 * paramters as arguments. 
 * Events can be parsed with their respective gst_event_parse_*() functions.
 * The event should be unreferenced with gst_event_unref().
33 34
 *
 * gst_event_new_seek() is a usually used to create a seek event and it takes
35
 * the needed parameters for a seek event.
36 37 38
 *
 * gst_event_new_flush() creates a new flush event.
 */
39

40
#include <string.h>             /* memcpy */
41

42 43 44
#include "gst_private.h"

#include "gstinfo.h"
45
#include "gstevent.h"
Wim Taymans's avatar
Wim Taymans committed
46
#include "gstenumtypes.h"
47
#include "gstutils.h"
Benjamin Otte's avatar
Benjamin Otte committed
48

49 50 51 52
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);
53 54 55 56

void
_gst_event_initialize (void)
{
57 58 59
  gst_event_get_type ();
}

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
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},
  {GST_EVENT_FILLER, "filler", 0},
75
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
76 77 78
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
79 80 81 82 83 84
  {GST_EVENT_CUSTOM_UP, "custom-up", 0},
  {GST_EVENT_CUSTOM_DS, "custom-ds", 0},
  {GST_EVENT_CUSTOM_DS_OOB, "custom-ds-oob", 0},
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

85 86 87
  {0, NULL, 0}
};

Stefan Kost's avatar
Stefan Kost committed
88 89 90 91 92 93 94 95
/**
 * gst_event_type_get_name:
 * @type: the event type
 *
 * Get a printable name for the given event type. Do not modify or free.
 *
 * Returns: a reference to the static name of the event. 
 */
96 97 98 99 100 101 102 103 104 105 106 107
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
108 109 110 111 112 113 114 115
/**
 * 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
 */
116 117 118 119 120 121 122 123 124 125 126 127
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;
}

128 129 130 131
GType
gst_event_get_type (void)
{
  static GType _gst_event_type;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
132
  int i;
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149

  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
150 151 152 153

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

156
  return _gst_event_type;
157 158
}

159 160
static void
gst_event_class_init (gpointer g_class, gpointer class_data)
Wim Taymans's avatar
Wim Taymans committed
161
{
162
  GstEventClass *event_class = GST_EVENT_CLASS (g_class);
Wim Taymans's avatar
Wim Taymans committed
163

164 165 166 167 168
  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
169

170 171 172 173
static void
gst_event_init (GTypeInstance * instance, gpointer g_class)
{
  GstEvent *event;
174

175
  event = GST_EVENT (instance);
Wim Taymans's avatar
Wim Taymans committed
176

177
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
178 179
}

180
static void
181
gst_event_finalize (GstEvent * event)
182
{
183 184 185
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

186 187
  GST_CAT_INFO (GST_CAT_EVENT, "freeing event %p type %s", event,
      gst_event_type_get_name (GST_EVENT_TYPE (event)));
Wim Taymans's avatar
Wim Taymans committed
188

189 190
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
191
    GST_EVENT_SRC (event) = NULL;
192
  }
Wim Taymans's avatar
Wim Taymans committed
193 194 195
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
196
  }
197 198 199 200 201 202 203
}

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

Wim Taymans's avatar
Wim Taymans committed
204
  copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
205

Wim Taymans's avatar
Wim Taymans committed
206 207
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
208

Wim Taymans's avatar
Wim Taymans committed
209 210 211 212 213 214 215
  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);
216 217
  }
  return copy;
218 219
}

Wim Taymans's avatar
Wim Taymans committed
220 221
static GstEvent *
gst_event_new (GstEventType type)
222
{
Wim Taymans's avatar
Wim Taymans committed
223
  GstEvent *event;
224

Wim Taymans's avatar
Wim Taymans committed
225
  event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
226

227 228
  GST_CAT_INFO (GST_CAT_EVENT, "creating new event %p %s", event,
      gst_event_type_get_name (type));
229

Wim Taymans's avatar
Wim Taymans committed
230 231 232
  event->type = type;
  event->src = NULL;
  event->structure = NULL;
233

Wim Taymans's avatar
Wim Taymans committed
234
  return event;
235 236
}

237
/**
Wim Taymans's avatar
Wim Taymans committed
238
 * gst_event_new_custom:
239
 * @type: The type of the new event
Wim Taymans's avatar
Wim Taymans committed
240 241
 * @structure: The structure for the event. The event will take ownership of
 * the structure.
242
 *
Wim Taymans's avatar
Wim Taymans committed
243 244 245
 * 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.
246
 *
Wim Taymans's avatar
Wim Taymans committed
247 248 249 250 251 252 253 254
 * 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.
255
 */
256
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
257
gst_event_new_custom (GstEventType type, GstStructure * structure)
258 259 260
{
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
261 262 263 264 265
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
266
  return event;
267 268
}

269
/**
Wim Taymans's avatar
Wim Taymans committed
270 271
 * gst_event_get_structure:
 * @event: The #GstEvent.
272
 *
Wim Taymans's avatar
Wim Taymans committed
273
 * Access the structure of the event.
274
 *
Wim Taymans's avatar
Wim Taymans committed
275 276 277 278 279
 * 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.
280
 */
Wim Taymans's avatar
Wim Taymans committed
281 282
const GstStructure *
gst_event_get_structure (GstEvent * event)
283
{
Wim Taymans's avatar
Wim Taymans committed
284
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
285

Wim Taymans's avatar
Wim Taymans committed
286
  return event->structure;
287
}
288

Wim Taymans's avatar
Wim Taymans committed
289
/**
Wim Taymans's avatar
Wim Taymans committed
290 291 292 293 294 295 296 297
 * 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
 * as fast as possible. 
Wim Taymans's avatar
Wim Taymans committed
298
 *
Wim Taymans's avatar
Wim Taymans committed
299 300
 * This event is typically generated after a seek to minimize the latency
 * after the seek.
Wim Taymans's avatar
Wim Taymans committed
301
 *
Wim Taymans's avatar
Wim Taymans committed
302
 * Returns: A new flush start event.
Wim Taymans's avatar
Wim Taymans committed
303
 */
304
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
305
gst_event_new_flush_start (void)
306
{
Wim Taymans's avatar
Wim Taymans committed
307
  return gst_event_new (GST_EVENT_FLUSH_START);
308 309
}

310
/**
Wim Taymans's avatar
Wim Taymans committed
311 312 313 314 315 316
 * 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.
317
 *
Wim Taymans's avatar
Wim Taymans committed
318 319
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
320
 *
Wim Taymans's avatar
Wim Taymans committed
321 322 323 324
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
 * Returns: A new flush stop event.
325
 */
326
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
327
gst_event_new_flush_stop (void)
328
{
Wim Taymans's avatar
Wim Taymans committed
329
  return gst_event_new (GST_EVENT_FLUSH_STOP);
330 331
}

Wim Taymans's avatar
Wim Taymans committed
332
/**
Wim Taymans's avatar
Wim Taymans committed
333
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
334
 *
Wim Taymans's avatar
Wim Taymans committed
335 336 337 338
 * 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
339
 *
Wim Taymans's avatar
Wim Taymans committed
340 341 342 343 344 345 346
 * The EOS event will travel up to the sink elements in the pipeline
 * which will then post the GST_MESSAGE_EOS on the bus.
 *
 * 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
347
 */
Wim Taymans's avatar
Wim Taymans committed
348 349
GstEvent *
gst_event_new_eos (void)
350
{
Wim Taymans's avatar
Wim Taymans committed
351
  return gst_event_new (GST_EVENT_EOS);
352 353
}

354
/**
Wim Taymans's avatar
Wim Taymans committed
355 356 357
 * gst_event_new_newsegment:
 * @rate: a new rate for playback
 * @format: The format of the segment values
358 359
 * @start_value: the start value of the segment
 * @stop_value: the stop value of the segment
Wim Taymans's avatar
Wim Taymans committed
360 361 362 363 364
 * @base: base value for buffer timestamps.
 *
 * Allocate a new newsegment event with the given format/values tripplets.
 *
 * The newsegment event marks the range of buffers to be processed. All
365 366 367
 * data not within the segment range is not to be processed. This can be
 * used intelligently by plugins to use more efficient methods of skipping
 * unneeded packets.
368
 *
369
 * The base time of the segment is also used to convert the buffer timestamps
Wim Taymans's avatar
Wim Taymans committed
370
 * into the stream time again.
371
 *
372 373 374
 * The @start_value cannot be -1, the @stop_value can be -1. If there
 * is a valid @stop_value given, it must be smaller than @start_value.
 *
Wim Taymans's avatar
Wim Taymans committed
375 376 377 378 379
 * After a newsegment event, the buffer stream time is calculated with:
 *
 *   TIMESTAMP(buf) - start_time + base
 *
 * Returns: A new newsegment event.
380
 */
381
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
382
gst_event_new_newsegment (gdouble rate, GstFormat format,
383
    gint64 start_value, gint64 stop_value, gint64 base)
384
{
385 386 387 388 389
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating newsegment rate %lf, format GST_FORMAT_TIME, "
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
        ", base %" GST_TIME_FORMAT,
390 391
        rate, GST_TIME_ARGS (start_value),
        GST_TIME_ARGS (stop_value), GST_TIME_ARGS (base));
392 393 394 395
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating newsegment rate %lf, format %d, "
        "start %lld, stop %lld, base %lld",
396
        rate, format, start_value, stop_value, base);
397
  }
398 399
  if (start_value == -1)
    g_return_val_if_fail (start_value != -1, NULL);
400

401
  if (stop_value != -1)
402
    g_return_val_if_fail (start_value <= stop_value, NULL);
403

Wim Taymans's avatar
Wim Taymans committed
404 405 406
  return gst_event_new_custom (GST_EVENT_NEWSEGMENT,
      gst_structure_new ("GstEventNewsegment", "rate", G_TYPE_DOUBLE, rate,
          "format", GST_TYPE_FORMAT, format,
407 408
          "start_val", G_TYPE_INT64, start_value,
          "stop_val", G_TYPE_INT64, stop_value,
Wim Taymans's avatar
Wim Taymans committed
409 410
          "base", G_TYPE_INT64, base, NULL));
}
411

Wim Taymans's avatar
Wim Taymans committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
/**
 * gst_event_parse_newsegment:
 * @event: The event to query
 * @rate: A pointer to the rate of the segment
 * @format: A pointer to the format of the newsegment values
 * @start_value: A pointer to store the start value in
 * @stop_value: A pointer to store the stop value in
 * @base: A pointer to store the base time in
 *
 * Get the start, stop and format in the newsegment event.
 */
void
gst_event_parse_newsegment (GstEvent * event, gdouble * rate,
    GstFormat * format, gint64 * start_value, gint64 * stop_value,
    gint64 * base)
{
  const GstStructure *structure;
429

Wim Taymans's avatar
Wim Taymans committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
  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);
  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 (start_value)
    *start_value =
        g_value_get_int64 (gst_structure_get_value (structure, "start_val"));
  if (stop_value)
    *stop_value =
        g_value_get_int64 (gst_structure_get_value (structure, "stop_val"));
  if (base)
    *base = g_value_get_int64 (gst_structure_get_value (structure, "base"));
}
447

448 449 450 451 452 453 454 455
/**
 * gst_event_new_tag:
 * @taglist: metadata list
 *
 * Generates a metadata tag event from the given @taglist.
 * 
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
456 457 458 459 460 461
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);
462 463
}

464 465 466 467 468 469 470
/**
 * 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
471 472 473 474 475 476 477 478 479 480 481
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;
}

/* filler event */
482 483 484 485 486 487 488
/**
 * gst_event_new_filler:
 *
 * Create a new dummy event that should be ignored.
 *
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
489 490 491 492 493
GstEvent *
gst_event_new_filler (void)
{
  return gst_event_new (GST_EVENT_FILLER);
}
494

495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
/* buffersize event */
/**
 * gst_event_new_buffersize:
 *
 * 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 *
gst_event_new_buffersize (GstFormat format, gint64 minsize,
    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));
}

void
gst_event_parse_buffersize (GstEvent * event, GstFormat * format,
    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"));
}

545
/**
Wim Taymans's avatar
Wim Taymans committed
546 547 548 549 550 551 552 553 554 555 556 557 558
 * 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
 * high/low CPU load.
 *
 * proportion is the requested adjustment in datarate, 1.0 is the normal
 * 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%.
559
 *
Wim Taymans's avatar
Wim Taymans committed
560 561
 * diff is the difference against the clock in stream time of the last 
 * buffer that caused the element to generate the QOS event.
562
 *
Wim Taymans's avatar
Wim Taymans committed
563 564 565 566
 * timestamp is the timestamp of the last buffer that cause the element
 * to generate the QOS event.
 *
 * Returns: A new QOS event.
567
 */
568
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
569 570
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
571
{
572 573 574 575 576
  GST_CAT_INFO (GST_CAT_EVENT,
      "creating qos proportion %lf, diff %" GST_TIME_FORMAT
      ", timestamp %" GST_TIME_FORMAT, proportion,
      GST_TIME_ARGS (diff), GST_TIME_ARGS (timestamp));

Wim Taymans's avatar
Wim Taymans committed
577 578 579 580 581 582
  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));
}
583

Wim Taymans's avatar
Wim Taymans committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597
/**
 * 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;
598

Wim Taymans's avatar
Wim Taymans committed
599 600 601 602 603 604 605 606 607 608 609 610
  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"));
611
}
612 613

/**
Wim Taymans's avatar
Wim Taymans committed
614 615 616 617 618 619 620 621 622 623 624
 * gst_event_new_seek:
 * @rate: The new playback rate
 * @format: The format of the seek values
 * @flags: The optional seek flags.
 * @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.
 *
625
 * The seek event configures playback of the pipeline from
Wim Taymans's avatar
Wim Taymans committed
626 627
 * @cur to @stop at the speed given in @rate.
 * The @cur and @stop values are expressed in format @format.
628
 *
Wim Taymans's avatar
Wim Taymans committed
629 630 631
 * 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.
632
 *
Wim Taymans's avatar
Wim Taymans committed
633 634 635 636 637
 * @cur_type and @stop_type specify how to adjust the current and stop
 * time, relative or absolute. A type of #GST_EVENT_TYPE_NONE means that
 * the position should not be updated.
 *
 * Returns: A new seek event.
638 639
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
640 641
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
    GstSeekType cur_type, gint64 cur, GstSeekType stop_type, gint64 stop)
642
{
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
  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
658 659 660 661 662 663 664 665 666
  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));
}
667

668 669 670 671 672 673 674 675 676 677 678 679 680
/**
 * 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
681 682 683 684 685 686 687
void
gst_event_parse_seek (GstEvent * event, gdouble * rate, GstFormat * format,
    GstSeekFlags * flags,
    GstSeekType * cur_type, gint64 * cur,
    GstSeekType * stop_type, gint64 * stop)
{
  const GstStructure *structure;
688

Wim Taymans's avatar
Wim Taymans committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
  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"));
}

711 712 713 714 715 716 717 718
/**
 * 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
719 720 721 722 723 724
GstEvent *
gst_event_new_navigation (GstStructure * structure)
{
  g_return_val_if_fail (structure != NULL, NULL);

  return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
725
}