gst/gaudieffects/gstsolarize.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2010 Luis de Bethencourt <luis@debethencourt.com>
   4  *
   5  * Solarize - curve adjustment video effect.
   6  * Based on Pete Warden's FreeFrame plugin with the same name.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * Alternatively, the contents of this file may be used under the
  27  * GNU Lesser General Public License Version 2.1 (the "LGPL"), in
  28  * which case the following provisions apply instead of the ones
  29  * mentioned above:
  30  *
  31  * This library is free software; you can redistribute it and/or
  32  * modify it under the terms of the GNU Library General Public
  33  * License as published by the Free Software Foundation; either
  34  * version 2 of the License, or (at your option) any later version.
  35  *
  36  * This library is distributed in the hope that it will be useful,
  37  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  38  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  39  * Library General Public License for more details.
  40  *
  41  * You should have received a copy of the GNU Library General Public
  42  * License along with this library; if not, write to the
  43  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  44  * Boston, MA 02111-1307, USA.
  45  */
  46
  47 /**
  48  * SECTION:element-solarize
  49  *
  50  * Solarize does a smart inverse in a video stream in realtime.
  51  *
  52  * <refsect2>
  53  * <title>Example launch line</title>
  54  * |[
  55  * gst-launch -v videotestsrc ! solarize ! ffmpegcolorspace ! autovideosink
  56  * ]| This pipeline shows the effect of solarize on a test stream
  57  * </refsect2>
  58  */
  59
  60 #ifdef HAVE_CONFIG_H
  61 #  include <config.h>
  62 #endif
  63
  64 #include <gst/gst.h>
  65 #include <math.h>
  66
  67 #include "gstplugin.h"
  68 #include "gstsolarize.h"
  69
  70 #include <gst/video/video.h>
  71 #include <gst/controller/gstcontroller.h>
  72
  73 GST_DEBUG_CATEGORY_STATIC (gst_solarize_debug);
  74 #define GST_CAT_DEFAULT gst_solarize_debug
  75
  76 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
  77 #define CAPS_STR GST_VIDEO_CAPS_BGRx ";" GST_VIDEO_CAPS_RGBx
  78 #else
  79 #define CAPS_STR GST_VIDEO_CAPS_xRGB ";" GST_VIDEO_CAPS_xBGR
  80 #endif
  81
  82 /* Filter signals and args. */
  83 enum
  84 {
  85   LAST_SIGNAL
  86 };
  87
  88 enum
  89 {
  90   PROP_0 = 0,
  91   PROP_THRESHOLD,
  92   PROP_START,
  93   PROP_END,
  94   PROP_SILENT
  95 };
  96
  97 /* Initializations */
  98
  99 #define DEFAULT_THRESHOLD 127
 100 #define DEFAULT_START 50
 101 #define DEFAULT_END 185
 102
 103 static gint gate_int (gint value, gint min, gint max);
 104 static void transform (guint32 * src, guint32 * dest, gint video_area,
 105     gint threshold, gint start, gint end);
 106
 107 /* The capabilities of the inputs and outputs. */
 108
 109 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
 110     GST_PAD_SINK,
 111     GST_PAD_ALWAYS,
 112     GST_STATIC_CAPS (CAPS_STR)
 113     );
 114
 115 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 116     GST_PAD_SRC,
 117     GST_PAD_ALWAYS,
 118     GST_STATIC_CAPS (CAPS_STR)
 119     );
 120
 121 GST_BOILERPLATE (GstSolarize, gst_solarize, GstVideoFilter,
 122     GST_TYPE_VIDEO_FILTER);
 123
 124 static void gst_solarize_set_property (GObject * object, guint prop_id,
 125     const GValue * value, GParamSpec * pspec);
 126 static void gst_solarize_get_property (GObject * object, guint prop_id,
 127     GValue * value, GParamSpec * pspec);
 128
 129 static gboolean gst_solarize_set_caps (GstBaseTransform * btrans,
 130     GstCaps * incaps, GstCaps * outcaps);
 131 static GstFlowReturn gst_solarize_transform (GstBaseTransform * btrans,
 132     GstBuffer * in_buf, GstBuffer * out_buf);
 133
 134 /* GObject vmethod implementations */
 135
 136 static void
 137 gst_solarize_base_init (gpointer gclass)
 138 {
 139   GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
 140
 141   gst_element_class_set_details_simple (element_class,
 142       "Solarize",
 143       "Filter/Effect/Video",
 144       "Solarize tunable inverse in the video signal.",
 145       "Luis de Bethencourt <luis@debethencourt.com>");
 146
 147   gst_element_class_add_pad_template (element_class,
 148       gst_static_pad_template_get (&src_factory));
 149   gst_element_class_add_pad_template (element_class,
 150       gst_static_pad_template_get (&sink_factory));
 151 }
 152
 153 /* Initialize the solarize's class. */
 154 static void
 155 gst_solarize_class_init (GstSolarizeClass * klass)
 156 {
 157   GObjectClass *gobject_class = (GObjectClass *) klass;
 158   GstBaseTransformClass *trans_class = (GstBaseTransformClass *) klass;
 159
 160   gobject_class->set_property = gst_solarize_set_property;
 161   gobject_class->get_property = gst_solarize_get_property;
 162
 163   g_object_class_install_property (gobject_class, PROP_THRESHOLD,
 164       g_param_spec_uint ("threshold", "Threshold",
 165           "Threshold parameter", 0, 256, DEFAULT_THRESHOLD,
 166           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 167
 168   g_object_class_install_property (gobject_class, PROP_START,
 169       g_param_spec_uint ("start", "Start",
 170           "Start parameter", 0, 256, DEFAULT_START,
 171           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 172
 173   g_object_class_install_property (gobject_class, PROP_END,
 174       g_param_spec_uint ("end", "End",
 175           "End parameter", 0, 256, DEFAULT_END,
 176           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 177
 178   g_object_class_install_property (gobject_class, PROP_SILENT,
 179       g_param_spec_boolean ("silent", "Silent", "Produce verbose output ?",
 180           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 181
 182   trans_class->set_caps = GST_DEBUG_FUNCPTR (gst_solarize_set_caps);
 183   trans_class->transform = GST_DEBUG_FUNCPTR (gst_solarize_transform);
 184 }
 185
 186 /* Initialize the element,
 187  * instantiate pads and add them to element,
 188  * set pad calback functions, and
 189  * initialize instance structure.
 190  */
 191 static void
 192 gst_solarize_init (GstSolarize * filter, GstSolarizeClass * gclass)
 193 {
 194   filter->threshold = DEFAULT_THRESHOLD;
 195   filter->start = DEFAULT_START;
 196   filter->end = DEFAULT_END;
 197   filter->silent = FALSE;
 198 }
 199
 200 static void
 201 gst_solarize_set_property (GObject * object, guint prop_id,
 202     const GValue * value, GParamSpec * pspec)
 203 {
 204   GstSolarize *filter = GST_SOLARIZE (object);
 205
 206   switch (prop_id) {
 207     case PROP_SILENT:
 208       filter->silent = g_value_get_boolean (value);
 209       break;
 210     case PROP_THRESHOLD:
 211       filter->threshold = g_value_get_uint (value);
 212       break;
 213     case PROP_START:
 214       filter->start = g_value_get_uint (value);
 215       break;
 216     case PROP_END:
 217       filter->end = g_value_get_uint (value);
 218       break;
 219     default:
 220       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 221       break;
 222   }
 223 }
 224
 225 static void
 226 gst_solarize_get_property (GObject * object, guint prop_id,
 227     GValue * value, GParamSpec * pspec)
 228 {
 229   GstSolarize *filter = GST_SOLARIZE (object);
 230
 231   GST_OBJECT_LOCK (filter);
 232   switch (prop_id) {
 233     case PROP_SILENT:
 234       g_value_set_boolean (value, filter->silent);
 235       break;
 236     case PROP_THRESHOLD:
 237       g_value_set_uint (value, filter->threshold);
 238       break;
 239     case PROP_START:
 240       g_value_set_uint (value, filter->start);
 241       break;
 242     case PROP_END:
 243       g_value_set_uint (value, filter->end);
 244       break;
 245     default:
 246       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 247       break;
 248   }
 249   GST_OBJECT_UNLOCK (filter);
 250 }
 251
 252 /* GstElement vmethod implementations */
 253
 254 /* Handle the link with other elements. */
 255 static gboolean
 256 gst_solarize_set_caps (GstBaseTransform * btrans, GstCaps * incaps,
 257     GstCaps * outcaps)
 258 {
 259   GstSolarize *filter = GST_SOLARIZE (btrans);
 260   GstStructure *structure;
 261   gboolean ret = FALSE;
 262
 263   GST_OBJECT_LOCK (filter);
 264   structure = gst_caps_get_structure (incaps, 0);
 265   if (gst_structure_get_int (structure, "width", &filter->width) &&
 266       gst_structure_get_int (structure, "height", &filter->height)) {
 267     ret = TRUE;
 268   }
 269   GST_OBJECT_UNLOCK (filter);
 270
 271   return ret;
 272 }
 273
 274 /* Actual processing. */
 275 static GstFlowReturn
 276 gst_solarize_transform (GstBaseTransform * btrans,
 277     GstBuffer * in_buf, GstBuffer * out_buf)
 278 {
 279   GstSolarize *filter = GST_SOLARIZE (btrans);
 280   gint video_size, threshold, start, end;
 281   guint32 *src = (guint32 *) GST_BUFFER_DATA (in_buf);
 282   guint32 *dest = (guint32 *) GST_BUFFER_DATA (out_buf);
 283   GstClockTime timestamp;
 284   gint64 stream_time;
 285
 286   /* GstController: update the properties */
 287   timestamp = GST_BUFFER_TIMESTAMP (in_buf);
 288   stream_time =
 289       gst_segment_to_stream_time (&btrans->segment, GST_FORMAT_TIME, timestamp);
 290
 291   GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT,
 292       GST_TIME_ARGS (timestamp));
 293
 294   if (GST_CLOCK_TIME_IS_VALID (stream_time))
 295     gst_object_sync_values (GST_OBJECT (filter), stream_time);
 296
 297   GST_OBJECT_LOCK (filter);
 298   threshold = filter->threshold;
 299   start = filter->start;
 300   end = filter->end;
 301   GST_OBJECT_UNLOCK (filter);
 302
 303   video_size = filter->width * filter->height;
 304   transform (src, dest, video_size, threshold, start, end);
 305
 306   return GST_FLOW_OK;
 307 }
 308
 309 /* Entry point to initialize the plug-in.
 310  * Register the element factories and other features. */
 311 gboolean
 312 gst_solarize_plugin_init (GstPlugin * solarize)
 313 {
 314   /* debug category for fltering log messages */
 315   GST_DEBUG_CATEGORY_INIT (gst_solarize_debug, "solarize",
 316       0, "Template solarize");
 317
 318   return gst_element_register (solarize, "solarize", GST_RANK_NONE,
 319       GST_TYPE_SOLARIZE);
 320 }
 321
 322 /*** Now the image processing work.... ***/
 323 /* Keep the values inbounds. */
 324 static gint
 325 gate_int (gint value, gint min, gint max)
 326 {
 327   if (value < min) {
 328     return min;
 329   } else if (value > max) {
 330     return max;
 331   } else {
 332     return value;
 333   }
 334 }
 335
 336 /* Transform processes each frame. */
 337 static void
 338 transform (guint32 * src, guint32 * dest, gint video_area,
 339     gint threshold, gint start, gint end)
 340 {
 341   guint32 in;
 342   guint32 color[3];
 343   gint x, c;
 344   gint floor = 0;
 345   gint ceiling = 255;
 346
 347   gint period, up_length, down_length, height_scale, param;
 348
 349   period = end - start;
 350   if (period == 0) {
 351     period = 1;
 352   }
 353
 354   up_length = threshold - start;
 355   if (up_length == 0) {
 356     up_length = 1;
 357   }
 358
 359   down_length = end - threshold;
 360   if (down_length == 0) {
 361     down_length = 1;
 362   }
 363
 364   height_scale = ceiling - floor;
 365
 366   /* Loop through pixels. */
 367   for (x = 0; x < video_area; x++) {
 368     in = *src++;
 369
 370     color[0] = (in >> 16) & 0xff;
 371     color[1] = (in >> 8) & 0xff;
 372     color[2] = (in) & 0xff;
 373
 374
 375     /* Loop through colors. */
 376     for (c = 0; c < 3; c++) {
 377       param = color[c];
 378       param += 256;
 379       param -= start;
 380       param %= period;
 381
 382       if (param < up_length) {
 383         color[c] = param * height_scale;
 384         color[c] /= up_length;
 385         color[c] += floor;
 386       } else {
 387         color[c] = down_length - (param - up_length);
 388         color[c] *= height_scale;
 389         color[c] /= down_length;
 390         color[c] += floor;
 391       }
 392     }
 393
 394     color[0] = gate_int (color[0], 0, 255);
 395     color[1] = gate_int (color[1], 0, 255);
 396     color[2] = gate_int (color[2], 0, 255);
 397
 398     *dest++ = (color[0] << 16) | (color[1] << 8) | color[2];
 399   }
 400 }