2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Jan Nieuwenhuizen <janneke@gnu.org>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef BEAM_SCORING_PROBLEM_HH
22 #define BEAM_SCORING_PROBLEM_HH
25 #include "interval.hh"
26 #include "lily-guile.hh"
27 #include "lily-proto.hh"
28 #include "main.hh" // DEBUG_BEAM_SCORING
29 #include "std-vector.hh"
30 #include "stem-info.hh"
33 // Should be ordered by increasing expensiveness.
45 struct Beam_configuration
49 #if DEBUG_BEAM_SCORING
55 Beam_configuration ();
57 void add (Real demerit, const string &reason);
58 static Beam_configuration* new_config(Interval start,
62 // Comparator for a queue of Beam_configuration*.
63 class Beam_configuration_less
66 bool operator() (Beam_configuration* const& l, Beam_configuration* const& r)
69 return l->demerits > r->demerits;
74 struct Beam_quant_parameters
76 Real SECONDARY_BEAM_DEMERIT;
77 Real STEM_LENGTH_DEMERIT_FACTOR;
81 threshold to combat rounding errors.
85 // possibly ridiculous, but too short stems just won't do
86 Real STEM_LENGTH_LIMIT_PENALTY;
87 Real DAMPING_DIRECTION_PENALTY;
88 Real MUSICAL_DIRECTION_FACTOR;
89 Real HINT_DIRECTION_PENALTY;
90 Real IDEAL_SLOPE_FACTOR;
91 Real ROUND_TO_ZERO_SLOPE;
92 Real COLLISION_PENALTY;
93 Real COLLISION_PADDING;
94 Real HORIZONTAL_INTER_QUANT_PENALTY;
95 Real STEM_COLLISION_FACTOR;
97 void fill (Grob *him);
100 struct Beam_collision {
105 // Need to add beam_config->y to get actual offsets.
111 Parameters for a single beam. Precomputed to save time in
112 scoring individual configurations.
114 TODO - use trailing _ on data members.
117 class Beam_scoring_problem
120 Beam_scoring_problem (Grob *me, Drul_array<Real> ys);
121 Drul_array<Real> solve() const;
126 Interval unquanted_y;
135 vector<Stem_info> stem_infos;
138 Do stem computations. These depend on YL and YR linearly, so we can
139 precompute for every stem 2 factors.
141 We store some info to quickly interpolate. The stemlengths are
142 affine linear in YL and YR. If YL == YR == 0, then we might have
143 stem_y != 0.0, when we're cross staff.
145 vector<Real> base_lengths;
146 vector<Real> stem_xpositions;
152 Beam_quant_parameters parameters;
155 Drul_array<int> edge_beam_counts;
156 Drul_array<Direction> edge_dirs;
158 // Half-open intervals, representing allowed positions for the beam,
159 // starting from close to the notehead to the direction of the stem
160 // end. This is used for quickly weeding out invalid
161 // Beam_configurations.
162 Drul_array<Interval> quant_range;
163 Real beam_translation;
164 vector<Beam_collision> collisions_;
165 vector<Beam_segment> segments_;
168 void init_collisions (vector<Grob*> grobs);
169 void add_collision (Real x, Interval y, Real factor);
171 void one_scorer (Beam_configuration* config) const;
172 Beam_configuration *force_score (SCM inspect_quants,
173 const vector<Beam_configuration*> &configs) const;
174 Real y_at (Real x, Beam_configuration const* c) const;
176 // Scoring functions:
177 void score_forbidden_quants (Beam_configuration *config) const;
178 void score_horizontal_inter_quants (Beam_configuration *config) const;
179 void score_slope_ideal (Beam_configuration *config) const;
180 void score_slope_direction (Beam_configuration *config) const;
181 void score_slope_musical (Beam_configuration *config) const;
182 void score_stem_lengths (Beam_configuration* config) const;
183 void generate_quants(vector<Beam_configuration*>* scores) const;
184 void score_collisions (Beam_configuration *config) const;
187 #endif /* BEAM_SCORING_PROBLEM_HH */