/* GStreamer * Copyright (C) 2004 Wim Taymans * * gstmessage.h: Header for GstMessage 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_MESSAGE_H__ #define __GST_MESSAGE_H__ G_BEGIN_DECLS typedef struct _GstMessage GstMessage; /** * GstMessageType: * @GST_MESSAGE_UNKNOWN: an undefined message * @GST_MESSAGE_EOS: end-of-stream reached in a pipeline. The application will * 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 * 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_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 * must PAUSE the pipeline until the buffering completes, when the percentage * field in the message is 100%. For live pipelines, no action must be * performed and the buffering percentage can be used to inform the user about * the progress. * @GST_MESSAGE_STATE_CHANGED: a state change happened * @GST_MESSAGE_STATE_DIRTY: an element changed state in a streaming thread. * This message is deprecated. * @GST_MESSAGE_STEP_DONE: a stepping operation finished. * @GST_MESSAGE_CLOCK_PROVIDE: an element notifies its capability of providing * a clock. This message is used internally and * never forwarded to the application. * @GST_MESSAGE_CLOCK_LOST: The current clock as selected by the pipeline became * unusable. The pipeline will select a new clock on * the next PLAYING state change. The application * should set the pipeline to PAUSED and back to * PLAYING when this message is received. * @GST_MESSAGE_NEW_CLOCK: a new clock was selected in the pipeline. * @GST_MESSAGE_STRUCTURE_CHANGE: the structure of the pipeline changed. This * message is used internally and never forwarded to the application. * @GST_MESSAGE_STREAM_STATUS: status about a stream, emitted when it starts, * stops, errors, etc.. * @GST_MESSAGE_APPLICATION: message posted by the application, possibly * via an application-specific element. * @GST_MESSAGE_ELEMENT: element-specific message, see the specific element's * documentation * @GST_MESSAGE_SEGMENT_START: pipeline started playback of a segment. This * message is used internally and never forwarded to the application. * @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_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. * @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 * @GST_MESSAGE_LATENCY: Posted by elements when their latency changes. The * application should recalculate and distribute a new latency. Since: 0.10.12 * @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 * @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 * @GST_MESSAGE_TOC: A new table of contents (TOC) was found or previously found TOC * was updated. Since: 0.10.37 * @GST_MESSAGE_ANY: mask for all of the above messages. * * The different message types that are available. */ /* NOTE: keep in sync with quark registration in gstmessage.c * NOTE: keep GST_MESSAGE_ANY a valid gint to avoid compiler warnings. */ typedef enum { GST_MESSAGE_UNKNOWN = 0, GST_MESSAGE_EOS = (1 << 0), GST_MESSAGE_ERROR = (1 << 1), GST_MESSAGE_WARNING = (1 << 2), GST_MESSAGE_INFO = (1 << 3), GST_MESSAGE_TAG = (1 << 4), GST_MESSAGE_BUFFERING = (1 << 5), GST_MESSAGE_STATE_CHANGED = (1 << 6), GST_MESSAGE_STATE_DIRTY = (1 << 7), GST_MESSAGE_STEP_DONE = (1 << 8), GST_MESSAGE_CLOCK_PROVIDE = (1 << 9), GST_MESSAGE_CLOCK_LOST = (1 << 10), GST_MESSAGE_NEW_CLOCK = (1 << 11), GST_MESSAGE_STRUCTURE_CHANGE = (1 << 12), GST_MESSAGE_STREAM_STATUS = (1 << 13), GST_MESSAGE_APPLICATION = (1 << 14), GST_MESSAGE_ELEMENT = (1 << 15), GST_MESSAGE_SEGMENT_START = (1 << 16), GST_MESSAGE_SEGMENT_DONE = (1 << 17), GST_MESSAGE_DURATION = (1 << 18), GST_MESSAGE_LATENCY = (1 << 19), GST_MESSAGE_ASYNC_START = (1 << 20), GST_MESSAGE_ASYNC_DONE = (1 << 21), GST_MESSAGE_REQUEST_STATE = (1 << 22), GST_MESSAGE_STEP_START = (1 << 23), GST_MESSAGE_QOS = (1 << 24), GST_MESSAGE_PROGRESS = (1 << 25), GST_MESSAGE_TOC = (1 << 26), GST_MESSAGE_ANY = ~0 } GstMessageType; #include #include #include #include #include #include #include #define GST_TYPE_MESSAGE (gst_message_get_type()) #define GST_IS_MESSAGE(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_MESSAGE)) #define GST_MESSAGE_CAST(obj) ((GstMessage*)(obj)) #define GST_MESSAGE(obj) (GST_MESSAGE_CAST(obj)) /* 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_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_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: * @message: a #GstMessage * * Get the #GstMessageType of @message. */ #define GST_MESSAGE_TYPE(message) (GST_MESSAGE_CAST(message)->type) /** * 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)) /** * GST_MESSAGE_TIMESTAMP: * @message: a #GstMessage * * Get the timestamp of @message. This is the timestamp when the message * was created. */ #define GST_MESSAGE_TIMESTAMP(message) (GST_MESSAGE_CAST(message)->timestamp) /** * GST_MESSAGE_SRC: * @message: a #GstMessage * * Get the object that posted @message. */ #define GST_MESSAGE_SRC(message) (GST_MESSAGE_CAST(message)->src) /** * GST_MESSAGE_SEQNUM: * @message: a #GstMessage * * Get the sequence number of @message. */ #define GST_MESSAGE_SEQNUM(message) (GST_MESSAGE_CAST(message)->seqnum) /** * GST_MESSAGE_SRC_NAME: * @message: a #GstMessage * * 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)") /** * GstStructureChangeType: * @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done. * @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, GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK = 1 } GstStructureChangeType; /** * GstStreamStatusType: * @GST_STREAM_STATUS_TYPE_CREATE: A new thread need to be created. * @GST_STREAM_STATUS_TYPE_ENTER: a thread entered its loop function * @GST_STREAM_STATUS_TYPE_LEAVE: a thread left its loop function * @GST_STREAM_STATUS_TYPE_DESTROY: a thread is destroyed * @GST_STREAM_STATUS_TYPE_START: a thread is started * @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused * @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped * * 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, GST_STREAM_STATUS_TYPE_ENTER = 1, GST_STREAM_STATUS_TYPE_LEAVE = 2, GST_STREAM_STATUS_TYPE_DESTROY = 3, GST_STREAM_STATUS_TYPE_START = 8, GST_STREAM_STATUS_TYPE_PAUSE = 9, GST_STREAM_STATUS_TYPE_STOP = 10 } GstStreamStatusType; /** * GstProgressType: * @GST_PROGRESS_TYPE_START: A new task started. * @GST_PROGRESS_TYPE_CONTINUE: A task completed and a new one continues. * @GST_PROGRESS_TYPE_COMPLETE: A task completed. * @GST_PROGRESS_TYPE_CANCELED: A task was canceled. * @GST_PROGRESS_TYPE_ERROR: A task caused an error. An error message is also * 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 */ 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, } GstProgressType; /** * GstMessage: * @mini_object: the parent structure * @type: the #GstMessageType of the message * @timestamp: the timestamp of the message * @src: the src of the message * @seqnum: the sequence number of the message * * A #GstMessage. */ struct _GstMessage { GstMiniObject mini_object; /*< public > *//* with COW */ GstMessageType type; guint64 timestamp; GstObject *src; guint32 seqnum; /*< private >*//* with MESSAGE_LOCK */ GMutex lock; /* lock and cond for async delivery */ GCond cond; }; GType gst_message_get_type (void); const gchar* gst_message_type_get_name (GstMessageType type); GQuark gst_message_type_to_quark (GstMessageType type); /* refcounting */ /** * gst_message_ref: * @msg: the message to ref * * Convenience macro to increase the reference count of the message. * * Returns: @msg (for convenience when doing assignments) */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg); #endif static inline GstMessage * gst_message_ref (GstMessage * msg) { return (GstMessage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (msg)); } /** * gst_message_unref: * @msg: the message to unref * * Convenience macro to decrease the reference count of the message, possibly * freeing it. */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC void gst_message_unref (GstMessage * msg); #endif static inline void gst_message_unref (GstMessage * msg) { gst_mini_object_unref (GST_MINI_OBJECT_CAST (msg)); } /* copy message */ /** * gst_message_copy: * @msg: the message to copy * * Creates a copy of the message. Returns a copy of the message. * * Returns: (transfer full): a new copy of @msg. * * MT safe */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC GstMessage * gst_message_copy (const GstMessage * msg); #endif static inline GstMessage * gst_message_copy (const GstMessage * msg) { return GST_MESSAGE_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (msg))); } /** * gst_message_is_writable: * @msg: a #GstMessage * * Tests if you can safely write into a message's structure or validly * modify the seqnum and timestamp fields. */ #define gst_message_is_writable(msg) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (msg)) /** * gst_message_make_writable: * @msg: (transfer full): the message to make writable * * Checks if a message is writable. If not, a writable copy is made and * returned. * * Returns: (transfer full): a message (possibly a duplicate) that is writable. * * MT safe */ #define gst_message_make_writable(msg) GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg))) /** * gst_message_replace: * @old_message: (inout) (transfer full): pointer to a pointer to a #GstMessage * to be replaced. * @new_message: (allow-none) (transfer none): pointer to a #GstMessage that will * replace the message pointed to by @old_message. * * Modifies a pointer to a #GstMessage to point to a different #GstMessage. 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 * message is unreffed, the new one is reffed). * * Either @new_message or the #GstMessage pointed to by @old_message may be NULL. * * 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); #endif static inline gboolean gst_message_replace (GstMessage **old_message, GstMessage *new_message) { return gst_mini_object_replace ((GstMiniObject **) old_message, (GstMiniObject *) new_message); } /* custom messages */ GstMessage * gst_message_new_custom (GstMessageType type, GstObject * src, GstStructure * structure) G_GNUC_MALLOC; const GstStructure * gst_message_get_structure (GstMessage *message); gboolean gst_message_has_name (GstMessage *message, const gchar *name); /* identifiers for events and messages */ guint32 gst_message_get_seqnum (GstMessage *message); void gst_message_set_seqnum (GstMessage *message, guint32 seqnum); /* EOS */ GstMessage * gst_message_new_eos (GstObject * src) G_GNUC_MALLOC; /* ERROR */ GstMessage * gst_message_new_error (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC; void gst_message_parse_error (GstMessage *message, GError **gerror, gchar **debug); /* WARNING */ GstMessage * gst_message_new_warning (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC; void gst_message_parse_warning (GstMessage *message, GError **gerror, gchar **debug); /* INFO */ GstMessage * gst_message_new_info (GstObject * src, GError * error, const gchar * debug) G_GNUC_MALLOC; void gst_message_parse_info (GstMessage *message, GError **gerror, gchar **debug); /* TAG */ GstMessage * gst_message_new_tag (GstObject * src, GstTagList * tag_list) G_GNUC_MALLOC; void gst_message_parse_tag (GstMessage *message, GstTagList **tag_list); /* BUFFERING */ GstMessage * gst_message_new_buffering (GstObject * src, gint percent) G_GNUC_MALLOC; void gst_message_parse_buffering (GstMessage *message, gint *percent); void gst_message_set_buffering_stats (GstMessage *message, GstBufferingMode mode, gint avg_in, gint avg_out, gint64 buffering_left); void gst_message_parse_buffering_stats (GstMessage *message, GstBufferingMode *mode, gint *avg_in, gint *avg_out, gint64 *buffering_left); /* STATE_CHANGED */ GstMessage * gst_message_new_state_changed (GstObject * src, GstState oldstate, GstState newstate, GstState pending) G_GNUC_MALLOC; void gst_message_parse_state_changed (GstMessage *message, GstState *oldstate, GstState *newstate, GstState *pending); /* STATE_DIRTY */ GstMessage * gst_message_new_state_dirty (GstObject * src) G_GNUC_MALLOC; /* STEP_DONE */ GstMessage * gst_message_new_step_done (GstObject * src, GstFormat format, guint64 amount, gdouble rate, gboolean flush, gboolean intermediate, guint64 duration, gboolean eos) G_GNUC_MALLOC; void gst_message_parse_step_done (GstMessage * message, GstFormat *format, guint64 *amount, gdouble *rate, gboolean *flush, gboolean *intermediate, guint64 *duration, gboolean *eos); /* CLOCK_PROVIDE */ GstMessage * gst_message_new_clock_provide (GstObject * src, GstClock *clock, gboolean ready) G_GNUC_MALLOC; void gst_message_parse_clock_provide (GstMessage *message, GstClock **clock, gboolean *ready); /* CLOCK_LOST */ GstMessage * gst_message_new_clock_lost (GstObject * src, GstClock *clock) G_GNUC_MALLOC; void gst_message_parse_clock_lost (GstMessage *message, GstClock **clock); /* NEW_CLOCK */ GstMessage * gst_message_new_new_clock (GstObject * src, GstClock *clock) G_GNUC_MALLOC; void gst_message_parse_new_clock (GstMessage *message, GstClock **clock); /* APPLICATION */ GstMessage * gst_message_new_application (GstObject * src, GstStructure * structure) G_GNUC_MALLOC; /* ELEMENT */ GstMessage * gst_message_new_element (GstObject * src, GstStructure * structure) G_GNUC_MALLOC; /* SEGMENT_START */ GstMessage * gst_message_new_segment_start (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC; void gst_message_parse_segment_start (GstMessage *message, GstFormat *format, gint64 *position); /* SEGMENT_DONE */ GstMessage * gst_message_new_segment_done (GstObject * src, GstFormat format, gint64 position) G_GNUC_MALLOC; 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); /* LATENCY */ GstMessage * gst_message_new_latency (GstObject * src) G_GNUC_MALLOC; /* ASYNC_START */ 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); /* STRUCTURE CHANGE */ GstMessage * gst_message_new_structure_change (GstObject * src, GstStructureChangeType type, GstElement *owner, gboolean busy) G_GNUC_MALLOC; void gst_message_parse_structure_change (GstMessage *message, GstStructureChangeType *type, GstElement **owner, gboolean *busy); /* STREAM STATUS */ GstMessage * gst_message_new_stream_status (GstObject * src, GstStreamStatusType type, GstElement *owner) G_GNUC_MALLOC; void gst_message_parse_stream_status (GstMessage *message, GstStreamStatusType *type, GstElement **owner); void gst_message_set_stream_status_object (GstMessage *message, const GValue *object); const GValue * gst_message_get_stream_status_object (GstMessage *message); /* REQUEST_STATE */ GstMessage * gst_message_new_request_state (GstObject * src, GstState state) G_GNUC_MALLOC; void gst_message_parse_request_state (GstMessage * message, GstState *state); /* STEP_START */ GstMessage * gst_message_new_step_start (GstObject * src, gboolean active, GstFormat format, guint64 amount, gdouble rate, gboolean flush, gboolean intermediate) G_GNUC_MALLOC; void gst_message_parse_step_start (GstMessage * message, gboolean *active, GstFormat *format, guint64 *amount, gdouble *rate, gboolean *flush, gboolean *intermediate); /* QOS */ GstMessage * gst_message_new_qos (GstObject * src, gboolean live, guint64 running_time, guint64 stream_time, guint64 timestamp, guint64 duration) G_GNUC_MALLOC; void gst_message_set_qos_values (GstMessage * message, gint64 jitter, gdouble proportion, gint quality); void gst_message_set_qos_stats (GstMessage * message, GstFormat format, guint64 processed, guint64 dropped); void gst_message_parse_qos (GstMessage * message, gboolean * live, guint64 * running_time, guint64 * stream_time, guint64 * timestamp, guint64 * duration); void gst_message_parse_qos_values (GstMessage * message, gint64 * jitter, gdouble * proportion, gint * quality); void gst_message_parse_qos_stats (GstMessage * message, GstFormat * format, guint64 * processed, guint64 * dropped); /* PROGRESS */ GstMessage * gst_message_new_progress (GstObject * src, GstProgressType type, const gchar *code, const gchar *text) G_GNUC_MALLOC; 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); G_END_DECLS #endif /* __GST_MESSAGE_H__ */