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