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