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