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