cxTextureSlicePainter.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.
=========================================================================*/


/*
 * vmTextureSlicePainter.cpp
 *
 *  Created on: Oct 13, 2009
 *      Author: petterw
 */

#include "cxTextureSlicePainter.h"

#ifndef WIN32
#include <QtCore>
#include <vtkOpenGLExtensionManager.h>
#include <vtkRenderer.h>
#include <vtkShaderProgram2.h>
#include <vtkShader2.h>
#include <vtkShader2Collection.h>
#include <vtkUniformVariables.h>
#include <vtkObjectFactory.h>
#include <vtkOpenGLRenderWindow.h>


#ifdef __APPLE__
#include <OpenGL/glu.h>
#include "X11/Xlib.h"
//#include "/usr/include/X11/Xlib.h"
#else
#include <GL/glu.h>
#endif

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

#include "cxGPUImageBuffer.h"
#include "cxTypeConversions.h"
#include "cxGLHelpers.h"

//---------------------------------------------------------
namespace cx
{
//---------------------------------------------------------

vtkStandardNewMacro(TextureSlicePainter);
vtkCxxRevisionMacro(TextureSlicePainter, "$Revision: 647 $");

SingleVolumePainterHelper::SingleVolumePainterHelper(int index) :
                mWindow(0.0),
                mLevel(0.0),
                mLLR(0.0),
                mAlpha(1.0)
{
        mIndex = index;
}

SingleVolumePainterHelper::SingleVolumePainterHelper() :
        mWindow(0.0),
        mLevel(0.0),
        mLLR(0.0),
        mAlpha(1.0)
{
        mIndex = -1;
}

SingleVolumePainterHelper::~SingleVolumePainterHelper()
{

}

void SingleVolumePainterHelper::SetBuffer(GPUImageDataBufferPtr buffer)
{
        mVolumeBuffer = buffer;
}

void SingleVolumePainterHelper::SetBuffer(GPUImageLutBufferPtr buffer)
{
        mLutBuffer = buffer;
}

void SingleVolumePainterHelper::SetColorAttribute(float window, float level, float llr,float alpha)
{
        mWindow = window;
        mLevel = level;
        mLLR = llr;
        mAlpha = alpha;
}

void SingleVolumePainterHelper::initializeRendering()
{
        if (mVolumeBuffer)
                mVolumeBuffer->allocate();
        if (mLutBuffer)
                mLutBuffer->allocate();
}

void SingleVolumePainterHelper::setUniformiArray(vtkUniformVariables* uniforms, QString name, int val)
{
        QString fullName = QString("%1[%2]").arg(name).arg(mIndex);
        uniforms->SetUniformi(cstring_cast(fullName), 1, &val);
}

void SingleVolumePainterHelper::setUniformfArray(vtkUniformVariables* uniforms, QString name, float val)
{
        QString fullName = QString("%1[%2]").arg(name).arg(mIndex);
        uniforms->SetUniformf(cstring_cast(fullName), 1, &val);
}

void SingleVolumePainterHelper::eachRenderInternal(vtkSmartPointer<vtkShaderProgram2> shader)
{
        if (!mVolumeBuffer)
                return;

        mVolumeBuffer->bind(mIndex);

        int texture = 2*mIndex; //texture unit 1
        int lut = 2*mIndex+1; //texture unit 1

        int lutsize = 0;
        if (mLutBuffer)
        {
                mLutBuffer->bind(mIndex);
                lutsize = mLutBuffer->getLutSize();
        }

        vtkUniformVariables* uniforms = shader->GetUniformVariables();
        this->setUniformiArray(uniforms, "texture", texture);
        this->setUniformiArray(uniforms, "lut", lut);
        this->setUniformiArray(uniforms, "lutsize", lutsize);
        this->setUniformfArray(uniforms, "llr", mLLR);
        this->setUniformfArray(uniforms, "level", mLevel);
        this->setUniformfArray(uniforms, "window", mWindow);
        this->setUniformfArray(uniforms, "alpha", mAlpha);

        report_gl_error();
}

//---------------------------------------------------------
TextureSlicePainter::TextureSlicePainter() :
        hasLoadedExtensions(false)
{
}

void TextureSlicePainter::setShaderPath(QString path)
{
        mShaderPath = path;
}

QString TextureSlicePainter::loadShaderFile()
{       
        QString filepath = mShaderPath + "/cxOverlay2D_frag.glsl";
        QFile fp(filepath);
        if (fp.exists())
        {
                fp.open(QFile::ReadOnly);
                QTextStream shaderfile(&fp);
                return shaderfile.readAll();
        }
        else
        {
                std::cout << "TextureSlicer can't read shaderfile [" << fp.fileName() << "]" << std::endl;
        }
        return "";
}

TextureSlicePainter::~TextureSlicePainter()
{
        if (this->LastContext)
        {
            this->ReleaseGraphicsResources(this->LastWindow);
        }
}

void TextureSlicePainter::ReleaseGraphicsResources(vtkWindow* win)
{
        if (this->Shader != 0)
        {
                this->Shader->ReleaseGraphicsResources();
                this->Shader = 0;
        }

        this->ClearGraphicsResources(); //the shader
        this->LastContext = 0;
        this->Superclass::ReleaseGraphicsResources(win);
}

void TextureSlicePainter::PrepareForRendering(vtkRenderer* renderer, vtkActor* actor)
{
        report_gl_error();
        if (!CanRender(renderer, actor))
        {
                this->ClearGraphicsResources();
                this->LastContext = 0;
                this->Superclass::PrepareForRendering(renderer, actor);
                return;
        }

        GLint oldTextureUnit;
        glGetIntegerv(GL_ACTIVE_TEXTURE, &oldTextureUnit);

        vtkRenderWindow* renWin = renderer->GetRenderWindow();
        if (this->LastContext != renWin)
        {
                this->ClearGraphicsResources();
                hasLoadedExtensions = false; // force re-check
        }
        this->LastContext = renWin;

        vtkOpenGLRenderWindow *context = vtkOpenGLRenderWindow::SafeDownCast(renWin);
        if (!hasLoadedExtensions)
        {
                if (!this->LoadRequiredExtensions(context->GetExtensionManager()))
                {
                        return;
                }
                hasLoadedExtensions = true;
        }

        for (unsigned i = 0; i < this->mElement.size(); ++i)
                this->mElement[i].initializeRendering();

        if (!this->Shader)
        {
                report_gl_error();
                QString shaderSource = this->loadShaderFile();
                shaderSource = this->replaceShaderSourceMacros(shaderSource);
//              int layers = this->mElement.size();
//              shaderSource = shaderSource.replace("${LAYERS}", QString("%1").arg(layers));

                this->buildProgram(shaderSource, context);
        }

        glPixelStorei(GL_PACK_ALIGNMENT, 1);
        glPixelStorei(GL_PACK_ROW_LENGTH, 0);
        glPixelStorei(GL_PACK_SKIP_ROWS, 0);
        glPixelStorei(GL_PACK_SKIP_PIXELS, 0);

        this->Superclass::PrepareForRendering(renderer, actor);
        report_gl_error();
        glActiveTexture(oldTextureUnit);
}

QString TextureSlicePainter::replaceShaderSourceMacros(QString shaderSource)
{
        // set constant layers
        int layers = this->mElement.size();
        shaderSource = shaderSource.replace("${LAYERS}", QString("%1").arg(layers));

        // fill function vec4 sampleLut(in int index, in float idx)
        QString element = "\tif (index==%1) return texture1D(lut[%1], idx);\n";
        QString sampleLutContent;
        for (unsigned i=0; i<layers; ++i)
                sampleLutContent += element.arg(i);
        shaderSource = shaderSource.replace("${SAMPLE_LUT_CONTENT}", sampleLutContent);

        return shaderSource;
}


void TextureSlicePainter::RenderInternal(vtkRenderer* renderer, vtkActor* actor, unsigned long typeflags,
                bool forceCompileOnly)
{
        if (!CanRender(renderer, actor))
        {
                return;
        }

        GLint oldTextureUnit;
        glGetIntegerv(GL_ACTIVE_TEXTURE, &oldTextureUnit);

        int layers = this->mElement.size();
        this->Shader->GetUniformVariables()->SetUniformi("layers", 1, &layers);

        for (unsigned i = 0; i < this->mElement.size(); ++i)
        {
                this->mElement[i].eachRenderInternal(this->Shader);
        }

        this->Shader->Use();

        if (!this->Shader->IsValid())
        {
                vtkErrorMacro(<<" validation of the program failed: "<< this->Shader->GetLastValidateLog());
        }

        this->Superclass::RenderInternal(renderer, actor, typeflags, forceCompileOnly);

        this->Shader->Restore();
        report_gl_error();
        glActiveTexture(oldTextureUnit);
}

bool TextureSlicePainter::CanRender(vtkRenderer*, vtkActor*)
{
        return !this->mElement.empty();
}

bool TextureSlicePainter::LoadRequiredExtension(vtkOpenGLExtensionManager* mgr, QString id)
{
        bool loaded = mgr->LoadSupportedExtension(cstring_cast(id));
        if (!loaded)
                std::cout << "TextureSlicePainter Error: GL extension " + id + " not found" << std::endl;
        return loaded;
}

bool TextureSlicePainter::LoadRequiredExtensions(vtkOpenGLExtensionManager* mgr)
{
        return (LoadRequiredExtension(mgr, "GL_VERSION_2_0")
                        && LoadRequiredExtension(mgr, "GL_VERSION_1_5")
                        && LoadRequiredExtension(mgr, "GL_ARB_vertex_buffer_object"));
}

void TextureSlicePainter::SetVolumeBuffer(int index, GPUImageDataBufferPtr buffer)
{
        this->safeIndex(index).SetBuffer(buffer);
}

void TextureSlicePainter::SetLutBuffer(int index, GPUImageLutBufferPtr buffer)
{
        this->safeIndex(index).SetBuffer(buffer);
}

void TextureSlicePainter::SetColorAttribute(int index, float window, float level, float llr,float alpha)
{
        this->safeIndex(index).SetColorAttribute(window, level, llr, alpha);
}

void TextureSlicePainter::releaseGraphicsResources(int index)
{
}

void TextureSlicePainter::PrintSelf(ostream& os, vtkIndent indent)
{
}

SingleVolumePainterHelper& TextureSlicePainter::safeIndex(int index)
{
        if ((int)mElement.size() <= index)
        {
                mElement.resize(index+1);
                mElement[index] = SingleVolumePainterHelper(index);
        }
        return mElement[index];
}

void TextureSlicePainter::buildProgram(QString shaderSource, vtkOpenGLRenderWindow* renderWindow)
{
        vtkShaderProgram2Ptr pgm = vtkShaderProgram2Ptr::New();
        pgm->SetContext(renderWindow);

        vtkShader2Ptr s2 = vtkShader2Ptr::New();
        s2->SetType(VTK_SHADER_TYPE_FRAGMENT);
        s2->SetSourceCode(cstring_cast(shaderSource));
        s2->SetContext(pgm->GetContext());
        pgm->GetShaders()->AddItem(s2);
        report_gl_error();
        pgm->Build();

        if (pgm->GetLastBuildStatus() != VTK_SHADER_PROGRAM2_LINK_SUCCEEDED)
        {
                vtkErrorMacro("Pass Two failed.");
                abort();
        }

        this->Shader = pgm;
}

void TextureSlicePainter::ClearGraphicsResources()
{
        if (this->Shader != 0)
        {
                this->Shader->ReleaseGraphicsResources();
                this->Shader = 0;
        }
}


//---------------------------------------------------------
}//end namespace
//---------------------------------------------------------
#endif //WIN32