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

   1 /*****************************************************************************
   2  * croppadd.c: Crop/Padd image filter
   3  *****************************************************************************
   4  * Copyright (C) 2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea @t 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 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <limits.h> /* INT_MAX */
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_filter.h>
  36 #include "filter_picture.h"
  37
  38 /****************************************************************************
  39  * Local prototypes
  40  ****************************************************************************/
  41 static int  OpenFilter ( vlc_object_t * );
  42 static void CloseFilter( vlc_object_t * );
  43
  44 static picture_t *Filter( filter_t *, picture_t * );
  45
  46 #define CROPTOP_TEXT N_( "Pixels to crop from top" )
  47 #define CROPTOP_LONGTEXT N_( \
  48     "Number of pixels to crop from the top of the image." )
  49 #define CROPBOTTOM_TEXT N_( "Pixels to crop from bottom" )
  50 #define CROPBOTTOM_LONGTEXT N_( \
  51     "Number of pixels to crop from the bottom of the image." )
  52 #define CROPLEFT_TEXT N_( "Pixels to crop from left" )
  53 #define CROPLEFT_LONGTEXT N_( \
  54     "Number of pixels to crop from the left of the image." )
  55 #define CROPRIGHT_TEXT N_( "Pixels to crop from right" )
  56 #define CROPRIGHT_LONGTEXT N_( \
  57     "Number of pixels to crop from the right of the image." )
  58
  59 #define PADDTOP_TEXT N_( "Pixels to padd to top" )
  60 #define PADDTOP_LONGTEXT N_( \
  61     "Number of pixels to padd to the top of the image after cropping." )
  62 #define PADDBOTTOM_TEXT N_( "Pixels to padd to bottom" )
  63 #define PADDBOTTOM_LONGTEXT N_( \
  64     "Number of pixels to padd to the bottom of the image after cropping." )
  65 #define PADDLEFT_TEXT N_( "Pixels to padd to left" )
  66 #define PADDLEFT_LONGTEXT N_( \
  67     "Number of pixels to padd to the left of the image after cropping." )
  68 #define PADDRIGHT_TEXT N_( "Pixels to padd to right" )
  69 #define PADDRIGHT_LONGTEXT N_( \
  70     "Number of pixels to padd to the right of the image after cropping." )
  71
  72 #define CFG_PREFIX "croppadd-"
  73
  74 /*****************************************************************************
  75  * Module descriptor
  76  *****************************************************************************/
  77 vlc_module_begin ()
  78     set_description( N_("Video scaling filter") )
  79     set_capability( "video filter2", 0 )
  80     set_callbacks( OpenFilter, CloseFilter )
  81
  82     set_category( CAT_VIDEO )
  83     set_subcategory( SUBCAT_VIDEO_VFILTER );
  84
  85     set_section( N_("Crop"), NULL )
  86         add_integer_with_range( CFG_PREFIX "croptop", 0, 0, INT_MAX, NULL,
  87                                 CROPTOP_TEXT, CROPTOP_LONGTEXT, false )
  88         add_integer_with_range( CFG_PREFIX "cropbottom", 0, 0, INT_MAX, NULL,
  89                                 CROPBOTTOM_TEXT, CROPBOTTOM_LONGTEXT, false )
  90         add_integer_with_range( CFG_PREFIX "cropleft", 0, 0, INT_MAX, NULL,
  91                                 CROPLEFT_TEXT, CROPLEFT_LONGTEXT, false )
  92         add_integer_with_range( CFG_PREFIX "cropright", 0, 0, INT_MAX, NULL,
  93                                 CROPRIGHT_TEXT, CROPRIGHT_LONGTEXT, false )
  94
  95     set_section( N_("Padd"), NULL )
  96         add_integer_with_range( CFG_PREFIX "paddtop", 0, 0, INT_MAX, NULL,
  97                                 PADDTOP_TEXT, PADDTOP_LONGTEXT, false )
  98         add_integer_with_range( CFG_PREFIX "paddbottom", 0, 0, INT_MAX, NULL,
  99                                 PADDBOTTOM_TEXT, PADDBOTTOM_LONGTEXT, false )
 100         add_integer_with_range( CFG_PREFIX "paddleft", 0, 0, INT_MAX, NULL,
 101                                 PADDLEFT_TEXT, PADDLEFT_LONGTEXT, false )
 102         add_integer_with_range( CFG_PREFIX "paddright", 0, 0, INT_MAX, NULL,
 103                                 PADDRIGHT_TEXT, PADDRIGHT_LONGTEXT, false )
 104 vlc_module_end ()
 105
 106 static const char *const ppsz_filter_options[] = {
 107     "croptop", "cropbottom", "cropleft", "cropright",
 108     "paddtop", "paddbottom", "paddleft", "paddright",
 109     NULL
 110 };
 111
 112 struct filter_sys_t
 113 {
 114     int i_croptop;
 115     int i_cropbottom;
 116     int i_cropleft;
 117     int i_cropright;
 118     int i_paddtop;
 119     int i_paddbottom;
 120     int i_paddleft;
 121     int i_paddright;
 122 };
 123
 124 /*****************************************************************************
 125  * OpenFilter: probe the filter and return score
 126  *****************************************************************************/
 127 static int OpenFilter( vlc_object_t *p_this )
 128 {
 129     filter_t *p_filter = (filter_t*)p_this;
 130     filter_sys_t *p_sys;
 131
 132     if( !p_filter->b_allow_fmt_out_change )
 133     {
 134         msg_Err( p_filter, "Picture format change isn't allowed" );
 135         return VLC_EGENERIC;
 136     }
 137
 138     if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma )
 139     {
 140         msg_Err( p_filter, "Input and output chromas don't match" );
 141         /* In fact we don't really care about this since we're allowed
 142          * to change the output format ... FIXME? */
 143         return VLC_EGENERIC;
 144     }
 145
 146     p_filter->p_sys = (filter_sys_t *)malloc( sizeof( filter_sys_t ) );
 147     if( !p_filter->p_sys ) return VLC_ENOMEM;
 148
 149     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
 150                        p_filter->p_cfg );
 151
 152     p_sys = p_filter->p_sys;
 153 #define GET_OPTION( name ) \
 154     p_sys->i_ ## name = var_CreateGetInteger( p_filter, CFG_PREFIX #name ); \
 155     if( p_sys->i_ ## name & 1 ) \
 156         msg_Warn( p_filter, "Using even values for `" #name "' is recommended" );
 157     GET_OPTION( croptop )
 158     GET_OPTION( cropbottom )
 159     GET_OPTION( cropleft )
 160     GET_OPTION( cropright )
 161     GET_OPTION( paddtop )
 162     GET_OPTION( paddbottom )
 163     GET_OPTION( paddleft )
 164     GET_OPTION( paddright )
 165
 166     p_filter->fmt_out.video.i_height =
 167     p_filter->fmt_out.video.i_visible_height =
 168         p_filter->fmt_in.video.i_visible_height
 169         - p_sys->i_croptop - p_sys->i_cropbottom
 170         + p_sys->i_paddtop + p_sys->i_paddbottom;
 171
 172     p_filter->fmt_out.video.i_width =
 173     p_filter->fmt_out.video.i_visible_width =
 174         p_filter->fmt_in.video.i_visible_width
 175         - p_sys->i_cropleft - p_sys->i_cropright
 176         + p_sys->i_paddleft + p_sys->i_paddright;
 177
 178     p_filter->pf_video_filter = Filter;
 179
 180     msg_Dbg( p_filter, "Crop: Top: %d, Bottom: %d, Left: %d, Right: %d",
 181              p_sys->i_croptop, p_sys->i_cropbottom, p_sys->i_cropleft,
 182              p_sys->i_cropright );
 183     msg_Dbg( p_filter, "Padd: Top: %d, Bottom: %d, Left: %d, Right: %d",
 184              p_sys->i_paddtop, p_sys->i_paddbottom, p_sys->i_paddleft,
 185              p_sys->i_paddright );
 186     msg_Dbg( p_filter, "%dx%d -> %dx%d",
 187              p_filter->fmt_in.video.i_width,
 188              p_filter->fmt_in.video.i_height,
 189              p_filter->fmt_out.video.i_width,
 190              p_filter->fmt_out.video.i_height );
 191
 192     return VLC_SUCCESS;
 193 }
 194
 195 /*****************************************************************************
 196  * CloseFilter: clean up the filter
 197  *****************************************************************************/
 198 static void CloseFilter( vlc_object_t *p_this )
 199 {
 200     filter_t *p_filter = (filter_t *)p_this;
 201     free( p_filter->p_sys );
 202 }
 203
 204 /****************************************************************************
 205  * Filter: the whole thing
 206  ****************************************************************************/
 207 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
 208 {
 209     filter_sys_t *p_sys = p_filter->p_sys;
 210     picture_t *p_outpic;
 211     int i_plane;
 212     int i_width, i_height, i_xcrop, i_ycrop,
 213         i_outwidth, i_outheight, i_xpadd, i_ypadd;
 214
 215     const int p_padd_color[] = { 0x00, 0x80, 0x80, 0xff };
 216
 217     if( !p_pic ) return NULL;
 218
 219     /* Request output picture */
 220     p_outpic = filter_NewPicture( p_filter );
 221     if( !p_outpic )
 222     {
 223         picture_Release( p_pic );
 224         return NULL;
 225     }
 226
 227     for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
 228     /* p_pic and p_outpic have the same chroma/number of planes but that's
 229      * about it. */
 230     {
 231         plane_t *p_plane = p_pic->p+i_plane;
 232         plane_t *p_outplane = p_outpic->p+i_plane;
 233         uint8_t *p_in = p_plane->p_pixels;
 234         uint8_t *p_out = p_outplane->p_pixels;
 235         int i_pixel_pitch = p_plane->i_pixel_pitch;
 236         int i_padd_color = i_plane > 3 ? p_padd_color[0]
 237                                        : p_padd_color[i_plane];
 238
 239         /* These assignments assume that the first plane always has
 240          * a width and height equal to the picture's */
 241         i_width =     ( ( p_filter->fmt_in.video.i_visible_width
 242                           - p_sys->i_cropleft - p_sys->i_cropright )
 243                         * p_plane->i_visible_pitch )
 244                       / p_pic->p->i_visible_pitch;
 245         i_height =    ( ( p_filter->fmt_in.video.i_visible_height
 246                           - p_sys->i_croptop - p_sys->i_cropbottom )
 247                         * p_plane->i_visible_lines )
 248                       / p_pic->p->i_visible_lines;
 249         i_xcrop =     ( p_sys->i_cropleft * p_plane->i_visible_pitch)
 250                       / p_pic->p->i_visible_pitch;
 251         i_ycrop =     ( p_sys->i_croptop * p_plane->i_visible_lines)
 252                       / p_pic->p->i_visible_lines;
 253         i_outwidth =  ( p_filter->fmt_out.video.i_visible_width
 254                         * p_outplane->i_visible_pitch )
 255                       / p_outpic->p->i_visible_pitch;
 256         i_outheight = ( p_filter->fmt_out.video.i_visible_height
 257                         * p_outplane->i_visible_lines )
 258                       / p_outpic->p->i_visible_lines;
 259         i_xpadd =     ( p_sys->i_paddleft * p_outplane->i_visible_pitch )
 260                       / p_outpic->p->i_visible_pitch;
 261         i_ypadd =     ( p_sys->i_paddtop * p_outplane->i_visible_lines )
 262                        / p_outpic->p->i_visible_lines;
 263
 264         /* Crop the top */
 265         p_in += i_ycrop * p_plane->i_pitch;
 266
 267         /* Padd on the top */
 268         vlc_memset( p_out, i_padd_color, i_ypadd * p_outplane->i_pitch );
 269         p_out += i_ypadd * p_outplane->i_pitch;
 270
 271         int i_line;
 272         for( i_line = 0; i_line < i_height; i_line++ )
 273         {
 274             uint8_t *p_in_next = p_in + p_plane->i_pitch;
 275             uint8_t *p_out_next = p_out + p_outplane->i_pitch;
 276
 277             /* Crop on the left */
 278             p_in += i_xcrop * i_pixel_pitch;
 279
 280             /* Padd on the left */
 281             vlc_memset( p_out, i_padd_color, i_xpadd * i_pixel_pitch );
 282             p_out += i_xpadd * i_pixel_pitch;
 283
 284             /* Copy the image and crop on the right */
 285             vlc_memcpy( p_out, p_in, i_width * i_pixel_pitch );
 286             p_out += i_width * i_pixel_pitch;
 287             p_in += i_width * i_pixel_pitch;
 288
 289             /* Padd on the right */
 290             vlc_memset( p_out, i_padd_color,
 291                         ( i_outwidth - i_xpadd - i_width ) * i_pixel_pitch );
 292
 293             /* Got to begining of the next line */
 294             p_in = p_in_next;
 295             p_out = p_out_next;
 296         }
 297
 298         /* Padd on the bottom */
 299         vlc_memset( p_out, i_padd_color,
 300                  ( i_outheight - i_ypadd - i_height ) * p_outplane->i_pitch );
 301     }
 302
 303     return CopyInfoAndRelease( p_outpic, p_pic );
 304 }