1 /* scherzo - Music notation training
3 * score - Utilities for drawing (simple) musical scores
5 * Copyright © 2010 Carl Worth
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see http://www.gnu.org/licenses/ .
33 typedef struct score_brace
41 /* Height of a single staff */
44 /* Height of one space within a staff */
47 /* Minimal line width for staff lines */
50 /* Full width of staff */
53 score_brace_t **braces;
57 score_staff_t **staves;
62 score_create (void *ctx)
66 score = talloc (ctx, score_t);
70 /* Also sets space_height and line_width */
71 score_set_staff_height (score, 24);
73 /* Just to have some nominal width. */
77 score->num_braces = 0;
80 score->num_staves = 0;
86 score_set_staff_height (score_t *score, int height)
88 score->space_height = (int) height / 4;
89 score->staff_height = score->space_height * 4;
91 score->line_width = score->space_height / 10;
92 if (score->line_width == 0)
93 score->line_width = 1;
95 return score->staff_height;
99 score_set_width (score_t *score, int width)
101 score->width = width;
104 /* Returns in brace_width the width of the brace */
106 _draw_brace (score_t *score, cairo_t *cr,
107 score_brace_t *brace, int *brace_width)
109 cairo_glyph_t brace_glyph;
110 cairo_text_extents_t brace_extents;
114 cairo_select_font_face (cr, "Gonville-Brace", 0, 0);
116 /* XXX: This hard-coded glyph index is pretty ugly. We should
117 * figure out how to lookup the glyph we want, (though, as it
118 * turns out, this brace font pretty much just has numbered glyph
119 * names for different sizes, so it wouldn't be all that different
120 * than just the bare index here). */
121 brace_glyph.index = 300;
123 brace_glyph.y = score->staff_height * (brace->first_staff + (2 * brace->num_staves - 1) / 2.0) + 1;
125 /* XXX: This font size (in conjunction with the glyph selection)
126 * is a rough guess at best. We should figure out how the brace
127 * font is intended to be used and actually measure to find the
128 * correctly-sized glyph. */
129 cairo_set_font_size (cr, (score->staff_height * 3) / 3.85);
131 cairo_glyph_extents (cr, &brace_glyph, 1, &brace_extents);
133 /* Subtract space for brace itself */
134 cairo_translate (cr, -brace_extents.x_bearing, 0);
136 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); /* black */
137 cairo_show_glyphs (cr, &brace_glyph, 1);
141 *brace_width = (int) -brace_extents.x_bearing;
144 /* Line containing middle C for the given clef. */
146 _score_clef_c_line (score_clef_t clef)
159 _score_note_to_line (score_staff_t *staff, score_note_t *note)
161 score_pitch_name_t name = SCORE_PITCH_NAME (note->pitch);
162 int c_line = _score_clef_c_line (staff->clef);
164 return c_line - (name - SCORE_PITCH_NAME_C) / 2.0 - 3.5 * (note->octave - 4);
168 _draw_note (score_t *score, cairo_t *cr,
169 score_staff_t *staff, score_note_t *note)
172 cairo_glyph_t note_glyph;
173 static double extend_factor = 0.25;
175 void _draw_ledger_line (double line, double width) {
177 - width * extend_factor / 2.0,
178 score->space_height * line + score->line_width / 2.0);
179 cairo_rel_line_to (cr, (1 + extend_factor) * width, 0);
185 /* Which line should the note appear on? Line 0 is the top line of
186 * the staff and increasing downwards. (Negative values indicate a
187 * note on a ledger line above the staff). Values half way between
188 * integers indicate notes appearing on a space between two staff
189 * lines (or ledger lines). */
190 line = _score_note_to_line (staff, note);
192 cairo_select_font_face (cr, "Gonville-26", 0, 0);
193 cairo_set_font_size (cr, score->staff_height);
195 /* XXX: The hard-coded glyph indices here are very ugly. We should
196 * figure out how to lookup glyphs by name from this font. */
197 switch (note->duration) {
198 case SCORE_DURATION_1:
199 note_glyph.index = 127;
201 case SCORE_DURATION_2:
202 note_glyph.index = 85;
204 case SCORE_DURATION_4:
205 case SCORE_DURATION_8:
206 case SCORE_DURATION_16:
207 case SCORE_DURATION_32:
208 case SCORE_DURATION_64:
209 case SCORE_DURATION_128:
211 note_glyph.index = 84;
215 note_glyph.y = score->space_height * line;
217 if (line < 0 || line > 4) {
219 cairo_text_extents_t note_extents;
221 cairo_glyph_extents (cr, ¬e_glyph, 1, ¬e_extents);
224 for (i = -1; i >= line; i--)
225 _draw_ledger_line (i, note_extents.width);
227 for (i = 5; i <= line; i++)
228 _draw_ledger_line (i, note_extents.width);
232 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); /* black */
233 cairo_show_glyphs (cr, ¬e_glyph, 1);
239 _draw_staff (score_t *score, cairo_t *cr,
240 score_staff_t *staff, int staff_width)
243 cairo_glyph_t clef_glyph;
247 cairo_select_font_face (cr, "Gonville-26", 0, 0);
249 cairo_set_font_size (cr, score->staff_height);
251 /* XXX: The hard-coded glyph indices here are very ugly. We should
252 * figure out how to lookup glyphs by name from this font. */
253 switch (staff->clef) {
256 clef_glyph.index = 46;
257 clef_glyph.y = 3 * score->space_height;
260 clef_glyph.index = 45;
261 clef_glyph.y = 1 * score->space_height;
264 clef_glyph.x = 3 * score->line_width;
267 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); /* black */
268 cairo_show_glyphs (cr, &clef_glyph, 1);
270 /* Draw staff lines */
271 for (i = 0; i < 5; i++) {
272 cairo_move_to (cr, 0, i * score->space_height + score->line_width / 2.0);
273 cairo_rel_line_to (cr, staff_width, 0);
276 cairo_set_line_width (cr, score->line_width);
278 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); /* black */
281 /* Make space for clef before drawing notes */
282 cairo_translate (cr, (int) (4 * score->space_height), 0);
285 for (i = 0; i < staff->num_notes; i++) {
286 _draw_note (score, cr, staff, staff->notes[i]);
287 /* Draw all notes concurrent for now (as a chord)
288 cairo_translate (cr, score->space_height * 2.0, 0);
296 score_draw (score_t *score, cairo_t *cr)
299 int staff_width = score->width;
303 if (score->num_braces)
307 for (i = 0; i < score->num_braces; i++)
308 _draw_brace (score, cr, score->braces[i], &brace_width);
310 /* Subtract space for brace itself */
311 cairo_translate (cr, brace_width, 0);
312 staff_width -= brace_width;
314 /* As well as some padding */
315 cairo_translate (cr, 2, 0);
319 /* Vertical lines at each end */
321 score->line_width / 2.0,
322 score->line_width / 2.0,
323 staff_width - score->line_width,
324 score->staff_height * 3);
325 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); /* black */
326 cairo_set_line_width (cr, score->line_width);
329 for (i = 0; i < score->num_staves; i++) {
330 _draw_staff (score, cr, score->staves[i], staff_width);
331 cairo_translate (cr, 0, 2 * score->staff_height);
338 score_add_brace (score_t *score, int staves)
340 score_brace_t *brace;
342 brace = talloc (score, score_brace_t);
346 brace->first_staff = score->num_staves;
347 brace->num_staves = staves;
350 score->braces = talloc_realloc (score,
354 if (score->braces == NULL) {
355 score->num_braces = 0;
359 score->braces[score->num_braces - 1] = brace;
364 score_add_staff (score_t *score, score_clef_t clef)
366 score_staff_t *staff;
368 staff = talloc (score, score_staff_t);
375 staff->num_notes = 0;
378 score->staves = talloc_realloc (score,
382 if (score->staves == NULL) {
383 score->num_staves = 0;
387 score->staves[score->num_staves - 1] = staff;
393 score_add_note (score_staff_t *staff,
396 score_duration_t duration)
400 note = talloc (staff, score_note_t);
406 note->octave = octave;
407 note->duration = duration;
410 staff->notes = talloc_realloc (staff,
414 if (staff->notes == NULL) {
415 staff->num_notes = 0;
419 staff->notes[staff->num_notes - 1] = note;
425 score_remove_note (score_note_t *note)
427 score_staff_t *staff = note->staff;
430 for (i = 0; i < staff->num_notes; i++)
431 if (staff->notes[i] == note)
434 if (i == staff->num_notes)
437 if (i < staff->num_notes - 1)
439 memmove (staff->notes + i,
440 staff->notes + i + 1,
441 (staff->num_notes - 1 - i) * sizeof (score_note_t *));
444 staff->num_notes -= 1;
448 score_staff_find_note (score_staff_t *staff,
451 score_duration_t duration)
456 for (i = 0; i < staff->num_notes; i++) {
457 note = staff->notes[i];
458 if (note->pitch == pitch &&
459 note->octave == octave &&
460 note->duration == duration)