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