1 /*****************************************************************************
2 * wxwidgets.cpp : wxWidgets plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2005 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <errno.h> /* ENOMEM */
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_interface.h>
41 #include "interface.hpp"
44 #if defined(WIN32) && defined(_WX_INIT_H_)
45 #if (wxMAJOR_VERSION <= 2) && (wxMINOR_VERSION <= 5) && (wxRELEASE_NUMBER < 3)
46 /* Hack to detect wxWidgets 2.5 which has a different wxEntry() prototype */
47 extern int wxEntry( HINSTANCE hInstance, HINSTANCE hPrevInstance = NULL,
48 char *pCmdLine = NULL, int nCmdShow = SW_NORMAL );
52 /*****************************************************************************
54 *****************************************************************************/
55 static int Open ( vlc_object_t * );
56 static void Close ( vlc_object_t * );
57 static int OpenDialogs ( vlc_object_t * );
59 static void Run ( intf_thread_t * );
60 static void* Init ( vlc_object_t * );
62 static void ShowDialog ( intf_thread_t *, int, int, intf_dialog_args_t * );
64 #if (wxCHECK_VERSION(2,5,0))
65 void *wxClassInfo_sm_classTable_BUGGY = 0;
68 /*****************************************************************************
69 * Local classes declarations.
70 *****************************************************************************/
71 class Instance: public wxApp
75 Instance( intf_thread_t *_p_intf );
81 intf_thread_t *p_intf;
82 wxLocale locale; /* locale we'll be using */
85 /*****************************************************************************
87 *****************************************************************************/
88 #define EMBED_TEXT N_("Embed video in interface")
89 #define EMBED_LONGTEXT N_("Embed the video inside the interface instead " \
90 "of having it in a separate window.")
91 #define BOOKMARKS_TEXT N_("Bookmarks dialog")
92 #define BOOKMARKS_LONGTEXT N_("Show bookmarks dialog at startup" )
93 #define EXTENDED_TEXT N_("Extended GUI")
94 #define EXTENDED_LONGTEXT N_("Show extended GUI (equalizer, image adjust, " \
95 "video filters...) at startup" )
96 #define TASKBAR_TEXT N_("Taskbar")
97 #define TASKBAR_LONGTEXT N_("Show VLC on the taskbar")
98 #define MINIMAL_TEXT N_("Minimal interface")
99 #define MINIMAL_LONGTEXT N_("Use minimal interface, with no toolbar and " \
101 #define SIZE_TO_VIDEO_TEXT N_("Size to video")
102 #define SIZE_TO_VIDEO_LONGTEXT N_("Resize VLC to match the video resolution.")
103 #define SYSTRAY_TEXT N_("Systray icon")
104 #define SYSTRAY_LONGTEXT N_("Show a systray icon for VLC")
105 #define LABEL_TEXT N_("Show labels in toolbar")
106 #define LABEL_LONGTEXT N_("Show labels below the icons in the toolbar.")
108 #define PLAYLIST_TEXT N_("Playlist view" )
109 #define PLAYLIST_LONGTEXT N_("There are two possible playlist views in the " \
110 "interface : the normal playlist (separate window), or an " \
111 "embedded playlist (within the main interface, but with " \
112 "less features). You can select which one will be available " \
113 "on the toolbar (or both)." )
115 static const int pi_playlist_views[] = { 0,1,2 };
116 static const char *const psz_playlist_views[] = {
117 N_("Normal" ), N_("Embedded" ), N_("Both") };
120 set_shortname( "wxWidgets" )
121 set_description( N_("wxWidgets interface module") )
122 set_category( CAT_INTERFACE )
123 set_subcategory( SUBCAT_INTERFACE_MAIN )
124 set_capability( "interface", 150 )
125 set_callbacks( Open, Close )
126 add_shortcut( "wxwindows" )
127 add_shortcut( "wxwin" )
129 add_shortcut( "wxwidgets" )
131 add_bool( "wx-embed", 1, NULL,
132 EMBED_TEXT, EMBED_LONGTEXT, false );
133 add_deprecated_alias( "wxwin-enbed" ) /*Deprecated since 0.8.4*/
134 add_bool( "wx-bookmarks", 0, NULL,
135 BOOKMARKS_TEXT, BOOKMARKS_LONGTEXT, false );
136 add_deprecated_alias( "wxwin-bookmarks" ) /*Deprecated since 0.8.4*/
137 add_bool( "wx-taskbar", 1, NULL,
138 TASKBAR_TEXT, TASKBAR_LONGTEXT, false );
139 add_deprecated_alias( "wxwin-taskbar" ) /*Deprecated since 0.8.4*/
140 add_bool( "wx-extended", 0, NULL,
141 EXTENDED_TEXT, EXTENDED_LONGTEXT, false );
142 add_bool( "wx-minimal", 0, NULL,
143 MINIMAL_TEXT, MINIMAL_LONGTEXT, true );
144 add_deprecated_alias( "wxwin-minimal" ) /*Deprecated since 0.8.4*/
145 add_bool( "wx-autosize", 1, NULL,
146 SIZE_TO_VIDEO_TEXT, SIZE_TO_VIDEO_LONGTEXT, true );
147 add_deprecated_alias( "wxwin-autosize" ) /*Deprecated since 0.8.4*/
148 add_integer( "wx-playlist-view", 0, NULL, PLAYLIST_TEXT, PLAYLIST_LONGTEXT,
150 change_integer_list( pi_playlist_views, psz_playlist_views, NULL );
151 /* wxCocoa pretends to support this, but at least 2.6.x doesn't */
153 #ifdef wxHAS_TASK_BAR_ICON
154 add_bool( "wx-systray", 0, NULL,
155 SYSTRAY_TEXT, SYSTRAY_LONGTEXT, false );
156 add_deprecated_alias( "wxwin-systray" ) /*Deprecated since 0.8.4*/
159 add_bool( "wx-labels", 0, NULL, LABEL_TEXT, LABEL_LONGTEXT, true)
160 add_string( "wx-config-last", NULL, NULL,
161 N_("last config"), N_("last config"), true );
164 add_deprecated_alias( "wxwin-config-last" ) /*Deprecated since 0.8.4*/
167 set_description( N_("wxWidgets dialogs provider") )
168 set_capability( "dialogs provider", 50 )
169 set_callbacks( OpenDialogs, Close )
172 linked_with_a_crap_library_which_uses_atexit ()
176 /*****************************************************************************
177 * Open: initialize and create window
178 *****************************************************************************/
179 static int Open( vlc_object_t *p_this )
181 intf_thread_t *p_intf = (intf_thread_t *)p_this;
182 /* Test in we have an X*/
183 #if defined HAVE_GETENV && (defined __WXGTK__ || defined __WXX11)
184 if( !getenv( "DISPLAY" ) )
186 msg_Err( p_intf, "no X server");
190 /* Allocate instance and initialize some members */
191 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
192 if( p_intf->p_sys == NULL )
194 memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
196 p_intf->pf_run = Run;
198 p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
200 /* Initialize wxWidgets thread */
201 p_intf->p_sys->b_playing = 0;
203 p_intf->p_sys->p_input = NULL;
204 p_intf->p_sys->i_playing = -1;
206 p_intf->p_sys->p_popup_menu = NULL;
207 p_intf->p_sys->p_video_window = NULL;
209 p_intf->pf_show_dialog = NULL;
211 p_intf->p_sys->b_video_autosize =
212 config_GetInt( p_intf, "wx-autosize" );
217 static int OpenDialogs( vlc_object_t *p_this )
219 intf_thread_t *p_intf = (intf_thread_t *)p_this;
220 int i_ret = Open( p_this );
222 p_intf->pf_show_dialog = ShowDialog;
227 /*****************************************************************************
228 * Close: destroy interface window
229 *****************************************************************************/
230 static void Close( vlc_object_t *p_this )
232 intf_thread_t *p_intf = (intf_thread_t *)p_this;
234 vlc_object_lock( p_intf );
235 p_intf->b_dead = true;
236 vlc_object_unlock( p_intf );
238 if( p_intf->pf_show_dialog )
240 /* We must destroy the dialogs thread */
241 wxCommandEvent event( wxEVT_DIALOG, INTF_DIALOG_EXIT );
242 p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
243 vlc_thread_join( p_intf );
246 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
249 delete p_intf->p_sys->p_window_settings;
251 #if (wxCHECK_VERSION(2,5,0))
252 wxClassInfo::sm_classTable = (wxHashTable*)wxClassInfo_sm_classTable_BUGGY;
255 /* Destroy structure */
256 free( p_intf->p_sys );
259 /*****************************************************************************
260 * Run: wxWidgets thread
261 *****************************************************************************/
263 //when is this called?
264 #if !defined(__BUILTIN__) && defined( WIN32 )
265 HINSTANCE hInstance = 0;
266 extern "C" BOOL WINAPI
267 DllMain (HANDLE hModule, DWORD fdwReason, LPVOID lpReserved)
269 hInstance = (HINSTANCE)hModule;
274 static void Run( intf_thread_t *p_intf )
276 if( p_intf->pf_show_dialog )
278 /* The module is used in dialog provider mode */
280 /* Create a new thread for wxWidgets */
281 if( vlc_thread_create( p_intf, "Skins Dialogs Thread", Init, 0 ) )
283 msg_Err( p_intf, "cannot create Skins Dialogs Thread" );
284 p_intf->pf_show_dialog = NULL;
289 int canc = vlc_savecancel();
290 /* The module is used in interface mode */
292 vlc_restorecancel( canc );
296 static void* Init( vlc_object_t * p_this )
298 intf_thread_t *p_intf = (intf_thread_t*)p_this;
299 #if !defined( WIN32 )
300 static char *p_args[] = { "" };
303 int canc = vlc_savecancel ();
305 /* Hack to pass the p_intf pointer to the new wxWidgets Instance object */
307 wxApp::SetInstance( new Instance( p_intf ) );
309 wxTheApp = new Instance( p_intf );
313 #if !defined(__BUILTIN__)
315 //because no one knows when DllMain is called
316 if (hInstance == NULL)
317 hInstance = GetModuleHandle(NULL);
319 wxEntry( hInstance/*GetModuleHandle(NULL)*/, NULL, NULL, SW_SHOW );
321 wxEntry( GetModuleHandle(NULL), NULL, NULL, SW_SHOW );
324 wxEntry( i_args, p_args );
326 vlc_restorecancel (canc);
330 /* following functions are local */
332 /*****************************************************************************
334 *****************************************************************************/
335 Instance::Instance( )
339 Instance::Instance( intf_thread_t *_p_intf )
345 IMPLEMENT_APP_NO_MAIN(Instance)
347 /*****************************************************************************
348 * Instance::OnInit: the parent interface execution starts here
349 *****************************************************************************
350 * This is the "main program" equivalent, the program execution will
352 *****************************************************************************/
353 bool Instance::OnInit()
355 /* Initialization of i18n stuff.
356 * Usefull for things we don't have any control over, like wxWidgets
357 * provided facilities (eg. open file dialog) */
358 locale.Init( wxLANGUAGE_DEFAULT, wxLOCALE_LOAD_DEFAULT );
360 /* Load saved window settings */
361 p_intf->p_sys->p_window_settings = new WindowSettings( p_intf );
363 /* Make an instance of your derived frame. Passing NULL (the default value
364 * of Frame's constructor is NULL) as the frame doesn't have a parent
365 * since it is the first window */
367 if( !p_intf->pf_show_dialog )
369 /* The module is used in interface mode */
370 long style = wxDEFAULT_FRAME_STYLE;
371 if ( ! config_GetInt( p_intf, "wx-taskbar" ) )
373 style = wxDEFAULT_FRAME_STYLE|wxFRAME_NO_TASKBAR;
376 Interface *MainInterface = new Interface( p_intf, style );
377 p_intf->p_sys->p_wxwindow = MainInterface;
379 /* Show the interface */
380 MainInterface->Show( TRUE );
381 SetTopWindow( MainInterface );
382 MainInterface->Raise();
385 /* Creates the dialogs provider */
386 p_intf->p_sys->p_wxwindow =
387 CreateDialogsProvider( p_intf, p_intf->pf_show_dialog ?
388 NULL : p_intf->p_sys->p_wxwindow );
390 p_intf->p_sys->pf_show_dialog = ShowDialog;
392 /* OK, initialization is over */
393 vlc_thread_ready( p_intf );
395 /* Return TRUE to tell program to continue (FALSE would terminate) */
399 /*****************************************************************************
400 * Instance::OnExit: called when the interface execution stops
401 *****************************************************************************/
402 int Instance::OnExit()
404 if( p_intf->pf_show_dialog )
406 /* We need to manually clean up the dialogs class */
407 delete p_intf->p_sys->p_wxwindow;
410 #if (wxCHECK_VERSION(2,5,0))
411 wxClassInfo_sm_classTable_BUGGY = wxClassInfo::sm_classTable;
412 wxClassInfo::sm_classTable = 0;
418 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
419 intf_dialog_args_t *p_arg )
421 wxCommandEvent event( wxEVT_DIALOG, i_dialog_event );
422 event.SetInt( i_arg );
423 event.SetClientData( p_arg );
426 SendMessage( (HWND)p_intf->p_sys->p_wxwindow->GetHandle(),
427 WM_CANCELMODE, 0, 0 );
429 if( i_dialog_event == INTF_DIALOG_POPUPMENU && i_arg == 0 ) return;
431 /* Hack to prevent popup events to be enqueued when
432 * one is already active */
433 if( i_dialog_event != INTF_DIALOG_POPUPMENU ||
434 !p_intf->p_sys->p_popup_menu )
436 p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
440 /*****************************************************************************
441 * WindowSettings utility class
442 *****************************************************************************/
443 WindowSettings::WindowSettings( intf_thread_t *_p_intf )
445 char *psz_org = NULL;
453 for( i = 0; i < ID_MAX; i++ )
457 position[i] = wxDefaultPosition;
458 size[i] = wxDefaultSize;
460 b_shown[ID_MAIN] = true;
462 if( p_intf->pf_show_dialog ) return;
464 /* Parse the configuration */
465 psz_org = psz = config_GetPsz( p_intf, "wx-config-last" );
466 if( !psz || *psz == '\0' ) return;
468 msg_Dbg( p_intf, "Using last windows config '%s'", psz );
476 psz = strchr( psz, '(' );
482 id = strtol( psz, &psz, 0 );
483 if( *psz != ',' ) /* broken cfg */
489 for( i = 0; i < 4; i++ )
491 v[i] = strtol( psz, &psz, 0 );
509 if( id == ID_SCREEN )
514 else if( id >= 0 && id < ID_MAX )
518 position[id] = wxPoint( v[0], v[1] );
519 size[id] = wxSize( v[2], v[3] );
521 msg_Dbg( p_intf, "id=%d p=(%d,%d) s=(%d,%d)",
522 id, position[id].x, position[id].y,
523 size[id].x, size[id].y );
526 psz = strchr( psz, ')' );
530 if( i_screen_w <= 0 || i_screen_h <= 0 )
535 for( i = 0; i < ID_MAX; i++ )
539 if( position[i].x < 0 || position[i].y < 0 )
543 if( i != ID_SMALL_PLAYLIST && (size[i].x <= 0 || size[i].y <= 0) )
553 msg_Dbg( p_intf, "last windows config is invalid (ignored)" );
554 for( i = 0; i < ID_MAX; i++ )
558 position[i] = wxDefaultPosition;
559 size[i] = wxDefaultSize;
565 WindowSettings::~WindowSettings( )
569 if( p_intf->pf_show_dialog ) return;
571 sCfg = wxString::Format( wxT("(%d,0,0,%d,%d)"), ID_SCREEN,
572 wxSystemSettings::GetMetric( wxSYS_SCREEN_X ),
573 wxSystemSettings::GetMetric( wxSYS_SCREEN_Y ) );
574 for( int i = 0; i < ID_MAX; i++ )
576 if( !b_valid[i] || !b_shown[i] )
579 sCfg += wxString::Format( wxT("(%d,%d,%d,%d,%d)"),
580 i, position[i].x, position[i].y,
581 size[i].x, size[i].y );
584 config_PutPsz( p_intf, "wx-config-last", sCfg.mb_str(wxConvUTF8) );
587 void WindowSettings::SetScreen( int i_screen_w, int i_screen_h )
591 for( i = 0; i < ID_MAX; i++ )
595 if( position[i].x >= i_screen_w || position[i].y >= i_screen_h )
601 for( i = 0; i < ID_MAX; i++ )
605 position[i] = wxDefaultPosition;
606 size[i] = wxDefaultSize;
610 void WindowSettings::SetSettings( int id, bool _b_shown, wxPoint p, wxSize s )
612 if( id < 0 || id >= ID_MAX )
616 b_shown[id] = _b_shown;
622 bool WindowSettings::GetSettings( int id, bool& _b_shown, wxPoint& p, wxSize& s)
624 if( id < 0 || id >= ID_MAX )
630 _b_shown = b_shown[id];