[libcamera-devel,v2] test: gstreamer: Add unit test to test gstreamer single stream working

13271 diff mbox series

This patch adds unit test to test if single stream using
libcamera's gstreamer element works.

Signed-off-by: Vedant Paranjape <vedantparanjape160201@gmail.com>
---
 .../gstreamer_single_stream_test.cpp          | 118 ++++++++++++++++++
 test/gstreamer/meson.build                    |  15 +++
 test/meson.build                              |   1 +
 3 files changed, 134 insertions(+)
 create mode 100644 test/gstreamer/gstreamer_single_stream_test.cpp
 create mode 100644 test/gstreamer/meson.build

Hi Vedant,

test: gstreamer: Add unit test to test gstreamer single stream working

On Tue, Aug 10, 2021 at 01:10:04PM +0530, Vedant Paranjape wrote:
> This patch adds unit test to test if single stream using

s/unit/a/

I think here it's fine, but since the subject needs to be concice, I
think the second "test" is redundant. "Add test for gstreamer single
stream" maybe is sufficient? Not sure how the others think, maybe this
would be too concise :p

> libcamera's gstreamer element works.
> 
> Signed-off-by: Vedant Paranjape <vedantparanjape160201@gmail.com>
> ---
>  .../gstreamer_single_stream_test.cpp          | 118 ++++++++++++++++++
>  test/gstreamer/meson.build                    |  15 +++
>  test/meson.build                              |   1 +
>  3 files changed, 134 insertions(+)
>  create mode 100644 test/gstreamer/gstreamer_single_stream_test.cpp
>  create mode 100644 test/gstreamer/meson.build
> 
> diff --git a/test/gstreamer/gstreamer_single_stream_test.cpp b/test/gstreamer/gstreamer_single_stream_test.cpp
> new file mode 100644
> index 00000000..c249a048
> --- /dev/null
> +++ b/test/gstreamer/gstreamer_single_stream_test.cpp
> @@ -0,0 +1,118 @@
> +#include <iostream>
> +#include <gst/gst.h>
> +
> +#include "test.h"
> +
> +using namespace std;
> +
> +class GstreamerSingleStreamTest: public Test
> +{
> +protected:
> +    GstElement *pipeline, *libcamera_src, *convert0, *sink0;
> +    GstBus *bus;
> +    GstMessage *msg;
> +    GstStateChangeReturn ret;


I think these can go in private. Also since they're all member variables
they should have a _ suffix.

(for the whole file) indentation

> +
> +    int GstreamerPrintError(GstMessage *msg_)
> +    {
> +        int TestResult = TestPass;
> +
> +        if (msg_ != NULL) {
> +            GError *err;
> +            gchar *debug_info;
> +
> +            switch (GST_MESSAGE_TYPE(msg_)) {
> +                case GST_MESSAGE_ERROR:

From here,

> +                    gst_message_parse_error(msg_, &err, &debug_info);
> +                    g_printerr("Error received from element %s: %s\n", GST_OBJECT_NAME(msg_->src), err->message);
> +                    g_printerr("Debugging information: %s\n", debug_info ? debug_info : "none");
> +                    g_clear_error(&err);
> +                    g_free(debug_info);
> +                    TestResult = TestFail;

to here, I meant this block should be in some print error function.

> +                    break;
> +                case GST_MESSAGE_EOS:
> +                    g_printerr("End-Of-Stream reached.\n");

For example, this isn't an error, so this certainly doesn't belong in a
"PrintError" function :D

> +                    TestResult = TestFail;
> +                    break;
> +                default:
> +                    /* We should not reach here because we only asked for ERRORs and EOS */
> +                    g_printerr("Unexpected message received.\n");
> +                    TestResult = TestFail;
> +                    break;
> +            }
> +        }
> +
> +        return TestResult;
> +    }
> +
> +    int init() override
> +    {
> +        /* Initialize GStreamer */
> +        GError *err_init = nullptr;
> +        if (!gst_init_check(nullptr, nullptr, &err_init)) {
> +            g_printerr ("Could not initialize GStreamer: %s\n", err_init ? err_init->message : "unknown error occurred");

Break up the line.

s/occurred//


> +            if (err_init) {
> +                g_error_free(err_init);
> +            }

Don't need the braces.

> +
> +            return TestFail;
> +        }
> +
> +        /* Create the elements */
> +        libcamera_src = gst_element_factory_make("libcamerasrc", "libcamera");
> +        convert0 = gst_element_factory_make("videoconvert", "convert0");
> +        sink0 = gst_element_factory_make("autovideosink", "sink0");
> +
> +        /* Create the empty pipeline */
> +        pipeline = gst_pipeline_new("test-pipeline");
> +
> +        if (!pipeline || !convert0 || !sink0 || !libcamera_src) {
> +            g_printerr("Not all elements could be created.\n");
> +            return TestFail;
> +        }
> +
> +        return TestPass;
> +    }
> +
> +    void cleanup() override
> +    {
> +        gst_message_unref(msg);
> +        gst_object_unref(bus);
> +        gst_element_set_state(pipeline, GST_STATE_NULL);
> +        gst_object_unref(pipeline);
> +    }
> +
> +    int run() override
> +    {
> +        /* Build the pipeline */
> +        gst_bin_add_many(GST_BIN(pipeline), libcamera_src, convert0, sink0, NULL);
> +        if (gst_element_link_many(libcamera_src, convert0, sink0, NULL) != TRUE) {
> +            g_printerr("Elements could not be linked (1).\n");

What's this (1) for?

> +            gst_object_unref(pipeline);
> +            return TestFail;
> +        }
> +
> +        /* Start playing */
> +        ret = gst_element_set_state(pipeline, GST_STATE_PLAYING);
> +        if (ret == GST_STATE_CHANGE_FAILURE) {
> +            g_printerr("Unable to set the pipeline to the playing state.\n");
> +            gst_object_unref(pipeline);
> +            return TestFail;
> +        }
> +
> +        /* Wait until error or EOS or timeout after 2 seconds*/
> +        GstClockTime timeout = 2000000000;
> +        bus = gst_element_get_bus(pipeline);
> +        msg = gst_bus_timed_pop_filtered(bus, timeout,
> +                                    GstMessageType((uint)GST_MESSAGE_ERROR | (uint)GST_MESSAGE_EOS));
> +
> +        /* Parse error message */
> +        if (GstreamerPrintError(msg) == TestFail) {
> +            return TestFail;
> +        }

This should be replaced with the switch-case.


Otherwise, looks good.


Paul

> +
> +        return TestPass;
> +    }
> +};
> +
> +TEST_REGISTER(GstreamerSingleStreamTest)
> diff --git a/test/gstreamer/meson.build b/test/gstreamer/meson.build
> new file mode 100644
> index 00000000..36643d4a
> --- /dev/null
> +++ b/test/gstreamer/meson.build
> @@ -0,0 +1,15 @@
> +# SPDX-License-Identifier: CC0-1.0
> +
> +gstreamer_tests = [
> +    ['single_stream_test',   'gstreamer_single_stream_test.cpp'],
> +]
> +gstreamer_dep = dependency('gstreamer-1.0', required: true)
> +
> +foreach t : gstreamer_tests
> +    exe = executable(t[0], t[1],
> +                     dependencies : [libcamera_private, gstreamer_dep],
> +                     link_with : test_libraries,
> +                     include_directories : test_includes_internal)
> +
> +    test(t[0], exe, suite : 'gstreamer', is_parallel : false)
> +endforeach
> diff --git a/test/meson.build b/test/meson.build
> index 3bceb5df..d0466f17 100644
> --- a/test/meson.build
> +++ b/test/meson.build
> @@ -11,6 +11,7 @@ subdir('libtest')
>  
>  subdir('camera')
>  subdir('controls')
> +subdir('gstreamer')
>  subdir('ipa')
>  subdir('ipc')
>  subdir('log')
> -- 
> 2.25.1
>

Hi Paul,

On Tue, Aug 10, 2021 at 1:26 PM <paul.elder@ideasonboard.com> wrote:

> Hi Vedant,
>
> test: gstreamer: Add unit test to test gstreamer single stream working
>
> On Tue, Aug 10, 2021 at 01:10:04PM +0530, Vedant Paranjape wrote:
> > This patch adds unit test to test if single stream using
>
> s/unit/a/
>
> I think here it's fine, but since the subject needs to be concice, I
> think the second "test" is redundant. "Add test for gstreamer single
> stream" maybe is sufficient? Not sure how the others think, maybe this
> would be too concise :p
>
> > libcamera's gstreamer element works.
> >
> > Signed-off-by: Vedant Paranjape <vedantparanjape160201@gmail.com>
> > ---
> >  .../gstreamer_single_stream_test.cpp          | 118 ++++++++++++++++++
> >  test/gstreamer/meson.build                    |  15 +++
> >  test/meson.build                              |   1 +
> >  3 files changed, 134 insertions(+)
> >  create mode 100644 test/gstreamer/gstreamer_single_stream_test.cpp
> >  create mode 100644 test/gstreamer/meson.build
> >
> > diff --git a/test/gstreamer/gstreamer_single_stream_test.cpp
> b/test/gstreamer/gstreamer_single_stream_test.cpp
> > new file mode 100644
> > index 00000000..c249a048
> > --- /dev/null
> > +++ b/test/gstreamer/gstreamer_single_stream_test.cpp
> > @@ -0,0 +1,118 @@
> > +#include <iostream>
> > +#include <gst/gst.h>
> > +
> > +#include "test.h"
> > +
> > +using namespace std;
> > +
> > +class GstreamerSingleStreamTest: public Test
> > +{
> > +protected:
> > +    GstElement *pipeline, *libcamera_src, *convert0, *sink0;
> > +    GstBus *bus;
> > +    GstMessage *msg;
> > +    GstStateChangeReturn ret;
>
>
> I think these can go in private. Also since they're all member variables
> they should have a _ suffix.
>
> (for the whole file) indentation
>

Not sure what's wrong with indentation. I have followed how it's there in
other tests

> +
> > +    int GstreamerPrintError(GstMessage *msg_)
> > +    {
> > +        int TestResult = TestPass;
> > +
> > +        if (msg_ != NULL) {
> > +            GError *err;
> > +            gchar *debug_info;
> > +
> > +            switch (GST_MESSAGE_TYPE(msg_)) {
> > +                case GST_MESSAGE_ERROR:
>
> From here,
>
> > +                    gst_message_parse_error(msg_, &err, &debug_info);
> > +                    g_printerr("Error received from element %s: %s\n",
> GST_OBJECT_NAME(msg_->src), err->message);
> > +                    g_printerr("Debugging information: %s\n",
> debug_info ? debug_info : "none");
> > +                    g_clear_error(&err);
> > +                    g_free(debug_info);
> > +                    TestResult = TestFail;
>
> to here, I meant this block should be in some print error function.
>
> > +                    break;
> > +                case GST_MESSAGE_EOS:
> > +                    g_printerr("End-Of-Stream reached.\n");
>
> For example, this isn't an error, so this certainly doesn't belong in a
> "PrintError" function :D
>
> > +                    TestResult = TestFail;
> > +                    break;
> > +                default:
> > +                    /* We should not reach here because we only asked
> for ERRORs and EOS */
> > +                    g_printerr("Unexpected message received.\n");
> > +                    TestResult = TestFail;
> > +                    break;
> > +            }
> > +        }
> > +
> > +        return TestResult;
> > +    }
> > +
> > +    int init() override
> > +    {
> > +        /* Initialize GStreamer */
> > +        GError *err_init = nullptr;
> > +        if (!gst_init_check(nullptr, nullptr, &err_init)) {
> > +            g_printerr ("Could not initialize GStreamer: %s\n",
> err_init ? err_init->message : "unknown error occurred");
>
> Break up the line.
>
> s/occurred//
>
>
> > +            if (err_init) {
> > +                g_error_free(err_init);
> > +            }
>
> Don't need the braces.
>
> > +
> > +            return TestFail;
> > +        }
> > +
> > +        /* Create the elements */
> > +        libcamera_src = gst_element_factory_make("libcamerasrc",
> "libcamera");
> > +        convert0 = gst_element_factory_make("videoconvert", "convert0");
> > +        sink0 = gst_element_factory_make("autovideosink", "sink0");
> > +
> > +        /* Create the empty pipeline */
> > +        pipeline = gst_pipeline_new("test-pipeline");
> > +
> > +        if (!pipeline || !convert0 || !sink0 || !libcamera_src) {
> > +            g_printerr("Not all elements could be created.\n");
> > +            return TestFail;
> > +        }
> > +
> > +        return TestPass;
> > +    }
> > +
> > +    void cleanup() override
> > +    {
> > +        gst_message_unref(msg);
> > +        gst_object_unref(bus);
> > +        gst_element_set_state(pipeline, GST_STATE_NULL);
> > +        gst_object_unref(pipeline);
> > +    }
> > +
> > +    int run() override
> > +    {
> > +        /* Build the pipeline */
> > +        gst_bin_add_many(GST_BIN(pipeline), libcamera_src, convert0,
> sink0, NULL);
> > +        if (gst_element_link_many(libcamera_src, convert0, sink0, NULL)
> != TRUE) {
> > +            g_printerr("Elements could not be linked (1).\n");
>
> What's this (1) for?
>
> > +            gst_object_unref(pipeline);
> > +            return TestFail;
> > +        }
> > +
> > +        /* Start playing */
> > +        ret = gst_element_set_state(pipeline, GST_STATE_PLAYING);
> > +        if (ret == GST_STATE_CHANGE_FAILURE) {
> > +            g_printerr("Unable to set the pipeline to the playing
> state.\n");
> > +            gst_object_unref(pipeline);
> > +            return TestFail;
> > +        }
> > +
> > +        /* Wait until error or EOS or timeout after 2 seconds*/
> > +        GstClockTime timeout = 2000000000;
> > +        bus = gst_element_get_bus(pipeline);
> > +        msg = gst_bus_timed_pop_filtered(bus, timeout,
> > +
> GstMessageType((uint)GST_MESSAGE_ERROR | (uint)GST_MESSAGE_EOS));
> > +
> > +        /* Parse error message */
> > +        if (GstreamerPrintError(msg) == TestFail) {
> > +            return TestFail;
> > +        }
>
> This should be replaced with the switch-case.
>
>
> Otherwise, looks good.
>
>
> Paul
>
> > +
> > +        return TestPass;
> > +    }
> > +};
> > +
> > +TEST_REGISTER(GstreamerSingleStreamTest)
> > diff --git a/test/gstreamer/meson.build b/test/gstreamer/meson.build
> > new file mode 100644
> > index 00000000..36643d4a
> > --- /dev/null
> > +++ b/test/gstreamer/meson.build
> > @@ -0,0 +1,15 @@
> > +# SPDX-License-Identifier: CC0-1.0
> > +
> > +gstreamer_tests = [
> > +    ['single_stream_test',   'gstreamer_single_stream_test.cpp'],
> > +]
> > +gstreamer_dep = dependency('gstreamer-1.0', required: true)
> > +
> > +foreach t : gstreamer_tests
> > +    exe = executable(t[0], t[1],
> > +                     dependencies : [libcamera_private, gstreamer_dep],
> > +                     link_with : test_libraries,
> > +                     include_directories : test_includes_internal)
> > +
> > +    test(t[0], exe, suite : 'gstreamer', is_parallel : false)
> > +endforeach
> > diff --git a/test/meson.build b/test/meson.build
> > index 3bceb5df..d0466f17 100644
> > --- a/test/meson.build
> > +++ b/test/meson.build
> > @@ -11,6 +11,7 @@ subdir('libtest')
> >
> >  subdir('camera')
> >  subdir('controls')
> > +subdir('gstreamer')
> >  subdir('ipa')
> >  subdir('ipc')
> >  subdir('log')
> > --
> > 2.25.1
> >


Thanks for the review, will do the requested changes.

Regards,
Vedant