gstevent.c 19 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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
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},
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
  {0, NULL, 0}
};

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";
}

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;
}

105 106 107 108
GType
gst_event_get_type (void)
{
  static GType _gst_event_type;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
109
  int i;
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

  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
127 128 129 130

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

133
  return _gst_event_type;
134 135
}

136 137
static void
gst_event_class_init (gpointer g_class, gpointer class_data)
Wim Taymans's avatar
Wim Taymans committed
138
{
139
  GstEventClass *event_class = GST_EVENT_CLASS (g_class);
Wim Taymans's avatar
Wim Taymans committed
140

141 142 143 144 145
  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
146

147 148 149 150
static void
gst_event_init (GTypeInstance * instance, gpointer g_class)
{
  GstEvent *event;
151

152
  event = GST_EVENT (instance);
Wim Taymans's avatar
Wim Taymans committed
153

154
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
155 156
}

157
static void
158
gst_event_finalize (GstEvent * event)
159
{
160 161 162
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

163 164
  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
165

166 167
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
168
    GST_EVENT_SRC (event) = NULL;
169
  }
Wim Taymans's avatar
Wim Taymans committed
170 171 172
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
173
  }
174 175 176 177 178 179 180
}

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

Wim Taymans's avatar
Wim Taymans committed
181
  copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
182

Wim Taymans's avatar
Wim Taymans committed
183 184
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
185

Wim Taymans's avatar
Wim Taymans committed
186 187 188 189 190 191 192
  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);
193 194
  }
  return copy;
195 196
}

Wim Taymans's avatar
Wim Taymans committed
197 198
static GstEvent *
gst_event_new (GstEventType type)
199
{
Wim Taymans's avatar
Wim Taymans committed
200
  GstEvent *event;
201

Wim Taymans's avatar
Wim Taymans committed
202
  event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
203

204 205
  GST_CAT_INFO (GST_CAT_EVENT, "creating new event %p %s", event,
      gst_event_type_get_name (type));
206

Wim Taymans's avatar
Wim Taymans committed
207 208 209
  event->type = type;
  event->src = NULL;
  event->structure = NULL;
210

Wim Taymans's avatar
Wim Taymans committed
211
  return event;
212 213
}

214
/**
Wim Taymans's avatar
Wim Taymans committed
215
 * gst_event_new_custom:
216
 * @type: The type of the new event
Wim Taymans's avatar
Wim Taymans committed
217 218
 * @structure: The structure for the event. The event will take ownership of
 * the structure.
219
 *
Wim Taymans's avatar
Wim Taymans committed
220 221 222
 * 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.
223
 *
Wim Taymans's avatar
Wim Taymans committed
224 225 226 227 228 229 230 231
 * 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.
232
 */
233
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
234
gst_event_new_custom (GstEventType type, GstStructure * structure)
235 236 237
{
  GstEvent *event;

Wim Taymans's avatar
Wim Taymans committed
238 239 240 241 242
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
243
  return event;
244 245
}

246
/**
Wim Taymans's avatar
Wim Taymans committed
247 248
 * gst_event_get_structure:
 * @event: The #GstEvent.
249
 *
Wim Taymans's avatar
Wim Taymans committed
250
 * Access the structure of the event.
251
 *
Wim Taymans's avatar
Wim Taymans committed
252 253 254 255 256
 * 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.
257
 */
Wim Taymans's avatar
Wim Taymans committed
258 259
const GstStructure *
gst_event_get_structure (GstEvent * event)
260
{
Wim Taymans's avatar
Wim Taymans committed
261
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
262

Wim Taymans's avatar
Wim Taymans committed
263
  return event->structure;
264
}
265

Wim Taymans's avatar
Wim Taymans committed
266
/**
Wim Taymans's avatar
Wim Taymans committed
267 268 269 270 271 272 273 274
 * 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
275
 *
Wim Taymans's avatar
Wim Taymans committed
276 277
 * This event is typically generated after a seek to minimize the latency
 * after the seek.
Wim Taymans's avatar
Wim Taymans committed
278
 *
Wim Taymans's avatar
Wim Taymans committed
279
 * Returns: A new flush start event.
Wim Taymans's avatar
Wim Taymans committed
280
 */
281
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
282
gst_event_new_flush_start (void)
283
{
Wim Taymans's avatar
Wim Taymans committed
284
  return gst_event_new (GST_EVENT_FLUSH_START);
285 286
}

287
/**
Wim Taymans's avatar
Wim Taymans committed
288 289 290 291 292 293
 * 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.
294
 *
Wim Taymans's avatar
Wim Taymans committed
295 296
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
297
 *
Wim Taymans's avatar
Wim Taymans committed
298 299 300 301
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
 * Returns: A new flush stop event.
302
 */
303
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
304
gst_event_new_flush_stop (void)
305
{
Wim Taymans's avatar
Wim Taymans committed
306
  return gst_event_new (GST_EVENT_FLUSH_STOP);
307 308
}

Wim Taymans's avatar
Wim Taymans committed
309
/**
Wim Taymans's avatar
Wim Taymans committed
310
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
311
 *
Wim Taymans's avatar
Wim Taymans committed
312 313 314 315
 * 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
316
 *
Wim Taymans's avatar
Wim Taymans committed
317 318 319 320 321 322 323
 * 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
324
 */
Wim Taymans's avatar
Wim Taymans committed
325 326
GstEvent *
gst_event_new_eos (void)
327
{
Wim Taymans's avatar
Wim Taymans committed
328
  return gst_event_new (GST_EVENT_EOS);
329 330
}

331
/**
Wim Taymans's avatar
Wim Taymans committed
332 333 334
 * gst_event_new_newsegment:
 * @rate: a new rate for playback
 * @format: The format of the segment values
335 336
 * @start_value: the start value of the segment
 * @stop_value: the stop value of the segment
Wim Taymans's avatar
Wim Taymans committed
337 338 339 340 341
 * @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
342 343 344
 * 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.
345
 *
346
 * The base time of the segment is also used to convert the buffer timestamps
Wim Taymans's avatar
Wim Taymans committed
347
 * into the stream time again.
348
 *
349 350 351
 * 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
352 353 354 355 356
 * After a newsegment event, the buffer stream time is calculated with:
 *
 *   TIMESTAMP(buf) - start_time + base
 *
 * Returns: A new newsegment event.
357
 */
358
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
359
gst_event_new_newsegment (gdouble rate, GstFormat format,
360
    gint64 start_value, gint64 stop_value, gint64 base)
361
{
362 363 364 365 366
  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,
367 368
        rate, GST_TIME_ARGS (start_value),
        GST_TIME_ARGS (stop_value), GST_TIME_ARGS (base));
369 370 371 372
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
        "creating newsegment rate %lf, format %d, "
        "start %lld, stop %lld, base %lld",
373
        rate, format, start_value, stop_value, base);
374
  }
375 376
  if (start_value == -1)
    g_return_val_if_fail (start_value != -1, NULL);
377

378
  if (stop_value != -1)
379
    g_return_val_if_fail (start_value <= stop_value, NULL);
380

Wim Taymans's avatar
Wim Taymans committed
381 382 383
  return gst_event_new_custom (GST_EVENT_NEWSEGMENT,
      gst_structure_new ("GstEventNewsegment", "rate", G_TYPE_DOUBLE, rate,
          "format", GST_TYPE_FORMAT, format,
384 385
          "start_val", G_TYPE_INT64, start_value,
          "stop_val", G_TYPE_INT64, stop_value,
Wim Taymans's avatar
Wim Taymans committed
386 387
          "base", G_TYPE_INT64, base, NULL));
}
388

Wim Taymans's avatar
Wim Taymans committed
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
/**
 * 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;
406

Wim Taymans's avatar
Wim Taymans committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
  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"));
}
424

425 426 427 428 429 430 431 432
/**
 * 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
433 434 435 436 437 438
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);
439 440
}

441 442 443 444 445 446 447
/**
 * 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
448 449 450 451 452 453 454 455 456 457 458
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 */
459 460 461 462 463 464 465
/**
 * gst_event_new_filler:
 *
 * Create a new dummy event that should be ignored.
 *
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
466 467 468 469 470
GstEvent *
gst_event_new_filler (void)
{
  return gst_event_new (GST_EVENT_FILLER);
}
471

472
/**
Wim Taymans's avatar
Wim Taymans committed
473 474 475 476 477 478 479 480 481 482 483 484 485
 * 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%.
486
 *
Wim Taymans's avatar
Wim Taymans committed
487 488
 * diff is the difference against the clock in stream time of the last 
 * buffer that caused the element to generate the QOS event.
489
 *
Wim Taymans's avatar
Wim Taymans committed
490 491 492 493
 * timestamp is the timestamp of the last buffer that cause the element
 * to generate the QOS event.
 *
 * Returns: A new QOS event.
494
 */
495
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
496 497
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
498
{
499 500 501 502 503
  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
504 505 506 507 508 509
  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));
}
510

Wim Taymans's avatar
Wim Taymans committed
511 512 513 514 515 516 517 518 519 520 521 522 523 524
/**
 * 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;
525

Wim Taymans's avatar
Wim Taymans committed
526 527 528 529 530 531 532 533 534 535 536 537
  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"));
538
}
539 540

/**
Wim Taymans's avatar
Wim Taymans committed
541 542 543 544 545 546 547 548 549 550 551
 * 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.
 *
552
 * The seek event configures playback of the pipeline from
Wim Taymans's avatar
Wim Taymans committed
553 554
 * @cur to @stop at the speed given in @rate.
 * The @cur and @stop values are expressed in format @format.
555
 *
Wim Taymans's avatar
Wim Taymans committed
556 557 558
 * 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.
559
 *
Wim Taymans's avatar
Wim Taymans committed
560 561 562 563 564
 * @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.
565 566
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
567 568
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
    GstSeekType cur_type, gint64 cur, GstSeekType stop_type, gint64 stop)
569
{
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
  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
585 586 587 588 589 590 591 592 593
  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));
}
594

595 596 597 598 599 600 601 602 603 604 605 606 607
/**
 * 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
608 609 610 611 612 613 614
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;
615

Wim Taymans's avatar
Wim Taymans committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
  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"));
}

638 639 640 641 642 643 644 645
/**
 * 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
646 647 648 649 650 651
GstEvent *
gst_event_new_navigation (GstStructure * structure)
{
  g_return_val_if_fail (structure != NULL, NULL);

  return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
652
}