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