vtkOpenGLShaderComputation.cxx

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkOpenGLShaderComputation.cxx,v $

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#include "vtkOpenGLShaderComputation.h"

// VTK includes
#include "vtkVersionMacros.h" // For VTK_VERSION_NUMBER, VTK_VERSION_CHECK
#if VTK_VERSION_NUMBER >= VTK_VERSION_CHECK(9, 4, 0)
#include "vtk_glad.h"
#else
#include "vtk_glew.h"
#endif
#include "vtkDataArray.h"
#include "vtkImageData.h"
#include "vtkObjectFactory.h"
#include "vtkOpenGLError.h"
#include "vtkOpenGLRenderWindow.h"
#include "vtkPointData.h"
#include "vtkRenderer.h"

// std includes
#include <math.h>

// vtkAddon includes
#include "vtkOpenGLTextureImage.h"

//----------------------------------------------------------------------------
vtkStandardNewMacro(vtkOpenGLShaderComputation);

//----------------------------------------------------------------------------
vtkOpenGLShaderComputation::vtkOpenGLShaderComputation()
{
  this->Initialized = false;
  this->ErrorOccurred = false;
  this->VertexShaderSource = nullptr;
  this->FragmentShaderSource = nullptr;
  this->ResultImageData = nullptr;
  this->ProgramObject = 0;
  this->ProgramObjectMTime = 0;

  this->RenderWindow = vtkRenderWindow::New();
  this->RenderWindow->OffScreenRenderingOn();

  this->Initialize(this->RenderWindow);

  this->Uniforms = std::map<std::string, vtkVariant>();
}

//----------------------------------------------------------------------------
vtkOpenGLShaderComputation::~vtkOpenGLShaderComputation()
{
  this->MakeCurrent();
  //Bind 0, which means render to back buffer, as a result, this->FramebufferID is unbound
  glBindFramebuffer(GL_FRAMEBUFFER, 0);
  if (this->FramebufferID != 0)
    {
    glDeleteFramebuffers(1, &(this->FramebufferID));
    }
  this->ReleaseResultRenderbuffer();
  this->SetVertexShaderSource(nullptr);
  this->SetFragmentShaderSource(nullptr);
  this->SetResultImageData(nullptr);
  if (this->ProgramObject > 0)
    {
    glDeleteProgram ( this->ProgramObject );
    this->ProgramObject = 0;
    }
  this->SetRenderWindow(nullptr);
}

//----------------------------------------------------------------------------
// Make sure OpenGL calls are sent to our render context
//
void vtkOpenGLShaderComputation::MakeCurrent()
{
  if (this->RenderWindow)
    {
    this->RenderWindow->MakeCurrent();
    }
  else
    {
    vtkErrorMacro ( "Trying to make current but render window is null" );
    this->ErrorOccurred = true;
    }
}

//----------------------------------------------------------------------------
// Make sure the framebuffer is okay
//
bool vtkOpenGLShaderComputation::FramebufferComplete()
{
  if (!this->RenderWindow)
    {
    vtkErrorMacro ( "Need a RenderWindow to check the framebuffer" );
    return false;
    }

  GLenum status;
  status = glCheckFramebufferStatus(GL_FRAMEBUFFER);
  if (status == GL_FRAMEBUFFER_COMPLETE)
    {
    return true;
    }
  else
    {
    switch(status)
      { // TODO: this mapping (macro to text) could be factored out for reuse elsewhere
      case GL_FRAMEBUFFER_UNDEFINED:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_UNDEFINED, status is: " << status);
        break;
      case GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT, status is: " << status);
        break;
      case GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT, status is: " << status);
        break;
      case GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER, status is: " << status);
        break;
      case GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER, status is: " << status);
        break;
      case GL_FRAMEBUFFER_UNSUPPORTED:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_UNSUPPORTED, status is: " << status);
        break;
      case GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE, status is: " << status);
        break;
      case GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS:
        vtkErrorMacro("Incompete framebuffer; GL_FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS, status is: " << status);
        break;
      default:
        vtkErrorMacro("Incompete framebuffer; status is: " << status);
      }
    return false;
    }
}

//----------------------------------------------------------------------------
///
// Create a shader object, load the shader source, and
// compile the shader.
//
static GLuint CompileShader ( vtkOpenGLShaderComputation *self, GLenum type, const char *shaderSource )
{
  self->MakeCurrent();
  vtkOpenGLClearErrorMacro();

  GLuint shader;
  GLint compiled;

  // Create the shader object
  shader = glCreateShader ( type );

  if ( shader == 0 )
    {
    return 0;
    }

  // Load the shader source
  glShaderSource ( shader, 1, &shaderSource, nullptr );

  // Compile the shader
  glCompileShader ( shader );
  vtkOpenGLStaticCheckErrorMacro("after compiling shader");

  // Check the compile status
  glGetShaderiv ( shader, GL_COMPILE_STATUS, &compiled );
  if ( !compiled )
    {
    GLint infoLen = 0;
    glGetShaderiv ( shader, GL_INFO_LOG_LENGTH, &infoLen );
    if ( infoLen > 1 )
      {
      char *infoLog = (char *) malloc ( sizeof ( char ) * infoLen );
      glGetShaderInfoLog ( shader, infoLen, nullptr, infoLog );
      switch(type)
        {
        case GL_VERTEX_SHADER:
          vtkErrorWithObjectMacro (self, "Error compiling vertex shader\n" << infoLog );
          break;
        case GL_FRAGMENT_SHADER:
          vtkErrorWithObjectMacro (self, "Error compiling fragment shader\n" << infoLog );
          break;
        default:
          vtkErrorWithObjectMacro (self, "Error compiling unknown shader type!\n" << infoLog );
          break;
        }
      free ( infoLog );
      }
      vtkOpenGLStaticCheckErrorMacro("after checking compile status");
      glDeleteShader ( shader );
      vtkOpenGLStaticCheckErrorMacro("after deleting bad shader");
      return 0;
    }

  vtkOpenGLStaticCheckErrorMacro("after compiling shader");
  return shader;
}

//----------------------------------------------------------------------------
// Rebuild the shader program if needed
//
bool vtkOpenGLShaderComputation::UpdateProgram()
{
  vtkOpenGLClearErrorMacro();
  GLuint vertexShader;
  GLuint fragmentShader;
  GLint linked;

  this->MakeCurrent();

  if (this->GetMTime() > this->ProgramObjectMTime)
    {
    if (this->ProgramObject != 0)
      {
      glDeleteProgram ( this->ProgramObject );
      }
    this->ProgramObjectMTime = 0;
    }
  else
    {
    return true;
    }

  // Load the vertex/fragment shaders
  vertexShader = CompileShader ( this, GL_VERTEX_SHADER, this->VertexShaderSource );
  fragmentShader = CompileShader ( this, GL_FRAGMENT_SHADER, this->FragmentShaderSource );

  if ( !vertexShader || !fragmentShader )
    {
    vtkOpenGLCheckErrorMacro("after failed compile");
    return false;
    }

  // Create the program object
  this->ProgramObject = glCreateProgram ( );

  if ( this->ProgramObject == 0 )
    {
    vtkOpenGLCheckErrorMacro("after failed program create");
    return false;
    }

  glAttachShader ( this->ProgramObject, vertexShader );
  glAttachShader ( this->ProgramObject, fragmentShader );

  glLinkProgram ( this->ProgramObject );

  // Check the link status
  glGetProgramiv ( this->ProgramObject, GL_LINK_STATUS, &linked );

  if ( !linked )
    {
    // something went wrong, so emit error message if possible
    GLint infoLen = 0;
    glGetProgramiv ( this->ProgramObject, GL_INFO_LOG_LENGTH, &infoLen );

    if ( infoLen > 1 )
      {
      char *infoLog = (char *) malloc ( sizeof ( char ) * infoLen );

      glGetProgramInfoLog ( this->ProgramObject, infoLen, nullptr, infoLog );
      vtkErrorMacro ( "Error linking program\n" << infoLog );
      this->ErrorOccurred = true;

      free ( infoLog );
      }

    glDeleteProgram ( this->ProgramObject );
    vtkOpenGLCheckErrorMacro("after failed program attachment");
    return false;
    }

  this->ProgramObjectMTime = this->GetMTime();
  vtkOpenGLCheckErrorMacro("after program creation");
  return true;
}

//-----------------------------------------------------------------------------
void vtkOpenGLShaderComputation::Initialize(vtkRenderWindow *renderWindow)
{
  if (this->Initialized)
    {
    return;
    }

  vtkOpenGLRenderWindow *openGLRenderWindow = vtkOpenGLRenderWindow::SafeDownCast(renderWindow);
  if (!openGLRenderWindow)
    {
    vtkErrorMacro("Bad render window");
    this->ErrorOccurred = true;
    return;
    }

  this->MakeCurrent();

  // generate and bind our Framebuffer
  glGenFramebuffers(1, &(this->FramebufferID));
  glBindFramebuffer(GL_FRAMEBUFFER, this->FramebufferID);
  vtkOpenGLCheckErrorMacro("after binding framebuffer");

  this->Initialized = true;
}


//-----------------------------------------------------------------------------
bool vtkOpenGLShaderComputation::AcquireResultRenderbuffer()
{
  //
  // adapted from
  // https://www.opengl.org/wiki/Framebuffer_Object_Examples
  //

  this->MakeCurrent();

  int resultDimensions[3];
  this->ResultImageData->GetDimensions(resultDimensions);

  vtkOpenGLClearErrorMacro();

  //
  // Create and attach a color buffer
  // * We must bind this->ColorRenderbufferID before we call glRenderbufferStorage
  // * The storage format is RGBA8
  // * Attach color buffer to FBO
  //
  glGenRenderbuffers(1, &(this->ColorRenderbufferID));
  glBindRenderbuffer(GL_RENDERBUFFER, this->ColorRenderbufferID);
  glRenderbufferStorage(GL_RENDERBUFFER, GL_RGBA8,
                        resultDimensions[0], resultDimensions[1]);
  glFramebufferRenderbuffer(GL_FRAMEBUFFER,
                            GL_COLOR_ATTACHMENT0,
                            GL_RENDERBUFFER,
                            this->ColorRenderbufferID);
  vtkOpenGLCheckErrorMacro("after binding color renderbuffer");

  //
  // Now do the same for the depth buffer
  //
  glGenRenderbuffers(1, &(this->DepthRenderbufferID));
  glBindRenderbuffer(GL_RENDERBUFFER, this->DepthRenderbufferID);
  glRenderbufferStorage(GL_RENDERBUFFER, GL_DEPTH_COMPONENT24,
                        resultDimensions[0], resultDimensions[1]);
  glFramebufferRenderbuffer(GL_FRAMEBUFFER,
                            GL_DEPTH_ATTACHMENT,
                            GL_RENDERBUFFER,
                            this->DepthRenderbufferID);
  vtkOpenGLCheckErrorMacro("after binding depth renderbuffer");

  //
  // Does the GPU support current Framebuffer configuration?
  //
  if (!this->FramebufferComplete())
    {
    this->ErrorOccurred = true;
    vtkOpenGLCheckErrorMacro("after bad framebuffer status");
    vtkErrorMacro("Bad framebuffer configuration");
    return false;
    }

  //
  // now we can render to the FBO (also called RenderBuffer)
  //
  glBindFramebuffer(GL_FRAMEBUFFER, this->FramebufferID);
  glClearColor(0.0, 0.0, 0.0, 0.0);
  glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
  vtkOpenGLCheckErrorMacro("after clearing renderbuffers");

  //
  // Set up a normalized rendering environment
  //
  glViewport(0, 0, resultDimensions[0], resultDimensions[1]);
  glDisable(GL_BLEND);
  glEnable(GL_DEPTH_TEST);
  vtkOpenGLCheckErrorMacro("after framebuffer acquisition");
  return true;
}

//----------------------------------------------------------------------------
void vtkOpenGLShaderComputation::ReleaseResultRenderbuffer()
{
  this->MakeCurrent();
  vtkOpenGLClearErrorMacro();
  //Delete temp resources
  if (this->ColorRenderbufferID != 0)
    {
    glDeleteRenderbuffers(1, &(this->ColorRenderbufferID));
    }
  if (this->DepthRenderbufferID != 0)
    {
    glDeleteRenderbuffers(1, &(this->DepthRenderbufferID));
    }
  vtkOpenGLCheckErrorMacro("after framebuffer release");
}

//----------------------------------------------------------------------------
// Perform the computation
//
void vtkOpenGLShaderComputation::Compute(float slice)
{
  // bail out early if we aren't configured correctly
  if (this->VertexShaderSource == nullptr || this->FragmentShaderSource == nullptr)
    {
    vtkErrorMacro("Both vertex and fragment shaders are needed for a shader computation.");
    this->ErrorOccurred = true;
    return;
    }

  // ensure that all our OpenGL calls go to the correct context
  this->MakeCurrent();

  //
  // Does the GPU support current Framebuffer configuration?
  //
  if (!this->FramebufferComplete())
    {
    vtkErrorMacro("Framebuffer is not complete.");
    this->ErrorOccurred = true;
    return;
    }


  // Configure the program and the input data
  if (!this->UpdateProgram())
    {
    vtkErrorMacro("Could not update shader program.");
    this->ErrorOccurred = true;
    return;
    }

  // define a normalized computing surface
  GLfloat planeVertices[] = { -1.0f, -1.0f, 0.0f,
                              -1.0f,  1.0f, 0.0f,
                               1.0f, -1.0f, 0.0f,
                               1.0f,  1.0f, 0.0f,
                        };
  GLuint planeVerticesSize = sizeof(GLfloat)*3*4;
  GLfloat planeTextureCoordinates[] = { 0.0f, 0.0f,
                                        0.0f, 1.0f,
                                        1.0f, 0.0f,
                                        1.0f, 1.0f,
                        };
  GLuint planeTextureCoordinatesSize = sizeof(GLfloat)*2*4;

  vtkOpenGLClearErrorMacro();
  // Use the program object
  glUseProgram ( this->ProgramObject );
  vtkOpenGLCheckErrorMacro("after use program");

  // put vertices in a buffer and make it available to the program
  GLuint vertexLocation = glGetAttribLocation(this->ProgramObject, "vertexAttribute");
  GLuint planeVerticesBuffer;
  GLuint vao;
  glGenVertexArrays(1, &vao);
  glBindVertexArray(vao);
  glGenBuffers(1, &planeVerticesBuffer);
  glBindBuffer(GL_ARRAY_BUFFER, planeVerticesBuffer);
  glBufferData(GL_ARRAY_BUFFER, planeVerticesSize, planeVertices, GL_STATIC_DRAW);
  glEnableVertexAttribArray ( vertexLocation );
  glVertexAttribPointer ( vertexLocation, 3, GL_FLOAT, GL_FALSE, 0, nullptr );
  vtkOpenGLCheckErrorMacro("after vertices");

  // texture coordinates in a buffer
  GLuint textureCoordinatesLocation = glGetAttribLocation(this->ProgramObject,
                                                          "textureCoordinateAttribute");
  GLuint textureCoordinatesBuffer;
  glGenBuffers(1, &textureCoordinatesBuffer);
  glBindBuffer(GL_ARRAY_BUFFER, textureCoordinatesBuffer);
  glBufferData(GL_ARRAY_BUFFER, planeTextureCoordinatesSize, planeTextureCoordinates, GL_STATIC_DRAW);
  glEnableVertexAttribArray ( textureCoordinatesLocation );
  glVertexAttribPointer ( textureCoordinatesLocation, 2, GL_FLOAT, GL_FALSE, 0, nullptr );
  vtkOpenGLCheckErrorMacro("after texture coordinates");

  // Iterate through all standard texture units and if one of them
  // is used as a uniform variable in the program, set the corresponding value.
  // This relies on vtkOpenGLTextureImage (or something else) to have
  // set up the texture units with data.
  // Up to 48 units are meant to be supported on any OpenGL implementation
  // but the defined enums appear to only go to 32.
  #define __TEXTURE_UNIT_COUNT 16 // TODO: maybe expose parameter of how many textures to look for
  char textureUnitUniformString[14]; // 14 length of "textureUnit__" including \0
  strncpy(textureUnitUniformString, "textureUnit__", 14);
  char textureUnitLength = 11; // Up to the two underscores that will be replaced
  char asciiUnit[3]; // target for snprintf
  int unitIndex;
  for (unitIndex = 0; unitIndex < __TEXTURE_UNIT_COUNT; unitIndex++)
    {
    snprintf(asciiUnit, 3, "%d", unitIndex);
    strncpy(textureUnitUniformString + textureUnitLength, asciiUnit, 2);
    GLint textureUnitSamplerLocation = glGetUniformLocation(this->ProgramObject, textureUnitUniformString);
    if ( textureUnitSamplerLocation >= 0 )
      {
      glUniform1i(textureUnitSamplerLocation, unitIndex);
      vtkOpenGLCheckErrorMacro("after setting texture unit uniform " << unitIndex);
      }
    }
  vtkOpenGLCheckErrorMacro("after setting texture unit uniforms");

  // pass in the slice location.
  // TODO: generalize uniform arguments, create vtkVariantMap
  GLint sliceLocation = glGetUniformLocation(this->ProgramObject, "slice");
  if ( sliceLocation >= 0 )
    {
    glUniform1f(sliceLocation, slice);
    }

  for (std::map<std::string, vtkVariant>::iterator uniformIt = this->Uniforms.begin(); uniformIt != this->Uniforms.end(); ++uniformIt)
  {
    // TODO: uniform support
    std::string uniformString = uniformIt->first;
    float uniform = uniformIt->second.ToFloat();

    GLint uniformLocation = glGetUniformLocation(this->ProgramObject, uniformString.c_str());
    glUniform1f(uniformLocation, uniform);
  }

  //
  // GO!
  //
  glDrawArrays( GL_TRIANGLE_STRIP, 0, 4 );
  vtkOpenGLCheckErrorMacro("after drawing");

  //
  // Don't use the program or the framebuffer anymore
  //
  glUseProgram ( 0 );
}

//----------------------------------------------------------------------------
void vtkOpenGLShaderComputation::SetUniform(std::string uniformString, float uniform)
{
  this->Uniforms[uniformString] = vtkVariant(uniform);
}

//----------------------------------------------------------------------------
void vtkOpenGLShaderComputation::ReadResult()
{

  this->MakeCurrent();
  vtkOpenGLClearErrorMacro();
  // check and set up the result area
  if (this->ResultImageData == nullptr
      ||
      this->ResultImageData->GetPointData() == nullptr
      ||
      this->ResultImageData->GetPointData()->GetScalars() == nullptr
      ||
      this->ResultImageData->GetPointData()->GetScalars()->GetVoidPointer(0) == nullptr)
    {
    vtkErrorMacro("Result image data is not correctly set up.");
    this->ErrorOccurred = true;
    return;
    }
  int resultDimensions[3];
  this->ResultImageData->GetDimensions(resultDimensions);
  vtkPointData *pointData = this->ResultImageData->GetPointData();
  vtkDataArray *scalars = pointData->GetScalars();
  void *resultPixels = scalars->GetVoidPointer(0);

  //
  // Collect the results of the calculation back into the image data
  //
  int componentCount = this->ResultImageData->GetNumberOfScalarComponents();
  GLuint format;
  if ( componentCount == 1 )
    {
    format = GL_RED;
    }
  else if ( componentCount == 3 )
    {
    format = GL_RGB;
    }
  else if ( componentCount == 4 )
    {
    format = GL_RGBA;
    }
  else
    {
    vtkErrorMacro("Must have 1, 3 or 4 component image data for texture");
    this->ErrorOccurred = true;
    return;
    }

  vtkTypeUInt32 scalarType = vtkOpenGLTextureImage::vtkScalarTypeToGLType(this->ResultImageData->GetScalarType());
  glReadPixels(0, 0, resultDimensions[0], resultDimensions[1], format, scalarType, resultPixels);
  pointData->Modified();

  vtkOpenGLCheckErrorMacro("after reading back");
}

//----------------------------------------------------------------------------
void vtkOpenGLShaderComputation::PrintSelf(ostream& os, vtkIndent indent)
{
  this->Superclass::PrintSelf(os,indent);
  os << indent << "Initialized: " << this->Initialized << "\n";
  if ( this->VertexShaderSource )
    {
    os << indent << "VertexShaderSource: " << this->VertexShaderSource << "\n";
    }
  else
    {
    os << indent << "VertexShaderSource: (none)\n";
    }
  if ( this->FragmentShaderSource )
    {
    os << indent << "FragmentShaderSource: " << this->FragmentShaderSource << "\n";
    }
  else
    {
    os << indent << "FragmentShaderSource: (none)\n";
    }
  if ( this->ResultImageData )
    {
    os << indent << "ResultImageData: " << this->ResultImageData << "\n";
    }
  else
    {
    os << indent << "ResultImageData: (none)\n";
    }
  os << indent << "ProgramObject: " << this->ProgramObject << "\n";
  os << indent << "ProgramObjectMTime: " << this->ProgramObjectMTime << "\n";
  os << indent << "FramebufferID: " << this->FramebufferID << "\n";
  os << indent << "ColorRenderbufferID: " << this->ColorRenderbufferID << "\n";
  os << indent << "DepthRenderbufferID: " << this->DepthRenderbufferID << "\n";
}