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();
99 static void initTerrasync()
101 if (fgGetBool("/sim/fghome-readonly", false)) {
105 // start TerraSync up now, so it can be synchronizing shared models
106 // and airports data in parallel with a nav-cache rebuild.
107 SGPath tsyncCache(globals->get_fg_home());
108 tsyncCache.append("terrasync-cache.xml");
110 // wipe the cache file if requested
111 if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
112 SG_LOG(SG_GENERAL, SG_INFO, "restore-defaults requested, wiping terrasync update cache at " <<
114 if (tsyncCache.exists()) {
119 fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
121 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync();
122 terra_sync->setRoot(globals->get_props());
123 globals->add_subsystem("terrasync", terra_sync);
128 // add the terrasync root as a data path so data can be retrieved from it
129 std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
130 globals->append_data_path(terraSyncDir);
133 static void registerMainLoop()
135 // stash current frame signal property
136 frame_signal = fgGetNode("/sim/signals/frame", true);
137 timeMgr = (TimeManager*) globals->get_subsystem("time");
138 fgRegisterIdleHandler( fgMainLoop );
141 // This is the top level master main function that is registered as
144 // The first few passes take care of initialization things (a couple
145 // per pass) and once everything has been initialized fgMainLoop from
148 static void fgIdleFunction ( void ) {
149 // Specify our current idle function state. This is used to run all
150 // our initializations out of the idle callback so that we can get a
151 // splash screen up and running right away.
152 static int idle_state = 0;
154 if ( idle_state == 0 ) {
158 fgSplashProgress("loading-aircraft-list");
161 } else if ( idle_state == 2 ) {
165 fgSplashProgress("loading-nav-dat");
167 } else if ( idle_state == 3 ) {
169 bool done = fgInitNav();
172 fgSplashProgress("init-scenery");
174 fgSplashProgress("loading-nav-dat");
177 } else if ( idle_state == 4 ) {
179 // based on the requested presets, calculate the true starting
181 flightgear::initPosition();
182 flightgear::initTowerLocationListener();
184 TimeManager* t = new TimeManager;
185 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
186 t->init(); // need to init now, not during initSubsystems
188 // Do some quick general initializations
189 if( !fgInitGeneral()) {
190 throw sg_exception("General initialization failed");
193 ////////////////////////////////////////////////////////////////////
194 // Initialize the property-based built-in commands
195 ////////////////////////////////////////////////////////////////////
198 flightgear::registerSubsystemCommands(globals->get_commands());
200 ////////////////////////////////////////////////////////////////////
201 // Initialize the material manager
202 ////////////////////////////////////////////////////////////////////
203 globals->set_matlib( new SGMaterialLib );
204 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
205 simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
207 ////////////////////////////////////////////////////////////////////
208 // Initialize the TG scenery subsystem.
209 ////////////////////////////////////////////////////////////////////
211 globals->set_scenery( new FGScenery );
212 globals->get_scenery()->init();
213 globals->get_scenery()->bind();
214 globals->set_tile_mgr( new FGTileMgr );
216 fgSplashProgress("loading-aircraft");
218 } else if ( idle_state == 6 ) {
220 fgSplashProgress("creating-subsystems");
222 } else if ( idle_state == 7 ) {
226 fgCreateSubsystems();
227 SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
228 fgSplashProgress("binding-subsystems");
230 } else if ( idle_state == 8 ) {
234 globals->get_subsystem_mgr()->bind();
235 SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
237 fgSplashProgress("init-subsystems");
238 } else if ( idle_state == 9 ) {
239 SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
240 if ( status == SGSubsystem::INIT_DONE) {
242 fgSplashProgress("finishing-subsystems");
244 fgSplashProgress("init-subsystems");
247 } else if ( idle_state == 10 ) {
249 fgPostInitSubsystems();
250 fgSplashProgress("finalize-position");
251 } else if ( idle_state == 900 ) {
254 // setup OpenGL view parameters
255 globals->get_renderer()->setupView();
257 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
258 fgGetInt("/sim/startup/ysize") );
259 WindowSystemAdapter::getWSA()->windows[0]->gc->add(
260 new simgear::canvas::VGInitOperation()
263 int session = fgGetInt("/sim/session",0);
265 fgSetInt("/sim/session",session);
268 if ( idle_state == 1000 ) {
269 // We've finished all our initialization steps, from now on we
270 // run the main loop.
271 fgSetBool("sim/sceneryloaded", false);
276 static void upper_case_property(const char *name)
278 using namespace simgear;
279 SGPropertyNode *p = fgGetNode(name, false);
281 p = fgGetNode(name, true);
282 p->setStringValue("");
284 props::Type t = p->getType();
285 if (t == props::NONE || t == props::UNSPECIFIED)
286 p->setStringValue("");
288 assert(t == props::STRING);
290 p->addChangeListener(new FGMakeUpperCase);
293 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
294 // for the details of this.
295 static void ATIScreenSizeHack()
297 osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
298 hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
299 int prettyMuchAnyInt = 1;
300 hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
301 globals->get_renderer()->addCamera(hackCam, false);
304 // Propose NVIDIA Optimus to use high-end GPU
305 #if defined(SG_WINDOWS)
307 _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
311 static void logToFile()
313 SGPath logPath = globals->get_fg_home();
314 logPath.append("fgfs.log");
315 if (logPath.exists()) {
316 SGPath prevLogPath = globals->get_fg_home();
317 prevLogPath.append("fgfs_0.log");
318 logPath.rename(prevLogPath);
319 // bit strange, we need to restore the correct value of logPath now
320 logPath = globals->get_fg_home();
321 logPath.append("fgfs.log");
323 sglog().logToFile(logPath, SG_ALL, SG_INFO);
326 // Main top level initialization
327 int fgMainInit( int argc, char **argv ) {
329 // set default log levels
330 sglog().setLogLevels( SG_ALL, SG_ALERT );
332 globals = new FGGlobals;
337 if (!fgGetBool("/sim/fghome-readonly")) {
338 // now home is initialised, we can log to a file inside it
343 #ifdef FLIGHTGEAR_VERSION
344 version = FLIGHTGEAR_VERSION;
346 version = "unknown version";
348 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
350 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
352 // Allocate global data structures. This needs to happen before
353 // we parse command line options
357 // seed the random number generator
360 string_list *col = new string_list;
361 globals->set_channel_options_list( col );
363 fgValidatePath("", false); // initialize static variables
364 upper_case_property("/sim/presets/airport-id");
365 upper_case_property("/sim/presets/runway");
366 upper_case_property("/sim/tower/airport-id");
367 upper_case_property("/autopilot/route-manager/input");
369 // Load the configuration parameters. (Command line options
370 // override config file options. Config file options override
372 int configResult = fgInitConfig(argc, argv);
373 if (configResult == flightgear::FG_OPTIONS_ERROR) {
375 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
379 // Initialize the Window/Graphics environment.
380 fgOSInit(&argc, argv);
383 fgRegisterIdleHandler( &fgIdleFunction );
385 // Initialize sockets (WinSock needs this)
386 simgear::Socket::initSockets();
388 // Clouds3D requires an alpha channel
389 fgOSOpenWindow(true /* request stencil buffer */);
390 fgOSResetProperties();
392 // Initialize the splash screen right away
396 if (fgGetBool("/sim/ati-viewport-hack", true)) {
397 SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
403 // pass control off to the master event handler
404 int result = fgOSMainLoop();
405 frame_signal.clear();
408 // clean up here; ensure we null globals to avoid
409 // confusing the atexit() handler
413 // delete the NavCache here. This will cause the destruction of many cached
414 // objects (eg, airports, navaids, runways).
415 delete flightgear::NavDataCache::instance();