X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgourlay-breaking.cc;h=06233738e8889cfecf4933c05bfa1d6d283bf745;hb=3df9923cfb65cc141b68b7258c965da417cba6d7;hp=562d06391e94b8a004426a35bfd16973b2bc1f4a;hpb=42760f5db93014a878f17f05538464326683d354;p=lilypond.git diff --git a/lily/gourlay-breaking.cc b/lily/gourlay-breaking.cc index 562d06391e..06233738e8 100644 --- a/lily/gourlay-breaking.cc +++ b/lily/gourlay-breaking.cc @@ -3,201 +3,262 @@ source file of the GNU LilyPond music typesetter - (c) 1997--1999 Han-Wen Nienhuys + (c) 1997--2006 Han-Wen Nienhuys */ #include "gourlay-breaking.hh" -#include "column-x-positions.hh" -#include "debug.hh" + +#include // rint +#include +using namespace std; + +#include "international.hh" +#include "main.hh" +#include "output-def.hh" #include "paper-column.hh" #include "paper-score.hh" -#include "paper-def.hh" -#include "line-spacer.hh" - -#include "killing-cons.tcc" +#include "simple-spacer.hh" +#include "system.hh" +#include "warn.hh" /// How often to print operator pacification marks? -const int HAPPY_DOTS_I = 3; +const int HAPPY_DOTS = 3; /** - Helper to trace back an optimal path - */ -struct Break_node { + Helper to trace back an optimal path +*/ +struct Break_node +{ /** this was the previous. If negative, this break should not be - considered: this path has infinite energy - - */ - int prev_break_i_; + considered: this path has infinite energy + + */ + int prev_break_; /** Which system number so far? - */ - int line_i_; + */ + int line_; - Real energy_f_; + Real demerits_; Column_x_positions line_config_; - - Break_node () + + Break_node () + { + prev_break_ = -1; + line_ = 0; + demerits_ = 0; + } + + void print () const { - prev_break_i_ = -1; - line_i_ = 0; + printf ("prev break %d, line %d, demerits %f\n", + prev_break_, line_, demerits_); } }; +void +print_break_nodes (vector const &arr) +{ + for (vsize i = 0; i < arr.size (); i++) + { + printf ("node %d: ", i); + arr[i].print (); + } +} + /** - This algorithms is adapted from the OSU Tech report on breaking lines. - */ -Array -Gourlay_breaking::do_solve () const + This algorithms is adapted from the OSU Tech report on breaking lines. + + this function is longish, but not very complicated. + + TODO: should rewrite. See the function in scm/page-layout.scm for + inspiration. +*/ +vector +Gourlay_breaking::solve () { - Array optimal_paths; - Line_of_cols all = pscore_l_->col_l_arr_ ; - Array breaks = find_break_indices (); - - optimal_paths.set_size (breaks.size ()); - - Break_node first_node ; - first_node.prev_break_i_ = -1; - first_node.line_config_.energy_f_ = 0; - first_node.line_i_ = 0; - - optimal_paths[0] = first_node; - int break_idx=1; - - for (; break_idx< breaks.size (); break_idx++) + vector optimal_paths; + vector all + = pscore_->root_system ()->columns (); + + vector breaks = pscore_->find_break_indices (); + + Break_node first_node; + optimal_paths.push_back (first_node); + + bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("ragged-right")); + bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("ragged-last")); + + Real worst_force = 0.0; + for (vsize break_idx = 1; break_idx < breaks.size (); break_idx++) { - Array candidates; - Array candidate_lines; - Cons_list spacer_p_list; - /* - start with a short line, add measures. At some point - the line becomes infeasible. Then we don't try to add more - */ - for (int start_idx = break_idx; start_idx--;) + start with a short line, add measures. At some point + the line becomes infeasible. Then we don't try to add more + */ + int minimal_start_idx = -1; + Column_x_positions minimal_sol; + Column_x_positions backup_sol; + + Real minimal_demerits = infinity_f; + + for (vsize start_idx = break_idx; start_idx--;) { - if (break_idx - start_idx > max_measures_i_) - break; + vector line (all.begin () + breaks[start_idx], + all.begin () + breaks[break_idx] + 1); - if (optimal_paths[start_idx].prev_break_i_ < 0 - && optimal_paths[start_idx].line_config_.energy_f_) - continue; + Interval line_dims + = line_dimensions_int (pscore_->layout (), optimal_paths[start_idx].line_); + bool last_line = break_idx == breaks.size () - 1; + bool ragged = ragged_right || (last_line && ragged_last); + Column_x_positions cp = get_line_configuration (line, line_dims[RIGHT] - line_dims[LEFT], + line_dims[LEFT], ragged); + if (ragged && last_line) + cp.force_ = 0.0; - - Line_of_cols line = all.slice (breaks[start_idx], breaks[break_idx]+1); - - line[0] = dynamic_cast(line[0]->find_broken_piece (RIGHT)); - line.top () = dynamic_cast(line.top ()->find_broken_piece (LEFT)); - - if (!feasible (line)) - break; - - Column_x_positions approx; - approx.cols_ = line; - - approx.spacer_l_ = generate_spacing_problem (line, - pscore_l_->paper_l_->line_dimensions_int (optimal_paths[start_idx].line_i_)); - spacer_p_list.append (new Killing_cons (approx.spacer_l_,0)); - - approx.approximate_solve_line (); - - if (approx.energy_f_ > energy_bound_f_) - { - continue; - } - - // this is a likely candidate. Store it. - candidate_lines.push (approx); - candidates.push (start_idx); - } + if (fabs (cp.force_) > worst_force) + worst_force = fabs (cp.force_); - - int minimal_j = -1; - Real minimal_energy = infinity_f; - for (int j=0; j < candidates.size (); j++) - { - int start = candidates[j]; - if (optimal_paths[start].line_config_.energy_f_ - + candidate_lines[j].energy_f_ > minimal_energy) - - continue; + /* + We remember this solution as a "should always work + solution", in case everything fucks up. */ + if (start_idx == break_idx - 1) + backup_sol = cp; - if (!candidate_lines[j].satisfies_constraints_b_) - { - candidate_lines[j].solve_line (); - } - - Real this_energy - = optimal_paths[start].line_config_.energy_f_ - + candidate_lines[j].energy_f_ ; - - if (this_energy < minimal_energy) + Real this_demerits; + + if (optimal_paths[start_idx].demerits_ >= infinity_f) + this_demerits = infinity_f; + else + this_demerits = combine_demerits (optimal_paths[start_idx].line_config_, cp) + + optimal_paths[start_idx].demerits_; + + if (this_demerits < minimal_demerits) { - minimal_j = j; - minimal_energy = this_energy; + minimal_start_idx = start_idx; + minimal_sol = cp; + minimal_demerits = this_demerits; } + + /* + we couldn't satisfy the constraints, this won't get better + if we add more columns, so we get on with the next one + */ + if (!cp.satisfies_constraints_) + break; } - if (minimal_j < 0) + Break_node bnod; + if (minimal_start_idx < 0) { - optimal_paths[break_idx].prev_break_i_ = -1; - optimal_paths[break_idx].line_config_.energy_f_ = infinity_f; + bnod.demerits_ = infinity_f; + bnod.line_config_ = backup_sol; + bnod.prev_break_ = break_idx - 1; } - else + else { - optimal_paths[break_idx].prev_break_i_ = candidates[minimal_j]; - optimal_paths[break_idx].line_config_ = candidate_lines[minimal_j]; - optimal_paths[break_idx].line_i_ = - optimal_paths[optimal_paths[break_idx].prev_break_i_].line_i_ + 1; + bnod.prev_break_ = minimal_start_idx; + bnod.demerits_ = minimal_demerits; + bnod.line_config_ = minimal_sol; } + bnod.line_ = optimal_paths[bnod.prev_break_].line_ + 1; + optimal_paths.push_back (bnod); - if (! (break_idx % HAPPY_DOTS_I)) - *mlog << "[" << break_idx << "]" << flush; - - spacer_p_list.junk (); + if (! (break_idx % HAPPY_DOTS)) + progress_indication (string ("[") + to_string (break_idx) + "]"); } - if (break_idx % HAPPY_DOTS_I) - *mlog << "[" << break_idx << "]"; + /* do the last one */ + if (breaks.size () % HAPPY_DOTS) + progress_indication (string ("[") + to_string (breaks.size ()) + "]"); - *mlog << endl; + progress_indication ("\n"); - Array final_breaks; - - Array lines; + vector final_breaks; + vector lines; /* skip 0-th element, since it is a "dummy" elt*/ - for (int i = optimal_paths.size ()-1; i> 0;) + for (vsize i = optimal_paths.size () - 1; i > 0;) + { + final_breaks.push_back (i); + vsize prev = optimal_paths[i].prev_break_; + assert (i > prev); + i = prev; + } + + if (be_verbose_global) { - final_breaks.push (i); - assert (i > optimal_paths[i].prev_break_i_); - - // there was no "feasible path" - if (!optimal_paths[i].line_config_.config_.size ()) { - final_breaks.set_size (0); - break; - } - i = optimal_paths[i].prev_break_i_; + message (_f ("Optimal demerits: %f", + optimal_paths.back ().demerits_) + "\n"); } + if (optimal_paths.back ().demerits_ >= infinity_f) + warning (_ ("no feasible line breaking found")); + + for (vsize i = final_breaks.size (); i--;) + { + Column_x_positions cp (optimal_paths[final_breaks[i]].line_config_); - for (int i= final_breaks.size (); i--;) - lines.push (optimal_paths[final_breaks[i]].line_config_); - + lines.push_back (cp); + if (!cp.satisfies_constraints_) + warning (_ ("can't find line breaking that satisfies constraints")); + } return lines; } - Gourlay_breaking::Gourlay_breaking () { - energy_bound_f_ = infinity_f; - max_measures_i_ = INT_MAX; } -void -Gourlay_breaking::do_set_pscore () +/* + TODO: uniformity parameter to control rel. importance of spacing differences. + + TODO: + + mixing break penalties and constraint-failing solutions is confusing. +*/ +Real +Gourlay_breaking::combine_demerits (Column_x_positions const &prev, + Column_x_positions const &this_one) const { - energy_bound_f_ = pscore_l_->paper_l_->get_var ("gourlay_energybound"); - max_measures_i_ =int (rint (pscore_l_->paper_l_->get_var ("gourlay_maxmeasures"))); + Real break_penalties = 0.0; + Grob *pc = this_one.cols_.back (); + if (pc->original ()) + { + SCM pen = pc->get_property ("penalty"); + if (scm_is_number (pen) && fabs (scm_to_double (pen)) < 10000) + break_penalties += scm_to_double (pen); + } + + /* + Q: do we want globally non-cramped lines, or locally equally + cramped lines? + + There used to be an example file input/test/uniform-breaking to + demonstrate problems with this approach. When music is gradually + becoming denser, the uniformity requirement makes lines go from + cramped to even more cramped (because going from cramped + 3meas/line to relatively loose 2meas/line is such a big step. + + */ + + Real demerit = abs (this_one.force_) + abs (prev.force_ - this_one.force_) + + break_penalties; + + if (!this_one.satisfies_constraints_) + { + /* + If it doesn't satisfy constraints, we make this one + really unattractive. + + add 20000 to the demerits, so that a break penalty + of -10000 won't change the result */ + demerit = max ((demerit + 20000), 2000.0); + + demerit *= 10; + } + + return demerit; }