Remove unneeded psz_program hack.
[vlc.git] / modules / gui / wxwidgets / wxwidgets.cpp
1 /*****************************************************************************
2  * wxwidgets.cpp : wxWidgets plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <errno.h>                                                 /* ENOMEM */
28
29 #include <vlc/vlc.h>
30 #include <vlc_interface.h>
31
32 #ifdef HAVE_LOCALE_H
33 #   include <locale.h>
34 #endif
35
36 #include "interface.hpp"
37
38 /* Temporary hack */
39 #if defined(WIN32) && defined(_WX_INIT_H_)
40 #if (wxMAJOR_VERSION <= 2) && (wxMINOR_VERSION <= 5) && (wxRELEASE_NUMBER < 3)
41 /* Hack to detect wxWidgets 2.5 which has a different wxEntry() prototype */
42 extern int wxEntry( HINSTANCE hInstance, HINSTANCE hPrevInstance = NULL,
43                     char *pCmdLine = NULL, int nCmdShow = SW_NORMAL );
44 #endif
45 #endif
46
47 /*****************************************************************************
48  * Local prototypes.
49  *****************************************************************************/
50 static int  Open         ( vlc_object_t * );
51 static void Close        ( vlc_object_t * );
52 static int  OpenDialogs  ( vlc_object_t * );
53
54 static void Run          ( intf_thread_t * );
55 static void Init         ( intf_thread_t * );
56
57 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
58
59 #if (wxCHECK_VERSION(2,5,0))
60 void *wxClassInfo_sm_classTable_BUGGY = 0;
61 #endif
62
63 /*****************************************************************************
64  * Local classes declarations.
65  *****************************************************************************/
66 class Instance: public wxApp
67 {
68 public:
69     Instance();
70     Instance( intf_thread_t *_p_intf );
71
72     bool OnInit();
73     int  OnExit();
74
75 private:
76     intf_thread_t *p_intf;
77     wxLocale locale;                                /* locale we'll be using */
78 };
79
80 /*****************************************************************************
81  * Module descriptor
82  *****************************************************************************/
83 #define EMBED_TEXT N_("Embed video in interface")
84 #define EMBED_LONGTEXT N_("Embed the video inside the interface instead " \
85     "of having it in a separate window.")
86 #define BOOKMARKS_TEXT N_("Bookmarks dialog")
87 #define BOOKMARKS_LONGTEXT N_("Show bookmarks dialog at startup" )
88 #define EXTENDED_TEXT N_("Extended GUI")
89 #define EXTENDED_LONGTEXT N_("Show extended GUI (equalizer, image adjust, "  \
90               "video filters...) at startup"  )
91 #define TASKBAR_TEXT N_("Taskbar")
92 #define TASKBAR_LONGTEXT N_("Show VLC on the taskbar")
93 #define MINIMAL_TEXT N_("Minimal interface")
94 #define MINIMAL_LONGTEXT N_("Use minimal interface, with no toolbar and " \
95                 "fewer menus.")
96 #define SIZE_TO_VIDEO_TEXT N_("Size to video")
97 #define SIZE_TO_VIDEO_LONGTEXT N_("Resize VLC to match the video resolution.")
98 #define SYSTRAY_TEXT N_("Systray icon")
99 #define SYSTRAY_LONGTEXT N_("Show a systray icon for VLC")
100 #define LABEL_TEXT N_("Show labels in toolbar")
101 #define LABEL_LONGTEXT N_("Show labels below the icons in the toolbar.")
102
103 #define PLAYLIST_TEXT N_("Playlist view" )
104 #define PLAYLIST_LONGTEXT N_("There are two possible playlist views in the " \
105                 "interface : the normal playlist (separate window), or an " \
106                 "embedded playlist (within the main interface, but with " \
107                 "less features). You can select which one will be available " \
108                 "on the toolbar (or both)." )
109
110 static int pi_playlist_views[] = { 0,1,2 };
111 static const char *psz_playlist_views[] = { N_("Normal" ), N_("Embedded" ) ,
112                                             N_("Both") };
113
114 vlc_module_begin();
115     int i_score = 150;
116     set_shortname( (char*) "wxWidgets" );
117     set_description( (char *) _("wxWidgets interface module") );
118     set_category( CAT_INTERFACE );
119     set_subcategory( SUBCAT_INTERFACE_MAIN );
120     set_capability( "interface", i_score );
121     set_callbacks( Open, Close );
122     add_shortcut( "wxwindows" );
123     add_shortcut( "wxwin" );
124     add_shortcut( "wx" );
125     add_shortcut( "wxwidgets" );
126
127     add_bool( "wx-embed", 1, NULL,
128               EMBED_TEXT, EMBED_LONGTEXT, VLC_FALSE );
129         add_deprecated_alias( "wxwin-enbed" ); /*Deprecated since 0.8.4*/
130     add_bool( "wx-bookmarks", 0, NULL,
131               BOOKMARKS_TEXT, BOOKMARKS_LONGTEXT, VLC_FALSE );
132         add_deprecated_alias( "wxwin-bookmarks" ); /*Deprecated since 0.8.4*/
133     add_bool( "wx-taskbar", 1, NULL,
134               TASKBAR_TEXT, TASKBAR_LONGTEXT, VLC_FALSE );
135         add_deprecated_alias( "wxwin-taskbar" ); /*Deprecated since 0.8.4*/
136     add_bool( "wx-extended", 0, NULL,
137               EXTENDED_TEXT, EXTENDED_LONGTEXT, VLC_FALSE );
138     add_bool( "wx-minimal", 0, NULL,
139               MINIMAL_TEXT, MINIMAL_LONGTEXT, VLC_TRUE );
140         add_deprecated_alias( "wxwin-minimal" ); /*Deprecated since 0.8.4*/
141     add_bool( "wx-autosize", 1, NULL,
142               SIZE_TO_VIDEO_TEXT, SIZE_TO_VIDEO_LONGTEXT, VLC_TRUE );
143         add_deprecated_alias( "wxwin-autosize" ); /*Deprecated since 0.8.4*/
144     add_integer( "wx-playlist-view", 0, NULL, PLAYLIST_TEXT, PLAYLIST_LONGTEXT,
145              VLC_FALSE );
146         change_integer_list( pi_playlist_views, psz_playlist_views, 0 );
147 /* wxCocoa pretends to support this, but at least 2.6.x doesn't */
148 #ifndef __APPLE__
149 #ifdef wxHAS_TASK_BAR_ICON
150     add_bool( "wx-systray", 0, NULL,
151               SYSTRAY_TEXT, SYSTRAY_LONGTEXT, VLC_FALSE );
152         add_deprecated_alias( "wxwin-systray" ); /*Deprecated since 0.8.4*/
153 #endif
154 #endif
155     add_bool( "wx-labels", 0, NULL, LABEL_TEXT, LABEL_LONGTEXT, VLC_TRUE);
156     add_string( "wx-config-last", NULL, NULL,
157                 N_("last config"), N_("last config"), VLC_TRUE );
158         change_autosave();
159         change_internal();
160         add_deprecated_alias( "wxwin-config-last" ); /*Deprecated since 0.8.4*/
161
162     add_submodule();
163     set_description( _("wxWidgets dialogs provider") );
164     set_capability( "dialogs provider", 50 );
165     set_callbacks( OpenDialogs, Close );
166
167 #if !defined(WIN32)
168     linked_with_a_crap_library_which_uses_atexit();
169 #endif
170 vlc_module_end();
171
172 /*****************************************************************************
173  * Open: initialize and create window
174  *****************************************************************************/
175 static int Open( vlc_object_t *p_this )
176 {
177     intf_thread_t *p_intf = (intf_thread_t *)p_this;
178     /* Test in we have an X*/
179 #if defined HAVE_GETENV && (defined __WXGTK__ || defined __WXX11)
180     if( !getenv( "DISPLAY" ) )
181     {
182         msg_Err( p_intf, "no X server");
183         return VLC_EGENERIC;
184     }
185 #endif
186     /* Allocate instance and initialize some members */
187     p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
188     if( p_intf->p_sys == NULL )
189     {
190         msg_Err( p_intf, "out of memory" );
191         return VLC_ENOMEM;
192     }
193     memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
194
195     p_intf->pf_run = Run;
196
197     p_intf->p_sys->p_sub = msg_Subscribe( p_intf, MSG_QUEUE_NORMAL );
198
199     /* Initialize wxWidgets thread */
200     p_intf->p_sys->b_playing = 0;
201
202     p_intf->p_sys->p_input = NULL;
203     p_intf->p_sys->i_playing = -1;
204
205     p_intf->p_sys->p_popup_menu = NULL;
206     p_intf->p_sys->p_video_window = NULL;
207
208     p_intf->pf_show_dialog = NULL;
209
210     /* We support play on start */
211     p_intf->b_play = VLC_TRUE;
212
213     p_intf->p_sys->b_video_autosize =
214         config_GetInt( p_intf, "wx-autosize" );
215
216     return VLC_SUCCESS;
217 }
218
219 static int OpenDialogs( vlc_object_t *p_this )
220 {
221     intf_thread_t *p_intf = (intf_thread_t *)p_this;
222     int i_ret = Open( p_this );
223
224     p_intf->pf_show_dialog = ShowDialog;
225
226     return i_ret;
227 }
228
229 /*****************************************************************************
230  * Close: destroy interface window
231  *****************************************************************************/
232 static void Close( vlc_object_t *p_this )
233 {
234     intf_thread_t *p_intf = (intf_thread_t *)p_this;
235
236     vlc_mutex_lock( &p_intf->object_lock );
237     p_intf->b_dead = VLC_TRUE;
238     vlc_mutex_unlock( &p_intf->object_lock );
239
240     if( p_intf->pf_show_dialog )
241     {
242         /* We must destroy the dialogs thread */
243         wxCommandEvent event( wxEVT_DIALOG, INTF_DIALOG_EXIT );
244         p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
245         vlc_thread_join( p_intf );
246     }
247
248     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
249
250     /* */
251     delete p_intf->p_sys->p_window_settings;
252
253 #if (wxCHECK_VERSION(2,5,0))
254     wxClassInfo::sm_classTable = (wxHashTable*)wxClassInfo_sm_classTable_BUGGY;
255 #endif
256
257     /* Destroy structure */
258     free( p_intf->p_sys );
259 }
260
261 /*****************************************************************************
262  * Run: wxWidgets thread
263  *****************************************************************************/
264
265 //when is this called?
266 #if !defined(__BUILTIN__) && defined( WIN32 )
267 HINSTANCE hInstance = 0;
268 extern "C" BOOL WINAPI
269 DllMain (HANDLE hModule, DWORD fdwReason, LPVOID lpReserved)
270 {
271     hInstance = (HINSTANCE)hModule;
272     return TRUE;
273 }
274 #endif
275
276 static void Run( intf_thread_t *p_intf )
277 {
278     if( p_intf->pf_show_dialog )
279     {
280         /* The module is used in dialog provider mode */
281
282         /* Create a new thread for wxWidgets */
283         if( vlc_thread_create( p_intf, "Skins Dialogs Thread",
284                                Init, 0, VLC_TRUE ) )
285         {
286             msg_Err( p_intf, "cannot create Skins Dialogs Thread" );
287             p_intf->pf_show_dialog = NULL;
288         }
289     }
290     else
291     {
292         /* The module is used in interface mode */
293         Init( p_intf );
294     }
295 }
296
297 static void Init( intf_thread_t *p_intf )
298 {
299 #if !defined( WIN32 )
300     static char  *p_args[] = { "" };
301     int i_args = 1;
302 #endif
303
304     /* Hack to pass the p_intf pointer to the new wxWidgets Instance object */
305 #ifdef wxTheApp
306     wxApp::SetInstance( new Instance( p_intf ) );
307 #else
308     wxTheApp = new Instance( p_intf );
309 #endif
310
311 #if defined( WIN32 )
312 #if !defined(__BUILTIN__)
313
314     //because no one knows when DllMain is called
315     if (hInstance == NULL)
316       hInstance = GetModuleHandle(NULL);
317
318     wxEntry( hInstance/*GetModuleHandle(NULL)*/, NULL, NULL, SW_SHOW );
319 #else
320     wxEntry( GetModuleHandle(NULL), NULL, NULL, SW_SHOW );
321 #endif
322 #else
323     wxEntry( i_args, p_args );
324 #endif
325 }
326
327 /* following functions are local */
328
329 /*****************************************************************************
330  * Constructors.
331  *****************************************************************************/
332 Instance::Instance( )
333 {
334 }
335
336 Instance::Instance( intf_thread_t *_p_intf )
337 {
338     /* Initialization */
339     p_intf = _p_intf;
340 }
341
342 IMPLEMENT_APP_NO_MAIN(Instance)
343
344 /*****************************************************************************
345  * Instance::OnInit: the parent interface execution starts here
346  *****************************************************************************
347  * This is the "main program" equivalent, the program execution will
348  * start here.
349  *****************************************************************************/
350 bool Instance::OnInit()
351 {
352     /* Initialization of i18n stuff.
353      * Usefull for things we don't have any control over, like wxWidgets
354      * provided facilities (eg. open file dialog) */
355     locale.Init( wxLANGUAGE_DEFAULT, wxLOCALE_LOAD_DEFAULT );
356
357     /* Load saved window settings */
358     p_intf->p_sys->p_window_settings = new WindowSettings( p_intf );
359
360     /* Make an instance of your derived frame. Passing NULL (the default value
361      * of Frame's constructor is NULL) as the frame doesn't have a parent
362      * since it is the first window */
363
364     if( !p_intf->pf_show_dialog )
365     {
366         /* The module is used in interface mode */
367         long style = wxDEFAULT_FRAME_STYLE;
368         if ( ! config_GetInt( p_intf, "wx-taskbar" ) )
369         {
370             style = wxDEFAULT_FRAME_STYLE|wxFRAME_NO_TASKBAR;
371         }
372
373         Interface *MainInterface = new Interface( p_intf, style );
374         p_intf->p_sys->p_wxwindow = MainInterface;
375
376         /* Show the interface */
377         MainInterface->Show( TRUE );
378         SetTopWindow( MainInterface );
379         MainInterface->Raise();
380     }
381
382     /* Creates the dialogs provider */
383     p_intf->p_sys->p_wxwindow =
384         CreateDialogsProvider( p_intf, p_intf->pf_show_dialog ?
385                                NULL : p_intf->p_sys->p_wxwindow );
386
387     p_intf->p_sys->pf_show_dialog = ShowDialog;
388
389     /* OK, initialization is over */
390     vlc_thread_ready( p_intf );
391
392     /* Check if we need to start playing */
393     if( !p_intf->pf_show_dialog && p_intf->b_play )
394     {
395         playlist_t *p_playlist =
396             (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
397                                            FIND_ANYWHERE );
398         if( p_playlist )
399         {
400             playlist_Control( p_playlist, PLAYLIST_AUTOPLAY, VLC_FALSE );
401             vlc_object_release( p_playlist );
402         }
403     }
404
405     /* Return TRUE to tell program to continue (FALSE would terminate) */
406     return TRUE;
407 }
408
409 /*****************************************************************************
410  * Instance::OnExit: called when the interface execution stops
411  *****************************************************************************/
412 int Instance::OnExit()
413 {
414     if( p_intf->pf_show_dialog )
415     {
416          /* We need to manually clean up the dialogs class */
417          if( p_intf->p_sys->p_wxwindow ) delete p_intf->p_sys->p_wxwindow;
418     }
419
420 #if (wxCHECK_VERSION(2,5,0))
421     wxClassInfo_sm_classTable_BUGGY = wxClassInfo::sm_classTable;
422     wxClassInfo::sm_classTable = 0;
423 #endif
424
425     return 0;
426 }
427
428 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
429                         intf_dialog_args_t *p_arg )
430 {
431     wxCommandEvent event( wxEVT_DIALOG, i_dialog_event );
432     event.SetInt( i_arg );
433     event.SetClientData( p_arg );
434
435 #ifdef WIN32
436     SendMessage( (HWND)p_intf->p_sys->p_wxwindow->GetHandle(),
437                  WM_CANCELMODE, 0, 0 );
438 #endif
439     if( i_dialog_event == INTF_DIALOG_POPUPMENU && i_arg == 0 ) return;
440
441     /* Hack to prevent popup events to be enqueued when
442      * one is already active */
443     if( i_dialog_event != INTF_DIALOG_POPUPMENU ||
444         !p_intf->p_sys->p_popup_menu )
445     {
446         p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
447     }
448 }
449
450 /*****************************************************************************
451  * WindowSettings utility class
452  *****************************************************************************/
453 WindowSettings::WindowSettings( intf_thread_t *_p_intf )
454 {
455     char *psz_org = NULL;
456     char *psz;
457     int i;
458
459     /* */
460     p_intf = _p_intf;
461
462     /* */
463     for( i = 0; i < ID_MAX; i++ )
464     {
465         b_valid[i] = false;
466         b_shown[i] = false;
467         position[i] = wxDefaultPosition;
468         size[i] = wxDefaultSize;
469     }
470     b_shown[ID_MAIN] = true;
471
472     if( p_intf->pf_show_dialog ) return;
473
474     /* Parse the configuration */
475     psz_org = psz = config_GetPsz( p_intf, "wx-config-last" );
476     if( !psz || *psz == '\0' ) return;
477
478     msg_Dbg( p_intf, "Using last windows config '%s'", psz );
479
480     i_screen_w = 0;
481     i_screen_h = 0;
482     while( psz && *psz )
483     {
484         int id, v[4];
485
486         psz = strchr( psz, '(' );
487
488         if( !psz )
489             break;
490         psz++;
491
492         id = strtol( psz, &psz, 0 );
493         if( *psz != ',' ) /* broken cfg */
494         {
495             goto invalid;
496         }
497         psz++;
498
499         for( i = 0; i < 4; i++ )
500         {
501             v[i] = strtol( psz, &psz, 0 );
502
503             if( i < 3 )
504             {
505                 if( *psz != ',' )
506                 {
507                     goto invalid;
508                 }
509                 psz++;
510             }
511             else
512             {
513                 if( *psz != ')' )
514                 {
515                     goto invalid;
516                 }
517             }
518         }
519         if( id == ID_SCREEN )
520         {
521             i_screen_w = v[2];
522             i_screen_h = v[3];
523         }
524         else if( id >= 0 && id < ID_MAX )
525         {
526             b_valid[id] = true;
527             b_shown[id] = true;
528             position[id] = wxPoint( v[0], v[1] );
529             size[id] = wxSize( v[2], v[3] );
530
531             msg_Dbg( p_intf, "id=%d p=(%d,%d) s=(%d,%d)",
532                      id, position[id].x, position[id].y,
533                          size[id].x, size[id].y );
534         }
535
536         psz = strchr( psz, ')' );
537         if( psz ) psz++;
538     }
539
540     if( i_screen_w <= 0 || i_screen_h <= 0 )
541     {
542         goto invalid;
543     }
544
545     for( i = 0; i < ID_MAX; i++ )
546     {
547         if( !b_valid[i] )
548             continue;
549         if( position[i].x < 0 || position[i].y < 0 )
550         {
551             goto invalid;
552         }
553         if( i != ID_SMALL_PLAYLIST && (size[i].x <= 0 || size[i].y <= 0)  )
554         {
555             goto invalid;
556         }
557     }
558
559     if( psz_org ) free( psz_org );
560     return;
561
562 invalid:
563     msg_Dbg( p_intf, "last windows config is invalid (ignored)" );
564     for( i = 0; i < ID_MAX; i++ )
565     {
566         b_valid[i] = false;
567         b_shown[i] = false;
568         position[i] = wxDefaultPosition;
569         size[i] = wxDefaultSize;
570     }
571     if( psz_org ) free( psz_org );
572 }
573
574
575 WindowSettings::~WindowSettings( )
576 {
577     wxString sCfg;
578
579     if( p_intf->pf_show_dialog ) return;
580
581     sCfg = wxString::Format( wxT("(%d,0,0,%d,%d)"), ID_SCREEN,
582                              wxSystemSettings::GetMetric( wxSYS_SCREEN_X ),
583                              wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) );
584     for( int i = 0; i < ID_MAX; i++ )
585     {
586         if( !b_valid[i] || !b_shown[i] )
587             continue;
588
589         sCfg += wxString::Format( wxT("(%d,%d,%d,%d,%d)"),
590                                   i, position[i].x, position[i].y,
591                                      size[i].x, size[i].y );
592     }
593
594     config_PutPsz( p_intf, "wx-config-last", sCfg.mb_str(wxConvUTF8) );
595 }
596
597 void WindowSettings::SetScreen( int i_screen_w, int i_screen_h )
598 {
599     int i;
600
601     for( i = 0; i < ID_MAX; i++ )
602     {
603         if( !b_valid[i] )
604             continue;
605         if( position[i].x >= i_screen_w || position[i].y >= i_screen_h )
606             goto invalid;
607     }
608     return;
609
610 invalid:
611     for( i = 0; i < ID_MAX; i++ )
612     {
613         b_valid[i] = false;
614         b_shown[i] = false;
615         position[i] = wxDefaultPosition;
616         size[i] = wxDefaultSize;
617     }
618 }
619
620 void WindowSettings::SetSettings( int id, bool _b_shown, wxPoint p, wxSize s )
621 {
622     if( id < 0 || id >= ID_MAX )
623         return;
624
625     b_valid[id] = true;
626     b_shown[id] = _b_shown;
627
628     position[id] = p;
629     size[id] = s;
630 }
631
632 bool WindowSettings::GetSettings( int id, bool& _b_shown, wxPoint& p, wxSize& s)
633 {
634     if( id < 0 || id >= ID_MAX )
635         return false;
636
637     if( !b_valid[id] )
638         return false;
639
640     _b_shown = b_shown[id];
641     p = position[id];
642     s = size[id];
643
644     return true;
645 }