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 *****************************************************************************/
31 #include "vlc_image.h"
33 #include "vlc_filter.h"
35 /*****************************************************************************
37 *****************************************************************************/
38 static int Create ( vlc_object_t * );
39 static void Destroy ( vlc_object_t * );
41 static picture_t *Filter( filter_t *, picture_t * );
42 static void FilterErase( filter_t *, picture_t *, picture_t * );
43 static int EraseCallback( vlc_object_t *, char const *,
44 vlc_value_t, vlc_value_t, void * );
46 /*****************************************************************************
48 *****************************************************************************/
49 #define MASK_TEXT N_("Image mask")
50 #define MASK_LONGTEXT N_("Image mask. Pixels with an alpha value greater than 50% will be erased.")
52 #define POSX_TEXT N_("X coordinate")
53 #define POSX_LONGTEXT N_("X coordinate of the mask.")
54 #define POSY_TEXT N_("Y coordinate")
55 #define POSY_LONGTEXT N_("Y coordinate of the mask.")
57 #define CFG_PREFIX "erase-"
60 set_description( _("Erase video filter") );
61 set_shortname( _( "Erase" ));
62 set_capability( "video filter2", 0 );
63 set_category( CAT_VIDEO );
64 set_subcategory( SUBCAT_VIDEO_VFILTER );
66 add_file( CFG_PREFIX "mask", NULL, NULL,
67 MASK_TEXT, MASK_LONGTEXT, VLC_FALSE );
68 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
69 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
71 add_shortcut( "erase" );
72 set_callbacks( Create, Destroy );
75 static const char *ppsz_filter_options[] = {
76 "mask", "x", "y", NULL
79 /*****************************************************************************
81 *****************************************************************************/
90 static void LoadMask( filter_t *p_filter, const char *psz_filename )
92 image_handler_t *p_image;
93 video_format_t fmt_in, fmt_out;
94 picture_t *p_old_mask = p_filter->p_sys->p_mask;
95 memset( &fmt_in, 0, sizeof( video_format_t ) );
96 memset( &fmt_out, 0, sizeof( video_format_t ) );
97 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
98 p_image = image_HandlerCreate( p_filter );
99 p_filter->p_sys->p_mask =
100 image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
101 if( p_filter->p_sys->p_mask )
104 p_old_mask->pf_release( p_old_mask );
106 else if( p_old_mask )
108 p_filter->p_sys->p_mask = p_old_mask;
109 msg_Err( p_filter, "Error while loading new mask. Keeping old mask." );
111 image_HandlerDelete( p_image );
114 /*****************************************************************************
116 *****************************************************************************/
117 static int Create( vlc_object_t *p_this )
119 filter_t *p_filter = (filter_t *)p_this;
123 /* Allocate structure */
124 p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
125 if( p_filter->p_sys == NULL )
127 msg_Err( p_filter, "out of memory" );
130 p_sys = p_filter->p_sys;
132 p_filter->pf_video_filter = Filter;
134 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
138 var_CreateGetNonEmptyStringCommand( p_filter, CFG_PREFIX "mask" );
142 msg_Err( p_filter, "Missing 'mask' option value." );
146 p_sys->p_mask = NULL;
147 LoadMask( p_filter, psz_filename );
148 free( psz_filename );
149 p_sys->i_x = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX "x" );
150 p_sys->i_y = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX "y" );
152 var_AddCallback( p_filter, CFG_PREFIX "x", EraseCallback, p_sys );
153 var_AddCallback( p_filter, CFG_PREFIX "y", EraseCallback, p_sys );
154 var_AddCallback( p_filter, CFG_PREFIX "mask", EraseCallback, p_sys );
156 vlc_mutex_init( p_filter, &p_sys->lock );
161 /*****************************************************************************
163 *****************************************************************************/
164 static void Destroy( vlc_object_t *p_this )
166 filter_t *p_filter = (filter_t *)p_this;
167 filter_sys_t *p_sys = p_filter->p_sys;
169 p_sys->p_mask->pf_release( p_sys->p_mask );
171 vlc_mutex_destroy( &p_sys->lock );
173 free( p_filter->p_sys );
176 /*****************************************************************************
178 *****************************************************************************/
179 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
183 if( !p_pic ) return NULL;
184 switch( p_pic->format.i_chroma )
186 case VLC_FOURCC('I','4','2','0'):
187 case VLC_FOURCC('I','Y','U','V'):
188 case VLC_FOURCC('J','4','2','0'):
189 case VLC_FOURCC('Y','V','1','2'):
191 case VLC_FOURCC('I','4','2','2'):
192 case VLC_FOURCC('J','4','2','2'):
195 msg_Warn( p_filter, "Unsupported input chroma (%4s)",
196 (char*)&(p_pic->format.i_chroma) );
197 if( p_pic->pf_release )
198 p_pic->pf_release( p_pic );
202 p_outpic = p_filter->pf_vout_buffer_new( p_filter );
205 msg_Warn( p_filter, "can't get output picture" );
206 if( p_pic->pf_release )
207 p_pic->pf_release( p_pic );
212 FilterErase( p_filter, p_pic, p_outpic );
214 p_outpic->date = p_pic->date;
215 p_outpic->b_force = p_pic->b_force;
216 p_outpic->i_nb_fields = p_pic->i_nb_fields;
217 p_outpic->b_progressive = p_pic->b_progressive;
218 p_outpic->b_top_field_first = p_pic->b_top_field_first;
220 if( p_pic->pf_release )
221 p_pic->pf_release( p_pic );
226 /*****************************************************************************
228 *****************************************************************************/
229 static void FilterErase( filter_t *p_filter, picture_t *p_inpic,
230 picture_t *p_outpic )
232 filter_sys_t *p_sys = p_filter->p_sys;
236 const int i_mask_pitch = p_sys->p_mask->A_PITCH;
237 const int i_mask_visible_pitch = p_sys->p_mask->p[A_PLANE].i_visible_pitch;
238 const int i_mask_visible_lines = p_sys->p_mask->p[A_PLANE].i_visible_lines;
240 for( i_plane = 0; i_plane < p_inpic->i_planes; i_plane++ )
242 const int i_pitch = p_inpic->p[i_plane].i_pitch;
243 const int i_2pitch = i_pitch<<1;
244 const int i_visible_pitch = p_inpic->p[i_plane].i_visible_pitch;
245 const int i_lines = p_inpic->p[i_plane].i_lines;
246 const int i_visible_lines = p_inpic->p[i_plane].i_visible_lines;
248 uint8_t *p_inpix = p_inpic->p[i_plane].p_pixels;
249 uint8_t *p_outpix = p_outpic->p[i_plane].p_pixels;
250 uint8_t *p_mask = p_sys->p_mask->A_PIXELS;
252 int i_x = p_sys->i_x,
255 int i_height = i_mask_visible_lines;
256 int i_width = i_mask_visible_pitch;
258 const vlc_bool_t b_line_factor = ( i_plane /* U_PLANE or V_PLANE */ &&
259 !( p_inpic->format.i_chroma == VLC_FOURCC('I','4','2','2')
260 || p_inpic->format.i_chroma == VLC_FOURCC('J','4','2','2') ) );
262 if( i_plane ) /* U_PLANE or V_PLANE */
272 i_height = __MIN( i_visible_lines - i_y, i_height );
273 i_width = __MIN( i_visible_pitch - i_x, i_width );
275 /* Copy original pixel buffer */
276 p_filter->p_libvlc->pf_memcpy( p_outpix, p_inpix, i_pitch * i_lines );
278 /* Horizontal linear interpolation of masked areas */
279 p_outpix = p_outpic->p[i_plane].p_pixels + i_y*i_pitch + i_x;
280 for( y = 0; y < i_height;
281 y++, p_mask += i_mask_pitch, p_outpix += i_pitch )
283 uint8_t prev, next = 0;
284 int prev_x = -1, next_x = -2;
287 /* Find a suitable value for the previous color to use when
288 * interpoling a masked pixel's value */
291 /* There are pixels before current position on the same line.
293 prev = *(p_outpix-1);
297 /* This is the first pixel on a line but there other lines
298 * above us. Use the pixel right above */
299 prev = *(p_outpix-i_pitch);
303 /* We're in the upper left corner. This sucks. We can't use
304 * any previous value, so we'll use a dummy one. In most
305 * cases this dummy value will be fixed later on in the
310 for( x = 0; x < i_width; x++ )
312 if( p_mask[i_plane?x<<1:x] > 127 )
314 /* This is a masked pixel */
315 if( next_x <= prev_x )
318 /* Look for the next non masked pixel on the same
319 * line (inside the mask's bounding box) */
320 for( x0 = x; x0 < i_width; x0++ )
322 if( p_mask[i_plane?x0<<1:x0] <= 127 )
324 /* We found an unmasked pixel. Victory! */
330 if( next_x <= prev_x )
332 /* We didn't find an unmasked pixel yet. Try
335 if( x0 < i_visible_pitch )
337 /* If we didn't find a non masked pixel on the
338 * same line inside the mask's bounding box,
339 * use the next pixel on the line (except if
340 * it doesn't exist) */
346 /* The last pixel on the line is masked,
347 * so we'll use the "prev" value. A better
348 * approach would be to use unmasked pixels
349 * at the end of adjacent lines */
354 if( !( i_x || y || i_y ) )
355 /* We were unable to find a suitable value for
356 * the previous color (which means that we are
357 * on the first line in the upper left corner)
361 /* Divide only once instead of next_x-prev_x-1 times */
362 quot = ((next-prev)<<16)/(next_x-prev_x);
364 /* Interpolate new value, and round correctly */
365 p_outpix[x] = prev + (((x-prev_x)*quot+(1<<16))>>16);
369 /* This pixel isn't masked. It's thus suitable as a
370 * previous color for the next interpolation */
377 /* Vertical bluring */
378 p_mask = p_sys->p_mask->A_PIXELS;
379 i_height = b_line_factor ? i_mask_visible_lines>>1
380 : i_mask_visible_lines;
381 /* Make sure that we stop at least 2 lines before the picture's end
382 * (since our bluring algorithm uses the 2 next lines) */
383 i_height = __MIN( i_visible_lines - i_y - 2, i_height );
384 /* Make sure that we start at least 2 lines from the top (since our
385 * bluring algorithm uses the 2 previous lines) */
387 p_outpix = p_outpic->p[i_plane].p_pixels + (i_y+y)*i_pitch + i_x;
388 for( ; y < i_height; y++, p_mask += i_mask_pitch, p_outpix += i_pitch )
390 for( x = 0; x < i_width; x++ )
392 if( p_mask[i_plane?x<<1:x] > 127 )
394 /* Ugly bluring function */
396 ( (p_outpix[x-i_2pitch]<<1) /* 2 */
397 + (p_outpix[x-i_pitch ]<<2) /* 4 */
398 + (p_outpix[x ]<<2) /* 4 */
399 + (p_outpix[x+i_pitch ]<<2) /* 4 */
400 + (p_outpix[x+i_2pitch]<<1) )>>4; /* 2 */
407 static int EraseCallback( vlc_object_t *p_this, char const *psz_var,
408 vlc_value_t oldval, vlc_value_t newval, void *p_data )
410 filter_sys_t *p_sys = (filter_sys_t *)p_data;
412 if( !strcmp( psz_var, CFG_PREFIX "x" ) )
414 vlc_mutex_lock( &p_sys->lock );
415 p_sys->i_x = newval.i_int;
416 vlc_mutex_unlock( &p_sys->lock );
418 else if( !strcmp( psz_var, CFG_PREFIX "y" ) )
420 vlc_mutex_lock( &p_sys->lock );
421 p_sys->i_y = newval.i_int;
422 vlc_mutex_unlock( &p_sys->lock );
424 else if( !strcmp( psz_var, CFG_PREFIX "mask" ) )
426 vlc_mutex_lock( &p_sys->lock );
427 LoadMask( (filter_t*)p_this, newval.psz_string );
428 vlc_mutex_unlock( &p_sys->lock );
432 msg_Warn( p_this, "Unknown callback command." );