Merge pull request #169 from neutralinsomniac/tarot-face

Implement tarot card face

4 files changed, 310 insertions, 0 deletions

diff --git a/movement/make/Makefile b/movement/make/Makefile
index a11f49f3..48d985f4 100644
--- a/movement/make/Makefile
+++ b/movement/make/Makefile
@@ -84,6 +84,7 @@ SRCS += \
   ../watch_faces/complication/databank_face.c \
   ../watch_faces/complication/tempchart_face.c \
   ../watch_faces/complication/tally_face.c \
+  ../watch_faces/complication/tarot_face.c \
 # New watch faces go above this line.
 
 # Leave this line at the bottom of the file; it has all the targets for making your project.
diff --git a/movement/movement_faces.h b/movement/movement_faces.h
index 2506671f..8ca3930f 100644
--- a/movement/movement_faces.h
+++ b/movement/movement_faces.h
@@ -69,6 +69,7 @@
 #include "databank_face.h"
 #include "tempchart_face.h"
 #include "tally_face.h"
+#include "tarot_face.h"
 // New includes go above this line.
 
 #endif // MOVEMENT_FACES_H_
diff --git a/movement/watch_faces/complication/tarot_face.c b/movement/watch_faces/complication/tarot_face.c
new file mode 100644
index 00000000..04c55360
--- /dev/null
+++ b/movement/watch_faces/complication/tarot_face.c
@@ -0,0 +1,255 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Jeremy O'Brien
+ * Base code copied from Spencer Bywater's probability face
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+// Emulator only: need time() to seed the random number generator.
+#if __EMSCRIPTEN__
+#include <time.h>
+#endif
+
+#include <stdlib.h>
+#include <string.h>
+#include "tarot_face.h"
+
+#define TAROT_ANIMATION_TICK_FREQUENCY 8
+#define FLIPPED_BIT_POS 7
+#define FLIPPED_MASK ((uint8_t)(1 << FLIPPED_BIT_POS))
+
+
+// --------------
+// Custom methods
+// --------------
+
+static char *major_arcana[] = {
+    " FOOL ",
+    "Mgcian",
+    "HPrsts",
+    "En&prs", // Empress
+    "En&por", // Emperor
+    "Hiroph",
+    "Lovers",
+    "Chriot",
+    "Strgth",
+    "Hrn&it", // Hermit
+    " Frtun",
+    "Justce",
+    "Hangn&", // Hangman
+    " Death",
+    " tmprn",
+    " Devil",
+    " Tower",
+    "  Star",
+    "n&OON ", // Moon
+    "  Sun ",
+    "Jdgmnt",
+    " World",
+};
+#define NUM_TAROT_CARDS (sizeof(major_arcana) / sizeof(*major_arcana))
+
+#define WORLD_CARD_INDEX (NUM_TAROT_CARDS - 1)
+
+static void init_deck(tarot_state_t *state) {
+    memset(state->drawn_cards, 0xff, sizeof(state->drawn_cards));
+    state->current_card = 0;
+}
+
+static void tarot_display(tarot_state_t *state) {
+    char buf[9];
+    uint8_t card;
+    bool flipped;
+
+    if (state->drawn_cards[0] == 0xff) {
+        /* deck is initialized; show current draw mode */
+        watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
+        sprintf(buf, "%2d draWW", state->num_cards_to_draw);
+        watch_display_string(buf, 2);
+        watch_clear_pixel(2, 3);
+        watch_clear_pixel(1, 4);
+        return;
+    }
+
+    sprintf(buf, "%2d", state->current_card + 1);
+    watch_display_string(buf, 2);
+
+    card = state->drawn_cards[state->current_card];
+    flipped = (card & FLIPPED_MASK) ? true : false; // check flipped bit
+    card &= ~FLIPPED_MASK; // remove the flipped bit
+    sprintf(buf, "%s", major_arcana[card]);
+    watch_display_string(buf, 4);
+    if (flipped) {
+        watch_set_indicator(WATCH_INDICATOR_SIGNAL);
+    } else {
+        watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
+    }
+}
+
+static uint8_t get_rand_num(uint8_t num_values) {
+    // Emulator: use rand. Hardware: use arc4random.
+#if __EMSCRIPTEN__
+    return rand() % num_values;
+#else
+    return arc4random_uniform(num_values);
+#endif
+}
+
+static uint8_t draw_one_card(void) {
+    return get_rand_num(NUM_TAROT_CARDS);
+}
+
+static bool already_drawn(tarot_state_t *state, uint8_t drawn_card) {
+    for (int i = 0; state->drawn_cards[i] != 0xff && i < state->num_cards_to_draw; i++) {
+        if ((state->drawn_cards[i] & ~FLIPPED_MASK) == drawn_card) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+static void pick_cards(tarot_state_t *state) {
+    uint8_t card;
+
+    for (int i = 0; i < state->num_cards_to_draw; i++) {
+        card = draw_one_card();
+        while (already_drawn(state, card)) {
+            card = draw_one_card();
+        }
+        card |= get_rand_num(2) << FLIPPED_BIT_POS; // randomly flip the card
+        state->drawn_cards[i] = card;
+    }
+}
+
+static void display_animation(tarot_state_t *state) {
+    if (state->is_picking) {
+        if (state->animation_frame == 0) {
+            watch_display_string("   ", 7);
+            watch_set_pixel(1, 4);
+            watch_set_pixel(1, 6);
+            state->animation_frame = 1;
+        } else if (state->animation_frame == 1) {
+            watch_clear_pixel(1, 4);
+            watch_clear_pixel(1, 6);
+            watch_set_pixel(2, 4);
+            watch_set_pixel(0, 6);
+            state->animation_frame = 2;
+        } else if (state->animation_frame == 2) {
+            watch_clear_pixel(2, 4);
+            watch_clear_pixel(0, 6);
+            watch_set_pixel(2, 5);
+            watch_set_pixel(0, 5);
+            state->animation_frame = 3;
+        } else if (state->animation_frame == 3) {
+            state->animation_frame = 0;
+            state->is_picking = false;
+            movement_request_tick_frequency(1);
+            tarot_display(state);
+        }
+    }
+}
+
+
+// ---------------------------
+// Standard watch face methods
+// ---------------------------
+void tarot_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr) {
+    (void) settings;
+    (void) watch_face_index;
+    if (*context_ptr == NULL) {
+        *context_ptr = malloc(sizeof(tarot_state_t));
+        memset(*context_ptr, 0, sizeof(tarot_state_t));
+    }
+    // Emulator only: Seed random number generator
+    #if __EMSCRIPTEN__
+    srand(time(NULL));
+    #endif
+}
+
+void tarot_face_activate(movement_settings_t *settings, void *context) {
+    (void) settings;
+    tarot_state_t *state = (tarot_state_t *)context;
+
+    watch_display_string("TA", 0);
+    init_deck(state);
+    state->num_cards_to_draw = 3;
+}
+
+bool tarot_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
+    (void) settings;
+    tarot_state_t *state = (tarot_state_t *)context;
+
+    if (state->is_picking && event.event_type != EVENT_TICK) {
+        return true;
+    }
+
+    switch (event.event_type) {
+        case EVENT_ACTIVATE:
+            tarot_display(state);
+            break;
+        case EVENT_TICK:
+            display_animation(state);
+            break;
+        case EVENT_MODE_BUTTON_UP:
+            movement_move_to_next_face();
+            break;
+        case EVENT_LIGHT_BUTTON_UP:
+            if (state->drawn_cards[0] == 0xff) {
+                // deck is inited; cycle through # cards to draw
+                state->num_cards_to_draw++;
+                if (state->num_cards_to_draw > 10) {
+                    state->num_cards_to_draw = 3;
+                }
+            } else {
+                // cycle through the drawn cards
+                state->current_card = (state->current_card + 1) % state->num_cards_to_draw;
+            }
+            tarot_display(state);
+            break;
+        case EVENT_LIGHT_LONG_PRESS:
+            init_deck(state);
+            tarot_display(state);
+            break;
+        case EVENT_ALARM_BUTTON_UP:
+            // Draw cards
+            watch_display_string("      ", 4);
+            watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
+            init_deck(state);
+            pick_cards(state);
+            state->is_picking = true;
+            // card picking animation begins on next tick and new cards will be displayed on completion
+            movement_request_tick_frequency(TAROT_ANIMATION_TICK_FREQUENCY);
+            break;
+        case EVENT_LOW_ENERGY_UPDATE:
+            watch_display_string("SLEEP ", 4);
+            break;
+        default:
+            break;
+    }
+
+    return true;
+}
+
+void tarot_face_resign(movement_settings_t *settings, void *context) {
+    (void) settings;
+    (void) context;
+}
diff --git a/movement/watch_faces/complication/tarot_face.h b/movement/watch_faces/complication/tarot_face.h
new file mode 100644
index 00000000..e9ffc896
--- /dev/null
+++ b/movement/watch_faces/complication/tarot_face.h
@@ -0,0 +1,53 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Jeremy O'Brien
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef TAROT_FACE_H_
+#define TAROT_FACE_H_
+
+#include "movement.h"
+
+#define MAX_CARDS_TO_DRAW 10
+
+typedef struct {
+    uint8_t drawn_cards[MAX_CARDS_TO_DRAW];
+    uint8_t current_card;
+    uint8_t animation_frame;
+    uint8_t num_cards_to_draw;
+    bool is_picking;
+} tarot_state_t;
+
+void tarot_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
+void tarot_face_activate(movement_settings_t *settings, void *context);
+bool tarot_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
+void tarot_face_resign(movement_settings_t *settings, void *context);
+
+#define tarot_face ((const watch_face_t){ \
+    tarot_face_setup, \
+    tarot_face_activate, \
+    tarot_face_loop, \
+    tarot_face_resign, \
+    NULL, \
+})
+
+#endif // TAROT_FACE_H_