1 /*****************************************************************************
2 * osdmenu.c: osd filter module
3 *****************************************************************************
4 * Copyright (C) 2004-2005 M2X
7 * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_filter.h>
35 /*****************************************************************************
37 *****************************************************************************/
39 /* FIXME: Future extension make the definition file in XML format. */
40 #define OSD_FILE_TEXT N_("Configuration file")
41 #define OSD_FILE_LONGTEXT N_( \
42 "Configuration file for the OSD Menu." )
43 #define OSD_PATH_TEXT N_("Path to OSD menu images")
44 #define OSD_PATH_LONGTEXT N_( \
45 "Path to the OSD menu images. This will override the path defined in the " \
46 "OSD configuration file." )
48 #define POSX_TEXT N_("X coordinate")
49 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
51 #define POSY_TEXT N_("Y coordinate")
52 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
54 #define POS_TEXT N_("Menu position")
55 #define POS_LONGTEXT N_( \
56 "You can enforce the OSD menu position on the video " \
57 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
58 "also use combinations of these values, eg. 6 = top-right).")
60 #define TIMEOUT_TEXT N_("Menu timeout")
61 #define TIMEOUT_LONGTEXT N_( \
62 "OSD menu pictures get a default timeout of 15 seconds added to their " \
63 "remaining time. This will ensure that they are at least the specified " \
66 #define OSD_UPDATE_TEXT N_("Menu update interval" )
67 #define OSD_UPDATE_LONGTEXT N_( \
68 "The default is to update the OSD menu picture every 200 ms. Shorten the" \
69 " update time for environments that experience transmissions errors. " \
70 "Be careful with this option as encoding OSD menu pictures is very " \
71 "computing intensive. The range is 0 - 1000 ms." )
73 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
74 static char *ppsz_pos_descriptions[] =
75 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
76 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
78 /* subfilter functions */
79 static int CreateFilter ( vlc_object_t * );
80 static void DestroyFilter( vlc_object_t * );
81 static subpicture_t *Filter( filter_t *, mtime_t );
82 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
83 vlc_value_t, vlc_value_t, void * );
84 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
85 vlc_value_t, vlc_value_t, void * );
87 #define OSD_CFG "osdmenu-"
89 #if defined( WIN32 ) || defined( UNDER_CE )
90 #define OSD_DEFAULT_CFG "osdmenu/default.cfg"
92 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
95 #define OSD_UPDATE_MIN 0
96 #define OSD_UPDATE_DEFAULT 0
97 #define OSD_UPDATE_MAX 1000
100 add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
101 add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
102 add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
103 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
104 add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT,
105 OSD_FILE_LONGTEXT, VLC_FALSE );
106 add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT,
107 OSD_PATH_LONGTEXT, VLC_FALSE );
108 add_integer( OSD_CFG "timeout", 15, NULL, TIMEOUT_TEXT,
109 TIMEOUT_LONGTEXT, VLC_FALSE );
110 add_integer_with_range( OSD_CFG "update", OSD_UPDATE_DEFAULT,
111 OSD_UPDATE_MIN, OSD_UPDATE_MAX, NULL, OSD_UPDATE_TEXT,
112 OSD_UPDATE_LONGTEXT, VLC_TRUE );
114 set_capability( "sub filter", 100 );
115 set_description( _("On Screen Display menu") );
116 set_shortname( _("OSD menu") );
117 add_shortcut( "osdmenu" );
119 set_category( CAT_VIDEO );
120 set_subcategory( SUBCAT_VIDEO_SUBPIC );
122 set_callbacks( CreateFilter, DestroyFilter );
125 /*****************************************************************************
127 *****************************************************************************/
129 /*****************************************************************************
131 *****************************************************************************/
136 int position; /* relative positioning of SPU images */
137 mtime_t i_last_date; /* last mdate SPU object has been sent to SPU subsytem */
138 mtime_t i_timeout; /* duration SPU object is valid on the video output in seconds */
140 vlc_bool_t b_absolute; /* do we use absolute positioning or relative? */
141 vlc_bool_t b_update; /* Update OSD Menu by sending SPU objects */
142 vlc_bool_t b_visible; /* OSD Menu is visible */
143 mtime_t i_update; /* Update the OSD menu every n ms */
144 mtime_t i_end_date; /* End data of display OSD menu */
146 char *psz_file; /* OSD Menu configuration file */
147 osd_menu_t *p_menu; /* pointer to OSD Menu object */
150 /*****************************************************************************
151 * CreateFilter: Create the filter and open the definition file
152 *****************************************************************************/
153 static int CreateFilter ( vlc_object_t *p_this )
155 filter_t *p_filter = (filter_t *)p_this;
159 p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
160 if( !p_filter->p_sys )
162 msg_Err( p_filter, "out of memory" );
166 /* Populating struct */
167 p_filter->p_sys->p_menu = NULL;
168 p_filter->p_sys->psz_file = NULL;
170 vlc_mutex_init( p_filter, &p_filter->p_sys->lock );
172 p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
173 if( p_filter->p_sys->psz_file == NULL || *p_filter->p_sys->psz_file == '\0' )
175 msg_Err( p_filter, "unable to get filename" );
179 var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
180 var_Get( p_this, OSD_CFG "position", &val );
181 p_filter->p_sys->position = val.i_int;
182 var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
183 var_Get( p_this, OSD_CFG "x", &val );
185 var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
186 var_Get( p_this, OSD_CFG "y", &val );
189 /* in micro seconds - divide by 2 to match user expectations */
190 var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
191 var_Get( p_this, OSD_CFG "timeout", &val );
192 p_filter->p_sys->i_timeout = (mtime_t)(val.i_int * 1000000) >> 2;
193 var_Create( p_this, OSD_CFG "update", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
194 var_Get( p_this, OSD_CFG "update", &val );
195 p_filter->p_sys->i_update = (mtime_t)(val.i_int * 1000); /* in micro seconds */
197 /* Load the osd menu subsystem */
198 p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
199 if( p_filter->p_sys->p_menu == NULL )
202 /* Check if menu position was overridden */
203 p_filter->p_sys->b_absolute = VLC_TRUE;
204 if( i_posx < 0 || i_posy < 0)
206 p_filter->p_sys->b_absolute = VLC_FALSE;
207 p_filter->p_sys->p_menu->i_x = 0;
208 p_filter->p_sys->p_menu->i_y = 0;
210 else if( i_posx >= 0 || i_posy >= 0 )
212 p_filter->p_sys->p_menu->i_x = i_posx;
213 p_filter->p_sys->p_menu->i_y = i_posy;
215 else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
217 p_filter->p_sys->b_absolute = VLC_FALSE;
218 p_filter->p_sys->p_menu->i_x = 0;
219 p_filter->p_sys->p_menu->i_y = 0;
222 /* Set up p_filter */
223 p_filter->p_sys->i_last_date = mdate();
225 /* Keep track of OSD Events */
226 p_filter->p_sys->b_update = VLC_FALSE;
227 p_filter->p_sys->b_visible = VLC_FALSE;
229 var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
230 var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
232 /* Attach subpicture filter callback */
233 p_filter->pf_sub_filter = Filter;
235 es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
236 p_filter->fmt_out.i_priority = 0;
238 msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
242 msg_Err( p_filter, "osdmenu filter discarded" );
243 vlc_mutex_destroy( &p_filter->p_sys->lock );
244 if( p_filter->p_sys->p_menu )
246 osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
247 p_filter->p_sys->p_menu = NULL;
249 if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
250 if( p_filter->p_sys ) free( p_filter->p_sys );
254 /*****************************************************************************
255 * DestroyFilter: Make a clean exit of this plugin
256 *****************************************************************************/
257 static void DestroyFilter( vlc_object_t *p_this )
259 filter_t *p_filter = (filter_t*)p_this;
260 filter_sys_t *p_sys = p_filter->p_sys;
262 var_Destroy( p_this, OSD_CFG "file" );
263 var_Destroy( p_this, OSD_CFG "x" );
264 var_Destroy( p_this, OSD_CFG "y" );
265 var_Destroy( p_this, OSD_CFG "position" );
266 var_Destroy( p_this, OSD_CFG "timeout" );
267 var_Destroy( p_this, OSD_CFG "update" );
269 var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
270 var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
272 osd_MenuDelete( p_filter, p_sys->p_menu );
274 vlc_mutex_destroy( &p_filter->p_sys->lock );
275 if( p_sys->psz_file) free( p_sys->psz_file );
276 if( p_sys ) free( p_sys );
278 msg_Dbg( p_filter, "osdmenu filter destroyed" );
281 /*****************************************************************************
282 * OSDMenuEvent: callback for OSD Menu events
283 *****************************************************************************/
284 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
285 vlc_value_t oldval, vlc_value_t newval, void *p_data )
287 filter_t *p_filter = (filter_t *) p_data;
289 p_filter->p_sys->b_visible = VLC_TRUE;
293 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
294 vlc_value_t oldval, vlc_value_t newval, void *p_data )
296 filter_t *p_filter = (filter_t *) p_data;
298 p_filter->p_sys->b_update = VLC_TRUE;
299 p_filter->p_sys->i_end_date = (mtime_t) 0;
304 /*****************************************************************************
305 * create_text_region : compose a text region SPU
306 *****************************************************************************/
307 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
308 int i_width, int i_height, const char *psz_text )
310 subpicture_region_t *p_region;
313 /* Create new SPU region */
314 memset( &fmt, 0, sizeof(video_format_t) );
315 fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
316 fmt.i_aspect = VOUT_ASPECT_FACTOR;
317 fmt.i_sar_num = fmt.i_sar_den = 1;
318 fmt.i_width = fmt.i_visible_width = i_width;
319 fmt.i_height = fmt.i_visible_height = i_height;
320 fmt.i_x_offset = fmt.i_y_offset = 0;
321 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
324 msg_Err( p_filter, "cannot allocate another SPU region" );
327 p_region->psz_text = strdup( psz_text );
331 msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
332 p_region->i_x, p_region->i_y,
333 p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
339 /*****************************************************************************
340 * create_picture_region : compose a picture region SPU
341 *****************************************************************************/
342 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
343 int i_width, int i_height, picture_t *p_pic )
345 subpicture_region_t *p_region;
348 if( !p_spu ) return NULL;
350 /* Create new SPU region */
351 memset( &fmt, 0, sizeof(video_format_t) );
352 fmt.i_chroma = (p_pic == NULL) ? VLC_FOURCC('Y','U','V','P') : VLC_FOURCC('Y','U','V','A');
353 fmt.i_aspect = VOUT_ASPECT_FACTOR;
354 fmt.i_sar_num = fmt.i_sar_den = 1;
355 fmt.i_width = fmt.i_visible_width = i_width;
356 fmt.i_height = fmt.i_visible_height = i_height;
357 fmt.i_x_offset = fmt.i_y_offset = 0;
358 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
361 msg_Err( p_filter, "cannot allocate SPU region" );
362 p_filter->pf_sub_buffer_del( p_filter, p_spu );
365 if( !p_pic && ( fmt.i_chroma == VLC_FOURCC('Y','U','V','P') ) )
367 p_region->fmt.p_palette->i_entries = 0;
368 p_region->fmt.i_width = p_region->fmt.i_visible_width = 0;
369 p_region->fmt.i_height = p_region->fmt.i_visible_height = 0;
372 vout_CopyPicture( p_filter, &p_region->picture, p_pic );
377 msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
378 p_region->i_x, p_region->i_y,
379 p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
384 /****************************************************************************
385 * Filter: the whole thing
386 ****************************************************************************
387 * This function outputs subpictures at regular time intervals.
388 ****************************************************************************/
389 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
391 filter_sys_t *p_sys = p_filter->p_sys;
393 subpicture_region_t *p_region;
395 if( !p_sys->b_update )
398 /* Am I too early? */
399 if( ( ( p_sys->i_last_date + p_sys->i_update ) > i_date ) &&
400 ( p_sys->i_end_date > 0 ) )
401 return NULL; /* we are too early, so wait */
403 /* Allocate the subpicture internal data. */
404 p_spu = p_filter->pf_sub_buffer_new( p_filter );
405 if( !p_spu ) return NULL;
406 p_spu->b_ephemer = VLC_TRUE;
407 p_spu->b_fade = VLC_TRUE;
408 p_spu->b_absolute = p_sys->b_absolute;
409 p_spu->i_flags = p_sys->position;
411 /* Determine the duration of the subpicture */
412 if( p_sys->i_end_date > 0 )
414 /* Display the subpicture again. */
415 p_spu->i_stop = p_sys->i_end_date - i_date;
416 if( ( i_date + p_sys->i_update ) >= p_sys->i_end_date )
417 p_sys->b_update = VLC_FALSE;
421 /* There is a new OSD picture to display */
422 p_spu->i_stop = i_date + p_sys->i_timeout;
423 p_sys->i_end_date = p_spu->i_stop;
426 p_sys->i_last_date = i_date;
427 p_spu->i_start = p_sys->i_last_date = i_date;
429 /* Send an empty subpicture to clear the display
430 * when OSD menu should be hidden and menu picture is not allocated.
432 if( !p_filter->p_sys->p_menu->p_state->p_pic ||
433 ( p_filter->p_sys->b_visible == VLC_FALSE ) )
435 /* Create new spu regions and allocate an empty picture in it. */
436 p_region = create_picture_region( p_filter, p_spu,
437 p_filter->p_sys->p_menu->p_state->i_width,
438 p_filter->p_sys->p_menu->p_state->i_height,
441 /* proper positioning of OSD menu image */
442 p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
443 p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
444 p_spu->p_region = p_region;
445 p_spu->i_alpha = 0xFF; /* Picture is completely transparent. */
449 /* Create new spu regions */
450 p_region = create_picture_region( p_filter, p_spu,
451 p_filter->p_sys->p_menu->p_state->i_width,
452 p_filter->p_sys->p_menu->p_state->i_height,
453 p_filter->p_sys->p_menu->p_state->p_pic );
455 p_region->p_next = create_text_region( p_filter, p_spu,
456 p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
457 p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
460 /* proper positioning of OSD menu image */
461 p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
462 p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
463 p_spu->p_region = p_region;