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>
67 #include <ATCDCL/ATCmgr.hxx>
69 #include <Time/TimeManager.hxx>
70 #include <Environment/environment_mgr.hxx>
71 #include <Environment/ephemeris.hxx>
73 #include <GUI/new_gui.hxx>
74 #include <MultiPlayer/multiplaymgr.hxx>
76 #include "CameraGroup.hxx"
77 #include "fg_commands.hxx"
79 #include "renderer.hxx"
83 #include "fg_init.hxx"
85 #include "WindowSystemAdapter.hxx"
86 #include <Main/viewer.hxx>
89 using namespace flightgear;
93 // Specify our current idle function state. This is used to run all
94 // our initializations out of the idle callback so that we can get a
95 // splash screen up and running right away.
99 void fgInitSoundManager();
100 void fgSetNewSoundDevice(const char *);
102 // The atexit() function handler should know when the graphical subsystem
104 extern int _bootstrap_OSInit;
106 // What should we do when we have nothing else to do? Let's get ready
107 // for the next move and update the display?
108 static void fgMainLoop( void ) {
110 static SGConstPropertyNode_ptr longitude
111 = fgGetNode("/position/longitude-deg");
112 static SGConstPropertyNode_ptr latitude
113 = fgGetNode("/position/latitude-deg");
114 static SGConstPropertyNode_ptr altitude
115 = fgGetNode("/position/altitude-ft");
116 static SGConstPropertyNode_ptr vn_fps
117 = fgGetNode("/velocities/speed-north-fps");
118 static SGConstPropertyNode_ptr ve_fps
119 = fgGetNode("/velocities/speed-east-fps");
120 static SGConstPropertyNode_ptr vd_fps
121 = fgGetNode("/velocities/speed-down-fps");
123 static SGPropertyNode_ptr frame_signal
124 = fgGetNode("/sim/signals/frame", true);
126 frame_signal->fireValueChanged();
127 SGCloudLayer::enable_bump_mapping = fgGetBool("/sim/rendering/bump-mapping");
129 SG_LOG( SG_ALL, SG_DEBUG, "Running Main Loop");
130 SG_LOG( SG_ALL, SG_DEBUG, "======= ==== ====");
134 double sim_dt, real_dt;
135 TimeManager* timeMgr = (TimeManager*) globals->get_subsystem("time");
136 // compute simulated time (allowing for pause, warp, etc) and
138 timeMgr->computeTimeDeltas(sim_dt, real_dt);
140 // update magvar model
141 globals->get_mag()->update( longitude->getDoubleValue()
142 * SGD_DEGREES_TO_RADIANS,
143 latitude->getDoubleValue()
144 * SGD_DEGREES_TO_RADIANS,
145 altitude->getDoubleValue() * SG_FEET_TO_METER,
146 globals->get_time_params()->getJD() );
150 if (fgGetBool("/sim/atc/enabled"))
151 globals->get_ATC_mgr()->update(sim_dt);
154 globals->get_subsystem_mgr()->update(sim_dt);
156 // Update the sound manager last so it can use the CPU while the GPU
157 // is processing the scenery (doubled the frame-rate for me) -EMH-
158 #ifdef ENABLE_AUDIO_SUPPORT
159 static bool smgr_init = true;
160 static SGPropertyNode *sound_working = fgGetNode("/sim/sound/working");
161 if (smgr_init == true) {
162 if (sound_working->getBoolValue() == true) {
163 fgInitSoundManager();
167 static SGPropertyNode *sound_enabled = fgGetNode("/sim/sound/enabled");
168 static SGSoundMgr *smgr = globals->get_soundmgr();
169 static bool smgr_enabled = true;
171 if (sound_working->getBoolValue() == false) { // request to reinit
174 sound_working->setBoolValue(true);
177 if (smgr_enabled != sound_enabled->getBoolValue()) {
178 if (smgr_enabled == true) { // request to suspend
180 smgr_enabled = false;
187 if (smgr_enabled == true) {
188 static SGPropertyNode *volume = fgGetNode("/sim/sound/volume");
189 smgr->set_volume(volume->getFloatValue());
190 smgr->update(sim_dt);
195 // END Tile Manager updates
196 bool scenery_loaded = fgGetBool("sim/sceneryloaded");
199 if (globals->get_tile_mgr()->isSceneryLoaded()
200 && fgGetBool("sim/fdm-initialized")) {
201 fgSetBool("sim/sceneryloaded",true);
202 if (fgGetBool("/sim/sound/working")) {
203 globals->get_soundmgr()->activate();
205 globals->get_props()->tie("/sim/sound/devices/name",
206 SGRawValueFunctions<const char *>(0, fgSetNewSoundDevice), false);
210 // be nice to loader threads while waiting for initial scenery, reduce to 2fps
211 simgear::sleepForMSec(500);
214 simgear::AtomicChangeListener::fireChangeListeners();
216 SG_LOG( SG_ALL, SG_DEBUG, "" );
219 void fgInitSoundManager()
221 SGSoundMgr *smgr = globals->get_soundmgr();
224 smgr->init(fgGetString("/sim/sound/device-name", NULL));
226 vector <const char*>devices = smgr->get_available_devices();
227 for (unsigned int i=0; i<devices.size(); i++) {
228 SGPropertyNode *p = fgGetNode("/sim/sound/devices/device", i, true);
229 p->setStringValue(devices[i]);
234 void fgSetNewSoundDevice(const char *device)
236 globals->get_soundmgr()->suspend();
237 globals->get_soundmgr()->stop();
238 globals->get_soundmgr()->init(device);
239 globals->get_soundmgr()->resume();
242 // Operation for querying OpenGL parameters. This must be done in a
243 // valid OpenGL context, potentially in another thread.
246 struct GeneralInitOperation : public GraphicsContextOperation
248 GeneralInitOperation()
249 : GraphicsContextOperation(std::string("General init"))
252 void run(osg::GraphicsContext* gc)
254 SGPropertyNode* simRendering = fgGetNode("/sim/rendering");
256 simRendering->setStringValue("gl-vendor", (char*) glGetString(GL_VENDOR));
257 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VENDOR));
259 simRendering->setStringValue("gl-renderer", (char*) glGetString(GL_RENDERER));
260 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_RENDERER));
262 simRendering->setStringValue("gl-version", (char*) glGetString(GL_VERSION));
263 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VERSION));
266 glGetIntegerv( GL_MAX_TEXTURE_SIZE, &tmp );
267 simRendering->setIntValue("max-texture-size", tmp);
269 glGetIntegerv( GL_DEPTH_BITS, &tmp );
270 simRendering->setIntValue("depth-buffer-bits", tmp);
275 osg::Node* load_panel(SGPropertyNode *n)
277 osg::Geode* geode = new osg::Geode;
278 geode->addDrawable(new FGPanelNode(n));
282 SGPath resolve_path(const std::string& s)
284 return globals->resolve_maybe_aircraft_path(s);
289 // This is the top level master main function that is registered as
292 // The first few passes take care of initialization things (a couple
293 // per pass) and once everything has been initialized fgMainLoop from
296 static void fgIdleFunction ( void ) {
297 static osg::ref_ptr<GeneralInitOperation> genOp;
298 if ( idle_state == 0 ) {
300 // Pick some window on which to do queries.
301 // XXX Perhaps all this graphics initialization code should be
302 // moved to renderer.cxx?
303 genOp = new GeneralInitOperation;
304 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
305 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
306 osg::GraphicsContext* gc = 0;
308 gc = guiCamera->getGraphicsContext();
310 gc->add(genOp.get());
312 wsa->windows[0]->gc->add(genOp.get());
315 } else if ( idle_state == 1 ) {
317 if (!genOp->isFinished())
321 if (!guiFinishInit())
324 fgSplashProgress("reading aircraft list");
327 } else if ( idle_state == 2 ) {
330 fgSplashProgress("reading airport & navigation data");
333 } else if ( idle_state == 3 ) {
336 fgSplashProgress("setting up scenery");
339 } else if ( idle_state == 4 ) {
341 // based on the requested presets, calculate the true starting
344 fgInitTowerLocationListener();
346 TimeManager* t = new TimeManager;
347 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
348 t->init(); // need to init now, not during initSubsystems
350 // Do some quick general initializations
351 if( !fgInitGeneral()) {
352 SG_LOG( SG_GENERAL, SG_ALERT,
353 "General initialization failed ..." );
357 ////////////////////////////////////////////////////////////////////
358 // Initialize the property-based built-in commands
359 ////////////////////////////////////////////////////////////////////
363 ////////////////////////////////////////////////////////////////////
364 // Initialize the material manager
365 ////////////////////////////////////////////////////////////////////
366 globals->set_matlib( new SGMaterialLib );
367 simgear::SGModelLib::init(globals->get_fg_root());
368 simgear::SGModelLib::setPropRoot(globals->get_props());
369 simgear::SGModelLib::setPanelFunc(load_panel);
371 ////////////////////////////////////////////////////////////////////
372 // Initialize the TG scenery subsystem.
373 ////////////////////////////////////////////////////////////////////
374 globals->set_scenery( new FGScenery );
375 globals->get_scenery()->init();
376 globals->get_scenery()->bind();
377 globals->set_tile_mgr( new FGTileMgr );
380 fgSplashProgress("loading aircraft");
383 } else if ( idle_state == 5 ) {
386 fgSplashProgress("generating sky elements");
389 } else if ( idle_state == 6 ) {
391 // Initialize the sky
393 Ephemeris* eph = new Ephemeris;
394 globals->add_subsystem("ephemeris", eph);
395 eph->init(); // FIXME - remove this once SGSky code below is also a subsystem
398 // TODO: move to environment mgr
400 SGPath texture_path(globals->get_fg_root());
401 texture_path.append("Textures");
402 texture_path.append("Sky");
403 for (int i = 0; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
404 SGCloudLayer * layer = new SGCloudLayer(texture_path.str());
405 thesky->add_cloud_layer(layer);
408 SGPath sky_tex_path( globals->get_fg_root() );
409 sky_tex_path.append( "Textures" );
410 sky_tex_path.append( "Sky" );
411 thesky->texture_path( sky_tex_path.str() );
413 // The sun and moon diameters are scaled down numbers of the
414 // actual diameters. This was needed to fit both the sun and the
415 // moon within the distance to the far clip plane.
416 // Moon diameter: 3,476 kilometers
417 // Sun diameter: 1,390,000 kilometers
418 thesky->build( 80000.0, 80000.0,
420 *globals->get_ephem(),
421 fgGetNode("/environment", true));
423 // Initialize MagVar model
424 SGMagVar *magvar = new SGMagVar();
425 globals->set_mag( magvar );
428 // kludge to initialize mag compass
429 // (should only be done for in-flight
431 // update magvar model
432 globals->get_mag()->update( fgGetDouble("/position/longitude-deg")
433 * SGD_DEGREES_TO_RADIANS,
434 fgGetDouble("/position/latitude-deg")
435 * SGD_DEGREES_TO_RADIANS,
436 fgGetDouble("/position/altitude-ft")
438 globals->get_time_params()->getJD() );
439 double var = globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
440 fgSetDouble("/instrumentation/heading-indicator/offset-deg", -var);
441 fgSetDouble("/instrumentation/heading-indicator-fg/offset-deg", -var);
444 // airport = new ssgBranch;
445 // airport->setName( "Airport Lighting" );
446 // lighting->addKid( airport );
448 // build our custom render states
449 fgSplashProgress("initializing subsystems");
452 } else if ( idle_state == 7 ) {
454 // Initialize audio support
455 #ifdef ENABLE_AUDIO_SUPPORT
457 // Start the intro music
458 if ( fgGetBool("/sim/startup/intro-music") ) {
459 SGPath mp3file( globals->get_fg_root() );
460 mp3file.append( "Sounds/intro.mp3" );
462 SG_LOG( SG_GENERAL, SG_INFO,
463 "Starting intro music: " << mp3file.str() );
465 # if defined( __CYGWIN__ )
466 string command = "start /m `cygpath -w " + mp3file.str() + "`";
467 # elif defined( _WIN32 )
468 string command = "start /m " + mp3file.str();
470 string command = "mpg123 " + mp3file.str() + "> /dev/null 2>&1";
473 system ( command.c_str() );
476 // This is the top level init routine which calls all the
477 // other subsystem initialization routines. If you are adding
478 // a subsystem to flightgear, its initialization call should be
479 // located in this routine.
480 if( !fgInitSubsystems()) {
481 SG_LOG( SG_GENERAL, SG_ALERT,
482 "Subsystem initialization failed ..." );
487 // ugly hack for automatic runway selection on startup based on
488 // metar data. Makes startup.nas obsolete and guarantees the same
489 // runway selection as for AI traffic. However, this code belongs to
490 // somewhere(?) else - if I only new where...
491 if( true == fgGetBool( "/environment/metar/valid" ) ) {
492 // the realwx_ctrl fetches metar in the foreground on init,
493 // If it was able to fetch a metar or one was given on the commandline,
494 // the valid flag is set here, otherwise it is false
495 double hdg = fgGetDouble( "/environment/metar/base-wind-dir-deg", 9999.0 );
496 string apt = fgGetString( "/sim/startup/options/airport" );
497 string rwy = fgGetString( "/sim/startup/options/runway" );
498 double strthdg = fgGetDouble( "/sim/startup/options/heading-deg", 9999.0 );
499 string parkpos = fgGetString( "/sim/presets/parkpos" );
500 bool onground = fgGetBool( "/sim/presets/onground", false );
501 // don't check for wind-speed < 1kt, this belongs to the runway-selection code
502 // the other logic is taken from former startup.nas
503 if( hdg < 360.0 && apt.length() > 0 && strthdg > 360.0 && rwy.length() == 0 && onground && parkpos.length() == 0 ) {
504 extern bool fgSetPosFromAirportIDandHdg( const string& id, double tgt_hdg );
505 fgSetPosFromAirportIDandHdg( apt, hdg );
508 fgSplashProgress("setting up time & renderer");
510 } else if ( idle_state == 8 ) {
513 // setup OpenGL view parameters
514 globals->get_renderer()->init();
516 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
517 fgGetInt("/sim/startup/ysize") );
519 fgSplashProgress("loading scenery objects");
520 int session = fgGetInt("/sim/session",0);
522 fgSetInt("/sim/session",session);
525 if ( idle_state == 1000 ) {
526 // We've finished all our initialization steps, from now on we
527 // run the main loop.
528 fgSetBool("sim/sceneryloaded", false);
529 fgRegisterIdleHandler( fgMainLoop );
534 static void upper_case_property(const char *name)
536 using namespace simgear;
537 SGPropertyNode *p = fgGetNode(name, false);
539 p = fgGetNode(name, true);
540 p->setStringValue("");
542 props::Type t = p->getType();
543 if (t == props::NONE || t == props::UNSPECIFIED)
544 p->setStringValue("");
546 assert(t == props::STRING);
548 p->addChangeListener(new FGMakeUpperCase);
552 // Main top level initialization
553 int fgMainInit( int argc, char **argv ) {
555 // set default log levels
556 sglog().setLogLevels( SG_ALL, SG_ALERT );
559 #ifdef FLIGHTGEAR_VERSION
560 version = FLIGHTGEAR_VERSION;
562 version = "unknown version";
564 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
566 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << endl );
568 // Allocate global data structures. This needs to happen before
569 // we parse command line options
571 globals = new FGGlobals;
573 // seed the random number generator
576 FGControls *controls = new FGControls;
577 globals->set_controls( controls );
579 string_list *col = new string_list;
580 globals->set_channel_options_list( col );
582 fgValidatePath("", false); // initialize static variables
583 upper_case_property("/sim/presets/airport-id");
584 upper_case_property("/sim/presets/runway");
585 upper_case_property("/sim/tower/airport-id");
586 upper_case_property("/autopilot/route-manager/input");
588 // Scan the config file(s) and command line options to see if
589 // fg_root was specified (ignore all other options for now)
590 fgInitFGRoot(argc, argv);
592 // Check for the correct base package version
593 static char required_version[] = "2.0.0";
594 string base_version = fgBasePackageVersion();
595 if ( !(base_version == required_version) ) {
596 // tell the operator how to use this application
598 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
599 cerr << endl << "Base package check failed ... " \
600 << "Found version " << base_version << " at: " \
601 << globals->get_fg_root() << endl;
602 cerr << "Please upgrade to version: " << required_version << endl;
604 cerr << "Hit a key to continue..." << endl;
610 // Load the configuration parameters. (Command line options
611 // override config file options. Config file options override
613 if ( !fgInitConfig(argc, argv) ) {
614 SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
618 // Initialize the Window/Graphics environment.
619 fgOSInit(&argc, argv);
622 fgRegisterWindowResizeHandler( &FGRenderer::resize );
623 fgRegisterIdleHandler( &fgIdleFunction );
624 fgRegisterDrawHandler( &FGRenderer::update );
626 // Initialize sockets (WinSock needs this)
627 simgear::Socket::initSockets();
629 // Clouds3D requires an alpha channel
630 fgOSOpenWindow(true /* request stencil buffer */);
632 // Initialize the splash screen right away
636 // pass control off to the master event handler
637 int result = fgOSMainLoop();
639 // clean up here; ensure we null globals to avoid
640 // confusing the atexit() handler