1 /*****************************************************************************
2 * osdmenu.c: osd filter module
3 *****************************************************************************
4 * Copyright (C) 2004-2005 M2X
5 * $Id: osdmenu.c 11131 2005-05-23 11:04:07Z hartman $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
30 #include <vlc/input.h>
32 #include <vlc_filter.h>
33 #include <vlc_video.h>
38 /*****************************************************************************
40 *****************************************************************************/
42 /* FIXME: Future extension make the definition file in XML format. */
43 #define OSD_FILE_TEXT N_("OSD menu configuration file")
44 #define OSD_FILE_LONGTEXT N_( \
45 "An OSD menu configuration file that menu actions with button images" )
47 #define OSD_PATH_TEXT N_("Path to OSD menu images")
48 #define OSD_PATH_LONGTEXT N_( \
49 "Specify another path to the OSD menu images. This will override the path as defined in the " \
50 "OSD configuration file." )
52 #define POSX_TEXT N_("X coordinate of the OSD menu")
53 #define POSX_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
55 #define POSY_TEXT N_("Y coordinate of the OSD menu")
56 #define POSY_LONGTEXT N_("You can move the OSD menu by left-clicking on it." )
58 #define POS_TEXT N_("OSD menu position")
59 #define POS_LONGTEXT N_( \
60 "You can enforce the OSD menu position on the video " \
61 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
62 "also use combinations of these values).")
64 #define TIMEOUT_TEXT N_("Timeout of OSD menu")
65 #define TIMEOUT_LONGTEXT N_( \
66 "OSD menu pictures get a default timeout of 15 seconds added to their remaining time." \
67 "This will ensure that they are at least the specified time visible.")
69 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
70 static char *ppsz_pos_descriptions[] =
71 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
72 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
74 /* subfilter functions */
75 static int CreateFilter ( vlc_object_t * );
76 static void DestroyFilter( vlc_object_t * );
77 static subpicture_t *Filter( filter_t *, mtime_t );
78 static int OSDMenuUpdateEvent( vlc_object_t *, char const *,
79 vlc_value_t, vlc_value_t, void * );
80 static int OSDMenuVisibleEvent( vlc_object_t *, char const *,
81 vlc_value_t, vlc_value_t, void * );
83 #define OSD_CFG "osdmenu-"
85 #if defined( WIN32 ) || defined( UNDER_CE )
86 #define OSD_DEFAULT_CFG "osdmenu/default.cfg"
88 #define OSD_DEFAULT_CFG "share/osdmenu/default.cfg"
92 add_integer( OSD_CFG "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
93 add_integer( OSD_CFG "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
94 add_integer( OSD_CFG "position", 8, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
95 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
96 add_string( OSD_CFG "file", OSD_DEFAULT_CFG, NULL, OSD_FILE_TEXT, OSD_FILE_LONGTEXT, VLC_FALSE );
97 add_string( OSD_CFG "file-path", NULL, NULL, OSD_PATH_TEXT, OSD_PATH_LONGTEXT, VLC_FALSE );
98 add_integer( OSD_CFG "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT, VLC_FALSE );
100 set_capability( "sub filter", 100 );
101 set_description( N_("On Screen Display menu subfilter") );
102 set_shortname( N_("OSD menu") );
103 add_shortcut( "osdmenu" );
104 set_category( CAT_VIDEO );
105 set_subcategory( SUBCAT_VIDEO_SUBPIC );
106 set_callbacks( CreateFilter, DestroyFilter );
109 /*****************************************************************************
111 *****************************************************************************/
113 /*****************************************************************************
115 *****************************************************************************/
120 int position; /* relative positioning of SPU images */
121 mtime_t i_last_date; /* last mdate SPU object has been sent to SPU subsytem */
122 int i_timeout; /* duration SPU object is valid on the video output in seconds */
124 vlc_bool_t b_absolute; /* do we use absolute positioning or relative? */
125 vlc_bool_t b_update; /* Update OSD Menu by sending SPU objects */
126 vlc_bool_t b_visible; /* OSD Menu is visible */
128 char *psz_file; /* OSD Menu configuration file */
129 osd_menu_t *p_menu; /* pointer to OSD Menu object */
132 /*****************************************************************************
133 * CreateFilter: Create the filter and open the definition file
134 *****************************************************************************/
135 static int CreateFilter ( vlc_object_t *p_this )
137 filter_t *p_filter = (filter_t *)p_this;
141 p_filter->p_sys = (filter_sys_t *) malloc( sizeof( filter_sys_t ) );
142 if( !p_filter->p_sys )
144 msg_Err( p_filter, "out of memory" );
148 /* Populating struct */
149 p_filter->p_sys->p_menu = NULL;
150 p_filter->p_sys->psz_file = NULL;
152 vlc_mutex_init( p_filter, &p_filter->p_sys->lock );
154 p_filter->p_sys->psz_file = config_GetPsz( p_filter, OSD_CFG "file" );
155 if( p_filter->p_sys->psz_file == NULL || *p_filter->p_sys->psz_file == '\0' )
157 msg_Err( p_filter, "unable to get filename" );
161 var_Create( p_this, OSD_CFG "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
162 var_Get( p_this, OSD_CFG "position", &val );
163 p_filter->p_sys->position = val.i_int;
164 var_Create( p_this, OSD_CFG "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
165 var_Get( p_this, OSD_CFG "x", &val );
167 var_Create( p_this, OSD_CFG "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
168 var_Get( p_this, OSD_CFG "y", &val );
170 var_Create( p_this, OSD_CFG "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
171 var_Get( p_this, OSD_CFG "timeout", &val );
172 p_filter->p_sys->i_timeout = val.i_int; /* in seconds */
174 /* Load the osd menu subsystem */
175 p_filter->p_sys->p_menu = osd_MenuCreate( p_this, p_filter->p_sys->psz_file );
176 if( p_filter->p_sys->p_menu == NULL )
179 /* Check if menu position was overridden */
180 p_filter->p_sys->b_absolute = VLC_TRUE;
182 if( posx < 0 || posy < 0)
184 p_filter->p_sys->b_absolute = VLC_FALSE;
185 p_filter->p_sys->p_menu->i_x = 0;
186 p_filter->p_sys->p_menu->i_y = 0;
188 else if( posx >= 0 || posy >= 0 )
190 p_filter->p_sys->p_menu->i_x = posx;
191 p_filter->p_sys->p_menu->i_y = posy;
193 else if( p_filter->p_sys->p_menu->i_x < 0 || p_filter->p_sys->p_menu->i_y < 0 )
195 p_filter->p_sys->b_absolute = VLC_FALSE;
196 p_filter->p_sys->p_menu->i_x = 0;
197 p_filter->p_sys->p_menu->i_y = 0;
200 /* Set up p_filter */
201 p_filter->p_sys->i_last_date = mdate();
203 /* Keep track of OSD Events */
204 p_filter->p_sys->b_update = VLC_FALSE;
205 p_filter->p_sys->b_visible = VLC_FALSE;
207 var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
208 var_AddCallback( p_filter->p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
210 /* Attach subpicture filter callback */
211 p_filter->pf_sub_filter = Filter;
213 es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
214 p_filter->fmt_out.i_priority = 0;
216 msg_Dbg( p_filter, "successfully loaded osdmenu filter" );
220 msg_Err( p_filter, "osdmenu filter discarded" );
221 vlc_mutex_destroy( &p_filter->p_sys->lock );
222 if( p_filter->p_sys->p_menu )
224 osd_MenuDelete( p_this, p_filter->p_sys->p_menu );
225 p_filter->p_sys->p_menu = NULL;
227 if( p_filter->p_sys->psz_file ) free( p_filter->p_sys->psz_file );
228 if( p_filter->p_sys ) free( p_filter->p_sys );
232 /*****************************************************************************
233 * DestroyFilter: Make a clean exit of this plugin
234 *****************************************************************************/
235 static void DestroyFilter( vlc_object_t *p_this )
237 filter_t *p_filter = (filter_t*)p_this;
238 filter_sys_t *p_sys = p_filter->p_sys;
240 var_Destroy( p_this, OSD_CFG "file" );
241 var_Destroy( p_this, OSD_CFG "x" );
242 var_Destroy( p_this, OSD_CFG "y" );
243 var_Destroy( p_this, OSD_CFG "position" );
244 var_Destroy( p_this, OSD_CFG "timeout" );
246 var_DelCallback( p_sys->p_menu, "osd-menu-update", OSDMenuUpdateEvent, p_filter );
247 var_DelCallback( p_sys->p_menu, "osd-menu-visible", OSDMenuVisibleEvent, p_filter );
249 osd_MenuDelete( p_filter, p_sys->p_menu );
251 vlc_mutex_destroy( &p_filter->p_sys->lock );
252 if( p_sys->psz_file) free( p_sys->psz_file );
253 if( p_sys ) free( p_sys );
255 msg_Dbg( p_filter, "osdmenu filter destroyed" );
258 /*****************************************************************************
259 * OSDMenuEvent: callback for OSD Menu events
260 *****************************************************************************/
261 static int OSDMenuVisibleEvent( vlc_object_t *p_this, char const *psz_var,
262 vlc_value_t oldval, vlc_value_t newval, void *p_data )
264 filter_t *p_filter = (filter_t *) p_data;
266 p_filter->p_sys->b_visible = VLC_TRUE;
270 static int OSDMenuUpdateEvent( vlc_object_t *p_this, char const *psz_var,
271 vlc_value_t oldval, vlc_value_t newval, void *p_data )
273 filter_t *p_filter = (filter_t *) p_data;
275 p_filter->p_sys->b_update = VLC_TRUE;
280 /*****************************************************************************
281 * create_text_region : compose a text region SPU
282 *****************************************************************************/
283 static subpicture_region_t *create_text_region( filter_t *p_filter, subpicture_t *p_spu,
284 int i_width, int i_height, const char *psz_text )
286 subpicture_region_t *p_region;
289 /* Create new SPU region */
290 memset( &fmt, 0, sizeof(video_format_t) );
291 fmt.i_chroma = VLC_FOURCC( 'T','E','X','T' );
292 fmt.i_aspect = VOUT_ASPECT_FACTOR;
293 fmt.i_sar_num = fmt.i_sar_den = 1;
294 fmt.i_width = fmt.i_visible_width = i_width;
295 fmt.i_height = fmt.i_visible_height = i_height;
296 fmt.i_x_offset = fmt.i_y_offset = 0;
297 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
300 msg_Err( p_filter, "cannot allocate another SPU region" );
303 p_region->psz_text = strdup( psz_text );
307 msg_Dbg( p_filter, "SPU text region position (%d,%d) (%d,%d) [%s]",
308 p_region->i_x, p_region->i_y,
309 p_region->fmt.i_width, p_region->fmt.i_height, p_region->psz_text );
315 /*****************************************************************************
316 * create_picture_region : compose a text region SPU
317 *****************************************************************************/
318 static subpicture_region_t *create_picture_region( filter_t *p_filter, subpicture_t *p_spu,
319 int i_width, int i_height, picture_t *p_pic )
321 subpicture_region_t *p_region;
324 /* Create new SPU region */
325 memset( &fmt, 0, sizeof(video_format_t) );
326 fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
327 fmt.i_aspect = VOUT_ASPECT_FACTOR;
328 fmt.i_sar_num = fmt.i_sar_den = 1;
329 fmt.i_width = fmt.i_visible_width = i_width;
330 fmt.i_height = fmt.i_visible_height = i_height;
331 fmt.i_x_offset = fmt.i_y_offset = 0;
332 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
335 msg_Err( p_filter, "cannot allocate SPU region" );
336 p_filter->pf_sub_buffer_del( p_filter, p_spu );
339 vout_CopyPicture( p_filter, &p_region->picture, p_pic );
344 msg_Dbg( p_filter, "SPU picture region position (%d,%d) (%d,%d) [%p]",
345 p_region->i_x, p_region->i_y,
346 p_region->fmt.i_width, p_region->fmt.i_height, p_pic );
351 /****************************************************************************
352 * Filter: the whole thing
353 ****************************************************************************
354 * This function outputs subpictures at regular time intervals.
355 ****************************************************************************/
356 static subpicture_t *Filter( filter_t *p_filter, mtime_t i_date )
358 filter_sys_t *p_sys = p_filter->p_sys;
360 subpicture_region_t *p_region;
362 if( !p_filter->p_sys->b_update ) return NULL;
364 p_filter->p_sys->i_last_date = i_date;
365 p_filter->p_sys->b_update = VLC_FALSE;
367 /* Allocate the subpicture internal data. */
368 p_spu = p_filter->pf_sub_buffer_new( p_filter );
369 if( !p_spu ) return NULL;
371 p_spu->b_absolute = p_sys->b_absolute;
372 p_spu->i_start = p_sys->i_last_date = i_date;
373 /* this never works why ? */
374 p_spu->i_stop = (p_sys->i_timeout == 0) ? 0 : i_date + (mtime_t)(p_sys->i_timeout * 1000000);
375 p_spu->b_ephemer = VLC_TRUE;
376 p_spu->b_fade = VLC_TRUE;
377 p_spu->i_flags = p_sys->position;
378 p_filter->p_sys->b_update = VLC_FALSE;
380 /* Send an empty subpicture to clear the display
381 * when OSD menu should be hidden and menu picture is not allocated.
383 if( !p_filter->p_sys->p_menu->p_state->p_pic )
385 if( p_filter->p_sys->b_visible == VLC_FALSE )
388 /* Create new spu regions */
389 p_region = create_picture_region( p_filter, p_spu,
390 p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
391 p_filter->p_sys->p_menu->p_state->p_pic );
393 p_region->p_next = create_text_region( p_filter, p_spu,
394 p_filter->p_sys->p_menu->p_state->i_width, p_filter->p_sys->p_menu->p_state->i_height,
395 p_filter->p_sys->p_menu->p_state->p_visible->psz_action );
398 /* proper positioning of OSD menu image */
399 p_spu->i_x = p_filter->p_sys->p_menu->p_state->i_x;
400 p_spu->i_y = p_filter->p_sys->p_menu->p_state->i_y;
402 p_spu->p_region = p_region;