1 /* scherzo - Music notation training
3 * Copyright © 2010 Carl Worth
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.
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.
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/ .
20 #include <gdk/gdkkeysyms.h>
22 #include <asoundlib.h>
27 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(arr[0]))
29 #define unused(foo) foo __attribute__((unused))
31 #define MIDI_BUF_SIZE 4096
33 typedef struct challenge
44 typedef struct note_group
52 typedef struct scherzo
59 score_staff_t *treble;
63 /* The word "keyboard" here is referring to a "computer
64 * keyboard". Any "piano keyboard" key knows its own octave and
65 * accidental already. */
67 pitch_accidental_t keyboard_accidental;
70 snd_midi_event_t *snd_midi_event;
73 challenge_t challenge;
75 note_group_t notes_pressed;
76 note_group_t notes_pedaled;
81 /* Forward declarations. */
83 scherzo_press_note (scherzo_t *scherzo, pitch_t pitch);
86 scherzo_release_note (scherzo_t *scherzo, pitch_t pitch);
89 scherzo_press_pedal (scherzo_t *scherzo);
92 scherzo_release_pedal (scherzo_t *scherzo);
95 _judge_note (scherzo_t *scherzo, score_note_t *note);
98 _score_challenge (scherzo_t *scherzo);
101 on_delete_event_quit (unused (GtkWidget *widget),
102 unused (GdkEvent *event),
103 unused (gpointer user_data))
107 /* Returning FALSE allows the default handler for delete-event
108 * to proceed to cleanup the widget. */
113 on_expose_event_draw (GtkWidget *widget,
114 unused (GdkEventExpose *expose),
117 scherzo_t *scherzo = user_data;
118 score_t *score = scherzo->score;
120 GtkAllocation allocation;
121 static const int pad = 10;
124 gtk_widget_get_allocation (widget, &allocation);
125 widget_width = allocation.width;
127 cr = gdk_cairo_create (widget->window);
129 /* White background */
130 cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
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);
138 score_draw (score, cr);
144 on_key_press_event (GtkWidget *widget,
148 scherzo_t *scherzo = user_data;
150 /* Initialize to keep the compiler quiet. */
151 pitch_name_t pitch_name = PITCH_NATURAL (C, 0);
154 if (scherzo->challenge.note)
155 octave = PITCH_OCTAVE (scherzo->challenge.note->pitch);
157 octave = scherzo->keyboard_octave;
159 switch (key->keyval) {
163 case GDK_KEY_KP_Equal:
164 scherzo->staff_height += 4;
165 gtk_widget_queue_draw (widget);
169 case GDK_KEY_KP_Subtract:
170 scherzo->staff_height -= 4;
171 gtk_widget_queue_draw (widget);
181 pitch_name = PITCH_NAME_C;
185 pitch_name = PITCH_NAME_D;
189 pitch_name = PITCH_NAME_E;
193 pitch_name = PITCH_NAME_F;
197 pitch_name = PITCH_NAME_G;
201 pitch_name = PITCH_NAME_A;
205 pitch_name = PITCH_NAME_B;
216 scherzo->keyboard_octave = key->keyval - GDK_KEY_0;
219 scherzo_press_pedal (scherzo);
222 if (scherzo->keyboard_accidental < PITCH_ACCIDENTAL_DOUBLE_SHARP)
223 scherzo->keyboard_accidental++;
226 if (scherzo->keyboard_accidental > PITCH_ACCIDENTAL_DOUBLE_FLAT)
227 scherzo->keyboard_accidental--;
231 pitch = PITCH (pitch_name, scherzo->keyboard_accidental, octave);
233 if ((key->keyval >= GDK_KEY_A && key->keyval <= GDK_KEY_G) ||
234 (key->keyval >= GDK_KEY_a && key->keyval <= GDK_KEY_g))
238 note = scherzo_press_note (scherzo, pitch);
239 _judge_note (scherzo, note);
240 gtk_widget_queue_draw (scherzo->window);
246 /* Allow an unhandled event to propagate to other handlers. */
251 on_key_release_event (unused (GtkWidget *widget),
255 scherzo_t *scherzo = user_data;
257 /* Initialize to keep the compiler quiet. */
258 pitch_name_t pitch_name = PITCH_NAME_C;
261 if (scherzo->challenge.note)
262 octave = PITCH_OCTAVE (scherzo->challenge.note->pitch);
264 octave = scherzo->keyboard_octave;
266 switch (key->keyval) {
269 pitch_name = PITCH_NAME_C;
273 pitch_name = PITCH_NAME_D;
277 pitch_name = PITCH_NAME_E;
281 pitch_name = PITCH_NAME_F;
285 pitch_name = PITCH_NAME_G;
289 pitch_name = PITCH_NAME_A;
293 pitch_name = PITCH_NAME_B;
296 scherzo_release_pedal (scherzo);
300 pitch = PITCH (pitch_name, scherzo->keyboard_accidental, octave);
302 if ((key->keyval >= GDK_KEY_A && key->keyval <= GDK_KEY_G) ||
303 (key->keyval >= GDK_KEY_a && key->keyval <= GDK_KEY_g))
305 scherzo_release_note (scherzo, pitch);
306 _score_challenge (scherzo);
307 gtk_widget_queue_draw (scherzo->window);
313 /* Allow an unhandled event to propagate to other handlers. */
318 _pitch_to_midi (pitch_t pitch)
320 int octave = PITCH_OCTAVE (pitch);
321 unsigned char midi_note = 12 * (octave + 1);
323 switch (PITCH_NAME (pitch)) {
346 switch (PITCH_ACCIDENTAL (pitch)) {
347 case PITCH_ACCIDENTAL_DOUBLE_FLAT:
350 case PITCH_ACCIDENTAL_FLAT:
353 case PITCH_ACCIDENTAL_NATURAL:
355 case PITCH_ACCIDENTAL_SHARP:
358 case PITCH_ACCIDENTAL_DOUBLE_SHARP:
366 /* octave can optionally by NULL */
368 _midi_to_pitch (unsigned char midi_note)
370 int octave = octave = midi_note / 12 - 1;
372 switch (midi_note % 12)
376 return PITCH_LITERAL (C, NATURAL, octave);
379 return PITCH_LITERAL (C, SHARP, octave);
382 return PITCH_LITERAL (D, NATURAL, octave);
385 return PITCH_LITERAL (D, SHARP, octave);
388 return PITCH_LITERAL (E, NATURAL, octave);
391 return PITCH_LITERAL (F, NATURAL, octave);
394 return PITCH_LITERAL (F, SHARP, octave);
397 return PITCH_LITERAL (G, NATURAL, octave);
400 return PITCH_LITERAL (G, SHARP, octave);
403 return PITCH_LITERAL (A, NATURAL, octave);
406 return PITCH_LITERAL (A, SHARP, octave);
409 return PITCH_LITERAL (B, NATURAL, octave);
414 /* Determine a chord name (if any) from the current notes pressed */
416 typedef struct analyzed_note {
417 /* Original note being analzyed. */
420 /* Absolute pitch (expressed as midi number). */
423 /* Pitch relative to bass note. */
428 _compare_analyzed_note_by_midi_pitch (const void *va, const void *vb)
430 const analyzed_note_t *a = va, *b = vb;
432 return a->midi_pitch - b->midi_pitch;
436 _compare_analyzed_note_by_relative_pitch (const void *va, const void *vb)
438 const analyzed_note_t *a = va, *b = vb;
440 return a->relative_pitch - b->relative_pitch;
443 typedef struct modified_degree
450 _modified_degree_to_half_steps (const modified_degree_t *degree)
453 int scale_degree = degree->degree;
455 /* Restrict to actual degrees within a scale. */
456 if (scale_degree > 7)
457 scale_degree = (scale_degree % 8) + 1;
459 /* Number of half steps from root to specified degree within a
461 switch (scale_degree) {
484 fprintf (stderr, "Internal: Invalid degree %d\n", degree->degree);
489 return half_steps + degree->modification;
492 /* Number of half steps from 'root' up to 'pitch' (that is, counting
493 * the steps up a chromatic scale), within the same octave. */
495 _pitch_from_root_in_half_steps (pitch_t pitch, pitch_t root)
497 int root_midi = _pitch_to_midi (root);
498 int pitch_midi = _pitch_to_midi (pitch);
500 while (pitch_midi < root_midi)
503 return (pitch_midi - root_midi) % 12;
507 _chord_signature_matches (analyzed_note_t *notes,
509 modified_degree_t *degrees,
514 #define MAX_DEGREES 6
515 int relative_pitches[MAX_DEGREES];
518 assert (num_degrees <= MAX_DEGREES);
520 if (num_notes != num_degrees)
523 if (inversion >= num_degrees)
526 /* We never spell simple intervals as inversions. */
527 if (num_degrees == 2 && inversion > 0)
530 for (i = 0; i < num_degrees; i++) {
531 /* The num_degrees is in the addition just to ensure all
532 * inputs to the modulus operator remain positive. */
533 int index = (i + num_degrees - inversion) % num_degrees;
535 /* Again, adding a 12 to keep things positive. */
536 relative_pitches[index] =
538 _modified_degree_to_half_steps (°rees[i]) -
539 _modified_degree_to_half_steps (°rees[inversion])) % 12;
543 for (i = 0; i < num_notes; i++)
544 if (notes[i].relative_pitch != relative_pitches[i])
547 root_index = (num_notes - inversion) % num_notes;
548 *root = notes[root_index].note->pitch;
554 _pitch_str (pitch_t pitch)
556 static char double_flat[] = "X𝄫";
557 static char flat[] = "X♭";
558 static char natural[] = "X";
559 static char sharp[] = "X♯";
560 static char double_sharp[] = "X𝄪";
563 switch (PITCH_ACCIDENTAL (pitch)) {
564 case PITCH_ACCIDENTAL_DOUBLE_FLAT:
567 case PITCH_ACCIDENTAL_FLAT:
570 case PITCH_ACCIDENTAL_NATURAL:
573 case PITCH_ACCIDENTAL_SHARP:
576 case PITCH_ACCIDENTAL_DOUBLE_SHARP:
581 switch (PITCH_NAME(pitch)) {
608 typedef struct chord_signature
611 modified_degree_t degrees[MAX_DEGREES];
615 /* XXX: The superscript rise value should be relative to the current
616 * font size. Best would be for pango to support this. See:
618 * https://bugzilla.gnome.org/show_bug.cgi?id=708780
620 * For now, these are emipirically-derived values that look reasonable
621 * at the default size that score.c is using to draw the staff. If the
622 * user scales the staff up or down then these will look wrong.
625 #define SUP "<span font='33' rise='30000'>"
626 #define PUS "</span>"
628 chord_signature_t signatures[] = {
630 { 1, {{1, 0}}, "P8" },
633 { 2, {{1, 0}, {2, -1}}, "m2" },
634 { 2, {{1, 0}, {2, 0}}, "M2" },
635 { 2, {{1, 0}, {3, -1}}, "m3" },
636 { 2, {{1, 0}, {3, 0}}, "M3" },
637 { 2, {{1, 0}, {4, 0}}, "P4" },
638 { 2, {{1, 0}, {5, -1}}, "Tri-tone" },
639 { 2, {{1, 0}, {5, 0}}, "P5" },
640 { 2, {{1, 0}, {6, -1}}, "m6" },
641 { 2, {{1, 0}, {6, 0}}, "M6" },
642 { 2, {{1, 0}, {7, -1}}, "m7" },
643 { 2, {{1, 0}, {7, 0}}, "M7" },
646 { 3, {{1, 0}, {4, 0}, {5, 0}}, "sus" },
647 { 3, {{1, 0}, {3, 0}, {5, +1}}, SUP "+" PUS },
648 { 3, {{1, 0}, {3, 0}, {5, 0}}, "" },
649 { 3, {{1, 0}, {3, -1}, {5, 0}}, "m" },
650 { 3, {{1, 0}, {3, -1}, {5, -1}}, "°" },
651 { 3, {{1, 0}, {2, 0}, {5, 0}}, "msus2" },
653 /* Seventh chords with no 3rd */
654 { 3, {{1, 0}, {5, +1}, {7, 0}}, SUP "+M7" PUS },
655 { 3, {{1, 0}, {5, +1}, {7, -1}}, SUP "+7" PUS },
656 { 3, {{1, 0}, {5, 0}, {7, 0}}, "M7" },
657 { 3, {{1, 0}, {5, 0}, {7, -1}}, "7" },
658 { 3, {{1, 0}, {5, -1}, {7, -1}}, "7♭5" },
660 /* Seventh chords with no 5th */
661 { 3, {{1, 0}, {4, 0}, {7, 0}}, "M7sus" },
662 { 3, {{1, 0}, {4, 0}, {7, -1}}, "7sus" },
663 { 3, {{1, 0}, {3, 0}, {7, 0}}, "M7" },
664 { 3, {{1, 0}, {3, 0}, {7, -1}}, "7" },
665 { 3, {{1, 0}, {3, -1}, {7, 0}}, "m" SUP "M7" PUS },
666 { 3, {{1, 0}, {3, -1}, {7, -1}}, "m7" },
667 { 3, {{1, 0}, {2, 0}, {7, 0}}, "m" SUP "M7" PUS "sus2" },
668 { 3, {{1, 0}, {2, 0}, {7, -1}}, "m7sus2" },
671 { 4, {{1, 0}, {4, 0}, {5, 0}, {6, 0}}, "6sus" },
672 { 4, {{1, 0}, {3, 0}, {5, 0}, {6, 0}}, "6" }, /* Ambiguous with m7 */
673 { 4, {{1, 0}, {3, -1}, {5, 0}, {6, 0}}, "m6" },
674 { 4, {{1, 0}, {2, 0}, {5, 0}, {6, 0}}, "m6sus2" },
677 { 4, {{1, 0}, {4, 0}, {5, +1}, {7, 0}}, SUP "+M7" PUS "sus" },
678 { 4, {{1, 0}, {4, 0}, {5, +1}, {7, -1}}, SUP "+7" PUS "sus" },
679 { 4, {{1, 0}, {4, 0}, {5, 0}, {7, 0}}, "M7sus" },
680 { 4, {{1, 0}, {4, 0}, {5, 0}, {7, -1}}, "7sus" },
681 { 4, {{1, 0}, {4, 0}, {5, -1}, {7, -1}}, "7♭5sus" },
682 { 4, {{1, 0}, {3, 0}, {5, +1}, {7, 0}}, SUP "+M7" PUS },
683 { 4, {{1, 0}, {3, 0}, {5, +1}, {7, -1}}, SUP "+7" PUS },
684 { 4, {{1, 0}, {3, 0}, {5, 0}, {7, 0}}, "M7" },
685 { 4, {{1, 0}, {3, 0}, {5, 0}, {7, -1}}, "7" },
686 { 4, {{1, 0}, {3, 0}, {5, -1}, {7, -1}}, "7♭5" },
687 { 4, {{1, 0}, {3, -1}, {5, 0}, {7, 0}}, "m" SUP "M7" PUS },
688 { 4, {{1, 0}, {3, -1}, {5, 0}, {7, -1}}, "m7" },
689 { 4, {{1, 0}, {3, -1}, {5, -1}, {7, 0}}, "°" SUP "M7" PUS },
690 { 4, {{1, 0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "7" PUS },
691 { 4, {{1, 0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "7" PUS },
692 { 4, {{1, 0}, {2, 0}, {5, 0}, {7, 0}}, "m" SUP "M7" PUS "sus2" },
693 { 4, {{1, 0}, {2, 0}, {5, 0}, {7, -1}}, "m7sus2" },
694 { 4, {{1, 0}, {2, 0}, {5, -1}, {7, 0}}, "°" SUP "M7" PUS "sus2" },
695 { 4, {{1, 0}, {2, 0}, {5, -1}, {7, -1}}, "𝆩" SUP "7" PUS "sus2" },
696 { 4, {{1, 0}, {2, 0}, {5, -1}, {7, -2}}, "°" SUP "7" PUS "sus2" }, /* Ambiguous with 7 */
698 /* The sorting for chords with degree higher than 9 is funny
699 * to keep the array in degree order after reducing each
700 * degree to an actual scale degree, (9 -> 2, 11 -> 4, 13 ->
703 /* Ninth chords voiced with no 5th */
704 { 4, {{1, 0}, {9, 0}, {4, 0}, {7, 0}}, "M9sus" },
705 { 4, {{1, 0}, {9, 0}, {4, 0}, {7, -1}}, "9sus" },
706 { 4, {{1, 0}, {9, 0}, {3, 0}, {7, 0}}, "M9" },
707 { 4, {{1, 0}, {9, 0}, {3, 0}, {7, -1}}, "9" },
708 { 4, {{1, 0}, {9, 0}, {3, -1}, {7, 0}}, "m" SUP "M9" PUS },
709 { 4, {{1, 0}, {9, 0}, {3, -1}, {7, -1}}, "m9" },
710 { 4, {{1, 0}, {9, -1}, {3, -1}, {7, -1}}, "m♭9" },
711 { 4, {{1, 0}, {9, 0}, {3, -1}, {6, 0}}, "m6/9" },
712 { 4, {{1, 0}, {9, -1}, {3, -1}, {6, 0}}, "m6/♭9" },
715 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, 0}, {6, 0}}, "6/9" },
716 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, 0}, {6, 0}}, "m6/9" },
717 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, 0}, {6, 0}}, "m6/♭9" },
719 /* Seventh plus altered 9 */
720 { 5, {{1, 0}, {9, +1}, {3, 0}, {5, 0}, {7, -1}}, "7♯9" },
721 { 5, {{1, 0}, {9, -1}, {3, 0}, {5, 0}, {7, -1}}, "7♭9" },
722 { 5, {{1, 0}, {9, +1}, {3, 0}, {5, -1}, {7, -1}}, "7♭5♯9" },
723 { 5, {{1, 0}, {9, -1}, {3, 0}, {5, -1}, {7, -1}}, "7♭5♭9" },
726 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, +1}, {7, 0}}, SUP "+M9" PUS "sus" },
727 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, +1}, {7, -1}}, SUP "+9" PUS "sus" },
728 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, 0}, {7, 0}}, "M9sus" },
729 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, 0}, {7, -1}}, "9sus" },
730 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, +1}, {7, 0}}, SUP "+M9" PUS },
731 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, +1}, {7, -1}}, SUP "+9" PUS },
732 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, 0}, {7, 0}}, "M9" },
733 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, 0}, {7, -1}}, "9" },
734 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, 0}, {7, 0}}, "m" SUP "M9" PUS },
735 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, 0}, {7, -1}}, "m9" },
736 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, 0}, {7, -1}}, "m♭9" },
737 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, -1}, {7, 0}}, "M9" SUP "♭5" PUS },
738 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, -1}, {7, -1}}, "9" SUP "♭5" PUS },
739 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, -1}, {7, 0}}, "m" SUP "M9♭5" PUS },
740 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "9" PUS },
741 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "♭9" PUS },
742 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "9" PUS },
743 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "♭9" PUS },
745 /* Eleventh chords */
746 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, +1}, {7, 0}}, SUP "+M11" PUS },
747 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, +1}, {7, -1}}, SUP "+11" PUS },
748 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, 0}, {7, 0}}, "M11" },
749 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, 0}, {7, -1}}, "11" },
750 { 6, {{1, 0}, {9, 0}, {3, -1}, {11, 0}, {5, 0}, {7, 0}}, "m" SUP "M11" PUS },
751 { 6, {{1, 0}, {9, 0}, {3, -1}, {11, 0}, {5, 0}, {7, -1}}, "m11" },
752 { 6, {{1, 0}, {9, -1}, {3, -1}, {11, 0}, {5, -1}, {7, -1}}, "𝆩" SUP "11" PUS },
753 { 6, {{1, 0}, {9, -1}, {3, -1}, {11, -1}, {5, -1}, {7, -2}}, "°" SUP "11" PUS }
757 scherzo_adjust_note_to_match_modified_degree (score_note_t *note,
759 modified_degree_t *degree)
761 pitch_name_t name = PITCH_NAME (note->pitch);
762 pitch_accidental_t accidental = PITCH_ACCIDENTAL (note->pitch);
763 int octave = PITCH_OCTAVE (note->pitch);
764 int degree_zero_based = (degree->degree - 1) % 7;
767 int note_degree_zero_based = name - PITCH_NAME (root);
768 if (note_degree_zero_based < 0)
769 note_degree_zero_based += 7;
771 if (note_degree_zero_based == degree_zero_based)
774 degree_delta = note_degree_zero_based - degree_zero_based;
775 if (degree_delta > 3)
776 degree_delta = - (7 - degree_delta);
777 if (degree_delta < -3)
778 degree_delta = - (-7 - degree_delta);
780 if (abs (degree_delta) != 1) {
781 fprintf (stderr, "Internal error: Cannot adjust a note more than one degree (%d vs. %d).\n", note_degree_zero_based + 1, degree->degree);
785 if (degree_delta == -1) {
786 if (name == PITCH_NAME_B) {
807 if (degree_delta == +1) {
808 if (name == PITCH_NAME_C) {
828 if (accidental < 0 || accidental > PITCH_ACCIDENTAL_DOUBLE_SHARP) {
829 fprintf (stderr, "Internal error: Trying to adjust an accidental out of range (degree_delta == %d (%d - %d), new accidental == %d).\n", degree_delta, note_degree_zero_based, degree_zero_based, accidental);
833 note->pitch = PITCH (name, accidental, octave);
837 _spell_chord_by_signature (note_group_t *chord,
839 chord_signature_t *signature,
842 int i, degree, note_half_steps, degree_half_steps;
845 /* Sanitize root to eliminate things like double-flats,
846 * double-sharps, Cb, E#, etc. */
847 root_midi = _pitch_to_midi (root);
848 root = _midi_to_pitch (root_midi);
850 for (i = 0; i < num_notes; i++) {
851 note_half_steps = _pitch_from_root_in_half_steps (chord->notes[i]->pitch,
853 for (degree = 0; degree < signature->num_degrees; degree++) {
854 degree_half_steps = _modified_degree_to_half_steps (&signature->degrees[degree]);
855 if (note_half_steps == degree_half_steps) {
856 scherzo_adjust_note_to_match_modified_degree (chord->notes[i],
858 &signature->degrees[degree]);
862 if (note_half_steps != degree_half_steps) {
863 fprintf (stderr, "Internal error: Chord and degree mis-match\n");
870 scherzo_analyze_chord (scherzo_t *scherzo)
872 void *local = talloc_new (NULL);
873 analyzed_note_t *notes;
874 note_group_t *note_group;
875 unsigned i, j, num_notes;
876 int bass_pitch, inversion;
878 chord_signature_t *match = NULL;
881 if (scherzo->pedal_pressed)
882 note_group = &scherzo->notes_pedaled;
884 note_group = &scherzo->notes_pressed;
886 num_notes = note_group->num_notes;
888 if (scherzo->chord) {
889 score_remove_chord (scherzo->chord);
890 scherzo->chord = NULL;
896 notes = talloc_array (local, analyzed_note_t, num_notes);
900 for (i = 0; i < num_notes; i++) {
901 score_note_t *note = note_group->notes[i];
902 notes[i].note = note;
903 notes[i].midi_pitch = _pitch_to_midi (note->pitch);
904 /* Relative pitch will be filled in after sorting. */
905 notes[i].relative_pitch = 0;
908 /* First, sort by midi pitch to find the bass note. */
909 qsort (notes, num_notes, sizeof (analyzed_note_t),
910 _compare_analyzed_note_by_midi_pitch);
912 bass_pitch = notes[0].midi_pitch;
914 /* With the bass note identified, we can find all relative pitches. */
915 for (i = 0; i < num_notes; i++) {
916 notes[i].relative_pitch = notes[i].midi_pitch - bass_pitch;
917 while (notes[i].relative_pitch >= 12)
918 notes[i].relative_pitch -= 12;
921 /* Now, sort again by relative pitch. */
922 qsort (notes, num_notes, sizeof (analyzed_note_t),
923 _compare_analyzed_note_by_relative_pitch);
925 /* Finally, eliminate all duplicate notes. */
926 for (i = 0; i < num_notes - 1; i++) {
927 if (notes[i+1].relative_pitch == notes[i].relative_pitch) {
929 while (j < num_notes &&
930 notes[j].relative_pitch == notes[i].relative_pitch)
934 /* The loop incremented j one past the last
935 * duplicate. Decrement so that it points to the
936 * last duplicate (and is guaranteed to not exceed
937 * the array bounds).*/
940 if (j < num_notes - 1) {
941 memmove (¬es[i+1], ¬es[j+1],
942 (num_notes - j) * sizeof (analyzed_note_t));
945 num_notes -= (j - i);
949 for (inversion = 0; inversion < 4; inversion++) {
950 for (i = 0; i < ARRAY_SIZE (signatures); i++) {
951 if (_chord_signature_matches (notes, num_notes,
952 signatures[i].degrees,
953 signatures[i].num_degrees,
956 match = &signatures[i];
963 chord_name = (char *) signatures[i].name;
966 /* Don't print root pitch for octaves and inversions,
967 * (since a pitch name alone looks like a major triad) */
969 chord_name = talloc_strdup (local, chord_name);
971 chord_name = talloc_asprintf (local, "%s%s",
976 _spell_chord_by_signature (note_group, num_notes,
979 chord_name = talloc_strdup (local, "?");
982 scherzo->chord = score_add_chord (scherzo->treble, chord_name);
989 note_group_init (void *ctx, note_group_t *group)
994 group->num_notes = 0;
998 note_group_add_note (note_group_t *group, score_note_t *note)
1002 /* Do nothing if note is already in group. */
1003 for (i = 0; i < group->num_notes; i++)
1004 if (group->notes[i]->pitch == note->pitch)
1009 if (group->num_notes > group->size) {
1011 group->notes = talloc_realloc (group->ctx, group->notes,
1012 score_note_t*, group->size);
1014 if (group->notes == NULL) {
1015 fprintf (stderr, "Out of memory.\n");
1020 group->notes[group->num_notes - 1] = note;
1024 note_group_remove_note_at (note_group_t *group, int i)
1026 if (i >= group->num_notes) {
1027 fprintf (stderr, "Internal error: No note to remove at index %d\n", i);
1031 if (i < group->num_notes - 1) {
1032 memmove (group->notes + i, group->notes + i + 1,
1033 (group->num_notes - 1 - i) * sizeof (score_note_t*));
1038 static score_note_t *
1039 scherzo_press_note (scherzo_t *scherzo, pitch_t pitch)
1041 score_staff_t *staff;
1045 if (scherzo->challenge.note) {
1046 staff = scherzo->challenge.staff;
1047 } else if (PITCH_OCTAVE (pitch) >= 4) {
1048 staff = scherzo->treble;
1050 staff = scherzo->bass;
1053 /* Do nothing if this note is already pressed. */
1054 for (i = 0; i < scherzo->notes_pressed.num_notes; i++)
1055 if (scherzo->notes_pressed.notes[i]->pitch == pitch)
1056 return scherzo->notes_pressed.notes[i];
1058 note = score_add_note (staff, pitch, SCORE_DURATION_WHOLE);
1060 note_group_add_note (&scherzo->notes_pressed, note);
1062 if (scherzo->pedal_pressed)
1063 note_group_add_note (&scherzo->notes_pedaled, note);
1065 scherzo_analyze_chord (scherzo);
1071 scherzo_release_note (scherzo_t *scherzo, pitch_t pitch)
1076 int target_midi = _pitch_to_midi (pitch);
1079 for (i = scherzo->notes_pressed.num_notes - 1; i >=0; i--) {
1080 note = scherzo->notes_pressed.notes[i];
1081 note_midi = _pitch_to_midi (note->pitch);
1082 if (note_midi == target_midi) {
1084 if (! scherzo->pedal_pressed)
1085 score_remove_note (note);
1086 note_group_remove_note_at (&scherzo->notes_pressed, i);
1091 fprintf (stderr, "Internal error: Failed to find note to release.\n");
1094 scherzo_analyze_chord (scherzo);
1097 static score_note_t *
1098 scherzo_press_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1100 return scherzo_press_note (scherzo, _midi_to_pitch (midi_note));
1104 scherzo_release_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1106 scherzo_release_note (scherzo, _midi_to_pitch (midi_note));
1110 scherzo_press_pedal (scherzo_t *scherzo)
1114 scherzo->pedal_pressed = 1;
1116 /* Copy all pressed notes to pedaled notes */
1117 for (i = 0; i < scherzo->notes_pressed.num_notes; i++)
1118 note_group_add_note (&scherzo->notes_pedaled, scherzo->notes_pressed.notes[i]);
1122 scherzo_release_pedal (scherzo_t *scherzo)
1124 score_note_t *note, *new_note;
1127 /* Make new notes in score for all pressed notes. */
1128 for (i = 0; i < scherzo->notes_pressed.num_notes; i++) {
1129 note = scherzo->notes_pressed.notes[i];
1130 new_note = score_add_note (note->staff, note->pitch, note->duration);
1131 scherzo->notes_pressed.notes[i] = new_note;
1134 /* Then remove all previously pedaled notes from the score. */
1135 for (i = scherzo->notes_pedaled.num_notes - 1; i >=0; i--) {
1136 note = scherzo->notes_pedaled.notes[i];
1137 score_remove_note (note);
1138 note_group_remove_note_at (&scherzo->notes_pedaled, i);
1141 scherzo->pedal_pressed = 0;
1143 scherzo_analyze_chord (scherzo);
1145 gtk_widget_queue_draw (scherzo->window);
1149 _select_challenge (scherzo_t *scherzo)
1151 category_t *category_unused;
1152 bool_t introduced_unused;
1154 challenge_t *challenge = &scherzo->challenge;
1155 pitch_name_t pitch_name;
1160 if (challenge->note) {
1161 score_remove_note (challenge->note);
1162 challenge->note = NULL;
1165 mnemon_select_item (&scherzo->mnemon,
1167 &challenge->item_index,
1169 &introduced_unused);
1171 item = challenge->bin->items[challenge->item_index];
1173 s = item->challenge;
1174 if (strncmp (s, "treble:", 7) == 0) {
1176 challenge->staff = scherzo->treble;
1177 } else if (strncmp (s, "bass:", 5) == 0) {
1179 challenge->staff = scherzo->bass;
1182 "Malformed staff name: %s (expected 'treble:' or 'bass:')\n",
1189 pitch_name = PITCH_NAME_C;
1192 pitch_name = PITCH_NAME_D;
1195 pitch_name = PITCH_NAME_E;
1198 pitch_name = PITCH_NAME_F;
1201 pitch_name = PITCH_NAME_G;
1204 pitch_name = PITCH_NAME_A;
1207 pitch_name = PITCH_NAME_B;
1210 fprintf (stderr, "Malformed pitch name: %s (expected 'A' - 'G')\n", s);
1215 if (*s < '0' || *s > '9') {
1216 fprintf (stderr, "Malformed octave number: %s (expected '0' - '9')\n", s);
1222 pitch = PITCH (pitch_name, PITCH_ACCIDENTAL_NATURAL, octave);
1224 challenge->note = score_add_note (challenge->staff, pitch,
1225 SCORE_DURATION_WHOLE);
1226 challenge->satisfied = 0;
1227 challenge->mistaken = 0;
1230 /* Determine whether the user hit the correct note. */
1232 _judge_note (scherzo_t *scherzo, score_note_t *note)
1234 challenge_t *challenge = &scherzo->challenge;
1236 if (! scherzo->challenge.note) {
1237 score_set_note_color_rgb (note, 0.0, 0.0, 0.0); /* black */
1241 if (note->pitch == challenge->note->pitch)
1243 challenge->satisfied = 1;
1244 score_set_note_color_rgb (note, 18/256., 130/256., 28/256.); /* green */
1248 challenge->mistaken = 1;
1249 score_set_note_color_rgb (note, 184/256., 4/256., 22/256.); /* red */
1253 /* If the user got the right note (eventually), then score it in
1254 * mnemon and show the next note. */
1256 _score_challenge (scherzo_t *scherzo)
1258 challenge_t *challenge = &scherzo->challenge;
1260 if (! challenge->note)
1263 if (! challenge->satisfied)
1266 mnemon_score_item (&scherzo->mnemon, challenge->bin, challenge->item_index,
1267 ! challenge->mistaken);
1269 _select_challenge (scherzo);
1273 on_midi_input (unused (GIOChannel *channel),
1274 unused (GIOCondition condition),
1277 unsigned char buf[MIDI_BUF_SIZE], *next;
1278 scherzo_t *scherzo = user_data;
1280 snd_seq_event_t event;
1282 int need_redraw = FALSE;
1284 remaining = read (scherzo->midi_fd, buf, MIDI_BUF_SIZE);
1290 consumed = snd_midi_event_encode (scherzo->snd_midi_event,
1291 next, remaining, &event);
1293 remaining -= consumed;
1296 switch (event.type) {
1297 case SND_SEQ_EVENT_NONE:
1298 /* Incomplete event. Nothing to do. */
1300 case SND_SEQ_EVENT_NOTEON:
1301 note = scherzo_press_note_midi (scherzo, event.data.note.note);
1302 _judge_note (scherzo, note);
1305 case SND_SEQ_EVENT_NOTEOFF:
1306 scherzo_release_note_midi (scherzo, event.data.note.note);
1307 _score_challenge (scherzo);
1310 case SND_SEQ_EVENT_CLOCK:
1311 /* Ignore for now as my piano sends a constant stream of these. */
1313 case SND_SEQ_EVENT_SENSING:
1314 /* Ignore for now as my piano sends a constant stream of these. */
1316 case SND_SEQ_EVENT_CONTROLLER:
1317 /* XXX: My piano gives me 64 for the sustain pedal, is
1318 * that universal? */
1319 if (event.data.control.param == 64) {
1320 if (event.data.control.value == 0)
1321 scherzo_release_pedal (scherzo);
1323 scherzo_press_pedal (scherzo);
1325 fprintf (stderr, "Fixme: Unhandled MIDI Control event (param=%d, value=%d)\n",
1326 event.data.control.param, event.data.control.value);
1330 fprintf (stderr, "Fixme: Do not yet know how to handle MIDI event %d\n",
1337 gtk_widget_queue_draw (scherzo->window);
1339 /* Return TRUE to continue to get called in the future. */
1344 main (int argc, char *argv[])
1346 GtkWidget *drawing_area;
1350 srand (time (NULL));
1352 gtk_init (&argc, &argv);
1354 scherzo.ctx = talloc_new (NULL);
1356 scherzo.score = score_create (scherzo.ctx);
1357 scherzo.staff_height = 100;
1358 score_set_staff_height (scherzo.score, scherzo.staff_height);
1360 score_add_brace (scherzo.score, 2);
1361 scherzo.treble = score_add_staff (scherzo.score, SCORE_CLEF_G);
1362 scherzo.bass = score_add_staff (scherzo.score, SCORE_CLEF_F);
1364 scherzo.chord = NULL;
1366 /* Default to octave 4 and natural for computer keyboard keypresses. */
1367 scherzo.keyboard_octave = 4;
1368 scherzo.keyboard_accidental = PITCH_ACCIDENTAL_NATURAL;
1370 note_group_init (scherzo.ctx, &scherzo.notes_pressed);
1371 note_group_init (scherzo.ctx, &scherzo.notes_pedaled);
1373 scherzo.pedal_pressed = 0;
1375 mnemon_init (&scherzo.mnemon);
1376 /* XXX: Should create a default file if one cannot be loaded. */
1377 mnemon_load_category (&scherzo.mnemon, "scherzo-notes");
1379 scherzo.challenge.note = NULL;
1381 _select_challenge (&scherzo);
1384 err = snd_midi_event_new (MIDI_BUF_SIZE, &scherzo.snd_midi_event);
1386 fprintf (stderr, "Out of memory.\n");
1390 #define MIDI_DEVICE "/dev/midi1"
1391 scherzo.midi_fd = open (MIDI_DEVICE, O_RDONLY);
1392 if (scherzo.midi_fd < 0) {
1393 printf ("failed to open " MIDI_DEVICE ". Midi input will not be available.\n");
1395 GIOChannel *channel;
1397 channel = g_io_channel_unix_new (scherzo.midi_fd);
1398 g_io_channel_set_encoding (channel, NULL, NULL);
1399 g_io_add_watch (channel, G_IO_IN, on_midi_input, &scherzo);
1402 scherzo.window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1404 gtk_window_set_default_size (GTK_WINDOW (scherzo.window), 1000, 600);
1406 g_signal_connect (scherzo.window, "delete-event",
1407 G_CALLBACK (on_delete_event_quit), NULL);
1409 drawing_area = gtk_drawing_area_new ();
1411 gtk_container_add (GTK_CONTAINER (scherzo.window), drawing_area);
1413 g_signal_connect (drawing_area, "expose-event",
1414 G_CALLBACK (on_expose_event_draw),
1417 g_signal_connect (scherzo.window, "key-press-event",
1418 G_CALLBACK (on_key_press_event),
1421 g_signal_connect (scherzo.window, "key-release-event",
1422 G_CALLBACK (on_key_release_event),
1425 gtk_widget_show_all (scherzo.window);
1429 mnemon_save (&scherzo.mnemon);
1431 snd_midi_event_free (scherzo.snd_midi_event);
1433 talloc_free (scherzo.ctx);