gstreamer/tests/check/gst/gstelement.c
Tim-Philipp Müller 6e3fb7af52 element: add API to get property change notifications via messages
Be notified in the application thread via bus messages about
notify::* and deep-notify::* property changes, instead of
having to deal with it in a non-application thread.

API: gst_element_add_property_notify_watch()
API: gst_element_add_property_deep_notify_watch()
API: gst_element_remove_property_notify_watch()
API: gst_message_new_property_notify()
API: gst_message_parse_property_notify()
API: GST_MESSAGE_PROPERTY_NOTIFY

https://bugzilla.gnome.org/show_bug.cgi?id=763142
2016-04-08 13:27:59 +01:00

503 lines
15 KiB
C

/* GStreamer
* Copyright (C) 2005 Thomas Vander Stichele <thomas at apestaart dot org>
*
* gstelement.c: Unit test for GstElement
*
* 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., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include <gst/check/gstcheck.h>
GST_START_TEST (test_add_remove_pad)
{
GstElement *e;
GstPad *p;
/* getting an existing element class is cheating, but easier */
e = gst_element_factory_make ("fakesrc", "source");
/* create a new floating pad with refcount 1 */
p = gst_pad_new ("source", GST_PAD_SRC);
ASSERT_OBJECT_REFCOUNT (p, "pad", 1);
/* ref it for ourselves */
gst_object_ref (p);
ASSERT_OBJECT_REFCOUNT (p, "pad", 2);
/* adding it sinks the pad -> not floating, same refcount */
gst_element_add_pad (e, p);
ASSERT_OBJECT_REFCOUNT (p, "pad", 2);
/* removing it reduces the refcount */
gst_element_remove_pad (e, p);
ASSERT_OBJECT_REFCOUNT (p, "pad", 1);
/* clean up our own reference */
gst_object_unref (p);
gst_object_unref (e);
}
GST_END_TEST;
GST_START_TEST (test_add_pad_unref_element)
{
GstElement *e;
GstPad *p;
/* getting an existing element class is cheating, but easier */
e = gst_element_factory_make ("fakesrc", "source");
/* create a new floating pad with refcount 1 */
p = gst_pad_new ("source", GST_PAD_SRC);
ASSERT_OBJECT_REFCOUNT (p, "pad", 1);
/* ref it for ourselves */
gst_object_ref (p);
ASSERT_OBJECT_REFCOUNT (p, "pad", 2);
/* adding it sinks the pad -> not floating, same refcount */
gst_element_add_pad (e, p);
ASSERT_OBJECT_REFCOUNT (p, "pad", 2);
/* unreffing the element should clean it up */
gst_object_unref (GST_OBJECT (e));
ASSERT_OBJECT_REFCOUNT (p, "pad", 1);
/* clean up our own reference */
gst_object_unref (p);
}
GST_END_TEST;
GST_START_TEST (test_error_no_bus)
{
GstElement *e;
GstBus *bus;
e = gst_element_factory_make ("fakesrc", "source");
/* get the bus, should be NULL */
bus = gst_element_get_bus (e);
fail_if (bus != NULL);
/* I don't want errors shown */
gst_debug_set_default_threshold (GST_LEVEL_NONE);
GST_ELEMENT_ERROR (e, RESOURCE, OPEN_READ, ("I could not read"), ("debug"));
gst_object_unref (e);
}
GST_END_TEST;
/* link and run two elements without putting them in a pipeline */
GST_START_TEST (test_link)
{
GstElement *src, *sink;
src = gst_element_factory_make ("fakesrc", "source");
sink = gst_element_factory_make ("fakesink", "sink");
fail_unless (gst_element_link_pads (src, "src", sink, "sink"));
/* do sink to source state change */
gst_element_set_state (sink, GST_STATE_PAUSED);
gst_element_set_state (src, GST_STATE_PAUSED);
/* wait for preroll */
gst_element_get_state (sink, NULL, NULL, GST_CLOCK_TIME_NONE);
/* play some more */
gst_element_set_state (sink, GST_STATE_PLAYING);
gst_element_set_state (src, GST_STATE_PLAYING);
g_usleep (G_USEC_PER_SEC);
/* and stop */
gst_element_set_state (sink, GST_STATE_PAUSED);
gst_element_set_state (src, GST_STATE_PAUSED);
/* wait for preroll */
gst_element_get_state (sink, NULL, NULL, GST_CLOCK_TIME_NONE);
gst_element_set_state (sink, GST_STATE_NULL);
gst_element_set_state (src, GST_STATE_NULL);
gst_element_get_state (sink, NULL, NULL, GST_CLOCK_TIME_NONE);
g_usleep (G_USEC_PER_SEC / 2);
ASSERT_OBJECT_REFCOUNT (sink, "sink", 1);
ASSERT_OBJECT_REFCOUNT (src, "src", 1);
gst_element_unlink_pads (src, "src", sink, "sink");
ASSERT_OBJECT_REFCOUNT (sink, "sink", 1);
ASSERT_OBJECT_REFCOUNT (src, "src", 1);
gst_object_unref (src);
gst_object_unref (sink);
}
GST_END_TEST;
/* linking two elements without pads should fail */
GST_START_TEST (test_link_no_pads)
{
GstElement *src, *sink;
src = gst_bin_new ("src");
sink = gst_bin_new ("sink");
fail_if (gst_element_link (src, sink));
gst_object_unref (src);
gst_object_unref (sink);
}
GST_END_TEST;
typedef struct _GstTestElement
{
GstElement parent;
} GstTestElement;
typedef struct _GstTestElementClass
{
GstElementClass parent;
} GstTestElementClass;
static void
gst_test_element_class_init (GstTestElementClass * klass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
GstPadTemplate *templ;
gst_element_class_set_metadata (element_class, "Test element",
"Element", "Does nothing", "Foo Bar <foo@bar.com>");
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 0);
fail_unless (gst_element_class_get_pad_template (element_class,
"test") == NULL);
gst_element_class_add_pad_template (element_class,
gst_pad_template_new ("test", GST_PAD_SRC, GST_PAD_ALWAYS, GST_CAPS_ANY));
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 1);
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test")) != NULL);
fail_unless (gst_caps_is_any (templ->caps));
gst_element_class_add_pad_template (element_class,
gst_pad_template_new ("test2", GST_PAD_SRC, GST_PAD_ALWAYS,
GST_CAPS_ANY));
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 2);
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test2")) != NULL);
fail_unless (gst_caps_is_any (templ->caps));
/* Add "test" again, with NONE caps this time */
gst_element_class_add_pad_template (element_class,
gst_pad_template_new ("test", GST_PAD_SRC, GST_PAD_ALWAYS,
GST_CAPS_NONE));
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 2);
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test")) != NULL);
fail_unless (gst_caps_is_empty (templ->caps));
}
static GType
gst_test_element_get_type (void)
{
static GType gst_test_element_type = G_TYPE_NONE;
if (gst_test_element_type == G_TYPE_NONE) {
static const GTypeInfo gst_test_element_info = {
sizeof (GstTestElementClass),
NULL, /* base_init */
NULL, /* base_finalize */
(GClassInitFunc) gst_test_element_class_init,
NULL,
NULL,
sizeof (GstTestElement),
0,
NULL, /* instance_init */
NULL
};
gst_test_element_type = g_type_register_static (GST_TYPE_ELEMENT,
"GstTestElement", &gst_test_element_info, 0);
}
return gst_test_element_type;
}
typedef struct _GstTestElement2
{
GstTestElement parent;
} GstTestElement2;
typedef struct _GstTestElement2Class
{
GstTestElementClass parent;
} GstTestElement2Class;
static void
gst_test_element2_class_init (GstTestElement2Class * klass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
GstPadTemplate *templ;
gst_element_class_set_metadata (element_class, "Test element 2",
"Element", "Does nothing", "Foo Bar <foo@bar.com>");
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 2);
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test")) != NULL);
fail_unless (gst_caps_is_empty (templ->caps));
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test2")) != NULL);
fail_unless (gst_caps_is_any (templ->caps));
/* Add "test" pad with ANY caps, should have "test" pad with EMPTY caps before */
gst_element_class_add_pad_template (element_class,
gst_pad_template_new ("test", GST_PAD_SRC, GST_PAD_ALWAYS, GST_CAPS_ANY));
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 2);
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test")) != NULL);
fail_unless (gst_caps_is_any (templ->caps));
gst_element_class_add_pad_template (element_class,
gst_pad_template_new ("test4", GST_PAD_SRC, GST_PAD_ALWAYS,
GST_CAPS_ANY));
fail_unless_equals_int (g_list_length (gst_element_class_get_pad_template_list
(element_class)), 3);
fail_unless ((templ =
gst_element_class_get_pad_template (element_class, "test4")) != NULL);
fail_unless (gst_caps_is_any (templ->caps));
}
static GType
gst_test_element2_get_type (void)
{
static GType gst_test_element2_type = G_TYPE_NONE;
if (gst_test_element2_type == G_TYPE_NONE) {
static const GTypeInfo gst_test_element2_info = {
sizeof (GstTestElement2Class),
NULL, /* base_init */
NULL, /* base_finalize */
(GClassInitFunc) gst_test_element2_class_init,
NULL,
NULL,
sizeof (GstTestElement2),
0,
NULL, /* instance_init */
NULL
};
gst_test_element2_type =
g_type_register_static (gst_test_element_get_type (), "GstTestElement2",
&gst_test_element2_info, 0);
}
return gst_test_element2_type;
}
GST_START_TEST (test_pad_templates)
{
GstTestElement *test;
GstTestElement2 *test2;
test = g_object_new (gst_test_element_get_type (), NULL);
test2 = g_object_new (gst_test_element2_get_type (), NULL);
g_object_unref (test);
g_object_unref (test2);
}
GST_END_TEST;
/* need to return the message here because object, property name and value
* are only valid as long as we keep the message alive */
static GstMessage *
bus_wait_for_notify_message (GstBus * bus, GstElement ** obj,
const gchar ** prop_name, const GValue ** val)
{
GstMessage *msg;
do {
msg = gst_bus_timed_pop_filtered (bus, -1, GST_MESSAGE_ANY);
if (GST_MESSAGE_TYPE (msg) == GST_MESSAGE_PROPERTY_NOTIFY)
break;
gst_message_unref (msg);
} while (TRUE);
gst_message_parse_property_notify (msg, (GstObject **) obj, prop_name, val);
return msg;
}
GST_START_TEST (test_property_notify_message)
{
GstElement *pipeline, *identity;
gulong watch_id0, watch_id1, watch_id2, deep_watch_id1, deep_watch_id2;
GstBus *bus;
pipeline = gst_pipeline_new (NULL);
identity = gst_element_factory_make ("identity", NULL);
gst_bin_add (GST_BIN (pipeline), identity);
bus = GST_ELEMENT_BUS (pipeline);
/* need to set state to READY, otherwise bus will be flushing and discard
* our messages */
gst_element_set_state (pipeline, GST_STATE_READY);
watch_id0 = gst_element_add_property_notify_watch (identity, NULL, FALSE);
watch_id1 = gst_element_add_property_notify_watch (identity, "sync", FALSE);
watch_id2 = gst_element_add_property_notify_watch (identity, "silent", TRUE);
deep_watch_id1 =
gst_element_add_property_deep_notify_watch (pipeline, NULL, TRUE);
deep_watch_id2 =
gst_element_add_property_deep_notify_watch (pipeline, "silent", FALSE);
/* Now test property changes and if we get the messages we expect. We rely
* on the signals being fired in the order that they were set up here. */
{
const GValue *val;
const gchar *name;
GstMessage *msg;
GstElement *obj;
/* A - This should be picked up by... */
g_object_set (identity, "dump", TRUE, NULL);
/* 1) the catch-all notify on the element (no value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless (obj == identity);
fail_unless_equals_string (name, "dump");
fail_unless (val == NULL);
gst_message_unref (msg);
/* 2) the catch-all deep-notify on the pipeline (with value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless_equals_string (name, "dump");
fail_unless (obj == identity);
fail_unless (G_VALUE_HOLDS_BOOLEAN (val));
fail_unless_equals_int (g_value_get_boolean (val), TRUE);
gst_message_unref (msg);
/* B - This should be picked up by... */
g_object_set (identity, "sync", TRUE, NULL);
/* 1) the catch-all notify on the element (no value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless (obj == identity);
fail_unless_equals_string (name, "sync");
fail_unless (val == NULL);
gst_message_unref (msg);
/* 2) the "sync" notify on the element (no value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless (obj == identity);
fail_unless_equals_string (name, "sync");
fail_unless (val == NULL);
gst_message_unref (msg);
/* 3) the catch-all deep-notify on the pipeline (with value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless_equals_string (name, "sync");
fail_unless (obj == identity);
fail_unless (G_VALUE_HOLDS_BOOLEAN (val));
fail_unless_equals_int (g_value_get_boolean (val), TRUE);
gst_message_unref (msg);
/* C - This should be picked up by... */
g_object_set (identity, "silent", FALSE, NULL);
/* 1) the catch-all notify on the element (no value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless (obj == identity);
fail_unless_equals_string (name, "silent");
fail_unless (val == NULL);
gst_message_unref (msg);
/* 2) the "silent" notify on the element (with value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless (obj == identity);
fail_unless_equals_string (name, "silent");
fail_unless (val != NULL);
fail_unless (G_VALUE_HOLDS_BOOLEAN (val));
fail_unless_equals_int (g_value_get_boolean (val), FALSE);
gst_message_unref (msg);
/* 3) the catch-all deep-notify on the pipeline (with value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless_equals_string (name, "silent");
fail_unless (obj == identity);
fail_unless (G_VALUE_HOLDS_BOOLEAN (val));
fail_unless_equals_int (g_value_get_boolean (val), FALSE);
gst_message_unref (msg);
/* 4) the "silent" deep-notify on the pipeline (without value) */
msg = bus_wait_for_notify_message (bus, &obj, &name, &val);
fail_unless_equals_string (name, "silent");
fail_unless (obj == identity);
fail_unless (val == NULL);
gst_message_unref (msg);
}
gst_element_remove_property_notify_watch (identity, watch_id0);
gst_element_remove_property_notify_watch (identity, watch_id1);
gst_element_remove_property_notify_watch (identity, watch_id2);
gst_element_remove_property_notify_watch (pipeline, deep_watch_id1);
gst_element_remove_property_notify_watch (pipeline, deep_watch_id2);
gst_element_set_state (pipeline, GST_STATE_NULL);
gst_object_unref (pipeline);
}
GST_END_TEST;
static Suite *
gst_element_suite (void)
{
Suite *s = suite_create ("GstElement");
TCase *tc_chain = tcase_create ("element tests");
suite_add_tcase (s, tc_chain);
tcase_add_test (tc_chain, test_add_remove_pad);
tcase_add_test (tc_chain, test_add_pad_unref_element);
tcase_add_test (tc_chain, test_error_no_bus);
tcase_add_test (tc_chain, test_link);
tcase_add_test (tc_chain, test_link_no_pads);
tcase_add_test (tc_chain, test_pad_templates);
tcase_add_test (tc_chain, test_property_notify_message);
return s;
}
GST_CHECK_MAIN (gst_element);