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 "subsystemFactory.hxx"
69 #include "options.hxx"
71 using namespace flightgear;
76 // The atexit() function handler should know when the graphical subsystem
78 extern int _bootstrap_OSInit;
80 static SGPropertyNode_ptr frame_signal;
81 static TimeManager* timeMgr;
83 // What should we do when we have nothing else to do? Let's get ready
84 // for the next move and update the display?
85 static void fgMainLoop( void )
87 frame_signal->fireValueChanged();
89 // compute simulated time (allowing for pause, warp, etc) and
91 double sim_dt, real_dt;
92 timeMgr->computeTimeDeltas(sim_dt, real_dt);
94 // update all subsystems
95 globals->get_subsystem_mgr()->update(sim_dt);
97 simgear::AtomicChangeListener::fireChangeListeners();
100 static void initTerrasync()
102 if (fgGetBool("/sim/fghome-readonly", false)) {
106 // start TerraSync up now, so it can be synchronizing shared models
107 // and airports data in parallel with a nav-cache rebuild.
108 SGPath tsyncCache(globals->get_fg_home());
109 tsyncCache.append("terrasync-cache.xml");
111 // wipe the cache file if requested
112 if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
113 SG_LOG(SG_GENERAL, SG_INFO, "restore-defaults requested, wiping terrasync update cache at " <<
115 if (tsyncCache.exists()) {
120 fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
122 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync();
123 terra_sync->setRoot(globals->get_props());
124 globals->add_subsystem("terrasync", terra_sync);
129 // add the terrasync root as a data path so data can be retrieved from it
130 std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
131 globals->append_data_path(terraSyncDir);
134 static void registerMainLoop()
136 // stash current frame signal property
137 frame_signal = fgGetNode("/sim/signals/frame", true);
138 timeMgr = (TimeManager*) globals->get_subsystem("time");
139 fgRegisterIdleHandler( fgMainLoop );
142 // This is the top level master main function that is registered as
145 // The first few passes take care of initialization things (a couple
146 // per pass) and once everything has been initialized fgMainLoop from
149 static int idle_state = 0;
151 static void fgIdleFunction ( void ) {
152 // Specify our current idle function state. This is used to run all
153 // our initializations out of the idle callback so that we can get a
154 // splash screen up and running right away.
156 if ( idle_state == 0 ) {
160 fgSplashProgress("loading-aircraft-list");
163 } else if ( idle_state == 2 ) {
166 fgSplashProgress("loading-nav-dat");
168 } else if ( idle_state == 3 ) {
170 bool done = fgInitNav();
173 fgSplashProgress("init-scenery");
175 fgSplashProgress("loading-nav-dat");
178 } else if ( idle_state == 4 ) {
181 TimeManager* t = new TimeManager;
182 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
184 // Do some quick general initializations
185 if( !fgInitGeneral()) {
186 throw sg_exception("General initialization failed");
189 ////////////////////////////////////////////////////////////////////
190 // Initialize the property-based built-in commands
191 ////////////////////////////////////////////////////////////////////
194 flightgear::registerSubsystemCommands(globals->get_commands());
196 ////////////////////////////////////////////////////////////////////
197 // Initialize the material manager
198 ////////////////////////////////////////////////////////////////////
199 globals->set_matlib( new SGMaterialLib );
200 simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
202 } else if (( idle_state == 5 ) || (idle_state == 2005)) {
204 flightgear::initPosition();
205 flightgear::initTowerLocationListener();
207 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
209 TimeManager* timeManager = (TimeManager*) globals->get_subsystem("time");
212 ////////////////////////////////////////////////////////////////////
213 // Initialize the TG scenery subsystem.
214 ////////////////////////////////////////////////////////////////////
216 globals->set_scenery( new FGScenery );
217 globals->get_scenery()->init();
218 globals->get_scenery()->bind();
219 globals->set_tile_mgr( new FGTileMgr );
221 fgSplashProgress("creating-subsystems");
222 } else if (( idle_state == 7 ) || (idle_state == 2007)) {
223 bool isReset = (idle_state == 2007);
224 idle_state = 8; // from the next state on, reset & startup are identical
227 fgCreateSubsystems(isReset);
228 SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
229 fgSplashProgress("binding-subsystems");
231 } else if ( idle_state == 8 ) {
235 globals->get_subsystem_mgr()->bind();
236 SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
238 fgSplashProgress("init-subsystems");
239 } else if ( idle_state == 9 ) {
240 SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
241 if ( status == SGSubsystem::INIT_DONE) {
243 fgSplashProgress("finishing-subsystems");
245 fgSplashProgress("init-subsystems");
248 } else if ( idle_state == 10 ) {
250 fgPostInitSubsystems();
251 fgSplashProgress("finalize-position");
252 } else if ( idle_state == 900 ) {
255 // setup OpenGL view parameters
256 globals->get_renderer()->setupView();
258 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
259 fgGetInt("/sim/startup/ysize") );
260 WindowSystemAdapter::getWSA()->windows[0]->gc->add(
261 new simgear::canvas::VGInitOperation()
264 int session = fgGetInt("/sim/session",0);
266 fgSetInt("/sim/session",session);
269 if ( idle_state == 1000 ) {
270 // We've finished all our initialization steps, from now on we
271 // run the main loop.
272 fgSetBool("sim/sceneryloaded", false);
276 if ( idle_state == 2000 ) {
282 void fgResetIdleState()
285 fgRegisterIdleHandler( &fgIdleFunction );
289 static void upper_case_property(const char *name)
291 using namespace simgear;
292 SGPropertyNode *p = fgGetNode(name, false);
294 p = fgGetNode(name, true);
295 p->setStringValue("");
297 props::Type t = p->getType();
298 if (t == props::NONE || t == props::UNSPECIFIED)
299 p->setStringValue("");
301 assert(t == props::STRING);
303 SGPropertyChangeListener* muc = new FGMakeUpperCase;
304 globals->addListenerToCleanup(muc);
305 p->addChangeListener(muc);
308 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
309 // for the details of this.
310 static void ATIScreenSizeHack()
312 osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
313 hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
314 int prettyMuchAnyInt = 1;
315 hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
316 globals->get_renderer()->addCamera(hackCam, false);
319 // Propose NVIDIA Optimus to use high-end GPU
320 #if defined(SG_WINDOWS)
322 _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
326 static void logToFile()
328 SGPath logPath = globals->get_fg_home();
329 logPath.append("fgfs.log");
330 if (logPath.exists()) {
331 SGPath prevLogPath = globals->get_fg_home();
332 prevLogPath.append("fgfs_0.log");
333 logPath.rename(prevLogPath);
334 // bit strange, we need to restore the correct value of logPath now
335 logPath = globals->get_fg_home();
336 logPath.append("fgfs.log");
338 sglog().logToFile(logPath, SG_ALL, SG_INFO);
341 // Main top level initialization
342 int fgMainInit( int argc, char **argv ) {
344 // set default log levels
345 sglog().setLogLevels( SG_ALL, SG_ALERT );
347 globals = new FGGlobals;
352 if (!fgGetBool("/sim/fghome-readonly")) {
353 // now home is initialised, we can log to a file inside it
358 #ifdef FLIGHTGEAR_VERSION
359 version = FLIGHTGEAR_VERSION;
361 version = "unknown version";
363 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
365 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
367 // Allocate global data structures. This needs to happen before
368 // we parse command line options
372 // seed the random number generator
375 string_list *col = new string_list;
376 globals->set_channel_options_list( col );
378 fgValidatePath("", false); // initialize static variables
379 upper_case_property("/sim/presets/airport-id");
380 upper_case_property("/sim/presets/runway");
381 upper_case_property("/sim/tower/airport-id");
382 upper_case_property("/autopilot/route-manager/input");
384 // Load the configuration parameters. (Command line options
385 // override config file options. Config file options override
387 int configResult = fgInitConfig(argc, argv, false);
388 if (configResult == flightgear::FG_OPTIONS_ERROR) {
390 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
394 configResult = fgInitAircraft(false);
395 if (configResult == flightgear::FG_OPTIONS_ERROR) {
397 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
401 configResult = flightgear::Options::sharedInstance()->processOptions();
402 if (configResult == flightgear::FG_OPTIONS_ERROR) {
404 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
408 // Initialize the Window/Graphics environment.
409 fgOSInit(&argc, argv);
412 fgRegisterIdleHandler( &fgIdleFunction );
414 // Initialize sockets (WinSock needs this)
415 simgear::Socket::initSockets();
417 // Clouds3D requires an alpha channel
418 fgOSOpenWindow(true /* request stencil buffer */);
419 fgOSResetProperties();
421 // Initialize the splash screen right away
425 if (fgGetBool("/sim/ati-viewport-hack", true)) {
426 SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
432 // pass control off to the master event handler
433 int result = fgOSMainLoop();
434 frame_signal.clear();
437 simgear::clearEffectCache();
439 // clean up here; ensure we null globals to avoid
440 // confusing the atexit() handler
444 // delete the NavCache here. This will cause the destruction of many cached
445 // objects (eg, airports, navaids, runways).
446 delete flightgear::NavDataCache::instance();