/*

-----------------------------------------------------------------------------

This source file is part of OGRE

(Object-oriented Graphics Rendering Engine)

For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2014 Torus Knot Software Ltd

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 above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

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.

-----------------------------------------------------------------------------

*/

#include "OgreShaderPrecompiledHeaders.h"

namespace Ogre {

namespace RTShader {

String GLSLProgramWriter::TargetLanguage = "glsl";

//-----------------------------------------------------------------------

GLSLProgramWriter::GLSLProgramWriter() : mGLSLVersion(100), mIsGLSLES(false), mIsVulkan(false)

{

    initializeStringMaps();

    auto* rs = Root::getSingleton().getRenderSystem();

    if (!rs)

        return;

    mGLSLVersion = rs->getNativeShadingLanguageVersion();

    if (rs->getCapabilities()->isShaderProfileSupported("spirv"))

    {

        mGLSLVersion = 460;

        mIsVulkan = true;

    }

    mIsGLSLES = rs->getCapabilities()->isShaderProfileSupported("glsles");

}

//-----------------------------------------------------------------------

GLSLProgramWriter::~GLSLProgramWriter()

{

}

//-----------------------------------------------------------------------

void GLSLProgramWriter::initializeStringMaps()

{

    // basic glsl types

    mGpuConstTypeMap[GCT_FLOAT1] = "float";

    mGpuConstTypeMap[GCT_FLOAT2] = "vec2";

    mGpuConstTypeMap[GCT_FLOAT3] = "vec3";

    mGpuConstTypeMap[GCT_FLOAT4] = "vec4";

    mGpuConstTypeMap[GCT_SAMPLER1D] = "sampler1D";

    mGpuConstTypeMap[GCT_SAMPLER2D] = "sampler2D";

    mGpuConstTypeMap[GCT_SAMPLER2DARRAY] = "sampler2DArray";

    mGpuConstTypeMap[GCT_SAMPLER3D] = "sampler3D";

    mGpuConstTypeMap[GCT_SAMPLERCUBE] = "samplerCube";

    mGpuConstTypeMap[GCT_SAMPLERCUBESHADOW] = "samplerCubeShadow";

    mGpuConstTypeMap[GCT_SAMPLER1DSHADOW] = "sampler1DShadow";

    mGpuConstTypeMap[GCT_SAMPLER2DSHADOW] = "sampler2DShadow";

    mGpuConstTypeMap[GCT_SAMPLER2DARRAYSHADOW] = "sampler2DArrayShadow";

    mGpuConstTypeMap[GCT_SAMPLER_EXTERNAL_OES] = "samplerExternalOES";

    mGpuConstTypeMap[GCT_MATRIX_2X2] = "mat2";

    mGpuConstTypeMap[GCT_MATRIX_2X3] = "mat2x3";

    mGpuConstTypeMap[GCT_MATRIX_2X4] = "mat2x4";

    mGpuConstTypeMap[GCT_MATRIX_3X2] = "mat3x2";

    mGpuConstTypeMap[GCT_MATRIX_3X3] = "mat3";

    mGpuConstTypeMap[GCT_MATRIX_3X4] = "mat3x4";

    mGpuConstTypeMap[GCT_MATRIX_4X2] = "mat4x2";

    mGpuConstTypeMap[GCT_MATRIX_4X3] = "mat4x3";

    mGpuConstTypeMap[GCT_MATRIX_4X4] = "mat4";

    mGpuConstTypeMap[GCT_INT1] = "int";

    mGpuConstTypeMap[GCT_INT2] = "ivec2";

    mGpuConstTypeMap[GCT_INT3] = "ivec3";

    mGpuConstTypeMap[GCT_INT4] = "ivec4";

    mGpuConstTypeMap[GCT_UINT1] = "uint";

    mGpuConstTypeMap[GCT_UINT2] = "uvec2";

    mGpuConstTypeMap[GCT_UINT3] = "uvec3";

    mGpuConstTypeMap[GCT_UINT4] = "uvec4";

    // Custom vertex attributes defined http://www.ogre3d.org/docs/manual/manual_21.html

    mParamSemanticToNameMap[Parameter::SPS_POSITION] = "vertex";

    mParamSemanticToNameMap[Parameter::SPS_NORMAL] = "normal";

    mParamSemanticToNameMap[Parameter::SPS_TANGENT] = "tangent";

    mParamSemanticToNameMap[Parameter::SPS_BINORMAL] = "binormal";

    mParamSemanticToNameMap[Parameter::SPS_BLEND_INDICES] = "blendIndices";

    mParamSemanticToNameMap[Parameter::SPS_BLEND_WEIGHTS] = "blendWeights";

    mParamSemanticToNameMap[Parameter::SPS_COLOR] = "colour";

}

//-----------------------------------------------------------------------

void GLSLProgramWriter::writeSourceCode(std::ostream& os, Program* program)

{

    // Write the current version (this force the driver to more fulfill the glsl standard)

    os << "OGRE_NATIVE_GLSL_VERSION_DIRECTIVE\n";

    for(const auto& p : program->getParameters())

    {

        if(p->getType() != GCT_SAMPLER_EXTERNAL_OES)

            continue;

        if(mGLSLVersion > 100)

            os << "#extension GL_OES_EGL_image_external_essl3 : require\n";

        else

            os << "#extension GL_OES_EGL_image_external : require\n";

        break;

    }

    if (program->getType() == GPT_VERTEX_PROGRAM && program->getMain()->getOutputParameter(Parameter::SPC_LAYER))

    {

        os << "#extension GL_ARB_shader_viewport_layer_array : require\n";

    }

    // Generate dependencies.

    writeProgramDependencies(os, program);

    os << std::endl;

    writeMainSourceCode(os, program);

}

void GLSLProgramWriter::writeUniformBlock(std::ostream& os, const String& name, int binding,

                                          const UniformParameterList& uniforms)

{

    os << "layout(binding = " << binding << ", row_major) uniform " << name << " {\n";

    for (const auto& uparam : uniforms)

    {

        if(uparam->getType() == GCT_MATRIX_3X4 || uparam->getType() == GCT_MATRIX_2X4)

            os << "layout(column_major) ";

        writeParameter(os, uparam);

        os << ";\n";

    }

    os << "};\n";

}

void GLSLProgramWriter::writeMainSourceCode(std::ostream& os, Program* program)

{

    GpuProgramType gpuType = program->getType();

    if(gpuType == GPT_GEOMETRY_PROGRAM)

    {

        OGRE_EXCEPT( Exception::ERR_NOT_IMPLEMENTED,

            "Geometry Program not supported in GLSL writer ",

            "GLSLProgramWriter::writeSourceCode" );

    }

    const UniformParameterList& parameterList = program->getParameters();

    // Generate global variable code.

    writeUniformParametersTitle(os, program);

    os << std::endl;

    auto* rs = Root::getSingleton().getRenderSystem();

    auto hasSSO = rs ? rs->getCapabilities()->hasCapability(RSC_SEPARATE_SHADER_OBJECTS) : false;

    // Write the uniforms

    UniformParameterList uniforms;

    for (const auto& param : parameterList)

    {

        if(!param->isSampler())

        {

            uniforms.push_back(param);

            continue;

        }

        writeSamplerParameter(os, param);

        os << ";" << std::endl;

    }

    if (mIsVulkan && !uniforms.empty())

    {

        writeUniformBlock(os, "OgreUniforms", gpuType, uniforms);

        uniforms.clear();

    }

    int uniformLoc = 0;

    for (const auto& uparam : uniforms)

    {

        if(mGLSLVersion >= 430 && hasSSO)

        {

            os << "layout(location = " << uniformLoc << ") ";

            auto esize = GpuConstantDefinition::getElementSize(uparam->getType(), true) / 4;

            uniformLoc += esize * std::max<int>(uparam->getSize(), 1);

        }

        os << "uniform\t";

        if(mIsGLSLES)

            os << "highp\t"; // force highp to avoid precision mismatch between VP/ FP

        writeParameter(os, uparam);

        os << ";\n";

    }

    os << std::endl;

    Function* curFunction = program->getMain();

    const ShaderParameterList& inParams = curFunction->getInputParameters();

    writeFunctionTitle(os, curFunction);

    // Write inout params and fill mInputToGLStatesMap

    writeInputParameters(os, curFunction, gpuType);

    writeOutParameters(os, curFunction, gpuType);

    // The function name must always main.

    os << "void main(void) {" << std::endl;

    // Write local parameters.

    for (const auto& p : curFunction->getLocalParameters())

    {

        os << "\t";

        writeParameter(os, p);

        os << ";" << std::endl;

    }

    os << std::endl;

    for (const auto& pFuncInvoc : curFunction->getAtomInstances())

    {

        redirectGlobalWrites(os, pFuncInvoc, inParams, parameterList);

        for (auto& operand : pFuncInvoc->getOperandList())

        {

            const ParameterPtr& param = operand.getParameter();

            if (gpuType != GPT_VERTEX_PROGRAM || param->getSemantic() != Parameter::SPS_TEXTURE_COORDINATES)

                continue;

            bool isInputParam = std::find(inParams.begin(), inParams.end(), param) != inParams.end();

            // Now that every texcoord is a vec4 (passed as vertex attributes) we

            // have to swizzle them according the desired type.

            if (isInputParam)

                operand.setMaskToParamType();

        }

        os << "\t";

        pFuncInvoc->writeSourceCode(os, getTargetLanguage());

        os << std::endl;

    }

    os << "}" << std::endl;

    os << std::endl;

}

//-----------------------------------------------------------------------

void GLSLProgramWriter::writeInputParameters(std::ostream& os, Function* function, GpuProgramType gpuType)

{

    int psInLocation = 0;

    for (const auto& p : function->getInputParameters())

    {

        auto paramContent = p->getContent();

        auto paramSemantic = p->getSemantic();

        const String& paramName = p->getName();

        if (gpuType == GPT_FRAGMENT_PROGRAM)

        {

            if(paramContent == Parameter::SPC_POINTSPRITE_COORDINATE)

            {

                p->_rename("gl_PointCoord");

                continue;

            }

            else if(paramContent == Parameter::SPC_POINTSPRITE_SIZE)

            {

                // injected by matchVStoPSInterface, but only available in VS

                continue;

            }

            else if(paramSemantic == Parameter::SPS_LAYER)

            {

                p->_rename("gl_Layer");

                continue;

            }

            else if(paramSemantic == Parameter::SPS_POSITION)

            {

                p->_rename("gl_FragCoord");

                continue;

            }

            else if(paramSemantic == Parameter::SPS_FRONT_FACING)

            {

                p->_rename("gl_FrontFacing");

                continue;

            }

            os << "IN(";

            if(p->isHighP())

                os << "f32"; // rely on unified shader vor f32vec4 etc.

            os << mGpuConstTypeMap[p->getType()];

            os << "\t";

            os << paramName;

            os << ", " << psInLocation++ << ")\n";

        }

        else if (gpuType == GPT_VERTEX_PROGRAM)

        {

            // Due the fact that glsl does not have register like cg we have to rename the params

            if(paramSemantic == Parameter::SPS_TEXTURE_COORDINATES)

                p->_rename(StringUtil::format("uv%d", p->getIndex()));

            else if(paramContent == Parameter::SPC_COLOR_SPECULAR)

                p->_rename("secondary_colour");

            else

                p->_rename(mParamSemanticToNameMap[paramSemantic]);

            os << "IN(";

            // all uv texcoords passed by ogre are at least vec4

            if ((paramSemantic == Parameter::SPS_TEXTURE_COORDINATES) && (p->getType() < GCT_FLOAT4))

            {

                os << "vec4";

            }

            else

            {

                // the gl rendersystems only pass float attributes

                GpuConstantType type = p->getType();

                if(!mIsVulkan && !GpuConstantDefinition::isFloat(type))

                    type = GpuConstantType(type & ~GpuConstantDefinition::getBaseType(type));

                os << mGpuConstTypeMap[type];

            }

            os << "\t";

            os << p->getName() << ", ";

            writeParameterSemantic(os, p);  // maps to location

            os << ")\n";

        }

    }

}

//-----------------------------------------------------------------------

void GLSLProgramWriter::writeOutParameters(std::ostream& os, Function* function, GpuProgramType gpuType)

{

    const ShaderParameterList& outParams = function->getOutputParameters();

    int vsOutLocation = 0;

    for (const auto& p : outParams)

    {

        if(gpuType == GPT_VERTEX_PROGRAM)

        {

            // GLSL vertex program has to write always gl_Position (but this is also deprecated after version 130)

            if(p->getSemantic() == Parameter::SPS_POSITION)

            {

                p->_rename("gl_Position");

            }

            else if(p->getContent() == Parameter::SPC_POINTSPRITE_SIZE)

            {

                p->_rename("gl_PointSize");

            }

            else if(p->getSemantic() == Parameter::SPS_LAYER)

            {

                p->_rename("gl_Layer");

            }

            else

            {

                os << "OUT(";

                writeParameter(os, p);

                os << ", " << vsOutLocation++ << ")\n";

            }

        }

        else if(gpuType == GPT_FRAGMENT_PROGRAM &&

                p->getSemantic() == Parameter::SPS_COLOR)

        {

            if(p->getIndex() == 0)

            {

                // handled by UnifiedShader

                p->_rename("gl_FragColor");

                continue;

            }

            os << "OUT(vec4\t" << p->getName() << ", " << p->getIndex() << ")\n";

        }

    }

}

//-----------------------------------------------------------------------

}

}