2 slur.cc -- implement Slur
4 source file of the GNU LilyPond music typesetter
6 (c) 1996, 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 * begin and end should be treated as a/acknowledge Scripts.
13 * broken slur should have uniform trend
16 #include "directional-element-interface.hh"
17 #include "group-interface.hh"
20 #include "paper-def.hh"
21 #include "note-column.hh"
23 #include "paper-column.hh"
24 #include "molecule.hh"
27 #include "bezier-bow.hh"
29 #include "cross-staff.hh"
30 #include "group-interface.hh"
31 #include "staff-symbol-referencer.hh"
32 #include "lily-guile.icc"
35 class Slur_bezier_bow : public Bezier_bow
38 Slur_bezier_bow (Array<Offset> encompass, Direction dir);
39 Array<Real> area_x_gradients_array (Real area);
41 Real enclosed_area_f () const;
42 Real fit_factor () const;
43 void minimise_enclosed_area (Paper_def* paper_l, Real default_height);
46 Slur_bezier_bow::Slur_bezier_bow (Array<Offset> encompass, Direction dir)
47 : Bezier_bow (encompass, dir)
52 Slur_bezier_bow::blow_fit ()
54 Real len = curve_.control_[3][X_AXIS];
55 Real h = curve_.control_[1][Y_AXIS] * fit_factor () / len;
56 curve_.control_[1][Y_AXIS] = h * len;
57 curve_.control_[2][Y_AXIS] = h * len;
58 curve_.assert_sanity ();
63 Slur_bezier_bow::enclosed_area_f () const
66 for (int i=0; i < encompass_.size (); i++)
72 x = Interval (0, encompass_[1][X_AXIS] / 2);
74 curve_.get_other_coordinate (X_AXIS,
78 else if (i == encompass_.size () - 1)
80 x = Interval ((encompass_[i-1][X_AXIS] + encompass_[i][X_AXIS])/2,
81 encompass_[i][X_AXIS]);
83 (curve_.get_other_coordinate (X_AXIS,
84 (x[MIN] + x[MAX]) / 2)));
88 x = Interval ((encompass_[i-1][X_AXIS] + encompass_[i][X_AXIS]) / 2,
89 (encompass_[i][X_AXIS] + encompass_[i+1][X_AXIS]) / 2);
90 y = Interval (encompass_[i][Y_AXIS],
91 (curve_.get_other_coordinate (X_AXIS, x[MIN])
92 + curve_.get_other_coordinate (X_AXIS,
93 (x[MIN] + x[MAX]) / 2)
94 + curve_.get_other_coordinate (X_AXIS, x[MAX])) / 3);
97 Real da = x.length () * y.length ();
104 Slur_bezier_bow::area_x_gradients_array (Real area)
106 Real len = curve_.control_[3][X_AXIS];
107 Real grow = len / 10.0;
109 for (int i=0; i < 2; i++)
111 Real r = curve_.control_[i+1][X_AXIS];
112 curve_.control_[i+1][X_AXIS] += grow;
113 da[i] = (enclosed_area_f () - area) / grow;
114 curve_.control_[i+1][X_AXIS] = r;
120 Slur_bezier_bow::minimise_enclosed_area (Paper_def* paper_l,
123 Real length = curve_.control_[3][X_AXIS];
124 Real sb = paper_l->get_var ("slur_beautiful");
125 Real beautiful = length * default_height * sb;
127 DEBUG_OUT << to_str ("Beautiful: %f\n", beautiful);
128 DEBUG_OUT << to_str ("Length: %f\n", length);
129 DEBUG_OUT << to_str ("D-height: %f\n", default_height);
130 DEBUG_OUT << to_str ("FitFac: %f\n", fit_factor ());
132 if (fit_factor () > 1.0)
135 Real pct_c0 = paper_l->get_var ("bezier_pct_c0");
136 Real pct_c3 = paper_l->get_var ("bezier_pct_c3");
137 Real pct_in_max = paper_l->get_var ("bezier_pct_in_max");
138 Real pct_out_max = paper_l->get_var ("bezier_pct_out_max");
139 Real steps = paper_l->get_var ("bezier_area_steps");
141 for (int i=0; i < steps; i++)
143 Real area = enclosed_area_f ();
145 DEBUG_OUT << to_str ("Init area: %f\n", area);
147 if (area <= beautiful)
150 Array<Real> da = area_x_gradients_array (area);
153 Real pct = pct_c0 + pct_c3 * length * length * length;
154 pct *= (steps - i) / steps;
155 if (da[0] > 0 || da[1] < 0)
156 pct = pct <? pct_out_max;
158 pct = pct <? pct_in_max;
160 Real u = (abs (curve_.control_[1][X_AXIS] / da[0])
161 <? abs ((curve_.control_[3][X_AXIS]
162 - curve_.control_[2][X_AXIS]) / da[1]));
164 DEBUG_OUT << to_str ("pct: %f\n", pct);
165 DEBUG_OUT << to_str ("u: %f\n", u);
167 DEBUG_OUT << to_str ("da: (%f, %f)\n", da[0], da[1]);
168 DEBUG_OUT << to_str ("da*u: (%f, %f)\n", da[0]*u*pct, da[1]*u*pct);
169 DEBUG_OUT << to_str ("cx: (%f, %f)\n", curve_.control_[1][X_AXIS],
170 curve_.control_[2][X_AXIS]);
172 curve_.control_[1][X_AXIS] -= da[0] * u * pct;
173 curve_.control_[2][X_AXIS] -= da[1] * u * pct;
176 Real area = enclosed_area_f ();
177 DEBUG_OUT << to_str ("Exarea: %f\n", area);
183 max ( encompass.y / curve.y )
187 Slur_bezier_bow::fit_factor () const
189 Real x1 = encompass_[0][X_AXIS];
190 Real x2 = encompass_.top ()[X_AXIS];
193 for (int i=1; i < encompass_.size ()-1; i++)
195 if (encompass_[i][X_AXIS] > x1 && encompass_[i][X_AXIS] < x2)
197 Real y = curve_.get_other_coordinate (X_AXIS, encompass_[i][X_AXIS]);
200 Real f = encompass_[i][Y_AXIS] / y;
201 factor = factor >? f;
221 dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = 0.0;
222 dx_f_drul_[LEFT] = dx_f_drul_[RIGHT] = 0.0;
224 set_elt_property ("note-columns", SCM_EOL);
225 set_elt_property ("control-points", SCM_EOL);
229 I still don't understand the merits of this Group_interface.
231 Group_interface c (this, "control-points");
237 Slur::add_column (Note_column*n)
239 if (!gh_pair_p (n->get_elt_property ("note-heads")))
240 warning (_ ("Putting slur over rest. Ignoring."));
243 Group_interface gi (this, "note-columns");
250 Slur::de_uglyfy (Slur_bezier_bow* bb, Real default_height)
252 Real length = bb->curve_.control_[3][X_AXIS] ;
253 Real ff = bb->fit_factor ();
254 for (int i = 1; i < 3; i++)
256 Real ind = abs (bb->curve_.control_[(i-1)*3][X_AXIS]
257 - bb->curve_.control_[i][X_AXIS]) / length;
258 Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
260 Real f = default_height / length;
261 Real c1 = paper_l ()->get_var ("bezier_control1");
262 Real c2 = paper_l ()->get_var ("bezier_control2");
263 Real c3 = paper_l ()->get_var ("bezier_control3");
268 else if (h > c2 + c3 * ind)
273 bb->curve_.control_[i][Y_AXIS] = h * length;
276 bb->curve_.assert_sanity ();
280 Slur::get_default_dir () const
282 Link_array<Note_column> encompass_arr =
283 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
286 for (int i=0; i < encompass_arr.size (); i ++)
288 if (encompass_arr[i]->dir () < 0)
298 Slur::do_add_processing ()
300 Link_array<Note_column> encompass_arr =
301 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
303 if (encompass_arr.size ())
305 set_bound (LEFT, encompass_arr[0]);
306 if (encompass_arr.size () > 1)
307 set_bound (RIGHT, encompass_arr.top ());
314 Slur::encompass_offset (Note_column const* col) const
317 Stem* stem_l = col->stem_l ();
318 Direction dir = directional_element (this).get ();
322 warning (_ ("Slur over rest?"));
323 o[X_AXIS] = col->hpos_f ();
324 o[Y_AXIS] = col->extent (Y_AXIS)[dir];
327 Direction stem_dir = directional_element (stem_l).get ();
328 o[X_AXIS] = stem_l->hpos_f ();
331 Simply set x to middle of notehead
334 o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
336 if ((stem_dir == dir)
337 && !stem_l->extent (Y_AXIS).empty_b ())
339 o[Y_AXIS] = stem_l->extent (Y_AXIS)[dir];
343 o[Y_AXIS] = col->extent (Y_AXIS)[dir];
347 leave a gap: slur mustn't touch head/stem
349 o[Y_AXIS] += dir * paper_l ()->get_var ("slur_y_free");
350 o[Y_AXIS] -= calc_interstaff_dist (stem_l, this);
355 Slur::do_post_processing ()
358 set_control_points ();
366 Slur::set_extremities ()
368 Link_array<Note_column> encompass_arr =
369 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
371 if (!encompass_arr.size ())
373 set_elt_property ("transparent", SCM_BOOL_T);
379 if (!directional_element (this).get ())
380 directional_element (this).set (get_default_dir ());
384 Slur and tie placement [OSU]
387 * x = centre of head - d * x_gap_f
390 * y = length < 5ss : horizontal tangent + d * 0.25 ss
391 y = length >= 5ss : y next interline - d * 0.25 ss
394 Real staff_space = paper_l ()->get_var ("interline");
395 Real half_staff_space = staff_space / 2;
397 Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
398 Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
400 Drul_array<Note_column*> note_column_drul;
401 note_column_drul[LEFT] = encompass_arr[0];
402 note_column_drul[RIGHT] = encompass_arr.top ();
404 bool fix_broken_b = false;
406 Direction my_dir = directional_element (this).get ();
414 if ((note_column_drul[d] == get_bound (d))
415 && note_column_drul[d]->first_head ()
416 && (note_column_drul[d]->stem_l ()))
418 Stem* stem_l = note_column_drul[d]->stem_l ();
420 side directly attached to note head;
421 no beam getting in the way
423 if ((stem_l->extent (Y_AXIS).empty_b ()
424 || !((stem_l->get_direction () == my_dir) && (my_dir != d)))
425 && !((my_dir == stem_l->get_direction ())
426 && stem_l->beam_l () && (stem_l->beam_count (-d) >= 1)))
428 dx_f_drul_[d] = get_bound (d)->extent (X_AXIS).length () / 2;
429 dx_f_drul_[d] -= d * x_gap_f;
431 if (stem_l->get_direction () != my_dir)
433 dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[my_dir];
437 dy_f_drul_[d] = stem_l->chord_start_f ()
438 + my_dir * half_staff_space;
440 dy_f_drul_[d] += my_dir * y_gap_f;
443 side attached to (visible) stem
447 dx_f_drul_[d] = stem_l->hpos_f ()
448 - get_bound (d)->relative_coordinate (0, X_AXIS);
450 side attached to beamed stem
452 if (stem_l->beam_l () && (stem_l->beam_count (-d) >= 1))
454 dy_f_drul_[d] = stem_l->extent (Y_AXIS)[my_dir];
455 dy_f_drul_[d] += my_dir * 2 * y_gap_f;
458 side attached to notehead, with stem getting in the way
462 dx_f_drul_[d] -= d * x_gap_f;
464 dy_f_drul_[d] = stem_l->chord_start_f ()
465 + my_dir * half_staff_space;
466 dy_f_drul_[d] += my_dir * y_gap_f;
475 dx_f_drul_[d] = get_broken_left_end_align ();
478 broken: should get y from other piece, so that slur
479 continues up/down trend
481 for now: be horizontal..
486 while (flip (&d) != LEFT);
488 int cross_count = cross_staff_count ();
489 bool interstaff_b = (0 < cross_count) && (cross_count < encompass_arr.size ());
491 Drul_array<Offset> info_drul;
492 Drul_array<Real> interstaff_interval;
496 info_drul[d] = encompass_offset (encompass_arr.boundary (d, 0));
497 interstaff_interval[d] = - calc_interstaff_dist (encompass_arr.boundary (d,0),
500 while (flip (&d) != LEFT);
502 Real interstaff_f = interstaff_interval[RIGHT] - interstaff_interval[LEFT];
506 Direction d = (encompass_arr.top () != get_bound (RIGHT)) ?
508 dy_f_drul_[d] = info_drul[d][Y_AXIS];
511 dy_f_drul_[d] -= interstaff_interval[d];
512 if (cross_count) // interstaff_i ?
514 dy_f_drul_[LEFT] += interstaff_interval[d];
515 dy_f_drul_[RIGHT] += interstaff_interval[d];
521 dy_f_drul_[RIGHT] += interstaff_f;
526 Slur::cross_staff_count ()const
528 Link_array<Note_column> encompass_arr =
529 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
533 for (int i = 0; i < encompass_arr.size (); i++)
535 if (calc_interstaff_dist (encompass_arr[i], this))
543 Slur::get_encompass_offset_arr () const
545 Link_array<Note_column> encompass_arr =
546 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
548 Array<Offset> offset_arr;
551 check non-disturbed slur
552 FIXME: x of ends off by a tiny bit!!
554 offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
555 offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
559 Offset origin (relative_coordinate (0, X_AXIS), 0);
562 int last = encompass_arr.size () - 2;
564 offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
570 int cross_count = cross_staff_count ();
571 bool cross_b = cross_count && cross_count < encompass_arr.size ();
572 if (encompass_arr[0] != get_bound (LEFT))
575 Real is = calc_interstaff_dist (encompass_arr[0], this);
577 offset_arr[0][Y_AXIS] += is;
583 if (encompass_arr.top () != get_bound (RIGHT))
588 for (int i = first; i <= last; i++)
590 Offset o (encompass_offset (encompass_arr[i]));
591 offset_arr.push (o - origin);
594 offset_arr.push (Offset (spanner_length ()+ dx_f_drul_[RIGHT],
602 Slur::get_rods () const
606 r.item_l_drul_[LEFT] = get_bound (LEFT);
607 r.item_l_drul_[RIGHT] = get_bound (RIGHT);
609 r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");
618 Ugh should have dash-length + dash-period
621 Slur::do_brew_molecule () const
623 Real thick = paper_l ()->get_var ("slur_thickness");
624 Bezier one = get_curve ();
627 SCM d = get_elt_property ("dashed");
629 a = lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
631 a = lookup_l ()->slur (one, directional_element (this).get () * thick, thick);
637 Slur::set_control_points ()
639 Slur_bezier_bow bb (get_encompass_offset_arr (),
640 directional_element (this).get ());
642 Real staff_space = Staff_symbol_referencer_interface (this).staff_space ();
643 Real h_inf = paper_l ()->get_var ("slur_height_limit_factor") * staff_space;
644 Real r_0 = paper_l ()->get_var ("slur_ratio");
646 bb.set_default_bezier (h_inf, r_0);
648 if (bb.fit_factor () > 1.0)
650 Real length = bb.curve_.control_[3][X_AXIS];
651 Real default_height = bb.get_default_height (h_inf, r_0, length);
652 bb.minimise_enclosed_area (paper_l(), default_height);
654 Real bff = paper_l ()->get_var ("slur_force_blowfit");
655 bb.curve_.control_[1][Y_AXIS] *= bff;
656 bb.curve_.control_[2][Y_AXIS] *= bff;
659 Real sb = paper_l ()->get_var ("slur_beautiful");
660 Real beautiful = length * default_height * sb;
661 Real area = bb.enclosed_area_f ();
664 Slurs that fit beautifully are not ugly
666 if (area > beautiful)
667 de_uglyfy (&bb, default_height);
670 Bezier b = bb.get_bezier ();
671 SCM controls = array_to_scm (b.control_);
672 set_elt_property ("control-points", controls);
677 Slur::get_curve () const
680 Array<Offset> controls (4);
681 scm_to_array (get_elt_property ("control-points"), &controls);
682 b.control_ = controls;
684 Array<Offset> enc (get_encompass_offset_arr ());
685 Direction dir = directional_element (this).get ();
687 Real x1 = enc[0][X_AXIS];
688 Real x2 = enc.top ()[X_AXIS];
691 for (int i=1; i < enc.size ()-1; i++)
693 Real x = enc[i][X_AXIS];
696 Real y = b.get_other_coordinate (X_AXIS, x);
697 off = off >? dir * (enc[i][Y_AXIS] - y);
700 b.translate (Offset (0, dir * off));