Deluge Firmware 1.3.0
Build date: 2025.06.24
Loading...
Searching...
No Matches
oled.h
1/*
2 * Copyright © 2020-2023 Synthstrom Audible Limited
3 *
4 * This file is part of The Synthstrom Audible Deluge Firmware.
5 *
6 * The Synthstrom Audible Deluge Firmware is free software: you can redistribute it and/or modify it under the
7 * terms of the GNU General Public License as published by the Free Software Foundation,
8 * either version 3 of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
11 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * See the GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along with this program.
15 * If not, see <https://www.gnu.org/licenses/>.
16 */
17
18#pragma once
19
20#include "gui/l10n/language.h"
21#include <string_view>
22#ifdef __cplusplus
23#include "definitions_cxx.hpp"
24#include "display.h"
25#include "oled_canvas/canvas.h"
26#include <vector>
27
28#define OLED_LOG_TIMING (0 && ENABLE_TEXT_OUTPUT)
29
30#if OLED_LOG_TIMING
31#include "io/debug/log.h"
32#endif
33
34namespace deluge::hid::display {
35class OLED : public Display {
36public:
37 OLED() : Display(DisplayType::OLED) {
38 if (l10n::chosenLanguage == nullptr || l10n::chosenLanguage == &l10n::built_in::seven_segment) {
39 l10n::chosenLanguage = &l10n::built_in::english;
40 }
41 }
42
48 static void clearMainImage();
49
50 static void setupBlink(int32_t minX, int32_t width, int32_t minY, int32_t maxY, bool shouldBlinkImmediately);
51 static void stopBlink();
52
53 static void sendMainImage();
54
55 static void setupPopup(PopupType type, int32_t width, int32_t height, std::optional<int32_t> startX = std::nullopt,
56 std::optional<int32_t> startY = std::nullopt);
57 static void removePopup();
58 static void popupText(std::string_view text, bool persistent = false, PopupType type = PopupType::GENERAL);
59 static bool isPopupPresent();
60 static bool isPopupPresentOfType(PopupType type = PopupType::GENERAL);
61 static bool isPermanentPopupPresent();
62
63 static void displayWorkingAnimation(std::string_view word);
64
65 static int32_t setupConsole(int32_t height);
66 static void drawConsoleTopLine();
67
68 static void stopScrollingAnimation();
69 static void setupSideScroller(int32_t index, std::string_view text, int32_t startX, int32_t endX, int32_t startY,
70 int32_t endY, int32_t textSpacingX, int32_t textSizeY, bool doHighlight);
71 static void drawPermanentPopupLookingText(std::string_view);
72
75 static void markChanged() {
76#if OLED_LOG_TIMING
77 if (!needsSending) {
78 D_PRINTLN("Fresh dirty mark");
79 }
80#endif
81 needsSending = true;
82 }
83
84 void consoleTimerEvent();
85 static void scrollingAndBlinkingTimerEvent();
86
87 static void renderEmulated7Seg(const std::array<uint8_t, kNumericDisplayLength>& display);
88
89 static oled_canvas::Canvas main;
90 static oled_canvas::Canvas popup;
91 static oled_canvas::Canvas console;
92
93 // pointer to one of the three above (the one currently displayed)
94 static uint8_t (*oledCurrentImage)[OLED_MAIN_WIDTH_PIXELS];
95
96 static const uint8_t folderIcon[];
97 static const uint8_t waveIcon[];
98 static const uint8_t songIcon[];
99 static const uint8_t synthIcon[];
100 static const uint8_t kitIcon[];
101 static const uint8_t midiIcon[];
102 static const uint8_t midiIconPt2[];
103 static const uint8_t downArrowIcon[];
104 static const uint8_t rightArrowIcon[];
105 static const uint8_t lockIcon[];
106 static const uint8_t checkedBoxIcon[];
107 static const uint8_t uncheckedBoxIcon[];
108 static const uint8_t submenuArrowIcon[];
109 static const uint8_t submenuArrowIconBold[];
110 static const uint8_t metronomeIcon[];
111 static const std::vector<uint8_t> lfoIconSine;
112 static const std::vector<uint8_t> lfoIconSquare;
113 static const std::vector<uint8_t> lfoIconSaw;
114 static const std::vector<uint8_t> lfoIconTriangle;
115 static const std::vector<uint8_t> lfoIconSampleHold;
116 static const std::vector<uint8_t> lfoIconRandomWalk;
117 static const std::vector<uint8_t> lfoIconWarbler;
118 static const std::vector<uint8_t> syncTypeEvenIcon;
119 static const std::vector<uint8_t> syncTypeDottedIcon;
120 static const std::vector<uint8_t> syncTypeTripletsIcon;
121 static const std::vector<uint8_t> switcherIconOff;
122 static const std::vector<uint8_t> switcherIconOn;
123 static const std::vector<uint8_t> arpModeIconUp;
124 static const std::vector<uint8_t> arpModeIconDown;
125 static const std::vector<uint8_t> arpModeIconWalk;
126 static const std::vector<uint8_t> arpModeIconCustom;
127 static const std::vector<uint8_t> diceIcon;
128 static const std::vector<uint8_t> stutterDirectionIcon;
129 static const std::vector<uint8_t> knobArcIcon;
130
131 void removeWorkingAnimation() override;
132 void timerRoutine() override;
133 void consoleText(std::string_view text) override;
134 void freezeWithError(std::string_view) override;
135
136 //************************ Display Interface stuff ***************************/
137
138 constexpr size_t getNumBrowserAndMenuLines() override { return 3; }
139
140 void displayPopup(std::string_view newText, int8_t numFlashes = 3, bool = false, uint8_t = 255, int32_t = 1,
141 PopupType type = PopupType::GENERAL) override {
142 popupText(newText, !numFlashes, type);
143 }
144
145 void popupText(std::string_view text, PopupType type = PopupType::GENERAL) override { popupText(text, true, type); }
146 void popupTextTemporary(std::string_view text, PopupType type = PopupType::GENERAL) override {
147 popupText(text, false, type);
148 }
149
150 void cancelPopup() override { removePopup(); }
151 bool isLayerCurrentlyOnTop(NumericLayer* layer) override { return (!this->hasPopup()); }
152 void displayError(Error error) override;
153
154 // Loading animations
155 void displayLoadingAnimationText(std::string_view text, bool delayed = false, bool transparent = false) override {
156 displayWorkingAnimation(text);
157 }
158 void removeLoadingAnimation() override { removeWorkingAnimation(); }
159
160 bool hasPopup() override { return isPopupPresent(); }
161 bool hasPopupOfType(PopupType type) override { return isPopupPresentOfType(type); }
162
163 // Horizontal menus
164 void displayHorizontalMenuPopup(std::string_view paramTitle, std::optional<std::string_view> paramValue) override;
165
166private:
167 static bool needsSending;
168};
169
170} // namespace deluge::hid::display
171#endif