gstevent.c 23.8 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.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
22

23 24
/**
 * SECTION:gstevent
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
25 26
 * @short_description: Structure describing events that are passed up and down
 *                     a pipeline
27 28 29 30
 * @see_also: #GstPad, #GstElement
 *
 * The event classes are used to construct and query events.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
31 32
 * Events are usually created with gst_event_new_*() which takes the extra
 * event parameters as arguments.
Wim Taymans's avatar
Wim Taymans committed
33
 * Events can be parsed with their respective gst_event_parse_*() functions.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
34
 * The event should be unreffed with gst_event_unref().
35
 *
Wim Taymans's avatar
Wim Taymans committed
36 37 38 39 40 41 42 43 44 45 46 47
 * 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. 
 * 
 * The events are used to signal special conditions in the datastream such as EOS
 * or the start of a new segment. Events are also used to flush the pipeline of
 * any pending data.
 *
 * Most of the event API is used inside plugins. The application usually only 
 * constructs and uses the seek event API when it wants to perform a seek in the
 * pipeline. 

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
48
 * gst_event_new_seek() is usually used to create a seek event and it takes
49
 * the needed parameters for a seek event.
Wim Taymans's avatar
Wim Taymans committed
50 51 52 53 54 55 56 57 58 59
 * <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
60 61 62
 *      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
63 64 65 66 67 68 69
 *   ...
 *   result = gst_element_send_event (pipeline, event);
 *   if (!result)
 *     g_warning ("seek failed");
 *   ...
 *   </programlisting>
 * </example>
Wim Taymans's avatar
Wim Taymans committed
70 71
 *
 * Last reviewed on 2005-11-23 (0.9.5)
72
 */
Wim Taymans's avatar
Wim Taymans committed
73

74
#include <string.h>             /* memcpy */
75

76 77 78
#include "gst_private.h"

#include "gstinfo.h"
79
#include "gstevent.h"
Wim Taymans's avatar
Wim Taymans committed
80
#include "gstenumtypes.h"
81
#include "gstutils.h"
Benjamin Otte's avatar
Benjamin Otte committed
82

83 84 85 86
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);
87 88 89 90

void
_gst_event_initialize (void)
{
91 92 93
  gst_event_get_type ();
}

94 95 96 97 98 99 100 101 102 103 104 105 106 107
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},
108
  {GST_EVENT_BUFFERSIZE, "buffersize", 0},
109 110 111
  {GST_EVENT_QOS, "qos", 0},
  {GST_EVENT_SEEK, "seek", 0},
  {GST_EVENT_NAVIGATION, "navigation", 0},
112 113 114
  {GST_EVENT_CUSTOM_UPSTREAM, "custom-upstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM, "custom-downstream", 0},
  {GST_EVENT_CUSTOM_DOWNSTREAM_OOB, "custom-downstream-oob", 0},
115 116 117
  {GST_EVENT_CUSTOM_BOTH, "custom-both", 0},
  {GST_EVENT_CUSTOM_BOTH_OOB, "custom-both-oob", 0},

118 119 120
  {0, NULL, 0}
};

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

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/**
 * 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;
}

179 180 181 182
GType
gst_event_get_type (void)
{
  static GType _gst_event_type;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
183
  int i;
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200

  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
201 202 203 204

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

207
  return _gst_event_type;
208 209
}

210 211
static void
gst_event_class_init (gpointer g_class, gpointer class_data)
Wim Taymans's avatar
Wim Taymans committed
212
{
213
  GstEventClass *event_class = GST_EVENT_CLASS (g_class);
Wim Taymans's avatar
Wim Taymans committed
214

215 216 217 218 219
  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
220

221 222 223 224
static void
gst_event_init (GTypeInstance * instance, gpointer g_class)
{
  GstEvent *event;
225

226
  event = GST_EVENT (instance);
Wim Taymans's avatar
Wim Taymans committed
227

228
  GST_EVENT_TIMESTAMP (event) = GST_CLOCK_TIME_NONE;
Wim Taymans's avatar
Wim Taymans committed
229 230
}

231
static void
232
gst_event_finalize (GstEvent * event)
233
{
234 235 236
  g_return_if_fail (event != NULL);
  g_return_if_fail (GST_IS_EVENT (event));

237
  GST_CAT_LOG (GST_CAT_EVENT, "freeing event %p type %s", event,
238
      gst_event_type_get_name (GST_EVENT_TYPE (event)));
Wim Taymans's avatar
Wim Taymans committed
239

240 241
  if (GST_EVENT_SRC (event)) {
    gst_object_unref (GST_EVENT_SRC (event));
242
    GST_EVENT_SRC (event) = NULL;
243
  }
Wim Taymans's avatar
Wim Taymans committed
244 245 246
  if (event->structure) {
    gst_structure_set_parent_refcount (event->structure, NULL);
    gst_structure_free (event->structure);
247
  }
248 249 250 251 252 253 254
}

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

Wim Taymans's avatar
Wim Taymans committed
255
  copy = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
256

Wim Taymans's avatar
Wim Taymans committed
257 258
  GST_EVENT_TYPE (copy) = GST_EVENT_TYPE (event);
  GST_EVENT_TIMESTAMP (copy) = GST_EVENT_TIMESTAMP (event);
259

Wim Taymans's avatar
Wim Taymans committed
260 261 262 263 264 265 266
  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);
267 268
  }
  return copy;
269 270
}

Wim Taymans's avatar
Wim Taymans committed
271 272
static GstEvent *
gst_event_new (GstEventType type)
273
{
Wim Taymans's avatar
Wim Taymans committed
274
  GstEvent *event;
275

Wim Taymans's avatar
Wim Taymans committed
276
  event = (GstEvent *) gst_mini_object_new (GST_TYPE_EVENT);
277

278
  GST_CAT_DEBUG (GST_CAT_EVENT, "creating new event %p %s", event,
279
      gst_event_type_get_name (type));
280

Wim Taymans's avatar
Wim Taymans committed
281 282 283
  event->type = type;
  event->src = NULL;
  event->structure = NULL;
284

Wim Taymans's avatar
Wim Taymans committed
285
  return event;
286 287
}

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

Wim Taymans's avatar
Wim Taymans committed
312 313 314 315 316
  event = gst_event_new (type);
  if (structure) {
    gst_structure_set_parent_refcount (structure, &event->mini_object.refcount);
    event->structure = structure;
  }
317
  return event;
318 319
}

320
/**
Wim Taymans's avatar
Wim Taymans committed
321 322
 * gst_event_get_structure:
 * @event: The #GstEvent.
323
 *
Wim Taymans's avatar
Wim Taymans committed
324
 * Access the structure of the event.
325
 *
Wim Taymans's avatar
Wim Taymans committed
326 327 328 329 330
 * 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.
331
 */
Wim Taymans's avatar
Wim Taymans committed
332 333
const GstStructure *
gst_event_get_structure (GstEvent * event)
334
{
Wim Taymans's avatar
Wim Taymans committed
335
  g_return_val_if_fail (GST_IS_EVENT (event), NULL);
336

Wim Taymans's avatar
Wim Taymans committed
337
  return event->structure;
338
}
339

Wim Taymans's avatar
Wim Taymans committed
340
/**
Wim Taymans's avatar
Wim Taymans committed
341 342 343 344 345 346 347
 * 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
348
 * as fast as possible.
Wim Taymans's avatar
Wim Taymans committed
349
 *
Wim Taymans's avatar
Wim Taymans committed
350 351
 * This event is typically generated after a seek to minimize the latency
 * after the seek.
Wim Taymans's avatar
Wim Taymans committed
352
 *
Wim Taymans's avatar
Wim Taymans committed
353
 * Returns: A new flush start event.
Wim Taymans's avatar
Wim Taymans committed
354
 */
355
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
356
gst_event_new_flush_start (void)
357
{
Wim Taymans's avatar
Wim Taymans committed
358
  return gst_event_new (GST_EVENT_FLUSH_START);
359 360
}

361
/**
Wim Taymans's avatar
Wim Taymans committed
362 363 364 365 366 367
 * 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.
368
 *
Wim Taymans's avatar
Wim Taymans committed
369 370
 * Elements can process this event synchronized with the dataflow since
 * the preceeding FLUSH_START event stopped the dataflow.
371
 *
Wim Taymans's avatar
Wim Taymans committed
372 373 374 375
 * This event is typically generated to complete a seek and to resume
 * dataflow.
 *
 * Returns: A new flush stop event.
376
 */
377
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
378
gst_event_new_flush_stop (void)
379
{
Wim Taymans's avatar
Wim Taymans committed
380
  return gst_event_new (GST_EVENT_FLUSH_STOP);
381 382
}

Wim Taymans's avatar
Wim Taymans committed
383
/**
Wim Taymans's avatar
Wim Taymans committed
384
 * gst_event_new_eos:
Wim Taymans's avatar
Wim Taymans committed
385
 *
Wim Taymans's avatar
Wim Taymans committed
386 387 388 389
 * 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
390
 *
Jan Schmidt's avatar
Jan Schmidt committed
391 392 393
 * 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
394 395 396 397 398
 *
 * 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
399
 */
Wim Taymans's avatar
Wim Taymans committed
400 401
GstEvent *
gst_event_new_eos (void)
402
{
Wim Taymans's avatar
Wim Taymans committed
403
  return gst_event_new (GST_EVENT_EOS);
404 405
}

406
/**
407
 * gst_event_new_new_segment:
408
 * @update: is this segment an update to a previous one
Wim Taymans's avatar
Wim Taymans committed
409 410
 * @rate: a new rate for playback
 * @format: The format of the segment values
411 412 413
 * @start: the start value of the segment
 * @stop: the stop value of the segment
 * @position: stream position
Wim Taymans's avatar
Wim Taymans committed
414 415 416 417
 *
 * Allocate a new newsegment event with the given format/values tripplets.
 *
 * The newsegment event marks the range of buffers to be processed. All
418 419 420
 * 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.
421
 *
422
 * The stream time of the segment is used to convert the buffer timestamps
423
 * into the stream time again, this is usually done in sinks to report the
424
 * current stream_time. @stream_time cannot be -1.
425
 *
426 427
 * @start cannot be -1, @stop can be -1. If there
 * is a valid @stop given, it must be greater or equal than @start.
428
 *
Wim Taymans's avatar
Wim Taymans committed
429 430
 * After a newsegment event, the buffer stream time is calculated with:
 *
431
 *   stream_time + (TIMESTAMP(buf) - start) * ABS (rate)
Wim Taymans's avatar
Wim Taymans committed
432 433
 *
 * Returns: A new newsegment event.
434
 */
435
GstEvent *
436
gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format,
437
    gint64 start, gint64 stop, gint64 position)
438
{
439 440
  g_return_val_if_fail (rate != 0.0, NULL);

441 442
  if (format == GST_FORMAT_TIME) {
    GST_CAT_INFO (GST_CAT_EVENT,
443
        "creating newsegment update %d, rate %lf, format GST_FORMAT_TIME, "
444
        "start %" GST_TIME_FORMAT ", stop %" GST_TIME_FORMAT
445 446 447
        ", position %" GST_TIME_FORMAT,
        update, rate, GST_TIME_ARGS (start),
        GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
448 449
  } else {
    GST_CAT_INFO (GST_CAT_EVENT,
450
        "creating newsegment update %d, rate %lf, format %d, "
451 452
        "start %" G_GINT64_FORMAT ", stop %" G_GINT64_FORMAT ", position %"
        G_GINT64_FORMAT, update, rate, format, start, stop, position);
453
  }
454 455 456 457
  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);
458

Wim Taymans's avatar
Wim Taymans committed
459
  return gst_event_new_custom (GST_EVENT_NEWSEGMENT,
460 461 462
      gst_structure_new ("GstEventNewsegment",
          "update", G_TYPE_BOOLEAN, update,
          "rate", G_TYPE_DOUBLE, rate,
Wim Taymans's avatar
Wim Taymans committed
463
          "format", GST_TYPE_FORMAT, format,
464 465 466
          "start", G_TYPE_INT64, start,
          "stop", G_TYPE_INT64, stop,
          "position", G_TYPE_INT64, position, NULL));
Wim Taymans's avatar
Wim Taymans committed
467
}
468

Wim Taymans's avatar
Wim Taymans committed
469
/**
470
 * gst_event_parse_new_segment:
Wim Taymans's avatar
Wim Taymans committed
471
 * @event: The event to query
472
 * @update: A pointer to the update flag of the segment
Wim Taymans's avatar
Wim Taymans committed
473 474
 * @rate: A pointer to the rate of the segment
 * @format: A pointer to the format of the newsegment values
475 476 477
 * @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
478
 *
479
 * Get the format, start, stop and position in the newsegment event.
Wim Taymans's avatar
Wim Taymans committed
480 481
 */
void
482
gst_event_parse_new_segment (GstEvent * event, gboolean * update,
483 484
    gdouble * rate, GstFormat * format, gint64 * start,
    gint64 * stop, gint64 * position)
Wim Taymans's avatar
Wim Taymans committed
485 486
{
  const GstStructure *structure;
487

Wim Taymans's avatar
Wim Taymans committed
488 489 490 491
  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);
492 493 494
  if (update)
    *update =
        g_value_get_boolean (gst_structure_get_value (structure, "update"));
Wim Taymans's avatar
Wim Taymans committed
495 496 497 498
  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"));
499 500 501 502 503 504 505
  if (start)
    *start = g_value_get_int64 (gst_structure_get_value (structure, "start"));
  if (stop)
    *stop = g_value_get_int64 (gst_structure_get_value (structure, "stop"));
  if (position)
    *position =
        g_value_get_int64 (gst_structure_get_value (structure, "position"));
Wim Taymans's avatar
Wim Taymans committed
506
}
507

508 509 510 511 512
/**
 * 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
513
 *
514 515
 * Returns: a new #GstEvent
 */
Wim Taymans's avatar
Wim Taymans committed
516 517 518 519 520 521
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);
522 523
}

524 525 526 527 528 529 530
/**
 * 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
531 532 533 534 535 536 537 538 539 540
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;
}

541 542
/* buffersize event */
/**
543
 * gst_event_new_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
544 545 546 547
 * @format: buffer format
 * @minsize: minimum buffer size
 * @maxsize: maximum buffer size
 * @async: thread behavior
548 549 550 551 552 553 554 555 556
 *
 * 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 *
557
gst_event_new_buffer_size (GstFormat format, gint64 minsize,
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    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
573
/**
574
 * gst_event_parse_buffer_size:
Stefan Kost's avatar
Stefan Kost committed
575 576 577 578 579 580 581 582
 * @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.
 */
583
void
584
gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
    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"));
}

605
/**
Wim Taymans's avatar
Wim Taymans committed
606 607 608 609 610 611 612 613 614 615 616 617 618
 * 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%.
619
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
620
 * diff is the difference against the clock in stream time of the last
Wim Taymans's avatar
Wim Taymans committed
621
 * buffer that caused the element to generate the QOS event.
622
 *
Wim Taymans's avatar
Wim Taymans committed
623 624 625 626
 * timestamp is the timestamp of the last buffer that cause the element
 * to generate the QOS event.
 *
 * Returns: A new QOS event.
627
 */
628
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
629 630
gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff,
    GstClockTime timestamp)
631
{
632 633 634 635 636
  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
637 638 639 640 641 642
  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));
}
643

Wim Taymans's avatar
Wim Taymans committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657
/**
 * 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;
658

Wim Taymans's avatar
Wim Taymans committed
659 660 661 662 663 664 665 666 667 668 669 670
  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"));
671
}
672 673

/**
Wim Taymans's avatar
Wim Taymans committed
674 675 676
 * 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
677
 * @flags: The optional seek flags
Wim Taymans's avatar
Wim Taymans committed
678 679 680 681 682 683 684
 * @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.
 *
685
 * The seek event configures playback of the pipeline from
Wim Taymans's avatar
Wim Taymans committed
686
 * @cur to @stop at the speed given in @rate, also called a segment.
Wim Taymans's avatar
Wim Taymans committed
687
 * The @cur and @stop values are expressed in format @format.
688
 *
Wim Taymans's avatar
Wim Taymans committed
689 690 691
 * 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.
692
 *
Wim Taymans's avatar
Wim Taymans committed
693
 * @cur_type and @stop_type specify how to adjust the current and stop
Wim Taymans's avatar
Wim Taymans committed
694 695 696
 * 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
697
 *
698 699 700 701 702 703
 * 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
704
 * Returns: A new seek event.
705 706
 */
GstEvent *
Wim Taymans's avatar
Wim Taymans committed
707 708
gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
    GstSeekType cur_type, gint64 cur, GstSeekType stop_type, gint64 stop)
709
{
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  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
725 726 727 728 729 730 731 732 733
  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));
}
734

735 736 737 738 739 740 741 742 743 744 745 746 747
/**
 * 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
748 749 750 751 752 753 754
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;
755

Wim Taymans's avatar
Wim Taymans committed
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
  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"));
}

778 779 780 781 782 783 784 785
/**
 * 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
786 787 788 789 790 791
GstEvent *
gst_event_new_navigation (GstStructure * structure)
{
  g_return_val_if_fail (structure != NULL, NULL);

  return gst_event_new_custom (GST_EVENT_NAVIGATION, structure);
792
}