2 slur.cc -- implement Slur
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 * should avoid stafflines with horizontal part.
13 * begin and end should be treated as a/acknowledge Scripts.
14 * smart changing of endings
15 * smart changing of (Y-?)offsets to avoid ugly beziers
19 #include "directional-element-interface.hh"
20 #include "group-interface.hh"
23 #include "paper-def.hh"
24 #include "note-column.hh"
26 #include "paper-column.hh"
27 #include "molecule.hh"
29 #include "slur-bezier-bow.hh"
31 #include "group-interface.hh"
32 #include "staff-symbol-referencer.hh"
37 Slur::set_interface (Grob*me)
39 /* Copy to mutable list. */
40 me->set_grob_property ("attachment",
41 ly_deep_copy (me->get_grob_property ("attachment")));
45 Slur::add_column (Grob*me, Grob*n)
47 if (!gh_pair_p (n->get_grob_property ("note-heads")))
48 warning (_ ("Putting slur over rest. Ignoring."));
51 Pointer_group_interface::add_element (me, "note-columns",n);
52 me->add_dependency (n);
55 add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (n));
59 Slur::de_uglyfy (Grob*me, Slur_bezier_bow* bb, Real default_height)
61 Real length = bb->curve_.control_[3][X_AXIS] ;
62 Real ff = bb->fit_factor ();
63 for (int i = 1; i < 3; i++)
65 Real ind = abs (bb->curve_.control_[ (i-1)*3][X_AXIS]
66 - bb->curve_.control_[i][X_AXIS]) / length;
67 Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
69 Real f = default_height / length;
70 SCM up = me->get_grob_property ("de-uglify-parameters");
72 Real c1 = gh_scm2double (ly_car (up));
73 Real c2 = gh_scm2double (ly_cadr (up));
74 Real c3 = gh_scm2double (ly_caddr (up));
80 else if (h > c2 + c3 * ind)
85 bb->curve_.control_[i][Y_AXIS] = h * length;
88 bb->curve_.assert_sanity ();
92 Slur::get_default_dir (Grob*me)
94 Link_array<Grob> encompass_arr =
95 Pointer_group_interface__extract_elements (me, (Grob*)0, "note-columns");
98 for (int i=0; i < encompass_arr.size (); i ++)
100 if (Note_column::dir (encompass_arr[i]) < 0)
110 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking,1);
112 Slur::after_line_breaking (SCM smob)
114 Grob *me = unsmob_grob (smob);
115 if (!scm_ilength (me->get_grob_property ("note-columns")))
118 return SCM_UNSPECIFIED;
120 set_extremities (me);
121 set_control_points (me);
122 return SCM_UNSPECIFIED;
127 Slur::check_slope (Grob *me)
130 Avoid too steep slurs.
132 SCM s = me->get_grob_property ("slope-limit");
135 Array<Offset> encompass = get_encompass_offset_arr (me);
136 Drul_array<Offset> attachment;
137 attachment[LEFT] = encompass[0];
138 attachment[RIGHT] = encompass.top ();
140 Real dx = attachment[RIGHT][X_AXIS] - attachment[LEFT][X_AXIS];
141 Real dy = attachment[RIGHT][Y_AXIS] - attachment[LEFT][Y_AXIS];
145 Real slope = slope = abs (dy / dx);
147 Real limit = gh_scm2double (s);
151 Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
152 Direction dir = (Direction)gh_scm2int (me->get_grob_property ("direction"));
153 Direction d = (Direction) (- dir * (sign (dy)));
154 SCM a = me->get_grob_property ("attachment-offset");
155 Drul_array<Offset> o;
156 o[LEFT] = ly_scm2offset (index_cell (a, LEFT));
157 o[RIGHT] = ly_scm2offset (index_cell (a, RIGHT));
158 o[d][Y_AXIS] -= (limit - slope) * dx * dir / staff_space;
160 o[d][Y_AXIS] *= Directional_element_interface::get (me);
162 me->set_grob_property ("attachment-offset",
163 gh_cons (ly_offset2scm (o[LEFT]),
164 ly_offset2scm (o[RIGHT])));
170 Slur::set_extremities (Grob *me)
172 if (!Directional_element_interface::get (me))
173 Directional_element_interface::set (me, get_default_dir (me));
175 Direction dir = LEFT;
178 SCM att = me->get_grob_property ("attachment");
181 if (!gh_pair_p (att))
183 programming_error ("attachment is not a cons?!");
184 att = gh_cons (SCM_EOL, SCM_EOL);
185 me->set_grob_property ("attachment", att);
188 if (!gh_symbol_p (index_cell (att, dir)))
190 for (SCM s = me->get_grob_property ("extremity-rules");
191 s != SCM_EOL; s = ly_cdr (s))
193 SCM r = gh_call2 (ly_caar (s), me->self_scm (),
194 gh_int2scm ((int)dir));
197 index_set_cell (att, dir,
204 while (flip (&dir) != LEFT);
211 Slur::get_first_notecolumn_y (Grob *me, Direction dir)
213 Grob *col = dir == LEFT
214 ? unsmob_grob (ly_car (scm_reverse (me->get_grob_property
217 (ly_car (me->get_grob_property ("note-columns")));
222 me->common_refpoint (col, Y_AXIS)
225 if (col == ((Spanner*)me)->get_bound (dir))
227 y = get_attachment (me, dir, common)[Y_AXIS];
231 y = encompass_offset (me, col, common)[Y_AXIS]
232 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
238 Slur::broken_trend_offset (Grob *me, Direction dir)
241 A broken slur should maintain the same vertical trend
242 the unbroken slur would have had.
245 if (Spanner *mother = dynamic_cast<Spanner*> (me->original_l_))
247 for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
248 dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
249 dir == LEFT ? i++ : i--)
251 if (mother->broken_into_l_arr_[i - dir] == me)
253 Grob *neighbour = mother->broken_into_l_arr_[i];
255 neighbour->set_grob_property ("direction",
256 me->get_grob_property ("direction"));
257 Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
258 Real y = get_first_notecolumn_y (me, -dir);
259 int neighbour_cols = scm_ilength (neighbour->get_grob_property ("note-columns"));
260 int cols = scm_ilength (me->get_grob_property ("note-columns"));
261 o = Offset (0, (y*neighbour_cols + neighbour_y*cols) /
262 (cols + neighbour_cols));
271 Slur::get_attachment (Grob *me, Direction dir,
274 SCM s = me->get_grob_property ("attachment");
275 if (!gh_symbol_p (index_cell (s, dir)))
277 set_extremities (me);
278 s = me->get_grob_property ("attachment");
280 SCM a = dir == LEFT ? ly_car (s) : ly_cdr (s);
281 Spanner*sp = dynamic_cast<Spanner*> (me);
282 String str = ly_symbol2string (a);
283 Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
284 Real hs = staff_space / 2.0;
288 if (Note_column::has_interface (sp->get_bound (dir)))
290 Grob * n =sp->get_bound (dir);
291 if ((stem = Note_column::stem_l (n)))
294 if (Grob *head = Note_column::first_head (n))
295 x_extent = head->extent (head, X_AXIS).length ();
297 x_extent = n->extent (n, X_AXIS).length ();
301 o = Offset (0, Stem::head_positions (stem)
302 [Directional_element_interface::get (me)] * hs);
304 Default position is centered in X, on outer side of head Y
306 o += Offset (0.5 * x_extent,
308 * Directional_element_interface::get (me));
310 else if (str == "alongside-stem")
312 o = Offset (0, Stem::chord_start_f (stem));
314 Default position is on stem X, on outer side of head Y
316 o += Offset (x_extent * (1 + Stem::get_direction (stem)),
318 * Directional_element_interface::get (me));
320 else if (str == "stem")
322 o = Offset (0, Stem::stem_end_position (stem) * hs);
324 Default position is on stem X, at stem end Y
327 x_extent * (1 + Stem::get_direction (stem)),
333 If we're not a note_column, we can't be anything but a loose-end.
334 But if user has set (attachment . (stem . stem)), our string is
337 Hmm, maybe after-line-breaking should set this to loose-end? */
338 else // if (str == "loose-end")
340 SCM other_a = dir == LEFT ? ly_cdr (s) : ly_car (s);
341 if (ly_symbol2string (other_a) != "loose-end")
342 o = broken_trend_offset (me, dir);
345 SCM alist = me->get_grob_property ("extremity-offset-alist");
346 int stemdir = stem ? Stem::get_direction (stem) : 1;
347 int slurdir = gh_scm2int (me->get_grob_property ("direction"));
350 gh_int2scm (stemdir * dir),
351 gh_int2scm (slurdir * dir),
352 SCM_UNDEFINED), alist);
356 Offset off = ly_scm2offset (ly_cdr (l)) * staff_space;
358 off[Y_AXIS] *= Directional_element_interface::get (me);
363 What if get_bound () is not a note-column?
365 if (str != "loose-end"
366 && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
368 o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
369 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
372 Offset off = ly_scm2offset (index_cell (me->get_grob_property
373 ("attachment-offset"),
376 off[Y_AXIS] *= Directional_element_interface::get (me);
382 Slur::encompass_offset (Grob*me,
387 Grob* stem_l = unsmob_grob (col->get_grob_property ("stem"));
389 Direction dir = Directional_element_interface::get (me);
393 warning (_ ("Slur over rest?"));
394 o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
395 o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
398 Direction stem_dir = Directional_element_interface::get (stem_l);
399 o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
402 Simply set x to middle of notehead
405 if (Grob *head = Note_column::first_head (col))
406 x_extent = head->extent (head, X_AXIS).length ();
408 x_extent = col->extent (col, X_AXIS).length ();
409 o[X_AXIS] -= 0.5 * stem_dir * x_extent;
411 if ((stem_dir == dir)
412 && !stem_l->extent (stem_l, Y_AXIS).empty_b ())
414 o[Y_AXIS] = stem_l->extent (common[Y_AXIS], Y_AXIS)[dir];
418 o[Y_AXIS] = col->extent (common[Y_AXIS], Y_AXIS)[dir];
422 leave a gap: slur mustn't touch head/stem
424 o[Y_AXIS] += dir * gh_scm2double (me->get_grob_property ("y-free")) *
430 Slur::get_encompass_offset_arr (Grob *me)
432 Spanner*sp = dynamic_cast<Spanner*> (me);
433 SCM eltlist = me->get_grob_property ("note-columns");
434 Grob *common[] = {me->common_refpoint (eltlist, X_AXIS),
435 me->common_refpoint (eltlist, Y_AXIS)};
438 common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
439 common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
441 Link_array<Grob> encompass_arr;
442 while (gh_pair_p (eltlist))
444 encompass_arr.push (unsmob_grob (ly_car (eltlist)));
445 eltlist =ly_cdr (eltlist);
447 encompass_arr.reverse ();
450 Array<Offset> offset_arr;
452 Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
453 me->relative_coordinate (common[Y_AXIS], Y_AXIS));
456 int last = encompass_arr.size () - 2;
458 offset_arr.push (get_attachment (me, LEFT, common));
464 if (encompass_arr[0] != sp->get_bound (LEFT))
469 offset_arr[0][Y_AXIS] -=
470 encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
471 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
477 if (encompass_arr.top () != sp->get_bound (RIGHT))
482 for (int i = first; i <= last; i++)
484 Offset o (encompass_offset (me, encompass_arr[i], common));
485 offset_arr.push (o - origin);
488 offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
490 if (encompass_arr[0] != sp->get_bound (LEFT))
492 offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
493 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
505 MAKE_SCHEME_CALLBACK (Slur, height, 2);
507 Slur::height (SCM smob, SCM ax)
509 Axis a = (Axis)gh_scm2int (ax);
510 Grob * me = unsmob_grob (smob);
511 assert (a == Y_AXIS);
513 SCM mol = me->get_uncached_molecule ();
514 return ly_interval2scm (unsmob_molecule (mol)->extent (a));
518 Ugh should have dash-length + dash-period
520 MAKE_SCHEME_CALLBACK (Slur, brew_molecule,1);
522 Slur::brew_molecule (SCM smob)
524 Grob * me = unsmob_grob (smob);
525 if (!scm_ilength (me->get_grob_property ("note-columns")))
531 Real thick = me->paper_l ()->get_var ("stafflinethickness") *
532 gh_scm2double (me->get_grob_property ("thickness"));
533 Bezier one = get_curve (me);
535 // get_curve may suicide
536 if (!scm_ilength (me->get_grob_property ("note-columns")))
540 SCM d = me->get_grob_property ("dashed");
542 a = Lookup::dashed_slur (one, thick, thick * gh_scm2double (d));
544 a = Lookup::slur (one, Directional_element_interface::get (me) * thick, thick);
546 return a.smobbed_copy ();
550 Slur::set_control_points (Grob*me)
552 Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
554 SCM details = me->get_grob_property ("details");
555 SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
556 SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
558 Real r_0 = gh_scm2double (ly_cdr (r_0_scm));
559 Real h_inf = staff_space * gh_scm2double (ly_cdr (h_inf_scm));
561 Slur_bezier_bow bb (get_encompass_offset_arr (me),
562 Directional_element_interface::get (me),
565 if (bb.fit_factor () > 1.0)
567 Real length = bb.curve_.control_[3][X_AXIS];
568 Real default_height = slur_height (length, h_inf, r_0);
570 SCM ssb = me->get_grob_property ("beautiful");
572 if (gh_number_p (ssb))
573 sb = gh_scm2double (ssb);
575 bb.minimise_enclosed_area (sb, details);
576 SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details);
578 if (gh_pair_p (sbf) && gh_number_p (ly_cdr (sbf)))
579 bff = gh_scm2double (ly_cdr (sbf));
581 bb.curve_.control_[1][Y_AXIS] *= bff;
582 bb.curve_.control_[2][Y_AXIS] *= bff;
586 Real beautiful = length * default_height * sb;
587 Real area = bb.enclosed_area_f ();
590 Slurs that fit beautifully are not ugly
592 if (area > beautiful)
593 de_uglyfy (me, &bb, default_height);
596 Bezier b = bb.get_bezier ();
599 SCM controls = SCM_EOL;
602 controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
605 All these null control-points, where do they all come from?
607 if (i && b.control_[i][X_AXIS] == 0)
614 me->set_grob_property ("control-points", controls);
618 Slur::get_curve (Grob*me)
623 if (!Directional_element_interface::get (me)
624 || ! gh_symbol_p (index_cell (me->get_grob_property ("attachment"), LEFT))
625 || ! gh_symbol_p (index_cell (me->get_grob_property ("attachment"), RIGHT)))
626 set_extremities (me);
628 if (!gh_pair_p (me->get_grob_property ("control-points")))
629 set_control_points (me);
631 // set_control_points may suicide
632 if (!scm_ilength (me->get_grob_property ("note-columns")))
635 for (SCM s= me->get_grob_property ("control-points"); s != SCM_EOL; s = ly_cdr (s))
637 b.control_[i] = ly_scm2offset (ly_car (s));
641 Array<Offset> enc (get_encompass_offset_arr (me));
642 Direction dir = Directional_element_interface::get (me);
644 Real x1 = enc[0][X_AXIS];
645 Real x2 = enc.top ()[X_AXIS];
648 for (int i=1; i < enc.size ()-1; i++)
650 Real x = enc[i][X_AXIS];
653 Real y = b.get_other_coordinate (X_AXIS, x);
654 off = off >? dir * (enc[i][Y_AXIS] - y);
657 b.translate (Offset (0, dir * off));
663 Slur::has_interface (Grob*me)
665 return me->has_interface (ly_symbol2scm ("slur-interface"));