]> git.sesse.net Git - vlc/blob - modules/gui/qt4/qt4.cpp
Qt4: fix race in requestVideo and simplify
[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 NOTIFICATION_TEXT N_( "Show notification popup on track change" )
99 #define NOTIFICATION_LONGTEXT N_( \
100     "Show a notification popup with the artist and track name when " \
101     "the current playlist item changes, when VLC is minimized or hidden." )
102
103 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
104 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
105                                       "in the dialogs." )
106
107 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1." )
108 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
109                              "for main interface, playlist and extended panel."\
110                              " This option only works with Windows and " \
111                              "X11 with composite extensions." )
112
113 #define OPACITY_FS_TEXT N_( "Fullscreen controller opacity opacity between 0.1 and 1." )
114 #define OPACITY_FS_LONGTEXT N_( "Sets the fullscreen controller opacity between 0.1 and 1 " \
115                              "for main interface, playlist and extended panel."\
116                              " This option only works with Windows and " \
117                              "X11 with composite extensions." )
118
119
120 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
121
122 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
123 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
124                             "versions of the software. It runs once every " \
125                             "two weeks." )
126 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
127
128 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
129 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
130                                  "400%, instead of 0% to 200%. This option " \
131                                  "can distort the audio, since it uses " \
132                                  "software amplification." )
133
134 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
135
136 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
137
138 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
139
140 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
141 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
142         "the recent items played in the player" )
143
144 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
145 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
146                        "By specifying the 12 numbers separated by a ';'\n" \
147             "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
148             "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
149
150 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
151 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
152                              " - normal mode\n"  \
153                              " - a zone always present to show information " \
154                                   "as lyrics, album arts...\n" \
155                              " - minimal mode with limited controls" )
156
157 #define QT_NORMAL_MODE_TEXT N_( "Classic" )
158 #define QT_ALWAYS_VIDEO_MODE_TEXT N_( "Complete (with information area)" )
159 #define QT_MINIMAL_MODE_TEXT N_( "Minimal (without menu)" )
160
161 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
162 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
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( Open, 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_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
237
238     add_submodule ()
239         set_description( "Dialogs provider" )
240         set_capability( "dialogs provider", 51 )
241
242         set_callbacks( OpenDialogs, Close )
243
244 #if defined(Q_WS_X11) || defined(WIN32)
245     add_submodule ()
246 #if defined(Q_WS_X11)
247         set_capability( "vout window xid", 50 )
248 #elif defined(WIN32)
249         set_capability( "vout window hwnd", 50 )
250 #endif
251         set_callbacks( WindowOpen, WindowClose )
252 #endif
253
254 vlc_module_end ()
255
256 /*****************************************/
257
258 /* Ugly, but the Qt4 interface assumes single instance anyway */
259 static struct
260 {
261     QMutex lock;
262     QWaitCondition ready;
263 } iface;
264
265 /*****************************************************************************
266  * Module callbacks
267  *****************************************************************************/
268
269 /* Open Interface */
270 static int Open( vlc_object_t *p_this )
271 {
272     intf_thread_t *p_intf = (intf_thread_t *)p_this;
273
274 #ifdef Q_WS_X11
275     char *psz_display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
276     Display *p_display = XOpenDisplay( psz_display );
277     free( psz_display );
278     if( !p_display )
279     {
280         msg_Err( p_intf, "Could not connect to X server" );
281         return VLC_EGENERIC;
282     }
283     XCloseDisplay( p_display );
284 #endif
285
286     /* Allocations of p_sys */
287     intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
288     p_sys->b_isDialogProvider = false;
289     p_sys->p_popup_menu = NULL;
290     p_sys->p_mi = NULL;
291     p_sys->p_playlist = pl_Hold( p_intf );
292
293     /* */
294     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
295     {
296         pl_Release (p_sys->p_playlist);
297         delete p_sys;
298         return VLC_ENOMEM;
299     }
300
301     /* */
302     QMutexLocker locker (&iface.lock);
303     vlc_value_t val;
304
305     while( p_sys->p_mi == NULL && !p_sys->b_isDialogProvider )
306         iface.ready.wait( &iface.lock );
307     if( !p_sys->b_isDialogProvider )
308     {
309         var_Create (p_this->p_libvlc, "qt4-iface", VLC_VAR_ADDRESS);
310         val.p_address = p_this;
311         var_Set (p_this->p_libvlc, "qt4-iface", val);
312     }
313     return VLC_SUCCESS;
314 }
315
316 /* Open Dialog Provider */
317 static int OpenDialogs( vlc_object_t *p_this )
318 {
319     intf_thread_t *p_intf = (intf_thread_t *)p_this;
320     p_intf->pf_show_dialog = ShowDialog;
321
322     int val = Open( p_this );
323     if( val )
324         return val;
325
326     return VLC_SUCCESS;
327 }
328
329 static void Close( vlc_object_t *p_this )
330 {
331     intf_thread_t *p_intf = (intf_thread_t *)p_this;
332     intf_sys_t *p_sys = p_intf->p_sys;
333
334     var_Destroy (p_this->p_libvlc, "qt4-iface");
335     QVLCApp::triggerQuit();
336
337     vlc_join (p_sys->thread, NULL);
338     pl_Release (p_this);
339     delete p_sys;
340 }
341
342 static void *Thread( void *obj )
343 {
344     intf_thread_t *p_intf = (intf_thread_t *)obj;
345     MainInterface *p_mi;
346     char dummy[] = "vlc"; /* for WM_CLASS */
347     char *argv[] = { dummy, NULL, };
348     int argc = 1;
349
350     Q_INIT_RESOURCE( vlc );
351
352     /* Start the QApplication here */
353 #ifdef Q_WS_X11
354     char *display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
355     if( display )
356     {
357         argv[argc++] = const_cast<char *>("-display");
358         argv[argc++] = display;
359         argv[argc] = NULL;
360     }
361 #endif
362     QVLCApp app( argc, argv );
363     p_intf->p_sys->p_app = &app;
364
365
366     /* All the settings are in the .conf/.ini style */
367     p_intf->p_sys->mainSettings = new QSettings(
368 #ifdef WIN32
369             QSettings::IniFormat,
370 #else
371             QSettings::NativeFormat,
372 #endif
373             QSettings::UserScope, "vlc", "vlc-qt-interface" );
374
375     /* Icon setting */
376     if( QDate::currentDate().dayOfYear() >= 352 ) /* One Week before Xmas */
377         app.setWindowIcon( QIcon( QPixmap(vlc_christmas_xpm) ) );
378     else
379         app.setWindowIcon( QIcon( QPixmap(vlc_xpm) ) );
380
381     /* Initialize timers and the Dialog Provider */
382     DialogsProvider::getInstance( p_intf );
383
384     /* Detect screensize for small screens like TV or EEEpc*/
385     p_intf->p_sys->i_screenHeight =
386         app.QApplication::desktop()->availableGeometry().height();
387
388 #ifdef UPDATE_CHECK
389     /* Checking for VLC updates */
390     if( config_GetInt( p_intf, "qt-updates-notif" ) &&
391         !config_GetInt( p_intf, "qt-privacy-ask" ) )
392     {
393         int interval = config_GetInt( p_intf, "qt-updates-days" );
394         if( QDate::currentDate() >
395              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
396         {
397             /* The constructor of the update Dialog will do the 1st request */
398             UpdateDialog::getInstance( p_intf );
399             getSettings()->setValue( "updatedate", QDate::currentDate() );
400         }
401     }
402 #endif
403
404     /* Create the normal interface in non-DP mode */
405     if( !p_intf->pf_show_dialog )
406         p_mi = new MainInterface( p_intf );
407     else
408         p_mi = NULL;
409
410     /* */
411     iface.lock.lock();
412     p_intf->p_sys->p_mi = p_mi;
413     p_intf->p_sys->b_isDialogProvider = p_mi == NULL;
414     iface.ready.wakeAll();
415     iface.lock.unlock();
416
417     /* Explain to the core how to show a dialog :D */
418     p_intf->pf_show_dialog = ShowDialog;
419
420 #ifdef ENABLE_NLS
421     // Translation - get locale
422 #   if defined (WIN32) || defined (__APPLE__)
423     char* psz_tmp = config_GetPsz( p_intf, "language" );
424     QString lang = qfu( psz_tmp );
425     free( psz_tmp);
426     if (lang == "auto")
427         lang = QLocale::system().name();
428 #   else
429     QString lang = QLocale::system().name();
430 #   endif
431     // Translations for qt's own dialogs
432     QTranslator qtTranslator( 0 );
433     // Let's find the right path for the translation file
434 #if !defined( WIN32 )
435     QString path =  QString( QT4LOCALEDIR );
436 #else
437     QString path = QString( QString(config_GetDataDir()) + DIR_SEP +
438                             "locale" + DIR_SEP + "qt4" + DIR_SEP );
439 #endif
440     // files depending on locale
441     bool b_loaded = qtTranslator.load( path + "qt_" + lang );
442     if (!b_loaded)
443         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
444     app.installTranslator( &qtTranslator );
445 #endif  //ENABLE_NLS
446
447     /* Last settings */
448     app.setQuitOnLastWindowClosed( false );
449
450     /* Retrieve last known path used in file browsing */
451     p_intf->p_sys->filepath =
452          getSettings()->value( "filedialog-path", config_GetHomeDir() ).toString();
453
454     /* Loads and tries to apply the preferred QStyle */
455     QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
456     if( s_style.compare("") != 0 )
457         QApplication::setStyle( s_style );
458
459
460     /* Launch */
461     app.exec();
462
463     /* And quit */
464     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
465
466     QApplication::closeAllWindows();
467
468     if (p_mi != NULL)
469     {
470         QMutexLocker locker (&iface.lock);
471
472         msg_Dbg (p_intf, "destroying the main Qt4 interface");
473         p_intf->p_sys->p_mi = NULL;
474         /* Destroy first the main interface because it is connected to some
475            slots in the MainInputManager */
476         delete p_mi;
477     }
478
479     /* Destroy all remaining windows,
480        because some are connected to some slots
481        in the MainInputManager
482        Settings must be destroyed after that.
483      */
484     DialogsProvider::killInstance();
485
486     /* Delete the recentsMRL object before the configuration */
487     RecentsMRL::killInstance();
488
489     /* Save the path */
490     getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
491
492     /* Delete the configuration. Application has to be deleted after that. */
493     delete p_intf->p_sys->mainSettings;
494
495     /* Destroy the MainInputManager */
496     MainInputManager::killInstance();
497
498
499
500     /* Delete the application automatically */
501 #ifdef Q_WS_X11
502     free( display );
503 #endif
504     return NULL;
505 }
506
507 /*****************************************************************************
508  * Callback to show a dialog
509  *****************************************************************************/
510 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
511                         intf_dialog_args_t *p_arg )
512 {
513     VLC_UNUSED( p_intf );
514     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
515     QApplication::postEvent( THEDP, event );
516 }
517
518 /**
519  * Video output window provider
520  *
521  * TODO move it out of here ?
522  */
523 #include <vlc_vout_window.h>
524
525 static int WindowControl( vout_window_t *, int i_query, va_list );
526
527 static int WindowOpen( vlc_object_t *p_obj )
528 {
529     vout_window_t *p_wnd = (vout_window_t*)p_obj;
530
531     /* */
532     if( p_wnd->cfg->is_standalone )
533         return VLC_EGENERIC;
534
535     QMutexLocker( &iface.lock );
536
537     vlc_value_t val;
538
539     if( var_Get( p_obj->p_libvlc, "qt4-iface", &val ) )
540         val.p_address = NULL;
541
542     intf_thread_t *p_intf = (intf_thread_t *)val.p_address;
543
544     if( !p_intf )
545     {   /* If another interface is used, this plugin cannot work */
546         msg_Dbg( p_obj, "Qt4 interface not found" );
547         return VLC_EGENERIC;
548     }
549
550     MainInterface *p_mi = p_intf->p_sys->p_mi;
551     msg_Dbg( p_obj, "requesting video..." );
552
553     int i_x = p_wnd->cfg->x;
554     int i_y = p_wnd->cfg->y;
555     unsigned i_width = p_wnd->cfg->width;
556     unsigned i_height = p_wnd->cfg->height;
557
558 #if defined (Q_WS_X11)
559     p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
560     if( !p_wnd->handle.xid )
561         return VLC_EGENERIC;
562
563 #elif defined (WIN32)
564     p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
565     if( !p_wnd->handle.hwnd )
566         return VLC_EGENERIC;
567 #endif
568
569     p_wnd->control = WindowControl;
570     p_wnd->sys = (vout_window_sys_t*)p_mi;
571     return VLC_SUCCESS;
572 }
573
574 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
575 {
576     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
577     QMutexLocker locker(&iface.lock);
578
579     return p_mi->controlVideo( i_query, args );
580 }
581
582 static void WindowClose( vlc_object_t *p_obj )
583 {
584     vout_window_t *p_wnd = (vout_window_t*)p_obj;
585     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
586
587     QMutexLocker locker( &iface.lock );
588
589     msg_Dbg( p_obj, "releasing video..." );
590     p_mi->releaseVideo();
591 }