git.sesse.net Git - vlc/blob - modules/gui/qt4/qt4.cpp

   1 /*****************************************************************************
   2  * qt4.cpp : QT4 interface
   3  ****************************************************************************
   4  * Copyright © 2006-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Baptiste Kempf <jb@videolan.org>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <QApplication>
  29 #include <QLocale>
  30 #include <QTranslator>
  31 #include <QDate>
  32 #include <QMutex>
  33 #include <QMutexLocker>
  34 #include <QWaitCondition>
  35 #include <QPointer>
  36
  37 #include "qt4.hpp"
  38 #include "dialogs_provider.hpp"
  39 #include "input_manager.hpp"
  40 #include "main_interface.hpp"
  41 #include "dialogs/help.hpp" /* update */
  42
  43 #ifdef HAVE_X11_XLIB_H
  44 #include <X11/Xlib.h>
  45 #endif
  46
  47 #include "../../../share/vlc32x32.xpm"
  48 #include "../../../share/vlc32x32-christmas.xpm"
  49 #include <vlc_plugin.h>
  50
  51 /*****************************************************************************
  52  * Local prototypes.
  53  *****************************************************************************/
  54 static int  Open         ( vlc_object_t * );
  55 static void Close        ( vlc_object_t * );
  56 static int  OpenDialogs  ( vlc_object_t * );
  57 static int  WindowOpen   ( vlc_object_t * );
  58 static void WindowClose  ( vlc_object_t * );
  59 static void Run          ( intf_thread_t * );
  60 static void *Init        ( vlc_object_t * );
  61 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
  62
  63 /*****************************************************************************
  64  * Module descriptor
  65  *****************************************************************************/
  66 #define ADVANCED_PREFS_TEXT N_( "Show advanced preferences over simple ones" )
  67 #define ADVANCED_PREFS_LONGTEXT N_( "Show advanced preferences and not simple "\
  68                                     "preferences when opening the preferences "\
  69                                     "dialog." )
  70
  71 #define SYSTRAY_TEXT N_( "Systray icon" )
  72 #define SYSTRAY_LONGTEXT N_( "Show an icon in the systray " \
  73                              "allowing you to control VLC media player " \
  74                              "for basic actions." )
  75
  76 #define MINIMIZED_TEXT N_( "Start VLC with only a systray icon" )
  77 #define MINIMIZED_LONGTEXT N_( "VLC will start with just an icon in " \
  78                                "your taskbar" )
  79
  80 #define TITLE_TEXT N_( "Show playing item name in window title" )
  81 #define TITLE_LONGTEXT N_( "Show the name of the song or video in the " \
  82                            "controler window title." )
  83
  84 #define FILEDIALOG_PATH_TEXT N_( "Path to use in openfile dialog" )
  85
  86 #define NOTIFICATION_TEXT N_( "Show notification popup on track change" )
  87 #define NOTIFICATION_LONGTEXT N_( \
  88     "Show a notification popup with the artist and track name when " \
  89     "the current playlist item changes, when VLC is minimized or hidden." )
  90
  91 #define ADVANCED_OPTIONS_TEXT N_( "Advanced options" )
  92 #define ADVANCED_OPTIONS_LONGTEXT N_( "Show all the advanced options " \
  93                                       "in the dialogs." )
  94
  95 #define OPACITY_TEXT N_( "Windows opacity between 0.1 and 1." )
  96 #define OPACITY_LONGTEXT N_( "Sets the windows opacity between 0.1 and 1 " \
  97                              "for main interface, playlist and extended panel."\
  98                              " This option only works with Windows and " \
  99                              "X11 with composite extensions." )
 100
 101 #define ERROR_TEXT N_( "Show unimportant error and warnings dialogs" )
 102
 103 #define UPDATER_TEXT N_( "Activate the updates availability notification" )
 104 #define UPDATER_LONGTEXT N_( "Activate the automatic notification of new " \
 105                             "versions of the software. It runs once every " \
 106                             "two weeks." )
 107 #define UPDATER_DAYS_TEXT N_("Number of days between two update checks")
 108
 109 #define COMPLETEVOL_TEXT N_( "Allow the volume to be set to 400%" )
 110 #define COMPLETEVOL_LONGTEXT N_( "Allow the volume to have range from 0% to " \
 111                                  "400%, instead of 0% to 200%. This option " \
 112                                  "can distort the audio, since it uses " \
 113                                  "software amplification." )
 114
 115 #define SAVEVOL_TEXT N_( "Automatically save the volume on exit" )
 116
 117 #define BLING_TEXT N_( "Use non native buttons and volume slider" )
 118
 119 #define PRIVACY_TEXT N_( "Ask for network policy at start" )
 120
 121 #define SLIDERCOL_TEXT N_( "Define the colors of the volume slider " )
 122 #define SLIDERCOL_LONGTEXT N_( "Define the colors of the volume slider\n" \
 123                        "By specifying the 12 numbers separated by a ';'\n" \
 124             "Default is '255;255;255;20;226;20;255;176;15;235;30;20'\n" \
 125             "An alternative can be '30;30;50;40;40;100;50;50;160;150;150;255' ")
 126
 127 #define QT_MODE_TEXT N_( "Selection of the starting mode and look " )
 128 #define QT_MODE_LONGTEXT N_( "Start VLC with:\n" \
 129                              " - normal mode\n"  \
 130                              " - a zone always present to show information " \
 131                                   "as lyrics, album arts...\n" \
 132                              " - minimal mode with limited controls" )
 133
 134 #define QT_NORMAL_MODE_TEXT N_( "Classic look" )
 135 #define QT_ALWAYS_VIDEO_MODE_TEXT N_( "Complete look with information area" )
 136 #define QT_MINIMAL_MODE_TEXT N_( "Minimal look with no menus" )
 137
 138 #define QT_FULLSCREEN_TEXT N_( "Show a controller in fullscreen mode" )
 139
 140 static const int i_mode_list[] =
 141     { QT_NORMAL_MODE, QT_ALWAYS_VIDEO_MODE, QT_MINIMAL_MODE };
 142 static const char *const psz_mode_list_text[] =
 143     { QT_NORMAL_MODE_TEXT, QT_ALWAYS_VIDEO_MODE_TEXT, QT_MINIMAL_MODE_TEXT };
 144
 145 vlc_module_begin();
 146     set_shortname( "Qt" );
 147     set_description( N_("Qt interface") );
 148     set_category( CAT_INTERFACE ) ;
 149     set_subcategory( SUBCAT_INTERFACE_MAIN );
 150     set_capability( "interface", 151 );
 151     set_callbacks( Open, Close );
 152
 153     add_shortcut("qt");
 154
 155     add_submodule();
 156         set_description( "Dialogs provider" );
 157         set_capability( "dialogs provider", 51 );
 158
 159         add_integer( "qt-display-mode", QT_NORMAL_MODE, NULL,
 160                      QT_MODE_TEXT, QT_MODE_LONGTEXT, false );
 161             change_integer_list( i_mode_list, psz_mode_list_text, 0 );
 162
 163         add_bool( "qt-notification", true, NULL, NOTIFICATION_TEXT,
 164                   NOTIFICATION_LONGTEXT, false );
 165
 166         add_float_with_range( "qt-opacity", 1., 0.1, 1., NULL, OPACITY_TEXT,
 167                   OPACITY_LONGTEXT, false );
 168         add_bool( "qt-blingbling", true, NULL, BLING_TEXT,
 169                   BLING_TEXT, false );
 170
 171         add_bool( "qt-system-tray", true, NULL, SYSTRAY_TEXT,
 172                 SYSTRAY_LONGTEXT, false);
 173         add_bool( "qt-start-minimized", false, NULL, MINIMIZED_TEXT,
 174                 MINIMIZED_LONGTEXT, true);
 175         add_bool( "qt-name-in-title", true, NULL, TITLE_TEXT,
 176                   TITLE_LONGTEXT, false );
 177         add_bool( "qt-fs-controller", true, NULL, QT_FULLSCREEN_TEXT,
 178                   QT_FULLSCREEN_TEXT, false );
 179
 180         add_bool( "qt-volume-complete", false, NULL, COMPLETEVOL_TEXT,
 181                 COMPLETEVOL_LONGTEXT, true );
 182         add_bool( "qt-autosave-volume", false, NULL, SAVEVOL_TEXT,
 183                 SAVEVOL_TEXT, true );
 184         add_string( "qt-filedialog-path", NULL, NULL, FILEDIALOG_PATH_TEXT,
 185                 FILEDIALOG_PATH_TEXT, true );
 186             change_autosave();
 187             change_internal();
 188
 189         add_bool( "qt-adv-options", false, NULL, ADVANCED_OPTIONS_TEXT,
 190                   ADVANCED_OPTIONS_LONGTEXT, true );
 191         add_bool( "qt-advanced-pref", false, NULL, ADVANCED_PREFS_TEXT,
 192                 ADVANCED_PREFS_LONGTEXT, false );
 193         add_bool( "qt-error-dialogs", true, NULL, ERROR_TEXT,
 194                 ERROR_TEXT, false );
 195 #ifdef UPDATE_CHECK
 196         add_bool( "qt-updates-notif", true, NULL, UPDATER_TEXT,
 197                 UPDATER_LONGTEXT, false );
 198         add_integer( "qt-updates-days", 7, NULL, UPDATER_DAYS_TEXT,
 199                 UPDATER_DAYS_TEXT, false );
 200 #endif
 201         add_string( "qt-slider-colours",
 202                 "255;255;255;20;226;20;255;176;15;235;30;20",
 203                 NULL, SLIDERCOL_TEXT, SLIDERCOL_LONGTEXT, false );
 204
 205         add_bool( "qt-privacy-ask", true, NULL, PRIVACY_TEXT, PRIVACY_TEXT,
 206                 false );
 207             change_internal();
 208
 209         set_callbacks( OpenDialogs, Close );
 210
 211     add_submodule();
 212         set_capability( "vout window", 50 );
 213         set_callbacks( WindowOpen, WindowClose );
 214 vlc_module_end();
 215
 216 /*****************************************************************************
 217  * Module callbacks
 218  *****************************************************************************/
 219 static int Open( vlc_object_t *p_this )
 220 {
 221     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 222
 223 #if defined Q_WS_X11 && defined HAVE_X11_XLIB_H
 224     /* Thanks for libqt4 calling exit() in QApplication::QApplication()
 225      * instead of returning an error, we have to check the X11 display */
 226     Display *p_display = XOpenDisplay( NULL );
 227     if( !p_display )
 228     {
 229         msg_Err( p_intf, "Could not connect to X server" );
 230         return VLC_EGENERIC;
 231     }
 232     XCloseDisplay( p_display );
 233 #endif
 234
 235     /* Allocations */
 236     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
 237     if( !p_intf->p_sys )
 238         return VLC_ENOMEM;
 239     memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
 240
 241     p_intf->pf_run = Run;
 242     p_intf->p_sys->p_mi = NULL;
 243
 244     /* Access to the playlist */
 245     p_intf->p_sys->p_playlist = pl_Yield( p_intf );
 246     /* Listen to the messages */
 247     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
 248     /* one settings to rule them all */
 249
 250     var_Create( p_this, "window_widget", VLC_VAR_ADDRESS );
 251     return VLC_SUCCESS;
 252 }
 253
 254 static int OpenDialogs( vlc_object_t *p_this )
 255 {
 256     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 257     int val = Open( p_this );
 258     if( val )
 259         return val;
 260
 261     p_intf->pf_show_dialog = ShowDialog;
 262     return VLC_SUCCESS;
 263 }
 264
 265 static void Close( vlc_object_t *p_this )
 266 {
 267     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 268
 269     vlc_object_lock( p_intf );
 270     p_intf->b_dead = true;
 271     vlc_object_unlock( p_intf );
 272
 273     if( p_intf->p_sys->b_isDialogProvider )
 274     {
 275         if( DialogsProvider::isAlive() )
 276         {
 277             msg_Dbg( p_intf, "Asking the DP to quit nicely" );
 278             DialogEvent *event = new DialogEvent( INTF_DIALOG_EXIT, 0, NULL );
 279             QApplication::postEvent( THEDP, static_cast<QEvent*>(event) );
 280         }
 281         vlc_thread_join( p_intf );
 282     }
 283
 284     vlc_object_release( p_intf->p_sys->p_playlist );
 285     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 286     free( p_intf->p_sys );
 287 }
 288
 289
 290 /*****************************************************************************
 291  * Initialize the interface or the dialogs provider
 292  *****************************************************************************/
 293 static void Run( intf_thread_t *p_intf )
 294 {
 295     if( p_intf->pf_show_dialog )
 296     {
 297         if( vlc_thread_create( p_intf, "Qt dialogs", Init, 0, true ) )
 298             msg_Err( p_intf, "failed to create Qt dialogs thread" );
 299     }
 300     else
 301         Init( VLC_OBJECT(p_intf) );
 302 }
 303
 304 static QMutex windowLock;
 305 static QWaitCondition windowWait;
 306
 307 static void *Init( vlc_object_t *obj )
 308 {
 309     intf_thread_t *p_intf = (intf_thread_t *)obj;
 310     vlc_value_t val;
 311     char dummy[] = "";
 312     char *argv[] = { dummy };
 313     int argc = 1;
 314
 315     Q_INIT_RESOURCE( vlc );
 316
 317 #if !defined(WIN32) && !defined(__APPLE__)
 318     /* KLUDGE:
 319      * disables icon theme use because that makes Cleanlooks style bug
 320      * because it asks gconf for some settings that timeout because of threads
 321      * see commits 21610 21622 21654 for reference */
 322
 323     /* If you don't have a gconftool-2 binary, you should comment this line */
 324     if( strcmp( qVersion(), "4.4.0" ) < 0 ) /* fixed in Qt 4.4.0 */
 325         QApplication::setDesktopSettingsAware( false );
 326 #endif
 327
 328     /* Start the QApplication here */
 329     QApplication *app = new QApplication( argc, argv , true );
 330     p_intf->p_sys->p_app = app;
 331
 332     p_intf->p_sys->mainSettings = new QSettings(
 333 #ifdef WIN32
 334             QSettings::IniFormat,
 335 #else
 336             QSettings::NativeFormat,
 337 #endif
 338             QSettings::UserScope, "vlc", "vlc-qt-interface" );
 339
 340     /* Icon setting
 341        FIXME: use a bigger icon ? */
 342     if( QDate::currentDate().dayOfYear() >= 354 )
 343         app->setWindowIcon( QIcon( QPixmap(vlc_christmas_xpm) ) );
 344     else
 345         app->setWindowIcon( QIcon( QPixmap(vlc_xpm) ) );
 346
 347     /* Initialize timers and the Dialog Provider */
 348     DialogsProvider::getInstance( p_intf );
 349
 350     QPointer<MainInterface> *miP = NULL;
 351
 352 #ifdef UPDATE_CHECK
 353     /* Checking for VLC updates */
 354     if( config_GetInt( p_intf, "qt-updates-notif" ) &&
 355         !config_GetInt( p_intf, "qt-privacy-ask" ) )
 356     {
 357         int interval = config_GetInt( p_intf, "qt-updates-days" );
 358         if( QDate::currentDate() >
 359              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
 360         {
 361             /* The constructor of the update Dialog will do the 1st request */
 362             UpdateDialog::getInstance( p_intf );
 363             getSettings()->setValue( "updatedate", QDate::currentDate() );
 364         }
 365     }
 366 #endif
 367
 368     /* Create the normal interface in non-DP mode */
 369     if( !p_intf->pf_show_dialog )
 370     {
 371         p_intf->p_sys->p_mi = new MainInterface( p_intf );
 372         /* We don't show it because it is done in the MainInterface constructor
 373         p_mi->show(); */
 374         p_intf->p_sys->b_isDialogProvider = false;
 375
 376         miP = new QPointer<MainInterface> (p_intf->p_sys->p_mi);
 377         val.p_address = miP;
 378         QMutexLocker locker (&windowLock);
 379         var_Set (p_intf, "window_widget", val);
 380         windowWait.wakeAll ();
 381     }
 382     else
 383     {
 384         vlc_thread_ready( p_intf );
 385         p_intf->p_sys->b_isDialogProvider = true;
 386     }
 387
 388     /* Explain to the core how to show a dialog :D */
 389     p_intf->pf_show_dialog = ShowDialog;
 390
 391 #ifdef ENABLE_NLS
 392     // Translation - get locale
 393 #   if defined (WIN32) || defined (__APPLE__)
 394     char* psz_tmp = config_GetPsz( p_intf, "language" );
 395     QString lang = qfu( psz_tmp );
 396     free( psz_tmp);
 397     if (lang == "auto")
 398         lang = QLocale::system().name();
 399 #   else
 400     QString lang = QLocale::system().name();
 401 #   endif
 402     // Translations for qt's own dialogs
 403     QTranslator qtTranslator( 0 );
 404     // Let's find the right path for the translation file
 405 #if !defined( WIN32 )
 406     QString path =  QString( QT4LOCALEDIR );
 407 #else
 408     QString path = QString( QString(config_GetDataDir()) + DIR_SEP +
 409                             "locale" + DIR_SEP + "qt4" + DIR_SEP );
 410 #endif
 411     // files depending on locale
 412     bool b_loaded = qtTranslator.load( path + "qt_" + lang );
 413     if (!b_loaded)
 414         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
 415     app->installTranslator( &qtTranslator );
 416 #endif  //ENABLE_NLS
 417
 418     /* Last settings */
 419     app->setQuitOnLastWindowClosed( false );
 420
 421     /* Retrieve last known path used in file browsing */
 422     char *psz_path = config_GetPsz( p_intf, "qt-filedialog-path" );
 423     p_intf->p_sys->psz_filepath = EMPTY_STR( psz_path ) ? psz_path
 424                                                         : config_GetHomeDir();
 425
 426     /* Launch */
 427     app->exec();
 428
 429     /* And quit */
 430     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
 431
 432     if (miP)
 433     {
 434         QMutexLocker locker (&windowLock);
 435
 436         /* We need to warn to detach from any vout before
 437          * deleting miP (WindowClose will not be called after it) */
 438         p_intf->p_sys->p_mi->releaseVideo( NULL );
 439
 440         val.p_address = NULL;
 441         var_Set (p_intf, "window_widget", val);
 442         delete miP;
 443     }
 444
 445     /* Destroy first the main interface because it is connected to some slots
 446        in the MainInputManager */
 447     delete p_intf->p_sys->p_mi;
 448
 449     /* Destroy all remaining windows,
 450        because some are connected to some slots
 451        in the MainInputManager
 452        Settings must be destroyed after that.
 453      */
 454     DialogsProvider::killInstance();
 455
 456     /* Delete the configuration. Application has to be deleted after that. */
 457     delete p_intf->p_sys->mainSettings;
 458
 459     /* Destroy the MainInputManager */
 460     MainInputManager::killInstance();
 461
 462     /* Delete the application */
 463     delete app;
 464
 465     /* Save the path */
 466     config_PutPsz( p_intf, "qt-filedialog-path", p_intf->p_sys->psz_filepath );
 467     free( psz_path );
 468 }
 469
 470 /*****************************************************************************
 471  * Callback to show a dialog
 472  *****************************************************************************/
 473 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
 474                         intf_dialog_args_t *p_arg )
 475 {
 476     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
 477     QApplication::postEvent( THEDP, static_cast<QEvent*>(event) );
 478 }
 479
 480 /*****************************************************************************
 481  * PopupMenuCB: callback to show the popupmenu.
 482  *  We don't show the menu directly here because we don't want the
 483  *  caller to block for a too long time.
 484  *****************************************************************************/
 485 static int PopupMenuCB( vlc_object_t *p_this, const char *psz_variable,
 486                         vlc_value_t old_val, vlc_value_t new_val, void *param )
 487 {
 488     intf_thread_t *p_intf = (intf_thread_t *)param;
 489     ShowDialog( p_intf, INTF_DIALOG_POPUPMENU, new_val.b_bool, 0 );
 490     return VLC_SUCCESS;
 491 }
 492
 493 /**
 494  * Video output window provider
 495  */
 496 #include <vlc_window.h>
 497
 498 static int WindowControl (vout_window_t *, int, va_list);
 499
 500 static int WindowOpen (vlc_object_t *obj)
 501 {
 502     vout_window_t *wnd = (vout_window_t *)obj;
 503
 504     if (config_GetInt (obj, "embedded-video") <= 0)
 505         return VLC_EGENERIC;
 506
 507     intf_thread_t *intf = (intf_thread_t *)
 508         vlc_object_find_name (obj, "qt4", FIND_ANYWHERE);
 509     if (intf == NULL)
 510         return VLC_EGENERIC; /* Qt4 not in use */
 511     assert (intf->i_object_type == VLC_OBJECT_INTF);
 512
 513     var_Create (intf, "window_widget", VLC_VAR_ADDRESS);
 514
 515     vlc_value_t ptrval;
 516
 517     windowLock.lock ();
 518     msg_Dbg (obj, "waiting for interface...");
 519     for (;;)
 520     {
 521         var_Get (intf, "window_widget", &ptrval);
 522         if (ptrval.p_address != NULL)
 523             break;
 524         windowWait.wait (&windowLock);
 525     }
 526
 527     msg_Dbg (obj, "requesting window...");
 528     QPointer<MainInterface> *miP = (QPointer<MainInterface> *)ptrval.p_address;
 529     miP = new QPointer<MainInterface> (*miP); /* create our own copy */
 530     vlc_object_release (intf);
 531
 532     if (miP->isNull ())
 533         return VLC_EGENERIC;
 534
 535     wnd->handle = (*miP)->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
 536                                         &wnd->width, &wnd->height);
 537     windowLock.unlock ();
 538
 539     if (!wnd->handle)
 540         return VLC_EGENERIC;
 541
 542     wnd->control = WindowControl;
 543     wnd->p_private = miP;
 544     return VLC_SUCCESS;
 545 }
 546
 547 static int WindowControl (vout_window_t *wnd, int query, va_list args)
 548 {
 549     QPointer<MainInterface> *miP = (QPointer<MainInterface> *)wnd->p_private;
 550     QMutexLocker locker (&windowLock);
 551
 552     if (miP->isNull ())
 553         return VLC_EGENERIC;
 554     return (*miP)->controlVideo (wnd->handle, query, args);
 555 }
 556
 557 static void WindowClose (vlc_object_t *obj)
 558 {
 559     vout_window_t *wnd = (vout_window_t *)obj;
 560     QPointer<MainInterface> *miP = (QPointer<MainInterface> *)wnd->p_private;
 561     QMutexLocker locker (&windowLock);
 562
 563     if (!miP->isNull ())
 564         (*miP)->releaseVideo( wnd->handle );
 565     delete miP;
 566 }