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