subprojects/gst-plugins-bad/ext/opencv/gstcvsobel.cpp

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2010 Thiago Santos <thiago.sousa.santos@collabora.co.uk>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Alternatively, the contents of this file may be used under the
  24  * GNU Lesser General Public License Version 2.1 (the "LGPL"), in
  25  * which case the following provisions apply instead of the ones
  26  * mentioned above:
  27  *
  28  * This library is free software; you can redistribute it and/or
  29  * modify it under the terms of the GNU Library General Public
  30  * License as published by the Free Software Foundation; either
  31  * version 2 of the License, or (at your option) any later version.
  32  *
  33  * This library is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  36  * Library General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU Library General Public
  39  * License along with this library; if not, write to the
  40  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  41  * Boston, MA 02110-1301, USA.
  42  */
  43
  44 /**
  45  * SECTION:element-cvsobel
  46  *
  47  * Applies the cvSobel OpenCV function to the image.
  48  *
  49  * ## Example launch line
  50  *
  51  * |[
  52  * gst-launch-1.0 videotestsrc ! cvsobel ! videoconvert ! autovideosink
  53  * ]|
  54  */
  55
  56 #ifdef HAVE_CONFIG_H
  57 #  include <config.h>
  58 #endif
  59
  60 #include "gstcvsobel.h"
  61 #include <opencv2/imgproc.hpp>
  62
  63 GST_DEBUG_CATEGORY_STATIC (gst_cv_sobel_debug);
  64 #define GST_CAT_DEFAULT gst_cv_sobel_debug
  65
  66 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  67     GST_PAD_SINK,
  68     GST_PAD_ALWAYS,
  69     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE ("RGB"))
  70     );
  71
  72 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  73     GST_PAD_SRC,
  74     GST_PAD_ALWAYS,
  75     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE ("RGB"))
  76     );
  77
  78 /* Filter signals and args */
  79 enum
  80 {
  81   /* FILL ME */
  82   LAST_SIGNAL
  83 };
  84 enum
  85 {
  86   PROP_0,
  87   PROP_X_ORDER,
  88   PROP_Y_ORDER,
  89   PROP_APERTURE_SIZE,
  90   PROP_MASK
  91 };
  92
  93 #define DEFAULT_X_ORDER 1
  94 #define DEFAULT_Y_ORDER 0
  95 #define DEFAULT_APERTURE_SIZE 3
  96 #define DEFAULT_MASK TRUE
  97
  98 G_DEFINE_TYPE_WITH_CODE (GstCvSobel, gst_cv_sobel, GST_TYPE_OPENCV_VIDEO_FILTER,
  99     GST_DEBUG_CATEGORY_INIT (gst_cv_sobel_debug, "cvsobel", 0, "cvsobel");
 100     );
 101 GST_ELEMENT_REGISTER_DEFINE (cvsobel, "cvsobel", GST_RANK_NONE,
 102     GST_TYPE_CV_SOBEL);
 103
 104 static void gst_cv_sobel_set_property (GObject * object, guint prop_id,
 105     const GValue * value, GParamSpec * pspec);
 106 static void gst_cv_sobel_get_property (GObject * object, guint prop_id,
 107     GValue * value, GParamSpec * pspec);
 108
 109 static GstFlowReturn gst_cv_sobel_transform (GstOpencvVideoFilter * filter,
 110     GstBuffer * buf, cv::Mat img, GstBuffer * outbuf, cv::Mat outimg);
 111 static gboolean gst_cv_sobel_set_caps (GstOpencvVideoFilter * transform,
 112     gint in_width, gint in_height, int in_cv_type,
 113     gint out_width, gint out_height, int out_cv_type);
 114
 115 /* Clean up */
 116 static void
 117 gst_cv_sobel_finalize (GObject * obj)
 118 {
 119   GstCvSobel *filter = GST_CV_SOBEL (obj);
 120
 121   filter->cvGray.release ();
 122   filter->cvSobel.release ();
 123
 124   G_OBJECT_CLASS (gst_cv_sobel_parent_class)->finalize (obj);
 125 }
 126
 127 /* initialize the cvsobel's class */
 128 static void
 129 gst_cv_sobel_class_init (GstCvSobelClass * klass)
 130 {
 131   GObjectClass *gobject_class;
 132   GstOpencvVideoFilterClass *gstopencvbasefilter_class;
 133
 134   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 135   gobject_class = (GObjectClass *) klass;
 136   gstopencvbasefilter_class = (GstOpencvVideoFilterClass *) klass;
 137
 138   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_cv_sobel_finalize);
 139   gobject_class->set_property = gst_cv_sobel_set_property;
 140   gobject_class->get_property = gst_cv_sobel_get_property;
 141
 142   gstopencvbasefilter_class->cv_trans_func = gst_cv_sobel_transform;
 143   gstopencvbasefilter_class->cv_set_caps = gst_cv_sobel_set_caps;
 144
 145   g_object_class_install_property (gobject_class, PROP_X_ORDER,
 146       g_param_spec_int ("x-order", "x order",
 147           "Order of the derivative x", -1, G_MAXINT,
 148           DEFAULT_X_ORDER,
 149           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 150   g_object_class_install_property (gobject_class, PROP_Y_ORDER,
 151       g_param_spec_int ("y-order", "y order", "Order of the derivative y", -1,
 152           G_MAXINT, DEFAULT_Y_ORDER,
 153           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 154   g_object_class_install_property (gobject_class, PROP_APERTURE_SIZE,
 155       g_param_spec_int ("aperture-size", "aperture size",
 156           "Size of the extended Sobel Kernel (1, 3, 5 or 7)", 1, 7,
 157           DEFAULT_APERTURE_SIZE,
 158           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 159   g_object_class_install_property (gobject_class, PROP_MASK,
 160       g_param_spec_boolean ("mask", "Mask",
 161           "Sets whether the detected derivative edges should be used as a mask on the original input or not",
 162           DEFAULT_MASK,
 163           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 164
 165   gst_element_class_add_static_pad_template (element_class, &src_factory);
 166   gst_element_class_add_static_pad_template (element_class, &sink_factory);
 167
 168   gst_element_class_set_static_metadata (element_class,
 169       "cvsobel",
 170       "Transform/Effect/Video",
 171       "Applies cvSobel OpenCV function to the image",
 172       "Thiago Santos<thiago.sousa.santos@collabora.co.uk>");
 173 }
 174
 175 static void
 176 gst_cv_sobel_init (GstCvSobel * filter)
 177 {
 178   filter->x_order = DEFAULT_X_ORDER;
 179   filter->y_order = DEFAULT_Y_ORDER;
 180   filter->aperture_size = DEFAULT_APERTURE_SIZE;
 181   filter->mask = DEFAULT_MASK;
 182
 183   gst_opencv_video_filter_set_in_place (GST_OPENCV_VIDEO_FILTER_CAST (filter),
 184       FALSE);
 185 }
 186
 187 /* this function handles the link with other elements */
 188 static gboolean
 189 gst_cv_sobel_set_caps (GstOpencvVideoFilter * transform,
 190     gint in_width, gint in_height, int in_cv_type,
 191     gint out_width, gint out_height, int out_cv_type)
 192 {
 193   GstCvSobel *filter = GST_CV_SOBEL (transform);
 194
 195   filter->cvGray.create (cv::Size (in_width, in_height), CV_8UC1);
 196   filter->cvSobel.create (cv::Size (out_width, out_height), CV_8UC1);
 197
 198   return TRUE;
 199 }
 200
 201 static void
 202 gst_cv_sobel_set_property (GObject * object, guint prop_id,
 203     const GValue * value, GParamSpec * pspec)
 204 {
 205   GstCvSobel *filter = GST_CV_SOBEL (object);
 206
 207   switch (prop_id) {
 208     case PROP_X_ORDER:
 209       filter->x_order = g_value_get_int (value);
 210       break;
 211     case PROP_Y_ORDER:
 212       filter->y_order = g_value_get_int (value);
 213       break;
 214     case PROP_APERTURE_SIZE:{
 215       gint as = g_value_get_int (value);
 216
 217       if (as % 2 != 1) {
 218         GST_WARNING_OBJECT (filter, "Invalid value %d for aperture size", as);
 219       } else
 220         filter->aperture_size = g_value_get_int (value);
 221     }
 222       break;
 223     case PROP_MASK:
 224       filter->mask = g_value_get_boolean (value);
 225       break;
 226     default:
 227       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 228       break;
 229   }
 230 }
 231
 232 static void
 233 gst_cv_sobel_get_property (GObject * object, guint prop_id,
 234     GValue * value, GParamSpec * pspec)
 235 {
 236   GstCvSobel *filter = GST_CV_SOBEL (object);
 237
 238   switch (prop_id) {
 239     case PROP_X_ORDER:
 240       g_value_set_int (value, filter->x_order);
 241       break;
 242     case PROP_Y_ORDER:
 243       g_value_set_int (value, filter->y_order);
 244       break;
 245     case PROP_APERTURE_SIZE:
 246       g_value_set_int (value, filter->aperture_size);
 247       break;
 248     case PROP_MASK:
 249       g_value_set_boolean (value, filter->mask);
 250       break;
 251     default:
 252       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 253       break;
 254   }
 255 }
 256
 257 static GstFlowReturn
 258 gst_cv_sobel_transform (GstOpencvVideoFilter * base, GstBuffer * buf,
 259     cv::Mat img, GstBuffer * outbuf, cv::Mat outimg)
 260 {
 261   GstCvSobel *filter = GST_CV_SOBEL (base);
 262
 263   cv::cvtColor (img, filter->cvGray, cv::COLOR_RGB2GRAY);
 264   cv::Sobel (filter->cvGray, filter->cvSobel, filter->cvGray.depth (),
 265       filter->x_order, filter->y_order, filter->aperture_size);
 266
 267   outimg.setTo (cv::Scalar::all (0));
 268   if (filter->mask) {
 269     img.copyTo (outimg, filter->cvSobel);
 270   } else {
 271     cv::cvtColor (filter->cvSobel, outimg, cv::COLOR_GRAY2RGB);
 272   }
 273
 274   return GST_FLOW_OK;
 275 }