]> git.sesse.net Git - vlc/blob - modules/gui/qt4/qt4.cpp
qt4: make dialog provider initialization less convoluted
[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 <X11/Xlib.h>
43 #endif
44
45 #include "../../../share/vlc32x32.xpm"
46 #include "../../../share/vlc32x32-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 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_NORMAL_MODE_TEXT N_( "Classic" )
154 #define QT_ALWAYS_VIDEO_MODE_TEXT N_( "Complete (with information area)" )
155 #define QT_MINIMAL_MODE_TEXT N_( "Minimal (without menu)" )
156
157 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
158 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
159
160 #define FULLSCREEN_NUMBER_TEXT N_( "Define which screen fullscreen goes" )
161 #define FULLSCREEN_NUMBER_LONGTEXT N_( "Screennumber of fullscreen, instead of" \
162                                        "same screen where interface is" )
163
164 /* Various modes definition */
165 static const int i_mode_list[] =
166     { QT_NORMAL_MODE, QT_ALWAYS_VIDEO_MODE, QT_MINIMAL_MODE };
167 static const char *const psz_mode_list_text[] =
168     { QT_NORMAL_MODE_TEXT, QT_ALWAYS_VIDEO_MODE_TEXT, QT_MINIMAL_MODE_TEXT };
169
170
171 /**********************************************************************/
172 vlc_module_begin ()
173     set_shortname( "Qt" )
174     set_description( N_("Qt interface") )
175     set_category( CAT_INTERFACE )
176     set_subcategory( SUBCAT_INTERFACE_MAIN )
177     set_capability( "interface", 151 )
178     set_callbacks( OpenIntf, Close )
179
180     add_shortcut("qt")
181     add_integer( "qt-display-mode", QT_NORMAL_MODE, NULL,
182                  QT_MODE_TEXT, QT_MODE_LONGTEXT, false )
183         change_integer_list( i_mode_list, psz_mode_list_text, NULL )
184
185     add_bool( "qt-notification", true, NULL, NOTIFICATION_TEXT,
186               NOTIFICATION_LONGTEXT, false )
187
188     add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
189                           OPACITY_LONGTEXT, false )
190     add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., NULL, OPACITY_FS_TEXT,
191                           OPACITY_FS_LONGTEXT, false )
192
193     add_bool( "qt-system-tray", true, NULL, SYSTRAY_TEXT,
194               SYSTRAY_LONGTEXT, false)
195     add_bool( "qt-start-minimized", false, NULL, MINIMIZED_TEXT,
196               MINIMIZED_LONGTEXT, true)
197     add_bool( "qt-video-autoresize", true, NULL, KEEPSIZE_TEXT,
198               KEEPSIZE_LONGTEXT, false )
199     add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
200               TITLE_LONGTEXT, false )
201     add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
202               QT_FULLSCREEN_TEXT, false )
203
204     add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
205               COMPLETEVOL_LONGTEXT, true )
206     add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
207               SAVEVOL_TEXT, true )
208
209     add_bool( "qt-embedded-open", false, NULL, QT_NATIVEOPEN_TEXT,
210                QT_NATIVEOPEN_TEXT, false )
211     add_bool( "qt-recentplay", true, NULL, RECENTPLAY_TEXT,
212               RECENTPLAY_TEXT, false )
213     add_string( "qt-recentplay-filter", "", NULL,
214                 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
215
216     add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
217               ADVANCED_OPTIONS_LONGTEXT, true )
218     add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
219               ADVANCED_PREFS_LONGTEXT, false )
220     add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
221               ERROR_TEXT, false )
222 #ifdef UPDATE_CHECK
223     add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
224               UPDATER_LONGTEXT, false )
225     add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
226                  UPDATER_DAYS_TEXT, false )
227 #endif
228     add_string( "qt-slider-colours",
229                 "255;255;255;20;210;20;255;199;15;245;39;29",
230                 NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
231
232     add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
233               false )
234         change_internal ()
235
236     add_integer( "qt-fullscreen-screennumber", -1, NULL, FULLSCREEN_NUMBER_TEXT,
237                FULLSCREEN_NUMBER_LONGTEXT, false );
238
239     add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
240
241     add_submodule ()
242         set_description( "Dialogs provider" )
243         set_capability( "dialogs provider", 51 )
244
245         set_callbacks( OpenDialogs, Close )
246
247 #if defined(Q_WS_X11) || defined(Q_WS_WIN)
248     add_submodule ()
249 #if defined(Q_WS_X11)
250         set_capability( "vout window xid", 50 )
251 #elif defined(Q_WS_WIN)
252         set_capability( "vout window hwnd", 50 )
253 #endif
254         set_callbacks( WindowOpen, WindowClose )
255 #endif
256
257 vlc_module_end ()
258
259 /*****************************************/
260
261 /* Ugly, but the Qt4 interface assumes single instance anyway */
262 static vlc_sem_t ready;
263 #ifdef Q_WS_X11
264 static char *x11_display = NULL;
265 #endif
266
267 /*****************************************************************************
268  * Module callbacks
269  *****************************************************************************/
270
271 /* Open Interface */
272 static int Open( vlc_object_t *p_this, bool isDialogProvider )
273 {
274     intf_thread_t *p_intf = (intf_thread_t *)p_this;
275
276 #ifdef Q_WS_X11
277     x11_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
278     Display *p_display = XOpenDisplay( x11_display );
279     if( !p_display )
280     {
281         msg_Err( p_intf, "Could not connect to X server" );
282         return VLC_EGENERIC;
283     }
284     XCloseDisplay( p_display );
285     putenv( (char *)"XLIB_SKIP_ARGB_VISUALS=1" );
286 #endif
287
288     /* Allocations of p_sys */
289     intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
290     p_intf->p_sys->b_isDialogProvider = isDialogProvider;
291     p_sys->p_popup_menu = NULL;
292     p_sys->p_mi = NULL;
293     p_sys->p_playlist = pl_Hold( p_intf );
294
295     /* */
296     vlc_sem_init (&ready, 0);
297     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
298     {
299         pl_Release (p_sys->p_playlist);
300         delete p_sys;
301         return VLC_ENOMEM;
302     }
303
304     /* */
305     vlc_sem_wait (&ready);
306     vlc_sem_destroy (&ready);
307
308     if( !p_sys->b_isDialogProvider )
309     {
310         vlc_value_t val;
311         var_Create (p_this->p_libvlc, "qt4-iface", VLC_VAR_ADDRESS);
312         val.p_address = p_this;
313         var_Set (p_this->p_libvlc, "qt4-iface", val);
314     }
315     return VLC_SUCCESS;
316 }
317
318 /* Open qt4 interface */
319 static int OpenIntf( vlc_object_t *p_this )
320 {
321     return Open( p_this, false );
322 }
323
324 /* Open Dialog Provider */
325 static int OpenDialogs( vlc_object_t *p_this )
326 {
327     return Open( p_this, true );
328 }
329
330 static void Close( vlc_object_t *p_this )
331 {
332     intf_thread_t *p_intf = (intf_thread_t *)p_this;
333     intf_sys_t *p_sys = p_intf->p_sys;
334
335     if( !p_sys->b_isDialogProvider )
336         var_Destroy (p_this->p_libvlc, "qt4-iface");
337
338     QVLCApp::triggerQuit();
339
340     vlc_join (p_sys->thread, NULL);
341     pl_Release (p_this);
342     delete p_sys;
343 #ifdef Q_WS_X11
344     free (x11_display);
345 #endif
346 }
347
348 static void *Thread( void *obj )
349 {
350     intf_thread_t *p_intf = (intf_thread_t *)obj;
351     MainInterface *p_mi;
352     char dummy[] = "vlc"; /* for WM_CLASS */
353     char *argv[4] = { dummy, NULL, };
354     int argc = 1;
355
356     Q_INIT_RESOURCE( vlc );
357
358     /* Start the QApplication here */
359 #ifdef Q_WS_X11
360     if( x11_display != NULL )
361     {
362         argv[argc++] = const_cast<char *>("-display");
363         argv[argc++] = x11_display;
364         argv[argc] = NULL;
365     }
366 #endif
367 #ifdef WIN32
368     QVLCApp app( p_intf, argc, argv );
369 #else
370     QVLCApp app( argc, argv );
371 #endif
372     p_intf->p_sys->p_app = &app;
373
374
375     /* All the settings are in the .conf/.ini style */
376     p_intf->p_sys->mainSettings = new QSettings(
377 #ifdef WIN32
378             QSettings::IniFormat,
379 #else
380             QSettings::NativeFormat,
381 #endif
382             QSettings::UserScope, "vlc", "vlc-qt-interface" );
383
384     /* Icon setting */
385     if( QDate::currentDate().dayOfYear() >= 352 ) /* One Week before Xmas */
386         app.setWindowIcon( QIcon(vlc_christmas_xpm) );
387     else
388         app.setWindowIcon( QIcon(vlc_xpm) );
389
390     /* Initialize timers and the Dialog Provider */
391     DialogsProvider::getInstance( p_intf );
392
393     /* Detect screensize for small screens like TV or EEEpc*/
394     p_intf->p_sys->i_screenHeight =
395         app.QApplication::desktop()->availableGeometry().height();
396
397 #ifdef UPDATE_CHECK
398     /* Checking for VLC updates */
399     if( config_GetInt( p_intf, "qt-updates-notif" ) &&
400         !config_GetInt( p_intf, "qt-privacy-ask" ) )
401     {
402         int interval = config_GetInt( p_intf, "qt-updates-days" );
403         if( QDate::currentDate() >
404              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
405         {
406             /* The constructor of the update Dialog will do the 1st request */
407             UpdateDialog::getInstance( p_intf );
408             getSettings()->setValue( "updatedate", QDate::currentDate() );
409         }
410     }
411 #endif
412
413     /* Create the normal interface in non-DP mode */
414     if( !p_intf->p_sys->b_isDialogProvider )
415         p_mi = new MainInterface( p_intf );
416     else
417         p_mi = NULL;
418
419     /* Explain how to show a dialog :D */
420     p_intf->pf_show_dialog = ShowDialog;
421
422     /* */
423     p_intf->p_sys->p_mi = p_mi;
424     vlc_sem_post (&ready);
425
426     /* Last settings */
427     app.setQuitOnLastWindowClosed( false );
428
429     /* Retrieve last known path used in file browsing */
430     p_intf->p_sys->filepath =
431          getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
432
433     /* Loads and tries to apply the preferred QStyle */
434     QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
435     if( s_style.compare("") != 0 )
436         QApplication::setStyle( s_style );
437
438     /* Launch */
439     app.exec();
440
441     /* And quit */
442     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
443
444     QApplication::closeAllWindows();
445
446     if (p_mi != NULL)
447     {
448         /* FIXME: are we sure that video window is already destroyed? */
449
450         msg_Dbg (p_intf, "destroying the main Qt4 interface");
451         p_intf->p_sys->p_mi = NULL;
452         /* Destroy first the main interface because it is connected to some
453            slots in the MainInputManager */
454         delete p_mi;
455     }
456
457     /* Destroy all remaining windows,
458        because some are connected to some slots
459        in the MainInputManager
460        Settings must be destroyed after that.
461      */
462     DialogsProvider::killInstance();
463
464     /* Delete the recentsMRL object before the configuration */
465     RecentsMRL::killInstance();
466
467     /* Save the path */
468     getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
469
470     /* Delete the configuration. Application has to be deleted after that. */
471     delete p_intf->p_sys->mainSettings;
472
473     /* Destroy the MainInputManager */
474     MainInputManager::killInstance();
475
476
477     /* Delete the application automatically */
478 #ifdef Q_WS_X11
479     free( x11_display );
480 #endif
481     return NULL;
482 }
483
484 /*****************************************************************************
485  * Callback to show a dialog
486  *****************************************************************************/
487 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
488                         intf_dialog_args_t *p_arg )
489 {
490     VLC_UNUSED( p_intf );
491     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
492     QApplication::postEvent( THEDP, event );
493 }
494
495 /**
496  * Video output window provider
497  *
498  * TODO move it out of here ?
499  */
500 #include <vlc_vout_window.h>
501
502 static int WindowControl( vout_window_t *, int i_query, va_list );
503
504 static int WindowOpen( vlc_object_t *p_obj )
505 {
506     vout_window_t *p_wnd = (vout_window_t*)p_obj;
507
508     /* */
509     if( p_wnd->cfg->is_standalone )
510         return VLC_EGENERIC;
511
512     vlc_value_t val;
513
514     if( var_Get( p_obj->p_libvlc, "qt4-iface", &val ) )
515         val.p_address = NULL;
516
517     intf_thread_t *p_intf = (intf_thread_t *)val.p_address;
518
519     if( !p_intf )
520     {   /* If another interface is used, this plugin cannot work */
521         msg_Dbg( p_obj, "Qt4 interface not found" );
522         return VLC_EGENERIC;
523     }
524
525     MainInterface *p_mi = p_intf->p_sys->p_mi;
526     msg_Dbg( p_obj, "requesting video..." );
527
528     int i_x = p_wnd->cfg->x;
529     int i_y = p_wnd->cfg->y;
530     unsigned i_width = p_wnd->cfg->width;
531     unsigned i_height = p_wnd->cfg->height;
532
533 #if defined (Q_WS_X11)
534     p_wnd->xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
535     if( !p_wnd->xid )
536         return VLC_EGENERIC;
537     p_wnd->x11_display = x11_display;
538
539 #elif defined (Q_WS_WIN)
540     p_wnd->hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
541     if( !p_wnd->hwnd )
542         return VLC_EGENERIC;
543 #else
544 # error FIXME
545 #endif
546
547     p_wnd->control = WindowControl;
548     p_wnd->sys = (vout_window_sys_t*)p_mi;
549     return VLC_SUCCESS;
550 }
551
552 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
553 {
554     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
555     return p_mi->controlVideo( i_query, args );
556 }
557
558 static void WindowClose( vlc_object_t *p_obj )
559 {
560     vout_window_t *p_wnd = (vout_window_t*)p_obj;
561     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
562
563     msg_Dbg( p_obj, "releasing video..." );
564     p_mi->releaseVideo();
565 }
566