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>
30 #if defined(__linux__) && defined(__i386__)
31 # include <fpu_control.h>
38 #include <osg/GraphicsContext>
39 #include <osgDB/Registry>
42 #include <simgear/scene/model/modellib.hxx>
43 #include <simgear/scene/material/matlib.hxx>
44 #include <simgear/scene/model/animation.hxx>
45 #include <simgear/scene/sky/sky.hxx>
46 #include <simgear/structure/event_mgr.hxx>
47 #include <simgear/props/AtomicChangeListener.hxx>
48 #include <simgear/props/props.hxx>
49 #include <simgear/timing/sg_time.hxx>
50 #include <simgear/magvar/magvar.hxx>
51 #include <simgear/math/sg_random.h>
52 #include <simgear/io/raw_socket.hxx>
53 #include <simgear/scene/tsync/terrasync.hxx>
54 #include <simgear/misc/sg_sleep.hxx>
56 #include <Time/light.hxx>
57 #include <Aircraft/replay.hxx>
58 #include <Aircraft/controls.hxx>
59 #include <Model/panelnode.hxx>
60 #include <Model/acmodel.hxx>
61 #include <Scenery/scenery.hxx>
62 #include <Scenery/tilemgr.hxx>
63 #include <Sound/fg_fx.hxx>
64 #include <Sound/beacon.hxx>
65 #include <Sound/morse.hxx>
66 #include <Sound/fg_fx.hxx>
67 #include <ATCDCL/ATCmgr.hxx>
68 #include <Time/TimeManager.hxx>
69 #include <Environment/environment_mgr.hxx>
70 #include <Environment/ephemeris.hxx>
72 #include <GUI/new_gui.hxx>
73 #include <MultiPlayer/multiplaymgr.hxx>
75 #include "CameraGroup.hxx"
76 #include "fg_commands.hxx"
78 #include "renderer.hxx"
82 #include "fg_init.hxx"
84 #include "WindowSystemAdapter.hxx"
85 #include <Main/viewer.hxx>
88 using namespace flightgear;
92 // Specify our current idle function state. This is used to run all
93 // our initializations out of the idle callback so that we can get a
94 // splash screen up and running right away.
98 void fgInitSoundManager();
99 void fgSetNewSoundDevice(const char *);
101 // The atexit() function handler should know when the graphical subsystem
103 extern int _bootstrap_OSInit;
105 // What should we do when we have nothing else to do? Let's get ready
106 // for the next move and update the display?
107 static void fgMainLoop( void ) {
109 static SGConstPropertyNode_ptr longitude
110 = fgGetNode("/position/longitude-deg");
111 static SGConstPropertyNode_ptr latitude
112 = fgGetNode("/position/latitude-deg");
113 static SGConstPropertyNode_ptr altitude
114 = fgGetNode("/position/altitude-ft");
115 static SGConstPropertyNode_ptr vn_fps
116 = fgGetNode("/velocities/speed-north-fps");
117 static SGConstPropertyNode_ptr ve_fps
118 = fgGetNode("/velocities/speed-east-fps");
119 static SGConstPropertyNode_ptr vd_fps
120 = fgGetNode("/velocities/speed-down-fps");
122 static SGPropertyNode_ptr frame_signal
123 = fgGetNode("/sim/signals/frame", true);
125 static SGPropertyNode_ptr _statisticsFlag
126 = fgGetNode("/sim/timing-statistics/enabled", true);
127 static SGPropertyNode_ptr _statisticsInterval
128 = fgGetNode("/sim/timing-statistics/interval-s", true);
129 static SGPropertyNode_ptr _statiticsMinJitter
130 = fgGetNode("/sim/timing-statistics/min-jitter-ms", true);
131 static SGPropertyNode_ptr _statiticsMinTime
132 = fgGetNode("/sim/timing-statistics/min-time-ms", true);
134 frame_signal->fireValueChanged();
135 SGCloudLayer::enable_bump_mapping = fgGetBool("/sim/rendering/bump-mapping");
137 SG_LOG( SG_GENERAL, SG_DEBUG, "Running Main Loop");
138 SG_LOG( SG_GENERAL, SG_DEBUG, "======= ==== ====");
142 double sim_dt, real_dt;
143 TimeManager* timeMgr = (TimeManager*) globals->get_subsystem("time");
144 // compute simulated time (allowing for pause, warp, etc) and
146 timeMgr->computeTimeDeltas(sim_dt, real_dt);
148 // update magvar model
149 globals->get_mag()->update( longitude->getDoubleValue()
150 * SGD_DEGREES_TO_RADIANS,
151 latitude->getDoubleValue()
152 * SGD_DEGREES_TO_RADIANS,
153 altitude->getDoubleValue() * SG_FEET_TO_METER,
154 globals->get_time_params()->getJD() );
157 globals->get_ATC_mgr()->update(sim_dt);
159 globals->get_subsystem_mgr()->update(sim_dt);
161 // Update the sound manager last so it can use the CPU while the GPU
162 // is processing the scenery (doubled the frame-rate for me) -EMH-
163 #ifdef ENABLE_AUDIO_SUPPORT
164 static bool smgr_init = true;
165 static SGPropertyNode *sound_working = fgGetNode("/sim/sound/working");
166 if (smgr_init == true) {
167 if (sound_working->getBoolValue() == true) {
168 fgInitSoundManager();
172 static SGPropertyNode *sound_enabled = fgGetNode("/sim/sound/enabled");
173 static SGSoundMgr *smgr = globals->get_soundmgr();
174 static bool smgr_enabled = true;
176 if (sound_working->getBoolValue() == false) { // request to reinit
179 sound_working->setBoolValue(true);
182 if (smgr_enabled != sound_enabled->getBoolValue()) {
183 if (smgr_enabled == true) { // request to suspend
185 smgr_enabled = false;
192 if (smgr_enabled == true) {
193 static SGPropertyNode *volume = fgGetNode("/sim/sound/volume");
194 smgr->set_volume(volume->getFloatValue());
195 smgr->update(sim_dt);
200 // END Tile Manager updates
201 bool scenery_loaded = fgGetBool("sim/sceneryloaded");
204 if (globals->get_tile_mgr()->isSceneryLoaded()
205 && fgGetBool("sim/fdm-initialized")) {
206 fgSetBool("sim/sceneryloaded",true);
207 fgSplashProgress("");
208 if (fgGetBool("/sim/sound/working")) {
209 globals->get_soundmgr()->activate();
211 globals->get_props()->tie("/sim/sound/devices/name",
212 SGRawValueFunctions<const char *>(0, fgSetNewSoundDevice), false);
216 fgSplashProgress("loading scenery");
217 // be nice to loader threads while waiting for initial scenery, reduce to 2fps
218 simgear::sleepForMSec(500);
222 // print timing statistics
223 static bool _lastStatisticsFlag = false;
224 if (_lastStatisticsFlag != _statisticsFlag->getBoolValue())
226 // flag has changed, update subsystem manager
227 _lastStatisticsFlag = _statisticsFlag->getBoolValue();
228 globals->get_subsystem_mgr()->collectDebugTiming(_lastStatisticsFlag);
230 if (_lastStatisticsFlag)
232 static double elapsed = 0;
234 if (elapsed >= _statisticsInterval->getDoubleValue())
236 // print and reset timing statistics
237 globals->get_subsystem_mgr()->printTimingStatistics(_statiticsMinTime->getDoubleValue(),
238 _statiticsMinJitter->getDoubleValue());
243 simgear::AtomicChangeListener::fireChangeListeners();
245 SG_LOG( SG_GENERAL, SG_DEBUG, "" );
248 void fgInitSoundManager()
250 SGSoundMgr *smgr = globals->get_soundmgr();
253 smgr->init(fgGetString("/sim/sound/device-name", NULL));
255 vector <const char*>devices = smgr->get_available_devices();
256 for (unsigned int i=0; i<devices.size(); i++) {
257 SGPropertyNode *p = fgGetNode("/sim/sound/devices/device", i, true);
258 p->setStringValue(devices[i]);
263 void fgSetNewSoundDevice(const char *device)
265 globals->get_soundmgr()->suspend();
266 globals->get_soundmgr()->stop();
267 globals->get_soundmgr()->init(device);
268 globals->get_soundmgr()->resume();
271 // Operation for querying OpenGL parameters. This must be done in a
272 // valid OpenGL context, potentially in another thread.
275 struct GeneralInitOperation : public GraphicsContextOperation
277 GeneralInitOperation()
278 : GraphicsContextOperation(std::string("General init"))
281 void run(osg::GraphicsContext* gc)
283 SGPropertyNode* simRendering = fgGetNode("/sim/rendering");
285 simRendering->setStringValue("gl-vendor", (char*) glGetString(GL_VENDOR));
286 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VENDOR));
288 simRendering->setStringValue("gl-renderer", (char*) glGetString(GL_RENDERER));
289 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_RENDERER));
291 simRendering->setStringValue("gl-version", (char*) glGetString(GL_VERSION));
292 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VERSION));
295 glGetIntegerv( GL_MAX_TEXTURE_SIZE, &tmp );
296 simRendering->setIntValue("max-texture-size", tmp);
298 glGetIntegerv( GL_DEPTH_BITS, &tmp );
299 simRendering->setIntValue("depth-buffer-bits", tmp);
304 osg::Node* load_panel(SGPropertyNode *n)
306 osg::Geode* geode = new osg::Geode;
307 geode->addDrawable(new FGPanelNode(n));
311 SGPath resolve_path(const std::string& s)
313 return globals->resolve_maybe_aircraft_path(s);
318 // This is the top level master main function that is registered as
321 // The first few passes take care of initialization things (a couple
322 // per pass) and once everything has been initialized fgMainLoop from
325 static void fgIdleFunction ( void ) {
326 static osg::ref_ptr<GeneralInitOperation> genOp;
327 if ( idle_state == 0 ) {
329 // Pick some window on which to do queries.
330 // XXX Perhaps all this graphics initialization code should be
331 // moved to renderer.cxx?
332 genOp = new GeneralInitOperation;
333 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
334 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
335 osg::GraphicsContext* gc = 0;
337 gc = guiCamera->getGraphicsContext();
339 gc->add(genOp.get());
341 wsa->windows[0]->gc->add(genOp.get());
344 } else if ( idle_state == 1 ) {
346 if (!genOp->isFinished())
350 if (!guiFinishInit())
353 fgSplashProgress("loading aircraft list");
355 } else if ( idle_state == 2 ) {
357 fgSplashProgress("loading navigation data");
359 } else if ( idle_state == 3 ) {
363 fgSplashProgress("initializing scenery system");
365 } else if ( idle_state == 4 ) {
367 // based on the requested presets, calculate the true starting
370 fgInitTowerLocationListener();
372 TimeManager* t = new TimeManager;
373 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
374 t->init(); // need to init now, not during initSubsystems
376 // Do some quick general initializations
377 if( !fgInitGeneral()) {
378 SG_LOG( SG_GENERAL, SG_ALERT,
379 "General initialization failed ..." );
383 ////////////////////////////////////////////////////////////////////
384 // Initialize the property-based built-in commands
385 ////////////////////////////////////////////////////////////////////
388 ////////////////////////////////////////////////////////////////////
389 // Initialize the material manager
390 ////////////////////////////////////////////////////////////////////
391 globals->set_matlib( new SGMaterialLib );
392 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
393 simgear::SGModelLib::setPanelFunc(load_panel);
395 ////////////////////////////////////////////////////////////////////
396 // Initialize the TG scenery subsystem.
397 ////////////////////////////////////////////////////////////////////
398 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync(globals->get_props());
399 globals->add_subsystem("terrasync", terra_sync);
400 globals->set_scenery( new FGScenery );
401 globals->get_scenery()->init();
402 globals->get_scenery()->bind();
403 globals->set_tile_mgr( new FGTileMgr );
405 fgSplashProgress("loading aircraft");
407 } else if ( idle_state == 5 ) {
410 fgSplashProgress("initializing sky elements");
412 } else if ( idle_state == 6 ) {
414 // Initialize the sky
416 Ephemeris* eph = new Ephemeris;
417 globals->add_subsystem("ephemeris", eph);
418 eph->init(); // FIXME - remove this once SGSky code below is also a subsystem
421 // TODO: move to environment mgr
423 SGPath texture_path(globals->get_fg_root());
424 texture_path.append("Textures");
425 texture_path.append("Sky");
426 for (int i = 0; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
427 SGCloudLayer * layer = new SGCloudLayer(texture_path.str());
428 thesky->add_cloud_layer(layer);
431 SGPath sky_tex_path( globals->get_fg_root() );
432 sky_tex_path.append( "Textures" );
433 sky_tex_path.append( "Sky" );
434 thesky->texture_path( sky_tex_path.str() );
436 // The sun and moon diameters are scaled down numbers of the
437 // actual diameters. This was needed to fit both the sun and the
438 // moon within the distance to the far clip plane.
439 // Moon diameter: 3,476 kilometers
440 // Sun diameter: 1,390,000 kilometers
441 thesky->build( 80000.0, 80000.0,
443 *globals->get_ephem(),
444 fgGetNode("/environment", true));
446 // Initialize MagVar model
447 SGMagVar *magvar = new SGMagVar();
448 globals->set_mag( magvar );
451 // kludge to initialize mag compass
452 // (should only be done for in-flight
454 // update magvar model
455 globals->get_mag()->update( fgGetDouble("/position/longitude-deg")
456 * SGD_DEGREES_TO_RADIANS,
457 fgGetDouble("/position/latitude-deg")
458 * SGD_DEGREES_TO_RADIANS,
459 fgGetDouble("/position/altitude-ft")
461 globals->get_time_params()->getJD() );
462 double var = globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
463 fgSetDouble("/instrumentation/heading-indicator/offset-deg", -var);
464 fgSetDouble("/instrumentation/heading-indicator-fg/offset-deg", -var);
467 // airport = new ssgBranch;
468 // airport->setName( "Airport Lighting" );
469 // lighting->addKid( airport );
471 fgSplashProgress("initializing subsystems");
473 } else if ( idle_state == 7 ) {
475 // Initialize audio support
476 #ifdef ENABLE_AUDIO_SUPPORT
478 // Start the intro music
479 if ( fgGetBool("/sim/startup/intro-music") ) {
480 SGPath mp3file( globals->get_fg_root() );
481 mp3file.append( "Sounds/intro.mp3" );
483 SG_LOG( SG_GENERAL, SG_INFO,
484 "Starting intro music: " << mp3file.str() );
486 # if defined( __CYGWIN__ )
487 string command = "start /m `cygpath -w " + mp3file.str() + "`";
488 # elif defined( _WIN32 )
489 string command = "start /m " + mp3file.str();
491 string command = "mpg123 " + mp3file.str() + "> /dev/null 2>&1";
494 system ( command.c_str() );
497 // This is the top level init routine which calls all the
498 // other subsystem initialization routines. If you are adding
499 // a subsystem to flightgear, its initialization call should be
500 // located in this routine.
501 if( !fgInitSubsystems()) {
502 SG_LOG( SG_GENERAL, SG_ALERT,
503 "Subsystem initialization failed ..." );
508 // ugly hack for automatic runway selection on startup based on
509 // metar data. Makes startup.nas obsolete and guarantees the same
510 // runway selection as for AI traffic. However, this code belongs to
511 // somewhere(?) else - if I only new where...
512 if( true == fgGetBool( "/environment/metar/valid" ) ) {
513 // the realwx_ctrl fetches metar in the foreground on init,
514 // If it was able to fetch a metar or one was given on the commandline,
515 // the valid flag is set here, otherwise it is false
516 double hdg = fgGetDouble( "/environment/metar/base-wind-dir-deg", 9999.0 );
517 string apt = fgGetString( "/sim/startup/options/airport" );
518 string rwy = fgGetString( "/sim/startup/options/runway" );
519 double strthdg = fgGetDouble( "/sim/startup/options/heading-deg", 9999.0 );
520 string parkpos = fgGetString( "/sim/presets/parkpos" );
521 bool onground = fgGetBool( "/sim/presets/onground", false );
522 // don't check for wind-speed < 1kt, this belongs to the runway-selection code
523 // the other logic is taken from former startup.nas
524 if( hdg < 360.0 && apt.length() > 0 && strthdg > 360.0 && rwy.length() == 0 && onground && parkpos.length() == 0 ) {
525 extern bool fgSetPosFromAirportIDandHdg( const string& id, double tgt_hdg );
526 fgSetPosFromAirportIDandHdg( apt, hdg );
530 fgSplashProgress("initializing graphics engine");
532 } else if ( idle_state == 8 ) {
535 // setup OpenGL view parameters
536 globals->get_renderer()->setupView();
538 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
539 fgGetInt("/sim/startup/ysize") );
541 int session = fgGetInt("/sim/session",0);
543 fgSetInt("/sim/session",session);
546 if ( idle_state == 1000 ) {
547 // We've finished all our initialization steps, from now on we
548 // run the main loop.
549 fgSetBool("sim/sceneryloaded", false);
550 fgRegisterIdleHandler( fgMainLoop );
554 static void fgWinResizeFunction(int width, int height)
556 globals->get_renderer()->resize(width, height);
559 static void upper_case_property(const char *name)
561 using namespace simgear;
562 SGPropertyNode *p = fgGetNode(name, false);
564 p = fgGetNode(name, true);
565 p->setStringValue("");
567 props::Type t = p->getType();
568 if (t == props::NONE || t == props::UNSPECIFIED)
569 p->setStringValue("");
571 assert(t == props::STRING);
573 p->addChangeListener(new FGMakeUpperCase);
577 // Main top level initialization
578 int fgMainInit( int argc, char **argv ) {
580 // set default log levels
581 sglog().setLogLevels( SG_ALL, SG_ALERT );
584 #ifdef FLIGHTGEAR_VERSION
585 version = FLIGHTGEAR_VERSION;
587 version = "unknown version";
589 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
591 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << endl );
593 // Allocate global data structures. This needs to happen before
594 // we parse command line options
596 globals = new FGGlobals;
598 // seed the random number generator
601 FGControls *controls = new FGControls;
602 globals->set_controls( controls );
604 string_list *col = new string_list;
605 globals->set_channel_options_list( col );
607 fgValidatePath("", false); // initialize static variables
608 upper_case_property("/sim/presets/airport-id");
609 upper_case_property("/sim/presets/runway");
610 upper_case_property("/sim/tower/airport-id");
611 upper_case_property("/autopilot/route-manager/input");
613 // Scan the config file(s) and command line options to see if
614 // fg_root was specified (ignore all other options for now)
615 fgInitFGRoot(argc, argv);
617 // Check for the correct base package version
618 static char required_version[] = "2.5.0";
619 string base_version = fgBasePackageVersion();
620 if ( !(base_version == required_version) ) {
621 // tell the operator how to use this application
623 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
624 cerr << endl << "Base package check failed:" << endl \
625 << " Version " << base_version << " found at: " \
626 << globals->get_fg_root() << endl \
627 << " Version " << required_version << " is required." << endl \
628 << "Please upgrade/downgrade base package and set the path to your fgdata" << endl \
629 << "with --fg-root=path_to_your_fgdata" << endl;
631 cerr << "Hit a key to continue..." << endl;
637 // Load the configuration parameters. (Command line options
638 // override config file options. Config file options override
640 if ( !fgInitConfig(argc, argv) ) {
641 SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
645 // Initialize the Window/Graphics environment.
646 fgOSInit(&argc, argv);
649 fgRegisterWindowResizeHandler( &fgWinResizeFunction );
650 fgRegisterIdleHandler( &fgIdleFunction );
651 fgRegisterDrawHandler( &FGRenderer::update );
653 // Initialize sockets (WinSock needs this)
654 simgear::Socket::initSockets();
656 // Clouds3D requires an alpha channel
657 fgOSOpenWindow(true /* request stencil buffer */);
659 // Initialize the splash screen right away
663 // pass control off to the master event handler
664 int result = fgOSMainLoop();
666 // clean up here; ensure we null globals to avoid
667 // confusing the atexit() handler