1 /*****************************************************************************
2 * croppadd.c: Crop/Padd image filter
3 *****************************************************************************
4 * Copyright (C) 2008 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea @t videolan dot org>
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.
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.
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 *****************************************************************************/
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_description( N_("Video scaling filter") )
79 set_capability( "video filter2", 0 )
80 set_callbacks( OpenFilter, CloseFilter )
82 set_section( N_("Crop"), NULL )
83 add_integer_with_range( CFG_PREFIX "croptop", 0, 0, INT_MAX, NULL,
84 CROPTOP_TEXT, CROPTOP_LONGTEXT, false )
85 add_integer_with_range( CFG_PREFIX "cropbottom", 0, 0, INT_MAX, NULL,
86 CROPBOTTOM_TEXT, CROPBOTTOM_LONGTEXT, false )
87 add_integer_with_range( CFG_PREFIX "cropleft", 0, 0, INT_MAX, NULL,
88 CROPLEFT_TEXT, CROPLEFT_LONGTEXT, false )
89 add_integer_with_range( CFG_PREFIX "cropright", 0, 0, INT_MAX, NULL,
90 CROPRIGHT_TEXT, CROPRIGHT_LONGTEXT, false )
92 set_section( N_("Padd"), NULL )
93 add_integer_with_range( CFG_PREFIX "paddtop", 0, 0, INT_MAX, NULL,
94 PADDTOP_TEXT, PADDTOP_LONGTEXT, false )
95 add_integer_with_range( CFG_PREFIX "paddbottom", 0, 0, INT_MAX, NULL,
96 PADDBOTTOM_TEXT, PADDBOTTOM_LONGTEXT, false )
97 add_integer_with_range( CFG_PREFIX "paddleft", 0, 0, INT_MAX, NULL,
98 PADDLEFT_TEXT, PADDLEFT_LONGTEXT, false )
99 add_integer_with_range( CFG_PREFIX "paddright", 0, 0, INT_MAX, NULL,
100 PADDRIGHT_TEXT, PADDRIGHT_LONGTEXT, false )
103 static const char *const ppsz_filter_options[] = {
104 "croptop", "cropbottom", "cropleft", "cropright",
105 "paddtop", "paddbottom", "paddleft", "paddright",
121 /*****************************************************************************
122 * OpenFilter: probe the filter and return score
123 *****************************************************************************/
124 static int OpenFilter( vlc_object_t *p_this )
126 filter_t *p_filter = (filter_t*)p_this;
129 if( !p_filter->b_allow_fmt_out_change )
131 msg_Err( p_filter, "Picture format change isn't allowed" );
135 if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma )
137 msg_Err( p_filter, "Input and output chromas don't match" );
138 /* In fact we don't really care about this since we're allowed
139 * to change the output format ... FIXME? */
143 p_filter->p_sys = (filter_sys_t *)malloc( sizeof( filter_sys_t ) );
144 if( !p_filter->p_sys ) return VLC_ENOMEM;
146 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
149 p_sys = p_filter->p_sys;
150 #define GET_OPTION( name ) \
151 p_sys->i_ ## name = var_CreateGetInteger( p_filter, CFG_PREFIX #name ); \
152 if( p_sys->i_ ## name & 1 ) \
153 msg_Warn( p_filter, "Using even values for `" #name "' is recommended" );
154 GET_OPTION( croptop )
155 GET_OPTION( cropbottom )
156 GET_OPTION( cropleft )
157 GET_OPTION( cropright )
158 GET_OPTION( paddtop )
159 GET_OPTION( paddbottom )
160 GET_OPTION( paddleft )
161 GET_OPTION( paddright )
163 p_filter->fmt_out.video.i_height =
164 p_filter->fmt_out.video.i_visible_height =
165 p_filter->fmt_in.video.i_visible_height
166 - p_sys->i_croptop - p_sys->i_cropbottom
167 + p_sys->i_paddtop + p_sys->i_paddbottom;
169 p_filter->fmt_out.video.i_width =
170 p_filter->fmt_out.video.i_visible_width =
171 p_filter->fmt_in.video.i_visible_width
172 - p_sys->i_cropleft - p_sys->i_cropright
173 + p_sys->i_paddleft + p_sys->i_paddright;
175 p_filter->pf_video_filter = Filter;
177 msg_Dbg( p_filter, "Crop: Top: %d, Bottom: %d, Left: %d, Right: %d",
178 p_sys->i_croptop, p_sys->i_cropbottom, p_sys->i_cropleft,
179 p_sys->i_cropright );
180 msg_Dbg( p_filter, "Padd: Top: %d, Bottom: %d, Left: %d, Right: %d",
181 p_sys->i_paddtop, p_sys->i_paddbottom, p_sys->i_paddleft,
182 p_sys->i_paddright );
183 msg_Dbg( p_filter, "%dx%d -> %dx%d",
184 p_filter->fmt_in.video.i_width,
185 p_filter->fmt_in.video.i_height,
186 p_filter->fmt_out.video.i_width,
187 p_filter->fmt_out.video.i_height );
192 /*****************************************************************************
193 * CloseFilter: clean up the filter
194 *****************************************************************************/
195 static void CloseFilter( vlc_object_t *p_this )
197 filter_t *p_filter = (filter_t *)p_this;
198 free( p_filter->p_sys );
201 /****************************************************************************
202 * Filter: the whole thing
203 ****************************************************************************/
204 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
206 filter_sys_t *p_sys = p_filter->p_sys;
209 int i_width, i_height, i_xcrop, i_ycrop,
210 i_outwidth, i_outheight, i_xpadd, i_ypadd;
212 const int p_padd_color[] = { 0x00, 0x80, 0x80, 0xff };
214 if( !p_pic ) return NULL;
216 /* Request output picture */
217 p_outpic = filter_NewPicture( p_filter );
220 picture_Release( p_pic );
224 for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
225 /* p_pic and p_outpic have the same chroma/number of planes but that's
228 plane_t *p_plane = p_pic->p+i_plane;
229 plane_t *p_outplane = p_outpic->p+i_plane;
230 uint8_t *p_in = p_plane->p_pixels;
231 uint8_t *p_out = p_outplane->p_pixels;
232 int i_pixel_pitch = p_plane->i_pixel_pitch;
233 int i_padd_color = i_plane > 3 ? p_padd_color[0]
234 : p_padd_color[i_plane];
236 /* These assignments assume that the first plane always has
237 * a width and height equal to the picture's */
238 i_width = ( ( p_filter->fmt_in.video.i_visible_width
239 - p_sys->i_cropleft - p_sys->i_cropright )
240 * p_plane->i_visible_pitch )
241 / p_pic->p->i_visible_pitch;
242 i_height = ( ( p_filter->fmt_in.video.i_visible_height
243 - p_sys->i_croptop - p_sys->i_cropbottom )
244 * p_plane->i_visible_lines )
245 / p_pic->p->i_visible_lines;
246 i_xcrop = ( p_sys->i_cropleft * p_plane->i_visible_pitch)
247 / p_pic->p->i_visible_pitch;
248 i_ycrop = ( p_sys->i_croptop * p_plane->i_visible_lines)
249 / p_pic->p->i_visible_lines;
250 i_outwidth = ( p_filter->fmt_out.video.i_visible_width
251 * p_outplane->i_visible_pitch )
252 / p_outpic->p->i_visible_pitch;
253 i_outheight = ( p_filter->fmt_out.video.i_visible_height
254 * p_outplane->i_visible_lines )
255 / p_outpic->p->i_visible_lines;
256 i_xpadd = ( p_sys->i_paddleft * p_outplane->i_visible_pitch )
257 / p_outpic->p->i_visible_pitch;
258 i_ypadd = ( p_sys->i_paddtop * p_outplane->i_visible_lines )
259 / p_outpic->p->i_visible_lines;
262 p_in += i_ycrop * p_plane->i_pitch;
264 /* Padd on the top */
265 vlc_memset( p_out, i_padd_color, i_ypadd * p_outplane->i_pitch );
266 p_out += i_ypadd * p_outplane->i_pitch;
269 for( i_line = 0; i_line < i_height; i_line++ )
271 uint8_t *p_in_next = p_in + p_plane->i_pitch;
272 uint8_t *p_out_next = p_out + p_outplane->i_pitch;
274 /* Crop on the left */
275 p_in += i_xcrop * i_pixel_pitch;
277 /* Padd on the left */
278 vlc_memset( p_out, i_padd_color, i_xpadd * i_pixel_pitch );
279 p_out += i_xpadd * i_pixel_pitch;
281 /* Copy the image and crop on the right */
282 vlc_memcpy( p_out, p_in, i_width * i_pixel_pitch );
283 p_out += i_width * i_pixel_pitch;
284 p_in += i_width * i_pixel_pitch;
286 /* Padd on the right */
287 vlc_memset( p_out, i_padd_color,
288 ( i_outwidth - i_xpadd - i_width ) * i_pixel_pitch );
290 /* Got to begining of the next line */
295 /* Padd on the bottom */
296 vlc_memset( p_out, i_padd_color,
297 ( i_outheight - i_ypadd - i_height ) * p_outplane->i_pitch );
300 return CopyInfoAndRelease( p_outpic, p_pic );