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>
36 #if defined(HAVE_CRASHRPT)
39 // defined in bootstrap.cxx
40 extern bool global_crashRptEnabled;
45 #include <simgear/canvas/VGInitOperation.hxx>
46 #include <simgear/scene/model/modellib.hxx>
47 #include <simgear/scene/material/matlib.hxx>
48 #include <simgear/scene/material/Effect.hxx>
49 #include <simgear/props/AtomicChangeListener.hxx>
50 #include <simgear/props/props.hxx>
51 #include <simgear/timing/sg_time.hxx>
52 #include <simgear/io/raw_socket.hxx>
53 #include <simgear/scene/tsync/terrasync.hxx>
54 #include <simgear/math/SGMath.hxx>
55 #include <simgear/math/sg_random.h>
56 #include <simgear/misc/strutils.hxx>
58 #include <Model/panelnode.hxx>
59 #include <Scenery/scenery.hxx>
60 #include <Scenery/tilemgr.hxx>
61 #include <Sound/soundmanager.hxx>
62 #include <Time/TimeManager.hxx>
64 #include <GUI/MessageBox.hxx>
65 #include <Viewer/splash.hxx>
66 #include <Viewer/renderer.hxx>
67 #include <Viewer/WindowSystemAdapter.hxx>
68 #include <Navaids/NavDataCache.hxx>
69 #include <Include/version.h>
71 #include "fg_commands.hxx"
75 #include "fg_init.hxx"
77 #include "fg_props.hxx"
78 #include "positioninit.hxx"
79 #include "screensaver_control.hxx"
80 #include "subsystemFactory.hxx"
81 #include "options.hxx"
84 using namespace flightgear;
89 // The atexit() function handler should know when the graphical subsystem
91 extern int _bootstrap_OSInit;
93 static SGPropertyNode_ptr frame_signal;
94 static TimeManager* timeMgr;
96 // What should we do when we have nothing else to do? Let's get ready
97 // for the next move and update the display?
98 static void fgMainLoop( void )
100 frame_signal->fireValueChanged();
102 // compute simulated time (allowing for pause, warp, etc) and
104 double sim_dt, real_dt;
105 timeMgr->computeTimeDeltas(sim_dt, real_dt);
107 // update all subsystems
108 globals->get_subsystem_mgr()->update(sim_dt);
110 simgear::AtomicChangeListener::fireChangeListeners();
113 static void initTerrasync()
115 // add the terrasync root as a data path so data can be retrieved from it
116 // (even if we are in read-only mode)
117 std::string terraSyncDir(fgGetString("/sim/terrasync/scenery-dir"));
118 globals->append_data_path(terraSyncDir);
120 if (fgGetBool("/sim/fghome-readonly", false)) {
124 // start TerraSync up now, so it can be synchronizing shared models
125 // and airports data in parallel with a nav-cache rebuild.
126 SGPath tsyncCache(globals->get_fg_home());
127 tsyncCache.append("terrasync-cache.xml");
129 // wipe the cache file if requested
130 if (flightgear::Options::sharedInstance()->isOptionSet("restore-defaults")) {
131 SG_LOG(SG_GENERAL, SG_INFO, "restore-defaults requested, wiping terrasync update cache at " <<
133 if (tsyncCache.exists()) {
138 fgSetString("/sim/terrasync/cache-path", tsyncCache.c_str());
140 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync();
141 terra_sync->setRoot(globals->get_props());
142 globals->add_subsystem("terrasync", terra_sync);
148 static void checkOpenGLVersion()
151 // Mac users can't upgrade their drivers, so complaining about
152 // versions doesn't help them much
156 // format of these strings is not standardised, so be careful about
158 std::string versionString(fgGetString("/sim/rendering/gl-version"));
159 string_list parts = simgear::strutils::split(versionString);
160 if (parts.size() == 3) {
161 if (parts[1].find("NVIDIA") != std::string::npos) {
162 // driver version number, dot-seperared
163 string_list driverVersion = simgear::strutils::split(parts[2], ".");
164 if (!driverVersion.empty()) {
165 int majorDriverVersion = simgear::strutils::to_int(driverVersion[0]);
166 if (majorDriverVersion < 300) {
167 std::ostringstream ss;
168 ss << "Please upgrade to at least version 300 of the nVidia drivers (installed version is " << parts[2] << ")";
170 flightgear::modalMessageBox("Outdated graphics drivers",
171 "FlightGear has detected outdated drivers for your graphics card.",
175 } // of NVIDIA-style version string
179 static void registerMainLoop()
181 // stash current frame signal property
182 frame_signal = fgGetNode("/sim/signals/frame", true);
183 timeMgr = (TimeManager*) globals->get_subsystem("time");
184 fgRegisterIdleHandler( fgMainLoop );
187 // This is the top level master main function that is registered as
190 // The first few passes take care of initialization things (a couple
191 // per pass) and once everything has been initialized fgMainLoop from
194 static int idle_state = 0;
196 static void fgIdleFunction ( void ) {
197 // Specify our current idle function state. This is used to run all
198 // our initializations out of the idle callback so that we can get a
199 // splash screen up and running right away.
201 if ( idle_state == 0 ) {
204 checkOpenGLVersion();
206 fgSplashProgress("loading-aircraft-list");
209 } else if ( idle_state == 2 ) {
212 fgSplashProgress("loading-nav-dat");
214 } else if ( idle_state == 3 ) {
216 bool done = fgInitNav();
219 fgSplashProgress("init-scenery");
221 fgSplashProgress("loading-nav-dat");
224 } else if ( idle_state == 4 ) {
227 TimeManager* t = new TimeManager;
228 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
230 // Do some quick general initializations
231 if( !fgInitGeneral()) {
232 throw sg_exception("General initialization failed");
235 ////////////////////////////////////////////////////////////////////
236 // Initialize the property-based built-in commands
237 ////////////////////////////////////////////////////////////////////
240 flightgear::registerSubsystemCommands(globals->get_commands());
242 ////////////////////////////////////////////////////////////////////
243 // Initialize the material manager
244 ////////////////////////////////////////////////////////////////////
245 globals->set_matlib( new SGMaterialLib );
246 simgear::SGModelLib::setPanelFunc(FGPanelNode::load);
248 } else if (( idle_state == 5 ) || (idle_state == 2005)) {
250 flightgear::initPosition();
251 flightgear::initTowerLocationListener();
253 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
255 TimeManager* timeManager = (TimeManager*) globals->get_subsystem("time");
258 ////////////////////////////////////////////////////////////////////
259 // Initialize the TG scenery subsystem.
260 ////////////////////////////////////////////////////////////////////
262 globals->set_scenery( new FGScenery );
263 globals->get_scenery()->init();
264 globals->get_scenery()->bind();
265 globals->set_tile_mgr( new FGTileMgr );
267 fgSplashProgress("creating-subsystems");
268 } else if (( idle_state == 7 ) || (idle_state == 2007)) {
269 bool isReset = (idle_state == 2007);
270 idle_state = 8; // from the next state on, reset & startup are identical
273 fgCreateSubsystems(isReset);
274 SG_LOG(SG_GENERAL, SG_INFO, "Creating subsystems took:" << st.elapsedMSec());
275 fgSplashProgress("binding-subsystems");
277 } else if ( idle_state == 8 ) {
281 globals->get_subsystem_mgr()->bind();
282 SG_LOG(SG_GENERAL, SG_INFO, "Binding subsystems took:" << st.elapsedMSec());
284 fgSplashProgress("init-subsystems");
285 } else if ( idle_state == 9 ) {
286 SGSubsystem::InitStatus status = globals->get_subsystem_mgr()->incrementalInit();
287 if ( status == SGSubsystem::INIT_DONE) {
289 fgSplashProgress("finishing-subsystems");
291 fgSplashProgress("init-subsystems");
294 } else if ( idle_state == 10 ) {
296 fgPostInitSubsystems();
297 fgSplashProgress("finalize-position");
298 } else if ( idle_state == 900 ) {
301 // setup OpenGL view parameters
302 globals->get_renderer()->setupView();
304 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
305 fgGetInt("/sim/startup/ysize") );
306 WindowSystemAdapter::getWSA()->windows[0]->gc->add(
307 new simgear::canvas::VGInitOperation()
310 int session = fgGetInt("/sim/session",0);
312 fgSetInt("/sim/session",session);
315 if ( idle_state == 1000 ) {
316 // We've finished all our initialization steps, from now on we
317 // run the main loop.
318 fgSetBool("sim/sceneryloaded", false);
322 if ( idle_state == 2000 ) {
328 void fgResetIdleState()
331 fgRegisterIdleHandler( &fgIdleFunction );
335 static void upper_case_property(const char *name)
337 using namespace simgear;
338 SGPropertyNode *p = fgGetNode(name, false);
340 p = fgGetNode(name, true);
341 p->setStringValue("");
343 props::Type t = p->getType();
344 if (t == props::NONE || t == props::UNSPECIFIED)
345 p->setStringValue("");
347 assert(t == props::STRING);
349 SGPropertyChangeListener* muc = new FGMakeUpperCase;
350 globals->addListenerToCleanup(muc);
351 p->addChangeListener(muc);
354 // see http://code.google.com/p/flightgear-bugs/issues/detail?id=385
355 // for the details of this.
356 static void ATIScreenSizeHack()
358 osg::ref_ptr<osg::Camera> hackCam = new osg::Camera;
359 hackCam->setRenderOrder(osg::Camera::PRE_RENDER);
360 int prettyMuchAnyInt = 1;
361 hackCam->setViewport(0, 0, prettyMuchAnyInt, prettyMuchAnyInt);
362 globals->get_renderer()->addCamera(hackCam, false);
365 // Propose NVIDIA Optimus to use high-end GPU
366 #if defined(SG_WINDOWS)
368 _declspec(dllexport) DWORD NvOptimusEnablement = 0x00000001;
372 static void logToFile()
374 SGPath logPath = globals->get_fg_home();
375 logPath.append("fgfs.log");
376 if (logPath.exists()) {
377 SGPath prevLogPath = globals->get_fg_home();
378 prevLogPath.append("fgfs_0.log");
379 logPath.rename(prevLogPath);
380 // bit strange, we need to restore the correct value of logPath now
381 logPath = globals->get_fg_home();
382 logPath.append("fgfs.log");
384 sglog().logToFile(logPath, SG_ALL, SG_INFO);
386 #if defined(HAVE_CRASHRPT)
387 if (global_crashRptEnabled) {
388 crAddFile2(logPath.c_str(), NULL, "FlightGear Log File", CR_AF_MAKE_FILE_COPY);
389 SG_LOG( SG_GENERAL, SG_INFO, "CrashRpt enabled");
391 SG_LOG(SG_GENERAL, SG_WARN, "CrashRpt enabled at compile time but failed to install");
396 // Main top level initialization
397 int fgMainInit( int argc, char **argv ) {
399 // set default log levels
400 sglog().setLogLevels( SG_ALL, SG_ALERT );
402 globals = new FGGlobals;
407 if (!fgGetBool("/sim/fghome-readonly")) {
408 // now home is initialised, we can log to a file inside it
413 #ifdef FLIGHTGEAR_VERSION
414 version = FLIGHTGEAR_VERSION;
416 version = "unknown version";
418 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
420 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR);
421 SG_LOG( SG_GENERAL, SG_INFO, "Jenkins number/ID " << HUDSON_BUILD_NUMBER << ":"
424 // Allocate global data structures. This needs to happen before
425 // we parse command line options
429 // seed the random number generator
432 string_list *col = new string_list;
433 globals->set_channel_options_list( col );
435 fgValidatePath("", false); // initialize static variables
436 upper_case_property("/sim/presets/airport-id");
437 upper_case_property("/sim/presets/runway");
438 upper_case_property("/sim/tower/airport-id");
439 upper_case_property("/autopilot/route-manager/input");
441 // Load the configuration parameters. (Command line options
442 // override config file options. Config file options override
444 int configResult = fgInitConfig(argc, argv, false);
445 if (configResult == flightgear::FG_OPTIONS_ERROR) {
447 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
451 configResult = fgInitAircraft(false);
452 if (configResult == flightgear::FG_OPTIONS_ERROR) {
454 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
458 configResult = flightgear::Options::sharedInstance()->processOptions();
459 if (configResult == flightgear::FG_OPTIONS_ERROR) {
461 } else if (configResult == flightgear::FG_OPTIONS_EXIT) {
465 // Initialize the Window/Graphics environment.
466 fgOSInit(&argc, argv);
469 fgRegisterIdleHandler( &fgIdleFunction );
471 // Initialize sockets (WinSock needs this)
472 simgear::Socket::initSockets();
474 // Clouds3D requires an alpha channel
475 fgOSOpenWindow(true /* request stencil buffer */);
476 fgOSResetProperties();
478 // Initialize the splash screen right away
482 if (fgGetBool("/sim/ati-viewport-hack", true)) {
483 SG_LOG(SG_GENERAL, SG_ALERT, "Enabling ATI viewport hack");
489 //try to disable the screensaver
490 fgOSDisableScreensaver();
492 // pass control off to the master event handler
493 int result = fgOSMainLoop();
494 frame_signal.clear();
497 simgear::clearEffectCache();
499 // clean up here; ensure we null globals to avoid
500 // confusing the atexit() handler
504 // delete the NavCache here. This will cause the destruction of many cached
505 // objects (eg, airports, navaids, runways).
506 delete flightgear::NavDataCache::instance();