src/Main/main.cxx

   1 // main.cxx -- top level sim routines
   2 //
   3 // Written by Curtis Olson, started May 1997.
   4 //
   5 // Copyright (C) 1997 - 2002  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/compiler.h>
  29
  30 #if defined(__linux__) && defined(__i386__)
  31 #  include <fpu_control.h>
  32 #  include <signal.h>
  33 #endif
  34
  35 #include <iostream>
  36
  37 #include <osg/Camera>
  38 #include <osg/GraphicsContext>
  39 #include <osgDB/Registry>
  40
  41 // Class references
  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>
  51 #include <simgear/io/raw_socket.hxx>
  52
  53 #include <Time/light.hxx>
  54 #include <Aircraft/replay.hxx>
  55 #include <Cockpit/cockpit.hxx>
  56 #include <Cockpit/hud.hxx>
  57 #include <Model/panelnode.hxx>
  58 #include <Model/acmodel.hxx>
  59 #include <Scenery/scenery.hxx>
  60 #include <Scenery/tilemgr.hxx>
  61 #include <Sound/fg_fx.hxx>
  62 #include <Sound/beacon.hxx>
  63 #include <Sound/morse.hxx>
  64 #include <Sound/fg_fx.hxx>
  65 #include <ATCDCL/ATCmgr.hxx>
  66 #include <Time/TimeManager.hxx>
  67 #include <Environment/environment_mgr.hxx>
  68 #include <Environment/ephemeris.hxx>
  69 #include <GUI/new_gui.hxx>
  70 #include <MultiPlayer/multiplaymgr.hxx>
  71
  72 #include "CameraGroup.hxx"
  73 #include "fg_commands.hxx"
  74 #include "fg_io.hxx"
  75 #include "renderer.hxx"
  76 #include "splash.hxx"
  77 #include "main.hxx"
  78 #include "util.hxx"
  79 #include "fg_init.hxx"
  80 #include "fg_os.hxx"
  81 #include "WindowSystemAdapter.hxx"
  82 #include <Main/viewer.hxx>
  83
  84
  85 using namespace flightgear;
  86
  87 using std::cerr;
  88
  89 // Specify our current idle function state.  This is used to run all
  90 // our initializations out of the idle callback so that we can get a
  91 // splash screen up and running right away.
  92 int idle_state = 0;
  93
  94
  95 void fgInitSoundManager();
  96 void fgSetNewSoundDevice(const char *);
  97
  98 // The atexit() function handler should know when the graphical subsystem
  99 // is initialized.
 100 extern int _bootstrap_OSInit;
 101
 102 // What should we do when we have nothing else to do?  Let's get ready
 103 // for the next move and update the display?
 104 static void fgMainLoop( void ) {
 105
 106     static SGConstPropertyNode_ptr longitude
 107         = fgGetNode("/position/longitude-deg");
 108     static SGConstPropertyNode_ptr latitude
 109         = fgGetNode("/position/latitude-deg");
 110     static SGConstPropertyNode_ptr altitude
 111         = fgGetNode("/position/altitude-ft");
 112     static SGConstPropertyNode_ptr vn_fps
 113         = fgGetNode("/velocities/speed-north-fps");
 114     static SGConstPropertyNode_ptr ve_fps
 115         = fgGetNode("/velocities/speed-east-fps");
 116     static SGConstPropertyNode_ptr vd_fps
 117         = fgGetNode("/velocities/speed-down-fps");
 118
 119     static SGPropertyNode_ptr frame_signal
 120         = fgGetNode("/sim/signals/frame", true);
 121
 122     frame_signal->fireValueChanged();
 123     SGCloudLayer::enable_bump_mapping = fgGetBool("/sim/rendering/bump-mapping");
 124
 125     SG_LOG( SG_ALL, SG_DEBUG, "Running Main Loop");
 126     SG_LOG( SG_ALL, SG_DEBUG, "======= ==== ====");
 127
 128
 129   // update "time"
 130     double sim_dt, real_dt;
 131     TimeManager* timeMgr = (TimeManager*) globals->get_subsystem("time");
 132     // compute simulated time (allowing for pause, warp, etc) and
 133     // real elapsed time
 134     timeMgr->computeTimeDeltas(sim_dt, real_dt);
 135
 136     // update magvar model
 137     globals->get_mag()->update( longitude->getDoubleValue()
 138                                 * SGD_DEGREES_TO_RADIANS,
 139                                 latitude->getDoubleValue()
 140                                 * SGD_DEGREES_TO_RADIANS,
 141                                 altitude->getDoubleValue() * SG_FEET_TO_METER,
 142                                 globals->get_time_params()->getJD() );
 143
 144 #if ENABLE_ATCDCL
 145     // Run ATC subsystem
 146     if (fgGetBool("/sim/atc/enabled"))
 147         globals->get_ATC_mgr()->update(sim_dt);
 148 #endif
 149
 150     globals->get_subsystem_mgr()->update(sim_dt);
 151
 152     // Update the sound manager last so it can use the CPU while the GPU
 153     // is processing the scenery (doubled the frame-rate for me) -EMH-
 154 #ifdef ENABLE_AUDIO_SUPPORT
 155     static bool smgr_init = true;
 156     static SGPropertyNode *sound_working = fgGetNode("/sim/sound/working");
 157     if (smgr_init == true) {
 158         if (sound_working->getBoolValue() == true) {
 159             fgInitSoundManager();
 160             smgr_init = false;
 161         }
 162     } else {
 163         static SGPropertyNode *sound_enabled = fgGetNode("/sim/sound/enabled");
 164         static SGSoundMgr *smgr = globals->get_soundmgr();
 165         static bool smgr_enabled = true;
 166
 167         if (sound_working->getBoolValue() == false) {   // request to reinit
 168            smgr->reinit();
 169            smgr->resume();
 170            sound_working->setBoolValue(true);
 171         }
 172
 173         if (smgr_enabled != sound_enabled->getBoolValue()) {
 174             if (smgr_enabled == true) { // request to suspend
 175                 smgr->suspend();
 176                 smgr_enabled = false;
 177             } else {
 178                 smgr->resume();
 179                 smgr_enabled = true;
 180             }
 181         }
 182
 183         if (smgr_enabled == true) {
 184             static SGPropertyNode *volume = fgGetNode("/sim/sound/volume");
 185             smgr->set_volume(volume->getFloatValue());
 186             smgr->update(sim_dt);
 187         }
 188     }
 189 #endif
 190
 191     // END Tile Manager udpates
 192     bool scenery_loaded = fgGetBool("sim/sceneryloaded");
 193     if (!scenery_loaded && globals->get_tile_mgr()->isSceneryLoaded()
 194         && fgGetBool("sim/fdm-initialized")) {
 195         fgSetBool("sim/sceneryloaded",true);
 196         if (fgGetBool("/sim/sound/working")) {
 197             globals->get_soundmgr()->activate();
 198         }
 199         globals->get_props()->tie("/sim/sound/devices/name",
 200               SGRawValueFunctions<const char *>(0, fgSetNewSoundDevice), false);
 201     }
 202     simgear::AtomicChangeListener::fireChangeListeners();
 203
 204     SG_LOG( SG_ALL, SG_DEBUG, "" );
 205 }
 206
 207 void fgInitSoundManager()
 208 {
 209     SGSoundMgr *smgr = globals->get_soundmgr();
 210
 211     smgr->bind();
 212     smgr->init(fgGetString("/sim/sound/device-name", NULL));
 213
 214     vector <const char*>devices = smgr->get_available_devices();
 215     for (unsigned int i=0; i<devices.size(); i++) {
 216         SGPropertyNode *p = fgGetNode("/sim/sound/devices/device", i, true);
 217         p->setStringValue(devices[i]);
 218     }
 219     devices.clear();
 220 }
 221
 222 void fgSetNewSoundDevice(const char *device)
 223 {
 224     globals->get_soundmgr()->suspend();
 225     globals->get_soundmgr()->stop();
 226     globals->get_soundmgr()->init(device);
 227     globals->get_soundmgr()->resume();
 228 }
 229
 230 // Operation for querying OpenGL parameters. This must be done in a
 231 // valid OpenGL context, potentially in another thread.
 232 namespace
 233 {
 234 struct GeneralInitOperation : public GraphicsContextOperation
 235 {
 236     GeneralInitOperation()
 237         : GraphicsContextOperation(std::string("General init"))
 238     {
 239     }
 240     void run(osg::GraphicsContext* gc)
 241     {
 242         SGPropertyNode* simRendering = fgGetNode("/sim/rendering");
 243
 244         simRendering->setStringValue("gl-vendor", (char*) glGetString(GL_VENDOR));
 245         SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VENDOR));
 246
 247         simRendering->setStringValue("gl-renderer", (char*) glGetString(GL_RENDERER));
 248         SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_RENDERER));
 249
 250         simRendering->setStringValue("gl-version", (char*) glGetString(GL_VERSION));
 251         SG_LOG( SG_GENERAL, SG_INFO, glGetString(GL_VERSION));
 252
 253         GLint tmp;
 254         glGetIntegerv( GL_MAX_TEXTURE_SIZE, &tmp );
 255         simRendering->setIntValue("max-texture-size", tmp);
 256
 257         glGetIntegerv( GL_DEPTH_BITS, &tmp );
 258         simRendering->setIntValue("depth-buffer-bits", tmp);
 259     }
 260 };
 261
 262
 263 osg::Node* load_panel(SGPropertyNode *n)
 264 {
 265     osg::Geode* geode = new osg::Geode;
 266     geode->addDrawable(new FGPanelNode(n));
 267     return geode;
 268 }
 269
 270 SGPath resolve_path(const std::string& s)
 271 {
 272   return globals->resolve_maybe_aircraft_path(s);
 273 }
 274
 275 }
 276
 277 // This is the top level master main function that is registered as
 278 // our idle funciton
 279
 280 // The first few passes take care of initialization things (a couple
 281 // per pass) and once everything has been initialized fgMainLoop from
 282 // then on.
 283
 284 static void fgIdleFunction ( void ) {
 285     static osg::ref_ptr<GeneralInitOperation> genOp;
 286     if ( idle_state == 0 ) {
 287         idle_state++;
 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;
 295         if (guiCamera)
 296             gc = guiCamera->getGraphicsContext();
 297         if (gc) {
 298             gc->add(genOp.get());
 299         } else {
 300             wsa->windows[0]->gc->add(genOp.get());
 301         }
 302         guiStartInit(gc);
 303     } else if ( idle_state == 1 ) {
 304         if (genOp.valid()) {
 305             if (!genOp->isFinished())
 306                 return;
 307             genOp = 0;
 308         }
 309         if (!guiFinishInit())
 310             return;
 311         idle_state++;
 312         fgSplashProgress("reading aircraft list");
 313
 314
 315     } else if ( idle_state == 2 ) {
 316         idle_state++;
 317
 318         fgSplashProgress("reading airport & navigation data");
 319
 320
 321     } else if ( idle_state == 3 ) {
 322         idle_state++;
 323         fgInitNav();
 324         fgSplashProgress("setting up scenery");
 325
 326
 327     } else if ( idle_state == 4 ) {
 328         idle_state++;
 329         // based on the requested presets, calculate the true starting
 330         // lon, lat
 331         fgInitPosition();
 332         fgInitTowerLocationListener();
 333
 334         TimeManager* t = new TimeManager;
 335         globals->add_subsystem("time", t, SGSubsystemMgr::INIT);
 336         t->init(); // need to init now, not during initSubsystems
 337
 338         // Do some quick general initializations
 339         if( !fgInitGeneral()) {
 340             SG_LOG( SG_GENERAL, SG_ALERT,
 341                 "General initialization failed ..." );
 342             exit(-1);
 343         }
 344
 345         ////////////////////////////////////////////////////////////////////
 346         // Initialize the property-based built-in commands
 347         ////////////////////////////////////////////////////////////////////
 348         fgInitCommands();
 349
 350
 351         ////////////////////////////////////////////////////////////////////
 352         // Initialize the material manager
 353         ////////////////////////////////////////////////////////////////////
 354         globals->set_matlib( new SGMaterialLib );
 355         simgear::SGModelLib::init(globals->get_fg_root());
 356         simgear::SGModelLib::setPropRoot(globals->get_props());
 357         simgear::SGModelLib::setPanelFunc(load_panel);
 358
 359         ////////////////////////////////////////////////////////////////////
 360         // Initialize the TG scenery subsystem.
 361         ////////////////////////////////////////////////////////////////////
 362         globals->set_scenery( new FGScenery );
 363         globals->get_scenery()->init();
 364         globals->get_scenery()->bind();
 365         globals->set_tile_mgr( new FGTileMgr );
 366
 367
 368         fgSplashProgress("loading aircraft");
 369
 370
 371     } else if ( idle_state == 5 ) {
 372         idle_state++;
 373
 374         fgSplashProgress("generating sky elements");
 375
 376
 377     } else if ( idle_state == 6 ) {
 378         idle_state++;
 379         // Initialize the sky
 380
 381         Ephemeris* eph = new Ephemeris;
 382         globals->add_subsystem("ephemeris", eph);
 383         eph->init(); // FIXME - remove this once SGSky code below is also a subsystem
 384         eph->bind();
 385
 386         // TODO: move to environment mgr
 387         thesky = new SGSky;
 388         SGPath texture_path(globals->get_fg_root());
 389         texture_path.append("Textures");
 390         texture_path.append("Sky");
 391         for (int i = 0; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
 392             SGCloudLayer * layer = new SGCloudLayer(texture_path.str());
 393             thesky->add_cloud_layer(layer);
 394         }
 395
 396         SGPath sky_tex_path( globals->get_fg_root() );
 397         sky_tex_path.append( "Textures" );
 398         sky_tex_path.append( "Sky" );
 399         thesky->texture_path( sky_tex_path.str() );
 400
 401         // The sun and moon diameters are scaled down numbers of the
 402         // actual diameters. This was needed to fit both the sun and the
 403         // moon within the distance to the far clip plane.
 404         // Moon diameter:    3,476 kilometers
 405         // Sun diameter: 1,390,000 kilometers
 406         thesky->build( 80000.0, 80000.0,
 407                        463.3, 361.8,
 408                        *globals->get_ephem(),
 409                        fgGetNode("/environment", true));
 410
 411         // Initialize MagVar model
 412         SGMagVar *magvar = new SGMagVar();
 413         globals->set_mag( magvar );
 414
 415
 416                                     // kludge to initialize mag compass
 417                                     // (should only be done for in-flight
 418                                     // startup)
 419         // update magvar model
 420         globals->get_mag()->update( fgGetDouble("/position/longitude-deg")
 421                                     * SGD_DEGREES_TO_RADIANS,
 422                                     fgGetDouble("/position/latitude-deg")
 423                                     * SGD_DEGREES_TO_RADIANS,
 424                                     fgGetDouble("/position/altitude-ft")
 425                                     * SG_FEET_TO_METER,
 426                                     globals->get_time_params()->getJD() );
 427         double var = globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
 428         fgSetDouble("/instrumentation/heading-indicator/offset-deg", -var);
 429         fgSetDouble("/instrumentation/heading-indicator-fg/offset-deg", -var);
 430
 431
 432         // airport = new ssgBranch;
 433         // airport->setName( "Airport Lighting" );
 434         // lighting->addKid( airport );
 435
 436         // build our custom render states
 437         fgSplashProgress("initializing subsystems");
 438
 439
 440     } else if ( idle_state == 7 ) {
 441         idle_state++;
 442         // Initialize audio support
 443 #ifdef ENABLE_AUDIO_SUPPORT
 444
 445         // Start the intro music
 446         if ( fgGetBool("/sim/startup/intro-music") ) {
 447             SGPath mp3file( globals->get_fg_root() );
 448             mp3file.append( "Sounds/intro.mp3" );
 449
 450             SG_LOG( SG_GENERAL, SG_INFO,
 451                 "Starting intro music: " << mp3file.str() );
 452
 453 # if defined( __CYGWIN__ )
 454             string command = "start /m `cygpath -w " + mp3file.str() + "`";
 455 # elif defined( _WIN32 )
 456             string command = "start /m " + mp3file.str();
 457 # else
 458             string command = "mpg123 " + mp3file.str() + "> /dev/null 2>&1";
 459 # endif
 460
 461             system ( command.c_str() );
 462         }
 463 #endif
 464         // This is the top level init routine which calls all the
 465         // other subsystem initialization routines.  If you are adding
 466         // a subsystem to flightgear, its initialization call should be
 467         // located in this routine.
 468         if( !fgInitSubsystems()) {
 469             SG_LOG( SG_GENERAL, SG_ALERT,
 470                 "Subsystem initialization failed ..." );
 471             exit(-1);
 472         }
 473         fgSplashProgress("setting up time & renderer");
 474
 475
 476     } else if ( idle_state == 8 ) {
 477         idle_state = 1000;
 478
 479         // setup OpenGL view parameters
 480         globals->get_renderer()->init();
 481
 482         globals->get_renderer()->resize( fgGetInt("/sim/startup/xsize"),
 483                                          fgGetInt("/sim/startup/ysize") );
 484
 485         fgSplashProgress("loading scenery objects");
 486         int session = fgGetInt("/sim/session",0);
 487         session++;
 488         fgSetInt("/sim/session",session);
 489     }
 490
 491     if ( idle_state == 1000 ) {
 492         // We've finished all our initialization steps, from now on we
 493         // run the main loop.
 494         fgSetBool("sim/sceneryloaded", false);
 495         fgRegisterIdleHandler( fgMainLoop );
 496     }
 497 }
 498
 499
 500 static void upper_case_property(const char *name)
 501 {
 502     using namespace simgear;
 503     SGPropertyNode *p = fgGetNode(name, false);
 504     if (!p) {
 505         p = fgGetNode(name, true);
 506         p->setStringValue("");
 507     } else {
 508         props::Type t = p->getType();
 509         if (t == props::NONE || t == props::UNSPECIFIED)
 510             p->setStringValue("");
 511         else
 512             assert(t == props::STRING);
 513     }
 514     p->addChangeListener(new FGMakeUpperCase);
 515 }
 516
 517
 518 // Main top level initialization
 519 int fgMainInit( int argc, char **argv ) {
 520
 521     // set default log levels
 522     sglog().setLogLevels( SG_ALL, SG_ALERT );
 523
 524     string version;
 525 #ifdef FLIGHTGEAR_VERSION
 526     version = FLIGHTGEAR_VERSION;
 527 #else
 528     version = "unknown version";
 529 #endif
 530     SG_LOG( SG_GENERAL, SG_INFO, "FlightGear:  Version "
 531             << version );
 532     SG_LOG( SG_GENERAL, SG_INFO, "Built with " << SG_COMPILER_STR << endl );
 533
 534     // Allocate global data structures.  This needs to happen before
 535     // we parse command line options
 536
 537     globals = new FGGlobals;
 538
 539     // seed the random number generator
 540     sg_srandom_time();
 541
 542     FGControls *controls = new FGControls;
 543     globals->set_controls( controls );
 544
 545     string_list *col = new string_list;
 546     globals->set_channel_options_list( col );
 547
 548     fgValidatePath("", false);  // initialize static variables
 549     upper_case_property("/sim/presets/airport-id");
 550     upper_case_property("/sim/presets/runway");
 551     upper_case_property("/sim/tower/airport-id");
 552     upper_case_property("/autopilot/route-manager/input");
 553
 554     // Scan the config file(s) and command line options to see if
 555     // fg_root was specified (ignore all other options for now)
 556     fgInitFGRoot(argc, argv);
 557
 558     // Check for the correct base package version
 559     static char required_version[] = "2.0.0";
 560     string base_version = fgBasePackageVersion();
 561     if ( !(base_version == required_version) ) {
 562         // tell the operator how to use this application
 563
 564         SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
 565         cerr << endl << "Base package check failed ... " \
 566              << "Found version " << base_version << " at: " \
 567              << globals->get_fg_root() << endl;
 568         cerr << "Please upgrade to version: " << required_version << endl;
 569 #ifdef _MSC_VER
 570         cerr << "Hit a key to continue..." << endl;
 571         cin.get();
 572 #endif
 573         exit(-1);
 574     }
 575
 576     // Load the configuration parameters.  (Command line options
 577     // override config file options.  Config file options override
 578     // defaults.)
 579     if ( !fgInitConfig(argc, argv) ) {
 580         SG_LOG( SG_GENERAL, SG_ALERT, "Config option parsing failed ..." );
 581         exit(-1);
 582     }
 583
 584     // Initialize the Window/Graphics environment.
 585     fgOSInit(&argc, argv);
 586     _bootstrap_OSInit++;
 587
 588     fgRegisterWindowResizeHandler( &FGRenderer::resize );
 589     fgRegisterIdleHandler( &fgIdleFunction );
 590     fgRegisterDrawHandler( &FGRenderer::update );
 591
 592     // Initialize sockets (WinSock needs this)
 593     simgear::Socket::initSockets();
 594
 595     // Clouds3D requires an alpha channel
 596     fgOSOpenWindow(true /* request stencil buffer */);
 597
 598     // Initialize the splash screen right away
 599     fntInit();
 600     fgSplashInit();
 601
 602     // pass control off to the master event handler
 603     int result = fgOSMainLoop();
 604
 605     // clean up here; ensure we null globals to avoid
 606     // confusing the atexit() handler
 607     delete globals;
 608     globals = NULL;
 609
 610     return result;
 611 }
 612
 613