source file of the GNU LilyPond music typesetter
- (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "gourlay-breaking.hh"
-#include "colhpos.hh"
-#include "spring-spacer.hh"
-#include "debug.hh"
-#include "p-col.hh"
-#include "p-score.hh"
-#include "paper-def.hh"
-const HAPPY_DOTS_I = 3;
+#include <cmath> // rint
+#include <cstdio>
+using namespace std;
+
+#include "warn.hh"
+#include "main.hh"
+#include "paper-column.hh"
+#include "paper-score.hh"
+#include "output-def.hh"
+#include "simple-spacer.hh"
+#include "system.hh"
+
+/// How often to print operator pacification marks?
+const int HAPPY_DOTS_I = 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_;
- Real energy_f_;
- Col_hpositions line_config_;
- Break_node()
+ considered: this path has infinite energy
+
+ */
+ int prev_break_;
+ /**
+ Which system number so far?
+ */
+ int line_;
+
+ Real demerits_;
+ Column_x_positions line_config_;
+
+ Break_node ()
{
- prev_break_i_ = -1;
+ prev_break_ = -1;
+ line_ = 0;
+ demerits_ = 0;
+ }
+
+ void print () const
+ {
+ printf ("prev break %d, line %d, demerits %f\n",
+ prev_break_, line_, demerits_);
}
};
+void
+print_break_nodes (Array<Break_node> const &arr)
+{
+ for (int i = 0; i < arr.size (); i++)
+ {
+ printf ("node %d: ", i);
+ arr[i].print ();
+ }
+}
+
/**
- This algorithms is adapted from
- */
+ This algorithms is adapted from the OSU Tech report on breaking lines.
+
+ this function is longish, but not very complicated.
-Array<Col_hpositions>
-Gourlay_breaking::do_solve() const
+ TODO: should rewrite. See the function in scm/page-layout.scm for
+ inspiration.
+*/
+Array<Column_x_positions>
+Gourlay_breaking::do_solve () const
{
Array<Break_node> optimal_paths;
- Line_of_cols all = all_cols();
- Array<int> 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;
-
- optimal_paths[0] = first_node;
- int break_idx=1;
-
-
- for (; break_idx< breaks.size(); break_idx++)
+ Link_array<Grob> all
+ = pscore_->root_system ()->columns ();
+
+ Array<int> breaks = find_break_indices ();
+
+ Break_node first_node;
+ optimal_paths.push (first_node);
+
+ bool ragged_right = to_boolean (pscore_->layout ()->c_variable ("raggedright"));
+ bool ragged_last = to_boolean (pscore_->layout ()->c_variable ("raggedlast"));
+
+ Real worst_force = 0.0;
+ for (int break_idx = 1; break_idx < breaks.size (); break_idx++)
{
- Array<int> candidates;
- Array<Col_hpositions> candidate_lines;
- Pointer_list<Line_spacer*> 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
- */
+ 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 (int start_idx = break_idx; start_idx--;)
{
- if (break_idx - start_idx > max_measures_i_)
- break;
+ Link_array<Grob> line = all.slice (breaks[start_idx], breaks[break_idx] + 1);
- if (optimal_paths[start_idx].prev_break_i_ < 0
- && optimal_paths[start_idx].line_config_.energy_f_)
-
- continue;
-
- Line_of_cols line = all.slice (breaks[start_idx], breaks[break_idx]+1);
-
- line[0] = line[0]->postbreak_l();
- line.top() = line.top ()->prebreak_l();
-
- if (!feasible (line))
- break;
-
- Col_hpositions approx;
- approx.cols = line;
-
- approx.spacer_l_ = generate_spacing_problem (line);
- spacer_p_list.bottom().add (approx.spacer_l_);
-
- ((Break_algorithm*)this)->approx_stats_.add (approx.cols);
- approx.approximate_solve_line();
-
- if (approx.energy_f_ > energy_bound_f_)
- {
- continue;
- }
+ line[0] = dynamic_cast<Item *> (line[0])->find_prebroken_piece (RIGHT);
+ line.top () = dynamic_cast<Item *> (line.top ())->find_prebroken_piece (LEFT);
-
- // this is a likely candidate. Store it.
- candidate_lines.push (approx);
- candidates.push (start_idx);
- }
+ Column_x_positions cp;
+ cp.cols_ = line;
-
- 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;
+ Interval line_dims
+ = line_dimensions_int (pscore_->layout (), optimal_paths[start_idx].line_);
+ Simple_spacer_wrapper *sp = generate_spacing_problem (line, line_dims);
+ bool last_line = break_idx == breaks.size () - 1;
+ bool ragged = ragged_right
+ || (last_line && ragged_last);
- if (!candidate_lines[j].satisfies_constraints_b_)
- {
- candidate_lines[j].solve_line();
- ((Break_algorithm*)this)->exact_stats_.add (candidate_lines[j].cols);
- }
-
- Real this_energy
- = optimal_paths[start].line_config_.energy_f_
- + candidate_lines[j].energy_f_ ;
-
- if (this_energy < minimal_energy)
+ sp->solve (&cp, ragged);
+
+ delete sp;
+
+ if (ragged && last_line)
+ cp.force_ = 0.0;
+
+ if (fabs (cp.force_) > worst_force)
+ worst_force = fabs (cp.force_);
+
+ /*
+ We remember this solution as a "should always work
+ solution", in case everything fucks up. */
+ if (start_idx == break_idx - 1)
+ backup_sol = cp;
+
+ 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];
+ 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 (bnod);
- if (!(break_idx % HAPPY_DOTS_I))
- *mlog << "[" << break_idx << "]"<<flush;
+ if (! (break_idx % HAPPY_DOTS_I))
+ progress_indication (String ("[") + to_string (break_idx) + "]");
}
- if (break_idx % HAPPY_DOTS_I)
- *mlog << "[" << break_idx << "]"<<flush;
+ /* do the last one */
+ if (breaks.size () % HAPPY_DOTS_I)
+ progress_indication (String ("[") + to_string (breaks.size ()) + "]");
- Array<int> final_breaks;
+ progress_indication ("\n");
- Array<Col_hpositions> lines;
+ Array<int> final_breaks;
+ Array<Column_x_positions> lines;
/* skip 0-th element, since it is a "dummy" elt*/
- for (int i = optimal_paths.size()-1; i> 0;)
+ for (int i = optimal_paths.size () - 1; i > 0;)
{
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_;
+ int prev = optimal_paths[i].prev_break_;
+ assert (i > prev);
+ i = prev;
}
+ if (be_verbose_global)
+ {
+ message (_f ("Optimal demerits: %f",
+ optimal_paths.top ().demerits_) + "\n");
+ }
+
+ if (optimal_paths.top ().demerits_ >= infinity_f)
+ warning (_ ("no feasible line breaking found"));
+
+ for (int 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 (cp);
+ if (!cp.satisfies_constraints_)
+ warning (_ ("can't find line breaking that satisfies constraints"));
+ }
return lines;
}
-
-Gourlay_breaking::Gourlay_breaking()
+Gourlay_breaking::Gourlay_breaking ()
{
- get_line_spacer = Spring_spacer::constructor;
- 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_.top ();
+ 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;
}
projects / lilypond.git / blobdiff