/* GStreamer * Copyright (C) 1999,2000 Erik Walthinsen * 2000 Wim Taymans * * 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., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ #ifndef __GST_EVENT_H__ #define __GST_EVENT_H__ #include #include #include #include #include G_BEGIN_DECLS GST_EXPORT GType _gst_event_type; typedef enum { GST_EVENT_UNKNOWN = 0, GST_EVENT_EOS = 1, GST_EVENT_FLUSH = 2, GST_EVENT_EMPTY = 3, GST_EVENT_DISCONTINUOUS = 4, /*GST_EVENT_NEW_MEDIA = 5, <- removed */ GST_EVENT_QOS = 6, GST_EVENT_SEEK = 7, GST_EVENT_SEEK_SEGMENT = 8, GST_EVENT_SEGMENT_DONE = 9, GST_EVENT_SIZE = 10, GST_EVENT_RATE = 11, GST_EVENT_FILLER = 12, GST_EVENT_TS_OFFSET = 13, GST_EVENT_INTERRUPT = 14, GST_EVENT_NAVIGATION = 15, GST_EVENT_TAG = 16 } GstEventType; #define GST_EVENT_ANY GST_EVENT_NAVIGATION #define GST_EVENT_TRACE_NAME "GstEvent" #define GST_TYPE_EVENT (_gst_event_type) #define GST_EVENT(event) ((GstEvent*)(event)) #define GST_IS_EVENT(event) (GST_DATA_TYPE(event) == GST_TYPE_EVENT) #define GST_EVENT_TYPE(event) (GST_EVENT(event)->type) #define GST_EVENT_TIMESTAMP(event) (GST_EVENT(event)->timestamp) #define GST_EVENT_SRC(event) (GST_EVENT(event)->src) #define GST_EVENT_IS_INTERRUPT(event) (GST_EVENT_TYPE (event) == GST_EVENT_INTERRUPT) #define GST_SEEK_FORMAT_SHIFT 0 #define GST_SEEK_METHOD_SHIFT 16 #define GST_SEEK_FLAGS_SHIFT 20 #define GST_SEEK_FORMAT_MASK 0x0000ffff #define GST_SEEK_METHOD_MASK 0x000f0000 #define GST_SEEK_FLAGS_MASK 0xfff00000 typedef enum { GST_EVENT_FLAG_NONE = 0, /* indicates negative rates are supported */ GST_RATE_FLAG_NEGATIVE = (1 << 1) } GstEventFlag; typedef struct { GstEventType type; GstEventFlag flags; } GstEventMask; #ifndef GST_DISABLE_DEPRECATED #ifdef G_HAVE_ISO_VARARGS #define GST_EVENT_MASK_FUNCTION(type,functionname, ...) \ static const GstEventMask* \ functionname (type pad) \ { \ static const GstEventMask masks[] = { \ __VA_ARGS__, \ { 0, } \ }; \ return masks; \ } #elif defined(G_HAVE_GNUC_VARARGS) #define GST_EVENT_MASK_FUNCTION(type,functionname, a...) \ static const GstEventMask* \ functionname (type pad) \ { \ static const GstEventMask masks[] = { \ a, \ { 0, } \ }; \ return masks; \ } #endif #endif /* seek events, extends GstEventFlag */ typedef enum { /* | with some format */ /* | with one of these */ GST_SEEK_METHOD_CUR = (1 << (GST_SEEK_METHOD_SHIFT + 0)), GST_SEEK_METHOD_SET = (1 << (GST_SEEK_METHOD_SHIFT + 1)), GST_SEEK_METHOD_END = (1 << (GST_SEEK_METHOD_SHIFT + 2)), /* | with optional seek flags */ /* seek flags */ GST_SEEK_FLAG_FLUSH = (1 << (GST_SEEK_FLAGS_SHIFT + 0)), GST_SEEK_FLAG_ACCURATE = (1 << (GST_SEEK_FLAGS_SHIFT + 1)), GST_SEEK_FLAG_KEY_UNIT = (1 << (GST_SEEK_FLAGS_SHIFT + 2)), GST_SEEK_FLAG_SEGMENT_LOOP = (1 << (GST_SEEK_FLAGS_SHIFT + 3)) } GstSeekType; typedef enum { GST_SEEK_CERTAIN, GST_SEEK_FUZZY } GstSeekAccuracy; typedef struct { GstFormat format; gint64 value; } GstFormatValue; /* FIXME: 0.9 - having GstEventCommonFlag and GstEventFlag is unneeded duplication, * but for now I have to because the GstEventFlag enum above is not suitable. */ typedef enum { /* Indicates that a result flag is not required. This is most important * when the event travels upstream through a queue */ GST_EVENT_COMMON_FLAG_NEED_RESPONSE = GST_DATA_FLAG_LAST, /* padding value for future expansion */ GST_EVENT_COMMON_FLAG_LAST = GST_DATA_FLAG_LAST + 16 } GstEventCommonFlag; #define GST_EVENT_SEEK_TYPE(event) (GST_EVENT(event)->event_data.seek.type) #define GST_EVENT_SEEK_FORMAT(event) (GST_EVENT_SEEK_TYPE(event) & GST_SEEK_FORMAT_MASK) #define GST_EVENT_SEEK_METHOD(event) (GST_EVENT_SEEK_TYPE(event) & GST_SEEK_METHOD_MASK) #define GST_EVENT_SEEK_FLAGS(event) (GST_EVENT_SEEK_TYPE(event) & GST_SEEK_FLAGS_MASK) #define GST_EVENT_SEEK_OFFSET(event) (GST_EVENT(event)->event_data.seek.offset) #define GST_EVENT_SEEK_ENDOFFSET(event) (GST_EVENT(event)->event_data.seek.endoffset) #define GST_EVENT_SEEK_ACCURACY(event) (GST_EVENT(event)->event_data.seek.accuracy) #define GST_EVENT_DISCONT_NEW_MEDIA(event) (GST_EVENT(event)->event_data.discont.new_media) #define GST_EVENT_DISCONT_OFFSET(event,i) (GST_EVENT(event)->event_data.discont.offsets[i]) #define GST_EVENT_DISCONT_OFFSET_LEN(event) (GST_EVENT(event)->event_data.discont.noffsets) #define GST_EVENT_SIZE_FORMAT(event) (GST_EVENT(event)->event_data.size.format) #define GST_EVENT_SIZE_VALUE(event) (GST_EVENT(event)->event_data.size.value) #define GST_EVENT_RATE_VALUE(event) (GST_EVENT(event)->event_data.rate.value) struct _GstEvent { GstData data; GstEventType type; guint64 timestamp; GstObject *src; union { struct { GstSeekType type; gint64 offset; gint64 endoffset; GstSeekAccuracy accuracy; } seek; struct { GstFormatValue offsets[8]; gint noffsets; gboolean new_media; } discont; struct { GstFormat format; gint64 value; } size; struct { gdouble value; } rate; struct { GstStructure *structure; } structure; } event_data; gpointer _gst_reserved[GST_PADDING]; }; void _gst_event_initialize (void); GType gst_event_get_type (void); GstEvent* gst_event_new (GstEventType type); /* refcounting */ #define gst_event_ref(ev) GST_EVENT (gst_data_ref (GST_DATA (ev))) #define gst_event_ref_by_count(ev,c) GST_EVENT (gst_data_ref_by_count (GST_DATA (ev), c)) #define gst_event_unref(ev) gst_data_unref (GST_DATA (ev)) /* copy buffer */ #define gst_event_copy(ev) GST_EVENT (gst_data_copy (GST_DATA (ev))) gboolean gst_event_masks_contains (const GstEventMask *masks, GstEventMask *mask); /* seek event */ GstEvent* gst_event_new_seek (GstSeekType type, gint64 offset); GstEvent* gst_event_new_segment_seek (GstSeekType type, gint64 start, gint64 stop); /* size events */ GstEvent* gst_event_new_size (GstFormat format, gint64 value); /* discontinous event */ GstEvent* gst_event_new_discontinuous (gboolean new_media, GstFormat format1, ...); GstEvent* gst_event_new_discontinuous_valist (gboolean new_media, GstFormat format1, va_list var_args); gboolean gst_event_discont_get_value (GstEvent *event, GstFormat format, gint64 *value); #define gst_event_new_filler() gst_event_new(GST_EVENT_FILLER) GstEvent* gst_event_new_filler_stamped (guint64 time, guint64 duration); guint64 gst_event_filler_get_duration (GstEvent *event); /* flush events */ #define gst_event_new_flush() gst_event_new(GST_EVENT_FLUSH) G_END_DECLS #endif /* __GST_EVENT_H__ */