-
Notifications
You must be signed in to change notification settings - Fork 21
/
mod_configui.h
1103 lines (997 loc) · 36 KB
/
mod_configui.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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
__ __| | | /_) | ___| | |
| __ \ _ \ ' / | | / | _ \ __ \ | _` | __ \ __|
| | | | __/ . \ | < | | __/ | | | ( | | |\__ \
_| _| |_|\___| _|\_\_|_|\_\\____|\___|_| _| _____|\__,_|_.__/ ____/
-----------------------------------------------------------------------------
USBMIDIKLIK 4X4 - USB Midi advanced firmware for STM32F1 platform.
Copyright (C) 2019 by The KikGen labs.
LICENCE CREATIVE COMMONS - Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
This file is part of the USBMIDIKLIK-4x4 distribution
https://github.com/TheKikGen/USBMidiKliK4x4
Copyright (c) 2019 TheKikGen Labs team.
-----------------------------------------------------------------------------
Disclaimer.
This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/
or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
NON COMMERCIAL - PERSONAL USE ONLY : You may not use the material for pure
commercial closed code solution without the licensor permission.
You are free to copy and redistribute the material in any medium or format,
adapt, transform, and build upon the material.
You must give appropriate credit, a link to the github site
https://github.com/TheKikGen/USBMidiKliK4x4 , provide a link to the license,
and indicate if changes were made. You may do so in any reasonable manner,
but not in any way that suggests the licensor endorses you or your use.
You may not apply legal terms or technological measures that legally restrict
others from doing anything the license permits.
You do not have to comply with the license for elements of the material
in the public domain or where your use is permitted by an applicable exception
or limitation.
No warranties are given. The license may not give you all of the permissions
necessary for your intended use. This program is distributed in the hope that
it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
///////////////////////////////////////////////////////////////////////////////
// CONFIGURATION USER INTERFACE FUNCTIONS
//-----------------------------------------------------------------------------
// Due to the unusual make process of Arduino platform, this file is directly
// included in the main ino one.
///////////////////////////////////////////////////////////////////////////////
#pragma once
///////////////////////////////////////////////////////////////////////////////
// FUNCTIONS PROTOTYPES
///////////////////////////////////////////////////////////////////////////////
//Shared. See usbmidiKlik4x4.h
//void __O_SMALL ShowBufferHexDump(uint8_t* , uint16_t, uint8_t nl=16 ) ;
uint8_t __O_SMALL GetInt8FromHexChar(char);
uint16_t __O_SMALL GetInt16FromHex4Char(char *);
uint16_t __O_SMALL GetInt16FromHex4Bin(char * );
//Shared. See usbmidiKlik4x4.h
//void __O_SMALL SerialPrintf(const char *format, ...) ;
uint16_t __O_SMALL PowInt(uint8_t ,uint8_t);
uint16_t __O_SMALL AsknNumber(uint8_t,boolean nl=true);
char __O_SMALL AskDigit();
char __O_SMALL AskChar();
uint8_t __O_SMALL AsknHexChar(char *, uint8_t ,char,char);
char __O_SMALL AskChoice(const char * , const char *,boolean nl=true);
void __O_SMALL ShowMask16(uint16_t ,uint8_t );
void __O_SMALL ShowPipelineSlotBrowser(boolean mustLoop=true);
void __O_SMALL ShowMidiRoutingLine(uint8_t ,uint8_t );
void __O_SMALL ShowMidiRouting(uint8_t);
void __O_SMALL ShowMidiKliKHeader();
void __O_SMALL ShowGlobalSettings();
uint16_t __O_SMALL AskMidiRoutingTargets(uint8_t,uint8_t , uint8_t );
void __O_SMALL AskMidiRouting(uint8_t);
void __O_SMALL AskProductString();
void __O_SMALL AskVIDPID();
void __O_SMALL MenuItems( const char * );
void __O_SMALL ShowConfigMenu();
///////////////////////////////////////////////////////////////////////////////
// Strings const used in UI
//////////////////////////////////////////////////////////////////////////////
// _M : Major Case. _B : Beautified.
const char* str_16DIGITS = "1234567890123456";
const char* str_71DIGITS = "1111111";
const char* str_BYPASS = "bypass";
const char* str_MIDI = "midi";
const char* str_IN = "in";
const char* str_OUT = "out";
const char* str_CABLE = "cable";
const char* str_JACK = "jack";
const char* str_VIRTUAL = "virtual";
const char* str_ROUTING = "routing";
const char* str_PIPELINE = "pipeline";
const char* str_VIRT = "virt.";
const char* str_SLOT = "slot";
const char* str_ENABLE = "enable";
const char* str_ENABLED = "enabled";
const char* str_DISABLE = "disable";
const char* str_DISABLED = "disabled";
const char* str_USB_M = "USB";
const char* str_PORT = "port";
const char* str_ERROR_B = "Error";
const char* str_TRYAGAIN_B = "Try again";
const char* str_ITHRU = "ithru";
const char* str_DEVICE_ID_B = "Device ID";
const char* str_SETTINGS = "settings";
const char* str_SETTINGS_M = "SETTINGS";
const char* str_DONE_B = "Done";
const char* str_MASTER_M = "MASTER";
const char* str_MASTER = "master";
const char* str_SLAVE_M = "SLAVE";
const char* str_SLAVE = "slave";
const char* str_NO_CHG_MADE = "no change made";
///////////////////////////////////////////////////////////////////////////////
// DUMP a byte buffer to screen
//////////////////////////////////////////////////////////////////////////////
void ShowBufferHexDump(uint8_t* bloc, uint16_t sz,uint8_t nl)
{
uint8_t j=0;
uint8_t * pp = bloc;
for (uint16_t i=0; i != sz; i++) {
SerialPrintf("%02x",*pp);
Serial.print(" ");
if (nl && (++j >= nl) ) { Serial.println(); j=0; }
pp++;
}
}
///////////////////////////////////////////////////////////////////////////////
// Get an Int8 From a hex char. letters are minus.
// Warning : No control of the size or hex validity!!
///////////////////////////////////////////////////////////////////////////////
uint8_t GetInt8FromHexChar(char c)
{
return (uint8_t) ( c <= '9' ? c - '0' : c - 'a' + 0xa );
}
///////////////////////////////////////////////////////////////////////////////
// Get an Int16 From a 4 Char hex array. letters are minus.
// Warning : No control of the size or hex validity!!
///////////////////////////////////////////////////////////////////////////////
uint16_t GetInt16FromHex4Char(char * buff)
{
char val[4];
for ( uint8_t i =0; i != sizeof(val) ; i++ )
val[i] = GetInt8FromHexChar(buff[i]);
return GetInt16FromHex4Bin(val);
}
///////////////////////////////////////////////////////////////////////////////
// Get an Int16 From a 4 hex digit binary array.
// Warning : No control of the size or hex validity!!
///////////////////////////////////////////////////////////////////////////////
uint16_t GetInt16FromHex4Bin(char * buff)
{
return (uint16_t) ( (buff[0] << 12) + (buff[1] << 8) + (buff[2] << 4) + buff[3] );
}
///////////////////////////////////////////////////////////////////////////////
// SerialPrintf : a light printf like to Serial.
// %% : %
// %n : new line
// %s : strings
// %m : string minor case
// %M : string major case
// %y : string beautify (fist letter major case)
// %c : character
// %x : hexa
// %d : integer
// %b : binary
// %(n)s : print n char from string or char array
// %(nn)d/x/b : pad space left until size n
// %(0n)d/x/b : pad 0 left untile size n (nb for b : n=32 bits max).
///////////////////////////////////////////////////////////////////////////////
#define _PRINT_OUT Serial.print
void SerialPrintf(const char *format, ...)
{
va_list varg;
va_start(varg, format);
while ( *format != 0 ) {
if (*format == '%') {
format++;
if (*format == '%') _PRINT_OUT(*format);
else if (*format == 'b') _PRINT_OUT(va_arg(varg, long),BIN); // Binary
else if (*format == 'c') _PRINT_OUT((char)va_arg(varg, int)); // Char (must be casted to int)
else if (*format == 'd') _PRINT_OUT(va_arg(varg, long )); // long int
else if (*format == 'u') _PRINT_OUT(va_arg(varg, unsigned long)); // u long int
else if (*format == 'x') _PRINT_OUT(va_arg(varg, long),HEX); // hexa
else if (*format == 's' || *format == 'M' || *format == 'm' || *format == 'y') {
char * str=va_arg(varg, char*);
uint16_t i = 0;
while (*str) {
char c = *str;
if ( c >= 'A' && c <= 'Z' ) {
if ( *format == 'm' || (*format == 'y' && i > 0) ) c += 0x20;
} else
if ( c >= 'a' && c <= 'z') {
if ( *format == 'M' || (*format == 'y' && i == 0) ) c -= 0x20;
}
_PRINT_OUT(c); str++; i++;
}
}
else if (*format >= '0' && *format <= '9' ) {
char p =' ';
if ( *format == '0') { format++; p = '0';}
if ( *format >='1' && *format <= '9' ) {
uint8_t pad = *format - '0';
format++;
if ( *format >='0' && *format <= '9' ) pad = pad*10 + *(format++) - '0';
if ( *format == 'c' ) {
while (--pad) _PRINT_OUT(p);
_PRINT_OUT((char)va_arg(varg, int));
}
else if ( *format == 's' || *format == 'M' || *format == 'm' || *format == 'y') {
char * str=va_arg(varg, char*);
uint16_t i = 0;
while (pad--) {
if (*str) {
char c = *str;
if ( c >= 'A' && c <= 'Z' ) {
if ( *format == 'm' || (*format == 'y' && i > 0) ) c += 0x20;
} else
if ( c >= 'a' && c <= 'z') {
if ( *format == 'M' || (*format == 'y' && i == 0) ) c -= 0x20;
}
_PRINT_OUT(c); str++; i++;
}
else break;
}
}
else {
uint8_t base = 0;
if ( *format == 'd' ) base = 10;
else if ( *format =='x' ) base = 16;
else if ( *format =='b' ) {
base = 2;
if ( pad > 32 ) pad = 8; // 32 bits max
}
if (base) {
int value = va_arg(varg, long);
uint32_t pw = base;
while (pad--) {
if ( value < (int)pw ) while (pad) { _PRINT_OUT(p);pad--;}
else pw *= base;
}
if (base == 16) _PRINT_OUT(value,HEX);
else if (base == 2) _PRINT_OUT(value,BIN);
else _PRINT_OUT(value);
}
}
} else return;
}
else if (*format == 'n') Serial.println(); // new line
else return;
} else Serial.print(*format);
format++;
}
va_end(varg);
}
///////////////////////////////////////////////////////////////////////////////
// A Pow function to not use the fat float math library one
///////////////////////////////////////////////////////////////////////////////
uint16_t PowInt(uint8_t p,uint8_t n)
{
if (n == 0) return 1;
uint16_t pow = 1;
while ( n--) pow = pow * p;
return pow;
}
///////////////////////////////////////////////////////////////////////////////
// USB serial get a number of N digit (long)
///////////////////////////////////////////////////////////////////////////////
uint16_t AsknNumber(uint8_t n,boolean nl)
{
uint16_t v=0;
uint8_t choice;
while (n--) {
v += ( (choice = AskDigit() ) - '0' )*PowInt(10,n);
Serial.print(choice - '0');
}
if (nl) Serial.println();
return v;
}
///////////////////////////////////////////////////////////////////////////////
// USB serial getdigit
///////////////////////////////////////////////////////////////////////////////
char AskDigit()
{
char c;
while ( ( c = AskChar() ) <'0' && c > '9');
return c;
}
///////////////////////////////////////////////////////////////////////////////
// USB serial getchar
///////////////////////////////////////////////////////////////////////////////
char AskChar()
{
while (!Serial.available() >0);
char c = Serial.read();
// Flush
while (Serial.available()>0) Serial.read();
return c;
}
///////////////////////////////////////////////////////////////////////////////
// "Scanf like" for hexadecimal inputs
///////////////////////////////////////////////////////////////////////////////
uint8_t AsknHexChar(char *buff, uint8_t len,char exitchar,char sepa)
{
uint8_t i = 0, c = 0;
while ( i < len ) {
c = AskChar();
if ( (c >= '0' && c <= '9') || (c >= 'a' && c <= 'f' ) ) {
Serial.write(c);
if (sepa) Serial.write(sepa);
buff[i++] = GetInt8FromHexChar(c);
} else if (c == exitchar && exitchar !=0 ) break;
}
return i;
}
///////////////////////////////////////////////////////////////////////////////
// Get a choice from a question
///////////////////////////////////////////////////////////////////////////////
char AskChoice(const char * qLabel, const char * choices,boolean nl)
{
char c;
const char * yn = "yn";
const char * ch;
if ( *choices == 0 ) ch = yn; else ch = choices;
SerialPrintf("%s (%s) ? ",qLabel,ch);
while (1) {
c = AskChar();
uint8_t i=0;
while (ch[i] )
if ( c == ch[i++] ) {
Serial.write(c);
if (nl) Serial.println();
return c;
}
}
}
///////////////////////////////////////////////////////////////////////////////
// Show a 16 bits mask value with "X" and "."
///////////////////////////////////////////////////////////////////////////////
void ShowMask16(uint16_t bitMsk,uint8_t maxValue)
{
// IN targets ports
for ( uint8_t p =0; p != 16 ; p++) {
if (p >= maxValue ) {
Serial.print(" ");
} else {
if ( bitMsk & ( 1 << p) ) Serial.print("X");
else Serial.print(".");
}
}
}
///////////////////////////////////////////////////////////////////////////////
// Browse pipelines
///////////////////////////////////////////////////////////////////////////////
void ShowPipelineSlotBrowser(boolean mustLoop)
{
while (1) {
SerialPrintf("Enter %s %s 1-8, or 0 to exit :",str_PIPELINE,str_SLOT);
uint8_t choice = AsknNumber(1);
if ( choice == 0 ) break;
if ( choice >= 1 && choice <= TRANS_PIPELINE_SLOT_SIZE ) {
ShowPipelineSlot(choice);
Serial.println();
if (!mustLoop) break;
}
}
}
///////////////////////////////////////////////////////////////////////////////
// Show a routing table line
///////////////////////////////////////////////////////////////////////////////
void ShowMidiRoutingLine(uint8_t port,uint8_t portType)
{
uint8_t attachedSlot = 0;
uint16_t cbInTgMsk =0;
uint16_t jkOutTgMsk =0;
uint16_t vrInTgMsk =0;
if (portType == PORT_TYPE_CABLE ) {
attachedSlot = EE_Prm.rtRulesCable[port].slot;
cbInTgMsk = EE_Prm.rtRulesCable[port].cbInTgMsk;
jkOutTgMsk = EE_Prm.rtRulesCable[port].jkOutTgMsk;
vrInTgMsk = EE_Prm.rtRulesCable[port].vrInTgMsk;
} else
if ( portType == PORT_TYPE_JACK ) {
attachedSlot = EE_Prm.rtRulesJack[port].slot;
cbInTgMsk = EE_Prm.rtRulesJack[port].cbInTgMsk;
jkOutTgMsk = EE_Prm.rtRulesJack[port].jkOutTgMsk;
vrInTgMsk = EE_Prm.rtRulesJack[port].vrInTgMsk;
} else
if (portType == PORT_TYPE_VIRTUAL ) {
attachedSlot = EE_Prm.rtRulesVirtual[port].slot;
cbInTgMsk = EE_Prm.rtRulesVirtual[port].cbInTgMsk;
jkOutTgMsk = EE_Prm.rtRulesVirtual[port].jkOutTgMsk;
}
else return;
// print a full new line
// Port
SerialPrintf("| %2d | ",port+1);
if ( attachedSlot)
Serial.print(attachedSlot);
else
Serial.print(".");
Serial.print(" | ");
// Cable IN targets ports
ShowMask16(cbInTgMsk,UsbCableInterfaceMax);
Serial.print(" | ");
// Jack Out targets ports
ShowMask16(jkOutTgMsk,SERIAL_INTERFACE_COUNT);
Serial.print(" | ");
// Clock attached to virtual ports
if ( portType == PORT_TYPE_VIRTUAL) {
if (port < MIDI_CLOCKGEN_MAX ) {
uint16_t bpm = EE_Prm.bpmClocks[port].bpm/10;
uint16_t bpmDec = EE_Prm.bpmClocks[port].bpm - bpm*10 ;
SerialPrintf(" | %c %3d.%d %c |",EE_Prm.bpmClocks[port].mtc ? 'X':'.',bpm,bpmDec,EE_Prm.bpmClocks[port].enabled ? 'X':'.');
}
}
else {
// virtual Out targets ports if not a virtual port
ShowMask16(vrInTgMsk,VIRTUAL_INTERFACE_MAX);
Serial.print(" |");
// Ithru if jack serial line
if ( portType == PORT_TYPE_JACK ) {
// IThru mask
Serial.print(" ");
if ( EE_Prm.ithruJackInMsk & ( 1 << port) )
Serial.print("X");
else
Serial.print(".");
// pipeLine slot
Serial.print(" | ");
if ( EE_Prm.rtRulesIthru[port].slot)
Serial.print( EE_Prm.rtRulesIthru[port].slot);
else
Serial.print(".");
Serial.print(" | ");
// Ithu Out targets ports
ShowMask16(EE_Prm.rtRulesIthru[port].jkOutTgMsk,SERIAL_INTERFACE_COUNT);
Serial.print(" | ");
ShowMask16(EE_Prm.rtRulesIthru[port].vrInTgMsk,VIRTUAL_INTERFACE_MAX);
Serial.print(" |");
}
}
Serial.println();
}
///////////////////////////////////////////////////////////////////////////////
// Show the midi routing map for a specific port type
///////////////////////////////////////////////////////////////////////////////
void ShowMidiRouting(uint8_t portType)
{
uint8_t maxPorts = 0;
// Cable
if (portType == PORT_TYPE_CABLE) {
SerialPrintf("%M %M",str_CABLE,str_OUT);
maxPorts = UsbCableInterfaceMax;
}
// Serial
else
if (portType == PORT_TYPE_JACK) {
SerialPrintf("%M %M",str_JACK,str_IN);
maxPorts = SERIAL_INTERFACE_COUNT;
}
// Virtual
else
if (portType == PORT_TYPE_VIRTUAL) {
SerialPrintf("%M %M",str_VIRTUAL,str_IN);
maxPorts = VIRTUAL_INTERFACE_MAX;
} else return;
SerialPrintf(" %M (%d %s(s) found)%n",str_ROUTING,maxPorts,str_PORT);
Serial.println();
Serial.print("| ");
if (portType == PORT_TYPE_CABLE) Serial.print("Cb");
else if (portType == PORT_TYPE_VIRTUAL) Serial.print("Vr");
else if (portType == PORT_TYPE_JACK) Serial.print("Jk");
else return;
SerialPrintf(" | %y",str_PIPELINE);
SerialPrintf(" | %y %M %s",str_CABLE,str_IN,str_71DIGITS);
SerialPrintf(" | %y %M %s",str_JACK,str_OUT,str_71DIGITS);
// Show clocks attached to virtual ports
if ( portType == PORT_TYPE_VIRTUAL) SerialPrintf(" |<-| Clock Generator ");
else {
SerialPrintf(" | %y %M %s",str_VIRT,str_IN,str_71DIGITS);
if ( portType == PORT_TYPE_JACK) {
SerialPrintf(" | <-- %M --> %y %M %s",str_ITHRU,str_JACK,str_OUT,str_71DIGITS);
SerialPrintf(" | %y %M %s",str_VIRT,str_IN,str_71DIGITS);
}
}
Serial.println(" |");
// Header line 2
SerialPrintf("| | %y | %s | %s",str_SLOT,str_16DIGITS,str_16DIGITS);
if ( portType == PORT_TYPE_VIRTUAL) SerialPrintf(" | | MTC Bpm %y",str_ENABLED);
else {
SerialPrintf(" | %s",str_16DIGITS);
if ( portType == PORT_TYPE_JACK)
SerialPrintf(" | %y | %y | %s | %s",str_ENABLED,str_SLOT,str_16DIGITS,str_16DIGITS);
}
Serial.println(" |");
for (uint8_t p=0; p != maxPorts ; p++) ShowMidiRoutingLine(p,portType);
Serial.println();
if ( portType == PORT_TYPE_JACK) {
SerialPrintf("%M mode is %s.%n",str_ITHRU,EE_Prm.ithruJackInMsk ? str_ENABLED:str_DISABLED);
SerialPrintf("%s idle detection time :%ds%n",str_USB_M,EE_Prm.ithruUSBIdleTimePeriod*15);
}
}
///////////////////////////////////////////////////////////////////////////////
// Show MidiKlik Header on screen
///////////////////////////////////////////////////////////////////////////////
void ShowMidiKliKHeader()
{
SerialPrintf("USBMIDIKLIK 4x4 - %s",HARDWARE_TYPE);
if ( IS_BUS_E && IS_MASTER ) SerialPrintf(" (%s ON BUS)",str_MASTER_M );
else if ( IS_BUS_E && IS_SLAVE ) SerialPrintf(" (%s %d ON BUS)",str_SLAVE_M,EE_Prm.I2C_DeviceId );
SerialPrintf("%nV%d.%d - Build %s - (c) TheKikGen Labs%n",VERSION_MAJOR,VERSION_MINOR,(char *)EE_Prm.TimestampedVersion);
Serial.println("https://github.com/TheKikGen/USBMidiKliK4x4");
}
///////////////////////////////////////////////////////////////////////////////
// Show current EEPROM settings
///////////////////////////////////////////////////////////////////////////////
void ShowGlobalSettings()
{
uint8_t i;
SerialPrintf("GLOBAL %s%n%n",str_SETTINGS_M);
SerialPrintf("Hardware type : %s%n",HARDWARE_TYPE);
SerialPrintf("MCU Flash size : %dK%n",*(uint16_t *)0x1FFFF7E0);
SerialPrintf("Firmware version : %d.%d - Build %s%n",EE_Prm.majorVersion, EE_Prm.minorVersion,(char *)EE_Prm.TimestampedVersion);
SerialPrintf("Magic number : %3s%d%n",EE_Prm.signature,EE_Prm.prmVersion);
SerialPrintf("Sysex header : ");
for (i=0; i != sizeof(sysExInternalHeader); i++) { SerialPrintf("%02x ",sysExInternalHeader[i]);}
SerialPrintf("%n%s VID - PID : %04x - %04x%n",str_USB_M,EE_Prm.vendorID,EE_Prm.productID);
SerialPrintf("%s Product string : ",str_USB_M);
Serial.write(EE_Prm.productString, sizeof(EE_Prm.productString));
Serial.println();
// Midi ports
SerialPrintf("%M %s(s) number : %y:%d - %y:%d - %y:%d%n",str_MIDI,str_PORT,str_CABLE,UsbCableInterfaceMax,str_JACK,SERIAL_INTERFACE_COUNT,str_VIRTUAL,VIRTUAL_INTERFACE_MAX);
// Bus Mode
SerialPrintf("%nI2C Bus mode : %M%n",EE_Prm.I2C_BusModeState == B_DISABLED ? str_DISABLED:str_ENABLED);
SerialPrintf("I2C %s : %d (%s)%n",str_DEVICE_ID_B,EE_Prm.I2C_DeviceId,IS_MASTER ? str_MASTER:str_SLAVE);
SerialPrintf("EEPROM param. size : %d / %d (%d %%)%n",sizeof(EEPROM_Prm_t),EE_CAPACITY,((int)sizeof(EEPROM_Prm_t)*100) / ((int)EE_CAPACITY));
}
///////////////////////////////////////////////////////////////////////////////
// Setup a Midi routing target on screen
///////////////////////////////////////////////////////////////////////////////
uint16_t AskMidiRoutingTargets(uint8_t portType,uint8_t portTypeOut, uint8_t port)
{
uint16_t targetsMsk = 0;
uint8_t portMax;
if (portTypeOut == PORT_TYPE_CABLE) portMax = UsbCableInterfaceMax;
else if (portTypeOut == PORT_TYPE_JACK ) portMax = SERIAL_INTERFACE_COUNT;
else if (portTypeOut == PORT_TYPE_VIRTUAL) portMax = VIRTUAL_INTERFACE_MAX;
else return 0;
char choice;
for ( uint8_t i=0 ; i != portMax ; i++ ){
Serial.print("Route ");
if (portType == PORT_TYPE_CABLE ) SerialPrintf("%s %M %s",str_CABLE,str_OUT,str_PORT);
else if (portType == PORT_TYPE_JACK ) SerialPrintf("%s %M %s",str_JACK,str_IN,str_PORT);
else if (portType == PORT_TYPE_VIRTUAL ) SerialPrintf("%s %M %s",str_VIRTUAL,str_IN,str_PORT);
else return 0;
SerialPrintf("# %02d to ",port+1);
if (portTypeOut == PORT_TYPE_CABLE ) SerialPrintf("%s %M %s",str_CABLE,str_IN,str_PORT);
else if (portTypeOut == PORT_TYPE_JACK ) SerialPrintf("%s %M %s",str_JACK,str_OUT,str_PORT);
else if (portTypeOut == PORT_TYPE_VIRTUAL ) SerialPrintf("%s %M %s",str_VIRTUAL,str_IN,str_PORT);
else return 0;
SerialPrintf("# %02d",i+1);
choice = AskChoice(" (x to exit)","ynx");
if (choice == 'x') break;
else if ( choice == 'y') targetsMsk |= (1 << i);
}
return targetsMsk;
}
///////////////////////////////////////////////////////////////////////////////
// Setup a Midi routing rule on screen
///////////////////////////////////////////////////////////////////////////////
void AskMidiRouting(uint8_t portType)
{
uint8_t portMax;
uint8_t choice;
uint16_t cTargets=0;
uint16_t jTargets=0;
uint16_t vTargets=0;
uint8_t port =0;
uint8_t attachedSlot=0;
if (portType != PORT_TYPE_CABLE && portType != PORT_TYPE_JACK && portType != PORT_TYPE_ITHRU && portType != PORT_TYPE_VIRTUAL) return ;
if (portType == PORT_TYPE_CABLE) {
portMax = UsbCableInterfaceMax;
SerialPrintf("%M %M",str_CABLE,str_OUT);
}
else if (portType == PORT_TYPE_JACK || portType == PORT_TYPE_ITHRU) {
portMax = SERIAL_INTERFACE_COUNT;
SerialPrintf("%M %M %M",str_JACK,str_IN,portType == PORT_TYPE_ITHRU ? str_ITHRU:"");
}
else if (portType == PORT_TYPE_VIRTUAL) {
portMax = VIRTUAL_INTERFACE_MAX;
SerialPrintf("%M %M",str_VIRTUAL,str_IN);
}
else return ;
SerialPrintf (" %M - Enter %s# (01-%02d) / 00 to exit) :",str_ROUTING,str_PORT,portMax);
while (1) {
choice = AsknNumber(2);
if ( choice > 0 && choice > portMax) {
SerialPrintf("%s. %s :",str_ERROR_B,str_TRYAGAIN_B);
} else break;
}
if (choice == 0) return;
port = choice - 1;
Serial.println();
attachedSlot = (portType == PORT_TYPE_CABLE) ? EE_Prm.rtRulesCable[port].slot :
(portType == PORT_TYPE_JACK) ? EE_Prm.rtRulesJack[port].slot:
(portType == PORT_TYPE_VIRTUAL) ? EE_Prm.rtRulesVirtual[port].slot:
(portType == PORT_TYPE_ITHRU) ? EE_Prm.rtRulesIthru[port].slot:0;
// Slot
SerialPrintf("Enter %s %s 0-8, (0 = no slot) [%d]:",str_PIPELINE,str_SLOT,attachedSlot);
while (1) {
attachedSlot = AsknNumber(1);
if ( attachedSlot == 0 || attachedSlot <= TRANS_PIPELINE_SLOT_SIZE ) break;
SerialPrintf("%s. %s :",str_ERROR_B,str_TRYAGAIN_B);
}
// Targets
Serial.println();
if (portType != PORT_TYPE_ITHRU) {
cTargets = AskMidiRoutingTargets(portType,PORT_TYPE_CABLE,port);
Serial.println();
jTargets = AskMidiRoutingTargets(portType,PORT_TYPE_JACK,port);
Serial.println();
if (portType != PORT_TYPE_VIRTUAL)
vTargets = AskMidiRoutingTargets(portType,PORT_TYPE_VIRTUAL,port);
} else {
if ( EE_Prm.rtRulesIthru[port].jkOutTgMsk ||
EE_Prm.rtRulesIthru[port].vrInTgMsk) {
// Enable of disable an existing ITHRU routing
SerialPrintf("Keep existing %s",str_ROUTING);
if (AskChoice("","") == 'y') {
SerialPrintf("%y",(EE_Prm.ithruJackInMsk & (1 << port) ) ? str_DISABLE:str_ENABLE);
SerialPrintf(" thru mode %s",str_ROUTING);
if (AskChoice("","") == 'y') {
EE_Prm.ithruJackInMsk ^= (1 << port);
SerialPrintf("%y %M %s.%n",str_JACK,str_IN,(EE_Prm.ithruJackInMsk & (1 << port)) ? str_ENABLED:str_DISABLED);
}
return;
}
}
jTargets = AskMidiRoutingTargets(PORT_TYPE_JACK,PORT_TYPE_JACK,port);
Serial.println();
vTargets = AskMidiRoutingTargets(PORT_TYPE_JACK,PORT_TYPE_VIRTUAL,port);
}
Serial.println();
if (portType == PORT_TYPE_CABLE ) {
EE_Prm.rtRulesCable[port].slot = attachedSlot;
EE_Prm.rtRulesCable[port].cbInTgMsk = cTargets;
EE_Prm.rtRulesCable[port].jkOutTgMsk = jTargets ;
EE_Prm.rtRulesCable[port].vrInTgMsk = vTargets ;
}
else if (portType == PORT_TYPE_JACK ) {
EE_Prm.rtRulesJack[port].slot = attachedSlot;
EE_Prm.rtRulesJack[port].cbInTgMsk = cTargets;
EE_Prm.rtRulesJack[port].jkOutTgMsk = jTargets ;
EE_Prm.rtRulesJack[port].vrInTgMsk = vTargets ;
}
else if (portType == PORT_TYPE_VIRTUAL ) {
EE_Prm.rtRulesVirtual[port].slot = attachedSlot;
EE_Prm.rtRulesVirtual[port].cbInTgMsk = cTargets;
EE_Prm.rtRulesVirtual[port].jkOutTgMsk = jTargets ;
}
else if (portType == PORT_TYPE_ITHRU ) {
EE_Prm.rtRulesIthru[port].slot = attachedSlot;
EE_Prm.rtRulesIthru[port].jkOutTgMsk = jTargets ;
EE_Prm.rtRulesIthru[port].vrInTgMsk = vTargets ;
if ( jTargets + vTargets == 0 ) {
EE_Prm.ithruJackInMsk &= ~(1 << port); // Disable
} else EE_Prm.ithruJackInMsk |= (1 << port); // enable Ithru for this port
}
}
///////////////////////////////////////////////////////////////////////////////
// Setup Product String on screen
///////////////////////////////////////////////////////////////////////////////
void AskProductString()
{
uint8_t i = 0;
char c;
char buff [32];
Serial.println("Enter product string - ENTER to terminate :");
while ( i < USB_MIDI_PRODUCT_STRING_SIZE && (c = AskChar() ) !=13 ) {
if ( c >= 32 && c < 127 ) {
Serial.write(c);
buff[i++] = c;
}
}
if ( i > 0 ) {
memset(EE_Prm.productString,0,sizeof(EE_Prm.productString) );
memcpy(EE_Prm.productString,buff,i);
}
}
///////////////////////////////////////////////////////////////////////////////
// Setup PID and VID on screen
///////////////////////////////////////////////////////////////////////////////
void AskVIDPID()
{
char buff [5];
Serial.println("Enter VID - PID, in hex (0-9,a-f) :");
AsknHexChar( (char *) buff, 4, 0, 0);
EE_Prm.vendorID = GetInt16FromHex4Bin((char*)buff);
Serial.print("-");
AsknHexChar( (char * ) buff, 4, 0, 0);
EE_Prm.productID = GetInt16FromHex4Bin((char*)buff);
}
///////////////////////////////////////////////////////////////////////////////
// Show menu items with columns
///////////////////////////////////////////////////////////////////////////////
void MenuItems( const char * menuItems[])
{
uint8_t c = 0;
uint8_t l = 0;
uint8_t nb = 0;
// 3 columns of 10 items max
const char * item[3][10];
// Fill columns
for ( c=0 ; c< 3 ; c++ ) {
for ( l=0 ; l < 10 ; l++) {
if ( strlen(menuItems[nb]) ) item[c][l] = menuItems[nb++];
else {
item[c][l] = 0;
}
}
}
// Print columns
for ( l=0 ; l< 10 ; l++ ) {
for ( c=0 ; c < 3 ; c++) {
if ( *item[c][l] != 0 ) {
if ( *item[c][l] != '.') {
Serial.print("["); Serial.print(*item[c][l]);Serial.print("] ");
Serial.print(item[c][l]+1);
} else Serial.print(" ");
for (uint8_t j = 0 ; j < 30-strlen(item[c][l]) ; j++) Serial.write(' ');
}
}
Serial.println();
}
}
///////////////////////////////////////////////////////////////////////////////
// INFINITE LOOP - CONFIG ROOT MENU
//----------------------------------------------------------------------------
// Allow USBMidLKLIK configuration by using a menu as a user interface
// from the USB serial port.
///////////////////////////////////////////////////////////////////////////////
void ShowConfigMenu()
{
char choice=0;
uint8_t i;
boolean showMenu = true;
static const char * configMenu[] =
{
"0Show global settings",
"1Show midi routing",
"2Usb VID PID",
"3Usb product string",
"4Cable OUT routing",
"5Jack IN routing",
"6IThru routing",
"7USB idle time",
"vVirtual IN routing",
"pShow pipeline",
"cMidi clock",
"8Toggle bus mode",
"9Set device Id",
"aShow active devices",
"dSYSEX settings dump",
".",
"eReload settings",
"fFactory settings",
"rReset routing",
"sSave settings",
"zUpdate Mode",
"xExit",
"!Dump EEPROM",
":Dump Flash memory",
"/Format EEPROM",
""
};
for ( ;; )
{
if (showMenu) {
Serial.println();
ShowMidiKliKHeader();
Serial.println();
MenuItems(configMenu);
}
showMenu = true;
Serial.print("=>");
choice = AskChar();
Serial.println(choice);
Serial.println();
switch (choice)
{
// Show global settings
case '0':
ShowGlobalSettings();
Serial.println();
showMenu = false;
break;
// Show midi routing
case '1':
ShowMidiRouting(PORT_TYPE_VIRTUAL);
Serial.println();
ShowMidiRouting(PORT_TYPE_CABLE);
Serial.println();
ShowMidiRouting(PORT_TYPE_JACK);
Serial.println();
showMenu = false;
break;
// Change VID & PID
case '2':
AskVIDPID();
Serial.println();
showMenu = false;
break;
// Change the product string
case '3':
AskProductString();
Serial.println();
showMenu = false;
break;
// Cables midi routing
case '4':
AskMidiRouting(PORT_TYPE_CABLE);
Serial.println();
break;
// Jack IN midi routing
case '5':
AskMidiRouting(PORT_TYPE_JACK);
Serial.println();
break;
// IntelliThru IN midi routing
case '6':
AskMidiRouting(PORT_TYPE_ITHRU);
Serial.println();
break;
// USB Timeout <number of 15s periods 1-127>
case '7':
Serial.print("15s periods nb (001-127 / 000 to exit) :");
i = AsknNumber(3,false);
if (i == 0 || i >127 )
SerialPrintf(". %s. %y.%n",str_ERROR_B,str_NO_CHG_MADE);
else {
EE_Prm.ithruUSBIdleTimePeriod = i;
SerialPrintf(" <= %s idle time set to %ds%n",str_USB_M,i*15);
}
Serial.println();
showMenu = false;
break;
// Enable Bus mode
case '8':
SerialPrintf("%y bus mode",(EE_Prm.I2C_BusModeState == B_ENABLED)?str_DISABLE:str_ENABLE);
if (AskChoice("","") == 'y' ) {
EE_Prm.I2C_BusModeState = (EE_Prm.I2C_BusModeState == B_ENABLED)? B_DISABLED:B_ENABLED ;
SerialPrintf("%s !%n",str_DONE_B);
}
UsbCableInterfaceMax = EE_Prm.I2C_BusModeState ? 16:4;
showMenu = false;
break;
// Set device ID.
case '9':
SerialPrintf("%s ( %02d:%y, %ys %02d-%02d ) :",str_DEVICE_ID_B,B_MASTERID,str_MASTER,str_SLAVE,B_SLAVE_DEVICE_BASE_ADDR,B_SLAVE_DEVICE_LAST_ADDR);
while (1) {
i = AsknNumber(2);
if ( i != B_MASTERID ) {
if ( i > B_SLAVE_DEVICE_LAST_ADDR || i < B_SLAVE_DEVICE_BASE_ADDR ) {
SerialPrintf("%s. %s :",str_ERROR_B,str_TRYAGAIN_B);
} else break;
} else break;
}
EE_Prm.I2C_DeviceId = i;
Serial.println();
showMenu = false;
break;
// Show active devices on the I2C Bus
case 'a':
Serial.println();
I2C_ShowActiveDevice();
Serial.println();
showMenu = false;
break;
// Set a midi clock
case 'c':
{
SerialPrintf("Clock # (01-%02d / 00 to exit) :",MIDI_CLOCKGEN_MAX);
while (1) {
i = AsknNumber(2);
if ( i == 0 ) break;
if ( i > VIRTUAL_INTERFACE_MAX) SerialPrintf("%n%s. %s :",str_ERROR_B,str_TRYAGAIN_B);
else break;
}
if ( i > 0 ) {
--i;
if (AskChoice("Send Midi Time Clock","") == 'y' ) EE_Prm.bpmClocks[i].mtc = true;
else EE_Prm.bpmClocks[i].mtc = false;
if (AskChoice("Disable midi clock","") == 'y' ) {
if ( !SetMidiEnableClock(i,false) ) SerialPrintf(". %s. %y.%n",str_ERROR_B,str_NO_CHG_MADE);
} else {
Serial.print("Enter BPM (10.0-300) :");
uint16_t bpm1 = AsknNumber(3,false);
Serial.print(".");
uint8_t bpm2 = AsknNumber(1,false);
bpm1 = bpm1 * 10 + bpm2;
if ( !SetMidiBpmClock(i, bpm1) || !SetMidiEnableClock(i,true) ) SerialPrintf(". %s. %y.%n",str_ERROR_B,str_NO_CHG_MADE);
}
}
Serial.println();
showMenu = false;
}
break;
// Sysex config dump
case 'd':
SysexInternal_DumpConfToStream(2);
Serial.println();
break;