1 // ModelRegistry.hxx -- interface to the OSG model registry
3 // Copyright (C) 2005-2007 Mathias Froehlich
4 // Copyright (C) 2007 Tim Moore <timoore@redhat.com>
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.
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.
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.
21 # include <simgear_config.h>
24 #include "ModelRegistry.hxx"
30 #include <OpenThreads/ScopedLock>
32 #include <osg/observer_ptr>
33 #include <osg/ref_ptr>
35 #include <osg/NodeCallback>
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>
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>
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>
58 #include "BoundingVolumeBuildVisitor.hxx"
62 using namespace osgUtil;
63 using namespace osgDB;
64 using namespace simgear;
66 using OpenThreads::ReentrantMutex;
67 using OpenThreads::ScopedLock;
69 // Little helper class that holds an extra reference to a
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.
79 class SGDatabaseReference : public Observer {
81 SGDatabaseReference(Referenced* referenced) :
82 mReferenced(referenced)
84 virtual void objectDeleted(void*)
89 ref_ptr<Referenced> mReferenced;
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 {
97 TextureNameVisitor(NodeVisitor::TraversalMode tm = NodeVisitor::TRAVERSE_ALL_CHILDREN) :
98 NodeAndDrawableVisitor(tm)
102 virtual void apply(Node& node)
104 nameTextures(node.getStateSet());
108 virtual void apply(Drawable& drawable)
110 nameTextures(drawable.getStateSet());
113 void nameTextures(StateSet* stateSet)
117 int numUnits = stateSet->getTextureAttributeList().size();
118 for (int i = 0; i < numUnits; ++i) {
120 = stateSet->getTextureAttribute(i, StateAttribute::TEXTURE);
121 Texture2D* texture = dynamic_cast<Texture2D*>(attr);
122 if (!texture || !texture->getName().empty())
124 const Image *image = texture->getImage();
127 texture->setName(image->getFileName());
132 // Change the StateSets of a model to hold different textures based on
135 class TextureUpdateVisitor : public NodeAndDrawableVisitor {
137 TextureUpdateVisitor(const FilePathList& pathList) :
138 NodeAndDrawableVisitor(NodeVisitor::TRAVERSE_ALL_CHILDREN),
143 virtual void apply(Node& node)
145 StateSet* stateSet = cloneStateSet(node.getStateSet());
147 node.setStateSet(stateSet);
151 virtual void apply(Drawable& drawable)
153 StateSet* stateSet = cloneStateSet(drawable.getStateSet());
155 drawable.setStateSet(stateSet);
157 // Copied from Mathias' earlier SGTextureUpdateVisitor
159 Texture2D* textureReplace(int unit, const StateAttribute* attr)
161 const Texture2D* texture = dynamic_cast<const Texture2D*>(attr);
166 const Image* image = texture->getImage();
167 const string* fullFilePath = 0;
169 // The currently loaded file name
170 fullFilePath = &image->getFileName();
173 fullFilePath = &texture->getName();
176 string fileName = getSimpleFileName(*fullFilePath);
177 if (fileName.empty())
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)
184 Image* newImage = readImageFile(fullLiveryFile);
187 CopyOp copyOp(CopyOp::DEEP_COPY_ALL & ~CopyOp::DEEP_COPY_IMAGES);
188 Texture2D* newTexture = static_cast<Texture2D*>(copyOp(texture));
192 newTexture->setImage(newImage);
197 StateSet* cloneStateSet(const StateSet* stateSet)
199 typedef pair<int, Texture2D*> Tex2D;
200 vector<Tex2D> newTextures;
201 StateSet* result = 0;
205 int numUnits = stateSet->getTextureAttributeList().size();
207 for (int i = 0; i < numUnits; ++i) {
208 const StateAttribute* attr
209 = stateSet->getTextureAttribute(i, StateAttribute::TEXTURE);
210 Texture2D* newTexture = textureReplace(i, attr);
212 newTextures.push_back(Tex2D(i, newTexture));
214 if (!newTextures.empty()) {
215 result = static_cast<StateSet*>(stateSet->clone(CopyOp()));
216 for (vector<Tex2D>::iterator i = newTextures.begin();
217 i != newTextures.end();
219 result->setTextureAttribute(i->first, i->second);
226 FilePathList _pathList;
230 class SGTexCompressionVisitor : public SGTextureStateAttributeVisitor {
232 virtual void apply(int, StateSet::RefAttributePair& refAttr)
235 texture = dynamic_cast<Texture2D*>(refAttr.first.get());
240 texture->setDataVariance(osg::Object::STATIC);
242 Image* image = texture->getImage(0);
249 if (s <= t && 32 <= s) {
250 SGSceneFeatures::instance()->setTextureCompression(texture);
251 } else if (t < s && 32 <= t) {
252 SGSceneFeatures::instance()->setTextureCompression(texture);
257 class SGTexDataVarianceVisitor : public SGTextureStateAttributeVisitor {
259 virtual void apply(int, StateSet::RefAttributePair& refAttr)
262 texture = dynamic_cast<Texture*>(refAttr.first.get());
266 texture->setDataVariance(Object::STATIC);
269 virtual void apply(StateSet* stateSet)
273 SGTextureStateAttributeVisitor::apply(stateSet);
274 stateSet->setDataVariance(Object::STATIC);
278 class SGAcMaterialCrippleVisitor : public SGStateAttributeVisitor {
280 virtual void apply(StateSet::RefAttributePair& refAttr)
283 material = dynamic_cast<Material*>(refAttr.first.get());
286 material->setColorMode(Material::AMBIENT_AND_DIFFUSE);
292 Node* DefaultProcessPolicy::process(Node* node, const string& filename,
293 const ReaderWriter::Options* opt)
295 TextureNameVisitor nameVisitor;
296 node->accept(nameVisitor);
300 ReaderWriter::ReadResult
301 ModelRegistry::readImage(const string& fileName,
302 const ReaderWriter::Options* opt)
304 ScopedLock<ReentrantMutex> lock(readerMutex);
305 CallbackMap::iterator iter
306 = imageCallbackMap.find(getFileExtension(fileName));
307 // XXX Workaround for OSG plugin bug
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;
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());
326 if (res.loadedFromCache())
327 SG_LOG(SG_IO, SG_INFO, "Returning cached image \""
328 << res.getImage()->getFileName() << "\"");
330 SG_LOG(SG_IO, SG_INFO, "Reading image \""
331 << res.getImage()->getFileName() << "\"");
338 osg::Node* DefaultCachePolicy::find(const string& fileName,
339 const ReaderWriter::Options* opt)
341 Registry* registry = Registry::instance();
343 = dynamic_cast<Node*>(registry->getFromObjectCache(fileName));
345 SG_LOG(SG_IO, SG_INFO, "Got cached model \""
346 << fileName << "\"");
348 SG_LOG(SG_IO, SG_INFO, "Reading model \""
349 << fileName << "\"");
353 void DefaultCachePolicy::addToCache(const string& fileName,
356 Registry::instance()->addEntryToObjectCache(fileName, node);
359 // Optimizations we don't use:
360 // Don't use this one. It will break animation names ...
361 // opts |= osgUtil::Optimizer::REMOVE_REDUNDANT_NODES;
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;
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)
379 osg::Node* OptimizeModelPolicy::optimize(osg::Node* node,
380 const string& fileName,
381 const osgDB::ReaderWriter::Options* opt)
383 osgUtil::Optimizer optimizer;
384 optimizer.optimize(node, _osgOptions);
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);
391 SGTexCompressionVisitor texComp;
392 node->accept(texComp);
396 osg::Node* DefaultCopyPolicy::copy(osg::Node* model, const string& fileName,
397 const osgDB::ReaderWriter::Options* opt)
399 // Add an extra reference to the model stored in the database.
400 // That it to avoid expiring the object from the cache even if it is still
401 // in use. Note that the object cache will think that a model is unused
402 // if the reference count is 1. If we clone all structural nodes here
403 // we need that extra reference to the original object
404 SGDatabaseReference* databaseReference;
405 databaseReference = new SGDatabaseReference(model);
406 CopyOp::CopyFlags flags = CopyOp::DEEP_COPY_ALL;
407 flags &= ~CopyOp::DEEP_COPY_TEXTURES;
408 flags &= ~CopyOp::DEEP_COPY_IMAGES;
409 flags &= ~CopyOp::DEEP_COPY_STATESETS;
410 flags &= ~CopyOp::DEEP_COPY_STATEATTRIBUTES;
411 flags &= ~CopyOp::DEEP_COPY_ARRAYS;
412 flags &= ~CopyOp::DEEP_COPY_PRIMITIVES;
413 // This will safe display lists ...
414 flags &= ~CopyOp::DEEP_COPY_DRAWABLES;
415 flags &= ~CopyOp::DEEP_COPY_SHAPES;
416 osg::Node* res = CopyOp(flags)(model);
417 res->addObserver(databaseReference);
420 TextureUpdateVisitor liveryUpdate(opt->getDatabasePathList());
421 res->accept(liveryUpdate);
426 string OSGSubstitutePolicy::substitute(const string& name,
427 const ReaderWriter::Options* opt)
429 string fileSansExtension = getNameLessExtension(name);
430 string osgFileName = fileSansExtension + ".osg";
431 string absFileName = findDataFile(osgFileName, opt);
435 ModelRegistry::ModelRegistry() :
436 _defaultCallback(new DefaultCallback("")),
442 ModelRegistry::addImageCallbackForExtension(const string& extension,
443 Registry::ReadFileCallback* callback)
445 imageCallbackMap.insert(CallbackMap::value_type(extension, callback));
449 ModelRegistry::addNodeCallbackForExtension(const string& extension,
450 Registry::ReadFileCallback* callback)
452 nodeCallbackMap.insert(CallbackMap::value_type(extension, callback));
455 ReaderWriter::ReadResult
456 ModelRegistry::readNode(const string& fileName,
457 const ReaderWriter::Options* opt)
459 ScopedLock<ReentrantMutex> lock(readerMutex);
462 // XXX Workaround for OSG plugin bug.
463 Registry* registry = Registry::instance();
464 ReaderWriter::ReadResult res;
465 CallbackMap::iterator iter
466 = nodeCallbackMap.find(getFileExtension(fileName));
467 ReaderWriter::ReadResult result;
468 if (iter != nodeCallbackMap.end() && iter->second.valid())
469 result = iter->second->readNode(fileName, opt);
471 result = _defaultCallback->readNode(fileName, opt);
473 if (0 == --_nestingLevel) {
474 SG_LOG(SG_IO, SG_INFO, "Building boundingvolume tree for \""
475 << fileName << "\".");
476 BoundingVolumeBuildVisitor bvBuilder;
477 result.getNode()->accept(bvBuilder);
479 SG_LOG(SG_IO, SG_INFO, "Defering boundingvolume tree built for \""
480 << fileName << "\" to parent.");
485 class SGReadCallbackInstaller {
487 SGReadCallbackInstaller()
489 // XXX I understand why we want this, but this seems like a weird
490 // place to set this option.
491 Referenced::setThreadSafeReferenceCounting(true);
493 Registry* registry = Registry::instance();
494 ReaderWriter::Options* options = new ReaderWriter::Options;
495 int cacheOptions = ReaderWriter::Options::CACHE_ALL;
497 setObjectCacheHint((ReaderWriter::Options::CacheHintOptions)cacheOptions);
498 registry->setOptions(options);
499 registry->getOrCreateSharedStateManager()->
500 setShareMode(SharedStateManager::SHARE_STATESETS);
501 registry->setReadFileCallback(ModelRegistry::instance());
505 static SGReadCallbackInstaller readCallbackInstaller;
507 // we get optimal geometry from the loader.
508 struct ACOptimizePolicy : public OptimizeModelPolicy {
509 ACOptimizePolicy(const string& extension) :
510 OptimizeModelPolicy(extension)
512 _osgOptions &= ~Optimizer::TRISTRIP_GEOMETRY;
514 Node* optimize(Node* node, const string& fileName,
515 const ReaderWriter::Options* opt)
517 ref_ptr<Node> optimized
518 = OptimizeModelPolicy::optimize(node, fileName, opt);
519 Group* group = dynamic_cast<Group*>(optimized.get());
520 MatrixTransform* transform
521 = dynamic_cast<MatrixTransform*>(optimized.get());
522 if (((transform && transform->getMatrix().isIdentity()) || group)
523 && group->getName().empty()
524 && group->getNumChildren() == 1) {
525 optimized = static_cast<Node*>(group->getChild(0));
526 group = dynamic_cast<Group*>(optimized.get());
527 if (group && group->getName().empty()
528 && group->getNumChildren() == 1)
529 optimized = static_cast<Node*>(group->getChild(0));
531 return optimized.release();
535 struct ACProcessPolicy {
536 ACProcessPolicy(const string& extension) {}
537 Node* process(Node* node, const string& filename,
538 const ReaderWriter::Options* opt)
544 // XXX Does there need to be a Group node here to trick the
545 // optimizer into optimizing the static transform?
546 osg::Group* root = new Group;
547 MatrixTransform* transform = new MatrixTransform;
548 root->addChild(transform);
550 transform->setDataVariance(Object::STATIC);
551 transform->setMatrix(m);
552 transform->addChild(node);
553 // Ok, this step is questionable.
554 // It is there to have the same visual appearance of ac objects for the
555 // first cut. Osg's ac3d loader will correctly set materials from the
556 // ac file. But the old plib loader used GL_AMBIENT_AND_DIFFUSE for the
557 // materials that in effect igored the ambient part specified in the
558 // file. We emulate that for the first cut here by changing all
559 // ac models here. But in the long term we should use the
560 // unchanged model and fix the input files instead ...
561 SGAcMaterialCrippleVisitor matCriple;
562 root->accept(matCriple);
567 typedef ModelRegistryCallback<ACProcessPolicy, DefaultCachePolicy,
568 ACOptimizePolicy, DefaultCopyPolicy,
569 OSGSubstitutePolicy> ACCallback;
573 ModelRegistryCallbackProxy<ACCallback> g_acRegister("ac");