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 */
31 #include <vlc_interface.h>
37 #include "interface.hpp"
40 #if defined(WIN32) && defined(_WX_INIT_H_)
41 #if (wxMAJOR_VERSION <= 2) && (wxMINOR_VERSION <= 5) && (wxRELEASE_NUMBER < 3)
42 /* Hack to detect wxWidgets 2.5 which has a different wxEntry() prototype */
43 extern int wxEntry( HINSTANCE hInstance, HINSTANCE hPrevInstance = NULL,
44 char *pCmdLine = NULL, int nCmdShow = SW_NORMAL );
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Open ( vlc_object_t * );
52 static void Close ( vlc_object_t * );
53 static int OpenDialogs ( vlc_object_t * );
55 static void Run ( intf_thread_t * );
56 static void Init ( intf_thread_t * );
58 static void ShowDialog ( intf_thread_t *, int, int, intf_dialog_args_t * );
60 #if (wxCHECK_VERSION(2,5,0))
61 void *wxClassInfo_sm_classTable_BUGGY = 0;
64 /*****************************************************************************
65 * Local classes declarations.
66 *****************************************************************************/
67 class Instance: public wxApp
71 Instance( intf_thread_t *_p_intf );
77 intf_thread_t *p_intf;
78 wxLocale locale; /* locale we'll be using */
81 /*****************************************************************************
83 *****************************************************************************/
84 #define EMBED_TEXT N_("Embed video in interface")
85 #define EMBED_LONGTEXT N_("Embed the video inside the interface instead " \
86 "of having it in a separate window.")
87 #define BOOKMARKS_TEXT N_("Bookmarks dialog")
88 #define BOOKMARKS_LONGTEXT N_("Show bookmarks dialog at startup" )
89 #define EXTENDED_TEXT N_("Extended GUI")
90 #define EXTENDED_LONGTEXT N_("Show extended GUI (equalizer, image adjust, " \
91 "video filters...) at startup" )
92 #define TASKBAR_TEXT N_("Taskbar")
93 #define TASKBAR_LONGTEXT N_("Show VLC on the taskbar")
94 #define MINIMAL_TEXT N_("Minimal interface")
95 #define MINIMAL_LONGTEXT N_("Use minimal interface, with no toolbar and " \
97 #define SIZE_TO_VIDEO_TEXT N_("Size to video")
98 #define SIZE_TO_VIDEO_LONGTEXT N_("Resize VLC to match the video resolution.")
99 #define SYSTRAY_TEXT N_("Systray icon")
100 #define SYSTRAY_LONGTEXT N_("Show a systray icon for VLC")
101 #define LABEL_TEXT N_("Show labels in toolbar")
102 #define LABEL_LONGTEXT N_("Show labels below the icons in the toolbar.")
104 #define PLAYLIST_TEXT N_("Playlist view" )
105 #define PLAYLIST_LONGTEXT N_("There are two possible playlist views in the " \
106 "interface : the normal playlist (separate window), or an " \
107 "embedded playlist (within the main interface, but with " \
108 "less features). You can select which one will be available " \
109 "on the toolbar (or both)." )
111 static int pi_playlist_views[] = { 0,1,2 };
112 static const char *psz_playlist_views[] = { N_("Normal" ), N_("Embedded" ) ,
117 set_shortname( (char*) "wxWidgets" );
118 set_description( (char *) _("wxWidgets interface module") );
119 set_category( CAT_INTERFACE );
120 set_subcategory( SUBCAT_INTERFACE_MAIN );
121 set_capability( "interface", i_score );
122 set_callbacks( Open, Close );
123 add_shortcut( "wxwindows" );
124 add_shortcut( "wxwin" );
125 add_shortcut( "wx" );
126 add_shortcut( "wxwidgets" );
127 set_program( "wxvlc" );
129 add_bool( "wx-embed", 1, NULL,
130 EMBED_TEXT, EMBED_LONGTEXT, VLC_FALSE );
131 add_deprecated_alias( "wxwin-enbed" ); /*Deprecated since 0.8.4*/
132 add_bool( "wx-bookmarks", 0, NULL,
133 BOOKMARKS_TEXT, BOOKMARKS_LONGTEXT, VLC_FALSE );
134 add_deprecated_alias( "wxwin-bookmarks" ); /*Deprecated since 0.8.4*/
135 add_bool( "wx-taskbar", 1, NULL,
136 TASKBAR_TEXT, TASKBAR_LONGTEXT, VLC_FALSE );
137 add_deprecated_alias( "wxwin-taskbar" ); /*Deprecated since 0.8.4*/
138 add_bool( "wx-extended", 0, NULL,
139 EXTENDED_TEXT, EXTENDED_LONGTEXT, VLC_FALSE );
140 add_bool( "wx-minimal", 0, NULL,
141 MINIMAL_TEXT, MINIMAL_LONGTEXT, VLC_TRUE );
142 add_deprecated_alias( "wxwin-minimal" ); /*Deprecated since 0.8.4*/
143 add_bool( "wx-autosize", 1, NULL,
144 SIZE_TO_VIDEO_TEXT, SIZE_TO_VIDEO_LONGTEXT, VLC_TRUE );
145 add_deprecated_alias( "wxwin-autosize" ); /*Deprecated since 0.8.4*/
146 add_integer( "wx-playlist-view", 0, NULL, PLAYLIST_TEXT, PLAYLIST_LONGTEXT,
148 change_integer_list( pi_playlist_views, psz_playlist_views, 0 );
149 /* wxCocoa pretends to support this, but at least 2.6.x doesn't */
151 #ifdef wxHAS_TASK_BAR_ICON
152 add_bool( "wx-systray", 0, NULL,
153 SYSTRAY_TEXT, SYSTRAY_LONGTEXT, VLC_FALSE );
154 add_deprecated_alias( "wxwin-systray" ); /*Deprecated since 0.8.4*/
157 add_bool( "wx-labels", 0, NULL, LABEL_TEXT, LABEL_LONGTEXT, VLC_TRUE);
158 add_string( "wx-config-last", NULL, NULL,
159 N_("last config"), N_("last config"), VLC_TRUE );
162 add_deprecated_alias( "wxwin-config-last" ); /*Deprecated since 0.8.4*/
165 set_description( _("wxWidgets dialogs provider") );
166 set_capability( "dialogs provider", 50 );
167 set_callbacks( OpenDialogs, Close );
170 linked_with_a_crap_library_which_uses_atexit();
174 /*****************************************************************************
175 * Open: initialize and create window
176 *****************************************************************************/
177 static int Open( vlc_object_t *p_this )
179 intf_thread_t *p_intf = (intf_thread_t *)p_this;
180 /* Test in we have an X*/
181 #if defined HAVE_GETENV && (defined __WXGTK__ || defined __WXX11)
182 if( !getenv( "DISPLAY" ) )
184 msg_Err( p_intf, "no X server");
188 /* Allocate instance and initialize some members */
189 p_intf->p_sys = (intf_sys_t *)malloc( sizeof( intf_sys_t ) );
190 if( p_intf->p_sys == NULL )
192 msg_Err( p_intf, "out of memory" );
195 memset( p_intf->p_sys, 0, sizeof( intf_sys_t ) );
197 p_intf->pf_run = Run;
199 p_intf->p_sys->p_sub = msg_Subscribe( p_intf, MSG_QUEUE_NORMAL );
201 /* Initialize wxWidgets thread */
202 p_intf->p_sys->b_playing = 0;
204 p_intf->p_sys->p_input = NULL;
205 p_intf->p_sys->i_playing = -1;
207 p_intf->p_sys->p_popup_menu = NULL;
208 p_intf->p_sys->p_video_window = NULL;
210 p_intf->pf_show_dialog = NULL;
212 /* We support play on start */
213 p_intf->b_play = VLC_TRUE;
215 p_intf->p_sys->b_video_autosize =
216 config_GetInt( p_intf, "wx-autosize" );
221 static int OpenDialogs( vlc_object_t *p_this )
223 intf_thread_t *p_intf = (intf_thread_t *)p_this;
224 int i_ret = Open( p_this );
226 p_intf->pf_show_dialog = ShowDialog;
231 /*****************************************************************************
232 * Close: destroy interface window
233 *****************************************************************************/
234 static void Close( vlc_object_t *p_this )
236 intf_thread_t *p_intf = (intf_thread_t *)p_this;
238 vlc_mutex_lock( &p_intf->object_lock );
239 p_intf->b_dead = VLC_TRUE;
240 vlc_mutex_unlock( &p_intf->object_lock );
242 if( p_intf->pf_show_dialog )
244 /* We must destroy the dialogs thread */
245 wxCommandEvent event( wxEVT_DIALOG, INTF_DIALOG_EXIT );
246 p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
247 vlc_thread_join( p_intf );
250 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
253 delete p_intf->p_sys->p_window_settings;
255 #if (wxCHECK_VERSION(2,5,0))
256 wxClassInfo::sm_classTable = (wxHashTable*)wxClassInfo_sm_classTable_BUGGY;
259 /* Destroy structure */
260 free( p_intf->p_sys );
263 /*****************************************************************************
264 * Run: wxWidgets thread
265 *****************************************************************************/
267 //when is this called?
268 #if !defined(__BUILTIN__) && defined( WIN32 )
269 HINSTANCE hInstance = 0;
270 extern "C" BOOL WINAPI
271 DllMain (HANDLE hModule, DWORD fdwReason, LPVOID lpReserved)
273 hInstance = (HINSTANCE)hModule;
278 static void Run( intf_thread_t *p_intf )
280 if( p_intf->pf_show_dialog )
282 /* The module is used in dialog provider mode */
284 /* Create a new thread for wxWidgets */
285 if( vlc_thread_create( p_intf, "Skins Dialogs Thread",
286 Init, 0, VLC_TRUE ) )
288 msg_Err( p_intf, "cannot create Skins Dialogs Thread" );
289 p_intf->pf_show_dialog = NULL;
294 /* The module is used in interface mode */
299 static void Init( intf_thread_t *p_intf )
301 #if !defined( WIN32 )
302 static char *p_args[] = { "" };
306 /* Hack to pass the p_intf pointer to the new wxWidgets Instance object */
308 wxApp::SetInstance( new Instance( p_intf ) );
310 wxTheApp = new Instance( p_intf );
314 #if !defined(__BUILTIN__)
316 //because no one knows when DllMain is called
317 if (hInstance == NULL)
318 hInstance = GetModuleHandle(NULL);
320 wxEntry( hInstance/*GetModuleHandle(NULL)*/, NULL, NULL, SW_SHOW );
322 wxEntry( GetModuleHandle(NULL), NULL, NULL, SW_SHOW );
325 wxEntry( i_args, p_args );
329 /* following functions are local */
331 /*****************************************************************************
333 *****************************************************************************/
334 Instance::Instance( )
338 Instance::Instance( intf_thread_t *_p_intf )
344 IMPLEMENT_APP_NO_MAIN(Instance)
346 /*****************************************************************************
347 * Instance::OnInit: the parent interface execution starts here
348 *****************************************************************************
349 * This is the "main program" equivalent, the program execution will
351 *****************************************************************************/
352 bool Instance::OnInit()
354 /* Initialization of i18n stuff.
355 * Usefull for things we don't have any control over, like wxWidgets
356 * provided facilities (eg. open file dialog) */
357 locale.Init( wxLANGUAGE_DEFAULT, wxLOCALE_LOAD_DEFAULT );
359 /* Load saved window settings */
360 p_intf->p_sys->p_window_settings = new WindowSettings( p_intf );
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 */
366 if( !p_intf->pf_show_dialog )
368 /* The module is used in interface mode */
369 long style = wxDEFAULT_FRAME_STYLE;
370 if ( ! config_GetInt( p_intf, "wx-taskbar" ) )
372 style = wxDEFAULT_FRAME_STYLE|wxFRAME_NO_TASKBAR;
375 Interface *MainInterface = new Interface( p_intf, style );
376 p_intf->p_sys->p_wxwindow = MainInterface;
378 /* Show the interface */
379 MainInterface->Show( TRUE );
380 SetTopWindow( MainInterface );
381 MainInterface->Raise();
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 );
389 p_intf->p_sys->pf_show_dialog = ShowDialog;
391 /* OK, initialization is over */
392 vlc_thread_ready( p_intf );
394 /* Check if we need to start playing */
395 if( !p_intf->pf_show_dialog && p_intf->b_play )
397 playlist_t *p_playlist =
398 (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
402 playlist_Control( p_playlist, PLAYLIST_AUTOPLAY, VLC_FALSE );
403 vlc_object_release( p_playlist );
407 /* Return TRUE to tell program to continue (FALSE would terminate) */
411 /*****************************************************************************
412 * Instance::OnExit: called when the interface execution stops
413 *****************************************************************************/
414 int Instance::OnExit()
416 if( p_intf->pf_show_dialog )
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;
422 #if (wxCHECK_VERSION(2,5,0))
423 wxClassInfo_sm_classTable_BUGGY = wxClassInfo::sm_classTable;
424 wxClassInfo::sm_classTable = 0;
430 static void ShowDialog( intf_thread_t *p_intf, int i_dialog_event, int i_arg,
431 intf_dialog_args_t *p_arg )
433 wxCommandEvent event( wxEVT_DIALOG, i_dialog_event );
434 event.SetInt( i_arg );
435 event.SetClientData( p_arg );
438 SendMessage( (HWND)p_intf->p_sys->p_wxwindow->GetHandle(),
439 WM_CANCELMODE, 0, 0 );
441 if( i_dialog_event == INTF_DIALOG_POPUPMENU && i_arg == 0 ) return;
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 )
448 p_intf->p_sys->p_wxwindow->AddPendingEvent( event );
452 /*****************************************************************************
453 * WindowSettings utility class
454 *****************************************************************************/
455 WindowSettings::WindowSettings( intf_thread_t *_p_intf )
457 char *psz_org = NULL;
465 for( i = 0; i < ID_MAX; i++ )
469 position[i] = wxDefaultPosition;
470 size[i] = wxDefaultSize;
472 b_shown[ID_MAIN] = true;
474 if( p_intf->pf_show_dialog ) return;
476 /* Parse the configuration */
477 psz_org = psz = config_GetPsz( p_intf, "wx-config-last" );
478 if( !psz || *psz == '\0' ) return;
480 msg_Dbg( p_intf, "Using last windows config '%s'", psz );
488 psz = strchr( psz, '(' );
494 id = strtol( psz, &psz, 0 );
495 if( *psz != ',' ) /* broken cfg */
501 for( i = 0; i < 4; i++ )
503 v[i] = strtol( psz, &psz, 0 );
521 if( id == ID_SCREEN )
526 else if( id >= 0 && id < ID_MAX )
530 position[id] = wxPoint( v[0], v[1] );
531 size[id] = wxSize( v[2], v[3] );
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 );
538 psz = strchr( psz, ')' );
542 if( i_screen_w <= 0 || i_screen_h <= 0 )
547 for( i = 0; i < ID_MAX; i++ )
551 if( position[i].x < 0 || position[i].y < 0 )
555 if( i != ID_SMALL_PLAYLIST && (size[i].x <= 0 || size[i].y <= 0) )
561 if( psz_org ) free( psz_org );
565 msg_Dbg( p_intf, "last windows config is invalid (ignored)" );
566 for( i = 0; i < ID_MAX; i++ )
570 position[i] = wxDefaultPosition;
571 size[i] = wxDefaultSize;
573 if( psz_org ) free( psz_org );
577 WindowSettings::~WindowSettings( )
581 if( p_intf->pf_show_dialog ) return;
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++ )
588 if( !b_valid[i] || !b_shown[i] )
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 );
596 config_PutPsz( p_intf, "wx-config-last", sCfg.mb_str(wxConvUTF8) );
599 void WindowSettings::SetScreen( int i_screen_w, int i_screen_h )
603 for( i = 0; i < ID_MAX; i++ )
607 if( position[i].x >= i_screen_w || position[i].y >= i_screen_h )
613 for( i = 0; i < ID_MAX; i++ )
617 position[i] = wxDefaultPosition;
618 size[i] = wxDefaultSize;
622 void WindowSettings::SetSettings( int id, bool _b_shown, wxPoint p, wxSize s )
624 if( id < 0 || id >= ID_MAX )
628 b_shown[id] = _b_shown;
634 bool WindowSettings::GetSettings( int id, bool& _b_shown, wxPoint& p, wxSize& s)
636 if( id < 0 || id >= ID_MAX )
642 _b_shown = b_shown[id];