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/misc/sg_sleep.hxx>
55 #include <Time/light.hxx>
56 #include <Aircraft/replay.hxx>
57 #include <Aircraft/controls.hxx>
58 #include <Model/panelnode.hxx>
59 #include <Model/acmodel.hxx>
60 #include <Scenery/scenery.hxx>
61 #include <Scenery/tilemgr.hxx>
62 #include <Sound/fg_fx.hxx>
63 #include <Sound/beacon.hxx>
64 #include <Sound/morse.hxx>
65 #include <Sound/fg_fx.hxx>
66 #include <ATCDCL/ATCmgr.hxx>
67 #include <Time/TimeManager.hxx>
68 #include <Environment/environment_mgr.hxx>
69 #include <Environment/ephemeris.hxx>
71 #include <GUI/new_gui.hxx>
72 #include <MultiPlayer/multiplaymgr.hxx>
74 #include "CameraGroup.hxx"
75 #include "fg_commands.hxx"
77 #include "renderer.hxx"
81 #include "fg_init.hxx"
83 #include "WindowSystemAdapter.hxx"
84 #include <Main/viewer.hxx>
87 using namespace flightgear;
91 // Specify our current idle function state. This is used to run all
92 // our initializations out of the idle callback so that we can get a
93 // splash screen up and running right away.
97 void fgInitSoundManager();
98 void fgSetNewSoundDevice(const char *);
100 // The atexit() function handler should know when the graphical subsystem
102 extern int _bootstrap_OSInit;
104 // What should we do when we have nothing else to do? Let's get ready
105 // for the next move and update the display?
106 static void fgMainLoop( void ) {
108 static SGConstPropertyNode_ptr longitude
109 = fgGetNode("/position/longitude-deg");
110 static SGConstPropertyNode_ptr latitude
111 = fgGetNode("/position/latitude-deg");
112 static SGConstPropertyNode_ptr altitude
113 = fgGetNode("/position/altitude-ft");
114 static SGConstPropertyNode_ptr vn_fps
115 = fgGetNode("/velocities/speed-north-fps");
116 static SGConstPropertyNode_ptr ve_fps
117 = fgGetNode("/velocities/speed-east-fps");
118 static SGConstPropertyNode_ptr vd_fps
119 = fgGetNode("/velocities/speed-down-fps");
121 static SGPropertyNode_ptr frame_signal
122 = fgGetNode("/sim/signals/frame", true);
124 static SGPropertyNode_ptr _statisticsFlag
125 = fgGetNode("/sim/timing-statistics/enabled", true);
126 static SGPropertyNode_ptr _statisticsInterval
127 = fgGetNode("/sim/timing-statistics/interval-s", true);
128 static SGPropertyNode_ptr _statiticsMinJitter
129 = fgGetNode("/sim/timing-statistics/min-jitter-ms", true);
130 static SGPropertyNode_ptr _statiticsMinTime
131 = fgGetNode("/sim/timing-statistics/min-time-ms", true);
133 frame_signal->fireValueChanged();
134 SGCloudLayer::enable_bump_mapping = fgGetBool("/sim/rendering/bump-mapping");
136 SG_LOG( SG_ALL, SG_DEBUG, "Running Main Loop");
137 SG_LOG( SG_ALL, SG_DEBUG, "======= ==== ====");
141 double sim_dt, real_dt;
142 TimeManager* timeMgr = (TimeManager*) globals->get_subsystem("time");
143 // compute simulated time (allowing for pause, warp, etc) and
145 timeMgr->computeTimeDeltas(sim_dt, real_dt);
147 // update magvar model
148 globals->get_mag()->update( longitude->getDoubleValue()
149 * SGD_DEGREES_TO_RADIANS,
150 latitude->getDoubleValue()
151 * SGD_DEGREES_TO_RADIANS,
152 altitude->getDoubleValue() * SG_FEET_TO_METER,
153 globals->get_time_params()->getJD() );
156 globals->get_ATC_mgr()->update(sim_dt);
158 globals->get_subsystem_mgr()->update(sim_dt);
160 // Update the sound manager last so it can use the CPU while the GPU
161 // is processing the scenery (doubled the frame-rate for me) -EMH-
162 #ifdef ENABLE_AUDIO_SUPPORT
163 static bool smgr_init = true;
164 static SGPropertyNode *sound_working = fgGetNode("/sim/sound/working");
165 if (smgr_init == true) {
166 if (sound_working->getBoolValue() == true) {
167 fgInitSoundManager();
171 static SGPropertyNode *sound_enabled = fgGetNode("/sim/sound/enabled");
172 static SGSoundMgr *smgr = globals->get_soundmgr();
173 static bool smgr_enabled = true;
175 if (sound_working->getBoolValue() == false) { // request to reinit
178 sound_working->setBoolValue(true);
181 if (smgr_enabled != sound_enabled->getBoolValue()) {
182 if (smgr_enabled == true) { // request to suspend
184 smgr_enabled = false;
191 if (smgr_enabled == true) {
192 static SGPropertyNode *volume = fgGetNode("/sim/sound/volume");
193 smgr->set_volume(volume->getFloatValue());
194 smgr->update(sim_dt);
199 // END Tile Manager updates
200 bool scenery_loaded = fgGetBool("sim/sceneryloaded");
203 if (globals->get_tile_mgr()->isSceneryLoaded()
204 && fgGetBool("sim/fdm-initialized")) {
205 fgSetBool("sim/sceneryloaded",true);
206 fgSplashProgress("");
207 if (fgGetBool("/sim/sound/working")) {
208 globals->get_soundmgr()->activate();
210 globals->get_props()->tie("/sim/sound/devices/name",
211 SGRawValueFunctions<const char *>(0, fgSetNewSoundDevice), false);
215 // be nice to loader threads while waiting for initial scenery, reduce to 2fps
216 simgear::sleepForMSec(500);
220 // print timing statistics
221 static bool _lastStatisticsFlag = false;
222 if (_lastStatisticsFlag != _statisticsFlag->getBoolValue())
224 // flag has changed, update subsystem manager
225 _lastStatisticsFlag = _statisticsFlag->getBoolValue();
226 globals->get_subsystem_mgr()->collectDebugTiming(_lastStatisticsFlag);
228 if (_lastStatisticsFlag)
230 static double elapsed = 0;
232 if (elapsed >= _statisticsInterval->getDoubleValue())
234 // print and reset timing statistics
235 globals->get_subsystem_mgr()->printTimingStatistics(_statiticsMinTime->getDoubleValue(),
236 _statiticsMinJitter->getDoubleValue());
241 simgear::AtomicChangeListener::fireChangeListeners();
243 SG_LOG( SG_ALL, SG_DEBUG, "" );
246 void fgInitSoundManager()
248 SGSoundMgr *smgr = globals->get_soundmgr();
251 smgr->init(fgGetString("/sim/sound/device-name", NULL));
253 vector <const char*>devices = smgr->get_available_devices();
254 for (unsigned int i=0; i<devices.size(); i++) {
255 SGPropertyNode *p = fgGetNode("/sim/sound/devices/device", i, true);
256 p->setStringValue(devices[i]);
261 void fgSetNewSoundDevice(const char *device)
263 globals->get_soundmgr()->suspend();
264 globals->get_soundmgr()->stop();
265 globals->get_soundmgr()->init(device);
266 globals->get_soundmgr()->resume();
269 // Operation for querying OpenGL parameters. This must be done in a
270 // valid OpenGL context, potentially in another thread.
273 struct GeneralInitOperation : public GraphicsContextOperation
275 GeneralInitOperation()
276 : GraphicsContextOperation(std::string("General init"))
279 void run(osg::GraphicsContext* gc)
281 SGPropertyNode* simRendering = fgGetNode("/sim/rendering");
283 simRendering->setStringValue("gl-vendor", (char*) glGetString(GL_VENDOR));
284 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VENDOR));
286 simRendering->setStringValue("gl-renderer", (char*) glGetString(GL_RENDERER));
287 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_RENDERER));
289 simRendering->setStringValue("gl-version", (char*) glGetString(GL_VERSION));
290 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VERSION));
293 glGetIntegerv( GL_MAX_TEXTURE_SIZE, &tmp );
294 simRendering->setIntValue("max-texture-size", tmp);
296 glGetIntegerv( GL_DEPTH_BITS, &tmp );
297 simRendering->setIntValue("depth-buffer-bits", tmp);
302 osg::Node* load_panel(SGPropertyNode *n)
304 osg::Geode* geode = new osg::Geode;
305 geode->addDrawable(new FGPanelNode(n));
309 SGPath resolve_path(const std::string& s)
311 return globals->resolve_maybe_aircraft_path(s);
316 // This is the top level master main function that is registered as
319 // The first few passes take care of initialization things (a couple
320 // per pass) and once everything has been initialized fgMainLoop from
323 static void fgIdleFunction ( void ) {
324 static osg::ref_ptr<GeneralInitOperation> genOp;
325 if ( idle_state == 0 ) {
327 // Pick some window on which to do queries.
328 // XXX Perhaps all this graphics initialization code should be
329 // moved to renderer.cxx?
330 genOp = new GeneralInitOperation;
331 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
332 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
333 osg::GraphicsContext* gc = 0;
335 gc = guiCamera->getGraphicsContext();
337 gc->add(genOp.get());
339 wsa->windows[0]->gc->add(genOp.get());
342 } else if ( idle_state == 1 ) {
344 if (!genOp->isFinished())
348 if (!guiFinishInit())
351 fgSplashProgress("reading aircraft list");
354 } else if ( idle_state == 2 ) {
357 fgSplashProgress("reading airport & navigation data");
360 } else if ( idle_state == 3 ) {
363 fgSplashProgress("setting up scenery");
366 } else if ( idle_state == 4 ) {
368 // based on the requested presets, calculate the true starting
371 fgInitTowerLocationListener();
373 TimeManager* t = new TimeManager;
374 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
375 t->init(); // need to init now, not during initSubsystems
377 // Do some quick general initializations
378 if( !fgInitGeneral()) {
379 SG_LOG( SG_GENERAL, SG_ALERT,
380 "General initialization failed ..." );
384 ////////////////////////////////////////////////////////////////////
385 // Initialize the property-based built-in commands
386 ////////////////////////////////////////////////////////////////////
390 ////////////////////////////////////////////////////////////////////
391 // Initialize the material manager
392 ////////////////////////////////////////////////////////////////////
393 globals->set_matlib( new SGMaterialLib );
394 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
395 simgear::SGModelLib::setPanelFunc(load_panel);
397 ////////////////////////////////////////////////////////////////////
398 // Initialize the TG scenery subsystem.
399 ////////////////////////////////////////////////////////////////////
400 globals->set_scenery( new FGScenery );
401 globals->get_scenery()->init();
402 globals->get_scenery()->bind();
403 globals->set_tile_mgr( new FGTileMgr );
406 fgSplashProgress("loading aircraft");
409 } else if ( idle_state == 5 ) {
412 fgSplashProgress("generating sky elements");
415 } else if ( idle_state == 6 ) {
417 // Initialize the sky
419 Ephemeris* eph = new Ephemeris;
420 globals->add_subsystem("ephemeris", eph);
421 eph->init(); // FIXME - remove this once SGSky code below is also a subsystem
424 // TODO: move to environment mgr
426 SGPath texture_path(globals->get_fg_root());
427 texture_path.append("Textures");
428 texture_path.append("Sky");
429 for (int i = 0; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
430 SGCloudLayer * layer = new SGCloudLayer(texture_path.str());
431 thesky->add_cloud_layer(layer);
434 SGPath sky_tex_path( globals->get_fg_root() );
435 sky_tex_path.append( "Textures" );
436 sky_tex_path.append( "Sky" );
437 thesky->texture_path( sky_tex_path.str() );
439 // The sun and moon diameters are scaled down numbers of the
440 // actual diameters. This was needed to fit both the sun and the
441 // moon within the distance to the far clip plane.
442 // Moon diameter: 3,476 kilometers
443 // Sun diameter: 1,390,000 kilometers
444 thesky->build( 80000.0, 80000.0,
446 *globals->get_ephem(),
447 fgGetNode("/environment", true));
449 // Initialize MagVar model
450 SGMagVar *magvar = new SGMagVar();
451 globals->set_mag( magvar );
454 // kludge to initialize mag compass
455 // (should only be done for in-flight
457 // update magvar model
458 globals->get_mag()->update( fgGetDouble("/position/longitude-deg")
459 * SGD_DEGREES_TO_RADIANS,
460 fgGetDouble("/position/latitude-deg")
461 * SGD_DEGREES_TO_RADIANS,
462 fgGetDouble("/position/altitude-ft")
464 globals->get_time_params()->getJD() );
465 double var = globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
466 fgSetDouble("/instrumentation/heading-indicator/offset-deg", -var);
467 fgSetDouble("/instrumentation/heading-indicator-fg/offset-deg", -var);
470 // airport = new ssgBranch;
471 // airport->setName( "Airport Lighting" );
472 // lighting->addKid( airport );
474 // build our custom render states
475 fgSplashProgress("initializing subsystems");
478 } else if ( idle_state == 7 ) {
480 // Initialize audio support
481 #ifdef ENABLE_AUDIO_SUPPORT
483 // Start the intro music
484 if ( fgGetBool("/sim/startup/intro-music") ) {
485 SGPath mp3file( globals->get_fg_root() );
486 mp3file.append( "Sounds/intro.mp3" );
488 SG_LOG( SG_GENERAL, SG_INFO,
489 "Starting intro music: " << mp3file.str() );
491 # if defined( __CYGWIN__ )
492 string command = "start /m `cygpath -w " + mp3file.str() + "`";
493 # elif defined( _WIN32 )
494 string command = "start /m " + mp3file.str();
496 string command = "mpg123 " + mp3file.str() + "> /dev/null 2>&1";
499 system ( command.c_str() );
502 // This is the top level init routine which calls all the
503 // other subsystem initialization routines. If you are adding
504 // a subsystem to flightgear, its initialization call should be
505 // located in this routine.
506 if( !fgInitSubsystems()) {
507 SG_LOG( SG_GENERAL, SG_ALERT,
508 "Subsystem initialization failed ..." );
513 // ugly hack for automatic runway selection on startup based on
514 // metar data. Makes startup.nas obsolete and guarantees the same
515 // runway selection as for AI traffic. However, this code belongs to
516 // somewhere(?) else - if I only new where...
517 if( true == fgGetBool( "/environment/metar/valid" ) ) {
518 // the realwx_ctrl fetches metar in the foreground on init,
519 // If it was able to fetch a metar or one was given on the commandline,
520 // the valid flag is set here, otherwise it is false
521 double hdg = fgGetDouble( "/environment/metar/base-wind-dir-deg", 9999.0 );
522 string apt = fgGetString( "/sim/startup/options/airport" );
523 string rwy = fgGetString( "/sim/startup/options/runway" );
524 double strthdg = fgGetDouble( "/sim/startup/options/heading-deg", 9999.0 );
525 string parkpos = fgGetString( "/sim/presets/parkpos" );
526 bool onground = fgGetBool( "/sim/presets/onground", false );
527 // don't check for wind-speed < 1kt, this belongs to the runway-selection code
528 // the other logic is taken from former startup.nas
529 if( hdg < 360.0 && apt.length() > 0 && strthdg > 360.0 && rwy.length() == 0 && onground && parkpos.length() == 0 ) {
530 extern bool fgSetPosFromAirportIDandHdg( const string& id, double tgt_hdg );
531 fgSetPosFromAirportIDandHdg( apt, hdg );
534 fgSplashProgress("setting up time & renderer");
536 } else if ( idle_state == 8 ) {
539 // setup OpenGL view parameters
540 globals->get_renderer()->init();
542 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
543 fgGetInt("/sim/startup/ysize") );
545 fgSplashProgress("loading scenery objects");
546 int session = fgGetInt("/sim/session",0);
548 fgSetInt("/sim/session",session);
551 if ( idle_state == 1000 ) {
552 // We've finished all our initialization steps, from now on we
553 // run the main loop.
554 fgSetBool("sim/sceneryloaded", false);
555 fgRegisterIdleHandler( fgMainLoop );
559 static void fgWinResizeFunction(int width, int height)
561 globals->get_renderer()->resize(width, height);
564 static void upper_case_property(const char *name)
566 using namespace simgear;
567 SGPropertyNode *p = fgGetNode(name, false);
569 p = fgGetNode(name, true);
570 p->setStringValue("");
572 props::Type t = p->getType();
573 if (t == props::NONE || t == props::UNSPECIFIED)
574 p->setStringValue("");
576 assert(t == props::STRING);
578 p->addChangeListener(new FGMakeUpperCase);
582 // Main top level initialization
583 int fgMainInit( int argc, char **argv ) {
585 // set default log levels
586 sglog().setLogLevels( SG_ALL, SG_ALERT );
589 #ifdef FLIGHTGEAR_VERSION
590 version = FLIGHTGEAR_VERSION;
592 version = "unknown version";
594 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
596 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << endl );
598 // Allocate global data structures. This needs to happen before
599 // we parse command line options
601 globals = new FGGlobals;
603 // seed the random number generator
606 FGControls *controls = new FGControls;
607 globals->set_controls( controls );
609 string_list *col = new string_list;
610 globals->set_channel_options_list( col );
612 fgValidatePath("", false); // initialize static variables
613 upper_case_property("/sim/presets/airport-id");
614 upper_case_property("/sim/presets/runway");
615 upper_case_property("/sim/tower/airport-id");
616 upper_case_property("/autopilot/route-manager/input");
618 // Scan the config file(s) and command line options to see if
619 // fg_root was specified (ignore all other options for now)
620 fgInitFGRoot(argc, argv);
622 // Check for the correct base package version
623 static char required_version[] = "2.0.0";
624 string base_version = fgBasePackageVersion();
625 if ( !(base_version == required_version) ) {
626 // tell the operator how to use this application
628 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
629 cerr << endl << "Base package check failed ... " \
630 << "Found version " << base_version << " at: " \
631 << globals->get_fg_root() << endl;
632 cerr << "Please upgrade to version: " << required_version << endl;
634 cerr << "Hit a key to continue..." << endl;
640 // Load the configuration parameters. (Command line options
641 // override config file options. Config file options override
643 if ( !fgInitConfig(argc, argv) ) {
644 SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
648 // Initialize the Window/Graphics environment.
649 fgOSInit(&argc, argv);
652 fgRegisterWindowResizeHandler( &fgWinResizeFunction );
653 fgRegisterIdleHandler( &fgIdleFunction );
654 fgRegisterDrawHandler( &FGRenderer::update );
656 // Initialize sockets (WinSock needs this)
657 simgear::Socket::initSockets();
659 // Clouds3D requires an alpha channel
660 fgOSOpenWindow(true /* request stencil buffer */);
662 // Initialize the splash screen right away
666 // pass control off to the master event handler
667 int result = fgOSMainLoop();
669 // clean up here; ensure we null globals to avoid
670 // confusing the atexit() handler