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 creation */
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 */
46 #include "../../../share/icons/32x32/vlc.xpm"
47 #include "../../../share/icons/32x32/vlc-xmas.xpm"
48 #include <vlc_plugin.h>
49 #include <vlc_vout_window.h>
51 #ifdef WIN32 /* For static builds */
53 Q_IMPORT_PLUGIN(qjpeg)
54 Q_IMPORT_PLUGIN(qtaccessiblewidgets)
57 /*****************************************************************************
59 *****************************************************************************/
60 static int OpenIntf ( vlc_object_t * );
61 static int OpenDialogs ( vlc_object_t * );
62 static int Open ( vlc_object_t *, bool );
63 static void Close ( vlc_object_t * );
64 static int WindowOpen ( vout_window_t *, const vout_window_cfg_t * );
65 static void WindowClose ( vout_window_t * );
66 static void *Thread ( void * );
67 static void ShowDialog ( intf_thread_t *, int, int, intf_dialog_args_t * );
69 /*****************************************************************************
71 *****************************************************************************/
72 #define ADVANCED_PREFS_TEXT N_( "Show advanced preferences over simple ones" )
73 #define ADVANCED_PREFS_LONGTEXT N_( "Show advanced preferences and not simple "\
74 "preferences when opening the preferences "\
77 #define SYSTRAY_TEXT N_( "Systray icon" )
78 #define SYSTRAY_LONGTEXT N_( "Show an icon in the systray " \
79 "allowing you to control VLC media player " \
80 "for basic actions." )
82 #define MINIMIZED_TEXT N_( "Start VLC with only a systray icon" )
83 #define MINIMIZED_LONGTEXT N_( "VLC will start with just an icon in " \
86 #define KEEPSIZE_TEXT N_( "Resize interface to the native video size" )
87 #define KEEPSIZE_LONGTEXT N_( "You have two choices:\n" \
88 " - The interface will resize to the native video size\n" \
89 " - The video will fit to the interface size\n " \
90 "By default, interface resize to the native video size." )
92 #define TITLE_TEXT N_( "Show playing item name in window title" )
93 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
94 "controler window title." )
96 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
97 #define NOTIFICATION_LONGTEXT N_( \
98 "Show a notification popup with the artist and track name when " \
99 "the current playlist item changes, when VLC is minimized or hidden." )
101 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
102 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
105 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1" )
106 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
107 "for main interface, playlist and extended panel."\
108 " This option only works with Windows and " \
109 "X11 with composite extensions." )
111 #define OPACITY_FS_TEXT N_( "Fullscreen controller opacity between 0.1 and 1" )
112 #define OPACITY_FS_LONGTEXT N_( "Sets the fullscreen controller opacity between 0.1 and 1 " \
113 "for main interface, playlist and extended panel."\
114 " This option only works with Windows and " \
115 "X11 with composite extensions." )
118 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
120 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
121 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
122 "versions of the software. It runs once every " \
124 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
126 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
127 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
128 "400%, instead of 0% to 200%. This option " \
129 "can distort the audio, since it uses " \
130 "software amplification." )
132 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
133 #define STARTVOL_TEXT N_( "Default start volume" )
135 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
137 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
139 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
140 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
141 "the recent items played in the player" )
143 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
144 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
145 "By specifying the 12 numbers separated by a ';'\n" \
146 "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
147 "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
149 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
150 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
152 " - a zone always present to show information " \
153 "as lyrics, album arts...\n" \
154 " - minimal mode with limited controls" )
156 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
157 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
159 #define FULLSCREEN_NUMBER_TEXT N_( "Define which screen fullscreen goes" )
160 #define FULLSCREEN_NUMBER_LONGTEXT N_( "Screennumber of fullscreen, instead of" \
161 "same screen where interface is" )
163 #define QT_AUTOLOAD_EXTENSIONS_TEXT N_( "Load extensions on startup" )
164 #define QT_AUTOLOAD_EXTENSIONS_LONGTEXT N_( "Automatically load the "\
165 "extensions module on startup" )
167 #define QT_MINIMAL_MODE_TEXT N_("Start in minimal view (without menus)" )
169 #define QT_BGCONE_TEXT N_( "Display background cone or art" )
170 #define QT_BGCONE_LONGTEXT N_( "Display background cone or current album art " \
171 "when not playing." \
172 "Can be disabled to prevent burning screen." )
173 #define QT_BGCONE_EXPANDS_TEXT N_( "Expanding background cone or art." )
174 #define QT_BGCONE_EXPANDS_LONGTEXT N_( "Background art fits window's size" )
176 #define QT_DISABLE_VOLUME_KEYS_TEXT N_( "Ignore keyboard volume buttons." )
177 #define QT_DISABLE_VOLUME_KEYS_LONGTEXT N_( \
178 "With this option checked, the volume up, volume down and mute buttons on your " \
179 "keyboard will always change your system volume. With this option unchecked, the " \
180 "volume buttons will change VLC's volume when VLC is selected and change the " \
181 "system volume when VLC is not selected." )
183 #define QT_PAUSE_MINIMIZED_TEXT N_( "Pause the video playback when minimized" )
184 #define QT_PAUSE_MINIMIZED_LONGTEXT N_( \
185 "With this option enabled, the playback will be automatically paused when minimizing the window." )
187 #define ICONCHANGE_TEXT N_( "Allow automatic icon changes")
188 #define ICONCHANGE_LONGTEXT N_( \
189 "This option allows the interface to change its icon on various occasions.")
191 /**********************************************************************/
193 set_shortname( "Qt" )
194 set_description( N_("Qt interface") )
195 set_category( CAT_INTERFACE )
196 set_subcategory( SUBCAT_INTERFACE_MAIN )
197 set_capability( "interface", 151 )
198 set_callbacks( OpenIntf, Close )
202 add_bool( "qt-minimal-view", false, QT_MINIMAL_MODE_TEXT,
203 QT_MINIMAL_MODE_TEXT, false );
205 add_bool( "qt-notification", true, NOTIFICATION_TEXT,
206 NOTIFICATION_LONGTEXT, false )
208 add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
209 OPACITY_LONGTEXT, false )
210 add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., NULL, OPACITY_FS_TEXT,
211 OPACITY_FS_LONGTEXT, false )
213 add_bool( "qt-system-tray", true, SYSTRAY_TEXT,
214 SYSTRAY_LONGTEXT, false)
215 add_bool( "qt-start-minimized", false, MINIMIZED_TEXT,
216 MINIMIZED_LONGTEXT, true)
217 add_bool( "qt-video-autoresize", true, KEEPSIZE_TEXT,
218 KEEPSIZE_LONGTEXT, false )
219 add_bool( "qt-name-in-title", true, TITLE_TEXT,
220 TITLE_LONGTEXT, false )
221 add_bool( "qt-fs-controller", true, QT_FULLSCREEN_TEXT,
222 QT_FULLSCREEN_TEXT, false )
224 add_bool( "qt-volume-complete", false, COMPLETEVOL_TEXT,
225 COMPLETEVOL_LONGTEXT, true )
226 add_bool( "qt-autosave-volume", false, SAVEVOL_TEXT,
228 add_integer_with_range( "qt-startvolume", QT_VOLUME_DEFAULT, 0,
229 QT_VOLUME_MAX, NULL, STARTVOL_TEXT, STARTVOL_TEXT, true )
231 add_bool( "qt-embedded-open", false, QT_NATIVEOPEN_TEXT,
232 QT_NATIVEOPEN_TEXT, false )
233 add_bool( "qt-recentplay", true, RECENTPLAY_TEXT,
234 RECENTPLAY_TEXT, false )
235 add_string( "qt-recentplay-filter", "",
236 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
238 add_bool( "qt-adv-options", false, ADVANCED_OPTIONS_TEXT,
239 ADVANCED_OPTIONS_LONGTEXT, true )
240 add_bool( "qt-advanced-pref", false, ADVANCED_PREFS_TEXT,
241 ADVANCED_PREFS_LONGTEXT, false )
242 add_bool( "qt-error-dialogs", true, ERROR_TEXT,
245 add_bool( "qt-updates-notif", true, UPDATER_TEXT,
246 UPDATER_LONGTEXT, false )
247 add_integer( "qt-updates-days", 3, UPDATER_DAYS_TEXT,
248 UPDATER_DAYS_TEXT, false )
250 add_string( "qt-slider-colours", "255;255;255;20;210;20;255;199;15;245;39;29",
251 SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
253 add_bool( "qt-privacy-ask", true, PRIVACY_TEXT, PRIVACY_TEXT,
257 add_integer( "qt-fullscreen-screennumber", -1, FULLSCREEN_NUMBER_TEXT,
258 FULLSCREEN_NUMBER_LONGTEXT, false );
260 add_bool( "qt-autoload-extensions", true,
261 QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
264 add_bool( "qt-bgcone", true, QT_BGCONE_TEXT, QT_BGCONE_LONGTEXT, true )
265 add_bool( "qt-bgcone-expands", false, QT_BGCONE_EXPANDS_TEXT,
266 QT_BGCONE_EXPANDS_LONGTEXT, true )
269 add_bool( "qt-disable-volume-keys" /* name */,
270 true /* default value */,
271 QT_DISABLE_VOLUME_KEYS_TEXT /* text */,
272 QT_DISABLE_VOLUME_KEYS_LONGTEXT /* longtext */,
273 false /* advanced mode only */)
276 add_bool( "qt-pause-minimized", true, QT_PAUSE_MINIMIZED_TEXT,
277 QT_PAUSE_MINIMIZED_LONGTEXT, false )
279 add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
280 add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
282 add_bool( "qt-icon-change", true, ICONCHANGE_TEXT, ICONCHANGE_LONGTEXT, true )
285 cannot_unload_broken_library()
289 set_description( "Dialogs provider" )
290 set_capability( "dialogs provider", 51 )
292 set_callbacks( OpenDialogs, Close )
294 #if defined(Q_WS_X11) || defined(Q_WS_WIN) || defined(Q_WS_MAC)
296 #if defined(Q_WS_X11)
297 set_capability( "vout window xid", 0 )
298 #elif defined(Q_WS_WIN)
299 set_capability( "vout window hwnd", 0 )
300 #elif defined(Q_WS_MAC)
301 set_capability( "vout window nsobject", 0 )
303 set_callbacks( WindowOpen, WindowClose )
308 /*****************************************/
310 /* Ugly, but the Qt4 interface assumes single instance anyway */
311 static vlc_sem_t ready;
313 static bool busy = false;
314 static bool active = false;
316 /*****************************************************************************
318 *****************************************************************************/
321 /* Used to abort the app.exec() on OSX after libvlc_Quit is called */
322 #include "../../../src/control/libvlc_internal.h" /* libvlc_SetExitHandler */
323 static void Abort( void *obj )
325 QVLCApp::triggerQuit();
329 static void RegisterIntf( vlc_object_t *p_this )
331 playlist_t *pl = pl_Get(p_this);
332 var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
333 var_SetAddress (pl, "qt4-iface", p_this);
334 var_Create (pl, "window", VLC_VAR_STRING);
335 var_SetString (pl, "window", "qt4,any");
339 static int Open( vlc_object_t *p_this, bool isDialogProvider )
341 intf_thread_t *p_intf = (intf_thread_t *)p_this;
344 if( !vlc_xlib_init( p_this ) )
347 Display *p_display = XOpenDisplay( NULL );
350 msg_Err( p_intf, "Could not connect to X server" );
353 XCloseDisplay( p_display );
356 QMutexLocker locker (&lock);
359 msg_Err (p_this, "cannot start Qt4 multiple times");
363 /* Allocations of p_sys */
364 intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
365 p_intf->p_sys->b_isDialogProvider = isDialogProvider;
369 vlc_sem_init (&ready, 0);
371 /* Run mainloop on the main thread as Cocoa requires */
372 libvlc_SetExitHandler( p_intf->p_libvlc, Abort, p_intf );
373 Thread( (void *)p_intf );
375 if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
382 /* Wait for the interface to be ready. This prevents the main
383 * LibVLC thread from starting video playback before we can create
384 * an embedded video window. */
385 vlc_sem_wait (&ready);
386 vlc_sem_destroy (&ready);
387 busy = active = true;
390 if( !isDialogProvider )
392 RegisterIntf( p_this );
399 /* Open qt4 interface */
400 static int OpenIntf( vlc_object_t *p_this )
402 return Open( p_this, false );
405 /* Open Dialog Provider */
406 static int OpenDialogs( vlc_object_t *p_this )
408 return Open( p_this, true );
411 static void Close( vlc_object_t *p_this )
413 intf_thread_t *p_intf = (intf_thread_t *)p_this;
414 intf_sys_t *p_sys = p_intf->p_sys;
416 if( !p_sys->b_isDialogProvider )
418 var_Destroy (pl_Get(p_this), "window");
419 var_Destroy (pl_Get(p_this), "qt4-iface");
423 msg_Dbg( p_this, "requesting exit..." );
424 QVLCApp::triggerQuit();
426 msg_Dbg( p_this, "waiting for UI thread..." );
428 vlc_join (p_sys->thread, NULL);
432 QMutexLocker locker (&lock);
437 static void *Thread( void *obj )
439 intf_thread_t *p_intf = (intf_thread_t *)obj;
441 char dummy[] = "vlc"; /* for WM_CLASS */
442 char *argv[2] = { dummy, NULL, };
445 Q_INIT_RESOURCE( vlc );
447 /* Start the QApplication here */
448 QVLCApp app( argc, argv );
450 p_intf->p_sys->p_app = &app;
453 /* All the settings are in the .conf/.ini style */
454 p_intf->p_sys->mainSettings = new QSettings(
456 QSettings::IniFormat,
458 QSettings::NativeFormat,
460 QSettings::UserScope, "vlc", "vlc-qt-interface" );
462 /* Icon setting, Mac uses icon from .icns */
464 if( QDate::currentDate().dayOfYear() >= QT_XMAS_JOKE_DAY && var_InheritBool( p_intf, "qt-icon-change" ) )
465 app.setWindowIcon( QIcon(vlc_xmas_xpm) );
467 app.setWindowIcon( QIcon(vlc_xpm) );
470 /* Initialize timers and the Dialog Provider */
471 DialogsProvider::getInstance( p_intf );
473 /* Detect screensize for small screens like TV or Netbooks */
474 p_intf->p_sys->i_screenHeight =
475 app.QApplication::desktop()->availableGeometry().height();
478 /* Checking for VLC updates */
479 if( var_InheritBool( p_intf, "qt-updates-notif" ) &&
480 !var_InheritBool( p_intf, "qt-privacy-ask" ) )
482 int interval = var_InheritInteger( p_intf, "qt-updates-days" );
483 if( QDate::currentDate() >
484 getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
486 /* The constructor of the update Dialog will do the 1st request */
487 UpdateDialog::getInstance( p_intf );
488 getSettings()->setValue( "updatedate", QDate::currentDate() );
493 /* Create the normal interface in non-DP mode */
494 if( !p_intf->p_sys->b_isDialogProvider )
496 p_mi = new MainInterface( p_intf );
497 p_intf->p_sys->p_mi = p_mi;
502 /* Explain how to show a dialog :D */
503 p_intf->pf_show_dialog = ShowDialog;
505 /* Tell the main LibVLC thread we are ready */
506 vlc_sem_post (&ready);
509 /* We took over main thread, register and start here */
510 if( !p_intf->p_sys->b_isDialogProvider )
512 RegisterIntf( (vlc_object_t *)p_intf );
513 playlist_Play( THEPL );
518 if( p_intf->p_sys->b_isDialogProvider )
519 app.setQuitOnLastWindowClosed( false );
521 app.setQuitOnLastWindowClosed( true );
523 /* Retrieve last known path used in file browsing */
524 p_intf->p_sys->filepath =
525 getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
527 /* Loads and tries to apply the preferred QStyle */
528 QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
529 if( s_style.compare("") != 0 )
530 QApplication::setStyle( s_style );
535 msg_Dbg( p_intf, "QApp exec() finished" );
538 QMutexLocker locker (&lock);
541 p_intf->p_sys->p_mi = NULL;
542 /* Destroy first the main interface because it is connected to some
543 slots in the MainInputManager */
547 /* Destroy all remaining windows,
548 because some are connected to some slots
549 in the MainInputManager
550 Settings must be destroyed after that.
552 DialogsProvider::killInstance();
554 /* Delete the recentsMRL object before the configuration */
555 RecentsMRL::killInstance();
558 getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
560 /* Delete the configuration. Application has to be deleted after that. */
561 delete p_intf->p_sys->mainSettings;
563 /* Destroy the MainInputManager */
564 MainInputManager::killInstance();
566 /* Delete the application automatically */
570 /*****************************************************************************
571 * Callback to show a dialog
572 *****************************************************************************/
573 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
574 intf_dialog_args_t *p_arg )
576 VLC_UNUSED( p_intf );
577 DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
578 QApplication::postEvent( THEDP, event );
582 * Video output window provider
584 * TODO move it out of here ?
586 static int WindowControl( vout_window_t *, int i_query, va_list );
588 static int WindowOpen( vout_window_t *p_wnd, const vout_window_cfg_t *cfg )
591 if( cfg->is_standalone )
593 #if defined (Q_WS_X11)
594 if( var_InheritBool( p_wnd, "video-wallpaper" ) )
598 intf_thread_t *p_intf =
599 (intf_thread_t *)var_InheritAddress( p_wnd, "qt4-iface" );
601 { /* If another interface is used, this plugin cannot work */
602 msg_Dbg( p_wnd, "Qt4 interface not found" );
606 QMutexLocker locker (&lock);
607 if (unlikely(!active))
610 MainInterface *p_mi = p_intf->p_sys->p_mi;
611 msg_Dbg( p_wnd, "requesting video..." );
615 unsigned i_width = cfg->width;
616 unsigned i_height = cfg->height;
618 #if defined (Q_WS_X11)
619 p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
620 if( !p_wnd->handle.xid )
622 p_wnd->display.x11 = NULL;
624 #elif defined (Q_WS_WIN)
625 p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
626 if( !p_wnd->handle.hwnd )
629 #elif defined (Q_WS_MAC)
630 p_wnd->handle.nsobject = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
631 if( !p_wnd->handle.nsobject )
637 p_wnd->control = WindowControl;
638 p_wnd->sys = (vout_window_sys_t*)p_mi;
642 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
644 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
645 QMutexLocker locker (&lock);
647 if (unlikely(!active))
649 msg_Warn (p_wnd, "video already released before control");
652 return p_mi->controlVideo( i_query, args );
655 static void WindowClose( vout_window_t *p_wnd )
657 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
658 QMutexLocker locker (&lock);
660 /* Normally, the interface terminates after the video. In the contrary, the
661 * Qt4 main loop is gone, so we cannot send any event to the user interface
662 * widgets. Ideally, we would keep the Qt4 main loop running until after
663 * the video window is released. But it is far simpler to just have the Qt4
664 * thread destroy the window early, and to turn this function into a stub.
666 * That assumes the video output will behave sanely if it window is
667 * destroyed asynchronously.
668 * XCB and Xlib-XCB are fine with that. Plain Xlib wouldn't, */
669 if (unlikely(!active))
671 msg_Warn (p_wnd, "video already released");
674 msg_Dbg (p_wnd, "releasing video...");
675 p_mi->releaseVideo();