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