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