wall.c: handle some rounding error causing a integer overflow. more window
[vlc.git] / modules / video_filter / wall.c
1 /*****************************************************************************
2  * wall.c : Wall video plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000, 2001, 2002, 2003 VideoLAN
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc/vout.h>
32
33 #include "filter_common.h"
34
35 /*****************************************************************************
36  * Local prototypes
37  *****************************************************************************/
38 static int  Create    ( vlc_object_t * );
39 static void Destroy   ( vlc_object_t * );
40
41 static int  Init      ( vout_thread_t * );
42 static void End       ( vout_thread_t * );
43 static void Render    ( vout_thread_t *, picture_t * );
44
45 static void RemoveAllVout  ( vout_thread_t *p_vout );
46
47 static int  SendEvents( vlc_object_t *, char const *,
48                         vlc_value_t, vlc_value_t, void * );
49
50 /*****************************************************************************
51  * Module descriptor
52  *****************************************************************************/
53 #define COLS_TEXT N_("Number of columns")
54 #define COLS_LONGTEXT N_("Select the number of horizontal video windows in " \
55     "which to split the video.")
56
57 #define ROWS_TEXT N_("Number of rows")
58 #define ROWS_LONGTEXT N_("Select the number of vertical video windows in " \
59     "which to split the video.")
60
61 #define ACTIVE_TEXT N_("Active windows")
62 #define ACTIVE_LONGTEXT N_("Comma separated list of active windows, " \
63     "defaults to all")
64
65 vlc_module_begin();
66     set_description( _("wall video filter") );
67     set_shortname( N_("Image wall" ));
68     set_capability( "video filter", 0 );
69     set_category( CAT_VIDEO );
70     set_subcategory( SUBCAT_VIDEO_VFILTER );
71
72     add_integer( "wall-cols", 3, NULL, COLS_TEXT, COLS_LONGTEXT, VLC_FALSE );
73     add_integer( "wall-rows", 3, NULL, ROWS_TEXT, ROWS_LONGTEXT, VLC_FALSE );
74     add_string( "wall-active", NULL, NULL, ACTIVE_TEXT, ACTIVE_LONGTEXT, VLC_FALSE );
75
76     add_shortcut( "wall" );
77     set_callbacks( Create, Destroy );
78 vlc_module_end();
79
80 /*****************************************************************************
81  * vout_sys_t: Wall video output method descriptor
82  *****************************************************************************
83  * This structure is part of the video output thread descriptor.
84  * It describes the Wall specific properties of an output thread.
85  *****************************************************************************/
86 struct vout_sys_t
87 {
88     int    i_col;
89     int    i_row;
90     int    i_vout;
91     struct vout_list_t
92     {
93         vlc_bool_t b_active;
94         int i_width;
95         int i_height;
96         int i_left;
97         int i_top;
98         vout_thread_t *p_vout;
99     } *pp_vout;
100 };
101
102 /*****************************************************************************
103  * Control: control facility for the vout (forwards to child vout)
104  *****************************************************************************/
105 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
106 {
107     int i_row, i_col, i_vout = 0;
108
109     for( i_row = 0; i_row < p_vout->p_sys->i_row; i_row++ )
110     {
111         for( i_col = 0; i_col < p_vout->p_sys->i_col; i_col++ )
112         {
113             vout_vaControl( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
114                             i_query, args );
115             i_vout++;
116         }
117     }
118     return VLC_SUCCESS;
119 }
120
121 /*****************************************************************************
122  * Create: allocates Wall video thread output method
123  *****************************************************************************
124  * This function allocates and initializes a Wall vout method.
125  *****************************************************************************/
126 static int Create( vlc_object_t *p_this )
127 {
128     vout_thread_t *p_vout = (vout_thread_t *)p_this;
129     char *psz_method, *psz_tmp, *psz_method_tmp;
130     int i_vout;
131
132     /* Allocate structure */
133     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
134     if( p_vout->p_sys == NULL )
135     {
136         msg_Err( p_vout, "out of memory" );
137         return VLC_ENOMEM;
138     }
139
140     p_vout->pf_init = Init;
141     p_vout->pf_end = End;
142     p_vout->pf_manage = NULL;
143     p_vout->pf_render = Render;
144     p_vout->pf_display = NULL;
145     p_vout->pf_control = Control;
146
147     /* Look what method was requested */
148     p_vout->p_sys->i_col = config_GetInt( p_vout, "wall-cols" );
149     p_vout->p_sys->i_row = config_GetInt( p_vout, "wall-rows" );
150
151     p_vout->p_sys->i_col = __MAX( 1, __MIN( 15, p_vout->p_sys->i_col ) );
152     p_vout->p_sys->i_row = __MAX( 1, __MIN( 15, p_vout->p_sys->i_row ) );
153
154     msg_Dbg( p_vout, "opening a %i x %i wall",
155              p_vout->p_sys->i_col, p_vout->p_sys->i_row );
156
157     p_vout->p_sys->pp_vout = malloc( p_vout->p_sys->i_row *
158                                      p_vout->p_sys->i_col *
159                                      sizeof(struct vout_list_t) );
160     if( p_vout->p_sys->pp_vout == NULL )
161     {
162         msg_Err( p_vout, "out of memory" );
163         free( p_vout->p_sys );
164         return VLC_ENOMEM;
165     }
166
167     psz_method_tmp = psz_method = config_GetPsz( p_vout, "wall-active" );
168
169     /* If no trailing vout are specified, take them all */
170     if( psz_method == NULL )
171     {
172         for( i_vout = p_vout->p_sys->i_row * p_vout->p_sys->i_col;
173              i_vout--; )
174         {
175             p_vout->p_sys->pp_vout[i_vout].b_active = 1;
176         }
177     }
178     /* If trailing vout are specified, activate only the requested ones */
179     else
180     {
181         for( i_vout = p_vout->p_sys->i_row * p_vout->p_sys->i_col;
182              i_vout--; )
183         {
184             p_vout->p_sys->pp_vout[i_vout].b_active = 0;
185         }
186
187         while( *psz_method )
188         {
189             psz_tmp = psz_method;
190             while( *psz_tmp && *psz_tmp != ',' )
191             {
192                 psz_tmp++;
193             }
194
195             if( *psz_tmp )
196             {
197                 *psz_tmp = '\0';
198                 i_vout = atoi( psz_method );
199                 psz_method = psz_tmp + 1;
200             }
201             else
202             {
203                 i_vout = atoi( psz_method );
204                 psz_method = psz_tmp;
205             }
206
207             if( i_vout >= 0 &&
208                 i_vout < p_vout->p_sys->i_row * p_vout->p_sys->i_col )
209             {
210                 p_vout->p_sys->pp_vout[i_vout].b_active = 1;
211             }
212         }
213     }
214
215     free( psz_method_tmp );
216
217     return VLC_SUCCESS;
218 }
219
220 /*****************************************************************************
221  * Init: initialize Wall video thread output method
222  *****************************************************************************/
223 static int Init( vout_thread_t *p_vout )
224 {
225     int i_index, i_row, i_col, i_width, i_height, i_left, i_top;
226     unsigned int i_target_width,i_target_height;
227     picture_t *p_pic;
228     int i_aspect = 4*VOUT_ASPECT_FACTOR/3;
229     int i_align = 0;
230     unsigned int i_hstart, i_hend, i_vstart, i_vend;
231     unsigned int w1,h1,w2,h2;
232     int i_xpos, i_ypos;
233
234     i_xpos = var_CreateGetInteger( p_vout, "video-x" );
235     i_ypos = var_CreateGetInteger( p_vout, "video-y" );
236     if( i_xpos < 0 ) i_xpos = 0;
237     if( i_ypos < 0 ) i_ypos = 0;
238
239     I_OUTPUTPICTURES = 0;
240
241     /* Initialize the output structure */
242     p_vout->output.i_chroma = p_vout->render.i_chroma;
243     p_vout->output.i_width  = p_vout->render.i_width;
244     p_vout->output.i_height = p_vout->render.i_height;
245     p_vout->output.i_aspect = p_vout->render.i_aspect;
246     var_Create( p_vout, "align", VLC_VAR_INTEGER );
247
248     w1 = p_vout->output.i_width / p_vout->p_sys->i_col;
249     w1 &= ~1;
250     h1 = w1 * VOUT_ASPECT_FACTOR / i_aspect&~1;
251     h1 &= ~1;
252     
253     h2 = p_vout->output.i_height / p_vout->p_sys->i_row&~1;
254     h2 &= ~1;
255     w2 = h2 * i_aspect / VOUT_ASPECT_FACTOR&~1;
256     w2 &= ~1;
257     
258     if ( h1 * p_vout->p_sys->i_row < p_vout->output.i_height )
259     {
260         int i_tmp;
261         i_target_width = w2;        
262         i_target_height = h2;
263         i_vstart = 0;
264         i_vend = p_vout->output.i_height;
265         i_tmp = i_target_width * p_vout->p_sys->i_col;
266         while( i_tmp < p_vout->output.i_width ) i_tmp += p_vout->p_sys->i_col;
267         i_hstart = (( i_tmp - p_vout->output.i_width ) / 2)&~1;
268         i_hend = i_hstart + p_vout->output.i_width;
269     }
270     else
271     {
272         int i_tmp;
273         i_target_height = h1;
274         i_target_width = w1;
275         i_hstart = 0;
276         i_hend = p_vout->output.i_width;
277         i_tmp = i_target_height * p_vout->p_sys->i_row;
278         while( i_tmp < p_vout->output.i_height ) i_tmp += p_vout->p_sys->i_row;
279         i_vstart = ( ( i_tmp - p_vout->output.i_height ) / 2 ) & ~1;
280         i_vend = i_vstart + p_vout->output.i_height;
281     }
282     msg_Dbg( p_vout, "target resolution %dx%d", i_target_width, i_target_height );
283
284     /* Try to open the real video output */
285     msg_Dbg( p_vout, "spawning the real video outputs" );
286
287     p_vout->p_sys->i_vout = 0;
288     msg_Dbg( p_vout, "target window (%d,%d)-(%d,%d)", i_hstart,i_vstart,i_hend,i_vend );
289     
290
291     i_top = 0;
292     i_height = 0;
293     for( i_row = 0; i_row < p_vout->p_sys->i_row; i_row++ )
294     {
295         i_left = 0;
296         i_top += i_height;
297         for( i_col = 0; i_col < p_vout->p_sys->i_col; i_col++ )
298         {
299             i_align = 0;
300
301             if( i_col*i_target_width >= i_hstart &&
302                 (i_col+1)*i_target_width <= i_hend )
303             {
304                 i_width = i_target_width;
305             }
306             else if( ( i_col + 1 ) * i_target_width < i_hstart ||
307                      ( i_col * i_target_width ) > i_hend )
308             {
309                 i_width = 0;                
310             }
311             else
312             {
313                 i_width = i_target_width - i_hstart % i_target_width;
314                 i_align |= i_col > ( p_vout->p_sys->i_col / 2 ) ?
315                     VOUT_ALIGN_LEFT : VOUT_ALIGN_RIGHT;
316             }
317             
318             if( i_row * i_target_height >= i_vstart &&
319                 ( i_row + 1 ) * i_target_height <= i_vend )
320             {
321                 i_height = i_target_height;
322             }
323             else if( ( i_row + 1 ) * i_target_height < i_vstart ||
324                      ( i_row * i_target_height ) > i_vend )
325             {
326                 i_height = 0;
327             }
328             else
329             {
330                 i_height = i_target_height -
331                              i_vstart%i_target_height;
332                 i_align |= i_row > ( p_vout->p_sys->i_row / 2 ) ?
333                     VOUT_ALIGN_TOP : VOUT_ALIGN_BOTTOM;
334             }
335             if( i_height == 0 || i_width == 0 )
336             {
337                 p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].b_active = VLC_FALSE;
338             }
339
340             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].i_width = i_width;
341             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].i_height = i_height;
342             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].i_left = i_left;
343             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].i_top = i_top;
344             i_left += i_width;
345
346             if( !p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].b_active )
347             {
348                 p_vout->p_sys->i_vout++;
349                 continue;
350             }
351             var_SetInteger( p_vout, "align", i_align );
352             var_SetInteger( p_vout, "video-x", i_left + i_xpos - i_width);
353             var_SetInteger( p_vout, "video-y", i_top + i_ypos );
354
355             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout =
356                 vout_Create( p_vout, i_width, i_height,
357                              p_vout->render.i_chroma,
358                              VOUT_ASPECT_FACTOR * i_width / i_height );
359             if( p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout == NULL )
360             {
361                 msg_Err( p_vout, "failed to get %ix%i vout threads",
362                                  p_vout->p_sys->i_col, p_vout->p_sys->i_row );
363                 RemoveAllVout( p_vout );
364                 return VLC_EGENERIC;
365             }
366             ADD_CALLBACKS(
367                 p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout,
368                 SendEvents );
369             p_vout->p_sys->i_vout++;
370         }
371     }
372
373     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
374
375     ADD_PARENT_CALLBACKS( SendEventsToChild );
376
377     return VLC_SUCCESS;
378 }
379
380 /*****************************************************************************
381  * End: terminate Wall video thread output method
382  *****************************************************************************/
383 static void End( vout_thread_t *p_vout )
384 {
385     int i_index;
386
387     /* Free the fake output buffers we allocated */
388     for( i_index = I_OUTPUTPICTURES ; i_index ; )
389     {
390         i_index--;
391         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
392     }
393 }
394
395 /*****************************************************************************
396  * Destroy: destroy Wall video thread output method
397  *****************************************************************************
398  * Terminate an output method created by WallCreateOutputMethod
399  *****************************************************************************/
400 static void Destroy( vlc_object_t *p_this )
401 {
402     vout_thread_t *p_vout = (vout_thread_t *)p_this;
403
404     RemoveAllVout( p_vout );
405
406     DEL_PARENT_CALLBACKS( SendEventsToChild );
407
408     free( p_vout->p_sys->pp_vout );
409     free( p_vout->p_sys );
410 }
411
412 /*****************************************************************************
413  * Render: displays previously rendered output
414  *****************************************************************************
415  * This function send the currently rendered image to Wall image, waits
416  * until it is displayed and switch the two rendering buffers, preparing next
417  * frame.
418  *****************************************************************************/
419 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
420 {
421     picture_t *p_outpic = NULL;
422     int i_col, i_row, i_vout, i_plane;
423     int pi_left_skip[VOUT_MAX_PLANES], pi_top_skip[VOUT_MAX_PLANES];
424
425     i_vout = 0;
426
427     for( i_row = 0; i_row < p_vout->p_sys->i_row; i_row++ )
428     {
429         for( i_col = 0; i_col < p_vout->p_sys->i_col; i_col++ )
430         {
431             for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
432             {
433                 pi_left_skip[i_plane] = p_vout->p_sys->pp_vout[ i_vout ].i_left * p_pic->p[ i_plane ].i_pitch / p_vout->output.i_width;
434                 pi_top_skip[i_plane] = (p_vout->p_sys->pp_vout[ i_vout ].i_top * p_pic->p[ i_plane ].i_lines / p_vout->output.i_height)*p_pic->p[i_plane].i_pitch;
435             }
436
437             if( !p_vout->p_sys->pp_vout[ i_vout ].b_active )
438             {
439                 i_vout++;
440                 continue;
441             }
442
443             while( ( p_outpic =
444                 vout_CreatePicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
445                                     0, 0, 0 )
446                    ) == NULL )
447             {
448                 if( p_vout->b_die || p_vout->b_error )
449                 {
450                     vout_DestroyPicture(
451                         p_vout->p_sys->pp_vout[ i_vout ].p_vout, p_outpic );
452                     return;
453                 }
454
455                 msleep( VOUT_OUTMEM_SLEEP );
456             }
457
458             vout_DatePicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
459                               p_outpic, p_pic->date );
460             vout_LinkPicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
461                               p_outpic );
462
463             for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
464             {
465                 uint8_t *p_in, *p_in_end, *p_out;
466                 int i_in_pitch = p_pic->p[i_plane].i_pitch;
467                 int i_out_pitch = p_outpic->p[i_plane].i_pitch;
468                 int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
469
470                 p_in = p_pic->p[i_plane].p_pixels
471                         + pi_top_skip[i_plane] + pi_left_skip[i_plane];
472
473                 p_in_end = p_in + p_outpic->p[i_plane].i_visible_lines
474                                    * p_pic->p[i_plane].i_pitch;
475
476                 p_out = p_outpic->p[i_plane].p_pixels;
477
478                 while( p_in < p_in_end )
479                 {
480                     p_vout->p_vlc->pf_memcpy( p_out, p_in, i_copy_pitch );
481                     p_in += i_in_pitch;
482                     p_out += i_out_pitch;
483                 }
484
485 //                pi_left_skip[i_plane] += i_copy_pitch;
486             }
487
488             vout_UnlinkPicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
489                                 p_outpic );
490             vout_DisplayPicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
491                                  p_outpic );
492
493             i_vout++;
494         }
495
496 /*         for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ ) */
497 /*         { */
498 /*             pi_top_skip[i_plane] += p_vout->p_sys->pp_vout[ i_vout ].i_height */
499 /*                                      * p_pic->p[i_plane].i_visible_lines */
500 /*                                      / p_vout->output.i_height */
501 /*                                      * p_pic->p[i_plane].i_pitch; */
502 /*         } */
503     }
504 }
505
506 /*****************************************************************************
507  * RemoveAllVout: destroy all the child video output threads
508  *****************************************************************************/
509 static void RemoveAllVout( vout_thread_t *p_vout )
510 {
511     while( p_vout->p_sys->i_vout )
512     {
513          --p_vout->p_sys->i_vout;
514          if( p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].b_active )
515          {
516              DEL_CALLBACKS(
517                  p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout,
518                  SendEvents );
519              vlc_object_detach(
520                  p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout );
521              vout_Destroy(
522                  p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout );
523          }
524     }
525 }
526
527 /*****************************************************************************
528  * SendEvents: forward mouse and keyboard events to the parent p_vout
529  *****************************************************************************/
530 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
531                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
532 {
533     vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
534     int i_vout;
535     vlc_value_t sentval = newval;
536
537     /* Find the video output index */
538     for( i_vout = 0; i_vout < p_vout->p_sys->i_vout; i_vout++ )
539     {
540         if( p_this == (vlc_object_t *)p_vout->p_sys->pp_vout[ i_vout ].p_vout )
541         {
542             break;
543         }
544     }
545
546     if( i_vout == p_vout->p_sys->i_vout )
547     {
548         return VLC_EGENERIC;
549     }
550
551     /* Translate the mouse coordinates */
552     if( !strcmp( psz_var, "mouse-x" ) )
553     {
554         sentval.i_int += p_vout->output.i_width
555                           * (i_vout % p_vout->p_sys->i_col)
556                           / p_vout->p_sys->i_col;
557     }
558     else if( !strcmp( psz_var, "mouse-y" ) )
559     {
560         sentval.i_int += p_vout->output.i_height
561                           * (i_vout / p_vout->p_sys->i_row)
562                           / p_vout->p_sys->i_row;
563     }
564
565     var_Set( p_vout, psz_var, sentval );
566
567     return VLC_SUCCESS;
568 }
569
570 /*****************************************************************************
571  * SendEventsToChild: forward events to the child/children vout
572  *****************************************************************************/
573 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
574                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
575 {
576     vout_thread_t *p_vout = (vout_thread_t *)p_this;
577     int i_row, i_col, i_vout = 0;
578
579     for( i_row = 0; i_row < p_vout->p_sys->i_row; i_row++ )
580     {
581         for( i_col = 0; i_col < p_vout->p_sys->i_col; i_col++ )
582         {
583             var_Set( p_vout->p_sys->pp_vout[ i_vout ].p_vout, psz_var, newval);
584             if( !strcmp( psz_var, "fullscreen" ) ) break;
585             i_vout++;
586         }
587     }
588
589     return VLC_SUCCESS;
590 }