3 * Copyright (C) 2006 Stefan Kost <ensonic@users.sf.net>
4 * Copyright (c) 2020 Anthony Violo <anthony.violo@ubicast.eu>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * SECTION:element-debugqroverlay
25 * This element will build a Json string that contains a description of the
26 * buffer and will convert the string to a QRcode. The QRcode contains a
27 * timestamp, a buffer number, a framerate and some custom extra-data. Each
28 * frame will have a Qrcode overlaid in the video stream. Some properties are
29 * available to set the position and to define its size. You can add custom data
30 * with the properties #debugqroverlay:extra-data-name and
31 * #debugqroverlay:extra-data-array. You can also define the quality of the Qrcode
32 * with #GstBaseQROverlay:qrcode-error-correction. You can also define interval and
33 * span of #debugqroverlay:extra-data-name #debugqroverlay:extra-data-array
35 * ## Example launch line
38 * gst-launch -v -m videotestsrc ! debugqroverlay ! fakesink silent=TRUE
49 #include <gst/base/gstbasetransform.h>
50 #include <json-glib/json-glib.h>
57 #include "gstqroverlayelements.h"
58 #include "gstdebugqroverlay.h"
61 GST_DEBUG_CATEGORY_STATIC (gst_debug_qr_overlay_debug);
62 #define GST_CAT_DEFAULT gst_debug_qr_overlay_debug
64 static gchar *get_qrcode_content (GstBaseQROverlay * base, GstBuffer * buf,
65 GstVideoInfo * info, gboolean * reuse_prev);
70 PROP_DATA_INTERVAL_BUFFERS,
71 PROP_DATA_SPAN_BUFFERS,
73 PROP_EXTRA_DATA_ARRAY,
76 struct _GstDebugQROverlay
78 GstBaseQROverlay parent;
84 guint64 extra_data_interval_buffers;
85 guint64 extra_data_span_buffers;
86 gchar *extra_data_name;
87 gchar *extra_data_str;
88 gchar **extra_data_array;
92 gboolean extra_data_enabled;
95 #define DEFAULT_PROP_QUALITY 1
96 #define DEFAULT_PROP_PIXEL_SIZE 3
98 #define gst_debug_qr_overlay_parent_class parent_class
99 G_DEFINE_TYPE (GstDebugQROverlay, gst_debug_qr_overlay,
100 GST_TYPE_BASE_QR_OVERLAY);
101 GST_ELEMENT_REGISTER_DEFINE_WITH_CODE (debugqroverlay, "debugqroverlay",
102 GST_RANK_NONE, GST_TYPE_DEBUG_QR_OVERLAY, qroverlay_element_init (plugin));
105 static void gst_debug_qr_overlay_set_property (GObject * object, guint prop_id,
106 const GValue * value, GParamSpec * pspec);
107 static void gst_debug_qr_overlay_get_property (GObject * object, guint prop_id,
108 GValue * value, GParamSpec * pspec);
110 /* initialize the qroverlay's class */
112 gst_debug_qr_overlay_class_init (GstDebugQROverlayClass * klass)
114 GObjectClass *gobject_class;
115 GstElementClass *gstelement_class;
117 gobject_class = (GObjectClass *) klass;
118 gstelement_class = (GstElementClass *) klass;
120 GST_DEBUG_CATEGORY_INIT (gst_debug_qr_overlay_debug, "debugqroverlay", 0,
121 "Qrcode overlay element");
123 gobject_class->set_property = gst_debug_qr_overlay_set_property;
124 gobject_class->get_property = gst_debug_qr_overlay_get_property;
126 g_object_class_install_property (gobject_class,
127 PROP_DATA_INTERVAL_BUFFERS,
128 g_param_spec_int64 ("extra-data-interval-buffers",
129 "extra-data-interval-buffers",
130 "Extra data append into the Qrcode at the first buffer of each "
131 " interval", 0, G_MAXINT64, 60, G_PARAM_READWRITE));
133 g_object_class_install_property (gobject_class,
134 PROP_DATA_SPAN_BUFFERS, g_param_spec_int64 ("extra-data-span-buffers",
135 "extra-data-span-buffers",
136 "Numbers of consecutive buffers that the extra data will be inserted "
137 " (counting the first buffer)", 0, G_MAXINT64, 1, G_PARAM_READWRITE));
139 g_object_class_install_property (gobject_class,
140 PROP_EXTRA_DATA_NAME, g_param_spec_string ("extra-data-name",
142 "Json key name for extra append data", NULL, G_PARAM_READWRITE));
144 g_object_class_install_property (gobject_class,
145 PROP_EXTRA_DATA_ARRAY, g_param_spec_string ("extra-data-array",
147 "List of comma separated values that the extra data value will be "
148 " cycled from at each interval, example array structure :"
149 " \"240,480,720,960,1200,1440,1680,1920\"", NULL, G_PARAM_READWRITE));
152 gst_element_class_set_details_simple (gstelement_class,
154 "Qrcode overlay containing buffer information",
155 "Overlay Qrcodes over each buffer with buffer information and custom data",
156 "Anthony Violo <anthony.violo@ubicast.eu>");
158 gst_type_mark_as_plugin_api (GST_TYPE_BASE_QR_OVERLAY, 0);
160 GST_BASE_QR_OVERLAY_CLASS (klass)->get_content =
161 GST_DEBUG_FUNCPTR (get_qrcode_content);
164 /* initialize the new element
165 * initialize instance structure
168 gst_debug_qr_overlay_init (GstDebugQROverlay * filter)
170 filter->frame_number = 1;
171 filter->x_percent = 50.0;
172 filter->y_percent = 50.0;
173 filter->array_counter = 0;
174 filter->array_size = 0;
175 filter->extra_data_interval_buffers = 60;
176 filter->extra_data_span_buffers = 1;
177 filter->span_frame = 0;
181 gst_debug_qr_overlay_set_property (GObject * object, guint prop_id,
182 const GValue * value, GParamSpec * pspec)
184 GstDebugQROverlay *filter = GST_DEBUG_QR_OVERLAY (object);
187 case PROP_DATA_INTERVAL_BUFFERS:
188 filter->extra_data_interval_buffers = g_value_get_int64 (value);
190 case PROP_DATA_SPAN_BUFFERS:
191 filter->extra_data_span_buffers = g_value_get_int64 (value);
193 case PROP_EXTRA_DATA_NAME:
194 filter->extra_data_name = g_value_dup_string (value);
196 case PROP_EXTRA_DATA_ARRAY:
198 g_clear_pointer (&filter->extra_data_str, g_free);
199 g_clear_pointer (&filter->extra_data_array, g_strfreev);
200 filter->extra_data_str = g_value_dup_string (value);
201 if (filter->extra_data_str) {
202 filter->extra_data_array = g_strsplit (filter->extra_data_str, ",", -1);
203 filter->array_size = g_strv_length (filter->extra_data_array);
208 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
214 gst_debug_qr_overlay_get_property (GObject * object, guint prop_id,
215 GValue * value, GParamSpec * pspec)
217 GstDebugQROverlay *filter = GST_DEBUG_QR_OVERLAY (object);
220 case PROP_DATA_INTERVAL_BUFFERS:
221 g_value_set_int64 (value, filter->extra_data_interval_buffers);
223 case PROP_DATA_SPAN_BUFFERS:
224 g_value_set_int64 (value, filter->extra_data_span_buffers);
226 case PROP_EXTRA_DATA_NAME:
227 g_value_set_string (value, filter->extra_data_name);
229 case PROP_EXTRA_DATA_ARRAY:
230 g_value_set_string (value, filter->extra_data_str);
233 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
239 get_qrcode_content (GstBaseQROverlay * base, GstBuffer * buf,
240 GstVideoInfo * info, gboolean * reuse_prev)
242 GstDebugQROverlay *filter = GST_DEBUG_QR_OVERLAY (base);
243 GString *res = g_string_new (NULL);
245 gchar *framerate_string = g_strdup_printf ("%d/%d", info->fps_n, info->fps_d);
247 JsonObject *jobj = json_object_new ();
248 JsonNode *root = json_node_new (JSON_NODE_OBJECT);
251 json_object_set_int_member (jobj, "TIMESTAMP",
252 (gint64) GST_BUFFER_TIMESTAMP (buf));
253 json_object_set_int_member (jobj, "BUFFERCOUNT",
254 (gint64) filter->frame_number);
255 json_object_set_string_member (jobj, "FRAMERATE", framerate_string);
256 json_object_set_string_member (jobj, "NAME", GST_ELEMENT_NAME (filter));
257 g_free (framerate_string);
259 if (filter->extra_data_array && filter->extra_data_name &&
260 (filter->frame_number == 1
261 || filter->frame_number % filter->extra_data_interval_buffers == 1
262 || (filter->span_frame > 0
263 && filter->span_frame < filter->extra_data_span_buffers))) {
264 json_object_set_string_member (jobj, filter->extra_data_name,
265 filter->extra_data_array[filter->array_counter]);
267 filter->span_frame++;
268 if (filter->span_frame == filter->extra_data_span_buffers) {
269 filter->array_counter++;
270 filter->span_frame = 0;
271 if (filter->array_counter >= filter->array_size)
272 filter->array_counter = 0;
276 jgen = json_generator_new ();
277 json_node_set_object (root, jobj);
278 json_generator_set_root (jgen, root);
279 res = json_generator_to_gstring (jgen, res);
280 g_object_unref (jgen);
281 filter->frame_number++;
283 return g_strdup (g_string_free (res, FALSE));