1 /*****************************************************************************
2 * erase.c : logo erase video filter
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include "vlc_image.h"
37 #include "vlc_filter.h"
38 #include "filter_picture.h"
40 /*****************************************************************************
42 *****************************************************************************/
43 static int Create ( vlc_object_t * );
44 static void Destroy ( vlc_object_t * );
46 static picture_t *Filter( filter_t *, picture_t * );
47 static void FilterErase( filter_t *, picture_t *, picture_t * );
48 static int EraseCallback( vlc_object_t *, char const *,
49 vlc_value_t, vlc_value_t, void * );
51 /*****************************************************************************
53 *****************************************************************************/
54 #define MASK_TEXT N_("Image mask")
55 #define MASK_LONGTEXT N_("Image mask. Pixels with an alpha value greater than 50% will be erased.")
57 #define POSX_TEXT N_("X coordinate")
58 #define POSX_LONGTEXT N_("X coordinate of the mask.")
59 #define POSY_TEXT N_("Y coordinate")
60 #define POSY_LONGTEXT N_("Y coordinate of the mask.")
62 #define CFG_PREFIX "erase-"
65 set_description( N_("Erase video filter") )
66 set_shortname( N_( "Erase" ))
67 set_capability( "video filter2", 0 )
68 set_category( CAT_VIDEO )
69 set_subcategory( SUBCAT_VIDEO_VFILTER )
71 add_file( CFG_PREFIX "mask", NULL, NULL,
72 MASK_TEXT, MASK_LONGTEXT, false )
73 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, false )
74 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, false )
76 add_shortcut( "erase" )
77 set_callbacks( Create, Destroy )
80 static const char *const ppsz_filter_options[] = {
81 "mask", "x", "y", NULL
84 /*****************************************************************************
86 *****************************************************************************/
95 static void LoadMask( filter_t *p_filter, const char *psz_filename )
97 image_handler_t *p_image;
98 video_format_t fmt_in, fmt_out;
99 picture_t *p_old_mask = p_filter->p_sys->p_mask;
100 memset( &fmt_in, 0, sizeof( video_format_t ) );
101 memset( &fmt_out, 0, sizeof( video_format_t ) );
102 fmt_out.i_chroma = VLC_CODEC_YUVA;
103 p_image = image_HandlerCreate( p_filter );
104 p_filter->p_sys->p_mask =
105 image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
106 if( p_filter->p_sys->p_mask )
109 picture_Release( p_old_mask );
111 else if( p_old_mask )
113 p_filter->p_sys->p_mask = p_old_mask;
114 msg_Err( p_filter, "Error while loading new mask. Keeping old mask." );
116 image_HandlerDelete( p_image );
119 /*****************************************************************************
121 *****************************************************************************/
122 static int Create( vlc_object_t *p_this )
124 filter_t *p_filter = (filter_t *)p_this;
128 switch( p_filter->fmt_in.video.i_chroma )
139 msg_Err( p_filter, "Unsupported input chroma (%4s)",
140 (char*)&(p_filter->fmt_in.video.i_chroma) );
144 /* Allocate structure */
145 p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
146 if( p_filter->p_sys == NULL )
148 p_sys = p_filter->p_sys;
150 p_filter->pf_video_filter = Filter;
152 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
156 var_CreateGetNonEmptyStringCommand( p_filter, CFG_PREFIX "mask" );
160 msg_Err( p_filter, "Missing 'mask' option value." );
164 p_sys->p_mask = NULL;
165 LoadMask( p_filter, psz_filename );
166 free( psz_filename );
167 p_sys->i_x = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX "x" );
168 p_sys->i_y = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX "y" );
170 vlc_mutex_init( &p_sys->lock );
171 var_AddCallback( p_filter, CFG_PREFIX "x", EraseCallback, p_sys );
172 var_AddCallback( p_filter, CFG_PREFIX "y", EraseCallback, p_sys );
173 var_AddCallback( p_filter, CFG_PREFIX "mask", EraseCallback, p_sys );
178 /*****************************************************************************
180 *****************************************************************************/
181 static void Destroy( vlc_object_t *p_this )
183 filter_t *p_filter = (filter_t *)p_this;
184 filter_sys_t *p_sys = p_filter->p_sys;
186 picture_Release( p_sys->p_mask );
188 var_DelCallback( p_filter, CFG_PREFIX "x", EraseCallback, p_sys );
189 var_DelCallback( p_filter, CFG_PREFIX "y", EraseCallback, p_sys );
190 var_DelCallback( p_filter, CFG_PREFIX "mask", EraseCallback, p_sys );
191 vlc_mutex_destroy( &p_sys->lock );
193 free( p_filter->p_sys );
196 /*****************************************************************************
198 *****************************************************************************/
199 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
203 if( !p_pic ) return NULL;
205 p_outpic = filter_NewPicture( p_filter );
208 picture_Release( p_pic );
213 FilterErase( p_filter, p_pic, p_outpic );
215 return CopyInfoAndRelease( p_outpic, p_pic );
218 /*****************************************************************************
220 *****************************************************************************/
221 static void FilterErase( filter_t *p_filter, picture_t *p_inpic,
222 picture_t *p_outpic )
224 filter_sys_t *p_sys = p_filter->p_sys;
226 vlc_mutex_lock( &p_sys->lock );
227 const int i_mask_pitch = p_sys->p_mask->A_PITCH;
228 const int i_mask_visible_pitch = p_sys->p_mask->p[A_PLANE].i_visible_pitch;
229 const int i_mask_visible_lines = p_sys->p_mask->p[A_PLANE].i_visible_lines;
231 for( int i_plane = 0; i_plane < p_inpic->i_planes; i_plane++ )
233 const int i_pitch = p_inpic->p[i_plane].i_pitch;
234 const int i_2pitch = i_pitch<<1;
235 const int i_visible_pitch = p_inpic->p[i_plane].i_visible_pitch;
236 const int i_lines = p_inpic->p[i_plane].i_lines;
237 const int i_visible_lines = p_inpic->p[i_plane].i_visible_lines;
239 uint8_t *p_inpix = p_inpic->p[i_plane].p_pixels;
240 uint8_t *p_outpix = p_outpic->p[i_plane].p_pixels;
241 uint8_t *p_mask = p_sys->p_mask->A_PIXELS;
242 int i_x = p_sys->i_x, i_y = p_sys->i_y;
245 int i_height = i_mask_visible_lines;
246 int i_width = i_mask_visible_pitch;
248 const bool b_line_factor = ( i_plane /* U_PLANE or V_PLANE */ &&
249 !( p_inpic->format.i_chroma == VLC_CODEC_I422
250 || p_inpic->format.i_chroma == VLC_CODEC_J422 ) );
252 if( i_plane ) /* U_PLANE or V_PLANE */
262 i_height = __MIN( i_visible_lines - i_y, i_height );
263 i_width = __MIN( i_visible_pitch - i_x, i_width );
265 /* Copy original pixel buffer */
266 vlc_memcpy( p_outpix, p_inpix, i_pitch * i_lines );
268 /* Horizontal linear interpolation of masked areas */
269 p_outpix = p_outpic->p[i_plane].p_pixels + i_y*i_pitch + i_x;
270 for( y = 0; y < i_height;
271 y++, p_mask += i_mask_pitch, p_outpix += i_pitch )
273 uint8_t prev, next = 0;
274 int prev_x = -1, next_x = -2;
277 /* Find a suitable value for the previous color to use when
278 * interpoling a masked pixel's value */
281 /* There are pixels before current position on the same line.
283 prev = *(p_outpix-1);
287 /* This is the first pixel on a line but there other lines
288 * above us. Use the pixel right above */
289 prev = *(p_outpix-i_pitch);
293 /* We're in the upper left corner. This sucks. We can't use
294 * any previous value, so we'll use a dummy one. In most
295 * cases this dummy value will be fixed later on in the
300 for( x = 0; x < i_width; x++ )
302 if( p_mask[i_plane?x<<1:x] > 127 )
304 /* This is a masked pixel */
305 if( next_x <= prev_x )
308 /* Look for the next non masked pixel on the same
309 * line (inside the mask's bounding box) */
310 for( x0 = x; x0 < i_width; x0++ )
312 if( p_mask[i_plane?x0<<1:x0] <= 127 )
314 /* We found an unmasked pixel. Victory! */
320 if( next_x <= prev_x )
322 /* We didn't find an unmasked pixel yet. Try
325 if( x0 < i_visible_pitch )
327 /* If we didn't find a non masked pixel on the
328 * same line inside the mask's bounding box,
329 * use the next pixel on the line (except if
330 * it doesn't exist) */
336 /* The last pixel on the line is masked,
337 * so we'll use the "prev" value. A better
338 * approach would be to use unmasked pixels
339 * at the end of adjacent lines */
344 if( !( i_x || y || i_y ) )
345 /* We were unable to find a suitable value for
346 * the previous color (which means that we are
347 * on the first line in the upper left corner)
351 /* Divide only once instead of next_x-prev_x-1 times */
352 quot = ((next-prev)<<16)/(next_x-prev_x);
354 /* Interpolate new value, and round correctly */
355 p_outpix[x] = prev + (((x-prev_x)*quot+(1<<16))>>16);
359 /* This pixel isn't masked. It's thus suitable as a
360 * previous color for the next interpolation */
367 /* Vertical bluring */
368 p_mask = p_sys->p_mask->A_PIXELS;
369 i_height = b_line_factor ? i_mask_visible_lines>>1
370 : i_mask_visible_lines;
371 /* Make sure that we stop at least 2 lines before the picture's end
372 * (since our bluring algorithm uses the 2 next lines) */
373 i_height = __MIN( i_visible_lines - i_y - 2, i_height );
374 /* Make sure that we start at least 2 lines from the top (since our
375 * bluring algorithm uses the 2 previous lines) */
377 p_outpix = p_outpic->p[i_plane].p_pixels + (i_y+y)*i_pitch + i_x;
378 for( ; y < i_height; y++, p_mask += i_mask_pitch, p_outpix += i_pitch )
380 for( x = 0; x < i_width; x++ )
382 if( p_mask[i_plane?x<<1:x] > 127 )
384 /* Ugly bluring function */
386 ( (p_outpix[x-i_2pitch]<<1) /* 2 */
387 + (p_outpix[x-i_pitch ]<<2) /* 4 */
388 + (p_outpix[x ]<<2) /* 4 */
389 + (p_outpix[x+i_pitch ]<<2) /* 4 */
390 + (p_outpix[x+i_2pitch]<<1) )>>4; /* 2 */
395 vlc_mutex_unlock( &p_sys->lock );
398 static int EraseCallback( vlc_object_t *p_this, char const *psz_var,
399 vlc_value_t oldval, vlc_value_t newval, void *p_data )
402 filter_sys_t *p_sys = (filter_sys_t *)p_data;
404 if( !strcmp( psz_var, CFG_PREFIX "x" ) )
406 vlc_mutex_lock( &p_sys->lock );
407 p_sys->i_x = newval.i_int;
408 vlc_mutex_unlock( &p_sys->lock );
410 else if( !strcmp( psz_var, CFG_PREFIX "y" ) )
412 vlc_mutex_lock( &p_sys->lock );
413 p_sys->i_y = newval.i_int;
414 vlc_mutex_unlock( &p_sys->lock );
416 else if( !strcmp( psz_var, CFG_PREFIX "mask" ) )
418 vlc_mutex_lock( &p_sys->lock );
419 LoadMask( (filter_t*)p_this, newval.psz_string );
420 vlc_mutex_unlock( &p_sys->lock );
424 msg_Warn( p_this, "Unknown callback command." );