OSDMenu: add to the CAT_VIDEO category to have tweaking in the preferences.
[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 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
88                     vlc_value_t, vlc_value_t, void * );
89 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
90                     vlc_value_t, vlc_value_t, void * );
91 static int OSDMenuCallback( vlc_object_t *, char const *,
92                             vlc_value_t, vlc_value_t, void * );
93
94 #define OSD_CFG "osdmenu-"
95
96 #if defined( WIN32 ) || defined( UNDER_CE )
97 #define OSD_DEFAULT_CFG "osdmenu/default.cfg"
98 #else
99 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
100 #endif
101
102 #define OSD_UPDATE_MIN     0
103 #define OSD_UPDATE_DEFAULT 300
104 #define OSD_UPDATE_MAX     1000
105
106 vlc_module_begin();
107     add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
108     add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
109     add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT,
110                  VLC_FALSE );
111         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
112     add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
113         OSD_FILE_LONGTEXT, VLC_FALSE );
114     add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
115         OSD_PATH_LONGTEXT, VLC_FALSE );
116     add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
117         TIMEOUT_LONGTEXT, VLC_FALSE );
118     add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
119         OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
120         OSD_UPDATE_LONGTEXT, VLC_TRUE );
121
122     add_integer_with_range( OSD_CFG "alpha", 255, 0, 255, NULL,
123         OSD_ALPHA_TEXT, OSD_ALPHA_LONGTEXT, VLC_TRUE );
124
125     set_capability( "sub filter", 100 );
126     set_description( _("On Screen Display menu") );
127     set_shortname( _("OSD menu") );
128     add_shortcut( "osdmenu" );
129
130     set_category( CAT_VIDEO );
131     set_subcategory( SUBCAT_VIDEO_SUBPIC );
132
133     set_callbacks( CreateFilter, DestroyFilter );
134 vlc_module_end();
135
136 /*****************************************************************************
137  * Sub filter code
138  *****************************************************************************/
139
140 /*****************************************************************************
141  * Local prototypes
142  *****************************************************************************/
143 struct filter_sys_t
144 {
145     int          i_position;    /* relative positioning of SPU images */
146     int          i_x;           /* absolute positioning of SPU images */
147     int          i_y;           /* absolute positioning of SPU images */
148     mtime_t      i_last_date;   /* last mdate SPU object has been sent to SPU subsytem */
149     mtime_t      i_timeout;     /* duration SPU object is valid on the video output in seconds */
150
151     vlc_bool_t   b_absolute;    /* do we use absolute positioning or relative? */
152     vlc_bool_t   b_update;      /* Update OSD Menu by sending SPU objects */
153     vlc_bool_t   b_visible;     /* OSD Menu is visible */
154     mtime_t      i_update;      /* Update the OSD menu every n ms */
155     mtime_t      i_end_date;    /* End data of display OSD menu */
156     int          i_alpha;       /* alpha transparency value */
157
158     char        *psz_file;      /* OSD Menu configuration file */
159     osd_menu_t  *p_menu;        /* pointer to OSD Menu object */
160 };
161
162 /*****************************************************************************
163  * CreateFilter: Create the filter and open the definition file
164  *****************************************************************************/
165 static int CreateFilter ( vlc_object_t *p_this )
166 {
167     filter_t *p_filter = (filter_t *)p_this;
168     filter_sys_t *p_sys = NULL;
169     vlc_value_t val;
170
171     p_filter->p_sys = p_sys = (filter_sys_t *) malloc( sizeof(filter_sys_t) );
172     if( !p_filter->p_sys )
173     {
174         msg_Err( p_filter, "out of memory" );
175         return VLC_ENOMEM;
176     }
177     memset( p_sys, 0, sizeof(filter_sys_t) );
178
179     /* Populating struct */
180     p_filter->p_sys->p_menu = NULL;
181     p_filter->p_sys->psz_file = NULL;
182
183     p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
184     if( (p_filter->p_sys->psz_file == NULL) ||
185         (*p_filter->p_sys->psz_file == '\0') )
186     {
187         msg_Err( p_filter, "unable to get filename" );
188         goto error;
189     }
190
191     p_sys->i_x = var_CreateGetIntegerCommand( p_this, OSD_CFG "x" );
192     p_sys->i_y = var_CreateGetIntegerCommand( p_this, OSD_CFG "y" );
193     p_sys->i_position = var_CreateGetIntegerCommand( p_this, OSD_CFG "position" );
194     p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, OSD_CFG "alpha" );
195
196     /* in micro seconds - divide by 2 to match user expectations */
197     var_Create( p_this, OSD_CFG "timeout",
198                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
199     var_Get( p_this, OSD_CFG "timeout", &val );
200     p_sys->i_timeout = (mtime_t)(val.i_int * 1000000) >> 2;
201     var_Create( p_this, OSD_CFG "update",
202                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
203     var_Get( p_this, OSD_CFG "update", &val );
204     p_sys->i_update = (mtime_t)(val.i_int * 1000); /* in micro seconds */
205
206     var_AddCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
207     var_AddCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
208     var_AddCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
209     var_AddCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
210
211     /* Load the osd menu subsystem */
212     p_sys->p_menu = osd_MenuCreate( p_this, p_sys->psz_file );
213     if( p_sys->p_menu == NULL )
214         goto error;
215
216     /* Check if menu position was overridden */
217     p_sys->b_absolute = VLC_TRUE;
218     if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
219     {
220         p_sys->b_absolute = VLC_FALSE;
221         p_sys->p_menu->i_x = 0;
222         p_sys->p_menu->i_y = 0;
223     }
224     else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
225     {
226         p_sys->p_menu->i_x = p_sys->i_x;
227         p_sys->p_menu->i_y = p_sys->i_y;
228     }
229     else if( (p_sys->p_menu->i_x < 0) ||
230              (p_sys->p_menu->i_y < 0) )
231     {
232         p_sys->b_absolute = VLC_FALSE;
233         p_sys->p_menu->i_x = 0;
234         p_sys->p_menu->i_y = 0;
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  = VLC_FALSE;
242     p_sys->b_visible = VLC_FALSE;
243
244     /* Listen to osd menu core updates/visible settings. */
245     var_AddCallback( p_sys->p_menu, "osd-menu-update",
246                      OSDMenuUpdateEvent, p_filter );
247     var_AddCallback( p_sys->p_menu, "osd-menu-visible",
248                      OSDMenuVisibleEvent, p_filter );
249
250     /* Attach subpicture filter callback */
251     p_filter->pf_sub_filter = Filter;
252
253     es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
254     p_filter->fmt_out.i_priority = 0;
255
256     msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
257     return VLC_SUCCESS;
258
259 error:
260     msg_Err( p_filter, "osdmenu filter discarded" );
261     if( p_filter->p_sys->p_menu )
262     {
263         osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
264         p_filter->p_sys->p_menu = NULL;
265     }
266     if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
267     if( p_filter->p_sys ) free( p_filter->p_sys );
268     return VLC_EGENERIC;
269 }
270
271 /*****************************************************************************
272  * DestroyFilter: Make a clean exit of this plugin
273  *****************************************************************************/
274 static void DestroyFilter( vlc_object_t *p_this )
275 {
276     filter_t     *p_filter = (filter_t*)p_this;
277     filter_sys_t *p_sys = p_filter->p_sys;
278
279     var_DelCallback( p_filter, OSD_CFG "position", OSDMenuCallback, p_sys );
280     var_DelCallback( p_filter, OSD_CFG "timeout", OSDMenuCallback, p_sys );
281     var_DelCallback( p_filter, OSD_CFG "update", OSDMenuCallback, p_sys );
282     var_DelCallback( p_filter, OSD_CFG "alpha", OSDMenuCallback, p_sys );
283
284     var_DelCallback( p_sys->p_menu, "osd-menu-update",
285                      OSDMenuUpdateEvent, p_filter );
286     var_DelCallback( p_sys->p_menu, "osd-menu-visible",
287                      OSDMenuVisibleEvent, p_filter );
288
289     var_Destroy( p_this, OSD_CFG "file" );
290     var_Destroy( p_this, OSD_CFG "x" );
291     var_Destroy( p_this, OSD_CFG "y" );
292     var_Destroy( p_this, OSD_CFG "position" );
293     var_Destroy( p_this, OSD_CFG "timeout" );
294     var_Destroy( p_this, OSD_CFG "update" );
295     var_Destroy( p_this, OSD_CFG "alpha" );
296
297     osd_MenuDelete( p_filter, p_sys->p_menu );
298
299     if( p_sys->psz_file) free( p_sys->psz_file );
300     if( p_sys ) free( p_sys );
301
302     msg_Dbg( p_filter, "osdmenu filter destroyed" );
303 }
304
305 /*****************************************************************************
306  * OSDMenuEvent: callback for OSD Menu events
307  *****************************************************************************/
308 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
309                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
310 {
311     filter_t *p_filter = (filter_t *) p_data;
312
313     p_filter->p_sys->b_visible = VLC_TRUE;
314     p_filter->p_sys->b_update = VLC_TRUE;
315     return VLC_SUCCESS;
316 }
317
318 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
319                     vlc_value_t oldval, vlc_value_t newval, void *p_data )
320 {
321     filter_t *p_filter = (filter_t *) p_data;
322     filter_sys_t *p_sys = p_filter->p_sys;
323
324     p_sys->b_update = p_sys->b_visible ? VLC_TRUE : VLC_FALSE;
325     p_sys->i_end_date = (mtime_t) 0;
326     return VLC_SUCCESS;
327 }
328
329 #if 0
330 /*****************************************************************************
331  * create_text_region : compose a text region SPU
332  *****************************************************************************/
333 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu, 
334     int i_width, int i_height, const char *psz_text )
335 {
336     subpicture_region_t *p_region;
337     video_format_t       fmt;
338
339     /* Create new SPU region */
340     memset( &fmt, 0, sizeof(video_format_t) );
341     fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
342     fmt.i_aspect = VOUT_ASPECT_FACTOR;
343     fmt.i_sar_num = fmt.i_sar_den = 1;
344     fmt.i_width = fmt.i_visible_width = i_width;
345     fmt.i_height = fmt.i_visible_height = i_height;
346     fmt.i_x_offset = fmt.i_y_offset = 0;
347     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
348     if( !p_region )
349     {
350         msg_Err( p_filter, "cannot allocate another SPU region" );
351         return NULL;
352     }
353     p_region->psz_text = strdup( psz_text );
354     p_region->i_x = 0;
355     p_region->i_y = 40;
356 #if 0
357     msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
358         p_region->i_x, p_region->i_y,
359         p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
360 #endif
361     return p_region;
362 }
363 #endif
364
365 /*****************************************************************************
366  * create_picture_region : compose a picture region SPU
367  *****************************************************************************/
368 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
369     int i_width, int i_height, picture_t *p_pic )
370 {
371     subpicture_region_t *p_region = NULL;
372     video_format_t       fmt;
373
374     if( !p_spu ) return NULL;
375
376     /* Create new SPU region */
377     memset( &fmt, 0, sizeof(video_format_t) );
378     fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
379     fmt.i_aspect = VOUT_ASPECT_FACTOR;
380     fmt.i_sar_num = fmt.i_sar_den = 1;
381     fmt.i_width = fmt.i_visible_width = i_width;
382     fmt.i_height = fmt.i_visible_height = i_height;
383     fmt.i_x_offset = fmt.i_y_offset = 0;
384
385     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
386     if( !p_region )
387     {
388         msg_Err( p_filter, "cannot allocate SPU region" );
389         p_filter->pf_sub_buffer_del( p_filter, p_spu );
390         return NULL;
391     }
392     if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
393     {
394         p_region->fmt.p_palette->i_entries = 0;
395         p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
396         p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
397     }
398     if( p_pic )
399         vout_CopyPicture( p_filter, &p_region->picture, p_pic );
400
401     p_region->i_x = 0;
402     p_region->i_y = 0;
403     p_region->i_align = p_filter->p_sys->i_position;
404 #if 0
405     msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
406         p_region->i_x, p_region->i_y,
407         p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
408 #endif
409     return p_region;
410 }
411
412 /****************************************************************************
413  * Filter: the whole thing
414  ****************************************************************************
415  * This function outputs subpictures at regular time intervals.
416  ****************************************************************************/
417 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
418 {
419     filter_sys_t *p_sys = p_filter->p_sys;
420     subpicture_t *p_spu = NULL;
421     subpicture_region_t *p_region = NULL;
422
423     if( !p_sys->b_update || (p_sys->i_update <= 0) )
424             return NULL;
425
426     /* Am I too early?
427     */
428     if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
429         ( p_sys->i_end_date > 0 ) )
430         return NULL; /* we are too early, so wait */
431
432     /* Allocate the subpicture internal data. */
433     p_spu = p_filter->pf_sub_buffer_new( p_filter );
434     if( !p_spu ) return NULL;
435
436     p_spu->b_ephemer = VLC_TRUE;
437     p_spu->b_fade = VLC_TRUE;
438     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
439         p_spu->b_absolute = VLC_TRUE;
440     else
441         p_spu->b_absolute = p_sys->b_absolute;
442     p_spu->i_flags = p_sys->i_position;
443
444     /* Determine the duration of the subpicture */
445     if( p_sys->i_end_date > 0 )
446     {
447         /* Display the subpicture again. */
448         p_spu->i_stop = p_sys->i_end_date - i_date;
449         if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
450             p_sys->b_update = VLC_FALSE;
451     }
452     else
453     {
454         /* There is a new OSD picture to display */
455         p_spu->i_stop = i_date + p_sys->i_timeout;
456         p_sys->i_end_date = p_spu->i_stop;
457     }
458
459     p_sys->i_last_date = i_date;
460     p_spu->i_start = p_sys->i_last_date = i_date;
461
462     /* Send an empty subpicture to clear the display
463      * when OSD menu should be hidden and menu picture is not allocated.
464      */
465     if( !p_filter->p_sys->p_menu->p_state->p_pic ||
466         ( p_filter->p_sys->b_visible == VLC_FALSE ) )
467     {
468         /* Create new spu regions and allocate an empty picture in it. */
469         p_region = create_picture_region( p_filter, p_spu,
470             p_filter->p_sys->p_menu->p_state->i_width,
471             p_filter->p_sys->p_menu->p_state->i_height,
472             NULL );
473
474         /* proper positioning of OSD menu image */
475         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
476         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
477         p_spu->p_region = p_region;
478         p_spu->i_alpha = 0xFF; /* Picture is completely non transparent. */
479         return p_spu;
480     }
481
482     /* Create new spu regions
483     */
484     p_region = create_picture_region( p_filter, p_spu,
485         p_filter->p_sys->p_menu->p_state->i_width,
486         p_filter->p_sys->p_menu->p_state->i_height,
487         p_filter->p_sys->p_menu->p_state->p_pic );
488
489     if( !p_region )
490     {
491         p_filter->pf_sub_buffer_del( p_filter, p_spu );
492         return NULL;
493     }
494
495     p_spu->i_width = p_region->fmt.i_visible_width;
496     p_spu->i_height = p_region->fmt.i_visible_height;
497     p_spu->i_alpha = p_filter->p_sys->i_alpha;
498
499     /* proper positioning of OSD menu image */
500     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
501     {
502         p_spu->i_x = p_filter->p_sys->p_menu->p_button->i_x;
503         p_spu->i_y = p_filter->p_sys->p_menu->p_button->i_y;
504     }
505     else
506     {
507         p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
508         p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
509     }
510
511     if( p_filter->p_sys->p_menu->i_style == OSD_MENU_STYLE_CONCAT )
512     {
513         subpicture_region_t *p_region_list = NULL;
514         subpicture_region_t *p_region_tail = NULL;
515         osd_menu_t *p_osd = p_filter->p_sys->p_menu;
516         osd_button_t *p_button = p_osd->p_button;
517
518         /* Construct the entire OSD from individual images */
519         while( p_button != NULL )
520         {
521             osd_button_t *p_tmp = NULL;
522             subpicture_region_t *p_new = NULL;
523
524             p_new = create_picture_region( p_filter, p_spu,
525                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_pitch,
526                     p_button->p_current_state->p_pic->p[Y_PLANE].i_visible_lines,
527                     p_button->p_current_state->p_pic );
528             if( !p_new )
529             {
530                 /* Cleanup when bailing out */
531                 subpicture_region_t *p_tmp = NULL;
532                 while( p_region_list )
533                 {
534                     p_tmp = p_region_list->p_next;
535                     p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region_list );
536                 };
537                 p_spu->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
538                 p_filter->pf_sub_buffer_del( p_filter, p_spu );
539                 return NULL;
540             }
541
542             p_spu->i_width += p_new->fmt.i_visible_width;
543             p_spu->i_height += p_new->fmt.i_visible_height;
544
545             if( !p_region_list )
546             {
547                 p_region_list = p_new;
548                 p_region_tail = p_new;
549             }
550             else
551             {
552                 p_new->i_x = p_region_tail->fmt.i_visible_width;
553                 p_new->i_y = p_button->i_y;
554                 p_region_tail->p_next = p_new;
555                 p_region_tail = p_new;
556             }
557             p_tmp = p_button->p_next;
558             p_button = p_tmp;
559         };
560         p_region->p_next = p_region_list;
561     }
562 #if 0
563     p_region->p_next = create_text_region( p_filter, p_spu,
564         p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
565         p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
566 #endif
567     p_spu->p_region = p_region;
568     return p_spu;
569 }
570
571 static int OSDMenuCallback( vlc_object_t *p_this, char const *psz_var,
572                             vlc_value_t oldval, vlc_value_t newval,
573                             void *p_data )
574 {
575     filter_sys_t *p_sys = (filter_sys_t *) p_data;
576
577     if( !p_sys )
578         return VLC_SUCCESS;
579
580     if( !strncmp( psz_var, OSD_CFG"position", 16) )
581     {
582 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
583         unsigned int i;
584         for( i=0; i < ARRAY_SIZE(pi_pos_values); i++ )
585         {
586             if( newval.i_int == pi_pos_values[i] )
587             {
588                 p_sys->i_position = newval.i_int % 11;
589                 break;
590             }
591         }
592 #undef ARRAY_SIZE
593     }
594     else if( !strncmp( psz_var, OSD_CFG"x", 9) ||
595              !strncmp( psz_var, OSD_CFG"y", 9))
596     {
597         p_sys->b_absolute = VLC_TRUE;
598         if( (p_sys->i_x < 0) || (p_sys->i_y < 0) )
599         {
600             p_sys->b_absolute = VLC_FALSE;
601             p_sys->p_menu->i_x = 0;
602             p_sys->p_menu->i_y = 0;
603         }
604         else if( (p_sys->i_x >= 0) || (p_sys->i_y >= 0) )
605         {
606             p_sys->p_menu->i_x = p_sys->i_x;
607             p_sys->p_menu->i_y = p_sys->i_y;
608         }
609     }
610     else if( !strncmp( psz_var, OSD_CFG"update", 14) )
611         p_sys->i_update =  (mtime_t)(newval.i_int * 1000);
612     else if( !strncmp( psz_var, OSD_CFG"timeout", 15) )
613         p_sys->i_update = newval.i_int % 1000;
614     else if( !strncmp( psz_var, OSD_CFG"alpha", 13) )
615         p_sys->i_alpha = newval.i_int % 256;
616
617     p_sys->b_update = p_sys->b_visible ? VLC_TRUE : VLC_FALSE;
618     return VLC_SUCCESS;
619 }