X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fconstrained-breaking.cc;h=0779c133a1d807e73ad3a3485ce0165f4cfb39b1;hb=1c122290caffd067b81c60a18c97e61d1c6b209e;hp=b7eddd6f225fbf060f4a762143b2d2725ff0c79e;hpb=474c8729dc274a30558102a015a01fa5882673db;p=lilypond.git diff --git a/lily/constrained-breaking.cc b/lily/constrained-breaking.cc index b7eddd6f22..0779c133a1 100644 --- a/lily/constrained-breaking.cc +++ b/lily/constrained-breaking.cc @@ -1,10 +1,20 @@ /* - constrained-breaking.cc -- implement a line breaker that - support limits on the number of systems + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2006--2010 Joe Neeman - (c) 2006--2007 Joe Neeman + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ #include "constrained-breaking.hh" @@ -12,6 +22,7 @@ #include "international.hh" #include "main.hh" #include "output-def.hh" +#include "page-layout-problem.hh" #include "paper-column.hh" #include "paper-score.hh" #include "simple-spacer.hh" @@ -19,20 +30,20 @@ #include "warn.hh" /* - We use the following optimal substructure. Let W(A) be our weight function. + We use the following optimal substructure. Let W (A) be our weight function. - Let A_{k,n} = (a_{k,n,1}, ... a_{k,n,k}) be the optimal set of line breaks - for k systems and n potential breakpoints. a_{k,n,k} = n (it is the end of + Let A_{k, n} = (a_{k, n, 1}, ... a_{k, n, k}) be the optimal set of line breaks + for k systems and n potential breakpoints. a_{k, n, k} = n (it is the end of the piece) Then A_{k+1, m} is contructed from - min_ {k < j < m} ( W(A_{k,j} :: m) ) + min_ {k < j < m} ( W (A_{k, j} :: m) ) where by A::m we denote appending m to the list A Indices in the code: The above algorithm makes it easy to end at a point before the end of the - score (just find A_{k,m} for some m < breaks_.size () - 1). However, we must + score (just find A_{k, m} for some m < breaks_.size () - 1). However, we must add information for starting at a point after the beginning. One constructor allows the specification of a list of starting columns, start_. We then have start_.size () different solution arrays. state_[i] is the array for the @@ -48,12 +59,12 @@ . . . . . . . . where the X's mark invalid solutions (can't have more systems than - breakpoints). Note that each value is of the form a_{x,n,x}. This is because - a breakpoint of the form a_{x,n,x-1} will also be called a_{x-1,m,x-1} for + breakpoints). Note that each value is of the form a_{x, n, x}. This is because + a breakpoint of the form a_{x, n, x-1} will also be called a_{x-1, m, x-1} for some m < n. Each cell in the array stores the value of its m (ie. the ending breakpoint of the previous line) as "prev_". - For finding A_{sys, brk}, let "me" be the (sys_count,brk) cell in our + For finding A_{sys, brk}, let "me" be the (sys_count, brk) cell in our solution array (state_[start][sys * rank + brk]). Then A_{sys, brk} = A_{sys - 1, me.prev_} :: me @@ -109,15 +120,6 @@ Constrained_breaking::calc_subproblem (vsize start, vsize sys, vsize brk) return found_something; } -vector -Constrained_breaking::solve () -{ - if (!systems_) - return get_best_solution (0, VPOS); - - resize (systems_); - return get_solution(0, VPOS, systems_); -} Column_x_positions Constrained_breaking::space_line (vsize i, vsize j) @@ -127,11 +129,20 @@ Constrained_breaking::space_line (vsize i, vsize j) Column_x_positions col; vector line (all_.begin () + breaks_[i], - all_.begin() + breaks_[j] + 1); + all_.begin () + breaks_[j] + 1); Interval line_dims = line_dimensions_int (pscore_->layout (), i); bool last = j == breaks_.size () - 1; bool ragged = ragged_right || (last && ragged_last); + /* As a special case, if there is only one line in the score and ragged-right + hasn't been specifically forbidden and the line is stretched, use + ragged spacing. */ + if (last && i == 0 + && lines_.at (i, j).force_ >= 0 + && !scm_is_bool (pscore_->layout ()->c_variable ("ragged-right")) + && !scm_is_bool (pscore_->layout ()->c_variable ("ragged-last"))) + ragged = true; + return get_line_configuration (line, line_dims[RIGHT] - line_dims[LEFT], line_dims[LEFT], ragged); } @@ -156,7 +167,7 @@ Constrained_breaking::resize (vsize systems) } vector -Constrained_breaking::get_solution (vsize start, vsize end, vsize sys_count) +Constrained_breaking::solve (vsize start, vsize end, vsize sys_count) { vsize start_brk = starting_breakpoints_[start]; vsize end_brk = prepare_solution (start, end, sys_count); @@ -173,10 +184,13 @@ Constrained_breaking::get_solution (vsize start, vsize end, vsize sys_count) { if (brk != end_brk) { - warning (_ ("cannot find line breaking that satisfies constraints" )); + brk = st.at (brk, sys).prev_; + sys--; + warning (_ ("cannot find line breaking that satisfies constraints")); ret.push_back (space_line (brk, end_brk)); } - /* build up the good solution */ + + /* build up the good part of the solution */ for (vsize cur_sys = sys; cur_sys != VPOS; cur_sys--) { vsize prev_brk = st.at (brk, cur_sys).prev_; @@ -190,16 +204,16 @@ Constrained_breaking::get_solution (vsize start, vsize end, vsize sys_count) } } /* if we get to here, just put everything on one line */ - warning (_ ("cannot find line breaking that satisfies constraints" )); + warning (_ ("cannot find line breaking that satisfies constraints")); ret.push_back (space_line (0, end_brk)); return ret; } vector -Constrained_breaking::get_best_solution (vsize start, vsize end) +Constrained_breaking::best_solution (vsize start, vsize end) { - vsize min_systems = get_min_systems (start, end); - vsize max_systems = get_max_systems (start, end); + vsize min_systems = min_system_count (start, end); + vsize max_systems = max_system_count (start, end); Real best_demerits = infinity_f; vector best_so_far; @@ -211,11 +225,11 @@ Constrained_breaking::get_best_solution (vsize start, vsize end) if (dem < best_demerits) { best_demerits = dem; - best_so_far = get_solution (start, end, i); + best_so_far = solve (start, end, i); } else { - vector cur = get_solution (start, end, i); + vector cur = solve (start, end, i); bool too_many_lines = true; for (vsize j = 0; j < cur.size (); j++) @@ -230,27 +244,63 @@ Constrained_breaking::get_best_solution (vsize start, vsize end) } if (best_so_far.size ()) return best_so_far; - return get_solution (start, end, max_systems); + return solve (start, end, max_systems); } std::vector -Constrained_breaking::get_details (vsize start, vsize end, vsize sys_count) +Constrained_breaking::line_details (vsize start, vsize end, vsize sys_count) { - vsize brk = prepare_solution (start, end, sys_count); + vsize end_brk = prepare_solution (start, end, sys_count); Matrix const &st = state_[start]; vector ret; - for (int sys = sys_count-1; sys >= 0 && brk != VPOS; sys--) + /* This loop structure is C&Ped from solve(). */ + /* find the first solution that satisfies constraints */ + for (vsize sys = sys_count-1; sys != VPOS; sys--) { - ret.push_back (st.at (brk, sys).details_); - brk = st.at (brk, sys).prev_; + for (vsize brk = end_brk; brk != VPOS; brk--) + { + if (!isinf (st.at (brk, sys).details_.force_)) + { + if (brk != end_brk) + { + /* + During initialize(), we only fill out a + Line_details for lines that are valid (ie. not too + long), otherwise line breaking becomes O(n^3). + In case sys_count is such that no valid solution + is found, we need to fill in the Line_details. + */ + Line_details details; + brk = st.at (brk, sys).prev_; + sys--; + fill_line_details (&details, brk, end_brk); + ret.push_back (details); + } + + /* build up the good part of the solution */ + for (vsize cur_sys = sys; cur_sys != VPOS; cur_sys--) + { + vsize prev_brk = st.at (brk, cur_sys).prev_; + assert (brk != VPOS); + ret.push_back (st.at (brk, cur_sys).details_); + brk = prev_brk; + } + reverse (ret); + return ret; + } + } } - reverse (ret); + + /* if we get to here, just put everything on one line */ + Line_details details; + fill_line_details (&details, 0, end_brk); + ret.push_back (details); return ret; } int -Constrained_breaking::get_min_systems (vsize start, vsize end) +Constrained_breaking::min_system_count (vsize start, vsize end) { vsize sys_count; vsize brk = prepare_solution (start, end, 1); @@ -272,7 +322,7 @@ Constrained_breaking::get_min_systems (vsize start, vsize end) } int -Constrained_breaking::get_max_systems (vsize start, vsize end) +Constrained_breaking::max_system_count (vsize start, vsize end) { vsize brk = (end >= start_.size ()) ? breaks_.size () - 1 : starting_breakpoints_[end]; return brk - starting_breakpoints_[start]; @@ -310,6 +360,17 @@ Constrained_breaking::Constrained_breaking (Paper_score *ps, vector const initialize (); } +static SCM +min_permission (SCM perm1, SCM perm2) +{ + if (perm1 == ly_symbol2scm ("force")) + return perm2; + if (perm1 == ly_symbol2scm ("allow") + && perm2 != ly_symbol2scm ("force")) + return perm2; + return SCM_EOL; +} + /* find the forces for all possible lines and cache ragged_ and ragged_right_ */ void Constrained_breaking::initialize () @@ -319,11 +380,54 @@ Constrained_breaking::initialize () ragged_right_ = to_boolean (pscore_->layout ()->c_variable ("ragged-right")); ragged_last_ = to_boolean (pscore_->layout ()->c_variable ("ragged-last")); - + /* NOTE: currently, we aren't using the space_ field of a + Line_details for anything. That's because the approximations + used for scoring a page configuration don't actually space things + properly (for speed reasons) using springs anchored at the staff + refpoints. Rather, the "space" is placed between the extent + boxes. To get a good result, therefore, the "space" value for + page breaking needs to be much smaller than the "space" value for + page layout. Currently, we just make it zero always, which means + that we will always prefer a tighter vertical layout. + */ + between_system_space_ = 0; + between_system_padding_ = 0; + between_system_min_distance_ = 0; + between_scores_system_padding_ = 0; + between_scores_system_min_distance_ = 0; + before_title_padding_ = 0; + before_title_min_distance_ = 0; + Output_def *l = pscore_->layout (); - System *sys = pscore_->root_system (); - Real padding = robust_scm2double (l->c_variable ("page-breaking-between-system-padding"), 0); - Real space = robust_scm2double (l->c_variable ("ideal-system-space"), 0); + + SCM spacing_spec = l->c_variable ("between-system-spacing"); + SCM between_scores_spec = l->c_variable ("between-scores-system-spacing"); + SCM title_spec = l->c_variable ("before-title-spacing"); + SCM page_breaking_spacing_spec = l->c_variable ("page-breaking-between-system-spacing"); + Page_layout_problem::read_spacing_spec (spacing_spec, + &between_system_padding_, + ly_symbol2scm ("padding")); + Page_layout_problem::read_spacing_spec (between_scores_spec, + &between_scores_system_padding_, + ly_symbol2scm ("padding")); + Page_layout_problem::read_spacing_spec (page_breaking_spacing_spec, + &between_system_padding_, + ly_symbol2scm ("padding")); + Page_layout_problem::read_spacing_spec (title_spec, + &before_title_padding_, + ly_symbol2scm ("padding")); + Page_layout_problem::read_spacing_spec (between_scores_spec, + &between_scores_system_min_distance_, + ly_symbol2scm ("minimum-distance")); + Page_layout_problem::read_spacing_spec (spacing_spec, + &between_system_min_distance_, + ly_symbol2scm ("minimum-distance")); + Page_layout_problem::read_spacing_spec (page_breaking_spacing_spec, + &between_system_min_distance_, + ly_symbol2scm ("minimum-distance")); + Page_layout_problem::read_spacing_spec (title_spec, + &before_title_min_distance_, + ly_symbol2scm ("minimum-distance")); Interval first_line = line_dimensions_int (pscore_->layout (), 0); Interval other_lines = line_dimensions_int (pscore_->layout (), 1); @@ -335,37 +439,21 @@ Constrained_breaking::initialize () other_lines.length (), other_lines.length () - first_line.length (), ragged_right_); - for (vsize i = 0; i < breaks_.size () - 1; i++) + for (vsize i = 0; i + 1 < breaks_.size (); i++) { - Real max_ext = 0; for (vsize j = i + 1; j < breaks_.size (); j++) { - int start = Paper_column::get_rank (all_[breaks_[i]]); - int end = Paper_column::get_rank (all_[breaks_[j]]); - Interval extent = sys->pure_height (sys, start, end); bool last = j == breaks_.size () - 1; bool ragged = ragged_right_ || (last && ragged_last_); Line_details &line = lines_.at (j, i); line.force_ = forces[i*breaks_.size () + j]; if (ragged && last && !isinf (line.force_)) - line.force_ = 0; + line.force_ = (line.force_ < 0 && j > i + 1) ? infinity_f : 0; if (isinf (line.force_)) break; - Grob *c = all_[breaks_[j]]; - line.break_penalty_ = robust_scm2double (c->get_property ("line-break-penalty"), 0); - line.page_penalty_ = robust_scm2double (c->get_property ("page-break-penalty"), 0); - line.turn_penalty_ = robust_scm2double (c->get_property ("page-turn-penalty"), 0); - line.break_permission_ = c->get_property ("line-break-permission"); - line.page_permission_ = c->get_property ("page-break-permission"); - line.turn_permission_ = c->get_property ("page-turn-permission"); - - max_ext = max (max_ext, extent.length ()); - line.extent_ = extent; - line.padding_ = padding; - line.space_ = space; - line.inverse_hooke_ = extent.length () + space; + fill_line_details (&line, i, j); } } @@ -373,7 +461,7 @@ Constrained_breaking::initialize () for (vsize i = 0; i < start_.size (); i++) { vsize j; - for (j = 0; j < breaks_.size () - 1 && breaks_[j] < start_[i]; j++) + for (j = 0; j + 1 < breaks_.size () && breaks_[j] < start_[i]; j++) ; starting_breakpoints_.push_back (j); start_[i] = breaks_[j]; @@ -381,6 +469,53 @@ Constrained_breaking::initialize () state_.resize (start_.size ()); } +/* + Fills out all of the information contained in a Line_details, + except for information about horizontal spacing. +*/ +void +Constrained_breaking::fill_line_details (Line_details *const out, vsize start, vsize end) +{ + int start_rank = Paper_column::get_rank (all_[breaks_[start]]); + int end_rank = Paper_column::get_rank (all_[breaks_[end]]); + System *sys = pscore_->root_system (); + Interval begin_of_line_extent = sys->begin_of_line_pure_height (start_rank, end_rank); + Interval rest_of_line_extent = sys->rest_of_line_pure_height (start_rank, end_rank); + bool last = (end == breaks_.size () - 1); + + Grob *c = all_[breaks_[end]]; + out->last_column_ = c; + out->break_penalty_ = robust_scm2double (c->get_property ("line-break-penalty"), 0); + out->page_penalty_ = robust_scm2double (c->get_property ("page-break-penalty"), 0); + out->turn_penalty_ = robust_scm2double (c->get_property ("page-turn-penalty"), 0); + out->break_permission_ = c->get_property ("line-break-permission"); + out->page_permission_ = c->get_property ("page-break-permission"); + out->turn_permission_ = c->get_property ("page-turn-permission"); + + /* turn permission should always be stricter than page permission + and page permission should always be stricter than line permission */ + out->page_permission_ = min_permission (out->break_permission_, + out->page_permission_); + out->turn_permission_ = min_permission (out->page_permission_, + out->turn_permission_); + + begin_of_line_extent = (begin_of_line_extent.is_empty () + || isnan (begin_of_line_extent[LEFT]) + || isnan (begin_of_line_extent[RIGHT])) + ? Interval (0, 0) : begin_of_line_extent; + rest_of_line_extent = (rest_of_line_extent.is_empty () + || isnan (rest_of_line_extent[LEFT]) + || isnan (rest_of_line_extent[RIGHT])) + ? Interval (0, 0) : rest_of_line_extent; + out->shape_ = Line_shape (begin_of_line_extent, rest_of_line_extent); + out->padding_ = last ? between_scores_system_padding_ : between_system_padding_; + out->title_padding_ = before_title_padding_; + out->min_distance_ = last ? between_scores_system_min_distance_ : between_system_min_distance_; + out->title_min_distance_ = before_title_min_distance_; + out->space_ = between_system_space_; + out->inverse_hooke_ = out->full_height () + between_system_space_; +} + Real Constrained_breaking::combine_demerits (Real force, Real prev_force) { @@ -390,3 +525,68 @@ Constrained_breaking::combine_demerits (Real force, Real prev_force) return force * force + (prev_force - force) * (prev_force - force); } +Line_details::Line_details (Prob *pb, Output_def *paper) +{ + SCM spec = paper->c_variable ("after-title-spacing"); + SCM title_spec = paper->c_variable ("between-title-spacing"); + padding_ = 0; + title_padding_ = 0; + Page_layout_problem::read_spacing_spec (spec, &padding_, ly_symbol2scm ("padding")); + Page_layout_problem::read_spacing_spec (title_spec, &title_padding_, ly_symbol2scm ("padding")); + Page_layout_problem::read_spacing_spec (spec, &min_distance_, ly_symbol2scm ("minimum-distance")); + Page_layout_problem::read_spacing_spec (title_spec, &title_min_distance_, ly_symbol2scm ("minimum-distance")); + + last_column_ = 0; + force_ = 0; + Interval stencil_extent = unsmob_stencil (pb->get_property ("stencil"))->extent (Y_AXIS); + shape_ = Line_shape (stencil_extent, stencil_extent); // pretend it goes all the way across + tallness_ = 0; + bottom_padding_ = 0; + space_ = 0.0; + inverse_hooke_ = 1.0; + break_permission_ = ly_symbol2scm ("allow"); + page_permission_ = pb->get_property ("page-break-permission"); + turn_permission_ = pb->get_property ("page-turn-permission"); + break_penalty_ = 0; + page_penalty_ = robust_scm2double (pb->get_property ("page-break-penalty"), 0); + turn_penalty_ = robust_scm2double (pb->get_property ("page-turn-penalty"), 0); + title_ = to_boolean (pb->get_property ("is-title")); + compressed_lines_count_ = 1; + compressed_nontitle_lines_count_ = title_ ? 0 : 1; + SCM last_scm = pb->get_property ("last-markup-line"); + last_markup_line_ = to_boolean (last_scm); + SCM first_scm = pb->get_property ("first-markup-line"); + first_markup_line_ = to_boolean (first_scm); + tight_spacing_ = to_boolean (pb->get_property ("tight-spacing")); + first_refpoint_offset_ = 0; +} + +Real +Line_details::full_height () const +{ + Interval ret; + ret.unite(shape_.begin_); + ret.unite(shape_.rest_); + return ret.length(); +} + +Real +Line_details::tallness () const +{ + return tallness_; +} + +Line_shape::Line_shape (Interval begin, Interval rest) +{ + begin_ = begin; + rest_ = rest; +} + +Line_shape +Line_shape::piggyback (Line_shape mount, Real padding) const +{ + Real elevation = max (begin_[UP]-mount.begin_[DOWN], rest_[UP]-mount.rest_[DOWN]); + Interval begin = Interval (begin_[DOWN], elevation + mount.begin_[UP] + padding); + Interval rest = Interval (rest_[DOWN], elevation + mount.rest_[UP] + padding); + return Line_shape (begin, rest); +}