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