1 // main.cxx -- top level sim routines
3 // Written by Curtis Olson, started May 1997.
5 // Copyright (C) 1997 - 2002 Curtis L. Olson - http://www.flightgear.org/~curt
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.
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.
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.
28 #include <simgear/compiler.h>
33 #include <osg/GraphicsContext>
34 #include <osgDB/Registry>
37 #include <simgear/canvas/VGInitOperation.hxx>
38 #include <simgear/scene/model/modellib.hxx>
39 #include <simgear/scene/material/matlib.hxx>
40 #include <simgear/scene/material/Effect.hxx>
41 #include <simgear/props/AtomicChangeListener.hxx>
42 #include <simgear/props/props.hxx>
43 #include <simgear/timing/sg_time.hxx>
44 #include <simgear/io/raw_socket.hxx>
45 #include <simgear/scene/tsync/terrasync.hxx>
46 #include <simgear/math/SGMath.hxx>
47 #include <simgear/math/sg_random.h>
49 #include <Model/panelnode.hxx>
50 #include <Scenery/scenery.hxx>
51 #include <Scenery/tilemgr.hxx>
52 #include <Sound/soundmanager.hxx>
53 #include <Time/TimeManager.hxx>
55 #include <Viewer/splash.hxx>
56 #include <Viewer/renderer.hxx>
57 #include <Viewer/WindowSystemAdapter.hxx>
58 #include <Navaids/NavDataCache.hxx>
60 #include "fg_commands.hxx"
64 #include "fg_init.hxx"
66 #include "fg_props.hxx"
67 #include "positioninit.hxx"
68 #include "screensaver_control.hxx"
69 #include "subsystemFactory.hxx"
70 #include "options.hxx"
73 using namespace flightgear;
78 // The atexit() function handler should know when the graphical subsystem
80 extern int _bootstrap_OSInit;
82 static SGPropertyNode_ptr frame_signal;
83 static TimeManager* timeMgr;
85 // What should we do when we have nothing else to do? Let's get ready
86 // for the next move and update the display?
87 static void fgMainLoop( void )
89 frame_signal->fireValueChanged();
91 // compute simulated time (allowing for pause, warp, etc) and
93 double sim_dt, real_dt;
94 timeMgr->computeTimeDeltas(sim_dt, real_dt);
96 // update all subsystems
97 globals->get_subsystem_mgr()->update(sim_dt);
99 simgear::AtomicChangeListener::fireChangeListeners();
102 static void initTerrasync()
104 if (fgGetBool("/sim/fghome-readonly", false)) {
108 // start TerraSync up now, so it can be synchronizing shared models
109 // and airports data in parallel with a nav-cache rebuild.
110 SGPath tsyncCache(globals->get_fg_home());
111 tsyncCache.append("terrasync-cache.xml");
113 // wipe the cache file if requested
114 if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
115 SG_LOG(SG_GENERAL, SG_INFO, "restore-defaults requested, wiping terrasync update cache at " <<
117 if (tsyncCache.exists()) {
122 fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
124 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync();
125 terra_sync->setRoot(globals->get_props());
126 globals->add_subsystem("terrasync", terra_sync);
131 // add the terrasync root as a data path so data can be retrieved from it
132 std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
133 globals->append_data_path(terraSyncDir);
136 static void registerMainLoop()
138 // stash current frame signal property
139 frame_signal = fgGetNode("/sim/signals/frame", true);
140 timeMgr = (TimeManager*) globals->get_subsystem("time");
141 fgRegisterIdleHandler( fgMainLoop );
144 // This is the top level master main function that is registered as
147 // The first few passes take care of initialization things (a couple
148 // per pass) and once everything has been initialized fgMainLoop from
151 static int idle_state = 0;
153 static void fgIdleFunction ( void ) {
154 // Specify our current idle function state. This is used to run all
155 // our initializations out of the idle callback so that we can get a
156 // splash screen up and running right away.
158 if ( idle_state == 0 ) {
162 fgSplashProgress("loading-aircraft-list");
165 } else if ( idle_state == 2 ) {
168 fgSplashProgress("loading-nav-dat");
170 } else if ( idle_state == 3 ) {
172 bool done = fgInitNav();
175 fgSplashProgress("init-scenery");
177 fgSplashProgress("loading-nav-dat");
180 } else if ( idle_state == 4 ) {
183 TimeManager* t = new TimeManager;
184 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
186 // Do some quick general initializations
187 if( !fgInitGeneral()) {
188 throw sg_exception("General initialization failed");
191 ////////////////////////////////////////////////////////////////////
192 // Initialize the property-based built-in commands
193 ////////////////////////////////////////////////////////////////////
196 flightgear::registerSubsystemCommands(globals->get_commands());
198 ////////////////////////////////////////////////////////////////////
199 // Initialize the material manager
200 ////////////////////////////////////////////////////////////////////
201 globals->set_matlib( new SGMaterialLib );
202 simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
204 } else if (( idle_state == 5 ) || (idle_state == 2005)) {
206 flightgear::initPosition();
207 flightgear::initTowerLocationListener();
209 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
211 TimeManager* timeManager = (TimeManager*) globals->get_subsystem("time");
214 ////////////////////////////////////////////////////////////////////
215 // Initialize the TG scenery subsystem.
216 ////////////////////////////////////////////////////////////////////
218 globals->set_scenery( new FGScenery );
219 globals->get_scenery()->init();
220 globals->get_scenery()->bind();
221 globals->set_tile_mgr( new FGTileMgr );
223 fgSplashProgress("creating-subsystems");
224 } else if (( idle_state == 7 ) || (idle_state == 2007)) {
225 bool isReset = (idle_state == 2007);
226 idle_state = 8; // from the next state on, reset & startup are identical
229 fgCreateSubsystems(isReset);
230 SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
231 fgSplashProgress("binding-subsystems");
233 } else if ( idle_state == 8 ) {
237 globals->get_subsystem_mgr()->bind();
238 SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
240 fgSplashProgress("init-subsystems");
241 } else if ( idle_state == 9 ) {
242 SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
243 if ( status == SGSubsystem::INIT_DONE) {
245 fgSplashProgress("finishing-subsystems");
247 fgSplashProgress("init-subsystems");
250 } else if ( idle_state == 10 ) {
252 fgPostInitSubsystems();
253 fgSplashProgress("finalize-position");
254 } else if ( idle_state == 900 ) {
257 // setup OpenGL view parameters
258 globals->get_renderer()->setupView();
260 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
261 fgGetInt("/sim/startup/ysize") );
262 WindowSystemAdapter::getWSA()->windows[0]->gc->add(
263 new simgear::canvas::VGInitOperation()
266 int session = fgGetInt("/sim/session",0);
268 fgSetInt("/sim/session",session);
271 if ( idle_state == 1000 ) {
272 // We've finished all our initialization steps, from now on we
273 // run the main loop.
274 fgSetBool("sim/sceneryloaded", false);
278 if ( idle_state == 2000 ) {
284 void fgResetIdleState()
287 fgRegisterIdleHandler( &fgIdleFunction );
291 static void upper_case_property(const char *name)
293 using namespace simgear;
294 SGPropertyNode *p = fgGetNode(name, false);
296 p = fgGetNode(name, true);
297 p->setStringValue("");
299 props::Type t = p->getType();
300 if (t == props::NONE || t == props::UNSPECIFIED)
301 p->setStringValue("");
303 assert(t == props::STRING);
305 SGPropertyChangeListener* muc = new FGMakeUpperCase;
306 globals->addListenerToCleanup(muc);
307 p->addChangeListener(muc);
310 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
311 // for the details of this.
312 static void ATIScreenSizeHack()
314 osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
315 hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
316 int prettyMuchAnyInt = 1;
317 hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
318 globals->get_renderer()->addCamera(hackCam, false);
321 // Propose NVIDIA Optimus to use high-end GPU
322 #if defined(SG_WINDOWS)
324 _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
328 static void logToFile()
330 SGPath logPath = globals->get_fg_home();
331 logPath.append("fgfs.log");
332 if (logPath.exists()) {
333 SGPath prevLogPath = globals->get_fg_home();
334 prevLogPath.append("fgfs_0.log");
335 logPath.rename(prevLogPath);
336 // bit strange, we need to restore the correct value of logPath now
337 logPath = globals->get_fg_home();
338 logPath.append("fgfs.log");
340 sglog().logToFile(logPath, SG_ALL, SG_INFO);
343 // Main top level initialization
344 int fgMainInit( int argc, char **argv ) {
346 // set default log levels
347 sglog().setLogLevels( SG_ALL, SG_ALERT );
349 globals = new FGGlobals;
354 if (!fgGetBool("/sim/fghome-readonly")) {
355 // now home is initialised, we can log to a file inside it
360 #ifdef FLIGHTGEAR_VERSION
361 version = FLIGHTGEAR_VERSION;
363 version = "unknown version";
365 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
367 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
369 // Allocate global data structures. This needs to happen before
370 // we parse command line options
374 // seed the random number generator
377 string_list *col = new string_list;
378 globals->set_channel_options_list( col );
380 fgValidatePath("", false); // initialize static variables
381 upper_case_property("/sim/presets/airport-id");
382 upper_case_property("/sim/presets/runway");
383 upper_case_property("/sim/tower/airport-id");
384 upper_case_property("/autopilot/route-manager/input");
386 // Load the configuration parameters. (Command line options
387 // override config file options. Config file options override
389 int configResult = fgInitConfig(argc, argv, false);
390 if (configResult == flightgear::FG_OPTIONS_ERROR) {
392 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
396 configResult = fgInitAircraft(false);
397 if (configResult == flightgear::FG_OPTIONS_ERROR) {
399 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
403 configResult = flightgear::Options::sharedInstance()->processOptions();
404 if (configResult == flightgear::FG_OPTIONS_ERROR) {
406 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
410 // Initialize the Window/Graphics environment.
411 fgOSInit(&argc, argv);
414 fgRegisterIdleHandler( &fgIdleFunction );
416 // Initialize sockets (WinSock needs this)
417 simgear::Socket::initSockets();
419 // Clouds3D requires an alpha channel
420 fgOSOpenWindow(true /* request stencil buffer */);
421 fgOSResetProperties();
423 // Initialize the splash screen right away
427 if (fgGetBool("/sim/ati-viewport-hack", true)) {
428 SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
434 //try to disable the screensaver
435 fgOSDisableScreensaver();
437 // pass control off to the master event handler
438 int result = fgOSMainLoop();
439 frame_signal.clear();
442 simgear::clearEffectCache();
444 // clean up here; ensure we null globals to avoid
445 // confusing the atexit() handler
449 // delete the NavCache here. This will cause the destruction of many cached
450 // objects (eg, airports, navaids, runways).
451 delete flightgear::NavDataCache::instance();