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.8 2003/02/20 01:52:46 sigmunau 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")
  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( _("image crop video module") );
  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     return VLC_SUCCESS;
 252 }
 253
 254 /*****************************************************************************
 255  * End: terminate Crop video thread output method
 256  *****************************************************************************/
 257 static void End( vout_thread_t *p_vout )
 258 {
 259     int i_index;
 260
 261     /* Free the fake output buffers we allocated */
 262     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 263     {
 264         i_index--;
 265         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
 266     }
 267 }
 268
 269 /*****************************************************************************
 270  * Destroy: destroy Crop video thread output method
 271  *****************************************************************************
 272  * Terminate an output method created by CropCreateOutputMethod
 273  *****************************************************************************/
 274 static void Destroy( vlc_object_t *p_this )
 275 {
 276     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 277
 278     DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 279     vout_Destroy( p_vout->p_sys->p_vout );
 280
 281     free( p_vout->p_sys );
 282 }
 283
 284 /*****************************************************************************
 285  * Manage: handle Crop events
 286  *****************************************************************************
 287  * This function should be called regularly by video output thread. It manages
 288  * console events. It returns a non null value on error.
 289  *****************************************************************************/
 290 static int Manage( vout_thread_t *p_vout )
 291 {
 292     if( !p_vout->p_sys->b_changed )
 293     {
 294         return VLC_SUCCESS;
 295     }
 296
 297     vout_Destroy( p_vout->p_sys->p_vout );
 298
 299     p_vout->p_sys->p_vout = vout_Create( p_vout,
 300                     p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 301                     p_vout->render.i_chroma, p_vout->p_sys->i_aspect );
 302     if( p_vout->p_sys->p_vout == NULL )
 303     {
 304         msg_Err( p_vout, "failed to create vout" );
 305         return VLC_EGENERIC;
 306     }
 307
 308     p_vout->p_sys->b_changed = VLC_FALSE;
 309     p_vout->p_sys->i_lastchange = 0;
 310
 311     return VLC_SUCCESS;
 312 }
 313
 314 /*****************************************************************************
 315  * Render: display previously rendered output
 316  *****************************************************************************
 317  * This function sends the currently rendered image to Crop image, waits
 318  * until it is displayed and switches the two rendering buffers, preparing next
 319  * frame.
 320  *****************************************************************************/
 321 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 322 {
 323     picture_t *p_outpic = NULL;
 324     int i_plane;
 325
 326     if( p_vout->p_sys->b_changed )
 327     {
 328         return;
 329     }
 330
 331     while( ( p_outpic =
 332                  vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 )
 333            ) == NULL )
 334     {
 335         if( p_vout->b_die || p_vout->b_error )
 336         {
 337             vout_DestroyPicture( p_vout->p_sys->p_vout, p_outpic );
 338             return;
 339         }
 340
 341         msleep( VOUT_OUTMEM_SLEEP );
 342     }
 343
 344     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
 345     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
 346
 347     for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
 348     {
 349         uint8_t *p_in, *p_out, *p_out_end;
 350         int i_in_pitch = p_pic->p[i_plane].i_pitch;
 351         const int i_out_pitch = p_outpic->p[i_plane].i_pitch;
 352         const int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
 353
 354         p_in = p_pic->p[i_plane].p_pixels
 355                 /* Skip the right amount of lines */
 356                 + i_in_pitch * ( p_pic->p[i_plane].i_lines * p_vout->p_sys->i_y
 357                                   / p_vout->output.i_height )
 358                 /* Skip the right amount of columns */
 359                 + i_in_pitch * p_vout->p_sys->i_x / p_vout->output.i_width;
 360
 361         p_out = p_outpic->p[i_plane].p_pixels;
 362         p_out_end = p_out + i_out_pitch * p_outpic->p[i_plane].i_lines;
 363
 364         while( p_out < p_out_end )
 365         {
 366             p_vout->p_vlc->pf_memcpy( p_out, p_in, i_copy_pitch );
 367             p_in += i_in_pitch;
 368             p_out += i_out_pitch;
 369         }
 370     }
 371
 372     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
 373     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
 374
 375     /* The source image may still be in the cache ... parse it! */
 376     if( p_vout->p_sys->b_autocrop )
 377     {
 378         UpdateStats( p_vout, p_pic );
 379     }
 380 }
 381
 382 static void UpdateStats( vout_thread_t *p_vout, picture_t *p_pic )
 383 {
 384     uint8_t *p_in = p_pic->p[0].p_pixels;
 385     int i_pitch = p_pic->p[0].i_pitch;
 386     int i_visible_pitch = p_pic->p[0].i_visible_pitch;
 387     int i_lines = p_pic->p[0].i_lines;
 388     int i_firstwhite = -1, i_lastwhite = -1, i;
 389
 390     /* Determine where black borders are */
 391     switch( p_vout->output.i_chroma )
 392     {
 393     case VLC_FOURCC('I','4','2','0'):
 394         /* XXX: Do not laugh ! I know this is very naive. But it's just a
 395          *      proof of concept code snippet... */
 396         for( i = i_lines ; i-- ; )
 397         {
 398             const int i_col = i * i_pitch / i_lines;
 399
 400             if( p_in[i_col/2] > 40
 401                  && p_in[i_visible_pitch/2] > 40
 402                  && p_in[i_visible_pitch/2 + i_col/2] > 40 )
 403             {
 404                 if( i_lastwhite == -1 )
 405                 {
 406                     i_lastwhite = i;
 407                 }
 408                 i_firstwhite = i;
 409             }
 410             p_in += i_pitch;
 411         }
 412         break;
 413
 414     default:
 415         break;
 416     }
 417
 418     /* Decide whether it's worth changing the size */
 419     if( i_lastwhite == -1 )
 420     {
 421         p_vout->p_sys->i_lastchange = 0;
 422         return;
 423     }
 424
 425     if( (unsigned int)(i_lastwhite - i_firstwhite)
 426                                            < p_vout->p_sys->i_height / 2 )
 427     {
 428         p_vout->p_sys->i_lastchange = 0;
 429         return;
 430     }
 431
 432     if( (unsigned int)(i_lastwhite - i_firstwhite)
 433                                           < p_vout->p_sys->i_height + 16
 434          && (unsigned int)(i_lastwhite - i_firstwhite + 16)
 435                                                 > p_vout->p_sys->i_height )
 436     {
 437         p_vout->p_sys->i_lastchange = 0;
 438         return;
 439     }
 440
 441     /* We need at least 25 images to make up our mind */
 442     p_vout->p_sys->i_lastchange++;
 443     if( p_vout->p_sys->i_lastchange < 25 )
 444     {
 445         return;
 446     }
 447
 448     /* Tune a few values */
 449     if( i_firstwhite & 1 )
 450     {
 451         i_firstwhite--;
 452     }
 453
 454     if( !(i_lastwhite & 1) )
 455     {
 456         i_lastwhite++;
 457     }
 458
 459     /* Change size */
 460     p_vout->p_sys->i_y = i_firstwhite;
 461     p_vout->p_sys->i_height = i_lastwhite - i_firstwhite + 1;
 462
 463     p_vout->p_sys->i_aspect = p_vout->output.i_aspect
 464                             * p_vout->output.i_height / p_vout->p_sys->i_height
 465                             * p_vout->p_sys->i_width / p_vout->output.i_width;
 466
 467     p_vout->p_sys->b_changed = VLC_TRUE;
 468 }
 469
 470 /*****************************************************************************
 471  * SendEvents: forward mouse and keyboard events to the parent p_vout
 472  *****************************************************************************/
 473 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 474                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
 475 {
 476     vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
 477     vlc_value_t sentval = newval;
 478
 479     /* Translate the mouse coordinates */
 480     if( !strcmp( psz_var, "mouse-x" ) )
 481     {
 482         sentval.i_int += p_vout->p_sys->i_x;
 483     }
 484     else if( !strcmp( psz_var, "mouse-y" ) )
 485     {
 486         sentval.i_int += p_vout->p_sys->i_y;
 487     }
 488
 489     var_Set( p_vout, psz_var, sentval );
 490
 491     return VLC_SUCCESS;
 492 }
 493