1 /*****************************************************************************
2 * croppadd.c: Crop/Padd image filter
3 *****************************************************************************
4 * Copyright (C) 2008 VLC authors and VideoLAN
7 * Authors: Antoine Cellerier <dionoea @t videolan dot org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <limits.h> /* INT_MAX */
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_filter.h>
36 #include "filter_picture.h"
38 /****************************************************************************
40 ****************************************************************************/
41 static int OpenFilter ( vlc_object_t * );
42 static void CloseFilter( vlc_object_t * );
44 static picture_t *Filter( filter_t *, picture_t * );
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." )
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." )
72 #define CFG_PREFIX "croppadd-"
74 /*****************************************************************************
76 *****************************************************************************/
78 set_shortname( N_("Croppadd") )
79 set_description( N_("Video cropping filter") )
80 set_capability( "video filter2", 0 )
81 set_callbacks( OpenFilter, CloseFilter )
83 set_category( CAT_VIDEO )
84 set_subcategory( SUBCAT_VIDEO_VFILTER );
86 set_section( N_("Crop"), NULL )
87 add_integer_with_range( CFG_PREFIX "croptop", 0, 0, INT_MAX,
88 CROPTOP_TEXT, CROPTOP_LONGTEXT, false )
89 add_integer_with_range( CFG_PREFIX "cropbottom", 0, 0, INT_MAX,
90 CROPBOTTOM_TEXT, CROPBOTTOM_LONGTEXT, false )
91 add_integer_with_range( CFG_PREFIX "cropleft", 0, 0, INT_MAX,
92 CROPLEFT_TEXT, CROPLEFT_LONGTEXT, false )
93 add_integer_with_range( CFG_PREFIX "cropright", 0, 0, INT_MAX,
94 CROPRIGHT_TEXT, CROPRIGHT_LONGTEXT, false )
96 set_section( N_("Padd"), NULL )
97 add_integer_with_range( CFG_PREFIX "paddtop", 0, 0, INT_MAX,
98 PADDTOP_TEXT, PADDTOP_LONGTEXT, false )
99 add_integer_with_range( CFG_PREFIX "paddbottom", 0, 0, INT_MAX,
100 PADDBOTTOM_TEXT, PADDBOTTOM_LONGTEXT, false )
101 add_integer_with_range( CFG_PREFIX "paddleft", 0, 0, INT_MAX,
102 PADDLEFT_TEXT, PADDLEFT_LONGTEXT, false )
103 add_integer_with_range( CFG_PREFIX "paddright", 0, 0, INT_MAX,
104 PADDRIGHT_TEXT, PADDRIGHT_LONGTEXT, false )
107 static const char *const ppsz_filter_options[] = {
108 "croptop", "cropbottom", "cropleft", "cropright",
109 "paddtop", "paddbottom", "paddleft", "paddright",
125 /*****************************************************************************
126 * OpenFilter: probe the filter and return score
127 *****************************************************************************/
128 static int OpenFilter( vlc_object_t *p_this )
130 filter_t *p_filter = (filter_t*)p_this;
133 if( !p_filter->b_allow_fmt_out_change )
135 msg_Err( p_filter, "Picture format change isn't allowed" );
139 if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma )
141 msg_Err( p_filter, "Input and output chromas don't match" );
142 /* In fact we don't really care about this since we're allowed
143 * to change the output format ... FIXME? */
147 const vlc_chroma_description_t *p_chroma =
148 vlc_fourcc_GetChromaDescription( p_filter->fmt_in.video.i_chroma );
149 if( p_chroma == NULL || p_chroma->plane_count == 0 )
152 p_filter->p_sys = (filter_sys_t *)malloc( sizeof( filter_sys_t ) );
153 if( !p_filter->p_sys ) return VLC_ENOMEM;
155 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
158 p_sys = p_filter->p_sys;
159 #define GET_OPTION( name ) \
160 p_sys->i_ ## name = var_CreateGetInteger( p_filter, CFG_PREFIX #name ); \
161 if( p_sys->i_ ## name & 1 ) \
162 msg_Warn( p_filter, "Using even values for `" #name "' is recommended" );
163 GET_OPTION( croptop )
164 GET_OPTION( cropbottom )
165 GET_OPTION( cropleft )
166 GET_OPTION( cropright )
167 GET_OPTION( paddtop )
168 GET_OPTION( paddbottom )
169 GET_OPTION( paddleft )
170 GET_OPTION( paddright )
172 p_filter->fmt_out.video.i_height =
173 p_filter->fmt_out.video.i_visible_height =
174 p_filter->fmt_in.video.i_visible_height
175 - p_sys->i_croptop - p_sys->i_cropbottom
176 + p_sys->i_paddtop + p_sys->i_paddbottom;
178 p_filter->fmt_out.video.i_width =
179 p_filter->fmt_out.video.i_visible_width =
180 p_filter->fmt_in.video.i_visible_width
181 - p_sys->i_cropleft - p_sys->i_cropright
182 + p_sys->i_paddleft + p_sys->i_paddright;
184 p_filter->pf_video_filter = Filter;
186 msg_Dbg( p_filter, "Crop: Top: %d, Bottom: %d, Left: %d, Right: %d",
187 p_sys->i_croptop, p_sys->i_cropbottom, p_sys->i_cropleft,
188 p_sys->i_cropright );
189 msg_Dbg( p_filter, "Padd: Top: %d, Bottom: %d, Left: %d, Right: %d",
190 p_sys->i_paddtop, p_sys->i_paddbottom, p_sys->i_paddleft,
191 p_sys->i_paddright );
192 msg_Dbg( p_filter, "%dx%d -> %dx%d",
193 p_filter->fmt_in.video.i_width,
194 p_filter->fmt_in.video.i_height,
195 p_filter->fmt_out.video.i_width,
196 p_filter->fmt_out.video.i_height );
201 /*****************************************************************************
202 * CloseFilter: clean up the filter
203 *****************************************************************************/
204 static void CloseFilter( vlc_object_t *p_this )
206 filter_t *p_filter = (filter_t *)p_this;
207 free( p_filter->p_sys );
210 /****************************************************************************
211 * Filter: the whole thing
212 ****************************************************************************/
213 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
215 filter_sys_t *p_sys = p_filter->p_sys;
218 int i_width, i_height, i_xcrop, i_ycrop,
219 i_outwidth, i_outheight, i_xpadd, i_ypadd;
221 const int p_padd_color[] = { 0x00, 0x80, 0x80, 0xff };
223 if( !p_pic ) return NULL;
225 /* Request output picture */
226 p_outpic = filter_NewPicture( p_filter );
229 picture_Release( p_pic );
233 for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
234 /* p_pic and p_outpic have the same chroma/number of planes but that's
237 plane_t *p_plane = p_pic->p+i_plane;
238 plane_t *p_outplane = p_outpic->p+i_plane;
239 uint8_t *p_in = p_plane->p_pixels;
240 uint8_t *p_out = p_outplane->p_pixels;
241 int i_pixel_pitch = p_plane->i_pixel_pitch;
242 int i_padd_color = i_plane > 3 ? p_padd_color[0]
243 : p_padd_color[i_plane];
245 /* These assignments assume that the first plane always has
246 * a width and height equal to the picture's */
247 i_width = ( ( p_filter->fmt_in.video.i_visible_width
248 - p_sys->i_cropleft - p_sys->i_cropright )
249 * p_plane->i_visible_pitch )
250 / p_pic->p->i_visible_pitch;
251 i_height = ( ( p_filter->fmt_in.video.i_visible_height
252 - p_sys->i_croptop - p_sys->i_cropbottom )
253 * p_plane->i_visible_lines )
254 / p_pic->p->i_visible_lines;
255 i_xcrop = ( p_sys->i_cropleft * p_plane->i_visible_pitch)
256 / p_pic->p->i_visible_pitch;
257 i_ycrop = ( p_sys->i_croptop * p_plane->i_visible_lines)
258 / p_pic->p->i_visible_lines;
259 i_outwidth = ( p_filter->fmt_out.video.i_visible_width
260 * p_outplane->i_visible_pitch )
261 / p_outpic->p->i_visible_pitch;
262 i_outheight = ( p_filter->fmt_out.video.i_visible_height
263 * p_outplane->i_visible_lines )
264 / p_outpic->p->i_visible_lines;
265 i_xpadd = ( p_sys->i_paddleft * p_outplane->i_visible_pitch )
266 / p_outpic->p->i_visible_pitch;
267 i_ypadd = ( p_sys->i_paddtop * p_outplane->i_visible_lines )
268 / p_outpic->p->i_visible_lines;
271 p_in += i_ycrop * p_plane->i_pitch;
273 /* Padd on the top */
274 memset( p_out, i_padd_color, i_ypadd * p_outplane->i_pitch );
275 p_out += i_ypadd * p_outplane->i_pitch;
278 for( i_line = 0; i_line < i_height; i_line++ )
280 uint8_t *p_in_next = p_in + p_plane->i_pitch;
281 uint8_t *p_out_next = p_out + p_outplane->i_pitch;
283 /* Crop on the left */
284 p_in += i_xcrop * i_pixel_pitch;
286 /* Padd on the left */
287 memset( p_out, i_padd_color, i_xpadd * i_pixel_pitch );
288 p_out += i_xpadd * i_pixel_pitch;
290 /* Copy the image and crop on the right */
291 memcpy( p_out, p_in, i_width * i_pixel_pitch );
292 p_out += i_width * i_pixel_pitch;
293 p_in += i_width * i_pixel_pitch;
295 /* Padd on the right */
296 memset( p_out, i_padd_color,
297 ( i_outwidth - i_xpadd - i_width ) * i_pixel_pitch );
299 /* Got to begining of the next line */
304 /* Padd on the bottom */
305 memset( p_out, i_padd_color,
306 ( i_outheight - i_ypadd - i_height ) * p_outplane->i_pitch );
309 return CopyInfoAndRelease( p_outpic, p_pic );