]> git.sesse.net Git - vlc/blob - modules/gui/qt4/qt4.cpp
Merge branch 1.0-bugfix
[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 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
158
159 /* Various modes definition */
160 static const int i_mode_list[] =
161     { QT_NORMAL_MODE, QT_ALWAYS_VIDEO_MODE, QT_MINIMAL_MODE };
162 static const char *const psz_mode_list_text[] =
163     { QT_NORMAL_MODE_TEXT, QT_ALWAYS_VIDEO_MODE_TEXT, QT_MINIMAL_MODE_TEXT };
164
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( Open, Close )
174
175     add_shortcut("qt")
176     add_integer( "qt-display-mode", QT_NORMAL_MODE, NULL,
177                  QT_MODE_TEXT, QT_MODE_LONGTEXT, false )
178         change_integer_list( i_mode_list, psz_mode_list_text, NULL )
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
186     add_bool( "qt-system-tray", true, NULL, SYSTRAY_TEXT,
187               SYSTRAY_LONGTEXT, false)
188     add_bool( "qt-start-minimized", false, NULL, MINIMIZED_TEXT,
189               MINIMIZED_LONGTEXT, true)
190     add_bool( "qt-video-autoresize", true, NULL, KEEPSIZE_TEXT,
191               KEEPSIZE_LONGTEXT, false )
192     add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
193               TITLE_LONGTEXT, false )
194     add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
195               QT_FULLSCREEN_TEXT, false )
196
197     add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
198               COMPLETEVOL_LONGTEXT, true )
199     add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
200               SAVEVOL_TEXT, true )
201     add_string( "qt-filedialog-path", NULL, NULL, FILEDIALOG_PATH_TEXT,
202                 FILEDIALOG_PATH_TEXT, true )
203         change_autosave ()
204         change_internal ()
205
206     add_bool( "qt-embedded-open", false, NULL, QT_NATIVEOPEN_TEXT,
207                QT_NATIVEOPEN_TEXT, false )
208     add_bool( "qt-recentplay", true, NULL, RECENTPLAY_TEXT,
209               RECENTPLAY_TEXT, false )
210     add_string( "qt-recentplay-filter", "", NULL,
211                 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
212
213     add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
214               ADVANCED_OPTIONS_LONGTEXT, true )
215     add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
216               ADVANCED_PREFS_LONGTEXT, false )
217     add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
218               ERROR_TEXT, false )
219 #ifdef UPDATE_CHECK
220     add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
221               UPDATER_LONGTEXT, false )
222     add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
223                  UPDATER_DAYS_TEXT, false )
224 #endif
225     add_string( "qt-slider-colours",
226                 "255;255;255;20;210;20;255;199;15;245;39;29",
227                 NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
228
229     add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
230               false )
231         change_internal ()
232
233     add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
234
235     add_submodule ()
236         set_description( "Dialogs provider" )
237         set_capability( "dialogs provider", 51 )
238
239         set_callbacks( OpenDialogs, Close )
240
241 #if defined (Q_WS_X11)
242 # define WID_CAPABILITY "xwindow"
243 #elif defined (WIN32)
244 # define WID_CAPABILITY "hwnd"
245 #endif
246 #ifdef WID_CAPABILITY
247     add_submodule ()
248         set_capability( WID_CAPABILITY, 50 )
249         set_callbacks( WindowOpen, WindowClose )
250 #endif
251
252 vlc_module_end ()
253
254 /*****************************************/
255
256 /* Ugly, but the Qt4 interface assumes single instance anyway */
257 static struct
258 {
259     QMutex lock;
260     QWaitCondition ready;
261 } iface;
262
263 /*****************************************************************************
264  * Module callbacks
265  *****************************************************************************/
266
267 /* Open Interface */
268 static int Open( vlc_object_t *p_this )
269 {
270     intf_thread_t *p_intf = (intf_thread_t *)p_this;
271
272 #ifdef Q_WS_X11
273     char *psz_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
274     Display *p_display = XOpenDisplay( psz_display );
275     free( psz_display );
276     if( !p_display )
277     {
278         msg_Err( p_intf, "Could not connect to X server" );
279         return VLC_EGENERIC;
280     }
281     XCloseDisplay( p_display );
282 #endif
283
284     /* Allocations of p_sys */
285     intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
286     p_sys->b_isDialogProvider = false;
287     p_sys->p_popup_menu = NULL;
288     p_sys->p_mi = NULL;
289     p_sys->p_playlist = pl_Hold( p_intf );
290
291     /* */
292     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
293     {
294         pl_Release (p_sys->p_playlist);
295         delete p_sys;
296         return VLC_ENOMEM;
297     }
298
299     /* */
300     QMutexLocker locker (&iface.lock);
301     vlc_value_t val;
302
303     while( p_sys->p_mi == NULL && !p_sys->b_isDialogProvider )
304         iface.ready.wait( &iface.lock );
305     if( !p_sys->b_isDialogProvider )
306     {
307         var_Create (p_this->p_libvlc, "qt4-iface", VLC_VAR_ADDRESS);
308         val.p_address = p_this;
309         var_Set (p_this->p_libvlc, "qt4-iface", val);
310     }
311     return VLC_SUCCESS;
312 }
313
314 /* Open Dialog Provider */
315 static int OpenDialogs( vlc_object_t *p_this )
316 {
317     intf_thread_t *p_intf = (intf_thread_t *)p_this;
318     p_intf->pf_show_dialog = ShowDialog;
319
320     int val = Open( p_this );
321     if( val )
322         return val;
323
324     return VLC_SUCCESS;
325 }
326
327 static void Close( vlc_object_t *p_this )
328 {
329     intf_thread_t *p_intf = (intf_thread_t *)p_this;
330     intf_sys_t *p_sys = p_intf->p_sys;
331
332     var_Destroy (p_this->p_libvlc, "qt4-iface");
333     QVLCApp::triggerQuit();
334
335     vlc_join (p_sys->thread, NULL);
336     pl_Release (p_this);
337     delete p_sys;
338 }
339
340 static QMutex windowLock;
341 static QWaitCondition windowWait;
342
343 static void *Thread( void *obj )
344 {
345     intf_thread_t *p_intf = (intf_thread_t *)obj;
346     MainInterface *p_mi;
347     char dummy[] = "vlc"; /* for WM_CLASS */
348     char *argv[] = { dummy, NULL, };
349     int argc = 1;
350
351     Q_INIT_RESOURCE( vlc );
352
353     /* Start the QApplication here */
354 #ifdef Q_WS_X11
355     char *display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
356     if( display )
357     {
358         argv[argc++] = const_cast<char *>("-display");
359         argv[argc++] = display;
360         argv[argc] = NULL;
361     }
362 #endif
363     QVLCApp app( argc, argv );
364     p_intf->p_sys->p_app = &app;
365
366
367     /* All the settings are in the .conf/.ini style */
368     p_intf->p_sys->mainSettings = new QSettings(
369 #ifdef WIN32
370             QSettings::IniFormat,
371 #else
372             QSettings::NativeFormat,
373 #endif
374             QSettings::UserScope, "vlc", "vlc-qt-interface" );
375
376     /* Icon setting */
377     if( QDate::currentDate().dayOfYear() >= 352 ) /* One Week before Xmas */
378         app.setWindowIcon( QIcon( QPixmap(vlc_christmas_xpm) ) );
379     else
380         app.setWindowIcon( QIcon( QPixmap(vlc_xpm) ) );
381
382     /* Initialize timers and the Dialog Provider */
383     DialogsProvider::getInstance( p_intf );
384
385     /* Detect screensize for small screens like TV or EEEpc*/
386     p_intf->p_sys->i_screenHeight =
387         app.QApplication::desktop()->availableGeometry().height();
388
389 #ifdef UPDATE_CHECK
390     /* Checking for VLC updates */
391     if( config_GetInt( p_intf, "qt-updates-notif" ) &&
392         !config_GetInt( p_intf, "qt-privacy-ask" ) )
393     {
394         int interval = config_GetInt( p_intf, "qt-updates-days" );
395         if( QDate::currentDate() >
396              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
397         {
398             /* The constructor of the update Dialog will do the 1st request */
399             UpdateDialog::getInstance( p_intf );
400             getSettings()->setValue( "updatedate", QDate::currentDate() );
401         }
402     }
403 #endif
404
405     /* Create the normal interface in non-DP mode */
406     if( !p_intf->pf_show_dialog )
407         p_mi = new MainInterface( p_intf );
408     else
409         p_mi = NULL;
410
411     /* */
412     iface.lock.lock();
413     p_intf->p_sys->p_mi = p_mi;
414     p_intf->p_sys->b_isDialogProvider = p_mi == NULL;
415     iface.ready.wakeAll();
416     iface.lock.unlock();
417
418     /* Explain to the core how to show a dialog :D */
419     p_intf->pf_show_dialog = ShowDialog;
420
421 #ifdef ENABLE_NLS
422     // Translation - get locale
423 #   if defined (WIN32) || defined (__APPLE__)
424     char* psz_tmp = config_GetPsz( p_intf, "language" );
425     QString lang = qfu( psz_tmp );
426     free( psz_tmp);
427     if (lang == "auto")
428         lang = QLocale::system().name();
429 #   else
430     QString lang = QLocale::system().name();
431 #   endif
432     // Translations for qt's own dialogs
433     QTranslator qtTranslator( 0 );
434     // Let's find the right path for the translation file
435 #if !defined( WIN32 )
436     QString path =  QString( QT4LOCALEDIR );
437 #else
438     QString path = QString( QString(config_GetDataDir()) + DIR_SEP +
439                             "locale" + DIR_SEP + "qt4" + DIR_SEP );
440 #endif
441     // files depending on locale
442     bool b_loaded = qtTranslator.load( path + "qt_" + lang );
443     if (!b_loaded)
444         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
445     app.installTranslator( &qtTranslator );
446 #endif  //ENABLE_NLS
447
448     /* Last settings */
449     app.setQuitOnLastWindowClosed( false );
450
451     /* Retrieve last known path used in file browsing */
452     {
453         char *psz_path = config_GetPsz( p_intf, "qt-filedialog-path" );
454         p_intf->p_sys->filepath =
455             EMPTY_STR(psz_path) ? config_GetHomeDir() : qfu(psz_path);
456         free( psz_path );
457     }
458
459     /* Launch */
460     app.exec();
461
462     /* And quit */
463     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
464
465     QApplication::closeAllWindows();
466
467     if (p_mi != NULL)
468     {
469         QMutexLocker locker (&iface.lock);
470
471         msg_Dbg (p_intf, "destroying the main Qt4 interface");
472         p_intf->p_sys->p_mi = NULL;
473         /* Destroy first the main interface because it is connected to some
474            slots in the MainInputManager */
475         delete p_mi;
476     }
477
478     /* Destroy all remaining windows,
479        because some are connected to some slots
480        in the MainInputManager
481        Settings must be destroyed after that.
482      */
483     DialogsProvider::killInstance();
484
485     /* Delete the recentsMRL object before the configuration */
486     RecentsMRL::killInstance();
487
488     /* Delete the configuration. Application has to be deleted after that. */
489     delete p_intf->p_sys->mainSettings;
490
491     /* Destroy the MainInputManager */
492     MainInputManager::killInstance();
493
494
495     /* Save the path */
496     config_PutPsz( p_intf, "qt-filedialog-path",
497                    qtu(p_intf->p_sys->filepath) );
498
499     /* Delete the application automatically */
500 #ifdef Q_WS_X11
501     free( display );
502 #endif
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     VLC_UNUSED( p_intf );
513     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
514     QApplication::postEvent( THEDP, event );
515 }
516
517 /**
518  * Video output window provider
519  */
520 #include <vlc_window.h>
521
522 static int WindowControl (vout_window_t *, int, va_list);
523
524 static int WindowOpen (vlc_object_t *obj)
525 {
526     vout_window_t *wnd = (vout_window_t *)obj;
527     intf_thread_t *intf = NULL;
528     vlc_value_t val;
529
530     if (config_GetInt (obj, "embedded-video") <= 0)
531         return VLC_EGENERIC;
532
533     QMutexLocker (&iface.lock);
534     if (var_Get (obj->p_libvlc, "qt4-iface", &val) == 0)
535         intf = (intf_thread_t *)val.p_address;
536     if (intf == NULL)
537     {   /* If another interface is used, this plugin cannot work */
538         msg_Dbg (obj, "Qt4 interface not found");
539         return VLC_EGENERIC;
540     }
541
542     MainInterface *p_mi = intf->p_sys->p_mi;
543     msg_Dbg (obj, "requesting video...");
544
545 #if defined (Q_WS_X11)
546     wnd->handle.xid = p_mi->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
547                                           &wnd->width, &wnd->height);
548     if (!wnd->handle.xid)
549         return VLC_EGENERIC;
550
551 #elif defined (WIN32)
552     wnd->handle.hwnd = p_mi->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
553                                            &wnd->width, &wnd->height);
554     if (!wnd->handle.hwnd)
555         return VLC_EGENERIC;
556
557 #else
558     return VLC_EGENERIC;
559
560 #endif
561
562     wnd->control = WindowControl;
563     wnd->p_private = p_mi;
564     return VLC_SUCCESS;
565 }
566
567 static int WindowControl (vout_window_t *wnd, int query, va_list args)
568 {
569     MainInterface *p_mi = (MainInterface *)wnd->p_private;
570     QMutexLocker locker (&iface.lock);
571
572     return p_mi->controlVideo (query, args);
573 }
574
575 static void WindowClose (vlc_object_t *obj)
576 {
577     vout_window_t *wnd = (vout_window_t *)obj;
578     MainInterface *p_mi = (MainInterface *)wnd->p_private;
579     QMutexLocker locker (&iface.lock);
580
581     msg_Dbg (obj, "releasing video...");
582     p_mi->releaseVideo ();
583 }