9cc0ad2060e126c2b316a35cf363f9e739abb2de
[vlc.git] / modules / video_filter / bluescreen.c
1 /*****************************************************************************
2  * bluescreen.c : Bluescreen (weather channel like) video filter for vlc
3  *****************************************************************************
4  * Copyright (C) 2005-2007 VLC authors and VideoLAN
5  *
6  * Authors: Antoine Cellerier <dionoea at videolan tod org>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_filter.h>
34 #include <vlc_picture.h>
35
36 #define BLUESCREEN_HELP N_( \
37     "This effect, also known as \"greenscreen\" or \"chroma key\" blends " \
38     "the \"blue parts\" of the foreground image of the mosaic on the " \
39     "background (like weather forecasts). You can choose the \"key\" " \
40     "color for blending (blue by default)." )
41
42 #define BLUESCREENU_TEXT N_("Bluescreen U value")
43 #define BLUESCREENU_LONGTEXT N_( \
44         "\"U\" value for the bluescreen key color " \
45         "(in YUV values). From 0 to 255. Defaults to 120 for blue." )
46 #define BLUESCREENV_TEXT N_("Bluescreen V value")
47 #define BLUESCREENV_LONGTEXT N_( \
48         "\"V\" value for the bluescreen key color " \
49         "(in YUV values). From 0 to 255. Defaults to 90 for blue." )
50 #define BLUESCREENUTOL_TEXT N_("Bluescreen U tolerance")
51 #define BLUESCREENUTOL_LONGTEXT N_( \
52         "Tolerance of the bluescreen blender " \
53         "on color variations for the U plane. A value between 10 and 20 " \
54         "seems sensible." )
55 #define BLUESCREENVTOL_TEXT N_("Bluescreen V tolerance")
56 #define BLUESCREENVTOL_LONGTEXT N_( \
57         "Tolerance of the bluescreen blender " \
58         "on color variations for the V plane. A value between 10 and 20 " \
59         "seems sensible." )
60
61 #define CFG_PREFIX "bluescreen-"
62
63 /*****************************************************************************
64  * Local prototypes
65  *****************************************************************************/
66 static int  Create      ( filter_t * );
67 static void Destroy     ( filter_t * );
68
69 static picture_t *Filter( filter_t *, picture_t * );
70 static int BluescreenCallback( vlc_object_t *, char const *,
71                                vlc_value_t, vlc_value_t, void * );
72
73 /*****************************************************************************
74  * Module descriptor
75  *****************************************************************************/
76 vlc_module_begin ()
77     set_description( N_("Bluescreen video filter") )
78     set_shortname( N_("Bluescreen" ))
79     set_help( BLUESCREEN_HELP )
80     set_category( CAT_VIDEO )
81     set_subcategory( SUBCAT_VIDEO_VFILTER )
82     add_shortcut( "bluescreen" )
83     set_callback_video_filter( Create )
84
85     add_integer_with_range( CFG_PREFIX "u", 120, 0, 255,
86                             BLUESCREENU_TEXT, BLUESCREENU_LONGTEXT, false )
87     add_integer_with_range( CFG_PREFIX "v", 90, 0, 255,
88                             BLUESCREENV_TEXT, BLUESCREENV_LONGTEXT, false )
89     add_integer_with_range( CFG_PREFIX "ut", 17, 0, 255,
90                             BLUESCREENUTOL_TEXT, BLUESCREENUTOL_LONGTEXT,
91                             false )
92     add_integer_with_range( CFG_PREFIX "vt", 17, 0, 255,
93                             BLUESCREENVTOL_TEXT, BLUESCREENVTOL_LONGTEXT,
94                             false )
95 vlc_module_end ()
96
97 static const char *const ppsz_filter_options[] = {
98     "u", "v", "ut", "vt", NULL
99 };
100
101 typedef struct
102 {
103     vlc_mutex_t lock;
104     int i_u, i_v, i_ut, i_vt;
105     uint8_t *p_at;
106 } filter_sys_t;
107
108 static const struct vlc_filter_operations filter_ops =
109 {
110     .filter_video = Filter, .close = Destroy,
111 };
112
113 static int Create( filter_t *p_filter )
114 {
115     filter_sys_t *p_sys;
116
117     if( p_filter->fmt_in.video.i_chroma != VLC_CODEC_YUVA )
118     {
119         msg_Err( p_filter,
120                  "Unsupported input chroma \"%4.4s\". "
121                  "Bluescreen can only use \"YUVA\".",
122                  (char*)&p_filter->fmt_in.video.i_chroma );
123         return VLC_EGENERIC;
124     }
125
126     /* Allocate structure */
127     p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
128     if( p_filter->p_sys == NULL )
129         return VLC_ENOMEM;
130     p_sys = p_filter->p_sys;
131
132     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
133                        p_filter->p_cfg );
134
135     int val;
136     vlc_mutex_init( &p_sys->lock );
137 #define GET_VAR( name, min, max )                                           \
138     val = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX #name );        \
139     p_sys->i_##name = VLC_CLIP( val, min, max );                                \
140     var_AddCallback( p_filter, CFG_PREFIX #name, BluescreenCallback, p_sys );
141
142     GET_VAR( u, 0x00, 0xff );
143     GET_VAR( v, 0x00, 0xff );
144     GET_VAR( ut, 0x00, 0xff );
145     GET_VAR( vt, 0x00, 0xff );
146     p_sys->p_at = NULL;
147 #undef GET_VAR
148
149     p_filter->ops = &filter_ops;
150
151     return VLC_SUCCESS;
152 }
153
154 static void Destroy( filter_t *p_filter )
155 {
156     filter_sys_t *p_sys = p_filter->p_sys;
157
158     var_DelCallback( p_filter, CFG_PREFIX "u", BluescreenCallback, p_sys );
159     var_DelCallback( p_filter, CFG_PREFIX "v", BluescreenCallback, p_sys );
160     var_DelCallback( p_filter, CFG_PREFIX "ut", BluescreenCallback, p_sys );
161     var_DelCallback( p_filter, CFG_PREFIX "vt", BluescreenCallback, p_sys );
162
163     free( p_sys->p_at );
164     free( p_sys );
165 }
166
167 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
168 {
169     filter_sys_t *p_sys = p_filter->p_sys;
170
171     int i_lines = p_pic->p[ A_PLANE ].i_lines;
172     int i_pitch = p_pic->p[ A_PLANE ].i_pitch;
173     uint8_t *p_a = p_pic->p[ A_PLANE ].p_pixels;
174     uint8_t *p_at;
175     uint8_t *p_u = p_pic->p[ U_PLANE ].p_pixels;
176     uint8_t *p_v = p_pic->p[ V_PLANE ].p_pixels;
177     uint8_t umin, umax, vmin, vmax;
178
179     if( p_pic->format.i_chroma != VLC_CODEC_YUVA )
180     {
181         msg_Err( p_filter,
182                  "Unsupported input chroma \"%4.4s\". "
183                  "Bluescreen can only use \"YUVA\".",
184                  (char*)&p_pic->format.i_chroma );
185         return NULL;
186     }
187
188     p_sys->p_at = xrealloc( p_sys->p_at,
189                             i_lines * i_pitch * sizeof( uint8_t ) );
190     p_at = p_sys->p_at;
191
192     vlc_mutex_lock( &p_sys->lock );
193     umin = p_sys->i_u - p_sys->i_ut >= 0x00 ? p_sys->i_u - p_sys->i_ut : 0x00;
194     umax = p_sys->i_u + p_sys->i_ut <= 0xff ? p_sys->i_u + p_sys->i_ut : 0xff;
195     vmin = p_sys->i_v - p_sys->i_vt >= 0x00 ? p_sys->i_v - p_sys->i_vt : 0x00;
196     vmax = p_sys->i_v + p_sys->i_vt <= 0xff ? p_sys->i_v + p_sys->i_vt : 0xff;
197     vlc_mutex_unlock( &p_sys->lock );
198
199     for( int i = 0; i < i_lines*i_pitch; i++ )
200     {
201         if(    p_u[i] < umax && p_u[i] > umin
202             && p_v[i] < vmax && p_v[i] > vmin )
203         {
204             p_at[i] = 0x00;
205         }
206         else
207         {
208             p_at[i] = 0xff;
209         }
210     }
211     /* Gaussian convolution to make it look cleaner */
212     memset( p_a, 0, 2 * i_pitch );
213     for( int i = 2; i < i_lines - 2; i++ )
214     {
215         p_a[i*i_pitch] = 0x00;
216         p_a[i*i_pitch+1] = 0x00;
217         for( int j = 2; j < i_pitch - 2; j++ )
218         {
219             p_a[i*i_pitch+j] = (uint8_t)((
220               /* 2 rows up */
221                 ( p_at[(i-2)*i_pitch+j-2]<<1 )
222               + ( p_at[(i-2)*i_pitch+j-1]<<2 )
223               + ( p_at[(i-2)*i_pitch+j]<<2 )
224               + ( p_at[(i-2)*i_pitch+j+1]<<2 )
225               + ( p_at[(i-2)*i_pitch+j+2]<<1 )
226               /* 1 row up */
227               + ( p_at[(i-1)*i_pitch+j-2]<<2 )
228               + ( p_at[(i-1)*i_pitch+j-1]<<3 )
229               + ( p_at[(i-1)*i_pitch+j]*12 )
230               + ( p_at[(i-1)*i_pitch+j+1]<<3 )
231               + ( p_at[(i-1)*i_pitch+j+2]<<2 )
232               /* */
233               + ( p_at[i*i_pitch+j-2]<<2 )
234               + ( p_at[i*i_pitch+j-1]*12 )
235               + ( p_at[i*i_pitch+j]<<4 )
236               + ( p_at[i*i_pitch+j+1]*12 )
237               + ( p_at[i*i_pitch+j+2]<<2 )
238               /* 1 row down */
239               + ( p_at[(i+1)*i_pitch+j-2]<<2 )
240               + ( p_at[(i+1)*i_pitch+j-1]<<3 )
241               + ( p_at[(i+1)*i_pitch+j]*12 )
242               + ( p_at[(i+1)*i_pitch+j+1]<<3 )
243               + ( p_at[(i+1)*i_pitch+j+2]<<2 )
244               /* 2 rows down */
245               + ( p_at[(i+2)*i_pitch+j-2]<<1 )
246               + ( p_at[(i+2)*i_pitch+j-1]<<2 )
247               + ( p_at[(i+2)*i_pitch+j]<<2 )
248               + ( p_at[(i+2)*i_pitch+j+1]<<2 )
249               + ( p_at[(i+2)*i_pitch+j+2]<<1 )
250               )/152);
251               if( p_a[i*i_pitch+j] < 0xbf ) p_a[i*i_pitch+j] = 0x00;
252         }
253     }
254     return p_pic;
255 }
256
257 /*****************************************************************************
258 * Callback to update params on the fly
259 *****************************************************************************/
260 static int BluescreenCallback( vlc_object_t *p_this, char const *psz_var,
261                                vlc_value_t oldval, vlc_value_t newval,
262                                void *p_data )
263 {
264     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
265     filter_sys_t *p_sys = (filter_sys_t *) p_data;
266
267     vlc_mutex_lock( &p_sys->lock );
268 #define VAR_IS( a ) !strcmp( psz_var, CFG_PREFIX a )
269     if( VAR_IS( "u" ) )
270         p_sys->i_u = VLC_CLIP( newval.i_int, 0, 255 );
271     else if( VAR_IS( "v" ) )
272         p_sys->i_v = VLC_CLIP( newval.i_int, 0, 255 );
273     else if( VAR_IS( "ut" ) )
274         p_sys->i_ut = VLC_CLIP( newval.i_int, 0, 255 );
275     else if( VAR_IS( "vt" ) )
276         p_sys->i_vt = VLC_CLIP( newval.i_int, 0, 255 );
277     vlc_mutex_unlock( &p_sys->lock );
278
279     return VLC_SUCCESS;
280 }