]> git.sesse.net Git - vlc/blob - modules/gui/qt4/qt4.cpp
Qt: qt4.cpp cosmetics.
[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 <QLocale>
31 #include <QTranslator>
32 #include <QDate>
33 #include <QMutex>
34 #include <QMutexLocker>
35 #include <QWaitCondition>
36
37 #include "qt4.hpp"
38
39 #include "input_manager.hpp"    /* THEMIM creation */
40 #include "dialogs_provider.hpp" /* THEDP creation */
41 #include "main_interface.hpp"   /* MainInterface creation */
42 #include "dialogs/help.hpp"     /* Launch Update */
43 #include "recents.hpp"          /* Recents Item destruction */
44 #include "util/qvlcapp.hpp"     /* QVLCApplication definition */
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  Q_IMPORT_PLUGIN(qtaccessiblewidgets)
58 #endif
59
60 /*****************************************************************************
61  * Local prototypes.
62  *****************************************************************************/
63 static int  Open         ( vlc_object_t * );
64 static void Close        ( vlc_object_t * );
65 static int  OpenDialogs  ( vlc_object_t * );
66 static int  WindowOpen   ( vlc_object_t * );
67 static void WindowClose  ( vlc_object_t * );
68 static void *Thread      ( void * );
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 KEEPSIZE_TEXT N_( "Resize interface to the native video size" )
89 #define KEEPSIZE_LONGTEXT N_( "You have two choices:\n" \
90             " - The interface will resize to the native video size\n" \
91             " - The video will fit to the interface size\n " \
92             "By default, interface resize to the native video size." )
93
94 #define TITLE_TEXT N_( "Show playing item name in window title" )
95 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
96                            "controler window title." )
97
98 #define FILEDIALOG_PATH_TEXT N_( "Path to use in openfile dialog" )
99
100 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
101 #define NOTIFICATION_LONGTEXT N_( \
102     "Show a notification popup with the artist and track name when " \
103     "the current playlist item changes, when VLC is minimized or hidden." )
104
105 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
106 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
107                                       "in the dialogs." )
108
109 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1." )
110 #define OPACITY_LONGTEXT N_( "Sets the windows 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 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
116
117 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
118 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
119                             "versions of the software. It runs once every " \
120                             "two weeks." )
121 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
122
123 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
124 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
125                                  "400%, instead of 0% to 200%. This option " \
126                                  "can distort the audio, since it uses " \
127                                  "software amplification." )
128
129 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
130
131 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
132
133 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
134
135 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
136 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
137         "the recent items played in the player" )
138
139 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
140 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
141                        "By specifying the 12 numbers separated by a ';'\n" \
142             "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
143             "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
144
145 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
146 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
147                              " - normal mode\n"  \
148                              " - a zone always present to show information " \
149                                   "as lyrics, album arts...\n" \
150                              " - minimal mode with limited controls" )
151
152 #define QT_NORMAL_MODE_TEXT N_( "Classic look" )
153 #define QT_ALWAYS_VIDEO_MODE_TEXT N_( "Complete look with information area" )
154 #define QT_MINIMAL_MODE_TEXT N_( "Minimal look with no menus" )
155
156 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
157
158 /* Various modes definition */
159 static const int i_mode_list[] =
160     { QT_NORMAL_MODE, QT_ALWAYS_VIDEO_MODE, QT_MINIMAL_MODE };
161 static const char *const psz_mode_list_text[] =
162     { QT_NORMAL_MODE_TEXT, QT_ALWAYS_VIDEO_MODE_TEXT, QT_MINIMAL_MODE_TEXT };
163
164
165 /**********************************************************************/
166 vlc_module_begin ()
167     set_shortname( "Qt" )
168     set_description( N_("Qt interface") )
169     set_category( CAT_INTERFACE )
170     set_subcategory( SUBCAT_INTERFACE_MAIN )
171     set_capability( "interface", 151 )
172     set_callbacks( Open, Close )
173
174     add_shortcut("qt")
175     add_integer( "qt-display-mode", QT_NORMAL_MODE, NULL,
176                  QT_MODE_TEXT, QT_MODE_LONGTEXT, false )
177         change_integer_list( i_mode_list, psz_mode_list_text, NULL )
178
179     add_bool( "qt-notification", true, NULL, NOTIFICATION_TEXT,
180               NOTIFICATION_LONGTEXT, false )
181
182     add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
183                           OPACITY_LONGTEXT, 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-video-autoresize", true, NULL, KEEPSIZE_TEXT,
190               KEEPSIZE_LONGTEXT, false )
191     add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
192               TITLE_LONGTEXT, false )
193     add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
194               QT_FULLSCREEN_TEXT, false )
195
196     add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
197               COMPLETEVOL_LONGTEXT, true )
198     add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
199               SAVEVOL_TEXT, true )
200     add_string( "qt-filedialog-path", NULL, NULL, FILEDIALOG_PATH_TEXT,
201                 FILEDIALOG_PATH_TEXT, true )
202         change_autosave ()
203         change_internal ()
204
205     add_bool( "qt-recentplay", true, NULL, RECENTPLAY_TEXT,
206               RECENTPLAY_TEXT, false )
207     add_string( "qt-recentplay-filter", "", NULL,
208                 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
209
210     add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
211               ADVANCED_OPTIONS_LONGTEXT, true )
212     add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
213               ADVANCED_PREFS_LONGTEXT, false )
214     add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
215               ERROR_TEXT, false )
216 #ifdef UPDATE_CHECK
217     add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
218               UPDATER_LONGTEXT, false )
219     add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
220                  UPDATER_DAYS_TEXT, false )
221 #endif
222     add_string( "qt-slider-colours",
223                 "255;255;255;20;226;20;255;176;15;235;30;20",
224                 NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
225
226     add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
227               false )
228         change_internal ()
229
230     add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
231
232     add_submodule ()
233         set_description( "Dialogs provider" )
234         set_capability( "dialogs provider", 51 )
235
236         set_callbacks( OpenDialogs, Close )
237
238 #if defined (Q_WS_X11)
239 # define WID_CAPABILITY "xwindow"
240 #elif defined (WIN32)
241 # define WID_CAPABILITY "hwnd"
242 #endif
243 #ifdef WID_CAPABILITY
244     add_submodule ()
245         set_capability( WID_CAPABILITY, 50 )
246         set_callbacks( WindowOpen, WindowClose )
247 #endif
248
249 vlc_module_end ()
250
251 /*****************************************/
252
253 /* Ugly, but the Qt4 interface assumes single instance anyway */
254 static struct
255 {
256     QMutex lock;
257     QWaitCondition ready;
258 } iface;
259
260 /*****************************************************************************
261  * Module callbacks
262  *****************************************************************************/
263
264 /* Open Interface */
265 static int Open( vlc_object_t *p_this )
266 {
267     intf_thread_t *p_intf = (intf_thread_t *)p_this;
268
269 #ifdef Q_WS_X11
270     char *psz_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
271     Display *p_display = XOpenDisplay( psz_display );
272     free( psz_display );
273     if( !p_display )
274     {
275         msg_Err( p_intf, "Could not connect to X server" );
276         return VLC_EGENERIC;
277     }
278 #endif
279
280     /* Allocations of p_sys */
281     intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
282     p_sys->b_isDialogProvider = false;
283     p_sys->p_popup_menu = NULL;
284     p_sys->p_mi = NULL;
285     p_sys->p_playlist = pl_Hold( p_intf );
286 #ifdef Q_WS_X11
287     p_sys->display = p_display;
288 #endif
289
290     /* */
291     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
292     {
293         pl_Release (p_sys->p_playlist);
294         delete p_sys;
295         return VLC_ENOMEM;
296     }
297
298     /* */
299     QMutexLocker locker (&iface.lock);
300     vlc_value_t val;
301
302     while( p_sys->p_mi == NULL && !p_sys->b_isDialogProvider )
303         iface.ready.wait( &iface.lock );
304     if( !p_sys->b_isDialogProvider )
305     {
306         var_Create (p_this->p_libvlc, "qt4-iface", VLC_VAR_ADDRESS);
307         val.p_address = p_this;
308         var_Set (p_this->p_libvlc, "qt4-iface", val);
309     }
310     return VLC_SUCCESS;
311 }
312
313 /* Open Dialog Provider */
314 static int OpenDialogs( vlc_object_t *p_this )
315 {
316     intf_thread_t *p_intf = (intf_thread_t *)p_this;
317     p_intf->pf_show_dialog = ShowDialog;
318
319     int val = Open( p_this );
320     if( val )
321         return val;
322
323     return VLC_SUCCESS;
324 }
325
326 static void Close( vlc_object_t *p_this )
327 {
328     intf_thread_t *p_intf = (intf_thread_t *)p_this;
329     intf_sys_t *p_sys = p_intf->p_sys;
330
331     var_Destroy (p_this->p_libvlc, "qt4-iface");
332     QApplication::quit();
333
334     vlc_join (p_sys->thread, NULL);
335 #ifdef Q_WS_X11
336     XCloseDisplay ((Display *)p_sys->display);
337 #endif
338     pl_Release (p_this);
339     delete p_sys;
340 }
341
342 static QMutex windowLock;
343 static QWaitCondition windowWait;
344
345 static void *Thread( void *obj )
346 {
347     intf_thread_t *p_intf = (intf_thread_t *)obj;
348     MainInterface *p_mi;
349     char dummy[] = "";
350     char *argv[] = { dummy };
351     int argc = 1;
352
353     Q_INIT_RESOURCE( vlc );
354
355 #if !defined(WIN32) && !defined(__APPLE__)
356     /* KLUDGE:
357      * disables icon theme use because that makes Cleanlooks style bug
358      * because it asks gconf for some settings that timeout because of threads
359      * see commits 21610 21622 21654 for reference */
360
361     /* If you don't have a gconftool-2 binary, you should comment this line */
362     if( strcmp( qVersion(), "4.4.0" ) < 0 ) /* fixed in Qt 4.4.0 */
363         QApplication::setDesktopSettingsAware( false );
364 #endif
365
366     /* Start the QApplication here */
367 #ifdef Q_WS_X11
368     QVLCApp app( (Display *)p_intf->p_sys->display, 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( QPixmap(vlc_christmas_xpm) ) );
387     else
388         app.setWindowIcon( QIcon( QPixmap(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->pf_show_dialog )
415         p_mi = new MainInterface( p_intf );
416     else
417         p_mi = NULL;
418
419     /* */
420     iface.lock.lock();
421     p_intf->p_sys->p_mi = p_mi;
422     p_intf->p_sys->b_isDialogProvider = p_mi == NULL;
423     iface.ready.wakeAll();
424     iface.lock.unlock();
425
426     /* Explain to the core how to show a dialog :D */
427     p_intf->pf_show_dialog = ShowDialog;
428
429 #ifdef ENABLE_NLS
430     // Translation - get locale
431 #   if defined (WIN32) || defined (__APPLE__)
432     char* psz_tmp = config_GetPsz( p_intf, "language" );
433     QString lang = qfu( psz_tmp );
434     free( psz_tmp);
435     if (lang == "auto")
436         lang = QLocale::system().name();
437 #   else
438     QString lang = QLocale::system().name();
439 #   endif
440     // Translations for qt's own dialogs
441     QTranslator qtTranslator( 0 );
442     // Let's find the right path for the translation file
443 #if !defined( WIN32 )
444     QString path =  QString( QT4LOCALEDIR );
445 #else
446     QString path = QString( QString(config_GetDataDir()) + DIR_SEP +
447                             "locale" + DIR_SEP + "qt4" + DIR_SEP );
448 #endif
449     // files depending on locale
450     bool b_loaded = qtTranslator.load( path + "qt_" + lang );
451     if (!b_loaded)
452         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
453     app.installTranslator( &qtTranslator );
454 #endif  //ENABLE_NLS
455
456     /* Last settings */
457     app.setQuitOnLastWindowClosed( false );
458
459     /* Retrieve last known path used in file browsing */
460     char *psz_path = config_GetPsz( p_intf, "qt-filedialog-path" );
461     p_intf->p_sys->psz_filepath = EMPTY_STR( psz_path ) ? config_GetHomeDir()
462                                                         : psz_path;
463
464     /* Launch */
465     app.exec();
466
467     /* And quit */
468     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
469
470     QApplication::closeAllWindows();
471
472     if (p_mi != NULL)
473     {
474         QMutexLocker locker (&iface.lock);
475
476         msg_Dbg (p_intf, "destroying the main Qt4 interface");
477         p_intf->p_sys->p_mi = NULL;
478         /* Destroy first the main interface because it is connected to some
479            slots in the MainInputManager */
480         delete p_mi;
481     }
482
483     /* Destroy all remaining windows,
484        because some are connected to some slots
485        in the MainInputManager
486        Settings must be destroyed after that.
487      */
488     DialogsProvider::killInstance();
489
490     /* Delete the recentsMRL object before the configuration */
491     RecentsMRL::killInstance();
492
493     /* Delete the configuration. Application has to be deleted after that. */
494     delete p_intf->p_sys->mainSettings;
495
496     /* Destroy the MainInputManager */
497     MainInputManager::killInstance();
498
499
500     /* Save the path */
501     config_PutPsz( p_intf, "qt-filedialog-path", p_intf->p_sys->psz_filepath );
502     free( psz_path );
503
504     /* Delete the application automatically */
505     return NULL;
506 }
507
508 /*****************************************************************************
509  * Callback to show a dialog
510  *****************************************************************************/
511 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
512                         intf_dialog_args_t *p_arg )
513 {
514     VLC_UNUSED( p_intf );
515     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
516     QApplication::postEvent( THEDP, event );
517 }
518
519 /**
520  * Video output window provider
521  */
522 #include <vlc_window.h>
523
524 static int WindowControl (vout_window_t *, int, va_list);
525
526 static int WindowOpen (vlc_object_t *obj)
527 {
528     vout_window_t *wnd = (vout_window_t *)obj;
529     intf_thread_t *intf = NULL;
530     vlc_value_t val;
531
532     if (config_GetInt (obj, "embedded-video") <= 0)
533         return VLC_EGENERIC;
534
535     QMutexLocker (&iface.lock);
536     if (var_Get (obj->p_libvlc, "qt4-iface", &val) == 0)
537         intf = (intf_thread_t *)val.p_address;
538     if (intf == NULL)
539     {   /* If another interface is used, this plugin cannot work */
540         msg_Dbg (obj, "Qt4 interface not found");
541         return VLC_EGENERIC;
542     }
543
544     MainInterface *p_mi = intf->p_sys->p_mi;
545     msg_Dbg (obj, "requesting video...");
546
547 #if defined (Q_WS_X11)
548     wnd->handle.xid = p_mi->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
549                                           &wnd->width, &wnd->height);
550     if (!wnd->handle.xid)
551         return VLC_EGENERIC;
552
553 #elif defined (WIN32)
554     wnd->handle.hwnd = p_mi->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
555                                            &wnd->width, &wnd->height);
556     if (!wnd->handle.hwnd)
557         return VLC_EGENERIC;
558
559 #else
560     return VLC_EGENERIC;
561
562 #endif
563
564     wnd->control = WindowControl;
565     wnd->p_private = p_mi;
566     return VLC_SUCCESS;
567 }
568
569 static int WindowControl (vout_window_t *wnd, int query, va_list args)
570 {
571     MainInterface *p_mi = (MainInterface *)wnd->p_private;
572     QMutexLocker locker (&iface.lock);
573
574     return p_mi->controlVideo (query, args);
575 }
576
577 static void WindowClose (vlc_object_t *obj)
578 {
579     vout_window_t *wnd = (vout_window_t *)obj;
580     MainInterface *p_mi = (MainInterface *)wnd->p_private;
581     QMutexLocker locker (&iface.lock);
582
583     msg_Dbg (obj, "releasing video...");
584     p_mi->releaseVideo ();
585 }