mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-09-08 13:18:52 +00:00
c307f1418d
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1730>
463 lines
15 KiB
C
Executable file
463 lines
15 KiB
C
Executable file
/*
|
|
* GStreamer
|
|
* Copyright (C) 2006 Stefan Kost <ensonic@users.sf.net>
|
|
* Copyright (c) 2020 Anthony Violo <anthony.violo@ubicast.eu>
|
|
*
|
|
* 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., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
/**
|
|
* SECTION:element-qroverlay
|
|
*
|
|
* This element will build a Json string that contains a description of the
|
|
* buffer and will convert the string to a QRcode. The QRcode contains a
|
|
* timestamp, a buffer number, a framerate and some custom extra-data. Each
|
|
* frame will have a Qrcode overlaid in the video stream. Some properties are
|
|
* available to set the position and to define its size. You can add custom data
|
|
* with the properties #qroverlay:extra-data-name and
|
|
* #qroverlay:extra-data-array. You can also define the quality of the Qrcode
|
|
* with #qroverlay:qrcode-error-correction. You can also define interval and
|
|
* span of #qrovlerlay:extra-data-name #qrovlerlay:extra-data-array
|
|
*
|
|
* ## Example launch line
|
|
*
|
|
* ``` bash
|
|
* gst-launch -v -m videotestsrc ! qroverlay ! fakesink silent=TRUE
|
|
* ```
|
|
*
|
|
* Since: 1.20
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/base/gstbasetransform.h>
|
|
#include <json-glib/json-glib.h>
|
|
|
|
#include <qrencode.h>
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
#include "gstqroverlay.h"
|
|
|
|
GST_DEBUG_CATEGORY_STATIC (gst_qr_overlay_debug);
|
|
#define GST_CAT_DEFAULT gst_qr_overlay_debug
|
|
|
|
enum
|
|
{
|
|
PROP_0,
|
|
PROP_X_AXIS,
|
|
PROP_Y_AXIS,
|
|
PROP_PIXEL_SIZE,
|
|
PROP_DATA_INTERVAL_BUFFERS,
|
|
PROP_DATA_SPAN_BUFFERS,
|
|
PROP_EXTRA_DATA_NAME,
|
|
PROP_EXTRA_DATA_ARRAY,
|
|
PROP_QRCODE_ERROR_CORRECTION,
|
|
};
|
|
|
|
|
|
static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
|
|
GST_PAD_SINK,
|
|
GST_PAD_ALWAYS,
|
|
GST_STATIC_CAPS ("video/x-raw, "
|
|
"format = (string) { I420 }, "
|
|
"framerate = (fraction) [0, MAX], "
|
|
"width = (int) [ 16, MAX ], " "height = (int) [ 16, MAX ]")
|
|
);
|
|
|
|
static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
|
|
GST_PAD_SRC,
|
|
GST_PAD_ALWAYS,
|
|
GST_STATIC_CAPS ("video/x-raw, "
|
|
"format = (string) { I420 }, "
|
|
"framerate = (fraction) [0, MAX], "
|
|
"width = (int) [ 16, MAX ], " "height = (int) [ 16, MAX ]")
|
|
);
|
|
|
|
#define DEFAULT_PROP_QUALITY 1
|
|
#define DEFAULT_PROP_PIXEL_SIZE 3
|
|
|
|
#define GST_TYPE_QRCODE_QUALITY (gst_qrcode_quality_get_type())
|
|
static GType
|
|
gst_qrcode_quality_get_type (void)
|
|
{
|
|
static GType qrcode_quality_type = 0;
|
|
|
|
static const GEnumValue qrcode_quality[] = {
|
|
{0, "Level L", "Approx 7%"},
|
|
{1, "Level M", "Approx 15%"},
|
|
{2, "Level Q", "Approx 25%"},
|
|
{3, "Level H", "Approx 30%"},
|
|
{0, NULL, NULL},
|
|
};
|
|
|
|
if (!qrcode_quality_type) {
|
|
qrcode_quality_type =
|
|
g_enum_register_static ("GstQrcodeOverlayCorrection", qrcode_quality);
|
|
}
|
|
return qrcode_quality_type;
|
|
}
|
|
|
|
#define gst_qr_overlay_parent_class parent_class
|
|
G_DEFINE_TYPE (GstQROverlay, gst_qr_overlay, GST_TYPE_VIDEO_FILTER);
|
|
|
|
static void gst_qr_overlay_set_property (GObject * object, guint prop_id,
|
|
const GValue * value, GParamSpec * pspec);
|
|
static void gst_qr_overlay_get_property (GObject * object, guint prop_id,
|
|
GValue * value, GParamSpec * pspec);
|
|
|
|
static GstFlowReturn
|
|
gst_qr_overlay_transform_frame_ip (GstVideoFilter * base,
|
|
GstVideoFrame * frame);
|
|
|
|
/* GObject vmethod implementations */
|
|
|
|
/* initialize the qroverlay's class */
|
|
static void
|
|
gst_qr_overlay_class_init (GstQROverlayClass * klass)
|
|
{
|
|
GObjectClass *gobject_class;
|
|
GstElementClass *gstelement_class;
|
|
|
|
gobject_class = (GObjectClass *) klass;
|
|
gstelement_class = (GstElementClass *) klass;
|
|
|
|
gobject_class->set_property = gst_qr_overlay_set_property;
|
|
gobject_class->get_property = gst_qr_overlay_get_property;
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_X_AXIS, g_param_spec_float ("x",
|
|
"X position (in percent of the width)",
|
|
"X position (in percent of the width)",
|
|
0.0, 100.0, 50.0, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_Y_AXIS, g_param_spec_float ("y",
|
|
"Y position (in percent of the height)",
|
|
"Y position (in percent of the height)",
|
|
0.0, 100.0, 50.0, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_PIXEL_SIZE, g_param_spec_float ("pixel-size",
|
|
"pixel-size", "Pixel size of each Qrcode pixel",
|
|
1, 100.0, DEFAULT_PROP_PIXEL_SIZE, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_DATA_INTERVAL_BUFFERS,
|
|
g_param_spec_int64 ("extra-data-interval-buffers",
|
|
"extra-data-interval-buffers",
|
|
"Extra data append into the Qrcode at the first buffer of each "
|
|
" interval", 0, G_MAXINT64, 60, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_DATA_SPAN_BUFFERS, g_param_spec_int64 ("extra-data-span-buffers",
|
|
"extra-data-span-buffers",
|
|
"Numbers of consecutive buffers that the extra data will be inserted "
|
|
" (counting the first buffer)", 0, G_MAXINT64, 1, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_EXTRA_DATA_NAME, g_param_spec_string ("extra-data-name",
|
|
"Extra data name",
|
|
"Json key name for extra append data", NULL, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_EXTRA_DATA_ARRAY, g_param_spec_string ("extra-data-array",
|
|
"Extra data array",
|
|
"List of comma separated values that the extra data value will be "
|
|
" cycled from at each interval, example array structure :"
|
|
" \"240,480,720,960,1200,1440,1680,1920\"", NULL, G_PARAM_READWRITE));
|
|
|
|
g_object_class_install_property (gobject_class, PROP_QRCODE_ERROR_CORRECTION,
|
|
g_param_spec_enum ("qrcode-error-correction", "qrcode-error-correction",
|
|
"qrcode-error-correction", GST_TYPE_QRCODE_QUALITY,
|
|
DEFAULT_PROP_QUALITY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
|
|
|
gst_element_class_set_details_simple (gstelement_class,
|
|
"qroverlay",
|
|
"Qrcode overlay containing buffer information",
|
|
"Overlay Qrcodes over each buffer with buffer information and custom data",
|
|
"Anthony Violo <anthony.violo@ubicast.eu>");
|
|
|
|
gst_element_class_add_pad_template (gstelement_class,
|
|
gst_static_pad_template_get (&src_template));
|
|
gst_element_class_add_pad_template (gstelement_class,
|
|
gst_static_pad_template_get (&sink_template));
|
|
|
|
gst_type_mark_as_plugin_api (GST_TYPE_QRCODE_QUALITY, 0);
|
|
|
|
GST_VIDEO_FILTER_CLASS (klass)->transform_frame_ip =
|
|
GST_DEBUG_FUNCPTR (gst_qr_overlay_transform_frame_ip);
|
|
}
|
|
|
|
/* initialize the new element
|
|
* initialize instance structure
|
|
*/
|
|
static void
|
|
gst_qr_overlay_init (GstQROverlay * filter)
|
|
{
|
|
filter->frame_number = 1;
|
|
filter->x_percent = 50.0;
|
|
filter->y_percent = 50.0;
|
|
filter->qrcode_quality = DEFAULT_PROP_QUALITY;
|
|
filter->array_counter = 0;
|
|
filter->array_size = 0;
|
|
filter->extra_data_interval_buffers = 60;
|
|
filter->extra_data_span_buffers = 1;
|
|
filter->span_frame = 0;
|
|
filter->qrcode_size = DEFAULT_PROP_PIXEL_SIZE;
|
|
}
|
|
|
|
static void
|
|
gst_qr_overlay_set_property (GObject * object, guint prop_id,
|
|
const GValue * value, GParamSpec * pspec)
|
|
{
|
|
GstQROverlay *filter = GST_QR_OVERLAY (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_X_AXIS:
|
|
filter->x_percent = g_value_get_float (value);
|
|
break;
|
|
case PROP_Y_AXIS:
|
|
filter->y_percent = g_value_get_float (value);
|
|
break;
|
|
case PROP_PIXEL_SIZE:
|
|
filter->qrcode_size = g_value_get_float (value);
|
|
break;
|
|
case PROP_QRCODE_ERROR_CORRECTION:
|
|
filter->qrcode_quality = g_value_get_enum (value);
|
|
break;
|
|
case PROP_DATA_INTERVAL_BUFFERS:
|
|
filter->extra_data_interval_buffers = g_value_get_int64 (value);
|
|
break;
|
|
case PROP_DATA_SPAN_BUFFERS:
|
|
filter->extra_data_span_buffers = g_value_get_int64 (value);
|
|
break;
|
|
case PROP_EXTRA_DATA_NAME:
|
|
filter->extra_data_name = g_value_dup_string (value);
|
|
break;
|
|
case PROP_EXTRA_DATA_ARRAY:
|
|
{
|
|
g_clear_pointer (&filter->extra_data_str, g_free);
|
|
g_clear_pointer (&filter->extra_data_array, g_strfreev);
|
|
filter->extra_data_str = g_value_dup_string (value);
|
|
if (filter->extra_data_str) {
|
|
filter->extra_data_array = g_strsplit (filter->extra_data_str, ",", -1);
|
|
filter->array_size = g_strv_length (filter->extra_data_array);
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
gst_qr_overlay_get_property (GObject * object, guint prop_id,
|
|
GValue * value, GParamSpec * pspec)
|
|
{
|
|
GstQROverlay *filter = GST_QR_OVERLAY (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_X_AXIS:
|
|
g_value_set_float (value, filter->x_percent);
|
|
break;
|
|
case PROP_Y_AXIS:
|
|
g_value_set_float (value, filter->y_percent);
|
|
break;
|
|
case PROP_PIXEL_SIZE:
|
|
g_value_set_float (value, filter->qrcode_size);
|
|
break;
|
|
case PROP_QRCODE_ERROR_CORRECTION:
|
|
g_value_set_enum (value, filter->qrcode_quality);
|
|
break;
|
|
case PROP_DATA_INTERVAL_BUFFERS:
|
|
g_value_set_int64 (value, filter->extra_data_interval_buffers);
|
|
break;
|
|
case PROP_DATA_SPAN_BUFFERS:
|
|
g_value_set_int64 (value, filter->extra_data_span_buffers);
|
|
break;
|
|
case PROP_EXTRA_DATA_NAME:
|
|
g_value_set_string (value, filter->extra_data_name);
|
|
break;
|
|
case PROP_EXTRA_DATA_ARRAY:
|
|
g_value_set_string (value, filter->extra_data_str);
|
|
break;
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static gchar *
|
|
get_qrcode_content (GstQROverlay * filter, GstBuffer * outbuf)
|
|
{
|
|
GString *res = g_string_new (NULL);
|
|
JsonGenerator *jgen;
|
|
|
|
JsonObject *jobj = json_object_new ();
|
|
JsonNode *root = json_node_new (JSON_NODE_OBJECT);
|
|
|
|
json_object_set_int_member (jobj, "TIMESTAMP",
|
|
(gint64) GST_BUFFER_TIMESTAMP (outbuf));
|
|
json_object_set_int_member (jobj, "BUFFERCOUNT",
|
|
(gint64) filter->frame_number);
|
|
json_object_set_string_member (jobj, "FRAMERATE", filter->framerate_string);
|
|
json_object_set_string_member (jobj, "NAME", GST_ELEMENT_NAME (filter));
|
|
|
|
if (filter->extra_data_array && filter->extra_data_name &&
|
|
(filter->frame_number == 1
|
|
|| filter->frame_number % filter->extra_data_interval_buffers == 1
|
|
|| (filter->span_frame > 0
|
|
&& filter->span_frame < filter->extra_data_span_buffers))) {
|
|
json_object_set_string_member (jobj, filter->extra_data_name,
|
|
filter->extra_data_array[filter->array_counter]);
|
|
|
|
filter->span_frame++;
|
|
if (filter->span_frame == filter->extra_data_span_buffers) {
|
|
filter->array_counter++;
|
|
filter->span_frame = 0;
|
|
if (filter->array_counter >= filter->array_size)
|
|
filter->array_counter = 0;
|
|
}
|
|
}
|
|
|
|
jgen = json_generator_new ();
|
|
json_node_set_object (root, jobj);
|
|
json_generator_set_root (jgen, root);
|
|
res = json_generator_to_gstring (jgen, res);
|
|
g_object_unref (jgen);
|
|
|
|
return g_strdup (g_string_free (res, FALSE));
|
|
}
|
|
|
|
static void
|
|
overlay_qr_in_frame (GstQROverlay * filter, QRcode * qrcode,
|
|
GstVideoFrame * frame)
|
|
{
|
|
guchar *source_data;
|
|
gint32 k, y, x, yy, square_size, line = 0;
|
|
int x1, x2, y1, y2;
|
|
guint8 *d;
|
|
gint stride;
|
|
|
|
square_size = (qrcode->width + 4 * 2) * filter->qrcode_size;
|
|
/* White bg */
|
|
x1 = (int) (GST_VIDEO_FRAME_WIDTH (frame) -
|
|
square_size) * (filter->x_percent / 100);
|
|
x1 = GST_ROUND_DOWN_2 (x1);
|
|
x2 = x1 + square_size;
|
|
y1 = (int) (GST_VIDEO_FRAME_HEIGHT (frame) -
|
|
square_size) * (filter->y_percent / 100);
|
|
y1 = GST_ROUND_DOWN_4 (y1);
|
|
y2 = y1 + square_size;
|
|
|
|
d = GST_VIDEO_FRAME_PLANE_DATA (frame, 0);
|
|
stride = GST_VIDEO_FRAME_PLANE_STRIDE (frame, 0);
|
|
|
|
/* Start drawing the white luma plane */
|
|
for (y = y1; y < y2; y++) {
|
|
for (x = x1; x < x2; x += square_size)
|
|
memset (&d[y * stride + x], 0xff, square_size);
|
|
}
|
|
|
|
/* Draw the black QR code blocks with 4px white space around it
|
|
* on top */
|
|
line += 4 * filter->qrcode_size * stride;
|
|
source_data = qrcode->data;
|
|
for (y = 0; y < qrcode->width; y++) {
|
|
for (x = 0; x < (qrcode->width); x++) {
|
|
for (yy = 0; yy < filter->qrcode_size; yy++) {
|
|
k = ((((line + (4 * filter->qrcode_size))) + stride * yy +
|
|
x * filter->qrcode_size) + x1) + (y1 * stride);
|
|
if (*source_data & 1) {
|
|
memset (d + k, 0, filter->qrcode_size);
|
|
}
|
|
}
|
|
source_data++;
|
|
}
|
|
line += (stride * filter->qrcode_size);
|
|
}
|
|
|
|
/* Set Chrominance planes */
|
|
x1 /= 2;
|
|
x2 /= 2;
|
|
y1 /= 2;
|
|
y2 /= 2;
|
|
stride = GST_VIDEO_FRAME_PLANE_STRIDE (frame, 1);
|
|
for (y = y1; y < y2; y++) {
|
|
for (x = x1; x < x2; x += (x2 - x1)) {
|
|
d = GST_VIDEO_FRAME_PLANE_DATA (frame, 1);
|
|
memset (&d[y * stride + x], 128, (x2 - x1));
|
|
d = GST_VIDEO_FRAME_PLANE_DATA (frame, 2);
|
|
memset (&d[y * stride + x], 128, (x2 - x1));
|
|
}
|
|
}
|
|
|
|
QRcode_free (qrcode);
|
|
}
|
|
|
|
/* GstBaseTransform vmethod implementations */
|
|
/* this function does the actual processing
|
|
*/
|
|
static GstFlowReturn
|
|
gst_qr_overlay_transform_frame_ip (GstVideoFilter * base, GstVideoFrame * frame)
|
|
{
|
|
GstQROverlay *filter = GST_QR_OVERLAY (base);
|
|
QRcode *qrcode;
|
|
gchar *content;
|
|
GstClockTime rtime =
|
|
gst_segment_to_running_time (&GST_BASE_TRANSFORM (base)->segment,
|
|
GST_FORMAT_TIME, GST_BUFFER_PTS (frame->buffer));
|
|
|
|
if (GST_CLOCK_TIME_IS_VALID (rtime))
|
|
gst_object_sync_values (GST_OBJECT (filter), rtime);
|
|
|
|
content = get_qrcode_content (filter, frame->buffer);
|
|
GST_INFO_OBJECT (filter, "String will be encoded : %s", content);
|
|
qrcode =
|
|
QRcode_encodeString (content, 0, filter->qrcode_quality, QR_MODE_8, 0);
|
|
if (qrcode) {
|
|
GST_DEBUG_OBJECT (filter, "String encoded");
|
|
overlay_qr_in_frame (filter, qrcode, frame);
|
|
filter->frame_number++;
|
|
} else {
|
|
GST_WARNING_OBJECT (filter, "Could not encode content: %s", content);
|
|
}
|
|
g_free (content);
|
|
|
|
return GST_FLOW_OK;
|
|
}
|
|
|
|
static gboolean
|
|
qroverlay_init (GstPlugin * qroverlay)
|
|
{
|
|
GST_DEBUG_CATEGORY_INIT (gst_qr_overlay_debug, "qroverlay", 0,
|
|
"Qrcode overlay element");
|
|
|
|
return gst_element_register (qroverlay, "qroverlay", GST_RANK_NONE,
|
|
GST_TYPE_QR_OVERLAY);
|
|
}
|
|
|
|
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
|
|
GST_VERSION_MINOR,
|
|
qroverlay,
|
|
"libqrencode qroverlay plugin",
|
|
qroverlay_init, VERSION, "LGPL", PACKAGE_NAME, GST_PACKAGE_ORIGIN)
|