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() */
35 #include "vlc_filter.h"
36 #include "vlc_image.h"
38 #include "../video_output/picture.h"
40 /*****************************************************************************
42 *****************************************************************************/
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 descriptor
53 *****************************************************************************/
58 image_handler_t *p_image;
60 image_handler_t *p_image2;
64 int i_position; /* mosaic positioning method */
65 vlc_bool_t b_ar; /* do we keep the aspect ratio ? */
66 vlc_bool_t b_keep; /* do we keep the original picture format ? */
67 int i_width, i_height; /* mosaic height and width */
68 int i_cols, i_rows; /* mosaic rows and cols */
69 int i_xoffset, i_yoffset; /* top left corner offset */
70 int i_vborder, i_hborder; /* border width/height between miniatures */
71 int i_alpha; /* subfilter alpha blending */
73 char **ppsz_order; /* list of picture-id */
79 /*****************************************************************************
81 *****************************************************************************/
82 #define ALPHA_TEXT N_("Alpha blending")
83 #define ALPHA_LONGTEXT N_("Alpha blending (0 -> 255). Default is 255")
85 #define HEIGHT_TEXT N_("Height in pixels")
86 #define WIDTH_TEXT N_("Width in pixels")
87 #define XOFFSET_TEXT N_("Top left corner x coordinate")
88 #define YOFFSET_TEXT N_("Top left corner y coordinate")
89 #define VBORDER_TEXT N_("Vertical border width in pixels")
90 #define HBORDER_TEXT N_("Horizontal border width in pixels")
92 #define POS_TEXT N_("Positioning method")
93 #define POS_LONGTEXT N_("Positioning method. auto : automatically choose " \
94 "the best number of rows and columns. fixed : use the user-defined " \
95 "number of rows and columns.")
96 #define ROWS_TEXT N_("Number of rows")
97 #define COLS_TEXT N_("Number of columns")
98 #define AR_TEXT N_("Keep aspect ratio when resizing")
99 #define KEEP_TEXT N_("Keep original size")
101 #define ORDER_TEXT N_("Order as a comma separated list of picture-id(s)")
103 #define DELAY_TEXT N_("Delay")
104 #define DELAY_LONGTEXT N_("Pictures coming from the picture video outputs " \
105 "will be delayed accordingly (in milliseconds, >= 100 ms). For high " \
106 "values you will need to raise file-caching and others.")
108 static int pi_pos_values[] = { 0, 1 };
109 static char * ppsz_pos_descriptions[] =
110 { N_("auto"), N_("fixed") };
114 set_description( N_("Mosaic video sub filter") );
115 set_shortname( N_("Mosaic") );
116 set_capability( "sub filter", 0 );
117 set_callbacks( CreateFilter, DestroyFilter );
119 add_integer( "mosaic-alpha", 255, NULL, ALPHA_TEXT, ALPHA_LONGTEXT, VLC_FALSE );
120 add_integer( "mosaic-height", 100, NULL, HEIGHT_TEXT, HEIGHT_TEXT, VLC_FALSE );
121 add_integer( "mosaic-width", 100, NULL, WIDTH_TEXT, WIDTH_TEXT, VLC_FALSE );
122 add_integer( "mosaic-xoffset", 0, NULL, XOFFSET_TEXT, XOFFSET_TEXT, VLC_TRUE );
123 add_integer( "mosaic-yoffset", 0, NULL, YOFFSET_TEXT, YOFFSET_TEXT, VLC_TRUE );
124 add_integer( "mosaic-vborder", 0, NULL, VBORDER_TEXT, VBORDER_TEXT, VLC_TRUE );
125 add_integer( "mosaic-hborder", 0, NULL, HBORDER_TEXT, HBORDER_TEXT, VLC_TRUE );
127 add_integer( "mosaic-position", 0, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
128 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
129 add_integer( "mosaic-rows", 2, NULL, ROWS_TEXT, ROWS_TEXT, VLC_FALSE );
130 add_integer( "mosaic-cols", 2, NULL, COLS_TEXT, COLS_TEXT, VLC_FALSE );
131 add_bool( "mosaic-keep-aspect-ratio", 0, NULL, AR_TEXT, AR_TEXT, VLC_FALSE );
132 add_bool( "mosaic-keep-picture", 0, NULL, KEEP_TEXT, KEEP_TEXT, VLC_FALSE );
133 add_string( "mosaic-order", "", NULL, ORDER_TEXT, ORDER_TEXT, VLC_FALSE );
135 add_integer( "mosaic-delay", 100, NULL, DELAY_TEXT, DELAY_LONGTEXT,
140 /*****************************************************************************
141 * CreateFiler: allocate mosaic video filter
142 *****************************************************************************/
143 static int CreateFilter( vlc_object_t *p_this )
145 filter_t *p_filter = (filter_t *)p_this;
147 libvlc_t *p_libvlc = p_filter->p_libvlc;
151 /* Allocate structure */
152 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
155 msg_Err( p_filter, "out of memory" );
159 p_filter->pf_sub_filter = Filter;
162 vlc_mutex_init( p_filter, &p_sys->lock );
163 vlc_mutex_lock( &p_sys->lock );
165 #define GET_VAR( name, min, max ) \
166 p_sys->i_##name = __MIN( max, __MAX( min, \
167 var_CreateGetInteger( p_filter, "mosaic-" #name ) ) ); \
168 var_Destroy( p_filter, "mosaic-" #name ); \
169 var_Create( p_libvlc, "mosaic-" #name, VLC_VAR_INTEGER ); \
170 var_SetInteger( p_libvlc, "mosaic-" #name, p_sys->i_##name ); \
171 var_AddCallback( p_libvlc, "mosaic-" #name, MosaicCallback, p_sys );
173 GET_VAR( width, 0, INT32_MAX );
174 GET_VAR( height, 0, INT32_MAX );
175 GET_VAR( xoffset, 0, INT32_MAX );
176 GET_VAR( yoffset, 0, INT32_MAX );
177 GET_VAR( vborder, 0, INT32_MAX );
178 GET_VAR( hborder, 0, INT32_MAX );
179 GET_VAR( rows, 1, INT32_MAX );
180 GET_VAR( cols, 1, INT32_MAX );
181 GET_VAR( alpha, 0, 255 );
182 GET_VAR( position, 0, 1 );
183 GET_VAR( delay, 100, INT32_MAX );
184 p_sys->i_delay *= 1000;
186 p_sys->b_ar = var_CreateGetBool( p_filter, "mosaic-keep-aspect-ratio" );
187 var_Destroy( p_filter, "mosaic-keep-aspect-ratio" );
188 var_Create( p_libvlc, "mosaic-keep-aspect-ratio", VLC_VAR_INTEGER );
189 var_SetBool( p_libvlc, "mosaic-keep-aspect-ratio", p_sys->b_ar );
190 var_AddCallback( p_libvlc, "mosaic-keep-aspect-ratio", MosaicCallback,
193 p_sys->b_keep = var_CreateGetBool( p_filter, "mosaic-keep-picture" );
194 if ( !p_sys->b_keep )
196 p_sys->p_image = image_HandlerCreate( p_filter );
198 p_sys->p_image2 = image_HandlerCreate( p_filter );
202 p_sys->i_order_length = 0;
203 p_sys->ppsz_order = NULL;
204 psz_order = var_CreateGetString( p_filter, "mosaic-order" );
206 if( psz_order[0] != 0 )
208 char *psz_end = NULL;
212 psz_end = strchr( psz_order, ',' );
214 p_sys->ppsz_order = realloc( p_sys->ppsz_order,
215 i_index * sizeof(char *) );
216 p_sys->ppsz_order[i_index - 1] = strndup( psz_order,
217 psz_end - psz_order );
218 psz_order = psz_end+1;
219 } while( NULL != psz_end );
220 p_sys->i_order_length = i_index;
223 vlc_mutex_unlock( &p_sys->lock );
225 vlc_thread_set_priority( p_filter, VLC_THREAD_PRIORITY_OUTPUT );
230 /*****************************************************************************
231 * DestroyFilter: destroy mosaic video filter
232 *****************************************************************************/
233 static void DestroyFilter( vlc_object_t *p_this )
235 filter_t *p_filter = (filter_t*)p_this;
236 filter_sys_t *p_sys = p_filter->p_sys;
237 libvlc_t *p_libvlc = p_filter->p_libvlc;
240 vlc_mutex_lock( &p_sys->lock );
244 image_HandlerDelete( p_sys->p_image );
246 image_HandlerDelete( p_sys->p_image2 );
250 if( p_sys->i_order_length )
252 for( i_index = 0; i_index < p_sys->i_order_length; i_index++ )
254 free( p_sys->ppsz_order[i_index] );
256 free( p_sys->ppsz_order );
259 var_Destroy( p_libvlc, "mosaic-alpha" );
260 var_Destroy( p_libvlc, "mosaic-height" );
261 var_Destroy( p_libvlc, "mosaic-width" );
262 var_Destroy( p_libvlc, "mosaic-xoffset" );
263 var_Destroy( p_libvlc, "mosaic-yoffset" );
264 var_Destroy( p_libvlc, "mosaic-vborder" );
265 var_Destroy( p_libvlc, "mosaic-hborder" );
266 var_Destroy( p_libvlc, "mosaic-position" );
267 var_Destroy( p_libvlc, "mosaic-rows" );
268 var_Destroy( p_libvlc, "mosaic-cols" );
269 var_Destroy( p_libvlc, "mosaic-keep-aspect-ratio" );
271 if( p_sys->p_pic ) p_sys->p_pic->pf_release( p_sys->p_pic );
272 vlc_mutex_unlock( &p_sys->lock );
273 vlc_mutex_destroy( &p_sys->lock );
277 /*****************************************************************************
278 * MosaicReleasePicture : Hack to avoid picture duplication
279 *****************************************************************************/
280 static void MosaicReleasePicture( picture_t *p_picture )
282 picture_t *p_original_pic = (picture_t *)p_picture->p_sys;
284 p_original_pic->pf_release( p_original_pic );
287 /*****************************************************************************
289 *****************************************************************************/
290 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
292 filter_sys_t *p_sys = p_filter->p_sys;
293 libvlc_t *p_libvlc = p_filter->p_libvlc;
297 int i_index, i_real_index, i_row, i_col;
298 int i_greatest_real_index_used = p_sys->i_order_length - 1;
300 subpicture_region_t *p_region;
301 subpicture_region_t *p_region_prev = NULL;
303 picture_vout_t *p_picture_vout;
304 vlc_value_t val, lockval;
306 /* Wait for the specified date. This is to avoid running too fast and
307 * take twice the same pictures. */
308 mwait( date - p_sys->i_delay );
310 if ( var_Get( p_libvlc, "picture-lock", &lockval ) )
313 vlc_mutex_lock( lockval.p_address );
315 if( var_Get( p_libvlc, "p_picture_vout", &val ) )
317 vlc_mutex_unlock( lockval.p_address );
321 p_picture_vout = val.p_address;
323 /* Allocate the subpicture internal data. */
324 p_spu = p_filter->pf_sub_buffer_new( p_filter );
330 /* Initialize subpicture */
331 p_spu->i_channel = 0;
332 p_spu->i_start = date;
334 p_spu->b_ephemer = VLC_TRUE;
335 p_spu->i_alpha = p_sys->i_alpha;
337 vlc_mutex_lock( &p_sys->lock );
339 if( p_sys->i_position == 0 ) /* use automatic positioning */
341 int i_numpics = p_sys->i_order_length; /* keep slots and all */
343 i_index < p_picture_vout->i_picture_num;
346 if( p_picture_vout->p_pic[i_index].i_status
347 == PICTURE_VOUT_E_OCCUPIED )
350 if( p_sys->i_order_length
351 && p_picture_vout->p_pic[i_index].psz_id != 0 )
353 /* We also want to leave slots for images given in
354 * mosaic-order that are not available in p_vout_picture */
356 for( i = 0; i < p_sys->i_order_length ; i++ )
358 if( !strcmp( p_sys->ppsz_order[i],
359 p_picture_vout->p_pic[i_index].psz_id ) )
369 p_sys->i_rows = ((int)ceil(sqrt( (float)i_numpics )));
370 p_sys->i_cols = ( i_numpics % p_sys->i_rows == 0 ?
371 i_numpics / p_sys->i_rows :
372 i_numpics / p_sys->i_rows + 1 );
377 for( i_index = 0; i_index < p_picture_vout->i_picture_num; i_index++ )
379 picture_vout_e_t *p_pic = &p_picture_vout->p_pic[i_index];
380 video_format_t fmt_in = {0}, fmt_out = {0};
381 picture_t *p_converted;
383 video_format_t fmt_middle = {0};
387 if( p_pic->i_status == PICTURE_VOUT_E_AVAILABLE
388 || p_pic->p_picture == NULL )
393 if( p_sys->i_order_length == 0 )
400 for( i = 0; i <= p_sys->i_order_length; i++ )
402 if( i == p_sys->i_order_length ) break;
403 if( strcmp( p_pic->psz_id, p_sys->ppsz_order[i] ) == 0 )
409 if( i == p_sys->i_order_length )
410 i_real_index = ++i_greatest_real_index_used;
412 i_row = ( i_real_index / p_sys->i_cols ) % p_sys->i_rows;
413 i_col = i_real_index % p_sys->i_cols ;
417 /* Convert the images */
418 fmt_in.i_chroma = p_pic->p_picture->format.i_chroma;
419 fmt_in.i_height = p_pic->p_picture->format.i_height;
420 fmt_in.i_width = p_pic->p_picture->format.i_width;
422 fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
423 fmt_out.i_width = fmt_in.i_width *
424 ( ( p_sys->i_width - ( p_sys->i_cols - 1 ) * p_sys->i_vborder )
425 / p_sys->i_cols ) / fmt_in.i_width;
426 fmt_out.i_height = fmt_in.i_height *
427 ( ( p_sys->i_height - ( p_sys->i_rows - 1 ) * p_sys->i_hborder )
428 / p_sys->i_rows ) / fmt_in.i_height;
429 if( p_sys->b_ar ) /* keep aspect ratio */
431 if( (float)fmt_out.i_width / (float)fmt_out.i_height
432 > (float)fmt_in.i_width / (float)fmt_in.i_height )
434 fmt_out.i_width = ( fmt_out.i_height * fmt_in.i_width )
439 fmt_out.i_height = ( fmt_out.i_width * fmt_in.i_height )
444 fmt_out.i_visible_width = fmt_out.i_width;
445 fmt_out.i_visible_height = fmt_out.i_height;
448 fmt_middle.i_chroma = fmt_in.i_chroma;
449 fmt_middle.i_visible_width = fmt_middle.i_width = fmt_out.i_width;
450 fmt_middle.i_visible_height = fmt_middle.i_height = fmt_out.i_height;
452 p_middle = image_Convert( p_sys->p_image2, p_pic->p_picture,
453 &fmt_in, &fmt_middle );
456 msg_Warn( p_filter, "image resizing failed" );
460 p_converted = image_Convert( p_sys->p_image, p_middle,
461 &fmt_middle, &fmt_out );
462 p_middle->pf_release( p_middle );
466 msg_Warn( p_filter, "image chroma conversion failed" );
470 p_converted = image_Convert( p_sys->p_image, p_pic->p_picture,
475 "image resizing and chroma conversion failed" );
482 p_converted = p_pic->p_picture;
483 p_converted->i_refcount++;
484 fmt_in.i_width = fmt_out.i_width = p_converted->format.i_width;
485 fmt_in.i_height = fmt_out.i_height = p_converted->format.i_height;
486 fmt_in.i_chroma = fmt_out.i_chroma = p_converted->format.i_chroma;
487 fmt_out.i_visible_width = fmt_out.i_width;
488 fmt_out.i_visible_height = fmt_out.i_height;
491 p_region = p_spu->pf_make_region( VLC_OBJECT(p_filter), &fmt_out,
495 msg_Err( p_filter, "cannot allocate SPU region" );
496 p_filter->pf_sub_buffer_del( p_filter, p_spu );
497 vlc_mutex_unlock( &p_sys->lock );
498 vlc_mutex_unlock( lockval.p_address );
502 /* HACK ALERT : let's fix the pointers to avoid picture duplication.
503 * This is necessary because p_region->picture is not a pointer
504 * as it ought to be. */
511 /* Keep a pointer to the original picture (and its refcount...). */
512 p_region->picture.p_sys = (picture_sys_t *)p_converted;
513 p_region->picture.pf_release = MosaicReleasePicture;
516 if( p_sys->b_ar || p_sys->b_keep ) /* keep aspect ratio */
518 /* center the video in the dedicated rectangle */
519 p_region->i_x = p_sys->i_xoffset
520 + i_col * ( p_sys->i_width / p_sys->i_cols )
521 + ( i_col * p_sys->i_vborder ) / p_sys->i_cols
522 + ( ( ( p_sys->i_width
523 - ( p_sys->i_cols - 1 ) * p_sys->i_vborder )
524 / p_sys->i_cols ) - fmt_out.i_width ) / 2;
525 p_region->i_y = p_sys->i_yoffset
526 + i_row * ( p_sys->i_height / p_sys->i_rows )
527 + ( i_row * p_sys->i_hborder ) / p_sys->i_rows
528 + ( ( ( p_sys->i_height
529 - ( p_sys->i_rows - 1 ) * p_sys->i_hborder )
530 / p_sys->i_rows ) - fmt_out.i_height ) / 2;
534 /* we don't have to center the video since it takes the
535 whole rectangle area */
536 p_region->i_x = p_sys->i_xoffset
537 + i_col * ( p_sys->i_width / p_sys->i_cols )
538 + ( i_col * p_sys->i_vborder ) / p_sys->i_cols;
539 p_region->i_y = p_sys->i_yoffset
540 + i_row * ( p_sys->i_height / p_sys->i_rows )
541 + ( i_row * p_sys->i_hborder ) / p_sys->i_rows;
544 if( p_region_prev == NULL )
546 p_spu->p_region = p_region;
550 p_region_prev->p_next = p_region;
553 p_region_prev = p_region;
556 vlc_mutex_unlock( &p_sys->lock );
557 vlc_mutex_unlock( lockval.p_address );
562 /*****************************************************************************
563 * Callback to update params on the fly
564 *****************************************************************************/
565 static int MosaicCallback( vlc_object_t *p_this, char const *psz_var,
566 vlc_value_t oldval, vlc_value_t newval,
569 filter_sys_t *p_sys = (filter_sys_t *) p_data;
570 if( !strcmp( psz_var, "mosaic-alpha" ) )
572 vlc_mutex_lock( &p_sys->lock );
573 msg_Dbg( p_this, "Changing alpha from %d/255 to %d/255",
574 p_sys->i_alpha, newval.i_int);
575 p_sys->i_alpha = __MIN( __MAX( newval.i_int, 0 ), 255 );
576 vlc_mutex_unlock( &p_sys->lock );
578 else if( !strcmp( psz_var, "mosaic-height" ) )
580 vlc_mutex_lock( &p_sys->lock );
581 msg_Dbg( p_this, "Changing height from %dpx to %dpx",
582 p_sys->i_height, newval.i_int );
583 p_sys->i_height = __MAX( newval.i_int, 0 );
584 vlc_mutex_unlock( &p_sys->lock );
586 else if( !strcmp( psz_var, "mosaic-width" ) )
588 vlc_mutex_lock( &p_sys->lock );
589 msg_Dbg( p_this, "Changing width from %dpx to %dpx",
590 p_sys->i_width, newval.i_int );
591 p_sys->i_width = __MAX( newval.i_int, 0 );
592 vlc_mutex_unlock( &p_sys->lock );
594 else if( !strcmp( psz_var, "mosaic-xoffset" ) )
596 vlc_mutex_lock( &p_sys->lock );
597 msg_Dbg( p_this, "Changing x offset from %dpx to %dpx",
598 p_sys->i_xoffset, newval.i_int );
599 p_sys->i_xoffset = __MAX( newval.i_int, 0 );
600 vlc_mutex_unlock( &p_sys->lock );
602 else if( !strcmp( psz_var, "mosaic-yoffset" ) )
604 vlc_mutex_lock( &p_sys->lock );
605 msg_Dbg( p_this, "Changing y offset from %dpx to %dpx",
606 p_sys->i_yoffset, newval.i_int );
607 p_sys->i_yoffset = __MAX( newval.i_int, 0 );
608 vlc_mutex_unlock( &p_sys->lock );
610 else if( !strcmp( psz_var, "mosaic-vborder" ) )
612 vlc_mutex_lock( &p_sys->lock );
613 msg_Dbg( p_this, "Changing vertical border from %dpx to %dpx",
614 p_sys->i_vborder, newval.i_int );
615 p_sys->i_vborder = __MAX( newval.i_int, 0 );
616 vlc_mutex_unlock( &p_sys->lock );
618 else if( !strcmp( psz_var, "mosaic-hborder" ) )
620 vlc_mutex_lock( &p_sys->lock );
621 msg_Dbg( p_this, "Changing horizontal border from %dpx to %dpx",
622 p_sys->i_vborder, newval.i_int );
623 p_sys->i_hborder = __MAX( newval.i_int, 0 );
624 vlc_mutex_unlock( &p_sys->lock );
626 else if( !strcmp( psz_var, "mosaic-position" ) )
628 if( newval.i_int > 1 || newval.i_int < 0 )
630 msg_Err( p_this, "Position is either 0 (auto) or 1 (fixed)" );
634 vlc_mutex_lock( &p_sys->lock );
635 msg_Dbg( p_this, "Changing position method from %d (%s) to %d (%s)",
636 p_sys->i_position, ppsz_pos_descriptions[p_sys->i_position],
637 newval.i_int, ppsz_pos_descriptions[newval.i_int]);
638 p_sys->i_position = newval.i_int;
639 vlc_mutex_unlock( &p_sys->lock );
642 else if( !strcmp( psz_var, "mosaic-rows" ) )
644 vlc_mutex_lock( &p_sys->lock );
645 msg_Dbg( p_this, "Changing number of rows from %d to %d",
646 p_sys->i_rows, newval.i_int );
647 p_sys->i_rows = __MAX( newval.i_int, 1 );
648 vlc_mutex_unlock( &p_sys->lock );
650 else if( !strcmp( psz_var, "mosaic-cols" ) )
652 vlc_mutex_lock( &p_sys->lock );
653 msg_Dbg( p_this, "Changing number of columns from %d to %d",
654 p_sys->i_cols, newval.i_int );
655 p_sys->i_cols = __MAX( newval.i_int, 1 );
656 vlc_mutex_unlock( &p_sys->lock );
658 else if( !strcmp( psz_var, "mosaic-keep-aspect-ratio" ) )
660 vlc_mutex_lock( &p_sys->lock );
663 msg_Dbg( p_this, "Keep aspect ratio" );
668 msg_Dbg( p_this, "Don't keep aspect ratio" );
671 vlc_mutex_unlock( &p_sys->lock );