*
* 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.
*/
/**
*
* Messages are posted by objects in the pipeline and are passed to the
* application using the #GstBus.
-
+ *
* The basic use pattern of posting a message on a #GstBus is as follows:
*
* <example>
GstStructure *structure;
} GstMessageImpl;
-#define GST_MESSAGE_STRUCTURE(m) (((GstMessageImpl *)(m))->structure)
+#define GST_MESSAGE_STRUCTURE(m) (((GstMessageImpl *)(m))->structure)
typedef struct
{
{GST_MESSAGE_ELEMENT, "element", 0},
{GST_MESSAGE_SEGMENT_START, "segment-start", 0},
{GST_MESSAGE_SEGMENT_DONE, "segment-done", 0},
- {GST_MESSAGE_DURATION, "duration", 0},
+ {GST_MESSAGE_DURATION_CHANGED, "duration-changed", 0},
{GST_MESSAGE_LATENCY, "latency", 0},
{GST_MESSAGE_ASYNC_START, "async-start", 0},
{GST_MESSAGE_ASYNC_DONE, "async-done", 0},
{GST_MESSAGE_STEP_START, "step-start", 0},
{GST_MESSAGE_QOS, "qos", 0},
{GST_MESSAGE_PROGRESS, "progress", 0},
+ {GST_MESSAGE_TOC, "toc", 0},
+ {GST_MESSAGE_RESET_TIME, "reset-time", 0},
+ {GST_MESSAGE_STREAM_START, "stream-start", 0},
{0, NULL, 0}
};
gst_structure_free (structure);
}
- g_slice_free1 (GST_MINI_OBJECT_SIZE (message), message);
+ g_slice_free1 (sizeof (GstMessageImpl), message);
}
static void
-gst_message_init (GstMessageImpl * message, gsize size, GstMessageType type,
+gst_message_init (GstMessageImpl * message, GstMessageType type,
GstObject * src);
static GstMessage *
copy = g_slice_new0 (GstMessageImpl);
- gst_message_init (copy, sizeof (GstMessageImpl), GST_MESSAGE_TYPE (message),
+ gst_message_init (copy, GST_MESSAGE_TYPE (message),
GST_MESSAGE_SRC (message));
GST_MESSAGE_TIMESTAMP (copy) = GST_MESSAGE_TIMESTAMP (message);
}
static void
-gst_message_init (GstMessageImpl * message, gsize size, GstMessageType type,
+gst_message_init (GstMessageImpl * message, GstMessageType type,
GstObject * src)
{
- gst_mini_object_init (GST_MINI_OBJECT_CAST (message), _gst_message_type,
- size);
-
- message->message.mini_object.copy =
- (GstMiniObjectCopyFunction) _gst_message_copy;
- message->message.mini_object.free =
- (GstMiniObjectFreeFunction) _gst_message_free;
+ gst_mini_object_init (GST_MINI_OBJECT_CAST (message), 0, _gst_message_type,
+ (GstMiniObjectCopyFunction) _gst_message_copy, NULL,
+ (GstMiniObjectFreeFunction) _gst_message_free);
GST_MESSAGE_TYPE (message) = type;
if (src)
&message->message.mini_object.refcount))
goto had_parent;
}
- gst_message_init (message, sizeof (GstMessageImpl), type, src);
+ gst_message_init (message, type, src);
GST_MESSAGE_STRUCTURE (message) = structure;
/* ERRORS */
had_parent:
{
- g_slice_free1 (GST_MINI_OBJECT_SIZE (message), message);
+ g_slice_free1 (sizeof (GstMessageImpl), message);
g_warning ("structure is already owned by another object");
return NULL;
}
* Returns: The message's sequence number.
*
* MT safe.
- *
- * Since: 0.10.22
*/
guint32
gst_message_get_seqnum (GstMessage * message)
* for more information.
*
* MT safe.
- *
- * Since: 0.10.22
*/
void
gst_message_set_seqnum (GstMessage * message, guint32 seqnum)
* MT safe.
*
* Returns: (transfer full): the new info message.
- *
- * Since: 0.10.12
*/
GstMessage *
gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
GstMessage *
gst_message_new_tag (GstObject * src, GstTagList * tag_list)
{
+ GstStructure *s;
GstMessage *message;
+ GValue val = G_VALUE_INIT;
- g_return_val_if_fail (GST_IS_STRUCTURE (tag_list), NULL);
-
- message =
- gst_message_new_custom (GST_MESSAGE_TAG, src, (GstStructure *) tag_list);
+ g_return_val_if_fail (GST_IS_TAG_LIST (tag_list), NULL);
+ s = gst_structure_new_id_empty (GST_QUARK (MESSAGE_TAG));
+ g_value_init (&val, GST_TYPE_TAG_LIST);
+ g_value_take_boxed (&val, tag_list);
+ gst_structure_id_take_value (s, GST_QUARK (TAGLIST), &val);
+ message = gst_message_new_custom (GST_MESSAGE_TAG, src, s);
return message;
}
* The application must be prepared to receive BUFFERING messages in the
* PREROLLING state and may only set the pipeline to PLAYING after receiving a
* message with @percent set to 100, which can happen after the pipeline
- * completed prerolling.
+ * completed prerolling.
*
* MT safe.
*
* Returns: (transfer full): The new buffering message.
- *
- * Since: 0.10.11
*/
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
{
GstMessage *message;
GstStructure *structure;
+ gint64 buffering_left;
g_return_val_if_fail (percent >= 0 && percent <= 100, NULL);
+ buffering_left = (percent == 100 ? 0 : -1);
+
structure = gst_structure_new_id (GST_QUARK (MESSAGE_BUFFERING),
GST_QUARK (BUFFER_PERCENT), G_TYPE_INT, percent,
GST_QUARK (BUFFERING_MODE), GST_TYPE_BUFFERING_MODE, GST_BUFFERING_STREAM,
GST_QUARK (AVG_IN_RATE), G_TYPE_INT, -1,
GST_QUARK (AVG_OUT_RATE), G_TYPE_INT, -1,
- GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, G_GINT64_CONSTANT (-1),
- GST_QUARK (ESTIMATED_TOTAL), G_TYPE_INT64, G_GINT64_CONSTANT (-1), NULL);
+ GST_QUARK (BUFFERING_LEFT), G_TYPE_INT64, buffering_left, NULL);
message = gst_message_new_custom (GST_MESSAGE_BUFFERING, src, structure);
return message;
GstMessage *message;
GstStructure *structure;
- structure = gst_structure_new_id (GST_QUARK (MESSAGE_STATE),
+ structure = gst_structure_new_id (GST_QUARK (MESSAGE_STATE_CHANGED),
GST_QUARK (OLD_STATE), GST_TYPE_STATE, (gint) oldstate,
GST_QUARK (NEW_STATE), GST_TYPE_STATE, (gint) newstate,
GST_QUARK (PENDING_STATE), GST_TYPE_STATE, (gint) pending, NULL);
* Returns: (transfer full): the new structure change message.
*
* MT safe.
- *
- * Since: 0.10.22.
*/
GstMessage *
gst_message_new_structure_change (GstObject * src, GstStructureChangeType type,
}
/**
- * gst_message_new_duration:
+ * gst_message_new_duration_changed:
* @src: (transfer none): The object originating the message.
- * @format: The format of the duration
- * @duration: The new duration
*
- * Create a new duration message. This message is posted by elements that
- * know the duration of a stream in a specific format. This message
+ * Create a new duration changed message. This message is posted by elements
+ * that know the duration of a stream when the duration changes. This message
* is received by bins and is used to calculate the total duration of a
* pipeline. Elements may post a duration message with a duration of
* GST_CLOCK_TIME_NONE to indicate that the duration has changed and the
* cached duration should be discarded. The new duration can then be
* retrieved via a query.
*
- * Returns: (transfer full): The new duration message.
+ * Returns: (transfer full): The new duration-changed message.
*
* MT safe.
*/
GstMessage *
-gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration)
+gst_message_new_duration_changed (GstObject * src)
{
GstMessage *message;
- GstStructure *structure;
- structure = gst_structure_new_id (GST_QUARK (MESSAGE_DURATION),
- GST_QUARK (FORMAT), GST_TYPE_FORMAT, format,
- GST_QUARK (DURATION), G_TYPE_INT64, duration, NULL);
- message = gst_message_new_custom (GST_MESSAGE_DURATION, src, structure);
+ message = gst_message_new_custom (GST_MESSAGE_DURATION_CHANGED, src,
+ gst_structure_new_id_empty (GST_QUARK (MESSAGE_DURATION_CHANGED)));
return message;
}
/**
* gst_message_new_async_done:
* @src: (transfer none): The object originating the message.
- * @reset_time: if the running_time should be reset
+ * @running_time: the desired running_time
*
* The message is posted when elements completed an ASYNC state change.
- * @reset_time is set to TRUE when the element requests a new running_time
- * before going to PLAYING.
+ * @running_time contains the time of the desired running_time when this
+ * elements goes to PLAYING. A value of #GST_CLOCK_TIME_NONE for @running_time
+ * means that the element has no clock interaction and thus doesn't care about
+ * the running_time of the pipeline.
*
* Returns: (transfer full): The new async_done message.
*
* MT safe.
*/
GstMessage *
-gst_message_new_async_done (GstObject * src, gboolean reset_time)
+gst_message_new_async_done (GstObject * src, GstClockTime running_time)
{
GstMessage *message;
GstStructure *structure;
structure = gst_structure_new_id (GST_QUARK (MESSAGE_ASYNC_DONE),
- GST_QUARK (RESET_TIME), G_TYPE_BOOLEAN, reset_time, NULL);
+ GST_QUARK (RUNNING_TIME), G_TYPE_UINT64, running_time, NULL);
message = gst_message_new_custom (GST_MESSAGE_ASYNC_DONE, src, structure);
return message;
* Returns: (transfer full): The new latency message.
*
* MT safe.
- *
- * Since: 0.10.12
*/
GstMessage *
gst_message_new_latency (GstObject * src)
* Returns: (transfer full): the new requst state message.
*
* MT safe.
- *
- * Since: 0.10.23
*/
GstMessage *
gst_message_new_request_state (GstObject * src, GstState state)
* check the name of a custom message.
*
* Returns: %TRUE if @name matches the name of the message structure.
- *
- * Since: 0.10.20
*/
gboolean
gst_message_has_name (GstMessage * message, const gchar * name)
* gst_message_parse_tag (msg, &tags);
* g_print ("Got tags from element %s\n", GST_OBJECT_NAME (msg->src));
* handle_tags (tags);
- * gst_tag_list_free (tags);
+ * gst_tag_list_unref (tags);
* break;
* }
* ...
void
gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
{
- GstStructure *ret;
-
g_return_if_fail (GST_IS_MESSAGE (message));
g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TAG);
g_return_if_fail (tag_list != NULL);
- ret = gst_structure_copy (GST_MESSAGE_STRUCTURE (message));
- gst_structure_remove_field (ret, "source-pad");
-
- *tag_list = (GstTagList *) ret;
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (TAGLIST), GST_TYPE_TAG_LIST, tag_list, NULL);
}
/**
* gst_message_new_buffering().
*
* MT safe.
- *
- * Since: 0.10.11
*/
void
gst_message_parse_buffering (GstMessage * message, gint * percent)
* @buffering_left: amount of buffering time left in milliseconds
*
* Configures the buffering stats values in @message.
- *
- * Since: 0.10.20
*/
void
gst_message_set_buffering_stats (GstMessage * message, GstBufferingMode mode,
* milliseconds, or NULL
*
* Extracts the buffering stats values from @message.
- *
- * Since: 0.10.20
*/
void
gst_message_parse_buffering_stats (GstMessage * message,
* Extracts the change type and completion status from the GstMessage.
*
* MT safe.
- *
- * Since: 0.10.22
*/
void
gst_message_parse_structure_change (GstMessage * message,
void
gst_message_parse_error (GstMessage * message, GError ** gerror, gchar ** debug)
{
- const GValue *error_gvalue;
- GError *error_val;
- GstStructure *structure;
-
g_return_if_fail (GST_IS_MESSAGE (message));
g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_ERROR);
- structure = GST_MESSAGE_STRUCTURE (message);
- error_gvalue = gst_structure_id_get_value (structure, GST_QUARK (GERROR));
- g_return_if_fail (error_gvalue != NULL);
- g_return_if_fail (G_VALUE_TYPE (error_gvalue) == G_TYPE_ERROR);
-
- error_val = (GError *) g_value_get_boxed (error_gvalue);
- if (error_val)
- *gerror = g_error_copy (error_val);
- else
- *gerror = NULL;
-
- if (debug)
- *debug =
- g_value_dup_string (gst_structure_id_get_value (structure,
- GST_QUARK (DEBUG)));
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (GERROR), G_TYPE_ERROR, gerror,
+ GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
}
/**
gst_message_parse_warning (GstMessage * message, GError ** gerror,
gchar ** debug)
{
- const GValue *error_gvalue;
- GError *error_val;
- GstStructure *structure;
-
g_return_if_fail (GST_IS_MESSAGE (message));
g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_WARNING);
- structure = GST_MESSAGE_STRUCTURE (message);
- error_gvalue = gst_structure_id_get_value (structure, GST_QUARK (GERROR));
- g_return_if_fail (error_gvalue != NULL);
- g_return_if_fail (G_VALUE_TYPE (error_gvalue) == G_TYPE_ERROR);
-
- error_val = (GError *) g_value_get_boxed (error_gvalue);
- if (error_val)
- *gerror = g_error_copy (error_val);
- else
- *gerror = NULL;
-
- if (debug)
- *debug =
- g_value_dup_string (gst_structure_id_get_value (structure,
- GST_QUARK (DEBUG)));
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (GERROR), G_TYPE_ERROR, gerror,
+ GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
}
/**
* in the output arguments are copies; the caller must free them when done.
*
* MT safe.
- *
- * Since: 0.10.12
*/
void
gst_message_parse_info (GstMessage * message, GError ** gerror, gchar ** debug)
{
- const GValue *error_gvalue;
- GError *error_val;
- GstStructure *structure;
-
g_return_if_fail (GST_IS_MESSAGE (message));
g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_INFO);
- structure = GST_MESSAGE_STRUCTURE (message);
- error_gvalue = gst_structure_id_get_value (structure, GST_QUARK (GERROR));
- g_return_if_fail (error_gvalue != NULL);
- g_return_if_fail (G_VALUE_TYPE (error_gvalue) == G_TYPE_ERROR);
-
- error_val = (GError *) g_value_get_boxed (error_gvalue);
- if (error_val)
- *gerror = g_error_copy (error_val);
- else
- *gerror = NULL;
-
- if (debug)
- *debug =
- g_value_dup_string (gst_structure_id_get_value (structure,
- GST_QUARK (DEBUG)));
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (GERROR), G_TYPE_ERROR, gerror,
+ GST_QUARK (DEBUG), G_TYPE_STRING, debug, NULL);
}
/**
* gst_message_parse_segment_start:
* @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START.
- * @format: (out): Result location for the format, or NULL
- * @position: (out): Result location for the position, or NULL
+ * @format: (out) (allow-none): Result location for the format, or NULL
+ * @position: (out) (allow-none): Result location for the position, or NULL
*
* Extracts the position and format from the segment start message.
*
/**
* gst_message_parse_segment_done:
* @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE.
- * @format: (out): Result location for the format, or NULL
- * @position: (out): Result location for the position, or NULL
+ * @format: (out) (allow-none): Result location for the format, or NULL
+ * @position: (out) (allow-none): Result location for the position, or NULL
*
- * Extracts the position and format from the segment start message.
+ * Extracts the position and format from the segment done message.
*
* MT safe.
*/
}
/**
- * gst_message_parse_duration:
- * @message: A valid #GstMessage of type GST_MESSAGE_DURATION.
- * @format: (out): Result location for the format, or NULL
- * @duration: (out): Result location for the duration, or NULL
- *
- * Extracts the duration and format from the duration message. The duration
- * might be GST_CLOCK_TIME_NONE, which indicates that the duration has
- * changed. Applications should always use a query to retrieve the duration
- * of a pipeline.
- *
- * MT safe.
- */
-void
-gst_message_parse_duration (GstMessage * message, GstFormat * format,
- gint64 * duration)
-{
- GstStructure *structure;
-
- g_return_if_fail (GST_IS_MESSAGE (message));
- g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_DURATION);
-
- structure = GST_MESSAGE_STRUCTURE (message);
- if (format)
- *format = (GstFormat)
- g_value_get_enum (gst_structure_id_get_value (structure,
- GST_QUARK (FORMAT)));
- if (duration)
- *duration =
- g_value_get_int64 (gst_structure_id_get_value (structure,
- GST_QUARK (DURATION)));
-}
-
-/**
* gst_message_parse_async_done:
* @message: A valid #GstMessage of type GST_MESSAGE_ASYNC_DONE.
- * @reset_time: (out): Result location for the reset_time or NULL
+ * @running_time: (out) (allow-none): Result location for the running_time or NULL
*
- * Extract the reset_time from the async_done message.
+ * Extract the running_time from the async_done message.
*
* MT safe.
*/
void
-gst_message_parse_async_done (GstMessage * message, gboolean * reset_time)
+gst_message_parse_async_done (GstMessage * message, GstClockTime * running_time)
{
GstStructure *structure;
g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_ASYNC_DONE);
structure = GST_MESSAGE_STRUCTURE (message);
- if (reset_time)
- *reset_time =
- g_value_get_boolean (gst_structure_id_get_value (structure,
- GST_QUARK (RESET_TIME)));
+ if (running_time)
+ *running_time =
+ g_value_get_uint64 (gst_structure_id_get_value (structure,
+ GST_QUARK (RUNNING_TIME)));
}
/**
* gst_message_parse_request_state:
* @message: A valid #GstMessage of type GST_MESSAGE_REQUEST_STATE.
- * @state: (out): Result location for the requested state or NULL
+ * @state: (out) (allow-none): Result location for the requested state or NULL
*
* Extract the requested state from the request_state message.
*
* MT safe.
- *
- * Since: 0.10.23
*/
void
gst_message_parse_request_state (GstMessage * message, GstState * state)
* Returns: (transfer full): the new stream status message.
*
* MT safe.
- *
- * Since: 0.10.24.
*/
GstMessage *
gst_message_new_stream_status (GstObject * src, GstStreamStatusType type,
* should thus not be unreffed.
*
* MT safe.
- *
- * Since: 0.10.24.
*/
void
gst_message_parse_stream_status (GstMessage * message,
*
* Configures the object handling the streaming thread. This is usually a
* GstTask object but other objects might be added in the future.
- *
- * Since: 0.10.24
*/
void
gst_message_set_stream_status_object (GstMessage * message,
* Returns: a GValue containing the object that manages the streaming thread.
* This object is usually of type GstTask but other types can be added in the
* future. The object remains valid as long as @message is valid.
- *
- * Since: 0.10.24
*/
const GValue *
gst_message_get_stream_status_object (GstMessage * message)
* Returns: (transfer full): the new step_done message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
GstMessage *
gst_message_new_step_done (GstObject * src, GstFormat format, guint64 amount,
* Extract the values the step_done message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_message_parse_step_done (GstMessage * message, GstFormat * format,
* Returns: (transfer full): The new step_start message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
GstMessage *
gst_message_new_step_start (GstObject * src, gboolean active, GstFormat format,
* Extract the values from step_start message.
*
* MT safe.
- *
- * Since: 0.10.24
*/
void
gst_message_parse_step_start (GstMessage * message, gboolean * active,
* Returns: (transfer full): The new qos message.
*
* MT safe.
- *
- * Since: 0.10.29
*/
GstMessage *
gst_message_new_qos (GstObject * src, gboolean live, guint64 running_time,
* Set the QoS values that have been calculated/analysed from the QoS data
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_set_qos_values (GstMessage * message, gint64 jitter,
* invalid. Values of -1 for either @processed or @dropped mean unknown values.
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_set_qos_stats (GstMessage * message, GstFormat format,
* values.
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_parse_qos (GstMessage * message, gboolean * live,
* Extract the QoS values that have been calculated/analysed from the QoS data
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_parse_qos_values (GstMessage * message, gint64 * jitter,
* invalid. Values of -1 for either @processed or @dropped mean unknown values.
*
* MT safe.
- *
- * Since: 0.10.29
*/
void
gst_message_parse_qos_stats (GstMessage * message, GstFormat * format,
* @test should contain a user visible string detailing the current action.
*
* Returns: (transfer full): The new qos message.
- *
- * Since: 0.10.33
*/
GstMessage *
gst_message_new_progress (GstObject * src, GstProgressType type,
* @text: (out) (allow-none) (transfer full): location for the text
*
* Parses the progress @type, @code and @text.
- *
- * Since: 0.10.33
*/
void
gst_message_parse_progress (GstMessage * message, GstProgressType * type,
GST_QUARK (CODE), G_TYPE_STRING, code,
GST_QUARK (TEXT), G_TYPE_STRING, text, NULL);
}
+
+/**
+ * gst_message_new_toc:
+ * @src: the object originating the message.
+ * @toc: (transfer none): #GstToc structure for the message.
+ * @updated: whether TOC was updated or not.
+ *
+ * Create a new TOC message. The message is posted by elements
+ * that discovered or updated a TOC.
+ *
+ * Returns: (transfer full): a new TOC message.
+ *
+ * MT safe.
+ */
+GstMessage *
+gst_message_new_toc (GstObject * src, GstToc * toc, gboolean updated)
+{
+ GstStructure *toc_struct;
+
+ g_return_val_if_fail (toc != NULL, NULL);
+
+ toc_struct = gst_structure_new_id (GST_QUARK (MESSAGE_TOC),
+ GST_QUARK (TOC), GST_TYPE_TOC, toc,
+ GST_QUARK (UPDATED), G_TYPE_BOOLEAN, updated, NULL);
+
+ return gst_message_new_custom (GST_MESSAGE_TOC, src, toc_struct);
+}
+
+/**
+ * gst_message_parse_toc:
+ * @message: a valid #GstMessage of type GST_MESSAGE_TOC.
+ * @toc: (out) (transfer full): return location for the TOC.
+ * @updated: (out): return location for the updated flag.
+ *
+ * Extract thef TOC from the #GstMessage. The TOC returned in the
+ * output argument is a copy; the caller must free it with
+ * gst_toc_unref() when done.
+ *
+ * MT safe.
+ */
+void
+gst_message_parse_toc (GstMessage * message, GstToc ** toc, gboolean * updated)
+{
+ g_return_if_fail (GST_IS_MESSAGE (message));
+ g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_TOC);
+ g_return_if_fail (toc != NULL);
+
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (TOC), GST_TYPE_TOC, toc,
+ GST_QUARK (UPDATED), G_TYPE_BOOLEAN, updated, NULL);
+}
+
+/**
+ * gst_message_new_reset_time:
+ * @src: (transfer none): The object originating the message.
+ * @running_time: the requested running-time
+ *
+ * This message is posted when the pipeline running-time should be reset to
+ * @running_time, like after a flushing seek.
+ *
+ * Returns: (transfer full): The new reset_time message.
+ *
+ * MT safe.
+ */
+GstMessage *
+gst_message_new_reset_time (GstObject * src, GstClockTime running_time)
+{
+ GstMessage *message;
+ GstStructure *structure;
+
+ structure = gst_structure_new_id (GST_QUARK (MESSAGE_RESET_TIME),
+ GST_QUARK (RUNNING_TIME), G_TYPE_UINT64, running_time, NULL);
+ message = gst_message_new_custom (GST_MESSAGE_RESET_TIME, src, structure);
+
+ return message;
+}
+
+/**
+ * gst_message_parse_reset_time:
+ * @message: A valid #GstMessage of type GST_MESSAGE_RESET_TIME.
+ * @running_time: (out) (allow-none): Result location for the running_time or
+ * NULL
+ *
+ * Extract the running-time from the RESET_TIME message.
+ *
+ * MT safe.
+ */
+void
+gst_message_parse_reset_time (GstMessage * message, GstClockTime * running_time)
+{
+ GstStructure *structure;
+
+ g_return_if_fail (GST_IS_MESSAGE (message));
+ g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_RESET_TIME);
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+ if (running_time)
+ *running_time =
+ g_value_get_uint64 (gst_structure_id_get_value (structure,
+ GST_QUARK (RUNNING_TIME)));
+}
+
+/**
+ * gst_message_new_stream_start:
+ * @src: (transfer none): The object originating the message.
+ *
+ * Create a new stream_start message. This message is generated and posted in
+ * the sink elements of a GstBin. The bin will only forward the STREAM_START
+ * message to the application if all sinks have posted an STREAM_START message.
+ *
+ * Returns: (transfer full): The new stream_start message.
+ *
+ * MT safe.
+ */
+GstMessage *
+gst_message_new_stream_start (GstObject * src)
+{
+ GstMessage *message;
+ GstStructure *s;
+
+ s = gst_structure_new_id_empty (GST_QUARK (MESSAGE_STREAM_START));
+ message = gst_message_new_custom (GST_MESSAGE_STREAM_START, src, s);
+
+ return message;
+}
+
+
+/**
+ * gst_message_set_group_id:
+ * @message: the message
+ * @group_id: the group id
+ *
+ * Sets the group id on the stream-start message.
+ *
+ * All streams that have the same group id are supposed to be played
+ * together, i.e. all streams inside a container file should have the
+ * same group id but different stream ids. The group id should change
+ * each time the stream is started, resulting in different group ids
+ * each time a file is played for example.
+ *
+ * MT safe.
+ *
+ * Since: 1.2
+ */
+void
+gst_message_set_group_id (GstMessage * message, guint group_id)
+{
+ GstStructure *structure;
+
+ g_return_if_fail (GST_IS_MESSAGE (message));
+ g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STREAM_START);
+ g_return_if_fail (gst_message_is_writable (message));
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+ gst_structure_id_set (structure, GST_QUARK (GROUP_ID), G_TYPE_UINT, group_id,
+ NULL);
+}
+
+/**
+ * gst_message_parse_group_id:
+ * @message: A valid #GstMessage of type GST_MESSAGE_STREAM_START.
+ * @group_id: (out) (allow-none): Result location for the group id or
+ * NULL
+ *
+ * Extract the group from the STREAM_START message.
+ *
+ * Returns: %TRUE if the message had a group id set, %FALSE otherwise
+ *
+ * MT safe.
+ *
+ * Since: 1.2
+ */
+gboolean
+gst_message_parse_group_id (GstMessage * message, guint * group_id)
+{
+ GstStructure *structure;
+ const GValue *v;
+
+ g_return_val_if_fail (GST_IS_MESSAGE (message), FALSE);
+ g_return_val_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_STREAM_START,
+ FALSE);
+
+ if (!group_id)
+ return TRUE;
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+
+ v = gst_structure_id_get_value (structure, GST_QUARK (GROUP_ID));
+ if (!v)
+ return FALSE;
+
+ *group_id = g_value_get_uint (v);
+ return TRUE;
+}
+
+/**
+ * gst_message_new_need_context:
+ * @src: (transfer none): The object originating the message.
+ *
+ * This message is posted when an element needs a specific #GstContext.
+ *
+ * Returns: (transfer full): The new need-context message.
+ *
+ * MT safe.
+ *
+ * Since: 1.2
+ */
+GstMessage *
+gst_message_new_need_context (GstObject * src)
+{
+ GstMessage *message;
+ GstStructure *structure;
+
+ structure = gst_structure_new_id_empty (GST_QUARK (MESSAGE_NEED_CONTEXT));
+ message = gst_message_new_custom (GST_MESSAGE_NEED_CONTEXT, src, structure);
+
+ return message;
+}
+
+static GArray *
+ensure_array (GstStructure * s, GQuark quark, gsize element_size,
+ GDestroyNotify clear_func)
+{
+ GArray *array;
+ const GValue *value;
+
+ value = gst_structure_id_get_value (s, quark);
+ if (value) {
+ array = (GArray *) g_value_get_boxed (value);
+ } else {
+ GValue new_array_val = { 0, };
+
+ array = g_array_new (FALSE, TRUE, element_size);
+ if (clear_func)
+ g_array_set_clear_func (array, clear_func);
+
+ g_value_init (&new_array_val, G_TYPE_ARRAY);
+ g_value_take_boxed (&new_array_val, array);
+
+ gst_structure_id_take_value (s, quark, &new_array_val);
+ }
+ return array;
+}
+
+static void
+free_array_string (gpointer ptr)
+{
+ gchar *str = *(gchar **) ptr;
+ g_free (str);
+}
+
+/**
+ * gst_message_add_context_type:
+ * @message: a GST_MESSAGE_NEED_CONTEXT type message
+ * @context_type: a context type
+ *
+ * Add a new context type to @message.
+ *
+ * Since: 1.2
+ */
+void
+gst_message_add_context_type (GstMessage * message, const gchar * context_type)
+{
+ GstStructure *structure;
+ GArray *array;
+ gchar *copy;
+
+ g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_NEED_CONTEXT);
+ g_return_if_fail (gst_message_is_writable (message));
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+ array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
+ sizeof (gchar *), free_array_string);
+
+ copy = g_strdup (context_type);
+ g_array_append_val (array, copy);
+}
+
+/**
+ * gst_message_get_n_context_types:
+ * @message: a GST_MESSAGE_NEED_CONTEXT type message
+ *
+ * Retrieve the number of values currently stored in the
+ * context-types array of the message's structure.
+ *
+ * Returns: the context-types array size as a #guint.
+ *
+ * Since: 1.2
+ */
+guint
+gst_message_get_n_context_types (GstMessage * message)
+{
+ GstStructure *structure;
+ GArray *array;
+
+ g_return_val_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_NEED_CONTEXT,
+ 0);
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+ array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
+ sizeof (gchar *), free_array_string);
+
+ return array->len;
+}
+
+/**
+ * gst_message_parse_nth_context_type:
+ * @message: a GST_MESSAGE_NEED_CONTEXT type message
+ * @context_type: (out) (allow-none): the context type, or NULL
+ *
+ * Parse a context type from an existing GST_MESSAGE_NEED_CONTEXT message
+ * from @index.
+ *
+ * Returns: a #gboolean indicating if the parsing succeeded.
+ *
+ * Since: 1.2
+ */
+gboolean
+gst_message_parse_nth_context_type (GstMessage * message, guint index,
+ const gchar ** context_type)
+{
+ GstStructure *structure;
+ GArray *array;
+
+ g_return_val_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_NEED_CONTEXT,
+ FALSE);
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+
+ array = ensure_array (structure, GST_QUARK (CONTEXT_TYPES),
+ sizeof (gchar *), free_array_string);
+ g_return_val_if_fail (index < array->len, FALSE);
+
+ if (context_type)
+ *context_type = g_array_index (array, gchar *, index);
+
+ return TRUE;
+}
+
+/**
+ * gst_message_new_have_context:
+ * @src: (transfer none): The object originating the message.
+ * @context: (transfer full): the context
+ *
+ * This message is posted when an element has a new local #GstContext.
+ *
+ * Returns: (transfer full): The new have-context message.
+ *
+ * MT safe.
+ *
+ * Since: 1.2
+ */
+GstMessage *
+gst_message_new_have_context (GstObject * src, GstContext * context)
+{
+ GstMessage *message;
+ GstStructure *structure;
+
+ structure = gst_structure_new_id (GST_QUARK (MESSAGE_HAVE_CONTEXT),
+ GST_QUARK (CONTEXT), GST_TYPE_CONTEXT, context, NULL);
+ message = gst_message_new_custom (GST_MESSAGE_HAVE_CONTEXT, src, structure);
+ gst_context_unref (context);
+
+ return message;
+}
+
+/**
+ * gst_message_parse_have_context:
+ * @message: A valid #GstMessage of type GST_MESSAGE_HAVE_CONTEXT.
+ * @context: (out) (transfer full) (allow-none): Result location for the
+ * context or NULL
+ *
+ * Extract the context from the HAVE_CONTEXT message.
+ *
+ * MT safe.
+ *
+ * Since: 1.2
+ */
+void
+gst_message_parse_have_context (GstMessage * message, GstContext ** context)
+{
+ g_return_if_fail (GST_IS_MESSAGE (message));
+ g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_HAVE_CONTEXT);
+
+ if (context)
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (CONTEXT), GST_TYPE_CONTEXT, context, NULL);
+}
projects / platform / upstream / gstreamer.git / blobdiff