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
  69 using namespace flightgear;
  70
  71 using std::cerr;
  72 using std::vector;
  73
  74 // The atexit() function handler should know when the graphical subsystem
  75 // is initialized.
  76 extern int _bootstrap_OSInit;
  77
  78 static SGPropertyNode_ptr frame_signal;
  79 static TimeManager* timeMgr;
  80
  81 // What should we do when we have nothing else to do?  Let's get ready
  82 // for the next move and update the display?
  83 static void fgMainLoop( void )
  84 {
  85     frame_signal->fireValueChanged();
  86
  87     SG_LOG( SG_GENERAL, SG_DEBUG, "Running Main Loop");
  88     SG_LOG( SG_GENERAL, SG_DEBUG, "======= ==== ====");
  89
  90     // compute simulated time (allowing for pause, warp, etc) and
  91     // real elapsed time
  92     double sim_dt, real_dt;
  93     timeMgr->computeTimeDeltas(sim_dt, real_dt);
  94
  95     // update all subsystems
  96     globals->get_subsystem_mgr()->update(sim_dt);
  97
  98     simgear::AtomicChangeListener::fireChangeListeners();
  99
 100     SG_LOG( SG_GENERAL, SG_DEBUG, "" );
 101 }
 102
 103
 104 static void registerMainLoop()
 105 {
 106     // stash current frame signal property
 107     frame_signal = fgGetNode("/sim/signals/frame", true);
 108     timeMgr = (TimeManager*) globals->get_subsystem("time");
 109     fgRegisterIdleHandler( fgMainLoop );
 110 }
 111
 112 // This is the top level master main function that is registered as
 113 // our idle function
 114
 115 // The first few passes take care of initialization things (a couple
 116 // per pass) and once everything has been initialized fgMainLoop from
 117 // then on.
 118
 119 static void fgIdleFunction ( void ) {
 120     // Specify our current idle function state.  This is used to run all
 121     // our initializations out of the idle callback so that we can get a
 122     // splash screen up and running right away.
 123     static int idle_state = 0;
 124
 125     if ( idle_state == 0 ) {
 126         if (guiInit())
 127         {
 128             idle_state+=2;
 129             fgSplashProgress("loading-aircraft-list");
 130         }
 131
 132     } else if ( idle_state == 2 ) {
 133         idle_state++;
 134         fgSplashProgress("loading-nav-dat");
 135
 136     } else if ( idle_state == 3 ) {
 137
 138         bool done = fgInitNav();
 139         if (done) {
 140           ++idle_state;
 141           fgSplashProgress("init-scenery");
 142         } else {
 143           fgSplashProgress("loading-nav-dat");
 144         }
 145
 146     } else if ( idle_state == 4 ) {
 147         idle_state+=2;
 148         // based on the requested presets, calculate the true starting
 149         // lon, lat
 150         flightgear::initPosition();
 151         flightgear::initTowerLocationListener();
 152
 153         TimeManager* t = new TimeManager;
 154         globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
 155         t->init(); // need to init now, not during initSubsystems
 156
 157         // Do some quick general initializations
 158         if( !fgInitGeneral()) {
 159             SG_LOG( SG_GENERAL, SG_ALERT,
 160                 "General initialization failed ..." );
 161             exit(-1);
 162         }
 163
 164         ////////////////////////////////////////////////////////////////////
 165         // Initialize the property-based built-in commands
 166         ////////////////////////////////////////////////////////////////////
 167         fgInitCommands();
 168
 169         flightgear::registerSubsystemCommands(globals->get_commands());
 170
 171         ////////////////////////////////////////////////////////////////////
 172         // Initialize the material manager
 173         ////////////////////////////////////////////////////////////////////
 174         globals->set_matlib( new SGMaterialLib );
 175         simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
 176         simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
 177
 178         ////////////////////////////////////////////////////////////////////
 179         // Initialize the TG scenery subsystem.
 180         ////////////////////////////////////////////////////////////////////
 181         simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync(globals->get_props());
 182         globals->add_subsystem("terrasync", terra_sync);
 183         globals->set_scenery( new FGScenery );
 184         globals->get_scenery()->init();
 185         globals->get_scenery()->bind();
 186         globals->set_tile_mgr( new FGTileMgr );
 187
 188         fgSplashProgress("loading-aircraft");
 189
 190     } else if ( idle_state == 6 ) {
 191         idle_state++;
 192         fgSplashProgress("creating-subsystems");
 193
 194     } else if ( idle_state == 7 ) {
 195         idle_state++;
 196         SGTimeStamp st;
 197         st.stamp();
 198         fgCreateSubsystems();
 199         SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
 200         fgSplashProgress("binding-subsystems");
 201
 202     } else if ( idle_state == 8 ) {
 203         idle_state++;
 204         SGTimeStamp st;
 205         st.stamp();
 206         globals->get_subsystem_mgr()->bind();
 207         SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
 208
 209         fgSplashProgress("init-subsystems");
 210     } else if ( idle_state == 9 ) {
 211         SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
 212         if ( status == SGSubsystem::INIT_DONE) {
 213           ++idle_state;
 214           fgSplashProgress("finishing-subsystems");
 215         } else {
 216           fgSplashProgress("init-subsystems");
 217         }
 218
 219     } else if ( idle_state == 10 ) {
 220         idle_state = 900;
 221         fgPostInitSubsystems();
 222         fgSplashProgress("finalize-position");
 223     } else if ( idle_state == 900 ) {
 224         idle_state = 1000;
 225
 226         // setup OpenGL view parameters
 227         globals->get_renderer()->setupView();
 228
 229         globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
 230                                          fgGetInt("/sim/startup/ysize") );
 231         WindowSystemAdapter::getWSA()->windows[0]->gc->add(
 232           new simgear::canvas::VGInitOperation()
 233         );
 234
 235         int session = fgGetInt("/sim/session",0);
 236         session++;
 237         fgSetInt("/sim/session",session);
 238     }
 239
 240     if ( idle_state == 1000 ) {
 241         // We've finished all our initialization steps, from now on we
 242         // run the main loop.
 243         fgSetBool("sim/sceneryloaded", false);
 244         registerMainLoop();
 245     }
 246 }
 247
 248 static void upper_case_property(const char *name)
 249 {
 250     using namespace simgear;
 251     SGPropertyNode *p = fgGetNode(name, false);
 252     if (!p) {
 253         p = fgGetNode(name, true);
 254         p->setStringValue("");
 255     } else {
 256         props::Type t = p->getType();
 257         if (t == props::NONE || t == props::UNSPECIFIED)
 258             p->setStringValue("");
 259         else
 260             assert(t == props::STRING);
 261     }
 262     p->addChangeListener(new FGMakeUpperCase);
 263 }
 264
 265 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
 266 // for the details of this.
 267 static void ATIScreenSizeHack()
 268 {
 269     osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
 270     hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
 271     int prettyMuchAnyInt = 1;
 272     hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
 273     globals->get_renderer()->addCamera(hackCam, false);
 274 }
 275
 276 // Propose NVIDIA Optimus to use high-end GPU
 277 #if defined(SG_WINDOWS)
 278 extern "C" {
 279     _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
 280 }
 281 #endif
 282
 283 static void logToFile()
 284 {
 285     SGPath logPath = globals->get_fg_home();
 286     logPath.append("fgfs.log");
 287     if (logPath.exists()) {
 288         SGPath prevLogPath = globals->get_fg_home();
 289         prevLogPath.append("fgfs_0.log");
 290         logPath.rename(prevLogPath);
 291         // bit strange, we need to restore the correct value of logPath now
 292         logPath = globals->get_fg_home();
 293         logPath.append("fgfs.log");
 294     }
 295     sglog().logToFile(logPath, SG_ALL, SG_INFO);
 296 }
 297
 298 // Main top level initialization
 299 int fgMainInit( int argc, char **argv ) {
 300
 301     // set default log levels
 302     sglog().setLogLevels( SG_ALL, SG_ALERT );
 303
 304     globals = new FGGlobals;
 305     fgInitHome();
 306
 307     // now home is initialised, we can log to a file inside it
 308     logToFile();
 309
 310     std::string version;
 311 #ifdef FLIGHTGEAR_VERSION
 312     version = FLIGHTGEAR_VERSION;
 313 #else
 314     version = "unknown version";
 315 #endif
 316     SG_LOG( SG_GENERAL, SG_INFO, "FlightGear:  Version "
 317             << version );
 318     SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
 319
 320     // Allocate global data structures.  This needs to happen before
 321     // we parse command line options
 322
 323
 324
 325     // seed the random number generator
 326     sg_srandom_time();
 327
 328     string_list *col = new string_list;
 329     globals->set_channel_options_list( col );
 330
 331     fgValidatePath("", false);  // initialize static variables
 332     upper_case_property("/sim/presets/airport-id");
 333     upper_case_property("/sim/presets/runway");
 334     upper_case_property("/sim/tower/airport-id");
 335     upper_case_property("/autopilot/route-manager/input");
 336
 337     // Load the configuration parameters.  (Command line options
 338     // override config file options.  Config file options override
 339     // defaults.)
 340     if ( !fgInitConfig(argc, argv) ) {
 341       SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
 342       exit(-1);
 343     }
 344
 345     // Initialize the Window/Graphics environment.
 346     fgOSInit(&argc, argv);
 347     _bootstrap_OSInit++;
 348
 349     fgRegisterIdleHandler( &fgIdleFunction );
 350
 351     // Initialize sockets (WinSock needs this)
 352     simgear::Socket::initSockets();
 353
 354     // Clouds3D requires an alpha channel
 355     fgOSOpenWindow(true /* request stencil buffer */);
 356
 357     // Initialize the splash screen right away
 358     fntInit();
 359     fgSplashInit();
 360
 361     if (fgGetBool("/sim/ati-viewport-hack", true)) {
 362         SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
 363         ATIScreenSizeHack();
 364     }
 365
 366     fgOutputSettings();
 367
 368     // pass control off to the master event handler
 369     int result = fgOSMainLoop();
 370
 371     // clean up here; ensure we null globals to avoid
 372     // confusing the atexit() handler
 373     delete globals;
 374     globals = NULL;
 375
 376     // delete the NavCache here. This will cause the destruction of many cached
 377     // objects (eg, airports, navaids, runways).
 378     delete flightgear::NavDataCache::instance();
 379
 380     return result;
 381 }