1 /*****************************************************************************
2 * qt4.cpp : QT4 interface
3 ****************************************************************************
4 * Copyright © 2006-2009 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Baptiste Kempf <jb@videolan.org>
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.
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.
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 *****************************************************************************/
29 #include <QApplication>
35 #include "input_manager.hpp" /* THEMIM destruction */
36 #include "dialogs_provider.hpp" /* THEDP creation */
37 #include "main_interface.hpp" /* MainInterface creation */
38 #include "dialogs/help.hpp" /* Launch Update */
39 #include "recents.hpp" /* Recents Item destruction */
40 #include "util/qvlcapp.hpp" /* QVLCApplication definition */
41 #include "components/playlist/playlist_model.hpp" /* for ~PLModel() */
42 #include <vlc_aout_intf.h>
48 #include "../../../share/icons/32x32/vlc.xpm"
49 #include "../../../share/icons/32x32/vlc-xmas.xpm"
50 #include <vlc_plugin.h>
51 #include <vlc_vout_window.h>
53 #ifdef WIN32 /* For static builds */
55 Q_IMPORT_PLUGIN(qjpeg)
56 Q_IMPORT_PLUGIN(qtaccessiblewidgets)
59 /*****************************************************************************
61 *****************************************************************************/
62 static int OpenIntf ( vlc_object_t * );
63 static int OpenDialogs ( vlc_object_t * );
64 static int Open ( vlc_object_t *, bool );
65 static void Close ( vlc_object_t * );
66 static int WindowOpen ( vout_window_t *, const vout_window_cfg_t * );
67 static void WindowClose ( vout_window_t * );
68 static void *Thread ( void * );
69 static void ShowDialog ( intf_thread_t *, int, int, intf_dialog_args_t * );
71 /*****************************************************************************
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 "\
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." )
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 " \
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." )
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 "controller window title." )
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." )
103 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
104 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
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." )
113 #define OPACITY_FS_TEXT N_( "Fullscreen controller 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." )
120 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
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 " \
126 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
128 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
130 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
132 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
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" )
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' ")
144 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
145 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
147 " - a zone always present to show information " \
148 "as lyrics, album arts...\n" \
149 " - minimal mode with limited controls" )
151 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
152 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
154 #define FULLSCREEN_NUMBER_TEXT N_( "Define which screen fullscreen goes" )
155 #define FULLSCREEN_NUMBER_LONGTEXT N_( "Screennumber of fullscreen, instead of " \
156 "same screen where interface is" )
158 #define QT_AUTOLOAD_EXTENSIONS_TEXT N_( "Load extensions on startup" )
159 #define QT_AUTOLOAD_EXTENSIONS_LONGTEXT N_( "Automatically load the "\
160 "extensions module on startup" )
162 #define QT_MINIMAL_MODE_TEXT N_("Start in minimal view (without menus)" )
164 #define QT_BGCONE_TEXT N_( "Display background cone or art" )
165 #define QT_BGCONE_LONGTEXT N_( "Display background cone or current album art " \
166 "when not playing. " \
167 "Can be disabled to prevent burning screen." )
168 #define QT_BGCONE_EXPANDS_TEXT N_( "Expanding background cone or art." )
169 #define QT_BGCONE_EXPANDS_LONGTEXT N_( "Background art fits window's size" )
171 #define QT_DISABLE_VOLUME_KEYS_TEXT N_( "Ignore keyboard volume buttons." )
172 #define QT_DISABLE_VOLUME_KEYS_LONGTEXT N_( \
173 "With this option checked, the volume up, volume down and mute buttons on your " \
174 "keyboard will always change your system volume. With this option unchecked, the " \
175 "volume buttons will change VLC's volume when VLC is selected and change the " \
176 "system volume when VLC is not selected." )
178 #define QT_PAUSE_MINIMIZED_TEXT N_( "Pause the video playback when minimized" )
179 #define QT_PAUSE_MINIMIZED_LONGTEXT N_( \
180 "With this option enabled, the playback will be automatically paused when minimizing the window." )
182 #define ICONCHANGE_TEXT N_( "Allow automatic icon changes")
183 #define ICONCHANGE_LONGTEXT N_( \
184 "This option allows the interface to change its icon on various occasions.")
186 static const int i_notification_list[] =
187 { NOTIFICATION_NEVER, NOTIFICATION_MINIMIZED, NOTIFICATION_ALWAYS };
189 static const char *const psz_notification_list_text[] =
190 { N_("Never"), N_("When minimized"), N_("Always") };
192 /**********************************************************************/
194 set_shortname( "Qt" )
195 set_description( N_("Qt interface") )
196 set_category( CAT_INTERFACE )
197 set_subcategory( SUBCAT_INTERFACE_MAIN )
198 set_capability( "interface", 151 )
199 set_callbacks( OpenIntf, Close )
203 add_bool( "qt-minimal-view", false, QT_MINIMAL_MODE_TEXT,
204 QT_MINIMAL_MODE_TEXT, false );
206 add_bool( "qt-system-tray",
212 SYSTRAY_TEXT, SYSTRAY_LONGTEXT, false)
214 add_integer( "qt-notification", NOTIFICATION_MINIMIZED,
216 NOTIFICATION_LONGTEXT, false )
217 change_integer_list( i_notification_list, psz_notification_list_text )
219 add_bool( "qt-start-minimized", false, MINIMIZED_TEXT,
220 MINIMIZED_LONGTEXT, true)
221 add_bool( "qt-pause-minimized", false, QT_PAUSE_MINIMIZED_TEXT,
222 QT_PAUSE_MINIMIZED_LONGTEXT, false )
224 add_float_with_range( "qt-opacity", 1., 0.1, 1., OPACITY_TEXT,
225 OPACITY_LONGTEXT, false )
226 add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., OPACITY_FS_TEXT,
227 OPACITY_FS_LONGTEXT, false )
229 add_bool( "qt-video-autoresize", true, KEEPSIZE_TEXT,
230 KEEPSIZE_LONGTEXT, false )
231 add_bool( "qt-name-in-title", true, TITLE_TEXT,
232 TITLE_LONGTEXT, false )
233 add_bool( "qt-fs-controller", true, QT_FULLSCREEN_TEXT,
234 QT_FULLSCREEN_TEXT, false )
236 add_bool( "qt-recentplay", true, RECENTPLAY_TEXT,
237 RECENTPLAY_TEXT, false )
238 add_string( "qt-recentplay-filter", "",
239 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
242 add_bool( "qt-updates-notif", true, UPDATER_TEXT,
243 UPDATER_LONGTEXT, false )
244 add_integer_with_range( "qt-updates-days", 3, 0, 180,
245 UPDATER_DAYS_TEXT, UPDATER_DAYS_TEXT, false )
248 add_bool( "qt-autosave-volume", true, SAVEVOL_TEXT,
251 add_bool( "qt-disable-volume-keys" /* name */,
252 true /* default value */,
253 QT_DISABLE_VOLUME_KEYS_TEXT /* text */,
254 QT_DISABLE_VOLUME_KEYS_LONGTEXT /* longtext */,
255 false /* advanced mode only */)
258 add_bool( "qt-embedded-open", false, QT_NATIVEOPEN_TEXT,
259 QT_NATIVEOPEN_TEXT, false )
262 add_bool( "qt-advanced-pref", false, ADVANCED_PREFS_TEXT,
263 ADVANCED_PREFS_LONGTEXT, false )
264 add_bool( "qt-error-dialogs", true, ERROR_TEXT,
267 add_string( "qt-slider-colours", "153;210;153;20;210;20;255;199;15;245;39;29",
268 SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
270 add_bool( "qt-privacy-ask", true, PRIVACY_TEXT, PRIVACY_TEXT,
274 add_integer( "qt-fullscreen-screennumber", -1, FULLSCREEN_NUMBER_TEXT,
275 FULLSCREEN_NUMBER_LONGTEXT, false );
277 add_bool( "qt-autoload-extensions", true,
278 QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
281 add_bool( "qt-bgcone", true, QT_BGCONE_TEXT, QT_BGCONE_LONGTEXT, true )
282 add_bool( "qt-bgcone-expands", false, QT_BGCONE_EXPANDS_TEXT,
283 QT_BGCONE_EXPANDS_LONGTEXT, true )
285 add_bool( "qt-icon-change", true, ICONCHANGE_TEXT, ICONCHANGE_LONGTEXT, true )
287 add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
288 add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
290 add_obsolete_bool( "qt-adv-options" ) /* Since 2.0.0 */
291 add_obsolete_bool( "qt-volume-complete" ) /* Since 2.0.0 */
292 add_obsolete_integer( "qt-startvolume" ) /* Since 2.0.0 */
294 cannot_unload_broken_library()
297 set_description( "Dialogs provider" )
298 set_capability( "dialogs provider", 51 )
300 set_callbacks( OpenDialogs, Close )
302 #if defined(Q_WS_X11) || defined(Q_WS_WIN) || defined(Q_WS_MAC) || defined(Q_WS_PM)
304 #if defined(Q_WS_X11)
305 set_capability( "vout window xid", 0 )
306 #elif defined(Q_WS_WIN) || defined(Q_WS_PM)
307 set_capability( "vout window hwnd", 0 )
308 #elif defined(Q_WS_MAC)
309 set_capability( "vout window nsobject", 0 )
311 set_callbacks( WindowOpen, WindowClose )
316 /*****************************************/
318 /* Ugly, but the Qt4 interface assumes single instance anyway */
319 static vlc_sem_t ready;
321 static bool busy = false;
322 static bool active = false;
324 /*****************************************************************************
326 *****************************************************************************/
329 /* Used to abort the app.exec() on OSX after libvlc_Quit is called */
330 #include "../../../lib/libvlc_internal.h" /* libvlc_SetExitHandler */
331 static void Abort( void *obj )
333 QVLCApp::triggerQuit();
337 static void RegisterIntf( vlc_object_t *p_this )
339 playlist_t *pl = pl_Get(p_this);
340 var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
341 var_SetAddress (pl, "qt4-iface", p_this);
342 var_Create (pl, "window", VLC_VAR_STRING);
343 var_SetString (pl, "window", "qt4,any");
347 static int Open( vlc_object_t *p_this, bool isDialogProvider )
349 intf_thread_t *p_intf = (intf_thread_t *)p_this;
352 if( !vlc_xlib_init( p_this ) )
355 Display *p_display = XOpenDisplay( NULL );
358 msg_Err( p_intf, "Could not connect to X server" );
361 XCloseDisplay( p_display );
364 QMutexLocker locker (&lock);
367 msg_Err (p_this, "cannot start Qt4 multiple times");
371 /* Allocations of p_sys */
372 intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
373 p_intf->p_sys->b_isDialogProvider = isDialogProvider;
375 p_sys->pl_model = NULL;
378 vlc_sem_init (&ready, 0);
380 /* Run mainloop on the main thread as Cocoa requires */
381 libvlc_SetExitHandler( p_intf->p_libvlc, Abort, p_intf );
382 Thread( (void *)p_intf );
384 if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
391 /* Wait for the interface to be ready. This prevents the main
392 * LibVLC thread from starting video playback before we can create
393 * an embedded video window. */
394 vlc_sem_wait (&ready);
395 vlc_sem_destroy (&ready);
396 busy = active = true;
399 if( !isDialogProvider )
401 RegisterIntf( p_this );
408 /* Open qt4 interface */
409 static int OpenIntf( vlc_object_t *p_this )
411 return Open( p_this, false );
414 /* Open Dialog Provider */
415 static int OpenDialogs( vlc_object_t *p_this )
417 return Open( p_this, true );
420 static void Close( vlc_object_t *p_this )
422 intf_thread_t *p_intf = (intf_thread_t *)p_this;
423 intf_sys_t *p_sys = p_intf->p_sys;
425 if( !p_sys->b_isDialogProvider )
427 var_Destroy (pl_Get(p_this), "window");
428 var_Destroy (pl_Get(p_this), "qt4-iface");
432 msg_Dbg( p_this, "requesting exit..." );
433 QVLCApp::triggerQuit();
435 msg_Dbg( p_this, "waiting for UI thread..." );
437 vlc_join (p_sys->thread, NULL);
441 QMutexLocker locker (&lock);
446 static void *Thread( void *obj )
448 intf_thread_t *p_intf = (intf_thread_t *)obj;
450 char dummy[] = "vlc"; /* for WM_CLASS */
451 char *argv[2] = { dummy, NULL, };
454 Q_INIT_RESOURCE( vlc );
456 /* Start the QApplication here */
457 QVLCApp app( argc, argv );
459 p_intf->p_sys->p_app = &app;
462 /* All the settings are in the .conf/.ini style */
463 p_intf->p_sys->mainSettings = new QSettings(
465 QSettings::IniFormat,
467 QSettings::NativeFormat,
469 QSettings::UserScope, "vlc", "vlc-qt-interface" );
471 /* Icon setting, Mac uses icon from .icns */
473 if( QDate::currentDate().dayOfYear() >= QT_XMAS_JOKE_DAY && var_InheritBool( p_intf, "qt-icon-change" ) )
474 app.setWindowIcon( QIcon(vlc_xmas_xpm) );
476 app.setWindowIcon( QIcon(vlc_xpm) );
479 /* Initialize timers and the Dialog Provider */
480 DialogsProvider::getInstance( p_intf );
482 /* Detect screensize for small screens like TV or Netbooks */
483 p_intf->p_sys->i_screenHeight =
484 app.QApplication::desktop()->availableGeometry().height();
487 /* Checking for VLC updates */
488 if( var_InheritBool( p_intf, "qt-updates-notif" ) &&
489 !var_InheritBool( p_intf, "qt-privacy-ask" ) )
491 int interval = var_InheritInteger( p_intf, "qt-updates-days" );
492 if( QDate::currentDate() >
493 getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
495 /* The constructor of the update Dialog will do the 1st request */
496 UpdateDialog::getInstance( p_intf );
497 getSettings()->setValue( "updatedate", QDate::currentDate() );
502 /* Create the normal interface in non-DP mode */
503 if( !p_intf->p_sys->b_isDialogProvider )
505 p_mi = new MainInterface( p_intf );
506 p_intf->p_sys->p_mi = p_mi;
511 /* Explain how to show a dialog :D */
512 p_intf->pf_show_dialog = ShowDialog;
514 /* Tell the main LibVLC thread we are ready */
515 vlc_sem_post (&ready);
518 /* We took over main thread, register and start here */
519 if( !p_intf->p_sys->b_isDialogProvider )
521 RegisterIntf( (vlc_object_t *)p_intf );
522 playlist_Play( THEPL );
527 app.setQuitOnLastWindowClosed( false );
529 /* Retrieve last known path used in file browsing */
530 p_intf->p_sys->filepath =
531 getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
533 /* Loads and tries to apply the preferred QStyle */
534 QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
535 if( s_style.compare("") != 0 )
536 QApplication::setStyle( s_style );
541 msg_Dbg( p_intf, "QApp exec() finished" );
544 QMutexLocker locker (&lock);
547 p_intf->p_sys->p_mi = NULL;
548 /* Destroy first the main interface because it is connected to some
549 slots in the MainInputManager */
553 /* Destroy all remaining windows,
554 because some are connected to some slots
555 in the MainInputManager
556 Settings must be destroyed after that.
558 DialogsProvider::killInstance();
560 /* Delete the recentsMRL object before the configuration */
561 RecentsMRL::killInstance();
563 /* Save the path or delete if recent play are disabled */
564 if( var_InheritBool( p_intf, "qt-recentplay" ) )
565 getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
567 getSettings()->remove( "filedialog-path" );
570 delete p_intf->p_sys->pl_model;
572 /* Delete the configuration. Application has to be deleted after that. */
573 delete p_intf->p_sys->mainSettings;
575 /* Destroy the MainInputManager */
576 MainInputManager::killInstance();
578 /* Delete the application automatically */
582 /*****************************************************************************
583 * Callback to show a dialog
584 *****************************************************************************/
585 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
586 intf_dialog_args_t *p_arg )
588 VLC_UNUSED( p_intf );
589 DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
590 QApplication::postEvent( THEDP, event );
594 * Video output window provider
596 * TODO move it out of here ?
598 static int WindowControl( vout_window_t *, int i_query, va_list );
600 static int WindowOpen( vout_window_t *p_wnd, const vout_window_cfg_t *cfg )
603 if( cfg->is_standalone )
605 #if defined (Q_WS_X11)
606 if( var_InheritBool( p_wnd, "video-wallpaper" ) )
610 intf_thread_t *p_intf =
611 (intf_thread_t *)var_InheritAddress( p_wnd, "qt4-iface" );
613 { /* If another interface is used, this plugin cannot work */
614 msg_Dbg( p_wnd, "Qt4 interface not found" );
618 QMutexLocker locker (&lock);
619 if (unlikely(!active))
622 MainInterface *p_mi = p_intf->p_sys->p_mi;
623 msg_Dbg( p_wnd, "requesting video..." );
627 unsigned i_width = cfg->width;
628 unsigned i_height = cfg->height;
630 #if defined (Q_WS_X11)
631 p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
632 if( !p_wnd->handle.xid )
634 p_wnd->display.x11 = NULL;
636 #elif defined (Q_WS_WIN) || defined(Q_WS_PM)
637 p_wnd->handle.hwnd = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
638 if( !p_wnd->handle.hwnd )
641 #elif defined (Q_WS_MAC)
642 p_wnd->handle.nsobject = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
643 if( !p_wnd->handle.nsobject )
649 p_wnd->control = WindowControl;
650 p_wnd->sys = (vout_window_sys_t*)p_mi;
654 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
656 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
657 QMutexLocker locker (&lock);
659 if (unlikely(!active))
661 msg_Warn (p_wnd, "video already released before control");
664 return p_mi->controlVideo( i_query, args );
667 static void WindowClose( vout_window_t *p_wnd )
669 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
670 QMutexLocker locker (&lock);
672 /* Normally, the interface terminates after the video. In the contrary, the
673 * Qt4 main loop is gone, so we cannot send any event to the user interface
674 * widgets. Ideally, we would keep the Qt4 main loop running until after
675 * the video window is released. But it is far simpler to just have the Qt4
676 * thread destroy the window early, and to turn this function into a stub.
678 * That assumes the video output will behave sanely if it window is
679 * destroyed asynchronously.
680 * XCB and Xlib-XCB are fine with that. Plain Xlib wouldn't, */
681 if (unlikely(!active))
683 msg_Warn (p_wnd, "video already released");
686 msg_Dbg (p_wnd, "releasing video...");
687 p_mi->releaseVideo();