ShaderCache.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * 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.              *
 *                                                                           *
\*===========================================================================*/



#pragma once


#include <list>
#include <QDateTime>
#include <ACG/Config/ACGDefines.hh>
#include <ACG/GL/ShaderGenerator.hh>

// forward declaration
namespace GLSL
{
  class Program;
}


namespace ACG {


class ACGDLLEXPORT ShaderCache
{
public:

  virtual ~ShaderCache();

  static ShaderCache* getInstance();


  GLSL::Program* getProgram(const ShaderGenDesc* _desc, const std::vector<unsigned int>& _mods);

  GLSL::Program* getProgram(const ShaderGenDesc* _desc, const std::vector<unsigned int>* _mods)
  {
    return _mods ? getProgram(_desc, *_mods) : getProgram(_desc);
  }

  GLSL::Program* getProgram(const ShaderGenDesc* _desc);


  GLSL::Program* getProgram(const char* _vertexShaderFile,
    const char* _tessControlShaderFile,
    const char* _tessEvalShaderFile,
    const char* _geometryShaderFile,
    const char* _fragmentShaderFile,
    QStringList* _macros = 0, bool _verbose = true);
  
  GLSL::Program* getProgram(const char* _vertexShaderFile, const char* _fragmentShaderFile, QStringList* _macros = 0, bool _verbose = true);


  GLSL::Program* getComputeProgram(const char* _computeShaderFile, QStringList* _macros = 0, bool _verbose = true);
  


  void clearCache();

  void setTimeCheck(bool _on){timeCheck_ = _on;}
  bool getTimeCheck(){return timeCheck_;}


  void setDebugOutputDir(const char* _outputDir);

protected:
  ShaderCache();

  struct CacheEntry
  {
    ShaderGenDesc desc;
    std::vector<unsigned int> mods;

    // string-pointer in ShaderGenDesc may not be permanent,
    // so copy string data here
    QString strVertexTemplate;
    QString strTessControlTemplate;
    QString strTessEvaluationTemplate;
    QString strGeometryTemplate;
    QString strFragmentTemplate;

    QDateTime vertexFileLastMod;
    QDateTime tessControlFileLastMod;
    QDateTime tessEvaluationFileLastMod;
    QDateTime geometryFileLastMod;
    QDateTime fragmentFileLastMod;

    QStringList macros;
  };

  bool compareTimeStamp(const CacheEntry* _a, const CacheEntry* _b);

  int compareShaderGenDescs(const CacheEntry* _a, const CacheEntry* _b);


  typedef std::list<std::pair<CacheEntry, GLSL::Program*> > CacheList;
  
  CacheList cache_;

  CacheList cacheStatic_;

  CacheList cacheComputeShaders_;

  bool timeCheck_;

  QString dbgOutputDir_;
};



//=============================================================================
} // namespace ACG
//=============================================================================