1a2b22eada4b4cc46487fd01463ed451f831b6b1
[vlc.git] / 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 *Init        ( vlc_object_t * );
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 /*****************************************************************************
236  * Module callbacks
237  *****************************************************************************/
238 static int Open( vlc_object_t *p_this )
239 {
240     intf_thread_t *p_intf = (intf_thread_t *)p_this;
241
242 #if defined Q_WS_X11 && defined HAVE_X11_XLIB_H
243     /* Thanks for libqt4 calling exit() in QApplication::QApplication()
244      * instead of returning an error, we have to check the X11 display */
245     Display *p_display = XOpenDisplay( NULL );
246     if( !p_display )
247     {
248         msg_Err( p_intf, "Could not connect to X server" );
249         return VLC_EGENERIC;
250     }
251     XCloseDisplay( p_display );
252 #endif
253
254     /* Allocations */
255     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
256     if( !p_intf->p_sys )
257         return VLC_ENOMEM;
258     memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
259
260     p_intf->pf_run = Run;
261     p_intf->p_sys->p_mi = NULL;
262
263     /* Access to the playlist */
264     p_intf->p_sys->p_playlist = pl_Hold( p_intf );
265     /* one settings to rule them all */
266
267     var_Create( p_this, "window_widget", VLC_VAR_ADDRESS );
268     return VLC_SUCCESS;
269 }
270
271 static int OpenDialogs( vlc_object_t *p_this )
272 {
273     intf_thread_t *p_intf = (intf_thread_t *)p_this;
274     int val = Open( p_this );
275     if( val )
276         return val;
277
278     p_intf->pf_show_dialog = ShowDialog;
279     return VLC_SUCCESS;
280 }
281
282 static void Close( vlc_object_t *p_this )
283 {
284     intf_thread_t *p_intf = (intf_thread_t *)p_this;
285
286     if( p_intf->p_sys->b_isDialogProvider )
287     {
288         if( DialogsProvider::isAlive() )
289         {
290             msg_Dbg( p_intf, "Asking the DP to quit nicely" );
291             DialogEvent *event = new DialogEvent( INTF_DIALOG_EXIT, 0, NULL );
292             QApplication::postEvent( THEDP, static_cast<QEvent*>(event) );
293         }
294         vlc_thread_join( p_intf );
295     }
296
297     vlc_object_release( p_intf->p_sys->p_playlist );
298     free( p_intf->p_sys );
299 }
300
301
302 /*****************************************************************************
303  * Initialize the interface or the dialogs provider
304  *****************************************************************************/
305 static void Run( intf_thread_t *p_intf )
306 {
307     if( p_intf->pf_show_dialog )
308     {
309         if( vlc_thread_create( p_intf, "Qt dialogs", Init, 0, true ) )
310             msg_Err( p_intf, "failed to create Qt dialogs thread" );
311     }
312     else
313     {
314         Init( VLC_OBJECT(p_intf) );
315     }
316 }
317
318 static QMutex windowLock;
319 static QWaitCondition windowWait;
320
321 static void ThreadCleanup( void *param)
322 {
323     intf_thread_t *p_intf = (intf_thread_t *)param;
324     QCloseEvent *event = new QCloseEvent();
325     QApplication::postEvent( p_intf->p_sys->p_mi, event );
326 }
327
328 static void *Init( vlc_object_t *obj )
329 {
330     intf_thread_t *p_intf = (intf_thread_t *)obj;
331     vlc_value_t val;
332     char dummy[] = "";
333     char *argv[] = { dummy };
334     int argc = 1;
335     int canc = vlc_savecancel ();
336
337     msg_Dbg( p_intf, "Setting ThreadCleanup");
338     vlc_cleanup_push( ThreadCleanup, (void*)p_intf );
339     Q_INIT_RESOURCE( vlc );
340
341 #if !defined(WIN32) && !defined(__APPLE__)
342     /* KLUDGE:
343      * disables icon theme use because that makes Cleanlooks style bug
344      * because it asks gconf for some settings that timeout because of threads
345      * see commits 21610 21622 21654 for reference */
346
347     /* If you don't have a gconftool-2 binary, you should comment this line */
348     if( strcmp( qVersion(), "4.4.0" ) < 0 ) /* fixed in Qt 4.4.0 */
349         QApplication::setDesktopSettingsAware( false );
350 #endif
351
352     /* Start the QApplication here */
353     QVLCApp *app = new QVLCApp( argc, argv , true );
354     p_intf->p_sys->p_app = app;
355
356     p_intf->p_sys->mainSettings = new QSettings(
357 #ifdef WIN32
358             QSettings::IniFormat,
359 #else
360             QSettings::NativeFormat,
361 #endif
362             QSettings::UserScope, "vlc", "vlc-qt-interface" );
363
364     /* Icon setting */
365     if( QDate::currentDate().dayOfYear() >= 354 )
366         app->setWindowIcon( QIcon( QPixmap(vlc_christmas_xpm) ) );
367     else
368         app->setWindowIcon( QIcon( QPixmap(vlc_xpm) ) );
369
370     /* Initialize timers and the Dialog Provider */
371     DialogsProvider::getInstance( p_intf );
372
373     QPointer<MainInterface> *miP = NULL;
374
375 #ifdef UPDATE_CHECK
376     /* Checking for VLC updates */
377     if( config_GetInt( p_intf, "qt-updates-notif" ) &&
378         !config_GetInt( p_intf, "qt-privacy-ask" ) )
379     {
380         int interval = config_GetInt( p_intf, "qt-updates-days" );
381         if( QDate::currentDate() >
382              getSettings()->value( "updatedate" ).toDate().addDays( interval ) )
383         {
384             /* The constructor of the update Dialog will do the 1st request */
385             UpdateDialog::getInstance( p_intf );
386             getSettings()->setValue( "updatedate", QDate::currentDate() );
387         }
388     }
389 #endif
390
391     /* Create the normal interface in non-DP mode */
392     if( !p_intf->pf_show_dialog )
393     {
394         p_intf->p_sys->p_mi = new MainInterface( p_intf );
395         /* We don't show it because it is done in the MainInterface constructor
396         p_mi->show(); */
397         p_intf->p_sys->b_isDialogProvider = false;
398
399         miP = new QPointer<MainInterface> (p_intf->p_sys->p_mi);
400         val.p_address = miP;
401         QMutexLocker locker (&windowLock);
402         var_Set (p_intf, "window_widget", val);
403         windowWait.wakeAll ();
404     }
405     else
406     {
407         vlc_thread_ready( p_intf );
408         p_intf->p_sys->b_isDialogProvider = true;
409     }
410
411     /* Explain to the core how to show a dialog :D */
412     p_intf->pf_show_dialog = ShowDialog;
413
414 #ifdef ENABLE_NLS
415     // Translation - get locale
416 #   if defined (WIN32) || defined (__APPLE__)
417     char* psz_tmp = config_GetPsz( p_intf, "language" );
418     QString lang = qfu( psz_tmp );
419     free( psz_tmp);
420     if (lang == "auto")
421         lang = QLocale::system().name();
422 #   else
423     QString lang = QLocale::system().name();
424 #   endif
425     // Translations for qt's own dialogs
426     QTranslator qtTranslator( 0 );
427     // Let's find the right path for the translation file
428 #if !defined( WIN32 )
429     QString path =  QString( QT4LOCALEDIR );
430 #else
431     QString path = QString( QString(config_GetDataDir()) + DIR_SEP +
432                             "locale" + DIR_SEP + "qt4" + DIR_SEP );
433 #endif
434     // files depending on locale
435     bool b_loaded = qtTranslator.load( path + "qt_" + lang );
436     if (!b_loaded)
437         msg_Dbg( p_intf, "Error while initializing qt-specific localization" );
438     app->installTranslator( &qtTranslator );
439 #endif  //ENABLE_NLS
440
441     /* Last settings */
442     app->setQuitOnLastWindowClosed( false );
443
444     /* Retrieve last known path used in file browsing */
445     char *psz_path = config_GetPsz( p_intf, "qt-filedialog-path" );
446     p_intf->p_sys->psz_filepath = EMPTY_STR( psz_path ) ? config_GetHomeDir()
447                                                         : psz_path;
448
449     vlc_restorecancel (canc);
450     /* Launch */
451     app->exec();
452
453     /* And quit */
454     canc = vlc_savecancel ();
455     msg_Dbg( p_intf, "Quitting the Qt4 Interface" );
456
457     if (miP)
458     {
459         QMutexLocker locker (&windowLock);
460
461         /* We need to warn to detach from any vout before
462          * deleting miP (WindowClose will not be called after it) */
463         p_intf->p_sys->p_mi->releaseVideo( NULL );
464
465         val.p_address = NULL;
466         var_Set (p_intf, "window_widget", val);
467         delete miP;
468     }
469
470     /* Destroy first the main interface because it is connected to some slots
471        in the MainInputManager */
472     delete p_intf->p_sys->p_mi;
473
474     /* Destroy all remaining windows,
475        because some are connected to some slots
476        in the MainInputManager
477        Settings must be destroyed after that.
478      */
479     DialogsProvider::killInstance();
480
481     /* Delete the recentsMRL object before the configuration */
482     RecentsMRL::killInstance();
483
484     /* Delete the configuration. Application has to be deleted after that. */
485     delete p_intf->p_sys->mainSettings;
486
487     /* Destroy the MainInputManager */
488     MainInputManager::killInstance();
489
490     /* Delete the application */
491     delete app;
492
493     /* Save the path */
494     config_PutPsz( p_intf, "qt-filedialog-path", p_intf->p_sys->psz_filepath );
495     free( psz_path );
496     vlc_restorecancel (canc);
497     vlc_cleanup_pop();
498     return NULL;
499 }
500
501 /*****************************************************************************
502  * Callback to show a dialog
503  *****************************************************************************/
504 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
505                         intf_dialog_args_t *p_arg )
506 {
507     DialogEvent *event = new DialogEvent( i_dialog_event, i_arg, p_arg );
508     QApplication::postEvent( THEDP, static_cast<QEvent*>(event) );
509 }
510
511 /*****************************************************************************
512  * PopupMenuCB: callback to show the popupmenu.
513  *  We don't show the menu directly here because we don't want the
514  *  caller to block for a too long time.
515  *****************************************************************************/
516 static int PopupMenuCB( vlc_object_t *p_this, const char *psz_variable,
517                         vlc_value_t old_val, vlc_value_t new_val, void *param )
518 {
519     intf_thread_t *p_intf = (intf_thread_t *)param;
520     ShowDialog( p_intf, INTF_DIALOG_POPUPMENU, new_val.b_bool, 0 );
521     return VLC_SUCCESS;
522 }
523
524 /**
525  * Video output window provider
526  */
527 #include <vlc_window.h>
528
529 static int WindowControl (vout_window_t *, int, va_list);
530
531 static int WindowOpen (vlc_object_t *obj)
532 {
533     vout_window_t *wnd = (vout_window_t *)obj;
534
535     if (config_GetInt (obj, "embedded-video") <= 0)
536         return VLC_EGENERIC;
537
538     intf_thread_t *intf = (intf_thread_t *)
539         vlc_object_find_name (obj, "qt4", FIND_ANYWHERE);
540     if (intf == NULL)
541         return VLC_EGENERIC; /* Qt4 not in use */
542     assert (intf->i_object_type == VLC_OBJECT_INTF);
543
544     var_Create (intf, "window_widget", VLC_VAR_ADDRESS);
545
546     vlc_value_t ptrval;
547
548     windowLock.lock ();
549     msg_Dbg (obj, "waiting for interface...");
550     for (;;)
551     {
552         var_Get (intf, "window_widget", &ptrval);
553         if (ptrval.p_address != NULL)
554             break;
555         windowWait.wait (&windowLock);
556     }
557
558     msg_Dbg (obj, "requesting window...");
559     QPointer<MainInterface> *miP = (QPointer<MainInterface> *)ptrval.p_address;
560     miP = new QPointer<MainInterface> (*miP); /* create our own copy */
561     vlc_object_release (intf);
562
563     if (miP->isNull ())
564         return VLC_EGENERIC;
565
566     wnd->handle = (*miP)->requestVideo (wnd->vout, &wnd->pos_x, &wnd->pos_y,
567                                         &wnd->width, &wnd->height);
568     windowLock.unlock ();
569
570     if (!wnd->handle)
571         return VLC_EGENERIC;
572
573     wnd->control = WindowControl;
574     wnd->p_private = miP;
575     return VLC_SUCCESS;
576 }
577
578 static int WindowControl (vout_window_t *wnd, int query, va_list args)
579 {
580     QPointer<MainInterface> *miP = (QPointer<MainInterface> *)wnd->p_private;
581     QMutexLocker locker (&windowLock);
582
583     if (miP->isNull ())
584         return VLC_EGENERIC;
585     return (*miP)->controlVideo (wnd->handle, query, args);
586 }
587
588 static void WindowClose (vlc_object_t *obj)
589 {
590     vout_window_t *wnd = (vout_window_t *)obj;
591     QPointer<MainInterface> *miP = (QPointer<MainInterface> *)wnd->p_private;
592     QMutexLocker locker (&windowLock);
593
594     if (!miP->isNull ())
595         (*miP)->releaseVideo( wnd->handle );
596     delete miP;
597 }