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/vlc.h>
  30 #include <vlc_plugin.h>
  31 #include <vlc_input.h>
  32 #include <vlc_demux.h>
  33 #include <vlc_playlist.h>
  34
  35 #include "dialogs.hpp"
  36 #include "os_factory.hpp"
  37 #include "os_loop.hpp"
  38 #include "var_manager.hpp"
  39 #include "vlcproc.hpp"
  40 #include "theme_loader.hpp"
  41 #include "theme.hpp"
  42 #include "theme_repository.hpp"
  43 #include "../parser/interpreter.hpp"
  44 #include "../commands/async_queue.hpp"
  45 #include "../commands/cmd_quit.hpp"
  46 #include "../commands/cmd_dialogs.hpp"
  47 #include "../commands/cmd_minimize.hpp"
  48
  49 //---------------------------------------------------------------------------
  50 // Exported interface functions.
  51 //---------------------------------------------------------------------------
  52 #ifdef WIN32_SKINS
  53 extern "C" __declspec( dllexport )
  54     int __VLC_SYMBOL( vlc_entry ) ( module_t *p_module );
  55 #endif
  56
  57
  58 //---------------------------------------------------------------------------
  59 // Local prototypes
  60 //---------------------------------------------------------------------------
  61 static int  Open  ( vlc_object_t * );
  62 static void Close ( vlc_object_t * );
  63 static void Run   ( intf_thread_t * );
  64
  65 static int DemuxOpen( vlc_object_t * );
  66 static int Demux( demux_t * );
  67 static int DemuxControl( demux_t *, int, va_list );
  68
  69 //---------------------------------------------------------------------------
  70 // Prototypes for configuration callbacks
  71 //---------------------------------------------------------------------------
  72 static int onSystrayChange( vlc_object_t *pObj, const char *pVariable,
  73                             vlc_value_t oldVal, vlc_value_t newVal,
  74                             void *pParam );
  75 static int onTaskBarChange( vlc_object_t *pObj, const char *pVariable,
  76                             vlc_value_t oldVal, vlc_value_t newVal,
  77                             void *pParam );
  78
  79
  80 //---------------------------------------------------------------------------
  81 // Open: initialize interface
  82 //---------------------------------------------------------------------------
  83 static int Open( vlc_object_t *p_this )
  84 {
  85     intf_thread_t *p_intf = (intf_thread_t *)p_this;
  86
  87     // Allocate instance and initialize some members
  88     p_intf->p_sys = (intf_sys_t *) malloc( sizeof( intf_sys_t ) );
  89     if( p_intf->p_sys == NULL )
  90     {
  91         msg_Err( p_intf, "out of memory" );
  92         return( VLC_ENOMEM );
  93     };
  94
  95     p_intf->pf_run = Run;
  96
  97     // Suscribe to messages bank
  98     p_intf->p_sys->p_sub = msg_Subscribe( p_intf, MSG_QUEUE_NORMAL );
  99
 100     p_intf->p_sys->p_input = NULL;
 101     p_intf->p_sys->p_playlist = (playlist_t *)vlc_object_find( p_intf,
 102         VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 103     if( p_intf->p_sys->p_playlist == NULL )
 104     {
 105         msg_Err( p_intf, "No playlist object found" );
 106         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 107         return VLC_EGENERIC;
 108     }
 109
 110     // Initialize "singleton" objects
 111     p_intf->p_sys->p_logger = NULL;
 112     p_intf->p_sys->p_queue = NULL;
 113     p_intf->p_sys->p_dialogs = NULL;
 114     p_intf->p_sys->p_interpreter = NULL;
 115     p_intf->p_sys->p_osFactory = NULL;
 116     p_intf->p_sys->p_osLoop = NULL;
 117     p_intf->p_sys->p_varManager = NULL;
 118     p_intf->p_sys->p_vlcProc = NULL;
 119     p_intf->p_sys->p_repository = NULL;
 120
 121     // No theme yet
 122     p_intf->p_sys->p_theme = NULL;
 123
 124     // Create a variable to be notified of skins to be loaded
 125     var_Create( p_intf, "skin-to-load", VLC_VAR_STRING );
 126
 127     // Initialize singletons
 128     if( OSFactory::instance( p_intf ) == NULL )
 129     {
 130         msg_Err( p_intf, "cannot initialize OSFactory" );
 131         vlc_object_release( p_intf->p_sys->p_playlist );
 132         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 133         return VLC_EGENERIC;
 134     }
 135     if( AsyncQueue::instance( p_intf ) == NULL )
 136     {
 137         msg_Err( p_intf, "cannot initialize AsyncQueue" );
 138         vlc_object_release( p_intf->p_sys->p_playlist );
 139         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 140         return VLC_EGENERIC;
 141     }
 142     if( Interpreter::instance( p_intf ) == NULL )
 143     {
 144         msg_Err( p_intf, "cannot instanciate Interpreter" );
 145         vlc_object_release( p_intf->p_sys->p_playlist );
 146         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 147         return VLC_EGENERIC;
 148     }
 149     if( VarManager::instance( p_intf ) == NULL )
 150     {
 151         msg_Err( p_intf, "cannot instanciate VarManager" );
 152         vlc_object_release( p_intf->p_sys->p_playlist );
 153         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 154         return VLC_EGENERIC;
 155     }
 156     if( VlcProc::instance( p_intf ) == NULL )
 157     {
 158         msg_Err( p_intf, "cannot initialize VLCProc" );
 159         vlc_object_release( p_intf->p_sys->p_playlist );
 160         msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 161         return VLC_EGENERIC;
 162     }
 163     Dialogs::instance( p_intf );
 164     ThemeRepository::instance( p_intf );
 165
 166     // We support play on start
 167     p_intf->b_play = true;
 168
 169     return( VLC_SUCCESS );
 170 }
 171
 172 //---------------------------------------------------------------------------
 173 // Close: destroy interface
 174 //---------------------------------------------------------------------------
 175 static void Close( vlc_object_t *p_this )
 176 {
 177     intf_thread_t *p_intf = (intf_thread_t *)p_this;
 178
 179     // Destroy "singleton" objects
 180     OSFactory::instance( p_intf )->destroyOSLoop();
 181     ThemeRepository::destroy( p_intf );
 182     Dialogs::destroy( p_intf );
 183     Interpreter::destroy( p_intf );
 184     AsyncQueue::destroy( p_intf );
 185     VarManager::destroy( p_intf );
 186     VlcProc::destroy( p_intf );
 187     OSFactory::destroy( p_intf );
 188
 189     if( p_intf->p_sys->p_playlist )
 190     {
 191         vlc_object_release( p_intf->p_sys->p_playlist );
 192     }
 193
 194     // Unsubscribe from messages bank
 195     msg_Unsubscribe( p_intf, p_intf->p_sys->p_sub );
 196
 197     // Destroy structure
 198     free( p_intf->p_sys );
 199 }
 200
 201
 202 //---------------------------------------------------------------------------
 203 // Run: main loop
 204 //---------------------------------------------------------------------------
 205 static void Run( intf_thread_t *p_intf )
 206 {
 207     // Load a theme
 208     ThemeLoader *pLoader = new ThemeLoader( p_intf );
 209     char *skin_last = config_GetPsz( p_intf, "skins2-last" );
 210
 211     if( !skin_last || !*skin_last || !pLoader->load( skin_last ) )
 212     {
 213         // Get the resource path and try to load the default skin
 214         OSFactory *pOSFactory = OSFactory::instance( p_intf );
 215         const list<string> &resPath = pOSFactory->getResourcePath();
 216         const string &sep = pOSFactory->getDirSeparator();
 217
 218         list<string>::const_iterator it;
 219         for( it = resPath.begin(); it != resPath.end(); it++ )
 220         {
 221             string path = (*it) + sep + "default.vlt";
 222             if( pLoader->load( path ) )
 223             {
 224                 // Theme loaded successfully
 225                 break;
 226             }
 227         }
 228         if( it == resPath.end() )
 229         {
 230             // Last chance: the user can select a new theme file
 231             if( Dialogs::instance( p_intf ) )
 232             {
 233                 CmdDlgChangeSkin *pCmd = new CmdDlgChangeSkin( p_intf );
 234                 AsyncQueue *pQueue = AsyncQueue::instance( p_intf );
 235                 pQueue->push( CmdGenericPtr( pCmd ) );
 236             }
 237             else
 238             {
 239                 // No dialogs provider, just quit...
 240                 CmdQuit *pCmd = new CmdQuit( p_intf );
 241                 AsyncQueue *pQueue = AsyncQueue::instance( p_intf );
 242                 pQueue->push( CmdGenericPtr( pCmd ) );
 243                 msg_Err( p_intf,
 244                          "cannot show the \"open skin\" dialog: exiting...");
 245             }
 246         }
 247     }
 248     delete pLoader;
 249
 250     free( skin_last );
 251
 252     // Get the instance of OSLoop
 253     OSLoop *loop = OSFactory::instance( p_intf )->getOSLoop();
 254
 255     // Check if we need to start playing
 256     if( p_intf->b_play )
 257     {
 258         playlist_t *p_playlist =
 259             (playlist_t *)vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 260                                            FIND_ANYWHERE );
 261         if( p_playlist )
 262         {
 263             playlist_Control( p_playlist, PLAYLIST_PLAY, false );
 264             vlc_object_release( p_playlist );
 265         }
 266     }
 267
 268     // Enter the main event loop
 269     loop->run();
 270
 271     // Delete the theme and save the configuration of the windows
 272     if( p_intf->p_sys->p_theme )
 273     {
 274         p_intf->p_sys->p_theme->saveConfig();
 275         delete p_intf->p_sys->p_theme;
 276         p_intf->p_sys->p_theme = NULL;
 277     }
 278 }
 279
 280
 281 //---------------------------------------------------------------------------
 282 // DemuxOpen: initialize demux
 283 //---------------------------------------------------------------------------
 284 static int DemuxOpen( vlc_object_t *p_this )
 285 {
 286     demux_t *p_demux = (demux_t*)p_this;
 287     intf_thread_t *p_intf;
 288     char *ext;
 289
 290     // Needed callbacks
 291     p_demux->pf_demux   = Demux;
 292     p_demux->pf_control = DemuxControl;
 293
 294     // Test that we have a valid .vlt or .wsz file, based on the extension
 295     // TODO: an actual check of the contents would be better...
 296     if( ( ext = strchr( p_demux->psz_path, '.' ) ) == NULL ||
 297         ( strcasecmp( ext, ".vlt" ) && strcasecmp( ext, ".wsz" ) ) )
 298     {
 299         return VLC_EGENERIC;
 300     }
 301
 302     p_intf = (intf_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INTF,
 303                                                FIND_ANYWHERE );
 304     if( p_intf != NULL )
 305     {
 306         // Do nothing is skins2 is not the main interface
 307         if( var_Type( p_intf, "skin-to-load" ) == VLC_VAR_STRING )
 308         {
 309             playlist_t *p_playlist =
 310                 (playlist_t *) vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
 311                                                 FIND_ANYWHERE );
 312             if( p_playlist != NULL )
 313             {
 314                 // Make sure the item is deleted afterwards
 315                 /// \bug does not always work
 316                 p_playlist->status.p_item->i_flags |= PLAYLIST_REMOVE_FLAG;
 317                 vlc_object_release( p_playlist );
 318             }
 319
 320             vlc_value_t val;
 321             val.psz_string = p_demux->psz_path;
 322             var_Set( p_intf, "skin-to-load", val );
 323         }
 324         else
 325         {
 326             msg_Warn( p_this,
 327                       "skin could not be loaded (not using skins2 intf)" );
 328         }
 329
 330         vlc_object_release( p_intf );
 331     }
 332
 333     return VLC_SUCCESS;
 334 }
 335
 336
 337 //---------------------------------------------------------------------------
 338 // Demux: return EOF
 339 //---------------------------------------------------------------------------
 340 static int Demux( demux_t *p_demux )
 341 {
 342     return 0;
 343 }
 344
 345
 346 //---------------------------------------------------------------------------
 347 // DemuxControl
 348 //---------------------------------------------------------------------------
 349 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 350 {
 351     return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 352 }
 353
 354
 355 //---------------------------------------------------------------------------
 356 // Callbacks
 357 //---------------------------------------------------------------------------
 358
 359 /// Callback for the systray configuration option
 360 static int onSystrayChange( vlc_object_t *pObj, const char *pVariable,
 361                             vlc_value_t oldVal, vlc_value_t newVal,
 362                             void *pParam )
 363 {
 364     intf_thread_t *pIntf =
 365         (intf_thread_t*)vlc_object_find( pObj, VLC_OBJECT_INTF, FIND_ANYWHERE );
 366
 367     if( pIntf == NULL )
 368     {
 369         return VLC_EGENERIC;
 370     }
 371
 372     // Check that we found the correct interface (same check as for the demux)
 373     if( var_Type( pIntf, "skin-to-load" ) == VLC_VAR_STRING )
 374     {
 375         AsyncQueue *pQueue = AsyncQueue::instance( pIntf );
 376         if( newVal.b_bool )
 377         {
 378             CmdAddInTray *pCmd = new CmdAddInTray( pIntf );
 379             pQueue->push( CmdGenericPtr( pCmd ) );
 380         }
 381         else
 382         {
 383             CmdRemoveFromTray *pCmd = new CmdRemoveFromTray( pIntf );
 384             pQueue->push( CmdGenericPtr( pCmd ) );
 385         }
 386     }
 387
 388     vlc_object_release( pIntf );
 389     return VLC_SUCCESS;
 390 }
 391
 392
 393 /// Callback for the systray configuration option
 394 static int onTaskBarChange( vlc_object_t *pObj, const char *pVariable,
 395                             vlc_value_t oldVal, vlc_value_t newVal,
 396                             void *pParam )
 397 {
 398     intf_thread_t *pIntf =
 399         (intf_thread_t*)vlc_object_find( pObj, VLC_OBJECT_INTF, FIND_ANYWHERE );
 400
 401     if( pIntf == NULL )
 402     {
 403         return VLC_EGENERIC;
 404     }
 405
 406     // Check that we found the correct interface (same check as for the demux)
 407     if( var_Type( pIntf, "skin-to-load" ) == VLC_VAR_STRING )
 408     {
 409         AsyncQueue *pQueue = AsyncQueue::instance( pIntf );
 410         if( newVal.b_bool )
 411         {
 412             CmdAddInTaskBar *pCmd = new CmdAddInTaskBar( pIntf );
 413             pQueue->push( CmdGenericPtr( pCmd ) );
 414         }
 415         else
 416         {
 417             CmdRemoveFromTaskBar *pCmd = new CmdRemoveFromTaskBar( pIntf );
 418             pQueue->push( CmdGenericPtr( pCmd ) );
 419         }
 420     }
 421
 422     vlc_object_release( pIntf );
 423     return VLC_SUCCESS;
 424 }
 425
 426
 427 //---------------------------------------------------------------------------
 428 // Module descriptor
 429 //---------------------------------------------------------------------------
 430 #define SKINS2_LAST      N_("Skin to use")
 431 #define SKINS2_LAST_LONG N_("Path to the skin to use.")
 432 #define SKINS2_CONFIG      N_("Config of last used skin")
 433 #define SKINS2_CONFIG_LONG N_("Windows configuration of the last skin used. " \
 434         "This option is updated automatically, do not touch it." )
 435 #define SKINS2_SYSTRAY      N_("Systray icon")
 436 #define SKINS2_SYSTRAY_LONG N_("Show a systray icon for VLC")
 437 #define SKINS2_TASKBAR      N_("Show VLC on the taskbar")
 438 #define SKINS2_TASKBAR_LONG N_("Show VLC on the taskbar")
 439 #define SKINS2_TRANSPARENCY      N_("Enable transparency effects")
 440 #define SKINS2_TRANSPARENCY_LONG N_("You can disable all transparency effects"\
 441     " if you want. This is mainly useful when moving windows does not behave" \
 442     " correctly.")
 443 #define SKINS2_PLAYLIST N_("Use a skinned playlist")
 444 #define SKINS2_PLAYLIST_LONG N_("Use a skinned playlist")
 445
 446 vlc_module_begin();
 447     set_category( CAT_INTERFACE );
 448     set_subcategory( SUBCAT_INTERFACE_MAIN );
 449     add_file( "skins2-last", "", NULL, SKINS2_LAST, SKINS2_LAST_LONG,
 450               true );
 451         change_autosave();
 452     add_string( "skins2-config", "", NULL, SKINS2_CONFIG, SKINS2_CONFIG_LONG,
 453                 true );
 454         change_autosave();
 455         change_internal();
 456 #ifdef WIN32
 457     add_bool( "skins2-systray", false, onSystrayChange, SKINS2_SYSTRAY,
 458               SKINS2_SYSTRAY_LONG, false );
 459     add_bool( "skins2-taskbar", true, onTaskBarChange, SKINS2_TASKBAR,
 460               SKINS2_TASKBAR_LONG, false );
 461     add_bool( "skins2-transparency", false, NULL, SKINS2_TRANSPARENCY,
 462               SKINS2_TRANSPARENCY_LONG, false );
 463 #endif
 464
 465     add_bool( "skinned-playlist", true, NULL, SKINS2_PLAYLIST,
 466               SKINS2_PLAYLIST_LONG, false );
 467     set_shortname( _("Skins"));
 468     set_description( _("Skinnable Interface") );
 469     set_capability( "interface", 30 );
 470     set_callbacks( Open, Close );
 471     add_shortcut( "skins" );
 472
 473     add_submodule();
 474         set_description( _("Skins loader demux") );
 475         set_capability( "demux", 5 );
 476         set_callbacks( DemuxOpen, NULL );
 477
 478 vlc_module_end();