2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2002--2015 Juergen Reuter <reuter@ipd.uka.de>,
5 Pal Benko <benkop@freestart.hu>
7 LilyPond 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 LilyPond 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 LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "coherent-ligature-engraver.hh"
22 #include "font-interface.hh"
23 #include "international.hh"
24 #include "mensural-ligature.hh"
25 #include "note-column.hh"
26 #include "note-head.hh"
27 #include "output-def.hh"
28 #include "paper-column.hh"
30 #include "rhythmic-head.hh"
32 #include "staff-symbol-referencer.hh"
33 #include "stream-event.hh"
36 #include "translator.icc"
39 * TODO: accidentals are aligned with the first note;
40 * they must appear ahead.
42 * TODO: prohibit ligatures having notes differing only in accidentals
43 * (like \[ a\breve g as \])
45 * TODO: do something with multiple voices within a ligature. See
47 * Ockeghem: Missa Ecce ancilla domini, bassus part, end of Christe.
49 * TODO: enhance robustness: in case of an invalid ligature (e.g. the
50 * input specifies a ligature that contains a minima), automatically
51 * break the ligature into smaller, valid pieces. Such a piece may be
55 class Mensural_ligature_engraver : public Coherent_ligature_engraver
59 virtual Spanner *create_ligature_spanner ();
60 virtual void build_ligature (Spanner *ligature,
61 vector<Grob_info> const &primitives);
64 TRANSLATOR_DECLARATIONS (Mensural_ligature_engraver);
65 TRANSLATOR_INHERIT (Coherent_ligature_engraver);
68 void transform_heads (vector<Grob_info> const &primitives);
69 void propagate_properties (Spanner *ligature,
70 vector<Grob_info> const &primitives,
72 void fold_up_primitives (vector<Grob_info> const &primitives,
76 Mensural_ligature_engraver::Mensural_ligature_engraver ()
78 brew_ligature_primitive_proc
79 = Mensural_ligature::brew_ligature_primitive_proc;
83 Mensural_ligature_engraver::create_ligature_spanner ()
85 return make_spanner ("MensuralLigature", SCM_EOL);
89 Mensural_ligature_engraver::transform_heads (vector<Grob_info> const &primitives)
91 if (primitives.size () < 2)
93 warning (_ ("ligature with less than 2 heads -> skipping"));
97 bool at_beginning = true;
99 // needed so that we can check whether
100 // the previous note can be turned into a flexa
101 bool prev_brevis_shape = false;
103 bool prev_semibrevis = false;
104 Item *prev_primitive = NULL;
106 for (vsize i = 0, s = primitives.size (); i < s; i++)
108 Grob_info info = primitives[i];
109 Item *primitive = dynamic_cast<Item *> (info.grob ());
110 int duration_log = Rhythmic_head::duration_log (primitive);
112 Stream_event *nr = info.event_cause ();
115 ugh. why not simply check for pitch?
117 if (!nr->in_event_class ("note-event"))
119 nr->origin ()->warning
120 (_ ("cannot determine pitch of ligature primitive -> skipping"));
125 int pitch = unsmob<Pitch> (nr->get_property ("pitch"))->steps ();
132 // we can get here after invalid input
133 nr->origin ()->warning
134 (_ ("single note ligature - skipping"));
137 prev_semibrevis = prev_brevis_shape = false;
138 prev_primitive = NULL;
142 if (pitch == prev_pitch)
144 nr->origin ()->warning
145 (_ ("prime interval within ligature -> skipping"));
152 if (duration_log < -3 // is this possible at all???
155 nr->origin ()->warning
156 (_ ("mensural ligature: duration none of Mx, L, B, S -> skipping"));
162 bool general_case = true;
163 bool make_flexa = false;
164 bool allow_flexa = true;
166 // first check special cases
171 if (duration_log == 0)
173 prim = MLP_UP | MLP_BREVIS;
174 general_case = false;
176 // b. descendens longa or brevis
178 && (unsmob<Pitch> (primitives[i + 1].event_cause ()
179 ->get_property ("pitch"))->steps () < pitch)
180 && duration_log > -3)
182 int left_stem = duration_log == -1 ? MLP_DOWN : 0;
183 prim = left_stem | MLP_BREVIS;
184 general_case = false;
187 // 2. initial semibrevis must be followed by another one
188 else if (prev_semibrevis)
190 prev_semibrevis = false;
191 if (duration_log == 0)
194 general_case = false;
198 nr->origin ()->warning
199 (_ ("semibrevis must be followed by another one -> skipping"));
205 // 3. semibreves are otherwise not allowed
206 else if (duration_log == 0)
208 nr->origin ()->warning
209 (_ ("semibreves can only appear at the beginning of a ligature,\n"
210 "and there may be only zero or two of them"));
215 // 4. end, descendens
216 else if (i == s - 1 && pitch < prev_pitch)
218 // brevis; previous note must be turned into flexa
219 if (duration_log == -1)
221 if (prev_brevis_shape)
224 general_case = false;
228 nr->origin ()->warning
229 (_ ("invalid ligatura ending:\n"
230 "when the last note is a descending brevis,\n"
231 "the penultimate note must be another one,\n"
232 "or the ligatura must be LB or SSB"));
238 else if (duration_log == -2)
241 general_case = allow_flexa = false;
243 // else maxima; fall through to regular case below
247 && to_boolean (primitive->get_property ("ligature-flexa")))
250 flexa requested, check whether allowed:
251 - there should be a previous note
252 - both of the notes must be of brevis shape
253 (i.e. can't be maxima or flexa;
254 longa is forbidden as well - it's nonexistent anyway)
255 - no compulsory flexa for the next note,
256 i.e. it's not an ultimate descending breve
258 make_flexa = !at_beginning && prev_brevis_shape && duration_log > -2;
259 if (make_flexa && i == s - 2)
262 check last condition: look ahead to next note
264 Grob_info next_info = primitives[i + 1];
265 Item *next_primitive = dynamic_cast<Item *> (next_info.grob ());
266 if (Rhythmic_head::duration_log (next_primitive) == -1)
269 breve: check whether descending
271 int const next_pitch = unsmob<Pitch>
272 (next_info.event_cause ()->get_property ("pitch"))->steps ();
273 if (next_pitch < pitch)
284 static int const shape[3] = {MLP_MAXIMA, MLP_LONGA, MLP_BREVIS};
286 prim = shape[duration_log + 3];
292 turn the note with the previous one into a flexa
294 prev_primitive->set_property
298 | (scm_to_int (prev_primitive->get_property ("primitive"))
300 prev_primitive->set_property
301 ("flexa-interval", scm_from_int (pitch - prev_pitch));
302 prim = MLP_FLEXA_END;
303 primitive->set_property
304 ("flexa-interval", scm_from_int (pitch - prev_pitch));
307 // join_primitives replacement
308 if (!(at_beginning || make_flexa))
309 prev_primitive->set_property ("add-join", ly_bool2scm (true));
311 at_beginning = false;
312 prev_primitive = primitive;
314 primitive->set_property ("primitive", scm_from_int (prim));
315 prev_brevis_shape = (prim & MLP_BREVIS) != 0;
316 prev_semibrevis = (prim & MLP_UP) != 0;
321 * A MensuralLigature grob consists of a bunch of NoteHead grobs that
322 * are glued together. It (a) does not make sense to change
323 * properties like thickness or flexa-width from one head to the next
324 * within a ligature (this would totally screw up alignment), and (b)
325 * some of these properties (like flexa-width) are specific to
326 * e.g. the MensuralLigature (as in contrast to e.g. LigatureBracket),
327 * and therefore should not be handled in the NoteHead code (which is
328 * also used by LigatureBracket). Therefore, we let the user control
329 * these properties via the concrete Ligature grob (like
330 * MensuralLigature) and then copy these properties as necessary to
331 * each of the NoteHead grobs. This is what
332 * propagate_properties () does.
335 Mensural_ligature_engraver::propagate_properties (Spanner *ligature,
336 vector<Grob_info> const &primitives,
340 = robust_scm2double (ligature->get_property ("thickness"), 1.3);
342 *= ligature->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
345 = Font_interface::get_default_font (ligature)->
346 find_by_name ("noteheads.sM1mensural").extent (X_AXIS).length ();
347 Real maxima_head_width
348 = Font_interface::get_default_font (ligature)->
349 find_by_name ("noteheads.sM3ligmensural").extent (X_AXIS).length ();
352 Item *prev_primitive = NULL;
353 for (vsize i = 0; i < primitives.size (); i++)
355 Item *primitive = dynamic_cast<Item *> (primitives[i].grob ());
356 int output = scm_to_int (primitive->get_property ("primitive"));
357 primitive->set_property ("thickness",
358 scm_from_double (thickness));
360 switch (output & MLP_ANY)
364 min_length += head_width;
365 primitive->set_property ("head-width", scm_from_double (head_width));
368 min_length += maxima_head_width;
369 primitive->set_property ("head-width",
370 scm_from_double (maxima_head_width));
372 case MLP_FLEXA_BEGIN:
374 the next note (should be MLP_FLEXA_END) will handle this one
379 SCM flexa_scm = primitive->get_property ("flexa-width");
380 Real const flexa_width = robust_scm2double (flexa_scm, 2.0);
381 min_length += flexa_width + thickness;
382 SCM head_width = scm_from_double (0.5 * (flexa_width + thickness));
383 primitive->set_property ("head-width", head_width);
384 prev_primitive->set_property ("head-width", head_width);
385 prev_primitive->set_property ("flexa-width", flexa_scm);
389 programming_error (_ ("unexpected case fall-through"));
393 prev_primitive = primitive;
398 Mensural_ligature_engraver::fold_up_primitives (vector<Grob_info> const &primitives,
403 Real staff_space = 0.0;
404 Real thickness = 0.0;
406 for (vsize i = 0; i < primitives.size (); i++)
408 Item *current = dynamic_cast<Item *> (primitives[i].grob ());
412 staff_space = Staff_symbol_referencer::staff_space (first);
413 thickness = scm_to_double (current->get_property ("thickness"));
416 move_related_items_to_column (current, first->get_column (),
419 Real head_width = scm_to_double (current->get_property ("head-width"));
420 distance += head_width - thickness;
422 if (size_t const dot_count = Rhythmic_head::dot_count (current))
424 Move dots above/behind the ligature.
425 dots should also avoid staff lines.
428 Grob *dot_gr = Rhythmic_head::get_dots (current);
430 bool const on_line = Staff_symbol_referencer::on_line
432 robust_scm2int (current->get_property ("staff-position"), 0));
433 Real vert_shift = on_line ? staff_space * 0.5 : 0.0;
434 bool const flexa_begin
435 = scm_to_int (current->get_property ("primitive"))
438 if (i + 1 < primitives.size ())
440 dot in the midst => avoid next note;
441 what to avoid and where depends on
442 being on a line or between lines
446 = scm_to_int (current->get_property ("delta-position"));
448 vert_shift += delta < 0
449 ? staff_space : (on_line ? -2.0 : -1.0) * staff_space;
452 if (0 < delta && delta < 3)
453 vert_shift -= staff_space;
455 else if (delta == 1 || delta == -1)
456 vert_shift -= delta * staff_space;
459 min_length += head_width * dot_count;
461 dot_gr->translate_axis (vert_shift, Y_AXIS);
464 move all dots behind head
466 dot_gr->translate_axis
467 ((flexa_begin ? staff_space * 0.6 : head_width) - 2.0 * thickness, X_AXIS);
473 Mensural_ligature_engraver::build_ligature (Spanner *ligature,
474 vector<Grob_info> const &primitives)
477 the X extent of the actual graphics representing the ligature;
478 less space than that means collision
482 transform_heads (primitives);
483 propagate_properties (ligature, primitives, min_length);
484 fold_up_primitives (primitives, min_length);
486 if (robust_scm2double (ligature->get_property ("minimum-length"), 0.0)
488 ligature->set_property ("minimum-length", scm_from_double (min_length));
493 Mensural_ligature_engraver::boot ()
495 ADD_LISTENER (Mensural_ligature_engraver, ligature);
496 ADD_ACKNOWLEDGER (Mensural_ligature_engraver, rest);
497 ADD_ACKNOWLEDGER (Mensural_ligature_engraver, ligature_head);
500 ADD_TRANSLATOR (Mensural_ligature_engraver,
502 "Handle @code{Mensural_ligature_events} by glueing special"
503 " ligature heads together.",