OpenSceneGraph/examples/osgphotoalbum/ImageReaderWriter.h
Robert Osfield 6a67be2e32 Introduced CMake option OSG_PROVIDE_READFILE option that defaults to ON, but when switched to OFF disables the building of the osgDB::read*File() methods,
forcing users to use osgDB::readRef*File() methods.  The later is preferable as it closes a potential threading bug when using paging databases in conjunction
with the osgDB::Registry Object Cache.  This threading bug occurs when one thread gets an object from the Cache via an osgDB::read*File() call where only
a pointer to the object is passed back, so taking a reference to the object is delayed till it gets reassigned to a ref_ptr<>, but at the same time another
thread calls a flush of the Object Cache deleting this object as it's referenceCount is now zero.  Using osgDB::readREf*File() makes sure the a ref_ptr<> is
passed back and the referenceCount never goes to zero.

To ensure the OSG builds when OSG_PROVIDE_READFILE is to OFF the many cases of osgDB::read*File() usage had to be replaced with a ref_ptr<> osgDB::readRef*File()
usage.  The avoid this change causing lots of other client code to be rewritten to handle the use of ref_ptr<> in place of C pointer I introduced a serious of
templte methods in various class to adapt ref_ptr<> to the underly C pointer to be passed to old OSG API's, example of this is found in include/osg/Group:

    bool addChild(Node* child); // old method which can only be used with a Node*

    tempalte<class T> bool addChild(const osg::ref_ptr<T>& child) { return addChild(child.get()); } // adapter template method

These changes together cover 149 modified files, so it's a large submission. This extent of changes are warrent to make use of the Object Cache
and multi-threaded loaded more robust.



git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/branches/OpenSceneGraph-3.4@15165 16af8721-9629-0410-8352-f15c8da7e697
2015-10-22 14:14:53 +00:00

97 lines
3.4 KiB
C++

/* -*-c++-*-
*
* OpenSceneGraph example, osgphotoalbum.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#ifndef IMAGEREADERWRITER_H
#define IMAGEREADERWRITER_H
#include <osgDB/ReadFile>
#include <osgDB/WriteFile>
#include <osgDB/ImageOptions>
#include <OpenThreads/ScopedLock>
#include <OpenThreads/ReentrantMutex>
#include "PhotoArchive.h"
#define SERIALIZER() OpenThreads::ScopedLock<OpenThreads::ReentrantMutex> lock(_serializerMutex)
class ImageReaderWriter : public osgDB::ReaderWriter
{
public:
ImageReaderWriter();
virtual const char* className() const { return "ImageReader"; }
void addPhotoArchive(PhotoArchive* archive) { _photoArchiveList.push_back(archive); }
std::string insertReference(const std::string& fileName, unsigned int res, float width, float height, bool backPage)
{
SERIALIZER();
return const_cast<ImageReaderWriter*>(this)->local_insertReference(fileName, res, width, height, backPage);
}
virtual ReadResult readNode(const std::string& fileName, const Options* options) const
{
SERIALIZER();
return const_cast<ImageReaderWriter*>(this)->local_readNode(fileName, options);
}
protected:
std::string local_insertReference(const std::string& fileName, unsigned int res, float width, float height, bool backPage);
ReadResult local_readNode(const std::string& fileName, const Options*);
mutable OpenThreads::ReentrantMutex _serializerMutex;
struct DataReference
{
DataReference();
DataReference(const std::string& fileName, unsigned int res, float width, float height,bool backPage);
DataReference(const DataReference& rhs);
std::string _fileName;
unsigned int _resolutionX;
unsigned int _resolutionY;
osg::Vec3 _center;
osg::Vec3 _maximumWidth;
osg::Vec3 _maximumHeight;
unsigned int _numPointsAcross;
unsigned int _numPointsUp;
bool _backPage;
};
osg::ref_ptr<osg::Image> readImage_Archive(DataReference& dr, float& s,float& t);
osg::ref_ptr<osg::Image> readImage_DynamicSampling(DataReference& dr, float& s,float& t);
typedef std::map< std::string,DataReference > DataReferenceMap;
typedef std::vector< osg::ref_ptr<PhotoArchive> > PhotoArchiveList;
DataReferenceMap _dataReferences;
PhotoArchiveList _photoArchiveList;
};
#endif