Add SVG support + basic MidiKeyboard example

Makefile

@@ -20,6 +20,7 @@ examples: dgl
 	$(MAKE) all -C examples/MidiThrough
 	$(MAKE) all -C examples/Parameters
 	$(MAKE) all -C examples/States
+	$(MAKE) all -C examples/MidiKeyboard
 
 ifeq ($(HAVE_CAIRO),true)
 	$(MAKE) all -C examples/CairoUI
@@ -60,6 +61,7 @@ clean:
 	$(MAKE) clean -C examples/MidiThrough
 	$(MAKE) clean -C examples/Parameters
 	$(MAKE) clean -C examples/States
+	$(MAKE) clean -C examples/MidiKeyboard
 	$(MAKE) clean -C utils/lv2-ttl-generator
 	rm -rf bin build
 

dgl/Base.hpp

@@ -86,6 +86,140 @@ enum Key {
     kKeySuper
 };
 
+/**
+   Layout-independent keycodes.
+   These keycodes are relative to an US QWERTY keyboard.
+   Therefore, the keycode for the letter 'A' on an AZERTY keyboard will be equal to kKeyCodeQ.
+ */
+enum KeyCode {
+    /* Zero, does not correspond to any key. */
+    kKeyCodeNone = 0,
+
+    kKeyCodeA = 4,
+    kKeyCodeB = 5,
+    kKeyCodeC = 6,
+    kKeyCodeD = 7,
+    kKeyCodeE = 8,
+    kKeyCodeF = 9,
+    kKeyCodeG = 10,
+    kKeyCodeH = 11,
+    kKeyCodeI = 12,
+    kKeyCodeJ = 13,
+    kKeyCodeK = 14,
+    kKeyCodeL = 15,
+    kKeyCodeM = 16,
+    kKeyCodeN = 17,
+    kKeyCodeO = 18,
+    kKeyCodeP = 19,
+    kKeyCodeQ = 20,
+    kKeyCodeR = 21,
+    kKeyCodeS = 22,
+    kKeyCodeT = 23,
+    kKeyCodeU = 24,
+    kKeyCodeV = 25,
+    kKeyCodeW = 26,
+    kKeyCodeX = 27,
+    kKeyCodeY = 28,
+    kKeyCodeZ = 29,
+    kKeyCode1 = 30,
+    kKeyCode2 = 31,
+    kKeyCode3 = 32,
+    kKeyCode4 = 33,
+    kKeyCode5 = 34,
+    kKeyCode6 = 35,
+    kKeyCode7 = 36,
+    kKeyCode8 = 37,
+    kKeyCode9 = 38,
+    kKeyCode0 = 39,
+    kKeyCodeEscape = 41,
+    kKeyCodeDelete = 42,
+    kKeyCodeTab = 43,
+    kKeyCodeSpace = 44,
+    kKeyCodeMinus = 45,
+    kKeyCodeEquals = 46,
+    kKeyCodeLeftBracket = 47,
+    kKeyCodeRightBracket = 48,
+    kKeyCodeBackslash = 49,
+    kKeyCodeSemicolon = 51,
+    kKeyCodeQuote = 52,
+    kKeyCodeGrave = 53,
+    kKeyCodeComma = 54,
+    kKeyCodePeriod = 55,
+    kKeyCodeSlash = 56,
+    kKeyCodeCapsLock = 57,
+    kKeyCodeF1 = 58,
+    kKeyCodeF2 = 59,
+    kKeyCodeF3 = 60,
+    kKeyCodeF4 = 61,
+    kKeyCodeF5 = 62,
+    kKeyCodeF6 = 63,
+    kKeyCodeF7 = 64,
+    kKeyCodeF8 = 65,
+    kKeyCodeF9 = 66,
+    kKeyCodeF10 = 67,
+    kKeyCodeF11 = 68,
+    kKeyCodeF12 = 69,
+    kKeyCodePrintScreen = 70,
+    kKeyCodeScrollLock = 71,
+    kKeyCodePause = 72,
+    kKeyCodeInsert = 73,
+    kKeyCodeHome = 74,
+    kKeyCodePageUp = 75,
+    kKeyCodeDeleteForward = 76,
+    kKeyCodeEnd = 77,
+    kKeyCodePageDown = 78,
+    kKeyCodeRight = 79,
+    kKeyCodeLeft = 80,
+    kKeyCodeDown = 81,
+    kKeyCodeUp = 82,
+    kKeyCodeKP_NumLock = 83,
+    kKeyCodeKP_Divide = 84,
+    kKeyCodeKP_Multiply = 85,
+    kKeyCodeKP_Subtract = 86,
+    kKeyCodeKP_Add = 87,
+    kKeyCodeKP_Enter = 88,
+    kKeyCodeKP_1 = 89,
+    kKeyCodeKP_2 = 90,
+    kKeyCodeKP_3 = 91,
+    kKeyCodeKP_4 = 92,
+    kKeyCodeKP_5 = 93,
+    kKeyCodeKP_6 = 94,
+    kKeyCodeKP_7 = 95,
+    kKeyCodeKP_8 = 96,
+    kKeyCodeKP_9 = 97,
+    kKeyCodeKP_0 = 98,
+    kKeyCodePoint = 99,
+    kKeyCodeNonUSBackslash = 100,
+    kKeyCodeKP_Equals = 103,
+    kKeyCodeF13 = 104,
+    kKeyCodeF14 = 105,
+    kKeyCodeF15 = 106,
+    kKeyCodeF16 = 107,
+    kKeyCodeF17 = 108,
+    kKeyCodeF18 = 109,
+    kKeyCodeF19 = 110,
+    kKeyCodeF20 = 111,
+    kKeyCodeF21 = 112,
+    kKeyCodeF22 = 113,
+    kKeyCodeF23 = 114,
+    kKeyCodeF24 = 115,
+    kKeyCodeHelp = 117,
+    kKeyCodeMenu = 118,
+    kKeyCodeMute = 127,
+    kKeyCodeSysReq = 154,
+    kKeyCodeReturn = 158,
+    kKeyCodeKP_Clear = 216,
+    kKeyCodeKP_Decimal = 220,
+    kKeyCodeLeftControl = 224,
+    kKeyCodeLeftShift = 225,
+    kKeyCodeLeftAlt = 226,
+    kKeyCodeLeftGUI = 227,
+    kKeyCodeRightControl = 228,
+    kKeyCodeRightShift = 229,
+    kKeyCodeRightAlt = 230,
+    kKeyCodeRightGUI = 231
+};
+
 // -----------------------------------------------------------------------
 // Base DGL classes
 

dgl/Image.hpp

@@ -92,6 +92,12 @@ class Image : public ImageBase
                         const GLenum format = GL_BGRA,
                         const GLenum type = GL_UNSIGNED_BYTE) noexcept;
 
+   /**
+    * Load image data from an SVG.
+    * @note The SVG instance must remain valid during the lifetime of this image.
+    */
+   void loadFromSVG(const SVG& svg) noexcept;
+
    /**
       Get the image format.
     */

dgl/ImageBase.hpp

@@ -18,6 +18,7 @@
 #define DGL_IMAGE_BASE_HPP_INCLUDED
 
 #include "Geometry.hpp"
+#include "SVG.hpp"
 
 START_NAMESPACE_DGL
 

dgl/Makefile

@@ -25,6 +25,7 @@ OBJS_common = \
 	../build/dgl/Geometry.cpp.o \
 	../build/dgl/ImageBase.cpp.o \
 	../build/dgl/Resources.cpp.o \
+	../build/dgl/SVG.cpp.o \
 	../build/dgl/Widget.cpp.o
 
 # TODO: ImageWidgets.cpp

dgl/SVG.hpp

@@ -0,0 +1,75 @@
+/*
+ * DISTRHO Plugin Framework (DPF)
+ * Copyright (C) 2012-2019 Filipe Coelho <falktx@falktx.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any purpose with
+ * or without fee is hereby granted, provided that the above copyright notice and this
+ * permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+ * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+ * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#ifndef DGL_SVG_HPP_INCLUDED
+#define DGL_SVG_HPP_INCLUDED
+
+#include "Geometry.hpp"
+
+struct NSVGrasterizer;
+
+START_NAMESPACE_DGL
+
+/**
+ * Utility class for loading SVGs.
+ */
+class SVG
+{
+public:
+
+   /**
+      Constructor for a null SVG.
+    */
+    SVG();
+
+   /**
+      Destructor.
+    */
+    ~SVG();
+
+   /**
+      Load SVG data from memory.
+      @note @a rawData must remain valid for the lifetime of this SVG.
+    */
+    void loadFromMemory(const char* const rawData,
+                        const uint dataSize,
+                        const float scaling = 1.0f) noexcept;
+
+    /**
+       Check if this SVG is valid.
+    */
+    const Size<uint>& getSize() const noexcept;
+
+   /**
+      Get the RGBA data of the rasterized SVG.
+    */
+    const unsigned char* getRGBAData() const noexcept;
+
+   /**
+      Check if this SVG is valid.
+    */
+    bool isValid() const noexcept;
+
+private:
+    Size<uint> fSize;
+    unsigned char* fRGBAData;
+
+    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(SVG)
+};
+
+END_NAMESPACE_DGL
+
+#endif

dgl/Widget.hpp

@@ -85,6 +85,7 @@ class Widget
     struct KeyboardEvent : BaseEvent {
         bool press;
         uint key;
+        uint keycode;
 
         /** Constuctor */
         KeyboardEvent() noexcept

dgl/src/Image.cpp

@@ -92,6 +92,13 @@ void Image::loadFromMemory(const char* const rawData,
     fIsReady = false;
 }
 
+void Image::loadFromSVG(const SVG& svg) noexcept
+{
+    DISTRHO_SAFE_ASSERT_RETURN(svg.isValid(),)
+
+    loadFromMemory((const char*)svg.getRGBAData(), svg.getSize(), GL_RGBA);
+}
+
 GLenum Image::getFormat() const noexcept
 {
     return fFormat;
@@ -114,8 +121,7 @@ Image& Image::operator=(const Image& image) noexcept
 
 void Image::_drawAt(const Point<int>& pos)
 {
-    if (fTextureId == 0 || ! isValid())
-        return;
+    DISTRHO_SAFE_ASSERT_RETURN(fTextureId != 0 && isValid(), )
 
     glEnable(GL_TEXTURE_2D);
     glBindTexture(GL_TEXTURE_2D, fTextureId);

dgl/src/SVG.cpp

@@ -0,0 +1,98 @@
+/*
+ * DISTRHO Plugin Framework (DPF)
+ * Copyright (C) 2012-2019 Filipe Coelho <falktx@falktx.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any purpose with
+ * or without fee is hereby granted, provided that the above copyright notice and this
+ * permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+ * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+ * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include "SVG.hpp"
+
+#define NANOSVG_IMPLEMENTATION
+#include "nanosvg/nanosvg.h"
+
+#define NANOSVGRAST_IMPLEMENTATION
+#include "nanosvg/nanosvgrast.h"
+
+
+START_NAMESPACE_DGL
+
+SVG::SVG()
+    : fSize(),
+      fRGBAData(nullptr)
+{
+}
+
+void SVG::loadFromMemory(const char* const rawData, const uint dataSize, const float scaling) noexcept
+{
+    DISTRHO_SAFE_ASSERT_RETURN(rawData != nullptr, )
+    DISTRHO_SAFE_ASSERT_RETURN(scaling > 0.0f, )
+
+    if (fRGBAData != nullptr)
+    {
+        free(fRGBAData);
+        fRGBAData = nullptr;
+    }
+
+    // nsvgParse modifies the input data, so we must use a temporary buffer
+    char* tmpBuffer = (char*)malloc(dataSize);
+
+    DISTRHO_SAFE_ASSERT_RETURN(tmpBuffer != nullptr, )
+
+    strncpy(tmpBuffer, rawData, dataSize);
+    tmpBuffer[dataSize - 1] = '\0';
+
+    const float dpi = 96;
+
+    NSVGimage* image = nsvgParse(tmpBuffer, "px", dpi);
+
+    free(tmpBuffer);
+
+    DISTRHO_SAFE_ASSERT_RETURN(image != nullptr, )
+
+    const uint scaledWidth = image->width * scaling;
+    const uint scaledHeight = image->height * scaling;
+
+    DISTRHO_SAFE_ASSERT_RETURN(scaledWidth > 0 && scaledHeight > 0, )
+
+    fRGBAData = (unsigned char*)malloc(scaledWidth * scaledHeight * 4);
+
+    NSVGrasterizer* rasterizer = nsvgCreateRasterizer();
+    nsvgRasterize(rasterizer, image, 0, 0, scaling, fRGBAData, scaledWidth, scaledHeight, scaledWidth * 4);
+
+    fSize.setSize(scaledWidth, scaledHeight);
+
+    nsvgDelete(image);
+    nsvgDeleteRasterizer(rasterizer);
+}
+
+SVG::~SVG()
+{
+    free(fRGBAData);
+}
+
+const Size<uint>& SVG::getSize() const noexcept
+{
+    return fSize;
+}
+
+const unsigned char* SVG::getRGBAData() const noexcept
+{
+    return fRGBAData;
+}
+
+bool SVG::isValid() const noexcept
+{
+    return (fRGBAData != nullptr && fSize.isValid());
+}
+
+END_NAMESPACE_DGL
+