// EMERGENT GAME TECHNOLOGIES PROPRIETARY INFORMATION
//
// This software is supplied under the terms of a license agreement or
// nondisclosure agreement with Emergent Game Technologies and may not 
// be copied or disclosed except in accordance with the terms of that 
// agreement.
//
//      Copyright (c) 1996-2007 Emergent Game Technologies.
//      All Rights Reserved.
//
// Emergent Game Technologies, Chapel Hill, North Carolina 27517
// http://www.emergent.net

#ifndef NSBSHADER_H
#define NSBSHADER_H

#include "NiBinaryShaderLibLibType.h"
#include "NSBAttributeTable.h"
#include "NSBObjectTable.h"
#include "NSBPackingDef.h"
#include "NSBImplementation.h"
#include "NSBUserDefinedDataSet.h"

#include <NiRefObject.h>
#include <NiSmartPointer.h>

class NiBinaryShader;
NiSmartPointer(NiShaderDesc);

class NIBINARYSHADERLIB_ENTRY NSBShader : public NiRefObject
{
protected:
    enum
    {
        MAGIC_NUMBER = 0x0062736E,  // NSB0
        // MMDDYY - version number change information
        // ------   -----------------------------------------------------------
        // 041003 - Bumped version number to 1.1 to reflect addition of
        //          UsesNiLightState requirement. (Shipped in 1.0.1)
        // 101403 - Bumped version to 1.2 to add shader targets, shader 
        //          entry points, and variable names
        // 102303 - Bumped version to 1.3 to add software vertex processing
        // 033004 - Bumped version to 1.4 to add streaming of 
        //          platform-specific constant map entries
        // 033104 - Bumped version to 1.5 to add streaming of a
        //          user-defined class name for implementations.
        // 010404 - Bumped version to 1.6 to add UserDefinedDataBlocks
        // 020404 - Bumped version to 1.7 to improve software vertex processing
        // 031505 - Bumped version to 1.8 to remove DX8 support
        // 031605 - Bumped version to 1.9 to add obj texture flags
        // 032805 - Bumped version to 1.10 to make NSB files endian-aware
        // 020806 - Bumped version to 1.11 to allow for NBT uv source spec.
        // 050106 - Bumped version to 1.12 to add PS3 support
        // 120106 - Bumped version to 1.13 to add D3D10 and geometry shader
        //          support.
        // 011607 - Bumped version to 1.14 to add separate NSBTexture objects.
        // 031907 - Bumped version to 1.15 to add shadow light object effect
        //          types.
        NSB_VERSION     = 0x00010015    // 1.15        
    };

public:
    NSBShader();
    ~NSBShader();

    // This will allow for customers to derived their own 
    // NiBinaryShader-based classes, allowing them to extend the 
    // functionality while still gaining the benefit of having the
    // default NSF parsing do the file handling.
    //
    // This is the prototype of the CreateNiBinaryShaderFunction
    typedef NiBinaryShader* (*CREATENIBINARYSHADER)(
        const char* pcClassName);

    static CREATENIBINARYSHADER SetCreateNiBinaryShaderCallback(
        CREATENIBINARYSHADER pfnCallback);
    static CREATENIBINARYSHADER GetCreateNiBinaryShaderCallback();
    
    static NiBinaryShader* DefaultCreateNiBinaryShader(
        const char* pcClassName);

    // Name
    const char* GetName();
    const char* GetDescription();

    // Shader Versions
    unsigned int GetMinVertexShaderVersion();
    unsigned int GetMaxVertexShaderVersion();
    unsigned int GetMinGeometryShaderVersion();
    unsigned int GetMaxGeometryShaderVersion();
    unsigned int GetMinPixelShaderVersion();
    unsigned int GetMaxPixelShaderVersion();
    unsigned int GetMinUserVersion();
    unsigned int GetMaxUserVersion();
    unsigned int GetPlatform();

    // Access to the attribute table
    NSBAttributeTable* GetGlobalAttributeTable();
    NSBAttributeTable* GetAttributeTable();
    // Access to the object table
    NSBObjectTable* GetObjectTable();
    // The packing definitions
    unsigned int GetPackingDefCount();
    NSBPackingDef* GetPackingDef(const char* pcName, bool bCreate = false);
    // The implementations
    unsigned int GetImplementationCount();
    NSBImplementation* GetImplementation(const char* pcName, 
        bool bCreate = false, unsigned int uiNextIndex = 0);
    NSBImplementation* GetImplementationByName(const char* pcName);
    NSBImplementation* GetImplementationByIndex(unsigned int uiIndex);

    void SetMinVertexShaderVersionRequest(unsigned int uiVersion);
    void SetMaxVertexShaderVersionRequest(unsigned int uiVersion);
    void SetMinGeometryShaderVersionRequest(unsigned int uiVersion);
    void SetMaxGeometryShaderVersionRequest(unsigned int uiVersion);
    void SetMinPixelShaderVersionRequest(unsigned int uiVersion);
    void SetMaxPixelShaderVersionRequest(unsigned int uiVersion);
    void SetMinUserVersionRequest(unsigned int uiVersion);
    void SetMaxUserVersionRequest(unsigned int uiVersion);
    void SetPlatformRequest(unsigned int uiPlatform);
    
    // Get the BINARY shader
    NiBinaryShader* GetD3DShader(NiD3DRenderer* pkRenderer, 
        unsigned int uiImplementation = NiShader::DEFAULT_IMPLEMENTATION);

    // *** begin Emergent internal use only
    // User defined data set
    NSBUserDefinedDataSet* GetUserDefinedDataSet();
    void SetUserDefinedDataSet(NSBUserDefinedDataSet* pkUDDSet);

    NiShaderDesc* GetShaderDesc();
    // These functions are used during the creation
    void SetName(const char* pcName);
    void SetDescription(const char* pcDescription);

    void AddVertexShaderVersion(unsigned int uiVersion);
    void AddGeometryShaderVersion(unsigned int uiVersion);
    void AddPixelShaderVersion(unsigned int uiVersion);
    void AddUserVersion(unsigned int uiVersion);
    void AddPlatform(unsigned int uiPlatformFlag);

    // By default, NSB shaders are saved to match the endianness of the
    // platform they are written out on (and can be loaded in on any
    // platform.)
    bool Save(const char* pcFilename, bool bSwapEndian = false);
    bool SaveBinary(NiBinaryStream& kStream, bool bSwapEndian = false);
    bool Load(const char* pcFilename);
    bool LoadBinary(NiBinaryStream& kStream);

    static unsigned int GetReadVersion();

#if defined(_DEBUG)
    void Dump();
#endif  //#if defined(_DEBUG)
    // *** end Emergent internal use only

protected:
    bool RegisterTextureStageGlobals(NiD3DRenderer* pkRenderer, 
        NSBImplementation* pkImplementation);
    bool ReleaseTextureStageGlobals(NiD3DRenderer* pkRenderer, 
        NSBImplementation* pkImplementation);

    NiBinaryShader* GetD3DShader_DX9(NiD3DRenderer* pkRenderer, 
        unsigned int uiImplementation);
    NiBinaryShader* GetD3DShader_Xenon(NiD3DRenderer* pkRenderer, 
        unsigned int uiImplementation);

    NSBImplementation* GetBestImplementation(NiD3DRenderer* pkRenderer);

    enum ValidityFlag
    {
        INVALID = 0,
        VALID = 1,
        VALID_REQUESTED = 2
    };

    class VersionInfo : public NiMemObject
    {
    public:
        unsigned int m_uiVS_Sys;
        unsigned int m_uiVS_Min;
        unsigned int m_uiVS_Req;
        unsigned int m_uiGS_Sys;
        unsigned int m_uiGS_Min;
        unsigned int m_uiGS_Req;
        unsigned int m_uiPS_Sys;
        unsigned int m_uiPS_Min;
        unsigned int m_uiPS_Req;
        unsigned int m_uiUser_Sys;
        unsigned int m_uiUser_Min;
        unsigned int m_uiUser_Req;
        unsigned int m_uiPlatform;
        bool m_bSoftwareVSCapable_Sys;
    };

    void SetupVersionInfo(NiD3DRenderer* pkRenderer, 
        VersionInfo& kVersionInfo);
    ValidityFlag IsImplementationValid(NSBImplementation* pkImplementation,
        VersionInfo& kVersionInfo);

    bool SaveBinaryPackingDefs(NiBinaryStream& kStream);
    bool LoadBinaryPackingDefs(NiBinaryStream& kStream);
    bool SaveBinaryImplementations(NiBinaryStream& kStream);
    bool LoadBinaryImplementations(NiBinaryStream& kStream);

    char* m_pcName;
    char* m_pcDescription;

    unsigned int m_uiMinVertexShaderVersionRequest;
    unsigned int m_uiMaxVertexShaderVersionRequest;
    unsigned int m_uiMinGeometryShaderVersionRequest;
    unsigned int m_uiMaxGeometryShaderVersionRequest;
    unsigned int m_uiMinPixelShaderVersionRequest;
    unsigned int m_uiMaxPixelShaderVersionRequest;
    unsigned int m_uiMinUserVersionRequest;
    unsigned int m_uiMaxUserVersionRequest;
    unsigned int m_uiPlatformRequest;

    unsigned int m_uiMinVertexShaderVersion;
    unsigned int m_uiMaxVertexShaderVersion;
    unsigned int m_uiMinGeometryShaderVersion;
    unsigned int m_uiMaxGeometryShaderVersion;
    unsigned int m_uiMinPixelShaderVersion;
    unsigned int m_uiMaxPixelShaderVersion;
    unsigned int m_uiMinUserVersion;
    unsigned int m_uiMaxUserVersion;
    unsigned int m_uiPlatform;

    // User defined data set
    NSBUserDefinedDataSetPtr m_spUserDefinedDataSet;

    NSBAttributeTable m_kGlobalAttribTable;
    NSBAttributeTable m_kAttribTable;
    NSBObjectTable m_kObjectTable;
    NiTStringPointerMap<NSBPackingDef*> m_kPackingDefMap;
    NiTPrimitiveArray<NSBImplementation*> m_kImplementationArray;

    NiShaderDescPtr m_spShaderDesc;

    static unsigned int ms_uiReadVersion;
    static CREATENIBINARYSHADER ms_pfnCreateNiBinaryShader;
};

typedef NiPointer<NSBShader> NSBShaderPtr;

#include "NSBShader.inl"

#endif  //NSBSHADER_H