DtIndirectGlTextureObjectManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2023 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once
#include <vrvOsg/vrvOsg.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvMath/DtVector2.h>

#include <boost/thread/mutex.hpp>

#include <map>
#include <unordered_map>
#include <unordered_set>

namespace makVrv
{
   class DtDe;
   class DtMeifConverter;
   class DtIndirectDefaultTexturesContainer;
   class DtIndirectLimitTextureStrategy;
   class DtIndirectTextureLimitAdjustedMipMap;
   class DtIndirectLog;
   class DtIndirectTextureResidencyManager;
   class DtIndirectTexturePrototype;
   class DtIndirectImagePrototype;
   class DtIndirectGlTextureObject;
   class DtIndirectImagePrototypeManager;

   enum DtIndirectGlTextureObjectStatus
   {
      LOADED = 0, LOADING = 1, FAILED = 2, UNKNOWN = 3
   };

   class DtIndirectGlTextureObjectResult
   {
   public:
      DtIndirectGlTextureObject* myIndirectGlTextureObject = nullptr;
      DtIndirectGlTextureObjectStatus myLoadStatus = UNKNOWN;
      bool myCreated = false;
   };

   class DtIndirectGlTextureObject;

   class DT_DLL_VRVOSG DtIndirectGlTextureObjectManager : public DtVirtualBaseClass
   {
   public:
      static DtIndirectGlTextureObjectManager& instance(DtDe& de);

      virtual ~DtIndirectGlTextureObjectManager();

      DtIndirectGlTextureObjectManager() = delete;
      DtIndirectGlTextureObjectManager& operator=(const DtIndirectGlTextureObjectManager& rhs) = delete;
      DtIndirectGlTextureObjectManager(const DtIndirectGlTextureObjectManager& rhs) = delete;

   public:
      virtual DtIndirectGlTextureObjectResult getOrCreate(const DtIndirectTexturePrototype* vrvTexture, int textureLimitStrategy);

      virtual DtIndirectGlTextureObject* get(const DtIndirectTexturePrototype* vrvTexture);

      virtual bool has(unsigned int textureId) const;

      // When this is called:
      //  -the entry is added to the internal residency manager for making this texture non-resident in all contexts.
      //  -the entry is removed. (this also makes it so, that queries for vrvTexture that used to return this texture
      //   , will cause an entirely new texture object to be created)
      virtual bool removeEntry(DtIndirectGlTextureObject* indirectGlTextureObject);

      virtual unsigned int outOfMemoryTextureId(void) const;

      virtual DtVector2<int> seenImageSize(const std::string& imageFileAbsolutePath) const;

      virtual void run(unsigned int frameNumber);

      virtual std::unordered_set<DtIndirectGlTextureObject*>& texturesSet(void);

      virtual void printStatsWhenNoWindows(void);

   protected:
      DtIndirectGlTextureObjectManager(DtDe& de);

   protected:
      virtual unsigned int createCompressedGlTexture2d(const DtIndirectTexturePrototype* vrvTexture, const DtIndirectImagePrototype* vrvImage
         , const DtIndirectLimitTextureStrategy& indirectLimitTextureStrategy
         , bool regularPath
         , bool& aboveCutoff) const;

      virtual unsigned int createUnCompressedGlTexture2d(const DtIndirectTexturePrototype* vrvTexture, const DtIndirectImagePrototype* vrvImage
         , const DtIndirectLimitTextureStrategy& indirectLimitTextureStrategy) const;

      virtual unsigned int createGlTexture2dArray(const DtIndirectTexturePrototype* vrvTexture) const;

      virtual unsigned int createGlTexture3D(const DtIndirectTexturePrototype* vrvTexture) const;

      virtual void setupWrapFilteringAndAniso(unsigned int textureId, const DtIndirectTexturePrototype* vrvTexture) const;

      virtual bool textureWillPutMemoryAboveCutoff(int sizeOfTextureInBytes) const;

      virtual DtIndirectLimitTextureStrategy* limitTextureStrategy(int strategyType);

   protected:
      DtDe& myDe;

      DtSignalConnectionManager myConnections;

      std::unordered_map<const DtIndirectTexturePrototype*, DtIndirectGlTextureObject*> myTexturePrototypeToObject;
      std::unordered_map<DtIndirectGlTextureObject*, const DtIndirectTexturePrototype* > myTextureObjectToPrototype;

      std::unordered_map<unsigned int, DtIndirectGlTextureObject*> myIdToGlTextures;

      std::unordered_set<DtIndirectGlTextureObject*> mySetIndirectGlTextureObjects;

      boost::mutex myMutex;

      DtMeifConverter* myImageCompressor;

      int myOutOfMemoryTextureId;

      DtIndirectDefaultTexturesContainer& myDefaultTexturesContainer;

      static const std::string theClassName;

      std::unordered_map<std::string, DtVector2<int> > mySeenImages;

      DtIndirectLimitTextureStrategy* myNoLimitStrategy;
      DtIndirectLimitTextureStrategy& myTerrainLimitTextureStrategy;

      DtIndirectLog& myIndirectLog;

      DtIndirectTextureResidencyManager* myIndirectTextureResidencyManager;

      DtIndirectImagePrototypeManager& myImagePrototypeManager;
   };
}