Remove unnedeeded msg_Error.
[vlc.git] / modules / video_filter / erase.c
1 /*****************************************************************************
2  * erase.c : logo erase video filter
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_sout.h>
35 #include <vlc_vout.h>
36 #include "vlc_image.h"
37
38 #include "vlc_filter.h"
39 #include "filter_picture.h"
40
41 /*****************************************************************************
42  * Local prototypes
43  *****************************************************************************/
44 static int  Create    ( vlc_object_t * );
45 static void Destroy   ( vlc_object_t * );
46
47 static picture_t *Filter( filter_t *, picture_t * );
48 static void FilterErase( filter_t *, picture_t *, picture_t * );
49 static int EraseCallback( vlc_object_t *, char const *,
50                           vlc_value_t, vlc_value_t, void * );
51
52 /*****************************************************************************
53  * Module descriptor
54  *****************************************************************************/
55 #define MASK_TEXT N_("Image mask")
56 #define MASK_LONGTEXT N_("Image mask. Pixels with an alpha value greater than 50% will be erased.")
57
58 #define POSX_TEXT N_("X coordinate")
59 #define POSX_LONGTEXT N_("X coordinate of the mask.")
60 #define POSY_TEXT N_("Y coordinate")
61 #define POSY_LONGTEXT N_("Y coordinate of the mask.")
62
63 #define CFG_PREFIX "erase-"
64
65 vlc_module_begin();
66     set_description( N_("Erase video filter") );
67     set_shortname( N_( "Erase" ));
68     set_capability( "video filter2", 0 );
69     set_category( CAT_VIDEO );
70     set_subcategory( SUBCAT_VIDEO_VFILTER );
71
72     add_file( CFG_PREFIX "mask", NULL, NULL,
73               MASK_TEXT, MASK_LONGTEXT, false );
74     add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, false );
75     add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, false );
76
77     add_shortcut( "erase" );
78     set_callbacks( Create, Destroy );
79 vlc_module_end();
80
81 static const char *const ppsz_filter_options[] = {
82     "mask", "x", "y", NULL
83 };
84
85 /*****************************************************************************
86  * filter_sys_t
87  *****************************************************************************/
88 struct filter_sys_t
89 {
90     int i_x;
91     int i_y;
92     picture_t *p_mask;
93     vlc_mutex_t lock;
94 };
95
96 static void LoadMask( filter_t *p_filter, const char *psz_filename )
97 {
98     image_handler_t *p_image;
99     video_format_t fmt_in, fmt_out;
100     picture_t *p_old_mask = p_filter->p_sys->p_mask;
101     memset( &fmt_in, 0, sizeof( video_format_t ) );
102     memset( &fmt_out, 0, sizeof( video_format_t ) );
103     fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
104     p_image = image_HandlerCreate( p_filter );
105     p_filter->p_sys->p_mask =
106         image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
107     if( p_filter->p_sys->p_mask )
108     {
109         if( p_old_mask )
110             p_old_mask->pf_release( p_old_mask );
111     }
112     else if( p_old_mask )
113     {
114         p_filter->p_sys->p_mask = p_old_mask;
115         msg_Err( p_filter, "Error while loading new mask. Keeping old mask." );
116     }
117     image_HandlerDelete( p_image );
118 }
119
120 /*****************************************************************************
121  * Create
122  *****************************************************************************/
123 static int Create( vlc_object_t *p_this )
124 {
125     filter_t *p_filter = (filter_t *)p_this;
126     filter_sys_t *p_sys;
127     char *psz_filename;
128
129     switch( p_filter->fmt_in.video.i_chroma )
130     {
131         case VLC_FOURCC('I','4','2','0'):
132         case VLC_FOURCC('I','Y','U','V'):
133         case VLC_FOURCC('J','4','2','0'):
134         case VLC_FOURCC('Y','V','1','2'):
135
136         case VLC_FOURCC('I','4','2','2'):
137         case VLC_FOURCC('J','4','2','2'):
138             break;
139
140         default:
141             msg_Err( p_filter, "Unsupported input chroma (%4s)",
142                      (char*)&(p_filter->fmt_in.video.i_chroma) );
143             return VLC_EGENERIC;
144     }
145
146     /* Allocate structure */
147     p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
148     if( p_filter->p_sys == NULL )
149         return VLC_ENOMEM;
150     p_sys = p_filter->p_sys;
151
152     p_filter->pf_video_filter = Filter;
153
154     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
155                        p_filter->p_cfg );
156
157     psz_filename =
158         var_CreateGetNonEmptyStringCommand( p_filter, CFG_PREFIX "mask" );
159
160     if( !psz_filename )
161     {
162         msg_Err( p_filter, "Missing 'mask' option value." );
163         return VLC_EGENERIC;
164     }
165
166     p_sys->p_mask = NULL;
167     LoadMask( p_filter, psz_filename );
168     free( psz_filename );
169     p_sys->i_x = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX "x" );
170     p_sys->i_y = var_CreateGetIntegerCommand( p_filter, CFG_PREFIX "y" );
171
172     var_AddCallback( p_filter, CFG_PREFIX "x", EraseCallback, p_sys );
173     var_AddCallback( p_filter, CFG_PREFIX "y", EraseCallback, p_sys );
174     var_AddCallback( p_filter, CFG_PREFIX "mask", EraseCallback, p_sys );
175
176     vlc_mutex_init( &p_sys->lock );
177
178     return VLC_SUCCESS;
179 }
180
181 /*****************************************************************************
182  * Destroy
183  *****************************************************************************/
184 static void Destroy( vlc_object_t *p_this )
185 {
186     filter_t *p_filter = (filter_t *)p_this;
187     filter_sys_t *p_sys = p_filter->p_sys;
188     if( p_sys->p_mask )
189         p_sys->p_mask->pf_release( p_sys->p_mask );
190
191     vlc_mutex_destroy( &p_sys->lock );
192
193     free( p_filter->p_sys );
194 }
195
196 /*****************************************************************************
197  * Filter
198  *****************************************************************************/
199 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
200 {
201     picture_t *p_outpic;
202
203     if( !p_pic ) return NULL;
204
205     p_outpic = p_filter->pf_vout_buffer_new( p_filter );
206     if( !p_outpic )
207     {
208         msg_Warn( p_filter, "can't get output picture" );
209         if( p_pic->pf_release )
210             p_pic->pf_release( p_pic );
211         return NULL;
212     }
213
214     /* Here */
215     FilterErase( p_filter, p_pic, p_outpic );
216
217     return CopyInfoAndRelease( p_outpic, p_pic );
218 }
219
220 /*****************************************************************************
221  * FilterErase
222  *****************************************************************************/
223 static void FilterErase( filter_t *p_filter, picture_t *p_inpic,
224                                              picture_t *p_outpic )
225 {
226     filter_sys_t *p_sys = p_filter->p_sys;
227
228     int i_plane;
229
230     const int i_mask_pitch = p_sys->p_mask->A_PITCH;
231     const int i_mask_visible_pitch = p_sys->p_mask->p[A_PLANE].i_visible_pitch;
232     const int i_mask_visible_lines = p_sys->p_mask->p[A_PLANE].i_visible_lines;
233
234     for( i_plane = 0; i_plane < p_inpic->i_planes; i_plane++ )
235     {
236         const int i_pitch = p_inpic->p[i_plane].i_pitch;
237         const int i_2pitch = i_pitch<<1;
238         const int i_visible_pitch = p_inpic->p[i_plane].i_visible_pitch;
239         const int i_lines = p_inpic->p[i_plane].i_lines;
240         const int i_visible_lines = p_inpic->p[i_plane].i_visible_lines;
241
242         uint8_t *p_inpix = p_inpic->p[i_plane].p_pixels;
243         uint8_t *p_outpix = p_outpic->p[i_plane].p_pixels;
244         uint8_t *p_mask = p_sys->p_mask->A_PIXELS;
245
246         int i_x = p_sys->i_x,
247             i_y = p_sys->i_y;
248         int x, y;
249         int i_height = i_mask_visible_lines;
250         int i_width  = i_mask_visible_pitch;
251
252         const bool b_line_factor = ( i_plane /* U_PLANE or V_PLANE */ &&
253             !( p_inpic->format.i_chroma == VLC_FOURCC('I','4','2','2')
254             || p_inpic->format.i_chroma == VLC_FOURCC('J','4','2','2') ) );
255
256         if( i_plane ) /* U_PLANE or V_PLANE */
257         {
258             i_width  >>= 1;
259             i_x      >>= 1;
260         }
261         if( b_line_factor )
262         {
263             i_height >>= 1;
264             i_y      >>= 1;
265         }
266         i_height = __MIN( i_visible_lines - i_y, i_height );
267         i_width  = __MIN( i_visible_pitch - i_x, i_width  );
268
269         /* Copy original pixel buffer */
270         vlc_memcpy( p_outpix, p_inpix, i_pitch * i_lines );
271
272         /* Horizontal linear interpolation of masked areas */
273         p_outpix = p_outpic->p[i_plane].p_pixels + i_y*i_pitch + i_x;
274         for( y = 0; y < i_height;
275              y++, p_mask += i_mask_pitch, p_outpix += i_pitch )
276         {
277             uint8_t prev, next = 0;
278             int prev_x = -1, next_x = -2;
279             int quot = 0;
280
281             /* Find a suitable value for the previous color to use when
282              * interpoling a masked pixel's value */
283             if( i_x )
284             {
285                 /* There are pixels before current position on the same line.
286                  * Use those */
287                 prev = *(p_outpix-1);
288             }
289             else if( y || i_y )
290             {
291                 /* This is the first pixel on a line but there other lines
292                  * above us. Use the pixel right above */
293                 prev = *(p_outpix-i_pitch);
294             }
295             else
296             {
297                 /* We're in the upper left corner. This sucks. We can't use
298                  * any previous value, so we'll use a dummy one. In most
299                  * cases this dummy value will be fixed later on in the
300                  * algorithm */
301                 prev = 0xff;
302             }
303
304             for( x = 0; x < i_width; x++ )
305             {
306                 if( p_mask[i_plane?x<<1:x] > 127 )
307                 {
308                     /* This is a masked pixel */
309                     if( next_x <= prev_x )
310                     {
311                         int x0;
312                         /* Look for the next non masked pixel on the same
313                          * line (inside the mask's bounding box) */
314                         for( x0 = x; x0 < i_width; x0++ )
315                         {
316                             if( p_mask[i_plane?x0<<1:x0] <= 127 )
317                             {
318                                 /* We found an unmasked pixel. Victory! */
319                                 next_x = x0;
320                                 next = p_outpix[x0];
321                                 break;
322                             }
323                         }
324                         if( next_x <= prev_x )
325                         {
326                             /* We didn't find an unmasked pixel yet. Try
327                              * harder */
328                             if( x0 == x ) x0++;
329                             if( x0 < i_visible_pitch )
330                             {
331                                 /* If we didn't find a non masked pixel on the
332                                  * same line inside the mask's bounding box,
333                                  * use the next pixel on the line (except if
334                                  * it doesn't exist) */
335                                 next_x = x0;
336                                 next = p_outpix[x0];
337                             }
338                             else
339                             {
340                                 /* The last pixel on the line is masked,
341                                  * so we'll use the "prev" value. A better
342                                  * approach would be to use unmasked pixels
343                                  * at the end of adjacent lines */
344                                 next_x = x0;
345                                 next = prev;
346                             }
347                         }
348                         if( !( i_x || y || i_y ) )
349                             /* We were unable to find a suitable value for
350                              * the previous color (which means that we are
351                              * on the first line in the upper left corner)
352                              */
353                             prev = next;
354
355                         /* Divide only once instead of next_x-prev_x-1 times */
356                         quot = ((next-prev)<<16)/(next_x-prev_x);
357                     }
358                     /* Interpolate new value, and round correctly */
359                     p_outpix[x] = prev + (((x-prev_x)*quot+(1<<16))>>16);
360                 }
361                 else
362                 {
363                     /* This pixel isn't masked. It's thus suitable as a
364                      * previous color for the next interpolation */
365                     prev = p_outpix[x];
366                     prev_x = x;
367                 }
368             }
369         }
370
371         /* Vertical bluring */
372         p_mask = p_sys->p_mask->A_PIXELS;
373         i_height = b_line_factor ? i_mask_visible_lines>>1
374                                  : i_mask_visible_lines;
375         /* Make sure that we stop at least 2 lines before the picture's end
376          * (since our bluring algorithm uses the 2 next lines) */
377         i_height = __MIN( i_visible_lines - i_y - 2, i_height );
378         /* Make sure that we start at least 2 lines from the top (since our
379          * bluring algorithm uses the 2 previous lines) */
380         y = __MAX(i_y,2);
381         p_outpix = p_outpic->p[i_plane].p_pixels + (i_y+y)*i_pitch + i_x;
382         for( ; y < i_height; y++, p_mask += i_mask_pitch, p_outpix += i_pitch )
383         {
384             for( x = 0; x < i_width; x++ )
385             {
386                 if( p_mask[i_plane?x<<1:x] > 127 )
387                 {
388                     /* Ugly bluring function */
389                     p_outpix[x] =
390                         ( (p_outpix[x-i_2pitch]<<1)       /* 2 */
391                         + (p_outpix[x-i_pitch ]<<2)       /* 4 */
392                         + (p_outpix[x         ]<<2)       /* 4 */
393                         + (p_outpix[x+i_pitch ]<<2)       /* 4 */
394                         + (p_outpix[x+i_2pitch]<<1) )>>4; /* 2 */
395                 }
396             }
397         }
398     }
399 }
400
401 static int EraseCallback( vlc_object_t *p_this, char const *psz_var,
402                           vlc_value_t oldval, vlc_value_t newval, void *p_data )
403 {
404     VLC_UNUSED(oldval);
405     filter_sys_t *p_sys = (filter_sys_t *)p_data;
406
407     if( !strcmp( psz_var, CFG_PREFIX "x" ) )
408     {
409         vlc_mutex_lock( &p_sys->lock );
410         p_sys->i_x = newval.i_int;
411         vlc_mutex_unlock( &p_sys->lock );
412     }
413     else if( !strcmp( psz_var, CFG_PREFIX "y" ) )
414     {
415         vlc_mutex_lock( &p_sys->lock );
416         p_sys->i_y = newval.i_int;
417         vlc_mutex_unlock( &p_sys->lock );
418     }
419     else if( !strcmp( psz_var, CFG_PREFIX "mask" ) )
420     {
421         vlc_mutex_lock( &p_sys->lock );
422         LoadMask( (filter_t*)p_this, newval.psz_string );
423         vlc_mutex_unlock( &p_sys->lock );
424     }
425     else
426     {
427         msg_Warn( p_this, "Unknown callback command." );
428     }
429     return VLC_SUCCESS;
430 }