]> git.sesse.net Git - vlc/blob - modules/gui/qt4/qt4.cpp
Qt4: drop window provider priority to zero
[vlc] / modules / gui / qt4 / qt4.cpp
1 /*****************************************************************************
2  * qt4.cpp : QT4 interface
3  ****************************************************************************
4  * Copyright © 2006-2009 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 <QDate>
31
32 #include "qt4.hpp"
33
34 #include "input_manager.hpp"    /* THEMIM creation */
35 #include "dialogs_provider.hpp" /* THEDP creation */
36 #include "main_interface.hpp"   /* MainInterface creation */
37 #include "dialogs/help.hpp"     /* Launch Update */
38 #include "recents.hpp"          /* Recents Item destruction */
39 #include "util/qvlcapp.hpp"     /* QVLCApplication definition */
40
41 #ifdef Q_WS_X11
42  #include <vlc_xlib.h>
43 #endif
44
45 #include "../../../share/icons/32x32/vlc.xpm"
46 #include "../../../share/icons/32x32/vlc-christmas.xpm"
47 #include <vlc_plugin.h>
48
49 #ifdef WIN32 /* For static builds */
50  #include <QtPlugin>
51  Q_IMPORT_PLUGIN(qjpeg)
52  Q_IMPORT_PLUGIN(qtaccessiblewidgets)
53 #endif
54
55 /*****************************************************************************
56  * Local prototypes.
57  *****************************************************************************/
58 static int  OpenIntf     ( vlc_object_t * );
59 static int  OpenDialogs  ( vlc_object_t * );
60 static int  Open         ( vlc_object_t *, bool );
61 static void Close        ( vlc_object_t * );
62 static int  WindowOpen   ( vlc_object_t * );
63 static void WindowClose  ( vlc_object_t * );
64 static void *Thread      ( void * );
65 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
66
67 /*****************************************************************************
68  * Module descriptor
69  *****************************************************************************/
70 #define ADVANCED_PREFS_TEXT N_( "Show advanced preferences over simple ones" )
71 #define ADVANCED_PREFS_LONGTEXT N_( "Show advanced preferences and not simple "\
72                                     "preferences when opening the preferences "\
73                                     "dialog." )
74
75 #define SYSTRAY_TEXT N_( "Systray icon" )
76 #define SYSTRAY_LONGTEXT N_( "Show an icon in the systray " \
77                              "allowing you to control VLC media player " \
78                              "for basic actions." )
79
80 #define MINIMIZED_TEXT N_( "Start VLC with only a systray icon" )
81 #define MINIMIZED_LONGTEXT N_( "VLC will start with just an icon in " \
82                                "your taskbar" )
83
84 #define KEEPSIZE_TEXT N_( "Resize interface to the native video size" )
85 #define KEEPSIZE_LONGTEXT N_( "You have two choices:\n" \
86             " - The interface will resize to the native video size\n" \
87             " - The video will fit to the interface size\n " \
88             "By default, interface resize to the native video size." )
89
90 #define TITLE_TEXT N_( "Show playing item name in window title" )
91 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
92                            "controler window title." )
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 OPACITY_FS_TEXT N_( "Fullscreen controller opacity between 0.1 and 1" )
110 #define OPACITY_FS_LONGTEXT N_( "Sets the fullscreen controller opacity between 0.1 and 1 " \
111                              "for main interface, playlist and extended panel."\
112                              " This option only works with Windows and " \
113                              "X11 with composite extensions." )
114
115
116 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
117
118 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
119 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
120                             "versions of the software. It runs once every " \
121                             "two weeks." )
122 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
123
124 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
125 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
126                                  "400%, instead of 0% to 200%. This option " \
127                                  "can distort the audio, since it uses " \
128                                  "software amplification." )
129
130 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
131
132 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
133
134 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
135
136 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
137 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
138         "the recent items played in the player" )
139
140 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
141 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
142                        "By specifying the 12 numbers separated by a ';'\n" \
143             "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
144             "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
145
146 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
147 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
148                              " - normal mode\n"  \
149                              " - a zone always present to show information " \
150                                   "as lyrics, album arts...\n" \
151                              " - minimal mode with limited controls" )
152
153 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
154 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
155
156 #define FULLSCREEN_NUMBER_TEXT N_( "Define which screen fullscreen goes" )
157 #define FULLSCREEN_NUMBER_LONGTEXT N_( "Screennumber of fullscreen, instead of" \
158                                        "same screen where interface is" )
159
160 #define QT_AUTOLOAD_EXTENSIONS_TEXT N_( "Load extensions on startup" )
161 #define QT_AUTOLOAD_EXTENSIONS_LONGTEXT N_( "Automatically load the "\
162                                             "extensions module on startup" )
163
164 #define QT_MINIMAL_MODE_TEXT N_("Start in minimal view (without menus)" )
165
166 /**********************************************************************/
167 vlc_module_begin ()
168     set_shortname( "Qt" )
169     set_description( N_("Qt interface") )
170     set_category( CAT_INTERFACE )
171     set_subcategory( SUBCAT_INTERFACE_MAIN )
172     set_capability( "interface", 151 )
173     set_callbacks( OpenIntf, Close )
174
175     add_shortcut("qt")
176
177     add_bool( "qt-minimal-view", false, NULL, QT_MINIMAL_MODE_TEXT,
178               QT_MINIMAL_MODE_TEXT, false );
179
180     add_bool( "qt-notification", true, NULL, NOTIFICATION_TEXT,
181               NOTIFICATION_LONGTEXT, false )
182
183     add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
184                           OPACITY_LONGTEXT, false )
185     add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., NULL, OPACITY_FS_TEXT,
186                           OPACITY_FS_LONGTEXT, false )
187
188     add_bool( "qt-system-tray", true, NULL, SYSTRAY_TEXT,
189               SYSTRAY_LONGTEXT, false)
190     add_bool( "qt-start-minimized", false, NULL, MINIMIZED_TEXT,
191               MINIMIZED_LONGTEXT, true)
192     add_bool( "qt-video-autoresize", true, NULL, KEEPSIZE_TEXT,
193               KEEPSIZE_LONGTEXT, false )
194     add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
195               TITLE_LONGTEXT, false )
196     add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
197               QT_FULLSCREEN_TEXT, false )
198
199     add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
200               COMPLETEVOL_LONGTEXT, true )
201     add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
202               SAVEVOL_TEXT, true )
203
204     add_bool( "qt-embedded-open", false, NULL, QT_NATIVEOPEN_TEXT,
205                QT_NATIVEOPEN_TEXT, false )
206     add_bool( "qt-recentplay", true, NULL, RECENTPLAY_TEXT,
207               RECENTPLAY_TEXT, false )
208     add_string( "qt-recentplay-filter", "", NULL,
209                 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
210
211     add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
212               ADVANCED_OPTIONS_LONGTEXT, true )
213     add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
214               ADVANCED_PREFS_LONGTEXT, false )
215     add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
216               ERROR_TEXT, false )
217 #ifdef UPDATE_CHECK
218     add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
219               UPDATER_LONGTEXT, false )
220     add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
221                  UPDATER_DAYS_TEXT, false )
222 #endif
223     add_string( "qt-slider-colours",
224                 "255;255;255;20;210;20;255;199;15;245;39;29",
225                 NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
226
227     add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
228               false )
229         change_private ()
230
231     add_integer( "qt-fullscreen-screennumber", -1, NULL, FULLSCREEN_NUMBER_TEXT,
232                FULLSCREEN_NUMBER_LONGTEXT, false );
233
234     add_bool( "qt-autoload-extensions", true, NULL,
235               QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
236               false )
237
238     add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
239     add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
240
241 #ifdef WIN32
242     cannot_unload_broken_library()
243 #endif
244
245     add_submodule ()
246         set_description( "Dialogs provider" )
247         set_capability( "dialogs provider", 51 )
248
249         set_callbacks( OpenDialogs, Close )
250
251 #if defined(Q_WS_X11) || defined(Q_WS_WIN)
252     add_submodule ()
253 #if defined(Q_WS_X11)
254         set_capability( "vout window xid", 0 )
255 #elif defined(Q_WS_WIN)
256         set_capability( "vout window hwnd", 0 )
257 #endif
258         set_callbacks( WindowOpen, WindowClose )
259 #endif
260
261 vlc_module_end ()
262
263 /*****************************************/
264
265 /* Ugly, but the Qt4 interface assumes single instance anyway */
266 static vlc_sem_t ready;
267 #ifdef Q_WS_X11
268 static char *x11_display = NULL;
269 #endif
270 static struct
271 {
272     vlc_mutex_t lock;
273     bool busy;
274 } one = { VLC_STATIC_MUTEX, false };
275
276 /*****************************************************************************
277  * Module callbacks
278  *****************************************************************************/
279
280 /* Open Interface */
281 static int Open( vlc_object_t *p_this, bool isDialogProvider )
282 {
283     intf_thread_t *p_intf = (intf_thread_t *)p_this;
284
285 #ifdef Q_WS_X11
286     if( !vlc_xlib_init( p_this ) )
287         return VLC_EGENERIC;
288
289     char *display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
290     Display *p_display = XOpenDisplay( x11_display );
291     if( !p_display )
292     {
293         msg_Err( p_intf, "Could not connect to X server" );
294         free (display);
295         return VLC_EGENERIC;
296     }
297     XCloseDisplay( p_display );
298 #else
299     char *display = NULL;
300 #endif
301
302     bool busy;
303     vlc_mutex_lock (&one.lock);
304     busy = one.busy;
305     one.busy = true;
306     vlc_mutex_unlock (&one.lock);
307     if (busy)
308     {
309         msg_Err (p_this, "cannot start Qt4 multiple times");
310         free (display);
311         return VLC_EGENERIC;
312     }
313
314     /* Allocations of p_sys */
315     intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
316     p_intf->p_sys->b_isDialogProvider = isDialogProvider;
317     p_sys->p_mi = NULL;
318     p_sys->p_playlist = pl_Get( p_intf );
319
320     /* */
321 #ifdef Q_WS_X11
322     x11_display = display;
323 #endif
324     vlc_sem_init (&ready, 0);
325     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
326     {
327         delete p_sys;
328         free (display);
329         vlc_mutex_lock (&one.lock);
330         one.busy = false;
331         vlc_mutex_unlock (&one.lock);
332         return VLC_ENOMEM;
333     }
334
335     /* */
336     vlc_sem_wait (&ready);
337     vlc_sem_destroy (&ready);
338
339     if( !p_sys->b_isDialogProvider )
340     {
341         playlist_t *pl = pl_Get(p_this);
342         var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
343         var_SetAddress (pl, "qt4-iface", p_this);
344         var_Create (pl, "window", VLC_VAR_STRING);
345         var_SetString (pl, "window", "qt4,any");
346     }
347     return VLC_SUCCESS;
348 }
349
350 /* Open qt4 interface */
351 static int OpenIntf( vlc_object_t *p_this )
352 {
353     return Open( p_this, false );
354 }
355
356 /* Open Dialog Provider */
357 static int OpenDialogs( vlc_object_t *p_this )
358 {
359     return Open( p_this, true );
360 }
361
362 static void Close( vlc_object_t *p_this )
363 {
364     intf_thread_t *p_intf = (intf_thread_t *)p_this;
365     intf_sys_t *p_sys = p_intf->p_sys;
366
367     if( !p_sys->b_isDialogProvider )
368     {
369         var_Destroy (pl_Get(p_this), "window");
370         var_Destroy (pl_Get(p_this), "qt4-iface");
371     }
372
373     QVLCApp::triggerQuit();
374
375     vlc_join (p_sys->thread, NULL);
376 #ifdef Q_WS_X11
377     free (x11_display);
378     x11_display = NULL;
379 #endif
380     delete p_sys;
381     vlc_mutex_lock (&one.lock);
382     one.busy = false;
383     vlc_mutex_unlock (&one.lock);
384 }
385
386 static void *Thread( void *obj )
387 {
388     intf_thread_t *p_intf = (intf_thread_t *)obj;
389     MainInterface *p_mi;
390     char dummy[] = "vlc"; /* for WM_CLASS */
391     char *argv[4] = { dummy, NULL, };
392     int argc = 1;
393
394     Q_INIT_RESOURCE( vlc );
395
396     /* Start the QApplication here */
397 #ifdef Q_WS_X11
398     if( x11_display != NULL )
399     {
400         argv[argc++] = const_cast<char *>("-display");
401         argv[argc++] = x11_display;
402         argv[argc] = NULL;
403     }
404 #endif
405
406     QVLCApp app( argc, argv );
407
408     p_intf->p_sys->p_app = &app;
409
410
411     /* All the settings are in the .conf/.ini style */
412     p_intf->p_sys->mainSettings = new QSettings(
413 #ifdef WIN32
414             QSettings::IniFormat,
415 #else
416             QSettings::NativeFormat,
417 #endif
418             QSettings::UserScope, "vlc", "vlc-qt-interface" );
419
420     /* Icon setting */
421     if( QDate::currentDate().dayOfYear() >= 352 ) /* One Week before Xmas */
422         app.setWindowIcon( QIcon(vlc_christmas_xpm) );
423     else
424         app.setWindowIcon( QIcon(vlc_xpm) );
425
426     /* Initialize timers and the Dialog Provider */
427     DialogsProvider::getInstance( p_intf );
428
429     /* Detect screensize for small screens like TV or EEEpc*/
430     p_intf->p_sys->i_screenHeight =
431         app.QApplication::desktop()->availableGeometry().height();
432
433 #ifdef UPDATE_CHECK
434     /* Checking for VLC updates */
435     if( var_InheritBool( p_intf, "qt-updates-notif" ) &&
436         !var_InheritBool( p_intf, "qt-privacy-ask" ) )
437     {
438         int interval = var_InheritInteger( p_intf, "qt-updates-days" );
439         if( QDate::currentDate() >
440              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
441         {
442             /* The constructor of the update Dialog will do the 1st request */
443             UpdateDialog::getInstance( p_intf );
444             getSettings()->setValue( "updatedate", QDate::currentDate() );
445         }
446     }
447 #endif
448
449     /* Create the normal interface in non-DP mode */
450     if( !p_intf->p_sys->b_isDialogProvider )
451         p_mi = new MainInterface( p_intf );
452     else
453         p_mi = NULL;
454     p_intf->p_sys->p_mi = p_mi;
455
456     /* Explain how to show a dialog :D */
457     p_intf->pf_show_dialog = ShowDialog;
458
459     /* */
460     vlc_sem_post (&ready);
461
462     /* Last settings */
463     app.setQuitOnLastWindowClosed( false );
464
465     /* Retrieve last known path used in file browsing */
466     p_intf->p_sys->filepath =
467          getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
468
469     /* Loads and tries to apply the preferred QStyle */
470     QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
471     if( s_style.compare("") != 0 )
472         QApplication::setStyle( s_style );
473
474     /* Launch */
475     app.exec();
476
477     /* And quit */
478     QApplication::closeAllWindows();
479
480     if (p_mi != NULL)
481     {
482 #warning BUG!
483         /* FIXME: the video window may still be registerd at this point */
484         /* See LP#448082 as an example. */
485
486         p_intf->p_sys->p_mi = NULL;
487         /* Destroy first the main interface because it is connected to some
488            slots in the MainInputManager */
489         delete p_mi;
490     }
491
492     /* Destroy all remaining windows,
493        because some are connected to some slots
494        in the MainInputManager
495        Settings must be destroyed after that.
496      */
497     DialogsProvider::killInstance();
498
499     /* Delete the recentsMRL object before the configuration */
500     RecentsMRL::killInstance();
501
502     /* Save the path */
503     getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
504
505     /* Delete the configuration. Application has to be deleted after that. */
506     delete p_intf->p_sys->mainSettings;
507
508     /* Destroy the MainInputManager */
509     MainInputManager::killInstance();
510
511     /* Delete the application automatically */
512     return NULL;
513 }
514
515 /*****************************************************************************
516  * Callback to show a dialog
517  *****************************************************************************/
518 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
519                         intf_dialog_args_t *p_arg )
520 {
521     VLC_UNUSED( p_intf );
522     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
523     QApplication::postEvent( THEDP, event );
524 }
525
526 /**
527  * Video output window provider
528  *
529  * TODO move it out of here ?
530  */
531 #include <vlc_vout_window.h>
532
533 static int WindowControl( vout_window_t *, int i_query, va_list );
534
535 static int WindowOpen( vlc_object_t *p_obj )
536 {
537     vout_window_t *p_wnd = (vout_window_t*)p_obj;
538
539     /* */
540     if( p_wnd->cfg->is_standalone )
541         return VLC_EGENERIC;
542 #if defined (Q_WS_X11)
543     if( var_InheritBool( p_obj, "video-wallpaper" ) )
544         return VLC_EGENERIC;
545 #endif
546
547     vlc_value_t val;
548     if( var_Inherit( p_obj, "qt4-iface", VLC_VAR_ADDRESS, &val ) )
549         val.p_address = NULL;
550
551     intf_thread_t *p_intf = (intf_thread_t *)val.p_address;
552
553     if( !p_intf )
554     {   /* If another interface is used, this plugin cannot work */
555         msg_Dbg( p_obj, "Qt4 interface not found" );
556         return VLC_EGENERIC;
557     }
558
559     MainInterface *p_mi = p_intf->p_sys->p_mi;
560     msg_Dbg( p_obj, "requesting video..." );
561
562     int i_x = p_wnd->cfg->x;
563     int i_y = p_wnd->cfg->y;
564     unsigned i_width = p_wnd->cfg->width;
565     unsigned i_height = p_wnd->cfg->height;
566
567 #if defined (Q_WS_X11)
568     p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
569     if( !p_wnd->handle.xid )
570         return VLC_EGENERIC;
571     p_wnd->display.x11 = x11_display;
572
573 #elif defined (Q_WS_WIN)
574     p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
575     if( !p_wnd->handle.hwnd )
576         return VLC_EGENERIC;
577 #else
578 # error FIXME
579 #endif
580
581     p_wnd->control = WindowControl;
582     p_wnd->sys = (vout_window_sys_t*)p_mi;
583     return VLC_SUCCESS;
584 }
585
586 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
587 {
588     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
589     return p_mi->controlVideo( i_query, args );
590 }
591
592 static void WindowClose( vlc_object_t *p_obj )
593 {
594     vout_window_t *p_wnd = (vout_window_t*)p_obj;
595     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
596
597     msg_Dbg( p_obj, "releasing video..." );
598     p_mi->releaseVideo();
599 }
600