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/math/sg_random.h>
52 #include <Time/light.hxx>
53 #include <Include/general.hxx>
54 #include <Aircraft/replay.hxx>
55 #include <Cockpit/cockpit.hxx>
56 #include <Cockpit/hud.hxx>
57 #include <Model/panelnode.hxx>
58 #include <Model/modelmgr.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>
70 #include <GUI/new_gui.hxx>
71 #include <MultiPlayer/multiplaymgr.hxx>
73 #include "CameraGroup.hxx"
74 #include "fg_commands.hxx"
76 #include "renderer.hxx"
80 #include "fg_init.hxx"
82 #include "WindowSystemAdapter.hxx"
83 #include <Main/viewer.hxx>
86 using namespace flightgear;
90 // This is a record containing a bit of global housekeeping information
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 if (globals->get_warp_delta() != 0) {
141 FGLight *l = (FGLight *)(globals->get_subsystem("lighting"));
145 // update magvar model
146 globals->get_mag()->update( longitude->getDoubleValue()
147 * SGD_DEGREES_TO_RADIANS,
148 latitude->getDoubleValue()
149 * SGD_DEGREES_TO_RADIANS,
150 altitude->getDoubleValue() * SG_FEET_TO_METER,
151 globals->get_time_params()->getJD() );
154 // Update any multiplayer's network queues, the AIMultiplayer
155 // implementation is an AI model and depends on that
156 globals->get_multiplayer_mgr()->Update();
160 if (fgGetBool("/sim/atc/enabled"))
161 globals->get_ATC_mgr()->update(sim_dt);
164 globals->get_subsystem_mgr()->update(sim_dt);
165 globals->get_aircraft_model()->update(sim_dt);
168 // Tile Manager updates - see if we need to load any new scenery tiles.
169 // this code ties together the fdm, viewer and scenery classes...
170 // we may want to move this to its own class at some point
172 double visibility_meters = fgGetDouble("/environment/visibility-m");
173 globals->get_tile_mgr()->prep_ssg_nodes( visibility_meters );
175 // update tile manager for view...
176 SGVec3d viewPos = globals->get_current_view()->get_view_pos();
177 SGGeod geodViewPos = SGGeod::fromCart(viewPos);
178 globals->get_tile_mgr()->update(geodViewPos, visibility_meters);
180 // run Nasal's settimer() loops right before the view manager
181 globals->get_event_mgr()->update(sim_dt);
183 // pick up model coordidnates that Nasal code may have set relative to the
185 globals->get_model_mgr()->update(sim_dt);
187 // update the view angle as late as possible, but before sound calculations
188 globals->get_viewmgr()->update(real_dt);
190 // Update the sound manager last so it can use the CPU while the GPU
191 // is processing the scenery (doubled the frame-rate for me) -EMH-
192 #ifdef ENABLE_AUDIO_SUPPORT
193 static bool smgr_init = true;
194 static SGPropertyNode *sound_working = fgGetNode("/sim/sound/working");
195 if (smgr_init == true) {
196 if (sound_working->getBoolValue() == true) {
197 fgInitSoundManager();
201 static SGPropertyNode *sound_enabled = fgGetNode("/sim/sound/enabled");
202 static SGSoundMgr *smgr = globals->get_soundmgr();
203 static bool smgr_enabled = true;
205 if (sound_working->getBoolValue() == false) { // request to reinit
208 sound_working->setBoolValue(true);
211 if (smgr_enabled != sound_enabled->getBoolValue()) {
212 if (smgr_enabled == true) { // request to suspend
214 smgr_enabled = false;
221 if (smgr_enabled == true) {
222 static SGPropertyNode *volume = fgGetNode("/sim/sound/volume");
223 smgr->set_volume(volume->getFloatValue());
224 smgr->update(sim_dt);
229 // END Tile Manager udpates
230 bool scenery_loaded = fgGetBool("sim/sceneryloaded");
231 if (!scenery_loaded && globals->get_tile_mgr()->isSceneryLoaded()
232 && fgGetBool("sim/fdm-initialized")) {
233 fgSetBool("sim/sceneryloaded",true);
234 if (fgGetBool("/sim/sound/working")) {
235 globals->get_soundmgr()->activate();
237 globals->get_props()->tie("/sim/sound/devices/name",
238 SGRawValueFunctions<const char *>(0, fgSetNewSoundDevice), false);
240 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 general.set_glVendor( (char *)glGetString ( GL_VENDOR ) );
282 general.set_glRenderer( (char *)glGetString ( GL_RENDERER ) );
283 general.set_glVersion( (char *)glGetString ( GL_VERSION ) );
284 SG_LOG( SG_GENERAL, SG_INFO, general.get_glVendor() );
285 SG_LOG( SG_GENERAL, SG_INFO, general.get_glRenderer() );
286 SG_LOG( SG_GENERAL, SG_INFO, general.get_glVersion() );
289 glGetIntegerv( GL_MAX_TEXTURE_SIZE, &tmp );
290 general.set_glMaxTexSize( tmp );
291 SG_LOG ( SG_GENERAL, SG_INFO, "Max texture size = " << tmp );
293 glGetIntegerv( GL_DEPTH_BITS, &tmp );
294 general.set_glDepthBits( tmp );
295 SG_LOG ( SG_GENERAL, SG_INFO, "Depth buffer bits = " << tmp );
300 osg::Node* load_panel(SGPropertyNode *n)
302 osg::Geode* geode = new osg::Geode;
303 geode->addDrawable(new FGPanelNode(n));
307 SGPath resolve_path(const std::string& s)
309 return globals->resolve_maybe_aircraft_path(s);
314 // This is the top level master main function that is registered as
317 // The first few passes take care of initialization things (a couple
318 // per pass) and once everything has been initialized fgMainLoop from
321 static void fgIdleFunction ( void ) {
322 static osg::ref_ptr<GeneralInitOperation> genOp;
323 if ( idle_state == 0 ) {
325 // Pick some window on which to do queries.
326 // XXX Perhaps all this graphics initialization code should be
327 // moved to renderer.cxx?
328 genOp = new GeneralInitOperation;
329 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
330 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
331 osg::GraphicsContext* gc = 0;
333 gc = guiCamera->getGraphicsContext();
335 gc->add(genOp.get());
337 wsa->windows[0]->gc->add(genOp.get());
340 } else if ( idle_state == 1 ) {
342 if (!genOp->isFinished())
346 if (!guiFinishInit())
349 fgSplashProgress("reading aircraft list");
352 } else if ( idle_state == 2 ) {
355 fgSplashProgress("reading airport & navigation data");
358 } else if ( idle_state == 3 ) {
361 fgSplashProgress("setting up scenery");
364 } else if ( idle_state == 4 ) {
366 // based on the requested presets, calculate the true starting
369 fgInitTowerLocationListener();
371 TimeManager* t = new TimeManager;
372 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
373 t->init(); // need to init now, not during initSubsystems
375 // Do some quick general initializations
376 if( !fgInitGeneral()) {
377 SG_LOG( SG_GENERAL, SG_ALERT,
378 "General initialization failed ..." );
382 ////////////////////////////////////////////////////////////////////
383 // Initialize the property-based built-in commands
384 ////////////////////////////////////////////////////////////////////
388 ////////////////////////////////////////////////////////////////////
389 // Initialize the material manager
390 ////////////////////////////////////////////////////////////////////
391 globals->set_matlib( new SGMaterialLib );
392 simgear::SGModelLib::init(globals->get_fg_root());
393 simgear::SGModelLib::setPropRoot(globals->get_props());
394 simgear::SGModelLib::setPanelFunc(load_panel);
396 ////////////////////////////////////////////////////////////////////
397 // Initialize the TG scenery subsystem.
398 ////////////////////////////////////////////////////////////////////
399 globals->set_scenery( new FGScenery );
400 globals->get_scenery()->init();
401 globals->get_scenery()->bind();
402 globals->set_tile_mgr( new FGTileMgr );
405 ////////////////////////////////////////////////////////////////////
406 // Initialize the general model subsystem.
407 ////////////////////////////////////////////////////////////////////
408 globals->set_model_mgr(new FGModelMgr);
409 globals->get_model_mgr()->init();
410 globals->get_model_mgr()->bind();
411 fgSplashProgress("loading aircraft");
414 } else if ( idle_state == 5 ) {
417 ////////////////////////////////////////////////////////////////////
418 // Initialize the 3D aircraft model subsystem (has a dependency on
419 // the scenery subsystem.)
420 ////////////////////////////////////////////////////////////////////
421 FGAircraftModel* acm = new FGAircraftModel;
422 globals->set_aircraft_model(acm);
423 //globals->add_subsystem("aircraft-model", acm);
427 ////////////////////////////////////////////////////////////////////
428 // Initialize the view manager subsystem.
429 ////////////////////////////////////////////////////////////////////
430 FGViewMgr *viewmgr = new FGViewMgr;
431 globals->set_viewmgr( viewmgr );
434 fgSplashProgress("generating sky elements");
437 } else if ( idle_state == 6 ) {
439 // Initialize the sky
441 Ephemeris* eph = new Ephemeris;
442 globals->add_subsystem("ephemeris", eph);
443 eph->init(); // FIXME - remove this once SGSky code below is also a subsystem
446 // TODO: move to environment mgr
448 SGPath texture_path(globals->get_fg_root());
449 texture_path.append("Textures");
450 texture_path.append("Sky");
451 for (int i = 0; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
452 SGCloudLayer * layer = new SGCloudLayer(texture_path.str());
453 thesky->add_cloud_layer(layer);
456 SGPath sky_tex_path( globals->get_fg_root() );
457 sky_tex_path.append( "Textures" );
458 sky_tex_path.append( "Sky" );
459 thesky->texture_path( sky_tex_path.str() );
461 // The sun and moon diameters are scaled down numbers of the
462 // actual diameters. This was needed to fit both the sun and the
463 // moon within the distance to the far clip plane.
464 // Moon diameter: 3,476 kilometers
465 // Sun diameter: 1,390,000 kilometers
466 thesky->build( 80000.0, 80000.0,
468 *globals->get_ephem(),
469 fgGetNode("/environment", true));
471 // Initialize MagVar model
472 SGMagVar *magvar = new SGMagVar();
473 globals->set_mag( magvar );
476 // kludge to initialize mag compass
477 // (should only be done for in-flight
479 // update magvar model
480 globals->get_mag()->update( fgGetDouble("/position/longitude-deg")
481 * SGD_DEGREES_TO_RADIANS,
482 fgGetDouble("/position/latitude-deg")
483 * SGD_DEGREES_TO_RADIANS,
484 fgGetDouble("/position/altitude-ft")
486 globals->get_time_params()->getJD() );
487 double var = globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
488 fgSetDouble("/instrumentation/heading-indicator/offset-deg", -var);
489 fgSetDouble("/instrumentation/heading-indicator-fg/offset-deg", -var);
492 // airport = new ssgBranch;
493 // airport->setName( "Airport Lighting" );
494 // lighting->addKid( airport );
496 // build our custom render states
497 fgSplashProgress("initializing subsystems");
500 } else if ( idle_state == 7 ) {
502 // Initialize audio support
503 #ifdef ENABLE_AUDIO_SUPPORT
505 // Start the intro music
506 if ( fgGetBool("/sim/startup/intro-music") ) {
507 SGPath mp3file( globals->get_fg_root() );
508 mp3file.append( "Sounds/intro.mp3" );
510 SG_LOG( SG_GENERAL, SG_INFO,
511 "Starting intro music: " << mp3file.str() );
513 # if defined( __CYGWIN__ )
514 string command = "start /m `cygpath -w " + mp3file.str() + "`";
515 # elif defined( _WIN32 )
516 string command = "start /m " + mp3file.str();
518 string command = "mpg123 " + mp3file.str() + "> /dev/null 2>&1";
521 system ( command.c_str() );
524 // This is the top level init routine which calls all the
525 // other subsystem initialization routines. If you are adding
526 // a subsystem to flightgear, its initialization call should be
527 // located in this routine.
528 if( !fgInitSubsystems()) {
529 SG_LOG( SG_GENERAL, SG_ALERT,
530 "Subsystem initialization failed ..." );
533 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 );
560 static void upper_case_property(const char *name)
562 using namespace simgear;
563 SGPropertyNode *p = fgGetNode(name, false);
565 p = fgGetNode(name, true);
566 p->setStringValue("");
568 props::Type t = p->getType();
569 if (t == props::NONE || t == props::UNSPECIFIED)
570 p->setStringValue("");
572 assert(t == props::STRING);
574 p->addChangeListener(new FGMakeUpperCase);
578 // Main top level initialization
579 int fgMainInit( int argc, char **argv ) {
581 // set default log levels
582 sglog().setLogLevels( SG_ALL, SG_ALERT );
585 #ifdef FLIGHTGEAR_VERSION
586 version = FLIGHTGEAR_VERSION;
588 version = "unknown version";
590 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
592 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << endl );
594 // Allocate global data structures. This needs to happen before
595 // we parse command line options
597 globals = new FGGlobals;
599 // seed the random number generator
602 FGControls *controls = new FGControls;
603 globals->set_controls( controls );
605 string_list *col = new string_list;
606 globals->set_channel_options_list( col );
608 fgValidatePath("", false); // initialize static variables
609 upper_case_property("/sim/presets/airport-id");
610 upper_case_property("/sim/presets/runway");
611 upper_case_property("/sim/tower/airport-id");
612 upper_case_property("/autopilot/route-manager/input");
614 // Scan the config file(s) and command line options to see if
615 // fg_root was specified (ignore all other options for now)
616 fgInitFGRoot(argc, argv);
618 // Check for the correct base package version
619 static char required_version[] = "2.0.0";
620 string base_version = fgBasePackageVersion();
621 if ( !(base_version == required_version) ) {
622 // tell the operator how to use this application
624 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
625 cerr << endl << "Base package check failed ... " \
626 << "Found version " << base_version << " at: " \
627 << globals->get_fg_root() << endl;
628 cerr << "Please upgrade to version: " << required_version << endl;
630 cerr << "Hit a key to continue..." << endl;
636 // Load the configuration parameters. (Command line options
637 // override config file options. Config file options override
639 if ( !fgInitConfig(argc, argv) ) {
640 SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
644 // Initialize the Window/Graphics environment.
645 fgOSInit(&argc, argv);
648 fgRegisterWindowResizeHandler( &FGRenderer::resize );
649 fgRegisterIdleHandler( &fgIdleFunction );
650 fgRegisterDrawHandler( &FGRenderer::update );
652 // Initialize plib net interface
653 netInit( &argc, argv );
655 // Clouds3D requires an alpha channel
656 fgOSOpenWindow(true /* request stencil buffer */);
658 // Initialize the splash screen right away
662 // pass control off to the master event handler
663 int result = fgOSMainLoop();
665 // clean up here; ensure we null globals to avoid
666 // confusing the atexit() handler