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 /**********************************************************************/
170 set_shortname( "Qt" )
171 set_description( N_("Qt interface") )
172 set_category( CAT_INTERFACE )
173 set_subcategory( SUBCAT_INTERFACE_MAIN )
174 set_capability( "interface", 151 )
175 set_callbacks( OpenIntf, Close )
179 add_bool( "qt-minimal-view", false, QT_MINIMAL_MODE_TEXT,
180 QT_MINIMAL_MODE_TEXT, false );
182 add_bool( "qt-notification", true, NOTIFICATION_TEXT,
183 NOTIFICATION_LONGTEXT, false )
185 add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
186 OPACITY_LONGTEXT, false )
187 add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., NULL, OPACITY_FS_TEXT,
188 OPACITY_FS_LONGTEXT, false )
190 add_bool( "qt-system-tray", true, SYSTRAY_TEXT,
191 SYSTRAY_LONGTEXT, false)
192 add_bool( "qt-start-minimized", false, MINIMIZED_TEXT,
193 MINIMIZED_LONGTEXT, true)
194 add_bool( "qt-video-autoresize", true, KEEPSIZE_TEXT,
195 KEEPSIZE_LONGTEXT, false )
196 add_bool( "qt-name-in-title", true, TITLE_TEXT,
197 TITLE_LONGTEXT, false )
198 add_bool( "qt-fs-controller", true, QT_FULLSCREEN_TEXT,
199 QT_FULLSCREEN_TEXT, false )
201 add_bool( "qt-volume-complete", false, COMPLETEVOL_TEXT,
202 COMPLETEVOL_LONGTEXT, true )
203 add_bool( "qt-autosave-volume", false, SAVEVOL_TEXT,
205 add_integer_with_range( "qt-startvolume", QT_VOLUME_DEFAULT, 0,
206 QT_VOLUME_MAX, NULL, STARTVOL_TEXT, STARTVOL_TEXT, true )
208 add_bool( "qt-embedded-open", false, QT_NATIVEOPEN_TEXT,
209 QT_NATIVEOPEN_TEXT, false )
210 add_bool( "qt-recentplay", true, RECENTPLAY_TEXT,
211 RECENTPLAY_TEXT, false )
212 add_string( "qt-recentplay-filter", "",
213 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
215 add_bool( "qt-adv-options", false, ADVANCED_OPTIONS_TEXT,
216 ADVANCED_OPTIONS_LONGTEXT, true )
217 add_bool( "qt-advanced-pref", false, ADVANCED_PREFS_TEXT,
218 ADVANCED_PREFS_LONGTEXT, false )
219 add_bool( "qt-error-dialogs", true, ERROR_TEXT,
222 add_bool( "qt-updates-notif", true, UPDATER_TEXT,
223 UPDATER_LONGTEXT, false )
224 add_integer( "qt-updates-days", 7, UPDATER_DAYS_TEXT,
225 UPDATER_DAYS_TEXT, false )
227 add_string( "qt-slider-colours", "255;255;255;20;210;20;255;199;15;245;39;29",
228 SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
230 add_bool( "qt-privacy-ask", true, PRIVACY_TEXT, PRIVACY_TEXT,
234 add_integer( "qt-fullscreen-screennumber", -1, FULLSCREEN_NUMBER_TEXT,
235 FULLSCREEN_NUMBER_LONGTEXT, false );
237 add_bool( "qt-autoload-extensions", true,
238 QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
241 add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
242 add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
245 cannot_unload_broken_library()
249 set_description( "Dialogs provider" )
250 set_capability( "dialogs provider", 51 )
252 set_callbacks( OpenDialogs, Close )
254 #if defined(Q_WS_X11) || defined(Q_WS_WIN) || defined(Q_WS_MAC)
256 #if defined(Q_WS_X11)
257 set_capability( "vout window xid", 0 )
258 #elif defined(Q_WS_WIN)
259 set_capability( "vout window hwnd", 0 )
260 #elif defined(Q_WS_MAC)
261 set_capability( "vout window nsobject", 0 )
263 set_callbacks( WindowOpen, WindowClose )
268 /*****************************************/
270 /* Ugly, but the Qt4 interface assumes single instance anyway */
271 static vlc_sem_t ready;
273 static char *x11_display = NULL;
276 static bool busy = false;
277 static bool active = false;
279 /*****************************************************************************
281 *****************************************************************************/
284 /* Used to abort the app.exec() on OSX after libvlc_Quit is called */
285 #include "../../../src/control/libvlc_internal.h" /* libvlc_SetExitHandler */
286 static void Abort( void *obj )
288 QVLCApp::triggerQuit();
292 static void RegisterIntf( vlc_object_t *p_this )
294 playlist_t *pl = pl_Get(p_this);
295 var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
296 var_SetAddress (pl, "qt4-iface", p_this);
297 var_Create (pl, "window", VLC_VAR_STRING);
298 var_SetString (pl, "window", "qt4,any");
302 static int Open( vlc_object_t *p_this, bool isDialogProvider )
304 intf_thread_t *p_intf = (intf_thread_t *)p_this;
307 if( !vlc_xlib_init( p_this ) )
310 char *display = var_CreateGetNonEmptyString( p_intf, "x11-display" );
311 Display *p_display = XOpenDisplay( x11_display );
314 msg_Err( p_intf, "Could not connect to X server" );
318 XCloseDisplay( p_display );
320 char *display = NULL;
323 QMutexLocker locker (&lock);
326 msg_Err (p_this, "cannot start Qt4 multiple times");
331 /* Allocations of p_sys */
332 intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
333 p_intf->p_sys->b_isDialogProvider = isDialogProvider;
338 x11_display = display;
340 vlc_sem_init (&ready, 0);
342 /* Run mainloop on the main thread as Cocoa requires */
343 libvlc_SetExitHandler( p_intf->p_libvlc, Abort, p_intf );
344 Thread( (void *)p_intf );
346 if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
354 /* Wait for the interface to be ready. This prevents the main
355 * LibVLC thread from starting video playback before we can create
356 * an embedded video window. */
357 vlc_sem_wait (&ready);
358 vlc_sem_destroy (&ready);
359 busy = active = true;
362 if( !isDialogProvider )
364 RegisterIntf( p_this );
371 /* Open qt4 interface */
372 static int OpenIntf( vlc_object_t *p_this )
374 return Open( p_this, false );
377 /* Open Dialog Provider */
378 static int OpenDialogs( vlc_object_t *p_this )
380 return Open( p_this, true );
383 static void Close( vlc_object_t *p_this )
385 intf_thread_t *p_intf = (intf_thread_t *)p_this;
386 intf_sys_t *p_sys = p_intf->p_sys;
388 if( !p_sys->b_isDialogProvider )
390 var_Destroy (pl_Get(p_this), "window");
391 var_Destroy (pl_Get(p_this), "qt4-iface");
395 msg_Dbg( p_intf, "Please die, die, die..." );
396 QApplication::closeAllWindows();
398 // QApplication::quit();
400 QVLCApp::triggerQuit();
402 msg_Dbg( p_intf, "Please die, die, die 2..." );
404 vlc_join (p_sys->thread, NULL);
412 QMutexLocker locker (&lock);
417 static void *Thread( void *obj )
419 intf_thread_t *p_intf = (intf_thread_t *)obj;
421 char dummy[] = "vlc"; /* for WM_CLASS */
422 char *argv[4] = { dummy, NULL, };
425 Q_INIT_RESOURCE( vlc );
427 /* Start the QApplication here */
429 if( x11_display != NULL )
431 argv[argc++] = const_cast<char *>("-display");
432 argv[argc++] = x11_display;
437 QVLCApp app( argc, argv );
439 p_intf->p_sys->p_app = &app;
442 /* All the settings are in the .conf/.ini style */
443 p_intf->p_sys->mainSettings = new QSettings(
445 QSettings::IniFormat,
447 QSettings::NativeFormat,
449 QSettings::UserScope, "vlc", "vlc-qt-interface" );
451 /* Icon setting, Mac uses icon from .icns */
453 if( QDate::currentDate().dayOfYear() >= 352 ) /* One Week before Xmas */
454 app.setWindowIcon( QIcon(vlc_christmas_xpm) );
456 app.setWindowIcon( QIcon(vlc_xpm) );
459 /* Initialize timers and the Dialog Provider */
460 DialogsProvider::getInstance( p_intf );
462 /* Detect screensize for small screens like TV or Netbooks */
463 p_intf->p_sys->i_screenHeight =
464 app.QApplication::desktop()->availableGeometry().height();
467 /* Checking for VLC updates */
468 if( var_InheritBool( p_intf, "qt-updates-notif" ) &&
469 !var_InheritBool( p_intf, "qt-privacy-ask" ) )
471 int interval = var_InheritInteger( p_intf, "qt-updates-days" );
472 if( QDate::currentDate() >
473 getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
475 /* The constructor of the update Dialog will do the 1st request */
476 UpdateDialog::getInstance( p_intf );
477 getSettings()->setValue( "updatedate", QDate::currentDate() );
482 /* Create the normal interface in non-DP mode */
483 if( !p_intf->p_sys->b_isDialogProvider )
485 p_mi = new MainInterface( p_intf );
486 p_intf->p_sys->p_mi = p_mi;
491 /* Explain how to show a dialog :D */
492 p_intf->pf_show_dialog = ShowDialog;
494 /* Tell the main LibVLC thread we are ready */
495 vlc_sem_post (&ready);
498 /* We took over main thread, register and start here */
499 if( !p_intf->p_sys->b_isDialogProvider )
501 RegisterIntf( (vlc_object_t *)p_intf );
502 playlist_Play( THEPL );
507 app.setQuitOnLastWindowClosed( true );
509 /* Retrieve last known path used in file browsing */
510 p_intf->p_sys->filepath =
511 getSettings()->value( "filedialog-path", QVLCUserDir( VLC_HOME_DIR ) ).toString();
513 /* Loads and tries to apply the preferred QStyle */
514 QString s_style = getSettings()->value( "MainWindow/QtStyle", "" ).toString();
515 if( s_style.compare("") != 0 )
516 QApplication::setStyle( s_style );
521 msg_Dbg( p_intf, "QApp exec() finished" );
524 QMutexLocker locker (&lock);
527 p_intf->p_sys->p_mi = NULL;
528 /* Destroy first the main interface because it is connected to some
529 slots in the MainInputManager */
533 /* Destroy all remaining windows,
534 because some are connected to some slots
535 in the MainInputManager
536 Settings must be destroyed after that.
538 DialogsProvider::killInstance();
540 /* Delete the recentsMRL object before the configuration */
541 RecentsMRL::killInstance();
544 getSettings()->setValue( "filedialog-path", p_intf->p_sys->filepath );
546 /* Delete the configuration. Application has to be deleted after that. */
547 delete p_intf->p_sys->mainSettings;
549 /* Destroy the MainInputManager */
550 MainInputManager::killInstance();
552 /* Delete the application automatically */
556 /*****************************************************************************
557 * Callback to show a dialog
558 *****************************************************************************/
559 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
560 intf_dialog_args_t *p_arg )
562 VLC_UNUSED( p_intf );
563 DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
564 QApplication::postEvent( THEDP, event );
568 * Video output window provider
570 * TODO move it out of here ?
572 #include <vlc_vout_window.h>
574 static int WindowControl( vout_window_t *, int i_query, va_list );
576 static int WindowOpen( vlc_object_t *p_obj )
578 vout_window_t *p_wnd = (vout_window_t*)p_obj;
581 if( p_wnd->cfg->is_standalone )
583 #if defined (Q_WS_X11)
584 if( var_InheritBool( p_obj, "video-wallpaper" ) )
589 if( var_Inherit( p_obj, "qt4-iface", VLC_VAR_ADDRESS, &val ) )
590 val.p_address = NULL;
592 intf_thread_t *p_intf = (intf_thread_t *)val.p_address;
595 { /* If another interface is used, this plugin cannot work */
596 msg_Dbg( p_obj, "Qt4 interface not found" );
600 QMutexLocker locker (&lock);
601 if (unlikely(!active))
604 MainInterface *p_mi = p_intf->p_sys->p_mi;
605 msg_Dbg( p_obj, "requesting video..." );
607 int i_x = p_wnd->cfg->x;
608 int i_y = p_wnd->cfg->y;
609 unsigned i_width = p_wnd->cfg->width;
610 unsigned i_height = p_wnd->cfg->height;
612 #if defined (Q_WS_X11)
613 p_wnd->handle.xid = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
614 if( !p_wnd->handle.xid )
616 p_wnd->display.x11 = x11_display;
618 #elif defined (Q_WS_WIN)
619 p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
620 if( !p_wnd->handle.hwnd )
623 #elif defined (Q_WS_MAC)
624 p_wnd->handle.nsobject = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
625 if( !p_wnd->handle.nsobject )
631 p_wnd->control = WindowControl;
632 p_wnd->sys = (vout_window_sys_t*)p_mi;
636 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
638 MainInterface *p_mi = (MainInterface *)p_wnd->sys;
639 QMutexLocker locker (&lock);
641 if (unlikely(!active))
643 msg_Warn (p_wnd, "video already released before control");
646 return p_mi->controlVideo( i_query, args );
649 static void WindowClose( vlc_object_t *p_obj )
651 vout_window_t *p_wnd = (vout_window_t*)p_obj;
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_obj, "video already released");
669 msg_Dbg (p_obj, "releasing video...");
670 p_mi->releaseVideo();