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 $
7 * Authors: Samuel Hocevar <sam@zoy.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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
33 #include "filter_common.h"
35 /*****************************************************************************
37 *****************************************************************************/
38 static int Create ( vlc_object_t * );
39 static void Destroy ( vlc_object_t * );
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 * );
46 static void UpdateStats ( vout_thread_t *, picture_t * );
48 static int SendEvents( vlc_object_t *, char const *,
49 vlc_value_t, vlc_value_t, void * );
51 /*****************************************************************************
53 *****************************************************************************/
54 #define GEOMETRY_TEXT N_("crop geometry")
55 #define GEOMETRY_LONGTEXT N_("Set the geometry of the zone to crop")
57 #define AUTOCROP_TEXT N_("automatic cropping")
58 #define AUTOCROP_LONGTEXT N_("Activate automatic black border cropping")
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 );
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 *****************************************************************************/
78 vout_thread_t *p_vout;
80 unsigned int i_x, i_y;
81 unsigned int i_width, i_height, i_aspect;
83 vlc_bool_t b_autocrop;
85 /* Autocrop specific variables */
86 unsigned int i_lastchange;
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 )
97 vout_thread_t *p_vout = (vout_thread_t *)p_this;
99 /* Allocate structure */
100 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
101 if( p_vout->p_sys == NULL )
103 msg_Err( p_vout, "out of memory" );
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;
116 /*****************************************************************************
117 * Init: initialize Crop video thread output method
118 *****************************************************************************/
119 static int Init( vout_thread_t *p_vout )
125 I_OUTPUTPICTURES = 0;
127 p_vout->p_sys->i_lastchange = 0;
128 p_vout->p_sys->b_changed = VLC_FALSE;
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;
136 /* Shall we use autocrop ? */
137 p_vout->p_sys->b_autocrop = config_GetInt( p_vout, "autocrop" );
139 /* Get geometry value from the user */
140 psz_var = config_GetPsz( p_vout, "crop-geometry" );
143 char *psz_parser, *psz_tmp;
145 psz_parser = psz_tmp = psz_var;
146 while( *psz_tmp && *psz_tmp != 'x' ) psz_tmp++;
151 p_vout->p_sys->i_width = atoi( psz_parser );
153 psz_parser = ++psz_tmp;
154 while( *psz_tmp && *psz_tmp != '+' ) psz_tmp++;
159 p_vout->p_sys->i_height = atoi( psz_parser );
161 psz_parser = ++psz_tmp;
162 while( *psz_tmp && *psz_tmp != '+' ) psz_tmp++;
167 p_vout->p_sys->i_x = atoi( psz_parser );
168 p_vout->p_sys->i_y = atoi( ++psz_tmp );
172 p_vout->p_sys->i_x = atoi( psz_parser );
174 ( p_vout->output.i_height - p_vout->p_sys->i_height ) / 2;
179 p_vout->p_sys->i_height = atoi( psz_parser );
181 ( p_vout->output.i_width - p_vout->p_sys->i_width ) / 2;
183 ( p_vout->output.i_height - p_vout->p_sys->i_height ) / 2;
188 p_vout->p_sys->i_width = atoi( psz_parser );
189 p_vout->p_sys->i_height = p_vout->output.i_height;
191 ( p_vout->output.i_width - p_vout->p_sys->i_width ) / 2;
193 ( p_vout->output.i_height - p_vout->p_sys->i_height ) / 2;
196 /* Check for validity */
197 if( p_vout->p_sys->i_x + p_vout->p_sys->i_width
198 > p_vout->output.i_width )
200 p_vout->p_sys->i_x = 0;
201 if( p_vout->p_sys->i_width > p_vout->output.i_width )
203 p_vout->p_sys->i_width = p_vout->output.i_width;
207 if( p_vout->p_sys->i_y + p_vout->p_sys->i_height
208 > p_vout->output.i_height )
210 p_vout->p_sys->i_y = 0;
211 if( p_vout->p_sys->i_height > p_vout->output.i_height )
213 p_vout->p_sys->i_height = p_vout->output.i_height;
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;
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 " );
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;
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 )
243 msg_Err( p_vout, "failed to create vout" );
247 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
249 ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
254 /*****************************************************************************
255 * End: terminate Crop video thread output method
256 *****************************************************************************/
257 static void End( vout_thread_t *p_vout )
261 /* Free the fake output buffers we allocated */
262 for( i_index = I_OUTPUTPICTURES ; i_index ; )
265 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
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 )
276 vout_thread_t *p_vout = (vout_thread_t *)p_this;
278 DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
279 vout_Destroy( p_vout->p_sys->p_vout );
281 free( p_vout->p_sys );
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 )
292 if( !p_vout->p_sys->b_changed )
297 vout_Destroy( p_vout->p_sys->p_vout );
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 )
304 msg_Err( p_vout, "failed to create vout" );
308 p_vout->p_sys->b_changed = VLC_FALSE;
309 p_vout->p_sys->i_lastchange = 0;
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
320 *****************************************************************************/
321 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
323 picture_t *p_outpic = NULL;
326 if( p_vout->p_sys->b_changed )
332 vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 )
335 if( p_vout->b_die || p_vout->b_error )
337 vout_DestroyPicture( p_vout->p_sys->p_vout, p_outpic );
341 msleep( VOUT_OUTMEM_SLEEP );
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 );
347 for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
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;
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;
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;
364 while( p_out < p_out_end )
366 p_vout->p_vlc->pf_memcpy( p_out, p_in, i_copy_pitch );
368 p_out += i_out_pitch;
372 vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
373 vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
375 /* The source image may still be in the cache ... parse it! */
376 if( p_vout->p_sys->b_autocrop )
378 UpdateStats( p_vout, p_pic );
382 static void UpdateStats( vout_thread_t *p_vout, picture_t *p_pic )
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;
390 /* Determine where black borders are */
391 switch( p_vout->output.i_chroma )
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-- ; )
398 const int i_col = i * i_pitch / i_lines;
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 )
404 if( i_lastwhite == -1 )
418 /* Decide whether it's worth changing the size */
419 if( i_lastwhite == -1 )
421 p_vout->p_sys->i_lastchange = 0;
425 if( (unsigned int)(i_lastwhite - i_firstwhite)
426 < p_vout->p_sys->i_height / 2 )
428 p_vout->p_sys->i_lastchange = 0;
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 )
437 p_vout->p_sys->i_lastchange = 0;
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 )
448 /* Tune a few values */
449 if( i_firstwhite & 1 )
454 if( !(i_lastwhite & 1) )
460 p_vout->p_sys->i_y = i_firstwhite;
461 p_vout->p_sys->i_height = i_lastwhite - i_firstwhite + 1;
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;
467 p_vout->p_sys->b_changed = VLC_TRUE;
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 )
476 vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
477 vlc_value_t sentval = newval;
479 /* Translate the mouse coordinates */
480 if( !strcmp( psz_var, "mouse-x" ) )
482 sentval.i_int += p_vout->p_sys->i_x;
484 else if( !strcmp( psz_var, "mouse-y" ) )
486 sentval.i_int += p_vout->p_sys->i_y;
489 var_Set( p_vout, psz_var, sentval );