3 * Copyright (C) <2010> Luis de Bethencourt <luis@debethencourt.com>
5 * Chromium - burning chrome 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-chromium
51 * Chromium breaks the colors of a video stream in realtime.
53 * ## Example launch line
55 * gst-launch-1.0 -v videotestsrc ! chromium ! videoconvert ! autovideosink
56 * ]| This pipeline shows the effect of chromium on a test stream
67 #include "gstplugin.h"
68 #include "gstchromium.h"
70 #define gst_chromium_parent_class parent_class
71 G_DEFINE_TYPE (GstChromium, gst_chromium, GST_TYPE_VIDEO_FILTER);
73 GST_DEBUG_CATEGORY_STATIC (gst_chromium_debug);
74 #define GST_CAT_DEFAULT gst_chromium_debug
76 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
77 #define CAPS_STR GST_VIDEO_CAPS_MAKE ("{ BGRx, RGBx }")
79 #define CAPS_STR GST_VIDEO_CAPS_MAKE ("{ xBGR, xRGB }")
82 /* Filter signals and args. */
97 #define DEFAULT_EDGE_A 200
98 #define DEFAULT_EDGE_B 1
100 const float pi = 3.141582f;
102 gint cosTablePi = 512;
103 gint cosTableTwoPi = (2 * 512);
104 gint cosTableOne = 512;
105 gint cosTableMask = 1023;
107 gint cosTable[2 * 512];
109 void setup_cos_table (void);
110 static gint cos_from_table (int angle);
111 static inline int abs_int (int val);
112 static void transform (guint32 * src, guint32 * dest, gint video_area,
113 gint edge_a, gint edge_b);
115 /* The capabilities of the inputs and outputs. */
117 static GstStaticPadTemplate gst_chromium_sink_template =
118 GST_STATIC_PAD_TEMPLATE ("sink",
121 GST_STATIC_CAPS (CAPS_STR)
124 static GstStaticPadTemplate gst_chromium_src_template =
125 GST_STATIC_PAD_TEMPLATE ("src",
128 GST_STATIC_CAPS (CAPS_STR)
131 static void gst_chromium_set_property (GObject * object, guint prop_id,
132 const GValue * value, GParamSpec * pspec);
133 static void gst_chromium_get_property (GObject * object, guint prop_id,
134 GValue * value, GParamSpec * pspec);
135 static void gst_chromium_finalize (GObject * object);
137 static GstFlowReturn gst_chromium_transform_frame (GstVideoFilter * vfilter,
138 GstVideoFrame * in_frame, GstVideoFrame * out_frame);
140 /* GObject vmethod implementations */
142 /* Initialize the chromium's class. */
144 gst_chromium_class_init (GstChromiumClass * klass)
146 GObjectClass *gobject_class = (GObjectClass *) klass;
147 GstElementClass *gstelement_class = (GstElementClass *) klass;
148 GstVideoFilterClass *vfilter_class = (GstVideoFilterClass *) klass;
150 gst_element_class_set_static_metadata (gstelement_class, "Chromium",
151 "Filter/Effect/Video",
152 "Chromium breaks the colors of the video signal.",
153 "Luis de Bethencourt <luis@debethencourt.com>");
155 gst_element_class_add_static_pad_template (gstelement_class,
156 &gst_chromium_sink_template);
157 gst_element_class_add_static_pad_template (gstelement_class,
158 &gst_chromium_src_template);
160 gobject_class->set_property = gst_chromium_set_property;
161 gobject_class->get_property = gst_chromium_get_property;
162 gobject_class->finalize = gst_chromium_finalize;
164 g_object_class_install_property (gobject_class, PROP_EDGE_A,
165 g_param_spec_uint ("edge-a", "Edge A",
166 "First edge parameter", 0, 256, DEFAULT_EDGE_A,
167 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
169 g_object_class_install_property (gobject_class, PROP_EDGE_B,
170 g_param_spec_uint ("edge-b", "Edge B",
171 "Second edge parameter", 0, 256, DEFAULT_EDGE_B,
172 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | GST_PARAM_CONTROLLABLE));
174 vfilter_class->transform_frame =
175 GST_DEBUG_FUNCPTR (gst_chromium_transform_frame);
178 /* Initialize the element,
179 * instantiate pads and add them to element,
180 * set pad calback functions, and
181 * initialize instance structure.
184 gst_chromium_init (GstChromium * filter)
186 filter->edge_a = DEFAULT_EDGE_A;
187 filter->edge_b = DEFAULT_EDGE_B;
193 gst_chromium_set_property (GObject * object, guint prop_id,
194 const GValue * value, GParamSpec * pspec)
196 GstChromium *filter = GST_CHROMIUM (object);
200 filter->edge_a = g_value_get_uint (value);
203 filter->edge_b = g_value_get_uint (value);
206 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
212 gst_chromium_get_property (GObject * object, guint prop_id,
213 GValue * value, GParamSpec * pspec)
215 GstChromium *filter = GST_CHROMIUM (object);
217 GST_OBJECT_LOCK (filter);
220 g_value_set_uint (value, filter->edge_a);
223 g_value_set_uint (value, filter->edge_b);
226 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
229 GST_OBJECT_UNLOCK (filter);
233 gst_chromium_finalize (GObject * object)
235 G_OBJECT_CLASS (parent_class)->finalize (object);
238 /* GstElement vmethod implementations */
240 /* Actual processing. */
242 gst_chromium_transform_frame (GstVideoFilter * vfilter,
243 GstVideoFrame * in_frame, GstVideoFrame * out_frame)
245 GstChromium *filter = GST_CHROMIUM (vfilter);
246 gint video_size, edge_a, edge_b;
248 GstClockTime timestamp;
251 src = GST_VIDEO_FRAME_PLANE_DATA (in_frame, 0);
252 dest = GST_VIDEO_FRAME_PLANE_DATA (out_frame, 0);
254 /* GstController: update the properties */
255 timestamp = GST_BUFFER_TIMESTAMP (in_frame->buffer);
257 gst_segment_to_stream_time (&GST_BASE_TRANSFORM (filter)->segment,
258 GST_FORMAT_TIME, timestamp);
260 GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT,
261 GST_TIME_ARGS (timestamp));
263 if (GST_CLOCK_TIME_IS_VALID (stream_time))
264 gst_object_sync_values (GST_OBJECT (filter), stream_time);
266 GST_OBJECT_LOCK (filter);
267 edge_a = filter->edge_a;
268 edge_b = filter->edge_b;
269 GST_OBJECT_UNLOCK (filter);
271 video_size = GST_VIDEO_FRAME_WIDTH (in_frame) *
272 GST_VIDEO_FRAME_HEIGHT (in_frame);
273 transform (src, dest, video_size, edge_a, edge_b);
278 /* Entry point to initialize the plug-in.
279 * Register the element factories and other features. */
281 gst_chromium_plugin_init (GstPlugin * chromium)
283 /* debug category for fltering log messages */
284 GST_DEBUG_CATEGORY_INIT (gst_chromium_debug, "chromium", 0,
285 "Template chromium");
287 return gst_element_register (chromium, "chromium", GST_RANK_NONE,
291 /*** Now the image processing work.... ***/
292 /* Set up the cosine table. */
294 setup_cos_table (void)
298 for (angle = 0; angle < cosTableTwoPi; ++angle) {
299 float angleInRadians = ((float) (angle) / cosTablePi) * pi;
300 cosTable[angle] = (int) (cos (angleInRadians) * cosTableOne);
304 /* Keep the values absolute. */
315 /* Cosine from Table. */
317 cos_from_table (int angle)
319 angle &= cosTableMask;
320 return cosTable[angle];
323 /* Transform processes each frame. */
325 transform (guint32 * src, guint32 * dest, gint video_area,
326 gint edge_a, gint edge_b)
329 gint x, red, green, blue;
331 for (x = 0; x < video_area; x++) {
334 red = (in >> 16) & 0xff;
335 green = (in >> 8) & 0xff;
338 red = abs_int (cos_from_table ((red + edge_a) + ((red * edge_b) / 2)));
339 green = abs_int (cos_from_table (
340 (green + edge_a) + ((green * edge_b) / 2)));
341 blue = abs_int (cos_from_table ((blue + edge_a) + ((blue * edge_b) / 2)));
343 red = CLAMP (red, 0, 255);
344 green = CLAMP (green, 0, 255);
345 blue = CLAMP (blue, 0, 255);
347 *dest++ = (red << 16) | (green << 8) | blue;