/usr/include/gstreamer-1.0/gst/gstevent.h is in libgstreamer1.0-dev 1.14.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 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 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 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 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 | /* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wim.taymans@chello.be>
* 2005 Wim Taymans <wim@fluendo.com>
*
* gstevent.h: Header for GstEvent subsystem
*
* 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., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_EVENT_H__
#define __GST_EVENT_H__
typedef struct _GstEvent GstEvent;
/**
* GstEventTypeFlags:
* @GST_EVENT_TYPE_UPSTREAM: Set if the event can travel upstream.
* @GST_EVENT_TYPE_DOWNSTREAM: Set if the event can travel downstream.
* @GST_EVENT_TYPE_SERIALIZED: Set if the event should be serialized with data
* flow.
* @GST_EVENT_TYPE_STICKY: Set if the event is sticky on the pads.
* @GST_EVENT_TYPE_STICKY_MULTI: Multiple sticky events can be on a pad, each
* identified by the event name.
*
* #GstEventTypeFlags indicate the aspects of the different #GstEventType
* values. You can get the type flags of a #GstEventType with the
* gst_event_type_get_flags() function.
*/
typedef enum {
GST_EVENT_TYPE_UPSTREAM = 1 << 0,
GST_EVENT_TYPE_DOWNSTREAM = 1 << 1,
GST_EVENT_TYPE_SERIALIZED = 1 << 2,
GST_EVENT_TYPE_STICKY = 1 << 3,
GST_EVENT_TYPE_STICKY_MULTI = 1 << 4
} GstEventTypeFlags;
/**
* GST_EVENT_TYPE_BOTH: (value 3) (type GstEventTypeFlags)
*
* The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.
*/
#define GST_EVENT_TYPE_BOTH \
((GstEventTypeFlags)(GST_EVENT_TYPE_UPSTREAM | GST_EVENT_TYPE_DOWNSTREAM))
#define GST_EVENT_NUM_SHIFT (8)
/**
* GST_EVENT_MAKE_TYPE:
* @num: the event number to create
* @flags: the event flags
*
* when making custom event types, use this macro with the num and
* the given flags
*/
#define GST_EVENT_MAKE_TYPE(num,flags) \
(((num) << GST_EVENT_NUM_SHIFT) | (flags))
#define FLAG(name) GST_EVENT_TYPE_##name
/**
* GstEventType:
* @GST_EVENT_UNKNOWN: unknown event.
* @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
* from the pipeline and unblock all streaming threads.
* @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
* running-time of the pipeline.
* @GST_EVENT_SELECT_STREAMS: A request to select one or more streams (Since 1.10)
* @GST_EVENT_STREAM_START: Event to mark the start of a new stream. Sent before any
* other serialized event and only sent at the start of a new stream,
* not after flushing seeks.
* @GST_EVENT_CAPS: #GstCaps event. Notify the pad of a new media type.
* @GST_EVENT_SEGMENT: A new media segment follows in the dataflow. The
* segment events contains information for clipping buffers and
* converting buffer timestamps to running-time and
* stream-time.
* @GST_EVENT_STREAM_COLLECTION: A new #GstStreamCollection is available (Since 1.10)
* @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
* @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
* used yet.
* @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
* send messages that should be emitted in sync with
* rendering.
* @GST_EVENT_STREAM_GROUP_DONE: Indicates that there is no more data for
* the stream group ID in the message. Sent before EOS
* in some instances and should be handled mostly the same. (Since 1.10)
* @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
* without either a STREAM_START event, or a FLUSH_STOP and a SEGMENT
* event.
* @GST_EVENT_SEGMENT_DONE: Marks the end of a segment playback.
* @GST_EVENT_GAP: Marks a gap in the datastream.
* @GST_EVENT_TOC: An event which indicates that a new table of contents (TOC)
* was found or updated.
* @GST_EVENT_PROTECTION: An event which indicates that new or updated
* encryption information has been found in the stream.
* @GST_EVENT_QOS: A quality message. Used to indicate to upstream elements
* that the downstream elements should adjust their processing
* rate.
* @GST_EVENT_SEEK: A request for a new playback position and rate.
* @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
* user requests, such as mouse or keyboard movements,
* to upstream elements.
* @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
* the latency information to adjust their synchronisation.
* @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
* execute the step operation.
* @GST_EVENT_RECONFIGURE: A request for upstream renegotiating caps and reconfiguring.
* @GST_EVENT_TOC_SELECT: A request for a new playback position based on TOC
* entry's UID.
* @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
* @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
* data flow.
* @GST_EVENT_CUSTOM_DOWNSTREAM_OOB: Custom out-of-band downstream event.
* @GST_EVENT_CUSTOM_DOWNSTREAM_STICKY: Custom sticky downstream event.
* @GST_EVENT_CUSTOM_BOTH: Custom upstream or downstream event.
* In-band when travelling downstream.
* @GST_EVENT_CUSTOM_BOTH_OOB: Custom upstream or downstream out-of-band event.
*
* #GstEventType lists the standard event types that can be sent in a pipeline.
*
* The custom event types can be used for private messages between elements
* that can't be expressed using normal
* GStreamer buffer passing semantics. Custom events carry an arbitrary
* #GstStructure.
* Specific custom events are distinguished by the name of the structure.
*/
/* NOTE: keep in sync with quark registration in gstevent.c */
typedef enum {
GST_EVENT_UNKNOWN = GST_EVENT_MAKE_TYPE (0, 0),
/* bidirectional events */
GST_EVENT_FLUSH_START = GST_EVENT_MAKE_TYPE (10, FLAG(BOTH)),
GST_EVENT_FLUSH_STOP = GST_EVENT_MAKE_TYPE (20, FLAG(BOTH) | FLAG(SERIALIZED)),
/* downstream serialized events */
GST_EVENT_STREAM_START = GST_EVENT_MAKE_TYPE (40, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
GST_EVENT_CAPS = GST_EVENT_MAKE_TYPE (50, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
GST_EVENT_SEGMENT = GST_EVENT_MAKE_TYPE (70, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
GST_EVENT_STREAM_COLLECTION = GST_EVENT_MAKE_TYPE (75, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
GST_EVENT_TAG = GST_EVENT_MAKE_TYPE (80, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
GST_EVENT_BUFFERSIZE = GST_EVENT_MAKE_TYPE (90, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
GST_EVENT_SINK_MESSAGE = GST_EVENT_MAKE_TYPE (100, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
GST_EVENT_STREAM_GROUP_DONE = GST_EVENT_MAKE_TYPE (105, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
GST_EVENT_EOS = GST_EVENT_MAKE_TYPE (110, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY)),
GST_EVENT_TOC = GST_EVENT_MAKE_TYPE (120, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
GST_EVENT_PROTECTION = GST_EVENT_MAKE_TYPE (130, FLAG (DOWNSTREAM) | FLAG (SERIALIZED) | FLAG (STICKY) | FLAG (STICKY_MULTI)),
/* non-sticky downstream serialized */
GST_EVENT_SEGMENT_DONE = GST_EVENT_MAKE_TYPE (150, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
GST_EVENT_GAP = GST_EVENT_MAKE_TYPE (160, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
/* upstream events */
GST_EVENT_QOS = GST_EVENT_MAKE_TYPE (190, FLAG(UPSTREAM)),
GST_EVENT_SEEK = GST_EVENT_MAKE_TYPE (200, FLAG(UPSTREAM)),
GST_EVENT_NAVIGATION = GST_EVENT_MAKE_TYPE (210, FLAG(UPSTREAM)),
GST_EVENT_LATENCY = GST_EVENT_MAKE_TYPE (220, FLAG(UPSTREAM)),
GST_EVENT_STEP = GST_EVENT_MAKE_TYPE (230, FLAG(UPSTREAM)),
GST_EVENT_RECONFIGURE = GST_EVENT_MAKE_TYPE (240, FLAG(UPSTREAM)),
GST_EVENT_TOC_SELECT = GST_EVENT_MAKE_TYPE (250, FLAG(UPSTREAM)),
GST_EVENT_SELECT_STREAMS = GST_EVENT_MAKE_TYPE (260, FLAG(UPSTREAM)),
/* custom events start here */
GST_EVENT_CUSTOM_UPSTREAM = GST_EVENT_MAKE_TYPE (270, FLAG(UPSTREAM)),
GST_EVENT_CUSTOM_DOWNSTREAM = GST_EVENT_MAKE_TYPE (280, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
GST_EVENT_CUSTOM_DOWNSTREAM_OOB = GST_EVENT_MAKE_TYPE (290, FLAG(DOWNSTREAM)),
GST_EVENT_CUSTOM_DOWNSTREAM_STICKY = GST_EVENT_MAKE_TYPE (300, FLAG(DOWNSTREAM) | FLAG(SERIALIZED) | FLAG(STICKY) | FLAG(STICKY_MULTI)),
GST_EVENT_CUSTOM_BOTH = GST_EVENT_MAKE_TYPE (310, FLAG(BOTH) | FLAG(SERIALIZED)),
GST_EVENT_CUSTOM_BOTH_OOB = GST_EVENT_MAKE_TYPE (320, FLAG(BOTH))
} GstEventType;
#undef FLAG
/**
* GstStreamFlags:
* @GST_STREAM_FLAG_NONE: This stream has no special attributes
* @GST_STREAM_FLAG_SPARSE: This stream is a sparse stream (e.g. a subtitle
* stream), data may flow only in irregular intervals with large gaps in
* between.
* @GST_STREAM_FLAG_SELECT: This stream should be selected by default. This
* flag may be used by demuxers to signal that a stream should be selected
* by default in a playback scenario.
* @GST_STREAM_FLAG_UNSELECT: This stream should not be selected by default.
* This flag may be used by demuxers to signal that a stream should not
* be selected by default in a playback scenario, but only if explicitly
* selected by the user (e.g. an audio track for the hard of hearing or
* a director's commentary track).
*
* Since: 1.2
*/
typedef enum {
GST_STREAM_FLAG_NONE,
GST_STREAM_FLAG_SPARSE = (1 << 0),
GST_STREAM_FLAG_SELECT = (1 << 1),
GST_STREAM_FLAG_UNSELECT = (1 << 2)
} GstStreamFlags;
#include <gst/gstminiobject.h>
#include <gst/gstformat.h>
#include <gst/gstobject.h>
#include <gst/gstclock.h>
#include <gst/gststructure.h>
#include <gst/gsttaglist.h>
#include <gst/gstsegment.h>
#include <gst/gstmessage.h>
#include <gst/gstcontext.h>
#include <gst/gststreams.h>
#include <gst/gsttoc.h>
#include <gst/gststreamcollection.h>
G_BEGIN_DECLS
GST_API GType _gst_event_type;
#define GST_TYPE_EVENT (_gst_event_type)
#define GST_IS_EVENT(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_EVENT))
#define GST_EVENT_CAST(obj) ((GstEvent *)(obj))
#define GST_EVENT(obj) (GST_EVENT_CAST(obj))
/**
* GST_EVENT_TYPE:
* @event: the event to query
*
* Get the #GstEventType of the event.
*/
#define GST_EVENT_TYPE(event) (GST_EVENT_CAST(event)->type)
/**
* GST_EVENT_TYPE_NAME:
* @event: the event to query
*
* Get a constant string representation of the #GstEventType of the event.
*/
#define GST_EVENT_TYPE_NAME(event) (gst_event_type_get_name(GST_EVENT_TYPE(event)))
/**
* GST_EVENT_TIMESTAMP:
* @event: the event to query
*
* Get the #GstClockTime timestamp of the event. This is the time when the event
* was created.
*/
#define GST_EVENT_TIMESTAMP(event) (GST_EVENT_CAST(event)->timestamp)
/**
* GST_EVENT_SEQNUM:
* @event: the event to query
*
* The sequence number of @event.
*/
#define GST_EVENT_SEQNUM(event) (GST_EVENT_CAST(event)->seqnum)
/**
* GST_EVENT_IS_UPSTREAM:
* @ev: the event to query
*
* Check if an event can travel upstream.
*/
#define GST_EVENT_IS_UPSTREAM(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_UPSTREAM)
/**
* GST_EVENT_IS_DOWNSTREAM:
* @ev: the event to query
*
* Check if an event can travel downstream.
*/
#define GST_EVENT_IS_DOWNSTREAM(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_DOWNSTREAM)
/**
* GST_EVENT_IS_SERIALIZED:
* @ev: the event to query
*
* Check if an event is serialized with the data stream.
*/
#define GST_EVENT_IS_SERIALIZED(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_SERIALIZED)
/**
* GST_EVENT_IS_STICKY:
* @ev: the event to query
*
* Check if an event is sticky on the pads.
*/
#define GST_EVENT_IS_STICKY(ev) !!(GST_EVENT_TYPE (ev) & GST_EVENT_TYPE_STICKY)
/**
* gst_event_is_writable:
* @ev: a #GstEvent
*
* Tests if you can safely write data into a event's structure or validly
* modify the seqnum and timestamp field.
*/
#define gst_event_is_writable(ev) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (ev))
/**
* gst_event_make_writable:
* @ev: (transfer full): a #GstEvent
*
* Makes a writable event from the given event. If the source event is
* already writable, this will simply return the same event. A copy will
* otherwise be made using gst_event_copy().
*
* Returns: (transfer full): a writable event which may or may not be the
* same as @ev
*/
#define gst_event_make_writable(ev) GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
/**
* gst_event_replace:
* @old_event: (inout) (transfer full) (nullable): pointer to a
* pointer to a #GstEvent to be replaced.
* @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
* replace the event pointed to by @old_event.
*
* Modifies a pointer to a #GstEvent to point to a different #GstEvent. The
* modification is done atomically (so this is useful for ensuring thread safety
* in some cases), and the reference counts are updated appropriately (the old
* event is unreffed, the new one is reffed).
*
* Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.
*
* Returns: %TRUE if @new_event was different from @old_event
*/
static inline gboolean
gst_event_replace (GstEvent **old_event, GstEvent *new_event)
{
return gst_mini_object_replace ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
}
/**
* gst_event_steal:
* @old_event: (inout) (transfer full) (nullable): pointer to a
* pointer to a #GstEvent to be stolen.
*
* Atomically replace the #GstEvent pointed to by @old_event with %NULL and
* return the original event.
*
* Returns: the #GstEvent that was in @old_event
*/
static inline GstEvent *
gst_event_steal (GstEvent **old_event)
{
return GST_EVENT_CAST (gst_mini_object_steal ((GstMiniObject **) old_event));
}
/**
* gst_event_take:
* @old_event: (inout) (transfer full) (nullable): pointer to a
* pointer to a #GstEvent to be stolen.
* @new_event: (allow-none) (transfer full): pointer to a #GstEvent that will
* replace the event pointed to by @old_event.
*
* Modifies a pointer to a #GstEvent to point to a different #GstEvent. This
* function is similar to gst_event_replace() except that it takes ownership of
* @new_event.
*
* Either @new_event or the #GstEvent pointed to by @old_event may be %NULL.
*
* Returns: %TRUE if @new_event was different from @old_event
*/
static inline gboolean
gst_event_take (GstEvent **old_event, GstEvent *new_event)
{
return gst_mini_object_take ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
}
/**
* GstQOSType:
* @GST_QOS_TYPE_OVERFLOW: The QoS event type that is produced when upstream
* elements are producing data too quickly and the element can't keep up
* processing the data. Upstream should reduce their production rate. This
* type is also used when buffers arrive early or in time.
* @GST_QOS_TYPE_UNDERFLOW: The QoS event type that is produced when upstream
* elements are producing data too slowly and need to speed up their
* production rate.
* @GST_QOS_TYPE_THROTTLE: The QoS event type that is produced when the
* application enabled throttling to limit the data rate.
*
* The different types of QoS events that can be given to the
* gst_event_new_qos() method.
*/
typedef enum {
GST_QOS_TYPE_OVERFLOW = 0,
GST_QOS_TYPE_UNDERFLOW = 1,
GST_QOS_TYPE_THROTTLE = 2
} GstQOSType;
/**
* GstEvent:
* @mini_object: the parent structure
* @type: the #GstEventType of the event
* @timestamp: the timestamp of the event
* @seqnum: the sequence number of the event
*
* A #GstEvent.
*/
struct _GstEvent {
GstMiniObject mini_object;
/*< public >*/ /* with COW */
GstEventType type;
guint64 timestamp;
guint32 seqnum;
};
GST_API
const gchar* gst_event_type_get_name (GstEventType type);
GST_API
GQuark gst_event_type_to_quark (GstEventType type);
GST_API
GstEventTypeFlags
gst_event_type_get_flags (GstEventType type);
/* refcounting */
/**
* gst_event_ref:
* @event: The event to refcount
*
* Increase the refcount of this event.
*
* Returns: (transfer full): @event (for convenience when doing assignments)
*/
static inline GstEvent *
gst_event_ref (GstEvent * event)
{
return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (event));
}
/**
* gst_event_unref:
* @event: (transfer full): the event to refcount
*
* Decrease the refcount of an event, freeing it if the refcount reaches 0.
*/
static inline void
gst_event_unref (GstEvent * event)
{
gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
}
/* copy event */
/**
* gst_event_copy:
* @event: The event to copy
*
* Copy the event using the event specific copy function.
*
* Returns: (transfer full): the new event
*/
static inline GstEvent *
gst_event_copy (const GstEvent * event)
{
return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
}
GST_API
GType gst_event_get_type (void);
/* custom event */
GST_API
GstEvent* gst_event_new_custom (GstEventType type, GstStructure *structure) G_GNUC_MALLOC;
GST_API
const GstStructure *
gst_event_get_structure (GstEvent *event);
GST_API
GstStructure * gst_event_writable_structure (GstEvent *event);
GST_API
gboolean gst_event_has_name (GstEvent *event, const gchar *name);
/* identifiers for events and messages */
GST_API
guint32 gst_event_get_seqnum (GstEvent *event);
GST_API
void gst_event_set_seqnum (GstEvent *event, guint32 seqnum);
/* accumulated pad offsets for the event */
GST_API
gint64 gst_event_get_running_time_offset (GstEvent *event);
GST_API
void gst_event_set_running_time_offset (GstEvent *event, gint64 offset);
/* Stream start event */
GST_API
GstEvent * gst_event_new_stream_start (const gchar *stream_id) G_GNUC_MALLOC;
GST_API
void gst_event_parse_stream_start (GstEvent *event, const gchar **stream_id);
GST_API
void gst_event_set_stream (GstEvent *event, GstStream *stream);
GST_API
void gst_event_parse_stream (GstEvent *event, GstStream **stream);
GST_API
void gst_event_set_stream_flags (GstEvent *event, GstStreamFlags flags);
GST_API
void gst_event_parse_stream_flags (GstEvent *event, GstStreamFlags *flags);
GST_API
void gst_event_set_group_id (GstEvent *event, guint group_id);
GST_API
gboolean gst_event_parse_group_id (GstEvent *event, guint *group_id);
/* flush events */
GST_API
GstEvent * gst_event_new_flush_start (void) G_GNUC_MALLOC;
GST_API
GstEvent * gst_event_new_flush_stop (gboolean reset_time) G_GNUC_MALLOC;
GST_API
void gst_event_parse_flush_stop (GstEvent *event, gboolean *reset_time);
/* Stream collection event */
GST_API
GstEvent * gst_event_new_stream_collection (GstStreamCollection *collection) G_GNUC_MALLOC;
GST_API
void gst_event_parse_stream_collection (GstEvent *event, GstStreamCollection **collection);
/* select streams event */
GST_API
GstEvent * gst_event_new_select_streams (GList *streams);
GST_API
void gst_event_parse_select_streams (GstEvent *event, GList **streams);
/* stream-group-done event */
GST_API
GstEvent * gst_event_new_stream_group_done (guint group_id) G_GNUC_MALLOC;
GST_API
void gst_event_parse_stream_group_done (GstEvent *event, guint *group_id);
/* EOS event */
GST_API
GstEvent * gst_event_new_eos (void) G_GNUC_MALLOC;
/* GAP event */
GST_API
GstEvent * gst_event_new_gap (GstClockTime timestamp,
GstClockTime duration) G_GNUC_MALLOC;
GST_API
void gst_event_parse_gap (GstEvent * event,
GstClockTime * timestamp,
GstClockTime * duration);
/* Caps events */
GST_API
GstEvent * gst_event_new_caps (GstCaps *caps) G_GNUC_MALLOC;
GST_API
void gst_event_parse_caps (GstEvent *event, GstCaps **caps);
/* segment event */
GST_API
GstEvent* gst_event_new_segment (const GstSegment *segment) G_GNUC_MALLOC;
GST_API
void gst_event_parse_segment (GstEvent *event, const GstSegment **segment);
GST_API
void gst_event_copy_segment (GstEvent *event, GstSegment *segment);
/* tag event */
GST_API
GstEvent* gst_event_new_tag (GstTagList *taglist) G_GNUC_MALLOC;
GST_API
void gst_event_parse_tag (GstEvent *event, GstTagList **taglist);
/* TOC event */
GST_API
GstEvent* gst_event_new_toc (GstToc *toc, gboolean updated);
GST_API
void gst_event_parse_toc (GstEvent *event, GstToc **toc, gboolean *updated);
/* Protection event */
GST_API
GstEvent * gst_event_new_protection (const gchar * system_id, GstBuffer * data, const gchar * origin);
GST_API
void gst_event_parse_protection (GstEvent * event, const gchar ** system_id,
GstBuffer ** data, const gchar ** origin);
/* buffer */
GST_API
GstEvent * gst_event_new_buffer_size (GstFormat format, gint64 minsize, gint64 maxsize,
gboolean async) G_GNUC_MALLOC;
GST_API
void gst_event_parse_buffer_size (GstEvent *event, GstFormat *format, gint64 *minsize,
gint64 *maxsize, gboolean *async);
/* sink message */
GST_API
GstEvent* gst_event_new_sink_message (const gchar *name, GstMessage *msg) G_GNUC_MALLOC;
GST_API
void gst_event_parse_sink_message (GstEvent *event, GstMessage **msg);
/* QOS events */
GST_API
GstEvent* gst_event_new_qos (GstQOSType type, gdouble proportion,
GstClockTimeDiff diff, GstClockTime timestamp) G_GNUC_MALLOC;
GST_API
void gst_event_parse_qos (GstEvent *event, GstQOSType *type,
gdouble *proportion, GstClockTimeDiff *diff,
GstClockTime *timestamp);
/* seek event */
GST_API
GstEvent* gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
GstSeekType start_type, gint64 start,
GstSeekType stop_type, gint64 stop) G_GNUC_MALLOC;
GST_API
void gst_event_parse_seek (GstEvent *event, gdouble *rate, GstFormat *format,
GstSeekFlags *flags,
GstSeekType *start_type, gint64 *start,
GstSeekType *stop_type, gint64 *stop);
/* navigation event */
GST_API
GstEvent* gst_event_new_navigation (GstStructure *structure) G_GNUC_MALLOC;
/* latency event */
GST_API
GstEvent* gst_event_new_latency (GstClockTime latency) G_GNUC_MALLOC;
GST_API
void gst_event_parse_latency (GstEvent *event, GstClockTime *latency);
/* step event */
GST_API
GstEvent* gst_event_new_step (GstFormat format, guint64 amount, gdouble rate,
gboolean flush, gboolean intermediate) G_GNUC_MALLOC;
GST_API
void gst_event_parse_step (GstEvent *event, GstFormat *format, guint64 *amount,
gdouble *rate, gboolean *flush, gboolean *intermediate);
/* renegotiate event */
GST_API
GstEvent* gst_event_new_reconfigure (void) G_GNUC_MALLOC;
/* TOC select event */
GST_API
GstEvent* gst_event_new_toc_select (const gchar *uid) G_GNUC_MALLOC;
GST_API
void gst_event_parse_toc_select (GstEvent *event, gchar **uid);
/* segment-done event */
GST_API
GstEvent* gst_event_new_segment_done (GstFormat format, gint64 position) G_GNUC_MALLOC;
GST_API
void gst_event_parse_segment_done (GstEvent *event, GstFormat *format, gint64 *position);
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstEvent, gst_event_unref)
#endif
G_END_DECLS
#endif /* __GST_EVENT_H__ */
|