lily/include/constrained-breaking.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2006--2010 Joe Neeman <joeneeman@gmail.com>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef CONSTRAINED_BREAKING_HH
  21 #define CONSTRAINED_BREAKING_HH
  22
  23 #include "lily-guile.hh"
  24 #include "matrix.hh"
  25 #include "prob.hh"
  26
  27 /*
  28  * Begin/rest-of-line hack.  This geometrical shape is a crude approximation
  29  * of Skyline, but it is better than a rectangle.
  30  */
  31 struct Line_shape
  32 {
  33   Interval begin_;
  34   Interval rest_;
  35
  36   Line_shape ()
  37   {
  38   }
  39   Line_shape (Interval begin, Interval rest);
  40   Line_shape piggyback (Line_shape mount, Real padding) const;
  41 };
  42
  43 struct Line_details {
  44   Grob *last_column_;
  45   Real force_;
  46   Line_shape shape_;
  47   Interval refpoint_extent_; /* The refpoints of the first and last
  48                                 spaceable staff in this line.  min-distance
  49                                 should be measured from the bottom
  50                                 refpoint_extent of one line to the
  51                                 top refpoint_extent of the next. */
  52   Real tallness_; /* Y-extent, adjusted according to begin/rest-of-line*/
  53
  54   Real padding_;  /* compulsory space after this system (if we're not
  55                      last on a page) */
  56   Real title_padding_;
  57   Real min_distance_;
  58   Real title_min_distance_;
  59   Real bottom_padding_;
  60   Real space_;    /* spring length */
  61   Real inverse_hooke_;
  62
  63   SCM break_permission_;
  64   SCM page_permission_;
  65   SCM turn_permission_;
  66   Real break_penalty_;
  67   Real page_penalty_;
  68   Real turn_penalty_;
  69
  70   bool title_;
  71
  72   /* The page-breaker deals with forbidden page breaks by "compressing"
  73      two Line_detailses into one. The following fields are used by the
  74      page-breaker to keep track of this. If the number of fields needed
  75      by the page-breaker grows, it might be a good idea to create a separate
  76      class. */
  77   int compressed_lines_count_;
  78   int compressed_nontitle_lines_count_;
  79   bool last_markup_line_;
  80   bool first_markup_line_;
  81   bool tight_spacing_;
  82
  83   Line_details ()
  84   {
  85     last_column_ = 0;
  86     force_ = infinity_f;
  87     padding_ = 0;
  88     title_padding_ = 0;
  89     bottom_padding_ = 0;
  90     min_distance_ = 0;
  91     title_min_distance_ = 0;
  92     space_ = 0;
  93     inverse_hooke_ = 1;
  94     tight_spacing_ = false;
  95     break_permission_ = ly_symbol2scm ("allow");
  96     page_permission_ = ly_symbol2scm ("allow");
  97     turn_permission_ = ly_symbol2scm ("allow");
  98     break_penalty_ = 0;
  99     page_penalty_ = 0;
 100     turn_penalty_ = 0;
 101     title_ = false;
 102     compressed_lines_count_ = 1;
 103     compressed_nontitle_lines_count_ = 1;
 104     last_markup_line_ = false;
 105     first_markup_line_ = false;
 106     tallness_ = 0;
 107     refpoint_extent_ = Interval (0, 0);
 108   }
 109
 110   Line_details (Prob *pb, Output_def *paper);
 111   Real full_height () const;
 112   Real tallness () const;
 113 };
 114
 115 /*
 116    Helper to trace back an optimal path
 117 */
 118 struct Constrained_break_node
 119 {
 120   /* the number of bars in all the systems before this one
 121   */
 122   int prev_;
 123
 124   /* unlike the Gourlay breaker, this is the sum of all demerits up to,
 125    * and including, this line */
 126   Real demerits_;
 127   struct Line_details details_;
 128
 129   Constrained_break_node ()
 130   {
 131     prev_ = -1;
 132     demerits_ = infinity_f;
 133   }
 134
 135   void print () const
 136   {
 137     printf ("prev break %d, demerits %f\n", prev_, demerits_);
 138   }
 139 };
 140
 141 /*
 142    A dynamic programming solution to breaking scores into lines
 143 */
 144 class Constrained_breaking
 145 {
 146 public:
 147   vector<Column_x_positions> solve (vsize start, vsize end, vsize sys_count);
 148   vector<Column_x_positions> best_solution (vsize start, vsize end);
 149   vector<Line_details> line_details (vsize start, vsize end, vsize sys_count);
 150
 151   Constrained_breaking (Paper_score *ps);
 152   Constrained_breaking (Paper_score *ps, vector<vsize> const &start_col_posns);
 153
 154   int max_system_count (vsize start, vsize end);
 155   int min_system_count (vsize start, vsize end);
 156
 157 private:
 158   Paper_score *pscore_;
 159   vsize valid_systems_;
 160   vsize systems_;
 161   bool ragged_right_;
 162   bool ragged_last_;
 163
 164   Real system_system_min_distance_;
 165   Real system_system_padding_;
 166   Real system_system_space_;
 167   Real score_system_min_distance_;
 168   Real score_system_padding_;
 169   Real score_markup_min_distance_;
 170   Real score_markup_padding_;
 171
 172   /* the (i,j)th entry is the configuration for breaking between
 173     columns i and j */
 174   Matrix<Line_details> lines_;
 175
 176   /* the [i](j,k)th entry is the score for fitting the first k bars onto the
 177     first j systems, starting at the i'th allowed starting column */
 178   vector<Matrix<Constrained_break_node> > state_;
 179
 180   vector<vsize> start_;         /* the columns at which we might be asked to start breaking */
 181   vector<vsize> starting_breakpoints_; /* the corresponding index in breaks_ */
 182
 183   vector<Grob*> all_;
 184   vector<vsize> breaks_;
 185
 186   void initialize ();
 187   void resize (vsize systems);
 188
 189   Column_x_positions space_line (vsize start_col, vsize end_col);
 190   vsize prepare_solution (vsize start, vsize end, vsize sys_count);
 191
 192   Real combine_demerits (Real force, Real prev_force);
 193
 194   bool calc_subproblem (vsize start, vsize systems, vsize max_break_index);
 195   void fill_line_details (Line_details *const, vsize, vsize);
 196 };
 197 #endif /* CONSTRAINED_BREAKING_HH */