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) ((int) (sizeof(arr) / sizeof(arr[0])))
29 #define unused(foo) foo __attribute__((unused))
31 #define MIDI_BUF_SIZE 4096
33 typedef struct challenge
45 typedef struct pitch_group
53 typedef struct scherzo
61 score_staff_t *treble;
65 /* The word "keyboard" here is referring to a "computer
66 * keyboard". Any "piano keyboard" key knows its own octave and
67 * accidental already. */
69 pitch_accidental_t keyboard_accidental;
72 snd_midi_event_t *snd_midi_event;
75 challenge_t challenge;
77 pitch_group_t notes_pressed;
78 pitch_group_t notes_pedaled;
83 /* Forward declarations. */
85 scherzo_press_note (scherzo_t *scherzo, pitch_t pitch);
88 scherzo_release_note (scherzo_t *scherzo, pitch_t pitch);
91 scherzo_press_pedal (scherzo_t *scherzo);
94 scherzo_release_pedal (scherzo_t *scherzo);
97 _judge_pitch (scherzo_t *scherzo, pitch_t pitch);
100 _score_challenge (scherzo_t *scherzo);
103 on_delete_event_quit (unused (GtkWidget *widget),
104 unused (GdkEvent *event),
105 unused (gpointer user_data))
109 /* Returning FALSE allows the default handler for delete-event
110 * to proceed to cleanup the widget. */
115 on_expose_event_draw (GtkWidget *widget,
116 unused (GdkEventExpose *expose),
119 scherzo_t *scherzo = user_data;
120 score_t *score = scherzo->score;
122 GtkAllocation allocation;
123 static const int pad = 10;
126 gtk_widget_get_allocation (widget, &allocation);
127 widget_width = allocation.width;
129 cr = gdk_cairo_create (widget->window);
131 /* White background */
132 cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
135 /* Add some padding on the sides and top */
136 cairo_translate (cr, pad, scherzo->staff_height);
137 score_set_staff_height (score, scherzo->staff_height);
138 score_set_width (score, widget_width - 2 * pad);
140 score_draw (score, cr);
146 on_key_press_event (GtkWidget *widget,
150 scherzo_t *scherzo = user_data;
152 /* Initialize to keep the compiler quiet. */
153 pitch_name_t pitch_name = PITCH_NATURAL (C, 0);
156 if (scherzo->challenge.active)
157 octave = PITCH_OCTAVE (scherzo->challenge.pitch);
159 octave = scherzo->keyboard_octave;
161 switch (key->keyval) {
165 case GDK_KEY_KP_Equal:
166 scherzo->staff_height += 4;
167 gtk_widget_queue_draw (widget);
171 case GDK_KEY_KP_Subtract:
172 scherzo->staff_height -= 4;
173 gtk_widget_queue_draw (widget);
183 pitch_name = PITCH_NAME_C;
187 pitch_name = PITCH_NAME_D;
191 pitch_name = PITCH_NAME_E;
195 pitch_name = PITCH_NAME_F;
199 pitch_name = PITCH_NAME_G;
203 pitch_name = PITCH_NAME_A;
207 pitch_name = PITCH_NAME_B;
218 scherzo->keyboard_octave = key->keyval - GDK_KEY_0;
221 scherzo_press_pedal (scherzo);
224 if (scherzo->keyboard_accidental < PITCH_ACCIDENTAL_DOUBLE_SHARP)
225 scherzo->keyboard_accidental++;
228 if (scherzo->keyboard_accidental > PITCH_ACCIDENTAL_DOUBLE_FLAT)
229 scherzo->keyboard_accidental--;
233 pitch = PITCH (pitch_name, scherzo->keyboard_accidental, octave);
235 if ((key->keyval >= GDK_KEY_A && key->keyval <= GDK_KEY_G) ||
236 (key->keyval >= GDK_KEY_a && key->keyval <= GDK_KEY_g))
238 scherzo_press_note (scherzo, pitch);
239 _judge_pitch (scherzo, pitch);
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.active)
262 octave = PITCH_OCTAVE (scherzo->challenge.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 /* Return true if 'a' and 'b' sound identical, (even if spelled differently)
416 * This comparison considers octaves as significant. So Bb and A# in
417 * the same octave are considered enharmonic, but Bb and A# in
418 * different octaves are not. */
420 _pitches_are_enharmonic (pitch_t a, pitch_t b)
422 return _pitch_to_midi (a) == _pitch_to_midi (b);
425 /* Determine a chord name (if any) from the current notes pressed */
427 typedef struct analyzed_pitch {
428 /* Original note being analzyed. */
431 /* Absolute pitch (expressed as midi number). */
434 /* Pitch relative to bass note. */
439 _compare_analyzed_pitch_by_midi_pitch (const void *va, const void *vb)
441 const analyzed_pitch_t *a = va, *b = vb;
443 return a->midi_pitch - b->midi_pitch;
447 _compare_analyzed_pitch_by_relative_pitch (const void *va, const void *vb)
449 const analyzed_pitch_t *a = va, *b = vb;
451 return a->relative_pitch - b->relative_pitch;
454 typedef struct modified_degree
461 _modified_degree_to_half_steps (const modified_degree_t *degree)
464 int scale_degree = degree->degree;
466 /* Restrict to actual degrees within a scale. */
467 if (scale_degree > 7)
468 scale_degree = (scale_degree % 8) + 1;
470 /* Number of half steps from root to specified degree within a
472 switch (scale_degree) {
495 fprintf (stderr, "Internal: Invalid degree %d\n", degree->degree);
500 return half_steps + degree->modification;
503 /* Number of half steps from 'root' up to 'pitch' (that is, counting
504 * the steps up a chromatic scale), within the same octave. */
506 _pitch_from_root_in_half_steps (pitch_t pitch, pitch_t root)
508 int root_midi = _pitch_to_midi (root);
509 int pitch_midi = _pitch_to_midi (pitch);
511 while (pitch_midi < root_midi)
514 return (pitch_midi - root_midi) % 12;
518 _chord_signature_matches (analyzed_pitch_t *pitches,
520 modified_degree_t *degrees,
525 #define MAX_DEGREES 6
526 int relative_pitches[MAX_DEGREES];
529 assert (num_degrees <= MAX_DEGREES);
531 if (num_pitches != num_degrees)
534 if (inversion >= num_degrees)
537 /* We never spell simple intervals as inversions. */
538 if (num_degrees == 2 && inversion > 0)
541 for (i = 0; i < num_degrees; i++) {
542 /* The num_degrees is in the addition just to ensure all
543 * inputs to the modulus operator remain positive. */
544 int index = (i + num_degrees - inversion) % num_degrees;
546 /* Again, adding a 12 to keep things positive. */
547 relative_pitches[index] =
549 _modified_degree_to_half_steps (°rees[i]) -
550 _modified_degree_to_half_steps (°rees[inversion])) % 12;
554 for (i = 0; i < num_pitches; i++)
555 if (pitches[i].relative_pitch != relative_pitches[i])
558 root_index = (num_pitches - inversion) % num_pitches;
559 *root = pitches[root_index].pitch;
565 _pitch_str (pitch_t pitch)
567 static char double_flat[] = "X𝄫";
568 static char flat[] = "X♭";
569 static char natural[] = "X";
570 static char sharp[] = "X♯";
571 static char double_sharp[] = "X𝄪";
574 switch (PITCH_ACCIDENTAL (pitch)) {
575 case PITCH_ACCIDENTAL_DOUBLE_FLAT:
578 case PITCH_ACCIDENTAL_FLAT:
581 case PITCH_ACCIDENTAL_NATURAL:
584 case PITCH_ACCIDENTAL_SHARP:
587 case PITCH_ACCIDENTAL_DOUBLE_SHARP:
592 switch (PITCH_NAME(pitch)) {
619 typedef struct chord_signature
622 modified_degree_t degrees[MAX_DEGREES];
626 /* XXX: The superscript rise value should be relative to the current
627 * font size. Best would be for pango to support this. See:
629 * https://bugzilla.gnome.org/show_bug.cgi?id=708780
631 * For now, these are emipirically-derived values that look reasonable
632 * at the default size that score.c is using to draw the staff. If the
633 * user scales the staff up or down then these will look wrong.
636 #define SUP "<span font='33' rise='30000'>"
637 #define PUS "</span>"
639 chord_signature_t signatures[] = {
641 { 1, {{1, 0}}, "P8" },
644 { 2, {{1, 0}, {2, -1}}, "m2" },
645 { 2, {{1, 0}, {2, 0}}, "M2" },
646 { 2, {{1, 0}, {3, -1}}, "m3" },
647 { 2, {{1, 0}, {3, 0}}, "M3" },
648 { 2, {{1, 0}, {4, 0}}, "P4" },
649 { 2, {{1, 0}, {5, -1}}, "Tri-tone" },
650 { 2, {{1, 0}, {5, 0}}, "P5" },
651 { 2, {{1, 0}, {6, -1}}, "m6" },
652 { 2, {{1, 0}, {6, 0}}, "M6" },
653 { 2, {{1, 0}, {7, -1}}, "m7" },
654 { 2, {{1, 0}, {7, 0}}, "M7" },
657 { 3, {{1, 0}, {4, 0}, {5, 0}}, "sus" },
658 { 3, {{1, 0}, {3, 0}, {5, +1}}, SUP "+" PUS },
659 { 3, {{1, 0}, {3, 0}, {5, 0}}, "" },
660 { 3, {{1, 0}, {3, -1}, {5, 0}}, "m" },
661 { 3, {{1, 0}, {3, -1}, {5, -1}}, "°" },
662 { 3, {{1, 0}, {2, 0}, {5, 0}}, "msus2" },
664 /* Seventh chords with no 3rd */
665 { 3, {{1, 0}, {5, +1}, {7, 0}}, SUP "+M7" PUS },
666 { 3, {{1, 0}, {5, +1}, {7, -1}}, SUP "+7" PUS },
667 { 3, {{1, 0}, {5, 0}, {7, 0}}, "M7" },
668 { 3, {{1, 0}, {5, 0}, {7, -1}}, "7" },
669 { 3, {{1, 0}, {5, -1}, {7, -1}}, "7♭5" },
671 /* Seventh chords with no 5th */
672 { 3, {{1, 0}, {4, 0}, {7, 0}}, "M7sus" },
673 { 3, {{1, 0}, {4, 0}, {7, -1}}, "7sus" },
674 { 3, {{1, 0}, {3, 0}, {7, 0}}, "M7" },
675 { 3, {{1, 0}, {3, 0}, {7, -1}}, "7" },
676 { 3, {{1, 0}, {3, -1}, {7, 0}}, "m" SUP "M7" PUS },
677 { 3, {{1, 0}, {3, -1}, {7, -1}}, "m7" },
678 { 3, {{1, 0}, {2, 0}, {7, 0}}, "m" SUP "M7" PUS "sus2" },
679 { 3, {{1, 0}, {2, 0}, {7, -1}}, "m7sus2" },
682 { 4, {{1, 0}, {4, 0}, {5, 0}, {6, 0}}, "6sus" },
683 { 4, {{1, 0}, {3, 0}, {5, 0}, {6, 0}}, "6" }, /* Ambiguous with m7 */
684 { 4, {{1, 0}, {3, -1}, {5, 0}, {6, 0}}, "m6" },
685 { 4, {{1, 0}, {2, 0}, {5, 0}, {6, 0}}, "m6sus2" },
688 { 4, {{1, 0}, {4, 0}, {5, +1}, {7, 0}}, SUP "+M7" PUS "sus" },
689 { 4, {{1, 0}, {4, 0}, {5, +1}, {7, -1}}, SUP "+7" PUS "sus" },
690 { 4, {{1, 0}, {4, 0}, {5, 0}, {7, 0}}, "M7sus" },
691 { 4, {{1, 0}, {4, 0}, {5, 0}, {7, -1}}, "7sus" },
692 { 4, {{1, 0}, {4, 0}, {5, -1}, {7, -1}}, "7♭5sus" },
693 { 4, {{1, 0}, {3, 0}, {5, +1}, {7, 0}}, SUP "+M7" PUS },
694 { 4, {{1, 0}, {3, 0}, {5, +1}, {7, -1}}, SUP "+7" PUS },
695 { 4, {{1, 0}, {3, 0}, {5, 0}, {7, 0}}, "M7" },
696 { 4, {{1, 0}, {3, 0}, {5, 0}, {7, -1}}, "7" },
697 { 4, {{1, 0}, {3, 0}, {5, -1}, {7, -1}}, "7♭5" },
698 { 4, {{1, 0}, {3, -1}, {5, 0}, {7, 0}}, "m" SUP "M7" PUS },
699 { 4, {{1, 0}, {3, -1}, {5, 0}, {7, -1}}, "m7" },
700 { 4, {{1, 0}, {3, -1}, {5, -1}, {7, 0}}, "°" SUP "M7" PUS },
701 { 4, {{1, 0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "7" PUS },
702 { 4, {{1, 0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "7" PUS },
703 { 4, {{1, 0}, {2, 0}, {5, 0}, {7, 0}}, "m" SUP "M7" PUS "sus2" },
704 { 4, {{1, 0}, {2, 0}, {5, 0}, {7, -1}}, "m7sus2" },
705 { 4, {{1, 0}, {2, 0}, {5, -1}, {7, 0}}, "°" SUP "M7" PUS "sus2" },
706 { 4, {{1, 0}, {2, 0}, {5, -1}, {7, -1}}, "𝆩" SUP "7" PUS "sus2" },
707 { 4, {{1, 0}, {2, 0}, {5, -1}, {7, -2}}, "°" SUP "7" PUS "sus2" }, /* Ambiguous with 7 */
709 /* The sorting for chords with degree higher than 9 is funny
710 * to keep the array in degree order after reducing each
711 * degree to an actual scale degree, (9 -> 2, 11 -> 4, 13 ->
714 /* Ninth chords voiced with no 5th */
715 { 4, {{1, 0}, {9, 0}, {4, 0}, {7, 0}}, "M9sus" },
716 { 4, {{1, 0}, {9, 0}, {4, 0}, {7, -1}}, "9sus" },
717 { 4, {{1, 0}, {9, 0}, {3, 0}, {7, 0}}, "M9" },
718 { 4, {{1, 0}, {9, 0}, {3, 0}, {7, -1}}, "9" },
719 { 4, {{1, 0}, {9, 0}, {3, -1}, {7, 0}}, "m" SUP "M9" PUS },
720 { 4, {{1, 0}, {9, 0}, {3, -1}, {7, -1}}, "m9" },
721 { 4, {{1, 0}, {9, -1}, {3, -1}, {7, -1}}, "m♭9" },
722 { 4, {{1, 0}, {9, 0}, {3, -1}, {6, 0}}, "m6/9" },
723 { 4, {{1, 0}, {9, -1}, {3, -1}, {6, 0}}, "m6/♭9" },
726 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, 0}, {6, 0}}, "6/9" },
727 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, 0}, {6, 0}}, "m6/9" },
728 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, 0}, {6, 0}}, "m6/♭9" },
730 /* Seventh plus altered 9 */
731 { 5, {{1, 0}, {9, +1}, {3, 0}, {5, 0}, {7, -1}}, "7♯9" },
732 { 5, {{1, 0}, {9, -1}, {3, 0}, {5, 0}, {7, -1}}, "7♭9" },
733 { 5, {{1, 0}, {9, +1}, {3, 0}, {5, -1}, {7, -1}}, "7♭5♯9" },
734 { 5, {{1, 0}, {9, -1}, {3, 0}, {5, -1}, {7, -1}}, "7♭5♭9" },
737 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, +1}, {7, 0}}, SUP "+M9" PUS "sus" },
738 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, +1}, {7, -1}}, SUP "+9" PUS "sus" },
739 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, 0}, {7, 0}}, "M9sus" },
740 { 5, {{1, 0}, {9, 0}, {4, 0}, {5, 0}, {7, -1}}, "9sus" },
741 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, +1}, {7, 0}}, SUP "+M9" PUS },
742 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, +1}, {7, -1}}, SUP "+9" PUS },
743 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, 0}, {7, 0}}, "M9" },
744 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, 0}, {7, -1}}, "9" },
745 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, 0}, {7, 0}}, "m" SUP "M9" PUS },
746 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, 0}, {7, -1}}, "m9" },
747 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, 0}, {7, -1}}, "m♭9" },
748 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, -1}, {7, 0}}, "M9" SUP "♭5" PUS },
749 { 5, {{1, 0}, {9, 0}, {3, 0}, {5, -1}, {7, -1}}, "9" SUP "♭5" PUS },
750 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, -1}, {7, 0}}, "m" SUP "M9♭5" PUS },
751 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "9" PUS },
752 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -1}}, "𝆩" SUP "♭9" PUS },
753 { 5, {{1, 0}, {9, 0}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "9" PUS },
754 { 5, {{1, 0}, {9, -1}, {3, -1}, {5, -1}, {7, -2}}, "°" SUP "♭9" PUS },
756 /* Eleventh chords */
757 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, +1}, {7, 0}}, SUP "+M11" PUS },
758 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, +1}, {7, -1}}, SUP "+11" PUS },
759 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, 0}, {7, 0}}, "M11" },
760 { 6, {{1, 0}, {9, 0}, {3, 0}, {11, 0}, {5, 0}, {7, -1}}, "11" },
761 { 6, {{1, 0}, {9, 0}, {3, -1}, {11, 0}, {5, 0}, {7, 0}}, "m" SUP "M11" PUS },
762 { 6, {{1, 0}, {9, 0}, {3, -1}, {11, 0}, {5, 0}, {7, -1}}, "m11" },
763 { 6, {{1, 0}, {9, -1}, {3, -1}, {11, 0}, {5, -1}, {7, -1}}, "𝆩" SUP "11" PUS },
764 { 6, {{1, 0}, {9, -1}, {3, -1}, {11, -1}, {5, -1}, {7, -2}}, "°" SUP "11" PUS }
768 scherzo_adjust_pitch_to_match_modified_degree (pitch_t *pitch,
770 modified_degree_t *degree)
772 pitch_name_t name = PITCH_NAME (*pitch);
773 pitch_accidental_t accidental = PITCH_ACCIDENTAL (*pitch);
774 int octave = PITCH_OCTAVE (*pitch);
775 int degree_zero_based = (degree->degree - 1) % 7;
778 int note_degree_zero_based = name - PITCH_NAME (root);
779 if (note_degree_zero_based < 0)
780 note_degree_zero_based += 7;
782 if (note_degree_zero_based == degree_zero_based)
785 degree_delta = note_degree_zero_based - degree_zero_based;
786 if (degree_delta > 3)
787 degree_delta = - (7 - degree_delta);
788 if (degree_delta < -3)
789 degree_delta = - (-7 - degree_delta);
791 if (abs (degree_delta) != 1) {
792 fprintf (stderr, "Internal error: Cannot adjust a note more than one degree (%d vs. %d).\n", note_degree_zero_based + 1, degree->degree);
796 if (degree_delta == -1) {
797 if (name == PITCH_NAME_B) {
818 if (degree_delta == +1) {
819 if (name == PITCH_NAME_C) {
839 if (accidental < 0 || accidental > PITCH_ACCIDENTAL_DOUBLE_SHARP) {
840 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);
844 *pitch = PITCH (name, accidental, octave);
848 _spell_chord_by_signature (pitch_group_t *chord,
849 chord_signature_t *signature,
852 int i, degree, note_half_steps, degree_half_steps;
855 /* Sanitize root to eliminate things like double-flats,
856 * double-sharps, Cb, E#, etc. */
857 root_midi = _pitch_to_midi (root);
858 root = _midi_to_pitch (root_midi);
860 for (i = 0; i < chord->num_pitches; i++) {
861 note_half_steps = _pitch_from_root_in_half_steps (chord->pitches[i],
863 for (degree = 0; degree < signature->num_degrees; degree++) {
864 degree_half_steps = _modified_degree_to_half_steps (&signature->degrees[degree]);
865 if (note_half_steps == degree_half_steps) {
866 scherzo_adjust_pitch_to_match_modified_degree (&chord->pitches[i],
868 &signature->degrees[degree]);
872 if (note_half_steps != degree_half_steps) {
873 fprintf (stderr, "Internal error: Chord and degree mis-match\n");
880 _analyze_chord (pitch_group_t *chord,
881 chord_signature_t **signature_ret,
884 void *local = talloc_new (NULL);
885 analyzed_pitch_t *pitches;
886 int i, j, num_pitches;
887 int bass_pitch, inversion;
889 chord_signature_t *match = NULL;
891 /* Default to no-match for any early return */
892 *signature_ret = NULL;
895 num_pitches = chord->num_pitches;
897 if (chord->num_pitches <= 1)
900 pitches = talloc_array (local, analyzed_pitch_t, num_pitches);
904 for (i = 0; i < num_pitches; i++) {
905 pitch_t pitch = chord->pitches[i];
906 pitches[i].pitch = pitch;
907 pitches[i].midi_pitch = _pitch_to_midi (pitch);
908 /* Relative pitch will be filled in after sorting. */
909 pitches[i].relative_pitch = 0;
912 /* First, sort by midi pitch to find the bass note. */
913 qsort (pitches, num_pitches, sizeof (analyzed_pitch_t),
914 _compare_analyzed_pitch_by_midi_pitch);
916 bass_pitch = pitches[0].midi_pitch;
918 /* With the bass note identified, we can find all relative pitches. */
919 for (i = 0; i < num_pitches; i++) {
920 pitches[i].relative_pitch = pitches[i].midi_pitch - bass_pitch;
921 while (pitches[i].relative_pitch >= 12)
922 pitches[i].relative_pitch -= 12;
925 /* Now, sort again by relative pitch. */
926 qsort (pitches, num_pitches, sizeof (analyzed_pitch_t),
927 _compare_analyzed_pitch_by_relative_pitch);
929 /* Finally, eliminate all duplicate notes. */
930 for (i = 0; i < num_pitches - 1; i++) {
931 if (pitches[i+1].relative_pitch == pitches[i].relative_pitch) {
933 while (j < num_pitches &&
934 pitches[j].relative_pitch == pitches[i].relative_pitch)
938 /* The loop incremented j one past the last
939 * duplicate. Decrement so that it points to the
940 * last duplicate (and is guaranteed to not exceed
941 * the array bounds).*/
944 if (j < num_pitches - 1) {
945 memmove (&pitches[i+1], &pitches[j+1],
946 (num_pitches - j) * sizeof (analyzed_pitch_t));
949 num_pitches -= (j - i);
953 for (inversion = 0; inversion < 4; inversion++) {
954 for (i = 0; i < ARRAY_SIZE (signatures); i++) {
955 if (_chord_signature_matches (pitches, num_pitches,
956 signatures[i].degrees,
957 signatures[i].num_degrees,
960 match = &signatures[i];
968 *signature_ret = match;
969 for (i = 0; i < chord->num_pitches; i++) {
970 if (chord->pitches[i] == root) {
971 *root_ret = &chord->pitches[i];
982 pitch_group_init (void *ctx, pitch_group_t *group)
985 group->pitches = NULL;
987 group->num_pitches = 0;
991 pitch_group_add_pitch (pitch_group_t *group, pitch_t pitch)
995 /* Do nothing if pitch is already in group. */
996 for (i = 0; i < group->num_pitches; i++)
997 if (group->pitches[i] == pitch)
1000 group->num_pitches++;
1002 if (group->num_pitches > group->size) {
1004 group->pitches = talloc_realloc (group->ctx, group->pitches,
1005 pitch_t, group->size);
1007 if (group->pitches == NULL) {
1008 fprintf (stderr, "Out of memory.\n");
1013 group->pitches[group->num_pitches - 1] = pitch;
1017 pitch_group_remove_pitch_at (pitch_group_t *group, int i)
1019 if (i > group->num_pitches) {
1020 fprintf (stderr, "Internal error: Cannot remove pitch %d from group with only %d %s\n",
1021 i, group->num_pitches,
1022 group->num_pitches == 1 ? "pitch" : "pitches");
1026 if (i < group->num_pitches - 1) {
1027 memmove (group->pitches + i, group->pitches + i + 1,
1028 (group->num_pitches - 1 - i) * sizeof (pitch_t));
1031 group->num_pitches--;
1034 /* Remove a 'pitch' from 'group', (including any enharmonic pitch)
1035 * See also: pitch_group_remove_pitch
1038 pitch_group_remove_pitch_enharmonic (pitch_group_t *group, pitch_t pitch)
1042 for (i = 0; i < group->num_pitches; i++)
1043 if (_pitches_are_enharmonic (group->pitches[i], pitch))
1044 pitch_group_remove_pitch_at (group, i);
1047 /* Remove an exactly-matching pitch from 'group'
1048 * See also: pitch_group_remove_pitch_enharmonic
1051 pitch_group_remove_pitch (pitch_group_t *group, pitch_t pitch)
1055 for (i = 0; i < group->num_pitches; i++)
1056 if (group->pitches[i] == pitch)
1057 pitch_group_remove_pitch_at (group, i);
1062 scherzo_update_notes_and_chord (scherzo_t *scherzo)
1064 if (scherzo->notes_pressed.num_pitches == 0 &&
1065 scherzo->notes_pedaled.num_pitches == 0)
1067 score_remove_notes (scherzo->score);
1069 score_remove_chords (scherzo->score);
1071 gtk_widget_queue_draw (scherzo->window);
1076 scherzo_press_note (scherzo_t *scherzo, pitch_t pitch)
1078 void *local = talloc_new (NULL);
1079 pitch_group_t *chord;
1080 chord_signature_t *signature;
1081 char *chord_name = NULL;
1085 /* Do nothing if this note is already pressed. */
1086 for (i = 0; i < scherzo->notes_pressed.num_pitches; i++)
1087 if (scherzo->notes_pressed.pitches[i] == pitch)
1090 pitch_group_add_pitch (&scherzo->notes_pressed, pitch);
1092 if (scherzo->pedal_pressed)
1093 pitch_group_add_pitch (&scherzo->notes_pedaled, pitch);
1095 /* Remove all notes/chords from score, then add current notes. */
1096 score_remove_notes (scherzo->score);
1097 score_remove_chords (scherzo->score);
1099 if (scherzo->pedal_pressed)
1100 chord = &scherzo->notes_pedaled;
1102 chord = &scherzo->notes_pressed;
1104 _analyze_chord (chord, &signature, &root);
1107 /* Don't print root pitch for octaves and inversions,
1108 * (since a pitch name alone looks like a major triad) */
1109 if (signature->num_degrees < 3) {
1110 chord_name = talloc_strdup (local, signature->name);
1112 _spell_chord_by_signature (&scherzo->notes_pressed,
1114 _spell_chord_by_signature (&scherzo->notes_pedaled,
1117 chord_name = talloc_asprintf (local, "%s%s",
1121 } else if (chord->num_pitches > 2) {
1122 chord_name = talloc_strdup (local, "?");
1126 scherzo->chord = score_add_chord (scherzo->treble, chord_name);
1128 for (i = 0; i < scherzo->notes_pressed.num_pitches; i++)
1130 score_add_note (scherzo->score, scherzo->notes_pressed.pitches[i],
1131 SCORE_DURATION_WHOLE);
1134 for (i = 0; i < scherzo->notes_pedaled.num_pitches; i++)
1136 score_add_note (scherzo->score, scherzo->notes_pedaled.pitches[i],
1137 SCORE_DURATION_WHOLE);
1140 talloc_free (local);
1144 scherzo_release_note (scherzo_t *scherzo, pitch_t pitch)
1146 pitch_group_remove_pitch_enharmonic (&scherzo->notes_pressed, pitch);
1148 if (scherzo->notes_pressed.num_pitches == 0)
1149 scherzo_update_notes_and_chord (scherzo);
1153 scherzo_press_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1155 pitch_t pitch = _midi_to_pitch (midi_note);
1157 scherzo_press_note (scherzo, pitch);
1163 scherzo_release_note_midi (scherzo_t *scherzo, unsigned char midi_note)
1165 scherzo_release_note (scherzo, _midi_to_pitch (midi_note));
1169 scherzo_press_pedal (scherzo_t *scherzo)
1173 if (scherzo->pedal_pressed)
1176 scherzo->pedal_pressed = 1;
1178 /* Copy all pressed notes to pedaled notes */
1179 for (i = 0; i < scherzo->notes_pressed.num_pitches; i++)
1180 pitch_group_add_pitch (&scherzo->notes_pedaled, scherzo->notes_pressed.pitches[i]);
1184 scherzo_release_pedal (scherzo_t *scherzo)
1188 if (! scherzo->pedal_pressed)
1191 /* Remove all previously pedaled notes. */
1192 for (i = scherzo->notes_pedaled.num_pitches - 1; i >=0; i--)
1193 pitch_group_remove_pitch_at (&scherzo->notes_pedaled, i);
1195 scherzo->pedal_pressed = 0;
1197 scherzo_update_notes_and_chord (scherzo);
1201 _select_challenge (scherzo_t *scherzo)
1203 category_t *category_unused;
1204 bool_t introduced_unused;
1206 challenge_t *challenge = &scherzo->challenge;
1207 pitch_name_t pitch_name;
1211 mnemon_select_item (&scherzo->mnemon,
1213 &challenge->item_index,
1215 &introduced_unused);
1217 item = challenge->bin->items[challenge->item_index];
1219 s = item->challenge;
1220 if (strncmp (s, "treble:", 7) == 0) {
1222 challenge->staff = scherzo->treble;
1223 } else if (strncmp (s, "bass:", 5) == 0) {
1225 challenge->staff = scherzo->bass;
1228 "Malformed staff name: %s (expected 'treble:' or 'bass:')\n",
1235 pitch_name = PITCH_NAME_C;
1238 pitch_name = PITCH_NAME_D;
1241 pitch_name = PITCH_NAME_E;
1244 pitch_name = PITCH_NAME_F;
1247 pitch_name = PITCH_NAME_G;
1250 pitch_name = PITCH_NAME_A;
1253 pitch_name = PITCH_NAME_B;
1256 fprintf (stderr, "Malformed pitch name: %s (expected 'A' - 'G')\n", s);
1261 if (*s < '0' || *s > '9') {
1262 fprintf (stderr, "Malformed octave number: %s (expected '0' - '9')\n", s);
1268 challenge->pitch = PITCH (pitch_name, PITCH_ACCIDENTAL_NATURAL, octave);
1270 challenge->active = 1;
1271 challenge->satisfied = 0;
1272 challenge->mistaken = 0;
1275 /* Determine whether the user hit the correct note. */
1277 _judge_pitch (scherzo_t *scherzo, pitch_t pitch)
1279 challenge_t *challenge = &scherzo->challenge;
1281 if (! challenge->active)
1284 if (pitch == challenge->pitch)
1285 challenge->satisfied = 1;
1287 challenge->mistaken = 1;
1290 /* If the user got the right note (eventually), then score it in
1291 * mnemon and show the next note. */
1293 _score_challenge (scherzo_t *scherzo)
1295 challenge_t *challenge = &scherzo->challenge;
1297 if (! challenge->active)
1300 if (! challenge->satisfied)
1303 mnemon_score_item (&scherzo->mnemon, challenge->bin, challenge->item_index,
1304 ! challenge->mistaken);
1306 _select_challenge (scherzo);
1310 on_midi_input (unused (GIOChannel *channel),
1311 unused (GIOCondition condition),
1314 unsigned char buf[MIDI_BUF_SIZE], *next;
1315 scherzo_t *scherzo = user_data;
1317 snd_seq_event_t event;
1319 int need_redraw = FALSE;
1321 remaining = read (scherzo->midi_fd, buf, MIDI_BUF_SIZE);
1327 consumed = snd_midi_event_encode (scherzo->snd_midi_event,
1328 next, remaining, &event);
1330 remaining -= consumed;
1333 switch (event.type) {
1334 case SND_SEQ_EVENT_NONE:
1335 /* Incomplete event. Nothing to do. */
1337 case SND_SEQ_EVENT_NOTEON:
1338 pitch = scherzo_press_note_midi (scherzo, event.data.note.note);
1339 _judge_pitch (scherzo, pitch);
1342 case SND_SEQ_EVENT_NOTEOFF:
1343 scherzo_release_note_midi (scherzo, event.data.note.note);
1344 _score_challenge (scherzo);
1347 case SND_SEQ_EVENT_CLOCK:
1348 /* Ignore for now as my piano sends a constant stream of these. */
1350 case SND_SEQ_EVENT_SENSING:
1351 /* Ignore for now as my piano sends a constant stream of these. */
1353 case SND_SEQ_EVENT_CONTROLLER:
1354 /* XXX: My piano gives me 64 for the sustain pedal, is
1355 * that universal? */
1356 if (event.data.control.param == 64) {
1357 if (event.data.control.value == 0)
1358 scherzo_release_pedal (scherzo);
1360 scherzo_press_pedal (scherzo);
1362 fprintf (stderr, "Fixme: Unhandled MIDI Control event (param=%d, value=%d)\n",
1363 event.data.control.param, event.data.control.value);
1367 fprintf (stderr, "Fixme: Do not yet know how to handle MIDI event %d\n",
1374 gtk_widget_queue_draw (scherzo->window);
1376 /* Return TRUE to continue to get called in the future. */
1381 main (int argc, char *argv[])
1383 GtkWidget *drawing_area;
1387 srand (time (NULL));
1389 gtk_init (&argc, &argv);
1391 scherzo.ctx = talloc_new (NULL);
1393 scherzo.score = score_create (scherzo.ctx);
1394 scherzo.staff_height = 100;
1395 score_set_staff_height (scherzo.score, scherzo.staff_height);
1397 score_add_brace (scherzo.score, 2);
1398 scherzo.treble = score_add_staff (scherzo.score, SCORE_CLEF_G);
1399 scherzo.bass = score_add_staff (scherzo.score, SCORE_CLEF_F);
1401 scherzo.chord = NULL;
1403 /* Default to octave 4 and natural for computer keyboard keypresses. */
1404 scherzo.keyboard_octave = 4;
1405 scherzo.keyboard_accidental = PITCH_ACCIDENTAL_NATURAL;
1407 pitch_group_init (scherzo.ctx, &scherzo.notes_pressed);
1408 pitch_group_init (scherzo.ctx, &scherzo.notes_pedaled);
1410 scherzo.pedal_pressed = 0;
1412 mnemon_init (&scherzo.mnemon);
1413 /* XXX: Should create a default file if one cannot be loaded. */
1414 mnemon_load_category (&scherzo.mnemon, "scherzo-notes");
1416 scherzo.challenge.active = 0;
1418 _select_challenge (&scherzo);
1421 err = snd_midi_event_new (MIDI_BUF_SIZE, &scherzo.snd_midi_event);
1423 fprintf (stderr, "Out of memory.\n");
1427 #define MIDI_DEVICE "/dev/midi1"
1428 scherzo.midi_fd = open (MIDI_DEVICE, O_RDONLY);
1429 if (scherzo.midi_fd < 0) {
1430 printf ("failed to open " MIDI_DEVICE ". Midi input will not be available.\n");
1432 GIOChannel *channel;
1434 channel = g_io_channel_unix_new (scherzo.midi_fd);
1435 g_io_channel_set_encoding (channel, NULL, NULL);
1436 g_io_add_watch (channel, G_IO_IN, on_midi_input, &scherzo);
1439 scherzo.window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1441 gtk_window_set_default_size (GTK_WINDOW (scherzo.window), 1000, 600);
1443 g_signal_connect (scherzo.window, "delete-event",
1444 G_CALLBACK (on_delete_event_quit), NULL);
1446 drawing_area = gtk_drawing_area_new ();
1448 gtk_container_add (GTK_CONTAINER (scherzo.window), drawing_area);
1450 g_signal_connect (drawing_area, "expose-event",
1451 G_CALLBACK (on_expose_event_draw),
1454 g_signal_connect (scherzo.window, "key-press-event",
1455 G_CALLBACK (on_key_press_event),
1458 g_signal_connect (scherzo.window, "key-release-event",
1459 G_CALLBACK (on_key_release_event),
1462 gtk_widget_show_all (scherzo.window);
1466 mnemon_save (&scherzo.mnemon);
1468 snd_midi_event_free (scherzo.snd_midi_event);
1470 talloc_free (scherzo.ctx);