]> git.cworth.org Git - scherzo/blob - scherzo.c
Add some flat-5 variants of 9th chords
[scherzo] / 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}, {4,  0}, {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}, {4,  0}, {5,  0}, {7,  0}}, "sus" SUP "M7" PUS },
685         { {{1, 0}, {4,  0}, {5,  0}, {7, -1}}, "sus" SUP "7" PUS },
686         { {{1, 0}, {4,  0}, {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}, {4,  0}, {7,  0}}, "sus" SUP "M9" PUS },
704         { {{1, 0}, {9,  0}, {4,  0}, {7, -1}}, "sus" SUP "9" PUS },
705         { {{1, 0}, {9,  0}, {3,  0}, {7,  0}}, "M9" },
706         { {{1, 0}, {9,  0}, {3,  0}, {7, -1}}, "9" },
707         { {{1, 0}, {9,  0}, {3, -1}, {7,  0}}, "m" SUP "M9" PUS },
708         { {{1, 0}, {9,  0}, {3, -1}, {7, -1}}, "m9" },
709         { {{1, 0}, {9, -1}, {3, -1}, {7, -1}}, "m♭9" },
710     };
711
712     /* The sorting here is funny to keep the array in degree order
713      * after reducing each degree to an actual scale degree, (9 -> 2,
714      * 11 -> 4, 13 -> 6) */
715     struct { modified_degree_t degrees[5]; const char *name; } pentachords[] = {
716         { {{1, 0}, {9,  0}, {4,  0}, {5, +1}, {7,  0}}, "sus" SUP "+M9" PUS },
717         { {{1, 0}, {9,  0}, {4,  0}, {5, +1}, {7, -1}}, "sus" SUP "+9" PUS },
718         { {{1, 0}, {9,  0}, {4,  0}, {5,  0}, {7,  0}}, "sus" SUP "M9" PUS },
719         { {{1, 0}, {9,  0}, {4,  0}, {5,  0}, {7, -1}}, "sus" SUP "9" PUS },
720
721         { {{1, 0}, {9,  0}, {3,  0}, {5, +1}, {7,  0}}, SUP "+M9" PUS },
722         { {{1, 0}, {9,  0}, {3,  0}, {5, +1}, {7, -1}}, SUP "+9" PUS },
723
724         { {{1, 0}, {9,  0}, {3,  0}, {5,  0}, {7,  0}}, "M9" },
725         { {{1, 0}, {9,  0}, {3,  0}, {5,  0}, {7, -1}}, "9" },
726         { {{1, 0}, {9,  0}, {3, -1}, {5,  0}, {7,  0}}, "m" SUP "M9" PUS },
727         { {{1, 0}, {9,  0}, {3, -1}, {5,  0}, {7, -1}}, "m9" },
728         { {{1, 0}, {9, -1}, {3, -1}, {5,  0}, {7, -1}}, "m♭9" },
729         { {{1, 0}, {9,  0}, {3,  0}, {5, -1}, {7,  0}}, "M9" SUP "♭5" PUS },
730         { {{1, 0}, {9,  0}, {3,  0}, {5, -1}, {7, -1}}, "9" SUP "♭5" PUS },
731         { {{1, 0}, {9,  0}, {3, -1}, {5, -1}, {7,  0}}, "m" SUP "M9♭5" PUS },
732         { {{1, 0}, {9,  0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "9" PUS },
733
734         /* FIXME: I don't have names for these last three after
735          * dropping the 5th from the voicing. That suggests to me that
736          * I'm missing names for these with a perfect 5th in the list
737          * above. */
738         { {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "♭9" PUS },
739         { {{1, 0}, {9,  0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "9" PUS },
740         { {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "♭9" PUS },
741     };
742
743     if (scherzo->chord) {
744         score_remove_chord (scherzo->chord);
745         scherzo->chord = NULL;
746     }
747
748     if (num_notes <= 1)
749         goto DONE;
750
751     notes = talloc_array (local, analyzed_note_t, num_notes);
752     if (notes == NULL)
753         goto DONE;
754
755     for (i = 0; i < num_notes; i++) {
756         score_note_t *note = note_group->notes[i];
757         notes[i].note = note;
758         notes[i].midi_pitch = _score_pitch_and_octave_to_midi (note->pitch,
759                                                                note->octave);
760         /* Relative pitch will be filled in after sorting. */
761         notes[i].relative_pitch = 0;
762     }
763
764     /* First, sort by midi pitch to find the bass note. */
765     qsort (notes, num_notes, sizeof (analyzed_note_t),
766            _compare_analyzed_note_by_midi_pitch);
767     
768     bass_pitch = notes[0].midi_pitch;
769
770     /* With the bass note identified, we can find all relative pitches. */
771     for (i = 0; i < num_notes; i++) {
772         notes[i].relative_pitch = notes[i].midi_pitch - bass_pitch;
773         while (notes[i].relative_pitch >= 12)
774             notes[i].relative_pitch -= 12;
775     }
776
777     /* Now, sort again by relative pitch. */
778     qsort (notes, num_notes, sizeof (analyzed_note_t),
779            _compare_analyzed_note_by_relative_pitch);
780
781     /* Finally, eliminate all duplicate notes. */
782     for (i = 0; i < num_notes - 1; i++) {
783             if (notes[i+1].relative_pitch == notes[i].relative_pitch) {
784                     j = i+1;
785                     while (j < num_notes &&
786                            notes[j].relative_pitch == notes[i].relative_pitch)
787                     {
788                             j++;
789                     }
790                     /* The loop incremented j one past the last
791                      * duplicate. Decrement so that it points to the
792                      * last duplicate (and is guaranteed to not exceed
793                      * the array bounds).*/
794                     j--;
795
796                     if (j < num_notes - 1) {
797                             memmove (&notes[i+1], &notes[j+1],
798                                      (num_notes - j) * sizeof (analyzed_note_t));
799                     }
800
801                     num_notes -= (j - i);
802             }
803     }
804
805     for (inversion = 0; inversion < 4; inversion++) {
806         switch (num_notes) {
807         case 1:
808             for (i = 0; i < ARRAY_SIZE (octaves); i++) {
809                 if (_chord_signature_matches (notes, num_notes,
810                                               octaves[i].degrees, 1,
811                                               inversion, &root))
812                 {
813                     chord_name = octaves[i].name;
814                     goto CHORD_NAME_KNOWN;
815                 }
816             }
817             break;
818         case 2:
819             for (i = 0; i < ARRAY_SIZE (intervals); i++) {
820                 if (_chord_signature_matches (notes, num_notes,
821                                               intervals[i].degrees, 2,
822                                               inversion, &root))
823                 {
824                     chord_name = intervals[i].name;
825                     goto CHORD_NAME_KNOWN;
826                 }
827             }
828             break;
829         case 3:
830             for (i = 0; i < ARRAY_SIZE (triads); i++) {
831                 if (_chord_signature_matches (notes, num_notes,
832                                               triads[i].degrees, 3,
833                                               inversion, &root))
834                 {
835                     chord_name = triads[i].name;
836                     goto CHORD_NAME_KNOWN;
837                 }
838             }
839             break;
840         case 4:
841             for (i = 0; i < ARRAY_SIZE (tetrachords); i++) {
842                 if (_chord_signature_matches (notes, num_notes,
843                                               tetrachords[i].degrees, 4,
844                                               inversion, &root))
845                 {
846                     chord_name = tetrachords[i].name;
847                     goto CHORD_NAME_KNOWN;
848                 }
849             }
850             break;
851         case 5:
852             for (i = 0; i < ARRAY_SIZE (pentachords); i++) {
853                 if (_chord_signature_matches (notes, num_notes,
854                                               pentachords[i].degrees, 5,
855                                               inversion, &root))
856                 {
857                     chord_name = pentachords[i].name;
858                     goto CHORD_NAME_KNOWN;
859                 }
860             }
861             break;
862         }
863     }
864     CHORD_NAME_KNOWN:
865
866     if (chord_name) {
867         if (inversion) {
868             const char *inversion_str;
869             switch (inversion) {
870             case 1:
871                 inversion_str = "1st inversion";
872                 break;
873             case 2:
874                 inversion_str = "2nd inversion";
875                 break;
876             case 3:
877                 inversion_str = "3rd inversion";
878                 break;
879             default:
880                 fprintf (stderr, "Internal error: Unexpected inversion: %d\n",
881                          inversion);
882                 exit(1);
883             }
884             chord_name = talloc_asprintf (local, "%s%s %s",
885                                           _pitch_str (root),
886                                           chord_name, inversion_str);
887         } else {
888             chord_name = talloc_asprintf (local, "%s%s",
889                                           _pitch_str (root),
890                                           chord_name);
891         }
892     } else {
893         chord_name = talloc_strdup (local, "Unknown chord");
894     }
895
896     scherzo->chord = score_add_chord (scherzo->treble, chord_name);
897
898 DONE:
899     talloc_free (local);
900 }
901
902 static void
903 note_group_init (void *ctx, note_group_t *group)
904 {
905     group->ctx = ctx;
906     group->notes = NULL;
907     group->size = 0;
908     group->num_notes = 0;
909 }
910
911 static void
912 note_group_add_note (note_group_t *group, score_note_t *note)
913 {
914     int i;
915
916     /* Do nothing if note is already in group. */
917     for (i = 0; i < group->num_notes; i++) {
918         if (group->notes[i]->pitch == note->pitch &&
919             group->notes[i]->octave == note->octave)
920         {
921             return;
922         }
923     }
924
925     group->num_notes++;
926
927     if (group->num_notes > group->size) {
928         group->size++;
929         group->notes = talloc_realloc (group->ctx, group->notes,
930                                        score_note_t*, group->size);
931
932         if (group->notes == NULL) {
933             fprintf (stderr, "Out of memory.\n");
934             exit (1);
935         }
936     }
937
938     group->notes[group->num_notes - 1] = note;
939 }
940
941 static void
942 note_group_remove_note_at (note_group_t *group, int i)
943 {
944     if (i >= group->num_notes) {
945         fprintf (stderr, "Internal error: No note to remove at index %d\n", i);
946         exit (1);
947     }
948
949     if (i < group->num_notes - 1) {
950         memmove (group->notes + i, group->notes + i + 1,
951                  (group->num_notes - 1 - i) * sizeof (score_note_t*));
952     }
953     group->num_notes--;
954 }
955
956 static score_note_t *
957 scherzo_press_note (scherzo_t *scherzo, score_pitch_t pitch, int octave)
958 {
959     score_staff_t *staff;
960     score_note_t *note;
961     int i;
962
963     if (scherzo->challenge.note) {
964         staff = scherzo->challenge.staff;
965     } else if (octave >= 4) {
966         staff = scherzo->treble;
967     } else {
968         staff = scherzo->bass;
969     }
970
971     /* Do nothing if this note is already pressed. */
972     for (i = 0; i < scherzo->notes_pressed.num_notes; i++) {
973         if (scherzo->notes_pressed.notes[i]->pitch == pitch &&
974             scherzo->notes_pressed.notes[i]->octave == octave)
975         {
976             return scherzo->notes_pressed.notes[i];
977         }
978     }
979
980     note = score_add_note (staff, pitch, octave, SCORE_DURATION_WHOLE);
981
982     note_group_add_note (&scherzo->notes_pressed, note);
983
984     if (scherzo->pedal_pressed)
985         note_group_add_note (&scherzo->notes_pedaled, note);
986
987     scherzo_analyze_chord (scherzo);
988
989     return note;
990 }
991
992 static void
993 scherzo_release_note (scherzo_t *scherzo, score_pitch_t pitch, int octave)
994 {
995     score_note_t *note;
996     int i;
997     int found = 0;
998
999     for (i = scherzo->notes_pressed.num_notes - 1; i >=0; i--) {
1000         note = scherzo->notes_pressed.notes[i];
1001         if (note->pitch == pitch && note->octave == octave) {
1002             found = 1;
1003             if (! scherzo->pedal_pressed)
1004                 score_remove_note (note);
1005             note_group_remove_note_at (&scherzo->notes_pressed, i);
1006         }
1007     }
1008
1009     if (found == 0) {
1010         fprintf (stderr, "Internal error: Failed to find note to release.\n");
1011     }
1012
1013     scherzo_analyze_chord (scherzo);
1014 }
1015
1016 static score_note_t *
1017 scherzo_press_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     return scherzo_press_note (scherzo, pitch, octave);
1025 }
1026
1027 static void
1028 scherzo_release_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1029 {
1030     score_pitch_t pitch;
1031     int octave;
1032  
1033     _midi_to_score_pitch_and_octave (midi_note, &pitch, &octave);
1034
1035     scherzo_release_note (scherzo, pitch, octave);
1036 }
1037
1038 static void
1039 scherzo_press_pedal (scherzo_t *scherzo)
1040 {
1041     int i;
1042
1043     scherzo->pedal_pressed = 1;
1044
1045     /* Copy all pressed notes to pedaled notes */
1046     for (i = 0; i < scherzo->notes_pressed.num_notes; i++)
1047         note_group_add_note (&scherzo->notes_pedaled, scherzo->notes_pressed.notes[i]);
1048 }
1049
1050 static void
1051 scherzo_release_pedal (scherzo_t *scherzo)
1052 {
1053     score_note_t *note, *new_note;
1054     int i;
1055
1056     /* Make new notes in score for all pressed notes. */
1057     for (i = 0; i < scherzo->notes_pressed.num_notes; i++) {
1058         note = scherzo->notes_pressed.notes[i];
1059         new_note = score_add_note (note->staff, note->pitch, note->octave, note->duration);
1060         scherzo->notes_pressed.notes[i] = new_note;
1061     }
1062
1063     /* Then remove all previously pedaled notes from the score. */
1064     for (i = scherzo->notes_pedaled.num_notes - 1; i >=0; i--) {
1065         note = scherzo->notes_pedaled.notes[i];
1066         score_remove_note (note);
1067         note_group_remove_note_at (&scherzo->notes_pedaled, i);
1068     }
1069
1070     scherzo->pedal_pressed = 0;
1071
1072     scherzo_analyze_chord (scherzo);
1073
1074     gtk_widget_queue_draw (scherzo->window);
1075 }
1076
1077 void
1078 _select_challenge (scherzo_t *scherzo)
1079 {
1080     category_t *category_unused;
1081     bool_t introduced_unused;
1082     item_t *item;
1083     challenge_t *challenge = &scherzo->challenge;
1084     score_pitch_t pitch;
1085     int octave;
1086     char *s;
1087
1088     if (challenge->note) {
1089         score_remove_note (challenge->note);
1090         challenge->note = NULL;
1091     }
1092
1093     mnemon_select_item (&scherzo->mnemon,
1094                         &challenge->bin,
1095                         &challenge->item_index,
1096                         &category_unused,
1097                         &introduced_unused);
1098
1099     item = challenge->bin->items[challenge->item_index];
1100
1101     s = item->challenge;
1102     if (strncmp (s, "treble:", 7) == 0) {
1103         s += 7;
1104         challenge->staff = scherzo->treble;
1105     } else if (strncmp (s, "bass:", 5) == 0) {
1106         s += 5;
1107         challenge->staff = scherzo->bass;
1108     } else {
1109         fprintf (stderr,
1110                  "Malformed staff name: %s (expected 'treble:' or 'bass:')\n",
1111                  s);
1112         exit (1);
1113     }
1114
1115     switch (*s) {
1116     case 'C':
1117         pitch = SCORE_PITCH_C;
1118         break;
1119     case 'D':
1120         pitch = SCORE_PITCH_D;
1121         break;
1122     case 'E':
1123         pitch = SCORE_PITCH_E;
1124         break;
1125     case 'F':
1126         pitch = SCORE_PITCH_F;
1127         break;
1128     case 'G':
1129         pitch = SCORE_PITCH_G;
1130         break;
1131     case 'A':
1132         pitch = SCORE_PITCH_A;
1133         break;
1134     case 'B':
1135         pitch = SCORE_PITCH_B;
1136         break;
1137     default:
1138         fprintf (stderr, "Malformed pitch name: %s (expected 'A' - 'G')\n", s);
1139         exit (1);
1140     }
1141     s++;
1142
1143     if (*s < '0' || *s > '9') {
1144         fprintf (stderr, "Malformed octave number: %s (expected '0' - '9')\n", s);
1145         exit (1);
1146     }
1147
1148     octave = *s - '0';
1149
1150     challenge->note = score_add_note (challenge->staff, pitch, octave,
1151                                       SCORE_DURATION_WHOLE);
1152     challenge->satisfied = 0;
1153     challenge->mistaken = 0;
1154 }
1155
1156 /* Determine whether the user hit the correct note. */
1157 static void
1158 _judge_note (scherzo_t *scherzo, score_note_t *note)
1159 {
1160     challenge_t *challenge = &scherzo->challenge;
1161
1162     if (! scherzo->challenge.note) {
1163         score_set_note_color_rgb (note, 0.0, 0.0, 0.0); /* black */
1164         return;
1165     }
1166
1167     if (note->pitch == challenge->note->pitch &&
1168         note->octave == challenge->note->octave)
1169     {
1170         challenge->satisfied = 1;
1171         score_set_note_color_rgb (note, 18/256., 130/256., 28/256.); /* green */
1172     }
1173     else
1174     {
1175         challenge->mistaken = 1;
1176         score_set_note_color_rgb (note, 184/256., 4/256., 22/256.); /* red */
1177     }
1178 }
1179
1180 /* If the user got the right note (eventually), then score it in
1181  * mnemon and show the next note. */
1182 static void
1183 _score_challenge (scherzo_t *scherzo)
1184 {
1185     challenge_t *challenge = &scherzo->challenge;
1186
1187     if (! challenge->note)
1188         return;
1189
1190     if (! challenge->satisfied)
1191         return;
1192
1193     mnemon_score_item (&scherzo->mnemon, challenge->bin, challenge->item_index,
1194                        ! challenge->mistaken);
1195
1196     _select_challenge (scherzo);
1197 }
1198
1199 static int
1200 on_midi_input (unused (GIOChannel *channel),
1201                unused (GIOCondition condition),
1202                void *user_data)
1203 {
1204     unsigned char buf[MIDI_BUF_SIZE], *next;
1205     scherzo_t *scherzo = user_data;
1206     ssize_t remaining;
1207     snd_seq_event_t event;
1208     score_note_t *note;
1209     int need_redraw = FALSE;
1210
1211     remaining = read (scherzo->midi_fd, buf, MIDI_BUF_SIZE);
1212
1213     next = buf;
1214     while (remaining) {
1215         long consumed;
1216
1217         consumed = snd_midi_event_encode (scherzo->snd_midi_event,
1218                                           next, remaining, &event);
1219
1220         remaining -= consumed;
1221         next += consumed;
1222
1223         switch (event.type) {
1224         case SND_SEQ_EVENT_NONE:
1225             /* Incomplete event. Nothing to do. */
1226             break;
1227         case SND_SEQ_EVENT_NOTEON:
1228             note = scherzo_press_note_midi (scherzo, event.data.note.note);
1229             _judge_note (scherzo, note);
1230             need_redraw = TRUE;
1231             break;
1232         case SND_SEQ_EVENT_NOTEOFF:
1233             scherzo_release_note_midi (scherzo, event.data.note.note);
1234             _score_challenge (scherzo);
1235             need_redraw = TRUE;
1236             break;
1237         case SND_SEQ_EVENT_CLOCK:
1238             /* Ignore for now as my piano sends a constant stream of these. */
1239             break;
1240         case SND_SEQ_EVENT_SENSING:
1241             /* Ignore for now as my piano sends a constant stream of these. */
1242             break;
1243         case SND_SEQ_EVENT_CONTROLLER:
1244             /* XXX: My piano gives me 64 for the sustain pedal, is
1245              * that universal? */
1246             if (event.data.control.param == 64) {
1247                 if (event.data.control.value == 0)
1248                     scherzo_release_pedal (scherzo);
1249                 else
1250                     scherzo_press_pedal (scherzo);
1251             } else {
1252                 fprintf (stderr, "Fixme: Unhandled MIDI Control event (param=%d, value=%d)\n",
1253                          event.data.control.param, event.data.control.value);
1254             }
1255             break;
1256         default:
1257             fprintf (stderr, "Fixme: Do not yet know how to handle MIDI event %d\n",
1258                      event.type);
1259             break;
1260         }
1261     }
1262
1263     if (need_redraw)
1264         gtk_widget_queue_draw (scherzo->window);
1265
1266     /* Return TRUE to continue to get called in the future. */
1267     return TRUE;
1268 }
1269
1270 int
1271 main (int argc, char *argv[])
1272 {
1273     GtkWidget *drawing_area;
1274     scherzo_t scherzo;
1275     int err;
1276
1277     srand (time (NULL));
1278
1279     gtk_init (&argc, &argv);
1280
1281     scherzo.ctx = talloc_new (NULL);
1282
1283     scherzo.score = score_create (scherzo.ctx);
1284     scherzo.staff_height = 100;
1285     score_set_staff_height (scherzo.score, scherzo.staff_height);
1286
1287     score_add_brace (scherzo.score, 2);
1288     scherzo.treble = score_add_staff (scherzo.score, SCORE_CLEF_G);
1289     scherzo.bass = score_add_staff (scherzo.score, SCORE_CLEF_F);
1290
1291     scherzo.chord = NULL;
1292
1293     /* Default to octave 4 and natural for computer keyboard keypresses. */
1294     scherzo.keyboard_octave = 4;
1295     scherzo.keyboard_accidental = SCORE_PITCH_ACCIDENTAL_NATURAL;
1296
1297     note_group_init (scherzo.ctx, &scherzo.notes_pressed);
1298     note_group_init (scherzo.ctx, &scherzo.notes_pedaled);
1299
1300     scherzo.pedal_pressed = 0;
1301
1302     mnemon_init (&scherzo.mnemon);
1303     /* XXX: Should create a default file if one cannot be loaded. */
1304     mnemon_load_category (&scherzo.mnemon, "scherzo-notes");
1305
1306     scherzo.challenge.note = NULL;
1307 /*
1308     _select_challenge (&scherzo);
1309 */
1310
1311     err = snd_midi_event_new (MIDI_BUF_SIZE, &scherzo.snd_midi_event);
1312     if (err) {
1313         fprintf (stderr, "Out of memory.\n");
1314         return 1;
1315     }
1316
1317 #define MIDI_DEVICE "/dev/midi1"
1318     scherzo.midi_fd = open (MIDI_DEVICE, O_RDONLY);
1319     if (scherzo.midi_fd < 0) {
1320         printf ("failed to open " MIDI_DEVICE ". Midi input will not be available.\n");
1321     } else {
1322         GIOChannel *channel;
1323
1324         channel = g_io_channel_unix_new (scherzo.midi_fd);
1325         g_io_channel_set_encoding (channel, NULL, NULL);
1326         g_io_add_watch (channel, G_IO_IN, on_midi_input, &scherzo);
1327     }
1328
1329     scherzo.window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1330
1331     gtk_window_set_default_size (GTK_WINDOW (scherzo.window), 1000, 600);
1332
1333     g_signal_connect (scherzo.window, "delete-event",
1334                       G_CALLBACK (on_delete_event_quit), NULL);
1335
1336     drawing_area = gtk_drawing_area_new ();
1337
1338     gtk_container_add (GTK_CONTAINER (scherzo.window), drawing_area);
1339
1340     g_signal_connect (drawing_area, "expose-event",  
1341                       G_CALLBACK (on_expose_event_draw),
1342                       &scherzo);
1343
1344     g_signal_connect (scherzo.window, "key-press-event",
1345                       G_CALLBACK (on_key_press_event),
1346                       &scherzo);
1347
1348     g_signal_connect (scherzo.window, "key-release-event",
1349                       G_CALLBACK (on_key_release_event),
1350                       &scherzo);
1351     
1352     gtk_widget_show_all (scherzo.window);
1353     
1354     gtk_main ();
1355
1356     mnemon_save (&scherzo.mnemon);
1357
1358     snd_midi_event_free (scherzo.snd_midi_event);
1359
1360     talloc_free (scherzo.ctx);
1361
1362     return 0;
1363 }