lily/page-turn-page-breaking.cc

   1 /*
   2   page-turn-page-breaking.cc -- implement Page_turn_page_breaking
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2006 Joe Neeman <joeneeman@gmail.com>
   7 */
   8
   9 #include "page-turn-page-breaking.hh"
  10
  11 #include "international.hh"
  12 #include "item.hh"
  13 #include "output-def.hh"
  14 #include "page-spacing.hh"
  15 #include "paper-book.hh"
  16 #include "paper-score.hh"
  17 #include "paper-system.hh"
  18 #include "system.hh"
  19 #include "warn.hh"
  20
  21 static bool
  22 is_break (Grob *g)
  23 {
  24   return scm_is_symbol (g->get_property ("page-turn-permission"));
  25 }
  26
  27 Page_turn_page_breaking::Page_turn_page_breaking (Paper_book *pb)
  28   : Page_breaking (pb, is_break)
  29 {
  30 }
  31
  32 Page_turn_page_breaking::~Page_turn_page_breaking ()
  33 {
  34 }
  35
  36 Real
  37 Page_turn_page_breaking::calc_demerits (const Break_node &me)
  38 {
  39   Real prev_f = 0;
  40   Real prev_dem = 0;
  41   Real page_weighting = robust_scm2double (book_->paper_->c_variable ("page-spacing-weight"), 1);
  42   if (me.prev_ != VPOS)
  43     {
  44       prev_f = state_[me.prev_].force_;
  45       prev_dem = state_[me.prev_].demerits_;
  46     }
  47
  48   Real dem = me.force_ * me.force_ * page_weighting
  49            + me.line_force_ * me.line_force_
  50            + fabs (me.force_ - prev_f);
  51   if (isinf (me.line_force_) || isinf (me.force_) || me.page_count_ == 0)
  52     dem = infinity_f;
  53
  54   return dem + prev_dem + me.penalty_ + me.line_penalty_;
  55 }
  56
  57 Page_turn_page_breaking::Break_node
  58 Page_turn_page_breaking::put_systems_on_pages (vsize start,
  59                                                vsize end,
  60                                                vector<Line_details> const &lines,
  61                                                Line_division const &div,
  62                                                int page_number)
  63 {
  64   bool last = end == breaks_.size () - 1;
  65   bool ragged_all = to_boolean (book_->paper_->c_variable ("ragged-bottom"));
  66   bool ragged_last = last && to_boolean (book_->paper_->c_variable ("ragged-last-bottom"));
  67   Real page_h = page_height (1, false); // FIXME
  68   SCM force_sym = last ? ly_symbol2scm ("blank-last-page-force") : ly_symbol2scm ("blank-page-force");
  69   Real blank_force = robust_scm2double (book_->paper_->lookup_variable (force_sym), 0);
  70   int min_p_count = min_page_count (lines, page_h, ragged_all, ragged_last);
  71   bool auto_first = to_boolean (book_->paper_->c_variable ("auto-first-page-number"));
  72
  73   /* If [START, END] does not contain an intermediate
  74      breakpoint, we may need to consider solutions that result in a bad turn.
  75      In this case, we won't abort if the min_page_count is too big */
  76   if (start < end - 1 && min_p_count > 2)
  77     return Break_node ();
  78
  79   /* if PAGE-NUMBER is odd, we are starting on a right hand page. That is, we
  80      have the options
  81      PAGE-NUMBER odd:
  82        - even number of pages + a blank page
  83        - odd number of pages
  84      PAGE-NUMBER even:
  85        - odd number of pages + a blank page
  86        - even number of pages
  87
  88      No matter which case PAGE-NUMBER falls into, we take the second choice if
  89      min_p_count has that evenness. (For example, if PAGE-NUMBER is even and
  90      min_p_count is even, we don't even consider the blank page option). */
  91
  92   Spacing_result result;
  93   if (start == 0 && auto_first)
  94     {
  95       if (min_p_count % 2)
  96         result = space_systems_on_n_or_one_more_pages (lines, min_p_count, page_h, 0, ragged_all, ragged_last);
  97       else
  98         result = space_systems_on_n_pages (lines, min_p_count, page_h, ragged_all, ragged_last);
  99     }
 100   else if (page_number % 2 == min_p_count % 2)
 101     result = space_systems_on_n_pages (lines, min_p_count, page_h, ragged_all, ragged_last);
 102   else
 103     result = space_systems_on_n_or_one_more_pages (lines, min_p_count, page_h, blank_force, ragged_all, ragged_last);
 104
 105   Break_node ret;
 106   ret.prev_ = start - 1;
 107   ret.break_pos_ = end;
 108   ret.page_count_ = result.force_.size ();
 109   ret.first_page_number_ = page_number;
 110   if (auto_first && start == 0)
 111     ret.first_page_number_ += 1 - (ret.page_count_ % 2);
 112   ret.force_ = 0;
 113   for (vsize i = 0; i < result.force_.size (); i++)
 114     ret.force_ += fabs (result.force_[i]);
 115
 116   ret.penalty_ = result.penalty_;
 117   ret.div_ = div;
 118   ret.system_count_ = result.systems_per_page_;
 119
 120   ret.too_many_lines_ = true;
 121   ret.line_force_ = 0;
 122   ret.line_penalty_ = 0;
 123   for (vsize i = 0; i < lines.size (); i++)
 124     {
 125       ret.line_force_ += fabs (lines[i].force_);
 126       ret.line_penalty_ += lines[i].break_penalty_;
 127       if (lines[i].force_ < 0)
 128         ret.too_many_lines_ = false;
 129     }
 130   return ret;
 131 }
 132
 133 /* "final page" meaning the number of the final right-hand page,
 134    which always has an odd page number */
 135 vsize
 136 Page_turn_page_breaking::final_page_num (Break_node const &b)
 137 {
 138   vsize end = b.first_page_number_ + b.page_count_;
 139   return end + 1 - (end % 2);
 140 }
 141
 142 void
 143 Page_turn_page_breaking::calc_subproblem (vsize ending_breakpoint)
 144 {
 145   vsize end = ending_breakpoint + 1;
 146   Break_node best;
 147   Break_node cur;
 148   Break_node this_start_best;
 149   vsize prev_best_system_count = 0;
 150
 151   for (vsize start = end; start--;)
 152     {
 153       if (start < end-1
 154           && breakpoint_property (start+1, "page-turn-permission") == ly_symbol2scm ("force"))
 155         break;
 156
 157       if (start > 0 && best.demerits_ < state_[start-1].demerits_)
 158         continue;
 159
 160       int p_num = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1);
 161       if (start > 0)
 162         {
 163           /* except possibly for the first page, enforce the fact that first_page_number_
 164              should always be even (left hand page).
 165              TODO: are there different conventions in right-to-left languages?
 166           */
 167           p_num = state_[start-1].first_page_number_ + state_[start-1].page_count_;
 168           p_num += p_num % 2;
 169         }
 170
 171       Line_division min_division;
 172       Line_division max_division;
 173
 174       vsize min_sys_count = min_system_count (start, end);
 175       vsize max_sys_count = max_system_count (start, end);
 176       this_start_best.demerits_ = infinity_f;
 177
 178       bool ok_page = true;
 179
 180       /* heuristic: we've just added a breakpoint, we'll need at least as
 181          many systems as before */
 182       min_sys_count = max (min_sys_count, prev_best_system_count);
 183       for (vsize sys_count = min_sys_count; sys_count <= max_sys_count && ok_page; sys_count++)
 184         {
 185           vector<Line_division> div = line_divisions (start, end, sys_count, min_division, max_division);
 186           bool found = false;
 187
 188           for (vsize d = 0; d < div.size (); d++)
 189             {
 190               vector<Line_details> line = line_details (start, end, div[d]);
 191
 192               cur = put_systems_on_pages (start, end, line, div[d], p_num);
 193               cur.demerits_ = calc_demerits (cur);
 194
 195               if (isinf (cur.demerits_)
 196                   || (cur.page_count_ > 2
 197                       && (!isinf (this_start_best.demerits_))
 198                       && final_page_num (cur) > final_page_num (this_start_best)))
 199                 {
 200                   ok_page = false;
 201                   break;
 202                 }
 203
 204               if (cur.demerits_ < this_start_best.demerits_)
 205                 {
 206                   found = true;
 207                   this_start_best = cur;
 208                   prev_best_system_count = sys_count;
 209
 210                   /* heuristic: if we increase the number of systems, we can bound the
 211                      division from below by our current best division */
 212                   min_division = div[d];
 213                 }
 214             }
 215           if (!found && this_start_best.too_many_lines_)
 216             break;
 217         }
 218       if (isinf (this_start_best.demerits_))
 219         {
 220           assert (!isinf (best.demerits_) && start < end - 1);
 221           break;
 222         }
 223
 224       if (start == 0 && end == 1
 225           && this_start_best.first_page_number_ == 1
 226           && this_start_best.page_count_ > 1)
 227         warning (_ ("couldn't fit the first page turn onto a single page. "
 228                     "Consider setting first-page-number to an even number."));
 229
 230       if (this_start_best.demerits_ < best.demerits_)
 231         best = this_start_best;
 232     }
 233   state_.push_back (best);
 234 }
 235
 236 SCM
 237 Page_turn_page_breaking::solve ()
 238 {
 239   state_.clear ();
 240   message (_f ("Calculating page and line breaks (%d possible page breaks)...",
 241                (int)breaks_.size () - 1) + " ");
 242   for (vsize i = 0; i < breaks_.size () - 1; i++)
 243     {
 244       calc_subproblem (i);
 245       progress_indication (string ("[") + to_string (i + 1) + "]");
 246     }
 247   progress_indication ("\n");
 248
 249   vector<Break_node> breaking;
 250   int i = state_.size () - 1;
 251   while (i >= 0)
 252     {
 253       breaking.push_back (state_[i]);
 254       i = state_[i].prev_;
 255     }
 256   reverse (breaking);
 257
 258   message (_ ("Drawing systems..."));
 259   SCM systems = make_lines (&breaking);
 260   return make_pages (breaking, systems);
 261 }
 262
 263 /* do the line breaking in all the scores and return a big list of systems */
 264 SCM
 265 Page_turn_page_breaking::make_lines (vector<Break_node> *psoln)
 266 {
 267   vector<Break_node> &soln = *psoln;
 268   for (vsize n = 0; n < soln.size (); n++)
 269     {
 270       vsize start = n > 0 ? soln[n-1].break_pos_ : 0;
 271       vsize end = soln[n].break_pos_;
 272
 273       break_into_pieces (start, end, soln[n].div_);
 274     }
 275
 276   return systems ();
 277 }
 278
 279 SCM
 280 Page_turn_page_breaking::make_pages (vector<Break_node> const &soln, SCM systems)
 281 {
 282   vector<vsize> lines_per_page;
 283   for (vsize i = 0; i < soln.size (); i++)
 284     {
 285       for (vsize j = 0; j < soln[i].page_count_; j++)
 286         lines_per_page.push_back (soln[i].system_count_[j]);
 287
 288       if (i < soln.size () - 1 && (soln[i].first_page_number_ + soln[i].page_count_) % 2)
 289         /* add a blank page */
 290         lines_per_page.push_back (0);
 291     }
 292
 293   /* this should only actually modify first-page-number if
 294      auto-first-page-number was true. */
 295   book_->paper_->set_variable (ly_symbol2scm ("first-page-number"),
 296                                scm_from_int (soln[0].first_page_number_));
 297   return Page_breaking::make_pages (lines_per_page, systems);
 298 }