]> git.sesse.net Git - vlc/blob - modules/gui/wxwidgets/wxwidgets.cpp
WX Strings review by Steven Sheehy (Refs:#438)
[vlc] / 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 <stdlib.h>                                      /* malloc(), free() */
28 #include <errno.h>                                                 /* ENOMEM */
29 #include <string.h>                                            /* strerror() */
30 #include <stdio.h>
31
32 #include <vlc/vlc.h>
33 #include <vlc/intf.h>
34
35 #ifdef HAVE_LOCALE_H
36 #   include <locale.h>
37 #endif
38
39 #include "interface.hpp"
40
41 /* Temporary hack */
42 #if defined(WIN32) && defined(_WX_INIT_H_)
43 #if (wxMAJOR_VERSION <= 2) && (wxMINOR_VERSION <= 5) && (wxRELEASE_NUMBER < 3)
44 /* Hack to detect wxWidgets 2.5 which has a different wxEntry() prototype */
45 extern int wxEntry( HINSTANCE hInstance, HINSTANCE hPrevInstance = NULL,
46                     char *pCmdLine = NULL, int nCmdShow = SW_NORMAL );
47 #endif
48 #endif
49
50 /*****************************************************************************
51  * Local prototypes.
52  *****************************************************************************/
53 static int  Open         ( vlc_object_t * );
54 static void Close        ( vlc_object_t * );
55 static int  OpenDialogs  ( vlc_object_t * );
56
57 static void Run          ( intf_thread_t * );
58 static void Init         ( intf_thread_t * );
59
60 static void ShowDialog   ( intf_thread_t *, int, int, intf_dialog_args_t * );
61
62 #if (wxCHECK_VERSION(2,5,0))
63 void *wxClassInfo_sm_classTable_BUGGY = 0;
64 #endif
65
66 /*****************************************************************************
67  * Local classes declarations.
68  *****************************************************************************/
69 class Instance: public wxApp
70 {
71 public:
72     Instance();
73     Instance( intf_thread_t *_p_intf );
74
75     bool OnInit();
76     int  OnExit();
77
78 private:
79     intf_thread_t *p_intf;
80     wxLocale locale;                                /* locale we'll be using */
81 };
82
83 /*****************************************************************************
84  * Module descriptor
85  *****************************************************************************/
86 #define EMBED_TEXT N_("Embed video in interface")
87 #define EMBED_LONGTEXT N_("Embed the video inside the interface instead " \
88     "of having it in a separate window.")
89 #define BOOKMARKS_TEXT N_("Bookmarks dialog")
90 #define BOOKMARKS_LONGTEXT N_("Show bookmarks dialog at startup" )
91 #define EXTENDED_TEXT N_("Extended GUI")
92 #define EXTENDED_LONGTEXT N_("Show extended GUI (equalizer, image adjust, "  \
93               "video filters...) at startup"  )
94 #define TASKBAR_TEXT N_("Taskbar")
95 #define TASKBAR_LONGTEXT N_("Show VLC on the taskbar")
96 #define MINIMAL_TEXT N_("Minimal interface")
97 #define MINIMAL_LONGTEXT N_("Use minimal interface, with no toolbar and " \
98                 "fewer menus.")
99 #define SIZE_TO_VIDEO_TEXT N_("Size to video")
100 #define SIZE_TO_VIDEO_LONGTEXT N_("Resize VLC to match the video resolution.")
101 #define SYSTRAY_TEXT N_("Systray icon")
102 #define SYSTRAY_LONGTEXT N_("Show a systray icon for VLC")
103 #define LABEL_TEXT N_("Show labels in toolbar")
104 #define LABEL_LONGTEXT N_("Show labels below the icons in the toolbar.")
105
106 #define PLAYLIST_TEXT N_("Playlist view" )
107 #define PLAYLIST_LONGTEXT N_("There are two possible playlist views in the " \
108                 "interface : the normal playlist (separate window), or an " \
109                 "embedded playlist (within the main interface, but with " \
110                 "less features). You can select which one will be available " \
111                 "on the toolbar (or both)." )
112
113 static int pi_playlist_views[] = { 0,1,2 };
114 static char *psz_playlist_views[] = { N_("Normal" ), N_("Embedded" ) ,
115                                       N_("Both") };
116
117 vlc_module_begin();
118 #ifdef WIN32
119     int i_score = 150;
120 #else
121     int i_score = getenv( "DISPLAY" ) == NULL ? 15 : 150;
122 #endif
123     set_shortname( (char*) "wxWidgets" );
124     set_description( (char *) _("wxWidgets interface module") );
125     set_category( CAT_INTERFACE );
126     set_subcategory( SUBCAT_INTERFACE_MAIN );
127     set_capability( "interface", i_score );
128     set_callbacks( Open, Close );
129     add_shortcut( "wxwindows" );
130     add_shortcut( "wxwin" );
131     add_shortcut( "wx" );
132     add_shortcut( "wxwidgets" );
133     set_program( "wxvlc" );
134
135     add_bool( "wx-embed", 1, NULL,
136               EMBED_TEXT, EMBED_LONGTEXT, VLC_FALSE );
137     add_deprecated( "wxwin-enbed", VLC_FALSE); /*Deprecated since 0.8.4*/
138     add_bool( "wx-bookmarks", 0, NULL,
139               BOOKMARKS_TEXT, BOOKMARKS_LONGTEXT, VLC_FALSE );
140     add_deprecated( "wxwin-bookmarks", VLC_FALSE); /*Deprecated since 0.8.4*/
141     add_bool( "wx-taskbar", 1, NULL,
142               TASKBAR_TEXT, TASKBAR_LONGTEXT, VLC_FALSE );
143     add_deprecated( "wxwin-taskbar", VLC_FALSE); /*Deprecated since 0.8.4*/
144     add_bool( "wx-extended", 0, NULL,
145               EXTENDED_TEXT, EXTENDED_LONGTEXT, VLC_FALSE );
146     add_bool( "wx-minimal", 0, NULL,
147               MINIMAL_TEXT, MINIMAL_LONGTEXT, VLC_TRUE );
148     add_deprecated( "wxwin-minimal", VLC_FALSE); /*Deprecated since 0.8.4*/
149     add_bool( "wx-autosize", 1, NULL,
150               SIZE_TO_VIDEO_TEXT, SIZE_TO_VIDEO_LONGTEXT, VLC_TRUE );
151     add_integer( "wx-playlist-view", 0, NULL, PLAYLIST_TEXT, PLAYLIST_LONGTEXT,
152              VLC_FALSE );
153         change_integer_list( pi_playlist_views, psz_playlist_views, 0 );
154     add_deprecated( "wxwin-autosize", VLC_FALSE); /*Deprecated since 0.8.4*/
155 /* wxCocoa pretends to support this, but at least 2.6.x doesn't */
156 #ifndef __APPLE__
157 #ifdef wxHAS_TASK_BAR_ICON
158     add_bool( "wx-systray", 0, NULL,
159               SYSTRAY_TEXT, SYSTRAY_LONGTEXT, VLC_FALSE );
160     add_deprecated( "wxwin-systray", VLC_FALSE); /*Deprecated since 0.8.4*/
161 #endif
162 #endif
163     add_bool( "wx-labels", 0, NULL, LABEL_TEXT, LABEL_LONGTEXT, VLC_TRUE);
164     add_string( "wx-config-last", NULL, NULL,
165                 "last config", "last config", VLC_TRUE );
166         change_autosave();
167     add_deprecated( "wxwin-config-last", VLC_FALSE); /*Deprecated since 0.8.4*/
168
169     add_submodule();
170     set_description( _("wxWidgets dialogs provider") );
171     set_capability( "dialogs provider", 50 );
172     set_callbacks( OpenDialogs, Close );
173
174 #if !defined(WIN32)
175     linked_with_a_crap_library_which_uses_atexit();
176 #endif
177 vlc_module_end();
178
179 /*****************************************************************************
180  * Open: initialize and create window
181  *****************************************************************************/
182 static int Open( vlc_object_t *p_this )
183 {
184     intf_thread_t *p_intf = (intf_thread_t *)p_this;
185
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     setlocale( LC_NUMERIC, "C" );
326 }
327
328 /* following functions are local */
329
330 /*****************************************************************************
331  * Constructors.
332  *****************************************************************************/
333 Instance::Instance( )
334 {
335 }
336
337 Instance::Instance( intf_thread_t *_p_intf )
338 {
339     /* Initialization */
340     p_intf = _p_intf;
341 }
342
343 IMPLEMENT_APP_NO_MAIN(Instance)
344
345 /*****************************************************************************
346  * Instance::OnInit: the parent interface execution starts here
347  *****************************************************************************
348  * This is the "main program" equivalent, the program execution will
349  * start here.
350  *****************************************************************************/
351 bool Instance::OnInit()
352 {
353     /* Initialization of i18n stuff.
354      * Usefull for things we don't have any control over, like wxWidgets
355      * provided facilities (eg. open file dialog) */
356     locale.Init( wxLANGUAGE_DEFAULT, wxLOCALE_LOAD_DEFAULT );
357     setlocale( LC_NUMERIC, "C" );
358
359     /* Load saved window settings */
360     p_intf->p_sys->p_window_settings = new WindowSettings( p_intf );
361
362     /* Make an instance of your derived frame. Passing NULL (the default value
363      * of Frame's constructor is NULL) as the frame doesn't have a parent
364      * since it is the first window */
365
366     if( !p_intf->pf_show_dialog )
367     {
368         /* The module is used in interface mode */
369         long style = wxDEFAULT_FRAME_STYLE;
370         if ( ! config_GetInt( p_intf, "wx-taskbar" ) )
371         {
372             style = wxDEFAULT_FRAME_STYLE|wxFRAME_NO_TASKBAR;
373         }
374
375         Interface *MainInterface = new Interface( p_intf, style );
376         p_intf->p_sys->p_wxwindow = MainInterface;
377
378         /* Show the interface */
379         MainInterface->Show( TRUE );
380         SetTopWindow( MainInterface );
381         MainInterface->Raise();
382     }
383
384     /* Creates the dialogs provider */
385     p_intf->p_sys->p_wxwindow =
386         CreateDialogsProvider( p_intf, p_intf->pf_show_dialog ?
387                                NULL : p_intf->p_sys->p_wxwindow );
388
389     p_intf->p_sys->pf_show_dialog = ShowDialog;
390
391     /* OK, initialization is over */
392     vlc_thread_ready( p_intf );
393
394     /* Check if we need to start playing */
395     if( !p_intf->pf_show_dialog && p_intf->b_play )
396     {
397         playlist_t *p_playlist =
398             (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
399                                            FIND_ANYWHERE );
400         if( p_playlist )
401         {
402             playlist_LockControl( p_playlist, PLAYLIST_AUTOPLAY );
403             vlc_object_release( p_playlist );
404         }
405     }
406
407     /* Return TRUE to tell program to continue (FALSE would terminate) */
408     return TRUE;
409 }
410
411 /*****************************************************************************
412  * Instance::OnExit: called when the interface execution stops
413  *****************************************************************************/
414 int Instance::OnExit()
415 {
416     if( p_intf->pf_show_dialog )
417     {
418          /* We need to manually clean up the dialogs class */
419          if( p_intf->p_sys->p_wxwindow ) delete p_intf->p_sys->p_wxwindow;
420     }
421
422 #if (wxCHECK_VERSION(2,5,0))
423     wxClassInfo_sm_classTable_BUGGY = wxClassInfo::sm_classTable;
424     wxClassInfo::sm_classTable = 0;
425 #endif
426
427     return 0;
428 }
429
430 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
431                         intf_dialog_args_t *p_arg )
432 {
433     wxCommandEvent event( wxEVT_DIALOG, i_dialog_event );
434     event.SetInt( i_arg );
435     event.SetClientData( p_arg );
436
437 #ifdef WIN32
438     SendMessage( (HWND)p_intf->p_sys->p_wxwindow->GetHandle(),
439                  WM_CANCELMODE, 0, 0 );
440 #endif
441     if( i_dialog_event == INTF_DIALOG_POPUPMENU && i_arg == 0 ) return;
442
443     /* Hack to prevent popup events to be enqueued when
444      * one is already active */
445     if( i_dialog_event != INTF_DIALOG_POPUPMENU ||
446         !p_intf->p_sys->p_popup_menu )
447     {
448         p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
449     }
450 }
451
452 /*****************************************************************************
453  * WindowSettings utility class
454  *****************************************************************************/
455 WindowSettings::WindowSettings( intf_thread_t *_p_intf )
456 {
457     char *psz_org = NULL;
458     char *psz;
459     int i;
460
461     /* */
462     p_intf = _p_intf;
463
464     /* */
465     for( i = 0; i < ID_MAX; i++ )
466     {
467         b_valid[i] = false;
468         b_shown[i] = false;
469         position[i] = wxDefaultPosition;
470         size[i] = wxDefaultSize;
471     }
472     b_shown[ID_MAIN] = true;
473
474     if( p_intf->pf_show_dialog ) return;
475
476     /* Parse the configuration */
477     psz_org = psz = config_GetPsz( p_intf, "wx-config-last" );
478     if( !psz || *psz == '\0' ) return;
479
480     msg_Dbg( p_intf, "Using last windows config '%s'", psz );
481
482     i_screen_w = 0;
483     i_screen_h = 0;
484     while( psz && *psz )
485     {
486         int id, v[4];
487
488         psz = strchr( psz, '(' );
489
490         if( !psz )
491             break;
492         psz++;
493
494         id = strtol( psz, &psz, 0 );
495         if( *psz != ',' ) /* broken cfg */
496         {
497             goto invalid;
498         }
499         psz++;
500
501         for( i = 0; i < 4; i++ )
502         {
503             v[i] = strtol( psz, &psz, 0 );
504
505             if( i < 3 )
506             {
507                 if( *psz != ',' )
508                 {
509                     goto invalid;
510                 }
511                 psz++;
512             }
513             else
514             {
515                 if( *psz != ')' )
516                 {
517                     goto invalid;
518                 }
519             }
520         }
521         if( id == ID_SCREEN )
522         {
523             i_screen_w = v[2];
524             i_screen_h = v[3];
525         }
526         else if( id >= 0 && id < ID_MAX )
527         {
528             b_valid[id] = true;
529             b_shown[id] = true;
530             position[id] = wxPoint( v[0], v[1] );
531             size[id] = wxSize( v[2], v[3] );
532
533             msg_Dbg( p_intf, "id=%d p=(%d,%d) s=(%d,%d)",
534                      id, position[id].x, position[id].y,
535                          size[id].x, size[id].y );
536         }
537
538         psz = strchr( psz, ')' );
539         if( psz ) psz++;
540     }
541
542     if( i_screen_w <= 0 || i_screen_h <= 0 )
543     {
544         goto invalid;
545     }
546
547     for( i = 0; i < ID_MAX; i++ )
548     {
549         if( !b_valid[i] )
550             continue;
551         if( position[i].x < 0 || position[i].y < 0 )
552         {
553             goto invalid;
554         }
555         if( i != ID_SMALL_PLAYLIST && (size[i].x <= 0 || size[i].y <= 0)  )
556         {
557             goto invalid;
558         }
559     }
560
561     if( psz_org ) free( psz_org );
562     return;
563
564 invalid:
565     msg_Dbg( p_intf, "last windows config is invalid (ignored)" );
566     for( i = 0; i < ID_MAX; i++ )
567     {
568         b_valid[i] = false;
569         b_shown[i] = false;
570         position[i] = wxDefaultPosition;
571         size[i] = wxDefaultSize;
572     }
573     if( psz_org ) free( psz_org );
574 }
575
576
577 WindowSettings::~WindowSettings( )
578 {
579     wxString sCfg;
580
581     if( p_intf->pf_show_dialog ) return;
582
583     sCfg = wxString::Format( wxT("(%d,0,0,%d,%d)"), ID_SCREEN,
584                              wxSystemSettings::GetMetric( wxSYS_SCREEN_X ),
585                              wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) );
586     for( int i = 0; i < ID_MAX; i++ )
587     {
588         if( !b_valid[i] || !b_shown[i] )
589             continue;
590
591         sCfg += wxString::Format( wxT("(%d,%d,%d,%d,%d)"),
592                                   i, position[i].x, position[i].y,
593                                      size[i].x, size[i].y );
594     }
595
596     config_PutPsz( p_intf, "wx-config-last", sCfg.mb_str() );
597 }
598
599 void WindowSettings::SetScreen( int i_screen_w, int i_screen_h )
600 {
601     int i;
602
603     for( i = 0; i < ID_MAX; i++ )
604     {
605         if( !b_valid[i] )
606             continue;
607         if( position[i].x >= i_screen_w || position[i].y >= i_screen_h )
608             goto invalid;
609     }
610     return;
611
612 invalid:
613     for( i = 0; i < ID_MAX; i++ )
614     {
615         b_valid[i] = false;
616         b_shown[i] = false;
617         position[i] = wxDefaultPosition;
618         size[i] = wxDefaultSize;
619     }
620 }
621
622 void WindowSettings::SetSettings( int id, bool _b_shown, wxPoint p, wxSize s )
623 {
624     if( id < 0 || id >= ID_MAX )
625         return;
626
627     b_valid[id] = true;
628     b_shown[id] = _b_shown;
629
630     position[id] = p;
631     size[id] = s;
632 }
633
634 bool WindowSettings::GetSettings( int id, bool& _b_shown, wxPoint& p, wxSize& s)
635 {
636     if( id < 0 || id >= ID_MAX )
637         return false;
638
639     if( !b_valid[id] )
640         return false;
641
642     _b_shown = b_shown[id];
643     p = position[id];
644     s = size[id];
645
646     return true;
647 }