/*
- mensural-ligature-engraver.cc -- implement Mensural_ligature_engraver
-
- source file of the GNU LilyPond music typesetter
-
- (c) 2002--2005 Juergen Reuter <reuter@ipd.uka.de>,
- Pal Benko <benkop@freestart.hu>
- */
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 2002--2011 Juergen Reuter <reuter@ipd.uka.de>,
+ Pal Benko <benkop@freestart.hu>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
#include "coherent-ligature-engraver.hh"
+#include "font-interface.hh"
+#include "international.hh"
#include "mensural-ligature.hh"
-#include "event.hh"
-#include "warn.hh"
-#include "spanner.hh"
-#include "paper-column.hh"
#include "note-column.hh"
-#include "rhythmic-head.hh"
#include "note-head.hh"
-#include "staff-symbol-referencer.hh"
#include "output-def.hh"
-#include "font-interface.hh"
+#include "paper-column.hh"
+#include "pitch.hh"
+#include "rhythmic-head.hh"
+#include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+#include "translator.icc"
/*
* TODO: accidentals are aligned with the first note;
* TODO: prohibit ligatures having notes differing only in accidentals
* (like \[ a\breve g as \])
*
- * TODO: dotted heads: avoid next note colliding with the dot, e.g. by
- * putting it *above* (rather than after) the affected ligature head.
- *
* TODO: do something with multiple voices within a ligature. See
* for example:
* Ockeghem: Missa Ecce ancilla domini, bassus part, end of Christe.
*
- * TODO: enhance robustness: in case of an illegal ligature (e.g. the
+ * TODO: enhance robustness: in case of an invalid ligature (e.g. the
* input specifies a ligature that contains a minima), automatically
* break the ligature into smaller, valid pieces. Such a piece may be
* a single note.
protected:
virtual Spanner *create_ligature_spanner ();
- virtual void build_ligature (Spanner *ligature, Array<Grob_info> primitives);
+ virtual void build_ligature (Spanner *ligature, vector<Grob_info> primitives);
+ DECLARE_TRANSLATOR_LISTENER (ligature);
public:
TRANSLATOR_DECLARATIONS (Mensural_ligature_engraver);
private:
- void transform_heads (Array<Grob_info> primitives);
- void propagate_properties (Spanner *ligature, Array<Grob_info> primitives);
- void fold_up_primitives (Array<Grob_info> primitives);
+ void transform_heads (vector<Grob_info> primitives);
+ void propagate_properties (Spanner *ligature, vector<Grob_info> primitives);
+ void fold_up_primitives (vector<Grob_info> primitives);
};
+IMPLEMENT_TRANSLATOR_LISTENER (Mensural_ligature_engraver, ligature);
+void
+Mensural_ligature_engraver::listen_ligature (Stream_event *ev)
+{
+ Ligature_engraver::listen_ligature (ev);
+}
Mensural_ligature_engraver::Mensural_ligature_engraver ()
{
+ brew_ligature_primitive_proc =
+ Mensural_ligature::brew_ligature_primitive_proc;
}
Spanner *
}
void
-Mensural_ligature_engraver::transform_heads (Array<Grob_info> primitives)
+Mensural_ligature_engraver::transform_heads (vector<Grob_info> primitives)
{
if (primitives.size () < 2)
{
- warning (_f ("ligature with less than 2 heads -> skipping"));
+ warning (_ ("ligature with less than 2 heads -> skipping"));
return;
}
int prev_pitch = 0;
bool prev_semibrevis = false;
Item *prev_primitive = NULL;
- for (int i = 0, s = primitives.size (); i < s; i++) {
- Grob_info info = primitives[i];
- Item *primitive = dynamic_cast<Item *> (info.grob_);
- int duration_log = Note_head::get_balltype (primitive);
-
- Music *nr = info.music_cause ();
-
- /*
- ugh. why not simply check for pitch?
- */
- if (!nr->is_mus_type ("note-event"))
- {
- nr->origin ()->warning
- (_f ("can not determine pitch of ligature primitive -> skipping"));
- at_beginning = true;
- continue;
- }
+ for (vsize i = 0, s = primitives.size (); i < s; i++)
+ {
+ Grob_info info = primitives[i];
+ Item *primitive = dynamic_cast<Item *> (info.grob ());
+ int duration_log = Rhythmic_head::duration_log (primitive);
- int pitch = unsmob_pitch (nr->get_property ("pitch"))->steps ();
- int delta_pitch = 0;
-
- if (at_beginning)
- {
- if (i == s - 1)
- {
- // we can get here after invalid input
- nr->origin ()->warning
- (_f ("single note ligature - skipping"));
- break;
- }
- prev_semibrevis = prev_brevis_shape = false;
- prev_primitive = NULL;
- }
- else
- {
- delta_pitch = pitch - prev_pitch;
- if (delta_pitch == 0)
- {
- nr->origin ()->warning
- (_f ("prime interval within ligature -> skipping"));
- at_beginning = true;
- primitive->set_property ("primitive",
- scm_int2num (MLP_NONE));
- continue;
- }
- }
+ Stream_event *nr = info.event_cause ();
- if (duration_log < -3 // is this possible at all???
- || duration_log > 0)
- {
- nr->origin ()->warning
- (_f ("mensural ligature: duration none of Mx, L, B, S -> skipping"));
- primitive->set_property ("primitive",
- scm_int2num (MLP_NONE));
- at_beginning = true;
- continue;
- }
+ /*
+ ugh. why not simply check for pitch?
+ */
+ if (!nr->in_event_class ("note-event"))
+ {
+ nr->origin ()->warning
+ (_ ("cannot determine pitch of ligature primitive -> skipping"));
+ at_beginning = true;
+ continue;
+ }
- // apply_transition replacement begins
- bool general_case = true;
-
- // first check special cases
- // 1. beginning
- if (at_beginning)
- {
- // a. semibreves
- if (duration_log == 0)
- {
- primitive->set_property ("primitive",
- scm_int2num (MLP_UP | MLP_BREVIS));
- prev_semibrevis = prev_brevis_shape = true;
- general_case = false;
- }
- // b. descendens longa or brevis
- else if (i < s - 1
- && (unsmob_pitch (primitives[i + 1].music_cause ()
- ->get_property ("pitch"))->steps () < pitch)
- && duration_log > -3)
- {
- int left_stem = duration_log == -1 ? MLP_DOWN : 0;
-
- primitive->set_property ("primitive",
- scm_int2num (left_stem | MLP_BREVIS));
- prev_brevis_shape = true;
- prev_semibrevis = general_case = false;
- }
- }
- // 2. initial semibrevis must be followed by another one
- else if (prev_semibrevis)
- {
- prev_semibrevis = false;
- if (duration_log == 0)
- {
- primitive->set_property ("primitive", scm_int2num(MLP_BREVIS));
- general_case = false;
- }
- else
- {
- nr->origin ()->warning
- (_f ("semibrevis must be followed by another one -> skipping"));
- primitive->set_property ("primitive",
- scm_int2num (MLP_NONE));
- at_beginning = true;
- continue;
- }
- }
- // 3. semibreves are otherwise not allowed
- else if (duration_log == 0)
- {
- nr->origin ()->warning
- (_f ("semibreves can only appear at the beginning of a ligature,\n"
- "and there may be only zero or two of them"));
- primitive->set_property ("primitive",
- scm_int2num (MLP_NONE));
- at_beginning = true;
- continue;
- }
- // 4. end, descendens
- else if (i == s - 1 && delta_pitch < 0)
- {
- // brevis; previous note must be turned into flexa
- if (duration_log == -1)
- {
- if (prev_brevis_shape)
- {
- prev_primitive->set_property
- ("primitive",
- scm_int2num
- (MLP_FLEXA
- | (scm_to_int (prev_primitive->get_property ("primitive"))
- & MLP_DOWN)));
- primitive->set_property ("primitive", scm_int2num (MLP_NONE));
- break; // no more notes, no join
- }
- else
- {
- nr->origin ()->warning
- (_f ("invalid ligatura ending:\n"
- "when the last note is a descending brevis,\n"
- "the penultimate note must be another one,\n"
- "or the ligatura must be LB or SSB"));
- primitive->set_property ("primitive", scm_int2num (MLP_NONE));
- break;
- }
- }
- // longa
- else if (duration_log == -2)
- {
- primitive->set_property ("primitive", scm_int2num (MLP_BREVIS));
- general_case = false;
- }
- // else maxima; fall through regular case below
- }
+ int pitch = unsmob_pitch (nr->get_property ("pitch"))->steps ();
+ int prim = 0;
- if (general_case)
- {
- static int const shape[3] = {MLP_MAXIMA, MLP_LONGA, MLP_BREVIS};
+ if (at_beginning)
+ {
+ if (i == s - 1)
+ {
+ // we can get here after invalid input
+ nr->origin ()->warning
+ (_ ("single note ligature - skipping"));
+ break;
+ }
+ prev_semibrevis = prev_brevis_shape = false;
+ prev_primitive = NULL;
+ }
+ else
+ {
+ if (pitch == prev_pitch)
+ {
+ nr->origin ()->warning
+ (_ ("prime interval within ligature -> skipping"));
+ at_beginning = true;
+ prim = MLP_NONE;
+ continue;
+ }
+ }
- primitive->set_property ("primitive",
- scm_int2num (shape[duration_log + 3]));
- prev_brevis_shape = duration_log == -1;
- }
+ if (duration_log < -3 // is this possible at all???
+ || duration_log > 0)
+ {
+ nr->origin ()->warning
+ (_ ("mensural ligature: duration none of Mx, L, B, S -> skipping"));
+ prim = MLP_NONE;
+ at_beginning = true;
+ continue;
+ }
- // join_primitives replacement
- if (!at_beginning)
- {
- /*
- if the previous note is longa-shaped and this note is lower,
- then the joining line may hide the stem, so it is made longer
- to serve as stem as well
- */
- if (delta_pitch < 0
- && (scm_to_int (prev_primitive->get_property ("primitive"))
- & MLP_LONGA))
- {
- delta_pitch -= 6;
- // instead of number 6
- // the legth of the longa stem should be queried something like
- // Font_interface::get_default_font (ligature)->find_by_name
- // ("noteheads.s-2mensural").extent (Y_AXIS).length ()
- }
- prev_primitive->set_property ("join-right-amount",
- scm_int2num (delta_pitch));
- // perhaps set add-join as well
- }
- at_beginning = false;
- prev_primitive = primitive;
- prev_pitch = pitch;
- // apply_transition replacement ends
- }
+ bool general_case = true;
+ bool make_flexa = false;
+ bool allow_flexa = true;
+
+ // first check special cases
+ // 1. beginning
+ if (at_beginning)
+ {
+ // a. semibreves
+ if (duration_log == 0)
+ {
+ prim = MLP_UP | MLP_BREVIS;
+ general_case = false;
+ }
+ // b. descendens longa or brevis
+ else if (i < s - 1
+ && (unsmob_pitch (primitives[i + 1].event_cause ()
+ ->get_property ("pitch"))->steps () < pitch)
+ && duration_log > -3)
+ {
+ int left_stem = duration_log == -1 ? MLP_DOWN : 0;
+ prim = left_stem | MLP_BREVIS;
+ general_case = false;
+ }
+ }
+ // 2. initial semibrevis must be followed by another one
+ else if (prev_semibrevis)
+ {
+ prev_semibrevis = false;
+ if (duration_log == 0)
+ {
+ prim = MLP_BREVIS;
+ general_case = false;
+ }
+ else
+ {
+ nr->origin ()->warning
+ (_ ("semibrevis must be followed by another one -> skipping"));
+ prim = MLP_NONE;
+ at_beginning = true;
+ continue;
+ }
+ }
+ // 3. semibreves are otherwise not allowed
+ else if (duration_log == 0)
+ {
+ nr->origin ()->warning
+ (_ ("semibreves can only appear at the beginning of a ligature,\n"
+ "and there may be only zero or two of them"));
+ prim = MLP_NONE;
+ at_beginning = true;
+ continue;
+ }
+ // 4. end, descendens
+ else if (i == s - 1 && pitch < prev_pitch)
+ {
+ // brevis; previous note must be turned into flexa
+ if (duration_log == -1)
+ {
+ if (prev_brevis_shape)
+ {
+ make_flexa = true;
+ general_case = false;
+ }
+ else
+ {
+ nr->origin ()->warning
+ (_ ("invalid ligatura ending:\n"
+ "when the last note is a descending brevis,\n"
+ "the penultimate note must be another one,\n"
+ "or the ligatura must be LB or SSB"));
+ prim = MLP_NONE;
+ break;
+ }
+ }
+ // longa
+ else if (duration_log == -2)
+ {
+ prim = MLP_BREVIS;
+ general_case = allow_flexa = false;
+ }
+ // else maxima; fall through to regular case below
+ }
+
+ if (allow_flexa
+ && to_boolean (primitive->get_property ("ligature-flexa")))
+ {
+ /*
+ flexa requested, check whether allowed:
+ - there should be a previous note
+ - both of the notes must be of brevis shape
+ (i.e. can't be maxima or flexa;
+ longa is forbidden as well - it's nonexistent anyway)
+ - no compulsory flexa for the next note,
+ i.e. it's not an ultimate descending breve
+ */
+ make_flexa = !at_beginning && prev_brevis_shape && duration_log > -2;
+ if (make_flexa && i == s - 2)
+ {
+ /*
+ check last condition: look ahead to next note
+ */
+ Grob_info next_info = primitives[i + 1];
+ Item *next_primitive = dynamic_cast<Item *> (next_info.grob ());
+ if (Rhythmic_head::duration_log (next_primitive) == -1)
+ {
+ /*
+ breve: check whether descending
+ */
+ int const next_pitch = unsmob_pitch
+ (next_info.event_cause ()->get_property ("pitch"))->steps ();
+ if (next_pitch < pitch)
+ /*
+ sorry, forbidden
+ */
+ make_flexa = false;
+ }
+ }
+ }
+
+ if (general_case)
+ {
+ static int const shape[3] = {MLP_MAXIMA, MLP_LONGA, MLP_BREVIS};
+
+ prim = shape[duration_log + 3];
+ }
+
+ if (make_flexa)
+ {
+ /*
+ turn the note with the previous one into a flexa
+ */
+ prev_primitive->set_property
+ ("primitive",
+ scm_from_int
+ (MLP_FLEXA_BEGIN
+ | (scm_to_int (prev_primitive->get_property ("primitive"))
+ & MLP_STEM)));
+ prev_primitive->set_property
+ ("flexa-interval", scm_from_int (pitch - prev_pitch));
+ prim = MLP_FLEXA_END;
+ primitive->set_property
+ ("flexa-interval", scm_from_int (pitch - prev_pitch));
+ }
+
+ // join_primitives replacement
+ if (!(at_beginning || make_flexa))
+ prev_primitive->set_property ("add-join", ly_bool2scm (true));
+
+ at_beginning = false;
+ prev_primitive = primitive;
+ prev_pitch = pitch;
+ primitive->set_property ("primitive", scm_from_int (prim));
+ prev_brevis_shape = (prim & MLP_BREVIS) != 0;
+ prev_semibrevis = (prim & MLP_UP) != 0;
+ }
}
/*
*/
void
Mensural_ligature_engraver::propagate_properties (Spanner *ligature,
- Array<Grob_info> primitives)
+ vector<Grob_info> primitives)
{
- Real thickness =
- robust_scm2double (ligature->get_property ("thickness"), 1.4);
- thickness *=
- ligature->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
-
- Real head_width =
- Font_interface::get_default_font (ligature)->
- find_by_name ("noteheads.s-1mensural").extent (X_AXIS).length ();
- Real flexa_width =
- robust_scm2double (ligature->get_property ("flexa-width"), 2);
- Real maxima_head_width =
- Font_interface::get_default_font (ligature)->
- find_by_name ("noteheads.s-1neomensural").extent (X_AXIS).length ();
-
- flexa_width *= Staff_symbol_referencer::staff_space (ligature);
+ Real thickness
+ = robust_scm2double (ligature->get_property ("thickness"), 1.4);
+ thickness
+ *= ligature->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+
+ Real head_width
+ = Font_interface::get_default_font (ligature)->
+ find_by_name ("noteheads.sM1mensural").extent (X_AXIS).length ();
+ Real maxima_head_width
+ = Font_interface::get_default_font (ligature)->
+ find_by_name ("noteheads.sM3ligmensural").extent (X_AXIS).length ();
- Real half_flexa_width = 0.5 * (flexa_width + thickness);
-
- for (int i = 0; i < primitives.size (); i++)
+ Item *prev_primitive = NULL;
+ for (vsize i = 0; i < primitives.size (); i++)
{
- Item *primitive = dynamic_cast<Item*> (primitives[i].grob_);
+ Item *primitive = dynamic_cast<Item *> (primitives[i].grob ());
int output = scm_to_int (primitive->get_property ("primitive"));
primitive->set_property ("thickness",
- scm_make_real (thickness));
+ scm_from_double (thickness));
switch (output & MLP_ANY) {
- case MLP_NONE:
- primitive->set_property ("head-width",
- scm_make_real (half_flexa_width));
- break;
case MLP_BREVIS:
case MLP_LONGA:
- primitive->set_property ("head-width",
- scm_make_real (head_width));
+ primitive->set_property ("head-width", scm_from_double (head_width));
break;
case MLP_MAXIMA:
primitive->set_property ("head-width",
- scm_make_real (maxima_head_width));
+ scm_from_double (maxima_head_width));
break;
- case MLP_FLEXA:
- primitive->set_property ("head-width",
- scm_make_real (half_flexa_width));
- primitive->set_property ("flexa-width",
- scm_make_real (flexa_width));
+ case MLP_FLEXA_BEGIN:
+ /*
+ the next note (should be MLP_FLEXA_END) will handle this one
+ */
+ break;
+ case MLP_FLEXA_END:
+ {
+ SCM flexa_scm = primitive->get_property ("flexa-width");
+ Real const flexa_width = robust_scm2double (flexa_scm, 2.0);
+ SCM head_width = scm_from_double (0.5 * (flexa_width + thickness));
+ primitive->set_property ("head-width", head_width);
+ prev_primitive->set_property ("head-width", head_width);
+ prev_primitive->set_property ("flexa-width", flexa_scm);
+ }
break;
default:
- programming_error (_f ("unexpected case fall-through"));
+ programming_error (_ ("unexpected case fall-through"));
break;
}
+
+ prev_primitive = primitive;
}
}
void
-Mensural_ligature_engraver::fold_up_primitives (Array<Grob_info> primitives)
+Mensural_ligature_engraver::fold_up_primitives (vector<Grob_info> primitives)
{
Item *first = 0;
- Real distance = 0;
- for (int i = 0; i < primitives.size (); i++)
+ Real distance = 0.0;
+ Real staff_space = 0.0;
+ Real thickness = 0.0;
+
+ for (vsize i = 0; i < primitives.size (); i++)
{
- Item *current = dynamic_cast<Item*> (primitives[i].grob_);
+ Item *current = dynamic_cast<Item *> (primitives[i].grob ());
if (i == 0)
{
first = current;
+ staff_space = Staff_symbol_referencer::staff_space (first);
+ thickness = scm_to_double (current->get_property ("thickness"));
}
- get_set_column (current, first->get_column ());
+ move_related_items_to_column (current, first->get_column (),
+ distance);
+
+ Real head_width = scm_to_double (current->get_property ("head-width"));
+ distance += head_width - thickness;
- if (i > 0)
+ if (Rhythmic_head::dot_count (current) > 0)
+ /*
+ Move dots above/behind the ligature.
+ dots should also avoid staff lines.
+ */
{
- current->translate_axis (distance, X_AXIS);
+ Grob *dot_gr = Rhythmic_head::get_dots (current);
+
+ bool const on_line = Staff_symbol_referencer::on_line
+ (current,
+ robust_scm2int (current->get_property ("staff-position"), 0));
+ Real vert_shift = on_line ? staff_space * 0.5 : 0.0;
+ bool const flexa_begin =
+ scm_to_int (current->get_property ("primitive"))
+ & MLP_FLEXA_BEGIN;
+
+ if (i + 1 < primitives.size ())
+ /*
+ dot in the midst => avoid next note;
+ what to avoid and where depends on
+ being on a line or between lines
+ */
+ {
+ int const delta =
+ scm_to_int (current->get_property ("delta-position"));
+ if (flexa_begin)
+ vert_shift += delta < 0
+ ? staff_space : (on_line ? -2.0 : -1.0) * staff_space;
+ else if (on_line)
+ {
+ if (0 < delta && delta < 3)
+ vert_shift -= staff_space;
+ }
+ else if (delta == 1 || delta == -1)
+ vert_shift -= delta * staff_space;
+ }
+
+ dot_gr->translate_axis (vert_shift, Y_AXIS);
+
+ /*
+ move all dots behind head
+ */
+ dot_gr->translate_axis
+ ((flexa_begin ? staff_space * 0.6 : head_width) - 2.0*thickness, X_AXIS);
}
-
- distance +=
- scm_to_double (current->get_property ("head-width")) -
- scm_to_double (current->get_property ("thickness"));
}
}
void
Mensural_ligature_engraver::build_ligature (Spanner *ligature,
- Array<Grob_info> primitives)
+ vector<Grob_info> primitives)
{
transform_heads (primitives);
propagate_properties (ligature, primitives);
fold_up_primitives (primitives);
}
+ADD_ACKNOWLEDGER (Mensural_ligature_engraver, rest);
+ADD_ACKNOWLEDGER (Mensural_ligature_engraver, ligature_head);
+
ADD_TRANSLATOR (Mensural_ligature_engraver,
-/* descr */ "Handles Mensural_ligature_events by glueing special ligature heads together.",
-/* creats*/ "MensuralLigature",
-/* accepts */ "ligature-event",
-/* acks */ "note-head-interface rest-interface",
-/* reads */ "",
-/* write */ "");
+ /* doc */
+ "Handle @code{Mensural_ligature_events} by glueing special"
+ " ligature heads together.",
+
+ /* create */
+ "MensuralLigature ",
+
+ /* read */
+ "",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff