308ef1e14a768ec69c099d243ded415569cbc15e
[vlc.git] / modules / gui / qt4 / qt4.cpp
1 /*****************************************************************************
2  * qt4.cpp : QT4 interface
3  ****************************************************************************
4  * Copyright © 2006-2008 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
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <QApplication>
30 #include <QLocale>
31 #include <QTranslator>
32 #include <QDate>
33 #include <QMutex>
34 #include <QMutexLocker>
35 #include <QWaitCondition>
36
37 #include "qt4.hpp"
38 #include "input_manager.hpp"    /* THEMIM creation */
39 #include "dialogs_provider.hpp" /* THEDP creation */
40 #include "main_interface.hpp"   /* MainInterface creation */
41 #include "dialogs/help.hpp"     /* Launch Update */
42 #include "recents.hpp"          /* Recents Item destruction */
43 #include "util/qvlcapp.hpp"
44
45 #ifdef HAVE_X11_XLIB_H
46 #include <X11/Xlib.h>
47 #endif
48
49 #include "../../../share/vlc32x32.xpm"
50 #include "../../../share/vlc32x32-christmas.xpm"
51 #include <vlc_plugin.h>
52
53 #ifdef WIN32
54  #include <QtPlugin>
55  Q_IMPORT_PLUGIN(qjpeg)
56  Q_IMPORT_PLUGIN(qtaccessiblewidgets)
57 #endif
58
59 /*****************************************************************************
60  * Local prototypes.
61  *****************************************************************************/
62 static int  Open         ( vlc_object_t * );
63 static void Close        ( vlc_object_t * );
64 static int  OpenDialogs  ( vlc_object_t * );
65 static int  WindowOpen   ( vlc_object_t * );
66 static void WindowClose  ( vlc_object_t * );
67 static void *Thread      ( void * );
68 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
69
70 /*****************************************************************************
71  * Module descriptor
72  *****************************************************************************/
73 #define ADVANCED_PREFS_TEXT N_( "Show advanced preferences over simple ones" )
74 #define ADVANCED_PREFS_LONGTEXT N_( "Show advanced preferences and not simple "\
75                                     "preferences when opening the preferences "\
76                                     "dialog." )
77
78 #define SYSTRAY_TEXT N_( "Systray icon" )
79 #define SYSTRAY_LONGTEXT N_( "Show an icon in the systray " \
80                              "allowing you to control VLC media player " \
81                              "for basic actions." )
82
83 #define MINIMIZED_TEXT N_( "Start VLC with only a systray icon" )
84 #define MINIMIZED_LONGTEXT N_( "VLC will start with just an icon in " \
85                                "your taskbar" )
86
87 #define TITLE_TEXT N_( "Show playing item name in window title" )
88 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
89                            "controler window title." )
90
91 #define FILEDIALOG_PATH_TEXT N_( "Path to use in openfile dialog" )
92
93 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
94 #define NOTIFICATION_LONGTEXT N_( \
95     "Show a notification popup with the artist and track name when " \
96     "the current playlist item changes, when VLC is minimized or hidden." )
97
98 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
99 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
100                                       "in the dialogs." )
101
102 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1." )
103 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
104                              "for main interface, playlist and extended panel."\
105                              " This option only works with Windows and " \
106                              "X11 with composite extensions." )
107
108 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
109
110 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
111 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
112                             "versions of the software. It runs once every " \
113                             "two weeks." )
114 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
115
116 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
117 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
118                                  "400%, instead of 0% to 200%. This option " \
119                                  "can distort the audio, since it uses " \
120                                  "software amplification." )
121
122 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
123
124 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
125
126 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
127
128 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
129 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
130         "the recent items played in the player" )
131
132 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
133 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
134                        "By specifying the 12 numbers separated by a ';'\n" \
135             "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
136             "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
137
138 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
139 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
140                              " - normal mode\n"  \
141                              " - a zone always present to show information " \
142                                   "as lyrics, album arts...\n" \
143                              " - minimal mode with limited controls" )
144
145 #define QT_NORMAL_MODE_TEXT N_( "Classic look" )
146 #define QT_ALWAYS_VIDEO_MODE_TEXT N_( "Complete look with information area" )
147 #define QT_MINIMAL_MODE_TEXT N_( "Minimal look with no menus" )
148
149 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
150
151 static const int i_mode_list[] =
152     { QT_NORMAL_MODE, QT_ALWAYS_VIDEO_MODE, QT_MINIMAL_MODE };
153 static const char *const psz_mode_list_text[] =
154     { QT_NORMAL_MODE_TEXT, QT_ALWAYS_VIDEO_MODE_TEXT, QT_MINIMAL_MODE_TEXT };
155
156 vlc_module_begin ()
157     set_shortname( "Qt" )
158     set_description( N_("Qt interface") )
159     set_category( CAT_INTERFACE )
160     set_subcategory( SUBCAT_INTERFACE_MAIN )
161     set_capability( "interface", 151 )
162     set_callbacks( Open, Close )
163
164     add_shortcut("qt")
165     add_integer( "qt-display-mode", QT_NORMAL_MODE, NULL,
166                  QT_MODE_TEXT, QT_MODE_LONGTEXT, false );
167         change_integer_list( i_mode_list, psz_mode_list_text, NULL );
168
169     add_bool( "qt-notification", true, NULL, NOTIFICATION_TEXT,
170               NOTIFICATION_LONGTEXT, false );
171
172     add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
173                           OPACITY_LONGTEXT, false );
174
175     add_bool( "qt-system-tray", true, NULL, SYSTRAY_TEXT,
176               SYSTRAY_LONGTEXT, false);
177     add_bool( "qt-start-minimized", false, NULL, MINIMIZED_TEXT,
178               MINIMIZED_LONGTEXT, true);
179     add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
180               TITLE_LONGTEXT, false );
181     add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
182               QT_FULLSCREEN_TEXT, false );
183
184     add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
185               COMPLETEVOL_LONGTEXT, true );
186     add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
187               SAVEVOL_TEXT, true );
188     add_string( "qt-filedialog-path", NULL, NULL, FILEDIALOG_PATH_TEXT,
189                 FILEDIALOG_PATH_TEXT, true );
190         change_autosave ()
191         change_internal ()
192
193     add_bool( "qt-recentplay", true, NULL, RECENTPLAY_TEXT,
194               RECENTPLAY_TEXT, false );
195     add_string( "qt-recentplay-filter", "", NULL,
196                 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false );
197
198     add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
199               ADVANCED_OPTIONS_LONGTEXT, true );
200     add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
201               ADVANCED_PREFS_LONGTEXT, false );
202     add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
203               ERROR_TEXT, false );
204 #ifdef UPDATE_CHECK
205     add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
206               UPDATER_LONGTEXT, false );
207     add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
208                  UPDATER_DAYS_TEXT, false );
209 #endif
210     add_string( "qt-slider-colours",
211                 "255;255;255;20;226;20;255;176;15;235;30;20",
212                 NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false );
213
214     add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
215               false );
216         change_internal ()
217
218     add_submodule ()
219         set_description( "Dialogs provider" )
220         set_capability( "dialogs provider", 51 )
221
222         set_callbacks( OpenDialogs, Close )
223
224     add_submodule ()
225         set_capability( "vout_window", 50 )
226         set_callbacks( WindowOpen, WindowClose )
227
228 vlc_module_end ()
229
230 /* Ugly, but the Qt4 interface assumes single instance anyway */
231 static struct
232 {
233     QMutex lock;
234     QWaitCondition ready;
235 } iface;
236
237 /*****************************************************************************
238  * Module callbacks
239  *****************************************************************************/
240 static int Open( vlc_object_t *p_this )
241 {
242     intf_thread_t *p_intf = (intf_thread_t *)p_this;
243     intf_sys_t *p_sys;
244
245 #if defined Q_WS_X11 && defined HAVE_X11_XLIB_H
246     /* Thanks for libqt4 calling exit() in QApplication::QApplication()
247      * instead of returning an error, we have to check the X11 display */
248     Display *p_display = XOpenDisplay( NULL );
249     if( !p_display )
250     {
251         msg_Err( p_intf, "Could not connect to X server" );
252         return VLC_EGENERIC;
253     }
254     XCloseDisplay( p_display );
255 #endif
256
257     /* Allocations */
258     p_sys = p_intf->p_sys = new intf_sys_t;
259     p_sys->b_isDialogProvider = false;
260     p_sys->p_popup_menu = NULL; /* ??? */
261     p_sys->p_playlist = pl_Hold( p_intf );
262     p_sys->p_mi = NULL;
263
264     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
265     {
266         pl_Release (p_sys->p_playlist);
267         delete p_sys;
268         return VLC_ENOMEM;
269     }
270
271     /* */
272     QMutexLocker locker (&iface.lock);
273     vlc_value_t val;
274
275     while( p_sys->p_mi == NULL && !p_sys->b_isDialogProvider )
276         iface.ready.wait( &iface.lock );
277     var_Create (p_this->p_libvlc, "qt4-iface", VLC_VAR_ADDRESS);
278     val.p_address = p_this;
279     var_Set (p_this->p_libvlc, "qt4-iface", val);
280     return VLC_SUCCESS;
281 }
282
283 static int OpenDialogs( vlc_object_t *p_this )
284 {
285     intf_thread_t *p_intf = (intf_thread_t *)p_this;
286     p_intf->pf_show_dialog = ShowDialog;
287
288     int val = Open( p_this );
289     if( val )
290         return val;
291
292     return VLC_SUCCESS;
293 }
294
295 static void Close( vlc_object_t *p_this )
296 {
297     intf_thread_t *p_intf = (intf_thread_t *)p_this;
298     intf_sys_t *p_sys = p_intf->p_sys;
299
300     var_Destroy (p_this->p_libvlc, "qt4-iface");
301     QApplication::quit();
302
303     vlc_join (p_sys->thread, NULL);
304     pl_Release (p_this);
305     delete p_sys;
306 }
307
308
309
310 static QMutex windowLock;
311 static QWaitCondition windowWait;
312
313 static void *Thread( void *obj )
314 {
315     intf_thread_t *p_intf = (intf_thread_t *)obj;
316     MainInterface *p_mi;
317     char dummy[] = "";
318     char *argv[] = { dummy };
319     int argc = 1;
320
321     Q_INIT_RESOURCE( vlc );
322
323 #if !defined(WIN32) && !defined(__APPLE__)
324     /* KLUDGE:
325      * disables icon theme use because that makes Cleanlooks style bug
326      * because it asks gconf for some settings that timeout because of threads
327      * see commits 21610 21622 21654 for reference */
328
329     /* If you don't have a gconftool-2 binary, you should comment this line */
330     if( strcmp( qVersion(), "4.4.0" ) < 0 ) /* fixed in Qt 4.4.0 */
331         QApplication::setDesktopSettingsAware( false );
332 #endif
333
334     /* Start the QApplication here */
335     QVLCApp *app = new QVLCApp( argc, argv , true );
336     p_intf->p_sys->p_app = app;
337
338     p_intf->p_sys->mainSettings = new QSettings(
339 #ifdef WIN32
340             QSettings::IniFormat,
341 #else
342             QSettings::NativeFormat,
343 #endif
344             QSettings::UserScope, "vlc", "vlc-qt-interface" );
345
346     /* Icon setting */
347     if( QDate::currentDate().dayOfYear() >= 354 )
348         app->setWindowIcon( QIcon( QPixmap(vlc_christmas_xpm) ) );
349     else
350         app->setWindowIcon( QIcon( QPixmap(vlc_xpm) ) );
351
352     /* Initialize timers and the Dialog Provider */
353     DialogsProvider::getInstance( p_intf );
354
355     /* Detect screensize for small screens like TV or EEEpc*/
356     p_intf->p_sys->i_screenHeight =
357         app->QApplication::desktop()->availableGeometry().height();
358
359 #ifdef UPDATE_CHECK
360     /* Checking for VLC updates */
361     if( config_GetInt( p_intf, "qt-updates-notif" ) &&
362         !config_GetInt( p_intf, "qt-privacy-ask" ) )
363     {
364         int interval = config_GetInt( p_intf, "qt-updates-days" );
365         if( QDate::currentDate() >
366              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
367         {
368             /* The constructor of the update Dialog will do the 1st request */
369             UpdateDialog::getInstance( p_intf );
370             getSettings()->setValue( "updatedate", QDate::currentDate() );
371         }
372     }
373 #endif
374
375     /* Create the normal interface in non-DP mode */
376     if( !p_intf->pf_show_dialog )
377         p_mi = new MainInterface( p_intf );
378     else
379         p_mi = NULL;
380
381     /* */
382     iface.lock.lock();
383     p_intf->p_sys->p_mi = p_mi;
384     p_intf->p_sys->b_isDialogProvider = p_mi == NULL;
385     iface.ready.wakeAll();
386     iface.lock.unlock();
387
388     /* Explain to the core how to show a dialog :D */
389     p_intf->pf_show_dialog = ShowDialog;
390
391 #ifdef ENABLE_NLS
392     // Translation - get locale
393 #   if defined (WIN32) || defined (__APPLE__)
394     char* psz_tmp = config_GetPsz( p_intf, "language" );
395     QString lang = qfu( psz_tmp );
396     free( psz_tmp);
397     if (lang == "auto")
398         lang = QLocale::system().name();
399 #   else
400     QString lang = QLocale::system().name();
401 #   endif
402     // Translations for qt's own dialogs
403     QTranslator qtTranslator( 0 );
404     // Let's find the right path for the translation file
405 #if !defined( WIN32 )
406     QString path =  QString( QT4LOCALEDIR );
407 #else
408     QString path = QString( QString(config_GetDataDir()) + DIR_SEP +
409                             "locale" + DIR_SEP + "qt4" + DIR_SEP );
410 #endif
411     // files depending on locale
412     bool b_loaded = qtTranslator.load( path + "qt_" + lang );
413     if (!b_loaded)
414         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
415     app->installTranslator( &qtTranslator );
416 #endif  //ENABLE_NLS
417
418     /* Last settings */
419     app->setQuitOnLastWindowClosed( false );
420
421     /* Retrieve last known path used in file browsing */
422     char *psz_path = config_GetPsz( p_intf, "qt-filedialog-path" );
423     p_intf->p_sys->psz_filepath = EMPTY_STR( psz_path ) ? config_GetHomeDir()
424                                                         : psz_path;
425
426     /* Launch */
427     app->exec();
428
429     /* And quit */
430     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
431
432     QApplication::closeAllWindows();
433
434     if (p_mi != NULL)
435     {
436         QMutexLocker locker (&iface.lock);
437
438         msg_Dbg (p_intf, "destroying the main Qt4 interface");
439         p_intf->p_sys->p_mi = NULL;
440         /* Destroy first the main interface because it is connected to some
441            slots in the MainInputManager */
442         delete p_mi;
443     }
444
445     /* Destroy all remaining windows,
446        because some are connected to some slots
447        in the MainInputManager
448        Settings must be destroyed after that.
449      */
450     DialogsProvider::killInstance();
451
452     /* Delete the recentsMRL object before the configuration */
453     RecentsMRL::killInstance();
454
455     /* Delete the configuration. Application has to be deleted after that. */
456     delete p_intf->p_sys->mainSettings;
457
458     /* Destroy the MainInputManager */
459     MainInputManager::killInstance();
460
461     /* Delete the application */
462     delete app;
463
464     /* Save the path */
465     config_PutPsz( p_intf, "qt-filedialog-path", p_intf->p_sys->psz_filepath );
466     free( psz_path );
467     return NULL;
468 }
469
470 /*****************************************************************************
471  * Callback to show a dialog
472  *****************************************************************************/
473 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
474                         intf_dialog_args_t *p_arg )
475 {
476     VLC_UNUSED( p_intf );
477     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
478     QApplication::postEvent( THEDP, static_cast<QEvent*>(event) );
479 }
480
481 /**
482  * Video output window provider
483  */
484 #include <vlc_window.h>
485
486 static int WindowControl (vout_window_t *, int, va_list);
487
488 static int WindowOpen (vlc_object_t *obj)
489 {
490     vout_window_t *wnd = (vout_window_t *)obj;
491     intf_thread_t *intf = NULL;
492     vlc_value_t val;
493
494     if (config_GetInt (obj, "embedded-video") <= 0)
495         return VLC_EGENERIC;
496
497     QMutexLocker (&iface.lock);
498     if (var_Get (obj->p_libvlc, "qt4-iface", &val) == 0)
499         intf = (intf_thread_t *)val.p_address;
500     if (intf == NULL)
501     {   /* If another interface is used, this plugin cannot work */
502         msg_Dbg (obj, "Qt4 interface not found");
503         return VLC_EGENERIC;
504     }
505
506     MainInterface *p_mi = intf->p_sys->p_mi;
507     msg_Dbg (obj, "requesting video...");
508
509     wnd->handle = p_mi->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
510                                       &wnd->width, &wnd->height);
511     if (!wnd->handle)
512         return VLC_EGENERIC;
513
514     wnd->control = WindowControl;
515     wnd->p_private = p_mi;
516     return VLC_SUCCESS;
517 }
518
519 static int WindowControl (vout_window_t *wnd, int query, va_list args)
520 {
521     MainInterface *p_mi = (MainInterface *)wnd->p_private;
522     QMutexLocker locker (&iface.lock);
523
524     return p_mi->controlVideo (wnd->handle, query, args);
525 }
526
527 static void WindowClose (vlc_object_t *obj)
528 {
529     vout_window_t *wnd = (vout_window_t *)obj;
530     MainInterface *p_mi = (MainInterface *)wnd->p_private;
531     QMutexLocker locker (&iface.lock);
532
533     msg_Dbg (obj, "releasing video...");
534     p_mi->releaseVideo ();
535 }