Skip to content

Commit 0bb55f4

Browse files
AnClarkAnClark
committed
(WIP) UI: Implement Dear ImGui UI part
1 parent 344d84f commit 0bb55f4

File tree

5 files changed

+343
-7
lines changed

5 files changed

+343
-7
lines changed

‎CMakeLists.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ add_subdirectory (dpf)
1212

1313
include_directories (
1414
src/
15+
dpf-widgets/opengl/
1516
)
1617

1718
set (SRC_BACKEND
@@ -42,5 +43,7 @@ dpf_add_plugin (${PROJECT_NAME}
4243
src/CetoneUIHelper.cpp
4344
src/Images/CetoneArtwork.cpp
4445
src/Fonts/CetoneFonts.cpp
46+
dpf-widgets/opengl/DearImGui.cpp
47+
src/Widgets/ImGui_UI.cpp
4548
)
4649

‎src/CetoneUI.cpp‎

Lines changed: 69 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,24 @@ CCetoneUI::CCetoneUI()
107107
_createSwitchButton(fBtnGlideState, pPortaMode, 764, 150);
108108

109109
_createSwitchButton(fBtnLFOTrigger, pLfo1Trig, 677, 260);
110+
111+
/* ImGui instance (popup menus, subwindows, etc.) */
112+
fImGuiInstance = new ImGuiUI(getTopLevelWidget(), this);
113+
114+
/* "About" button (by clicking the plugin logo) */
115+
_createHiddenButton(fBtnAbout, BTN_ABOUT, Size<uint>(118, 25), Point<int>(0, 0));
116+
117+
/* Popup menu button on params which has constant value sets */
118+
_createHiddenButton(fBtnOsc1Waveform, pOsc1Wave, Size<uint>(45, 10 + 2), Point<int>(10 + 48 * 2, 200 + 2));
119+
_createHiddenButton(fBtnOsc2Waveform, pOsc2Wave, Size<uint>(45, 10 + 2), Point<int>(262 + 48 * 2, 200 + 2));
120+
_createHiddenButton(fBtnOsc3Waveform, pOsc3Wave, Size<uint>(45, 10 + 2), Point<int>(514 + 48 * 2, 200 + 2));
121+
122+
_createHiddenButton(fBtnFilterType, pFilterType, Size<uint>(45, 10 + 2), Point<int>(514, 96 - 4));
123+
_createHiddenButton(fBtnFilterMode, pFilterMode, Size<uint>(45, 10 + 2), Point<int>(514 + 48, 96 - 4));
124+
125+
_createHiddenButton(fBtnLfo1Waveform, pLfo1Wave, Size<uint>(45, 10 + 2), Point<int>(534 + 48, 316 - 4));
126+
127+
_createHiddenButton(fBtnArpMode, pArpMode, Size<uint>(45, 10 + 2), Point<int>(767, 316 - 4));
110128
}
111129

112130
void CCetoneUI::parameterChanged(uint32_t index, float value)
@@ -349,14 +367,58 @@ void CCetoneUI::parameterChanged(uint32_t index, float value)
349367

350368
void CCetoneUI::imageButtonClicked(ImageButton* button, int)
351369
{
352-
#if 0
353-
switch (button->getId()) {
354-
case BTN_PANIC: {
355-
panic();
356-
break;
357-
}
370+
DISTRHO_SAFE_ASSERT_RETURN(fImGuiInstance, )
371+
372+
switch (button->getId())
373+
{
374+
case BTN_ABOUT:
375+
{
376+
fImGuiInstance->isAboutWindowOpen = !fImGuiInstance->isAboutWindowOpen;
377+
break;
378+
}
379+
case pOsc1Wave:
380+
{
381+
fImGuiInstance->menuPos = ImVec2(fBtnOsc1Waveform->getAbsolutePos().getX(), fBtnOsc1Waveform->getAbsolutePos().getY() + fBtnOsc1Waveform->getHeight());
382+
fImGuiInstance->requestMenuId = pOsc1Wave;
383+
break;
384+
}
385+
case pOsc2Wave:
386+
{
387+
fImGuiInstance->menuPos = ImVec2(fBtnOsc2Waveform->getAbsolutePos().getX(), fBtnOsc2Waveform->getAbsolutePos().getY() + fBtnOsc2Waveform->getHeight());
388+
fImGuiInstance->requestMenuId = pOsc2Wave;
389+
break;
390+
}
391+
case pOsc3Wave:
392+
{
393+
fImGuiInstance->menuPos = ImVec2(fBtnOsc3Waveform->getAbsolutePos().getX(), fBtnOsc3Waveform->getAbsolutePos().getY() + fBtnOsc3Waveform->getHeight());
394+
fImGuiInstance->requestMenuId = pOsc3Wave;
395+
break;
396+
}
397+
case pFilterType:
398+
{
399+
fImGuiInstance->menuPos = ImVec2(fBtnFilterType->getAbsolutePos().getX(), fBtnFilterType->getAbsolutePos().getY() + fBtnFilterType->getHeight());
400+
fImGuiInstance->requestMenuId = pFilterType;
401+
break;
402+
}
403+
case pFilterMode:
404+
{
405+
fImGuiInstance->menuPos = ImVec2(fBtnFilterMode->getAbsolutePos().getX(), fBtnFilterMode->getAbsolutePos().getY() + fBtnFilterMode->getHeight());
406+
fImGuiInstance->requestMenuId = pFilterMode;
407+
break;
408+
}
409+
case pLfo1Wave:
410+
{
411+
fImGuiInstance->menuPos = ImVec2(fBtnLfo1Waveform->getAbsolutePos().getX(), fBtnLfo1Waveform->getAbsolutePos().getY() + fBtnLfo1Waveform->getHeight());
412+
fImGuiInstance->requestMenuId = pLfo1Wave;
413+
break;
414+
}
415+
case pArpMode:
416+
{
417+
// NOTICE: No need to specify menu position. Let Dear ImGui decide menu's position.
418+
fImGuiInstance->requestMenuId = pArpMode;
419+
break;
420+
}
358421
}
359-
#endif
360422
}
361423

362424
void CCetoneUI::imageSwitchClicked(ImageSwitch* button, bool down)

‎src/CetoneUI.hpp‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
#include "ImageWidgets.hpp"
55
#include "NanoVG.hpp"
66

7+
#include "Widgets/ImGui_UI.hpp"
8+
79
using DGL_NAMESPACE::ImageAboutWindow;
810
using DGL_NAMESPACE::ImageButton;
911
using DGL_NAMESPACE::ImageKnob;
@@ -55,6 +57,12 @@ class CCetoneUI : public DISTRHO::UI,
5557
NanoVG fNanoText;
5658
char fLabelBuffer[32 + 1];
5759

60+
// -------------------------------------------------------------------
61+
// Dear ImGui Instance
62+
63+
ScopedPointer<ImGuiUI> fImGuiInstance;
64+
friend class ImGuiUI;
65+
5866
// -------------------------------------------------------------------
5967
// Image resources
6068

@@ -93,6 +101,16 @@ class CCetoneUI : public DISTRHO::UI,
93101
ScopedPointer<ImageSwitch> fBtnGlideState;
94102
ScopedPointer<ImageSwitch> fBtnLFOTrigger;
95103

104+
// -------------------------------------------------------------------
105+
// Buttons
106+
107+
ScopedPointer<ImageButton> fBtnAbout;
108+
109+
ScopedPointer<ImageButton> fBtnOsc1Waveform, fBtnOsc2Waveform, fBtnOsc3Waveform;
110+
ScopedPointer<ImageButton> fBtnFilterType, fBtnFilterMode;
111+
ScopedPointer<ImageButton> fBtnLfo1Waveform;
112+
ScopedPointer<ImageButton> fBtnArpMode;
113+
96114
// -------------------------------------------------------------------
97115
// Helpers
98116

@@ -127,5 +145,6 @@ class CCetoneUI : public DISTRHO::UI,
127145
// Button IDs
128146

129147
constexpr uint BTN_PANIC = d_cconst('p', 'n', 'i', 'c');
148+
constexpr uint BTN_ABOUT = d_cconst('a', 'b', 't', '.');
130149

131150
// -----------------------------------------------------------------------

‎src/Widgets/ImGui_UI.cpp‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
#include "ImGui_UI.hpp"
2+
#include "DistrhoPluginInfo.h"
3+
4+
#include "Structures.h"
5+
#include "Defines.h"
6+
7+
#include "CetoneUI.hpp" // For class CCetoneUI
8+
9+
void ImGuiUI::onImGuiDisplay()
10+
{
11+
double scaleFactor = getScaleFactor() * userScaling;
12+
const double initialSize = 800 * scaleFactor;
13+
14+
//
15+
// "About" Window
16+
//
17+
{
18+
ImGui::SetNextWindowPos(ImVec2(initialSize / 4, initialSize / 16), ImGuiCond_Once);
19+
ImGui::SetNextWindowSize(ImVec2(600, 230), ImGuiCond_Once);
20+
21+
if (isAboutWindowOpen)
22+
{
23+
ImGui::Begin("About " DISTRHO_PLUGIN_NAME, &isAboutWindowOpen, ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoResize);
24+
{
25+
ImGui::SeparatorText("Cetone Synth Light");
26+
ImGui::Text("Light-weight monophonic analogue-style synthesizer, by Neotec Software.\n");
27+
28+
ImGui::SeparatorText("Authors");
29+
ImGui::BulletText("René 'Neotec' Jeschke - Original developer");
30+
ImGui::BulletText("AnClark Liu <[email protected]> - Ported to DPF, Further developments");
31+
32+
ImGui::SeparatorText("License");
33+
ImGui::BulletText("This project is licensed under GNU General Public License, version 3.");
34+
35+
ImGui::Text("\n\n");
36+
ImGui::Dummy(ImVec2(490, 0));
37+
ImGui::SameLine();
38+
if (ImGui::Button("OK", ImVec2(80, 0)))
39+
isAboutWindowOpen = false;
40+
}
41+
ImGui::End();
42+
}
43+
}
44+
45+
//
46+
// Handle menu opening requests
47+
//
48+
// Here, variable `requestTestMenuOpen` acts as an "event flag" to request ImGui to show the menu.
49+
//
50+
// Dear ImGui has its own mechanism to show popup menus, which does not require a flag to control its exisitance.
51+
// This is quite different from window (ImGui::Begin()).
52+
// So just call this function once, your popup will stick on the screen unless you do some operations.
53+
//
54+
switch (requestMenuId)
55+
{
56+
case pOsc1Wave:
57+
ImGui::OpenPopup("menu_osc1_wave");
58+
requestMenuId = 0;
59+
break;
60+
case pOsc2Wave:
61+
ImGui::OpenPopup("menu_osc2_wave");
62+
requestMenuId = 0;
63+
break;
64+
case pOsc3Wave:
65+
ImGui::OpenPopup("menu_osc3_wave");
66+
requestMenuId = 0;
67+
break;
68+
case pFilterType:
69+
ImGui::OpenPopup("menu_filter_type");
70+
requestMenuId = 0;
71+
break;
72+
case pFilterMode:
73+
ImGui::OpenPopup("menu_filter_mode");
74+
requestMenuId = 0;
75+
break;
76+
case pLfo1Wave:
77+
ImGui::OpenPopup("menu_lfo1_wave");
78+
requestMenuId = 0;
79+
break;
80+
case pArpMode:
81+
ImGui::OpenPopup("menu_arp_mode");
82+
requestMenuId = 0;
83+
break;
84+
85+
default:
86+
requestMenuId = 0;
87+
}
88+
89+
//
90+
// Create popup menus
91+
// [NOTICE] ImGui::BeginPopup() MUST be put after ImGui::OpenPopup(), otherwise popup won't show!
92+
//
93+
94+
ImGui::SetNextWindowPos(menuPos); // Specify menu position
95+
96+
if (ImGui::BeginPopup("menu_osc1_wave"))
97+
{
98+
ImGui::SeparatorText("Waveform");
99+
if (ImGui::MenuItem("Saw")) { _triggerParamUpdate(pOsc1Wave, ui->_pi2f(OWAVE_SAW, OWAVE_MAX)); }
100+
if (ImGui::MenuItem("Pulse")) { _triggerParamUpdate(pOsc1Wave, ui->_pi2f(OWAVE_PULSE, OWAVE_MAX)); }
101+
if (ImGui::MenuItem("Triangle")) { _triggerParamUpdate(pOsc1Wave, ui->_pi2f(OWAVE_TRI, OWAVE_MAX)); }
102+
if (ImGui::MenuItem("Sine")) { _triggerParamUpdate(pOsc1Wave, ui->_pi2f(OWAVE_SINE, OWAVE_MAX)); }
103+
if (ImGui::MenuItem("C64 Noise")) { _triggerParamUpdate(pOsc1Wave, ui->_pi2f(OWAVE_C64NOISE, OWAVE_MAX)); }
104+
ImGui::EndPopup();
105+
}
106+
107+
ImGui::SetNextWindowPos(menuPos); // Specify menu position
108+
109+
if (ImGui::BeginPopup("menu_osc2_wave"))
110+
{
111+
ImGui::SeparatorText("Waveform");
112+
if (ImGui::MenuItem("Saw")) { _triggerParamUpdate(pOsc2Wave, ui->_pi2f(OWAVE_SAW, OWAVE_MAX)); }
113+
if (ImGui::MenuItem("Pulse")) { _triggerParamUpdate(pOsc2Wave, ui->_pi2f(OWAVE_PULSE, OWAVE_MAX)); }
114+
if (ImGui::MenuItem("Triangle")) { _triggerParamUpdate(pOsc2Wave, ui->_pi2f(OWAVE_TRI, OWAVE_MAX)); }
115+
if (ImGui::MenuItem("Sine")) { _triggerParamUpdate(pOsc2Wave, ui->_pi2f(OWAVE_SINE, OWAVE_MAX)); }
116+
if (ImGui::MenuItem("C64 Noise")) { _triggerParamUpdate(pOsc2Wave, ui->_pi2f(OWAVE_C64NOISE, OWAVE_MAX)); }
117+
ImGui::EndPopup();
118+
}
119+
120+
ImGui::SetNextWindowPos(menuPos); // Specify menu position
121+
122+
if (ImGui::BeginPopup("menu_osc3_wave"))
123+
{
124+
ImGui::SeparatorText("Waveform");
125+
if (ImGui::MenuItem("Saw")) { _triggerParamUpdate(pOsc3Wave, ui->_pi2f(OWAVE_SAW, OWAVE_MAX)); }
126+
if (ImGui::MenuItem("Pulse")) { _triggerParamUpdate(pOsc3Wave, ui->_pi2f(OWAVE_PULSE, OWAVE_MAX)); }
127+
if (ImGui::MenuItem("Triangle")) { _triggerParamUpdate(pOsc3Wave, ui->_pi2f(OWAVE_TRI, OWAVE_MAX)); }
128+
if (ImGui::MenuItem("Sine")) { _triggerParamUpdate(pOsc3Wave, ui->_pi2f(OWAVE_SINE, OWAVE_MAX)); }
129+
if (ImGui::MenuItem("C64 Noise")) { _triggerParamUpdate(pOsc3Wave, ui->_pi2f(OWAVE_C64NOISE, OWAVE_MAX)); }
130+
ImGui::EndPopup();
131+
}
132+
133+
ImGui::SetNextWindowPos(menuPos); // Specify menu position
134+
135+
if (ImGui::BeginPopup("menu_filter_type"))
136+
{
137+
ImGui::SeparatorText("Filter Type");
138+
if (ImGui::MenuItem("Dirty")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_DIRTY, FTYPE_MAX)); }
139+
if (ImGui::MenuItem("Moog")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_MOOG, FTYPE_MAX)); }
140+
if (ImGui::MenuItem("Moog 2")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_MOOG2, FTYPE_MAX)); }
141+
if (ImGui::MenuItem("Ch12db")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_CH12DB, FTYPE_MAX)); }
142+
if (ImGui::MenuItem("x0x (303)")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_303, FTYPE_MAX)); }
143+
if (ImGui::MenuItem("8580")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_8580, FTYPE_MAX)); }
144+
if (ImGui::MenuItem("Bi12db (Budda)")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_BUDDA, FTYPE_MAX)); }
145+
ImGui::Separator();
146+
if (ImGui::MenuItem("No Filter")) { _triggerParamUpdate(pFilterType, ui->_pi2f(FTYPE_NONE, FTYPE_MAX)); }
147+
ImGui::EndPopup();
148+
}
149+
150+
ImGui::SetNextWindowPos(menuPos);
151+
152+
if (ImGui::BeginPopup("menu_filter_mode"))
153+
{
154+
ImGui::SeparatorText("Filter Mode");
155+
if (ImGui::MenuItem("Low pass")) { _triggerParamUpdate(pFilterMode, ui->_pi2f(FMODE_LOW, FMODE_MAX)); }
156+
if (ImGui::MenuItem("Band pass")) { _triggerParamUpdate(pFilterMode, ui->_pi2f(FMODE_BAND, FMODE_MAX)); }
157+
if (ImGui::MenuItem("High pass")) { _triggerParamUpdate(pFilterMode, ui->_pi2f(FMODE_HIGH, FMODE_MAX)); }
158+
if (ImGui::MenuItem("Notch")) { _triggerParamUpdate(pFilterMode, ui->_pi2f(FMODE_NOTCH, FMODE_MAX)); }
159+
ImGui::EndPopup();
160+
}
161+
162+
ImGui::SetNextWindowPos(menuPos); // Specify menu position
163+
164+
if (ImGui::BeginPopup("menu_lfo1_wave"))
165+
{
166+
ImGui::SeparatorText("Waveform");
167+
if (ImGui::MenuItem("Saw")) { _triggerParamUpdate(pLfo1Wave, ui->_pi2f(OWAVE_SAW, OWAVE_MAX)); }
168+
if (ImGui::MenuItem("Pulse")) { _triggerParamUpdate(pLfo1Wave, ui->_pi2f(OWAVE_PULSE, OWAVE_MAX)); }
169+
if (ImGui::MenuItem("Triangle")) { _triggerParamUpdate(pLfo1Wave, ui->_pi2f(OWAVE_TRI, OWAVE_MAX)); }
170+
if (ImGui::MenuItem("Sine")) { _triggerParamUpdate(pLfo1Wave, ui->_pi2f(OWAVE_SINE, OWAVE_MAX)); }
171+
if (ImGui::MenuItem("C64 Noise")) { _triggerParamUpdate(pLfo1Wave, ui->_pi2f(OWAVE_C64NOISE, OWAVE_MAX)); }
172+
ImGui::EndPopup();
173+
}
174+
175+
// NOTICE:
176+
// For menus below, no need to specify menu position. Let Dear ImGui decide menu's position.
177+
// Otherwise, menu will partially show on the screen due to insufficient space.
178+
179+
if (ImGui::BeginPopup("menu_arp_mode"))
180+
{
181+
ImGui::SeparatorText("Arp Mode");
182+
if (ImGui::MenuItem("Minor")) { _triggerParamUpdate(pArpMode, ui->_pi2f(0 + 1, ARP_MAX + 1)); }
183+
if (ImGui::MenuItem("Major")) { _triggerParamUpdate(pArpMode, ui->_pi2f(1 + 1, ARP_MAX + 1)); }
184+
if (ImGui::MenuItem("Minor + 1 Octave")) { _triggerParamUpdate(pArpMode, ui->_pi2f(2 + 1, ARP_MAX + 1)); }
185+
if (ImGui::MenuItem("Major + 1 Octave")) { _triggerParamUpdate(pArpMode, ui->_pi2f(3 + 1, ARP_MAX + 1)); }
186+
if (ImGui::MenuItem("1 Octave")) { _triggerParamUpdate(pArpMode, ui->_pi2f(4 + 1, ARP_MAX + 1)); }
187+
if (ImGui::MenuItem("2 Octaves")) { _triggerParamUpdate(pArpMode, ui->_pi2f(5 + 1, ARP_MAX + 1)); }
188+
if (ImGui::MenuItem("Quint")) { _triggerParamUpdate(pArpMode, ui->_pi2f(6 + 1, ARP_MAX + 1)); }
189+
if (ImGui::MenuItem("Quint 2")) { _triggerParamUpdate(pArpMode, ui->_pi2f(7 + 1, ARP_MAX + 1)); }
190+
ImGui::Separator();
191+
if (ImGui::MenuItem("Off")) { _triggerParamUpdate(pArpMode, ui->_pi2f(-1 + 1, ARP_MAX + 1)); }
192+
193+
ImGui::EndPopup();
194+
}
195+
}
196+
197+
void ImGuiUI::_triggerParamUpdate(uint32_t paramId, float newValue)
198+
{
199+
ui->setParameterValue(paramId, newValue); // Tell the DSP to update parameter value
200+
ui->parameterChanged(paramId, newValue); // Request UI refresh
201+
}

0 commit comments

Comments
 (0)