/*
- tie.cc -- implement Tie
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ 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 "tie.hh"
-#include <math.h>
-
-#include "spanner.hh"
+#include "main.hh"
+#include "bezier.hh"
+#include "directional-element-interface.hh"
+#include "font-interface.hh"
+#include "grob-array.hh"
#include "lookup.hh"
+#include "note-head.hh"
#include "output-def.hh"
-#include "rhythmic-head.hh"
-#include "bezier.hh"
#include "paper-column.hh"
-#include "warn.hh"
+#include "pointer-group-interface.hh"
+#include "rhythmic-head.hh"
+#include "semi-tie.hh"
+#include "spanner.hh"
#include "staff-symbol-referencer.hh"
-#include "directional-element-interface.hh"
-#include "bezier.hh"
#include "stem.hh"
-#include "note-head.hh"
+#include "text-interface.hh"
#include "tie-column.hh"
+#include "tie-configuration.hh"
+#include "tie-formatting-problem.hh"
+#include "warn.hh"
+#include "semi-tie-column.hh"
-/*
- tie: Connect two noteheads.
-
- What if we have
-
- c4 ~ \clef bass ; c4 or
+bool
+Tie::less (Grob *g1, Grob *g2)
+{
+ Spanner *s1 = dynamic_cast<Spanner *> (g1);
+ if (!s1)
+ {
+ g1->programming_error ("grob is not a tie");
+ return false;
+ }
- c4 \staffchange c4
+ Spanner *s2 = dynamic_cast<Spanner *> (g2);
+ if (!s2)
+ {
+ g2->programming_error ("grob is not a tie");
+ return true;
+ }
- do we have non-horizontal ties then?
-*/
+ return get_position (s1) < get_position (s2);
+}
void
-Tie::set_head (Grob *me, Direction d, Grob *h)
+Tie::set_head (Spanner *me, Direction d, Grob *h)
{
- assert (!head (me, d));
- index_set_cell (me->get_property ("head-pair"), d, h->self_scm ());
-
- dynamic_cast<Spanner *> (me)->set_bound (d, h);
- me->add_dependency (h);
+ me->set_bound (d, h);
}
-void
-Tie::set_interface (Grob *me)
+Item *
+Tie::head (Spanner *me, Direction d)
{
- me->set_property ("head-pair", scm_cons (SCM_EOL, SCM_EOL));
+ Item *it = me->get_bound (d);
+ return has_interface<Note_head> (it) ? it : 0;
}
-Grob *
-Tie::head (Grob *me, Direction d)
+int
+Tie::get_column_rank (Spanner *me, Direction d)
{
- SCM c = me->get_property ("head-pair");
-
- if (scm_is_pair (c))
- return unsmob_grob (index_get_cell (c, d));
- else
- return 0;
+ return Paper_column::get_rank (me->get_bound (d)->get_column ());
}
int
-Tie::get_column_rank (Grob *me, Direction d)
+Tie::get_position (Spanner *me)
{
- Spanner *span = dynamic_cast<Spanner *> (me);
- Grob *h = head (me, d);
- if (!h)
- h = span->get_bound (d);
+ for (LEFT_and_RIGHT (d))
+ {
+ Grob *h = head (me, d);
+ if (h)
+ return (int) rint (Staff_symbol_referencer::get_position (h));
+ }
- Grob *col = dynamic_cast<Item *> (h)->get_column ();
- return Paper_column::get_rank (col);
-}
+ /*
+ TODO: this is theoretically possible for ties across more than 2
+ systems.. We should look at the first broken copy.
-Real
-Tie::get_position (Grob *me)
-{
- Direction d = head (me, LEFT) ? LEFT : RIGHT;
- return Staff_symbol_referencer::get_position (head (me, d));
+ */
+ programming_error ("Tie without heads. Suicide");
+ me->suicide ();
+ return 0;
}
/*
(what about linebreaks? )
*/
Direction
-Tie::get_default_dir (Grob *me)
+Tie::get_default_dir (Spanner *me)
{
- Item *sl = head (me, LEFT) ? Rhythmic_head::get_stem (head (me, LEFT)) : 0;
- Item *sr = head (me, RIGHT) ? Rhythmic_head::get_stem (head (me, RIGHT)) : 0;
- if (sl && sr)
+ Drul_array<Grob *> stems;
+ for (LEFT_and_RIGHT (d))
{
- if (get_grob_direction (sl) == UP
- && get_grob_direction (sr) == UP)
- return DOWN;
+ Grob *one_head = head (me, d);
+ if (!one_head)
+ one_head = head (me->broken_neighbor (d), d);
+
+ Grob *stem = one_head ? Rhythmic_head::get_stem (one_head) : 0;
+ stems[d] = (stem && !Stem::is_invisible (stem)) ? stem : 0;
}
- else if (sl || sr)
+
+ if (stems[LEFT] && stems[RIGHT])
{
- Item *s = sl ? sl : sr;
- return -get_grob_direction (s);
- }
+ if (get_grob_direction (stems[LEFT]) == UP
+ && get_grob_direction (stems[RIGHT]) == UP)
+ return DOWN;
- return UP;
-}
+ // And why not return UP if both stems are DOWN?
-void
-Tie::set_direction (Grob *me)
-{
- if (!get_grob_direction (me))
- {
- if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
- Tie_column::set_directions (me->get_parent (Y_AXIS));
- else
- set_grob_direction (me, Tie::get_default_dir (me));
+ // And when stems conflict, why fall directly through to using
+ // neutral-direction without considering get_position (me)?
}
+ else if (stems[LEFT])
+ return -get_grob_direction (stems[LEFT]);
+ else if (stems[RIGHT])
+ return -get_grob_direction (stems[RIGHT]);
+ else if (int p = get_position (me))
+ return Direction (sign (p));
+
+ return to_dir (me->get_property ("neutral-direction"));
}
-/*
- TODO: we should also use thickness for computing the clearance
- between head and tie. Very thick ties will now touch the note head.
-*/
+MAKE_SCHEME_CALLBACK (Tie, calc_direction, 1);
SCM
-Tie::get_control_points (SCM smob)
+Tie::calc_direction (SCM smob)
{
- Spanner *me = unsmob_spanner (smob);
- Direction headdir = CENTER;
- if (head (me, LEFT))
- headdir = LEFT;
- else if (head (me, RIGHT))
- headdir = RIGHT;
- else
- {
- programming_error ("tie without heads");
- me->suicide ();
- return SCM_EOL;
- }
-
- set_direction (me);
-
- Direction dir = get_grob_direction (me);
-
- Real staff_space = Staff_symbol_referencer::staff_space (me);
-
- Real x_gap_f = robust_scm2double (me->get_property ("x-gap"), 0);
-
- Grob *l = me->get_bound (LEFT);
- Grob *r = me->get_bound (RIGHT);
-
- Grob *commonx = me->common_refpoint (l, X_AXIS);
- commonx = me->common_refpoint (r, X_AXIS);
-
- Real left_x;
-
- /*
- the tie has to be long enough to be visible, but should not go
- through key sigs. In the 1.5 series the pref.matter - note
- distance is fixed , so this won't be a problem anymore.
- */
- Real lambda = 0.9;
-
- if (Note_head::has_interface (l))
+ // In this method, Tie and Semi_tie require the same logic with different
+ // types. It might be clearer to use a template.
+ Grob *me = unsmob<Grob> (smob);
+ Grob *yparent = me->get_parent (Y_AXIS);
+ if ((has_interface<Tie_column> (yparent)
+ || has_interface<Semi_tie_column> (yparent))
+ && unsmob<Grob_array> (yparent->get_object ("ties"))
+ // && unsmob<Grob_array> (yparent->get_object ("ties"))->size () > 1
+ )
{
- Real where = RIGHT;
+ /* trigger positioning. */
+ (void) yparent->get_property ("positioning-done");
- /*
- This correction is due te the shape of the black note head.
- */
- if (Rhythmic_head::duration_log (l) == 2)
- where += dir * 0.2;
- left_x = l->extent (l, X_AXIS).linear_combination (where)
- + x_gap_f;
- }
- else
- left_x = l->extent (l, X_AXIS).linear_combination (lambda);
-
- Real width;
- if (Note_head::has_interface (l) && Note_head::has_interface (r))
- {
- width
- = + r->extent (commonx, X_AXIS)[LEFT]
- - l->extent (commonx, X_AXIS)[RIGHT]
- -2 * x_gap_f;
- }
- else
- {
- if (Note_head::has_interface (l))
- width = r->relative_coordinate (commonx, X_AXIS)
- - l->extent (commonx, X_AXIS)[RIGHT]
- - 2 * x_gap_f;
- else
- width
- = -l->extent (commonx, X_AXIS).linear_combination (lambda)
- + r->extent (commonx, X_AXIS)[LEFT]
- - 2 * x_gap_f;
+ return me->get_property_data ("direction");
}
- SCM details = me->get_property ("details");
-
- SCM lim // groetjes aan de chirurgendochter.
- = scm_assq (ly_symbol2scm ("height-limit"), details);
+ programming_error ("no Tie_column or Semi_tie_column. Killing grob.");
+ me->suicide ();
+ return scm_from_int (CENTER);
+}
- Real h_inf = scm_to_double (scm_cdr (lim)) * staff_space;
- Real r_0 = scm_to_double (scm_cdr (scm_assq (ly_symbol2scm ("ratio"), details)));
+SCM
+Tie::get_default_control_points (Spanner *me)
+{
+ Grob *common = me;
+ common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
+ common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
- Bezier b = slur_shape (width, h_inf, r_0);
+ Tie_formatting_problem problem;
+ problem.from_tie (me);
- /*
- I think this better, particularly for small ties. It always allows the user to move ties if
- they seem in the wrong place
+ if (!me->is_live ())
+ return SCM_EOL;
- TODO: what if 2 heads have different size.
+ Ties_configuration conf
+ = problem.generate_optimal_configuration ();
- */
+ return get_control_points (me, problem.common_x_refpoint (),
+ conf[0], problem.details_);
+}
- Real ypos = Tie::get_position (me) * staff_space / 2
- + dir * scm_to_double (me->get_property ("y-offset"));;
+SCM
+Tie::get_control_points (Grob *me,
+ Grob *common,
+ Tie_configuration const &conf,
+ Tie_details const &details)
+{
+ Bezier b = conf.get_transformed_bezier (details);
+ b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
- /*
- Make sure we don't start on a dots
- */
- if (Note_head::has_interface (l) && Rhythmic_head::get_dots (l))
+ SCM controls = SCM_EOL;
+ for (int i = 4; i--;)
{
- Grob *dots = Rhythmic_head::get_dots (l);
- if (fabs (staff_space * Staff_symbol_referencer::get_position (dots) / 2
- - ypos) < 0.5)
- ypos += 0.5 * dir;
+ if (!b.control_[i].is_sane ())
+ programming_error ("Insane offset");
+ controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
}
+ return controls;
+}
- /*
- todo: prevent ending / staffline collision.
-
- todo: tie / stem collision
- */
-
- b = slur_shape (width, h_inf, r_0);
- b.scale (1, dir);
- b.translate (Offset (left_x, ypos));
-
- /*
- Avoid colliding of the horizontal part with stafflines.
-
-
- TODO: redo this, heuristic is half-baken, and ties often look ugly
- as a result.
+MAKE_SCHEME_CALLBACK (Tie, calc_control_points, 1);
+SCM
+Tie::calc_control_points (SCM smob)
+{
+ Spanner *me = LY_ASSERT_SMOB(Spanner, smob, 1);
- TODO: doesn't work when on staff with even number of lines.
- */
- Array<Real> horizontal (b.solve_derivative (Offset (1, 0)));
- if (horizontal.size ())
+ Grob *yparent = me->get_parent (Y_AXIS);
+ if ((has_interface<Tie_column> (yparent)
+ || has_interface<Semi_tie_column> (yparent))
+ && unsmob<Grob_array> (yparent->get_object ("ties")))
{
- /*
- ugh. Doesnt work for non-horizontal curves.
- */
- Real y = b.curve_point (horizontal[0])[Y_AXIS];
-
- Real ry = rint (y / staff_space) * staff_space;
- Real diff = ry - y;
- Real newy = y;
-
- Real clear = staff_space * scm_to_double (me->get_property ("staffline-clearance"));
-
- if (fabs (y)
- <= Staff_symbol_referencer::staff_radius (me) * staff_space + clear
- && fabs (diff) < clear)
- {
- Real y1 = ry + clear;
- Real y2 = ry - clear;
-
- /*
- ugh, we shove the 0.5 out of our sleeves.
-
- Any way. This test is to make sure that staffline
- collision avoidance does not result in completely flat
- ties.
- */
- if (fabs (y1 - ypos) < 0.5)
- y1 = y2;
- else if (fabs (y2 - ypos) < 0.5)
- y2 = y1;
-
- newy = (fabs (y1 - y) < fabs (y2 - y)) ? y1 : y2;
-
- // newy = ry - 0.5 * staff_space * sign (diff) ;
-
- /*
- we don't want horizontal ties
- */
- if (fabs (newy - b.control_[0][Y_AXIS]) < 1e-2)
- newy = newy + dir * staff_space;
- }
-
- Real y0 = b.control_ [0][Y_AXIS];
- b.control_[2][Y_AXIS]
- = b.control_[1][Y_AXIS]
- = (b.control_[1][Y_AXIS] - y0) * ((newy - y0) / (y - y0)) + y0;
+ extract_grob_set (yparent, "ties", ties);
+ if (me->original () && ties.size () == 1
+ && !to_dir (me->get_property_data ("direction")))
+ {
+ assert (ties[0] == me);
+ set_grob_direction (me, Tie::get_default_dir (me));
+ }
+ /* trigger positioning. */
+ (void) yparent->get_property ("positioning-done");
}
- else
- programming_error ("tie is nowhere horizontal");
- SCM controls = SCM_EOL;
- for (int i = 4; i--;)
- controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
- return controls;
+ SCM cp = me->get_property_data ("control-points");
+ if (!scm_is_pair (cp))
+ cp = get_default_control_points (me);
+
+ return cp;
}
+/*
+ TODO: merge with Slur::print.
+*/
MAKE_SCHEME_CALLBACK (Tie, print, 1);
SCM
Tie::print (SCM smob)
{
- Grob *me = unsmob_grob (smob);
+ Grob *me = unsmob<Grob> (smob);
SCM cp = me->get_property ("control-points");
- if (!scm_is_pair (cp)) // list is more accurate
- {
- cp = get_control_points (smob);
- me->set_property ("control-points", cp);
- }
-
- if (!scm_is_pair (cp))
- return Stencil ().smobbed_copy ();
Real staff_thick = Staff_symbol_referencer::line_thickness (me);
- Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
- Real thick = base_thick * staff_thick;
+ Real base_thick = staff_thick * robust_scm2double (me->get_property ("thickness"), 1);
+ Real line_thick = staff_thick * robust_scm2double (me->get_property ("line-thickness"), 1);
Bezier b;
int i = 0;
- for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
+ for (SCM s = cp; scm_is_pair (s); s = scm_cdr (s))
{
b.control_[i] = ly_scm2offset (scm_car (s));
i++;
Stencil a;
- SCM p = me->get_property ("dash-period");
- SCM f = me->get_property ("dash-fraction");
- if (scm_is_number (p) && scm_is_number (f))
- a = Lookup::dashed_slur (b,
- thick,
- robust_scm2double (p, 1.0),
- robust_scm2double (f, 0));
- else
- a = Lookup::slur (b,
- get_grob_direction (me) * staff_thick,
- thick);
+ SCM dash_definition = me->get_property ("dash-definition");
+ a = Lookup::slur (b,
+ get_grob_direction (me) * base_thick,
+ line_thick,
+ dash_definition);
+
+#if DEBUG_TIE_SCORING
+ SCM annotation = me->get_property ("annotation");
+ if (scm_is_string (annotation))
+ {
+ string str;
+ SCM properties = Font_interface::text_font_alist_chain (me);
+
+ Stencil tm = *unsmob<Stencil> (Text_interface::interpret_markup
+ (me->layout ()->self_scm (), properties,
+ annotation));
+ tm.translate (Offset (b.control_[3][X_AXIS] + 0.5,
+ b.control_[0][Y_AXIS] * 2));
+ tm = tm.in_color (1, 0, 0);
+
+ /*
+ It would be nice if we could put this in a different layer,
+ but alas, this must be done with a Tie override.
+ */
+ a.add_stencil (tm);
+ }
+#endif
return a.smobbed_copy ();
}
ADD_INTERFACE (Tie,
- "tie-interface",
- "A tie connecting two noteheads.\n",
-
- "y-offset dash-period dash-fraction "
- "staffline-clearance control-points head-pair "
- "details thickness x-gap direction minimum-length");
+ "A tie - a horizontal curve connecting two noteheads.\n"
+ "\n"
+ "The following properties may be set in the @code{details}"
+ " list.\n"
+ "\n"
+ "@table @code\n"
+ "@item height-limit\n"
+ "The maximum height allowed for this tie.\n"
+ "@item ratio\n"
+ "Parameter for tie shape. The higher this number, the"
+ " quicker the slur attains its height-limit.\n"
+ "@item between-length-limit\n"
+ "This detail is currently unused.\n"
+ "@item wrong-direction-offset-penalty\n"
+ "Demerit for ties that are offset in the wrong"
+ " direction.\n"
+ "@item min-length\n"
+ "If the tie is shorter than this amount (in"
+ " staff-spaces) an increasingly large length penalty is"
+ " incurred.\n"
+ "@item min-length-penalty-factor\n"
+ "Demerit factor for tie lengths shorter than"
+ " @code{min-length}.\n"
+ "@item center-staff-line-clearance\n"
+ "If the center of the tie is closer to a staff line"
+ " than this amount, an increasingly large staff line"
+ " collision penalty is incurred.\n"
+ "@item tip-staff-line-clearance\n"
+ "If the tips of the tie are closer to a staff line"
+ " than this amount, an increasingly large staff line"
+ " collision penalty is incurred.\n"
+ "@item staff-line-collision-penalty\n"
+ "Demerit factor for ties whose tips or center come"
+ " close to staff lines.\n"
+ "@item dot-collision-clearance\n"
+ "If the tie comes closer to a dot than this amount, an"
+ " increasingly large dot collision penalty is incurred.\n"
+ "@item dot-collision-penalty\n"
+ "Demerit factor for ties which come close to dots.\n"
+ "@item note-head-gap\n"
+ "The distance (in staff-spaces) by which the ends of"
+ " the tie are offset horizontally from the center"
+ " line through the note head.\n"
+ "@item stem-gap\n"
+ "The distance (in staff-spaces) by which the ends of"
+ " the tie are offset horizontally from a stem which"
+ " is on the same side of the note head as the tie.\n"
+ "@item tie-column-monotonicity-penalty\n"
+ "Demerit if the y-position of this tie in the set of"
+ " ties being considered is less than the y-position"
+ " of the previous tie.\n"
+ "@item tie-tie-collision-distance\n"
+ "If this tie is closer than this amount to the previous"
+ " tie in the set being considered, an increasingly"
+ " large tie-tie collision penalty is incurred.\n"
+ "@item tie-tie-collision-penalty\n"
+ "Demerit factor for a tie in the set being considered"
+ " which is close to the previous one.\n"
+ "@item horizontal-distance-penalty-factor\n"
+ "Demerit factor for ties in the set being considered"
+ " which are horizontally distant from the note heads.\n"
+ "@item vertical-distance-penalty-factor\n"
+ "Demerit factor for ties in the set being considered"
+ " which are vertically distant from the note heads.\n"
+ "@item same-dir-as-stem-penalty\n"
+ "Demerit if tie is on the same side as a stem or on the"
+ " opposite side to the one specified.\n"
+ "@item intra-space-threshold\n"
+ "If the tie's height (in half staff-spaces) is less than"
+ " this it is positioned between two adjacent staff"
+ " lines; otherwise it is positioned to straddle a staff"
+ " line further from the note heads.\n"
+ "@item outer-tie-length-symmetry-penalty-factor\n"
+ "Demerit factor for ties horizontally positioned"
+ " unsymmetrically with respect to the two note heads.\n"
+ "@item outer-tie-vertical-distance-symmetry-penalty-factor\n"
+ "Demerit factor for ties vertically positioned"
+ " unsymmetrically with respect to the two note heads.\n"
+ "@item outer-tie-vertical-gap\n"
+ "Amount (in half staff-spaces) by which a tie is moved"
+ " away from the note heads if it is closer to either"
+ " of them than 0.25 half staff-spaces.\n"
+ "@item skyline-padding\n"
+ "Padding of the skylines around note heads in chords.\n"
+ "@item single-tie-region-size\n"
+ "The number of candidate ties to generate when only a"
+ " single tie is required. Successive candidates differ"
+ " in their initial vertical position by half a"
+ " staff-space.\n"
+ "@item multi-tie-region-size\n"
+ "The number of variations that are tried for the"
+ " extremal ties in a chord. Variations differ in their"
+ " initial vertical position by half a staff-space.\n"
+
+ "@end table\n",
+
+ /* properties */
+ "annotation "
+ "avoid-slur " // UGH.
+ "control-points "
+ "dash-definition "
+ "details "
+ "direction "
+ "head-direction "
+ "line-thickness "
+ "neutral-direction "
+ "staff-position "
+ "thickness "
+ );
projects / lilypond.git / blobdiff