3 * Copyright (C) <2010-2015> Luis de Bethencourt <luis@debethencourt.com>
5 * Solarize - curve adjustment video effect.
6 * Based on Pete Warden's FreeFrame plugin with the same name.
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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.
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
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.
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.
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., 51 Franklin St, Fifth Floor,
44 * Boston, MA 02110-1301, USA.
48 * SECTION:element-solarize
50 * Solarize does a smart inverse in a video stream in realtime.
53 * <title>Example launch line</title>
55 * gst-launch -v videotestsrc ! solarize ! videoconvert ! autovideosink
56 * ]| This pipeline shows the effect of solarize on a test stream
67 #include "gstplugin.h"
68 #include "gstsolarize.h"
70 GST_DEBUG_CATEGORY_STATIC (gst_solarize_debug);
71 #define GST_CAT_DEFAULT gst_solarize_debug
73 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
74 #define CAPS_STR GST_VIDEO_CAPS_MAKE ("{ BGRx, RGBx }")
76 #define CAPS_STR GST_VIDEO_CAPS_MAKE ("{ xBGR, xRGB }")
79 /* Filter signals and args. */
95 #define DEFAULT_THRESHOLD 127
96 #define DEFAULT_START 50
97 #define DEFAULT_END 185
99 static void transform (guint32 * src, guint32 * dest, gint video_area,
100 gint threshold, gint start, gint end);
102 /* The capabilities of the inputs and outputs. */
104 static GstStaticPadTemplate gst_solarize_sink_template =
105 GST_STATIC_PAD_TEMPLATE ("sink",
108 GST_STATIC_CAPS (CAPS_STR)
111 static GstStaticPadTemplate gst_solarize_src_template =
112 GST_STATIC_PAD_TEMPLATE ("src",
115 GST_STATIC_CAPS (CAPS_STR)
118 #define gst_solarize_parent_class parent_class
119 G_DEFINE_TYPE (GstSolarize, gst_solarize, GST_TYPE_VIDEO_FILTER);
121 static void gst_solarize_set_property (GObject * object, guint prop_id,
122 const GValue * value, GParamSpec * pspec);
123 static void gst_solarize_get_property (GObject * object, guint prop_id,
124 GValue * value, GParamSpec * pspec);
125 static void gst_solarize_finalize (GObject * object);
127 static GstFlowReturn gst_solarize_transform_frame (GstVideoFilter * vfilter,
128 GstVideoFrame * in_frame, GstVideoFrame * out_frame);
130 /* GObject vmethod implementations */
132 /* Initialize the solarize's class. */
134 gst_solarize_class_init (GstSolarizeClass * klass)
136 GObjectClass *gobject_class = (GObjectClass *) klass;
137 GstElementClass *gstelement_class = (GstElementClass *) klass;
138 GstVideoFilterClass *vfilter_class = (GstVideoFilterClass *) klass;
140 gst_element_class_set_static_metadata (gstelement_class,
142 "Filter/Effect/Video",
143 "Solarize tunable inverse in the video signal.",
144 "Luis de Bethencourt <luis@debethencourt.com>");
146 gst_element_class_add_pad_template (gstelement_class,
147 gst_static_pad_template_get (&gst_solarize_sink_template));
148 gst_element_class_add_pad_template (gstelement_class,
149 gst_static_pad_template_get (&gst_solarize_src_template));
151 gobject_class->set_property = gst_solarize_set_property;
152 gobject_class->get_property = gst_solarize_get_property;
153 gobject_class->finalize = gst_solarize_finalize;
155 g_object_class_install_property (gobject_class, PROP_THRESHOLD,
156 g_param_spec_uint ("threshold", "Threshold",
157 "Threshold parameter", 0, 256, DEFAULT_THRESHOLD,
158 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
160 g_object_class_install_property (gobject_class, PROP_START,
161 g_param_spec_uint ("start", "Start",
162 "Start parameter", 0, 256, DEFAULT_START,
163 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
165 g_object_class_install_property (gobject_class, PROP_END,
166 g_param_spec_uint ("end", "End",
167 "End parameter", 0, 256, DEFAULT_END,
168 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
170 vfilter_class->transform_frame =
171 GST_DEBUG_FUNCPTR (gst_solarize_transform_frame);
174 /* Initialize the element,
175 * instantiate pads and add them to element,
176 * set pad calback functions, and
177 * initialize instance structure.
180 gst_solarize_init (GstSolarize * filter)
182 filter->threshold = DEFAULT_THRESHOLD;
183 filter->start = DEFAULT_START;
184 filter->end = DEFAULT_END;
188 gst_solarize_set_property (GObject * object, guint prop_id,
189 const GValue * value, GParamSpec * pspec)
191 GstSolarize *filter = GST_SOLARIZE (object);
195 filter->threshold = g_value_get_uint (value);
198 filter->start = g_value_get_uint (value);
201 filter->end = g_value_get_uint (value);
204 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
210 gst_solarize_get_property (GObject * object, guint prop_id,
211 GValue * value, GParamSpec * pspec)
213 GstSolarize *filter = GST_SOLARIZE (object);
215 GST_OBJECT_LOCK (filter);
218 g_value_set_uint (value, filter->threshold);
221 g_value_set_uint (value, filter->start);
224 g_value_set_uint (value, filter->end);
227 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
230 GST_OBJECT_UNLOCK (filter);
234 gst_solarize_finalize (GObject * object)
236 G_OBJECT_CLASS (parent_class)->finalize (object);
239 /* GstElement vmethod implementations */
241 /* Actual processing. */
243 gst_solarize_transform_frame (GstVideoFilter * vfilter,
244 GstVideoFrame * in_frame, GstVideoFrame * out_frame)
246 GstSolarize *filter = GST_SOLARIZE (vfilter);
247 gint video_size, threshold, start, end;
249 GstClockTime timestamp;
252 src = GST_VIDEO_FRAME_PLANE_DATA (in_frame, 0);
253 dest = GST_VIDEO_FRAME_PLANE_DATA (out_frame, 0);
255 /* GstController: update the properties */
256 timestamp = GST_BUFFER_TIMESTAMP (in_frame->buffer);
258 gst_segment_to_stream_time (&GST_BASE_TRANSFORM (filter)->segment,
259 GST_FORMAT_TIME, timestamp);
261 GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT,
262 GST_TIME_ARGS (timestamp));
264 if (GST_CLOCK_TIME_IS_VALID (stream_time))
265 gst_object_sync_values (GST_OBJECT (filter), stream_time);
267 GST_OBJECT_LOCK (filter);
268 threshold = filter->threshold;
269 start = filter->start;
271 GST_OBJECT_UNLOCK (filter);
273 video_size = GST_VIDEO_FRAME_WIDTH (in_frame) *
274 GST_VIDEO_FRAME_HEIGHT (in_frame);
276 transform (src, dest, video_size, threshold, start, end);
281 /* Entry point to initialize the plug-in.
282 * Register the element factories and other features. */
284 gst_solarize_plugin_init (GstPlugin * solarize)
286 /* debug category for fltering log messages */
287 GST_DEBUG_CATEGORY_INIT (gst_solarize_debug, "solarize",
288 0, "Template solarize");
290 return gst_element_register (solarize, "solarize", GST_RANK_NONE,
294 /*** Now the image processing work.... ***/
296 /* Transform processes each frame. */
298 transform (guint32 * src, guint32 * dest, gint video_area,
299 gint threshold, gint start, gint end)
303 gint period = 1, up_length = 1, down_length = 1;
306 static const guint floor = 0;
307 static const guint ceiling = 255;
312 period = end - start;
314 if (threshold != start)
315 up_length = threshold - start;
317 if (threshold != end)
318 down_length = end - threshold;
320 /* Loop through pixels. */
321 for (x = 0; x < video_area; x++) {
324 color[0] = (in >> 16) & 0xff;
325 color[1] = (in >> 8) & 0xff;
326 color[2] = (in) & 0xff;
328 /* Loop through colors. */
329 for (c = 0; c < 3; c++) {
335 if (param < up_length) {
336 color[c] = param * ceiling;
337 color[c] /= up_length;
340 color[c] = down_length - (param - up_length);
342 color[c] /= down_length;
348 for (c = 0; c < 3; c++) {
349 if (G_UNLIKELY (color[c] > 255))
353 *dest++ = (color[0] << 16) | (color[1] << 8) | color[2];