Add Milkdrop user sprites

Author: kblaschke

src/libprojectM/CMakeLists.txt

@@ -9,6 +9,7 @@ add_compile_definitions(
 add_subdirectory(Audio)
 add_subdirectory(MilkdropPreset)
 add_subdirectory(Renderer)
+add_subdirectory(UserSprites)
 
 add_library(projectM_main OBJECT
         "${PROJECTM_EXPORT_HEADER}"
@@ -65,6 +66,7 @@ add_library(projectM
         $<TARGET_OBJECTS:Audio>
         $<TARGET_OBJECTS:MilkdropPreset>
         $<TARGET_OBJECTS:Renderer>
+        $<TARGET_OBJECTS:UserSprites>
         $<TARGET_OBJECTS:hlslparser>
         $<TARGET_OBJECTS:SOIL2>
         $<TARGET_OBJECTS:projectM_main>

src/libprojectM/MilkdropPreset/MilkdropPreset.cpp

@@ -181,6 +181,14 @@ void MilkdropPreset::DrawInitialImage(const std::shared_ptr<Renderer::Texture>&
     m_flipTexture.Draw(image, m_framebuffer, m_previousFrameBuffer);
 }
 
+void MilkdropPreset::BindFramebuffer()
+{
+    if (m_framebuffer.Width() > 0 && m_framebuffer.Height() > 0)
+    {
+        m_framebuffer.BindDraw(m_previousFrameBuffer);
+    }
+}
+
 void MilkdropPreset::PerFrameUpdate()
 {
     m_perFrameContext.LoadStateVariables(m_state);
@@ -312,5 +320,6 @@ auto MilkdropPreset::ParseFilename(const std::string& filename) -> std::string
     return filename.substr(start + 1, filename.length());
 }
 
+
 } // namespace MilkdropPreset
 } // namespace libprojectM

src/libprojectM/MilkdropPreset/MilkdropPreset.hpp

@@ -87,6 +87,8 @@ class MilkdropPreset : public ::libprojectM::Preset
 
     void DrawInitialImage(const std::shared_ptr<Renderer::Texture>& image, const Renderer::RenderContext& renderContext) override;
 
+    void BindFramebuffer() override;
+
 private:
     void PerFrameUpdate();
 

src/libprojectM/Preset.hpp

@@ -47,6 +47,19 @@ class Preset
     virtual void DrawInitialImage(const std::shared_ptr<Renderer::Texture>& image,
                                   const Renderer::RenderContext& renderContext) = 0;
 
+    /**
+     * @brief Bind the preset's internal framebuffer.
+     * This framebuffer contains the image passed on to the next frame, onto which warp effects etc.
+     * are then applied. Has no effect if the framebuffer isn't initialized yet, e.g. before drawing
+     * the first frame.
+     *
+     * Can be used to draw anything on top of the preset's image, "burning in" additional shapes,
+     * images or text. Depending on the preset, it's not guaranteed though that the image actually
+     * is used in the next frame, or completely painted over. That said, the effect varies between
+     * presets.
+     */
+    virtual void BindFramebuffer() = 0;
+
     inline void SetFilename(const std::string& filename)
     {
         m_filename = filename;

src/libprojectM/UserSprites/CMakeLists.txt

@@ -0,0 +1,38 @@
+set(SPRITE_SHADER_FILES
+        Shaders/MilkdropSpriteFragmentGlsl330.frag
+        Shaders/MilkdropSpriteVertexGlsl330.vert
+        )
+
+include(GenerateShaderResources)
+generate_shader_resources(${CMAKE_CURRENT_BINARY_DIR}/SpriteShaders.hpp
+        ${SPRITE_SHADER_FILES}
+        )
+
+add_library(UserSprites OBJECT
+        ${CMAKE_CURRENT_BINARY_DIR}/SpriteShaders.hpp
+        Factory.cpp
+        Factory.hpp
+        MilkdropSprite.cpp
+        MilkdropSprite.hpp
+        Sprite.hpp
+        SpriteException.hpp
+        SpriteManager.cpp
+        SpriteManager.hpp
+        )
+
+target_include_directories(UserSprites
+        PRIVATE
+        "${CMAKE_CURRENT_SOURCE_DIR}/.."
+        PUBLIC
+        "${CMAKE_CURRENT_SOURCE_DIR}"
+        "${CMAKE_CURRENT_BINARY_DIR}"
+        )
+
+target_link_libraries(UserSprites
+        PRIVATE
+        projectM::Eval
+        libprojectM::API # For export header
+        PUBLIC
+        GLM::GLM
+        ${PROJECTM_OPENGL_LIBRARIES}
+        )

src/libprojectM/UserSprites/Factory.cpp

@@ -0,0 +1,15 @@
+#include "Factory.hpp"
+
+namespace libprojectM {
+namespace UserSprites {
+
+Factory::Factory()
+{
+}
+
+Factory::~Factory()
+{
+}
+
+} // namespace UserSprites
+} // namespace libprojectM

src/libprojectM/UserSprites/Factory.hpp

@@ -0,0 +1,17 @@
+#pragma once
+
+namespace libprojectM {
+namespace UserSprites {
+
+class Factory
+{
+public:
+    Factory();
+
+    virtual ~Factory();
+
+private:
+};
+
+} // namespace UserSprites
+} // namespace libprojectM