* modules/*: sanitization of the modules description strings.
[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: wall.c,v 1.9 2003/03/30 18:14:38 gbazin Exp $
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 videowindows 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 videowindows 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     add_category_hint( N_("Miscellaneous"), NULL, VLC_FALSE );
67     add_integer( "wall-cols", 3, NULL, COLS_TEXT, COLS_LONGTEXT, VLC_FALSE );
68     add_integer( "wall-rows", 3, NULL, ROWS_TEXT, ROWS_LONGTEXT, VLC_FALSE );
69     add_string( "wall-active", NULL, NULL, ACTIVE_TEXT, ACTIVE_LONGTEXT, VLC_FALSE );
70     set_description( _("wall video filter") );
71     set_capability( "video filter", 0 );
72     add_shortcut( "wall" );
73     set_callbacks( Create, Destroy );
74 vlc_module_end();
75
76 /*****************************************************************************
77  * vout_sys_t: Wall video output method descriptor
78  *****************************************************************************
79  * This structure is part of the video output thread descriptor.
80  * It describes the Wall specific properties of an output thread.
81  *****************************************************************************/
82 struct vout_sys_t
83 {
84     int    i_col;
85     int    i_row;
86     int    i_vout;
87     struct vout_list_t
88     {
89         vlc_bool_t b_active;
90         int i_width;
91         int i_height;
92         vout_thread_t *p_vout;
93     } *pp_vout;
94 };
95
96 /*****************************************************************************
97  * Create: allocates Wall video thread output method
98  *****************************************************************************
99  * This function allocates and initializes a Wall vout method.
100  *****************************************************************************/
101 static int Create( vlc_object_t *p_this )
102 {
103     vout_thread_t *p_vout = (vout_thread_t *)p_this;
104     char *psz_method, *psz_tmp, *psz_method_tmp;
105     int i_vout;
106
107     /* Allocate structure */
108     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
109     if( p_vout->p_sys == NULL )
110     {
111         msg_Err( p_vout, "out of memory" );
112         return VLC_ENOMEM;
113     }
114
115     p_vout->pf_init = Init;
116     p_vout->pf_end = End;
117     p_vout->pf_manage = NULL;
118     p_vout->pf_render = Render;
119     p_vout->pf_display = NULL;
120
121     /* Look what method was requested */
122     p_vout->p_sys->i_col = config_GetInt( p_vout, "wall-cols" );
123     p_vout->p_sys->i_row = config_GetInt( p_vout, "wall-rows" );
124
125     p_vout->p_sys->i_col = __MAX( 1, __MIN( 15, p_vout->p_sys->i_col ) );
126     p_vout->p_sys->i_row = __MAX( 1, __MIN( 15, p_vout->p_sys->i_row ) );
127
128     msg_Dbg( p_vout, "opening a %i x %i wall",
129              p_vout->p_sys->i_col, p_vout->p_sys->i_row );
130
131     p_vout->p_sys->pp_vout = malloc( p_vout->p_sys->i_row *
132                                      p_vout->p_sys->i_col *
133                                      sizeof(struct vout_list_t) );
134     if( p_vout->p_sys->pp_vout == NULL )
135     {
136         msg_Err( p_vout, "out of memory" );
137         free( p_vout->p_sys );
138         return VLC_ENOMEM;
139     }
140
141     psz_method_tmp = psz_method = config_GetPsz( p_vout, "wall-active" );
142
143     /* If no trailing vout are specified, take them all */
144     if( psz_method == NULL )
145     {
146         for( i_vout = p_vout->p_sys->i_row * p_vout->p_sys->i_col;
147              i_vout--; )
148         {
149             p_vout->p_sys->pp_vout[i_vout].b_active = 1;
150         }
151     }
152     /* If trailing vout are specified, activate only the requested ones */
153     else
154     {
155         for( i_vout = p_vout->p_sys->i_row * p_vout->p_sys->i_col;
156              i_vout--; )
157         {
158             p_vout->p_sys->pp_vout[i_vout].b_active = 0;
159         }
160
161         while( *psz_method )
162         {
163             psz_tmp = psz_method;
164             while( *psz_tmp && *psz_tmp != ',' )
165             {
166                 psz_tmp++;
167             }
168
169             if( *psz_tmp )
170             {
171                 *psz_tmp = '\0';
172                 i_vout = atoi( psz_method );
173                 psz_method = psz_tmp + 1;
174             }
175             else
176             {
177                 i_vout = atoi( psz_method );
178                 psz_method = psz_tmp;
179             }
180
181             if( i_vout >= 0 &&
182                 i_vout < p_vout->p_sys->i_row * p_vout->p_sys->i_col )
183             {
184                 p_vout->p_sys->pp_vout[i_vout].b_active = 1;
185             }
186         }
187     }
188
189     free( psz_method_tmp );
190
191     return VLC_SUCCESS;
192 }
193
194 /*****************************************************************************
195  * Init: initialize Wall video thread output method
196  *****************************************************************************/
197 static int Init( vout_thread_t *p_vout )
198 {
199     int i_index, i_row, i_col, i_width, i_height;
200     picture_t *p_pic;
201
202     I_OUTPUTPICTURES = 0;
203
204     /* Initialize the output structure */
205     p_vout->output.i_chroma = p_vout->render.i_chroma;
206     p_vout->output.i_width  = p_vout->render.i_width;
207     p_vout->output.i_height = p_vout->render.i_height;
208     p_vout->output.i_aspect = p_vout->render.i_aspect;
209
210     /* Try to open the real video output */
211     msg_Dbg( p_vout, "spawning the real video outputs" );
212
213     p_vout->p_sys->i_vout = 0;
214
215     /* FIXME: use bresenham instead of those ugly divisions */
216     for( i_row = 0; i_row < p_vout->p_sys->i_row; i_row++ )
217     {
218         for( i_col = 0; i_col < p_vout->p_sys->i_col; i_col++ )
219         {
220             if( i_col + 1 < p_vout->p_sys->i_col )
221             {
222                 i_width = ( p_vout->render.i_width
223                              / p_vout->p_sys->i_col ) & ~0x1;
224             }
225             else
226             {
227                 i_width = p_vout->render.i_width
228                            - ( ( p_vout->render.i_width
229                                   / p_vout->p_sys->i_col ) & ~0x1 ) * i_col;
230             }
231
232             if( i_row + 1 < p_vout->p_sys->i_row )
233             {
234                 i_height = ( p_vout->render.i_height
235                               / p_vout->p_sys->i_row ) & ~0x3;
236             }
237             else
238             {
239                 i_height = p_vout->render.i_height
240                             - ( ( p_vout->render.i_height
241                                    / p_vout->p_sys->i_row ) & ~0x3 ) * i_row;
242             }
243
244             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].i_width = i_width;
245             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].i_height = i_height;
246
247             if( !p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].b_active )
248             {
249                 p_vout->p_sys->i_vout++;
250                 continue;
251             }
252
253             p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout =
254                 vout_Create( p_vout, i_width, i_height,
255                              p_vout->render.i_chroma,
256                              p_vout->render.i_aspect
257                               * p_vout->render.i_height / i_height
258                               * i_width / p_vout->render.i_width );
259             if( p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout == NULL )
260             {
261                 msg_Err( p_vout, "failed to get %ix%i vout threads",
262                                  p_vout->p_sys->i_col, p_vout->p_sys->i_row );
263                 RemoveAllVout( p_vout );
264                 return VLC_EGENERIC;
265             }
266             ADD_CALLBACKS(
267                 p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout,
268                 SendEvents );
269
270             p_vout->p_sys->i_vout++;
271         }
272     }
273
274     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
275
276     return VLC_SUCCESS;
277 }
278
279 /*****************************************************************************
280  * End: terminate Wall video thread output method
281  *****************************************************************************/
282 static void End( vout_thread_t *p_vout )
283 {
284     int i_index;
285
286     /* Free the fake output buffers we allocated */
287     for( i_index = I_OUTPUTPICTURES ; i_index ; )
288     {
289         i_index--;
290         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
291     }
292 }
293
294 /*****************************************************************************
295  * Destroy: destroy Wall video thread output method
296  *****************************************************************************
297  * Terminate an output method created by WallCreateOutputMethod
298  *****************************************************************************/
299 static void Destroy( vlc_object_t *p_this )
300 {
301     vout_thread_t *p_vout = (vout_thread_t *)p_this;
302
303     RemoveAllVout( p_vout );
304
305     free( p_vout->p_sys->pp_vout );
306     free( p_vout->p_sys );
307 }
308
309 /*****************************************************************************
310  * Render: displays previously rendered output
311  *****************************************************************************
312  * This function send the currently rendered image to Wall image, waits
313  * until it is displayed and switch the two rendering buffers, preparing next
314  * frame.
315  *****************************************************************************/
316 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
317 {
318     picture_t *p_outpic = NULL;
319     int i_col, i_row, i_vout, i_plane;
320     int pi_left_skip[VOUT_MAX_PLANES], pi_top_skip[VOUT_MAX_PLANES];
321
322     i_vout = 0;
323
324     for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
325     {
326         pi_top_skip[i_plane] = 0;
327     }
328
329     for( i_row = 0; i_row < p_vout->p_sys->i_row; i_row++ )
330     {
331         for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
332         {
333             pi_left_skip[i_plane] = 0;
334         }
335
336         for( i_col = 0; i_col < p_vout->p_sys->i_col; i_col++ )
337         {
338             if( !p_vout->p_sys->pp_vout[ i_vout ].b_active )
339             {
340                 for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
341                 {
342                     pi_left_skip[i_plane] +=
343                         p_vout->p_sys->pp_vout[ i_vout ].i_width
344                          * p_pic->p[i_plane].i_pitch / p_vout->output.i_width;
345                 }
346                 i_vout++;
347                 continue;
348             }
349
350             while( ( p_outpic =
351                 vout_CreatePicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
352                                     0, 0, 0 )
353                    ) == NULL )
354             {
355                 if( p_vout->b_die || p_vout->b_error )
356                 {
357                     vout_DestroyPicture(
358                         p_vout->p_sys->pp_vout[ i_vout ].p_vout, p_outpic );
359                     return;
360                 }
361
362                 msleep( VOUT_OUTMEM_SLEEP );
363             }
364
365             vout_DatePicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
366                               p_outpic, p_pic->date );
367             vout_LinkPicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
368                               p_outpic );
369
370             for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
371             {
372                 uint8_t *p_in, *p_in_end, *p_out;
373                 int i_in_pitch = p_pic->p[i_plane].i_pitch;
374                 int i_out_pitch = p_outpic->p[i_plane].i_pitch;
375                 int i_copy_pitch = p_outpic->p[i_plane].i_visible_pitch;
376
377                 p_in = p_pic->p[i_plane].p_pixels
378                         + pi_top_skip[i_plane] + pi_left_skip[i_plane];
379
380                 p_in_end = p_in + p_outpic->p[i_plane].i_lines
381                                    * p_pic->p[i_plane].i_pitch;
382
383                 p_out = p_outpic->p[i_plane].p_pixels;
384
385                 while( p_in < p_in_end )
386                 {
387                     p_vout->p_vlc->pf_memcpy( p_out, p_in, i_copy_pitch );
388                     p_in += i_in_pitch;
389                     p_out += i_out_pitch;
390                 }
391
392                 pi_left_skip[i_plane] += i_out_pitch;
393             }
394
395             vout_UnlinkPicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
396                                 p_outpic );
397             vout_DisplayPicture( p_vout->p_sys->pp_vout[ i_vout ].p_vout,
398                                  p_outpic );
399
400             i_vout++;
401         }
402
403         for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
404         {
405             pi_top_skip[i_plane] += p_vout->p_sys->pp_vout[ i_vout ].i_height
406                                      * p_pic->p[i_plane].i_lines
407                                      / p_vout->output.i_height
408                                      * p_pic->p[i_plane].i_pitch;
409         }
410     }
411 }
412
413 /*****************************************************************************
414  * RemoveAllVout: destroy all the child video output threads
415  *****************************************************************************/
416 static void RemoveAllVout( vout_thread_t *p_vout )
417 {
418     while( p_vout->p_sys->i_vout )
419     {
420          --p_vout->p_sys->i_vout;
421          if( p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].b_active )
422          {
423              DEL_CALLBACKS(
424                  p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout,
425                  SendEvents );
426              vlc_object_detach(
427                  p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout );
428              vout_Destroy(
429                  p_vout->p_sys->pp_vout[ p_vout->p_sys->i_vout ].p_vout );
430          }
431     }
432 }
433
434 /*****************************************************************************
435  * SendEvents: forward mouse and keyboard events to the parent p_vout
436  *****************************************************************************/
437 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
438                        vlc_value_t oldval, vlc_value_t newval, void *_p_vout )
439 {
440     vout_thread_t *p_vout = (vout_thread_t *)_p_vout;
441     int i_vout;
442     vlc_value_t sentval = newval;
443
444     /* Find the video output index */
445     for( i_vout = 0; i_vout < p_vout->p_sys->i_vout; i_vout++ )
446     {
447         if( p_this == (vlc_object_t *)p_vout->p_sys->pp_vout[ i_vout ].p_vout )
448         {
449             break;
450         }
451     }
452
453     if( i_vout == p_vout->p_sys->i_vout )
454     {
455         return VLC_EGENERIC;
456     }
457
458     /* Translate the mouse coordinates */
459     if( !strcmp( psz_var, "mouse-x" ) )
460     {
461         sentval.i_int += p_vout->output.i_width
462                           * (i_vout % p_vout->p_sys->i_col)
463                           / p_vout->p_sys->i_col;
464     }
465     else if( !strcmp( psz_var, "mouse-y" ) )
466     {
467         sentval.i_int += p_vout->output.i_height
468                           * (i_vout / p_vout->p_sys->i_row)
469                           / p_vout->p_sys->i_row;
470     }
471
472     var_Set( p_vout, psz_var, sentval );
473
474     return VLC_SUCCESS;
475 }
476