git.sesse.net Git - vlc/blob - modules/gui/skins2/src/skin_main.cpp

   1 /*****************************************************************************
   2  * skin_main.cpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  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.
  14  *
  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.
  19  *
  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  *****************************************************************************/
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  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>
  35
  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"
  42 #include "theme.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"
  49
  50 //---------------------------------------------------------------------------
  51 // Exported interface functions.
  52 //---------------------------------------------------------------------------
  53 #ifdef WIN32_SKINS
  54 extern "C" __declspec( dllexport )
  55     int __VLC_SYMBOL( vlc_entry ) ( module_t *p_module );
  56 #endif
  57
  58
  59 //---------------------------------------------------------------------------
  60 // Local prototypes
  61 //---------------------------------------------------------------------------
  62 static int  Open  ( vlc_object_t * );
  63 static void Close ( vlc_object_t * );
  64 static void Run   ( intf_thread_t * );
  65
  66 static int DemuxOpen( vlc_object_t * );
  67 static int Demux( demux_t * );
  68 static int DemuxControl( demux_t *, int, va_list );
  69
  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,
  75                             void *pParam );
  76 static int onTaskBarChange( vlc_object_t *pObj, const char *pVariable,
  77                             vlc_value_t oldVal, vlc_value_t newVal,
  78                             void *pParam );
  79
  80
  81 //---------------------------------------------------------------------------
  82 // Open: initialize interface
  83 //---------------------------------------------------------------------------
  84 static int Open( vlc_object_t *p_this )
  85 {
  86     intf_thread_t *p_intf = (intf_thread_t *)p_this;
  87
  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 )
  91     {
  92         msg_Err( p_intf, "out of memory" );
  93         return( VLC_ENOMEM );
  94     };
  95
  96     p_intf->pf_run = Run;
  97
  98     // Suscribe to messages bank
  99     p_intf->p_sys->p_sub = msg_Subscribe( p_intf );
 100
 101     p_intf->p_sys->p_input = NULL;
 102     p_intf->p_sys->p_playlist = pl_Yield( p_intf );
 103
 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;
 114
 115     // No theme yet
 116     p_intf->p_sys->p_theme = NULL;
 117
 118     // Create a variable to be notified of skins to be loaded
 119     var_Create( p_intf, "skin-to-load", VLC_VAR_STRING );
 120
 121     // Initialize singletons
 122     if( OSFactory::instance( p_intf ) == NULL )
 123     {
 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 );
 127         return VLC_EGENERIC;
 128     }
 129     if( AsyncQueue::instance( p_intf ) == NULL )
 130     {
 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 );
 134         return VLC_EGENERIC;
 135     }
 136     if( Interpreter::instance( p_intf ) == NULL )
 137     {
 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 );
 141         return VLC_EGENERIC;
 142     }
 143     if( VarManager::instance( p_intf ) == NULL )
 144     {
 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 );
 148         return VLC_EGENERIC;
 149     }
 150     if( VlcProc::instance( p_intf ) == NULL )
 151     {
 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 );
 155         return VLC_EGENERIC;
 156     }
 157     Dialogs::instance( p_intf );
 158     ThemeRepository::instance( p_intf );
 159
 160     return( VLC_SUCCESS );
 161 }
 162
 163 //---------------------------------------------------------------------------
 164 // Close: destroy interface
 165 //---------------------------------------------------------------------------
 166 static void Close( vlc_object_t *p_this )
 167 {
 168     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 169
 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 );
 179
 180     if( p_intf->p_sys->p_playlist )
 181     {
 182         vlc_object_release( p_intf->p_sys->p_playlist );
 183     }
 184
 185     // Unsubscribe from messages bank
 186     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 187
 188     // Destroy structure
 189     free( p_intf->p_sys );
 190 }
 191
 192
 193 //---------------------------------------------------------------------------
 194 // Run: main loop
 195 //---------------------------------------------------------------------------
 196 static void Run( intf_thread_t *p_intf )
 197 {
 198     int canc = vlc_savecancel();
 199     // Load a theme
 200     ThemeLoader *pLoader = new ThemeLoader( p_intf );
 201     char *skin_last = config_GetPsz( p_intf, "skins2-last" );
 202
 203     if( !skin_last || !*skin_last || !pLoader->load( skin_last ) )
 204     {
 205         // Get the resource path and try to load the default skin
 206         OSFactory *pOSFactory = OSFactory::instance( p_intf );
 207         const list<string> &resPath = pOSFactory->getResourcePath();
 208         const string &sep = pOSFactory->getDirSeparator();
 209
 210         list<string>::const_iterator it;
 211         for( it = resPath.begin(); it != resPath.end(); it++ )
 212         {
 213             string path = (*it) + sep + "default.vlt";
 214             if( pLoader->load( path ) )
 215             {
 216                 // Theme loaded successfully
 217                 break;
 218             }
 219         }
 220         if( it == resPath.end() )
 221         {
 222             // Last chance: the user can select a new theme file
 223             if( Dialogs::instance( p_intf ) )
 224             {
 225                 CmdDlgChangeSkin *pCmd = new CmdDlgChangeSkin( p_intf );
 226                 AsyncQueue *pQueue = AsyncQueue::instance( p_intf );
 227                 pQueue->push( CmdGenericPtr( pCmd ) );
 228             }
 229             else
 230             {
 231                 // No dialogs provider, just quit...
 232                 CmdQuit *pCmd = new CmdQuit( p_intf );
 233                 AsyncQueue *pQueue = AsyncQueue::instance( p_intf );
 234                 pQueue->push( CmdGenericPtr( pCmd ) );
 235                 msg_Err( p_intf,
 236                          "cannot show the \"open skin\" dialog: exiting...");
 237             }
 238         }
 239     }
 240     delete pLoader;
 241
 242     free( skin_last );
 243
 244     // Get the instance of OSLoop
 245     OSLoop *loop = OSFactory::instance( p_intf )->getOSLoop();
 246
 247     // Enter the main event loop
 248     loop->run();
 249
 250     // Delete the theme and save the configuration of the windows
 251     if( p_intf->p_sys->p_theme )
 252     {
 253         p_intf->p_sys->p_theme->saveConfig();
 254         delete p_intf->p_sys->p_theme;
 255         p_intf->p_sys->p_theme = NULL;
 256     }
 257     vlc_restorecancel(canc);
 258 }
 259
 260
 261 // Callbacks for vout requests
 262 static int WindowOpen( vlc_object_t *p_this )
 263 {
 264     vout_window_t *pWnd = (vout_window_t *)p_this;
 265     intf_thread_t *pIntf = (intf_thread_t *)
 266         vlc_object_find_name( p_this, "skins2", FIND_ANYWHERE );
 267
 268     if( pIntf == NULL )
 269         return VLC_EGENERIC;
 270
 271     /* FIXME: most probably not thread-safe,
 272      * albeit no worse than ever before */
 273     pWnd->handle = VlcProc::getWindow( pIntf, pWnd->vout,
 274                                        &pWnd->pos_x, &pWnd->pos_y,
 275                                        &pWnd->width, &pWnd->height );
 276     pWnd->p_private = pIntf;
 277     pWnd->control = &VlcProc::controlWindow;
 278     return VLC_SUCCESS;
 279 }
 280
 281
 282 static void WindowClose( vlc_object_t *p_this )
 283 {
 284     vout_window_t *pWnd = (vout_window_t *)p_this;
 285     intf_thread_t *pIntf = (intf_thread_t *)p_this->p_private;
 286
 287     VlcProc::releaseWindow( pIntf, pWnd->handle );
 288 }
 289
 290 //---------------------------------------------------------------------------
 291 // DemuxOpen: initialize demux
 292 //---------------------------------------------------------------------------
 293 static int DemuxOpen( vlc_object_t *p_this )
 294 {
 295     demux_t *p_demux = (demux_t*)p_this;
 296     intf_thread_t *p_intf;
 297     char *ext;
 298
 299     // Needed callbacks
 300     p_demux->pf_demux   = Demux;
 301     p_demux->pf_control = DemuxControl;
 302
 303     // Test that we have a valid .vlt or .wsz file, based on the extension
 304     // TODO: an actual check of the contents would be better...
 305     if( ( ext = strchr( p_demux->psz_path, '.' ) ) == NULL ||
 306         ( strcasecmp( ext, ".vlt" ) && strcasecmp( ext, ".wsz" ) ) )
 307     {
 308         return VLC_EGENERIC;
 309     }
 310
 311     p_intf = (intf_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INTF,
 312                                                FIND_ANYWHERE );
 313     if( p_intf != NULL )
 314     {
 315         // Do nothing is skins2 is not the main interface
 316         if( var_Type( p_intf, "skin-to-load" ) == VLC_VAR_STRING )
 317         {
 318             playlist_t *p_playlist = pl_Yield( p_this );
 319             // Make sure the item is deleted afterwards
 320             /// \bug does not always work
 321             p_playlist->status.p_item->i_flags |= PLAYLIST_REMOVE_FLAG;
 322             vlc_object_release( p_playlist );
 323
 324             vlc_value_t val;
 325             val.psz_string = p_demux->psz_path;
 326             var_Set( p_intf, "skin-to-load", val );
 327         }
 328         else
 329         {
 330             msg_Warn( p_this,
 331                       "skin could not be loaded (not using skins2 intf)" );
 332         }
 333
 334         vlc_object_release( p_intf );
 335     }
 336
 337     return VLC_SUCCESS;
 338 }
 339
 340
 341 //---------------------------------------------------------------------------
 342 // Demux: return EOF
 343 //---------------------------------------------------------------------------
 344 static int Demux( demux_t *p_demux )
 345 {
 346     return 0;
 347 }
 348
 349
 350 //---------------------------------------------------------------------------
 351 // DemuxControl
 352 //---------------------------------------------------------------------------
 353 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 354 {
 355     return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 356 }
 357
 358
 359 //---------------------------------------------------------------------------
 360 // Callbacks
 361 //---------------------------------------------------------------------------
 362
 363 /// Callback for the systray configuration option
 364 static int onSystrayChange( vlc_object_t *pObj, const char *pVariable,
 365                             vlc_value_t oldVal, vlc_value_t newVal,
 366                             void *pParam )
 367 {
 368     intf_thread_t *pIntf =
 369         (intf_thread_t*)vlc_object_find( pObj, VLC_OBJECT_INTF, FIND_ANYWHERE );
 370
 371     if( pIntf == NULL )
 372     {
 373         return VLC_EGENERIC;
 374     }
 375
 376     // Check that we found the correct interface (same check as for the demux)
 377     if( var_Type( pIntf, "skin-to-load" ) == VLC_VAR_STRING )
 378     {
 379         AsyncQueue *pQueue = AsyncQueue::instance( pIntf );
 380         if( newVal.b_bool )
 381         {
 382             CmdAddInTray *pCmd = new CmdAddInTray( pIntf );
 383             pQueue->push( CmdGenericPtr( pCmd ) );
 384         }
 385         else
 386         {
 387             CmdRemoveFromTray *pCmd = new CmdRemoveFromTray( pIntf );
 388             pQueue->push( CmdGenericPtr( pCmd ) );
 389         }
 390     }
 391
 392     vlc_object_release( pIntf );
 393     return VLC_SUCCESS;
 394 }
 395
 396
 397 /// Callback for the systray configuration option
 398 static int onTaskBarChange( vlc_object_t *pObj, const char *pVariable,
 399                             vlc_value_t oldVal, vlc_value_t newVal,
 400                             void *pParam )
 401 {
 402     intf_thread_t *pIntf =
 403         (intf_thread_t*)vlc_object_find( pObj, VLC_OBJECT_INTF, FIND_ANYWHERE );
 404
 405     if( pIntf == NULL )
 406     {
 407         return VLC_EGENERIC;
 408     }
 409
 410     // Check that we found the correct interface (same check as for the demux)
 411     if( var_Type( pIntf, "skin-to-load" ) == VLC_VAR_STRING )
 412     {
 413         AsyncQueue *pQueue = AsyncQueue::instance( pIntf );
 414         if( newVal.b_bool )
 415         {
 416             CmdAddInTaskBar *pCmd = new CmdAddInTaskBar( pIntf );
 417             pQueue->push( CmdGenericPtr( pCmd ) );
 418         }
 419         else
 420         {
 421             CmdRemoveFromTaskBar *pCmd = new CmdRemoveFromTaskBar( pIntf );
 422             pQueue->push( CmdGenericPtr( pCmd ) );
 423         }
 424     }
 425
 426     vlc_object_release( pIntf );
 427     return VLC_SUCCESS;
 428 }
 429
 430
 431 //---------------------------------------------------------------------------
 432 // Module descriptor
 433 //---------------------------------------------------------------------------
 434 #define SKINS2_LAST      N_("Skin to use")
 435 #define SKINS2_LAST_LONG N_("Path to the skin to use.")
 436 #define SKINS2_CONFIG      N_("Config of last used skin")
 437 #define SKINS2_CONFIG_LONG N_("Windows configuration of the last skin used. " \
 438         "This option is updated automatically, do not touch it." )
 439 #define SKINS2_SYSTRAY      N_("Systray icon")
 440 #define SKINS2_SYSTRAY_LONG N_("Show a systray icon for VLC")
 441 #define SKINS2_TASKBAR      N_("Show VLC on the taskbar")
 442 #define SKINS2_TASKBAR_LONG N_("Show VLC on the taskbar")
 443 #define SKINS2_TRANSPARENCY      N_("Enable transparency effects")
 444 #define SKINS2_TRANSPARENCY_LONG N_("You can disable all transparency effects"\
 445     " if you want. This is mainly useful when moving windows does not behave" \
 446     " correctly.")
 447 #define SKINS2_PLAYLIST N_("Use a skinned playlist")
 448 #define SKINS2_PLAYLIST_LONG N_("Use a skinned playlist")
 449
 450 vlc_module_begin();
 451     set_category( CAT_INTERFACE );
 452     set_subcategory( SUBCAT_INTERFACE_MAIN );
 453     add_file( "skins2-last", "", NULL, SKINS2_LAST, SKINS2_LAST_LONG,
 454               true );
 455         change_autosave();
 456     add_string( "skins2-config", "", NULL, SKINS2_CONFIG, SKINS2_CONFIG_LONG,
 457                 true );
 458         change_autosave();
 459         change_internal();
 460 #ifdef WIN32
 461     add_bool( "skins2-systray", false, onSystrayChange, SKINS2_SYSTRAY,
 462               SKINS2_SYSTRAY_LONG, false );
 463     add_bool( "skins2-taskbar", true, onTaskBarChange, SKINS2_TASKBAR,
 464               SKINS2_TASKBAR_LONG, false );
 465     add_bool( "skins2-transparency", false, NULL, SKINS2_TRANSPARENCY,
 466               SKINS2_TRANSPARENCY_LONG, false );
 467 #endif
 468
 469     add_bool( "skinned-playlist", true, NULL, SKINS2_PLAYLIST,
 470               SKINS2_PLAYLIST_LONG, false );
 471     set_shortname( N_("Skins"));
 472     set_description( N_("Skinnable Interface") );
 473     set_capability( "interface", 30 );
 474     set_callbacks( Open, Close );
 475     add_shortcut( "skins" );
 476
 477     add_submodule();
 478         set_capability( "vout window", 51 );
 479         set_callbacks( WindowOpen, WindowClose );
 480
 481     add_submodule();
 482         set_description( N_("Skins loader demux") );
 483         set_capability( "demux", 5 );
 484         set_callbacks( DemuxOpen, NULL );
 485
 486 vlc_module_end();