Add a new midi challenge type

[mnemon] / mnemon.c

diff --git a/mnemon.c b/mnemon.c
index 33f2c260132a6efff082da9989da5ca6be6ef739..3523ef822685c33489b64f9e63e619053d4237ed 100644 (file)
--- a/mnemon.c
+++ b/mnemon.c
@@ -35,6 +35,12 @@
 #include <readline/readline.h>
 #include <readline/history.h>
 
+#define ASSERT_NOT_REACHED             \
+do {                                   \
+    static const int NOT_REACHED = 0;  \
+    assert (NOT_REACHED);              \
+} while (0)
+
 typedef int bool_t;
 
 typedef struct _item {
@@ -55,6 +61,13 @@ typedef enum {
     CATEGORY_ORDER_SEQUENTIAL
 } category_order_t;
 
+typedef enum {
+    CHALLENGE_TYPE_TEXT,
+    CHALLENGE_TYPE_IMAGE,
+    CHALLENGE_TYPE_AUDIO,
+    CHALLENGE_TYPE_MIDI
+} challenge_type_t;
+
 typedef struct _category {
     char *name;
     int items_size;
@@ -66,6 +79,8 @@ typedef struct _category {
     /* Support categories where responses are timed (0.0 == disable). */
     double time_limit;
     int bin_zero_head;
+    /* Support challenges of non-text types (image, audio, etc.) */
+    challenge_type_t challenge_type;
 } category_t;
 
 typedef struct _mnemon {
@@ -193,6 +208,7 @@ category_init (category_t *category,
     category->order = CATEGORY_ORDER_RANDOM;
     category->time_limit = 0.0;
     category->bin_zero_head = 0;
+    category->challenge_type = CHALLENGE_TYPE_TEXT;
 }
 
 static void
@@ -262,6 +278,23 @@ category_print (category_t *category,
     fprintf (file, "time = %f\n\n",
             category->time_limit);
 
+    fprintf (file, "challenge = ");
+    switch (category->challenge_type) {
+    case CHALLENGE_TYPE_TEXT:
+       fprintf (file, "text");
+       break;
+    case CHALLENGE_TYPE_IMAGE:
+       fprintf (file, "image");
+       break;
+    case CHALLENGE_TYPE_AUDIO:
+       fprintf (file, "audio");
+       break;
+    case CHALLENGE_TYPE_MIDI:
+       fprintf (file, "midi");
+       break;
+    }
+    fprintf (file, "\n\n");
+
     for (i = 0; i < category->num_items; i++) {
        item = &category->items[i];
        if (i != 0)
@@ -618,6 +651,20 @@ mnemon_load_category (mnemon_t             *mnemon,
                         value, path, line_count);
                exit (1);
            }
+       } else if (strcmp (name, "challenge") == 0) {
+           if (strcmp (value, "text") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_TEXT;
+           } else if (strcmp (value, "image") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_IMAGE;
+           } else if (strcmp (value, "audio") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_AUDIO;
+           } else if (strcmp (value, "midi") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_MIDI;
+           } else {
+               fprintf (stderr, "Unknown value for \"challenge\" option \"%s\" at %s:%d\n",
+                        value, path, line_count);
+               exit (1);
+           }
        } else {
            fprintf (stderr, "Unknown option %s at %s:%d\n",
                     name, path, line_count);
@@ -1000,6 +1047,7 @@ mnemon_handle_command (mnemon_t           *mnemon,
     const char *arg;
     int len;
     switch (command[0]) {
+       /* 'h' for histogram */
        case 'h':
        {
            char *category = NULL;
@@ -1018,6 +1066,12 @@ mnemon_handle_command (mnemon_t          *mnemon,
            mnemon_print_histogram (mnemon, category, length);
        }
        break;
+       /* 'r' for repeat */
+        case 'r':
+       {
+           /* Nothing necessary for repeating. */
+       }
+       break;
         default:
            printf ("Unknown command: %s\n", command);
            break;
@@ -1113,6 +1167,63 @@ mnemon_handle_response (mnemon_t *mnemon,
     bin_add_item (bin, item);
 }
 
+static void
+mnemon_show_challenge (mnemon_t *mnemon,
+                      challenge_type_t challenge_type,
+                      const char *challenge)
+{
+    const char *program;
+    char *command;
+
+    if (challenge_type == CHALLENGE_TYPE_TEXT) {
+       printf ("%s\n", challenge);
+       return;
+    }
+
+    /* XXX: Yes, shelling out to system is total cheese. The planned
+     * fix here is to bring graphical display in process, (or at least
+     * have a custom external program that accepts image filenames on
+     * stdin.
+     */
+    switch (challenge_type) {
+    case CHALLENGE_TYPE_TEXT:
+       ASSERT_NOT_REACHED;
+       break;
+    case CHALLENGE_TYPE_IMAGE:
+       program = "xli -gamma 2.2";
+       break;
+    case CHALLENGE_TYPE_AUDIO:
+       program = "play";
+       break;
+    case CHALLENGE_TYPE_MIDI:
+       program = "timidity -Os";
+       break;
+    }
+
+    xasprintf (&command, "%s %s/%s >/dev/null 2>&1 &",
+              program,
+              mnemon->dir_name,
+              challenge);
+    system (command);
+    free (command);
+}
+
+static void
+mnemon_hide_challenge (mnemon_t *mnemon, challenge_type_t challenge_type)
+{
+    char * command;
+
+    if (challenge_type != CHALLENGE_TYPE_IMAGE)
+       return;
+
+    /* XXX: And this is just embarrassing (obviously wrong in several
+     * ways). Hopefully I'll amend away any commit that includes this.
+     */
+    xasprintf (&command, "killall xli");
+    system (command);
+    free (command);
+}
+
 static void
 mnemon_do_challenges (mnemon_t *mnemon)
 {
@@ -1164,13 +1275,16 @@ mnemon_do_challenges (mnemon_t *mnemon)
                response = readline ("The next one is timed. Press enter when ready:");
                free (response);
            }
-               
-           printf ("%s\n", item->challenge);
+
+           mnemon_show_challenge (mnemon, category->challenge_type,
+                                  item->challenge);
 
            gettimeofday (&start, NULL);
            response = readline ("> ");
            gettimeofday (&end, NULL);
 
+           mnemon_hide_challenge (mnemon, category->challenge_type);
+
            /* Terminate on EOF */
            if (response == NULL) {
                printf ("\n");
@@ -1191,6 +1305,16 @@ mnemon_do_challenges (mnemon_t *mnemon)
                                (start.tv_sec + start.tv_usec / 1e6),
                                category->time_limit);
        free (response);
+
+       /* Replay audio challenges for reinforcement. */
+       if (category->challenge_type == CHALLENGE_TYPE_AUDIO ||
+           category->challenge_type == CHALLENGE_TYPE_MIDI)
+       {
+           mnemon_show_challenge (mnemon, category->challenge_type,
+                                  item->challenge);
+           printf ("%s\n", item->challenge);
+           sleep (2);
+       }
     } while (mnemon->to_introduce ||
             mnemon->unlearned ||
             mnemon->to_master > 0);