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/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>
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>
54 #include <Viewer/splash.hxx>
55 #include <Viewer/renderer.hxx>
56 #include <Viewer/WindowSystemAdapter.hxx>
57 #include <Navaids/NavDataCache.hxx>
59 #include "fg_commands.hxx"
63 #include "fg_init.hxx"
65 #include "fg_props.hxx"
66 #include "positioninit.hxx"
67 #include "subsystemFactory.hxx"
68 #include "options.hxx"
70 using namespace flightgear;
75 // The atexit() function handler should know when the graphical subsystem
77 extern int _bootstrap_OSInit;
79 static SGPropertyNode_ptr frame_signal;
80 static TimeManager* timeMgr;
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 )
86 frame_signal->fireValueChanged();
88 // compute simulated time (allowing for pause, warp, etc) and
90 double sim_dt, real_dt;
91 timeMgr->computeTimeDeltas(sim_dt, real_dt);
93 // update all subsystems
94 globals->get_subsystem_mgr()->update(sim_dt);
96 simgear::AtomicChangeListener::fireChangeListeners();
100 static void registerMainLoop()
102 // stash current frame signal property
103 frame_signal = fgGetNode("/sim/signals/frame", true);
104 timeMgr = (TimeManager*) globals->get_subsystem("time");
105 fgRegisterIdleHandler( fgMainLoop );
108 // This is the top level master main function that is registered as
111 // The first few passes take care of initialization things (a couple
112 // per pass) and once everything has been initialized fgMainLoop from
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;
121 if ( idle_state == 0 ) {
125 fgSplashProgress("loading-aircraft-list");
128 } else if ( idle_state == 2 ) {
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");
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 " <<
139 if (tsyncCache.exists()) {
144 fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
146 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync(globals->get_props());
147 globals->add_subsystem("terrasync", terra_sync);
154 // add the terrasync root as a data path so data can be retrieved from it
155 std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
156 globals->append_data_path(terraSyncDir);
159 fgSplashProgress("loading-nav-dat");
161 } else if ( idle_state == 3 ) {
163 bool done = fgInitNav();
166 fgSplashProgress("init-scenery");
168 fgSplashProgress("loading-nav-dat");
171 } else if ( idle_state == 4 ) {
173 // based on the requested presets, calculate the true starting
175 flightgear::initPosition();
176 flightgear::initTowerLocationListener();
178 TimeManager* t = new TimeManager;
179 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
180 t->init(); // need to init now, not during initSubsystems
182 // Do some quick general initializations
183 if( !fgInitGeneral()) {
184 throw sg_exception("General initialization failed");
187 ////////////////////////////////////////////////////////////////////
188 // Initialize the property-based built-in commands
189 ////////////////////////////////////////////////////////////////////
192 flightgear::registerSubsystemCommands(globals->get_commands());
194 ////////////////////////////////////////////////////////////////////
195 // Initialize the material manager
196 ////////////////////////////////////////////////////////////////////
197 globals->set_matlib( new SGMaterialLib );
198 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
199 simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
201 ////////////////////////////////////////////////////////////////////
202 // Initialize the TG scenery subsystem.
203 ////////////////////////////////////////////////////////////////////
205 globals->set_scenery( new FGScenery );
206 globals->get_scenery()->init();
207 globals->get_scenery()->bind();
208 globals->set_tile_mgr( new FGTileMgr );
210 fgSplashProgress("loading-aircraft");
212 } else if ( idle_state == 6 ) {
214 fgSplashProgress("creating-subsystems");
216 } else if ( idle_state == 7 ) {
220 fgCreateSubsystems();
221 SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
222 fgSplashProgress("binding-subsystems");
224 } else if ( idle_state == 8 ) {
228 globals->get_subsystem_mgr()->bind();
229 SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
231 fgSplashProgress("init-subsystems");
232 } else if ( idle_state == 9 ) {
233 SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
234 if ( status == SGSubsystem::INIT_DONE) {
236 fgSplashProgress("finishing-subsystems");
238 fgSplashProgress("init-subsystems");
241 } else if ( idle_state == 10 ) {
243 fgPostInitSubsystems();
244 fgSplashProgress("finalize-position");
245 } else if ( idle_state == 900 ) {
248 // setup OpenGL view parameters
249 globals->get_renderer()->setupView();
251 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
252 fgGetInt("/sim/startup/ysize") );
253 WindowSystemAdapter::getWSA()->windows[0]->gc->add(
254 new simgear::canvas::VGInitOperation()
257 int session = fgGetInt("/sim/session",0);
259 fgSetInt("/sim/session",session);
262 if ( idle_state == 1000 ) {
263 // We've finished all our initialization steps, from now on we
264 // run the main loop.
265 fgSetBool("sim/sceneryloaded", false);
270 static void upper_case_property(const char *name)
272 using namespace simgear;
273 SGPropertyNode *p = fgGetNode(name, false);
275 p = fgGetNode(name, true);
276 p->setStringValue("");
278 props::Type t = p->getType();
279 if (t == props::NONE || t == props::UNSPECIFIED)
280 p->setStringValue("");
282 assert(t == props::STRING);
284 p->addChangeListener(new FGMakeUpperCase);
287 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
288 // for the details of this.
289 static void ATIScreenSizeHack()
291 osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
292 hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
293 int prettyMuchAnyInt = 1;
294 hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
295 globals->get_renderer()->addCamera(hackCam, false);
298 // Propose NVIDIA Optimus to use high-end GPU
299 #if defined(SG_WINDOWS)
301 _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
305 static void logToFile()
307 SGPath logPath = globals->get_fg_home();
308 logPath.append("fgfs.log");
309 if (logPath.exists()) {
310 SGPath prevLogPath = globals->get_fg_home();
311 prevLogPath.append("fgfs_0.log");
312 logPath.rename(prevLogPath);
313 // bit strange, we need to restore the correct value of logPath now
314 logPath = globals->get_fg_home();
315 logPath.append("fgfs.log");
317 sglog().logToFile(logPath, SG_ALL, SG_INFO);
320 // Main top level initialization
321 int fgMainInit( int argc, char **argv ) {
323 // set default log levels
324 sglog().setLogLevels( SG_ALL, SG_ALERT );
326 globals = new FGGlobals;
329 // now home is initialised, we can log to a file inside it
333 #ifdef FLIGHTGEAR_VERSION
334 version = FLIGHTGEAR_VERSION;
336 version = "unknown version";
338 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
340 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
342 // Allocate global data structures. This needs to happen before
343 // we parse command line options
347 // seed the random number generator
350 string_list *col = new string_list;
351 globals->set_channel_options_list( col );
353 fgValidatePath("", false); // initialize static variables
354 upper_case_property("/sim/presets/airport-id");
355 upper_case_property("/sim/presets/runway");
356 upper_case_property("/sim/tower/airport-id");
357 upper_case_property("/autopilot/route-manager/input");
359 // Load the configuration parameters. (Command line options
360 // override config file options. Config file options override
362 int configResult = fgInitConfig(argc, argv);
363 if (configResult == flightgear::FG_OPTIONS_ERROR) {
365 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
369 // Initialize the Window/Graphics environment.
370 fgOSInit(&argc, argv);
373 fgRegisterIdleHandler( &fgIdleFunction );
375 // Initialize sockets (WinSock needs this)
376 simgear::Socket::initSockets();
378 // Clouds3D requires an alpha channel
379 fgOSOpenWindow(true /* request stencil buffer */);
381 // Initialize the splash screen right away
385 if (fgGetBool("/sim/ati-viewport-hack", true)) {
386 SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
392 // pass control off to the master event handler
393 int result = fgOSMainLoop();
395 // clean up here; ensure we null globals to avoid
396 // confusing the atexit() handler
400 // delete the NavCache here. This will cause the destruction of many cached
401 // objects (eg, airports, navaids, runways).
402 delete flightgear::NavDataCache::instance();