* all: added a new access_filter module: record + one hotkey to start/stop
[vlc.git] / modules / visualization / xosd.c
1 /*****************************************************************************
2  * xosd.c : X On Screen Display interface
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id$
6  *
7  * Authors: Loïc Minier <lool@videolan.org>
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 implied 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <xosd.h>
31
32 #include <vlc/intf.h>
33
34 #ifdef HAVE_UNISTD_H
35 #    include <unistd.h>
36 #endif
37
38 /*****************************************************************************
39  * intf_sys_t: description and status of rc interface
40  *****************************************************************************/
41 struct intf_sys_t
42 {
43     xosd * p_osd;               /* libxosd handle */
44     vlc_bool_t  b_need_update;   /* Update display ? */
45 };
46
47 #define MAX_LINE_LENGTH 256
48
49 /*****************************************************************************
50  * Local prototypes.
51  *****************************************************************************/
52 static int  Open         ( vlc_object_t * );
53 static void Close        ( vlc_object_t * );
54
55 static void Run          ( intf_thread_t * );
56
57 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
58                 vlc_value_t oval, vlc_value_t nval, void *param );
59
60 /*****************************************************************************
61  * Module descriptor
62  *****************************************************************************/
63 #define POSITION_TEXT N_("Flip vertical position")
64 #define POSITION_LONGTEXT N_("Display xosd output on the bottom of the " \
65                              "screen instead of the top")
66
67 #define TXT_OFS_TEXT N_("Vertical offset")
68 #define TXT_OFS_LONGTEXT N_("Vertical offset in pixels of the displayed text")
69
70 #define SHD_OFS_TEXT N_("Shadow offset")
71 #define SHD_OFS_LONGTEXT N_("Offset in pixels of the shadow")
72
73 #define FONT_TEXT N_("Font")
74 #define FONT_LONGTEXT N_("Font used to display text in the xosd output")
75 /* FIXME FIXME FIXME: Gettextize */
76 #define COLOUR_TEXT ("Colour")
77 #define COLOUR_LONGTEXT ("Colour used to display text in the xosd output")
78
79 vlc_module_begin();
80     set_category( CAT_INTERFACE );
81     set_subcategory( SUBCAT_INTERFACE_CONTROL );
82     set_description( _("XOSD interface") );
83     add_bool( "xosd-position", 1, NULL, POSITION_TEXT, POSITION_LONGTEXT, VLC_TRUE );
84     add_integer( "xosd-text-offset", 30, NULL, TXT_OFS_TEXT, TXT_OFS_LONGTEXT, VLC_TRUE );
85     add_integer( "xosd-shadow-offset", 2, NULL,
86                  SHD_OFS_TEXT, SHD_OFS_LONGTEXT, VLC_TRUE );
87     add_string( "xosd-font",
88                 "-adobe-helvetica-bold-r-normal-*-*-160-*-*-p-*-iso8859-1",
89                 NULL, FONT_TEXT, FONT_LONGTEXT, VLC_TRUE );
90     add_string( "xosd-colour", "LawnGreen",
91                     NULL, COLOUR_TEXT, COLOUR_LONGTEXT, VLC_TRUE );
92     set_capability( "interface", 10 );
93     set_callbacks( Open, Close );
94 vlc_module_end();
95
96 /*****************************************************************************
97  * Open: initialize and create stuff
98  *****************************************************************************/
99 static int Open( vlc_object_t *p_this )
100 {
101     intf_thread_t *p_intf = (intf_thread_t *)p_this;
102
103     /* Allocate instance and initialize some members */
104     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
105     if( p_intf->p_sys == NULL )
106     {
107         msg_Err( p_intf, "out of memory" );
108         return VLC_ENOMEM;
109     }
110
111     if( getenv( "DISPLAY" ) == NULL )
112     {
113         msg_Err( p_intf, "no display, please set the DISPLAY variable" );
114         return VLC_EGENERIC;
115     }
116
117     /* Initialize library */
118     p_intf->p_sys->p_osd =
119 #if defined(HAVE_XOSD_VERSION_0) || defined(HAVE_XOSD_VERSION_1)
120         xosd_init( config_GetPsz( p_intf, "xosd-font" ),
121                    config_GetPsz( p_intf,"xosd-colour" ), 3,
122                    XOSD_top, 0, 1 );
123 #else
124         xosd_init( config_GetPsz( p_intf, "xosd-font" ),
125                    config_GetPsz( p_intf,"xosd-colour" ), 3,
126                     XOSD_top, 0, 0, 1 );
127 #endif
128
129     if( p_intf->p_sys->p_osd == NULL )
130     {
131         msg_Err( p_intf, "couldn't initialize libxosd" );
132         return VLC_EGENERIC;
133     }
134
135     playlist_t *p_playlist =
136             (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
137                                            FIND_ANYWHERE );
138     if( p_playlist == NULL )
139     {
140         return VLC_EGENERIC;
141     }
142
143     var_AddCallback( p_playlist, "playlist-current", PlaylistNext, p_this );
144     var_AddCallback( p_playlist, "item-change", PlaylistNext, p_this );
145
146     vlc_object_release( p_playlist );
147
148     /* Set user preferences */
149     xosd_set_font( p_intf->p_sys->p_osd,
150                     config_GetPsz( p_intf, "xosd-font" ) );
151     xosd_set_outline_colour( p_intf->p_sys->p_osd,"black" );
152 #ifdef HAVE_XOSD_VERSION_2
153     xosd_set_horizontal_offset( p_intf->p_sys->p_osd,
154                     config_GetInt( p_intf, "xosd-text-offset" ) );
155     xosd_set_vertical_offset( p_intf->p_sys->p_osd,
156                     config_GetInt( p_intf, "xosd-text-offset" ) );
157 #else
158     xosd_set_offset( p_intf->p_sys->p_osd,
159                     config_GetInt( p_intf, "xosd-text-offset" ) );
160 #endif
161     xosd_set_shadow_offset( p_intf->p_sys->p_osd,
162                     config_GetInt( p_intf, "xosd-shadow-offset" ));
163     xosd_set_pos( p_intf->p_sys->p_osd,
164                     config_GetInt( p_intf, "xosd-position" ) ?
165                                          XOSD_bottom: XOSD_top );
166
167     /* Initialize to NULL */
168     xosd_display( p_intf->p_sys->p_osd,
169                   0,
170                   XOSD_string,
171                   "xosd interface initialized" );
172
173     p_intf->pf_run = Run;
174
175     p_intf->p_sys->b_need_update = VLC_TRUE;
176
177     return VLC_SUCCESS;
178 }
179
180 /*****************************************************************************
181  * Close: destroy interface stuff
182  *****************************************************************************/
183 static void Close( vlc_object_t *p_this )
184 {
185     intf_thread_t *p_intf = (intf_thread_t *)p_this;
186
187     /* Uninitialize library */
188     xosd_destroy( p_intf->p_sys->p_osd );
189
190     /* Destroy structure */
191     free( p_intf->p_sys );
192 }
193
194 /*****************************************************************************
195  * Run: xosd thread
196  *****************************************************************************
197  * This part of the interface runs in a separate thread
198  *****************************************************************************/
199 static void Run( intf_thread_t *p_intf )
200 {
201     int i_size,i_index;
202     playlist_t *p_playlist;
203     playlist_item_t *p_item = NULL;
204     input_item_t item;
205     char psz_duration[MSTRTIME_MAX_SIZE+2];
206     char *psz_display = NULL;
207
208     while( !p_intf->b_die )
209     {
210         if( p_intf->p_sys->b_need_update == VLC_TRUE )
211         {
212             p_intf->p_sys->b_need_update = VLC_FALSE;
213             p_playlist = (playlist_t *)vlc_object_find( p_intf,
214                                       VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
215             if( !p_playlist )
216             {
217                 continue;
218             }
219
220             if( p_playlist->i_size < 0 || p_playlist->i_index < 0 )
221             {
222                 vlc_object_release( p_playlist );
223                 continue;
224             }
225             if( psz_display )
226             {
227                 free( psz_display );
228                 psz_display = NULL;
229             }
230             if( p_playlist->status.i_status == PLAYLIST_STOPPED )
231             {
232                 psz_display = (char *)malloc( sizeof(char )*strlen(_("Stop")));
233                 sprintf( psz_display,_("Stop") );
234                 vlc_object_release( p_playlist );
235             }
236             else if( p_playlist->status.i_status == PLAYLIST_PAUSED )
237             {
238                 psz_display = (char *)malloc( sizeof(char )*strlen(_("Pause")));
239                 sprintf( psz_display,_("Pause") );
240                 vlc_object_release( p_playlist );
241             }
242             else
243             {
244     //           vlc_mutex_lock(&p_playlist->object_lock );
245                  p_item = p_playlist->status.p_item;
246                 item = p_item->input;
247                 if( !p_item )
248                 {
249                     vlc_object_release( p_playlist );
250      //            vlc_mutex_unlock(&p_playlist->object_lock );
251                     continue;
252                 }
253                 i_size = p_playlist->i_size;
254                 i_index = p_playlist->i_index+1;
255     //            vlc_mutex_unlock(&p_playlist->object_lock );
256
257                 vlc_object_release( p_playlist );
258
259                 if( item.i_duration != -1 )
260                 {
261                     char psz_durationstr[MSTRTIME_MAX_SIZE];
262                     secstotimestr( psz_durationstr, item.i_duration/1000000 );
263                     sprintf( psz_duration, "(%s)", psz_durationstr );
264                 }
265                 else
266                 {
267                     sprintf( psz_duration," " );
268                 }
269
270                 psz_display = (char *)malloc( sizeof(char )*
271                                           (strlen( item.psz_name ) +
272                                           MSTRTIME_MAX_SIZE + 2+6 + 10 +10 ));
273                 sprintf( psz_display," %i/%i - %s %s",
274                          i_index,i_size, item.psz_name, psz_duration);
275             }
276
277             /* Display */
278             xosd_display( p_intf->p_sys->p_osd,
279                             0,                               /* first line */
280                             XOSD_string,
281                             psz_display );
282         }
283
284         msleep( INTF_IDLE_SLEEP );
285     }
286 }
287
288 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
289                 vlc_value_t oval, vlc_value_t nval, void *param )
290 {
291     intf_thread_t *p_intf = (intf_thread_t *)param;
292
293     p_intf->p_sys->b_need_update = VLC_TRUE;
294     return VLC_SUCCESS;
295 }
296