src/Main/main.cxx

   1 // main.cxx -- top level sim routines
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997 - 2002  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29
  30 #include <iostream>
  31
  32 #include <osg/Camera>
  33 #include <osg/GraphicsContext>
  34 #include <osgDB/Registry>
  35
  36 // Class references
  37 #include <simgear/canvas/VGInitOperation.hxx>
  38 #include <simgear/scene/model/modellib.hxx>
  39 #include <simgear/scene/material/matlib.hxx>
  40 #include <simgear/props/AtomicChangeListener.hxx>
  41 #include <simgear/props/props.hxx>
  42 #include <simgear/timing/sg_time.hxx>
  43 #include <simgear/io/raw_socket.hxx>
  44 #include <simgear/scene/tsync/terrasync.hxx>
  45 #include <simgear/math/SGMath.hxx>
  46 #include <simgear/math/sg_random.h>
  47
  48 #include <Model/panelnode.hxx>
  49 #include <Scenery/scenery.hxx>
  50 #include <Scenery/tilemgr.hxx>
  51 #include <Sound/soundmanager.hxx>
  52 #include <Time/TimeManager.hxx>
  53 #include <GUI/gui.h>
  54 #include <Viewer/splash.hxx>
  55 #include <Viewer/renderer.hxx>
  56 #include <Viewer/WindowSystemAdapter.hxx>
  57 #include <Navaids/NavDataCache.hxx>
  58
  59 #include "fg_commands.hxx"
  60 #include "fg_io.hxx"
  61 #include "main.hxx"
  62 #include "util.hxx"
  63 #include "fg_init.hxx"
  64 #include "fg_os.hxx"
  65 #include "fg_props.hxx"
  66 #include "positioninit.hxx"
  67 #include "subsystemFactory.hxx"
  68 #include "options.hxx"
  69
  70 using namespace flightgear;
  71
  72 using std::cerr;
  73 using std::vector;
  74
  75 // The atexit() function handler should know when the graphical subsystem
  76 // is initialized.
  77 extern int _bootstrap_OSInit;
  78
  79 static SGPropertyNode_ptr frame_signal;
  80 static TimeManager* timeMgr;
  81
  82 // What should we do when we have nothing else to do?  Let's get ready
  83 // for the next move and update the display?
  84 static void fgMainLoop( void )
  85 {
  86     frame_signal->fireValueChanged();
  87
  88     // compute simulated time (allowing for pause, warp, etc) and
  89     // real elapsed time
  90     double sim_dt, real_dt;
  91     timeMgr->computeTimeDeltas(sim_dt, real_dt);
  92
  93     // update all subsystems
  94     globals->get_subsystem_mgr()->update(sim_dt);
  95
  96     simgear::AtomicChangeListener::fireChangeListeners();
  97 }
  98
  99
 100 static void registerMainLoop()
 101 {
 102     // stash current frame signal property
 103     frame_signal = fgGetNode("/sim/signals/frame", true);
 104     timeMgr = (TimeManager*) globals->get_subsystem("time");
 105     fgRegisterIdleHandler( fgMainLoop );
 106 }
 107
 108 // This is the top level master main function that is registered as
 109 // our idle function
 110
 111 // The first few passes take care of initialization things (a couple
 112 // per pass) and once everything has been initialized fgMainLoop from
 113 // then on.
 114
 115 static void fgIdleFunction ( void ) {
 116     // Specify our current idle function state.  This is used to run all
 117     // our initializations out of the idle callback so that we can get a
 118     // splash screen up and running right away.
 119     static int idle_state = 0;
 120
 121     if ( idle_state == 0 ) {
 122         if (guiInit())
 123         {
 124             idle_state+=2;
 125             fgSplashProgress("loading-aircraft-list");
 126         }
 127
 128     } else if ( idle_state == 2 ) {
 129
 130         // start TerraSync up now, so it can be synchronizing shared models
 131         // and airports data in parallel with a nav-cache rebuild.
 132         SGPath tsyncCache(globals->get_fg_home());
 133         tsyncCache.append("terrasync-cache.xml");
 134
 135         // wipe the cache file if requested
 136         if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
 137             SG_LOG(SG_GENERAL, SG_INFO, "restore-defaults requested, wiping terrasync update cache at " <<
 138                    tsyncCache);
 139             if (tsyncCache.exists()) {
 140                 tsyncCache.remove();
 141             }
 142         }
 143
 144         fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
 145
 146         simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync();
 147         terra_sync->setRoot(globals->get_props());
 148         globals->add_subsystem("terrasync", terra_sync);
 149
 150
 151
 152         terra_sync->bind();
 153         terra_sync->init();
 154
 155         // add the terrasync root as a data path so data can be retrieved from it
 156         std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
 157         globals->append_data_path(terraSyncDir);
 158
 159         idle_state++;
 160         fgSplashProgress("loading-nav-dat");
 161
 162     } else if ( idle_state == 3 ) {
 163
 164         bool done = fgInitNav();
 165         if (done) {
 166           ++idle_state;
 167           fgSplashProgress("init-scenery");
 168         } else {
 169           fgSplashProgress("loading-nav-dat");
 170         }
 171
 172     } else if ( idle_state == 4 ) {
 173         idle_state+=2;
 174         // based on the requested presets, calculate the true starting
 175         // lon, lat
 176         flightgear::initPosition();
 177         flightgear::initTowerLocationListener();
 178
 179         TimeManager* t = new TimeManager;
 180         globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
 181         t->init(); // need to init now, not during initSubsystems
 182
 183         // Do some quick general initializations
 184         if( !fgInitGeneral()) {
 185             throw sg_exception("General initialization failed");
 186         }
 187
 188         ////////////////////////////////////////////////////////////////////
 189         // Initialize the property-based built-in commands
 190         ////////////////////////////////////////////////////////////////////
 191         fgInitCommands();
 192
 193         flightgear::registerSubsystemCommands(globals->get_commands());
 194
 195         ////////////////////////////////////////////////////////////////////
 196         // Initialize the material manager
 197         ////////////////////////////////////////////////////////////////////
 198         globals->set_matlib( new SGMaterialLib );
 199         simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
 200         simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
 201
 202         ////////////////////////////////////////////////////////////////////
 203         // Initialize the TG scenery subsystem.
 204         ////////////////////////////////////////////////////////////////////
 205
 206         globals->set_scenery( new FGScenery );
 207         globals->get_scenery()->init();
 208         globals->get_scenery()->bind();
 209         globals->set_tile_mgr( new FGTileMgr );
 210
 211         fgSplashProgress("loading-aircraft");
 212
 213     } else if ( idle_state == 6 ) {
 214         idle_state++;
 215         fgSplashProgress("creating-subsystems");
 216
 217     } else if ( idle_state == 7 ) {
 218         idle_state++;
 219         SGTimeStamp st;
 220         st.stamp();
 221         fgCreateSubsystems();
 222         SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
 223         fgSplashProgress("binding-subsystems");
 224
 225     } else if ( idle_state == 8 ) {
 226         idle_state++;
 227         SGTimeStamp st;
 228         st.stamp();
 229         globals->get_subsystem_mgr()->bind();
 230         SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
 231
 232         fgSplashProgress("init-subsystems");
 233     } else if ( idle_state == 9 ) {
 234         SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
 235         if ( status == SGSubsystem::INIT_DONE) {
 236           ++idle_state;
 237           fgSplashProgress("finishing-subsystems");
 238         } else {
 239           fgSplashProgress("init-subsystems");
 240         }
 241
 242     } else if ( idle_state == 10 ) {
 243         idle_state = 900;
 244         fgPostInitSubsystems();
 245         fgSplashProgress("finalize-position");
 246     } else if ( idle_state == 900 ) {
 247         idle_state = 1000;
 248
 249         // setup OpenGL view parameters
 250         globals->get_renderer()->setupView();
 251
 252         globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
 253                                          fgGetInt("/sim/startup/ysize") );
 254         WindowSystemAdapter::getWSA()->windows[0]->gc->add(
 255           new simgear::canvas::VGInitOperation()
 256         );
 257
 258         int session = fgGetInt("/sim/session",0);
 259         session++;
 260         fgSetInt("/sim/session",session);
 261     }
 262
 263     if ( idle_state == 1000 ) {
 264         // We've finished all our initialization steps, from now on we
 265         // run the main loop.
 266         fgSetBool("sim/sceneryloaded", false);
 267         registerMainLoop();
 268     }
 269 }
 270
 271 static void upper_case_property(const char *name)
 272 {
 273     using namespace simgear;
 274     SGPropertyNode *p = fgGetNode(name, false);
 275     if (!p) {
 276         p = fgGetNode(name, true);
 277         p->setStringValue("");
 278     } else {
 279         props::Type t = p->getType();
 280         if (t == props::NONE || t == props::UNSPECIFIED)
 281             p->setStringValue("");
 282         else
 283             assert(t == props::STRING);
 284     }
 285     p->addChangeListener(new FGMakeUpperCase);
 286 }
 287
 288 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
 289 // for the details of this.
 290 static void ATIScreenSizeHack()
 291 {
 292     osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
 293     hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
 294     int prettyMuchAnyInt = 1;
 295     hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
 296     globals->get_renderer()->addCamera(hackCam, false);
 297 }
 298
 299 // Propose NVIDIA Optimus to use high-end GPU
 300 #if defined(SG_WINDOWS)
 301 extern "C" {
 302     _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
 303 }
 304 #endif
 305
 306 static void logToFile()
 307 {
 308     SGPath logPath = globals->get_fg_home();
 309     logPath.append("fgfs.log");
 310     if (logPath.exists()) {
 311         SGPath prevLogPath = globals->get_fg_home();
 312         prevLogPath.append("fgfs_0.log");
 313         logPath.rename(prevLogPath);
 314         // bit strange, we need to restore the correct value of logPath now
 315         logPath = globals->get_fg_home();
 316         logPath.append("fgfs.log");
 317     }
 318     sglog().logToFile(logPath, SG_ALL, SG_INFO);
 319 }
 320
 321 // Main top level initialization
 322 int fgMainInit( int argc, char **argv ) {
 323
 324     // set default log levels
 325     sglog().setLogLevels( SG_ALL, SG_ALERT );
 326
 327     globals = new FGGlobals;
 328     fgInitHome();
 329
 330     // now home is initialised, we can log to a file inside it
 331     logToFile();
 332
 333     std::string version;
 334 #ifdef FLIGHTGEAR_VERSION
 335     version = FLIGHTGEAR_VERSION;
 336 #else
 337     version = "unknown version";
 338 #endif
 339     SG_LOG( SG_GENERAL, SG_INFO, "FlightGear:  Version "
 340             << version );
 341     SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
 342
 343     // Allocate global data structures.  This needs to happen before
 344     // we parse command line options
 345
 346
 347
 348     // seed the random number generator
 349     sg_srandom_time();
 350
 351     string_list *col = new string_list;
 352     globals->set_channel_options_list( col );
 353
 354     fgValidatePath("", false);  // initialize static variables
 355     upper_case_property("/sim/presets/airport-id");
 356     upper_case_property("/sim/presets/runway");
 357     upper_case_property("/sim/tower/airport-id");
 358     upper_case_property("/autopilot/route-manager/input");
 359
 360     // Load the configuration parameters.  (Command line options
 361     // override config file options.  Config file options override
 362     // defaults.)
 363     int configResult = fgInitConfig(argc, argv);
 364     if (configResult == flightgear::FG_OPTIONS_ERROR) {
 365         return EXIT_FAILURE;
 366     } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
 367         return EXIT_SUCCESS;
 368     }
 369
 370     // Initialize the Window/Graphics environment.
 371     fgOSInit(&argc, argv);
 372     _bootstrap_OSInit++;
 373
 374     fgRegisterIdleHandler( &fgIdleFunction );
 375
 376     // Initialize sockets (WinSock needs this)
 377     simgear::Socket::initSockets();
 378
 379     // Clouds3D requires an alpha channel
 380     fgOSOpenWindow(true /* request stencil buffer */);
 381
 382     // Initialize the splash screen right away
 383     fntInit();
 384     fgSplashInit();
 385
 386     if (fgGetBool("/sim/ati-viewport-hack", true)) {
 387         SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
 388         ATIScreenSizeHack();
 389     }
 390
 391     fgOutputSettings();
 392
 393     // pass control off to the master event handler
 394     int result = fgOSMainLoop();
 395     frame_signal.clear();
 396     fgOSCloseWindow();
 397
 398     // clean up here; ensure we null globals to avoid
 399     // confusing the atexit() handler
 400     delete globals;
 401     globals = NULL;
 402
 403     // delete the NavCache here. This will cause the destruction of many cached
 404     // objects (eg, airports, navaids, runways).
 405     delete flightgear::NavDataCache::instance();
 406
 407     return result;
 408 }