lily/optimal-page-breaking.cc

   1 /*
   2   optimal-page-breaking.cc -- implement a page-breaker that
   3   will break pages in such a way that both horizontal and
   4   vertical spacing will be acceptable
   5
   6   source file of the GNU LilyPond music typesetter
   7
   8   (c) 2006--2008 Joe Neeman <joeneeman@gmail.com>
   9 */
  10
  11 #include "international.hh"
  12 #include "optimal-page-breaking.hh"
  13 #include "output-def.hh"
  14 #include "page-spacing.hh"
  15 #include "paper-book.hh"
  16 #include "paper-score.hh"
  17 #include "prob.hh"
  18 #include "system.hh"
  19
  20 static bool
  21 is_break (Grob *)
  22 {
  23   return false;
  24 }
  25
  26 Optimal_page_breaking::Optimal_page_breaking (Paper_book *pb)
  27   : Page_breaking (pb, is_break)
  28 {
  29 }
  30
  31 Optimal_page_breaking::~Optimal_page_breaking ()
  32 {
  33 }
  34
  35 SCM
  36 Optimal_page_breaking::solve ()
  37 {
  38   vsize end = last_break_position ();
  39   vsize max_sys_count = max_system_count (0, end);
  40   vsize first_page_num = robust_scm2int (book_->paper_->c_variable ("first-page-number"), 1);
  41   SCM forced_page_count = book_->paper_->c_variable ("page-count");
  42
  43   set_to_ideal_line_configuration (0, end);
  44
  45   Page_spacing_result best;
  46   vsize page_count = robust_scm2int (forced_page_count, 1);
  47   Line_division ideal_line_division = current_configuration (0);
  48   Line_division best_division = ideal_line_division;
  49   vsize min_sys_count = 1;
  50   vsize ideal_sys_count = system_count ();
  51
  52   if (!scm_is_integer (forced_page_count))
  53     {
  54       /* find out the ideal number of pages */
  55       message (_ ("Finding the ideal number of pages..."));
  56
  57       best = space_systems_on_best_pages (0, first_page_num);
  58       page_count = best.systems_per_page_.size ();
  59
  60       ideal_sys_count = best.system_count ();
  61       min_sys_count = ideal_sys_count - best.systems_per_page_.back ();
  62
  63       if (page_count > 1 && best.systems_per_page_[page_count - 2] > 1)
  64         min_sys_count -= best.systems_per_page_[page_count - 2];
  65
  66       min_sys_count = max (min_sys_count, (vsize)1);
  67     }
  68   else
  69     {
  70       /* todo: the following line will spit out programming errors if the
  71          ideal line spacing doesn't fit on PAGE_COUNT pages */
  72       best = space_systems_on_n_pages (0, page_count, first_page_num);
  73       min_sys_count = page_count;
  74     }
  75
  76   if (page_count == 1)
  77     message (_ ("Fitting music on 1 page..."));
  78   else if (scm_is_integer (forced_page_count))
  79     message (_f ("Fitting music on %d pages...", (int)page_count));
  80   else
  81     message (_f ("Fitting music on %d or %d pages...", (int)page_count-1, (int)page_count));
  82
  83   /* try a smaller number of systems than the ideal number for line breaking */
  84   Line_division bound = ideal_line_division;
  85   for (vsize sys_count = ideal_sys_count; --sys_count >= min_sys_count;)
  86     {
  87       Page_spacing_result best_for_this_sys_count;
  88       set_current_breakpoints (0, end, sys_count, Line_division (), bound);
  89
  90       for (vsize i = 0; i < current_configuration_count (); i++)
  91         {
  92           vsize min_p_count = min_page_count (i, first_page_num);
  93           Page_spacing_result cur;
  94
  95           if (min_p_count == page_count || scm_is_integer (forced_page_count))
  96             cur = space_systems_on_n_pages (i, page_count, first_page_num);
  97           else
  98             cur = space_systems_on_n_or_one_more_pages (i, page_count-1, first_page_num);
  99
 100           if (cur.demerits_ < best_for_this_sys_count.demerits_ || isinf (best_for_this_sys_count.demerits_))
 101             {
 102               best_for_this_sys_count = cur;
 103               bound = current_configuration (i);
 104             }
 105         }
 106
 107       if (best_for_this_sys_count.demerits_ < best.demerits_ || isinf (best.demerits_))
 108         {
 109           best = best_for_this_sys_count;
 110           best_division = bound;
 111         }
 112
 113       /* if the pages are stretched on average, stop trying to reduce sys_count */
 114       if (best_for_this_sys_count.page_count () < page_count
 115           && best_for_this_sys_count.average_force () > 0)
 116         break;
 117
 118
 119       if (isinf (best_for_this_sys_count.demerits_))
 120         break;
 121     }
 122
 123   /* try a larger number of systems than the ideal line breaking number. This
 124      is more or less C&P, but the loop bounds make it difficult to try something
 125      like do {...} while (flip(&d) != UP). */
 126   bound = ideal_line_division;
 127   for (vsize sys_count = ideal_sys_count+1; sys_count <= max_sys_count; sys_count++)
 128     {
 129       Real best_demerits_for_this_sys_count = infinity_f;
 130       set_current_breakpoints (0, end, sys_count, bound);
 131
 132       for (vsize i = 0; i < current_configuration_count (); i++)
 133         {
 134           vsize min_p_count = min_page_count (i, first_page_num);
 135           Page_spacing_result cur;
 136
 137           if (min_p_count > page_count)
 138             continue;
 139           else
 140             cur = space_systems_on_n_pages (i, page_count, first_page_num);
 141
 142           if (cur.demerits_ < best.demerits_ || isinf (best.demerits_))
 143             {
 144               best = cur;
 145               best_division = current_configuration (i);
 146             }
 147
 148           if (cur.demerits_ < best_demerits_for_this_sys_count || isinf (best_demerits_for_this_sys_count))
 149             {
 150               best_demerits_for_this_sys_count = cur.demerits_;
 151               bound = current_configuration (i);
 152             }
 153         }
 154       if (isinf (best_demerits_for_this_sys_count))
 155         break;
 156     }
 157
 158   message (_ ("Drawing systems..."));
 159   break_into_pieces (0, end, best_division);
 160   SCM lines = systems ();
 161   return make_pages (best.systems_per_page_, lines);
 162 }
 163