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 <vlc_aout_intf.h>
47 #include "../../../share/icons/32x32/vlc.xpm"
48 #include "../../../share/icons/32x32/vlc-xmas.xpm"
49 #include <vlc_plugin.h>
50 #include <vlc_vout_window.h>
52 #ifdef WIN32 /* For static builds */
54 Q_IMPORT_PLUGIN(qjpeg)
55 Q_IMPORT_PLUGIN(qtaccessiblewidgets)
58 /*****************************************************************************
60 *****************************************************************************/
61 static int OpenIntf ( vlc_object_t * );
62 static int OpenDialogs ( vlc_object_t * );
63 static int Open ( vlc_object_t *, bool );
64 static void Close ( vlc_object_t * );
65 static int WindowOpen ( vout_window_t *, const vout_window_cfg_t * );
66 static void WindowClose ( vout_window_t * );
67 static void *Thread ( void * );
68 static void ShowDialog ( intf_thread_t *, int, int, intf_dialog_args_t * );
70 /*****************************************************************************
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 "\
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." )
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 " \
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." )
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 "controller window title." )
97 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
98 #define NOTIFICATION_LONGTEXT N_( \
99 "Show a notification popup with the artist and track name when " \
100 "the current playlist item changes, when VLC is minimized or hidden." )
102 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
103 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
106 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1" )
107 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
108 "for main interface, playlist and extended panel."\
109 " This option only works with Windows and " \
110 "X11 with composite extensions." )
112 #define OPACITY_FS_TEXT N_( "Fullscreen controller opacity between 0.1 and 1" )
113 #define OPACITY_FS_LONGTEXT N_( "Sets the fullscreen controller opacity between 0.1 and 1 " \
114 "for main interface, playlist and extended panel."\
115 " This option only works with Windows and " \
116 "X11 with composite extensions." )
119 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
121 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
122 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
123 "versions of the software. It runs once every " \
125 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
127 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
129 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
131 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
133 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
134 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
135 "the recent items played in the player" )
137 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
138 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
139 "By specifying the 12 numbers separated by a ';'\n" \
140 "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
141 "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
143 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
144 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
146 " - a zone always present to show information " \
147 "as lyrics, album arts...\n" \
148 " - minimal mode with limited controls" )
150 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
151 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
153 #define FULLSCREEN_NUMBER_TEXT N_( "Define which screen fullscreen goes" )
154 #define FULLSCREEN_NUMBER_LONGTEXT N_( "Screennumber of fullscreen, instead of " \
155 "same screen where interface is" )
157 #define QT_AUTOLOAD_EXTENSIONS_TEXT N_( "Load extensions on startup" )
158 #define QT_AUTOLOAD_EXTENSIONS_LONGTEXT N_( "Automatically load the "\
159 "extensions module on startup" )
161 #define QT_MINIMAL_MODE_TEXT N_("Start in minimal view (without menus)" )
163 #define QT_BGCONE_TEXT N_( "Display background cone or art" )
164 #define QT_BGCONE_LONGTEXT N_( "Display background cone or current album art " \
165 "when not playing." \
166 "Can be disabled to prevent burning screen." )
167 #define QT_BGCONE_EXPANDS_TEXT N_( "Expanding background cone or art." )
168 #define QT_BGCONE_EXPANDS_LONGTEXT N_( "Background art fits window's size" )
170 #define QT_DISABLE_VOLUME_KEYS_TEXT N_( "Ignore keyboard volume buttons." )
171 #define QT_DISABLE_VOLUME_KEYS_LONGTEXT N_( \
172 "With this option checked, the volume up, volume down and mute buttons on your " \
173 "keyboard will always change your system volume. With this option unchecked, the " \
174 "volume buttons will change VLC's volume when VLC is selected and change the " \
175 "system volume when VLC is not selected." )
177 #define QT_PAUSE_MINIMIZED_TEXT N_( "Pause the video playback when minimized" )
178 #define QT_PAUSE_MINIMIZED_LONGTEXT N_( \
179 "With this option enabled, the playback will be automatically paused when minimizing the window." )
181 #define ICONCHANGE_TEXT N_( "Allow automatic icon changes")
182 #define ICONCHANGE_LONGTEXT N_( \
183 "This option allows the interface to change its icon on various occasions.")
185 /**********************************************************************/
187 set_shortname( "Qt" )
188 set_description( N_("Qt interface") )
189 set_category( CAT_INTERFACE )
190 set_subcategory( SUBCAT_INTERFACE_MAIN )
191 set_capability( "interface", 151 )
192 set_callbacks( OpenIntf, Close )
196 add_bool( "qt-minimal-view", false, QT_MINIMAL_MODE_TEXT,
197 QT_MINIMAL_MODE_TEXT, false );
199 add_bool( "qt-system-tray", true, SYSTRAY_TEXT,
200 SYSTRAY_LONGTEXT, false)
201 add_bool( "qt-notification", true, NOTIFICATION_TEXT,
202 NOTIFICATION_LONGTEXT, false )
203 add_bool( "qt-start-minimized", false, MINIMIZED_TEXT,
204 MINIMIZED_LONGTEXT, true)
205 add_bool( "qt-pause-minimized", true, QT_PAUSE_MINIMIZED_TEXT,
206 QT_PAUSE_MINIMIZED_LONGTEXT, false )
208 add_float_with_range( "qt-opacity", 1., 0.1, 1., OPACITY_TEXT,
209 OPACITY_LONGTEXT, false )
210 add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., OPACITY_FS_TEXT,
211 OPACITY_FS_LONGTEXT, false )
213 add_bool( "qt-video-autoresize", true, KEEPSIZE_TEXT,
214 KEEPSIZE_LONGTEXT, false )
215 add_bool( "qt-name-in-title", true, TITLE_TEXT,
216 TITLE_LONGTEXT, false )
217 add_bool( "qt-fs-controller", true, QT_FULLSCREEN_TEXT,
218 QT_FULLSCREEN_TEXT, false )
220 add_bool( "qt-recentplay", true, RECENTPLAY_TEXT,
221 RECENTPLAY_TEXT, false )
222 add_string( "qt-recentplay-filter", "",
223 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
226 add_bool( "qt-updates-notif", true, UPDATER_TEXT,
227 UPDATER_LONGTEXT, false )
228 add_integer( "qt-updates-days", 3, UPDATER_DAYS_TEXT,
229 UPDATER_DAYS_TEXT, false )
232 add_bool( "qt-autosave-volume", false, SAVEVOL_TEXT,
235 add_bool( "qt-disable-volume-keys" /* name */,
236 true /* default value */,
237 QT_DISABLE_VOLUME_KEYS_TEXT /* text */,
238 QT_DISABLE_VOLUME_KEYS_LONGTEXT /* longtext */,
239 false /* advanced mode only */)
242 add_bool( "qt-embedded-open", false, QT_NATIVEOPEN_TEXT,
243 QT_NATIVEOPEN_TEXT, false )
246 add_bool( "qt-advanced-pref", false, ADVANCED_PREFS_TEXT,
247 ADVANCED_PREFS_LONGTEXT, false )
248 add_bool( "qt-error-dialogs", true, ERROR_TEXT,
251 add_string( "qt-slider-colours", "153;210;153;20;210;20;255;199;15;245;39;29",
252 SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
254 add_bool( "qt-privacy-ask", true, PRIVACY_TEXT, PRIVACY_TEXT,
258 add_integer( "qt-fullscreen-screennumber", -1, FULLSCREEN_NUMBER_TEXT,
259 FULLSCREEN_NUMBER_LONGTEXT, false );
261 add_bool( "qt-autoload-extensions", true,
262 QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
265 add_bool( "qt-bgcone", true, QT_BGCONE_TEXT, QT_BGCONE_LONGTEXT, true )
266 add_bool( "qt-bgcone-expands", false, QT_BGCONE_EXPANDS_TEXT,
267 QT_BGCONE_EXPANDS_LONGTEXT, true )
269 add_bool( "qt-icon-change", true, ICONCHANGE_TEXT, ICONCHANGE_LONGTEXT, true )
271 add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
272 add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
274 add_obsolete_bool( "qt-adv-options" ) /* Since 1.2.0 */
275 add_obsolete_bool( "qt-volume-complete" ) /* Since 1.2.0 */
276 add_obsolete_integer( "qt-startvolume" ) /* Since 1.2.0 */
278 cannot_unload_broken_library()
281 set_description( "Dialogs provider" )
282 set_capability( "dialogs provider", 51 )
284 set_callbacks( OpenDialogs, Close )
286 #if defined(Q_WS_X11) || defined(Q_WS_WIN) || defined(Q_WS_MAC)
288 #if defined(Q_WS_X11)
289 set_capability( "vout window xid", 0 )
290 #elif defined(Q_WS_WIN)
291 set_capability( "vout window hwnd", 0 )
292 #elif defined(Q_WS_MAC)
293 set_capability( "vout window nsobject", 0 )
295 set_callbacks( WindowOpen, WindowClose )
300 /*****************************************/
302 /* Ugly, but the Qt4 interface assumes single instance anyway */
303 static vlc_sem_t ready;
305 static bool busy = false;
306 static bool active = false;
308 /*****************************************************************************
310 *****************************************************************************/
313 /* Used to abort the app.exec() on OSX after libvlc_Quit is called */
314 #include "../../../lib/libvlc_internal.h" /* libvlc_SetExitHandler */
315 static void Abort( void *obj )
317 QVLCApp::triggerQuit();
321 static void RegisterIntf( vlc_object_t *p_this )
323 playlist_t *pl = pl_Get(p_this);
324 var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
325 var_SetAddress (pl, "qt4-iface", p_this);
326 var_Create (pl, "window", VLC_VAR_STRING);
327 var_SetString (pl, "window", "qt4,any");
331 static int Open( vlc_object_t *p_this, bool isDialogProvider )
333 intf_thread_t *p_intf = (intf_thread_t *)p_this;
336 if( !vlc_xlib_init( p_this ) )
339 Display *p_display = XOpenDisplay( NULL );
342 msg_Err( p_intf, "Could not connect to X server" );
345 XCloseDisplay( p_display );
348 QMutexLocker locker (&lock);
351 msg_Err (p_this, "cannot start Qt4 multiple times");
355 /* Allocations of p_sys */
356 intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
357 p_intf->p_sys->b_isDialogProvider = isDialogProvider;
361 vlc_sem_init (&ready, 0);
363 /* Run mainloop on the main thread as Cocoa requires */
364 libvlc_SetExitHandler( p_intf->p_libvlc, Abort, p_intf );
365 Thread( (void *)p_intf );
367 if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
374 /* Wait for the interface to be ready. This prevents the main
375 * LibVLC thread from starting video playback before we can create
376 * an embedded video window. */
377 vlc_sem_wait (&ready);
378 vlc_sem_destroy (&ready);
379 busy = active = true;
382 if( !isDialogProvider )
384 RegisterIntf( p_this );
391 /* Open qt4 interface */
392 static int OpenIntf( vlc_object_t *p_this )
394 return Open( p_this, false );
397 /* Open Dialog Provider */
398 static int OpenDialogs( vlc_object_t *p_this )
400 return Open( p_this, true );
403 static void Close( vlc_object_t *p_this )
405 intf_thread_t *p_intf = (intf_thread_t *)p_this;
406 intf_sys_t *p_sys = p_intf->p_sys;
408 if( !p_sys->b_isDialogProvider )
410 var_Destroy (pl_Get(p_this), "window");
411 var_Destroy (pl_Get(p_this), "qt4-iface");
415 msg_Dbg( p_this, "requesting exit..." );
416 QVLCApp::triggerQuit();
418 msg_Dbg( p_this, "waiting for UI thread..." );
420 vlc_join (p_sys->thread, NULL);
424 QMutexLocker locker (&lock);
429 static void *Thread( void *obj )
431 intf_thread_t *p_intf = (intf_thread_t *)obj;
433 char dummy[] = "vlc"; /* for WM_CLASS */
434 char *argv[2] = { dummy, NULL, };
437 Q_INIT_RESOURCE( vlc );
439 /* Start the QApplication here */
440 QVLCApp app( argc, argv );
442 p_intf->p_sys->p_app = &app;
445 /* All the settings are in the .conf/.ini style */
446 p_intf->p_sys->mainSettings = new QSettings(
448 QSettings::IniFormat,
450 QSettings::NativeFormat,
452 QSettings::UserScope, "vlc", "vlc-qt-interface" );
454 /* Icon setting, Mac uses icon from .icns */
456 if( QDate::currentDate().dayOfYear() >= QT_XMAS_JOKE_DAY && var_InheritBool( p_intf, "qt-icon-change" ) )
457 app.setWindowIcon( QIcon(vlc_xmas_xpm) );
459 app.setWindowIcon( QIcon(vlc_xpm) );
462 /* Initialize timers and the Dialog Provider */
463 DialogsProvider::getInstance( p_intf );
465 /* Detect screensize for small screens like TV or Netbooks */
466 p_intf->p_sys->i_screenHeight =
467 app.QApplication::desktop()->availableGeometry().height();
470 /* Checking for VLC updates */
471 if( var_InheritBool( p_intf, "qt-updates-notif" ) &&
472 !var_InheritBool( p_intf, "qt-privacy-ask" ) )
474 int interval = var_InheritInteger( p_intf, "qt-updates-days" );
475 if( QDate::currentDate() >
476 getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
478 /* The constructor of the update Dialog will do the 1st request */
479 UpdateDialog::getInstance( p_intf );
480 getSettings()->setValue( "updatedate", QDate::currentDate() );
485 /* Create the normal interface in non-DP mode */
486 if( !p_intf->p_sys->b_isDialogProvider )
488 p_mi = new MainInterface( p_intf );
489 p_intf->p_sys->p_mi = p_mi;
494 /* Explain how to show a dialog :D */
495 p_intf->pf_show_dialog = ShowDialog;
497 /* Tell the main LibVLC thread we are ready */
498 vlc_sem_post (&ready);
501 /* We took over main thread, register and start here */
502 if( !p_intf->p_sys->b_isDialogProvider )
504 RegisterIntf( (vlc_object_t *)p_intf );
505 playlist_Play( THEPL );
510 if( p_intf->p_sys->b_isDialogProvider )
511 app.setQuitOnLastWindowClosed( false );
513 app.setQuitOnLastWindowClosed( true );
515 /* Retrieve last known path used in file browsing */
516 p_intf->p_sys->filepath =
517 getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
519 /* Loads and tries to apply the preferred QStyle */
520 QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
521 if( s_style.compare("") != 0 )
522 QApplication::setStyle( s_style );
527 msg_Dbg( p_intf, "QApp exec() finished" );
530 QMutexLocker locker (&lock);
533 p_intf->p_sys->p_mi = NULL;
534 /* Destroy first the main interface because it is connected to some
535 slots in the MainInputManager */
539 /* Destroy all remaining windows,
540 because some are connected to some slots
541 in the MainInputManager
542 Settings must be destroyed after that.
544 DialogsProvider::killInstance();
546 /* Delete the recentsMRL object before the configuration */
547 RecentsMRL::killInstance();
549 /* Save the path or delete if recent play are disabled */
550 if( var_InheritBool( p_intf, "qt-recentplay" ) )
551 getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
553 getSettings()->remove( "filedialog-path" );
555 /* Delete the configuration. Application has to be deleted after that. */
556 delete p_intf->p_sys->mainSettings;
558 /* Destroy the MainInputManager */
559 MainInputManager::killInstance();
561 /* Delete the application automatically */
565 /*****************************************************************************
566 * Callback to show a dialog
567 *****************************************************************************/
568 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
569 intf_dialog_args_t *p_arg )
571 VLC_UNUSED( p_intf );
572 DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
573 QApplication::postEvent( THEDP, event );
577 * Video output window provider
579 * TODO move it out of here ?
581 static int WindowControl( vout_window_t *, int i_query, va_list );
583 static int WindowOpen( vout_window_t *p_wnd, const vout_window_cfg_t *cfg )
586 if( cfg->is_standalone )
588 #if defined (Q_WS_X11)
589 if( var_InheritBool( p_wnd, "video-wallpaper" ) )
593 intf_thread_t *p_intf =
594 (intf_thread_t *)var_InheritAddress( p_wnd, "qt4-iface" );
596 { /* If another interface is used, this plugin cannot work */
597 msg_Dbg( p_wnd, "Qt4 interface not found" );
601 QMutexLocker locker (&lock);
602 if (unlikely(!active))
605 MainInterface *p_mi = p_intf->p_sys->p_mi;
606 msg_Dbg( p_wnd, "requesting video..." );
610 unsigned i_width = cfg->width;
611 unsigned i_height = cfg->height;
613 #if defined (Q_WS_X11)
614 p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
615 if( !p_wnd->handle.xid )
617 p_wnd->display.x11 = NULL;
619 #elif defined (Q_WS_WIN)
620 p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
621 if( !p_wnd->handle.hwnd )
624 #elif defined (Q_WS_MAC)
625 p_wnd->handle.nsobject = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
626 if( !p_wnd->handle.nsobject )
632 p_wnd->control = WindowControl;
633 p_wnd->sys = (vout_window_sys_t*)p_mi;
637 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
639 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
640 QMutexLocker locker (&lock);
642 if (unlikely(!active))
644 msg_Warn (p_wnd, "video already released before control");
647 return p_mi->controlVideo( i_query, args );
650 static void WindowClose( vout_window_t *p_wnd )
652 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
653 QMutexLocker locker (&lock);
655 /* Normally, the interface terminates after the video. In the contrary, the
656 * Qt4 main loop is gone, so we cannot send any event to the user interface
657 * widgets. Ideally, we would keep the Qt4 main loop running until after
658 * the video window is released. But it is far simpler to just have the Qt4
659 * thread destroy the window early, and to turn this function into a stub.
661 * That assumes the video output will behave sanely if it window is
662 * destroyed asynchronously.
663 * XCB and Xlib-XCB are fine with that. Plain Xlib wouldn't, */
664 if (unlikely(!active))
666 msg_Warn (p_wnd, "video already released");
669 msg_Dbg (p_wnd, "releasing video...");
670 p_mi->releaseVideo();