OgreShaderProgramProcessor.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
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.
-----------------------------------------------------------------------------
*/
#ifndef _ShaderProgramProcessor_
#define _ShaderProgramProcessor_

#include "OgreShaderPrerequisites.h"
#include "OgreShaderParameter.h"
#include "OgreShaderFunctionAtom.h"


namespace Ogre {
namespace RTShader {

class _OgreRTSSExport ProgramProcessor : public RTShaderSystemAlloc
{

// Interface.
public: 

    ProgramProcessor();

    virtual ~ProgramProcessor();

    virtual const String& getTargetLanguage() const = 0;
    
    virtual bool preCreateGpuPrograms(ProgramSet* programSet) = 0;

    virtual bool postCreateGpuPrograms(ProgramSet* programSet) = 0;
 
// Protected types.
protected:
    
    //-----------------------------------------------------------------------------
    // Class that holds merge parameter information.
    class _OgreRTSSExport MergeParameter 
    {
    // Interface.
    public:
        MergeParameter();


        void clear();
        
        void addSourceParameter(ParameterPtr srcParam, int mask);

        size_t getSourceParameterCount() const { return mSrcParameterCount; }

        ParameterPtr getSourceParameter(unsigned int index) { return mSrcParameter[index]; }

        int getSourceParameterMask(unsigned int index) const { return mSrcParameterMask[index]; }

        int getDestinationParameterMask(unsigned int index) const { return mDstParameterMask[index]; }

        int getUsedFloatCount();
        
        ParameterPtr getDestinationParameter(int usage, int index);

    protected:
    
        void createDestinationParameter(int usage, int index);


    protected:
        // Destination merged parameter.
        ParameterPtr mDstParameter;
        // Source parameters - 4 source at max 1,1,1,1 -> 4.
        ParameterPtr mSrcParameter[4];
        // Source parameters mask. OPM_ALL means all fields used, otherwise it is split source parameter.
        int mSrcParameterMask[4];
        // Destination parameters mask. OPM_ALL means all fields used, otherwise it is split source parameter.
        int mDstParameterMask[4];
        // The actual source parameters count.
        size_t mSrcParameterCount;
        // The number of used floats.
        int mUsedFloatCount;
    };
    typedef vector<MergeParameter>::type    MergeParameterList;

    
    //-----------------------------------------------------------------------------
    // A struct that defines merge parameters combination.
    struct _OgreRTSSExport MergeCombination
    {       
        // The count of each source type. I.E (1 FLOAT1, 0 FLOAT2, 1 FLOAT3, 0 FLOAT4).
        size_t srcParameterTypeCount[4];
        // Source parameters mask. OPM_ALL means all fields used, otherwise it is split source parameter.
        int srcParameterMask[4];

        MergeCombination(
            int float1Count, int float1Mask,
            int float2Count, int float2Mask,
            int float3Count, int float3Mask,
            int float4Count, int float4Mask)
        {
            srcParameterTypeCount[0] = float1Count;
            srcParameterTypeCount[1] = float2Count;
            srcParameterTypeCount[2] = float3Count;
            srcParameterTypeCount[3] = float4Count;
            srcParameterMask[0]     = float1Mask;
            srcParameterMask[1]     = float2Mask;
            srcParameterMask[2]     = float3Mask;
            srcParameterMask[3]     = float4Mask;

        }
    };
    typedef vector<MergeCombination>::type  MergeCombinationList;

    //-----------------------------------------------------------------------------
    typedef vector<Operand*>::type                      OperandPtrVector;
    typedef map<Parameter*, OperandPtrVector>::type     ParameterOperandMap;
    typedef map<Parameter*, ParameterPtr>::type         LocalParameterMap;

protected:

    void buildMergeCombinations();

    virtual bool compactVsOutputs(Function* vsMain, Function* fsMain);

    void countVsTexcoordOutputs(Function* vsMain, int& outTexCoordSlots, int& outTexCoordFloats);

    void buildTexcoordTable(const ShaderParameterList& paramList, ShaderParameterList outParamsTable[4]);


    void mergeParameters(ShaderParameterList paramsTable[4], MergeParameterList& mergedParams, ShaderParameterList& splitParams);


    void mergeParametersByPredefinedCombinations(ShaderParameterList paramsTable[4], MergeParameterList& mergedParams);

    bool mergeParametersByCombination(const MergeCombination& combination, ShaderParameterList paramsTable[4], 
                                                                 MergeParameter* mergedParameter);

    void mergeParametersReminders(ShaderParameterList paramsTable[4], MergeParameterList& mergedParams, ShaderParameterList& splitParams);


    void generateLocalSplitParameters(Function* func, GpuProgramType progType, MergeParameterList& mergedParams, ShaderParameterList& splitParams, LocalParameterMap& localParamsMap);
    
    void rebuildParameterList(Function* func, int paramsUsage, MergeParameterList& mergedParams);

    void rebuildFunctionInvocations(FunctionAtomInstanceList& funcAtomList, MergeParameterList& mergedParams, LocalParameterMap& localParamsMap);

    void buildParameterReferenceMap(FunctionAtomInstanceList& funcAtomList, ParameterOperandMap& paramsRefMap);

    void replaceParametersReferences(MergeParameterList& mergedParams, ParameterOperandMap& paramsRefMap);

    void replaceSplitParametersReferences(LocalParameterMap& localParamsMap, ParameterOperandMap& paramsRefMap);

    static int getParameterFloatCount(GpuConstantType type);        

    static int getParameterMaskByType(GpuConstantType type);
    
    static int getParameterMaskByFloatCount(int floatCount);
    
    void bindAutoParameters(Program* pCpuProgram, GpuProgramPtr pGpuProgram);

protected:
    // Merging combinations defs.
    MergeCombinationList mParamMergeCombinations;
    // Maximum texcoord slots.
    int mMaxTexCoordSlots;
    // Maximum texcoord floats count.
    int mMaxTexCoordFloats;
    map<Function *, String *>::type  mFunctionMap;           // Map between function signatures and source code

};


}
}

#endif