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