git.sesse.net Git - vlc/blob - modules/video_filter/crop.c

   1 /*****************************************************************************
   2  * crop.c : Crop video plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2002, 2003 VideoLAN
   5  * $Id: crop.c,v 1.13 2003/10/15 22:49:48 gbazin Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28 #include <string.h>
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc/vout.h>
  32
  33 #include "filter_common.h"
  34
  35 /*****************************************************************************
  36  * Local prototypes
  37  *****************************************************************************/
  38 static int  Create    ( vlc_object_t * );
  39 static void Destroy   ( vlc_object_t * );
  40
  41 static int  Init      ( vout_thread_t * );
  42 static void End       ( vout_thread_t * );
  43 static int  Manage    ( vout_thread_t * );
  44 static void Render    ( vout_thread_t *, picture_t * );
  45
  46 static void UpdateStats    ( vout_thread_t *, picture_t * );
  47
  48 static int  SendEvents( vlc_object_t *, char const *,
  49                         vlc_value_t, vlc_value_t, void * );
  50
  51 /*****************************************************************************
  52  * Module descriptor
  53  *****************************************************************************/
  54 #define GEOMETRY_TEXT N_("Crop geometry")
  55 #define GEOMETRY_LONGTEXT N_("Set the geometry of the zone to crop. This is set as width x heigth + left offset + top offset.")
  56
  57 #define AUTOCROP_TEXT N_("Automatic cropping")
  58 #define AUTOCROP_LONGTEXT N_("Activate automatic black border cropping")
  59
  60 vlc_module_begin();
  61     add_category_hint( N_("Crop"), NULL, VLC_FALSE );
  62     add_string( "crop-geometry", NULL, NULL, GEOMETRY_TEXT, GEOMETRY_LONGTEXT, VLC_FALSE );
  63     add_bool( "autocrop", 0, NULL, AUTOCROP_TEXT, AUTOCROP_LONGTEXT, VLC_FALSE );
  64     set_description( _("crop video filter") );
  65     set_capability( "video filter", 0 );
  66     add_shortcut( "crop" );
  67     set_callbacks( Create, Destroy );
  68 vlc_module_end();
  69
  70 /*****************************************************************************
  71  * vout_sys_t: Crop video output method descriptor
  72  *****************************************************************************
  73  * This structure is part of the video output thread descriptor.
  74  * It describes the Crop specific properties of an output thread.
  75  *****************************************************************************/
  76 struct vout_sys_t
  77 {
  78     vout_thread_t *p_vout;
  79
  80     unsigned int i_x, i_y;
  81     unsigned int i_width, i_height, i_aspect;
  82
  83     vlc_bool_t b_autocrop;
  84
  85     /* Autocrop specific variables */
  86     unsigned int i_lastchange;
  87     vlc_bool_t   b_changed;
  88 };
  89
  90 /*****************************************************************************
  91  * Create: allocates Crop video thread output method
  92  *****************************************************************************
  93  * This function allocates and initializes a Crop vout method.
  94  *****************************************************************************/
  95 static int Create( vlc_object_t *p_this )
  96 {
  97     vout_thread_t *p_vout = (vout_thread_t *)p_this;
  98
  99     /* Allocate structure */
 100     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 101     if( p_vout->p_sys == NULL )
 102     {
 103         msg_Err( p_vout, "out of memory" );
 104         return VLC_ENOMEM;
 105     }
 106
 107     p_vout->pf_init = Init;
 108     p_vout->pf_end = End;
 109     p_vout->pf_manage = Manage;
 110     p_vout->pf_render = Render;
 111     p_vout->pf_display = NULL;
 112
 113     return VLC_SUCCESS;
 114 }
 115
 116 /*****************************************************************************
 117  * Init: initialize Crop video thread output method
 118  *****************************************************************************/
 119 static int Init( vout_thread_t *p_vout )
 120 {
 121     int   i_index;
 122     char *psz_var;
 123     picture_t *p_pic;
 124
 125     I_OUTPUTPICTURES = 0;
 126
 127     p_vout->p_sys->i_lastchange = 0;
 128     p_vout->p_sys->b_changed = VLC_FALSE;
 129
 130     /* Initialize the output structure */
 131     p_vout->output.i_chroma = p_vout->render.i_chroma;
 132     p_vout->output.i_width  = p_vout->render.i_width;
 133     p_vout->output.i_height = p_vout->render.i_height;
 134     p_vout->output.i_aspect = p_vout->render.i_aspect;
 135
 136     /* Shall we use autocrop ? */
 137     p_vout->p_sys->b_autocrop = config_GetInt( p_vout, "autocrop" );
 138
 139     /* Get geometry value from the user */
 140     psz_var = config_GetPsz( p_vout, "crop-geometry" );
 141     if( psz_var )
 142     {
 143         char *psz_parser, *psz_tmp;
 144
 145         psz_parser = psz_tmp = psz_var;
 146         while( *psz_tmp && *psz_tmp != 'x' ) psz_tmp++;
 147
 148         if( *psz_tmp )
 149         {
 150             psz_tmp[0] = '\0';
 151             p_vout->p_sys->i_width = atoi( psz_parser );
 152
 153             psz_parser = ++psz_tmp;
 154             while( *psz_tmp && *psz_tmp != '+' ) psz_tmp++;
 155
 156             if( *psz_tmp )
 157             {
 158                 psz_tmp[0] = '\0';
 159                 p_vout->p_sys->i_height = atoi( psz_parser );
 160
 161                 psz_parser = ++psz_tmp;
 162                 while( *psz_tmp && *psz_tmp != '+' ) psz_tmp++;
 163
 164                 if( *psz_tmp )
 165                 {
 166                     psz_tmp[0] = '\0';
 167                     p_vout->p_sys->i_x = atoi( psz_parser );
 168                     p_vout->p_sys->i_y = atoi( ++psz_tmp );
 169                 }
 170                 else
 171                 {
 172                     p_vout->p_sys->i_x = atoi( psz_parser );
 173                     p_vout->p_sys->i_y =
 174                      ( p_vout->output.i_height - p_vout->p_sys->i_height ) / 2;
 175                 }
 176             }
 177             else
 178             {
 179                 p_vout->p_sys->i_height = atoi( psz_parser );
 180                 p_vout->p_sys->i_x =
 181                      ( p_vout->output.i_width - p_vout->p_sys->i_width ) / 2;
 182                 p_vout->p_sys->i_y =
 183                      ( p_vout->output.i_height - p_vout->p_sys->i_height ) / 2;
 184             }
 185         }
 186         else
 187         {
 188             p_vout->p_sys->i_width = atoi( psz_parser );
 189             p_vout->p_sys->i_height = p_vout->output.i_height;
 190             p_vout->p_sys->i_x =
 191                      ( p_vout->output.i_width - p_vout->p_sys->i_width ) / 2;
 192             p_vout->p_sys->i_y =
 193                      ( p_vout->output.i_height - p_vout->p_sys->i_height ) / 2;
 194         }
 195
 196         /* Check for validity */
 197         if( p_vout->p_sys->i_x + p_vout->p_sys->i_width
 198                                                    > p_vout->output.i_width )
 199         {
 200             p_vout->p_sys->i_x = 0;
 201             if( p_vout->p_sys->i_width > p_vout->output.i_width )
 202             {
 203                 p_vout->p_sys->i_width = p_vout->output.i_width;
 204             }
 205         }
 206
 207         if( p_vout->p_sys->i_y + p_vout->p_sys->i_height
 208                                                    > p_vout->output.i_height )
 209         {
 210             p_vout->p_sys->i_y = 0;
 211             if( p_vout->p_sys->i_height > p_vout->output.i_height )
 212             {
 213                 p_vout->p_sys->i_height = p_vout->output.i_height;
 214             }
 215         }
 216
 217         free( psz_var );
 218     }
 219     else
 220     {
 221         p_vout->p_sys->i_width  = p_vout->output.i_width;
 222         p_vout->p_sys->i_height = p_vout->output.i_height;
 223         p_vout->p_sys->i_x = p_vout->p_sys->i_y = 0;
 224     }
 225
 226     /* Pheeew. Parsing done. */
 227     msg_Dbg( p_vout, "cropping at %ix%i+%i+%i, %sautocropping",
 228                      p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 229                      p_vout->p_sys->i_x, p_vout->p_sys->i_y,
 230                      p_vout->p_sys->b_autocrop ? "" : "not " );
 231
 232     /* Set current output image properties */
 233     p_vout->p_sys->i_aspect = p_vout->output.i_aspect
 234                             * p_vout->output.i_height / p_vout->p_sys->i_height
 235                             * p_vout->p_sys->i_width / p_vout->output.i_width;
 236
 237     /* Try to open the real video output */
 238     p_vout->p_sys->p_vout = vout_Create( p_vout,
 239                     p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 240                     p_vout->render.i_chroma, p_vout->p_sys->i_aspect );
 241     if( p_vout->p_sys->p_vout == NULL )
 242     {
 243         msg_Err( p_vout, "failed to create vout" );
 244         return VLC_EGENERIC;
 245     }
 246
 247     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
 248
 249     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 250
 251     ADD_PARENT_CALLBACKS( SendEventsToChild );
 252
 253     return VLC_SUCCESS;
 254 }
 255
 256 /*****************************************************************************
 257  * End: terminate Crop video thread output method
 258  *****************************************************************************/
 259 static void End( vout_thread_t *p_vout )
 260 {
 261     int i_index;
 262
 263     /* Free the fake output buffers we allocated */
 264     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 265     {
 266         i_index--;
 267         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
 268     }
 269 }
 270
 271 /*****************************************************************************
 272  * Destroy: destroy Crop video thread output method
 273  *****************************************************************************
 274  * Terminate an output method created by CropCreateOutputMethod
 275  *****************************************************************************/
 276 static void Destroy( vlc_object_t *p_this )
 277 {
 278     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 279
 280     DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 281     vlc_object_detach( p_vout->p_sys->p_vout );
 282     vout_Destroy( p_vout->p_sys->p_vout );
 283
 284     DEL_PARENT_CALLBACKS( SendEventsToChild );
 285
 286     free( p_vout->p_sys );
 287 }
 288
 289 /*****************************************************************************
 290  * Manage: handle Crop events
 291  *****************************************************************************
 292  * This function should be called regularly by video output thread. It manages
 293  * console events. It returns a non null value on error.
 294  *****************************************************************************/
 295 static int Manage( vout_thread_t *p_vout )
 296 {
 297     if( !p_vout->p_sys->b_changed )
 298     {
 299         return VLC_SUCCESS;
 300     }
 301
 302     vout_Destroy( p_vout->p_sys->p_vout );
 303
 304     p_vout->p_sys->p_vout = vout_Create( p_vout,
 305                     p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 306                     p_vout->render.i_chroma, p_vout->p_sys->i_aspect );
 307     if( p_vout->p_sys->p_vout == NULL )
 308     {
 309         msg_Err( p_vout, "failed to create vout" );
 310         return VLC_EGENERIC;
 311     }
 312
 313     p_vout->p_sys->b_changed = VLC_FALSE;
 314     p_vout->p_sys->i_lastchange = 0;
 315
 316     return VLC_SUCCESS;
 317 }
 318
 319 /*****************************************************************************
 320  * Render: display previously rendered output
 321  *****************************************************************************
 322  * This function sends the currently rendered image to Crop image, waits
 323  * until it is displayed and switches the two rendering buffers, preparing next
 324  * frame.
 325  *****************************************************************************/
 326 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 327 {
 328     picture_t *p_outpic = NULL;
 329     int i_plane;
 330
 331     if( p_vout->p_sys->b_changed )
 332     {
 333         return;
 334     }
 335
 336     while( ( p_outpic =
 337                  vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 )
 338            ) == NULL )
 339     {
 340         if( p_vout->b_die || p_vout->b_error )
 341         {
 342             vout_DestroyPicture( p_vout->p_sys->p_vout, p_outpic );
 343             return;
 344         }
 345
 346         msleep( VOUT_OUTMEM_SLEEP );
 347     }
 348
 349     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
 350     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
 351
 352     for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
 353     {
 354         uint8_t *p_in, *p_out, *p_out_end;
 355         int i_in_pitch = p_pic->p[i_plane].i_pitch;
 356         const int i_out_pitch = p_outpic->p[i_plane].i_pitch;
 357         const int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
 358
 359         p_in = p_pic->p[i_plane].p_pixels
 360                 /* Skip the right amount of lines */
 361                 + i_in_pitch * ( p_pic->p[i_plane].i_lines * p_vout->p_sys->i_y
 362                                   / p_vout->output.i_height )
 363                 /* Skip the right amount of columns */
 364                 + i_in_pitch * p_vout->p_sys->i_x / p_vout->output.i_width;
 365
 366         p_out = p_outpic->p[i_plane].p_pixels;
 367         p_out_end = p_out + i_out_pitch * p_outpic->p[i_plane].i_lines;
 368
 369         while( p_out < p_out_end )
 370         {
 371             p_vout->p_vlc->pf_memcpy( p_out, p_in, i_copy_pitch );
 372             p_in += i_in_pitch;
 373             p_out += i_out_pitch;
 374         }
 375     }
 376
 377     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
 378     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
 379
 380     /* The source image may still be in the cache ... parse it! */
 381     if( p_vout->p_sys->b_autocrop )
 382     {
 383         UpdateStats( p_vout, p_pic );
 384     }
 385 }
 386
 387 static void UpdateStats( vout_thread_t *p_vout, picture_t *p_pic )
 388 {
 389     uint8_t *p_in = p_pic->p[0].p_pixels;
 390     int i_pitch = p_pic->p[0].i_pitch;
 391     int i_visible_pitch = p_pic->p[0].i_visible_pitch;
 392     int i_lines = p_pic->p[0].i_lines;
 393     int i_firstwhite = -1, i_lastwhite = -1, i;
 394
 395     /* Determine where black borders are */
 396     switch( p_vout->output.i_chroma )
 397     {
 398     case VLC_FOURCC('I','4','2','0'):
 399         /* XXX: Do not laugh ! I know this is very naive. But it's just a
 400          *      proof of concept code snippet... */
 401         for( i = i_lines ; i-- ; )
 402         {
 403             const int i_col = i * i_pitch / i_lines;
 404
 405             if( p_in[i_col/2] > 40
 406                  && p_in[i_visible_pitch/2] > 40
 407                  && p_in[i_visible_pitch/2 + i_col/2] > 40 )
 408             {
 409                 if( i_lastwhite == -1 )
 410                 {
 411                     i_lastwhite = i;
 412                 }
 413                 i_firstwhite = i;
 414             }
 415             p_in += i_pitch;
 416         }
 417         break;
 418
 419     default:
 420         break;
 421     }
 422
 423     /* Decide whether it's worth changing the size */
 424     if( i_lastwhite == -1 )
 425     {
 426         p_vout->p_sys->i_lastchange = 0;
 427         return;
 428     }
 429
 430     if( (unsigned int)(i_lastwhite - i_firstwhite)
 431                                            < p_vout->p_sys->i_height / 2 )
 432     {
 433         p_vout->p_sys->i_lastchange = 0;
 434         return;
 435     }
 436
 437     if( (unsigned int)(i_lastwhite - i_firstwhite)
 438                                           < p_vout->p_sys->i_height + 16
 439          && (unsigned int)(i_lastwhite - i_firstwhite + 16)
 440                                                 > p_vout->p_sys->i_height )
 441     {
 442         p_vout->p_sys->i_lastchange = 0;
 443         return;
 444     }
 445
 446     /* We need at least 25 images to make up our mind */
 447     p_vout->p_sys->i_lastchange++;
 448     if( p_vout->p_sys->i_lastchange < 25 )
 449     {
 450         return;
 451     }
 452
 453     /* Tune a few values */
 454     if( i_firstwhite & 1 )
 455     {
 456         i_firstwhite--;
 457     }
 458
 459     if( !(i_lastwhite & 1) )
 460     {
 461         i_lastwhite++;
 462     }
 463
 464     /* Change size */
 465     p_vout->p_sys->i_y = i_firstwhite;
 466     p_vout->p_sys->i_height = i_lastwhite - i_firstwhite + 1;
 467
 468     p_vout->p_sys->i_aspect = p_vout->output.i_aspect
 469                             * p_vout->output.i_height / p_vout->p_sys->i_height
 470                             * p_vout->p_sys->i_width / p_vout->output.i_width;
 471
 472     p_vout->p_sys->b_changed = VLC_TRUE;
 473 }
 474
 475 /*****************************************************************************
 476  * SendEvents: forward mouse and keyboard events to the parent p_vout
 477  *****************************************************************************/
 478 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 479                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
 480 {
 481     vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
 482     vlc_value_t sentval = newval;
 483
 484     /* Translate the mouse coordinates */
 485     if( !strcmp( psz_var, "mouse-x" ) )
 486     {
 487         sentval.i_int += p_vout->p_sys->i_x;
 488     }
 489     else if( !strcmp( psz_var, "mouse-y" ) )
 490     {
 491         sentval.i_int += p_vout->p_sys->i_y;
 492     }
 493
 494     var_Set( p_vout, psz_var, sentval );
 495
 496     return VLC_SUCCESS;
 497 }
 498
 499 /*****************************************************************************
 500  * SendEventsToChild: forward events to the child/children vout
 501  *****************************************************************************/
 502 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
 503                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 504 {
 505     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 506     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
 507     return VLC_SUCCESS;
 508 }