2 slur.cc -- implement Slur
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 * fix broken interstaff slurs
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 (Score_element*me)
39 me->set_elt_property ("attachment", gh_cons (SCM_BOOL_F, SCM_BOOL_F));
40 me->set_interface (ly_symbol2scm ("slur-interface"));
44 Slur::add_column (Score_element*me, Score_element*n)
46 if (!gh_pair_p (n->get_elt_property ("note-heads")))
47 warning (_ ("Putting slur over rest. Ignoring."));
50 Pointer_group_interface::add_element (me, "note-columns",n);
51 me->add_dependency (n);
54 add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*>(n));
58 Slur::de_uglyfy (Score_element*me, Slur_bezier_bow* bb, Real default_height)
60 Real length = bb->curve_.control_[3][X_AXIS] ;
61 Real ff = bb->fit_factor ();
62 for (int i = 1; i < 3; i++)
64 Real ind = abs (bb->curve_.control_[(i-1)*3][X_AXIS]
65 - bb->curve_.control_[i][X_AXIS]) / length;
66 Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
68 Real f = default_height / length;
69 SCM up = me->get_elt_property ("de-uglify-parameters");
71 Real c1 = gh_scm2double (gh_car (up));
72 Real c2 = gh_scm2double (gh_cadr (up));
73 Real c3 = gh_scm2double (gh_caddr (up));
79 else if (h > c2 + c3 * ind)
84 bb->curve_.control_[i][Y_AXIS] = h * length;
87 bb->curve_.assert_sanity ();
91 Slur::get_default_dir (Score_element*me)
93 Link_array<Score_element> encompass_arr =
94 Pointer_group_interface__extract_elements (me, (Score_element*)0, "note-columns");
97 for (int i=0; i < encompass_arr.size (); i ++)
99 if (Note_column::dir (encompass_arr[i]) < 0)
109 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking,1);
111 Slur::after_line_breaking (SCM smob)
113 Score_element *me = unsmob_element (smob);
114 if (!scm_ilength (me->get_elt_property ("note-columns")))
117 return SCM_UNSPECIFIED;
119 set_extremities (me);
120 set_control_points (me);
121 return SCM_UNSPECIFIED;
126 Slur::check_slope (Score_element *me)
129 Avoid too steep slurs.
131 SCM s = me->get_elt_property ("slope-limit");
134 Array<Offset> encompass = get_encompass_offset_arr (me);
135 Drul_array<Offset> attachment;
136 attachment[LEFT] = encompass[0];
137 attachment[RIGHT] = encompass.top ();
139 Real dx = attachment[RIGHT][X_AXIS] - attachment[LEFT][X_AXIS];
140 Real dy = attachment[RIGHT][Y_AXIS] - attachment[LEFT][Y_AXIS];
144 Real slope = slope = abs (dy / dx);
146 Real limit = gh_scm2double (s);
150 Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me);
151 Direction dir = (Direction)gh_scm2int (me->get_elt_property ("direction"));
152 Direction d = (Direction)(- dir * (sign (dy)));
153 SCM a = me->get_elt_property ("attachment-offset");
154 Drul_array<Offset> o;
155 o[LEFT] = ly_scm2offset (index_cell (a, LEFT));
156 o[RIGHT] = ly_scm2offset (index_cell (a, RIGHT));
157 o[d][Y_AXIS] -= (limit - slope) * dx * dir / staff_space;
158 //o[d][Y_AXIS] = attachment[-d][Y_AXIS] + (dx * limit * dir / staff_space);
159 me->set_elt_property ("attachment-offset",
160 gh_cons (ly_offset2scm (o[LEFT]),
161 ly_offset2scm (o[RIGHT])));
167 Slur::set_extremities (Score_element *me)
169 if (!Directional_element_interface::get (me))
170 Directional_element_interface::set (me, get_default_dir (me));
172 Direction dir = LEFT;
175 if (!gh_symbol_p (index_cell (me->get_elt_property ("attachment"), dir)))
177 for (SCM s = me->get_elt_property ("extremity-rules");
178 s != SCM_EOL; s = gh_cdr (s))
180 SCM r = gh_call2 (gh_caar (s), me->self_scm (),
181 gh_int2scm ((int)dir));
184 index_set_cell (me->get_elt_property ("attachment"), dir,
191 while (flip (&dir) != LEFT);
198 Slur::get_first_notecolumn_y (Score_element *me, Direction dir)
200 Score_element *col = dir == LEFT
201 ? unsmob_element (gh_car (scm_reverse (me->get_elt_property
204 (gh_car (me->get_elt_property ("note-columns")));
206 Score_element *common[] =
209 me->common_refpoint (col, Y_AXIS)
212 if (col == ((Spanner*)me)->get_bound (dir))
214 y = get_attachment (me, dir, common)[Y_AXIS];
218 y = encompass_offset (me, col, common)[Y_AXIS]
219 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
225 Slur::broken_trend_offset (Score_element *me, Direction dir)
228 A broken slur should maintain the same vertical trend
229 the unbroken slur would have had.
232 if (Spanner *mother = dynamic_cast<Spanner*> (me->original_l_))
234 for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
235 dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
236 dir == LEFT ? i++ : i--)
238 if (mother->broken_into_l_arr_[i - dir] == me)
240 Score_element *neighbour = mother->broken_into_l_arr_[i];
242 neighbour->set_elt_property ("direction",
243 me->get_elt_property ("direction"));
244 Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
245 Real y = get_first_notecolumn_y (me, -dir);
246 int neighbour_cols = scm_ilength (neighbour->get_elt_property ("note-columns"));
247 int cols = scm_ilength (me->get_elt_property ("note-columns"));
248 o = Offset (0, (y*neighbour_cols + neighbour_y*cols) /
249 (cols + neighbour_cols));
258 Slur::get_attachment (Score_element *me, Direction dir,
259 Score_element **common)
261 SCM s = me->get_elt_property ("attachment");
262 if (!gh_symbol_p (index_cell (s, dir)))
264 set_extremities (me);
265 s = me->get_elt_property ("attachment");
267 SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s);
268 Spanner*sp = dynamic_cast<Spanner*>(me);
269 String str = ly_symbol2string (a);
270 Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me);
271 Real hs = staff_space / 2.0;
274 Score_element *stem = 0;
275 if (Note_column::has_interface (sp->get_bound (dir)))
277 Score_element * n =sp->get_bound (dir);
278 if ((stem = Note_column::stem_l (n)))
283 o = Offset (0, Stem::head_positions (stem)
284 [Directional_element_interface::get (me)] * hs);
286 Default position is centered in X, on outer side of head Y
288 o += Offset (0.5 * n->extent (n,X_AXIS).length (),
290 * Directional_element_interface::get (me));
292 else if (str == "alongside-stem")
294 o = Offset (0, Stem::chord_start_f (stem));
296 Default position is on stem X, on outer side of head Y
298 o += Offset (n->extent (n,X_AXIS).length ()
299 * (1 + Stem::get_direction (stem)),
301 * Directional_element_interface::get (me));
303 else if (str == "stem")
305 o = Offset (0, Stem::stem_end_position (stem) * hs);
307 Default position is on stem X, at stem end Y
310 (n->extent (n,X_AXIS).length ()
311 - stem->extent (stem,X_AXIS).length ())
312 * (1 + Stem::get_direction (stem)),
317 else if (str == "loose-end")
319 SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s);
320 if (ly_symbol2string (other_a) != "loose-end")
324 The braindead way: horizontal
326 o = Offset (0, get_attachment (me, -dir, common)[Y_AXIS]);
328 o = broken_trend_offset (me, dir);
336 SCM alist = me->get_elt_property ("extremity-offset-alist");
337 int stemdir = stem ? Stem::get_direction (stem) : 1;
338 int slurdir = gh_scm2int (me->get_elt_property ("direction"));
341 gh_int2scm (stemdir * dir),
342 gh_int2scm (slurdir * dir),
343 SCM_UNDEFINED), alist);
347 o += ly_scm2offset (gh_cdr (l)) * staff_space * dir;
351 What if get_bound () is not a note-column?
353 if (str != "loose-end"
354 && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
356 o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
357 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
360 o += ly_scm2offset (index_cell (me->get_elt_property ("attachment-offset"),
366 Slur::encompass_offset (Score_element*me,
368 Score_element **common)
371 Score_element* stem_l = unsmob_element (col->get_elt_property ("stem"));
373 Direction dir = Directional_element_interface::get (me);
377 warning (_ ("Slur over rest?"));
378 o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
379 o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
382 Direction stem_dir = Directional_element_interface::get (stem_l);
383 o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
386 Simply set x to middle of notehead
389 o[X_AXIS] -= 0.5 * stem_dir * col->extent (col,X_AXIS).length ();
391 if ((stem_dir == dir)
392 && !stem_l->extent (stem_l, Y_AXIS).empty_b ())
394 o[Y_AXIS] = stem_l->extent (common[Y_AXIS], Y_AXIS)[dir];
398 o[Y_AXIS] = col->extent (common[Y_AXIS], Y_AXIS)[dir];
402 leave a gap: slur mustn't touch head/stem
404 o[Y_AXIS] += dir * gh_scm2double (me->get_elt_property ("y-free")) *
405 me->paper_l ()->get_var ("staffspace");
410 Slur::get_encompass_offset_arr (Score_element *me)
412 Spanner*sp = dynamic_cast<Spanner*>(me);
413 SCM eltlist = me->get_elt_property ("note-columns");
414 Score_element *common[] = {me->common_refpoint (eltlist, X_AXIS),
415 me->common_refpoint (eltlist, Y_AXIS)};
418 common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
419 common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
421 Link_array<Score_element> encompass_arr;
422 while (gh_pair_p (eltlist))
424 encompass_arr.push (unsmob_element (gh_car (eltlist)));
425 eltlist =gh_cdr (eltlist);
427 encompass_arr.reverse ();
430 Array<Offset> offset_arr;
432 Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
433 me->relative_coordinate (common[Y_AXIS], Y_AXIS));
436 int last = encompass_arr.size () - 2;
438 offset_arr.push (get_attachment (me, LEFT, common));
444 if (encompass_arr[0] != sp->get_bound (LEFT))
449 offset_arr[0][Y_AXIS] -=
450 encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
451 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
457 if (encompass_arr.top () != sp->get_bound (RIGHT))
462 for (int i = first; i <= last; i++)
464 Offset o (encompass_offset (me, encompass_arr[i], common));
465 offset_arr.push (o - origin);
468 offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
470 if (encompass_arr[0] != sp->get_bound (LEFT))
472 offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
473 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
480 MAKE_SCHEME_CALLBACK(Slur,set_spacing_rods,1);
482 Slur::set_spacing_rods (SCM smob)
484 Score_element*me = unsmob_element (smob);
487 Spanner*sp = dynamic_cast<Spanner*>(me);
488 r.item_l_drul_[LEFT] = sp->get_bound (LEFT);
489 r.item_l_drul_[RIGHT] = sp->get_bound (RIGHT);
491 gh_scm2double (me->get_elt_property ("minimum-length"))
492 * me->paper_l ()->get_var ("staffspace");
495 return SCM_UNSPECIFIED;
500 Ugh should have dash-length + dash-period
502 MAKE_SCHEME_CALLBACK (Slur, brew_molecule,1);
504 Slur::brew_molecule (SCM smob)
506 Score_element * me = unsmob_element (smob);
507 if (!scm_ilength (me->get_elt_property ("note-columns")))
513 Real thick = me->paper_l ()->get_var ("stafflinethickness") *
514 gh_scm2double (me->get_elt_property ("thickness"));
515 Bezier one = get_curve (me);
517 // get_curve may suicide
518 if (!scm_ilength (me->get_elt_property ("note-columns")))
522 SCM d = me->get_elt_property ("dashed");
524 a = me->lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
526 a = me->lookup_l ()->slur (one, Directional_element_interface::get (me) * thick, thick);
528 return a.create_scheme();
532 Slur::set_control_points (Score_element*me)
534 Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me);
536 SCM details = me->get_elt_property ("details");
537 SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
538 SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
540 Real r_0 = gh_scm2double (gh_cdr (r_0_scm));
541 Real h_inf = staff_space * gh_scm2double (gh_cdr (h_inf_scm));
543 Slur_bezier_bow bb (get_encompass_offset_arr (me),
544 Directional_element_interface::get (me),
547 if (bb.fit_factor () > 1.0)
549 Real length = bb.curve_.control_[3][X_AXIS];
550 Real default_height = slur_height (length, h_inf, r_0);
552 SCM ssb = me->get_elt_property ("beautiful");
554 if (gh_number_p (ssb))
555 sb = gh_scm2double (ssb);
557 bb.minimise_enclosed_area (me->paper_l(), sb);
558 SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details);
560 if (gh_pair_p (sbf) && gh_number_p (gh_cdr (sbf)))
561 bff = gh_scm2double (gh_cdr (sbf));
563 bb.curve_.control_[1][Y_AXIS] *= bff;
564 bb.curve_.control_[2][Y_AXIS] *= bff;
568 Real beautiful = length * default_height * sb;
569 Real area = bb.enclosed_area_f ();
572 Slurs that fit beautifully are not ugly
574 if (area > beautiful)
575 de_uglyfy (me, &bb, default_height);
578 Bezier b = bb.get_bezier ();
581 SCM controls = SCM_EOL;
584 controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
587 All these null control-points, where do they all come from?
589 if (i && b.control_[i][X_AXIS] == 0)
596 me->set_elt_property ("control-points", controls);
600 Slur::get_curve (Score_element*me)
605 if (!Directional_element_interface::get (me)
606 || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), LEFT))
607 || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), RIGHT)))
608 set_extremities (me);
610 if (!gh_pair_p (me->get_elt_property ("control-points")))
611 set_control_points (me);
613 // set_control_points may suicide
614 if (!scm_ilength (me->get_elt_property ("note-columns")))
617 for (SCM s= me->get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
619 b.control_[i] = ly_scm2offset (gh_car (s));
623 Array<Offset> enc (get_encompass_offset_arr (me));
624 Direction dir = Directional_element_interface::get (me);
626 Real x1 = enc[0][X_AXIS];
627 Real x2 = enc.top ()[X_AXIS];
630 for (int i=1; i < enc.size ()-1; i++)
632 Real x = enc[i][X_AXIS];
635 Real y = b.get_other_coordinate (X_AXIS, x);
636 off = off >? dir * (enc[i][Y_AXIS] - y);
639 b.translate (Offset (0, dir * off));
645 Slur::has_interface (Score_element*me)
647 return me->has_interface (ly_symbol2scm ("slur-interface"));