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