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