src/Scenery/tilemgr.cxx

   1 // tilemgr.cxx -- routines to handle dynamic management of scenery tiles
   2 //
   3 // Written by Curtis Olson, started January 1998.
   4 //
   5 // Copyright (C) 1997  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 <algorithm>
  29 #include <functional>
  30
  31 #include <osgViewer/Viewer>
  32 #include <osgDB/Registry>
  33
  34 #include <simgear/constants.h>
  35 #include <simgear/debug/logstream.hxx>
  36 #include <simgear/structure/exception.hxx>
  37 #include <simgear/scene/model/modellib.hxx>
  38 #include <simgear/scene/util/SGReaderWriterOptions.hxx>
  39 #include <simgear/scene/tsync/terrasync.hxx>
  40 #include <simgear/misc/strutils.hxx>
  41 #include <simgear/scene/material/matlib.hxx>
  42
  43 #include <Main/globals.hxx>
  44 #include <Main/fg_props.hxx>
  45 #include <Viewer/renderer.hxx>
  46 #include <Viewer/splash.hxx>
  47 #include <Scripting/NasalSys.hxx>
  48 #include <Scripting/NasalModelData.hxx>
  49
  50 #include "scenery.hxx"
  51 #include "SceneryPager.hxx"
  52 #include "tilemgr.hxx"
  53
  54 using flightgear::SceneryPager;
  55
  56 class FGTileMgr::TileManagerListener : public SGPropertyChangeListener
  57 {
  58 public:
  59     TileManagerListener(FGTileMgr* manager) :
  60         _manager(manager),
  61         _useVBOsProp(fgGetNode("/sim/rendering/use-vbos", true)),
  62         _enableCacheProp(fgGetNode("/sim/tile-cache/enable", true)),
  63         _pagedLODMaximumProp(fgGetNode("/sim/rendering/max-paged-lod", true))
  64     {
  65         _useVBOsProp->addChangeListener(this, true);
  66
  67         _enableCacheProp->addChangeListener(this, true);
  68         if (_enableCacheProp->getType() == simgear::props::NONE) {
  69             _enableCacheProp->setBoolValue(true);
  70         }
  71
  72         if (_pagedLODMaximumProp->getType() == simgear::props::NONE) {
  73             // not set, use OSG default / environment value variable
  74             osg::ref_ptr<osgViewer::Viewer> viewer(globals->get_renderer()->getViewer());
  75             int current = viewer->getDatabasePager()->getTargetMaximumNumberOfPageLOD();
  76             _pagedLODMaximumProp->setIntValue(current);
  77         }
  78         _pagedLODMaximumProp->addChangeListener(this, true);
  79     }
  80
  81     ~TileManagerListener()
  82     {
  83         _useVBOsProp->removeChangeListener(this);
  84         _enableCacheProp->removeChangeListener(this);
  85         _pagedLODMaximumProp->removeChangeListener(this);
  86     }
  87
  88     virtual void valueChanged(SGPropertyNode* prop)
  89     {
  90         if (prop == _useVBOsProp) {
  91             bool useVBOs = prop->getBoolValue();
  92             _manager->_options->setPluginStringData("SimGear::USE_VBOS",
  93                                                 useVBOs ? "ON" : "OFF");
  94         } else if (prop == _enableCacheProp) {
  95             _manager->_enableCache = prop->getBoolValue();
  96         } else if (prop == _pagedLODMaximumProp) {
  97           int v = prop->getIntValue();
  98           osg::ref_ptr<osgViewer::Viewer> viewer(globals->get_renderer()->getViewer());
  99           viewer->getDatabasePager()->setTargetMaximumNumberOfPageLOD(v);
 100         }
 101     }
 102
 103 private:
 104     FGTileMgr* _manager;
 105     SGPropertyNode_ptr _useVBOsProp,
 106       _enableCacheProp,
 107       _pagedLODMaximumProp;
 108 };
 109
 110 FGTileMgr::FGTileMgr():
 111     state( Start ),
 112     last_state( Running ),
 113     scheduled_visibility(100.0),
 114     _terra_sync(NULL),
 115     _listener(NULL),
 116     _visibilityMeters(fgGetNode("/environment/visibility-m", true)),
 117     _maxTileRangeM(fgGetNode("/sim/rendering/static-lod/bare", true)),
 118     _disableNasalHooks(fgGetNode("/sim/temp/disable-scenery-nasal", true)),
 119     _scenery_loaded(fgGetNode("/sim/sceneryloaded", true)),
 120     _scenery_override(fgGetNode("/sim/sceneryloaded-override", true)),
 121     _pager(FGScenery::getPagerSingleton()),
 122     _enableCache(true)
 123 {
 124 }
 125
 126
 127 FGTileMgr::~FGTileMgr()
 128 {
 129     delete _listener;
 130
 131     // remove all nodes we might have left behind
 132     osg::Group* group = globals->get_scenery()->get_terrain_branch();
 133     group->removeChildren(0, group->getNumChildren());
 134     // clear OSG cache
 135     osgDB::Registry::instance()->clearObjectCache();
 136 }
 137
 138
 139 // Initialize the Tile Manager subsystem
 140 void FGTileMgr::init()
 141 {
 142     reinit();
 143 }
 144
 145 void FGTileMgr::reinit()
 146 {
 147     SG_LOG( SG_TERRAIN, SG_INFO, "Initializing Tile Manager subsystem." );
 148     _terra_sync = static_cast<simgear::SGTerraSync*> (globals->get_subsystem("terrasync"));
 149
 150   // drops the previous options reference
 151     _options = new simgear::SGReaderWriterOptions;
 152     _listener = new TileManagerListener(this);
 153
 154     materialLibChanged();
 155     _options->setPropertyNode(globals->get_props());
 156
 157     osgDB::FilePathList &fp = _options->getDatabasePathList();
 158     const string_list &sc = globals->get_fg_scenery();
 159     fp.clear();
 160     std::copy(sc.begin(), sc.end(), back_inserter(fp));
 161     _options->setPluginStringData("SimGear::FG_ROOT", globals->get_fg_root());
 162
 163     if (_terra_sync) {
 164       _options->setPluginStringData("SimGear::TERRASYNC_ROOT", fgGetString("/sim/terrasync/scenery-dir"));
 165     }
 166
 167     if (!_disableNasalHooks->getBoolValue())
 168       _options->setModelData(new FGNasalModelDataProxy);
 169
 170
 171     if (state != Start)
 172     {
 173       // protect against multiple scenery reloads and properly reset flags,
 174       // otherwise aircraft fall through the ground while reloading scenery
 175       if (_scenery_loaded->getBoolValue() == false)
 176           return;
 177     }
 178
 179     _scenery_loaded->setBoolValue(false);
 180     fgSetDouble("/sim/startup/splash-alpha", 1.0);
 181
 182     materialLibChanged();
 183
 184     // remove all old scenery nodes from scenegraph and clear cache
 185     osg::Group* group = globals->get_scenery()->get_terrain_branch();
 186     group->removeChildren(0, group->getNumChildren());
 187     tile_cache.init();
 188
 189     // clear OSG cache, except on initial start-up
 190     if (state != Start)
 191     {
 192         osgDB::Registry::instance()->clearObjectCache();
 193     }
 194
 195     state = Inited;
 196
 197     previous_bucket.make_bad();
 198     current_bucket.make_bad();
 199     scheduled_visibility = 100.0;
 200
 201     // force an update now
 202     update(0.0);
 203 }
 204
 205 void FGTileMgr::materialLibChanged()
 206 {
 207     _options->setMaterialLib(globals->get_matlib());
 208 }
 209
 210 /* schedule a tile for loading, keep request for given amount of time.
 211  * Returns true if tile is already loaded. */
 212 bool FGTileMgr::sched_tile( const SGBucket& b, double priority, bool current_view, double duration)
 213 {
 214     // see if tile already exists in the cache
 215     TileEntry *t = tile_cache.get_tile( b );
 216     if (!t)
 217     {
 218         // create a new entry
 219         t = new TileEntry( b );
 220         // insert the tile into the cache, update will generate load request
 221         if ( tile_cache.insert_tile( t ) )
 222         {
 223             // Attach to scene graph
 224
 225             t->addToSceneGraph(globals->get_scenery()->get_terrain_branch());
 226         } else
 227         {
 228             // insert failed (cache full with no available entries to
 229             // delete.)  Try again later
 230             delete t;
 231             return false;
 232         }
 233
 234         SG_LOG( SG_TERRAIN, SG_DEBUG, "  New tile cache size " << (int)tile_cache.get_size() );
 235     }
 236
 237     // update tile's properties
 238     tile_cache.request_tile(t,priority,current_view,duration);
 239
 240     return t->is_loaded();
 241 }
 242
 243 /* schedule needed buckets for the current view position for loading,
 244  * keep request for given amount of time */
 245 void FGTileMgr::schedule_needed(const SGBucket& curr_bucket, double vis)
 246 {
 247     // sanity check (unfortunately needed!)
 248     if (!curr_bucket.isValid() )
 249     {
 250         SG_LOG( SG_TERRAIN, SG_ALERT,
 251                 "Attempting to schedule tiles for invalid bucket" );
 252         return;
 253     }
 254
 255     double tile_width = curr_bucket.get_width_m();
 256     double tile_height = curr_bucket.get_height_m();
 257     SG_LOG( SG_TERRAIN, SG_INFO,
 258             "scheduling needed tiles for " << curr_bucket
 259            << ", tile-width-m:" << tile_width << ", tile-height-m:" << tile_height);
 260
 261
 262     // cout << "tile width = " << tile_width << "  tile_height = "
 263     //      << tile_height << endl;
 264
 265     double tileRangeM = std::min(vis,_maxTileRangeM->getDoubleValue());
 266     int xrange = (int)(tileRangeM / tile_width) + 1;
 267     int yrange = (int)(tileRangeM / tile_height) + 1;
 268     if ( xrange < 1 ) { xrange = 1; }
 269     if ( yrange < 1 ) { yrange = 1; }
 270
 271     // make the cache twice as large to avoid losing terrain when switching
 272     // between aircraft and tower views
 273     tile_cache.set_max_cache_size( (2*xrange + 2) * (2*yrange + 2) * 2 );
 274     // cout << "xrange = " << xrange << "  yrange = " << yrange << endl;
 275     // cout << "max cache size = " << tile_cache.get_max_cache_size()
 276     //      << " current cache size = " << tile_cache.get_size() << endl;
 277
 278     // clear flags of all tiles belonging to the previous view set
 279     tile_cache.clear_current_view();
 280
 281     // update timestamps, so all tiles scheduled now are *newer* than any tile previously loaded
 282     osg::FrameStamp* framestamp
 283             = globals->get_renderer()->getViewer()->getFrameStamp();
 284     tile_cache.set_current_time(framestamp->getReferenceTime());
 285
 286     SGBucket b;
 287
 288     int x, y;
 289
 290     /* schedule all tiles, use distance-based loading priority,
 291      * so tiles are loaded in innermost-to-outermost sequence. */
 292     for ( x = -xrange; x <= xrange; ++x )
 293     {
 294         for ( y = -yrange; y <= yrange; ++y )
 295         {
 296             SGBucket b = curr_bucket.sibling(x, y);
 297             if (!b.isValid()) {
 298                 continue;
 299             }
 300
 301             float priority = (-1.0) * (x*x+y*y);
 302             sched_tile( b, priority, true, 0.0 );
 303
 304             if (_terra_sync) {
 305                 _terra_sync->scheduleTile(b);
 306             }
 307         }
 308     }
 309 }
 310
 311 /**
 312  * Update the various queues maintained by the tilemgr (private
 313  * internal function, do not call directly.)
 314  */
 315 void FGTileMgr::update_queues(bool& isDownloadingScenery)
 316 {
 317     osg::FrameStamp* framestamp
 318         = globals->get_renderer()->getViewer()->getFrameStamp();
 319     double current_time = framestamp->getReferenceTime();
 320     double vis = _visibilityMeters->getDoubleValue();
 321     TileEntry *e;
 322     int loading=0;
 323     int sz=0;
 324
 325     tile_cache.set_current_time( current_time );
 326     tile_cache.reset_traversal();
 327
 328     while ( ! tile_cache.at_end() )
 329     {
 330         e = tile_cache.get_current();
 331         if ( e )
 332         {
 333             // Prepare the ssg nodes corresponding to each tile.
 334             // Set the ssg transform and update it's range selector
 335             // based on current visibilty
 336             e->prep_ssg_node(vis);
 337
 338             if (!e->is_loaded()) {
 339                 bool nonExpiredOrCurrent = !e->is_expired(current_time) || e->is_current_view();
 340                 bool downloading = isTileDirSyncing(e->tileFileName);
 341                 isDownloadingScenery |= downloading;
 342                 if ( !downloading && nonExpiredOrCurrent) {
 343                     // schedule tile for loading with osg pager
 344                     _pager->queueRequest(e->tileFileName,
 345                                          e->getNode(),
 346                                          e->get_priority(),
 347                                          framestamp,
 348                                          e->getDatabaseRequest(),
 349                                          _options.get());
 350                     loading++;
 351                 }
 352             } // of tile not loaded case
 353         } else {
 354             SG_LOG(SG_TERRAIN, SG_ALERT, "Warning: empty tile in cache!");
 355         }
 356         tile_cache.next();
 357         sz++;
 358     }
 359
 360     int drop_count = sz - tile_cache.get_max_cache_size();
 361     bool dropTiles = false;
 362     if (_enableCache) {
 363       dropTiles = ( drop_count > 0 ) && ((loading==0)||(drop_count > 10));
 364     } else {
 365       dropTiles = true;
 366       drop_count = sz; // no limit on tiles to drop
 367     }
 368
 369     if (dropTiles)
 370     {
 371         long drop_index = _enableCache ? tile_cache.get_drop_tile() :
 372                                          tile_cache.get_first_expired_tile();
 373         while ( drop_index > -1 )
 374         {
 375             // schedule tile for deletion with osg pager
 376             TileEntry* old = tile_cache.get_tile(drop_index);
 377             SG_LOG(SG_TERRAIN, SG_DEBUG, "Dropping:" << old->get_tile_bucket());
 378
 379             tile_cache.clear_entry(drop_index);
 380
 381             osg::ref_ptr<osg::Object> subgraph = old->getNode();
 382             old->removeFromSceneGraph();
 383             delete old;
 384             // zeros out subgraph ref_ptr, so subgraph is owned by
 385             // the pager and will be deleted in the pager thread.
 386             _pager->queueDeleteRequest(subgraph);
 387
 388             if (!_enableCache)
 389                 drop_index = tile_cache.get_first_expired_tile();
 390             // limit tiles dropped to drop_count
 391             else if (--drop_count > 0)
 392                 drop_index = tile_cache.get_drop_tile();
 393             else
 394                drop_index = -1;
 395         }
 396     } // of dropping tiles loop
 397 }
 398
 399 // given the current lon/lat (in degrees), fill in the array of local
 400 // chunks.  If the chunk isn't already in the cache, then read it from
 401 // disk.
 402 void FGTileMgr::update(double)
 403 {
 404     double vis = _visibilityMeters->getDoubleValue();
 405     schedule_tiles_at(globals->get_view_position(), vis);
 406
 407     bool waitingOnTerrasync = false;
 408     update_queues(waitingOnTerrasync);
 409
 410     // scenery loading check, triggers after each sim (tile manager) reinit
 411     if (!_scenery_loaded->getBoolValue())
 412     {
 413         bool fdmInited = fgGetBool("sim/fdm-initialized");
 414         bool positionFinalized = fgGetBool("sim/position-finalized");
 415         bool sceneryOverride = _scenery_override->getBoolValue();
 416
 417
 418     // we are done if final position is set and the scenery & FDM are done.
 419     // scenery-override can ignore the last two, but not position finalization.
 420         if (positionFinalized && (sceneryOverride || (isSceneryLoaded() && fdmInited)))
 421         {
 422             _scenery_loaded->setBoolValue(true);
 423             fgSplashProgress("");
 424         }
 425         else
 426         {
 427             if (!positionFinalized) {
 428                 fgSplashProgress("finalize-position");
 429             } else if (waitingOnTerrasync) {
 430                 fgSplashProgress("downloading-scenery");
 431             } else {
 432                 fgSplashProgress("loading-scenery");
 433             }
 434
 435             // be nice to loader threads while waiting for initial scenery, reduce to 20fps
 436             SGTimeStamp::sleepForMSec(50);
 437         }
 438     }
 439 }
 440
 441 // schedule tiles for the viewer bucket
 442 // (FDM/AI/groundcache/... should use "schedule_scenery" instead)
 443 void FGTileMgr::schedule_tiles_at(const SGGeod& location, double range_m)
 444 {
 445     // SG_LOG( SG_TERRAIN, SG_DEBUG, "FGTileMgr::update() for "
 446     //         << longitude << " " << latitude );
 447
 448     current_bucket = SGBucket( location );
 449
 450     // schedule more tiles when visibility increased considerably
 451     // TODO Calculate tile size - instead of using fixed value (5000m)
 452     if (range_m - scheduled_visibility > 5000.0)
 453         previous_bucket.make_bad();
 454
 455     // SG_LOG( SG_TERRAIN, SG_DEBUG, "Updating tile list for "
 456     //         << current_bucket );
 457     fgSetInt( "/environment/current-tile-id", current_bucket.gen_index() );
 458
 459     // do tile load scheduling.
 460     // Note that we need keep track of both viewer buckets and fdm buckets.
 461     if ( state == Running ) {
 462         if (last_state != state)
 463         {
 464             SG_LOG( SG_TERRAIN, SG_DEBUG, "State == Running" );
 465         }
 466         if (current_bucket != previous_bucket) {
 467             // We've moved to a new bucket, we need to schedule any
 468             // needed tiles for loading.
 469             SG_LOG( SG_TERRAIN, SG_INFO, "FGTileMgr: at " << location << ", scheduling needed for:" << current_bucket
 470                    << ", visbility=" << range_m);
 471             scheduled_visibility = range_m;
 472             schedule_needed(current_bucket, range_m);
 473         }
 474
 475         // save bucket
 476         previous_bucket = current_bucket;
 477     } else if ( state == Start || state == Inited ) {
 478         SG_LOG( SG_TERRAIN, SG_DEBUG, "State == Start || Inited" );
 479         // do not update bucket yet (position not valid in initial loop)
 480         state = Running;
 481         previous_bucket.make_bad();
 482     }
 483     last_state = state;
 484 }
 485
 486 /** Schedules scenery for given position. Load request remains valid for given duration
 487  * (duration=0.0 => nothing is loaded).
 488  * Used for FDM/AI/groundcache/... requests. Viewer uses "schedule_tiles_at" instead.
 489  * Returns true when all tiles for the given position are already loaded, false otherwise.
 490  */
 491 bool FGTileMgr::schedule_scenery(const SGGeod& position, double range_m, double duration)
 492 {
 493     // sanity check (unfortunately needed!)
 494     if (!position.isValid())
 495         return false;
 496     const float priority = 0.0;
 497     bool available = true;
 498
 499     SGBucket bucket(position);
 500     available = sched_tile( bucket, priority, false, duration );
 501
 502     if ((!available)&&(duration==0.0))
 503         return false;
 504
 505     SGVec3d cartPos = SGVec3d::fromGeod(position);
 506
 507     // Traverse all tiles required to be there for the given visibility.
 508     double tile_width = bucket.get_width_m();
 509     double tile_height = bucket.get_height_m();
 510     double tile_r = 0.5*sqrt(tile_width*tile_width + tile_height*tile_height);
 511     double max_dist = tile_r + range_m;
 512     double max_dist2 = max_dist*max_dist;
 513
 514     int xrange = (int)fabs(range_m / tile_width) + 1;
 515     int yrange = (int)fabs(range_m / tile_height) + 1;
 516
 517     for ( int x = -xrange; x <= xrange; ++x )
 518     {
 519         for ( int y = -yrange; y <= yrange; ++y )
 520         {
 521             // We have already checked for the center tile.
 522             if ( x != 0 || y != 0 )
 523             {
 524                 SGBucket b = bucket.sibling(x, y );
 525                 if (!b.isValid()) {
 526                     continue;
 527                 }
 528
 529                 double distance2 = distSqr(cartPos, SGVec3d::fromGeod(b.get_center()));
 530                 // Do not ask if it is just the next tile but way out of range.
 531                 if (distance2 <= max_dist2)
 532                 {
 533                     available &= sched_tile( b, priority, false, duration );
 534                     if ((!available)&&(duration==0.0))
 535                         return false;
 536                 }
 537             }
 538         }
 539     }
 540
 541     return available;
 542 }
 543
 544 // Returns true if tiles around current view position have been loaded
 545 bool FGTileMgr::isSceneryLoaded()
 546 {
 547     double range_m = 100.0;
 548     if (scheduled_visibility < range_m)
 549         range_m = scheduled_visibility;
 550
 551     return schedule_scenery(globals->get_view_position(), range_m, 0.0);
 552 }
 553
 554 bool FGTileMgr::isTileDirSyncing(const std::string& tileFileName) const
 555 {
 556     if (!_terra_sync) {
 557         return false;
 558     }
 559
 560     std::string nameWithoutExtension = tileFileName.substr(0, tileFileName.size() - 4);
 561     long int bucketIndex = simgear::strutils::to_int(nameWithoutExtension);
 562     SGBucket bucket(bucketIndex);
 563
 564     return _terra_sync->isTileDirPending(bucket.gen_base_path());
 565 }
 566