cxGPUImageBuffer.cpp

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/


#include "cxGPUImageBuffer.h"

#include <QString>

#include <vector>
#include <vtkImageData.h>
#include <vtkPointData.h>
#include <vtkUnsignedCharArray.h>
#include <vtkUnsignedShortArray.h>
#include <boost/cstdint.hpp>
#include "cxGLHelpers.h"
#include "cxLogger.h"


#ifndef WIN32
#define GL_GLEXT_PROTOTYPES //Needed to compile on Linux?
//#include <vtkgl.h>

#ifdef __APPLE__
#include <OpenGL/glu.h>
#else
#include <GL/glu.h>
#endif

#ifdef WIN32
#include <windows.h>
#include <GL/glext.h>
#endif


namespace cx
{

class GPUImageDataBufferImpl : public GPUImageDataBuffer
{
public:
        GLuint textureId;
        vtkImageDataPtr mTexture;
        bool mAllocated;
        uint64_t mMTime;
        int mMemorySize;

        GPUImageDataBufferImpl()
        {
                mAllocated = false;
                mMTime = 0;
                textureId = 0;
                mMemorySize = 0;
        }
        virtual ~GPUImageDataBufferImpl()
        {
                release();
        }

        virtual int getMemorySize()
        {
                return mMemorySize;
        }

        virtual void SetImage (vtkImageDataPtr texture)
        {
                if (!texture)
                {
                        std::cout << "error: bad buffer initialization: null image" << std::endl;
                }
                mTexture = texture;
        }
        virtual unsigned int getTextureUid() const
        {
                return textureId;
        }

        virtual void allocate(int textureUnitIndex)
        {
                if (mAllocated) // do this only once.
                {
                        return;
                }
                if (!mTexture)
                {
                        std::cout << "error: bad volume buffer initialization" << std::endl;
                        return;
                }

//              glActiveTexture(GL_TEXTURE7);
//              glActiveTexture(GL_TEXTURE0);
                glActiveTexture(getGLTextureForVolume(textureUnitIndex));
                report_gl_error();

//              glEnable(GL_TEXTURE_3D);
                report_gl_error();
                glGenTextures(1, &textureId);
                report_gl_error();
//              glDisable(GL_TEXTURE_3D);

                report_gl_error();
                CX_LOG_DEBUG() << "textureId: " << textureId;

                updateTexture();
                mAllocated = true;
        }
        virtual void updateTexture()
        {
                if (mMTime == mTexture->GetMTime())
                {
                        return;
                }
                mMTime = mTexture->GetMTime();
                //vtkgl::ActiveTexture(getGLTextureForVolume(textureUnitIndex)); //TODO is this OK?
                GLenum size,internalType;
                boost::uint32_t dimx = mTexture ->GetDimensions( )[0];
                boost::uint32_t dimy = mTexture ->GetDimensions( )[1];
                boost::uint32_t dimz = mTexture ->GetDimensions( )[2];
                mMemorySize = dimx * dimy * dimz;


                //Example: https://open.gl/textures

//              glEnable( GL_TEXTURE_3D );
                glBindTexture(GL_TEXTURE_3D, textureId);
                glTexParameteri( GL_TEXTURE_3D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_BORDER );//GL_CLAMP is no longer allowed. Try with GL_CLAMP_TO_BORDER
                glTexParameteri( GL_TEXTURE_3D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_BORDER );
                glTexParameteri( GL_TEXTURE_3D, GL_TEXTURE_WRAP_R, GL_CLAMP_TO_BORDER );
                glTexParameteri( GL_TEXTURE_3D, GL_TEXTURE_MAG_FILTER, GL_LINEAR );
                glTexParameteri( GL_TEXTURE_3D, GL_TEXTURE_MIN_FILTER, GL_LINEAR );
//              glGenerateMipmap(GL_TEXTURE_3D);
                switch (mTexture->GetScalarType())
                {
                case VTK_UNSIGNED_CHAR:
                {
                        size = GL_UNSIGNED_BYTE;
                        internalType = GL_RED;// GL_LUMINANCE is no longer used
                }
                        break; //8UI_EXT; break;
                case VTK_UNSIGNED_SHORT:
                {
                        size = GL_UNSIGNED_SHORT;
                        internalType = GL_RED; //GL_LUMINANCE16 is deprecated
                        mMemorySize *= 2;
                }
                        break; //16UI_EXT; break;
                default:
                        size = 0;
                        internalType = 0;
                        std::cout << "Bit size not supported!" << std::endl;
                        QString dataType(mTexture->GetScalarTypeAsString());
                        CX_LOG_ERROR() << QString("Attempt to update 3D GL texture from type %1 failed. Only unsigned types supported").arg(dataType);
                        break;
                }

                report_gl_error();
                if (mTexture->GetNumberOfScalarComponents()==1)
                {
                        void* data = mTexture->GetPointData()->GetScalars()->GetVoidPointer(0);
                        glTexImage3D(GL_TEXTURE_3D, 0, internalType, dimx, dimy, dimz, 0, GL_RED, size, data);
                }
                else if (mTexture->GetNumberOfScalarComponents()==3)
                {
                        internalType = GL_RGB;
                        void* data = mTexture->GetPointData()->GetScalars()->GetVoidPointer(0);
                        glTexImage3D(GL_TEXTURE_3D, 0, internalType, dimx, dimy, dimz, 0, GL_RGB, size, data);
                        mMemorySize *= 3;
                }
                else
                {
                        std::cout << "unsupported number of image components" << std::endl;
                }

//              glDisable(GL_TEXTURE_3D);

                report_gl_error();
        }

        virtual void bind(int textureUnitIndex)
        {
                glActiveTexture(getGLTextureForVolume(textureUnitIndex));
                this->updateTexture();
                if (!mAllocated)
                {
                        std::cout << "error: called bind() on unallocated volume buffer" << std::endl;
                        return;
                }
                glBindTexture(GL_TEXTURE_3D, textureId);
                report_gl_error();
        }

        virtual void release()
        {
                glDeleteTextures(1, &textureId);
        }

        int getGLTextureForVolume(int textureUnitIndex)
        {
                switch (textureUnitIndex)
                {
                case 0: return GL_TEXTURE0;
                case 1: return GL_TEXTURE2;
                case 2: return GL_TEXTURE4;
                case 3: return GL_TEXTURE6;
                case 4: return GL_TEXTURE8;
                default: return -1;
                }
        }
};


class GPUImageLutBufferImpl : public GPUImageLutBuffer
{
public:
        GLuint lutBuffer;
        GLuint textureId;
        bool mAllocated;
        vtkUnsignedCharArrayPtr mTable;
        uint64_t mMTime;

        GPUImageLutBufferImpl()
        {
                mAllocated = false;
                textureId = 0;
                mMTime = 0;
//              mDebugEnableCrossplatform=false;
        }
        virtual ~GPUImageLutBufferImpl()
        {
                release();
        }

        virtual int getMemorySize()
        {
                if (!mTable)
                        return 0;
                return mTable->GetNumberOfTuples() * mTable->GetNumberOfComponents() * sizeof(float);
        }


        //intput lookuptable is raw imported table
        virtual void SetColorMap(vtkUnsignedCharArrayPtr table)
        {
                mTable = table;
        }

        virtual void allocate()
        {
                if (!mTable)
                {
                        std::cout << "error: bad lut buffer initialization" << std::endl;
                        return;
                }

                if (!mAllocated)
                {
                        glActiveTexture(GL_TEXTURE6);
                        glGenTextures(1, &textureId);
                        mAllocated = true;
                }
                this->updateTexture();
        }

        virtual void updateTexture()
        {
                if (mMTime == mTable->GetMTime())
                {
                        return;
                }
                mMTime = mTable->GetMTime();

                glActiveTexture(GL_TEXTURE6);
                this->sendDataToGL();
                report_gl_error();
        }

        void sendDataToGL()
        {
                std::vector<float> lut;
                int lutSize = mTable->GetNumberOfTuples();
                int lutDataSize = lutSize * mTable->GetNumberOfComponents();
                lut.resize(lutDataSize);
                unsigned char* ptr = mTable->GetPointer(0);

                for (int i = 0; i < lut.size(); ++i)
                {
                        lut[i] = ((float) *ptr) / 255.0;
                        ++ptr;
                }

                glBindTexture(GL_TEXTURE_1D, textureId);
                glTexParameteri(GL_TEXTURE_1D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
                glTexParameteri( GL_TEXTURE_1D, GL_TEXTURE_MAG_FILTER, GL_LINEAR );
                glTexParameteri( GL_TEXTURE_1D, GL_TEXTURE_MIN_FILTER, GL_LINEAR );
                report_gl_error();

                glTexImage1D(GL_TEXTURE_1D, 0, GL_RGBA,
                                         lutSize, 0,
                                         GL_RGBA, GL_FLOAT, &(*lut.begin()));
                report_gl_error();
        }

        virtual void bind(int textureUnitIndex)
        {
                this->updateTexture();
                if (!mAllocated)
                {
                        std::cout << "error: called bind() on unallocated lut buffer" << std::endl;
                        return;
                }
                glActiveTexture(getGLTextureForLut(textureUnitIndex));
                this->bindDataToGL();
                report_gl_error();
        }

        void bindDataToGL()
        {
                glBindTexture(GL_TEXTURE_1D, textureId);
        }

        int getLutSize() const
        {
                return mTable->GetNumberOfTuples();
        }

        virtual void release()
        {
                if (!mAllocated)
                        return;

                glDeleteTextures(1, &textureId);
        }

        int getGLTextureForLut(int textureUnitIndex)
        {
                switch (textureUnitIndex)
                {
                case 0: return GL_TEXTURE1;
                case 1: return GL_TEXTURE3;
                case 2: return GL_TEXTURE5;
                case 3: return GL_TEXTURE7;
                case 4: return GL_TEXTURE9;
                default: return -1;
                }
        }
};

GPUImageDataBufferPtr createGPUImageDataBuffer(vtkImageDataPtr volume)
{
        std::auto_ptr<GPUImageDataBufferImpl> retval(new GPUImageDataBufferImpl);
        retval->SetImage(volume);
        return GPUImageDataBufferPtr(retval.release());
}

GPUImageLutBufferPtr createGPUImageLutBuffer(vtkUnsignedCharArrayPtr lut)
{
        std::auto_ptr<GPUImageLutBufferImpl> retval(new GPUImageLutBufferImpl);
        retval->SetColorMap(lut);
        return GPUImageLutBufferPtr(retval.release());
}

template<class BUFFER, class DATA_PTR>
boost::shared_ptr<BUFFER> createGPUImageBuffer(DATA_PTR val);

template<>
boost::shared_ptr<GPUImageDataBuffer> createGPUImageBuffer<GPUImageDataBuffer>(vtkImageDataPtr val);
template<>
boost::shared_ptr<GPUImageLutBuffer> createGPUImageBuffer<GPUImageLutBuffer>(vtkUnsignedCharArrayPtr val);

template<>
boost::shared_ptr<GPUImageDataBuffer> createGPUImageBuffer<GPUImageDataBuffer,vtkImageDataPtr>(vtkImageDataPtr val)
{
        return createGPUImageDataBuffer(val);
}
template<>
boost::shared_ptr<GPUImageLutBuffer> createGPUImageBuffer<GPUImageLutBuffer>(vtkUnsignedCharArrayPtr val)
{
        return createGPUImageLutBuffer(val);
}


//---------------------------------------------------------
GPUImageBufferRepository* GPUImageBufferRepository::mInstance = NULL;
//---------------------------------------------------------

template<class DATA_PTR, class BUFFER>
class BufferQueue
{
public:
        typedef boost::shared_ptr<BUFFER> BufferPtr;
        typedef boost::weak_ptr<BUFFER> BufferWeakPtr;

        struct BufferStore
        {
                BufferStore(DATA_PTR data, BufferPtr buffer) : mData(data), mBuffer(buffer) {}
                DATA_PTR mData;
                BufferPtr mBuffer;
        };
public:

        BufferQueue() : mMaxBuffers(7)
        {

        }
        void setMaxBuffers(unsigned val)
        {
                mMaxBuffers = val;
        }
        void setName(const QString& name)
        {
                mName = name;
        }

        BufferPtr get(DATA_PTR data)
        {
                // clear out deleted data
                for (typename BufferMap::iterator iter=mRemovedData.begin(); iter!=mRemovedData.end(); )
                {
                        if (!iter->second.lock())
                        {
                                typename BufferMap::iterator temp = iter;
                                ++iter;
                                mRemovedData.erase(temp);
                        }
                        else
                        {
                                ++iter;
                        }
                }

                // reclaim weak pointer to buffer if it exists.
                if (mRemovedData.count(data))
                {
                        BufferPtr object = mRemovedData[data].lock();
                        if (object)
                        {
                                mData.push_front(BufferStore(data, object));
                                mRemovedData.erase(data);
                        }
                }

                // move current data to front of buffer (i.e. increase importance)
                BufferPtr retval;
                for (typename std::list<BufferStore>::iterator iter=mData.begin(); iter!=mData.end(); ++iter)
                {
                        if (iter->mData==data)
                        {
                                retval = iter->mBuffer; // retrieve data
                                mData.push_front(*iter); // push on queue front (most recent)
                                mData.erase(iter); // erase from old position
                                break;
                        }
                }

                // create buffer if nonexistent
                if (!retval)
                {
                        retval = createGPUImageBuffer<BUFFER>(data);
                        mData.push_front(BufferStore(data, retval));
                }

                // reduce repository size if too large.
                while (mData.size()>mMaxBuffers)
                {
                        mRemovedData[mData.back().mData] = mData.back().mBuffer;
                        mData.pop_back();;
                }

                return retval;
        }
        int getMemoryUsage(int *textures)
        {
                int mem = 0;
                if (textures)
                {
                        *textures = mData.size();
                }
                for (typename std::list<BufferStore>::iterator iter=mData.begin(); iter!=mData.end(); ++iter)
                {
                        mem += iter->mBuffer->getMemorySize();
                }
                return mem;
        }
private:
        typedef std::map<DATA_PTR, BufferWeakPtr> BufferMap;
        BufferMap mRemovedData; // those buffers that are removed but still might live outside of the repo.
        std::list<BufferStore> mData; // newest elems in front
        unsigned mMaxBuffers;
        QString mName; // debug
};

class GPUImageBufferRepositoryInternal
{
public:
        GPUImageBufferRepositoryInternal()
        {
                mVolumeBuffer.setName("Volume");
                mLutBuffer.setName("Lut");

                mVolumeBuffer.setMaxBuffers(12);
                mLutBuffer.setMaxBuffers(15);
        }
        BufferQueue<vtkImageDataPtr, GPUImageDataBuffer> mVolumeBuffer;
        BufferQueue<vtkUnsignedCharArrayPtr, GPUImageLutBuffer> mLutBuffer;
};

GPUImageBufferRepository::GPUImageBufferRepository()
{
        mInternal = new GPUImageBufferRepositoryInternal();
}

GPUImageBufferRepository::~GPUImageBufferRepository()
{
        tearDown();
}

void GPUImageBufferRepository::clear()
{
        tearDown();
        mInternal = new GPUImageBufferRepositoryInternal();
}

GPUImageBufferRepository* GPUImageBufferRepository::getInstance()
{
        if (!mInstance)
        {
                mInstance = new GPUImageBufferRepository();
        }
        return mInstance;
}

void GPUImageBufferRepository::shutdown()
{
        if(mInstance)
        {
                delete mInstance;
        }
        mInstance = NULL;

}

void GPUImageBufferRepository::tearDown()
{
        delete mInternal;
        mInternal = NULL;
}

int GPUImageBufferRepository::getMemoryUsage(int *textures)
{
        return mInternal->mVolumeBuffer.getMemoryUsage(textures);
}

GPUImageDataBufferPtr GPUImageBufferRepository::getGPUImageDataBuffer(vtkImageDataPtr volume)
{
        return mInternal->mVolumeBuffer.get(volume);
}

GPUImageLutBufferPtr GPUImageBufferRepository::getGPUImageLutBuffer(vtkUnsignedCharArrayPtr lut)
{
        return mInternal->mLutBuffer.get(lut);
}

GPUImageBufferRepository* getGPUImageBufferRepository()
{
        return GPUImageBufferRepository::getInstance();
}
}//cx

#else

namespace cx
{
void GPUImageBufferRepository::shutdown() {;}
void GPUImageBufferRepository::tearDown() {;}
}//namespace cx

#endif //WIN32