1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2003 the VideoLAN team
7 * Authors: Cyril Deguet <asmax@via.ecp.fr>
8 * Olivier Teulière <ipkiss@via.ecp.fr>
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.
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.
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 *****************************************************************************/
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
31 #include <vlc_input.h>
32 #include <vlc_demux.h>
33 #include <vlc_playlist.h>
34 #include <vlc_window.h>
36 #include "dialogs.hpp"
37 #include "os_factory.hpp"
38 #include "os_loop.hpp"
39 #include "var_manager.hpp"
40 #include "vlcproc.hpp"
41 #include "theme_loader.hpp"
43 #include "theme_repository.hpp"
44 #include "../parser/interpreter.hpp"
45 #include "../commands/async_queue.hpp"
46 #include "../commands/cmd_quit.hpp"
47 #include "../commands/cmd_dialogs.hpp"
48 #include "../commands/cmd_minimize.hpp"
50 //---------------------------------------------------------------------------
51 // Exported interface functions.
52 //---------------------------------------------------------------------------
54 extern "C" __declspec( dllexport )
55 int __VLC_SYMBOL( vlc_entry ) ( module_t *p_module );
59 //---------------------------------------------------------------------------
61 //---------------------------------------------------------------------------
62 static int Open ( vlc_object_t * );
63 static void Close ( vlc_object_t * );
64 static void Run ( intf_thread_t * );
66 static int DemuxOpen( vlc_object_t * );
67 static int Demux( demux_t * );
68 static int DemuxControl( demux_t *, int, va_list );
70 //---------------------------------------------------------------------------
71 // Prototypes for configuration callbacks
72 //---------------------------------------------------------------------------
73 static int onSystrayChange( vlc_object_t *pObj, const char *pVariable,
74 vlc_value_t oldVal, vlc_value_t newVal,
76 static int onTaskBarChange( vlc_object_t *pObj, const char *pVariable,
77 vlc_value_t oldVal, vlc_value_t newVal,
81 //---------------------------------------------------------------------------
82 // Open: initialize interface
83 //---------------------------------------------------------------------------
84 static int Open( vlc_object_t *p_this )
86 intf_thread_t *p_intf = (intf_thread_t *)p_this;
88 // Allocate instance and initialize some members
89 p_intf->p_sys = (intf_sys_t *) malloc( sizeof( intf_sys_t ) );
90 if( p_intf->p_sys == NULL )
92 msg_Err( p_intf, "out of memory" );
98 // Suscribe to messages bank
99 p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
101 p_intf->p_sys->p_input = NULL;
102 p_intf->p_sys->p_playlist = pl_Yield( p_intf );
104 // Initialize "singleton" objects
105 p_intf->p_sys->p_logger = NULL;
106 p_intf->p_sys->p_queue = NULL;
107 p_intf->p_sys->p_dialogs = NULL;
108 p_intf->p_sys->p_interpreter = NULL;
109 p_intf->p_sys->p_osFactory = NULL;
110 p_intf->p_sys->p_osLoop = NULL;
111 p_intf->p_sys->p_varManager = NULL;
112 p_intf->p_sys->p_vlcProc = NULL;
113 p_intf->p_sys->p_repository = NULL;
116 p_intf->p_sys->p_theme = NULL;
118 // Create a variable to be notified of skins to be loaded
119 var_Create( p_intf, "skin-to-load", VLC_VAR_STRING );
121 // Initialize singletons
122 if( OSFactory::instance( p_intf ) == NULL )
124 msg_Err( p_intf, "cannot initialize OSFactory" );
125 vlc_object_release( p_intf->p_sys->p_playlist );
126 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
129 if( AsyncQueue::instance( p_intf ) == NULL )
131 msg_Err( p_intf, "cannot initialize AsyncQueue" );
132 vlc_object_release( p_intf->p_sys->p_playlist );
133 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
136 if( Interpreter::instance( p_intf ) == NULL )
138 msg_Err( p_intf, "cannot instanciate Interpreter" );
139 vlc_object_release( p_intf->p_sys->p_playlist );
140 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
143 if( VarManager::instance( p_intf ) == NULL )
145 msg_Err( p_intf, "cannot instanciate VarManager" );
146 vlc_object_release( p_intf->p_sys->p_playlist );
147 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
150 if( VlcProc::instance( p_intf ) == NULL )
152 msg_Err( p_intf, "cannot initialize VLCProc" );
153 vlc_object_release( p_intf->p_sys->p_playlist );
154 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
157 Dialogs::instance( p_intf );
158 ThemeRepository::instance( p_intf );
160 return( VLC_SUCCESS );
163 //---------------------------------------------------------------------------
164 // Close: destroy interface
165 //---------------------------------------------------------------------------
166 static void Close( vlc_object_t *p_this )
168 intf_thread_t *p_intf = (intf_thread_t *)p_this;
170 // Destroy "singleton" objects
171 OSFactory::instance( p_intf )->destroyOSLoop();
172 ThemeRepository::destroy( p_intf );
173 Dialogs::destroy( p_intf );
174 Interpreter::destroy( p_intf );
175 AsyncQueue::destroy( p_intf );
176 VarManager::destroy( p_intf );
177 VlcProc::destroy( p_intf );
178 OSFactory::destroy( p_intf );
180 if( p_intf->p_sys->p_playlist )
182 vlc_object_release( p_intf->p_sys->p_playlist );
185 // Unsubscribe from messages bank
186 msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
189 free( p_intf->p_sys );
193 //---------------------------------------------------------------------------
195 //---------------------------------------------------------------------------
196 static void Run( intf_thread_t *p_intf )
199 ThemeLoader *pLoader = new ThemeLoader( p_intf );
200 char *skin_last = config_GetPsz( p_intf, "skins2-last" );
202 if( !skin_last || !*skin_last || !pLoader->load( skin_last ) )
204 // Get the resource path and try to load the default skin
205 OSFactory *pOSFactory = OSFactory::instance( p_intf );
206 const list<string> &resPath = pOSFactory->getResourcePath();
207 const string &sep = pOSFactory->getDirSeparator();
209 list<string>::const_iterator it;
210 for( it = resPath.begin(); it != resPath.end(); it++ )
212 string path = (*it) + sep + "default.vlt";
213 if( pLoader->load( path ) )
215 // Theme loaded successfully
219 if( it == resPath.end() )
221 // Last chance: the user can select a new theme file
222 if( Dialogs::instance( p_intf ) )
224 CmdDlgChangeSkin *pCmd = new CmdDlgChangeSkin( p_intf );
225 AsyncQueue *pQueue = AsyncQueue::instance( p_intf );
226 pQueue->push( CmdGenericPtr( pCmd ) );
230 // No dialogs provider, just quit...
231 CmdQuit *pCmd = new CmdQuit( p_intf );
232 AsyncQueue *pQueue = AsyncQueue::instance( p_intf );
233 pQueue->push( CmdGenericPtr( pCmd ) );
235 "cannot show the \"open skin\" dialog: exiting...");
243 // Get the instance of OSLoop
244 OSLoop *loop = OSFactory::instance( p_intf )->getOSLoop();
246 // Enter the main event loop
249 // Delete the theme and save the configuration of the windows
250 if( p_intf->p_sys->p_theme )
252 p_intf->p_sys->p_theme->saveConfig();
253 delete p_intf->p_sys->p_theme;
254 p_intf->p_sys->p_theme = NULL;
259 // Callbacks for vout requests
260 static int WindowOpen( vlc_object_t *p_this )
262 vout_window_t *pWnd = (vout_window_t *)p_this;
263 intf_thread_t *pIntf = (intf_thread_t *)
264 vlc_object_find_name( p_this, "skins2", FIND_ANYWHERE );
269 /* FIXME: most probably not thread-safe,
270 * albeit no worse than ever before */
271 pWnd->handle = VlcProc::getWindow( pIntf, pWnd->vout,
272 &pWnd->pos_x, &pWnd->pos_y,
273 &pWnd->width, &pWnd->height );
274 pWnd->p_private = pIntf;
275 pWnd->control = &VlcProc::controlWindow;
280 static void WindowClose( vlc_object_t *p_this )
282 vout_window_t *pWnd = (vout_window_t *)p_this;
283 intf_thread_t *pIntf = (intf_thread_t *)p_this->p_private;
285 Vlcproc::releaseWindow( pIntf, pWnd->handle );
288 //---------------------------------------------------------------------------
289 // DemuxOpen: initialize demux
290 //---------------------------------------------------------------------------
291 static int DemuxOpen( vlc_object_t *p_this )
293 demux_t *p_demux = (demux_t*)p_this;
294 intf_thread_t *p_intf;
298 p_demux->pf_demux = Demux;
299 p_demux->pf_control = DemuxControl;
301 // Test that we have a valid .vlt or .wsz file, based on the extension
302 // TODO: an actual check of the contents would be better...
303 if( ( ext = strchr( p_demux->psz_path, '.' ) ) == NULL ||
304 ( strcasecmp( ext, ".vlt" ) && strcasecmp( ext, ".wsz" ) ) )
309 p_intf = (intf_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INTF,
313 // Do nothing is skins2 is not the main interface
314 if( var_Type( p_intf, "skin-to-load" ) == VLC_VAR_STRING )
316 playlist_t *p_playlist = pl_Yield( p_this );
317 // Make sure the item is deleted afterwards
318 /// \bug does not always work
319 p_playlist->status.p_item->i_flags |= PLAYLIST_REMOVE_FLAG;
320 vlc_object_release( p_playlist );
323 val.psz_string = p_demux->psz_path;
324 var_Set( p_intf, "skin-to-load", val );
329 "skin could not be loaded (not using skins2 intf)" );
332 vlc_object_release( p_intf );
339 //---------------------------------------------------------------------------
341 //---------------------------------------------------------------------------
342 static int Demux( demux_t *p_demux )
348 //---------------------------------------------------------------------------
350 //---------------------------------------------------------------------------
351 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
353 return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
357 //---------------------------------------------------------------------------
359 //---------------------------------------------------------------------------
361 /// Callback for the systray configuration option
362 static int onSystrayChange( vlc_object_t *pObj, const char *pVariable,
363 vlc_value_t oldVal, vlc_value_t newVal,
366 intf_thread_t *pIntf =
367 (intf_thread_t*)vlc_object_find( pObj, VLC_OBJECT_INTF, FIND_ANYWHERE );
374 // Check that we found the correct interface (same check as for the demux)
375 if( var_Type( pIntf, "skin-to-load" ) == VLC_VAR_STRING )
377 AsyncQueue *pQueue = AsyncQueue::instance( pIntf );
380 CmdAddInTray *pCmd = new CmdAddInTray( pIntf );
381 pQueue->push( CmdGenericPtr( pCmd ) );
385 CmdRemoveFromTray *pCmd = new CmdRemoveFromTray( pIntf );
386 pQueue->push( CmdGenericPtr( pCmd ) );
390 vlc_object_release( pIntf );
395 /// Callback for the systray configuration option
396 static int onTaskBarChange( vlc_object_t *pObj, const char *pVariable,
397 vlc_value_t oldVal, vlc_value_t newVal,
400 intf_thread_t *pIntf =
401 (intf_thread_t*)vlc_object_find( pObj, VLC_OBJECT_INTF, FIND_ANYWHERE );
408 // Check that we found the correct interface (same check as for the demux)
409 if( var_Type( pIntf, "skin-to-load" ) == VLC_VAR_STRING )
411 AsyncQueue *pQueue = AsyncQueue::instance( pIntf );
414 CmdAddInTaskBar *pCmd = new CmdAddInTaskBar( pIntf );
415 pQueue->push( CmdGenericPtr( pCmd ) );
419 CmdRemoveFromTaskBar *pCmd = new CmdRemoveFromTaskBar( pIntf );
420 pQueue->push( CmdGenericPtr( pCmd ) );
424 vlc_object_release( pIntf );
429 //---------------------------------------------------------------------------
431 //---------------------------------------------------------------------------
432 #define SKINS2_LAST N_("Skin to use")
433 #define SKINS2_LAST_LONG N_("Path to the skin to use.")
434 #define SKINS2_CONFIG N_("Config of last used skin")
435 #define SKINS2_CONFIG_LONG N_("Windows configuration of the last skin used. " \
436 "This option is updated automatically, do not touch it." )
437 #define SKINS2_SYSTRAY N_("Systray icon")
438 #define SKINS2_SYSTRAY_LONG N_("Show a systray icon for VLC")
439 #define SKINS2_TASKBAR N_("Show VLC on the taskbar")
440 #define SKINS2_TASKBAR_LONG N_("Show VLC on the taskbar")
441 #define SKINS2_TRANSPARENCY N_("Enable transparency effects")
442 #define SKINS2_TRANSPARENCY_LONG N_("You can disable all transparency effects"\
443 " if you want. This is mainly useful when moving windows does not behave" \
445 #define SKINS2_PLAYLIST N_("Use a skinned playlist")
446 #define SKINS2_PLAYLIST_LONG N_("Use a skinned playlist")
449 set_category( CAT_INTERFACE );
450 set_subcategory( SUBCAT_INTERFACE_MAIN );
451 add_file( "skins2-last", "", NULL, SKINS2_LAST, SKINS2_LAST_LONG,
454 add_string( "skins2-config", "", NULL, SKINS2_CONFIG, SKINS2_CONFIG_LONG,
459 add_bool( "skins2-systray", false, onSystrayChange, SKINS2_SYSTRAY,
460 SKINS2_SYSTRAY_LONG, false );
461 add_bool( "skins2-taskbar", true, onTaskBarChange, SKINS2_TASKBAR,
462 SKINS2_TASKBAR_LONG, false );
463 add_bool( "skins2-transparency", false, NULL, SKINS2_TRANSPARENCY,
464 SKINS2_TRANSPARENCY_LONG, false );
467 add_bool( "skinned-playlist", true, NULL, SKINS2_PLAYLIST,
468 SKINS2_PLAYLIST_LONG, false );
469 set_shortname( N_("Skins"));
470 set_description( N_("Skinnable Interface") );
471 set_capability( "interface", 30 );
472 set_callbacks( Open, Close );
473 add_shortcut( "skins" );
476 set_capability( "vout window", 51 );
477 set_callbacks( WindowOpen, WindowClose );
480 set_description( N_("Skins loader demux") );
481 set_capability( "demux", 5 );
482 set_callbacks( DemuxOpen, NULL );