src/Scenery/FGTileLoader.cxx

   1 // FGTileLoader - Queue scenery tiles for loading.
   2 //
   3 // Written by Bernie Bright, started March 2001.
   4 //
   5 // Copyright (C) 2001  Bernard Bright - bbright@bigpond.net.au
   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 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <Main/globals.hxx>
  30 #include "FGTileLoader.hxx"
  31 #include "tileentry.hxx"
  32 #include "tilemgr.hxx"
  33
  34 extern ssgBranch *terrain;
  35 extern ssgBranch *ground;
  36
  37
  38 /**
  39  *
  40  */
  41 FGTileLoader::FGTileLoader()
  42 {
  43 #if defined(ENABLE_THREADS) && ENABLE_THREADS
  44     // Create and start the loader threads.
  45     for (int i = 0; i < MAX_THREADS; ++i)
  46     {
  47         threads[i] = new LoaderThread(this);
  48         threads[i]->start();
  49     }
  50 #endif // ENABLE_THREADS
  51 }
  52
  53 /**
  54  * Terminate all threads.
  55  */
  56 FGTileLoader::~FGTileLoader()
  57 {
  58 #if defined(ENABLE_THREADS) && ENABLE_THREADS
  59     // Wake up its time to die.
  60     // queue_cond.broadcast();
  61
  62     for (int i = 0; i < MAX_THREADS; ++i)
  63     {
  64         threads[i]->cancel();
  65         threads[i]->join();
  66     }
  67 #endif // ENABLE_THREADS
  68 }
  69
  70
  71 #if 0 // we don't ever want to do this I don't think
  72 /**
  73  *
  74  */
  75 void FGTileLoader::reinit() {
  76     while ( !tile_load_queue.empty() ) {
  77         tile_load_queue.pop();
  78     }
  79 }
  80 #endif
  81
  82
  83 /**
  84  *
  85  */
  86 void
  87 FGTileLoader::add( FGTileEntry* tile )
  88 {
  89     /**
  90      * Initialise tile_path here and not in ctor to avoid problems
  91      * with the initialastion order of global objects.
  92      */
  93     static bool beenhere = false;
  94     if (!beenhere)
  95     {
  96         if ( !globals->get_fg_scenery().empty() ) {
  97             tile_path = globals->get_fg_scenery();
  98         } else {
  99             SGPath tmp;
 100             tmp.set( globals->get_fg_root() );
 101             tmp.append( "Scenery" );
 102             tile_path = tmp.str();
 103         }
 104         beenhere = true;
 105     }
 106
 107     tile_load_queue.push( tile );
 108 }
 109
 110 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 111 /**
 112  *
 113  */
 114 void
 115 FGTileLoader::remove( FGTileEntry* tile )
 116 {
 117     tile_free_queue.push( tile );
 118 }
 119 #endif
 120
 121 /**
 122  *
 123  */
 124 void
 125 FGTileLoader::update()
 126 {
 127
 128 #if defined(ENABLE_THREADS) && ENABLE_THREADS
 129     // send a signal to the pager thread that it is allowed to load
 130     // another tile
 131     mutex.lock();
 132     frame_cond.signal();
 133     mutex.unlock();
 134 #else
 135     if ( !tile_load_queue.empty() ) {
 136         // cout << "loading next tile ..." << endl;
 137         // load the next tile in the queue
 138         FGTileEntry* tile = tile_load_queue.front();
 139         tile_load_queue.pop();
 140
 141         tile->load( tile_path, true );
 142
 143         FGTileMgr::ready_to_attach( tile );
 144     }
 145
 146 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 147     if ( !tile_free_queue.empty() ) {
 148         // cout << "freeing next tile ..." << endl;
 149         // free the next tile in the queue
 150         FGTileEntry* tile = tile_free_queue.front();
 151         tile_free_queue.pop();
 152         tile->free_tile();
 153         delete tile;
 154     }
 155 #endif
 156
 157 #endif // ENABLE_THREADS
 158
 159 }
 160
 161
 162 #if defined(ENABLE_THREADS) && ENABLE_THREADS
 163 /**
 164  *
 165  */
 166 void
 167 FGTileLoader::LoaderThread::run()
 168 {
 169     pthread_cleanup_push( cleanup_handler, loader );
 170     while ( true ) {
 171         // Wait for a load request to be placed in the queue.
 172         FGTileEntry* tile = loader->tile_load_queue.pop();
 173
 174         // Wait for the next frame signal before we load a tile from the queue
 175         loader->mutex.lock();
 176         loader->frame_cond.wait( loader->mutex );
 177         loader->mutex.unlock();
 178
 179         set_cancel( SGThread::CANCEL_DISABLE );
 180         tile->load( loader->tile_path, true );
 181         set_cancel( SGThread::CANCEL_DEFERRED );
 182
 183         FGTileMgr::ready_to_attach( tile );
 184
 185 #ifdef WISH_PLIB_WAS_THREADED // but it isn't
 186         // Handle and pending removals
 187         while ( !loader->tile_free_queue.empty() ) {
 188             // cout << "freeing next tile ..." << endl;
 189             // free the next tile in the queue
 190             FGTileEntry* tile = loader->tile_free_queue.pop();
 191             tile->free_tile();
 192             delete tile;
 193         }
 194 #endif
 195
 196     }
 197     pthread_cleanup_pop(1);
 198 }
 199
 200 /**
 201  * Ensure mutex is unlocked.
 202  */
 203 void
 204 cleanup_handler( void* arg )
 205 {
 206     FGTileLoader* loader = (FGTileLoader*) arg;
 207     loader->mutex.unlock();
 208 }
 209 #endif // ENABLE_THREADS