Custom GStreamer Plugin that converts GRAY8 to NV12 data fails negotiation

Plugin and library development
1 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <gst/gst.h>
#include <gst/video/video.h>
#include <gst/video/gstvideofilter.h>
#include "gstformatconvert.hpp"

GST_DEBUG_CATEGORY_STATIC (gst_formatconvert_debug_category);
#define GST_CAT_DEFAULT gst_formatconvert_debug_category

/* prototypes */


static void gst_formatconvert_set_property (GObject * object,
    guint property_id, const GValue * value, GParamSpec * pspec);
static void gst_formatconvert_get_property (GObject * object,
    guint property_id, GValue * value, GParamSpec * pspec);
static void gst_formatconvert_dispose (GObject * object);
static void gst_formatconvert_finalize (GObject * object);

static gboolean gst_formatconvert_start (GstBaseTransform * trans);
static gboolean gst_formatconvert_stop (GstBaseTransform * trans);
static gboolean gst_formatconvert_set_info (GstVideoFilter * filter,
    GstCaps * incaps, GstVideoInfo * in_info, GstCaps * outcaps,
    GstVideoInfo * out_info);
static GstFlowReturn gst_formatconvert_transform_frame (GstVideoFilter * filter,
    GstVideoFrame * inframe, GstVideoFrame * outframe);
static GstFlowReturn gst_formatconvert_transform_frame_ip (GstVideoFilter *
    filter, GstVideoFrame * frame);

enum
{
  PROP_0
};

/* pad templates */

/* FIXME: add/remove formats you can handle */
#define VIDEO_SRC_CAPS \
    GST_VIDEO_CAPS_MAKE("{NV12}")

/* FIXME: add/remove formats you can handle */
#define VIDEO_SINK_CAPS \
    GST_VIDEO_CAPS_MAKE("{GRAY8}")


/* class initialization */

G_DEFINE_TYPE_WITH_CODE (GstFormatconvert, gst_formatconvert,
    GST_TYPE_VIDEO_FILTER,
    GST_DEBUG_CATEGORY_INIT (gst_formatconvert_debug_category, "formatconvert",
        0, "debug category for formatconvert element"));

static void
gst_formatconvert_class_init (GstFormatconvertClass * klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  GstBaseTransformClass *base_transform_class =
      GST_BASE_TRANSFORM_CLASS (klass);
  GstVideoFilterClass *video_filter_class = GST_VIDEO_FILTER_CLASS (klass);

  /* Setting up pads and setting metadata should be moved to
     base_class_init if you intend to subclass this class. */
  gst_element_class_add_pad_template (GST_ELEMENT_CLASS (klass),
      gst_pad_template_new ("src",
                            GST_PAD_SRC,
                            GST_PAD_ALWAYS,
                            gst_caps_from_string (VIDEO_SRC_CAPS)));
  gst_element_class_add_pad_template (GST_ELEMENT_CLASS (klass),
      gst_pad_template_new ("sink",
                            GST_PAD_SINK,
                            GST_PAD_ALWAYS,
                            gst_caps_from_string (VIDEO_SINK_CAPS)));

  gst_element_class_set_static_metadata (GST_ELEMENT_CLASS (klass),
      "FIXME Long name", "Generic", "FIXME Description",
      "FIXME <fixme@example.com>");

  gobject_class->set_property = gst_formatconvert_set_property;
  gobject_class->get_property = gst_formatconvert_get_property;
  gobject_class->dispose = gst_formatconvert_dispose;
  gobject_class->finalize = gst_formatconvert_finalize;
  base_transform_class->start = GST_DEBUG_FUNCPTR (gst_formatconvert_start);
  base_transform_class->stop = GST_DEBUG_FUNCPTR (gst_formatconvert_stop);
  //video_filter_class->set_info = GST_DEBUG_FUNCPTR (gst_formatconvert_set_info);
  video_filter_class->transform_frame =
      GST_DEBUG_FUNCPTR (gst_formatconvert_transform_frame);
  video_filter_class->transform_frame_ip =
      GST_DEBUG_FUNCPTR (gst_formatconvert_transform_frame_ip);

}

static void
gst_formatconvert_init (GstFormatconvert * formatconvert)
{

  
}

void
gst_formatconvert_set_property (GObject * object, guint property_id,
    const GValue * value, GParamSpec * pspec)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "set_property");

  switch (property_id) {
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
  }
}

void
gst_formatconvert_get_property (GObject * object, guint property_id,
    GValue * value, GParamSpec * pspec)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "get_property");

  switch (property_id) {
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
  }
}

void
gst_formatconvert_dispose (GObject * object)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "dispose");

  /* clean up as possible.  may be called multiple times */

  G_OBJECT_CLASS (gst_formatconvert_parent_class)->dispose (object);
}

void
gst_formatconvert_finalize (GObject * object)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "finalize");

  /* clean up object here */

  G_OBJECT_CLASS (gst_formatconvert_parent_class)->finalize (object);
}

static gboolean
gst_formatconvert_start (GstBaseTransform * trans)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (trans);

  GST_DEBUG_OBJECT (formatconvert, "start");

  return TRUE;
}

static gboolean
gst_formatconvert_stop (GstBaseTransform * trans)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (trans);

  GST_DEBUG_OBJECT (formatconvert, "stop");

  return TRUE;
}

static gboolean
gst_formatconvert_set_info (GstVideoFilter * filter, GstCaps * incaps,
    GstVideoInfo * in_info, GstCaps * outcaps, GstVideoInfo * out_info)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (filter);

  GST_DEBUG_OBJECT (formatconvert, "set_info");

  

  return TRUE;
}

static GstFlowReturn
gst_formatconvert_transform_frame(GstVideoFilter *filter,
                                  GstVideoFrame *inframe,
                                  GstVideoFrame *outframe)
{
    GstFormatconvert *formatconvert = GST_FORMATCONVERT(filter);

    GST_DEBUG_OBJECT(formatconvert, "transform_frame");

    // Retrieve the video info from the inframe
    GstVideoInfo *video_info = &inframe->info;

    // Retrieve the format from the video info
    GstVideoFormat format = GST_VIDEO_INFO_FORMAT(video_info);

    guint n_planes = GST_VIDEO_INFO_N_PLANES(video_info);

    g_print("No of Planes : %d\n", n_planes);

    // Convert the format to a string for easier reading
    const gchar *format_str = gst_video_format_to_string(format);

    // Print or use the format as needed
    g_print("Captured video format: %s\n", format_str);

    guint width = GST_VIDEO_FRAME_WIDTH(inframe);
    guint height = GST_VIDEO_FRAME_HEIGHT(inframe);

    guint8 *inframe_data =  (guint8*) GST_VIDEO_FRAME_PLANE_DATA(inframe, 0); // GRAY8 data
    //guint8 *inframe_data_1 = (guint8*) GST_VIDEO_FRAME_PLANE_DATA(inframe, 1);
    guint8 *outframe_y_data = (guint8*) GST_VIDEO_FRAME_PLANE_DATA(outframe, 0); // Y plane data
    guint8 *outframe_uv_data = (guint8*) GST_VIDEO_FRAME_PLANE_DATA(outframe, 1); // UV plane data

    guint inframe_stride = GST_VIDEO_FRAME_PLANE_STRIDE(inframe, 0);
    guint outframe_y_stride = GST_VIDEO_FRAME_PLANE_STRIDE(outframe, 0);
    guint outframe_uv_stride = GST_VIDEO_FRAME_PLANE_STRIDE(outframe, 1);

    for (guint y = 0; y < height; y++) 
    {
        for (guint x = 0; x < width; x++) 
        {
            // Convert GRAY8 pixel to Y value
            guint8 gray_pixel = inframe_data[y * inframe_stride + x];
            outframe_y_data[y * outframe_y_stride + x] = gray_pixel;

            // Fill UV plane with neutral values
            outframe_uv_data[y / 2 * outframe_uv_stride + 2 * (x / 2)] = 128; // U value
            outframe_uv_data[y / 2 * outframe_uv_stride + 2 * (x / 2) + 1] = 128; // V value
        }
    }

    return GST_FLOW_OK;
}

static GstFlowReturn
gst_formatconvert_transform_frame_ip (GstVideoFilter * filter,
    GstVideoFrame * frame)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (filter);

  GST_DEBUG_OBJECT (formatconvert, "transform_frame_ip");

  return GST_FLOW_OK;
}

static gboolean
plugin_init (GstPlugin * plugin)
{

  /* FIXME Remember to set the rank if it's an element that is meant
     to be autoplugged by decodebin. */
  return gst_element_register (plugin, "formatconvert", GST_RANK_NONE,
      GST_TYPE_FORMATCONVERT);
}

/* FIXME: these are normally defined by the GStreamer build system.
   If you are creating an element to be included in gst-plugins-*,
   remove these, as they're always defined.  Otherwise, edit as
   appropriate for your external plugin package. */
#ifndef VERSION
#define VERSION "0.0.FIXME"
#endif
#ifndef PACKAGE
#define PACKAGE "FIXME_package"
#endif
#ifndef PACKAGE_NAME
#define PACKAGE_NAME "FIXME_package_name"
#endif
#ifndef GST_PACKAGE_ORIGIN
#define GST_PACKAGE_ORIGIN "http://FIXME.org/"
#endif

GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
    GST_VERSION_MINOR,
    formatconvert,
    "FIXME plugin description",
    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
2

Can you provide some information how you run it and how it fails?

At the very least, you’ll have to implement GstBaseTransform::transform_caps() to convert from the GRAY8 to the corresponding NV12 caps and the other way around. If you don’t implement this then sink and source pad caps are assumed to be the same, which is exactly not what you want here.

3 

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <gst/gst.h>
#include <gst/video/video.h>
#include <gst/video/gstvideofilter.h>
#include "gstformatconvert.hpp"

GST_DEBUG_CATEGORY_STATIC (gst_formatconvert_debug_category);
#define GST_CAT_DEFAULT gst_formatconvert_debug_category


static void gst_formatconvert_set_property (GObject * object,
    guint property_id, const GValue * value, GParamSpec * pspec);
static void gst_formatconvert_get_property (GObject * object,
    guint property_id, GValue * value, GParamSpec * pspec);
static void gst_formatconvert_dispose (GObject * object);
static void gst_formatconvert_finalize (GObject * object);

static gboolean gst_formatconvert_start (GstBaseTransform * trans);
static gboolean gst_formatconvert_stop (GstBaseTransform * trans);

static gboolean gst_formatconvert_set_info (GstVideoFilter * filter,
    GstCaps * incaps, GstVideoInfo * in_info, GstCaps * outcaps,GstVideoInfo * out_info);

static GstFlowReturn gst_formatconvert_transform_frame (GstVideoFilter * filter,
    GstVideoFrame * inframe, GstVideoFrame * outframe);

static GstFlowReturn gst_formatconvert_transform_frame_ip (GstVideoFilter *
    filter, GstVideoFrame * frame);

enum
{
  PROP_0
};

/* pad templates */

/* FIXME: add/remove formats you can handle */
#define VIDEO_SRC_CAPS \
    GST_VIDEO_CAPS_MAKE("{GRAY8}")

/* FIXME: add/remove formats you can handle */
#define VIDEO_SINK_CAPS \
    GST_VIDEO_CAPS_MAKE("{GRAY8}")


/* class initialization */

G_DEFINE_TYPE_WITH_CODE (GstFormatconvert, gst_formatconvert,
    GST_TYPE_VIDEO_FILTER,
    GST_DEBUG_CATEGORY_INIT (gst_formatconvert_debug_category, "formatconvert",
        0, "debug category for formatconvert element"));

static void
gst_formatconvert_class_init (GstFormatconvertClass * klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  GstBaseTransformClass *base_transform_class =
      GST_BASE_TRANSFORM_CLASS (klass);
  GstVideoFilterClass *video_filter_class = GST_VIDEO_FILTER_CLASS (klass);

  /* Setting up pads and setting metadata should be moved to
     base_class_init if you intend to subclass this class. */
  gst_element_class_add_pad_template (GST_ELEMENT_CLASS (klass),
      gst_pad_template_new ("src",
                            GST_PAD_SRC,
                            GST_PAD_ALWAYS,
                            gst_caps_from_string (VIDEO_SRC_CAPS)));
                            
  gst_element_class_add_pad_template (GST_ELEMENT_CLASS (klass),
      gst_pad_template_new ("sink",
                            GST_PAD_SINK,
                            GST_PAD_ALWAYS,
                            gst_caps_from_string (VIDEO_SINK_CAPS)));

  gst_element_class_set_static_metadata (GST_ELEMENT_CLASS (klass),
      "FIXME Long name", "Generic", "FIXME Description",
      "FIXME <fixme@example.com>");

  gobject_class->set_property = gst_formatconvert_set_property;
  gobject_class->get_property = gst_formatconvert_get_property;
  gobject_class->dispose = gst_formatconvert_dispose;
  gobject_class->finalize = gst_formatconvert_finalize;

  base_transform_class->start = GST_DEBUG_FUNCPTR (gst_formatconvert_start);

  base_transform_class->stop = GST_DEBUG_FUNCPTR (gst_formatconvert_stop);

  video_filter_class->set_info = GST_DEBUG_FUNCPTR (gst_formatconvert_set_info);

  video_filter_class->transform_frame =
      GST_DEBUG_FUNCPTR (gst_formatconvert_transform_frame);

  video_filter_class->transform_frame_ip =
      GST_DEBUG_FUNCPTR (gst_formatconvert_transform_frame_ip);

}

static void
gst_formatconvert_init (GstFormatconvert * formatconvert)
{
}

void
gst_formatconvert_set_property (GObject * object, guint property_id,
    const GValue * value, GParamSpec * pspec)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "set_property");

  switch (property_id) {
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
  }
}

void
gst_formatconvert_get_property (GObject * object, guint property_id,
    GValue * value, GParamSpec * pspec)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "get_property");

  switch (property_id) {
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
  }
}

void
gst_formatconvert_dispose (GObject * object)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "dispose");

  /* clean up as possible.  may be called multiple times */

  G_OBJECT_CLASS (gst_formatconvert_parent_class)->dispose (object);
}

void
gst_formatconvert_finalize (GObject * object)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (object);

  GST_DEBUG_OBJECT (formatconvert, "finalize");

  /* clean up object here */

  G_OBJECT_CLASS (gst_formatconvert_parent_class)->finalize (object);
}

static gboolean
gst_formatconvert_start (GstBaseTransform * trans)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (trans);

  GST_DEBUG_OBJECT (formatconvert, "start");

  return TRUE;
}

static gboolean
gst_formatconvert_stop (GstBaseTransform * trans)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (trans);

  GST_DEBUG_OBJECT (formatconvert, "stop");

  return TRUE;
}


static gboolean
gst_formatconvert_set_info (GstVideoFilter * filter, GstCaps * incaps,
    GstVideoInfo * in_info, GstCaps * outcaps, GstVideoInfo * out_info)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (filter);

  GST_DEBUG_OBJECT (formatconvert, "set_info");

  return TRUE; // Indicate successful configuration

  
}

static GstFlowReturn
gst_formatconvert_transform_frame(GstVideoFilter *filter,
                                  GstVideoFrame *inframe,
                                  GstVideoFrame *outframe)
{
    GstFormatconvert *formatconvert = GST_FORMATCONVERT(filter);

    GST_DEBUG_OBJECT(formatconvert, "transform_frame");

    // Retrieve the video info from the inframe
    GstVideoInfo *video_info = &inframe->info;

    // Retrieve the format from the video info
    GstVideoFormat format = GST_VIDEO_INFO_FORMAT(video_info);

    guint n_planes = GST_VIDEO_INFO_N_PLANES(video_info);

    g_print("No of Planes : %d\n", n_planes);

    // Convert the format to a string for easier reading
    const gchar *format_str = gst_video_format_to_string(format);

    // Print or use the format as needed
    g_print("Captured video format: %s\n", format_str);

    guint width = GST_VIDEO_FRAME_WIDTH(inframe);
    guint height = GST_VIDEO_FRAME_HEIGHT(inframe);

    guint8 *inframe_data =  (guint8*) GST_VIDEO_FRAME_PLANE_DATA(inframe, 0); // GRAY8 data
    guint8 *outframe_data = (guint8*) GST_VIDEO_FRAME_PLANE_DATA(outframe, 0);
  
    guint inframe_stride = GST_VIDEO_FRAME_PLANE_STRIDE(inframe, 0);
    guint outframe_stride = GST_VIDEO_FRAME_PLANE_STRIDE(outframe, 0);

    for (guint y = 0; y < height; y++) 
    {
        for (guint x = 0; x < width; x++) 
        {
            // Convert GRAY8 pixel to Y value
            guint8 gray_pixel = inframe_data[y * inframe_stride + x];
            outframe_data[y * outframe_stride + x] = gray_pixel;

        }
    }

    return GST_FLOW_OK;
}

static GstFlowReturn
gst_formatconvert_transform_frame_ip (GstVideoFilter * filter,
    GstVideoFrame * frame)
{
  GstFormatconvert *formatconvert = GST_FORMATCONVERT (filter);

  GST_DEBUG_OBJECT (formatconvert, "transform_frame_ip");

  return GST_FLOW_OK;
}

static gboolean
plugin_init (GstPlugin * plugin)
{

  /* FIXME Remember to set the rank if it's an element that is meant
     to be autoplugged by decodebin. */
  return gst_element_register (plugin, "formatconvert", GST_RANK_NONE,
      GST_TYPE_FORMATCONVERT);
}

/* FIXME: these are normally defined by the GStreamer build system.
   If you are creating an element to be included in gst-plugins-*,
   remove these, as they're always defined.  Otherwise, edit as
   appropriate for your external plugin package. */
#ifndef VERSION
#define VERSION "0.0.FIXME"
#endif
#ifndef PACKAGE
#define PACKAGE "FIXME_package"
#endif
#ifndef PACKAGE_NAME
#define PACKAGE_NAME "FIXME_package_name"
#endif
#ifndef GST_PACKAGE_ORIGIN
#define GST_PACKAGE_ORIGIN "http://FIXME.org/"
#endif

GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
    GST_VERSION_MINOR,
    formatconvert,
    "FIXME plugin description",
    plugin_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)

So far I have element built from videofilter baseclass that accepts GRAY8 data, how do I further continue to build the pulgin that converts GRAY8 data to NV12. Please help me out since I am new to GStreamer.

4

See above, you’ll have to at least implement transform_caps(). Check the various elements in the GStreamer code base for some examples.

For Rust, there would also be a small tutorial that explains more or less exactly your use-case: tutorial/tutorial-1.md · main · GStreamer / gst-plugins-rs · GitLab

1 Like
5

Thanks for the Guidance. I successfully built the Plugin