simgear/scene/model/ModelRegistry.cxx

   1 // ModelRegistry.hxx -- interface to the OSG model registry
   2 //
   3 // Copyright (C) 2005-2007 Mathias Froehlich
   4 // Copyright (C) 2007  Tim Moore <timoore@redhat.com>
   5 //
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License as
   8 // published by the Free Software Foundation; either version 2 of the
   9 // License, or (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include <simgear_config.h>
  22 #endif
  23
  24 #include "ModelRegistry.hxx"
  25
  26 #include <algorithm>
  27 #include <utility>
  28 #include <vector>
  29
  30 #include <OpenThreads/ScopedLock>
  31
  32 #include <osg/observer_ptr>
  33 #include <osg/ref_ptr>
  34 #include <osg/Group>
  35 #include <osg/NodeCallback>
  36 #include <osg/Switch>
  37 #include <osg/Material>
  38 #include <osg/MatrixTransform>
  39 #include <osgDB/Archive>
  40 #include <osgDB/FileNameUtils>
  41 #include <osgDB/FileUtils>
  42 #include <osgDB/ReadFile>
  43 #include <osgDB/WriteFile>
  44 #include <osgDB/Registry>
  45 #include <osgDB/SharedStateManager>
  46 #include <osgUtil/Optimizer>
  47
  48 #include <simgear/scene/util/SGSceneFeatures.hxx>
  49 #include <simgear/scene/util/SGStateAttributeVisitor.hxx>
  50 #include <simgear/scene/util/SGTextureStateAttributeVisitor.hxx>
  51 #include <simgear/scene/util/NodeAndDrawableVisitor.hxx>
  52
  53 #include <simgear/structure/exception.hxx>
  54 #include <simgear/props/props.hxx>
  55 #include <simgear/props/props_io.hxx>
  56 #include <simgear/props/condition.hxx>
  57
  58 #include "BoundingVolumeBuildVisitor.hxx"
  59
  60 using namespace std;
  61 using namespace osg;
  62 using namespace osgUtil;
  63 using namespace osgDB;
  64 using namespace simgear;
  65
  66 using OpenThreads::ReentrantMutex;
  67 using OpenThreads::ScopedLock;
  68
  69 // Little helper class that holds an extra reference to a
  70 // loaded 3d model.
  71 // Since we clone all structural nodes from our 3d models,
  72 // the database pager will only see one single reference to
  73 // top node of the model and expire it relatively fast.
  74 // We attach that extra reference to every model cloned from
  75 // a base model in the pager. When that cloned model is deleted
  76 // this extra reference is deleted too. So if there are no
  77 // cloned models left the model will expire.
  78 namespace {
  79 class SGDatabaseReference : public Observer {
  80 public:
  81   SGDatabaseReference(Referenced* referenced) :
  82     mReferenced(referenced)
  83   { }
  84   virtual void objectDeleted(void*)
  85   {
  86     mReferenced = 0;
  87   }
  88 private:
  89   ref_ptr<Referenced> mReferenced;
  90 };
  91
  92 // Set the name of a Texture to the simple name of its image
  93 // file. This can be used to do livery substitution after the image
  94 // has been deallocated.
  95 class TextureNameVisitor  : public NodeAndDrawableVisitor {
  96 public:
  97     TextureNameVisitor(NodeVisitor::TraversalMode tm = NodeVisitor::TRAVERSE_ALL_CHILDREN) :
  98         NodeAndDrawableVisitor(tm)
  99     {
 100     }
 101
 102     virtual void apply(Node& node)
 103     {
 104         nameTextures(node.getStateSet());
 105         traverse(node);
 106     }
 107
 108     virtual void apply(Drawable& drawable)
 109     {
 110         nameTextures(drawable.getStateSet());
 111     }
 112 protected:
 113     void nameTextures(StateSet* stateSet)
 114     {
 115         if (!stateSet)
 116             return;
 117         int numUnits = stateSet->getTextureAttributeList().size();
 118         for (int i = 0; i < numUnits; ++i) {
 119             StateAttribute* attr
 120                 = stateSet->getTextureAttribute(i, StateAttribute::TEXTURE);
 121             Texture2D* texture = dynamic_cast<Texture2D*>(attr);
 122             if (!texture || !texture->getName().empty())
 123                 continue;
 124             const Image *image = texture->getImage();
 125             if (!image)
 126                 continue;
 127             texture->setName(image->getFileName());
 128         }
 129     }
 130 };
 131
 132 // Change the StateSets of a model to hold different textures based on
 133 // a livery path.
 134
 135 class TextureUpdateVisitor : public NodeAndDrawableVisitor {
 136 public:
 137     TextureUpdateVisitor(const FilePathList& pathList) :
 138         NodeAndDrawableVisitor(NodeVisitor::TRAVERSE_ALL_CHILDREN),
 139         _pathList(pathList)
 140     {
 141     }
 142
 143     virtual void apply(Node& node)
 144     {
 145         StateSet* stateSet = cloneStateSet(node.getStateSet());
 146         if (stateSet)
 147             node.setStateSet(stateSet);
 148         traverse(node);
 149     }
 150
 151     virtual void apply(Drawable& drawable)
 152     {
 153         StateSet* stateSet = cloneStateSet(drawable.getStateSet());
 154         if (stateSet)
 155             drawable.setStateSet(stateSet);
 156     }
 157     // Copied from Mathias' earlier SGTextureUpdateVisitor
 158 protected:
 159     Texture2D* textureReplace(int unit, const StateAttribute* attr)
 160     {
 161         const Texture2D* texture = dynamic_cast<const Texture2D*>(attr);
 162
 163         if (!texture)
 164             return 0;
 165
 166         const Image* image = texture->getImage();
 167         const string* fullFilePath = 0;
 168         if (image) {
 169             // The currently loaded file name
 170             fullFilePath = &image->getFileName();
 171
 172         } else {
 173             fullFilePath = &texture->getName();
 174         }
 175         // The short name
 176         string fileName = getSimpleFileName(*fullFilePath);
 177         if (fileName.empty())
 178             return 0;
 179         // The name that should be found with the current database path
 180         string fullLiveryFile = findFileInPath(fileName, _pathList);
 181         // If it is empty or they are identical then there is nothing to do
 182         if (fullLiveryFile.empty() || fullLiveryFile == *fullFilePath)
 183             return 0;
 184         Image* newImage = readImageFile(fullLiveryFile);
 185         if (!newImage)
 186             return 0;
 187         CopyOp copyOp(CopyOp::DEEP_COPY_ALL & ~CopyOp::DEEP_COPY_IMAGES);
 188         Texture2D* newTexture = static_cast<Texture2D*>(copyOp(texture));
 189         if (!newTexture) {
 190             return 0;
 191         } else {
 192             newTexture->setImage(newImage);
 193             return newTexture;
 194         }
 195     }
 196
 197     StateSet* cloneStateSet(const StateSet* stateSet)
 198     {
 199         typedef pair<int, Texture2D*> Tex2D;
 200         vector<Tex2D> newTextures;
 201         StateSet* result = 0;
 202
 203         if (!stateSet)
 204             return 0;
 205         int numUnits = stateSet->getTextureAttributeList().size();
 206         if (numUnits > 0) {
 207             for (int i = 0; i < numUnits; ++i) {
 208                 const StateAttribute* attr
 209                     = stateSet->getTextureAttribute(i, StateAttribute::TEXTURE);
 210                 Texture2D* newTexture = textureReplace(i, attr);
 211                 if (newTexture)
 212                     newTextures.push_back(Tex2D(i, newTexture));
 213             }
 214             if (!newTextures.empty()) {
 215                 result = static_cast<StateSet*>(stateSet->clone(CopyOp()));
 216                 for (vector<Tex2D>::iterator i = newTextures.begin();
 217                      i != newTextures.end();
 218                      ++i) {
 219                     result->setTextureAttribute(i->first, i->second);
 220                 }
 221             }
 222         }
 223         return result;
 224     }
 225 private:
 226     FilePathList _pathList;
 227 };
 228
 229
 230 class SGTexCompressionVisitor : public SGTextureStateAttributeVisitor {
 231 public:
 232   virtual void apply(int, StateSet::RefAttributePair& refAttr)
 233   {
 234     Texture2D* texture;
 235     texture = dynamic_cast<Texture2D*>(refAttr.first.get());
 236     if (!texture)
 237       return;
 238
 239     // Hmm, true??
 240     texture->setDataVariance(osg::Object::STATIC);
 241
 242     Image* image = texture->getImage(0);
 243     if (!image)
 244       return;
 245
 246     int s = image->s();
 247     int t = image->t();
 248
 249     if (s <= t && 32 <= s) {
 250       SGSceneFeatures::instance()->setTextureCompression(texture);
 251     } else if (t < s && 32 <= t) {
 252       SGSceneFeatures::instance()->setTextureCompression(texture);
 253     }
 254   }
 255 };
 256
 257 class SGTexDataVarianceVisitor : public SGTextureStateAttributeVisitor {
 258 public:
 259   virtual void apply(int, StateSet::RefAttributePair& refAttr)
 260   {
 261     Texture* texture;
 262     texture = dynamic_cast<Texture*>(refAttr.first.get());
 263     if (!texture)
 264       return;
 265
 266     texture->setDataVariance(Object::STATIC);
 267   }
 268
 269   virtual void apply(StateSet* stateSet)
 270   {
 271     if (!stateSet)
 272       return;
 273     SGTextureStateAttributeVisitor::apply(stateSet);
 274     stateSet->setDataVariance(Object::STATIC);
 275   }
 276 };
 277
 278 class SGAcMaterialCrippleVisitor : public SGStateAttributeVisitor {
 279 public:
 280   virtual void apply(StateSet::RefAttributePair& refAttr)
 281   {
 282     Material* material;
 283     material = dynamic_cast<Material*>(refAttr.first.get());
 284     if (!material)
 285       return;
 286     material->setColorMode(Material::AMBIENT_AND_DIFFUSE);
 287   }
 288 };
 289
 290 } // namespace
 291
 292 Node* DefaultProcessPolicy::process(Node* node, const string& filename,
 293                                     const ReaderWriter::Options* opt)
 294 {
 295     TextureNameVisitor nameVisitor;
 296     node->accept(nameVisitor);
 297     return node;
 298 }
 299
 300 ReaderWriter::ReadResult
 301 ModelRegistry::readImage(const string& fileName,
 302                          const ReaderWriter::Options* opt)
 303 {
 304     ScopedLock<ReentrantMutex> lock(readerMutex);
 305     CallbackMap::iterator iter
 306         = imageCallbackMap.find(getFileExtension(fileName));
 307     // XXX Workaround for OSG plugin bug
 308     {
 309         if (iter != imageCallbackMap.end() && iter->second.valid())
 310             return iter->second->readImage(fileName, opt);
 311         string absFileName = findDataFile(fileName, opt);
 312         if (!fileExists(absFileName)) {
 313             SG_LOG(SG_IO, SG_ALERT, "Cannot find image file \""
 314                    << fileName << "\"");
 315             return ReaderWriter::ReadResult::FILE_NOT_FOUND;
 316         }
 317
 318         Registry* registry = Registry::instance();
 319         ReaderWriter::ReadResult res;
 320         res = registry->readImageImplementation(absFileName, opt);
 321         if (!res.success()) {
 322           SG_LOG(SG_IO, SG_WARN, "Image loading failed:" << res.message());
 323           return res;
 324         }
 325
 326         if (res.loadedFromCache())
 327             SG_LOG(SG_IO, SG_INFO, "Returning cached image \""
 328                    << res.getImage()->getFileName() << "\"");
 329         else
 330             SG_LOG(SG_IO, SG_INFO, "Reading image \""
 331                    << res.getImage()->getFileName() << "\"");
 332
 333         return res;
 334     }
 335 }
 336
 337
 338 osg::Node* DefaultCachePolicy::find(const string& fileName,
 339                                     const ReaderWriter::Options* opt)
 340 {
 341     Registry* registry = Registry::instance();
 342     osg::Node* cached
 343         = dynamic_cast<Node*>(registry->getFromObjectCache(fileName));
 344     if (cached)
 345         SG_LOG(SG_IO, SG_INFO, "Got cached model \""
 346                << fileName << "\"");
 347     else
 348         SG_LOG(SG_IO, SG_INFO, "Reading model \""
 349                << fileName << "\"");
 350     return cached;
 351 }
 352
 353 void DefaultCachePolicy::addToCache(const string& fileName,
 354                                     osg::Node* node)
 355 {
 356     Registry::instance()->addEntryToObjectCache(fileName, node);
 357 }
 358
 359 // Optimizations we don't use:
 360 // Don't use this one. It will break animation names ...
 361 // opts |= osgUtil::Optimizer::REMOVE_REDUNDANT_NODES;
 362 //
 363 // opts |= osgUtil::Optimizer::REMOVE_LOADED_PROXY_NODES;
 364 // opts |= osgUtil::Optimizer::COMBINE_ADJACENT_LODS;
 365 // opts |= osgUtil::Optimizer::CHECK_GEOMETRY;
 366 // opts |= osgUtil::Optimizer::SPATIALIZE_GROUPS;
 367 // opts |= osgUtil::Optimizer::COPY_SHARED_NODES;
 368 // opts |= osgUtil::Optimizer::TESSELATE_GEOMETRY;
 369 // opts |= osgUtil::Optimizer::OPTIMIZE_TEXTURE_SETTINGS;
 370
 371 OptimizeModelPolicy::OptimizeModelPolicy(const string& extension) :
 372     _osgOptions(Optimizer::SHARE_DUPLICATE_STATE
 373                 | Optimizer::MERGE_GEOMETRY
 374                 | Optimizer::FLATTEN_STATIC_TRANSFORMS
 375                 | Optimizer::TRISTRIP_GEOMETRY)
 376 {
 377 }
 378
 379 osg::Node* OptimizeModelPolicy::optimize(osg::Node* node,
 380                                          const string& fileName,
 381                                          const osgDB::ReaderWriter::Options* opt)
 382 {
 383     osgUtil::Optimizer optimizer;
 384     optimizer.optimize(node, _osgOptions);
 385
 386     // Make sure the data variance of sharable objects is set to
 387     // STATIC so that textures will be globally shared.
 388     SGTexDataVarianceVisitor dataVarianceVisitor;
 389     node->accept(dataVarianceVisitor);
 390
 391     SGTexCompressionVisitor texComp;
 392     node->accept(texComp);
 393     return node;
 394 }
 395
 396 osg::Node* DefaultCopyPolicy::copy(osg::Node* model, const string& fileName,
 397                     const osgDB::ReaderWriter::Options* opt)
 398 {
 399     /// Crude hack for the bounding volume sharing problem.
 400     /// Better solution this week.
 401     /// Note that this does not really build in the case we come here
 402     /// the second time for the same node
 403     BoundingVolumeBuildVisitor bvBuilder;
 404     model->accept(bvBuilder);
 405
 406     // Add an extra reference to the model stored in the database.
 407     // That it to avoid expiring the object from the cache even if it is still
 408     // in use. Note that the object cache will think that a model is unused
 409     // if the reference count is 1. If we clone all structural nodes here
 410     // we need that extra reference to the original object
 411     SGDatabaseReference* databaseReference;
 412     databaseReference = new SGDatabaseReference(model);
 413     CopyOp::CopyFlags flags = CopyOp::DEEP_COPY_ALL;
 414     flags &= ~CopyOp::DEEP_COPY_TEXTURES;
 415     flags &= ~CopyOp::DEEP_COPY_IMAGES;
 416     flags &= ~CopyOp::DEEP_COPY_STATESETS;
 417     flags &= ~CopyOp::DEEP_COPY_STATEATTRIBUTES;
 418     flags &= ~CopyOp::DEEP_COPY_ARRAYS;
 419     flags &= ~CopyOp::DEEP_COPY_PRIMITIVES;
 420     // This will safe display lists ...
 421     flags &= ~CopyOp::DEEP_COPY_DRAWABLES;
 422     flags &= ~CopyOp::DEEP_COPY_SHAPES;
 423     osg::Node* res = CopyOp(flags)(model);
 424     res->addObserver(databaseReference);
 425
 426     // Update liveries
 427     TextureUpdateVisitor liveryUpdate(opt->getDatabasePathList());
 428     res->accept(liveryUpdate);
 429
 430     return res;
 431 }
 432
 433 string OSGSubstitutePolicy::substitute(const string& name,
 434                                        const ReaderWriter::Options* opt)
 435 {
 436     string fileSansExtension = getNameLessExtension(name);
 437     string osgFileName = fileSansExtension + ".osg";
 438     string absFileName = findDataFile(osgFileName, opt);
 439     return absFileName;
 440 }
 441
 442 ModelRegistry::ModelRegistry() :
 443     _defaultCallback(new DefaultCallback("")),
 444     _nestingLevel(0)
 445 {
 446 }
 447
 448 void
 449 ModelRegistry::addImageCallbackForExtension(const string& extension,
 450                                             Registry::ReadFileCallback* callback)
 451 {
 452     imageCallbackMap.insert(CallbackMap::value_type(extension, callback));
 453 }
 454
 455 void
 456 ModelRegistry::addNodeCallbackForExtension(const string& extension,
 457                                            Registry::ReadFileCallback* callback)
 458 {
 459     nodeCallbackMap.insert(CallbackMap::value_type(extension, callback));
 460 }
 461
 462 ReaderWriter::ReadResult
 463 ModelRegistry::readNode(const string& fileName,
 464                         const ReaderWriter::Options* opt)
 465 {
 466     ScopedLock<ReentrantMutex> lock(readerMutex);
 467     ++_nestingLevel;
 468
 469     // XXX Workaround for OSG plugin bug.
 470     Registry* registry = Registry::instance();
 471     ReaderWriter::ReadResult res;
 472     CallbackMap::iterator iter
 473         = nodeCallbackMap.find(getFileExtension(fileName));
 474     ReaderWriter::ReadResult result;
 475     if (iter != nodeCallbackMap.end() && iter->second.valid())
 476         result = iter->second->readNode(fileName, opt);
 477     else
 478         result = _defaultCallback->readNode(fileName, opt);
 479
 480     if (0 == --_nestingLevel) {
 481         SG_LOG(SG_IO, SG_INFO, "Building boundingvolume tree for \""
 482                << fileName << "\".");
 483         BoundingVolumeBuildVisitor bvBuilder;
 484         result.getNode()->accept(bvBuilder);
 485     } else {
 486         SG_LOG(SG_IO, SG_INFO, "Defering boundingvolume tree built for \""
 487                << fileName << "\" to parent.");
 488     }
 489     return result;
 490 }
 491
 492 class SGReadCallbackInstaller {
 493 public:
 494   SGReadCallbackInstaller()
 495   {
 496     // XXX I understand why we want this, but this seems like a weird
 497     // place to set this option.
 498     Referenced::setThreadSafeReferenceCounting(true);
 499
 500     Registry* registry = Registry::instance();
 501     ReaderWriter::Options* options = new ReaderWriter::Options;
 502     int cacheOptions = ReaderWriter::Options::CACHE_ALL;
 503     options->
 504       setObjectCacheHint((ReaderWriter::Options::CacheHintOptions)cacheOptions);
 505     registry->setOptions(options);
 506     registry->getOrCreateSharedStateManager()->
 507       setShareMode(SharedStateManager::SHARE_STATESETS);
 508     registry->setReadFileCallback(ModelRegistry::instance());
 509   }
 510 };
 511
 512 static SGReadCallbackInstaller readCallbackInstaller;
 513
 514 // we get optimal geometry from the loader.
 515 struct ACOptimizePolicy : public OptimizeModelPolicy {
 516     ACOptimizePolicy(const string& extension)  :
 517         OptimizeModelPolicy(extension)
 518     {
 519         _osgOptions &= ~Optimizer::TRISTRIP_GEOMETRY;
 520     }
 521     Node* optimize(Node* node, const string& fileName,
 522                    const ReaderWriter::Options* opt)
 523     {
 524         ref_ptr<Node> optimized
 525             = OptimizeModelPolicy::optimize(node, fileName, opt);
 526         Group* group = dynamic_cast<Group*>(optimized.get());
 527         MatrixTransform* transform
 528             = dynamic_cast<MatrixTransform*>(optimized.get());
 529         if (((transform && transform->getMatrix().isIdentity()) || group)
 530             && group->getName().empty()
 531             && group->getNumChildren() == 1) {
 532             optimized = static_cast<Node*>(group->getChild(0));
 533             group = dynamic_cast<Group*>(optimized.get());
 534             if (group && group->getName().empty()
 535                 && group->getNumChildren() == 1)
 536                 optimized = static_cast<Node*>(group->getChild(0));
 537         }
 538         return optimized.release();
 539     }
 540 };
 541
 542 struct ACProcessPolicy {
 543     ACProcessPolicy(const string& extension) {}
 544     Node* process(Node* node, const string& filename,
 545                   const ReaderWriter::Options* opt)
 546     {
 547         Matrix m(1, 0, 0, 0,
 548                  0, 0, 1, 0,
 549                  0, -1, 0, 0,
 550                  0, 0, 0, 1);
 551         // XXX Does there need to be a Group node here to trick the
 552         // optimizer into optimizing the static transform?
 553         osg::Group* root = new Group;
 554         MatrixTransform* transform = new MatrixTransform;
 555         root->addChild(transform);
 556
 557         transform->setDataVariance(Object::STATIC);
 558         transform->setMatrix(m);
 559         transform->addChild(node);
 560         // Ok, this step is questionable.
 561         // It is there to have the same visual appearance of ac objects for the
 562         // first cut. Osg's ac3d loader will correctly set materials from the
 563         // ac file. But the old plib loader used GL_AMBIENT_AND_DIFFUSE for the
 564         // materials that in effect igored the ambient part specified in the
 565         // file. We emulate that for the first cut here by changing all
 566         // ac models here. But in the long term we should use the
 567         // unchanged model and fix the input files instead ...
 568         SGAcMaterialCrippleVisitor matCriple;
 569         root->accept(matCriple);
 570         return root;
 571     }
 572 };
 573
 574 typedef ModelRegistryCallback<ACProcessPolicy, DefaultCachePolicy,
 575                               ACOptimizePolicy, DefaultCopyPolicy,
 576                               OSGSubstitutePolicy> ACCallback;
 577
 578 namespace
 579 {
 580 ModelRegistryCallbackProxy<ACCallback> g_acRegister("ac");
 581 }