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_shortname( N_("Cropadd") )
79 set_description( N_("Video scaling 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 p_filter
->p_sys
= (filter_sys_t
*)malloc( sizeof( filter_sys_t
) );
148 if( !p_filter
->p_sys
) return VLC_ENOMEM
;
150 config_ChainParse( p_filter
, CFG_PREFIX
, ppsz_filter_options
,
153 p_sys
= p_filter
->p_sys
;
154 #define GET_OPTION( name ) \
155 p_sys->i_ ## name = var_CreateGetInteger( p_filter, CFG_PREFIX #name ); \
156 if( p_sys->i_ ## name & 1 ) \
157 msg_Warn( p_filter, "Using even values for `" #name "' is recommended" );
158 GET_OPTION( croptop
)
159 GET_OPTION( cropbottom
)
160 GET_OPTION( cropleft
)
161 GET_OPTION( cropright
)
162 GET_OPTION( paddtop
)
163 GET_OPTION( paddbottom
)
164 GET_OPTION( paddleft
)
165 GET_OPTION( paddright
)
167 p_filter
->fmt_out
.video
.i_height
=
168 p_filter
->fmt_out
.video
.i_visible_height
=
169 p_filter
->fmt_in
.video
.i_visible_height
170 - p_sys
->i_croptop
- p_sys
->i_cropbottom
171 + p_sys
->i_paddtop
+ p_sys
->i_paddbottom
;
173 p_filter
->fmt_out
.video
.i_width
=
174 p_filter
->fmt_out
.video
.i_visible_width
=
175 p_filter
->fmt_in
.video
.i_visible_width
176 - p_sys
->i_cropleft
- p_sys
->i_cropright
177 + p_sys
->i_paddleft
+ p_sys
->i_paddright
;
179 p_filter
->pf_video_filter
= Filter
;
181 msg_Dbg( p_filter
, "Crop: Top: %d, Bottom: %d, Left: %d, Right: %d",
182 p_sys
->i_croptop
, p_sys
->i_cropbottom
, p_sys
->i_cropleft
,
183 p_sys
->i_cropright
);
184 msg_Dbg( p_filter
, "Padd: Top: %d, Bottom: %d, Left: %d, Right: %d",
185 p_sys
->i_paddtop
, p_sys
->i_paddbottom
, p_sys
->i_paddleft
,
186 p_sys
->i_paddright
);
187 msg_Dbg( p_filter
, "%dx%d -> %dx%d",
188 p_filter
->fmt_in
.video
.i_width
,
189 p_filter
->fmt_in
.video
.i_height
,
190 p_filter
->fmt_out
.video
.i_width
,
191 p_filter
->fmt_out
.video
.i_height
);
196 /*****************************************************************************
197 * CloseFilter: clean up the filter
198 *****************************************************************************/
199 static void CloseFilter( vlc_object_t
*p_this
)
201 filter_t
*p_filter
= (filter_t
*)p_this
;
202 free( p_filter
->p_sys
);
205 /****************************************************************************
206 * Filter: the whole thing
207 ****************************************************************************/
208 static picture_t
*Filter( filter_t
*p_filter
, picture_t
*p_pic
)
210 filter_sys_t
*p_sys
= p_filter
->p_sys
;
213 int i_width
, i_height
, i_xcrop
, i_ycrop
,
214 i_outwidth
, i_outheight
, i_xpadd
, i_ypadd
;
216 const int p_padd_color
[] = { 0x00, 0x80, 0x80, 0xff };
218 if( !p_pic
) return NULL
;
220 /* Request output picture */
221 p_outpic
= filter_NewPicture( p_filter
);
224 picture_Release( p_pic
);
228 for( i_plane
= 0; i_plane
< p_pic
->i_planes
; i_plane
++ )
229 /* p_pic and p_outpic have the same chroma/number of planes but that's
232 plane_t
*p_plane
= p_pic
->p
+i_plane
;
233 plane_t
*p_outplane
= p_outpic
->p
+i_plane
;
234 uint8_t *p_in
= p_plane
->p_pixels
;
235 uint8_t *p_out
= p_outplane
->p_pixels
;
236 int i_pixel_pitch
= p_plane
->i_pixel_pitch
;
237 int i_padd_color
= i_plane
> 3 ? p_padd_color
[0]
238 : p_padd_color
[i_plane
];
240 /* These assignments assume that the first plane always has
241 * a width and height equal to the picture's */
242 i_width
= ( ( p_filter
->fmt_in
.video
.i_visible_width
243 - p_sys
->i_cropleft
- p_sys
->i_cropright
)
244 * p_plane
->i_visible_pitch
)
245 / p_pic
->p
->i_visible_pitch
;
246 i_height
= ( ( p_filter
->fmt_in
.video
.i_visible_height
247 - p_sys
->i_croptop
- p_sys
->i_cropbottom
)
248 * p_plane
->i_visible_lines
)
249 / p_pic
->p
->i_visible_lines
;
250 i_xcrop
= ( p_sys
->i_cropleft
* p_plane
->i_visible_pitch
)
251 / p_pic
->p
->i_visible_pitch
;
252 i_ycrop
= ( p_sys
->i_croptop
* p_plane
->i_visible_lines
)
253 / p_pic
->p
->i_visible_lines
;
254 i_outwidth
= ( p_filter
->fmt_out
.video
.i_visible_width
255 * p_outplane
->i_visible_pitch
)
256 / p_outpic
->p
->i_visible_pitch
;
257 i_outheight
= ( p_filter
->fmt_out
.video
.i_visible_height
258 * p_outplane
->i_visible_lines
)
259 / p_outpic
->p
->i_visible_lines
;
260 i_xpadd
= ( p_sys
->i_paddleft
* p_outplane
->i_visible_pitch
)
261 / p_outpic
->p
->i_visible_pitch
;
262 i_ypadd
= ( p_sys
->i_paddtop
* p_outplane
->i_visible_lines
)
263 / p_outpic
->p
->i_visible_lines
;
266 p_in
+= i_ycrop
* p_plane
->i_pitch
;
268 /* Padd on the top */
269 vlc_memset( p_out
, i_padd_color
, i_ypadd
* p_outplane
->i_pitch
);
270 p_out
+= i_ypadd
* p_outplane
->i_pitch
;
273 for( i_line
= 0; i_line
< i_height
; i_line
++ )
275 uint8_t *p_in_next
= p_in
+ p_plane
->i_pitch
;
276 uint8_t *p_out_next
= p_out
+ p_outplane
->i_pitch
;
278 /* Crop on the left */
279 p_in
+= i_xcrop
* i_pixel_pitch
;
281 /* Padd on the left */
282 vlc_memset( p_out
, i_padd_color
, i_xpadd
* i_pixel_pitch
);
283 p_out
+= i_xpadd
* i_pixel_pitch
;
285 /* Copy the image and crop on the right */
286 vlc_memcpy( p_out
, p_in
, i_width
* i_pixel_pitch
);
287 p_out
+= i_width
* i_pixel_pitch
;
288 p_in
+= i_width
* i_pixel_pitch
;
290 /* Padd on the right */
291 vlc_memset( p_out
, i_padd_color
,
292 ( i_outwidth
- i_xpadd
- i_width
) * i_pixel_pitch
);
294 /* Got to begining of the next line */
299 /* Padd on the bottom */
300 vlc_memset( p_out
, i_padd_color
,
301 ( i_outheight
- i_ypadd
- i_height
) * p_outplane
->i_pitch
);
304 return CopyInfoAndRelease( p_outpic
, p_pic
);