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