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