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

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