video_filter: fix warnings
[vlc.git] / modules / video_filter / osdmenu.c
1 /*****************************************************************************
2  * osdmenu.c: osd filter module
3  *****************************************************************************
4  * Copyright (C) 2004-2007 M2X
5  * $Id$
6  *
7  * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
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 implid 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc/vlc.h>
32 #include <vlc_vout.h>
33 #include <vlc_filter.h>
34
35 #include <vlc_osd.h>
36
37 /*****************************************************************************
38  * Module descriptor
39  *****************************************************************************/
40
41 /* FIXME: Future extension make the definition file in XML format. */
42 #define OSD_FILE_TEXT N_("Configuration file")
43 #define OSD_FILE_LONGTEXT N_( \
44     "Configuration file for the OSD Menu." )
45 #define OSD_PATH_TEXT N_("Path to OSD menu images")
46 #define OSD_PATH_LONGTEXT N_( \
47     "Path to the OSD menu images. This will override the path defined in the " \
48     "OSD configuration file." )
49
50 #define POSX_TEXT N_("X coordinate")
51 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
52
53 #define POSY_TEXT N_("Y coordinate")
54 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
55
56 #define POS_TEXT N_("Menu position")
57 #define POS_LONGTEXT N_( \
58   "You can enforce the OSD menu position on the video " \
59   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
60   "also use combinations of these values, eg. 6 = top-right).")
61
62 #define TIMEOUT_TEXT N_("Menu timeout")
63 #define TIMEOUT_LONGTEXT N_( \
64     "OSD menu pictures get a default timeout of 15 seconds added to their " \
65     "remaining time. This will ensure that they are at least the specified " \
66     "time visible.")
67
68 #define OSD_UPDATE_TEXT N_("Menu update interval" )
69 #define OSD_UPDATE_LONGTEXT N_( \
70     "The default is to update the OSD menu picture every 200 ms. Shorten the" \
71     " update time for environments that experience transmissions errors. " \
72     "Be careful with this option as encoding OSD menu pictures is very " \
73     "computing intensive. The range is 0 - 1000 ms." )
74
75 #define OSD_ALPHA_TEXT N_("Alpha transparency value (default 255)")
76 #define OSD_ALPHA_LONGTEXT N_( \
77     "The transparency of the OSD menu can be changed by giving a value " \
78     "between 0 and 255. A lower value specifies more transparency a higher " \
79     "means less transparency. The default is being not transparent " \
80     "(value 255) the minimum is fully transparent (value 0)." )
81
82 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
83 static const char *ppsz_pos_descriptions[] =
84 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
85   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
86
87 /* subfilter functions */
88 static int  CreateFilter ( vlc_object_t * );
89 static void DestroyFilter( vlc_object_t * );
90 static subpicture_t *Filter( filter_t *, mtime_t );
91
92 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
93                     vlc_value_t, vlc_value_t, void * );
94 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
95                     vlc_value_t, vlc_value_t, void * );
96 static int OSDMenuCallback( vlc_object_t *, char const *,
97                             vlc_value_t, vlc_value_t, void * );
98
99 static int MouseEvent( vlc_object_t *, char const *,
100                         vlc_value_t , vlc_value_t , void * );
101
102 #define OSD_CFG "osdmenu-"
103
104 #if defined( WIN32 ) || defined( UNDER_CE )
105 #define OSD_DEFAULT_CFG "osdmenu/default.cfg"
106 #else
107 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
108 #endif
109
110 #define OSD_UPDATE_MIN     0
111 #define OSD_UPDATE_DEFAULT 300
112 #define OSD_UPDATE_MAX     1000
113
114 vlc_module_begin();
115     add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
116     add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
117     add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT,
118                  VLC_FALSE );
119         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
120     add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
121         OSD_FILE_LONGTEXT, VLC_FALSE );
122     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
123         OSD_PATH_LONGTEXT, VLC_FALSE );
124     add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
125         TIMEOUT_LONGTEXT, VLC_FALSE );
126     add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
127         OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
128         OSD_UPDATE_LONGTEXT, VLC_TRUE );
129     add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
130         OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, VLC_TRUE );
131
132     set_capability( "sub filter", 100 );
133     set_description( _("On Screen Display menu") );
134     set_shortname( _("OSD menu") );
135     add_shortcut( "osdmenu" );
136
137     set_category( CAT_VIDEO );
138     set_subcategory( SUBCAT_VIDEO_SUBPIC );
139
140     set_callbacks( CreateFilter, DestroyFilter );
141 vlc_module_end();
142
143 /*****************************************************************************
144  * Sub filter code
145  *****************************************************************************/
146
147 /*****************************************************************************
148  * Local prototypes
149  *****************************************************************************/
150 struct filter_sys_t
151 {
152     int          i_position;    /* relative positioning of SPU images */
153     int          i_x;           /* absolute positioning of SPU images */
154     int          i_y;           /* absolute positioning of SPU images */
155     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
156     mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
157
158     vlc_bool_t   b_absolute;    /* do we use absolute positioning or relative? */
159     vlc_bool_t   b_update;      /* Update OSD Menu by sending SPU objects */
160     vlc_bool_t   b_visible;     /* OSD Menu is visible */
161     mtime_t      i_update;      /* Update the OSD menu every n ms */
162     mtime_t      i_end_date;    /* End data of display OSD menu */
163     int          i_alpha;       /* alpha transparency value */
164
165     char        *psz_file;      /* OSD Menu configuration file */
166     char        *psz_path;      /* Path to OSD Menu pictures */
167     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
168
169     /* menu interaction */
170     vout_thread_t *p_vout;
171     vlc_bool_t  b_clicked;
172     uint32_t    i_mouse_x;
173     uint32_t    i_mouse_y;
174 };
175
176 /*****************************************************************************
177  * CreateFilter: Create the filter and open the definition file
178  *****************************************************************************/
179 static int CreateFilter ( vlc_object_t *p_this )
180 {
181     filter_t *p_filter = (filter_t *)p_this;
182     filter_sys_t *p_sys = NULL;
183
184     p_filter->p_sys = p_sys = (filter_sys_t *) malloc( sizeof(filter_sys_t) );
185     if( !p_filter->p_sys )
186     {
187         msg_Err( p_filter, "out of memory" );
188         return VLC_ENOMEM;
189     }
190     memset( p_sys, 0, sizeof(filter_sys_t) );
191
192     /* Populating struct */
193     p_sys->psz_path = var_CreateGetString( p_this, OSD_CFG "file-path" );
194     p_sys->psz_file = var_CreateGetString( p_this, OSD_CFG "file" );
195     if( (p_sys->psz_file == NULL) ||
196         (*p_sys->psz_file == '\0') )
197     {
198         msg_Err( p_filter, "unable to get filename" );
199         goto error;
200     }
201
202     p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
203     p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
204     p_sys->i_position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
205     p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, OSD_CFG "alpha" );
206
207     /* in micro seconds - divide by 2 to match user expectations */
208     p_sys->i_timeout = var_CreateGetIntegerCommand( p_this, OSD_CFG "timeout" );
209     p_sys->i_timeout = (mtime_t)(p_sys->i_timeout * 1000000) >> 2;
210     p_sys->i_update  = var_CreateGetIntegerCommand( p_this, OSD_CFG "update" );
211     p_sys->i_update = (mtime_t)(p_sys->i_update * 1000); /* in micro seconds */
212
213     var_AddCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
214     var_AddCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
215     var_AddCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
216     var_AddCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
217
218     /* Load the osd menu subsystem */
219     p_sys->p_menu = osd_MenuCreate( p_this, p_sys->psz_file );
220     if( p_sys->p_menu == NULL )
221         goto error;
222
223     p_sys->p_menu->i_position = p_sys->i_position;
224
225     /* Check if menu position was overridden */
226     p_sys->b_absolute = VLC_TRUE;
227     if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
228     {
229         p_sys->b_absolute = VLC_FALSE;
230         p_sys->p_menu->i_x = 0;
231         p_sys->p_menu->i_y = 0;
232     }
233     else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
234     {
235         p_sys->p_menu->i_x = p_sys->i_x;
236         p_sys->p_menu->i_y = p_sys->i_y;
237     }
238     else if( (p_sys->p_menu->i_x < 0) ||
239              (p_sys->p_menu->i_y < 0) )
240     {
241         p_sys->b_absolute = VLC_FALSE;
242         p_sys->p_menu->i_x = 0;
243         p_sys->p_menu->i_y = 0;
244     }
245
246     /* Set up p_filter */
247     p_sys->i_last_date = mdate();
248
249     /* Keep track of OSD Events */
250     p_sys->b_update  = VLC_FALSE;
251     p_sys->b_visible = VLC_FALSE;
252     p_sys->b_clicked = VLC_FALSE;
253
254     /* Listen to osd menu core updates/visible settings. */
255     var_AddCallback( p_sys->p_menu, "osd-menu-update",
256                      OSDMenuUpdateEvent, p_filter );
257     var_AddCallback( p_sys->p_menu, "osd-menu-visible",
258                      OSDMenuVisibleEvent, p_filter );
259
260     /* Attach subpicture filter callback */
261     p_filter->pf_sub_filter = Filter;
262
263     p_sys->p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_ANYWHERE );
264     if( p_sys->p_vout )
265     {
266         var_AddCallback( p_sys->p_vout, "mouse-x",
267                         MouseEvent, p_sys );
268         var_AddCallback( p_sys->p_vout, "mouse-y",
269                         MouseEvent, p_sys );
270         var_AddCallback( p_sys->p_vout, "mouse-clicked",
271                         MouseEvent, p_sys );
272     }
273
274     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
275     p_filter->fmt_out.i_priority = 0;
276
277     return VLC_SUCCESS;
278
279 error:
280     msg_Err( p_filter, "osdmenu filter discarded" );
281
282     osd_MenuDelete( p_this, p_sys->p_menu );
283     p_sys->p_menu = NULL;
284     if( p_sys->psz_file ) free( p_sys->psz_file );
285     if( p_sys ) free( p_sys );
286     return VLC_EGENERIC;
287 }
288
289 /*****************************************************************************
290  * DestroyFilter: Make a clean exit of this plugin
291  *****************************************************************************/
292 static void DestroyFilter( vlc_object_t *p_this )
293 {
294     filter_t     *p_filter = (filter_t*)p_this;
295     filter_sys_t *p_sys = p_filter->p_sys;
296
297     var_DelCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
298     var_DelCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
299     var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
300     var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
301
302     var_DelCallback( p_sys->p_menu, "osd-menu-update",
303                      OSDMenuUpdateEvent, p_filter );
304     var_DelCallback( p_sys->p_menu, "osd-menu-visible",
305                      OSDMenuVisibleEvent, p_filter );
306
307     if( p_sys->p_vout )
308     {
309         var_DelCallback( p_sys->p_vout, "mouse-x",
310                         MouseEvent, p_sys );
311         var_DelCallback( p_sys->p_vout, "mouse-y",
312                         MouseEvent, p_sys );
313         var_DelCallback( p_sys->p_vout, "mouse-clicked",
314                         MouseEvent, p_sys );
315
316         vlc_object_release( p_sys->p_vout );
317         p_sys->p_vout = NULL;
318     }
319
320     var_Destroy( p_this, OSD_CFG "file-path" );
321     var_Destroy( p_this, OSD_CFG "file" );
322     var_Destroy( p_this, OSD_CFG "x" );
323     var_Destroy( p_this, OSD_CFG "y" );
324     var_Destroy( p_this, OSD_CFG "position" );
325     var_Destroy( p_this, OSD_CFG "timeout" );
326     var_Destroy( p_this, OSD_CFG "update" );
327     var_Destroy( p_this, OSD_CFG "alpha" );
328
329     osd_MenuDelete( p_filter, p_sys->p_menu );
330
331     if( p_sys->psz_file ) free( p_sys->psz_file );
332     if( p_sys ) free( p_sys );
333 }
334
335 /*****************************************************************************
336  * OSDMenuEvent: callback for OSD Menu events
337  *****************************************************************************/
338 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
339                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
340 {
341     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
342     VLC_UNUSED(newval);
343     filter_t *p_filter = (filter_t *) p_data;
344
345     p_filter->p_sys->b_visible = VLC_TRUE;
346     p_filter->p_sys->b_update = VLC_TRUE;
347     return VLC_SUCCESS;
348 }
349
350 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
351                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
352 {
353     VLC_UNUSED(p_this); VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
354     VLC_UNUSED(newval);
355     filter_t *p_filter = (filter_t *) p_data;
356     filter_sys_t *p_sys = p_filter->p_sys;
357
358     p_sys->b_update = p_sys->b_visible ? VLC_TRUE : VLC_FALSE;
359     p_sys->i_end_date = (mtime_t) 0;
360     return VLC_SUCCESS;
361 }
362
363 #if 0
364 /*****************************************************************************
365  * create_text_region : compose a text region SPU
366  *****************************************************************************/
367 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
368     int i_width, int i_height, const char *psz_text )
369 {
370     subpicture_region_t *p_region;
371     video_format_t       fmt;
372
373     /* Create new SPU region */
374     memset( &fmt, 0, sizeof(video_format_t) );
375     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
376     fmt.i_aspect = VOUT_ASPECT_FACTOR;
377     fmt.i_sar_num = fmt.i_sar_den = 1;
378     fmt.i_width = fmt.i_visible_width = i_width;
379     fmt.i_height = fmt.i_visible_height = i_height;
380     fmt.i_x_offset = fmt.i_y_offset = 0;
381     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
382     if( !p_region )
383     {
384         msg_Err( p_filter, "cannot allocate another SPU region" );
385         return NULL;
386     }
387     p_region->psz_text = strdup( psz_text );
388     p_region->i_x = 0;
389     p_region->i_y = 40;
390 #if 0
391     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
392         p_region->i_x, p_region->i_y,
393         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
394 #endif
395     return p_region;
396 }
397 #endif
398
399 /*****************************************************************************
400  * create_picture_region : compose a picture region SPU
401  *****************************************************************************/
402 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
403     int i_width, int i_height, picture_t *p_pic )
404 {
405     subpicture_region_t *p_region = NULL;
406     video_format_t       fmt;
407
408     if( !p_spu ) return NULL;
409
410     /* Create new SPU region */
411     memset( &fmt, 0, sizeof(video_format_t) );
412     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
413     fmt.i_aspect = VOUT_ASPECT_FACTOR;
414     fmt.i_sar_num = fmt.i_sar_den = 1;
415     fmt.i_width = fmt.i_visible_width = i_width;
416     fmt.i_height = fmt.i_visible_height = i_height;
417     fmt.i_x_offset = fmt.i_y_offset = 0;
418
419     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
420     if( !p_region )
421     {
422         msg_Err( p_filter, "cannot allocate SPU region" );
423         p_filter->pf_sub_buffer_del( p_filter, p_spu );
424         return NULL;
425     }
426     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
427     {
428         p_region->fmt.p_palette->i_entries = 0;
429         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
430         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
431     }
432     if( p_pic )
433         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
434
435     p_region->i_x = 0;
436     p_region->i_y = 0;
437     p_region->i_align = p_filter->p_sys->i_position;
438 #if 0
439     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
440         p_region->i_x, p_region->i_y,
441         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
442 #endif
443     return p_region;
444 }
445
446 /****************************************************************************
447  * Filter: the whole thing
448  ****************************************************************************
449  * This function outputs subpictures at regular time intervals.
450  ****************************************************************************/
451 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
452 {
453     filter_sys_t *p_sys = p_filter->p_sys;
454     subpicture_t *p_spu = NULL;
455     subpicture_region_t *p_region = NULL;
456
457     if( !p_sys->b_update || (p_sys->i_update <= 0) )
458             return NULL;
459
460     /* Am I too early?
461     */
462     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
463         ( p_sys->i_end_date > 0 ) )
464         return NULL; /* we are too early, so wait */
465
466     /* Allocate the subpicture internal data. */
467     p_spu = p_filter->pf_sub_buffer_new( p_filter );
468     if( !p_spu ) return NULL;
469
470     p_spu->b_ephemer = VLC_TRUE;
471     p_spu->b_fade = VLC_TRUE;
472     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
473         p_spu->b_absolute = VLC_TRUE;
474     else
475         p_spu->b_absolute = p_sys->b_absolute;
476     p_spu->i_flags = p_sys->i_position;
477
478     /* Determine the duration of the subpicture */
479     if( p_sys->i_end_date > 0 )
480     {
481         /* Display the subpicture again. */
482         p_spu->i_stop = p_sys->i_end_date - i_date;
483         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
484             p_sys->b_update = VLC_FALSE;
485     }
486     else
487     {
488         /* There is a new OSD picture to display */
489         p_spu->i_stop = i_date + p_sys->i_timeout;
490         p_sys->i_end_date = p_spu->i_stop;
491     }
492
493     p_sys->i_last_date = i_date;
494     p_spu->i_start = p_sys->i_last_date = i_date;
495
496     /* Send an empty subpicture to clear the display
497      * when OSD menu should be hidden and menu picture is not allocated.
498      */
499     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
500         ( p_filter->p_sys->b_visible == VLC_FALSE ) )
501     {
502         /* Create new spu regions and allocate an empty picture in it. */
503         p_region = create_picture_region( p_filter, p_spu,
504             p_filter->p_sys->p_menu->p_state->i_width,
505             p_filter->p_sys->p_menu->p_state->i_height,
506             NULL );
507
508         /* proper positioning of OSD menu image */
509         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
510         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
511         p_spu->p_region = p_region;
512         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
513         return p_spu;
514     }
515
516     if( p_sys->p_vout && p_sys->b_clicked )
517     {
518         p_sys->b_clicked = VLC_FALSE;
519         osd_MenuActivate( p_filter );
520     }
521     /* Create new spu regions
522     */
523     p_region = create_picture_region( p_filter, p_spu,
524         p_filter->p_sys->p_menu->p_state->i_width,
525         p_filter->p_sys->p_menu->p_state->i_height,
526         p_filter->p_sys->p_menu->p_state->p_pic );
527
528     if( !p_region )
529     {
530         p_filter->pf_sub_buffer_del( p_filter, p_spu );
531         return NULL;
532     }
533
534     p_spu->i_width = p_region->fmt.i_visible_width;
535     p_spu->i_height = p_region->fmt.i_visible_height;
536     p_spu->i_alpha = p_filter->p_sys->i_alpha;
537
538     /* proper positioning of OSD menu image */
539     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
540     {
541         p_spu->i_x = p_filter->p_sys->p_menu->p_button->i_x;
542         p_spu->i_y = p_filter->p_sys->p_menu->p_button->i_y;
543     }
544     else
545     {
546         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
547         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
548     }
549
550     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
551     {
552         subpicture_region_t *p_region_list = NULL;
553         subpicture_region_t *p_region_tail = NULL;
554         osd_menu_t *p_osd = p_filter->p_sys->p_menu;
555         osd_button_t *p_button = p_osd->p_button;
556
557         /* Construct the entire OSD from individual images */
558         while( p_button != NULL )
559         {
560             osd_button_t *p_tmp = NULL;
561             subpicture_region_t *p_new = NULL;
562
563             p_new = create_picture_region( p_filter, p_spu,
564                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
565                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
566                     p_button->p_current_state->p_pic );
567             if( !p_new )
568             {
569                 /* Cleanup when bailing out */
570                 subpicture_region_t *p_tmp = NULL;
571                 while( p_region_list )
572                 {
573                     p_tmp = p_region_list->p_next;
574                     p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region_list );
575                 };
576                 p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
577                 p_filter->pf_sub_buffer_del( p_filter, p_spu );
578                 return NULL;
579             }
580
581             p_spu->i_width += p_new->fmt.i_visible_width;
582             p_spu->i_height += p_new->fmt.i_visible_height;
583
584             if( !p_region_list )
585             {
586                 p_region_list = p_new;
587                 p_region_tail = p_new;
588             }
589             else
590             {
591                 p_new->i_x = p_region_tail->fmt.i_visible_width;
592                 p_new->i_y = p_button->i_y;
593                 p_region_tail->p_next = p_new;
594                 p_region_tail = p_new;
595             }
596             p_tmp = p_button->p_next;
597             p_button = p_tmp;
598         };
599         p_region->p_next = p_region_list;
600     }
601 #if 0
602     p_region->p_next = create_text_region( p_filter, p_spu,
603         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
604         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
605 #endif
606     p_spu->p_region = p_region;
607     return p_spu;
608 }
609
610 static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
611                             vlc_value_t oldval, vlc_value_t newval,
612                             void *p_data )
613 {
614     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
615     filter_sys_t *p_sys = (filter_sys_t *) p_data;
616
617     if( !p_sys )
618         return VLC_SUCCESS;
619
620     if( !strncmp( psz_var, OSD_CFG"position", 16) )
621     {
622 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
623         unsigned int i;
624         for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
625         {
626             if( newval.i_int == pi_pos_values[i] )
627             {
628                 p_sys->i_position = newval.i_int % 11;
629                 break;
630             }
631         }
632 #undef ARRAY_SIZE
633     }
634     else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
635              !strncmp( psz_var, OSD_CFG"y", 9))
636     {
637         p_sys->b_absolute = VLC_TRUE;
638         if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
639         {
640             p_sys->b_absolute = VLC_FALSE;
641             p_sys->p_menu->i_x = 0;
642             p_sys->p_menu->i_y = 0;
643         }
644         else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
645         {
646             p_sys->p_menu->i_x = p_sys->i_x;
647             p_sys->p_menu->i_y = p_sys->i_y;
648         }
649     }
650     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
651         p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
652     else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
653         p_sys->i_update = newval.i_int % 1000;
654     else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
655         p_sys->i_alpha = newval.i_int % 256;
656
657     p_sys->b_update = p_sys->b_visible ? VLC_TRUE : VLC_FALSE;
658     return VLC_SUCCESS;
659 }
660
661 /*****************************************************************************
662  * MouseEvent: callback for mouse events
663  *****************************************************************************/
664 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
665                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
666 {
667     VLC_UNUSED(oldval); VLC_UNUSED(newval);
668     filter_sys_t *p_sys = (filter_sys_t *)p_data;
669     vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
670     int i_x, i_y;
671     int i_v;
672
673 #define MOUSE_DOWN    1
674 #define MOUSE_CLICKED 2
675 #define MOUSE_MOVE_X  4
676 #define MOUSE_MOVE_Y  8
677 #define MOUSE_MOVE    12
678     uint8_t mouse= 0;
679
680     int v_h = p_vout->output.i_height;
681     int v_w = p_vout->output.i_width;
682
683     if( psz_var[6] == 'x' ) mouse |= MOUSE_MOVE_X;
684     if( psz_var[6] == 'y' ) mouse |= MOUSE_MOVE_Y;
685     if( psz_var[6] == 'c' ) mouse |= MOUSE_CLICKED;
686
687     i_v = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
688     if( i_v & 0x1 ) mouse |= MOUSE_DOWN;
689     i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
690     i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
691
692     if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
693         return VLC_SUCCESS;
694
695     if( mouse & MOUSE_CLICKED )
696     {
697         int i_scale_width, i_scale_height;
698         osd_button_t *p_button = NULL;
699
700         i_scale_width = p_vout->fmt_out.i_visible_width * 1000 /
701             p_vout->fmt_in.i_visible_width;
702         i_scale_height = p_vout->fmt_out.i_visible_height * 1000 /
703             p_vout->fmt_in.i_visible_height;
704
705         p_button = osd_ButtonFind( p_this, i_x, i_y, v_h, v_w,
706                                    i_scale_width, i_scale_height );
707         if( p_button )
708         {
709             osd_ButtonSelect( p_this, p_button );
710             p_sys->b_update = p_sys->b_visible ? VLC_TRUE : VLC_FALSE;
711             p_sys->b_clicked = VLC_TRUE;
712             msg_Dbg( p_this, "mouse clicked %s (%d,%d)\n", p_button->psz_name, i_x, i_y );
713         }
714     }
715     return VLC_SUCCESS;
716 }