X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpage-breaking.cc;h=668231f63aa95f6ab8092f0c2c547189a4861ab1;hb=2feaf5f56c9b5f0b4f24f28c5cc44a7181b1383e;hp=d3a2762bbb350285dd3d00141976c9c235e793e8;hpb=481e336f410e933bea8705862743fc078ccb49f7;p=lilypond.git diff --git a/lily/page-breaking.cc b/lily/page-breaking.cc index d3a2762bbb..668231f63a 100644 --- a/lily/page-breaking.cc +++ b/lily/page-breaking.cc @@ -4,7 +4,63 @@ source file of the GNU LilyPond music typesetter - (c) 2006--2007 Joe Neeman + (c) 2006--2009 Joe Neeman +*/ + +/* + This is a utility class for page-breaking algorithms. There are some complex + parts of this class, some of which are useful to understand if you intend + to write a page breaking algorithm (ie. a subclass of Page_breaking). Most + of these complexities were introduced in order to break the problem of + page-breaking into simpler subproblems and to hide some of the bookkeeping + complexities of page breaking from the page breaking algorithms. + + COMPRESSED LINES + There are several functions that actually distribute systems across pages + (for example, the space_systems_XXX and pack_systems_XXX functions). If + each of these functions had to handle \noPageBreak, it would be a mess. + Therefore, we handle \noPageBreak by "compressing" the list of systems + before doing any layout: we concatenate any two systems separated by a + \noPageBreak into a single system. The page-breaking functions can do their + magic without encountering a \noPageBreak; we then "uncompress" the systems + at the end. We almost always work with cached_line_details_, which are + "compressed." + + CHUNKS + The basic operation of a page breaking algorithm is to repeatedly request + some systems from the line-breaker and place those systems on some pages. + With each repetition, the page breaking algorithm asks the line-breaker for + some systems that it thinks will help it achieve a better layout. The + Page_breaking class provides functionality to facilitate this in the case + that the page breaking algorithm only cares about the number of systems. + + Even if a page breaking algorithm only cares number of systems, there may + be many ways to satisfy its request. For example, in a piece with 2 scores + and a request for 10 systems, we could return 5 systems from each score or + 4 from the first and 6 from the second. Even within a score, we might + want to try several different line breaking configurations with a fixed + system count; if there is a forced \pageBreak, for example, we might wish + to tweak the number of systems on both sides of the \pageBreak independently. + + The Page_breaking class takes care of finding these configurations. It + divides the piece into "chunks" and sets up the line-breaker in such a way + that the number of systems in each chunk can be modified independently. + Chunks never cross score boundaries; each title and markup is its own chunk. + When a page breaking algorithm requests a number of systems, the Page_breaker + stores an array of potential configurations, which the page breaking + algorithm can iterate over using current_configuration(vsize). + + LINE_DIVISION + A Line_division is simply a way of storing the exact way in which the + total number of systems is distributed among chunks. Note that a + Line_division may not (in fact, usually will not) describe all of the chunks + in the entire book. Rather, it will describe the subset of chunks that lie + between some fixed starting and ending point. This subset of chunks changes + whenever a page breaking algorithm asks to consider a different pair of + starting and ending breakpoints. In particular, a Line_division should be + discarded after a call to set_current_breakpoints, since that Line_division + refers to a subset of chunks which might be different from the current + subset of chunks under consideration. */ #include "page-breaking.hh" @@ -36,13 +92,12 @@ compress_lines (const vector &orig) compressed.extent_[UP] = old.extent_[UP] + orig[i].extent_.length () + old.padding_; compressed.space_ += old.space_; compressed.inverse_hooke_ += old.inverse_hooke_; - compressed.title_ = old.title_; - /* we don't need the force_ field for the vertical spacing, - so we use force_ = n to signal that the line was compressed, - reducing the number of lines by n (and force_ = 0 otherwise). - This makes uncompression much easier. */ - compressed.force_ = old.force_ + 1; + compressed.compressed_lines_count_ = old.compressed_lines_count_ + 1; + compressed.compressed_nontitle_lines_count_ = + old.compressed_nontitle_lines_count_ + (compressed.title_ ? 0 : 1); + + compressed.title_ = compressed.title_ && old.title_; ret.back () = compressed; } else @@ -68,7 +123,7 @@ uncompress_solution (vector const &systems_per_page, { int compressed_count = 0; for (vsize j = start_sys; j < start_sys + systems_per_page[i]; j++) - compressed_count += (int)compressed[j].force_; + compressed_count += compressed[j].compressed_lines_count_ - 1; ret.push_back (systems_per_page[i] + compressed_count); start_sys += systems_per_page[i]; @@ -102,6 +157,21 @@ Page_breaking::Page_breaking (Paper_book *pb, Break_predicate is_break) ragged_ = to_boolean (pb->paper_->c_variable ("ragged-bottom")); ragged_last_ = to_boolean (pb->paper_->c_variable ("ragged-last-bottom")); page_top_space_ = robust_scm2double (pb->paper_->c_variable ("page-top-space"), 0); + systems_per_page_ = max (0, robust_scm2int (pb->paper_->c_variable ("systems-per-page"), 0)); + max_systems_per_page_ = max (0, robust_scm2int (pb->paper_->c_variable ("max-systems-per-page"), 0)); + min_systems_per_page_ = max (0, robust_scm2int (pb->paper_->c_variable ("min-systems-per-page"), 0)); + + if (systems_per_page_ && (max_systems_per_page_ || min_systems_per_page_)) + { + warning (_f ("ignoring min-systems-per-page and max-systems-per-page because systems-per-page was set")); + min_systems_per_page_ = max_systems_per_page_ = 0; + } + if (max_systems_per_page_ && min_systems_per_page_ > max_systems_per_page_) + { + warning (_f ("min-systems-per-page is larger than max-systems-per-page, ignoring both values")); + min_systems_per_page_ = max_systems_per_page_ = 0; + } + create_system_list (); find_chunks_and_breaks (is_break); } @@ -122,6 +192,24 @@ Page_breaking::ragged_last () const return ragged_last_; } +int +Page_breaking::systems_per_page () const +{ + return systems_per_page_; +} + +int +Page_breaking::max_systems_per_page () const +{ + return max_systems_per_page_; +} + +int +Page_breaking::min_systems_per_page () const +{ + return min_systems_per_page_; +} + Real Page_breaking::page_top_space () const { @@ -134,6 +222,40 @@ Page_breaking::system_count () const return system_count_; } +bool +Page_breaking::too_many_lines (int line_count) const +{ + return max_systems_per_page () > 0 && line_count > max_systems_per_page (); +} + +bool +Page_breaking::too_few_lines (int line_count) const +{ + return line_count < min_systems_per_page (); +} + +Real +Page_breaking::line_count_penalty (int line_count) const +{ + if (too_many_lines (line_count)) + return (line_count - max_systems_per_page ()) * TERRIBLE_SPACING_PENALTY; + if (too_few_lines (line_count)) + return (min_systems_per_page () - line_count) * TERRIBLE_SPACING_PENALTY; + + return 0; +} + +int +Page_breaking::line_count_status (int line_count) const +{ + if (too_many_lines (line_count)) + return SYSTEM_COUNT_TOO_MANY; + if (too_few_lines (line_count)) + return SYSTEM_COUNT_TOO_FEW; + + return SYSTEM_COUNT_OK; +} + /* translate indices into breaks_ into start-end parameters for the line breaker */ void Page_breaking::line_breaker_args (vsize sys, @@ -212,6 +334,7 @@ Page_breaking::systems () Real Page_breaking::page_height (int page_num, bool last) const { + bool last_part = ly_scm2bool (book_->paper_->c_variable ("is-last-bookpart")); SCM mod = scm_c_resolve_module ("scm page"); SCM calc_height = scm_c_module_lookup (mod, "calc-printable-height"); SCM make_page = scm_c_module_lookup (mod, "make-page"); @@ -222,7 +345,8 @@ Page_breaking::page_height (int page_num, bool last) const SCM page = scm_apply_0 (make_page, scm_list_n ( book_->self_scm (), ly_symbol2scm ("page-number"), scm_from_int (page_num), - ly_symbol2scm ("is-last"), scm_from_bool (last), + ly_symbol2scm ("is-last-bookpart"), scm_from_bool (last_part), + ly_symbol2scm ("is-bookpart-last-page"), scm_from_bool (last), SCM_UNDEFINED)); SCM height = scm_apply_1 (calc_height, page, SCM_EOL); return scm_to_double (height) - page_top_space_; @@ -254,21 +378,24 @@ Page_breaking::make_pages (vector lines_per_page, SCM systems) SCM book = book_->self_scm (); int first_page_number = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1); + bool last_bookpart = ly_scm2bool (book_->paper_->c_variable ("is-last-bookpart")); SCM ret = SCM_EOL; - SCM label_page_table = SCM_EOL; + SCM label_page_table = book_->top_paper ()->c_variable ("label-page-table"); + if (label_page_table == SCM_UNDEFINED) + label_page_table = SCM_EOL; for (vsize i = 0; i < lines_per_page.size (); i++) { SCM page_num = scm_from_int (i + first_page_number); - SCM last = scm_from_bool (i == lines_per_page.size () - 1); - SCM rag = scm_from_bool (ragged () || (to_boolean (last) - && ragged_last ())); + bool partbook_last_page = (i == lines_per_page.size () - 1); + SCM rag = scm_from_bool (ragged () || ( partbook_last_page && ragged_last ())); SCM line_count = scm_from_int (lines_per_page[i]); SCM lines = scm_list_head (systems, line_count); SCM page = scm_apply_0 (make_page, - scm_list_n (book, lines, page_num, - rag, last, SCM_UNDEFINED)); - + scm_list_n (book, lines, page_num, rag, + scm_from_bool (last_bookpart), + scm_from_bool (partbook_last_page), + SCM_UNDEFINED)); /* collect labels */ for (SCM l = lines ; scm_is_pair (l) ; l = scm_cdr (l)) { @@ -290,7 +417,7 @@ Page_breaking::make_pages (vector lines_per_page, SCM systems) ret = scm_cons (page, ret); systems = scm_list_tail (systems, line_count); } - book_->paper_->set_variable (ly_symbol2scm ("label-page-table"), label_page_table); + book_->top_paper ()->set_variable (ly_symbol2scm ("label-page-table"), label_page_table); ret = scm_reverse (ret); return ret; } @@ -632,8 +759,15 @@ Page_breaking::min_page_count (vsize configuration, vsize first_page_num) Real cur_rod_height = 0; Real cur_spring_height = 0; Real cur_page_height = page_height (first_page_num, false); + int line_count = 0; cache_line_details (configuration); + + // If the first line on a page has titles, allow them some extra space. + if (cached_line_details_.size () + && cached_line_details_[0].compressed_nontitle_lines_count_ < cached_line_details_[0].compressed_lines_count_) + cur_page_height += page_top_space (); + for (vsize i = 0; i < cached_line_details_.size (); i++) { Real ext_len = cached_line_details_[i].extent_.length (); @@ -641,21 +775,27 @@ Page_breaking::min_page_count (vsize configuration, vsize first_page_num) + ((cur_rod_height > 0) ? cached_line_details_[i].padding_: 0); Real next_spring_height = cur_spring_height + cached_line_details_[i].space_; Real next_height = next_rod_height + (ragged () ? next_spring_height : 0); + int next_line_count = line_count + cached_line_details_[i].compressed_nontitle_lines_count_; - - if ((next_height > cur_page_height && cur_rod_height > 0) + if ((!too_few_lines (line_count) && (next_height > cur_page_height && cur_rod_height > 0)) + || too_many_lines (next_line_count) || (i > 0 && cached_line_details_[i-1].page_permission_ == ly_symbol2scm ("force"))) { + line_count = cached_line_details_[i].compressed_nontitle_lines_count_; cur_rod_height = ext_len; cur_spring_height = cached_line_details_[i].space_; cur_page_height = page_height (first_page_num + ret, false); + + if (cached_line_details_[i].compressed_nontitle_lines_count_ < cached_line_details_[i].compressed_lines_count_) + cur_page_height += page_top_space (); ret++; } else { cur_rod_height = next_rod_height; cur_spring_height = next_spring_height; + line_count = next_line_count; } } @@ -674,7 +814,8 @@ Page_breaking::min_page_count (vsize configuration, vsize first_page_num) cur_page_height = page_height (first_page_num + ret - 1, true); Real cur_height = cur_rod_height + ((ragged_last () || ragged ()) ? cur_spring_height : 0); - if (cur_height > cur_page_height + if (!too_few_lines (line_count - cached_line_details_.back ().compressed_nontitle_lines_count_) + && cur_height > cur_page_height /* don't increase the page count if the last page had only one system */ && cur_rod_height > cached_line_details_.back ().extent_.length ()) ret++; @@ -683,11 +824,21 @@ Page_breaking::min_page_count (vsize configuration, vsize first_page_num) return ret; } +// If systems_per_page_ is positive, we don't really try to space on N pages; +// we just put the requested number of systems on each page and penalize +// if the result doesn't have N pages. Page_spacing_result Page_breaking::space_systems_on_n_pages (vsize configuration, vsize n, vsize first_page_num) { Page_spacing_result ret; + if (systems_per_page_ > 0) + { + Page_spacing_result ret = space_systems_with_fixed_number_per_page (configuration, first_page_num); + ret.demerits_ += (ret.force_.size () == n) ? 0 : BAD_SPACING_PENALTY; + return ret; + } + cache_line_details (configuration); bool valid_n = (n >= min_page_count (configuration, first_page_num) && n <= cached_line_details_.size ()); @@ -713,16 +864,37 @@ Page_breaking::space_systems_on_n_pages (vsize configuration, vsize n, vsize fir Real Page_breaking::blank_page_penalty () const { - SCM penalty_sym = is_last () ? ly_symbol2scm ("blank-last-page-force") : ly_symbol2scm ("blank-page-force"); + SCM penalty_sym; + + if (is_last ()) + penalty_sym = ly_symbol2scm ("blank-last-page-force"); + else if (ends_score ()) + penalty_sym = ly_symbol2scm ("blank-after-score-page-force"); + else + penalty_sym = ly_symbol2scm ("blank-page-force"); + + Break_position const &pos = breaks_[current_end_breakpoint_]; + if (Paper_score *ps = system_specs_[pos.system_spec_index_].pscore_) + return robust_scm2double (ps->layout ()->lookup_variable (penalty_sym), 0.0); + return robust_scm2double (book_->paper_->lookup_variable (penalty_sym), 0.0); } +// If systems_per_page_ is positive, we don't really try to space on N +// or N+1 pages; see the comment to space_systems_on_n_pages. Page_spacing_result Page_breaking::space_systems_on_n_or_one_more_pages (vsize configuration, vsize n, vsize first_page_num) { Page_spacing_result n_res; Page_spacing_result m_res; + if (systems_per_page_ > 0) + { + Page_spacing_result ret = space_systems_with_fixed_number_per_page (configuration, first_page_num); + ret.demerits_ += (ret.force_.size () == n || ret.force_.size () == (n-1)) ? 0 : BAD_SPACING_PENALTY; + return ret; + } + cache_line_details (configuration); vsize min_p_count = min_page_count (configuration, first_page_num); bool valid_n = n >= min_p_count || n <= cached_line_details_.size (); @@ -785,9 +957,61 @@ Page_breaking::space_systems_on_best_pages (vsize configuration, vsize first_pag return finalize_spacing_result (configuration, best); } +Page_spacing_result +Page_breaking::space_systems_with_fixed_number_per_page (vsize configuration, + vsize first_page_num) +{ + Page_spacing_result res; + Page_spacing space (page_height (first_page_num, false), page_top_space_); + vsize line = 0; + vsize page = 0; + vsize page_first_line = 0; + + cache_line_details (configuration); + while (line < cached_line_details_.size ()) + { + page++; + space.clear (); + space.resize (page_height (first_page_num + page, false)); + + int system_count_on_this_page = 0; + while (system_count_on_this_page < systems_per_page_ + && line < cached_line_details_.size ()) + { + Line_details const &cur_line = cached_line_details_[line]; + space.append_system (cur_line); + system_count_on_this_page += cur_line.compressed_nontitle_lines_count_; + line++; + + if (cur_line.page_permission_ == ly_symbol2scm ("force")) + break; + } + + res.systems_per_page_.push_back (line - page_first_line); + + res.force_.push_back (space.force_); + res.penalty_ += cached_line_details_[line-1].page_penalty_; + if (system_count_on_this_page != systems_per_page_) + { + res.penalty_ += TERRIBLE_SPACING_PENALTY; + res.system_count_status_ |= ((system_count_on_this_page < systems_per_page_)) + ? SYSTEM_COUNT_TOO_FEW : SYSTEM_COUNT_TOO_MANY; + } + + page_first_line = line; + } + + /* Recalculate forces for the last page because we know now that is + really the last page. */ + space.resize (page_height (first_page_num + page, true)); + res.force_.back () = space.force_; + return finalize_spacing_result (configuration, res); +} + Page_spacing_result Page_breaking::pack_systems_on_least_pages (vsize configuration, vsize first_page_num) { + // TODO: add support for min/max-systems-per-page. Page_spacing_result res; vsize page = 0; vsize page_first_line = 0; @@ -857,7 +1081,7 @@ Page_breaking::finalize_spacing_result (vsize configuration, Page_spacing_result Real line_force = 0; Real line_penalty = 0; - Real page_force = 0; + Real page_demerits = res.penalty_; Real page_weighting = robust_scm2double (book_->paper_->c_variable ("page-spacing-weight"), 10); for (vsize i = 0; i < uncompressed_line_details_.size (); i++) @@ -869,10 +1093,8 @@ Page_breaking::finalize_spacing_result (vsize configuration, Page_spacing_result for (vsize i = 0; i < res.force_.size (); i++) { Real f = res.force_[i]; - if (isinf (f) && res.systems_per_page_[i] == 1) - f = 20000; - page_force += f * f; + page_demerits += min(f*f, BAD_SPACING_PENALTY); } /* for a while we tried averaging page and line forces across pages instead @@ -880,7 +1102,7 @@ Page_breaking::finalize_spacing_result (vsize configuration, Page_spacing_result with a very bad page force (for example because of a forced page break), the page breaker will put in a _lot_ of pages so that the bad force becomes averaged out over many pages. */ - res.demerits_ = line_force + line_penalty + (page_force + res.penalty_) * page_weighting; + res.demerits_ = line_force + line_penalty + page_demerits * page_weighting; return res; } @@ -897,13 +1119,18 @@ Page_breaking::space_systems_on_1_page (vector const &lines, Real { Page_spacing space (page_height, page_top_space_); Page_spacing_result ret; + int line_count = 0; for (vsize i = 0; i < lines.size (); i++) - space.append_system (lines[i]); + { + space.append_system (lines[i]); + line_count += lines[i].compressed_nontitle_lines_count_; + } ret.systems_per_page_.push_back (lines.size ()); ret.force_.push_back (ragged ? min (space.force_, 0.0) : space.force_); - ret.penalty_ = lines.back ().page_penalty_ + lines.back ().turn_penalty_; + ret.penalty_ = line_count_penalty (line_count) + lines.back ().page_penalty_ + lines.back ().turn_penalty_; + ret.system_count_status_ |= line_count_status (line_count); /* don't do finalize_spacing_result () because we are only an internal function */ return ret; @@ -935,24 +1162,48 @@ Page_breaking::space_systems_on_2_pages (vsize configuration, vsize first_page_n vector page1_force; vector page2_force; + + // page1_penalty and page2_penalty store the penalties based + // on min-systems-per-page and max-systems-per-page. + vector page1_penalty; + vector page2_penalty; + + // page1_status and page2_status keep track of whether the min-systems-per-page + // and max-systems-per-page constraints are satisfied. + vector page1_status; + vector page2_status; + Page_spacing page1 (page1_height, page_top_space_); Page_spacing page2 (page2_height, page_top_space_); + int page1_line_count = 0; + int page2_line_count = 0; page1_force.resize (cached_line_details_.size () - 1, infinity_f); page2_force.resize (cached_line_details_.size () - 1, infinity_f); + page1_penalty.resize (cached_line_details_.size () - 1, infinity_f); + page2_penalty.resize (cached_line_details_.size () - 1, infinity_f); + page1_status.resize (cached_line_details_.size () - 1, 0); + page2_status.resize (cached_line_details_.size () - 1, 0); /* find the page 1 and page 2 forces for each page-breaking position */ for (vsize i = 0; i < page1_force.size (); i++) { page1.append_system (cached_line_details_[i]); page2.prepend_system (cached_line_details_[cached_line_details_.size () - 1 - i]); + page1_line_count += cached_line_details_[i].compressed_nontitle_lines_count_; + page2_line_count += cached_line_details_[cached_line_details_.size () - 1 - i].compressed_nontitle_lines_count_; + page1_force[i] = (ragged1 && page1.force_ < 0 && i > 0) ? infinity_f : page1.force_; + page1_penalty[i] = line_count_penalty (page1_line_count); + page1_status[i] = line_count_status (page1_line_count); if (ragged2) page2_force[page2_force.size () - 1 - i] = (page2.force_ < 0 && i + 1 < page1_force.size ()) ? infinity_f : 0; else page2_force[page2_force.size () - 1 - i] = page2.force_; + page2_penalty[page2_penalty.size () - 1 - i] = line_count_penalty (page2_line_count); + page2_status[page2_penalty.size () - 1 - i] = line_count_status (page2_line_count); } /* find the position that minimises the sum of the page forces */ @@ -961,8 +1212,12 @@ Page_breaking::space_systems_on_2_pages (vsize configuration, vsize first_page_n for (vsize i = 0; i < page1_force.size (); i++) { Real f = page1_force[i] * page1_force[i] + page2_force[i] * page2_force[i]; - Real uneven = 2 * (page1_force[i] - page2_force[i]); - Real dem = uneven * uneven + f + + // NOTE: we treat max-systems-per-page and min-systems-per-page as soft + // constraints. That is, we penalize harshly when they don't happen + // but we don't completely reject. + Real dem = f + + page1_penalty[i] + page2_penalty[i] + cached_line_details_[i+1].page_penalty_ + cached_line_details_.back ().page_penalty_ + cached_line_details_.back ().turn_penalty_; if (dem < best_demerits) @@ -977,9 +1232,11 @@ Page_breaking::space_systems_on_2_pages (vsize configuration, vsize first_page_n ret.systems_per_page_.push_back (cached_line_details_.size () - best_sys_count); ret.force_.push_back (page1_force[best_sys_count-1]); ret.force_.push_back (page2_force[best_sys_count-1]); + ret.system_count_status_ = page1_status[best_sys_count-1] | page2_status[best_sys_count-1]; ret.penalty_ = cached_line_details_[best_sys_count-1].page_penalty_ + cached_line_details_.back ().page_penalty_ - + cached_line_details_.back ().turn_penalty_; + + cached_line_details_.back ().turn_penalty_ + + page1_penalty[best_sys_count-1] + page2_penalty[best_sys_count-1]; /* don't do finalize_spacing_result () because we are only an internal function */ return ret; @@ -1008,6 +1265,12 @@ Page_breaking::is_last () const return current_end_breakpoint_ == last_break_position (); } +bool +Page_breaking::ends_score () const +{ + return breaks_[current_end_breakpoint_].score_ender_; +} + vsize Page_breaking::last_break_position () const {