/*

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

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 __GpuProgramManager_H_

#define __GpuProgramManager_H_

// Precompiler options

#include "OgrePrerequisites.h"

#include "OgreResourceManager.h"

#include "OgreGpuProgram.h"

#include "OgreSingleton.h"

#include "OgreHeaderPrefix.h"

namespace Ogre {

    /** \addtogroup Core

    *  @{

    */

    /** \addtogroup Resources

    *  @{

    */

    /** Interface definition for factories of GpuProgram. */

    class _OgreExport GpuProgramFactory : public FactoryAlloc

    {

    public:

        virtual ~GpuProgramFactory() {}

        /// Get the name of the language this factory creates programs for

        virtual const String& getLanguage(void) const = 0;

        virtual GpuProgram* create(ResourceManager* creator, const String& name, ResourceHandle handle,

                                   const String& group, bool isManual, ManualResourceLoader* loader) = 0;

        virtual void destroy(GpuProgram* prog) { delete prog; }

    };

    /** This ResourceManager manages GPU shader programs

        This class not only manages the programs themselves, it also manages the factory

        classes which allow the creation of programs using a variety of

        syntaxes. Plugins can be created which register themselves as program

        factories and as such the engine can be extended to accept virtually any kind of

        program provided a plugin is written.

    */

    class _OgreExport GpuProgramManager : public ResourceManager, public Singleton<GpuProgramManager>

    {

        // silence warnings

        using ResourceManager::load;

        /// Factories capable of creating GpuProgram instances

        typedef std::map<String, GpuProgramFactory*> FactoryMap;

        FactoryMap mFactories;

        /// Factory for dealing with programs for languages we can't create

        std::unique_ptr<GpuProgramFactory> mNullFactory;

        /// Factory for unified high-level programs

        std::unique_ptr<GpuProgramFactory> mUnifiedFactory;

        GpuProgramFactory* getFactory(const String& language);

    public:

        typedef std::set<String> SyntaxCodes;

        typedef std::map<String, GpuSharedParametersPtr> SharedParametersMap;

        typedef MemoryDataStreamPtr Microcode;

    protected:

        SharedParametersMap mSharedParametersMap;

        std::map<uint32, Microcode> mMicrocodeCache;

        bool mSaveMicrocodesToCache;

        bool mCacheDirty;           // When this is true the cache is 'dirty' and should be resaved to disk.

        static String addRenderSystemToName( const String &  name );

        /// Generic create method

        Resource* createImpl(const String& name, ResourceHandle handle,

            const String& group, bool isManual, ManualResourceLoader* loader,

            const NameValuePairList* createParams) override;

    public:

        GpuProgramManager();

        virtual ~GpuProgramManager();

        /// Get a GPU Program by name. For example, a GPU Program defined in some .program file.

        /// @see GpuProgramManager::getResourceByName

        GpuProgramPtr getByName(const String& name, const String& group OGRE_RESOURCE_GROUP_INIT) const;

        /// @deprecated preferHighLevelPrograms has no effect

        OGRE_DEPRECATED GpuProgramPtr getByName(const String& name, const String& group,

                                                bool preferHighLevelPrograms) const

        {

            return getByName(name, group);

        }

        /** Loads a GPU program from a file

            This method creates a new program of the type specified as the second parameter.

            As with all types of ResourceManager, this class will search for the file in

            all resource locations it has been configured to look in.

        @param name The name of the GpuProgram

        @param groupName The name of the resource group

        @param filename The file to load

        @param gptype The type of program to create

        @param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

        */

        virtual GpuProgramPtr load(const String& name, const String& groupName, 

            const String& filename, GpuProgramType gptype, 

            const String& syntaxCode);

        /** Loads a GPU program from a string

            The assembly code must be compatible with this manager - call the 

            getSupportedSyntax method for details of the supported syntaxes 

        @param name The identifying name to give this program, which can be used to

            retrieve this program later with getByName.

        @param groupName The name of the resource group

        @param code A string of assembly code which will form the program to run

        @param gptype The type of program to create.

        @param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

        */

        virtual GpuProgramPtr loadFromString(const String& name, const String& groupName,

            const String& code, GpuProgramType gptype,

            const String& syntaxCode);

        /** Returns the syntaxes that the RenderSystem supports. */

        static const SyntaxCodes& getSupportedSyntax(void);

        /** Returns whether a given syntax code (e.g. "glsl330", "vs_4_0", "arbvp1") is supported. */

        static bool isSyntaxSupported(const String& syntaxCode);

        /** Returns whether a given high-level language (e.g. "glsl", "hlsl") is supported. */

        bool isLanguageSupported(const String& lang) const;

        /** Creates a new GpuProgramParameters instance which can be used to bind

            parameters to your programs.

            Program parameters can be shared between multiple programs if you wish.

        */

        static GpuProgramParametersPtr createParameters(void) { return std::make_shared<GpuProgramParameters>(); }

        /** Create a new, unloaded GpuProgram from a file of assembly. 

            Use this method in preference to the 'load' methods if you wish to define

            a GpuProgram, but not load it yet; useful for saving memory.

        @par

            This method creates a new program of the type specified as the second parameter.

            As with all types of ResourceManager, this class will search for the file in

            all resource locations it has been configured to look in. 

        @param name The name of the program

        @param groupName The name of the resource group

        @param filename The file to load

        @param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

        @param gptype The type of program to create

        */

        virtual GpuProgramPtr createProgram(const String& name, 

            const String& groupName, const String& filename, 

            GpuProgramType gptype, const String& syntaxCode);

        /** Create a GPU program from a string of assembly code.

            Use this method in preference to the 'load' methods if you wish to define

            a GpuProgram, but not load it yet; useful for saving memory.

        @par

            The assembly code must be compatible with this manager - call the 

            getSupportedSyntax method for details of the supported syntaxes 

        @param name The identifying name to give this program, which can be used to

            retrieve this program later with getByName.

        @param groupName The name of the resource group

        @param code A string of assembly code which will form the program to run

        @param gptype The type of program to create.

        @param syntaxCode The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

        */

        virtual GpuProgramPtr createProgramFromString(const String& name, 

            const String& groupName, const String& code, 

            GpuProgramType gptype, const String& syntaxCode);

        /** General create method, using specific create parameters

            instead of name / value pairs. 

        */

        GpuProgramPtr create(const String& name, const String& group,

            GpuProgramType gptype, const String& language, bool isManual = false,

            ManualResourceLoader* loader = 0);

        /** Create a new, unloaded GpuProgram.

        @par

            This method creates a new program of the type specified as the second and third parameters.

            You will have to call further methods on the returned program in order to

            define the program fully before you can load it.

        @param name The identifying name of the program

        @param groupName The name of the resource group which this program is

            to be a member of

        @param language Code of the language to use (e.g. "cg")

        @param gptype The type of program to create

        */

        GpuProgramPtr createProgram(const String& name, const String& groupName, const String& language,

                                    GpuProgramType gptype)

        {

            return create(name, groupName, gptype, language);

        }

        /** Create a new set of shared parameters, which can be used across many 

            GpuProgramParameters objects of different structures.

        @param name The name to give the shared parameters so you can refer to them

            later.

        */

        virtual GpuSharedParametersPtr createSharedParameters(const String& name);

        /** Retrieve a set of shared parameters, which can be used across many 

        GpuProgramParameters objects of different structures.

        */

        virtual GpuSharedParametersPtr getSharedParameters(const String& name) const;

        /** Get (const) access to the available shared parameter sets. 

        */

        virtual const SharedParametersMap& getAvailableSharedParameters() const;

        /** Get if the microcode of a shader should be saved to a cache

        */

        bool getSaveMicrocodesToCache() const;

        /** Set if the microcode of a shader should be saved to a cache

        */

        void setSaveMicrocodesToCache( bool val );

        /** Returns true if the microcodecache changed during the run.

        */

        bool isCacheDirty(void) const;

        static bool canGetCompiledShaderBuffer();

        /** Check if a microcode is available for a program in the microcode cache.

        @param id The id of the program.

        */

        bool isMicrocodeAvailableInCache(uint32 id) const;

        /** Returns a microcode for a program from the microcode cache.

        @param id The name of the program.

        */

        const Microcode& getMicrocodeFromCache(uint32 id) const;

        /** Creates a microcode to be later added to the cache.

        @param size The size of the microcode in bytes

        */

        static Microcode createMicrocode(size_t size) { return std::make_shared<MemoryDataStream>(size); }

        /** Adds a microcode for a program to the microcode cache.

        @param id The id of the program

        @param microcode the program binary

        */

        void addMicrocodeToCache(uint32 id, const Microcode& microcode);

        /** Removes a microcode for a program from the microcode cache.

        @param id The name of the program.

        */

        void removeMicrocodeFromCache(uint32 id);

        /** Saves the microcode cache to disk.

        @param stream The destination stream

        */

        void saveMicrocodeCache( const DataStreamPtr& stream ) const;

        /** Loads the microcode cache from disk.

        @param stream The source stream

        */

        void loadMicrocodeCache( const DataStreamPtr& stream );

        /** Add a new factory object for programs of a given language. */

        void addFactory(GpuProgramFactory* factory);

        /** Remove a factory object for programs of a given language. */

        void removeFactory(GpuProgramFactory* factory);

        /// @copydoc Singleton::getSingleton()

        static GpuProgramManager& getSingleton(void);

        /// @copydoc Singleton::getSingleton()

        static GpuProgramManager* getSingletonPtr(void);

    };

    /** @} */

    /** @} */

}

#include "OgreHeaderSuffix.h"

#endif