]> git.donarmstrong.com Git - lilypond.git/blob - lily/slur-configuration.cc
Docs-hu: Translated Community Updated macro translations Fixed some translations...
[lilypond.git] / lily / slur-configuration.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 2004--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
6   LilyPond is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   LilyPond is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "slur-configuration.hh"
21
22
23 #include "item.hh"
24 #include "libc-extension.hh"
25 #include "misc.hh"
26 #include "pointer-group-interface.hh"
27 #include "slur-scoring.hh"
28 #include "slur.hh"
29 #include "spanner.hh"
30 #include "staff-symbol-referencer.hh"
31 #include "stem.hh"
32 #include "warn.hh"
33
34 Bezier
35 avoid_staff_line (Slur_score_state const &state,
36                   Bezier bez)
37 {
38   Offset horiz (1, 0);
39   vector<Real> ts = bez.solve_derivative (horiz);
40
41   /* TODO: handle case of broken slur.  */
42   if (!ts.empty ()
43       && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
44       && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
45     {
46       Real y = bez.curve_point (ts[0])[Y_AXIS];
47
48       Grob *staff = state.extremes_[LEFT].staff_;
49
50       Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
51         / state.staff_space_;
52
53       Real distance = fabs (my_round (p) - p);  //  in halfspaces
54       if (distance < 4 * state.thickness_
55           && (int) fabs (my_round (p))
56           <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
57           && (int (fabs (my_round (p))) % 2
58               != Staff_symbol_referencer::line_count (staff) % 2))
59         {
60           Direction resolution_dir
61             = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
62
63           // TODO: parameter
64           Real newp = my_round (p) + resolution_dir
65             * 5 * state.thickness_;
66
67           Real dy = (newp - p) * state.staff_space_ / 2.0;
68
69           bez.control_[1][Y_AXIS] += dy;
70           bez.control_[2][Y_AXIS] += dy;
71         }
72     }
73   return bez;
74 }
75
76 Real
77 fit_factor (Offset dz_unit, Offset dz_perp,
78             Bezier curve, Direction d, vector<Offset> const &avoid)
79 {
80   Real fit_factor = 0.0;
81   Offset x0 = curve.control_[0];
82   curve.translate (-x0);
83   curve.rotate (-dz_unit.arg ());
84   curve.scale (1, d);
85
86   Interval curve_xext;
87   curve_xext.add_point (curve.control_[0][X_AXIS]);
88   curve_xext.add_point (curve.control_[3][X_AXIS]);
89
90   for (vsize i = 0; i < avoid.size (); i++)
91     {
92       Offset z = (avoid[i] - x0);
93       Offset p (dot_product (z, dz_unit),
94                 d * dot_product (z, dz_perp));
95
96       Real eps = 0.01;
97       Interval pext = eps * Interval (-1,1) + p[X_AXIS];
98       pext.intersect (curve_xext);
99       if (pext.is_empty () || pext.length () <= 1.999 * eps)
100         continue;
101
102       Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
103       if (y)
104         fit_factor = max (fit_factor, (p[Y_AXIS] / y));
105     }
106   return fit_factor;
107 }
108
109 void
110 Slur_configuration::generate_curve (Slur_score_state const &state,
111                                     Real r_0, Real h_inf,
112                                     vector<Offset> const &avoid)
113 {
114   Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
115   Offset dz_unit = dz;
116   dz_unit *= 1 / dz.length ();
117   Offset dz_perp = dz_unit * Offset (0, 1);
118
119   Real indent, height;
120   get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
121
122   Real len = dz.length ();
123
124   /* This condition,
125
126   len^2 > 4h^2 +  3 (i + 1/3len)^2  - 1/3 len^2
127
128   is equivalent to:
129
130   |bez' (0)| < | bez' (.5)|
131
132   when (control2 - control1) has the same direction as
133   (control3 - control0).  */
134
135   Real max_indent = len / 3.1;
136   indent = min (indent, max_indent);
137
138   Real a1 = sqr (len) / 3.0;
139   Real a2 = 0.75 * sqr (indent + len / 3.0);
140   Real max_h = a1 - a2;
141
142   if (max_h < 0)
143     {
144       programming_error ("slur indent too small");
145       max_h = len / 3.0;
146     }
147   else
148     max_h = sqrt (max_h);
149
150   Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
151
152   Real x1 = (eccentricity + indent);
153   Real x2 = (eccentricity - indent);
154
155   Bezier curve;
156   curve.control_[0] = attachment_[LEFT];
157   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
158     + dz_unit * x1;
159   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
160     + dz_unit * x2;
161   curve.control_[3] = attachment_[RIGHT];
162
163   Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
164
165   height = max (height, min (height * ff, max_h));
166
167   curve.control_[0] = attachment_[LEFT];
168   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
169     + dz_unit * x1;
170   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
171     + dz_unit * x2;
172   curve.control_[3] = attachment_[RIGHT];
173
174   curve_ = avoid_staff_line (state, curve);
175   height_ = height;
176 }
177
178 Slur_configuration::Slur_configuration ()
179 {
180   tags_ = 0x0;
181   score_ = 0.0;
182   index_ = -1;
183 };
184
185
186 void
187 Slur_configuration::add_score (Real s, string desc)
188 {
189   if (s < 0)
190     {
191       programming_error ("Negative demerits found for slur. Ignoring");
192       s = 0.0;
193     }
194   
195   if (s)
196     {
197       if (score_card_.length () > 0)
198         score_card_ += ", ";
199       score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
200       score_ += s;
201     }
202 }
203
204 void
205 Slur_configuration::score_encompass (Slur_score_state const &state)
206 {
207   Bezier const &bez (curve_);
208   Real demerit = 0.0;
209
210   /*
211     Distances for heads that are between slur and line between
212     attachment points.
213   */
214   vector<Real> convex_head_distances;
215   for (vsize j = 0; j < state.encompass_infos_.size (); j++)
216     {
217       Real x = state.encompass_infos_[j].x_;
218
219       bool l_edge = j == 0;
220       bool r_edge = j == state.encompass_infos_.size () - 1;
221       bool edge = l_edge || r_edge;
222
223       if (! (x < attachment_[RIGHT][X_AXIS]
224              && x > attachment_[LEFT][X_AXIS]))
225         continue;
226
227       Real y = bez.get_other_coordinate (X_AXIS, x);
228       if (!edge)
229         {
230           Real head_dy = (y - state.encompass_infos_[j].head_);
231           if (state.dir_ * head_dy < 0)
232             {
233               demerit += state.parameters_.head_encompass_penalty_;
234               convex_head_distances.push_back (0.0);
235             }
236           else
237             {
238               Real hd = (head_dy)
239                 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
240                 : state.parameters_.head_encompass_penalty_;
241               hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
242
243               demerit += hd;
244             }
245
246           Real line_y = linear_interpolate (x,
247                                             attachment_[RIGHT][X_AXIS],
248                                             attachment_[LEFT][X_AXIS],
249                                             attachment_[RIGHT][Y_AXIS],
250                                             attachment_[LEFT][Y_AXIS]);
251
252           if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
253             {
254
255               Real closest
256                 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
257               Real d = fabs (closest - y);
258
259               convex_head_distances.push_back (d);
260             }
261         }
262
263       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
264         {
265           Real stem_dem = state.parameters_.stem_encompass_penalty_;
266           if ((l_edge && state.dir_ == UP)
267               || (r_edge && state.dir_ == DOWN))
268             stem_dem /= 5;
269
270           demerit += stem_dem;
271         }
272       else if (!edge)
273         {
274           Interval ext;
275           ext.add_point (state.encompass_infos_[j].stem_);
276           ext.add_point (state.encompass_infos_[j].head_);
277
278           // ?
279           demerit += -state.parameters_.closeness_factor_
280             * min (state.dir_
281                    * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
282             / state.encompass_infos_.size ();
283         }
284     }
285   add_score (demerit, "encompass");
286   
287   if (convex_head_distances.size ())
288     {
289       Real avg_distance = 0.0;
290       Real min_dist = infinity_f;
291       for (vsize j = 0; j < convex_head_distances.size (); j++)
292         {
293           min_dist = min (min_dist, convex_head_distances[j]);
294           avg_distance += convex_head_distances[j];
295         }
296
297       /*
298         For slurs over 3 or 4 heads, the average distance is not a
299         good normalizer.
300       */
301       Real n = convex_head_distances.size ();
302       if (n <= 2)
303         {
304           Real fact = 1.0;
305           avg_distance += height_ * fact;
306           n += fact;
307         }
308
309       /*
310         TODO: maybe it's better to use (avgdist - mindist)*factor
311         as penalty.
312       */
313       avg_distance /= n;
314       Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
315       if (min_dist > 0.0)
316         variance_penalty
317           = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
318
319       variance_penalty = max (variance_penalty, 0.0);
320       variance_penalty *= state.parameters_.head_slur_distance_factor_;
321
322       add_score (variance_penalty, "variance");
323     }
324 }
325
326 void
327 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
328 {
329   for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
330     {
331       Drul_array<Offset> attachment = attachment_;
332       Extra_collision_info const &info (state.extra_encompass_infos_[j]);
333       
334       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
335
336       /*
337         to prevent numerical inaccuracies in
338         Bezier::get_other_coordinate ().
339       */
340       Direction d = LEFT;
341       bool found = false;
342       Real y = 0.0;
343
344       do
345         {
346           /*
347             We need to check for the bound explicitly, since the
348             slur-ending can be almost vertical, making the Y
349             coordinate a bad approximation of the object-slur
350             distance.
351           */
352           Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
353           if (!as_item)
354             continue;
355           
356           Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
357           item_x.intersect (state.extremes_[d].slur_head_x_extent_);
358           if (!item_x.is_empty ())
359             {
360               y = attachment[d][Y_AXIS];
361               found = true;
362             }
363               
364         }
365       while (flip (&d) != LEFT);
366
367       if (!found)
368         {
369           Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
370
371           if (!slur_wid.contains (x))
372             continue;
373
374           y = curve_.get_other_coordinate (X_AXIS, x);
375         }
376
377       Real dist = 0.0;
378       if (info.type_ == ly_symbol2scm ("around"))
379         dist = info.extents_[Y_AXIS].distance (y);
380
381       /*
382         Have to score too: the curve enumeration is limited in its
383         shape, and may produce curves which collide anyway.
384        */
385       else if (info.type_ == ly_symbol2scm ("inside"))
386         dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
387       else
388         programming_error ("unknown avoidance type");
389
390       dist = max (dist, 0.0);
391       
392       Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
393                                                   state.parameters_.extra_encompass_free_distance_,
394                                                   dist);
395       
396       add_score (penalty, "extra");
397     }
398 }
399
400 void
401 Slur_configuration::score_edges (Slur_score_state const &state)
402 {
403   Direction d = LEFT;
404   Offset dz = attachment_[RIGHT]
405     - attachment_[LEFT];
406   Real slope = dz[Y_AXIS] / dz[X_AXIS];
407   do
408     {
409       Real y = attachment_[d][Y_AXIS];
410       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
411
412       Real factor = state.parameters_.edge_attraction_factor_;
413       Real demerit = factor * dy;
414       if (state.extremes_[d].stem_
415           && state.extremes_[d].stem_dir_ == state.dir_
416           && !Stem::get_beaming (state.extremes_[d].stem_, -d))
417         demerit /= 5;
418
419       demerit *= exp (state.dir_ * d * slope
420                       * state.parameters_.edge_slope_exponent_);
421
422
423       string dir_str = d == LEFT ? "L" : "R";
424       add_score (demerit, dir_str + " edge");
425     }
426   while (flip (&d) != LEFT);
427 }
428
429 void
430 Slur_configuration ::score_slopes (Slur_score_state const &state)
431 {
432   Real dy = state.musical_dy_;
433   Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
434   Real slur_dy = slur_dz[Y_AXIS];
435   Real demerit = 0.0;
436
437   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
438                    - state.parameters_.max_slope_), 0.0)
439     * state.parameters_.max_slope_factor_;
440
441   /* 0.2: account for staffline offset. */
442   Real max_dy = (fabs (dy) + 0.2);
443   if (state.edge_has_beams_)
444     max_dy += 1.0;
445
446   if (!state.is_broken_)
447     demerit += state.parameters_.steeper_slope_factor_
448       * (max (fabs (slur_dy) -max_dy, 0.0));
449
450   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
451                    - state.parameters_.max_slope_), 0.0)
452     * state.parameters_.max_slope_factor_;
453
454   if (sign (dy) == 0
455       && sign (slur_dy) != 0
456       && !state.is_broken_)
457     demerit += state.parameters_.non_horizontal_penalty_;
458
459   if (sign (dy)
460       && !state.is_broken_
461       && sign (slur_dy)
462       && sign (slur_dy) != sign (dy))
463     demerit += state.edge_has_beams_
464       ? state.parameters_.same_slope_penalty_ / 10
465       : state.parameters_.same_slope_penalty_;
466
467   add_score (demerit, "slope");
468 }
469
470 void
471 Slur_configuration::calculate_score (Slur_score_state const &state)
472 {
473   score_extra_encompass (state);
474   score_slopes (state);
475   score_edges (state);
476   score_encompass (state);
477 }