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