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