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
  72 GST_DEBUG_CATEGORY_STATIC (gst_solarize_debug);
  73 #define GST_CAT_DEFAULT gst_solarize_debug
  74
  75 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
  76 #define CAPS_STR GST_VIDEO_CAPS_BGRx ";" GST_VIDEO_CAPS_RGBx
  77 #else
  78 #define CAPS_STR GST_VIDEO_CAPS_xRGB ";" GST_VIDEO_CAPS_xBGR
  79 #endif
  80
  81 /* Filter signals and args. */
  82 enum
  83 {
  84   LAST_SIGNAL
  85 };
  86
  87 enum
  88 {
  89   PROP_0 = 0,
  90   PROP_THRESHOLD,
  91   PROP_START,
  92   PROP_END,
  93   PROP_SILENT
  94 };
  95
  96 /* Initializations */
  97
  98 #define DEFAULT_THRESHOLD 127
  99 #define DEFAULT_START 50
 100 #define DEFAULT_END 185
 101
 102 static gint gate_int (gint value, gint min, gint max);
 103 static void transform (guint32 * src, guint32 * dest, gint video_area,
 104     gint threshold, gint start, gint end);
 105
 106 /* The capabilities of the inputs and outputs. */
 107
 108 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
 109     GST_PAD_SINK,
 110     GST_PAD_ALWAYS,
 111     GST_STATIC_CAPS (CAPS_STR)
 112     );
 113
 114 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 115     GST_PAD_SRC,
 116     GST_PAD_ALWAYS,
 117     GST_STATIC_CAPS (CAPS_STR)
 118     );
 119
 120 GST_BOILERPLATE (GstSolarize, gst_solarize, GstVideoFilter,
 121     GST_TYPE_VIDEO_FILTER);
 122
 123 static void gst_solarize_set_property (GObject * object, guint prop_id,
 124     const GValue * value, GParamSpec * pspec);
 125 static void gst_solarize_get_property (GObject * object, guint prop_id,
 126     GValue * value, GParamSpec * pspec);
 127
 128 static gboolean gst_solarize_set_caps (GstBaseTransform * btrans,
 129     GstCaps * incaps, GstCaps * outcaps);
 130 static GstFlowReturn gst_solarize_transform (GstBaseTransform * btrans,
 131     GstBuffer * in_buf, GstBuffer * out_buf);
 132
 133 /* GObject vmethod implementations */
 134
 135 static void
 136 gst_solarize_base_init (gpointer gclass)
 137 {
 138   GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
 139
 140   gst_element_class_set_details_simple (element_class,
 141       "Solarize",
 142       "Filter/Effect/Video",
 143       "Solarize tunable inverse in the video signal.",
 144       "Luis de Bethencourt <luis@debethencourt.com>");
 145
 146   gst_element_class_add_pad_template (element_class,
 147       gst_static_pad_template_get (&src_factory));
 148   gst_element_class_add_pad_template (element_class,
 149       gst_static_pad_template_get (&sink_factory));
 150 }
 151
 152 /* Initialize the solarize's class. */
 153 static void
 154 gst_solarize_class_init (GstSolarizeClass * klass)
 155 {
 156   GObjectClass *gobject_class = (GObjectClass *) klass;
 157   GstBaseTransformClass *trans_class = (GstBaseTransformClass *) klass;
 158
 159   gobject_class->set_property = gst_solarize_set_property;
 160   gobject_class->get_property = gst_solarize_get_property;
 161
 162   g_object_class_install_property (gobject_class, PROP_THRESHOLD,
 163       g_param_spec_uint ("threshold", "Threshold",
 164           "Threshold parameter", 0, 256, DEFAULT_THRESHOLD,
 165           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 166
 167   g_object_class_install_property (gobject_class, PROP_START,
 168       g_param_spec_uint ("start", "Start",
 169           "Start parameter", 0, 256, DEFAULT_START,
 170           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 171
 172   g_object_class_install_property (gobject_class, PROP_END,
 173       g_param_spec_uint ("end", "End",
 174           "End parameter", 0, 256, DEFAULT_END,
 175           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 176
 177   g_object_class_install_property (gobject_class, PROP_SILENT,
 178       g_param_spec_boolean ("silent", "Silent", "Produce verbose output ?",
 179           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 180
 181   trans_class->set_caps = GST_DEBUG_FUNCPTR (gst_solarize_set_caps);
 182   trans_class->transform = GST_DEBUG_FUNCPTR (gst_solarize_transform);
 183 }
 184
 185 /* Initialize the element,
 186  * instantiate pads and add them to element,
 187  * set pad calback functions, and
 188  * initialize instance structure.
 189  */
 190 static void
 191 gst_solarize_init (GstSolarize * filter, GstSolarizeClass * gclass)
 192 {
 193   filter->threshold = DEFAULT_THRESHOLD;
 194   filter->start = DEFAULT_START;
 195   filter->end = DEFAULT_END;
 196   filter->silent = FALSE;
 197 }
 198
 199 static void
 200 gst_solarize_set_property (GObject * object, guint prop_id,
 201     const GValue * value, GParamSpec * pspec)
 202 {
 203   GstSolarize *filter = GST_SOLARIZE (object);
 204
 205   switch (prop_id) {
 206     case PROP_SILENT:
 207       filter->silent = g_value_get_boolean (value);
 208       break;
 209     case PROP_THRESHOLD:
 210       filter->threshold = g_value_get_uint (value);
 211       break;
 212     case PROP_START:
 213       filter->start = g_value_get_uint (value);
 214       break;
 215     case PROP_END:
 216       filter->end = g_value_get_uint (value);
 217       break;
 218     default:
 219       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 220       break;
 221   }
 222 }
 223
 224 static void
 225 gst_solarize_get_property (GObject * object, guint prop_id,
 226     GValue * value, GParamSpec * pspec)
 227 {
 228   GstSolarize *filter = GST_SOLARIZE (object);
 229
 230   GST_OBJECT_LOCK (filter);
 231   switch (prop_id) {
 232     case PROP_SILENT:
 233       g_value_set_boolean (value, filter->silent);
 234       break;
 235     case PROP_THRESHOLD:
 236       g_value_set_uint (value, filter->threshold);
 237       break;
 238     case PROP_START:
 239       g_value_set_uint (value, filter->start);
 240       break;
 241     case PROP_END:
 242       g_value_set_uint (value, filter->end);
 243       break;
 244     default:
 245       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 246       break;
 247   }
 248   GST_OBJECT_UNLOCK (filter);
 249 }
 250
 251 /* GstElement vmethod implementations */
 252
 253 /* Handle the link with other elements. */
 254 static gboolean
 255 gst_solarize_set_caps (GstBaseTransform * btrans, GstCaps * incaps,
 256     GstCaps * outcaps)
 257 {
 258   GstSolarize *filter = GST_SOLARIZE (btrans);
 259   GstStructure *structure;
 260   gboolean ret = FALSE;
 261
 262   GST_OBJECT_LOCK (filter);
 263   structure = gst_caps_get_structure (incaps, 0);
 264   if (gst_structure_get_int (structure, "width", &filter->width) &&
 265       gst_structure_get_int (structure, "height", &filter->height)) {
 266     ret = TRUE;
 267   }
 268   GST_OBJECT_UNLOCK (filter);
 269
 270   return ret;
 271 }
 272
 273 /* Actual processing. */
 274 static GstFlowReturn
 275 gst_solarize_transform (GstBaseTransform * btrans,
 276     GstBuffer * in_buf, GstBuffer * out_buf)
 277 {
 278   GstSolarize *filter = GST_SOLARIZE (btrans);
 279   gint video_size, threshold, start, end;
 280   guint32 *src = (guint32 *) GST_BUFFER_DATA (in_buf);
 281   guint32 *dest = (guint32 *) GST_BUFFER_DATA (out_buf);
 282   GstClockTime timestamp;
 283   gint64 stream_time;
 284
 285   /* GstController: update the properties */
 286   timestamp = GST_BUFFER_TIMESTAMP (in_buf);
 287   stream_time =
 288       gst_segment_to_stream_time (&btrans->segment, GST_FORMAT_TIME, timestamp);
 289
 290   GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT,
 291       GST_TIME_ARGS (timestamp));
 292
 293   if (GST_CLOCK_TIME_IS_VALID (stream_time))
 294     gst_object_sync_values (GST_OBJECT (filter), stream_time);
 295
 296   GST_OBJECT_LOCK (filter);
 297   threshold = filter->threshold;
 298   start = filter->start;
 299   end = filter->end;
 300   GST_OBJECT_UNLOCK (filter);
 301
 302   video_size = filter->width * filter->height;
 303   transform (src, dest, video_size, threshold, start, end);
 304
 305   return GST_FLOW_OK;
 306 }
 307
 308 /* Entry point to initialize the plug-in.
 309  * Register the element factories and other features. */
 310 gboolean
 311 gst_solarize_plugin_init (GstPlugin * solarize)
 312 {
 313   /* debug category for fltering log messages */
 314   GST_DEBUG_CATEGORY_INIT (gst_solarize_debug, "solarize",
 315       0, "Template solarize");
 316
 317   return gst_element_register (solarize, "solarize", GST_RANK_NONE,
 318       GST_TYPE_SOLARIZE);
 319 }
 320
 321 /*** Now the image processing work.... ***/
 322 /* Keep the values inbounds. */
 323 static gint
 324 gate_int (gint value, gint min, gint max)
 325 {
 326   if (value < min) {
 327     return min;
 328   } else if (value > max) {
 329     return max;
 330   } else {
 331     return value;
 332   }
 333 }
 334
 335 /* Transform processes each frame. */
 336 static void
 337 transform (guint32 * src, guint32 * dest, gint video_area,
 338     gint threshold, gint start, gint end)
 339 {
 340   guint32 in;
 341   guint32 color[3];
 342   gint x, c;
 343   gint floor = 0;
 344   gint ceiling = 255;
 345
 346   gint period, up_length, down_length, height_scale, param;
 347
 348   period = end - start;
 349   if (period == 0) {
 350     period = 1;
 351   }
 352
 353   up_length = threshold - start;
 354   if (up_length == 0) {
 355     up_length = 1;
 356   }
 357
 358   down_length = end - threshold;
 359   if (down_length == 0) {
 360     down_length = 1;
 361   }
 362
 363   height_scale = ceiling - floor;
 364
 365   /* Loop through pixels. */
 366   for (x = 0; x < video_area; x++) {
 367     in = *src++;
 368
 369     color[0] = (in >> 16) & 0xff;
 370     color[1] = (in >> 8) & 0xff;
 371     color[2] = (in) & 0xff;
 372
 373
 374     /* Loop through colors. */
 375     for (c = 0; c < 3; c++) {
 376       param = color[c];
 377       param += 256;
 378       param -= start;
 379       param %= period;
 380
 381       if (param < up_length) {
 382         color[c] = param * height_scale;
 383         color[c] /= up_length;
 384         color[c] += floor;
 385       } else {
 386         color[c] = down_length - (param - up_length);
 387         color[c] *= height_scale;
 388         color[c] /= down_length;
 389         color[c] += floor;
 390       }
 391     }
 392
 393     color[0] = gate_int (color[0], 0, 255);
 394     color[1] = gate_int (color[1], 0, 255);
 395     color[2] = gate_int (color[2], 0, 255);
 396
 397     *dest++ = (color[0] << 16) | (color[1] << 8) | color[2];
 398   }
 399 }