gst/gaudieffects/gstchromium.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2010 Luis de Bethencourt <luis@debethencourt.com>
   4  *
   5  * Chromium - burning chrome 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-chromium
  49  *
  50  * Chromium breaks the colors of a video stream in realtime.
  51  *
  52  * <refsect2>
  53  * <title>Example launch line</title>
  54  * |[
  55  * gst-launch -v videotestsrc ! chromium ! ffmpegcolorspace ! autovideosink
  56  * ]| This pipeline shows the effect of chromium on a test stream
  57  * </refsect2>
  58  */
  59
  60 #ifdef HAVE_CONFIG_H
  61 #  include <config.h>
  62 #endif
  63
  64 #include <math.h>
  65 #include <gst/gst.h>
  66 #include <gst/controller/gstcontroller.h>
  67
  68 #include "gstplugin.h"
  69 #include "gstchromium.h"
  70
  71 #include <gst/video/video.h>
  72
  73 GST_DEBUG_CATEGORY_STATIC (gst_chromium_debug);
  74 #define GST_CAT_DEFAULT gst_chromium_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_EDGE_A,
  92   PROP_EDGE_B,
  93   PROP_SILENT
  94 };
  95
  96 /* Initializations */
  97
  98 #define DEFAULT_EDGE_A 200
  99 #define DEFAULT_EDGE_B 1
 100
 101 const float pi = 3.141582f;
 102
 103 gint cosTablePi = 512;
 104 gint cosTableTwoPi = (2 * 512);
 105 gint cosTableOne = 512;
 106 gint cosTableMask = 1023;
 107
 108 gint cosTable[2 * 512];
 109
 110 static gint gate_int (gint value, gint min, gint max);
 111 void setup_cos_table (void);
 112 static gint cos_from_table (int angle);
 113 static inline int abs_int (int val);
 114 static void transform (guint32 * src, guint32 * dest, gint video_area,
 115     gint edge_a, gint edge_b);
 116
 117 /* The capabilities of the inputs and outputs. */
 118
 119 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
 120     GST_PAD_SINK,
 121     GST_PAD_ALWAYS,
 122     GST_STATIC_CAPS (CAPS_STR)
 123     );
 124
 125 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 126     GST_PAD_SRC,
 127     GST_PAD_ALWAYS,
 128     GST_STATIC_CAPS (CAPS_STR)
 129     );
 130
 131 GST_BOILERPLATE (GstChromium, gst_chromium, GstVideoFilter,
 132     GST_TYPE_VIDEO_FILTER);
 133
 134 static void gst_chromium_set_property (GObject * object, guint prop_id,
 135     const GValue * value, GParamSpec * pspec);
 136 static void gst_chromium_get_property (GObject * object, guint prop_id,
 137     GValue * value, GParamSpec * pspec);
 138
 139 static gboolean gst_chromium_set_caps (GstBaseTransform * btrans,
 140     GstCaps * incaps, GstCaps * outcaps);
 141 static GstFlowReturn gst_chromium_transform (GstBaseTransform * btrans,
 142     GstBuffer * in_buf, GstBuffer * out_buf);
 143
 144 /* GObject vmethod implementations */
 145
 146 static void
 147 gst_chromium_base_init (gpointer gclass)
 148 {
 149   GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
 150
 151   gst_element_class_set_details_simple (element_class,
 152       "Chromium",
 153       "Filter/Effect/Video",
 154       "Chromium breaks the colors of the video signal.",
 155       "Luis de Bethencourt <luis@debethencourt.com>");
 156
 157   gst_element_class_add_static_pad_template (element_class, &src_factory);
 158   gst_element_class_add_static_pad_template (element_class, &sink_factory);
 159 }
 160
 161 /* Initialize the chromium's class. */
 162 static void
 163 gst_chromium_class_init (GstChromiumClass * klass)
 164 {
 165   GObjectClass *gobject_class = (GObjectClass *) klass;
 166   GstBaseTransformClass *trans_class = (GstBaseTransformClass *) klass;
 167
 168   gobject_class->set_property = gst_chromium_set_property;
 169   gobject_class->get_property = gst_chromium_get_property;
 170
 171   g_object_class_install_property (gobject_class, PROP_EDGE_A,
 172       g_param_spec_uint ("edge-a", "Edge A",
 173           "First edge parameter", 0, 256, DEFAULT_EDGE_A,
 174           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 175
 176   g_object_class_install_property (gobject_class, PROP_EDGE_B,
 177       g_param_spec_uint ("edge-b", "Edge B",
 178           "Second edge parameter", 0, 256, DEFAULT_EDGE_B,
 179           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
 180
 181   g_object_class_install_property (gobject_class, PROP_SILENT,
 182       g_param_spec_boolean ("silent", "Silent", "Produce verbose output ?",
 183           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 184
 185   trans_class->set_caps = GST_DEBUG_FUNCPTR (gst_chromium_set_caps);
 186   trans_class->transform = GST_DEBUG_FUNCPTR (gst_chromium_transform);
 187 }
 188
 189 /* Initialize the element,
 190  * instantiate pads and add them to element,
 191  * set pad calback functions, and
 192  * initialize instance structure.
 193  */
 194 static void
 195 gst_chromium_init (GstChromium * filter, GstChromiumClass * gclass)
 196 {
 197   filter->edge_a = DEFAULT_EDGE_A;
 198   filter->edge_b = DEFAULT_EDGE_B;
 199   filter->silent = FALSE;
 200
 201   setup_cos_table ();
 202 }
 203
 204 static void
 205 gst_chromium_set_property (GObject * object, guint prop_id,
 206     const GValue * value, GParamSpec * pspec)
 207 {
 208   GstChromium *filter = GST_CHROMIUM (object);
 209
 210   switch (prop_id) {
 211     case PROP_SILENT:
 212       filter->silent = g_value_get_boolean (value);
 213       break;
 214     case PROP_EDGE_A:
 215       filter->edge_a = g_value_get_uint (value);
 216       break;
 217     case PROP_EDGE_B:
 218       filter->edge_b = g_value_get_uint (value);
 219       break;
 220     default:
 221       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 222       break;
 223   }
 224 }
 225
 226
 227 static void
 228 gst_chromium_get_property (GObject * object, guint prop_id,
 229     GValue * value, GParamSpec * pspec)
 230 {
 231   GstChromium *filter = GST_CHROMIUM (object);
 232
 233   GST_OBJECT_LOCK (filter);
 234   switch (prop_id) {
 235     case PROP_SILENT:
 236       g_value_set_boolean (value, filter->silent);
 237       break;
 238     case PROP_EDGE_A:
 239       g_value_set_uint (value, filter->edge_a);
 240       break;
 241     case PROP_EDGE_B:
 242       g_value_set_uint (value, filter->edge_b);
 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_chromium_set_caps (GstBaseTransform * btrans, GstCaps * incaps,
 256     GstCaps * outcaps)
 257 {
 258   GstChromium *filter = GST_CHROMIUM (btrans);
 259   GstStructure *structure;
 260   gboolean ret = FALSE;
 261
 262   structure = gst_caps_get_structure (incaps, 0);
 263
 264   GST_OBJECT_LOCK (filter);
 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_chromium_transform (GstBaseTransform * btrans,
 277     GstBuffer * in_buf, GstBuffer * out_buf)
 278 {
 279   GstChromium *filter = GST_CHROMIUM (btrans);
 280   gint video_size, edge_a, edge_b;
 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 (G_OBJECT (filter), stream_time);
 296
 297   GST_OBJECT_LOCK (filter);
 298   edge_a = filter->edge_a;
 299   edge_b = filter->edge_b;
 300   GST_OBJECT_UNLOCK (filter);
 301
 302   video_size = filter->width * filter->height;
 303   transform (src, dest, video_size, edge_a, edge_b);
 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_chromium_plugin_init (GstPlugin * chromium)
 312 {
 313   /* debug category for fltering log messages */
 314   GST_DEBUG_CATEGORY_INIT (gst_chromium_debug, "chromium", 0,
 315       "Template chromium");
 316
 317   return gst_element_register (chromium, "chromium", GST_RANK_NONE,
 318       GST_TYPE_CHROMIUM);
 319 }
 320
 321 /*** Now the image processing work.... ***/
 322 /* Set up the cosine table. */
 323 void
 324 setup_cos_table (void)
 325 {
 326   int angle;
 327
 328   for (angle = 0; angle < cosTableTwoPi; ++angle) {
 329     float angleInRadians = ((float) (angle) / cosTablePi) * pi;
 330     cosTable[angle] = (int) (cos (angleInRadians) * cosTableOne);
 331   }
 332 }
 333
 334 /* Keep the values absolute. */
 335 static inline int
 336 abs_int (int val)
 337 {
 338   if (val > 0) {
 339     return val;
 340   } else {
 341     return -val;
 342   }
 343 }
 344
 345 /* Keep the values inbounds. */
 346 static gint
 347 gate_int (gint value, gint min, gint max)
 348 {
 349   if (value < min) {
 350     return min;
 351   } else if (value > max) {
 352     return max;
 353   } else {
 354     return value;
 355   }
 356 }
 357
 358 /* Cosine from Table. */
 359 static gint
 360 cos_from_table (int angle)
 361 {
 362   angle &= cosTableMask;
 363   return cosTable[angle];
 364 }
 365
 366 /* Transform processes each frame. */
 367 static void
 368 transform (guint32 * src, guint32 * dest, gint video_area,
 369     gint edge_a, gint edge_b)
 370 {
 371   guint32 in, red, green, blue;
 372   gint x;
 373
 374   for (x = 0; x < video_area; x++) {
 375     in = *src++;
 376
 377     red = (in >> 16) & 0xff;
 378     green = (in >> 8) & 0xff;
 379     blue = (in) & 0xff;
 380
 381     red = abs_int (cos_from_table ((red + edge_a) + ((red * edge_b) / 2)));
 382     green = abs_int (cos_from_table (
 383             (green + edge_a) + ((green * edge_b) / 2)));
 384     blue = abs_int (cos_from_table ((blue + edge_a) + ((blue * edge_b) / 2)));
 385
 386     red = gate_int (red, 0, 255);
 387     green = gate_int (green, 0, 255);
 388     blue = gate_int (blue, 0, 255);
 389
 390     *dest++ = (red << 16) | (green << 8) | blue;
 391   }
 392 }