tee: Check for the removed pad flag also in the slow pushing path
[platform/upstream/gstreamer.git] / gst / gstevent.h
index 56f920a..38ad3fb 100644 (file)
@@ -79,7 +79,7 @@ typedef enum {
  *                 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_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.
@@ -88,7 +88,7 @@ typedef enum {
  *                 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_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.
@@ -97,7 +97,7 @@ typedef enum {
  *                          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)
+ *                 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.
@@ -222,7 +222,7 @@ typedef enum {
 
 G_BEGIN_DECLS
 
-GST_EXPORT GType _gst_event_type;
+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))
@@ -252,6 +252,7 @@ GST_EXPORT GType _gst_event_type;
  * Get the #GstClockTime timestamp of the event. This is the time when the event
  * was created.
  */
+/* FIXME 2.0: Remove the GstEvent::timestamp field */
 #define GST_EVENT_TIMESTAMP(event)      (GST_EVENT_CAST(event)->timestamp)
 
 /**
@@ -406,17 +407,18 @@ struct _GstEvent {
 
   /*< public >*/ /* with COW */
   GstEventType  type;
+  /* FIXME 2.0: Remove the GstEvent::timestamp field */
   guint64       timestamp;
   guint32       seqnum;
 };
 
-GST_EXPORT
+GST_API
 const gchar*    gst_event_type_get_name         (GstEventType type);
 
-GST_EXPORT
+GST_API
 GQuark          gst_event_type_to_quark         (GstEventType type);
 
-GST_EXPORT
+GST_API
 GstEventTypeFlags
                 gst_event_type_get_flags        (GstEventType type);
 
@@ -448,6 +450,25 @@ gst_event_unref (GstEvent * event)
   gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
 }
 
+/**
+ * gst_clear_event: (skip)
+ * @event_ptr: a pointer to a #GstEvent reference
+ *
+ * Clears a reference to a #GstEvent.
+ *
+ * @event_ptr must not be %NULL.
+ *
+ * If the reference is %NULL then this function does nothing. Otherwise, the
+ * reference count of the event is decreased and the pointer is set to %NULL.
+ *
+ * Since: 1.16
+ */
+static inline void
+gst_clear_event (GstEvent ** event_ptr)
+{
+  gst_clear_mini_object ((GstMiniObject **) event_ptr);
+}
+
 /* copy event */
 /**
  * gst_event_copy:
@@ -463,239 +484,245 @@ gst_event_copy (const GstEvent * event)
   return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (event)));
 }
 
-GST_EXPORT
+GST_API
 GType           gst_event_get_type              (void);
 
 /* custom event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_custom            (GstEventType type, GstStructure *structure) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 const GstStructure *
                 gst_event_get_structure         (GstEvent *event);
 
-GST_EXPORT
+GST_API
 GstStructure *  gst_event_writable_structure    (GstEvent *event);
 
-GST_EXPORT
+GST_API
 gboolean        gst_event_has_name              (GstEvent *event, const gchar *name);
 
 /* identifiers for events and messages */
 
-GST_EXPORT
+GST_API
 guint32         gst_event_get_seqnum            (GstEvent *event);
 
-GST_EXPORT
+GST_API
 void            gst_event_set_seqnum            (GstEvent *event, guint32 seqnum);
 
 /* accumulated pad offsets for the event */
 
-GST_EXPORT
+GST_API
 gint64          gst_event_get_running_time_offset (GstEvent *event);
 
-GST_EXPORT
+GST_API
 void            gst_event_set_running_time_offset (GstEvent *event, gint64 offset);
 
 /* Stream start event */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_stream_start      (const gchar *stream_id) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_stream_start    (GstEvent *event, const gchar **stream_id);
 
-GST_EXPORT
+GST_API
 void            gst_event_set_stream           (GstEvent *event, GstStream *stream);
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_stream         (GstEvent *event, GstStream **stream);
 
-GST_EXPORT
+GST_API
 void            gst_event_set_stream_flags      (GstEvent *event, GstStreamFlags flags);
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_stream_flags    (GstEvent *event, GstStreamFlags *flags);
 
-GST_EXPORT
+GST_API
 void            gst_event_set_group_id          (GstEvent *event, guint group_id);
 
-GST_EXPORT
+GST_API
 gboolean        gst_event_parse_group_id        (GstEvent *event, guint *group_id);
 
 /* flush events */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_flush_start       (void) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_flush_stop        (gboolean reset_time) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_flush_stop      (GstEvent *event, gboolean *reset_time);
 
 /* Stream collection event */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_stream_collection   (GstStreamCollection *collection) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_stream_collection (GstEvent *event, GstStreamCollection **collection);
 
 /* select streams event */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_select_streams    (GList *streams);
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_select_streams  (GstEvent *event, GList **streams);
 
 /* stream-group-done event */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_stream_group_done (guint group_id) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_stream_group_done (GstEvent *event, guint *group_id);
 
 /* EOS event */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_eos               (void) G_GNUC_MALLOC;
 
 /* GAP event */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_gap               (GstClockTime   timestamp,
                                                  GstClockTime   duration) G_GNUC_MALLOC;
-GST_EXPORT
+GST_API
 void            gst_event_parse_gap             (GstEvent     * event,
                                                  GstClockTime * timestamp,
                                                  GstClockTime * duration);
 
 /* Caps events */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_caps              (GstCaps *caps) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_caps            (GstEvent *event, GstCaps **caps);
 
 /* segment event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_segment           (const GstSegment *segment) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_segment         (GstEvent *event, const GstSegment **segment);
 
-GST_EXPORT
+GST_API
 void            gst_event_copy_segment          (GstEvent *event, GstSegment *segment);
 
 /* tag event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_tag               (GstTagList *taglist) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_tag             (GstEvent *event, GstTagList **taglist);
 
 /* TOC event */
 
-GST_EXPORT
+GST_API
 GstEvent*      gst_event_new_toc                (GstToc *toc, gboolean updated);
 
-GST_EXPORT
+GST_API
 void           gst_event_parse_toc              (GstEvent *event, GstToc **toc, gboolean *updated);
 
 /* Protection event */
 
-GST_EXPORT
+GST_API
 GstEvent *     gst_event_new_protection         (const gchar * system_id, GstBuffer * data, const gchar * origin);
 
-GST_EXPORT
+GST_API
 void           gst_event_parse_protection       (GstEvent * event, const gchar ** system_id,
                                                  GstBuffer ** data, const gchar ** origin);
 
 /* buffer */
 
-GST_EXPORT
+GST_API
 GstEvent *      gst_event_new_buffer_size       (GstFormat format, gint64 minsize, gint64 maxsize,
                                                  gboolean async) G_GNUC_MALLOC;
-GST_EXPORT
+GST_API
 void            gst_event_parse_buffer_size     (GstEvent *event, GstFormat *format, gint64 *minsize,
                                                  gint64 *maxsize, gboolean *async);
 
 /* sink message */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_sink_message      (const gchar *name, GstMessage *msg) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_sink_message    (GstEvent *event, GstMessage **msg);
 
 /* QOS events */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_qos               (GstQOSType type, gdouble proportion,
                                                  GstClockTimeDiff diff, GstClockTime timestamp) G_GNUC_MALLOC;
-GST_EXPORT
+GST_API
 void            gst_event_parse_qos             (GstEvent *event, GstQOSType *type,
                                                  gdouble *proportion, GstClockTimeDiff *diff,
                                                  GstClockTime *timestamp);
 /* seek event */
 
-GST_EXPORT
+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_EXPORT
+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);
 
+GST_API
+void            gst_event_set_seek_trickmode_interval (GstEvent *event, GstClockTime interval);
+
+GST_API
+void            gst_event_parse_seek_trickmode_interval (GstEvent *event, GstClockTime *interval);
+
 /* navigation event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_navigation        (GstStructure *structure) G_GNUC_MALLOC;
 
 /* latency event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_latency           (GstClockTime latency) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_latency         (GstEvent *event, GstClockTime *latency);
 
 /* step event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_step              (GstFormat format, guint64 amount, gdouble rate,
                                                  gboolean flush, gboolean intermediate) G_GNUC_MALLOC;
-GST_EXPORT
+GST_API
 void            gst_event_parse_step            (GstEvent *event, GstFormat *format, guint64 *amount,
                                                  gdouble *rate, gboolean *flush, gboolean *intermediate);
 
 /* renegotiate event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_reconfigure       (void) G_GNUC_MALLOC;
 
 /* TOC select event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_toc_select        (const gchar *uid) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_toc_select      (GstEvent *event, gchar **uid);
 
 /* segment-done event */
 
-GST_EXPORT
+GST_API
 GstEvent*       gst_event_new_segment_done      (GstFormat format, gint64 position) G_GNUC_MALLOC;
 
-GST_EXPORT
+GST_API
 void            gst_event_parse_segment_done    (GstEvent *event, GstFormat *format, gint64 *position);
 
 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC