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