-
Notifications
You must be signed in to change notification settings - Fork 1
/
cfg_volume.h
338 lines (303 loc) · 13.2 KB
/
cfg_volume.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
#pragma once // Please format this file with clang before check-in to GitHub
/*
File: cfg_volume.h
Software: Barry Hansen, K7BWH, barry@k7bwh.com, Seattle, WA
Hardware: John Vanderbeck, KM7O, Seattle, WA
Purpose: This is the user interface to increase/decrease/mute speaker volume.
This "view" module is all about speaker volume.
As such, the only thing it does is set the DS1804 digital potentiometer.
It has nothing to do with the DAC, audio files, Morse code speed/pitch,
or with other playback attributes.
+-------------------------------------------+
| * Speaker > |
| |
| 33 Audio Volume |... yRow1
| 33 of 10 |... yRow2
| |
| +----------------+ |
| | Up | |
| | | +--------+ |
| +----------------+ | Mute | |
| | Down | +--------+ |
| | | |
+-------+----------------+------------------+
*/
#include <Adafruit_ILI9341.h> // TFT color display library
#include <DS1804.h> // DS1804 digital potentiometer library
#include "constants.h" // Griduino constants and colors
#include "logger.h" // conditional printing to Serial port
#include "model_gps.h" // Model of a GPS for model-view-controller
#include "morse_dac.h" // morse code
#include "TextField.h" // Optimize TFT display text for proportional fonts
#include "view.h" // Base class for all views
// ========== extern ===========================================
extern Logger logger; // Griduino.ino
extern void announceGrid(String gridName, int len); // Griduino.ino
extern DACMorseSender dacMorse; // morse code (so we can send audio sample)
extern DS1804 volume; // digital potentiometer
#if defined(ARDUINO_ADAFRUIT_FEATHER_RP2040)
// todo - for now, RP2040 has no DAC, no speech, no audio output
#else
#include <Audio_QSPI.h> // Audio playback library for Arduino, https://github.com/barry-ha/Audio_QSPI
extern AudioQSPI dacSpeech; // spoken word (so we can play speech sample)
#endif
// ========== class ViewVolume =================================
class ViewVolume : public View {
public:
// ---------- public interface ----------
// This derived class must implement the public interface:
ViewVolume(Adafruit_ILI9341 *vtft, int vid) // ctor
: View{vtft, vid} {}
void updateScreen();
void startScreen();
void endScreen();
bool onTouch(Point touch);
void loadConfig();
void saveConfig();
protected:
// ----- 'globals' -----
int gVolIndex = 5; // init to middle value
int gMute = false; // true=muted, false=UNmuted (not saved in NVR)
// ---------- local data for this derived class ----------
// color scheme: see constants.h
// vertical placement of text rows
const int yRow1 = 66; // label: "Audio Volume"
const int yRow2 = yRow1 + 30; // text: "of 10"
const int yRow9 = gScreenHeight - 10; // "v1.14, Jan 22 2024"
#define xButton 160 // indented column of buttons
// names for the array indexes, must be named in same order as array below
enum txtSettings {
SETTINGS = 0,
BIGVOLUME,
LINE1,
LINE2,
MUTELABEL,
PANEL,
};
// clang-format off
#define numVolFields 5
TextField txtVolume[numVolFields] = {
// text x, y color alignment size
{"Speaker", -1, 20, cHIGHLIGHT, ALIGNCENTER, eFONTSMALLEST}, // [SETTINGS]
{"0", 82, yRow2, cVALUE, ALIGNRIGHT, eFONTGIANT}, // [BIGVOLUME] giant audio volume display
{"Audio Volume", 98, yRow1, cLABEL, ALIGNLEFT, eFONTSMALL}, // [LINE1] normal size text labels
{"of 10", 98, yRow2, cLABEL, ALIGNLEFT, eFONTSMALL}, // [LINE2]
{" Mute", 216, 180, cBUTTONLABEL, ALIGNLEFT, eFONTSMALL}, // [MUTELABEL] leading blanks to be on top of "Unmute"
//{"1 of 6", xPanel, 20, cFAINT}, // [PANEL]
};
// clang-format on
enum functionID {
UP_ID = 0,
DOWN_ID,
MUTE_ID,
};
// clang-format off
#define nVolButtons 3
FunctionButton volButtons[nVolButtons] = {
// label origin size touch-target
// text x,y w,h x,y w,h radius color functionID
{"", 48, 108, 126, 62, { 47, 107, 128, 64}, 10, cBUTTONLABEL, UP_ID}, // Up
{"", 48, 176, 126, 62, { 47, 175, 128, 64}, 10, cBUTTONLABEL, DOWN_ID}, // Down
{"", 210, 142, 92, 62, {208, 141, 112, 64}, 10, cBUTTONLABEL, MUTE_ID}, // Mute
};
// clang-format on
#define numLevels 11
const int volLevel[numLevels] = {
// Digital potentiometer settings, about 2 dB steps = ratio 1.585
0, // [0] mute, lowest allowed wiper position
1, // [1] lowest possible position with non-zero output
2, // [2] next lowest poss
4, // [3] 2.000 * 1.585 = 4.755
7, // [4] 4.755 * 1.585 = 7.513
12, // [5] 7.513 * 1.585 = 11.908
19, // [6] 11.908 * 1.585 = 18.874
29, // [7] 18.874 * 1.585 = 29.916
47, // [8] 29.916 * 1.585 = 47.417
75, // [9] 47.417 * 1.585 = 75.155
99, // [10] max allowed wiper position
};
// ---------- local functions for this derived class ----------
void setVolume(int volIndex) {
// set digital potentiometer
// @param volIndex = 0..10
int wiperPosition = volLevel[volIndex];
#if defined(ARDUINO_ADAFRUIT_FEATHER_RP2040)
// todo - add code to control new I2C volume control chip
#else
#define PIN_VCS A1 // chip select pin for DS1804 volume control via SPI
pinMode(PIN_VCS, OUTPUT); // fix bug that somehow forgets this is an output pin
volume.unlock(); // enable (set low)
volume.setWiperPosition(wiperPosition);
#endif
char msg[256];
snprintf(msg, 256, "Set volume index %d, wiper position %d", volIndex, wiperPosition); // debug
logger.info(msg);
}
void changeVolume(int diff) {
gVolIndex += diff;
gVolIndex = constrain(gVolIndex, 0, numLevels - 1);
setVolume(gVolIndex);
this->updateScreen(); // update screen _before_ playing lengthy morse code
}
void volumeUp() {
if (gMute) {
unmuteVolume();
} else {
changeVolume(+1); // increase volume
}
}
void volumeDown() {
if (gMute) {
unmuteVolume();
} else {
changeVolume(-1); // decrease volume
}
}
void volumeMute() { // mute
// we keep track of "mute" status separately from "volume" level
if (gMute) {
// already muted, so UN mute
unmuteVolume();
} else {
// mute volume
gMute = true;
txtVolume[BIGVOLUME].setColor(cDISABLED);
txtVolume[BIGVOLUME].setBackground(cBACKGROUND);
txtVolume[MUTELABEL].setBackground(cBUTTONFILL);
txtVolume[MUTELABEL].print("Unmute");
setVolume(0);
}
}
void unmuteVolume() {
gMute = false;
txtVolume[BIGVOLUME].setColor(cVALUE);
txtVolume[BIGVOLUME].setBackground(cBACKGROUND);
txtVolume[MUTELABEL].setBackground(cBUTTONFILL);
txtVolume[MUTELABEL].print(" Mute"); // leading blanks to align it on top of "Unmute"
setVolume(gVolIndex);
}
}; // end class ViewVolume
// ============== implement public interface ================
void ViewVolume::updateScreen() {
// called on every pass through main()
// ----- fill in replacment string text
txtVolume[BIGVOLUME].setBackground(cBACKGROUND);
txtVolume[BIGVOLUME].print(gVolIndex);
txtVolume[MUTELABEL].setBackground(cBUTTONFILL);
txtVolume[MUTELABEL].print();
} // end updateScreen
void ViewVolume::startScreen() {
// called once each time this view becomes active
this->clearScreen(cBACKGROUND); // clear screen
txtVolume[BIGVOLUME].setBackground(cBACKGROUND); // set background for all TextFields in this view
TextField::setTextDirty(txtVolume, numVolFields); // make sure all fields get re-printed on screen change
drawAllIcons(); // draw gear (settings) and arrow (next screen)
showDefaultTouchTargets(); // optionally draw box around default button-touch areas
showMyTouchTargets(volButtons, nVolButtons); // optionally show this view's touch targets
showScreenBorder(); // optionally outline visible area
showScreenCenterline(); // optionally draw visual alignment bar
// ----- draw buttons
for (int ii = 0; ii < nVolButtons; ii++) {
FunctionButton item = volButtons[ii];
tft->fillRoundRect(item.x, item.y, item.w, item.h, item.radius, cBUTTONFILL);
tft->drawRoundRect(item.x, item.y, item.w, item.h, item.radius, cBUTTONOUTLINE);
// ----- label on top of button
if (strlen(item.text) > 0) {
tft->setCursor(item.x + 20, item.y + 32);
tft->setTextColor(cVALUE);
tft->print(item.text);
}
}
// ----- draw text fields
// draw text AFTER buttons because the MUTE text is on top of a button
for (int ii = 0; ii < numVolFields; ii++) {
int bkg = (ii == MUTELABEL) ? cBUTTONFILL : cBACKGROUND; // TODO:
txtVolume[ii].setBackground(bkg);
txtVolume[ii].print();
}
// ----- icons on buttons
int ht = 24; // height of triangle
int ww = 16; // width of triangle
int nn = 8; // nudge toward center of button
int xx = volButtons[0].x + volButtons[0].w / 2; // centerline is halfway in the middle
int yy = volButtons[0].y + volButtons[0].h / 2; // baseline is halfway in the middle
// x0,y0, x1,y1, x2,y2, color
tft->fillTriangle(xx - ww, yy + nn, xx + ww, yy + nn, xx, yy - ht + nn, cVALUE); // arrow UP
yy = volButtons[1].y + volButtons[1].h / 2;
tft->fillTriangle(xx - ww, yy - nn, xx + ww, yy - nn, xx, yy + ht - nn, cVALUE); // arrow DOWN
showProgressBar(1, 8); // draw marker for advancing through settings
updateScreen(); // update UI immediately, don't wait for laggy mainline loop
} // end startScreen()
void ViewVolume::endScreen() {
// Called once each time this view becomes INactive
// This is a 'goodbye kiss' to do cleanup work
// For the volume control, save our settings here instead of on each
// button press because writing to NVR is slow (0.5 sec) and would delay the user
// while trying to press a button many times in a row.
saveConfig();
}
bool ViewVolume::onTouch(Point touch) {
logger.info("->->-> Touched volume screen.");
bool handled = false; // assume a touch target was not hit
for (int ii = 0; ii < nVolButtons; ii++) {
FunctionButton item = volButtons[ii];
if (item.hitTarget.contains(touch)) {
handled = true; // hit!
switch (item.functionIndex) // do the thing
{
case UP_ID:
volumeUp();
break;
case DOWN_ID:
volumeDown();
break;
case MUTE_ID:
volumeMute();
break;
default:
logger.error("Error, unknown function ", item.functionIndex);
break;
}
updateScreen(); // update UI immediately, don't wait for laggy mainline loop
if (!gMute) {
// audible example
announceGrid("hi", 4);
/*
// announce grid square for an audible example of this selection
char newGrid4[7];
calcLocator(newGrid4, model->gLatitude, model->gLongitude, 4);
announceGrid(newGrid4, 4); // announce by Morse code OR speech
*/
/*
dacMorse.setMessage("hi"); // announce new volume in Morse code
dacMorse.sendBlocking();
dacSpeech.play("/audio/7.wav"); // announce new volume in Spoken Word
dacSpeech.play("/audio/3.wav");
*/
}
}
}
return handled; // true=handled, false=controller uses default action
} // end onTouch()
// ========== load/save config setting =========================
#define VOLUME_CONFIG_FILE CONFIG_FOLDER "/volume.cfg"
#define CONFIG_VOLUME_VERSION "Volume v02"
// ----- load from SDRAM -----
void ViewVolume::loadConfig() {
SaveRestore config(VOLUME_CONFIG_FILE, CONFIG_VOLUME_VERSION);
int tempVolIndex = 0;
int result = config.readConfig((byte *)&tempVolIndex, sizeof(tempVolIndex));
if (result) {
gVolIndex = constrain(tempVolIndex, 0, 10); // global volume index
setVolume(gVolIndex); // set the hardware to this volume index
logger.info("Loaded volume setting from NVR: ", gVolIndex);
} else {
logger.error("Failed to load Volume control settings, re-initializing config file");
saveConfig();
}
}
// ----- save to SDRAM -----
void ViewVolume::saveConfig() {
SaveRestore config(VOLUME_CONFIG_FILE, CONFIG_VOLUME_VERSION);
config.writeConfig((byte *)&gVolIndex, sizeof(gVolIndex));
}