Add giabalanai keyboard (#10125)

by 3araht

3 files changed, 261 insertions, 0 deletions

diff --git a/keyboards/giabalanai/keymaps/default/keymap.c b/keyboards/giabalanai/keymaps/default/keymap.c
new file mode 100644
index 0000000000..7b5f524a4f
--- /dev/null
+++ b/keyboards/giabalanai/keymaps/default/keymap.c
@@ -0,0 +1,259 @@
+/* Copyright 2020 3araht
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+#include "version.h"
+
+// Alias layout macros that expand groups of keys.
+#define LAYOUT_wrapper(...) LAYOUT(__VA_ARGS__)
+
+#define DFCBASE DF(_C_SYSTEM_BASE)
+#define DF_QWER DF(_QWERTY)
+// Long press: go to _FN layer, tap: MUTE
+#define FN_MUTE LT(_FN, KC_MUTE)
+
+// Used to set octave to MI_OCT_0
+extern midi_config_t midi_config;
+uint8_t midi_bass_ch = 0, midi_chord_ch = 0;  // By default, all use the same channel.
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _C_SYSTEM_BASE,  //  MIDI C-system
+    _QWERTY,         //  just in case
+    _FN
+};
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+
+    // MIDI Chord Keycodes - Root notes
+    MY_CHORD_MIN = SAFE_RANGE,
+
+    MI_CH_Cr = MY_CHORD_MIN,
+    MI_CH_Csr,
+    MI_CH_Dbr = MI_CH_Csr,
+    MI_CH_Dr,
+    MI_CH_Dsr,
+    MI_CH_Ebr = MI_CH_Dsr,
+    MI_CH_Er,
+    MI_CH_Fr,
+    MI_CH_Fsr,
+    MI_CH_Gbr = MI_CH_Fsr,
+    MI_CH_Gr,
+    MI_CH_Gsr,
+    MI_CH_Abr = MI_CH_Gsr,
+    MI_CH_Ar,
+    MI_CH_Asr,
+    MI_CH_Bbr = MI_CH_Asr,
+    MI_CH_Br,
+
+    // MIDI Chord Keycodes - Major
+
+    MI_CH_C,
+    MI_CH_Cs,
+    MI_CH_Db = MI_CH_Cs,
+    MI_CH_D,
+    MI_CH_Ds,
+    MI_CH_Eb = MI_CH_Ds,
+    MI_CH_E,
+    MI_CH_F,
+    MI_CH_Fs,
+    MI_CH_Gb = MI_CH_Fs,
+    MI_CH_G,
+    MI_CH_Gs,
+    MI_CH_Ab = MI_CH_Gs,
+    MI_CH_A,
+    MI_CH_As,
+    MI_CH_Bb = MI_CH_As,
+    MI_CH_B,
+
+    // MIDI Chord Keycodes Minor
+
+    MI_CH_Cm,
+    MI_CH_Csm,
+    MI_CH_Dbm = MI_CH_Csm,
+    MI_CH_Dm,
+    MI_CH_Dsm,
+    MI_CH_Ebm = MI_CH_Dsm,
+    MI_CH_Em,
+    MI_CH_Fm,
+    MI_CH_Fsm,
+    MI_CH_Gbm = MI_CH_Fsm,
+    MI_CH_Gm,
+    MI_CH_Gsm,
+    MI_CH_Abm = MI_CH_Gsm,
+    MI_CH_Am,
+    MI_CH_Asm,
+    MI_CH_Bbm = MI_CH_Asm,
+    MI_CH_Bm,
+
+    //MIDI Chord Keycodes Dominant Seventh
+
+    MI_CH_CDom7,
+    MI_CH_CsDom7,
+    MI_CH_DbDom7 = MI_CH_CsDom7,
+    MI_CH_DDom7,
+    MI_CH_DsDom7,
+    MI_CH_EbDom7 = MI_CH_DsDom7,
+    MI_CH_EDom7,
+    MI_CH_FDom7,
+    MI_CH_FsDom7,
+    MI_CH_GbDom7 = MI_CH_FsDom7,
+    MI_CH_GDom7,
+    MI_CH_GsDom7,
+    MI_CH_AbDom7 = MI_CH_GsDom7,
+    MI_CH_ADom7,
+    MI_CH_AsDom7,
+    MI_CH_BbDom7 = MI_CH_AsDom7,
+    MI_CH_BDom7,
+
+    // MIDI Chord Keycodes Diminished Seventh
+
+    MI_CH_CDim7,
+    MI_CH_CsDim7,
+    MI_CH_DbDim7 = MI_CH_CsDim7,
+    MI_CH_DDim7,
+    MI_CH_DsDim7,
+    MI_CH_EbDim7 = MI_CH_DsDim7,
+    MI_CH_EDim7,
+    MI_CH_FDim7,
+    MI_CH_FsDim7,
+    MI_CH_GbDim7 = MI_CH_FsDim7,
+    MI_CH_GDim7,
+    MI_CH_GsDim7,
+    MI_CH_AbDim7 = MI_CH_GsDim7,
+    MI_CH_ADim7,
+    MI_CH_AsDim7,
+    MI_CH_BbDim7 = MI_CH_AsDim7,
+    MI_CH_BDim7,
+
+    MY_CHORD_MAX = MI_CH_BDim7,
+
+    VERSION
+};
+
+#define MY_CHORD_COUNT (MY_CHORD_MAX - MY_CHORD_MIN + 1)
+static uint8_t chord_status[MY_CHORD_COUNT];
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* C-system Base */
+  [_C_SYSTEM_BASE] = LAYOUT(
+    MI_CH_Dbr,    MI_CH_Abr,    MI_CH_Ebr,    MI_CH_Bbr,    MI_CH_Fr,    MI_CH_Cr,    MI_CH_Gr,    MI_CH_Dr,    MI_CH_Ar,    MI_CH_Er,    MI_CH_Br,    MI_CH_Fsr,
+      MI_CH_Db,     MI_CH_Ab,     MI_CH_Eb,     MI_CH_Bb,     MI_CH_F,     MI_CH_C,     MI_CH_G,     MI_CH_D,     MI_CH_A,     MI_CH_E,     MI_CH_B,     MI_CH_Fs,
+        MI_CH_Dbm,    MI_CH_Abm,    MI_CH_Ebm,    MI_CH_Bbm,    MI_CH_Fm,    MI_CH_Cm,    MI_CH_Gm,    MI_CH_Dm,    MI_CH_Am,    MI_CH_Em,    MI_CH_Bm,    MI_CH_Fsm,
+          MI_CH_DbDom7, MI_CH_AbDom7, MI_CH_EbDom7, MI_CH_BbDom7, MI_CH_FDom7, MI_CH_CDom7, MI_CH_GDom7, MI_CH_DDom7, MI_CH_ADom7, MI_CH_EDom7, MI_CH_BDom7, MI_CH_FsDom7,
+            MI_CH_DbDim7, MI_CH_AbDim7, MI_CH_EbDim7, MI_CH_BbDim7, MI_CH_FDim7, MI_CH_CDim7, MI_CH_GDim7, MI_CH_DDim7, MI_CH_ADim7, MI_CH_EDim7, MI_CH_BDim7, MI_CH_FsDim7,
+
+    MI_Fs_2,
+      MI_Ab_2, MI_B_2,  MI_D_3,  MI_F_3,  MI_Ab_3, MI_B_3,  MI_D_4,  MI_F_4,  MI_Ab_4, MI_B_4,  MI_D_5,  MI_F_5,    FN_MUTE,
+    MI_G_2,  MI_Bb_2, MI_Db_3, MI_E_3,  MI_G_3,  MI_Bb_3, MI_Db_4, MI_E_4,  MI_G_4,  MI_Bb_4, MI_Db_5, MI_E_5,  MI_G_5,
+      MI_A_2,  MI_C_3,  MI_Eb_3, MI_Fs_3, MI_A_3,  MI_C_4,  MI_Eb_4, MI_Fs_4, MI_A_4,  MI_C_5,  MI_Eb_5, MI_Fs_5
+  ),
+
+  /* QWERTY */
+  [_QWERTY] = LAYOUT_wrapper(
+    KC_GESC, _________________NUMBER_L__________________, _________________NUMBER_R__________________, KC_BSPC,
+      KC_TAB,  _________________QWERTY_L1_________________, _________________QWERTY_R1_________________, KC_DEL,
+        KC_CAPS, _________________QWERTY_L2_________________, _________________QWERTY_R2_________________, KC_ENT,
+          KC_LSFT, _________________QWERTY_L3_________________, _________________QWERTY_R3_________________, KC_RSFT,
+            KC_LCTL, KC_LGUI, KC_LALT, KC_LANG2, KC_SPC,  KC_SPC, KC_SPC, KC_SPC, KC_LANG1, KC_RALT,  KC_RGUI, KC_RCTRL,
+
+    _______,
+      _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+      _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+  ),
+
+  /* Fn */
+  [_FN] = LAYOUT(
+    DFCBASE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+      DF_QWER, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+          XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+            XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+
+    XXXXXXX,
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, VERSION, XXXXXXX,   _______,
+    XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX
+  )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [_C_SYSTEM_BASE]    = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+    [_QWERTY]           = { ENCODER_CCW_CW(_______, _______) },
+    [_FN]               = { ENCODER_CCW_CW(_______, _______) },
+};
+#endif
+
+void keyboard_post_init_user(void) {
+    //  Set otave to MI_OCT_0
+    midi_config.octave = MI_OCT_0 - MIDI_OCTAVE_MIN;
+
+    // avoid using 127 since it is used as a special number in some sound sources.
+    midi_config.velocity = MIDI_INITIAL_VELOCITY;
+
+    for (uint8_t i = 0; i < MY_CHORD_COUNT; i++) {
+        chord_status[i] = MIDI_INVALID_NOTE;
+    }
+
+    default_layer_set(1UL << _C_SYSTEM_BASE);
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    uint16_t root_note = MIDI_INVALID_NOTE;  // Starting value for the root note of each chord
+
+    uint8_t chord        = keycode - MY_CHORD_MIN;
+
+    switch (keycode) {
+        case VERSION: // Output firmware info.
+            if (record->event.pressed) {
+                SEND_STRING(QMK_KEYBOARD ":" QMK_KEYMAP " @ " QMK_VERSION " | " QMK_BUILDDATE);
+            }
+            break;
+
+        // MIDI Chord Keycodes, on the left side.
+        case MI_CH_Cr ... MI_CH_Br:  // Root Notes
+            root_note = keycode - MI_CH_Cr + MI_C_1;
+            my_process_midi4Bass(midi_bass_ch, record, chord_status, chord, root_note, false);
+            break;
+
+        case MI_CH_C ... MI_CH_B:  // Major Chords
+            root_note = keycode - MI_CH_C + MI_C_2;
+            // Root, Major Third, and Fifth Notes
+            my_process_midi4TriadChords(midi_chord_ch, record, chord_status, chord, root_note, 0, 4, 7);
+            break;
+
+        case MI_CH_Cm ... MI_CH_Bm:  // Minor Chord
+            root_note = keycode - MI_CH_Cm + MI_C_2;
+            // Root, Minor Third, and Fifth Notes
+            my_process_midi4TriadChords(midi_chord_ch, record, chord_status, chord, root_note, 0, 3, 7);
+            break;
+
+        case MI_CH_CDom7 ... MI_CH_BDom7:  // Dominant 7th Chord
+            root_note = keycode - MI_CH_CDom7 + MI_C_2;
+            // Major Third, Major Fifth, and Minor Seventh Notes
+            my_process_midi4TriadChords(midi_chord_ch, record, chord_status, chord, root_note, 4, 7, 10);
+            break;
+
+        case MI_CH_CDim7 ... MI_CH_BDim7:                // Diminished 7th Chord
+            root_note = keycode - MI_CH_CDim7 + MI_C_2;
+            // Root, Minor Third, and Diminished 5th Note
+            my_process_midi4TriadChords(midi_chord_ch, record, chord_status, chord, root_note, 0, 3, 6);
+            break;
+    }
+    return true;
+}
diff --git a/keyboards/giabalanai/keymaps/default/readme.md b/keyboards/giabalanai/keymaps/default/readme.md
new file mode 100644
index 0000000000..d929aa1f5e
--- /dev/null
+++ b/keyboards/giabalanai/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for giabalanai
diff --git a/keyboards/giabalanai/keymaps/default/rules.mk b/keyboards/giabalanai/keymaps/default/rules.mk
new file mode 100644
index 0000000000..8006608ea9
--- /dev/null
+++ b/keyboards/giabalanai/keymaps/default/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes    # replacing ENCODERS_CW_KEY method to this on 2022/08/31.