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 <plib/ssg.h>
  29
  30 #include <simgear/constants.h>
  31 #include <simgear/debug/logstream.hxx>
  32 #include <simgear/math/point3d.hxx>
  33 #include <simgear/math/polar3d.hxx>
  34 #include <simgear/math/sg_geodesy.hxx>
  35 #include <simgear/math/vector.hxx>
  36 #include <simgear/structure/exception.hxx>
  37 #include <simgear/scene/model/modellib.hxx>
  38 #include <simgear/scene/model/shadowvolume.hxx>
  39
  40 #include <Main/globals.hxx>
  41 #include <Main/fg_props.hxx>
  42 #include <Main/viewer.hxx>
  43 #include <Scripting/NasalSys.hxx>
  44
  45 #include "newcache.hxx"
  46 #include "scenery.hxx"
  47 #include "tilemgr.hxx"
  48
  49 #define TEST_LAST_HIT_CACHE
  50
  51 #if defined(ENABLE_THREADS)
  52 SGLockedQueue<FGTileEntry *> FGTileMgr::attach_queue;
  53 SGLockedQueue<FGDeferredModel *> FGTileMgr::model_queue;
  54 #else
  55 queue<FGTileEntry *> FGTileMgr::attach_queue;
  56 queue<FGDeferredModel *> FGTileMgr::model_queue;
  57 #endif // ENABLE_THREADS
  58 queue<FGTileEntry *> FGTileMgr::delete_queue;
  59
  60 bool FGTileMgr::tile_filter = true;
  61
  62 extern SGShadowVolume *shadows;
  63
  64 // Constructor
  65 FGTileMgr::FGTileMgr():
  66     state( Start ),
  67     current_tile( NULL ),
  68     vis( 16000 )
  69 {
  70 }
  71
  72
  73 // Destructor
  74 FGTileMgr::~FGTileMgr() {
  75 }
  76
  77
  78 // Initialize the Tile Manager subsystem
  79 int FGTileMgr::init() {
  80     SG_LOG( SG_TERRAIN, SG_INFO, "Initializing Tile Manager subsystem." );
  81
  82     tile_cache.init();
  83
  84 #if 0
  85
  86     // instead it's just a lot easier to let any pending work flush
  87     // through, rather than trying to arrest the queue and nuke all
  88     // the various work at all the various stages and get everything
  89     // cleaned up properly.
  90
  91     while ( ! attach_queue.empty() ) {
  92         attach_queue.pop();
  93     }
  94
  95     while ( ! model_queue.empty() ) {
  96 #if defined(ENABLE_THREADS)
  97         FGDeferredModel* dm = model_queue.pop();
  98 #else
  99         FGDeferredModel* dm = model_queue.front();
 100         model_queue.pop();
 101 #endif
 102         delete dm;
 103     }
 104     loader.reinit();
 105 #endif
 106
 107     state = Inited;
 108
 109     previous_bucket.make_bad();
 110     current_bucket.make_bad();
 111
 112     longitude = latitude = -1000.0;
 113
 114     return 1;
 115 }
 116
 117
 118 // schedule a tile for loading
 119 void FGTileMgr::sched_tile( const SGBucket& b, const bool is_inner_ring ) {
 120     // see if tile already exists in the cache
 121     FGTileEntry *t = tile_cache.get_tile( b );
 122
 123     if ( t == NULL ) {
 124         // make space in the cache
 125         while ( (int)tile_cache.get_size() > tile_cache.get_max_cache_size() ) {
 126             long index = tile_cache.get_oldest_tile();
 127             if ( index >= 0 ) {
 128                 FGTileEntry *old = tile_cache.get_tile( index );
 129                 shadows->deleteOccluderFromTile( (ssgBranch *) old->get_terra_transform() );
 130                 old->disconnect_ssg_nodes();
 131                 delete_queue.push( old );
 132                 tile_cache.clear_entry( index );
 133             } else {
 134                 // nothing to free ?!? forge ahead
 135                 break;
 136             }
 137         }
 138
 139         // create a new entry
 140         FGTileEntry *e = new FGTileEntry( b );
 141
 142         // insert the tile into the cache
 143         if ( tile_cache.insert_tile( e ) ) {
 144             // Schedule tile for loading
 145             loader.add( e );
 146         } else {
 147             // insert failed (cache full with no available entries to
 148             // delete.)  Try again later
 149             delete e;
 150         }
 151     } else {
 152         t->set_inner_ring( is_inner_ring );
 153     }
 154 }
 155
 156
 157 // schedule a needed buckets for loading
 158 void FGTileMgr::schedule_needed( double vis, const SGBucket& curr_bucket) {
 159     // sanity check (unfortunately needed!)
 160     if ( longitude < -180.0 || longitude > 180.0
 161          || latitude < -90.0 || latitude > 90.0 )
 162     {
 163         SG_LOG( SG_TERRAIN, SG_ALERT,
 164                 "Attempting to schedule tiles for bogus lon and lat  = ("
 165                 << longitude << "," << latitude << ")" );
 166         return;         // FIXME
 167         SG_LOG( SG_TERRAIN, SG_ALERT,
 168                 "This is a FATAL error.  Exiting!" );
 169         exit(-1);
 170     }
 171
 172     SG_LOG( SG_TERRAIN, SG_INFO,
 173             "scheduling needed tiles for " << longitude << " " << latitude );
 174
 175     // vis = fgGetDouble("/environment/visibility-m");
 176
 177     double tile_width = curr_bucket.get_width_m();
 178     double tile_height = curr_bucket.get_height_m();
 179     // cout << "tile width = " << tile_width << "  tile_height = "
 180     //      << tile_height << endl;
 181
 182     xrange = (int)(vis / tile_width) + 1;
 183     yrange = (int)(vis / tile_height) + 1;
 184     if ( xrange < 1 ) { xrange = 1; }
 185     if ( yrange < 1 ) { yrange = 1; }
 186
 187     // note * 2 at end doubles cache size (for fdm and viewer)
 188     tile_cache.set_max_cache_size( (2*xrange + 2) * (2*yrange + 2) * 2 );
 189     // cout << "xrange = " << xrange << "  yrange = " << yrange << endl;
 190     // cout << "max cache size = " << tile_cache.get_max_cache_size()
 191     //      << " current cache size = " << tile_cache.get_size() << endl;
 192
 193     // clear the inner ring flags so we can set them below.  This
 194     // prevents us from having "true" entries we aren't able to find
 195     // to get rid of if we teleport a long ways away from the current
 196     // location.
 197     tile_cache.clear_inner_ring_flags();
 198
 199     SGBucket b;
 200
 201     // schedule center tile first so it can be loaded first
 202     b = sgBucketOffset( longitude, latitude, 0, 0 );
 203     sched_tile( b, true );
 204
 205     int x, y;
 206
 207     // schedule next ring of 8 tiles
 208     for ( x = -1; x <= 1; ++x ) {
 209         for ( y = -1; y <= 1; ++y ) {
 210             if ( x != 0 || y != 0 ) {
 211                 b = sgBucketOffset( longitude, latitude, x, y );
 212                 sched_tile( b, true );
 213             }
 214         }
 215     }
 216
 217     // schedule remaining tiles
 218     for ( x = -xrange; x <= xrange; ++x ) {
 219         for ( y = -yrange; y <= yrange; ++y ) {
 220             if ( x < -1 || x > 1 || y < -1 || y > 1 ) {
 221                 SGBucket b = sgBucketOffset( longitude, latitude, x, y );
 222                 sched_tile( b, false );
 223             }
 224         }
 225     }
 226 }
 227
 228
 229 void FGTileMgr::initialize_queue()
 230 {
 231     // First time through or we have teleported, initialize the
 232     // system and load all relavant tiles
 233
 234     SG_LOG( SG_TERRAIN, SG_INFO, "Initialize_queue(): Updating Tile list for "
 235             << current_bucket );
 236     // cout << "tile cache size = " << tile_cache.get_size() << endl;
 237
 238     // wipe/initialize tile cache
 239     // tile_cache.init();
 240     previous_bucket.make_bad();
 241
 242     // build the local area list and schedule tiles for loading
 243
 244     // start with the center tile and work out in concentric
 245     // "rings"
 246
 247     double visibility_meters = fgGetDouble("/environment/visibility-m");
 248     schedule_needed(visibility_meters, current_bucket);
 249
 250     // do we really want to lose this? CLO
 251 #if 0
 252     // Now force a load of the center tile and inner ring so we
 253     // have something to see in our first frame.
 254     int i;
 255     for ( i = 0; i < 9; ++i ) {
 256         if ( load_queue.size() ) {
 257             SG_LOG( SG_TERRAIN, SG_DEBUG,
 258                     "Load queue not empty, loading a tile" );
 259
 260             SGBucket pending = load_queue.front();
 261             load_queue.pop_front();
 262             load_tile( pending );
 263         }
 264     }
 265 #endif
 266 }
 267
 268 /**
 269  * return current status of queues
 270  *
 271  */
 272
 273 bool FGTileMgr::all_queues_empty() {
 274         return attach_queue.empty() && model_queue.empty();
 275 }
 276
 277
 278 /**
 279  * Update the various queues maintained by the tilemagr (private
 280  * internal function, do not call directly.)
 281  */
 282 void FGTileMgr::update_queues()
 283 {
 284     // load the next model in the load queue.  Currently this must
 285     // happen in the render thread because model loading can trigger
 286     // texture loading which involves use of the opengl api.  Skip any
 287     // models belonging to not loaded tiles (i.e. the tile was removed
 288     // before we were able to load some of the associated models.)
 289     if ( !model_queue.empty() ) {
 290         bool processed_one = false;
 291
 292         while ( model_queue.size() > 200 || processed_one == false ) {
 293             processed_one = true;
 294
 295             if ( model_queue.size() > 200 ) {
 296                 SG_LOG( SG_TERRAIN, SG_INFO,
 297                         "Alert: catching up on model load queue" );
 298             }
 299
 300             // cout << "loading next model ..." << endl;
 301             // load the next tile in the queue
 302 #if defined(ENABLE_THREADS)
 303             FGDeferredModel* dm = model_queue.pop();
 304 #else
 305             FGDeferredModel* dm = model_queue.front();
 306             model_queue.pop();
 307 #endif
 308
 309             // only load the model if the tile still exists in the
 310             // tile cache
 311             FGTileEntry *t = tile_cache.get_tile( dm->get_bucket() );
 312             if ( t != NULL ) {
 313                 ssgTexturePath( (char *)(dm->get_texture_path().c_str()) );
 314                 try {
 315                     ssgEntity *obj_model =
 316                         globals->get_model_lib()->load_model( ".",
 317                                                   dm->get_model_path(),
 318                                                   globals->get_props(),
 319                                                   globals->get_sim_time_sec(),
 320                                                   dm->get_cache_state(),
 321                                                   new FGNasalModelData );
 322                     if ( obj_model != NULL ) {
 323                         dm->get_obj_trans()->addKid( obj_model );
 324                         shadows->addOccluder( (ssgBranch *) obj_model->getParent(0),
 325                             SGShadowVolume::occluderTypeTileObject,
 326                             (ssgBranch *) dm->get_tile()->get_terra_transform());
 327                     }
 328                 } catch (const sg_io_exception& exc) {
 329                                         string m(exc.getMessage());
 330                                         m += " ";
 331                                         m += exc.getLocation().asString();
 332                     SG_LOG( SG_ALL, SG_ALERT, m );
 333                 } catch (const sg_exception& exc) { // XXX may be redundant
 334                     SG_LOG( SG_ALL, SG_ALERT, exc.getMessage());
 335                 }
 336
 337                 dm->get_tile()->dec_pending_models();
 338             }
 339             delete dm;
 340         }
 341     }
 342
 343     // Notify the tile loader that it can load another tile
 344     loader.update();
 345
 346     if ( !attach_queue.empty() ) {
 347 #if defined(ENABLE_THREADS)
 348         FGTileEntry* e = attach_queue.pop();
 349 #else
 350         FGTileEntry* e = attach_queue.front();
 351         attach_queue.pop();
 352 #endif
 353         e->add_ssg_nodes( globals->get_scenery()->get_terrain_branch(),
 354                           globals->get_scenery()->get_gnd_lights_root(),
 355                           globals->get_scenery()->get_vasi_lights_root(),
 356                           globals->get_scenery()->get_rwy_lights_root(),
 357                           globals->get_scenery()->get_taxi_lights_root() );
 358         // cout << "Adding ssg nodes for "
 359     }
 360
 361     if ( !delete_queue.empty() ) {
 362         // cout << "delete queue = " << delete_queue.size() << endl;
 363         bool processed_one = false;
 364
 365         while ( delete_queue.size() > 30 || processed_one == false ) {
 366             processed_one = true;
 367
 368             if ( delete_queue.size() > 30 ) {
 369                 // uh oh, delete queue is blowing up, we aren't clearing
 370                 // it fast enough.  Let's just panic, well not panic, but
 371                 // get real serious and agressively free up some tiles so
 372                 // we don't explode our memory usage.
 373
 374                 SG_LOG( SG_TERRAIN, SG_ALERT,
 375                         "Warning: catching up on tile delete queue" );
 376             }
 377
 378             FGTileEntry* e = delete_queue.front();
 379             if ( e->free_tile() ) {
 380                 delete_queue.pop();
 381                 delete e;
 382             }
 383         }
 384     }
 385 }
 386
 387
 388 // given the current lon/lat (in degrees), fill in the array of local
 389 // chunks.  If the chunk isn't already in the cache, then read it from
 390 // disk.
 391 int FGTileMgr::update( double visibility_meters )
 392 {
 393     SGLocation *location = globals->get_current_view()->getSGLocation();
 394     return update( location, visibility_meters );
 395 }
 396
 397
 398 int FGTileMgr::update( SGLocation *location, double visibility_meters )
 399 {
 400     SG_LOG( SG_TERRAIN, SG_DEBUG, "FGTileMgr::update()" );
 401
 402     longitude = location->getLongitude_deg();
 403     latitude = location->getLatitude_deg();
 404     // add 1.0m to the max altitude to give a little leeway to the
 405     // ground reaction code.
 406     altitude_m = location->getAltitudeASL_ft() * SG_FEET_TO_METER + 1.0;
 407
 408     // if current altitude is apparently not initialized, set max
 409     // altitude to something big.
 410     if ( altitude_m < -1000 ) {
 411         altitude_m = 10000;
 412     }
 413     // SG_LOG( SG_TERRAIN, SG_DEBUG, "FGTileMgr::update() for "
 414     //         << longitude << " " << latatitude );
 415
 416     current_bucket.set_bucket( longitude, latitude );
 417     // SG_LOG( SG_TERRAIN, SG_DEBUG, "Updating tile list for "
 418     //         << current_bucket );
 419     fgSetInt( "/environment/current-tile-id", current_bucket.gen_index() );
 420
 421     // do tile load scheduling.
 422     // Note that we need keep track of both viewer buckets and fdm buckets.
 423     if ( state == Running ) {
 424         SG_LOG( SG_TERRAIN, SG_DEBUG, "State == Running" );
 425         if (!(current_bucket == previous_bucket )) {
 426             // We've moved to a new bucket, we need to schedule any
 427             // needed tiles for loading.
 428             SG_LOG( SG_TERRAIN, SG_INFO, "FGTileMgr::update()" );
 429             schedule_needed(visibility_meters, current_bucket);
 430         }
 431     } else if ( state == Start || state == Inited ) {
 432         SG_LOG( SG_TERRAIN, SG_INFO, "State == Start || Inited" );
 433 //        initialize_queue();
 434         state = Running;
 435
 436         // load the next tile in the load queue (or authorize the next
 437         // load in the case of the threaded tile pager)
 438         loader.update();
 439     }
 440
 441     update_queues();
 442
 443     // save bucket...
 444     previous_bucket = current_bucket;
 445
 446     return 1;
 447 }
 448
 449
 450 // timer event driven call to scheduler for the purpose of refreshing the tile timestamps
 451 void FGTileMgr::refresh_view_timestamps() {
 452     SG_LOG( SG_TERRAIN, SG_INFO,
 453             "Refreshing timestamps for " << current_bucket.get_center_lon()
 454             << " " << current_bucket.get_center_lat() );
 455     if ( longitude >= -180.0 && longitude <= 180.0
 456          && latitude >= -90.0 && latitude <= 90.0 )
 457     {
 458         schedule_needed(fgGetDouble("/environment/visibility-m"), current_bucket);
 459     }
 460 }
 461
 462 void FGTileMgr::prep_ssg_nodes( SGLocation *location, float vis ) {
 463
 464     // traverse the potentially viewable tile list and update range
 465     // selector and transform
 466
 467     float *up = location->get_world_up();
 468
 469     FGTileEntry *e;
 470     tile_cache.reset_traversal();
 471
 472     const double *vp = location->get_absolute_view_pos();
 473     Point3D viewpos(vp[0], vp[1], vp[2]);
 474     while ( ! tile_cache.at_end() ) {
 475         // cout << "processing a tile" << endl;
 476         if ( (e = tile_cache.get_current()) ) {
 477             e->prep_ssg_node( viewpos, up, vis);
 478         } else {
 479             SG_LOG(SG_INPUT, SG_ALERT, "warning ... empty tile in cache");
 480         }
 481         tile_cache.next();
 482     }
 483 }
 484
 485 bool FGTileMgr::set_tile_filter( bool f ) {
 486     bool old = tile_filter;
 487     tile_filter = f;
 488     return old;
 489 }
 490
 491 int FGTileMgr::tile_filter_cb( ssgEntity *, int )
 492 {
 493   return tile_filter ? 1 : 0;
 494 }
 495
 496 bool FGTileMgr::scenery_available(double lat, double lon, double range_m)
 497 {
 498   // sanity check (unfortunately needed!)
 499   if ( lon <= -180.0 || lon >= 180.0 || lat <= -90.0 || lat >= 90.0 )
 500     return false;
 501
 502   SGBucket bucket(lon, lat);
 503   FGTileEntry *te = tile_cache.get_tile(bucket);
 504   if (!te || !te->is_loaded())
 505     return false;
 506
 507   // Traverse all tiles required to be there for the given visibility.
 508   // This uses exactly the same algorithm like the tile scheduler.
 509   double tile_width = bucket.get_width_m();
 510   double tile_height = bucket.get_height_m();
 511
 512   int xrange = (int)fabs(range_m / tile_width) + 1;
 513   int yrange = (int)fabs(range_m / tile_height) + 1;
 514
 515   for ( int x = -xrange; x <= xrange; ++x ) {
 516     for ( int y = -yrange; y <= yrange; ++y ) {
 517       // We have already checked for the center tile.
 518       if ( x != 0 || y != 0 ) {
 519         SGBucket b = sgBucketOffset( lon, lat, x, y );
 520         FGTileEntry *te = tile_cache.get_tile(b);
 521         if (!te || !te->is_loaded())
 522           return false;
 523       }
 524     }
 525   }
 526
 527   // Survived all tests.
 528   return true;
 529 }