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/timing/timestamp.hxx>
51 #include <simgear/magvar/magvar.hxx>
52 #include <simgear/math/sg_random.h>
53 #include <simgear/io/raw_socket.hxx>
54 #include <simgear/scene/tsync/terrasync.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>
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>
85 #include <Main/fg_props.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.
96 // The atexit() function handler should know when the graphical subsystem
98 extern int _bootstrap_OSInit;
101 void fgInitSoundManager()
103 SGSoundMgr *smgr = globals->get_soundmgr();
106 smgr->init(fgGetString("/sim/sound/device-name", NULL));
108 vector <const char*>devices = smgr->get_available_devices();
109 for (unsigned int i=0; i<devices.size(); i++) {
110 SGPropertyNode *p = fgGetNode("/sim/sound/devices/device", i, true);
111 p->setStringValue(devices[i]);
116 void fgSetNewSoundDevice(const char *device)
118 SGSoundMgr *smgr = globals->get_soundmgr();
125 // Update sound manager state (init/suspend/resume) and propagate property values,
126 // since the sound manager doesn't read any properties itself.
127 // Actual sound update is triggered by the subsystem manager.
128 static void fgUpdateSound(double dt)
130 #ifdef ENABLE_AUDIO_SUPPORT
131 static bool smgr_init = true;
132 static SGPropertyNode *sound_working = fgGetNode("/sim/sound/working");
133 if (smgr_init == true) {
134 if (sound_working->getBoolValue() == true) {
135 fgInitSoundManager();
139 static SGPropertyNode *sound_enabled = fgGetNode("/sim/sound/enabled");
140 static SGSoundMgr *smgr = globals->get_soundmgr();
141 static bool smgr_enabled = true;
143 if (sound_working->getBoolValue() == false) { // request to reinit
146 sound_working->setBoolValue(true);
149 if (smgr_enabled != sound_enabled->getBoolValue()) {
150 if (smgr_enabled == true) { // request to suspend
152 smgr_enabled = false;
159 if (smgr_enabled == true) {
160 static SGPropertyNode *volume = fgGetNode("/sim/sound/volume");
161 smgr->set_volume(volume->getFloatValue());
167 static void fgLoadInitialScenery()
169 static SGPropertyNode_ptr scenery_loaded
170 = fgGetNode("sim/sceneryloaded", true);
172 if (!scenery_loaded->getBoolValue())
174 if (globals->get_tile_mgr()->isSceneryLoaded()
175 && fgGetBool("sim/fdm-initialized")) {
176 fgSetBool("sim/sceneryloaded",true);
177 fgSplashProgress("");
178 if (fgGetBool("/sim/sound/working")) {
179 globals->get_soundmgr()->activate();
181 globals->get_props()->tie("/sim/sound/devices/name",
182 SGRawValueFunctions<const char *>(0, fgSetNewSoundDevice), false);
186 fgSplashProgress("loading scenery");
187 // be nice to loader threads while waiting for initial scenery, reduce to 2fps
188 SGTimeStamp::sleepForMSec(500);
193 // What should we do when we have nothing else to do? Let's get ready
194 // for the next move and update the display?
195 static void fgMainLoop( void )
197 static SGPropertyNode_ptr frame_signal
198 = fgGetNode("/sim/signals/frame", true);
200 frame_signal->fireValueChanged();
202 SG_LOG( SG_GENERAL, SG_DEBUG, "Running Main Loop");
203 SG_LOG( SG_GENERAL, SG_DEBUG, "======= ==== ====");
205 // compute simulated time (allowing for pause, warp, etc) and
207 double sim_dt, real_dt;
208 TimeManager* timeMgr = (TimeManager*) globals->get_subsystem("time");
209 timeMgr->computeTimeDeltas(sim_dt, real_dt);
211 // update magvar model
212 globals->get_mag()->update( globals->get_aircraft_position(),
213 globals->get_time_params()->getJD() );
215 // Propagate sound manager properties (note: actual update is triggered
216 // by the subsystem manager).
217 fgUpdateSound(sim_dt);
219 // update all subsystems
220 globals->get_subsystem_mgr()->update(sim_dt);
222 // END Tile Manager updates
223 fgLoadInitialScenery();
225 simgear::AtomicChangeListener::fireChangeListeners();
227 SG_LOG( SG_GENERAL, SG_DEBUG, "" );
230 // Operation for querying OpenGL parameters. This must be done in a
231 // valid OpenGL context, potentially in another thread.
234 struct GeneralInitOperation : public GraphicsContextOperation
236 GeneralInitOperation()
237 : GraphicsContextOperation(std::string("General init"))
240 void run(osg::GraphicsContext* gc)
242 SGPropertyNode* simRendering = fgGetNode("/sim/rendering");
244 simRendering->setStringValue("gl-vendor", (char*) glGetString(GL_VENDOR));
245 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VENDOR));
247 simRendering->setStringValue("gl-renderer", (char*) glGetString(GL_RENDERER));
248 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_RENDERER));
250 simRendering->setStringValue("gl-version", (char*) glGetString(GL_VERSION));
251 SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VERSION));
254 glGetIntegerv( GL_MAX_TEXTURE_SIZE, &tmp );
255 simRendering->setIntValue("max-texture-size", tmp);
257 glGetIntegerv( GL_DEPTH_BITS, &tmp );
258 simRendering->setIntValue("depth-buffer-bits", tmp);
263 osg::Node* load_panel(SGPropertyNode *n)
265 osg::Geode* geode = new osg::Geode;
266 geode->addDrawable(new FGPanelNode(n));
270 SGPath resolve_path(const std::string& s)
272 return globals->resolve_maybe_aircraft_path(s);
277 // This is the top level master main function that is registered as
280 // The first few passes take care of initialization things (a couple
281 // per pass) and once everything has been initialized fgMainLoop from
284 static void fgIdleFunction ( void ) {
285 static osg::ref_ptr<GeneralInitOperation> genOp;
286 if ( idle_state == 0 ) {
288 // Pick some window on which to do queries.
289 // XXX Perhaps all this graphics initialization code should be
290 // moved to renderer.cxx?
291 genOp = new GeneralInitOperation;
292 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
293 WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
294 osg::GraphicsContext* gc = 0;
296 gc = guiCamera->getGraphicsContext();
298 gc->add(genOp.get());
300 wsa->windows[0]->gc->add(genOp.get());
303 } else if ( idle_state == 1 ) {
305 if (!genOp->isFinished())
309 if (!guiFinishInit())
312 fgSplashProgress("loading aircraft list");
314 } else if ( idle_state == 2 ) {
316 fgSplashProgress("loading navigation data");
318 } else if ( idle_state == 3 ) {
322 fgSplashProgress("initializing scenery system");
324 } else if ( idle_state == 4 ) {
326 // based on the requested presets, calculate the true starting
329 fgInitTowerLocationListener();
331 TimeManager* t = new TimeManager;
332 globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
333 t->init(); // need to init now, not during initSubsystems
335 // Do some quick general initializations
336 if( !fgInitGeneral()) {
337 SG_LOG( SG_GENERAL, SG_ALERT,
338 "General initialization failed ..." );
342 ////////////////////////////////////////////////////////////////////
343 // Initialize the property-based built-in commands
344 ////////////////////////////////////////////////////////////////////
347 ////////////////////////////////////////////////////////////////////
348 // Initialize the material manager
349 ////////////////////////////////////////////////////////////////////
350 globals->set_matlib( new SGMaterialLib );
351 simgear::SGModelLib::init(globals->get_fg_root(), globals->get_props());
352 simgear::SGModelLib::setPanelFunc(load_panel);
354 ////////////////////////////////////////////////////////////////////
355 // Initialize the TG scenery subsystem.
356 ////////////////////////////////////////////////////////////////////
357 simgear::SGTerraSync* terra_sync = new simgear::SGTerraSync(globals->get_props());
358 globals->add_subsystem("terrasync", terra_sync);
359 globals->set_scenery( new FGScenery );
360 globals->get_scenery()->init();
361 globals->get_scenery()->bind();
362 globals->set_tile_mgr( new FGTileMgr );
364 fgSplashProgress("loading aircraft");
366 } else if ( idle_state == 5 ) {
369 fgSplashProgress("initializing sky elements");
371 } else if ( idle_state == 6 ) {
374 // Initialize MagVar model
375 SGMagVar *magvar = new SGMagVar();
376 globals->set_mag( magvar );
379 // kludge to initialize mag compass
380 // (should only be done for in-flight
382 // update magvar model
383 globals->get_mag()->update( fgGetDouble("/position/longitude-deg")
384 * SGD_DEGREES_TO_RADIANS,
385 fgGetDouble("/position/latitude-deg")
386 * SGD_DEGREES_TO_RADIANS,
387 fgGetDouble("/position/altitude-ft")
389 globals->get_time_params()->getJD() );
391 fgSplashProgress("initializing subsystems");
393 } else if ( idle_state == 7 ) {
395 // Initialize audio support
396 #ifdef ENABLE_AUDIO_SUPPORT
398 // Start the intro music
399 if ( fgGetBool("/sim/startup/intro-music") ) {
400 SGPath mp3file( globals->get_fg_root() );
401 mp3file.append( "Sounds/intro.mp3" );
403 SG_LOG( SG_GENERAL, SG_INFO,
404 "Starting intro music: " << mp3file.str() );
406 # if defined( __CYGWIN__ )
407 string command = "start /m `cygpath -w " + mp3file.str() + "`";
408 # elif defined( _WIN32 )
409 string command = "start /m " + mp3file.str();
411 string command = "mpg123 " + mp3file.str() + "> /dev/null 2>&1";
414 if (0 != system ( command.c_str() ))
416 SG_LOG( SG_SOUND, SG_WARN,
417 "Failed to play mp3 file " << mp3file.str() << ". Maybe mp3 player is not installed." );
421 // This is the top level init routine which calls all the
422 // other subsystem initialization routines. If you are adding
423 // a subsystem to flightgear, its initialization call should be
424 // located in this routine.
425 if( !fgInitSubsystems()) {
426 SG_LOG( SG_GENERAL, SG_ALERT,
427 "Subsystem initialization failed ..." );
432 // ugly hack for automatic runway selection on startup based on
433 // metar data. Makes startup.nas obsolete and guarantees the same
434 // runway selection as for AI traffic. However, this code belongs to
435 // somewhere(?) else - if I only new where...
436 if( true == fgGetBool( "/environment/metar/valid" ) ) {
437 SG_LOG(SG_ENVIRONMENT, SG_INFO,
438 "Using METAR for runway selection: '" << fgGetString("/environment/metar/data") << "'" );
439 // the realwx_ctrl fetches metar in the foreground on init,
440 // If it was able to fetch a metar or one was given on the commandline,
441 // the valid flag is set here, otherwise it is false
442 double hdg = fgGetDouble( "/environment/metar/base-wind-dir-deg", 9999.0 );
443 string apt = fgGetString( "/sim/startup/options/airport" );
444 string rwy = fgGetString( "/sim/startup/options/runway" );
445 double strthdg = fgGetDouble( "/sim/startup/options/heading-deg", 9999.0 );
446 string parkpos = fgGetString( "/sim/presets/parkpos" );
447 bool onground = fgGetBool( "/sim/presets/onground", false );
448 // don't check for wind-speed < 1kt, this belongs to the runway-selection code
449 // the other logic is taken from former startup.nas
450 if( hdg < 360.0 && apt.length() > 0 && strthdg > 360.0 && rwy.length() == 0 && onground && parkpos.length() == 0 ) {
451 extern bool fgSetPosFromAirportIDandHdg( const string& id, double tgt_hdg );
452 fgSetPosFromAirportIDandHdg( apt, hdg );
455 SG_LOG(SG_ENVIRONMENT, SG_INFO,
456 "No METAR available to pick active runway" );
459 fgSplashProgress("initializing graphics engine");
461 } else if ( idle_state == 8 ) {
464 // setup OpenGL view parameters
465 globals->get_renderer()->setupView();
467 globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
468 fgGetInt("/sim/startup/ysize") );
470 int session = fgGetInt("/sim/session",0);
472 fgSetInt("/sim/session",session);
475 if ( idle_state == 1000 ) {
476 // We've finished all our initialization steps, from now on we
477 // run the main loop.
478 fgSetBool("sim/sceneryloaded", false);
479 fgRegisterIdleHandler( fgMainLoop );
483 static void upper_case_property(const char *name)
485 using namespace simgear;
486 SGPropertyNode *p = fgGetNode(name, false);
488 p = fgGetNode(name, true);
489 p->setStringValue("");
491 props::Type t = p->getType();
492 if (t == props::NONE || t == props::UNSPECIFIED)
493 p->setStringValue("");
495 assert(t == props::STRING);
497 p->addChangeListener(new FGMakeUpperCase);
501 // Main top level initialization
502 int fgMainInit( int argc, char **argv ) {
504 // set default log levels
505 sglog().setLogLevels( SG_ALL, SG_ALERT );
508 #ifdef FLIGHTGEAR_VERSION
509 version = FLIGHTGEAR_VERSION;
511 version = "unknown version";
513 SG_LOG( SG_GENERAL, SG_INFO, "FlightGear: Version "
515 SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << std::endl );
517 // Allocate global data structures. This needs to happen before
518 // we parse command line options
520 globals = new FGGlobals;
522 // seed the random number generator
525 FGControls *controls = new FGControls;
526 globals->set_controls( controls );
528 string_list *col = new string_list;
529 globals->set_channel_options_list( col );
531 fgValidatePath("", false); // initialize static variables
532 upper_case_property("/sim/presets/airport-id");
533 upper_case_property("/sim/presets/runway");
534 upper_case_property("/sim/tower/airport-id");
535 upper_case_property("/autopilot/route-manager/input");
537 // Load the configuration parameters. (Command line options
538 // override config file options. Config file options override
540 if ( !fgInitConfig(argc, argv) ) {
541 SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
545 // Initialize the Window/Graphics environment.
546 fgOSInit(&argc, argv);
549 fgRegisterIdleHandler( &fgIdleFunction );
551 // Initialize sockets (WinSock needs this)
552 simgear::Socket::initSockets();
554 // Clouds3D requires an alpha channel
555 fgOSOpenWindow(true /* request stencil buffer */);
557 // Initialize the splash screen right away
561 // pass control off to the master event handler
562 int result = fgOSMainLoop();
564 // clean up here; ensure we null globals to avoid
565 // confusing the atexit() handler