Add a missing word.
[vlc.git] / modules / gui / qt4 / qt4.cpp
1 /*****************************************************************************
2  * qt4.cpp : QT4 interface
3  ****************************************************************************
4  * Copyright (C) 2006-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Jean-Baptiste Kempf <jb@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <QApplication>
29 #include <QLocale>
30 #include <QTranslator>
31 #include <QDate>
32
33 #include "qt4.hpp"
34 #include <vlc_os_specific.h>
35 #include "dialogs_provider.hpp"
36 #include "input_manager.hpp"
37 #include "main_interface.hpp"
38 #include "dialogs/help.hpp" /* update */
39
40 #ifdef HAVE_X11_XLIB_H
41 #include <X11/Xlib.h>
42 #endif
43
44 #include "../../../share/vlc32x32.xpm"
45 #include "../../../share/vlc32x32-christmas.xpm"
46
47 /*****************************************************************************
48  * Local prototypes.
49  *****************************************************************************/
50 static int  Open         ( vlc_object_t * );
51 static void Close        ( vlc_object_t * );
52 static int  OpenDialogs  ( vlc_object_t * );
53 static void Run          ( intf_thread_t * );
54 static void Init         ( intf_thread_t * );
55 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
56
57 /*****************************************************************************
58  * Module descriptor
59  *****************************************************************************/
60 #define ADVANCED_PREFS_TEXT N_( "Show advanced prefs over simple ones" )
61 #define ADVANCED_PREFS_LONGTEXT N_( "Show advanced preferences and not simple "\
62                                     "preferences when opening the preferences "\
63                                     "dialog." )
64
65 #define SYSTRAY_TEXT N_( "Systray icon" )
66 #define SYSTRAY_LONGTEXT N_( "Show an icon in the systray " \
67                              "allowing you to control VLC media player " \
68                              "for basic actions" )
69
70 #define MINIMIZED_TEXT N_( "Start VLC with only a systray icon" )
71 #define MINIMIZED_LONGTEXT N_( "When you launch VLC with that option, " \
72                                "VLC will start with just an icon in" \
73                                "your taskbar" )
74
75 #define TITLE_TEXT N_( "Show playing item name in window title" )
76 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
77                            "controler window title" )
78
79 #define FILEDIALOG_PATH_TEXT N_( "Path to use in openfile dialog" )
80
81 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
82 #define NOTIFICATION_LONGTEXT N_( \
83     "Show a notification popup with the artist and track name when " \
84     "the current playlist item changes, when VLC is minimized or hidden." )
85
86 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
87 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
88                                       "in the dialogs" )
89
90 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1." )
91 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
92                              "for main interface, playlist and extended panel." \
93                              " This option only works with Windows and " \
94                              "X11 with composite extensions." )
95
96 #define SHOWFLAGS_TEXT N_( "Define what columns to show in playlist window" )
97 #define SHOWFLAGS_LONGTEXT N_( "Enter the sum of the options that you want: \n" \
98                                "Title: 1; Duration: 2; Artist: 4; Genre: 8; " \
99                            "Copyright: 16; Collection/album: 32; Rating: 256." )
100
101 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
102
103 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
104 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
105                             "versions of the software. It runs once a week." )
106 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
107
108 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
109 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
110                                  "400%, instead of 0% to 200%. This option " \
111                                  "can distort the audio, since it uses " \
112                                  "software amplification." )
113
114 #define BLING_TEXT N_( "Use non native buttons and volume slider" )
115
116 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
117
118
119 #define VIEWDETAIL_TEXT N_( "Show the opening dialog view in detail mode" )
120
121 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
122 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
123                              " - normal mode\n"  \
124                              " - a zone always present to show information" \
125                                   "as lyrics, album arts...\n" \
126                              " - minimal mode with limited controls" )
127
128 #define QT_NORMAL_MODE_TEXT N_( "Classic look" )
129 #define QT_ALWAYS_VIDEO_MODE_TEXT N_( "Complete look with information area" )
130 #define QT_MINIMAL_MODE_TEXT N_( "Minimal look with no menus" )
131
132 static int i_mode_list[] =
133     { QT_NORMAL_MODE, QT_ALWAYS_VIDEO_MODE, QT_MINIMAL_MODE };
134 static const char *psz_mode_list_text[] =
135     { QT_NORMAL_MODE_TEXT, QT_ALWAYS_VIDEO_MODE_TEXT, QT_MINIMAL_MODE_TEXT };
136
137 vlc_module_begin();
138     set_shortname( (char *)"Qt" );
139     set_description( (char*)_("Qt interface") );
140     set_category( CAT_INTERFACE ) ;
141     set_subcategory( SUBCAT_INTERFACE_MAIN );
142     set_capability( "interface", 151 );
143     set_callbacks( Open, Close );
144
145     add_shortcut("qt");
146
147     add_submodule();
148         set_description( "Dialogs provider" );
149         set_capability( "dialogs provider", 51 );
150
151         add_integer( "qt-display-mode", QT_NORMAL_MODE, NULL,
152                      QT_MODE_TEXT, QT_MODE_LONGTEXT, VLC_FALSE );
153             change_integer_list( i_mode_list, psz_mode_list_text, 0 );
154
155         add_bool( "qt-notification", VLC_TRUE, NULL, NOTIFICATION_TEXT,
156                   NOTIFICATION_LONGTEXT, VLC_FALSE );
157
158         add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
159                   OPACITY_LONGTEXT, VLC_FALSE );
160         add_bool( "qt-blingbling", VLC_TRUE, NULL, BLING_TEXT,
161                   BLING_TEXT, VLC_FALSE );
162
163         add_bool( "qt-system-tray", VLC_TRUE, NULL, SYSTRAY_TEXT,
164                 SYSTRAY_LONGTEXT, VLC_FALSE);
165         add_bool( "qt-start-minimized", VLC_FALSE, NULL, MINIMIZED_TEXT,
166                 MINIMIZED_LONGTEXT, VLC_TRUE);
167         add_bool( "qt-name-in-title", VLC_TRUE, NULL, TITLE_TEXT,
168                   TITLE_LONGTEXT, VLC_FALSE );
169
170         add_bool( "qt-volume-complete", VLC_FALSE, NULL, COMPLETEVOL_TEXT,
171                 COMPLETEVOL_LONGTEXT, VLC_TRUE );
172         add_string( "qt-filedialog-path", NULL, NULL, FILEDIALOG_PATH_TEXT,
173                 FILEDIALOG_PATH_TEXT, VLC_TRUE );
174             change_autosave();
175             change_internal();
176
177         add_bool( "qt-adv-options", VLC_FALSE, NULL, ADVANCED_OPTIONS_TEXT,
178                   ADVANCED_OPTIONS_LONGTEXT, VLC_TRUE );
179         add_bool( "qt-advanced-pref", VLC_FALSE, NULL, ADVANCED_PREFS_TEXT,
180                 ADVANCED_PREFS_LONGTEXT, VLC_FALSE );
181         add_bool( "qt-error-dialogs", VLC_TRUE, NULL, ERROR_TEXT,
182                 ERROR_TEXT, VLC_FALSE );
183 #ifdef UPDATE_CHECK
184         add_bool( "qt-updates-notif", VLC_TRUE, NULL, UPDATER_TEXT,
185                 UPDATER_LONGTEXT, VLC_FALSE );
186         add_integer( "qt-updates-days", 14, NULL, UPDATER_DAYS_TEXT,
187                 UPDATER_DAYS_TEXT, VLC_FALSE );
188 #endif
189
190         add_integer( "qt-pl-showflags",
191                 VLC_META_ENGINE_ARTIST|VLC_META_ENGINE_TITLE|
192                 VLC_META_ENGINE_DURATION|VLC_META_ENGINE_COLLECTION,
193                 NULL, SHOWFLAGS_TEXT,
194                 SHOWFLAGS_LONGTEXT, VLC_TRUE );
195             change_autosave();
196
197         add_bool( "qt-open-detail", VLC_FALSE, NULL, VIEWDETAIL_TEXT,
198                 VIEWDETAIL_TEXT, VLC_FALSE );
199
200         add_bool( "qt-privacy-ask", VLC_TRUE, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
201                 VLC_FALSE );
202
203         set_callbacks( OpenDialogs, Close );
204 vlc_module_end();
205
206 /*****************************************************************************
207  * Module callbacks
208  *****************************************************************************/
209 static int Open( vlc_object_t *p_this )
210 {
211     intf_thread_t *p_intf = (intf_thread_t *)p_this;
212     p_intf->pf_run = Run;
213 #if defined Q_WS_X11 && defined HAVE_X11_XLIB_H
214     /* Thanks for libqt4 calling exit() in QApplication::QApplication()
215      * instead of returning an error, we have to check the X11 display */
216     Display *p_display = XOpenDisplay( NULL );
217     if( !p_display )
218     {
219         msg_Err( p_intf, "Could not connect to X server" );
220         return VLC_EGENERIC;
221     }
222     XCloseDisplay( p_display );
223 #endif
224     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
225     if( !p_intf->p_sys )
226     {
227         msg_Err( p_intf, "Out of memory" );
228         return VLC_ENOMEM;
229     }
230     memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
231
232     p_intf->p_sys->p_playlist = pl_Yield( p_intf );
233     p_intf->p_sys->p_sub = msg_Subscribe( p_intf, MSG_QUEUE_NORMAL );
234
235     p_intf->b_play = VLC_TRUE;
236
237     return VLC_SUCCESS;
238 }
239
240 static int OpenDialogs( vlc_object_t *p_this )
241 {
242     intf_thread_t *p_intf = (intf_thread_t *)p_this;
243     int val = Open( p_this );
244     if( val )
245         return val;
246
247     p_intf->pf_show_dialog = ShowDialog;
248     return VLC_SUCCESS;
249 }
250
251 static void Close( vlc_object_t *p_this )
252 {
253     intf_thread_t *p_intf = (intf_thread_t *)p_this;
254     vlc_mutex_lock( &p_intf->object_lock );
255     p_intf->b_dead = VLC_TRUE;
256     vlc_mutex_unlock( &p_intf->object_lock );
257
258     vlc_object_release( p_intf->p_sys->p_playlist );
259     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
260     free( p_intf->p_sys );
261 }
262
263
264 /*****************************************************************************
265  * Initialize the interface or the dialogs provider
266  *****************************************************************************/
267 static void Run( intf_thread_t *p_intf )
268 {
269     if( p_intf->pf_show_dialog )
270     {
271         if( vlc_thread_create( p_intf, "Qt dialogs", Init, 0, VLC_TRUE ) )
272             msg_Err( p_intf, "failed to create Qt dialogs thread" );
273     }
274     else
275         Init( p_intf );
276 }
277
278 static void Init( intf_thread_t *p_intf )
279 {
280     char dummy[] = "";
281     char *argv[] = { dummy };
282     int argc = 1;
283
284     Q_INIT_RESOURCE( vlc );
285
286 #if !defined(WIN32) && !defined(__APPLE__)
287     /* KLUDGE:
288      * disables icon theme use because that makes Cleanlooks style bug
289      * because it asks gconf for some settings that timeout because of threads
290      * see commits 21610 21622 21654 for reference */
291
292     /* If you don't have a gconftool-2 binary, you should comment this line */
293     QApplication::setDesktopSettingsAware( false );
294 #endif
295
296     /* Start the QApplication here */
297     QApplication *app = new QApplication( argc, argv , true );
298     if( QDate::currentDate().dayOfYear() >= 354 )
299         app->setWindowIcon( QIcon( QPixmap(vlc_christmas_xpm) ) );
300     else
301         app->setWindowIcon( QIcon( QPixmap(vlc_xpm) ) );
302     p_intf->p_sys->p_app = app;
303
304     // Initialize timers and the Dialog Provider
305     DialogsProvider::getInstance( p_intf );
306
307     // Create the normal interface
308     if( !p_intf->pf_show_dialog )
309     {
310         MainInterface *p_mi = new MainInterface( p_intf );
311         p_intf->p_sys->p_mi = p_mi;
312         p_mi->show();
313     }
314     else
315         vlc_thread_ready( p_intf );
316
317
318 #ifdef ENABLE_NLS
319     // Translation - get locale
320     QLocale ql = QLocale::system();
321     // Translations for qt's own dialogs
322     QTranslator qtTranslator( 0 );
323     // Let's find the right path for the translation file
324 #if !defined( WIN32 )
325     QString path =  QString( QT4LOCALEDIR );
326 #else
327     QString path = QString( QString(system_VLCPath()) + DIR_SEP +
328                             "locale" + DIR_SEP );
329 #endif
330     // files depending on locale
331     bool b_loaded = qtTranslator.load( path + "qt_" + ql.name());
332     if (!b_loaded)
333         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
334     app->installTranslator( &qtTranslator );
335 #endif  //ENABLE_NLS
336
337     /* Start playing if needed */
338     if( !p_intf->pf_show_dialog && p_intf->b_play )
339     {
340         playlist_Control( THEPL, PLAYLIST_AUTOPLAY, VLC_FALSE );
341     }
342
343     /* Explain to the core how to show a dialog :D */
344     p_intf->pf_show_dialog = ShowDialog;
345
346     /* Last settings */
347     app->setQuitOnLastWindowClosed( false );
348
349     /*        retrieve last known path used in file browsing */
350     char *psz_path = config_GetPsz( p_intf, "qt-filedialog-path" );
351     p_intf->p_sys->psz_filepath = EMPTY_STR( psz_path ) ? psz_path
352                            : p_intf->p_libvlc->psz_homedir;
353
354 #ifdef UPDATE_CHECK
355     if( config_GetInt( p_intf, "qt-updates-notif" ) )
356     {
357         int interval = config_GetInt( p_intf, "qt-updates-days" );
358         QSettings settings( "vlc", "vlc-qt-interface" );
359         if( QDate::currentDate() > settings.value( "updatedate" ).toDate().addDays( interval ) )
360         {
361             msg_Dbg( p_intf, "Someone said I need to check updates" );
362             /* The constructor of the update Dialog will do the 1st request */
363             UpdateDialog::getInstance( p_intf );
364             settings.setValue( "updatedate", QDate::currentDate() );
365         }
366     }
367 #endif
368
369     /* Launch */
370     app->exec();
371
372     /* And quit */
373
374     /* Destroy first the main interface because it is connected to some slots
375        in the MainInputManager */
376     if( p_intf->p_sys->p_mi ) delete p_intf->p_sys->p_mi;
377
378     /* Destroy then other windows, because some are connected to some slots
379        in the MainInputManager */
380     DialogsProvider::killInstance();
381
382     /* Destroy the MainInputManager */
383     MainInputManager::killInstance();
384
385     config_PutPsz( p_intf, "qt-filedialog-path", p_intf->p_sys->psz_filepath );
386     free( psz_path );
387
388     delete app;
389 }
390
391 /*****************************************************************************
392  * Callback to show a dialog
393  *****************************************************************************/
394 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
395                         intf_dialog_args_t *p_arg )
396 {
397     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
398     QApplication::postEvent( THEDP, static_cast<QEvent*>(event) );
399 }
400
401 /*****************************************************************************
402  * PopupMenuCB: callback to show the popupmenu.
403  *  We don't show the menu directly here because we don't want the
404  *  caller to block for a too long time.
405  *****************************************************************************/
406 static int PopupMenuCB( vlc_object_t *p_this, const char *psz_variable,
407                         vlc_value_t old_val, vlc_value_t new_val, void *param )
408 {
409     intf_thread_t *p_intf = (intf_thread_t *)param;
410     ShowDialog( p_intf, INTF_DIALOG_POPUPMENU, new_val.b_bool, 0 );
411     return VLC_SUCCESS;
412 }