add IAnimationBlendManager

Author: devshgraphicsprogramming

include/nbl/asset/IAnimationLibrary.h

@@ -23,7 +23,10 @@ template <class BufferType>
 class IAnimationLibrary : public virtual core::IReferenceCounted
 {
 	public:
+		using keyframe_t = uint32_t;
+		using animation_t = uint32_t;
 		using timestamp_t = uint32_t;
+
 		struct alignas(8) Keyframe
 		{
 				Keyframe() : scale(0ull) // TODO: initialize scale to 1.f
@@ -71,14 +74,14 @@ class IAnimationLibrary : public virtual core::IReferenceCounted
 				{
 					data[0] = data[1] = 0xffffffffu;
 				}
-				inline Animation(const uint32_t keyframeOffset, const uint32_t keyframeCount, const E_INTERPOLATION_MODE interpolation)
+				inline Animation(const keyframe_t keyframeOffset, const uint32_t keyframeCount, const E_INTERPOLATION_MODE interpolation)
 				{
 					data[0] = keyframeOffset;
 					assert(keyframeCount<0x4fffffffu);
 					data[1] = keyframeCount|interpolation;
 				}
 
-				inline uint32_t getKeyframeOffset() const
+				inline keyframe_t getKeyframeOffset() const
 				{
 					return data[0];
 				}
@@ -121,7 +124,7 @@ class IAnimationLibrary : public virtual core::IReferenceCounted
 			return m_animationStorageRange.size/sizeof(Animation);
 		}
 
-		inline uint32_t getAnimationOffsetFromName(const char* animationName) const
+		inline animation_t getAnimationOffsetFromName(const char* animationName) const
 		{
 			m_temporaryString = animationName;
 			auto found = m_nameToAnimation.find(0xffffffffu);
@@ -217,7 +220,7 @@ class IAnimationLibrary : public virtual core::IReferenceCounted
 		};
 		core::vector<char> m_stringPool;
 		mutable const char* m_temporaryString;
-		core::map<uint32_t,uint32_t,StringComparator> m_nameToAnimation;
+		core::map<uint32_t,animation_t,StringComparator> m_nameToAnimation;
 
 		SBufferBinding<BufferType> m_keyframeStorageBinding,m_timestampStorageBinding;
 		SBufferRange<BufferType> m_animationStorageRange;

include/nbl/scene/IAnimationBlendManager.h

@@ -0,0 +1,91 @@
+// Copyright (C) 2019 - DevSH Graphics Programming Sp. z O.O.
+// For conditions of distribution and use, see copyright notice in nabla.h
+// See the original file in irrlicht source for authors
+
+#ifndef __NBL_SCENE_I_ANIMATION_BLEND_MANAGER_H_INCLUDED__
+#define __NBL_SCENE_I_ANIMATION_BLEND_MANAGER_H_INCLUDED__
+
+#include "nbl/core/core.h"
+#include "nbl/video/video.h"
+
+#include "nbl/scene/ITransformTreeManager.h"
+
+namespace nbl
+{
+namespace scene
+{
+
+class IAnimationBlendManager : public virtual core::IReferenceCounted
+{
+	public:
+		using blend_t = uint32_t;
+
+		// creation (TODO: should we support adding and removing animation libraries at runtime?)
+        static inline core::smart_refctd_ptr<ITransformTreeManager> create(video::IVideoDriver* _driver, core::smart_refctd_ptr<video::IGPUAnimationLibrary>&& _animationLibrary)
+        {
+			if (true) // TODO: some checks and validation before creating?
+				return nullptr;
+
+			auto* abm = new IAnimationBlendManager(_driver,std::move(_animationLibrary));
+            return core::smart_refctd_ptr<IAnimationBlendManager>(abm,core::dont_grab);
+        }
+
+		// TODO: we should probably group blends of different update frequencies separately
+		void registerBlends(blend_t* blendsOut)
+		{
+			// TODO: register animation blends as <video::IGPUAnimationLibrary::animation_t,<updateFrequency,finishAndPause/finish/loop/<pingpongCurrFWD,pingpongCurrBWD>>,target node_t> (use a pool allocator) 
+		}
+
+		// add to a contiguous list in GPU memory
+		void startBlends(const blend_t* begin, const blend_t* end)
+		{
+			// easy enough, just add the uints to the back of a GPU buffer and increment the counter used in dispatch indirect buffer
+		}
+		// remove from a contiguous list in GPU memory
+		void pauseBlends(const blend_t* begin, const blend_t* end)
+		{
+		}
+
+		//
+		void seekBlends(const blend_t* begin, const blend_t* end, const ITransformTreeManager::timestamp_t* timestamps)
+		{
+		}
+
+		// need to pause the blends first
+		void deregisterBlends(const blend_t* begin, const blend_t* end)
+		{
+		}
+
+		void computeBlends(ITransformTreeManager::timestamp_t newTimestamp,
+			const asset::SBufferBinding<video::IGPUBuffer>& relativeTformUpdateIndirectParameters,
+			const asset::SBufferBinding<video::IGPUBuffer>& nodeIDBuffer, // first uint in the nodeIDBuffer is used to denote how many requests we have
+			const asset::SBufferBinding<video::IGPUBuffer>& modificationRequestBuffer,
+			const asset::SBufferBinding<video::IGPUBuffer>& modificationRequestTimestampBuffer)
+		{
+			m_driver->bindComputePipeline(m_computeBlendsPipeline.get());
+			// TODO: bind descriptor sets
+			m_driver->dispatchIndirect(m_dispatchIndirectCommandBuffer.get(),0u);
+			// TODO: pipeline barrier for SSBO and TBO and COMMAND_BIT too
+		}
+	protected:
+		IAnimationBlendManager(video::IVideoDriver* _driver, core::smart_refctd_ptr<video::IGPUAnimationLibrary>&& _animationLibrary) : m_driver(_driver), m_animationLibrary(std::move(_animationLibrary))
+		{
+		}
+		~IAnimationBlendManager()
+		{
+			// everything drops itself automatically
+		}
+
+		video::IVideoDriver* m_driver;
+		core::smart_refctd_ptr<video::IGPUAnimationLibrary> m_animationLibrary;
+		core::smart_refctd_ptr<video::IGPUComputePipeline> m_computeBlendsPipeline;
+		core::smart_refctd_ptr<video::IGPUDescriptorSet> m_animationDS; // animation library (keyframes + animations) + registered blends + active blends
+		core::smart_refctd_ptr<video::IGPUBuffer> m_dispatchIndirectCommandBuffer;
+};
+
+
+} // end namespace scene
+} // end namespace nbl
+
+#endif
+

include/nbl/scene/ITransformTreeManager.h

@@ -211,6 +211,11 @@ class ITransformTreeManager : public virtual core::IReferenceCounted
 		core::smart_refctd_ptr<property_pool_t> m_nodeStorage;
 		core::smart_refctd_ptr<video::IGPUComputePipeline> m_updatePipeline,m_recomputePipeline,m_updateAndRecomputePipeline;
 		core::smart_refctd_ptr<video::IGPUDescriptorSet> m_transformHierarchyDS;
+		// TODO: do we keep a contiguous `node_t` array in-case we want to shortcut to full tree reevaluation when the number of relative transform modification requsts > totalNodes*ratio (or overflows the temporary buffer we've provided) ?
+		/** Ideal O(1) insertion and erasure
+		* Add: new nodes using pool allocator, add the node_t references to the back of the contiguous array (increment atomic) and record where the reference is (offset into contiguous) as an additional property of the node
+		* Remove: lookup the contiguous offset property for the removed node, decremenet contiguous array size atomic and save the return value as the reference to be swapped, swap the erased reference with the one to be swapped, dereference the swapped reference and update its pointer to contiguous 
+		**/
 };
 
 

include/nbl/scene/scene.h

@@ -10,8 +10,7 @@
 #include "nbl/ui/ui.h"
 
 //
-//#include "nbl/scene/IAnimationBlendManager.h"
-#include "nbl/scene/ITransformTreeManager.h"
+#include "nbl/scene/IAnimationBlendManager.h"
 //#include "nbl/scene/ILevelOfDetailLibrary.h"
 //#include "nbl/scene/ISensor.h" or asset? or a struct?
 //#include "nbl/scene/ICamera.h" or do we stick it inside the renderpass?