git.cworth.org Git - scherzo/blob - scherzo.c

   1 /* scherzo - Music notation training
   2  *
   3  * Copyright © 2010 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  17  */
  18
  19 #include <gtk/gtk.h>
  20 #include <gdk/gdkkeysyms.h>
  21
  22 #include <asoundlib.h>
  23
  24 #include "score.h"
  25 #include "mnemon.h"
  26
  27 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
  28
  29 #define unused(foo) foo __attribute__((unused))
  30
  31 #define MIDI_BUF_SIZE 4096
  32
  33 typedef struct challenge
  34 {
  35     bin_t *bin;
  36     int item_index;
  37     score_staff_t *staff;
  38     score_note_t *note;
  39
  40     int satisfied;
  41     int mistaken;
  42 } challenge_t;
  43
  44 typedef struct note_group
  45 {
  46     void *ctx;
  47     score_note_t **notes;
  48     int size;
  49     int num_notes;
  50 } note_group_t;
  51
  52 typedef struct scherzo
  53 {
  54     void *ctx;
  55
  56     GtkWidget *window;
  57     score_t *score;
  58     int staff_height;
  59     score_staff_t *treble;
  60     score_staff_t *bass;
  61     score_chord_t *chord;
  62
  63     /* The word "keyboard" here is referring to a "computer
  64      * keyboard". Any "piano keyboard" key knows its own octave and
  65      * accidental already. */
  66     int keyboard_octave;
  67     score_pitch_accidental_t keyboard_accidental;
  68
  69     int midi_fd;
  70     snd_midi_event_t *snd_midi_event;
  71
  72     mnemon_t mnemon;
  73     challenge_t challenge;
  74
  75     note_group_t notes_pressed;
  76     note_group_t notes_pedaled;
  77
  78     int pedal_pressed;
  79 } scherzo_t;
  80
  81 /* Forward declarations. */
  82 static score_note_t *
  83 scherzo_press_note (scherzo_t *scherzo, score_pitch_t pitch, int octave);
  84
  85 static void
  86 scherzo_release_note (scherzo_t *scherzo, score_pitch_t pitch, int octave);
  87
  88 static void
  89 scherzo_press_pedal (scherzo_t *scherzo);
  90
  91 static void
  92 scherzo_release_pedal (scherzo_t *scherzo);
  93
  94 static void
  95 _judge_note (scherzo_t *scherzo, score_note_t *note);
  96
  97 static void
  98 _score_challenge (scherzo_t *scherzo);
  99
 100 static int
 101 on_delete_event_quit (unused (GtkWidget *widget),
 102                       unused (GdkEvent *event),
 103                       unused (gpointer user_data))
 104 {
 105     gtk_main_quit ();
 106
 107     /* Returning FALSE allows the default handler for delete-event
 108      * to proceed to cleanup the widget. */
 109     return FALSE;
 110 }
 111
 112 static int
 113 on_expose_event_draw (GtkWidget *widget,
 114                       unused (GdkEventExpose *expose),
 115                       void * user_data)
 116 {
 117     scherzo_t *scherzo = user_data;
 118     score_t *score = scherzo->score;
 119     cairo_t *cr;
 120     GtkAllocation allocation;
 121     static const int pad = 10;
 122     int widget_width;
 123
 124     gtk_widget_get_allocation (widget, &allocation);
 125     widget_width = allocation.width;
 126
 127     cr = gdk_cairo_create (widget->window);
 128
 129     /* White background */
 130     cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
 131     cairo_paint (cr);
 132
 133     /* Add some padding on the sides and top */
 134     cairo_translate (cr, pad, scherzo->staff_height);
 135     score_set_staff_height (score, scherzo->staff_height);
 136     score_set_width (score, widget_width - 2 * pad);
 137
 138     score_draw (score, cr);
 139
 140     return TRUE;
 141 }
 142
 143 static int
 144 on_key_press_event (GtkWidget *widget,
 145                     GdkEventKey *key,
 146                     void *user_data)
 147 {
 148     scherzo_t *scherzo = user_data;
 149     int octave;
 150     /* Initialize to keep the compiler quiet. */
 151     score_pitch_name_t pitch_name = SCORE_PITCH_C;
 152     score_pitch_t pitch;
 153
 154     if (scherzo->challenge.note)
 155         octave = scherzo->challenge.note->octave;
 156     else
 157         octave = scherzo->keyboard_octave;
 158
 159     switch (key->keyval) {
 160     case GDK_KEY_plus:
 161     case GDK_KEY_KP_Add:
 162     case GDK_KEY_equal:
 163     case GDK_KEY_KP_Equal:
 164         scherzo->staff_height += 4;
 165         gtk_widget_queue_draw (widget);
 166         return TRUE;
 167         break;
 168     case GDK_KEY_minus:
 169     case GDK_KEY_KP_Subtract:
 170         scherzo->staff_height -= 4;
 171         gtk_widget_queue_draw (widget);
 172         return TRUE;
 173         break;
 174     case GDK_KEY_q:
 175     case GDK_KEY_Q:
 176     case GDK_KEY_Escape:
 177         gtk_main_quit ();
 178         return FALSE;
 179     case GDK_KEY_c:
 180     case GDK_KEY_C:
 181         pitch_name = SCORE_PITCH_NAME_C;
 182         break;
 183     case GDK_KEY_d:
 184     case GDK_KEY_D:
 185         pitch_name = SCORE_PITCH_NAME_D;
 186         break;
 187     case GDK_KEY_e:
 188     case GDK_KEY_E:
 189         pitch_name = SCORE_PITCH_NAME_E;
 190         break;
 191     case GDK_KEY_f:
 192     case GDK_KEY_F:
 193         pitch_name = SCORE_PITCH_NAME_F;
 194         break;
 195     case GDK_KEY_g:
 196     case GDK_KEY_G:
 197         pitch_name = SCORE_PITCH_NAME_G;
 198         break;
 199     case GDK_KEY_a:
 200     case GDK_KEY_A:
 201         pitch_name = SCORE_PITCH_NAME_A;
 202         break;
 203     case GDK_KEY_b:
 204     case GDK_KEY_B:
 205         pitch_name = SCORE_PITCH_NAME_B;
 206         break;
 207     case GDK_KEY_0:
 208     case GDK_KEY_1:
 209     case GDK_KEY_2:
 210     case GDK_KEY_3:
 211     case GDK_KEY_4:
 212     case GDK_KEY_5:
 213     case GDK_KEY_6:
 214     case GDK_KEY_7:
 215     case GDK_KEY_8:
 216         scherzo->keyboard_octave = key->keyval - GDK_KEY_0;
 217         break;
 218     case GDK_KEY_space:
 219         scherzo_press_pedal (scherzo);
 220         break;
 221     case GDK_KEY_Up:
 222         if (scherzo->keyboard_accidental < SCORE_PITCH_ACCIDENTAL_DOUBLE_SHARP)
 223             scherzo->keyboard_accidental++;
 224         break;
 225     case GDK_KEY_Down:
 226         if (scherzo->keyboard_accidental > SCORE_PITCH_ACCIDENTAL_DOUBLE_FLAT)
 227             scherzo->keyboard_accidental--;
 228         break;
 229     }
 230
 231     pitch = SCORE_PITCH (pitch_name, scherzo->keyboard_accidental);
 232
 233     if ((key->keyval >= GDK_KEY_A && key->keyval <= GDK_KEY_G) ||
 234         (key->keyval >= GDK_KEY_a && key->keyval <= GDK_KEY_g))
 235     {
 236         score_note_t *note;
 237
 238         note = scherzo_press_note (scherzo, pitch, octave);
 239         _judge_note (scherzo, note);
 240         gtk_widget_queue_draw (scherzo->window);
 241
 242         return TRUE;
 243     }
 244
 245
 246     /* Allow an unhandled event to propagate to other handlers. */
 247     return FALSE;
 248 }
 249
 250 static int
 251 on_key_release_event (unused (GtkWidget *widget),
 252                       GdkEventKey *key,
 253                       void *user_data)
 254 {
 255     scherzo_t *scherzo = user_data;
 256     int octave;
 257     /* Initialize to keep the compiler quiet. */
 258     score_pitch_name_t pitch_name = SCORE_PITCH_NAME_C;
 259     score_pitch_t pitch;
 260
 261     if (scherzo->challenge.note)
 262         octave = scherzo->challenge.note->octave;
 263     else
 264         octave = scherzo->keyboard_octave;
 265
 266     switch (key->keyval) {
 267     case GDK_KEY_c:
 268     case GDK_KEY_C:
 269         pitch_name = SCORE_PITCH_NAME_C;
 270         break;
 271     case GDK_KEY_d:
 272     case GDK_KEY_D:
 273         pitch_name = SCORE_PITCH_NAME_D;
 274         break;
 275     case GDK_KEY_e:
 276     case GDK_KEY_E:
 277         pitch_name = SCORE_PITCH_NAME_E;
 278         break;
 279     case GDK_KEY_f:
 280     case GDK_KEY_F:
 281         pitch_name = SCORE_PITCH_NAME_F;
 282         break;
 283     case GDK_KEY_g:
 284     case GDK_KEY_G:
 285         pitch_name = SCORE_PITCH_NAME_G;
 286         break;
 287     case GDK_KEY_a:
 288     case GDK_KEY_A:
 289         pitch_name = SCORE_PITCH_NAME_A;
 290         break;
 291     case GDK_KEY_b:
 292     case GDK_KEY_B:
 293         pitch_name = SCORE_PITCH_NAME_B;
 294         break;
 295     case GDK_KEY_space:
 296         scherzo_release_pedal (scherzo);
 297         break;
 298     }
 299
 300     pitch = SCORE_PITCH (pitch_name, scherzo->keyboard_accidental);
 301
 302     if ((key->keyval >= GDK_KEY_A && key->keyval <= GDK_KEY_G) ||
 303         (key->keyval >= GDK_KEY_a && key->keyval <= GDK_KEY_g))
 304     {
 305         scherzo_release_note (scherzo, pitch, octave);
 306         _score_challenge (scherzo);
 307         gtk_widget_queue_draw (scherzo->window);
 308
 309         return TRUE;
 310     }
 311
 312
 313     /* Allow an unhandled event to propagate to other handlers. */
 314     return FALSE;
 315 }
 316
 317 static unsigned char
 318 _score_pitch_and_octave_to_midi (score_pitch_t pitch,
 319                                  int octave)
 320 {
 321     unsigned char midi_note = 12 * (octave + 1);
 322
 323     switch (SCORE_PITCH_NAME (pitch)) {
 324     case SCORE_PITCH_NAME_C:
 325         break;
 326     case SCORE_PITCH_NAME_D:
 327         midi_note += 2;
 328         break;
 329     case SCORE_PITCH_NAME_E:
 330         midi_note += 4;
 331         break;
 332     case SCORE_PITCH_NAME_F:
 333         midi_note += 5;
 334         break;
 335     case SCORE_PITCH_NAME_G:
 336         midi_note += 7;
 337         break;
 338     case SCORE_PITCH_NAME_A:
 339         midi_note += 9;
 340         break;
 341     case SCORE_PITCH_NAME_B:
 342         midi_note += 11;
 343         break;
 344     }
 345
 346     switch (SCORE_PITCH_ACCIDENTAL (pitch)) {
 347     case SCORE_PITCH_ACCIDENTAL_DOUBLE_FLAT:
 348         midi_note -= 2;
 349         break;
 350     case SCORE_PITCH_ACCIDENTAL_FLAT:
 351         midi_note -= 1;
 352         break;
 353     case SCORE_PITCH_ACCIDENTAL_NATURAL:
 354         break;
 355     case SCORE_PITCH_ACCIDENTAL_SHARP:
 356         midi_note += 1;
 357         break;
 358     case SCORE_PITCH_ACCIDENTAL_DOUBLE_SHARP:
 359         midi_note += 2;
 360         break;
 361     }
 362
 363     return midi_note;
 364 }
 365
 366 static void
 367 _midi_to_score_pitch_and_octave (unsigned char midi_note,
 368                                  score_pitch_t *pitch,
 369                                  int *octave)
 370 {
 371     *octave = midi_note / 12 - 1;
 372
 373     switch (midi_note % 12)
 374     {
 375     case 0:
 376         *pitch = SCORE_PITCH_C;
 377         break;
 378     case 1:
 379         *pitch = SCORE_PITCH_Cs;
 380         break;
 381     case 2:
 382         *pitch = SCORE_PITCH_D;
 383         break;
 384     case 3:
 385         *pitch = SCORE_PITCH_Ds;
 386         break;
 387     case 4:
 388         *pitch = SCORE_PITCH_E;
 389         break;
 390     case 5:
 391         *pitch = SCORE_PITCH_F;
 392         break;
 393     case 6:
 394         *pitch = SCORE_PITCH_Fs;
 395         break;
 396     case 7:
 397         *pitch = SCORE_PITCH_G;
 398         break;
 399     case 8:
 400         *pitch = SCORE_PITCH_Gs;
 401         break;
 402     case 9:
 403         *pitch = SCORE_PITCH_A;
 404         break;
 405     case 10:
 406         *pitch = SCORE_PITCH_As;
 407         break;
 408     case 11:
 409         *pitch = SCORE_PITCH_B;
 410         break;
 411     }
 412 }
 413
 414 /* Determine a chord name (if any) from the current notes pressed */
 415
 416 typedef struct analyzed_note {
 417     /* Original note being analzyed. */
 418     score_note_t *note;
 419
 420     /* Absolute pitch (expressed as midi number). */
 421     int midi_pitch;
 422
 423     /* Pitch relative to bass note. */
 424     int relative_pitch;
 425 } analyzed_note_t;
 426
 427 static int
 428 _compare_analyzed_note_by_midi_pitch (const void *va, const void *vb)
 429 {
 430     const analyzed_note_t *a = va, *b = vb;
 431
 432     return a->midi_pitch - b->midi_pitch;
 433 }
 434
 435 static int
 436 _compare_analyzed_note_by_relative_pitch (const void *va, const void *vb)
 437 {
 438     const analyzed_note_t *a = va, *b = vb;
 439
 440     return a->relative_pitch - b->relative_pitch;
 441 }
 442
 443 typedef struct modified_degree
 444 {
 445     int degree;
 446     int modification;
 447 } modified_degree_t;
 448
 449 static int
 450 _modified_degree_to_half_steps (const modified_degree_t *degree)
 451 {
 452     int half_steps;
 453     int scale_degree = degree->degree;
 454
 455     /* Restrict to actual degrees within a scale. */
 456     if (scale_degree > 7)
 457         scale_degree = (scale_degree % 8) + 1;
 458
 459     /* Number of half steps from root to specified degree within a
 460      * diatonic scaled. */
 461     switch (scale_degree) {
 462     case 1:
 463         half_steps = 0;
 464         break;
 465     case 2:
 466         half_steps = 2;
 467         break;
 468     case 3:
 469         half_steps = 4;
 470         break;
 471     case 4:
 472         half_steps = 5;
 473         break;
 474     case 5:
 475         half_steps = 7;
 476         break;
 477     case 6:
 478         half_steps = 9;
 479         break;
 480     case 7:
 481         half_steps = 11;
 482         break;
 483     default:
 484         fprintf (stderr, "Internal: Invalid degree %d\n", degree->degree);
 485         exit (1);
 486         break;
 487     }
 488
 489     return half_steps + degree->modification;
 490 }
 491
 492 static int
 493 _chord_signature_matches (analyzed_note_t *notes,
 494                           int num_notes,
 495                           modified_degree_t *degrees,
 496                           int num_degrees,
 497                           int inversion,
 498                           score_pitch_t *root)
 499 {
 500 #define MAX_DEGREES 5
 501     int relative_pitches[MAX_DEGREES];
 502     int i, root_index;
 503
 504     assert (num_degrees <= MAX_DEGREES);
 505
 506     if (num_notes != num_degrees)
 507         return 0;
 508
 509     if (inversion >= num_degrees)
 510         return 0;
 511
 512     /* We never spell simple intervals as inversions. */
 513     if (num_degrees == 2 && inversion > 0)
 514         return 0;
 515
 516     for (i = 0; i < num_degrees; i++) {
 517         /* The num_degrees is in the addition just to ensure all
 518          * inputs to the modulus operator remain positive. */
 519         int index = (i + num_degrees - inversion) % num_degrees;
 520
 521         /* Again, adding a 12 to keep things positive. */
 522         relative_pitches[index] =
 523             (12 +
 524              _modified_degree_to_half_steps (&degrees[i]) -
 525              _modified_degree_to_half_steps (&degrees[inversion])) % 12;
 526
 527     }
 528
 529     for (i = 0; i < num_notes; i++)
 530         if (notes[i].relative_pitch != relative_pitches[i])
 531             return 0;
 532
 533     root_index = (num_notes - inversion) % num_notes;
 534     *root = notes[root_index].note->pitch;
 535
 536     return 1;
 537 }
 538
 539 static const char *
 540 _pitch_str (score_pitch_t pitch)
 541 {
 542     switch (pitch) {
 543     case SCORE_PITCH_Cff:
 544         return "C𝄫";
 545     case SCORE_PITCH_Cf:
 546         return "C♭";
 547     case SCORE_PITCH_C:
 548         return "C";
 549     case SCORE_PITCH_Cs:
 550         return "C♯";
 551     case SCORE_PITCH_Css:
 552         return "C𝄪";
 553     case SCORE_PITCH_Dff:
 554         return "D𝄫";
 555     case SCORE_PITCH_Df:
 556         return "D♭";
 557     case SCORE_PITCH_D:
 558         return "D";
 559     case SCORE_PITCH_Ds:
 560         return "D♯";
 561     case SCORE_PITCH_Dss:
 562         return "D𝄪";
 563     case SCORE_PITCH_Eff:
 564         return "E𝄫";
 565     case SCORE_PITCH_Ef:
 566         return "E♭";
 567     case SCORE_PITCH_E:
 568         return "E";
 569     case SCORE_PITCH_Es:
 570         return "E♯";
 571     case SCORE_PITCH_Ess:
 572         return "E𝄪";
 573     case SCORE_PITCH_Fff:
 574         return "F𝄫";
 575     case SCORE_PITCH_Ff:
 576         return "F♭";
 577     case SCORE_PITCH_F:
 578         return "F";
 579     case SCORE_PITCH_Fs:
 580         return "F♯";
 581     case SCORE_PITCH_Fss:
 582         return "F𝄪";
 583     case SCORE_PITCH_Gff:
 584         return "G𝄫";
 585     case SCORE_PITCH_Gf:
 586         return "G♭";
 587     case SCORE_PITCH_G:
 588         return "G";
 589     case SCORE_PITCH_Gs:
 590         return "G♯";
 591     case SCORE_PITCH_Gss:
 592         return "G𝄪";
 593     case SCORE_PITCH_Aff:
 594         return "A𝄫";
 595     case SCORE_PITCH_Af:
 596         return "A♭";
 597     case SCORE_PITCH_A:
 598         return "A";
 599     case SCORE_PITCH_As:
 600         return "A♯";
 601     case SCORE_PITCH_Ass:
 602         return "A𝄪";
 603     case SCORE_PITCH_Bff:
 604         return "B𝄫";
 605     case SCORE_PITCH_Bf:
 606         return "B♭";
 607     case SCORE_PITCH_B:
 608         return "B";
 609     case SCORE_PITCH_Bs:
 610         return "B♯";
 611     case SCORE_PITCH_Bss:
 612         return "B𝄪";
 613     }
 614
 615     fprintf (stderr, "Internal error: Unknown pitch %d\n", pitch);
 616     exit (1);
 617 }
 618
 619 static void
 620 scherzo_analyze_chord (scherzo_t *scherzo)
 621 {
 622     void *local = talloc_new (NULL);
 623     analyzed_note_t *notes;
 624     note_group_t *note_group;
 625     unsigned i, j, num_notes;
 626     int bass_pitch, inversion;
 627     score_pitch_t root;
 628     const char *chord_name = NULL;
 629
 630     if (scherzo->pedal_pressed)
 631         note_group = &scherzo->notes_pedaled;
 632     else
 633         note_group = &scherzo->notes_pressed;
 634
 635     num_notes = note_group->num_notes;
 636
 637     struct { modified_degree_t degrees[1]; const char *name; } octaves[] = {
 638         { {{1, 0}}, " Octave"}
 639     };
 640
 641     struct { modified_degree_t degrees[2]; const char *name; } intervals[] = {
 642         { {{1, 0}, {2, -1}}, " Minor 2nd"},
 643         { {{1, 0}, {2,  0}}, " Major 2nd"},
 644         { {{1, 0}, {3, -1}}, " Minor 3rd"},
 645         { {{1, 0}, {3,  0}}, " Major 3rd"},
 646         { {{1, 0}, {4,  0}}, " Perfect 4th"},
 647         { {{1, 0}, {5, -1}}, " Diminished 5th"},
 648         { {{1, 0}, {5,  0}}, " Perfect 5th"},
 649         { {{1, 0}, {6, -1}}, " Minor 6th"},
 650         { {{1, 0}, {6,  0}}, " Major 6th"},
 651         { {{1, 0}, {7, -1}}, " Minor 7th"},
 652         { {{1, 0}, {7,  0}}, " Major 7th"}
 653     };
 654
 655 /* XXX: The superscript rise value should be relative to the current
 656  * font size. Best would be for pango to support this. See:
 657  *
 658  * https://bugzilla.gnome.org/show_bug.cgi?id=708780
 659  *
 660  * For now, these are emipirically-derived values that look reasonable
 661  * at the default size that score.c is using to draw the staff. If the
 662  * user scales the staff up or down then these will look wrong.
 663  */
 664
 665 #define SUP "<span font='33' rise='30000'>"
 666 #define PUS "</span>"
 667
 668     struct { modified_degree_t degrees[3]; const char *name; } triads[] = {
 669         { {{1, 0}, {3, +1}, {5,  0}}, "sus" },
 670         { {{1, 0}, {3,  0}, {5, +1}}, SUP "+" PUS },
 671         { {{1, 0}, {3,  0}, {5,  0}}, "" },
 672         { {{1, 0}, {3, -1}, {5,  0}}, "m" },
 673         { {{1, 0}, {3, -1}, {5, -1}}, "°" },
 674         { {{1, 0}, {2,  0}, {5,  0}}, "msus2" }
 675     };
 676
 677     struct { modified_degree_t degrees[4]; const char *name; } tetrachords[] = {
 678         /* Sixth chords */
 679         { {{1, 0}, {3, +1}, {5,  0}, {6,  0}}, "sus" SUP "6" PUS },
 680         { {{1, 0}, {3,  0}, {5,  0}, {6,  0}}, "6" },
 681         { {{1, 0}, {3, -1}, {5,  0}, {6,  0}}, "m6" },
 682         { {{1, 0}, {2,  0}, {5,  0}, {6,  0}}, "msus2" SUP "6" PUS },
 683         /* Seventh chords */
 684         { {{1, 0}, {3, +1}, {5,  0}, {7,  0}}, "sus" SUP "M7" PUS },
 685         { {{1, 0}, {3, +1}, {5,  0}, {7, -1}}, "sus" SUP "7" PUS },
 686         { {{1, 0}, {3, +1}, {5, -1}, {7, -1}}, "sus" SUP "7♭5" PUS },
 687         { {{1, 0}, {3,  0}, {5, +1}, {7,  0}}, SUP "+M7" PUS },
 688         { {{1, 0}, {3,  0}, {5, +1}, {7, -1}}, SUP "+7" PUS },
 689         { {{1, 0}, {3,  0}, {5,  0}, {7,  0}}, "M7" },
 690         { {{1, 0}, {3,  0}, {5,  0}, {7, -1}}, "7" },
 691         { {{1, 0}, {3,  0}, {5, -1}, {7, -1}}, SUP "7♭5" PUS },
 692         { {{1, 0}, {3, -1}, {5,  0}, {7,  0}}, "m" SUP "M7" PUS },
 693         { {{1, 0}, {3, -1}, {5,  0}, {7, -1}}, "m7" },
 694         { {{1, 0}, {3, -1}, {5, -1}, {7,  0}}, "°" SUP "M7" PUS },
 695         { {{1, 0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "7" PUS },
 696         { {{1, 0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "7" PUS },
 697         { {{1, 0}, {2,  0}, {5,  0}, {7,  0}}, "msus2" SUP "M7" PUS },
 698         { {{1, 0}, {2,  0}, {5,  0}, {7, -1}}, "msus2" SUP "7" PUS },
 699         { {{1, 0}, {2,  0}, {5, -1}, {7,  0}}, "msus2°" SUP "M7" PUS },
 700         { {{1, 0}, {2,  0}, {5, -1}, {7, -1}}, "msus2𝆩" SUP "7" PUS },
 701         { {{1, 0}, {2,  0}, {5, -1}, {7, -2}}, "msus2°" SUP "7" PUS },
 702         /* Ninth chords voiced with no 5th */
 703         { {{1, 0}, {9,  0}, {3,  0}, {7,  0}}, "M9" },
 704         { {{1, 0}, {9,  0}, {3,  0}, {7, -1}}, "9" },
 705         { {{1, 0}, {9,  0}, {3, -1}, {7,  0}}, "m" SUP "M9" PUS },
 706         { {{1, 0}, {9,  0}, {3, -1}, {7, -1}}, "m9" },
 707         { {{1, 0}, {9, -1}, {3, -1}, {7, -1}}, "m♭9" },
 708     };
 709
 710     /* The sorting here is funny to keep the array in degree order
 711      * after reducing each degree to an actual scale degree, (9 -> 2,
 712      * 11 -> 4, 13 -> 6) */
 713     struct { modified_degree_t degrees[5]; const char *name; } pentachords[] = {
 714         { {{1, 0}, {9,  0}, {3,  0}, {5, +1}, {7,  0}}, SUP "+M9" PUS },
 715         { {{1, 0}, {9,  0}, {3,  0}, {5, +1}, {7, -1}}, SUP "+9" PUS },
 716         { {{1, 0}, {9,  0}, {3,  0}, {5,  0}, {7,  0}}, "M9" },
 717         { {{1, 0}, {9,  0}, {3,  0}, {5,  0}, {7, -1}}, "9" },
 718         { {{1, 0}, {9,  0}, {3, -1}, {5,  0}, {7,  0}}, "m" SUP "M9" PUS },
 719         { {{1, 0}, {9,  0}, {3, -1}, {5,  0}, {7, -1}}, "m9" },
 720         { {{1, 0}, {9, -1}, {3, -1}, {5,  0}, {7, -1}}, "m♭9" },
 721         { {{1, 0}, {9,  0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "9" PUS },
 722
 723         /* FIXME: I don't have names for these last three after
 724          * dropping the 5th from the voicing. That suggests to me that
 725          * I'm missing names for these with a perfect 5th in the list
 726          * above. */
 727         { {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "♭9" PUS },
 728         { {{1, 0}, {9,  0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "9" PUS },
 729         { {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "♭9" PUS },
 730     };
 731
 732     if (scherzo->chord) {
 733         score_remove_chord (scherzo->chord);
 734         scherzo->chord = NULL;
 735     }
 736
 737     if (num_notes <= 1)
 738         goto DONE;
 739
 740     notes = talloc_array (local, analyzed_note_t, num_notes);
 741     if (notes == NULL)
 742         goto DONE;
 743
 744     for (i = 0; i < num_notes; i++) {
 745         score_note_t *note = note_group->notes[i];
 746         notes[i].note = note;
 747         notes[i].midi_pitch = _score_pitch_and_octave_to_midi (note->pitch,
 748                                                                note->octave);
 749         /* Relative pitch will be filled in after sorting. */
 750         notes[i].relative_pitch = 0;
 751     }
 752
 753     /* First, sort by midi pitch to find the bass note. */
 754     qsort (notes, num_notes, sizeof (analyzed_note_t),
 755            _compare_analyzed_note_by_midi_pitch);
 756
 757     bass_pitch = notes[0].midi_pitch;
 758
 759     /* With the bass note identified, we can find all relative pitches. */
 760     for (i = 0; i < num_notes; i++) {
 761         notes[i].relative_pitch = notes[i].midi_pitch - bass_pitch;
 762         while (notes[i].relative_pitch >= 12)
 763             notes[i].relative_pitch -= 12;
 764     }
 765
 766     /* Now, sort again by relative pitch. */
 767     qsort (notes, num_notes, sizeof (analyzed_note_t),
 768            _compare_analyzed_note_by_relative_pitch);
 769
 770     /* Finally, eliminate all duplicate notes. */
 771     for (i = 0; i < num_notes - 1; i++) {
 772             if (notes[i+1].relative_pitch == notes[i].relative_pitch) {
 773                     j = i+1;
 774                     while (j < num_notes &&
 775                            notes[j].relative_pitch == notes[i].relative_pitch)
 776                     {
 777                             j++;
 778                     }
 779                     /* The loop incremented j one past the last
 780                      * duplicate. Decrement so that it points to the
 781                      * last duplicate (and is guaranteed to not exceed
 782                      * the array bounds).*/
 783                     j--;
 784
 785                     if (j < num_notes - 1) {
 786                             memmove (&notes[i+1], &notes[j+1],
 787                                      (num_notes - j) * sizeof (analyzed_note_t));
 788                     }
 789
 790                     num_notes -= (j - i);
 791             }
 792     }
 793
 794     for (inversion = 0; inversion < 4; inversion++) {
 795         switch (num_notes) {
 796         case 1:
 797             for (i = 0; i < ARRAY_SIZE (octaves); i++) {
 798                 if (_chord_signature_matches (notes, num_notes,
 799                                               octaves[i].degrees, 1,
 800                                               inversion, &root))
 801                 {
 802                     chord_name = octaves[i].name;
 803                     goto CHORD_NAME_KNOWN;
 804                 }
 805             }
 806             break;
 807         case 2:
 808             for (i = 0; i < ARRAY_SIZE (intervals); i++) {
 809                 if (_chord_signature_matches (notes, num_notes,
 810                                               intervals[i].degrees, 2,
 811                                               inversion, &root))
 812                 {
 813                     chord_name = intervals[i].name;
 814                     goto CHORD_NAME_KNOWN;
 815                 }
 816             }
 817             break;
 818         case 3:
 819             for (i = 0; i < ARRAY_SIZE (triads); i++) {
 820                 if (_chord_signature_matches (notes, num_notes,
 821                                               triads[i].degrees, 3,
 822                                               inversion, &root))
 823                 {
 824                     chord_name = triads[i].name;
 825                     goto CHORD_NAME_KNOWN;
 826                 }
 827             }
 828             break;
 829         case 4:
 830             for (i = 0; i < ARRAY_SIZE (tetrachords); i++) {
 831                 if (_chord_signature_matches (notes, num_notes,
 832                                               tetrachords[i].degrees, 4,
 833                                               inversion, &root))
 834                 {
 835                     chord_name = tetrachords[i].name;
 836                     goto CHORD_NAME_KNOWN;
 837                 }
 838             }
 839             break;
 840         case 5:
 841             for (i = 0; i < ARRAY_SIZE (pentachords); i++) {
 842                 if (_chord_signature_matches (notes, num_notes,
 843                                               pentachords[i].degrees, 5,
 844                                               inversion, &root))
 845                 {
 846                     chord_name = pentachords[i].name;
 847                     goto CHORD_NAME_KNOWN;
 848                 }
 849             }
 850             break;
 851         }
 852     }
 853     CHORD_NAME_KNOWN:
 854
 855     if (chord_name) {
 856         if (inversion) {
 857             const char *inversion_str;
 858             switch (inversion) {
 859             case 1:
 860                 inversion_str = "1st inversion";
 861                 break;
 862             case 2:
 863                 inversion_str = "2nd inversion";
 864                 break;
 865             case 3:
 866                 inversion_str = "3rd inversion";
 867                 break;
 868             default:
 869                 fprintf (stderr, "Internal error: Unexpected inversion: %d\n",
 870                          inversion);
 871                 exit(1);
 872             }
 873             chord_name = talloc_asprintf (local, "%s%s %s",
 874                                           _pitch_str (root),
 875                                           chord_name, inversion_str);
 876         } else {
 877             chord_name = talloc_asprintf (local, "%s%s",
 878                                           _pitch_str (root),
 879                                           chord_name);
 880         }
 881     } else {
 882         chord_name = talloc_strdup (local, "Unknown chord");
 883     }
 884
 885     scherzo->chord = score_add_chord (scherzo->treble, chord_name);
 886
 887 DONE:
 888     talloc_free (local);
 889 }
 890
 891 static void
 892 note_group_init (void *ctx, note_group_t *group)
 893 {
 894     group->ctx = ctx;
 895     group->notes = NULL;
 896     group->size = 0;
 897     group->num_notes = 0;
 898 }
 899
 900 static void
 901 note_group_add_note (note_group_t *group, score_note_t *note)
 902 {
 903     int i;
 904
 905     /* Do nothing if note is already in group. */
 906     for (i = 0; i < group->num_notes; i++) {
 907         if (group->notes[i]->pitch == note->pitch &&
 908             group->notes[i]->octave == note->octave)
 909         {
 910             return;
 911         }
 912     }
 913
 914     group->num_notes++;
 915
 916     if (group->num_notes > group->size) {
 917         group->size++;
 918         group->notes = talloc_realloc (group->ctx, group->notes,
 919                                        score_note_t*, group->size);
 920
 921         if (group->notes == NULL) {
 922             fprintf (stderr, "Out of memory.\n");
 923             exit (1);
 924         }
 925     }
 926
 927     group->notes[group->num_notes - 1] = note;
 928 }
 929
 930 static void
 931 note_group_remove_note_at (note_group_t *group, int i)
 932 {
 933     if (i >= group->num_notes) {
 934         fprintf (stderr, "Internal error: No note to remove at index %d\n", i);
 935         exit (1);
 936     }
 937
 938     if (i < group->num_notes - 1) {
 939         memmove (group->notes + i, group->notes + i + 1,
 940                  (group->num_notes - 1 - i) * sizeof (score_note_t*));
 941     }
 942     group->num_notes--;
 943 }
 944
 945 static score_note_t *
 946 scherzo_press_note (scherzo_t *scherzo, score_pitch_t pitch, int octave)
 947 {
 948     score_staff_t *staff;
 949     score_note_t *note;
 950     int i;
 951
 952     if (scherzo->challenge.note) {
 953         staff = scherzo->challenge.staff;
 954     } else if (octave >= 4) {
 955         staff = scherzo->treble;
 956     } else {
 957         staff = scherzo->bass;
 958     }
 959
 960     /* Do nothing if this note is already pressed. */
 961     for (i = 0; i < scherzo->notes_pressed.num_notes; i++) {
 962         if (scherzo->notes_pressed.notes[i]->pitch == pitch &&
 963             scherzo->notes_pressed.notes[i]->octave == octave)
 964         {
 965             return scherzo->notes_pressed.notes[i];
 966         }
 967     }
 968
 969     note = score_add_note (staff, pitch, octave, SCORE_DURATION_WHOLE);
 970
 971     note_group_add_note (&scherzo->notes_pressed, note);
 972
 973     if (scherzo->pedal_pressed)
 974         note_group_add_note (&scherzo->notes_pedaled, note);
 975
 976     scherzo_analyze_chord (scherzo);
 977
 978     return note;
 979 }
 980
 981 static void
 982 scherzo_release_note (scherzo_t *scherzo, score_pitch_t pitch, int octave)
 983 {
 984     score_note_t *note;
 985     int i;
 986     int found = 0;
 987
 988     for (i = scherzo->notes_pressed.num_notes - 1; i >=0; i--) {
 989         note = scherzo->notes_pressed.notes[i];
 990         if (note->pitch == pitch && note->octave == octave) {
 991             found = 1;
 992             if (! scherzo->pedal_pressed)
 993                 score_remove_note (note);
 994             note_group_remove_note_at (&scherzo->notes_pressed, i);
 995         }
 996     }
 997
 998     if (found == 0) {
 999         fprintf (stderr, "Internal error: Failed to find note to release.\n");
1000     }
1001
1002     scherzo_analyze_chord (scherzo);
1003 }
1004
1005 static score_note_t *
1006 scherzo_press_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1007 {
1008     score_pitch_t pitch;
1009     int octave;
1010
1011     _midi_to_score_pitch_and_octave (midi_note, &pitch, &octave);
1012
1013     return scherzo_press_note (scherzo, pitch, octave);
1014 }
1015
1016 static void
1017 scherzo_release_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1018 {
1019     score_pitch_t pitch;
1020     int octave;
1021
1022     _midi_to_score_pitch_and_octave (midi_note, &pitch, &octave);
1023
1024     scherzo_release_note (scherzo, pitch, octave);
1025 }
1026
1027 static void
1028 scherzo_press_pedal (scherzo_t *scherzo)
1029 {
1030     int i;
1031
1032     scherzo->pedal_pressed = 1;
1033
1034     /* Copy all pressed notes to pedaled notes */
1035     for (i = 0; i < scherzo->notes_pressed.num_notes; i++)
1036         note_group_add_note (&scherzo->notes_pedaled, scherzo->notes_pressed.notes[i]);
1037 }
1038
1039 static void
1040 scherzo_release_pedal (scherzo_t *scherzo)
1041 {
1042     score_note_t *note, *new_note;
1043     int i;
1044
1045     /* Make new notes in score for all pressed notes. */
1046     for (i = 0; i < scherzo->notes_pressed.num_notes; i++) {
1047         note = scherzo->notes_pressed.notes[i];
1048         new_note = score_add_note (note->staff, note->pitch, note->octave, note->duration);
1049         scherzo->notes_pressed.notes[i] = new_note;
1050     }
1051
1052     /* Then remove all previously pedaled notes from the score. */
1053     for (i = scherzo->notes_pedaled.num_notes - 1; i >=0; i--) {
1054         note = scherzo->notes_pedaled.notes[i];
1055         score_remove_note (note);
1056         note_group_remove_note_at (&scherzo->notes_pedaled, i);
1057     }
1058
1059     scherzo->pedal_pressed = 0;
1060
1061     scherzo_analyze_chord (scherzo);
1062
1063     gtk_widget_queue_draw (scherzo->window);
1064 }
1065
1066 void
1067 _select_challenge (scherzo_t *scherzo)
1068 {
1069     category_t *category_unused;
1070     bool_t introduced_unused;
1071     item_t *item;
1072     challenge_t *challenge = &scherzo->challenge;
1073     score_pitch_t pitch;
1074     int octave;
1075     char *s;
1076
1077     if (challenge->note) {
1078         score_remove_note (challenge->note);
1079         challenge->note = NULL;
1080     }
1081
1082     mnemon_select_item (&scherzo->mnemon,
1083                         &challenge->bin,
1084                         &challenge->item_index,
1085                         &category_unused,
1086                         &introduced_unused);
1087
1088     item = challenge->bin->items[challenge->item_index];
1089
1090     s = item->challenge;
1091     if (strncmp (s, "treble:", 7) == 0) {
1092         s += 7;
1093         challenge->staff = scherzo->treble;
1094     } else if (strncmp (s, "bass:", 5) == 0) {
1095         s += 5;
1096         challenge->staff = scherzo->bass;
1097     } else {
1098         fprintf (stderr,
1099                  "Malformed staff name: %s (expected 'treble:' or 'bass:')\n",
1100                  s);
1101         exit (1);
1102     }
1103
1104     switch (*s) {
1105     case 'C':
1106         pitch = SCORE_PITCH_C;
1107         break;
1108     case 'D':
1109         pitch = SCORE_PITCH_D;
1110         break;
1111     case 'E':
1112         pitch = SCORE_PITCH_E;
1113         break;
1114     case 'F':
1115         pitch = SCORE_PITCH_F;
1116         break;
1117     case 'G':
1118         pitch = SCORE_PITCH_G;
1119         break;
1120     case 'A':
1121         pitch = SCORE_PITCH_A;
1122         break;
1123     case 'B':
1124         pitch = SCORE_PITCH_B;
1125         break;
1126     default:
1127         fprintf (stderr, "Malformed pitch name: %s (expected 'A' - 'G')\n", s);
1128         exit (1);
1129     }
1130     s++;
1131
1132     if (*s < '0' || *s > '9') {
1133         fprintf (stderr, "Malformed octave number: %s (expected '0' - '9')\n", s);
1134         exit (1);
1135     }
1136
1137     octave = *s - '0';
1138
1139     challenge->note = score_add_note (challenge->staff, pitch, octave,
1140                                       SCORE_DURATION_WHOLE);
1141     challenge->satisfied = 0;
1142     challenge->mistaken = 0;
1143 }
1144
1145 /* Determine whether the user hit the correct note. */
1146 static void
1147 _judge_note (scherzo_t *scherzo, score_note_t *note)
1148 {
1149     challenge_t *challenge = &scherzo->challenge;
1150
1151     if (! scherzo->challenge.note) {
1152         score_set_note_color_rgb (note, 0.0, 0.0, 0.0); /* black */
1153         return;
1154     }
1155
1156     if (note->pitch == challenge->note->pitch &&
1157         note->octave == challenge->note->octave)
1158     {
1159         challenge->satisfied = 1;
1160         score_set_note_color_rgb (note, 18/256., 130/256., 28/256.); /* green */
1161     }
1162     else
1163     {
1164         challenge->mistaken = 1;
1165         score_set_note_color_rgb (note, 184/256., 4/256., 22/256.); /* red */
1166     }
1167 }
1168
1169 /* If the user got the right note (eventually), then score it in
1170  * mnemon and show the next note. */
1171 static void
1172 _score_challenge (scherzo_t *scherzo)
1173 {
1174     challenge_t *challenge = &scherzo->challenge;
1175
1176     if (! challenge->note)
1177         return;
1178
1179     if (! challenge->satisfied)
1180         return;
1181
1182     mnemon_score_item (&scherzo->mnemon, challenge->bin, challenge->item_index,
1183                        ! challenge->mistaken);
1184
1185     _select_challenge (scherzo);
1186 }
1187
1188 static int
1189 on_midi_input (unused (GIOChannel *channel),
1190                unused (GIOCondition condition),
1191                void *user_data)
1192 {
1193     unsigned char buf[MIDI_BUF_SIZE], *next;
1194     scherzo_t *scherzo = user_data;
1195     ssize_t remaining;
1196     snd_seq_event_t event;
1197     score_note_t *note;
1198     int need_redraw = FALSE;
1199
1200     remaining = read (scherzo->midi_fd, buf, MIDI_BUF_SIZE);
1201
1202     next = buf;
1203     while (remaining) {
1204         long consumed;
1205
1206         consumed = snd_midi_event_encode (scherzo->snd_midi_event,
1207                                           next, remaining, &event);
1208
1209         remaining -= consumed;
1210         next += consumed;
1211
1212         switch (event.type) {
1213         case SND_SEQ_EVENT_NONE:
1214             /* Incomplete event. Nothing to do. */
1215             break;
1216         case SND_SEQ_EVENT_NOTEON:
1217             note = scherzo_press_note_midi (scherzo, event.data.note.note);
1218             _judge_note (scherzo, note);
1219             need_redraw = TRUE;
1220             break;
1221         case SND_SEQ_EVENT_NOTEOFF:
1222             scherzo_release_note_midi (scherzo, event.data.note.note);
1223             _score_challenge (scherzo);
1224             need_redraw = TRUE;
1225             break;
1226         case SND_SEQ_EVENT_CLOCK:
1227             /* Ignore for now as my piano sends a constant stream of these. */
1228             break;
1229         case SND_SEQ_EVENT_SENSING:
1230             /* Ignore for now as my piano sends a constant stream of these. */
1231             break;
1232         case SND_SEQ_EVENT_CONTROLLER:
1233             /* XXX: My piano gives me 64 for the sustain pedal, is
1234              * that universal? */
1235             if (event.data.control.param == 64) {
1236                 if (event.data.control.value == 0)
1237                     scherzo_release_pedal (scherzo);
1238                 else
1239                     scherzo_press_pedal (scherzo);
1240             } else {
1241                 fprintf (stderr, "Fixme: Unhandled MIDI Control event (param=%d, value=%d)\n",
1242                          event.data.control.param, event.data.control.value);
1243             }
1244             break;
1245         default:
1246             fprintf (stderr, "Fixme: Do not yet know how to handle MIDI event %d\n",
1247                      event.type);
1248             break;
1249         }
1250     }
1251
1252     if (need_redraw)
1253         gtk_widget_queue_draw (scherzo->window);
1254
1255     /* Return TRUE to continue to get called in the future. */
1256     return TRUE;
1257 }
1258
1259 int
1260 main (int argc, char *argv[])
1261 {
1262     GtkWidget *drawing_area;
1263     scherzo_t scherzo;
1264     int err;
1265
1266     srand (time (NULL));
1267
1268     gtk_init (&argc, &argv);
1269
1270     scherzo.ctx = talloc_new (NULL);
1271
1272     scherzo.score = score_create (scherzo.ctx);
1273     scherzo.staff_height = 100;
1274     score_set_staff_height (scherzo.score, scherzo.staff_height);
1275
1276     score_add_brace (scherzo.score, 2);
1277     scherzo.treble = score_add_staff (scherzo.score, SCORE_CLEF_G);
1278     scherzo.bass = score_add_staff (scherzo.score, SCORE_CLEF_F);
1279
1280     scherzo.chord = NULL;
1281
1282     /* Default to octave 4 and natural for computer keyboard keypresses. */
1283     scherzo.keyboard_octave = 4;
1284     scherzo.keyboard_accidental = SCORE_PITCH_ACCIDENTAL_NATURAL;
1285
1286     note_group_init (scherzo.ctx, &scherzo.notes_pressed);
1287     note_group_init (scherzo.ctx, &scherzo.notes_pedaled);
1288
1289     scherzo.pedal_pressed = 0;
1290
1291     mnemon_init (&scherzo.mnemon);
1292     /* XXX: Should create a default file if one cannot be loaded. */
1293     mnemon_load_category (&scherzo.mnemon, "scherzo-notes");
1294
1295     scherzo.challenge.note = NULL;
1296 /*
1297     _select_challenge (&scherzo);
1298 */
1299
1300     err = snd_midi_event_new (MIDI_BUF_SIZE, &scherzo.snd_midi_event);
1301     if (err) {
1302         fprintf (stderr, "Out of memory.\n");
1303         return 1;
1304     }
1305
1306 #define MIDI_DEVICE "/dev/midi1"
1307     scherzo.midi_fd = open (MIDI_DEVICE, O_RDONLY);
1308     if (scherzo.midi_fd < 0) {
1309         printf ("failed to open " MIDI_DEVICE ". Midi input will not be available.\n");
1310     } else {
1311         GIOChannel *channel;
1312
1313         channel = g_io_channel_unix_new (scherzo.midi_fd);
1314         g_io_channel_set_encoding (channel, NULL, NULL);
1315         g_io_add_watch (channel, G_IO_IN, on_midi_input, &scherzo);
1316     }
1317
1318     scherzo.window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1319
1320     gtk_window_set_default_size (GTK_WINDOW (scherzo.window), 1000, 600);
1321
1322     g_signal_connect (scherzo.window, "delete-event",
1323                       G_CALLBACK (on_delete_event_quit), NULL);
1324
1325     drawing_area = gtk_drawing_area_new ();
1326
1327     gtk_container_add (GTK_CONTAINER (scherzo.window), drawing_area);
1328
1329     g_signal_connect (drawing_area, "expose-event",
1330                       G_CALLBACK (on_expose_event_draw),
1331                       &scherzo);
1332
1333     g_signal_connect (scherzo.window, "key-press-event",
1334                       G_CALLBACK (on_key_press_event),
1335                       &scherzo);
1336
1337     g_signal_connect (scherzo.window, "key-release-event",
1338                       G_CALLBACK (on_key_release_event),
1339                       &scherzo);
1340
1341     gtk_widget_show_all (scherzo.window);
1342
1343     gtk_main ();
1344
1345     mnemon_save (&scherzo.mnemon);
1346
1347     snd_midi_event_free (scherzo.snd_midi_event);
1348
1349     talloc_free (scherzo.ctx);
1350
1351     return 0;
1352 }