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-christmas.xpm"
48 #include <vlc_plugin.h>
50 #ifdef WIN32 /* For static builds */
52 Q_IMPORT_PLUGIN(qjpeg)
53 Q_IMPORT_PLUGIN(qtaccessiblewidgets)
56 /*****************************************************************************
58 *****************************************************************************/
59 static int OpenIntf ( vlc_object_t * );
60 static int OpenDialogs ( vlc_object_t * );
61 static int Open ( vlc_object_t *, bool );
62 static void Close ( vlc_object_t * );
63 static int WindowOpen ( vlc_object_t * );
64 static void WindowClose ( vlc_object_t * );
65 static void *Thread ( void * );
66 static void ShowDialog ( intf_thread_t *, int, int, intf_dialog_args_t * );
68 /*****************************************************************************
70 *****************************************************************************/
71 #define ADVANCED_PREFS_TEXT N_( "Show advanced preferences over simple ones" )
72 #define ADVANCED_PREFS_LONGTEXT N_( "Show advanced preferences and not simple "\
73 "preferences when opening the preferences "\
76 #define SYSTRAY_TEXT N_( "Systray icon" )
77 #define SYSTRAY_LONGTEXT N_( "Show an icon in the systray " \
78 "allowing you to control VLC media player " \
79 "for basic actions." )
81 #define MINIMIZED_TEXT N_( "Start VLC with only a systray icon" )
82 #define MINIMIZED_LONGTEXT N_( "VLC will start with just an icon in " \
85 #define KEEPSIZE_TEXT N_( "Resize interface to the native video size" )
86 #define KEEPSIZE_LONGTEXT N_( "You have two choices:\n" \
87 " - The interface will resize to the native video size\n" \
88 " - The video will fit to the interface size\n " \
89 "By default, interface resize to the native video size." )
91 #define TITLE_TEXT N_( "Show playing item name in window title" )
92 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
93 "controler window title." )
95 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
96 #define NOTIFICATION_LONGTEXT N_( \
97 "Show a notification popup with the artist and track name when " \
98 "the current playlist item changes, when VLC is minimized or hidden." )
100 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
101 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
104 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1" )
105 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
106 "for main interface, playlist and extended panel."\
107 " This option only works with Windows and " \
108 "X11 with composite extensions." )
110 #define OPACITY_FS_TEXT N_( "Fullscreen controller opacity between 0.1 and 1" )
111 #define OPACITY_FS_LONGTEXT N_( "Sets the fullscreen controller opacity between 0.1 and 1 " \
112 "for main interface, playlist and extended panel."\
113 " This option only works with Windows and " \
114 "X11 with composite extensions." )
117 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
119 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
120 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
121 "versions of the software. It runs once every " \
123 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
125 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
126 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
127 "400%, instead of 0% to 200%. This option " \
128 "can distort the audio, since it uses " \
129 "software amplification." )
131 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
132 #define STARTVOL_TEXT N_( "Default start volume" )
134 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
136 #define RECENTPLAY_TEXT N_( "Save the recently played items in the menu" )
138 #define RECENTPLAY_FILTER_TEXT N_( "List of words separated by | to filter" )
139 #define RECENTPLAY_FILTER_LONGTEXT N_( "Regular expression used to filter " \
140 "the recent items played in the player" )
142 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
143 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
144 "By specifying the 12 numbers separated by a ';'\n" \
145 "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
146 "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
148 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
149 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
151 " - a zone always present to show information " \
152 "as lyrics, album arts...\n" \
153 " - minimal mode with limited controls" )
155 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
156 #define QT_NATIVEOPEN_TEXT N_( "Embed the file browser in open dialog" )
158 #define FULLSCREEN_NUMBER_TEXT N_( "Define which screen fullscreen goes" )
159 #define FULLSCREEN_NUMBER_LONGTEXT N_( "Screennumber of fullscreen, instead of" \
160 "same screen where interface is" )
162 #define QT_AUTOLOAD_EXTENSIONS_TEXT N_( "Load extensions on startup" )
163 #define QT_AUTOLOAD_EXTENSIONS_LONGTEXT N_( "Automatically load the "\
164 "extensions module on startup" )
166 #define QT_MINIMAL_MODE_TEXT N_("Start in minimal view (without menus)" )
168 #define QT_BGCONE_TEXT N_( "Display background cone or art" )
169 #define QT_BGCONE_LONGTEXT N_( "Display background cone or current album art " \
170 "when not playing." \
171 "Can be disabled to prevent burning screen." )
172 #define QT_BGCONE_EXPANDS_TEXT N_( "Expanding background cone or art." )
173 #define QT_BGCONE_EXPANDS_LONGTEXT N_( "Background art fits window's size" )
175 #define QT_DISABLE_VOLUME_KEYS_TEXT N_( "Ignore keyboard volume buttons." )
176 #define QT_DISABLE_VOLUME_KEYS_LONGTEXT N_( \
177 "With this option checked, the volume up, volume down and mute buttons on your " \
178 "keyboard will always change your system volume. With this option unchecked, the " \
179 "volume buttons will change VLC's volume when VLC is selected and change the " \
180 "system volume when VLC is not selected." )
181 /**********************************************************************/
183 set_shortname( "Qt" )
184 set_description( N_("Qt interface") )
185 set_category( CAT_INTERFACE )
186 set_subcategory( SUBCAT_INTERFACE_MAIN )
187 set_capability( "interface", 151 )
188 set_callbacks( OpenIntf, Close )
192 add_bool( "qt-minimal-view", false, QT_MINIMAL_MODE_TEXT,
193 QT_MINIMAL_MODE_TEXT, false );
195 add_bool( "qt-notification", true, NOTIFICATION_TEXT,
196 NOTIFICATION_LONGTEXT, false )
198 add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
199 OPACITY_LONGTEXT, false )
200 add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., NULL, OPACITY_FS_TEXT,
201 OPACITY_FS_LONGTEXT, false )
203 add_bool( "qt-system-tray", true, SYSTRAY_TEXT,
204 SYSTRAY_LONGTEXT, false)
205 add_bool( "qt-start-minimized", false, MINIMIZED_TEXT,
206 MINIMIZED_LONGTEXT, true)
207 add_bool( "qt-video-autoresize", true, KEEPSIZE_TEXT,
208 KEEPSIZE_LONGTEXT, false )
209 add_bool( "qt-name-in-title", true, TITLE_TEXT,
210 TITLE_LONGTEXT, false )
211 add_bool( "qt-fs-controller", true, QT_FULLSCREEN_TEXT,
212 QT_FULLSCREEN_TEXT, false )
214 add_bool( "qt-volume-complete", false, COMPLETEVOL_TEXT,
215 COMPLETEVOL_LONGTEXT, true )
216 add_bool( "qt-autosave-volume", false, SAVEVOL_TEXT,
218 add_integer_with_range( "qt-startvolume", QT_VOLUME_DEFAULT, 0,
219 QT_VOLUME_MAX, NULL, STARTVOL_TEXT, STARTVOL_TEXT, true )
221 add_bool( "qt-embedded-open", false, QT_NATIVEOPEN_TEXT,
222 QT_NATIVEOPEN_TEXT, false )
223 add_bool( "qt-recentplay", true, RECENTPLAY_TEXT,
224 RECENTPLAY_TEXT, false )
225 add_string( "qt-recentplay-filter", "",
226 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
228 add_bool( "qt-adv-options", false, ADVANCED_OPTIONS_TEXT,
229 ADVANCED_OPTIONS_LONGTEXT, true )
230 add_bool( "qt-advanced-pref", false, ADVANCED_PREFS_TEXT,
231 ADVANCED_PREFS_LONGTEXT, false )
232 add_bool( "qt-error-dialogs", true, ERROR_TEXT,
235 add_bool( "qt-updates-notif", true, UPDATER_TEXT,
236 UPDATER_LONGTEXT, false )
237 add_integer( "qt-updates-days", 7, UPDATER_DAYS_TEXT,
238 UPDATER_DAYS_TEXT, false )
240 add_string( "qt-slider-colours", "255;255;255;20;210;20;255;199;15;245;39;29",
241 SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
243 add_bool( "qt-privacy-ask", true, PRIVACY_TEXT, PRIVACY_TEXT,
247 add_integer( "qt-fullscreen-screennumber", -1, FULLSCREEN_NUMBER_TEXT,
248 FULLSCREEN_NUMBER_LONGTEXT, false );
250 add_bool( "qt-autoload-extensions", true,
251 QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
254 add_bool( "qt-bgcone", true, QT_BGCONE_TEXT, QT_BGCONE_LONGTEXT, true )
255 add_bool( "qt-bgcone-expands", false, QT_BGCONE_EXPANDS_TEXT,
256 QT_BGCONE_EXPANDS_LONGTEXT, true )
259 add_bool( "qt-disable-volume-keys" /* name */,
260 false /* default value */,
261 QT_DISABLE_VOLUME_KEYS_TEXT /* text */,
262 QT_DISABLE_VOLUME_KEYS_LONGTEXT /* longtext */,
263 false /* advanced mode only */)
266 add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
267 add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
270 cannot_unload_broken_library()
274 set_description( "Dialogs provider" )
275 set_capability( "dialogs provider", 51 )
277 set_callbacks( OpenDialogs, Close )
279 #if defined(Q_WS_X11) || defined(Q_WS_WIN) || defined(Q_WS_MAC)
281 #if defined(Q_WS_X11)
282 set_capability( "vout window xid", 0 )
283 #elif defined(Q_WS_WIN)
284 set_capability( "vout window hwnd", 0 )
285 #elif defined(Q_WS_MAC)
286 set_capability( "vout window nsobject", 0 )
288 set_callbacks( WindowOpen, WindowClose )
293 /*****************************************/
295 /* Ugly, but the Qt4 interface assumes single instance anyway */
296 static vlc_sem_t ready;
298 static char *x11_display = NULL;
301 static bool busy = false;
302 static bool active = false;
304 /*****************************************************************************
306 *****************************************************************************/
309 /* Used to abort the app.exec() on OSX after libvlc_Quit is called */
310 #include "../../../src/control/libvlc_internal.h" /* libvlc_SetExitHandler */
311 static void Abort( void *obj )
313 QVLCApp::triggerQuit();
317 static void RegisterIntf( vlc_object_t *p_this )
319 playlist_t *pl = pl_Get(p_this);
320 var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
321 var_SetAddress (pl, "qt4-iface", p_this);
322 var_Create (pl, "window", VLC_VAR_STRING);
323 var_SetString (pl, "window", "qt4,any");
327 static int Open( vlc_object_t *p_this, bool isDialogProvider )
329 intf_thread_t *p_intf = (intf_thread_t *)p_this;
332 if( !vlc_xlib_init( p_this ) )
335 char *display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
336 Display *p_display = XOpenDisplay( x11_display );
339 msg_Err( p_intf, "Could not connect to X server" );
343 XCloseDisplay( p_display );
345 char *display = NULL;
348 QMutexLocker locker (&lock);
351 msg_Err (p_this, "cannot start Qt4 multiple times");
356 /* Allocations of p_sys */
357 intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
358 p_intf->p_sys->b_isDialogProvider = isDialogProvider;
363 x11_display = display;
365 vlc_sem_init (&ready, 0);
367 /* Run mainloop on the main thread as Cocoa requires */
368 libvlc_SetExitHandler( p_intf->p_libvlc, Abort, p_intf );
369 Thread( (void *)p_intf );
371 if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
379 /* Wait for the interface to be ready. This prevents the main
380 * LibVLC thread from starting video playback before we can create
381 * an embedded video window. */
382 vlc_sem_wait (&ready);
383 vlc_sem_destroy (&ready);
384 busy = active = true;
387 if( !isDialogProvider )
389 RegisterIntf( p_this );
396 /* Open qt4 interface */
397 static int OpenIntf( vlc_object_t *p_this )
399 return Open( p_this, false );
402 /* Open Dialog Provider */
403 static int OpenDialogs( vlc_object_t *p_this )
405 return Open( p_this, true );
408 static void Close( vlc_object_t *p_this )
410 intf_thread_t *p_intf = (intf_thread_t *)p_this;
411 intf_sys_t *p_sys = p_intf->p_sys;
413 if( !p_sys->b_isDialogProvider )
415 var_Destroy (pl_Get(p_this), "window");
416 var_Destroy (pl_Get(p_this), "qt4-iface");
420 msg_Dbg( p_this, "requesting exit..." );
421 QVLCApp::triggerQuit();
423 msg_Dbg( p_this, "waiting for UI thread..." );
425 vlc_join (p_sys->thread, NULL);
433 QMutexLocker locker (&lock);
438 static void *Thread( void *obj )
440 intf_thread_t *p_intf = (intf_thread_t *)obj;
442 char dummy[] = "vlc"; /* for WM_CLASS */
443 char *argv[4] = { dummy, NULL, };
446 Q_INIT_RESOURCE( vlc );
448 /* Start the QApplication here */
450 if( x11_display != NULL )
452 argv[argc++] = const_cast<char *>("-display");
453 argv[argc++] = x11_display;
458 QVLCApp app( argc, argv );
460 p_intf->p_sys->p_app = &app;
463 /* All the settings are in the .conf/.ini style */
464 p_intf->p_sys->mainSettings = new QSettings(
466 QSettings::IniFormat,
468 QSettings::NativeFormat,
470 QSettings::UserScope, "vlc", "vlc-qt-interface" );
472 /* Icon setting, Mac uses icon from .icns */
474 if( QDate::currentDate().dayOfYear() >= QT_CHRISTMAS_TROLL_DAY )
475 app.setWindowIcon( QIcon(vlc_christmas_xpm) );
477 app.setWindowIcon( QIcon(vlc_xpm) );
480 /* Initialize timers and the Dialog Provider */
481 DialogsProvider::getInstance( p_intf );
483 /* Detect screensize for small screens like TV or Netbooks */
484 p_intf->p_sys->i_screenHeight =
485 app.QApplication::desktop()->availableGeometry().height();
488 /* Checking for VLC updates */
489 if( var_InheritBool( p_intf, "qt-updates-notif" ) &&
490 !var_InheritBool( p_intf, "qt-privacy-ask" ) )
492 int interval = var_InheritInteger( p_intf, "qt-updates-days" );
493 if( QDate::currentDate() >
494 getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
496 /* The constructor of the update Dialog will do the 1st request */
497 UpdateDialog::getInstance( p_intf );
498 getSettings()->setValue( "updatedate", QDate::currentDate() );
503 /* Create the normal interface in non-DP mode */
504 if( !p_intf->p_sys->b_isDialogProvider )
506 p_mi = new MainInterface( p_intf );
507 p_intf->p_sys->p_mi = p_mi;
512 /* Explain how to show a dialog :D */
513 p_intf->pf_show_dialog = ShowDialog;
515 /* Tell the main LibVLC thread we are ready */
516 vlc_sem_post (&ready);
519 /* We took over main thread, register and start here */
520 if( !p_intf->p_sys->b_isDialogProvider )
522 RegisterIntf( (vlc_object_t *)p_intf );
523 playlist_Play( THEPL );
528 app.setQuitOnLastWindowClosed( true );
530 /* Retrieve last known path used in file browsing */
531 p_intf->p_sys->filepath =
532 getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
534 /* Loads and tries to apply the preferred QStyle */
535 QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
536 if( s_style.compare("") != 0 )
537 QApplication::setStyle( s_style );
542 msg_Dbg( p_intf, "QApp exec() finished" );
545 QMutexLocker locker (&lock);
548 p_intf->p_sys->p_mi = NULL;
549 /* Destroy first the main interface because it is connected to some
550 slots in the MainInputManager */
554 /* Destroy all remaining windows,
555 because some are connected to some slots
556 in the MainInputManager
557 Settings must be destroyed after that.
559 DialogsProvider::killInstance();
561 /* Delete the recentsMRL object before the configuration */
562 RecentsMRL::killInstance();
565 getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
567 /* Delete the configuration. Application has to be deleted after that. */
568 delete p_intf->p_sys->mainSettings;
570 /* Destroy the MainInputManager */
571 MainInputManager::killInstance();
573 /* Delete the application automatically */
577 /*****************************************************************************
578 * Callback to show a dialog
579 *****************************************************************************/
580 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
581 intf_dialog_args_t *p_arg )
583 VLC_UNUSED( p_intf );
584 DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
585 QApplication::postEvent( THEDP, event );
589 * Video output window provider
591 * TODO move it out of here ?
593 #include <vlc_vout_window.h>
595 static int WindowControl( vout_window_t *, int i_query, va_list );
597 static int WindowOpen( vlc_object_t *p_obj )
599 vout_window_t *p_wnd = (vout_window_t*)p_obj;
602 if( p_wnd->cfg->is_standalone )
604 #if defined (Q_WS_X11)
605 if( var_InheritBool( p_obj, "video-wallpaper" ) )
610 if( var_Inherit( p_obj, "qt4-iface", VLC_VAR_ADDRESS, &val ) )
611 val.p_address = NULL;
613 intf_thread_t *p_intf = (intf_thread_t *)val.p_address;
616 { /* If another interface is used, this plugin cannot work */
617 msg_Dbg( p_obj, "Qt4 interface not found" );
621 QMutexLocker locker (&lock);
622 if (unlikely(!active))
625 MainInterface *p_mi = p_intf->p_sys->p_mi;
626 msg_Dbg( p_obj, "requesting video..." );
628 int i_x = p_wnd->cfg->x;
629 int i_y = p_wnd->cfg->y;
630 unsigned i_width = p_wnd->cfg->width;
631 unsigned i_height = p_wnd->cfg->height;
633 #if defined (Q_WS_X11)
634 p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
635 if( !p_wnd->handle.xid )
637 p_wnd->display.x11 = x11_display;
639 #elif defined (Q_WS_WIN)
640 p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
641 if( !p_wnd->handle.hwnd )
644 #elif defined (Q_WS_MAC)
645 p_wnd->handle.nsobject = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
646 if( !p_wnd->handle.nsobject )
652 p_wnd->control = WindowControl;
653 p_wnd->sys = (vout_window_sys_t*)p_mi;
657 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
659 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
660 QMutexLocker locker (&lock);
662 if (unlikely(!active))
664 msg_Warn (p_wnd, "video already released before control");
667 return p_mi->controlVideo( i_query, args );
670 static void WindowClose( vlc_object_t *p_obj )
672 vout_window_t *p_wnd = (vout_window_t*)p_obj;
673 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
674 QMutexLocker locker (&lock);
676 /* Normally, the interface terminates after the video. In the contrary, the
677 * Qt4 main loop is gone, so we cannot send any event to the user interface
678 * widgets. Ideally, we would keep the Qt4 main loop running until after
679 * the video window is released. But it is far simpler to just have the Qt4
680 * thread destroy the window early, and to turn this function into a stub.
682 * That assumes the video output will behave sanely if it window is
683 * destroyed asynchronously.
684 * XCB and Xlib-XCB are fine with that. Plain Xlib wouldn't, */
685 if (unlikely(!active))
687 msg_Warn (p_obj, "video already released");
690 msg_Dbg (p_obj, "releasing video...");
691 p_mi->releaseVideo();