1 /*****************************************************************************
2 * mosaic.c : Mosaic video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2004-2005 VideoLAN
7 * Authors: Antoine Cellerier <dionoea@via.ecp.fr>
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() */
34 #include "vlc_filter.h"
35 #include "vlc_input.h"
37 #include "vlc_image.h"
39 /*****************************************************************************
41 *****************************************************************************/
43 static int CreateFilter ( vlc_object_t * );
44 static void DestroyFilter ( vlc_object_t * );
46 static subpicture_t *Filter( filter_t *, mtime_t );
48 static int MosaicCallback( vlc_object_t *, char const *, vlc_value_t,
49 vlc_value_t, void * );
51 /*****************************************************************************
52 * filter_sys_t : filter desriptor
53 *****************************************************************************/
55 #include "../video_output/picture.h"
60 image_handler_t *p_image;
61 image_handler_t *p_image2;
64 int i_pos; /* mosaic positioning method */
65 int i_ar; /* do we keep aspect ratio ? */
66 int i_width, i_height; /* mosaic height and width */
67 int i_cols, i_rows; /* mosaic rows and cols */
68 int i_xoffset, i_yoffset; /* top left corner offset */
69 int i_vborder, i_hborder; /* border width/height between miniatures */
70 int i_alpha; /* subfilter alpha blending */
74 /*****************************************************************************
76 *****************************************************************************/
78 #define ALPHA_TEXT N_("Mosaic alpha blending (0 -> 255)")
79 #define ALPHA_LONGTEXT N_("Mosaic alpha blending (0 -> 255). default is 255")
81 #define HEIGHT_TEXT N_("Mosaic height in pixels")
82 #define WIDTH_TEXT N_("Mosaic width in pixels")
83 #define XOFFSET_TEXT N_("Mosaic top left corner x coordinate")
84 #define YOFFSET_TEXT N_("Mosaic top left corner y coordinate")
85 #define VBORDER_TEXT N_("Mosaic vertical border width in pixels")
86 #define HBORDER_TEXT N_("Mosaic horizontal border width in pixels")
88 #define POS_TEXT N_("Mosaic positioning method")
89 #define POS_LONGTEXT N_("Mosaic positioning method. auto : automatically chose the best number of rows and columns. fixed : used the user defined number of rows and columns.")
90 #define ROWS_TEXT N_("Mosaic number of rows")
91 #define COLS_TEXT N_("Mosaic number of columns")
92 #define AR_TEXT N_("Keep aspect ratio when resizing")
94 static int pi_pos_values[] = { 0, 1 };
95 static char * ppsz_pos_descriptions[] =
96 { N_("auto"), N_("fixed") };
100 set_description( _("Mosaic video sub filter") );
101 set_shortname( N_("Mosaic") );
102 set_capability( "sub filter", 0 );
103 set_category( CAT_VIDEO );
104 set_subcategory( SUBCAT_VIDEO_SUBPIC );
105 set_callbacks( CreateFilter, DestroyFilter );
107 add_integer( "mosaic-alpha", 255, NULL, ALPHA_TEXT, ALPHA_LONGTEXT, VLC_FALSE );
108 add_integer( "mosaic-height", 100, NULL, HEIGHT_TEXT, HEIGHT_TEXT, VLC_FALSE );
109 add_integer( "mosaic-width", 100, NULL, WIDTH_TEXT, WIDTH_TEXT, VLC_FALSE );
110 add_integer( "mosaic-xoffset", 0, NULL, XOFFSET_TEXT, XOFFSET_TEXT, VLC_TRUE );
111 add_integer( "mosaic-yoffset", 0, NULL, YOFFSET_TEXT, YOFFSET_TEXT, VLC_TRUE );
112 add_integer( "mosaic-vborder", 0, NULL, VBORDER_TEXT, VBORDER_TEXT, VLC_TRUE );
113 add_integer( "mosaic-hborder", 0, NULL, HBORDER_TEXT, HBORDER_TEXT, VLC_TRUE );
115 add_integer( "mosaic-position", 0, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
116 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
117 add_integer( "mosaic-rows", 2, NULL, ROWS_TEXT, ROWS_TEXT, VLC_FALSE );
118 add_integer( "mosaic-cols", 2, NULL, COLS_TEXT, COLS_TEXT, VLC_FALSE );
119 add_bool( "mosaic-keep-aspect-ratio", 0, NULL, AR_TEXT, AR_TEXT, VLC_FALSE );
123 /*****************************************************************************
124 * CreateFiler: allocates mosaic video filter
125 *****************************************************************************/
127 static int CreateFilter( vlc_object_t *p_this )
129 filter_t *p_filter = (filter_t *)p_this;
132 /* Allocate structure */
133 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
136 msg_Err( p_filter, "out of memory" );
139 p_sys->p_image = image_HandlerCreate( p_filter );
140 p_sys->p_image2 = image_HandlerCreate( p_filter );
142 p_filter->pf_sub_filter = Filter;
145 p_sys->i_width = __MAX( 0, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-width" ) );
146 p_sys->i_height = __MAX( 0, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-height" ) );
148 p_sys->i_xoffset = __MAX( 0, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-xoffset" ) );
149 p_sys->i_yoffset = __MAX( 0, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-yoffset" ) );
151 p_sys->i_vborder = __MAX( 0, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-vborder" ) );
152 p_sys->i_hborder = __MAX( 0, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-hborder" ) );
154 p_sys->i_rows = __MAX( 1, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-rows") );
155 p_sys->i_cols = __MAX( 1, var_CreateGetInteger( p_filter->p_libvlc, "mosaic-cols") );
157 p_sys->i_alpha = var_CreateGetInteger( p_filter->p_libvlc, "mosaic-alpha" );
158 p_sys->i_alpha = __MIN( 255, __MAX( 0, p_sys->i_alpha ) );
160 p_sys->i_pos = var_CreateGetInteger( p_filter->p_libvlc, "mosaic-position" );
161 if( p_sys->i_pos > 1 || p_sys->i_pos < 0 ) p_sys->i_pos = 0;
163 p_sys->i_ar = var_CreateGetInteger( p_filter->p_libvlc, "mosaic-keep-aspect-ratio" );
165 var_AddCallback( p_filter->p_libvlc, "mosaic-alpha",
166 MosaicCallback, p_sys );
167 var_AddCallback( p_filter->p_libvlc, "mosaic-height",
168 MosaicCallback, p_sys );
169 var_AddCallback( p_filter->p_libvlc, "mosaic-width",
170 MosaicCallback, p_sys );
171 var_AddCallback( p_filter->p_libvlc, "mosaic-xoffset",
172 MosaicCallback, p_sys );
173 var_AddCallback( p_filter->p_libvlc, "mosaic-yoffset",
174 MosaicCallback, p_sys );
175 var_AddCallback( p_filter->p_libvlc, "mosaic-vborder",
176 MosaicCallback, p_sys );
177 var_AddCallback( p_filter->p_libvlc, "mosaic-hborder",
178 MosaicCallback, p_sys );
179 var_AddCallback( p_filter->p_libvlc, "mosaic-position",
180 MosaicCallback, p_sys );
181 var_AddCallback( p_filter->p_libvlc, "mosaic-rows",
182 MosaicCallback, p_sys );
183 var_AddCallback( p_filter->p_libvlc, "mosaic-cols",
184 MosaicCallback, p_sys );
185 var_AddCallback( p_filter->p_libvlc, "mosaic-keep-aspect-ratio",
186 MosaicCallback, p_sys );
191 /*****************************************************************************
192 * DestroyFilter: destroy mosaic video filter
193 *****************************************************************************/
195 static void DestroyFilter( vlc_object_t *p_this )
197 filter_t *p_filter = (filter_t*)p_this;
198 filter_sys_t *p_sys = p_filter->p_sys;
200 image_HandlerDelete( p_sys->p_image );
201 image_HandlerDelete( p_sys->p_image2 );
203 var_Destroy( p_filter->p_libvlc, "mosaic-alpha" );
204 var_Destroy( p_filter->p_libvlc, "mosaic-height" );
205 var_Destroy( p_filter->p_libvlc, "mosaic-width" );
206 var_Destroy( p_filter->p_libvlc, "mosaic-xoffset" );
207 var_Destroy( p_filter->p_libvlc, "mosaic-yoffset" );
208 var_Destroy( p_filter->p_libvlc, "mosaic-vborder" );
209 var_Destroy( p_filter->p_libvlc, "mosaic-hborder" );
210 var_Destroy( p_filter->p_libvlc, "mosaic-position" );
211 var_Destroy( p_filter->p_libvlc, "mosaic-rows" );
212 var_Destroy( p_filter->p_libvlc, "mosaic-cols" );
213 var_Destroy( p_filter->p_libvlc, "mosaic-keep-aspect-ratio" );
214 if( p_sys->p_pic ) p_sys->p_pic->pf_release( p_sys->p_pic );
218 /*****************************************************************************
220 *****************************************************************************/
222 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
225 filter_sys_t *p_sys = p_filter->p_sys;
228 libvlc_t *p_libvlc = p_filter->p_libvlc;
230 int i_index, i_real_index, i_row, i_col;
232 subpicture_region_t *p_region;
233 subpicture_region_t *p_region_prev = NULL;
235 struct picture_vout_t *p_picture_vout;
237 if( var_Get( p_libvlc, "p_picture_vout", &val ) )
242 p_picture_vout = val.p_address;
244 /* Allocate the subpicture internal data. */
245 p_spu = p_filter->pf_sub_buffer_new( p_filter );
251 /* Initialize subpicture */
252 p_spu->i_channel = 0;
253 p_spu->i_start = date;
255 p_spu->b_ephemer = VLC_TRUE;
256 p_spu->i_alpha = p_sys->i_alpha;
258 vlc_mutex_lock( &p_picture_vout->lock );
260 if( p_sys->i_pos == 0 ) /* use automatic positioning */
264 i_index < p_picture_vout->i_picture_num ;
267 if( p_picture_vout->p_pic[i_index].i_status
268 == PICTURE_VOUT_E_OCCUPIED ) {
272 p_sys->i_rows = ((int)ceil(sqrt( (float)i_numpics )));
273 p_sys->i_cols = ( i_numpics%p_sys->i_rows == 0 ?
274 i_numpics/p_sys->i_rows :
275 i_numpics/p_sys->i_rows + 1 );
280 for( i_index = 0 ; i_index < p_picture_vout->i_picture_num ; i_index ++ )
283 video_format_t fmt_in = {0}, fmt_middle = {0}, fmt_out = {0};
285 picture_t *p_converted, *p_middle;
287 if( p_picture_vout->p_pic[i_index].p_picture == NULL )
292 if( p_picture_vout->p_pic[i_index].i_status
293 == PICTURE_VOUT_E_AVAILABLE )
295 msg_Dbg( p_filter, "Picture Vout Element is empty");
299 i_row = ( i_real_index / p_sys->i_cols ) % p_sys->i_rows ;
300 i_col = i_real_index % p_sys->i_cols ;
304 /* Convert the images */
305 /* fprintf (stderr, "Input image %ix%i %4.4s\n",
306 p_picture_vout->p_pic[i_index].p_picture->format.i_width,
307 p_picture_vout->p_pic[i_index].p_picture->format.i_height,
308 (char *)&p_picture_vout->p_pic[i_index].p_picture->format.i_chroma );*/
310 fmt_in.i_chroma = p_picture_vout->p_pic[i_index].
311 p_picture->format.i_chroma;
312 fmt_in.i_height = p_picture_vout->p_pic[i_index].
313 p_picture->format.i_height;
314 fmt_in.i_width = p_picture_vout->p_pic[i_index].
315 p_picture->format.i_width;
318 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
319 fmt_out.i_width = fmt_in.i_width *
320 ( ( p_sys->i_width - ( p_sys->i_cols - 1 ) * p_sys->i_vborder )
321 / p_sys->i_cols ) / fmt_in.i_width;
322 fmt_out.i_height = fmt_in.i_height *
323 ( ( p_sys->i_height - ( p_sys->i_rows - 1 ) * p_sys->i_hborder )
324 / p_sys->i_rows ) / fmt_in.i_height;
325 if( p_sys->i_ar ) /* keep aspect ratio */
327 if( (float)fmt_out.i_width/(float)fmt_out.i_height
328 > (float)fmt_in.i_width/(float)fmt_in.i_height )
330 fmt_out.i_width = ( fmt_out.i_height * fmt_in.i_width ) / fmt_in.i_height ;
332 fmt_out.i_height = ( fmt_out.i_width * fmt_in.i_height ) / fmt_in.i_width ;
336 fmt_out.i_visible_width = fmt_out.i_width;
337 fmt_out.i_visible_height = fmt_out.i_height;
339 fmt_middle.i_chroma = fmt_in.i_chroma;
340 fmt_middle.i_visible_width = fmt_middle.i_width = fmt_out.i_width;
341 fmt_middle.i_visible_height = fmt_middle.i_height = fmt_out.i_height;
343 p_middle = image_Convert( p_sys->p_image,
344 p_picture_vout->p_pic[i_index].p_picture, &fmt_in, &fmt_middle );
347 msg_Err( p_filter, "image resizing failed" );
348 p_filter->pf_sub_buffer_del( p_filter, p_spu );
349 vlc_mutex_unlock( &p_picture_vout->lock );
353 p_converted = image_Convert( p_sys->p_image2,
354 p_middle, &fmt_middle, &fmt_out );
357 msg_Err( p_filter, "image chroma convertion failed" );
358 p_filter->pf_sub_buffer_del( p_filter, p_spu );
359 vlc_mutex_unlock( &p_picture_vout->lock );
363 /* fprintf( stderr, "Converted %ix%i %4.4s\n", p_converted->format.i_width, p_converted->format.i_height, (char *)&p_converted->format.i_chroma);*/
366 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt_out);
369 msg_Err( p_filter, "cannot allocate SPU region" );
370 p_filter->pf_sub_buffer_del( p_filter, p_spu );
371 vlc_mutex_unlock( &p_picture_vout->lock );
375 if( p_sys->i_ar ) /* keep aspect ratio */
377 /* center the video in the dedicated rectangle */
378 p_region->i_x = p_sys->i_xoffset
379 + i_col * ( p_sys->i_width / p_sys->i_cols )
380 + ( i_col * p_sys->i_vborder ) / p_sys->i_cols
382 ( ( p_sys->i_width - ( p_sys->i_cols - 1 ) * p_sys->i_vborder )
383 / p_sys->i_cols ) / fmt_in.i_width - fmt_out.i_width ) / 2;
384 p_region->i_y = p_sys->i_yoffset
385 + i_row * ( p_sys->i_height / p_sys->i_rows )
386 + ( i_row * p_sys->i_hborder ) / p_sys->i_rows
387 + ( fmt_in.i_height *
388 ( ( p_sys->i_height - ( p_sys->i_rows - 1 ) * p_sys->i_hborder )
389 / p_sys->i_rows ) / fmt_in.i_height - fmt_out.i_height ) / 2;
391 /* we don't have to center the video since it takes the
392 whole rectangle area */
393 p_region->i_x = p_sys->i_xoffset
394 + i_col * ( p_sys->i_width / p_sys->i_cols )
395 + ( i_col * p_sys->i_vborder ) / p_sys->i_cols;
396 p_region->i_y = p_sys->i_yoffset
397 + i_row * ( p_sys->i_height / p_sys->i_rows )
398 + ( i_row * p_sys->i_hborder ) / p_sys->i_rows;
401 if( p_region_prev == NULL ){
402 p_spu->p_region = p_region;
404 p_region_prev->p_next = p_region;
407 p_region_prev = p_region;
409 vout_CopyPicture( p_filter, &p_region->picture, p_converted );
411 p_middle->pf_release( p_middle );
412 p_converted->pf_release( p_converted );
415 vlc_mutex_unlock( &p_picture_vout->lock );
420 /*****************************************************************************
421 * Callback to update params on the fly
422 *****************************************************************************/
424 static int MosaicCallback( vlc_object_t *p_this, char const *psz_var,
425 vlc_value_t oldval, vlc_value_t newval,
428 filter_sys_t *p_sys = (filter_sys_t *) p_data;
429 fprintf( stderr, "Callback" );
430 if( !strcmp( psz_var, "mosaic-alpha" ) )
432 msg_Dbg( p_this, "Changing alpha from %d/255 to %d/255",
433 p_sys->i_alpha, newval.i_int);
434 p_sys->i_alpha = __MIN( __MAX( newval.i_int, 0 ), 255 );
436 else if( !strcmp( psz_var, "mosaic-height" ) )
438 msg_Dbg( p_this, "Changing height from %dpx to %dpx",
439 p_sys->i_height, newval.i_int );
440 p_sys->i_height = __MAX( newval.i_int, 0 );
442 else if( !strcmp( psz_var, "mosaic-width" ) )
444 msg_Dbg( p_this, "Changing width from %dpx to %dpx",
445 p_sys->i_width, newval.i_int );
446 p_sys->i_width = __MAX( newval.i_int, 0 );
448 else if( !strcmp( psz_var, "mosaic-xoffset" ) )
450 msg_Dbg( p_this, "Changing x offset from %dpx to %dpx",
451 p_sys->i_xoffset, newval.i_int );
452 p_sys->i_xoffset = __MAX( newval.i_int, 0 );
454 else if( !strcmp( psz_var, "mosaic-yoffset" ) )
456 msg_Dbg( p_this, "Changing y offset from %dpx to %dpx",
457 p_sys->i_yoffset, newval.i_int );
458 p_sys->i_yoffset = __MAX( newval.i_int, 0 );
460 else if( !strcmp( psz_var, "mosaic-vborder" ) )
462 msg_Dbg( p_this, "Changing vertical border from %dpx to %dpx",
463 p_sys->i_vborder, newval.i_int );
464 p_sys->i_vborder = __MAX( newval.i_int, 0 );
466 else if( !strcmp( psz_var, "mosaic-hborder" ) )
468 msg_Dbg( p_this, "Changing horizontal border from %dpx to %dpx",
469 p_sys->i_vborder, newval.i_int );
470 p_sys->i_hborder = __MAX( newval.i_int, 0 );
472 else if( !strcmp( psz_var, "mosaic-position" ) )
474 if( newval.i_int > 1 || newval.i_int < 0 )
476 msg_Err( p_this, "Position is either 0 (auto) or 1 (fixed)" );
480 msg_Dbg( p_this, "Changing position method from %d (%s) to %d (%s)",
481 p_sys->i_pos, ppsz_pos_descriptions[p_sys->i_pos],
482 newval.i_int, ppsz_pos_descriptions[newval.i_int]);
483 p_sys->i_pos = newval.i_int;
486 else if( !strcmp( psz_var, "mosaic-rows" ) )
488 msg_Dbg( p_this, "Changing number of rows from %d to %d",
489 p_sys->i_rows, newval.i_int );
490 p_sys->i_rows = __MAX( newval.i_int, 1 );
492 else if( !strcmp( psz_var, "mosaic-cols" ) )
494 msg_Dbg( p_this, "Changing number of columns from %d to %d",
495 p_sys->i_cols, newval.i_int );
496 p_sys->i_cols = __MAX( newval.i_int, 1 );
498 else if( !strcmp( psz_var, "mosaic-keep-aspect-ratio" ) )
502 msg_Dbg( p_this, "Keep aspect ratio" );
507 msg_Dbg( p_this, "Don't keep aspect ratio" );