X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gst%2Fgstmessage.h;h=72b4260064694588706ed0b99b58433bc22d53cd;hb=e10266e3f3cf9b05b69198b1ac6faa9a62840e30;hp=74092571d635d552cf0060a3c69f67ed1fb23657;hpb=eaa2d81474e20f98dc60d3e2356db4ff8f7ce076;p=platform%2Fupstream%2Fgstreamer.git diff --git a/gst/gstmessage.h b/gst/gstmessage.h index 7409257..72b4260 100644 --- a/gst/gstmessage.h +++ b/gst/gstmessage.h @@ -15,8 +15,8 @@ * * 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. + * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, + * Boston, MA 02110-1301, USA. */ #ifndef __GST_MESSAGE_H__ @@ -33,11 +33,11 @@ typedef struct _GstMessage GstMessage; * only receive this message in the PLAYING state and every time it sets a * pipeline to PLAYING that is in the EOS state. The application can perform a * flushing seek in the pipeline, which will undo the EOS state again. - * @GST_MESSAGE_ERROR: an error occured. When the application receives an error + * @GST_MESSAGE_ERROR: an error occurred. When the application receives an error * message it should stop playback of the pipeline and not assume that more * data will be played. - * @GST_MESSAGE_WARNING: a warning occured. - * @GST_MESSAGE_INFO: an info message occured + * @GST_MESSAGE_WARNING: a warning occurred. + * @GST_MESSAGE_INFO: an info message occurred * @GST_MESSAGE_TAG: a tag was found. * @GST_MESSAGE_BUFFERING: the pipeline is buffering. When the application * receives a buffering message in the PLAYING state for a non-live pipeline it @@ -71,23 +71,43 @@ typedef struct _GstMessage GstMessage; * @GST_MESSAGE_SEGMENT_DONE: pipeline completed playback of a segment. This * message is forwarded to the application after all elements that posted * @GST_MESSAGE_SEGMENT_START posted a GST_MESSAGE_SEGMENT_DONE message. - * @GST_MESSAGE_DURATION: The duration of a pipeline changed. The application - * can get the new duration with a duration query. + * @GST_MESSAGE_DURATION_CHANGED: The duration of a pipeline changed. The + * application can get the new duration with a duration query. * @GST_MESSAGE_ASYNC_START: Posted by elements when they start an ASYNC * #GstStateChange. This message is not forwarded to the application but is used - * internally. Since: 0.10.13. + * internally. * @GST_MESSAGE_ASYNC_DONE: Posted by elements when they complete an ASYNC * #GstStateChange. The application will only receive this message from the toplevel - * pipeline. Since: 0.10.13 + * pipeline. * @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The - * application should recalculate and distribute a new latency. Since: 0.10.12 + * application should recalculate and distribute a new latency. * @GST_MESSAGE_REQUEST_STATE: Posted by elements when they want the pipeline to * change state. This message is a suggestion to the application which can - * decide to perform the state change on (part of) the pipeline. Since: 0.10.23. - * @GST_MESSAGE_STEP_START: A stepping operation was started. Since: 0.10.24 + * decide to perform the state change on (part of) the pipeline. + * @GST_MESSAGE_STEP_START: A stepping operation was started. * @GST_MESSAGE_QOS: A buffer was dropped or an element changed its processing - * strategy for Quality of Service reasons. Since: 0.10.29 - * @GST_MESSAGE_PROGRESS: A progress message. Since: 0.10.33 + * strategy for Quality of Service reasons. + * @GST_MESSAGE_PROGRESS: A progress message. + * @GST_MESSAGE_TOC: A new table of contents (TOC) was found or previously found TOC + * was updated. + * @GST_MESSAGE_RESET_TIME: Message to request resetting the pipeline's + * running time from the pipeline. This is an internal message which + * applications will likely never receive. + * @GST_MESSAGE_STREAM_START: Message indicating start of a new stream. Useful + * e.g. when using playbin in gapless playback mode, to get notified when + * the next title actually starts playing (which will be some time after + * the URI for the next title has been set). + * @GST_MESSAGE_NEED_CONTEXT: Message indicating that an element wants a specific context (Since 1.2) + * @GST_MESSAGE_HAVE_CONTEXT: Message indicating that an element created a context (Since 1.2) + * @GST_MESSAGE_EXTENDED: Message is an extended message type (see below). + * These extended message IDs can't be used directly with mask-based API + * like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still + * filter for GST_MESSAGE_EXTENDED and then check the result for the + * specific type. (Since 1.4) + * @GST_MESSAGE_DEVICE_ADDED: Message indicating a #GstDevice was added to + * a #GstDeviceMonitor (Since 1.4) + * @GST_MESSAGE_DEVICE_REMOVED: Message indicating a #GstDevice was removed + * from a #GstDeviceMonitor (Since 1.4) * @GST_MESSAGE_ANY: mask for all of the above messages. * * The different message types that are available. @@ -95,6 +115,7 @@ typedef struct _GstMessage GstMessage; /* NOTE: keep in sync with quark registration in gstmessage.c * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings. */ +/* FIXME: 2.0: Make it NOT flags, just a regular 1,2,3,4.. enumeration */ typedef enum { GST_MESSAGE_UNKNOWN = 0, @@ -116,7 +137,7 @@ typedef enum GST_MESSAGE_ELEMENT = (1 << 15), GST_MESSAGE_SEGMENT_START = (1 << 16), GST_MESSAGE_SEGMENT_DONE = (1 << 17), - GST_MESSAGE_DURATION = (1 << 18), + GST_MESSAGE_DURATION_CHANGED = (1 << 18), GST_MESSAGE_LATENCY = (1 << 19), GST_MESSAGE_ASYNC_START = (1 << 20), GST_MESSAGE_ASYNC_DONE = (1 << 21), @@ -124,6 +145,14 @@ typedef enum GST_MESSAGE_STEP_START = (1 << 23), GST_MESSAGE_QOS = (1 << 24), GST_MESSAGE_PROGRESS = (1 << 25), + GST_MESSAGE_TOC = (1 << 26), + GST_MESSAGE_RESET_TIME = (1 << 27), + GST_MESSAGE_STREAM_START = (1 << 28), + GST_MESSAGE_NEED_CONTEXT = (1 << 29), + GST_MESSAGE_HAVE_CONTEXT = (1 << 30), + GST_MESSAGE_EXTENDED = (1 << 31), + GST_MESSAGE_DEVICE_ADDED = GST_MESSAGE_EXTENDED + 1, + GST_MESSAGE_DEVICE_REMOVED = GST_MESSAGE_EXTENDED + 2, GST_MESSAGE_ANY = ~0 } GstMessageType; @@ -133,13 +162,8 @@ typedef enum #include #include #include - -/** - * GST_MESSAGE_TRACE_NAME: - * - * The name used for memory allocation tracing - */ -#define GST_MESSAGE_TRACE_NAME "GstMessage" +#include +#include #define GST_TYPE_MESSAGE (gst_message_get_type()) #define GST_IS_MESSAGE(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE)) @@ -149,12 +173,12 @@ typedef enum /* the lock is used to handle the synchronous handling of messages, * the emiting thread is block until the handling thread processed * the message using this mutex/cond pair */ -#define GST_MESSAGE_GET_LOCK(message) (GST_MESSAGE_CAST(message)->lock) +#define GST_MESSAGE_GET_LOCK(message) (&GST_MESSAGE_CAST(message)->lock) #define GST_MESSAGE_LOCK(message) g_mutex_lock(GST_MESSAGE_GET_LOCK(message)) #define GST_MESSAGE_UNLOCK(message) g_mutex_unlock(GST_MESSAGE_GET_LOCK(message)) -#define GST_MESSAGE_COND(message) (GST_MESSAGE_CAST(message)->cond) -#define GST_MESSAGE_WAIT(message) g_cond_wait(GST_MESSAGE_COND(message),GST_MESSAGE_GET_LOCK(message)) -#define GST_MESSAGE_SIGNAL(message) g_cond_signal(GST_MESSAGE_COND(message)) +#define GST_MESSAGE_GET_COND(message) (&GST_MESSAGE_CAST(message)->cond) +#define GST_MESSAGE_WAIT(message) g_cond_wait(GST_MESSAGE_GET_COND(message),GST_MESSAGE_GET_LOCK(message)) +#define GST_MESSAGE_SIGNAL(message) g_cond_signal(GST_MESSAGE_GET_COND(message)) /** * GST_MESSAGE_TYPE: @@ -164,12 +188,19 @@ typedef enum */ #define GST_MESSAGE_TYPE(message) (GST_MESSAGE_CAST(message)->type) /** + * GST_MESSAGE_TYPE_IS_EXTENDED: + * @message: a #GstMessage + * + * Check if the message is in the extended message group + * (Since 1.4) + */ +#define GST_MESSAGE_TYPE_IS_EXTENDED(message) (!!(GST_MESSAGE_CAST(message)->type & GST_MESSAGE_EXTENDED)) + +/** * GST_MESSAGE_TYPE_NAME: * @message: a #GstMessage * * Get a constant string representation of the #GstMessageType of @message. - * - * Since: 0.10.4 */ #define GST_MESSAGE_TYPE_NAME(message) gst_message_type_get_name(GST_MESSAGE_TYPE(message)) /** @@ -202,8 +233,6 @@ typedef enum * * Get the name of the object that posted @message. Returns "(NULL)" if * the message has no source object set. - * - * Since: 0.10.24 */ #define GST_MESSAGE_SRC_NAME(message) (GST_MESSAGE_SRC(message) ? \ GST_OBJECT_NAME (GST_MESSAGE_SRC(message)) : "(NULL)") @@ -214,8 +243,6 @@ typedef enum * @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done. * * The type of a %GST_MESSAGE_STRUCTURE_CHANGE. - * - * Since: 0.10.22 */ typedef enum { GST_STRUCTURE_CHANGE_TYPE_PAD_LINK = 0, @@ -234,8 +261,6 @@ typedef enum { * * The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the * application of new streaming threads and their status. - * - * Since: 0.10.24 */ typedef enum { GST_STREAM_STATUS_TYPE_CREATE = 0, @@ -258,16 +283,14 @@ typedef enum { * posted on the bus. * * The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the - * application of the status of assynchronous tasks. - * - * Since: 0.10.33 + * application of the status of asynchronous tasks. */ typedef enum { GST_PROGRESS_TYPE_START = 0, GST_PROGRESS_TYPE_CONTINUE = 1, GST_PROGRESS_TYPE_COMPLETE = 2, GST_PROGRESS_TYPE_CANCELED = 3, - GST_PROGRESS_TYPE_ERROR = 4, + GST_PROGRESS_TYPE_ERROR = 4 } GstProgressType; /** @@ -282,17 +305,17 @@ typedef enum { */ struct _GstMessage { - GstMiniObject mini_object; + GstMiniObject mini_object; /*< public > *//* with COW */ - GstMessageType type; - guint64 timestamp; - GstObject *src; - guint32 seqnum; + GstMessageType type; + guint64 timestamp; + GstObject *src; + guint32 seqnum; /*< private >*//* with MESSAGE_LOCK */ - GMutex *lock; /* lock and cond for async delivery */ - GCond *cond; + GMutex lock; /* lock and cond for async delivery */ + GCond cond; }; GType gst_message_get_type (void); @@ -389,9 +412,9 @@ gst_message_copy (const GstMessage * msg) * in some cases), and the reference counts are updated appropriately (the old * message is unreffed, the new one is reffed). * - * Either @new_message or the #GstMessage pointed to by @old_message may be NULL. + * Either @new_message or the #GstMessage pointed to by @old_message may be %NULL. * - * Returns: TRUE if @new_message was different from @old_message + * Returns: %TRUE if @new_message was different from @old_message */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_message_replace (GstMessage **old_message, GstMessage *new_message); @@ -492,10 +515,8 @@ GstMessage * gst_message_new_segment_done (GstObject * src, GstFormat form void gst_message_parse_segment_done (GstMessage *message, GstFormat *format, gint64 *position); -/* DURATION */ -GstMessage * gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration) G_GNUC_MALLOC; -void gst_message_parse_duration (GstMessage *message, GstFormat *format, - gint64 *duration); +/* DURATION_CHANGED */ +GstMessage * gst_message_new_duration_changed (GstObject * src) G_GNUC_MALLOC; /* LATENCY */ GstMessage * gst_message_new_latency (GstObject * src) G_GNUC_MALLOC; @@ -504,8 +525,8 @@ GstMessage * gst_message_new_latency (GstObject * src) G_GNUC_MALLOC; GstMessage * gst_message_new_async_start (GstObject * src) G_GNUC_MALLOC; /* ASYNC_DONE */ -GstMessage * gst_message_new_async_done (GstObject * src, gboolean reset_time) G_GNUC_MALLOC; -void gst_message_parse_async_done (GstMessage *message, gboolean *reset_time); +GstMessage * gst_message_new_async_done (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC; +void gst_message_parse_async_done (GstMessage *message, GstClockTime *running_time); /* STRUCTURE CHANGE */ GstMessage * gst_message_new_structure_change (GstObject * src, GstStructureChangeType type, @@ -552,6 +573,36 @@ GstMessage * gst_message_new_progress (GstObject * src, GstProgress void gst_message_parse_progress (GstMessage * message, GstProgressType * type, gchar ** code, gchar ** text); +/* TOC */ +GstMessage * gst_message_new_toc (GstObject *src, GstToc *toc, gboolean updated); +void gst_message_parse_toc (GstMessage *message, GstToc **toc, gboolean *updated); + +/* RESET_TIME */ +GstMessage * gst_message_new_reset_time (GstObject * src, GstClockTime running_time) G_GNUC_MALLOC; +void gst_message_parse_reset_time (GstMessage *message, GstClockTime *running_time); + +/* STREAM_START */ +GstMessage * gst_message_new_stream_start (GstObject * src) G_GNUC_MALLOC; + +void gst_message_set_group_id (GstMessage *message, guint group_id); +gboolean gst_message_parse_group_id (GstMessage *message, guint *group_id); + +/* NEED_CONTEXT */ +GstMessage * gst_message_new_need_context (GstObject * src, const gchar * context_type) G_GNUC_MALLOC; +gboolean gst_message_parse_context_type (GstMessage * message, const gchar ** context_type); + +/* HAVE_CONTEXT */ +GstMessage * gst_message_new_have_context (GstObject * src, GstContext *context) G_GNUC_MALLOC; +void gst_message_parse_have_context (GstMessage *message, GstContext **context); + +/* DEVICE_ADDED */ +GstMessage * gst_message_new_device_added (GstObject * src, GstDevice * device) G_GNUC_MALLOC; +void gst_message_parse_device_added (GstMessage * message, GstDevice ** device); + +/* DEVICE_REMOVED */ +GstMessage * gst_message_new_device_removed (GstObject * src, GstDevice * device) G_GNUC_MALLOC; +void gst_message_parse_device_removed (GstMessage * message, GstDevice ** device); + G_END_DECLS