urho3d/Engine/Graphics/Shader.cpp

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// 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 "Precompiled.h"
#include "Context.h"
#include "Deserializer.h"
#include "Graphics.h"
#include "GraphicsImpl.h"
#include "Log.h"
#include "Profiler.h"
#include "Shader.h"
#include "ShaderProgram.h"

/// Shader parameter structure for loading
struct Parameter
{
    /// Parameter name
    String name_;
    /// Constant register or sampler
    unsigned register_;
};

OBJECTTYPESTATIC(Shader);

Shader::Shader(Context* context) :
    Resource(context),
    shaderType_(VS),
    isSM3_(false)
{
}

Shader::~Shader()
{
}

void Shader::RegisterObject(Context* context)
{
    context->RegisterFactory<Shader>();
}

bool Shader::Load(Deserializer& source)
{
    PROFILE(LoadShader);
    
    variations_.Clear();
    
    Graphics* graphics = GetSubsystem<Graphics>();
    if (!graphics)
        return false;
    
    // Check ID
    if (source.ReadID() != "USHD")
    {
        LOGERROR(source.GetName() + " is not a valid shader file");
        return false;
    }
    
    shaderType_ = (ShaderType)source.ReadShort();
    isSM3_ = (source.ReadShort() == 3);
    
    Vector<Parameter> parameters;
    Vector<Parameter> textureUnits;
    
    // Read the parameters and texture units used by this shader; use information is specified in terms of them
    unsigned numParameters = source.ReadUInt();
    for (unsigned i = 0; i < numParameters; ++i)
    {
        Parameter newParameter;
        newParameter.name_ = source.ReadString();
        newParameter.register_ = source.ReadUByte();
        parameters.Push(newParameter);
        
        ShaderParameter paramIndex = graphics->GetShaderParameter(newParameter.name_);
        if (paramIndex != MAX_SHADER_PARAMETERS)
            graphics->SetShaderRegister(paramIndex, newParameter.register_);
        else
            LOGWARNING("Unknown shader parameter " + newParameter.name_);
    }
    
    unsigned numTextureUnits = source.ReadUInt();
    for (unsigned i = 0; i < numTextureUnits; ++i)
    {
        Parameter newTextureUnit;
        newTextureUnit.name_ = source.ReadString();
        newTextureUnit.register_ = source.ReadUByte();
        textureUnits.Push(newTextureUnit);
        
        TextureUnit tuIndex = graphics->GetTextureUnit(newTextureUnit.name_);
        if (tuIndex == MAX_TEXTURE_UNITS)
            LOGWARNING("Unknown texture unit " + newTextureUnit.name_);
    }
    
    // Read the variations
    unsigned numVariations = source.ReadUInt();
    for (unsigned i = 0; i < numVariations; ++i)
    {
        SharedPtr<ShaderProgram> variation(new ShaderProgram(this, shaderType_, isSM3_));
        variation->SetName(source.ReadString());
        
        // Fill the parameter & texture unit use information
        for (unsigned j = 0; j < numParameters; ++j)
        {
            if (source.ReadBool())
            {
                ShaderParameter paramIndex = graphics->GetShaderParameter(parameters[j].name_);
                if (paramIndex != MAX_SHADER_PARAMETERS)
                    variation->SetUseParameter(paramIndex, true);
            }
        }
        
        for (unsigned j = 0; j < numTextureUnits; ++j)
        {
            if (source.ReadBool())
            {
                TextureUnit tuIndex = graphics->GetTextureUnit(textureUnits[j].name_);
                if (tuIndex != MAX_TEXTURE_UNITS)
                    variation->SetUseTextureUnit(tuIndex, true);
            }
        }
        
        // Read the bytecode
        unsigned dataSize = source.ReadUInt();
        if (dataSize)
        {
            SharedArrayPtr<unsigned char> byteCode(new unsigned char[dataSize]);
            source.Read(byteCode.GetPtr(), dataSize);
            variation->SetByteCode(byteCode);
        }
        
        // Store the variation
        variations_[StringHash(variation->GetName())] = variation;
    }
    
    // This is not exactly accurate, but a reasonable estimate
    SetMemoryUse(source.GetSize());
    return true;
}

ShaderProgram* Shader::GetVariation(const String& name)
{
    return GetVariation(StringHash(name));
}

ShaderProgram* Shader::GetVariation(StringHash nameHash)
{
    Map<StringHash, SharedPtr<ShaderProgram> >::Iterator i = variations_.Find(nameHash);
    if (i == variations_.End())
        return 0;
    ShaderProgram* variation = i->second_;
    
    // Create shader object now if not yet created. If fails, remove the variation
    if (!variation->GetGPUObject())
    {
        PROFILE(CreateShaderProgram);
        bool success = variation->Create();
        if (!success)
        {
            LOGERROR("Failed to create variation " + variation->GetName() + " of shader " + GetName());
            variations_.Erase(i);
            return 0;
        }
    }
    
    return variation;
}