/**
* SECTION:gstmessage
+ * @title: GstMessage
* @short_description: Lightweight objects to signal the application of
* pipeline events
* @see_also: #GstBus, #GstMiniObject, #GstElement
{GST_MESSAGE_HAVE_CONTEXT, "have-context", 0},
{GST_MESSAGE_DEVICE_ADDED, "device-added", 0},
{GST_MESSAGE_DEVICE_REMOVED, "device-removed", 0},
+ {GST_MESSAGE_DEVICE_CHANGED, "device-changed", 0},
{GST_MESSAGE_PROPERTY_NOTIFY, "property-notify", 0},
{GST_MESSAGE_STREAM_COLLECTION, "stream-collection", 0},
{GST_MESSAGE_STREAMS_SELECTED, "streams-selected", 0},
gst_structure_set_parent_refcount (structure, NULL);
gst_structure_free (structure);
}
+#ifdef USE_POISONING
+ memset (message, 0xff, sizeof (GstMessageImpl));
+#endif
g_slice_free1 (sizeof (GstMessageImpl), message);
}
* handled by other message-specific functions to pass a message to the
* app. The structure field can be %NULL.
*
- * Returns: (transfer full): The new message.
+ * Returns: (transfer full) (nullable): The new message.
*
* MT safe.
*/
gst_message_set_seqnum (GstMessage * message, guint32 seqnum)
{
g_return_if_fail (GST_IS_MESSAGE (message));
+ g_return_if_fail (seqnum != GST_SEQNUM_INVALID);
GST_MESSAGE_SEQNUM (message) = seqnum;
}
* @src: (transfer none) (allow-none): The object originating the message.
* @error: (transfer none): The GError for this message.
* @debug: A debugging string.
- * @details: (transfer full): (allow-none): A GstStructure with details
+ * @details: (transfer full) (allow-none): A GstStructure with details
*
* Create a new error message. The message will copy @error and
* @debug. This message is posted by element when a fatal event
* occurred. The pipeline will probably (partially) stop. The application
* receiving this message should stop the pipeline.
*
- * Returns: (transfer full): the new error message.
+ * Returns: (transfer full) (nullable): the new error message.
*
* Since: 1.10
*/
GstMessage *message;
GstStructure *structure;
- if (!g_utf8_validate (debug, -1, NULL)) {
+ if (debug && !g_utf8_validate (debug, -1, NULL)) {
debug = NULL;
g_warning ("Trying to set debug field of error message, but "
"string is not valid UTF-8. Please file a bug.");
/**
* gst_message_parse_error_details:
* @message: The message object
- * @structure: (out): A pointer to the returned details
+ * @structure: (transfer none) (out): A pointer to the returned details
*
* Returns the optional details structure, may be NULL if none.
* The returned structure must not be freed.
* @src: (transfer none) (allow-none): The object originating the message.
* @error: (transfer none): The GError for this message.
* @debug: A debugging string.
- * @details: (transfer full): (allow-none): A GstStructure with details
+ * @details: (transfer full) (allow-none): A GstStructure with details
*
* Create a new warning message. The message will make copies of @error and
* @debug.
*
- * Returns: (transfer full): the new warning message.
+ * Returns: (transfer full) (nullable): the new warning message.
*
* Since: 1.10
*/
GstMessage *message;
GstStructure *structure;
- if (!g_utf8_validate (debug, -1, NULL)) {
+ if (debug && !g_utf8_validate (debug, -1, NULL)) {
debug = NULL;
g_warning ("Trying to set debug field of warning message, but "
"string is not valid UTF-8. Please file a bug.");
/**
* gst_message_parse_warning_details:
* @message: The message object
- * @structure: (out): A pointer to the returned details structure
+ * @structure: (transfer none) (out): A pointer to the returned details structure
*
* Returns the optional details structure, may be NULL if none
* The returned structure must not be freed.
* @src: (transfer none) (allow-none): The object originating the message.
* @error: (transfer none): The GError for this message.
* @debug: A debugging string.
- * @details: (transfer full): (allow-none): A GstStructure with details
+ * @details: (transfer full) (allow-none): A GstStructure with details
*
* Create a new info message. The message will make copies of @error and
* @debug.
*
- * Returns: (transfer full): the new warning message.
+ * Returns: (transfer full) (nullable): the new warning message.
*
* Since: 1.10
*/
GstMessage *message;
GstStructure *structure;
- if (!g_utf8_validate (debug, -1, NULL)) {
+ if (debug && !g_utf8_validate (debug, -1, NULL)) {
debug = NULL;
g_warning ("Trying to set debug field of info message, but "
"string is not valid UTF-8. Please file a bug.");
/**
* gst_message_parse_info_details:
* @message: The message object
- * @structure: (out): A pointer to the returned details structure
+ * @structure: (transfer none) (out): A pointer to the returned details structure
*
* Returns the optional details structure, may be NULL if none
* The returned structure must not be freed.
*
* MT safe.
*
- * Returns: (transfer full): The new buffering message.
+ * Returns: (transfer full) (nullable): The new buffering message.
*/
GstMessage *
gst_message_new_buffering (GstObject * src, gint percent)
* Create a new application-typed message. GStreamer will never create these
* messages; they are a gift from us to you. Enjoy.
*
- * Returns: (transfer full): The new application message.
+ * Returns: (transfer full) (nullable): The new application message.
*
* MT safe.
*/
* "the firewire cable was unplugged". The format of the message should be
* documented in the element's documentation. The structure field can be %NULL.
*
- * Returns: (transfer full): The new element message.
+ * Returns: (transfer full) (nullable): The new element message.
*
* MT safe.
*/
*
* Access the structure of the message.
*
- * Returns: (transfer none): The structure of the message. The structure is
- * still owned by the message, which means that you should not free it and
- * that the pointer becomes invalid when you free the message.
+ * Returns: (transfer none) (nullable): The structure of the message. The
+ * structure is still owned by the message, which means that you should not
+ * free it and that the pointer becomes invalid when you free the message.
*
* MT safe.
*/
}
/**
+ * gst_message_writable_structure:
+ * @message: The #GstMessage.
+ *
+ * Get a writable version of the structure.
+ *
+ * Returns: (transfer none): The structure of the message. The structure
+ * is still owned by the message, which means that you should not free
+ * it and that the pointer becomes invalid when you free the message.
+ * This function checks if @message is writable and will never return
+ * %NULL.
+ *
+ * MT safe.
+ *
+ * Since: 1.14
+ */
+GstStructure *
+gst_message_writable_structure (GstMessage * message)
+{
+ GstStructure *structure;
+
+ g_return_val_if_fail (GST_IS_MESSAGE (message), NULL);
+ g_return_val_if_fail (gst_message_is_writable (message), NULL);
+
+ structure = GST_MESSAGE_STRUCTURE (message);
+
+ if (structure == NULL) {
+ structure =
+ gst_structure_new_id_empty (gst_message_type_to_quark (GST_MESSAGE_TYPE
+ (message)));
+ gst_structure_set_parent_refcount (structure,
+ &message->mini_object.refcount);
+ GST_MESSAGE_STRUCTURE (message) = structure;
+ }
+ return structure;
+}
+
+/**
* gst_message_has_name:
* @message: The #GstMessage.
* @name: name to check
* switch (GST_MESSAGE_TYPE (msg)) {
* case GST_MESSAGE_TAG: {
* GstTagList *tags = NULL;
- *
+ *
* gst_message_parse_tag (msg, &tags);
* g_print ("Got tags from element %s\n", GST_OBJECT_NAME (msg->src));
* handle_tags (tags);
/**
* gst_message_set_buffering_stats:
* @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING.
- * @mode: a buffering mode
+ * @mode: a buffering mode
* @avg_in: the average input rate
* @avg_out: the average output rate
* @buffering_left: amount of buffering time left in milliseconds
* switch (GST_MESSAGE_TYPE (msg)) {
* case GST_MESSAGE_STATE_CHANGED: {
* GstState old_state, new_state;
- *
+ *
* gst_message_parse_state_changed (msg, &old_state, &new_state, NULL);
* g_print ("Element %s changed state from %s to %s.\n",
* GST_OBJECT_NAME (msg->src),
* case GST_MESSAGE_ERROR: {
* GError *err = NULL;
* gchar *dbg_info = NULL;
- *
+ *
* gst_message_parse_error (msg, &err, &dbg_info);
* g_printerr ("ERROR from element %s: %s\n",
* GST_OBJECT_NAME (msg->src), err->message);
*
* Create a new stream status message. This message is posted when a streaming
* thread is created/destroyed or when the state changed.
- *
+ *
* Returns: (transfer full): the new stream status message.
*
* MT safe.
*
* Extracts the object managing the streaming thread from @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.
+ * Returns: (nullable): 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.
*/
const GValue *
gst_message_get_stream_status_object (GstMessage * message)
* @intermediate: is this an intermediate step
*
* This message is posted by elements when they accept or activate a new step
- * event for @amount in @format.
+ * event for @amount in @format.
*
* @active is set to %FALSE when the element accepted the new step event and has
* queued it for execution in the streaming threads.
* message is emitted, the application can queue a new step operation in the
* element.
*
- * Returns: (transfer full): The new step_start message.
+ * Returns: (transfer full): The new step_start message.
*
* MT safe.
*/
* @code contains a well defined string describing the action.
* @text should contain a user visible string detailing the current action.
*
- * Returns: (transfer full): The new qos message.
+ * Returns: (transfer full) (nullable): The new qos message.
*/
GstMessage *
gst_message_new_progress (GstObject * src, GstProgressType type,
/**
* gst_message_parse_context_type:
* @message: a GST_MESSAGE_NEED_CONTEXT type message
- * @context_type: (out) (allow-none): the context type, or %NULL
+ * @context_type: (out) (transfer none) (allow-none): the context type, or %NULL
*
* Parse a context type from an existing GST_MESSAGE_NEED_CONTEXT message.
*
* @message: a #GstMessage of type %GST_MESSAGE_DEVICE_ADDED
* @device: (out) (allow-none) (transfer full): A location where to store a
* pointer to the new #GstDevice, or %NULL
- *
+ *
* Parses a device-added message. The device-added message is produced by
* #GstDeviceProvider or a #GstDeviceMonitor. It announces the appearance
* of monitored devices.
}
/**
+ * gst_message_new_device_changed:
+ * @src: The #GstObject that created the message
+ * @device: (transfer none): The newly created device representing @replaced_device
+ * with its new configuration.
+ *
+ * Creates a new device-changed message. The device-changed message is produced
+ * by #GstDeviceProvider or a #GstDeviceMonitor. They announce that a device
+ * properties has changed and @device represent the new modified version of @changed_device.
+ *
+ * Returns: a newly allocated #GstMessage
+ *
+ * Since: 1.16
+ */
+GstMessage *
+gst_message_new_device_changed (GstObject * src, GstDevice * device,
+ GstDevice * changed_device)
+{
+ GstMessage *message;
+ GstStructure *structure;
+
+ g_return_val_if_fail (device != NULL, NULL);
+ g_return_val_if_fail (GST_IS_DEVICE (device), NULL);
+
+ structure = gst_structure_new_id (GST_QUARK (MESSAGE_DEVICE_CHANGED),
+ GST_QUARK (DEVICE), GST_TYPE_DEVICE, device,
+ GST_QUARK (DEVICE_CHANGED), GST_TYPE_DEVICE, changed_device, NULL);
+ message = gst_message_new_custom (GST_MESSAGE_DEVICE_CHANGED, src, structure);
+
+ return message;
+}
+
+/**
+ * gst_message_parse_device_changed:
+ * @message: a #GstMessage of type %GST_MESSAGE_DEVICE_CHANGED
+ * @device: (out) (allow-none) (transfer full): A location where to store a
+ * pointer to the updated version of the #GstDevice, or %NULL
+ * @changed_device: (out) (allow-none) (transfer full): A location where to store a
+ * pointer to the old version of the #GstDevice, or %NULL
+ *
+ * Parses a device-changed message. The device-changed message is produced by
+ * #GstDeviceProvider or a #GstDeviceMonitor. It announces the
+ * disappearance of monitored devices. * It announce that a device properties has
+ * changed and @device represents the new modified version of @changed_device.
+ *
+ * Since: 1.16
+ */
+void
+gst_message_parse_device_changed (GstMessage * message, GstDevice ** device,
+ GstDevice ** changed_device)
+{
+ g_return_if_fail (GST_IS_MESSAGE (message));
+ g_return_if_fail (GST_MESSAGE_TYPE (message) == GST_MESSAGE_DEVICE_CHANGED);
+
+ if (device)
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (DEVICE), GST_TYPE_DEVICE, device, NULL);
+
+ if (changed_device)
+ gst_structure_id_get (GST_MESSAGE_STRUCTURE (message),
+ GST_QUARK (DEVICE_CHANGED), GST_TYPE_DEVICE, changed_device, NULL);
+}
+
+/**
* gst_message_new_property_notify:
* @src: The #GstObject whose property changed (may or may not be a #GstElement)
* @property_name: name of the property that changed
* @message: a #GstMessage of type %GST_MESSAGE_PROPERTY_NOTIFY
* @object: (out) (allow-none) (transfer none): location where to store a
* pointer to the object whose property got changed, or %NULL
- * @property_name: (out) (allow-none): return location for the name of the
- * property that got changed, or %NULL
- * @property_value: (out) (allow-none): return location for the new value of
- * the property that got changed, or %NULL. This will only be set if the
- * property notify watch was told to include the value when it was set up
+ * @property_name: (out) (transfer none) (allow-none): return location for
+ * the name of the property that got changed, or %NULL
+ * @property_value: (out) (transfer none) (allow-none): return location for
+ * the new value of the property that got changed, or %NULL. This will
+ * only be set if the property notify watch was told to include the value
+ * when it was set up
*
* Parses a property-notify message. These will be posted on the bus only
* when set up with gst_element_add_property_notify_watch() or
* @collection: (out) (allow-none) (transfer full): A location where to store a
* pointer to the #GstStreamCollection, or %NULL
*
- * Parses a stream-collection message.
+ * Parses a stream-collection message.
*
* Since: 1.10
*/
*
* Retrieves the #GstStream with index @index from the @message.
*
- * Returns: (transfer full): A #GstStream
+ * Returns: (transfer full) (nullable): A #GstStream
*
* Since: 1.10
*/
* @collection: (out) (allow-none) (transfer full): A location where to store a
* pointer to the #GstStreamCollection, or %NULL
*
- * Parses a streams-selected message.
+ * Parses a streams-selected message.
*
* Since: 1.10
*/
projects / platform / upstream / gstreamer.git / blobdiff