1 /*****************************************************************************
2 * mosaic.c : Mosaic video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2004-2005 VideoLAN
7 * Authors: Antoine Cellerier <dionoea@via.ecp.fr>
8 * Christophe Massiot <massiot@via.ecp.fr>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
28 #include <stdlib.h> /* malloc(), free() */
36 # include <limits.h> /* INT_MAX */
39 #include "vlc_filter.h"
40 #include "vlc_image.h"
42 #include "../video_output/picture.h"
44 /*****************************************************************************
46 *****************************************************************************/
47 static int CreateFilter ( vlc_object_t * );
48 static void DestroyFilter ( vlc_object_t * );
50 static subpicture_t *Filter( filter_t *, mtime_t );
52 static int MosaicCallback( vlc_object_t *, char const *, vlc_value_t,
53 vlc_value_t, void * );
55 /*****************************************************************************
56 * filter_sys_t : filter descriptor
57 *****************************************************************************/
62 image_handler_t *p_image;
64 image_handler_t *p_image2;
68 int i_position; /* mosaic positioning method */
69 vlc_bool_t b_ar; /* do we keep the aspect ratio ? */
70 vlc_bool_t b_keep; /* do we keep the original picture format ? */
71 int i_width, i_height; /* mosaic height and width */
72 int i_cols, i_rows; /* mosaic rows and cols */
73 int i_xoffset, i_yoffset; /* top left corner offset */
74 int i_vborder, i_hborder; /* border width/height between miniatures */
75 int i_alpha; /* subfilter alpha blending */
77 char **ppsz_order; /* list of picture-id */
83 /*****************************************************************************
85 *****************************************************************************/
86 #define ALPHA_TEXT N_("Alpha blending")
87 #define ALPHA_LONGTEXT N_("Alpha blending (0 -> 255). Default is 255")
89 #define HEIGHT_TEXT N_("Height in pixels")
90 #define WIDTH_TEXT N_("Width in pixels")
91 #define XOFFSET_TEXT N_("Top left corner x coordinate")
92 #define YOFFSET_TEXT N_("Top left corner y coordinate")
93 #define VBORDER_TEXT N_("Vertical border width in pixels")
94 #define HBORDER_TEXT N_("Horizontal border width in pixels")
96 #define POS_TEXT N_("Positioning method")
97 #define POS_LONGTEXT N_("Positioning method. auto : automatically choose " \
98 "the best number of rows and columns. fixed : use the user-defined " \
99 "number of rows and columns.")
100 #define ROWS_TEXT N_("Number of rows")
101 #define COLS_TEXT N_("Number of columns")
102 #define AR_TEXT N_("Keep aspect ratio when resizing")
103 #define KEEP_TEXT N_("Keep original size")
105 #define ORDER_TEXT N_("Order as a comma separated list of picture-id(s)")
107 #define DELAY_TEXT N_("Delay")
108 #define DELAY_LONGTEXT N_("Pictures coming from the picture video outputs " \
109 "will be delayed accordingly (in milliseconds, >= 100 ms). For high " \
110 "values you will need to raise file-caching and others.")
112 static int pi_pos_values[] = { 0, 1 };
113 static char * ppsz_pos_descriptions[] =
114 { N_("auto"), N_("fixed") };
118 set_description( N_("Mosaic video sub filter") );
119 set_shortname( N_("Mosaic") );
120 set_capability( "sub filter", 0 );
121 set_callbacks( CreateFilter, DestroyFilter );
123 add_integer( "mosaic-alpha", 255, NULL, ALPHA_TEXT, ALPHA_LONGTEXT, VLC_FALSE );
124 add_integer( "mosaic-height", 100, NULL, HEIGHT_TEXT, HEIGHT_TEXT, VLC_FALSE );
125 add_integer( "mosaic-width", 100, NULL, WIDTH_TEXT, WIDTH_TEXT, VLC_FALSE );
126 add_integer( "mosaic-xoffset", 0, NULL, XOFFSET_TEXT, XOFFSET_TEXT, VLC_TRUE );
127 add_integer( "mosaic-yoffset", 0, NULL, YOFFSET_TEXT, YOFFSET_TEXT, VLC_TRUE );
128 add_integer( "mosaic-vborder", 0, NULL, VBORDER_TEXT, VBORDER_TEXT, VLC_TRUE );
129 add_integer( "mosaic-hborder", 0, NULL, HBORDER_TEXT, HBORDER_TEXT, VLC_TRUE );
131 add_integer( "mosaic-position", 0, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
132 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
133 add_integer( "mosaic-rows", 2, NULL, ROWS_TEXT, ROWS_TEXT, VLC_FALSE );
134 add_integer( "mosaic-cols", 2, NULL, COLS_TEXT, COLS_TEXT, VLC_FALSE );
135 add_bool( "mosaic-keep-aspect-ratio", 0, NULL, AR_TEXT, AR_TEXT, VLC_FALSE );
136 add_bool( "mosaic-keep-picture", 0, NULL, KEEP_TEXT, KEEP_TEXT, VLC_FALSE );
137 add_string( "mosaic-order", "", NULL, ORDER_TEXT, ORDER_TEXT, VLC_FALSE );
139 add_integer( "mosaic-delay", 100, NULL, DELAY_TEXT, DELAY_LONGTEXT,
144 /*****************************************************************************
145 * CreateFiler: allocate mosaic video filter
146 *****************************************************************************/
147 static int CreateFilter( vlc_object_t *p_this )
149 filter_t *p_filter = (filter_t *)p_this;
151 libvlc_t *p_libvlc = p_filter->p_libvlc;
155 /* Allocate structure */
156 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
159 msg_Err( p_filter, "out of memory" );
163 p_filter->pf_sub_filter = Filter;
166 vlc_mutex_init( p_filter, &p_sys->lock );
167 vlc_mutex_lock( &p_sys->lock );
169 #define GET_VAR( name, min, max ) \
170 p_sys->i_##name = __MIN( max, __MAX( min, \
171 var_CreateGetInteger( p_filter, "mosaic-" #name ) ) ); \
172 var_Destroy( p_filter, "mosaic-" #name ); \
173 var_Create( p_libvlc, "mosaic-" #name, VLC_VAR_INTEGER ); \
174 var_SetInteger( p_libvlc, "mosaic-" #name, p_sys->i_##name ); \
175 var_AddCallback( p_libvlc, "mosaic-" #name, MosaicCallback, p_sys );
177 GET_VAR( width, 0, INT_MAX );
178 GET_VAR( height, 0, INT_MAX );
179 GET_VAR( xoffset, 0, INT_MAX );
180 GET_VAR( yoffset, 0, INT_MAX );
181 GET_VAR( vborder, 0, INT_MAX );
182 GET_VAR( hborder, 0, INT_MAX );
183 GET_VAR( rows, 1, INT_MAX );
184 GET_VAR( cols, 1, INT_MAX );
185 GET_VAR( alpha, 0, 255 );
186 GET_VAR( position, 0, 1 );
187 GET_VAR( delay, 100, INT_MAX );
188 p_sys->i_delay *= 1000;
190 p_sys->b_ar = var_CreateGetBool( p_filter, "mosaic-keep-aspect-ratio" );
191 var_Destroy( p_filter, "mosaic-keep-aspect-ratio" );
192 var_Create( p_libvlc, "mosaic-keep-aspect-ratio", VLC_VAR_INTEGER );
193 var_SetBool( p_libvlc, "mosaic-keep-aspect-ratio", p_sys->b_ar );
194 var_AddCallback( p_libvlc, "mosaic-keep-aspect-ratio", MosaicCallback,
197 p_sys->b_keep = var_CreateGetBool( p_filter, "mosaic-keep-picture" );
198 if ( !p_sys->b_keep )
200 p_sys->p_image = image_HandlerCreate( p_filter );
202 p_sys->p_image2 = image_HandlerCreate( p_filter );
206 p_sys->i_order_length = 0;
207 p_sys->ppsz_order = NULL;
208 psz_order = var_CreateGetString( p_filter, "mosaic-order" );
210 if( psz_order[0] != 0 )
212 char *psz_end = NULL;
216 psz_end = strchr( psz_order, ',' );
218 p_sys->ppsz_order = realloc( p_sys->ppsz_order,
219 i_index * sizeof(char *) );
220 p_sys->ppsz_order[i_index - 1] = strndup( psz_order,
221 psz_end - psz_order );
222 psz_order = psz_end+1;
223 } while( NULL != psz_end );
224 p_sys->i_order_length = i_index;
227 vlc_mutex_unlock( &p_sys->lock );
229 vlc_thread_set_priority( p_filter, VLC_THREAD_PRIORITY_OUTPUT );
234 /*****************************************************************************
235 * DestroyFilter: destroy mosaic video filter
236 *****************************************************************************/
237 static void DestroyFilter( vlc_object_t *p_this )
239 filter_t *p_filter = (filter_t*)p_this;
240 filter_sys_t *p_sys = p_filter->p_sys;
241 libvlc_t *p_libvlc = p_filter->p_libvlc;
244 vlc_mutex_lock( &p_sys->lock );
248 image_HandlerDelete( p_sys->p_image );
250 image_HandlerDelete( p_sys->p_image2 );
254 if( p_sys->i_order_length )
256 for( i_index = 0; i_index < p_sys->i_order_length; i_index++ )
258 free( p_sys->ppsz_order[i_index] );
260 free( p_sys->ppsz_order );
263 var_Destroy( p_libvlc, "mosaic-alpha" );
264 var_Destroy( p_libvlc, "mosaic-height" );
265 var_Destroy( p_libvlc, "mosaic-width" );
266 var_Destroy( p_libvlc, "mosaic-xoffset" );
267 var_Destroy( p_libvlc, "mosaic-yoffset" );
268 var_Destroy( p_libvlc, "mosaic-vborder" );
269 var_Destroy( p_libvlc, "mosaic-hborder" );
270 var_Destroy( p_libvlc, "mosaic-position" );
271 var_Destroy( p_libvlc, "mosaic-rows" );
272 var_Destroy( p_libvlc, "mosaic-cols" );
273 var_Destroy( p_libvlc, "mosaic-keep-aspect-ratio" );
275 if( p_sys->p_pic ) p_sys->p_pic->pf_release( p_sys->p_pic );
276 vlc_mutex_unlock( &p_sys->lock );
277 vlc_mutex_destroy( &p_sys->lock );
281 /*****************************************************************************
282 * MosaicReleasePicture : Hack to avoid picture duplication
283 *****************************************************************************/
284 static void MosaicReleasePicture( picture_t *p_picture )
286 picture_t *p_original_pic = (picture_t *)p_picture->p_sys;
288 p_original_pic->pf_release( p_original_pic );
291 /*****************************************************************************
293 *****************************************************************************/
294 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
296 filter_sys_t *p_sys = p_filter->p_sys;
297 libvlc_t *p_libvlc = p_filter->p_libvlc;
301 int i_index, i_real_index, i_row, i_col;
302 int i_greatest_real_index_used = p_sys->i_order_length - 1;
304 subpicture_region_t *p_region;
305 subpicture_region_t *p_region_prev = NULL;
307 picture_vout_t *p_picture_vout;
308 vlc_value_t val, lockval;
310 /* Wait for the specified date. This is to avoid running too fast and
311 * take twice the same pictures. */
312 mwait( date - p_sys->i_delay );
314 if ( var_Get( p_libvlc, "picture-lock", &lockval ) )
317 vlc_mutex_lock( lockval.p_address );
319 if( var_Get( p_libvlc, "p_picture_vout", &val ) )
321 vlc_mutex_unlock( lockval.p_address );
325 p_picture_vout = val.p_address;
327 /* Allocate the subpicture internal data. */
328 p_spu = p_filter->pf_sub_buffer_new( p_filter );
334 /* Initialize subpicture */
335 p_spu->i_channel = 0;
336 p_spu->i_start = date;
338 p_spu->b_ephemer = VLC_TRUE;
339 p_spu->i_alpha = p_sys->i_alpha;
341 vlc_mutex_lock( &p_sys->lock );
343 if( p_sys->i_position == 0 ) /* use automatic positioning */
345 int i_numpics = p_sys->i_order_length; /* keep slots and all */
347 i_index < p_picture_vout->i_picture_num;
350 if( p_picture_vout->p_pic[i_index].i_status
351 == PICTURE_VOUT_E_OCCUPIED )
354 if( p_sys->i_order_length
355 && p_picture_vout->p_pic[i_index].psz_id != 0 )
357 /* We also want to leave slots for images given in
358 * mosaic-order that are not available in p_vout_picture */
360 for( i = 0; i < p_sys->i_order_length ; i++ )
362 if( !strcmp( p_sys->ppsz_order[i],
363 p_picture_vout->p_pic[i_index].psz_id ) )
373 p_sys->i_rows = ((int)ceil(sqrt( (float)i_numpics )));
374 p_sys->i_cols = ( i_numpics % p_sys->i_rows == 0 ?
375 i_numpics / p_sys->i_rows :
376 i_numpics / p_sys->i_rows + 1 );
381 for( i_index = 0; i_index < p_picture_vout->i_picture_num; i_index++ )
383 picture_vout_e_t *p_pic = &p_picture_vout->p_pic[i_index];
384 video_format_t fmt_in = {0}, fmt_out = {0};
385 picture_t *p_converted;
387 video_format_t fmt_middle = {0};
391 if( p_pic->i_status == PICTURE_VOUT_E_AVAILABLE
392 || p_pic->p_picture == NULL )
397 if( p_sys->i_order_length == 0 )
404 for( i = 0; i <= p_sys->i_order_length; i++ )
406 if( i == p_sys->i_order_length ) break;
407 if( strcmp( p_pic->psz_id, p_sys->ppsz_order[i] ) == 0 )
413 if( i == p_sys->i_order_length )
414 i_real_index = ++i_greatest_real_index_used;
416 i_row = ( i_real_index / p_sys->i_cols ) % p_sys->i_rows;
417 i_col = i_real_index % p_sys->i_cols ;
421 /* Convert the images */
422 fmt_in.i_chroma = p_pic->p_picture->format.i_chroma;
423 fmt_in.i_height = p_pic->p_picture->format.i_height;
424 fmt_in.i_width = p_pic->p_picture->format.i_width;
426 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
427 fmt_out.i_width = fmt_in.i_width *
428 ( ( p_sys->i_width - ( p_sys->i_cols - 1 ) * p_sys->i_vborder )
429 / p_sys->i_cols ) / fmt_in.i_width;
430 fmt_out.i_height = fmt_in.i_height *
431 ( ( p_sys->i_height - ( p_sys->i_rows - 1 ) * p_sys->i_hborder )
432 / p_sys->i_rows ) / fmt_in.i_height;
433 if( p_sys->b_ar ) /* keep aspect ratio */
435 if( (float)fmt_out.i_width / (float)fmt_out.i_height
436 > (float)fmt_in.i_width / (float)fmt_in.i_height )
438 fmt_out.i_width = ( fmt_out.i_height * fmt_in.i_width )
443 fmt_out.i_height = ( fmt_out.i_width * fmt_in.i_height )
448 fmt_out.i_visible_width = fmt_out.i_width;
449 fmt_out.i_visible_height = fmt_out.i_height;
452 fmt_middle.i_chroma = fmt_in.i_chroma;
453 fmt_middle.i_visible_width = fmt_middle.i_width = fmt_out.i_width;
454 fmt_middle.i_visible_height = fmt_middle.i_height = fmt_out.i_height;
456 p_middle = image_Convert( p_sys->p_image2, p_pic->p_picture,
457 &fmt_in, &fmt_middle );
460 msg_Warn( p_filter, "image resizing failed" );
464 p_converted = image_Convert( p_sys->p_image, p_middle,
465 &fmt_middle, &fmt_out );
466 p_middle->pf_release( p_middle );
470 msg_Warn( p_filter, "image chroma conversion failed" );
474 p_converted = image_Convert( p_sys->p_image, p_pic->p_picture,
479 "image resizing and chroma conversion failed" );
486 p_converted = p_pic->p_picture;
487 p_converted->i_refcount++;
488 fmt_in.i_width = fmt_out.i_width = p_converted->format.i_width;
489 fmt_in.i_height = fmt_out.i_height = p_converted->format.i_height;
490 fmt_in.i_chroma = fmt_out.i_chroma = p_converted->format.i_chroma;
491 fmt_out.i_visible_width = fmt_out.i_width;
492 fmt_out.i_visible_height = fmt_out.i_height;
495 p_region = p_spu->pf_make_region( VLC_OBJECT(p_filter), &fmt_out,
499 msg_Err( p_filter, "cannot allocate SPU region" );
500 p_filter->pf_sub_buffer_del( p_filter, p_spu );
501 vlc_mutex_unlock( &p_sys->lock );
502 vlc_mutex_unlock( lockval.p_address );
506 /* HACK ALERT : let's fix the pointers to avoid picture duplication.
507 * This is necessary because p_region->picture is not a pointer
508 * as it ought to be. */
515 /* Keep a pointer to the original picture (and its refcount...). */
516 p_region->picture.p_sys = (picture_sys_t *)p_converted;
517 p_region->picture.pf_release = MosaicReleasePicture;
520 if( p_sys->b_ar || p_sys->b_keep ) /* keep aspect ratio */
522 /* center the video in the dedicated rectangle */
523 p_region->i_x = p_sys->i_xoffset
524 + i_col * ( p_sys->i_width / p_sys->i_cols )
525 + ( i_col * p_sys->i_vborder ) / p_sys->i_cols
526 + ( ( ( p_sys->i_width
527 - ( p_sys->i_cols - 1 ) * p_sys->i_vborder )
528 / p_sys->i_cols ) - fmt_out.i_width ) / 2;
529 p_region->i_y = p_sys->i_yoffset
530 + i_row * ( p_sys->i_height / p_sys->i_rows )
531 + ( i_row * p_sys->i_hborder ) / p_sys->i_rows
532 + ( ( ( p_sys->i_height
533 - ( p_sys->i_rows - 1 ) * p_sys->i_hborder )
534 / p_sys->i_rows ) - fmt_out.i_height ) / 2;
538 /* we don't have to center the video since it takes the
539 whole rectangle area */
540 p_region->i_x = p_sys->i_xoffset
541 + i_col * ( p_sys->i_width / p_sys->i_cols )
542 + ( i_col * p_sys->i_vborder ) / p_sys->i_cols;
543 p_region->i_y = p_sys->i_yoffset
544 + i_row * ( p_sys->i_height / p_sys->i_rows )
545 + ( i_row * p_sys->i_hborder ) / p_sys->i_rows;
548 if( p_region_prev == NULL )
550 p_spu->p_region = p_region;
554 p_region_prev->p_next = p_region;
557 p_region_prev = p_region;
560 vlc_mutex_unlock( &p_sys->lock );
561 vlc_mutex_unlock( lockval.p_address );
566 /*****************************************************************************
567 * Callback to update params on the fly
568 *****************************************************************************/
569 static int MosaicCallback( vlc_object_t *p_this, char const *psz_var,
570 vlc_value_t oldval, vlc_value_t newval,
573 filter_sys_t *p_sys = (filter_sys_t *) p_data;
574 if( !strcmp( psz_var, "mosaic-alpha" ) )
576 vlc_mutex_lock( &p_sys->lock );
577 msg_Dbg( p_this, "Changing alpha from %d/255 to %d/255",
578 p_sys->i_alpha, newval.i_int);
579 p_sys->i_alpha = __MIN( __MAX( newval.i_int, 0 ), 255 );
580 vlc_mutex_unlock( &p_sys->lock );
582 else if( !strcmp( psz_var, "mosaic-height" ) )
584 vlc_mutex_lock( &p_sys->lock );
585 msg_Dbg( p_this, "Changing height from %dpx to %dpx",
586 p_sys->i_height, newval.i_int );
587 p_sys->i_height = __MAX( newval.i_int, 0 );
588 vlc_mutex_unlock( &p_sys->lock );
590 else if( !strcmp( psz_var, "mosaic-width" ) )
592 vlc_mutex_lock( &p_sys->lock );
593 msg_Dbg( p_this, "Changing width from %dpx to %dpx",
594 p_sys->i_width, newval.i_int );
595 p_sys->i_width = __MAX( newval.i_int, 0 );
596 vlc_mutex_unlock( &p_sys->lock );
598 else if( !strcmp( psz_var, "mosaic-xoffset" ) )
600 vlc_mutex_lock( &p_sys->lock );
601 msg_Dbg( p_this, "Changing x offset from %dpx to %dpx",
602 p_sys->i_xoffset, newval.i_int );
603 p_sys->i_xoffset = __MAX( newval.i_int, 0 );
604 vlc_mutex_unlock( &p_sys->lock );
606 else if( !strcmp( psz_var, "mosaic-yoffset" ) )
608 vlc_mutex_lock( &p_sys->lock );
609 msg_Dbg( p_this, "Changing y offset from %dpx to %dpx",
610 p_sys->i_yoffset, newval.i_int );
611 p_sys->i_yoffset = __MAX( newval.i_int, 0 );
612 vlc_mutex_unlock( &p_sys->lock );
614 else if( !strcmp( psz_var, "mosaic-vborder" ) )
616 vlc_mutex_lock( &p_sys->lock );
617 msg_Dbg( p_this, "Changing vertical border from %dpx to %dpx",
618 p_sys->i_vborder, newval.i_int );
619 p_sys->i_vborder = __MAX( newval.i_int, 0 );
620 vlc_mutex_unlock( &p_sys->lock );
622 else if( !strcmp( psz_var, "mosaic-hborder" ) )
624 vlc_mutex_lock( &p_sys->lock );
625 msg_Dbg( p_this, "Changing horizontal border from %dpx to %dpx",
626 p_sys->i_vborder, newval.i_int );
627 p_sys->i_hborder = __MAX( newval.i_int, 0 );
628 vlc_mutex_unlock( &p_sys->lock );
630 else if( !strcmp( psz_var, "mosaic-position" ) )
632 if( newval.i_int > 1 || newval.i_int < 0 )
634 msg_Err( p_this, "Position is either 0 (auto) or 1 (fixed)" );
638 vlc_mutex_lock( &p_sys->lock );
639 msg_Dbg( p_this, "Changing position method from %d (%s) to %d (%s)",
640 p_sys->i_position, ppsz_pos_descriptions[p_sys->i_position],
641 newval.i_int, ppsz_pos_descriptions[newval.i_int]);
642 p_sys->i_position = newval.i_int;
643 vlc_mutex_unlock( &p_sys->lock );
646 else if( !strcmp( psz_var, "mosaic-rows" ) )
648 vlc_mutex_lock( &p_sys->lock );
649 msg_Dbg( p_this, "Changing number of rows from %d to %d",
650 p_sys->i_rows, newval.i_int );
651 p_sys->i_rows = __MAX( newval.i_int, 1 );
652 vlc_mutex_unlock( &p_sys->lock );
654 else if( !strcmp( psz_var, "mosaic-cols" ) )
656 vlc_mutex_lock( &p_sys->lock );
657 msg_Dbg( p_this, "Changing number of columns from %d to %d",
658 p_sys->i_cols, newval.i_int );
659 p_sys->i_cols = __MAX( newval.i_int, 1 );
660 vlc_mutex_unlock( &p_sys->lock );
662 else if( !strcmp( psz_var, "mosaic-keep-aspect-ratio" ) )
664 vlc_mutex_lock( &p_sys->lock );
667 msg_Dbg( p_this, "Keep aspect ratio" );
672 msg_Dbg( p_this, "Don't keep aspect ratio" );
675 vlc_mutex_unlock( &p_sys->lock );