3 * Copyright (C) 2010 Luis de Bethencourt <luis@debethencourt.com>
5 * Dodge - saturation 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., 59 Temple Place - Suite 330,
44 * Boston, MA 02111-1307, USA.
48 * SECTION:element-dodge
50 * Dodge saturates the colors of a video stream in realtime.
53 * <title>Example launch line</title>
55 * gst-launch -v videotestsrc ! dodge ! ffmpegcolorspace ! autovideosink
56 * ]| This pipeline shows the effect of dodge on a test stream
67 #include "gstplugin.h"
70 #include <gst/video/video.h>
71 #include <gst/controller/gstcontroller.h>
73 GST_DEBUG_CATEGORY_STATIC (gst_dodge_debug);
74 #define GST_CAT_DEFAULT gst_dodge_debug
76 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
77 #define CAPS_STR GST_VIDEO_CAPS_BGRx ";" GST_VIDEO_CAPS_RGBx
79 #define CAPS_STR GST_VIDEO_CAPS_xRGB ";" GST_VIDEO_CAPS_xBGR
82 /* Filter signals and args. */
96 static gint gate_int (gint value, gint min, gint max);
97 static void transform (guint32 * src, guint32 * dest, gint video_area);
99 /* The capabilities of the inputs and outputs. */
101 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
104 GST_STATIC_CAPS (CAPS_STR)
107 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
110 GST_STATIC_CAPS (CAPS_STR)
113 GST_BOILERPLATE (GstDodge, gst_dodge, GstVideoFilter, GST_TYPE_VIDEO_FILTER);
115 static void gst_dodge_set_property (GObject * object, guint prop_id,
116 const GValue * value, GParamSpec * pspec);
117 static void gst_dodge_get_property (GObject * object, guint prop_id,
118 GValue * value, GParamSpec * pspec);
120 static gboolean gst_dodge_set_caps (GstBaseTransform * btrans,
121 GstCaps * incaps, GstCaps * outcaps);
122 static GstFlowReturn gst_dodge_transform (GstBaseTransform * btrans,
123 GstBuffer * in_buf, GstBuffer * out_buf);
125 /* GObject vmethod implementations */
128 gst_dodge_base_init (gpointer gclass)
130 GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
132 gst_element_class_set_details_simple (element_class,
134 "Filter/Effect/Video",
135 "Dodge saturates the colors in the video signal.",
136 "Luis de Bethencourt <luis@debethencourt.com>");
138 gst_element_class_add_static_pad_template (element_class, &src_factory);
139 gst_element_class_add_static_pad_template (element_class, &sink_factory);
142 /* Initialize the dodge's class. */
144 gst_dodge_class_init (GstDodgeClass * klass)
146 GObjectClass *gobject_class = (GObjectClass *) klass;
147 GstBaseTransformClass *trans_class = (GstBaseTransformClass *) klass;
149 gobject_class->set_property = gst_dodge_set_property;
150 gobject_class->get_property = gst_dodge_get_property;
152 g_object_class_install_property (gobject_class, PROP_SILENT,
153 g_param_spec_boolean ("silent", "Silent", "Produce verbose output ?",
154 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
156 trans_class->set_caps = GST_DEBUG_FUNCPTR (gst_dodge_set_caps);
157 trans_class->transform = GST_DEBUG_FUNCPTR (gst_dodge_transform);
160 /* Initialize the element,
161 * instantiate pads and add them to element,
162 * set pad calback functions, and
163 * initialize instance structure.
166 gst_dodge_init (GstDodge * filter, GstDodgeClass * gclass)
168 filter->silent = FALSE;
172 gst_dodge_set_property (GObject * object, guint prop_id,
173 const GValue * value, GParamSpec * pspec)
175 GstDodge *filter = GST_DODGE (object);
179 filter->silent = g_value_get_boolean (value);
182 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
188 gst_dodge_get_property (GObject * object, guint prop_id,
189 GValue * value, GParamSpec * pspec)
191 GstDodge *filter = GST_DODGE (object);
193 GST_OBJECT_LOCK (filter);
196 g_value_set_boolean (value, filter->silent);
199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
202 GST_OBJECT_UNLOCK (filter);
205 /* GstElement vmethod implementations */
207 /* Handle the link with other elements. */
209 gst_dodge_set_caps (GstBaseTransform * btrans, GstCaps * incaps,
212 GstDodge *filter = GST_DODGE (btrans);
213 GstStructure *structure;
216 structure = gst_caps_get_structure (incaps, 0);
218 GST_OBJECT_LOCK (filter);
219 if (gst_structure_get_int (structure, "width", &filter->width) &&
220 gst_structure_get_int (structure, "height", &filter->height)) {
223 GST_OBJECT_UNLOCK (filter);
228 /* Actual processing. */
230 gst_dodge_transform (GstBaseTransform * btrans,
231 GstBuffer * in_buf, GstBuffer * out_buf)
233 GstDodge *filter = GST_DODGE (btrans);
234 guint32 *src = (guint32 *) GST_BUFFER_DATA (in_buf);
235 guint32 *dest = (guint32 *) GST_BUFFER_DATA (out_buf);
238 video_size = filter->width * filter->height;
240 transform (src, dest, video_size);
245 /* Entry point to initialize the plug-in.
246 * Register the element factories and other features. */
248 gst_dodge_plugin_init (GstPlugin * dodge)
250 /* debug category for fltering log messages */
251 GST_DEBUG_CATEGORY_INIT (gst_dodge_debug, "dodge", 0, "Template dodge");
253 return gst_element_register (dodge, "dodge", GST_RANK_NONE, GST_TYPE_DODGE);
256 /*** Now the image processing work.... ***/
258 /* Keep the values inbounds. */
260 gate_int (gint value, gint min, gint max)
264 } else if (value > max) {
271 /* Transform processes each frame. */
273 transform (guint32 * src, guint32 * dest, gint video_area)
275 guint32 in, red, green, blue;
278 for (x = 0; x < video_area; x++) {
281 red = (in >> 16) & 0xff;
282 green = (in >> 8) & 0xff;
285 red = (256 * red) / (256 - red);
286 green = (256 * green) / (256 - green);
287 blue = (256 * blue) / (256 - blue);
289 red = gate_int (red, 0, 255);
290 green = gate_int (green, 0, 255);
291 blue = gate_int (blue, 0, 255);
293 *dest++ = (red << 16) | (green << 8) | blue;