lily/include/constrained-breaking.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2006--2011 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 {
  45   Grob *last_column_;
  46   Real force_;
  47   Line_shape shape_;
  48   vector<Stencil *> footnotes_; /* The footnotes at the bottom of the
  49                                    page, where each stencil represents
  50                                    a different footnote. */
  51   Interval refpoint_extent_; /* The refpoints of the first and last
  52                                 spaceable staff in this line.  min-distance
  53                                 should be measured from the bottom
  54                                 refpoint_extent of one line to the
  55                                 top refpoint_extent of the next. */
  56   Real tallness_; /* Y-extent, adjusted according to begin/rest-of-line*/
  57
  58   Real padding_;  /* compulsory space after this system (if we're not
  59                      last on a page) */
  60   Real title_padding_;
  61   Real min_distance_;
  62   Real title_min_distance_;
  63   Real bottom_padding_;
  64   Real space_;    /* spring length */
  65   Real title_space_;
  66   Real inverse_hooke_;
  67
  68   SCM break_permission_;
  69   SCM page_permission_;
  70   SCM turn_permission_;
  71   Real break_penalty_;
  72   Real page_penalty_;
  73   Real turn_penalty_;
  74
  75   bool title_;
  76
  77   /* The page-breaker deals with forbidden page breaks by "compressing"
  78      two Line_detailses into one. The following fields are used by the
  79      page-breaker to keep track of this. If the number of fields needed
  80      by the page-breaker grows, it might be a good idea to create a separate
  81      class. */
  82   int compressed_lines_count_;
  83   int compressed_nontitle_lines_count_;
  84   bool last_markup_line_;
  85   bool first_markup_line_;
  86   bool tight_spacing_;
  87
  88   Line_details ()
  89   {
  90     last_column_ = 0;
  91     force_ = infinity_f;
  92     padding_ = 0;
  93     title_padding_ = 0;
  94     bottom_padding_ = 0;
  95     min_distance_ = 0;
  96     title_min_distance_ = 0;
  97     space_ = 0;
  98     title_space_ = 0;
  99     inverse_hooke_ = 1;
 100     tight_spacing_ = false;
 101     break_permission_ = ly_symbol2scm ("allow");
 102     page_permission_ = ly_symbol2scm ("allow");
 103     turn_permission_ = ly_symbol2scm ("allow");
 104     break_penalty_ = 0;
 105     page_penalty_ = 0;
 106     turn_penalty_ = 0;
 107     title_ = false;
 108     compressed_lines_count_ = 1;
 109     compressed_nontitle_lines_count_ = 1;
 110     last_markup_line_ = false;
 111     first_markup_line_ = false;
 112     tallness_ = 0;
 113     refpoint_extent_ = Interval (0, 0);
 114   }
 115
 116   Line_details (Prob *pb, Output_def *paper);
 117   Real full_height () const;
 118   Real tallness () const;
 119   Real spring_length (Line_details const &next_line) const;
 120 };
 121
 122 /*
 123    Helper to trace back an optimal path
 124 */
 125 struct Constrained_break_node
 126 {
 127   /* the number of bars in all the systems before this one
 128   */
 129   int prev_;
 130
 131   /* unlike the Gourlay breaker, this is the sum of all demerits up to,
 132    * and including, this line */
 133   Real demerits_;
 134   struct Line_details details_;
 135
 136   Constrained_break_node ()
 137   {
 138     prev_ = -1;
 139     demerits_ = infinity_f;
 140   }
 141
 142   void print () const
 143   {
 144     printf ("prev break %d, demerits %f\n", prev_, demerits_);
 145   }
 146 };
 147
 148 /*
 149    A dynamic programming solution to breaking scores into lines
 150 */
 151 class Constrained_breaking
 152 {
 153 public:
 154   vector<Column_x_positions> solve (vsize start, vsize end, vsize sys_count);
 155   vector<Column_x_positions> best_solution (vsize start, vsize end);
 156   vector<Line_details> line_details (vsize start, vsize end, vsize sys_count);
 157
 158   Constrained_breaking (Paper_score *ps);
 159   Constrained_breaking (Paper_score *ps, vector<vsize> const &start_col_posns);
 160
 161   int max_system_count (vsize start, vsize end);
 162   int min_system_count (vsize start, vsize end);
 163
 164 private:
 165   Paper_score *pscore_;
 166   vsize valid_systems_;
 167   vsize systems_;
 168   bool ragged_right_;
 169   bool ragged_last_;
 170
 171   Real system_system_min_distance_;
 172   Real system_system_padding_;
 173   Real system_system_space_;
 174   Real system_markup_space_;
 175   Real score_system_min_distance_;
 176   Real score_system_padding_;
 177   Real score_markup_min_distance_;
 178   Real score_markup_padding_;
 179
 180   /* the (i,j)th entry is the configuration for breaking between
 181     columns i and j */
 182   Matrix<Line_details> lines_;
 183
 184   /* the [i](j,k)th entry is the score for fitting the first k bars onto the
 185     first j systems, starting at the i'th allowed starting column */
 186   vector<Matrix<Constrained_break_node> > state_;
 187
 188   vector<vsize> start_;         /* the columns at which we might be asked to start breaking */
 189   vector<vsize> starting_breakpoints_; /* the corresponding index in breaks_ */
 190
 191   vector<Grob *> all_;
 192   vector<vsize> breaks_;
 193
 194   void initialize ();
 195   void resize (vsize systems);
 196
 197   Column_x_positions space_line (vsize start_col, vsize end_col);
 198   vsize prepare_solution (vsize start, vsize end, vsize sys_count);
 199
 200   Real combine_demerits (Real force, Real prev_force);
 201
 202   bool calc_subproblem (vsize start, vsize systems, vsize max_break_index);
 203   void fill_line_details (Line_details *const, vsize, vsize);
 204 };
 205 #endif /* CONSTRAINED_BREAKING_HH */