1 /*****************************************************************************
2 * xosd.c : X On Screen Display interface
3 *****************************************************************************
4 * Copyright (C) 2001 the VideoLAN team
7 * Authors: Loïc Minier <lool@videolan.org>
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 implied 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 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_playlist.h>
36 #include <vlc_input.h>
37 #include <vlc_interface.h>
43 /*****************************************************************************
44 * intf_sys_t: description and status of rc interface
45 *****************************************************************************/
48 xosd * p_osd; /* libxosd handle */
49 bool b_need_update; /* Update display ? */
52 #define MAX_LINE_LENGTH 256
54 /*****************************************************************************
56 *****************************************************************************/
57 static int Open ( vlc_object_t * );
58 static void Close ( vlc_object_t * );
60 static void Run ( intf_thread_t * );
62 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
63 vlc_value_t oval, vlc_value_t nval, void *param );
65 /*****************************************************************************
67 *****************************************************************************/
68 #define POSITION_TEXT N_("Flip vertical position")
69 #define POSITION_LONGTEXT N_("Display XOSD output at the bottom of the " \
70 "screen instead of the top.")
72 #define TXT_OFS_TEXT N_("Vertical offset")
73 #define TXT_OFS_LONGTEXT N_("Vertical offset between the border of the screen "\
74 "and the displayed text (in pixels, defaults to "\
77 #define SHD_OFS_TEXT N_("Shadow offset")
78 #define SHD_OFS_LONGTEXT N_("Offset between the text and the shadow (in " \
79 "pixels, defaults to 2 pixels)." )
81 #define FONT_TEXT N_("Font")
82 #define FONT_LONGTEXT N_("Font used to display text in the XOSD output.")
83 #define COLOUR_TEXT N_("Color")
84 #define COLOUR_LONGTEXT N_("Color used to display text in the XOSD output.")
87 set_category( CAT_INTERFACE );
88 set_subcategory( SUBCAT_INTERFACE_CONTROL );
89 set_description( N_("XOSD interface") );
90 set_shortname( "XOSD" );
91 add_bool( "xosd-position", 1, NULL, POSITION_TEXT, POSITION_LONGTEXT, true );
92 add_integer( "xosd-text-offset", 30, NULL, TXT_OFS_TEXT, TXT_OFS_LONGTEXT, true );
93 add_integer( "xosd-shadow-offset", 2, NULL,
94 SHD_OFS_TEXT, SHD_OFS_LONGTEXT, true );
95 add_string( "xosd-font",
96 "-adobe-helvetica-bold-r-normal-*-*-160-*-*-p-*-iso8859-1",
97 NULL, FONT_TEXT, FONT_LONGTEXT, true );
98 add_string( "xosd-colour", "LawnGreen",
99 NULL, COLOUR_TEXT, COLOUR_LONGTEXT, true );
100 set_capability( "interface", 10 );
101 set_callbacks( Open, Close );
104 /*****************************************************************************
105 * Open: initialize and create stuff
106 *****************************************************************************/
107 static int Open( vlc_object_t *p_this )
109 intf_thread_t *p_intf = (intf_thread_t *)p_this;
112 /* Allocate instance and initialize some members */
113 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
114 if( p_intf->p_sys == NULL )
116 msg_Err( p_intf, "out of memory" );
120 if( getenv( "DISPLAY" ) == NULL )
122 msg_Err( p_intf, "no display, please set the DISPLAY variable" );
126 /* Initialize library */
127 #if defined(HAVE_XOSD_VERSION_0) || defined(HAVE_XOSD_VERSION_1)
128 p_osd = p_intf->p_sys->p_osd =
129 xosd_init( config_GetPsz( p_intf, "xosd-font" ),
130 config_GetPsz( p_intf,"xosd-colour" ), 3,
132 if( p_intf->p_sys->p_osd == NULL )
134 msg_Err( p_intf, "couldn't initialize libxosd" );
138 p_osd = p_intf->p_sys->p_osd = xosd_create( 1 );
141 msg_Err( p_intf, "couldn't initialize libxosd" );
144 xosd_set_colour( p_osd, config_GetPsz( p_intf,"xosd-colour" ) );
145 xosd_set_timeout( p_osd, 3 );
149 playlist_t *p_playlist = pl_Yield( p_intf );
150 var_AddCallback( p_playlist, "playlist-current", PlaylistNext, p_this );
151 var_AddCallback( p_playlist, "item-change", PlaylistNext, p_this );
152 pl_Release( p_intf );
154 /* Set user preferences */
155 xosd_set_font( p_intf->p_sys->p_osd,
156 config_GetPsz( p_intf, "xosd-font" ) );
157 xosd_set_outline_colour( p_intf->p_sys->p_osd,"black" );
158 #ifdef HAVE_XOSD_VERSION_2
159 xosd_set_horizontal_offset( p_intf->p_sys->p_osd,
160 config_GetInt( p_intf, "xosd-text-offset" ) );
161 xosd_set_vertical_offset( p_intf->p_sys->p_osd,
162 config_GetInt( p_intf, "xosd-text-offset" ) );
164 xosd_set_offset( p_intf->p_sys->p_osd,
165 config_GetInt( p_intf, "xosd-text-offset" ) );
167 xosd_set_shadow_offset( p_intf->p_sys->p_osd,
168 config_GetInt( p_intf, "xosd-shadow-offset" ));
169 xosd_set_pos( p_intf->p_sys->p_osd,
170 config_GetInt( p_intf, "xosd-position" ) ?
171 XOSD_bottom: XOSD_top );
173 /* Initialize to NULL */
174 xosd_display( p_osd, 0, XOSD_string, "XOSD interface initialized" );
176 p_intf->pf_run = Run;
178 p_intf->p_sys->b_need_update = true;
183 /*****************************************************************************
184 * Close: destroy interface stuff
185 *****************************************************************************/
186 static void Close( vlc_object_t *p_this )
188 intf_thread_t *p_intf = (intf_thread_t *)p_this;
189 playlist_t *p_playlist = pl_Yield( p_intf );
190 var_DelCallback( p_playlist, "playlist-current", PlaylistNext, p_this );
191 var_DelCallback( p_playlist, "item-change", PlaylistNext, p_this );
192 pl_Release( p_intf );
194 /* Uninitialize library */
195 xosd_destroy( p_intf->p_sys->p_osd );
197 /* Destroy structure */
198 free( p_intf->p_sys );
201 /*****************************************************************************
203 *****************************************************************************
204 * This part of the interface runs in a separate thread
205 *****************************************************************************/
206 static void Run( intf_thread_t *p_intf )
208 playlist_t *p_playlist;
209 playlist_item_t *p_item = NULL;
210 input_item_t *p_input;
211 char psz_duration[MSTRTIME_MAX_SIZE+2];
212 char *psz_display = NULL;
214 while( vlc_object_alive (p_intf) )
216 if( p_intf->p_sys->b_need_update == true )
218 p_intf->p_sys->b_need_update = false;
219 p_playlist = pl_Yield( p_intf );
221 if( playlist_IsEmpty( p_playlist ) )
223 pl_Release( p_playlist );
228 if( p_playlist->status.i_status == PLAYLIST_STOPPED )
230 psz_display = strdup(_("Stop"));
231 pl_Release( p_playlist );
233 else if( p_playlist->status.i_status == PLAYLIST_PAUSED )
235 psz_display = strdup(_("Pause"));
236 pl_Release( p_playlist );
240 p_item = p_playlist->status.p_item;
241 p_input = p_item->p_input;
243 pl_Release( p_playlist );
247 mtime_t i_duration = input_item_GetDuration( p_input );
248 if( i_duration != -1 )
250 char psz_durationstr[MSTRTIME_MAX_SIZE];
251 secstotimestr( psz_durationstr, i_duration / 1000000 );
252 sprintf( psz_duration, "(%s)", psz_durationstr );
256 sprintf( psz_duration," " );
259 psz_display = (char *)malloc( sizeof(char )*
260 (strlen( p_input->psz_name ) +
261 MSTRTIME_MAX_SIZE + 2+6 + 10 +10 ));
262 sprintf( psz_display,"%s %s",
263 p_input->psz_name, psz_duration);
267 xosd_display( p_intf->p_sys->p_osd,
273 msleep( INTF_IDLE_SLEEP );
277 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
278 vlc_value_t oval, vlc_value_t nval, void *param )
280 intf_thread_t *p_intf = (intf_thread_t *)param;
282 p_intf->p_sys->b_need_update = true;