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