3 * Copyright (C) <2010-2015> Luis de Bethencourt <luis@debethencourt.com>
5 * Exclusion - color exclusion 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-exclusion
51 * Exclusion saturates the colors of a video stream in realtime.
53 * ## Example launch line
55 * gst-launch-1.0 -v videotestsrc ! exclusion ! videoconvert ! autovideosink
56 * ]| This pipeline shows the effect of exclusion on a test stream
67 #include "gstplugin.h"
68 #include "gstexclusion.h"
70 #include <gst/video/video.h>
72 GST_DEBUG_CATEGORY_STATIC (gst_exclusion_debug);
73 #define GST_CAT_DEFAULT gst_exclusion_debug
75 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
76 #define CAPS_STR GST_VIDEO_CAPS_MAKE ("{ BGRx, RGBx }")
78 #define CAPS_STR GST_VIDEO_CAPS_MAKE ("{ xBGR, xRGB }")
81 /* Filter signals and args. */
95 #define DEFAULT_FACTOR 175
97 static void transform (guint32 * src, guint32 * dest, gint video_area,
100 /* The capabilities of the inputs and outputs. */
102 static GstStaticPadTemplate gst_exclusion_sink_template =
103 GST_STATIC_PAD_TEMPLATE ("sink",
106 GST_STATIC_CAPS (CAPS_STR)
109 static GstStaticPadTemplate gst_exclusion_src_template =
110 GST_STATIC_PAD_TEMPLATE ("src",
113 GST_STATIC_CAPS (CAPS_STR)
116 #define gst_exclusion_parent_class parent_class
117 G_DEFINE_TYPE (GstExclusion, gst_exclusion, GST_TYPE_VIDEO_FILTER);
119 static void gst_exclusion_set_property (GObject * object, guint prop_id,
120 const GValue * value, GParamSpec * pspec);
121 static void gst_exclusion_get_property (GObject * object, guint prop_id,
122 GValue * value, GParamSpec * pspec);
123 static void gst_exclusion_finalize (GObject * object);
125 static GstFlowReturn gst_exclusion_transform_frame (GstVideoFilter * vfilter,
126 GstVideoFrame * in_frame, GstVideoFrame * out_frame);
128 /* GObject vmethod implementations */
130 /* Initialize the exclusion's class. */
132 gst_exclusion_class_init (GstExclusionClass * klass)
134 GObjectClass *gobject_class = (GObjectClass *) klass;
135 GstElementClass *gstelement_class = (GstElementClass *) klass;
136 GstVideoFilterClass *vfilter_class = (GstVideoFilterClass *) klass;
138 gst_element_class_set_static_metadata (gstelement_class, "Exclusion",
139 "Filter/Effect/Video",
140 "Exclusion exclodes the colors in the video signal.",
141 "Luis de Bethencourt <luis@debethencourt.com>");
143 gst_element_class_add_static_pad_template (gstelement_class,
144 &gst_exclusion_sink_template);
145 gst_element_class_add_static_pad_template (gstelement_class,
146 &gst_exclusion_src_template);
148 gobject_class->set_property = gst_exclusion_set_property;
149 gobject_class->get_property = gst_exclusion_get_property;
150 gobject_class->finalize = gst_exclusion_finalize;
152 g_object_class_install_property (gobject_class, PROP_FACTOR,
153 g_param_spec_uint ("factor", "Factor",
154 "Exclusion factor parameter", 1, 175, DEFAULT_FACTOR,
155 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
157 vfilter_class->transform_frame =
158 GST_DEBUG_FUNCPTR (gst_exclusion_transform_frame);
161 /* Initialize the element,
162 * instantiate pads and add them to element,
163 * set pad callback functions, and
164 * initialize instance structure.
167 gst_exclusion_init (GstExclusion * filter)
169 filter->factor = DEFAULT_FACTOR;
173 gst_exclusion_set_property (GObject * object, guint prop_id,
174 const GValue * value, GParamSpec * pspec)
176 GstExclusion *filter = GST_EXCLUSION (object);
180 filter->factor = g_value_get_uint (value);
183 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
189 gst_exclusion_get_property (GObject * object, guint prop_id,
190 GValue * value, GParamSpec * pspec)
192 GstExclusion *filter = GST_EXCLUSION (object);
194 GST_OBJECT_LOCK (filter);
197 g_value_set_uint (value, filter->factor);
200 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
203 GST_OBJECT_UNLOCK (filter);
207 gst_exclusion_finalize (GObject * object)
209 G_OBJECT_CLASS (parent_class)->finalize (object);
212 /* GstElement vmethod implementations */
214 /* Actual processing. */
216 gst_exclusion_transform_frame (GstVideoFilter * vfilter,
217 GstVideoFrame * in_frame, GstVideoFrame * out_frame)
219 GstExclusion *filter = GST_EXCLUSION (vfilter);
220 gint video_size, factor;
222 GstClockTime timestamp;
225 src = GST_VIDEO_FRAME_PLANE_DATA (in_frame, 0);
226 dest = GST_VIDEO_FRAME_PLANE_DATA (out_frame, 0);
228 /* GstController: update the properties */
229 timestamp = GST_BUFFER_TIMESTAMP (in_frame->buffer);
231 gst_segment_to_stream_time (&GST_BASE_TRANSFORM (filter)->segment,
232 GST_FORMAT_TIME, timestamp);
234 GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT,
235 GST_TIME_ARGS (timestamp));
237 if (GST_CLOCK_TIME_IS_VALID (stream_time))
238 gst_object_sync_values (GST_OBJECT (filter), stream_time);
240 GST_OBJECT_LOCK (filter);
241 factor = filter->factor;
242 GST_OBJECT_UNLOCK (filter);
244 video_size = GST_VIDEO_FRAME_WIDTH (in_frame) *
245 GST_VIDEO_FRAME_HEIGHT (in_frame);
246 transform (src, dest, video_size, factor);
251 /* Entry point to initialize the plug-in.
252 * Register the element factories and other features. */
254 gst_exclusion_plugin_init (GstPlugin * exclusion)
256 /* debug category for fltering log messages */
257 GST_DEBUG_CATEGORY_INIT (gst_exclusion_debug, "exclusion",
258 0, "Template exclusion");
260 return gst_element_register (exclusion, "exclusion", GST_RANK_NONE,
264 /*** Now the image processing work.... ***/
266 /* Transform processes each frame. */
268 transform (guint32 * src, guint32 * dest, gint video_area, gint factor)
271 gint x, red, green, blue;
273 for (x = 0; x < video_area; x++) {
276 red = (in >> 16) & 0xff;
277 green = (in >> 8) & 0xff;
281 (((factor - red) * (factor - red) / factor) + ((green * red) / factor));
283 (((factor - green) * (factor - green) / factor) +
284 ((green * green) / factor));
286 (((factor - blue) * (factor - blue) / factor) +
287 ((blue * blue) / factor));
289 red = CLAMP (red, 0, 255);
290 green = CLAMP (green, 0, 255);
291 blue = CLAMP (blue, 0, 255);
293 *dest++ = (red << 16) | (green << 8) | blue;