DPF/examples/MidiKeyboard/MidiKeyboardExampleUI.cpp

/*
 * 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 "DistrhoUI.hpp"
#include "Window.hpp"
#include "KeyboardWidget.hpp"
#include "src/pugl/pugl.h"

START_NAMESPACE_DISTRHO


// -----------------------------------------------------------------------------------------------------------

class MidiKeyboardExampleUI : public UI,
                              public KeyboardWidget::Callback
{
public:
    /* constructor */
    MidiKeyboardExampleUI()
        : UI(kUIWidth, kUIHeight),
          fKeyboardWidget(getParentWindow())
    {
        const int keyboardDeltaWidth = kUIWidth - fKeyboardWidget.getWidth();

        fKeyboardWidget.setAbsoluteX(keyboardDeltaWidth / 2);
        fKeyboardWidget.setAbsoluteY(kUIHeight - fKeyboardWidget.getHeight() - 4);
        fKeyboardWidget.setCallback(this);

        // Add a min-size constraint to the window, to make sure that it can't become too small
        setGeometryConstraints(kUIWidth, kUIHeight, true, true);

        // Avoid key repeat when playing notes using the computer keyboard
        getParentWindow().setIgnoringKeyRepeat(true);
    }

protected:
    /* --------------------------------------------------------------------------------------------------------
    * DSP/Plugin Callbacks */

    /**
      A parameter has changed on the plugin side.
      This is called by the host to inform the UI about parameter changes.
      This plugin does not have any parameters, so we can leave this blank.
    */
    void parameterChanged(uint32_t, float) override
    {
    }

    /* --------------------------------------------------------------------------------------------------------
    * Widget Callbacks */

    /**
      The OpenGL drawing function.
      Here, we set a custom background color.
    */
    void onDisplay() override
    {
      glClearColor(17.f / 255.f,
                   17.f / 255.f,
                   17.f / 255.f,
                   17.f / 255.f);

      glClear(GL_COLOR_BUFFER_BIT);
    }

    /**
       Allow playing notes using the bottom and top rows of the computer keyboard.
    */
    bool onKeyboard(const KeyboardEvent& ev) override
    {
      // Offset from C4
      int offset = -1;

      const int keyjazzKeyCount = 37;

      const PuglKeyCodes keyjazzKeys[keyjazzKeyCount] = {
        PUGL_KC_Z, // C-0
        PUGL_KC_S, // C#0
        PUGL_KC_X, // D-0
        PUGL_KC_D, // D#0
        PUGL_KC_C, // E-0
        PUGL_KC_V, // F-0
        PUGL_KC_G, // F#0
        PUGL_KC_B, // G-0
        PUGL_KC_H, // G#0
        PUGL_KC_N, // A-0
        PUGL_KC_J, // A#0
        PUGL_KC_M, // B-0
        PUGL_KC_Comma, // C-1
        PUGL_KC_L, // C#1
        PUGL_KC_Period, // D-1
        PUGL_KC_Semicolon, // D#1
        PUGL_KC_Slash, // E-1
        PUGL_KC_Q, // C-1
        PUGL_KC_2, // C#1
        PUGL_KC_W, // D-1
        PUGL_KC_3, // D#1
        PUGL_KC_E, // E-1
        PUGL_KC_R, // F-1
        PUGL_KC_5, // F#1
        PUGL_KC_T, // G-1
        PUGL_KC_6, // G#1
        PUGL_KC_Y, // A-1
        PUGL_KC_7, // A#1
        PUGL_KC_U, // B-1
        PUGL_KC_I, // C-2
        PUGL_KC_9, // C#2
        PUGL_KC_O, // D-2
        PUGL_KC_0, // D#2
        PUGL_KC_P, // E-2
        PUGL_KC_LeftBracket, // F-2
        PUGL_KC_Equals, // F#2
        PUGL_KC_RightBracket // G-2
      };

        for (int i = 0; i < keyjazzKeyCount; ++i)
        {
          if (ev.keycode == keyjazzKeys[i])
          {
              offset = i;

              // acknowledge 5 duplicate notes
              if (i > 16)
              {
                  offset -= 5;
              }

              break;
          }
      }

      if (offset == -1)
      {
          return false;
      }

      fKeyboardWidget.setKeyPressed(offset, ev.press, true);

      return true;
    }

    /**
       Called when a note is pressed on the piano.
     */
    void keyboardKeyPressed(const uint keyIndex) override
    {
      const uint C4 = 60;
      sendNote(0, C4 + keyIndex, 127);
    }

    /**
       Called when a note is released on the piano.
     */
    void keyboardKeyReleased(const uint keyIndex) override
    {
      const uint C4 = 60;
      sendNote(0, C4 + keyIndex, 0);
    }

    // -------------------------------------------------------------------------------------------------------

private:
    static const int kUIWidth = 750;
    static const int kUIHeight = 124;

    KeyboardWidget fKeyboardWidget;

    /**
      Set our UI class as non-copyable and add a leak detector just in case.
    */
    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(MidiKeyboardExampleUI)
};

/* ------------------------------------------------------------------------------------------------------------
 * UI entry point, called by DPF to create a new UI instance. */

UI *createUI()
{
    return new MidiKeyboardExampleUI();
}

// -----------------------------------------------------------------------------------------------------------

END_NAMESPACE_DISTRHO