2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2002--2014 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);
62 DECLARE_TRANSLATOR_LISTENER (ligature);
65 TRANSLATOR_DECLARATIONS (Mensural_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 IMPLEMENT_TRANSLATOR_LISTENER (Mensural_ligature_engraver, ligature);
78 Mensural_ligature_engraver::listen_ligature (Stream_event *ev)
80 Ligature_engraver::listen_ligature (ev);
83 Mensural_ligature_engraver::Mensural_ligature_engraver ()
85 brew_ligature_primitive_proc
86 = Mensural_ligature::brew_ligature_primitive_proc;
90 Mensural_ligature_engraver::create_ligature_spanner ()
92 return make_spanner ("MensuralLigature", SCM_EOL);
96 Mensural_ligature_engraver::transform_heads (vector<Grob_info> const &primitives)
98 if (primitives.size () < 2)
100 warning (_ ("ligature with less than 2 heads -> skipping"));
104 bool at_beginning = true;
106 // needed so that we can check whether
107 // the previous note can be turned into a flexa
108 bool prev_brevis_shape = false;
110 bool prev_semibrevis = false;
111 Item *prev_primitive = NULL;
113 for (vsize i = 0, s = primitives.size (); i < s; i++)
115 Grob_info info = primitives[i];
116 Item *primitive = dynamic_cast<Item *> (info.grob ());
117 int duration_log = Rhythmic_head::duration_log (primitive);
119 Stream_event *nr = info.event_cause ();
122 ugh. why not simply check for pitch?
124 if (!nr->in_event_class ("note-event"))
126 nr->origin ()->warning
127 (_ ("cannot determine pitch of ligature primitive -> skipping"));
132 int pitch = unsmob_pitch (nr->get_property ("pitch"))->steps ();
139 // we can get here after invalid input
140 nr->origin ()->warning
141 (_ ("single note ligature - skipping"));
144 prev_semibrevis = prev_brevis_shape = false;
145 prev_primitive = NULL;
149 if (pitch == prev_pitch)
151 nr->origin ()->warning
152 (_ ("prime interval within ligature -> skipping"));
159 if (duration_log < -3 // is this possible at all???
162 nr->origin ()->warning
163 (_ ("mensural ligature: duration none of Mx, L, B, S -> skipping"));
169 bool general_case = true;
170 bool make_flexa = false;
171 bool allow_flexa = true;
173 // first check special cases
178 if (duration_log == 0)
180 prim = MLP_UP | MLP_BREVIS;
181 general_case = false;
183 // b. descendens longa or brevis
185 && (unsmob_pitch (primitives[i + 1].event_cause ()
186 ->get_property ("pitch"))->steps () < pitch)
187 && duration_log > -3)
189 int left_stem = duration_log == -1 ? MLP_DOWN : 0;
190 prim = left_stem | MLP_BREVIS;
191 general_case = false;
194 // 2. initial semibrevis must be followed by another one
195 else if (prev_semibrevis)
197 prev_semibrevis = false;
198 if (duration_log == 0)
201 general_case = false;
205 nr->origin ()->warning
206 (_ ("semibrevis must be followed by another one -> skipping"));
212 // 3. semibreves are otherwise not allowed
213 else if (duration_log == 0)
215 nr->origin ()->warning
216 (_ ("semibreves can only appear at the beginning of a ligature,\n"
217 "and there may be only zero or two of them"));
222 // 4. end, descendens
223 else if (i == s - 1 && pitch < prev_pitch)
225 // brevis; previous note must be turned into flexa
226 if (duration_log == -1)
228 if (prev_brevis_shape)
231 general_case = false;
235 nr->origin ()->warning
236 (_ ("invalid ligatura ending:\n"
237 "when the last note is a descending brevis,\n"
238 "the penultimate note must be another one,\n"
239 "or the ligatura must be LB or SSB"));
245 else if (duration_log == -2)
248 general_case = allow_flexa = false;
250 // else maxima; fall through to regular case below
254 && to_boolean (primitive->get_property ("ligature-flexa")))
257 flexa requested, check whether allowed:
258 - there should be a previous note
259 - both of the notes must be of brevis shape
260 (i.e. can't be maxima or flexa;
261 longa is forbidden as well - it's nonexistent anyway)
262 - no compulsory flexa for the next note,
263 i.e. it's not an ultimate descending breve
265 make_flexa = !at_beginning && prev_brevis_shape && duration_log > -2;
266 if (make_flexa && i == s - 2)
269 check last condition: look ahead to next note
271 Grob_info next_info = primitives[i + 1];
272 Item *next_primitive = dynamic_cast<Item *> (next_info.grob ());
273 if (Rhythmic_head::duration_log (next_primitive) == -1)
276 breve: check whether descending
278 int const next_pitch = unsmob_pitch
279 (next_info.event_cause ()->get_property ("pitch"))->steps ();
280 if (next_pitch < pitch)
291 static int const shape[3] = {MLP_MAXIMA, MLP_LONGA, MLP_BREVIS};
293 prim = shape[duration_log + 3];
299 turn the note with the previous one into a flexa
301 prev_primitive->set_property
305 | (scm_to_int (prev_primitive->get_property ("primitive"))
307 prev_primitive->set_property
308 ("flexa-interval", scm_from_int (pitch - prev_pitch));
309 prim = MLP_FLEXA_END;
310 primitive->set_property
311 ("flexa-interval", scm_from_int (pitch - prev_pitch));
314 // join_primitives replacement
315 if (!(at_beginning || make_flexa))
316 prev_primitive->set_property ("add-join", ly_bool2scm (true));
318 at_beginning = false;
319 prev_primitive = primitive;
321 primitive->set_property ("primitive", scm_from_int (prim));
322 prev_brevis_shape = (prim & MLP_BREVIS) != 0;
323 prev_semibrevis = (prim & MLP_UP) != 0;
328 * A MensuralLigature grob consists of a bunch of NoteHead grobs that
329 * are glued together. It (a) does not make sense to change
330 * properties like thickness or flexa-width from one head to the next
331 * within a ligature (this would totally screw up alignment), and (b)
332 * some of these properties (like flexa-width) are specific to
333 * e.g. the MensuralLigature (as in contrast to e.g. LigatureBracket),
334 * and therefore should not be handled in the NoteHead code (which is
335 * also used by LigatureBracket). Therefore, we let the user control
336 * these properties via the concrete Ligature grob (like
337 * MensuralLigature) and then copy these properties as necessary to
338 * each of the NoteHead grobs. This is what
339 * propagate_properties () does.
342 Mensural_ligature_engraver::propagate_properties (Spanner *ligature,
343 vector<Grob_info> const &primitives,
347 = robust_scm2double (ligature->get_property ("thickness"), 1.3);
349 *= ligature->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
352 = Font_interface::get_default_font (ligature)->
353 find_by_name ("noteheads.sM1mensural").extent (X_AXIS).length ();
354 Real maxima_head_width
355 = Font_interface::get_default_font (ligature)->
356 find_by_name ("noteheads.sM3ligmensural").extent (X_AXIS).length ();
359 Item *prev_primitive = NULL;
360 for (vsize i = 0; i < primitives.size (); i++)
362 Item *primitive = dynamic_cast<Item *> (primitives[i].grob ());
363 int output = scm_to_int (primitive->get_property ("primitive"));
364 primitive->set_property ("thickness",
365 scm_from_double (thickness));
367 switch (output & MLP_ANY)
371 min_length += head_width;
372 primitive->set_property ("head-width", scm_from_double (head_width));
375 min_length += maxima_head_width;
376 primitive->set_property ("head-width",
377 scm_from_double (maxima_head_width));
379 case MLP_FLEXA_BEGIN:
381 the next note (should be MLP_FLEXA_END) will handle this one
386 SCM flexa_scm = primitive->get_property ("flexa-width");
387 Real const flexa_width = robust_scm2double (flexa_scm, 2.0);
388 min_length += flexa_width + thickness;
389 SCM head_width = scm_from_double (0.5 * (flexa_width + thickness));
390 primitive->set_property ("head-width", head_width);
391 prev_primitive->set_property ("head-width", head_width);
392 prev_primitive->set_property ("flexa-width", flexa_scm);
396 programming_error (_ ("unexpected case fall-through"));
400 prev_primitive = primitive;
405 Mensural_ligature_engraver::fold_up_primitives (vector<Grob_info> const &primitives,
410 Real staff_space = 0.0;
411 Real thickness = 0.0;
413 for (vsize i = 0; i < primitives.size (); i++)
415 Item *current = dynamic_cast<Item *> (primitives[i].grob ());
419 staff_space = Staff_symbol_referencer::staff_space (first);
420 thickness = scm_to_double (current->get_property ("thickness"));
423 move_related_items_to_column (current, first->get_column (),
426 Real head_width = scm_to_double (current->get_property ("head-width"));
427 distance += head_width - thickness;
429 if (size_t const dot_count = Rhythmic_head::dot_count (current))
431 Move dots above/behind the ligature.
432 dots should also avoid staff lines.
435 Grob *dot_gr = Rhythmic_head::get_dots (current);
437 bool const on_line = Staff_symbol_referencer::on_line
439 robust_scm2int (current->get_property ("staff-position"), 0));
440 Real vert_shift = on_line ? staff_space * 0.5 : 0.0;
441 bool const flexa_begin
442 = scm_to_int (current->get_property ("primitive"))
445 if (i + 1 < primitives.size ())
447 dot in the midst => avoid next note;
448 what to avoid and where depends on
449 being on a line or between lines
453 = scm_to_int (current->get_property ("delta-position"));
455 vert_shift += delta < 0
456 ? staff_space : (on_line ? -2.0 : -1.0) * staff_space;
459 if (0 < delta && delta < 3)
460 vert_shift -= staff_space;
462 else if (delta == 1 || delta == -1)
463 vert_shift -= delta * staff_space;
466 min_length += head_width * dot_count;
468 dot_gr->translate_axis (vert_shift, Y_AXIS);
471 move all dots behind head
473 dot_gr->translate_axis
474 ((flexa_begin ? staff_space * 0.6 : head_width) - 2.0 * thickness, X_AXIS);
480 Mensural_ligature_engraver::build_ligature (Spanner *ligature,
481 vector<Grob_info> const &primitives)
484 the X extent of the actual graphics representing the ligature;
485 less space than that means collision
489 transform_heads (primitives);
490 propagate_properties (ligature, primitives, min_length);
491 fold_up_primitives (primitives, min_length);
493 if (robust_scm2double (ligature->get_property ("minimum-length"), 0.0)
495 ligature->set_property ("minimum-length", scm_from_double (min_length));
498 ADD_ACKNOWLEDGER (Mensural_ligature_engraver, rest);
499 ADD_ACKNOWLEDGER (Mensural_ligature_engraver, ligature_head);
501 ADD_TRANSLATOR (Mensural_ligature_engraver,
503 "Handle @code{Mensural_ligature_events} by glueing special"
504 " ligature heads together.",