]> git.sesse.net Git - vlc/blobdiff - modules/gui/qt4/qt4.cpp
Qt: option for enabling / disabling changes to its icon
[vlc] / modules / gui / qt4 / qt4.cpp
index 990b2554754165072708d7f1cf46ae068a020639..9caadf7d23b6c87b68f79153635e26108935c095 100644 (file)
@@ -28,6 +28,7 @@
 
 #include <QApplication>
 #include <QDate>
+#include <QMutex>
 
 #include "qt4.hpp"
 
@@ -43,7 +44,7 @@
 #endif
 
 #include "../../../share/icons/32x32/vlc.xpm"
-#include "../../../share/icons/32x32/vlc-christmas.xpm"
+#include "../../../share/icons/32x32/vlc-xmas.xpm"
 #include <vlc_plugin.h>
 
 #ifdef WIN32 /* For static builds */
@@ -128,6 +129,7 @@ static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
                                  "software amplification." )
 
 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
+#define STARTVOL_TEXT N_( "Default start volume" )
 
 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
 
@@ -163,6 +165,28 @@ static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
 
 #define QT_MINIMAL_MODE_TEXT N_("Start in minimal view (without menus)" )
 
+#define QT_BGCONE_TEXT N_( "Display background cone or art" )
+#define QT_BGCONE_LONGTEXT N_( "Display background cone or current album art " \
+                            "when not playing." \
+                            "Can be disabled to prevent burning screen." )
+#define QT_BGCONE_EXPANDS_TEXT N_( "Expanding background cone or art." )
+#define QT_BGCONE_EXPANDS_LONGTEXT N_( "Background art fits window's size" )
+
+#define QT_DISABLE_VOLUME_KEYS_TEXT N_( "Ignore keyboard volume buttons." )
+#define QT_DISABLE_VOLUME_KEYS_LONGTEXT N_(                                             \
+    "With this option checked, the volume up, volume down and mute buttons on your "    \
+    "keyboard will always change your system volume. With this option unchecked, the "  \
+    "volume buttons will change VLC's volume when VLC is selected and change the "      \
+    "system volume when VLC is not selected." )
+
+#define QT_PAUSE_MINIMIZED_TEXT N_( "Pause the video playback when minimized" )
+#define QT_PAUSE_MINIMIZED_LONGTEXT N_( \
+    "With this option enabled, the playback will be automatically paused when minimizing the window." )
+
+#define ICONCHANGE_TEXT N_( "Allow automatic icon changes")
+#define ICONCHANGE_LONGTEXT N_( \
+    "This option allows the interface to change its icon on various occasions.")
+
 /**********************************************************************/
 vlc_module_begin ()
     set_shortname( "Qt" )
@@ -174,10 +198,10 @@ vlc_module_begin ()
 
     add_shortcut("qt")
 
-    add_bool( "qt-minimal-view", false, NULL, QT_MINIMAL_MODE_TEXT,
+    add_bool( "qt-minimal-view", false, QT_MINIMAL_MODE_TEXT,
               QT_MINIMAL_MODE_TEXT, false );
 
-    add_bool( "qt-notification", true, NULL, NOTIFICATION_TEXT,
+    add_bool( "qt-notification", true, NOTIFICATION_TEXT,
               NOTIFICATION_LONGTEXT, false )
 
     add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
@@ -185,59 +209,77 @@ vlc_module_begin ()
     add_float_with_range( "qt-fs-opacity", 0.8, 0.1, 1., NULL, OPACITY_FS_TEXT,
                           OPACITY_FS_LONGTEXT, false )
 
-    add_bool( "qt-system-tray", true, NULL, SYSTRAY_TEXT,
+    add_bool( "qt-system-tray", true, SYSTRAY_TEXT,
               SYSTRAY_LONGTEXT, false)
-    add_bool( "qt-start-minimized", false, NULL, MINIMIZED_TEXT,
+    add_bool( "qt-start-minimized", false, MINIMIZED_TEXT,
               MINIMIZED_LONGTEXT, true)
-    add_bool( "qt-video-autoresize", true, NULL, KEEPSIZE_TEXT,
+    add_bool( "qt-video-autoresize", true, KEEPSIZE_TEXT,
               KEEPSIZE_LONGTEXT, false )
-    add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
+    add_bool( "qt-name-in-title", true, TITLE_TEXT,
               TITLE_LONGTEXT, false )
-    add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
+    add_bool( "qt-fs-controller", true, QT_FULLSCREEN_TEXT,
               QT_FULLSCREEN_TEXT, false )
 
-    add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
+    add_bool( "qt-volume-complete", false, COMPLETEVOL_TEXT,
               COMPLETEVOL_LONGTEXT, true )
-    add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
+    add_bool( "qt-autosave-volume", false, SAVEVOL_TEXT,
               SAVEVOL_TEXT, true )
+    add_integer_with_range( "qt-startvolume", QT_VOLUME_DEFAULT, 0,
+               QT_VOLUME_MAX, NULL, STARTVOL_TEXT, STARTVOL_TEXT, true )
 
-    add_bool( "qt-embedded-open", false, NULL, QT_NATIVEOPEN_TEXT,
+    add_bool( "qt-embedded-open", false, QT_NATIVEOPEN_TEXT,
                QT_NATIVEOPEN_TEXT, false )
-    add_bool( "qt-recentplay", true, NULL, RECENTPLAY_TEXT,
+    add_bool( "qt-recentplay", true, RECENTPLAY_TEXT,
               RECENTPLAY_TEXT, false )
-    add_string( "qt-recentplay-filter", "", NULL,
+    add_string( "qt-recentplay-filter", "",
                 RECENTPLAY_FILTER_TEXT, RECENTPLAY_FILTER_LONGTEXT, false )
 
-    add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
+    add_bool( "qt-adv-options", false, ADVANCED_OPTIONS_TEXT,
               ADVANCED_OPTIONS_LONGTEXT, true )
-    add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
+    add_bool( "qt-advanced-pref", false, ADVANCED_PREFS_TEXT,
               ADVANCED_PREFS_LONGTEXT, false )
-    add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
+    add_bool( "qt-error-dialogs", true, ERROR_TEXT,
               ERROR_TEXT, false )
 #ifdef UPDATE_CHECK
-    add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
+    add_bool( "qt-updates-notif", true, UPDATER_TEXT,
               UPDATER_LONGTEXT, false )
-    add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
+    add_integer( "qt-updates-days", 7, UPDATER_DAYS_TEXT,
                  UPDATER_DAYS_TEXT, false )
 #endif
-    add_string( "qt-slider-colours",
-                "255;255;255;20;210;20;255;199;15;245;39;29",
-                NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
+    add_string( "qt-slider-colours", "255;255;255;20;210;20;255;199;15;245;39;29",
+                SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false )
 
-    add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
+    add_bool( "qt-privacy-ask", true, PRIVACY_TEXT, PRIVACY_TEXT,
               false )
         change_private ()
 
-    add_integer( "qt-fullscreen-screennumber", -1, NULL, FULLSCREEN_NUMBER_TEXT,
+    add_integer( "qt-fullscreen-screennumber", -1, FULLSCREEN_NUMBER_TEXT,
                FULLSCREEN_NUMBER_LONGTEXT, false );
 
-    add_bool( "qt-autoload-extensions", true, NULL,
+    add_bool( "qt-autoload-extensions", true,
               QT_AUTOLOAD_EXTENSIONS_TEXT, QT_AUTOLOAD_EXTENSIONS_LONGTEXT,
               false )
 
+    add_bool( "qt-bgcone", true, QT_BGCONE_TEXT, QT_BGCONE_LONGTEXT, true )
+    add_bool( "qt-bgcone-expands", false, QT_BGCONE_EXPANDS_TEXT,
+              QT_BGCONE_EXPANDS_LONGTEXT, true )
+
+#ifdef WIN32
+    add_bool( "qt-disable-volume-keys"             /* name */,
+              false                                /* default value */,
+              QT_DISABLE_VOLUME_KEYS_TEXT          /* text */,
+              QT_DISABLE_VOLUME_KEYS_LONGTEXT      /* longtext */,
+              false                                /* advanced mode only */)
+#endif
+
+    add_bool( "qt-pause-minimized", true, QT_PAUSE_MINIMIZED_TEXT,
+              QT_PAUSE_MINIMIZED_LONGTEXT, false )
+
     add_obsolete_bool( "qt-blingbling" ) /* Suppressed since 1.0.0 */
     add_obsolete_integer( "qt-display-mode" ) /* Suppressed since 1.1.0 */
 
+    add_bool( "qt-icon-change", true, ICONCHANGE_TEXT, ICONCHANGE_LONGTEXT, true )
+
 #ifdef WIN32
     cannot_unload_broken_library()
 #endif
@@ -248,12 +290,14 @@ vlc_module_begin ()
 
         set_callbacks( OpenDialogs, Close )
 
-#if defined(Q_WS_X11) || defined(Q_WS_WIN)
+#if defined(Q_WS_X11) || defined(Q_WS_WIN) || defined(Q_WS_MAC)
     add_submodule ()
 #if defined(Q_WS_X11)
         set_capability( "vout window xid", 0 )
 #elif defined(Q_WS_WIN)
         set_capability( "vout window hwnd", 0 )
+#elif defined(Q_WS_MAC)
+        set_capability( "vout window nsobject", 0 )
 #endif
         set_callbacks( WindowOpen, WindowClose )
 #endif
@@ -267,16 +311,32 @@ static vlc_sem_t ready;
 #ifdef Q_WS_X11
 static char *x11_display = NULL;
 #endif
-static struct
-{
-    vlc_mutex_t lock;
-    bool busy;
-} one = { VLC_STATIC_MUTEX, false };
+static QMutex lock;
+static bool busy = false;
+static bool active = false;
 
 /*****************************************************************************
  * Module callbacks
  *****************************************************************************/
 
+#ifdef Q_WS_MAC
+/* Used to abort the app.exec() on OSX after libvlc_Quit is called */
+#include "../../../src/control/libvlc_internal.h" /* libvlc_SetExitHandler */
+static void Abort( void *obj )
+{
+    QVLCApp::triggerQuit();
+}
+#endif
+
+static void RegisterIntf( vlc_object_t *p_this )
+{
+    playlist_t *pl = pl_Get(p_this);
+    var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
+    var_SetAddress (pl, "qt4-iface", p_this);
+    var_Create (pl, "window", VLC_VAR_STRING);
+    var_SetString (pl, "window", "qt4,any");
+}
+
 /* Open Interface */
 static int Open( vlc_object_t *p_this, bool isDialogProvider )
 {
@@ -299,11 +359,7 @@ static int Open( vlc_object_t *p_this, bool isDialogProvider )
     char *display = NULL;
 #endif
 
-    bool busy;
-    vlc_mutex_lock (&one.lock);
-    busy = one.busy;
-    one.busy = true;
-    vlc_mutex_unlock (&one.lock);
+    QMutexLocker locker (&lock);
     if (busy)
     {
         msg_Err (p_this, "cannot start Qt4 multiple times");
@@ -315,35 +371,39 @@ static int Open( vlc_object_t *p_this, bool isDialogProvider )
     intf_sys_t *p_sys = p_intf->p_sys = new intf_sys_t;
     p_intf->p_sys->b_isDialogProvider = isDialogProvider;
     p_sys->p_mi = NULL;
-    p_sys->p_playlist = pl_Get( p_intf );
 
     /* */
 #ifdef Q_WS_X11
     x11_display = display;
 #endif
     vlc_sem_init (&ready, 0);
+#ifdef Q_WS_MAC
+    /* Run mainloop on the main thread as Cocoa requires */
+    libvlc_SetExitHandler( p_intf->p_libvlc, Abort, p_intf );
+    Thread( (void *)p_intf );
+#else
     if( vlc_clone( &p_sys->thread, Thread, p_intf, VLC_THREAD_PRIORITY_LOW ) )
     {
         delete p_sys;
         free (display);
-        vlc_mutex_lock (&one.lock);
-        one.busy = false;
-        vlc_mutex_unlock (&one.lock);
         return VLC_ENOMEM;
     }
+#endif
 
-    /* */
+    /* Wait for the interface to be ready. This prevents the main
+     * LibVLC thread from starting video playback before we can create
+     * an embedded video window. */
     vlc_sem_wait (&ready);
     vlc_sem_destroy (&ready);
+    busy = active = true;
 
-    if( !p_sys->b_isDialogProvider )
+#ifndef Q_WS_MAC
+    if( !isDialogProvider )
     {
-        playlist_t *pl = pl_Get(p_this);
-        var_Create (pl, "qt4-iface", VLC_VAR_ADDRESS);
-        var_SetAddress (pl, "qt4-iface", p_this);
-        var_Create (pl, "window", VLC_VAR_STRING);
-        var_SetString (pl, "window", "qt4,any");
+        RegisterIntf( p_this );
     }
+#endif
+
     return VLC_SUCCESS;
 }
 
@@ -370,17 +430,23 @@ static void Close( vlc_object_t *p_this )
         var_Destroy (pl_Get(p_this), "qt4-iface");
     }
 
+    /* And quit */
+    msg_Dbg( p_this, "requesting exit..." );
     QVLCApp::triggerQuit();
 
+    msg_Dbg( p_this, "waiting for UI thread..." );
+#ifndef Q_WS_MAC
     vlc_join (p_sys->thread, NULL);
+#endif
 #ifdef Q_WS_X11
     free (x11_display);
     x11_display = NULL;
 #endif
     delete p_sys;
-    vlc_mutex_lock (&one.lock);
-    one.busy = false;
-    vlc_mutex_unlock (&one.lock);
+
+    QMutexLocker locker (&lock);
+    assert (busy);
+    busy = false;
 }
 
 static void *Thread( void *obj )
@@ -417,16 +483,18 @@ static void *Thread( void *obj )
 #endif
             QSettings::UserScope, "vlc", "vlc-qt-interface" );
 
-    /* Icon setting */
-    if( QDate::currentDate().dayOfYear() >= 352 ) /* One Week before Xmas */
-        app.setWindowIcon( QIcon(vlc_christmas_xpm) );
+    /* Icon setting, Mac uses icon from .icns */
+#ifndef Q_WS_MAC
+    if( QDate::currentDate().dayOfYear() >= QT_XMAS_JOKE_DAY && var_InheritBool( p_intf, "qt-icon-change" ) )
+        app.setWindowIcon( QIcon(vlc_xmas_xpm) );
     else
         app.setWindowIcon( QIcon(vlc_xpm) );
+#endif
 
     /* Initialize timers and the Dialog Provider */
     DialogsProvider::getInstance( p_intf );
 
-    /* Detect screensize for small screens like TV or EEEpc*/
+    /* Detect screensize for small screens like TV or Netbooks */
     p_intf->p_sys->i_screenHeight =
         app.QApplication::desktop()->availableGeometry().height();
 
@@ -448,19 +516,33 @@ static void *Thread( void *obj )
 
     /* Create the normal interface in non-DP mode */
     if( !p_intf->p_sys->b_isDialogProvider )
+    {
         p_mi = new MainInterface( p_intf );
+        p_intf->p_sys->p_mi = p_mi;
+    }
     else
         p_mi = NULL;
-    p_intf->p_sys->p_mi = p_mi;
 
     /* Explain how to show a dialog :D */
     p_intf->pf_show_dialog = ShowDialog;
 
-    /* */
+    /* Tell the main LibVLC thread we are ready */
     vlc_sem_post (&ready);
 
+#ifdef Q_WS_MAC
+    /* We took over main thread, register and start here */
+    if( !p_intf->p_sys->b_isDialogProvider )
+    {
+        RegisterIntf( (vlc_object_t *)p_intf );
+        playlist_Play( THEPL );
+    }
+#endif
+
     /* Last settings */
-    app.setQuitOnLastWindowClosed( false );
+    if( p_intf->p_sys->b_isDialogProvider )
+        app.setQuitOnLastWindowClosed( false );
+    else
+        app.setQuitOnLastWindowClosed( true );
 
     /* Retrieve last known path used in file browsing */
     p_intf->p_sys->filepath =
@@ -474,14 +556,11 @@ static void *Thread( void *obj )
     /* Launch */
     app.exec();
 
-    /* And quit */
-    QApplication::closeAllWindows();
-
+    msg_Dbg( p_intf, "QApp exec() finished" );
     if (p_mi != NULL)
     {
-#warning BUG!
-        /* FIXME: the video window may still be registerd at this point */
-        /* See LP#448082 as an example. */
+        QMutexLocker locker (&lock);
+        active = false;
 
         p_intf->p_sys->p_mi = NULL;
         /* Destroy first the main interface because it is connected to some
@@ -556,6 +635,10 @@ static int WindowOpen( vlc_object_t *p_obj )
         return VLC_EGENERIC;
     }
 
+    QMutexLocker locker (&lock);
+    if (unlikely(!active))
+        return VLC_EGENERIC;
+
     MainInterface *p_mi = p_intf->p_sys->p_mi;
     msg_Dbg( p_obj, "requesting video..." );
 
@@ -574,6 +657,11 @@ static int WindowOpen( vlc_object_t *p_obj )
     p_wnd->handle.hwnd = p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
     if( !p_wnd->handle.hwnd )
         return VLC_EGENERIC;
+
+#elif defined (Q_WS_MAC)
+    p_wnd->handle.nsobject = (void *)p_mi->getVideo( &i_x, &i_y, &i_width, &i_height );
+    if( !p_wnd->handle.nsobject )
+        return VLC_EGENERIC;
 #else
 # error FIXME
 #endif
@@ -586,6 +674,13 @@ static int WindowOpen( vlc_object_t *p_obj )
 static int WindowControl( vout_window_t *p_wnd, int i_query, va_list args )
 {
     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
+    QMutexLocker locker (&lock);
+
+    if (unlikely(!active))
+    {
+        msg_Warn (p_wnd, "video already released before control");
+        return VLC_EGENERIC;
+    }
     return p_mi->controlVideo( i_query, args );
 }
 
@@ -593,8 +688,22 @@ static void WindowClose( vlc_object_t *p_obj )
 {
     vout_window_t *p_wnd = (vout_window_t*)p_obj;
     MainInterface *p_mi = (MainInterface *)p_wnd->sys;
-
-    msg_Dbg( p_obj, "releasing video..." );
+    QMutexLocker locker (&lock);
+
+    /* Normally, the interface terminates after the video. In the contrary, the
+     * Qt4 main loop is gone, so we cannot send any event to the user interface
+     * widgets. Ideally, we would keep the Qt4 main loop running until after
+     * the video window is released. But it is far simpler to just have the Qt4
+     * thread destroy the window early, and to turn this function into a stub.
+     *
+     * That assumes the video output will behave sanely if it window is
+     * destroyed asynchronously.
+     * XCB and Xlib-XCB are fine with that. Plain Xlib wouldn't, */
+    if (unlikely(!active))
+    {
+        msg_Warn (p_obj, "video already released");
+        return;
+    }
+    msg_Dbg (p_obj, "releasing video...");
     p_mi->releaseVideo();
 }
-