lily/gourlay-breaking.cc

   1 /*
   2   gourlay-breaking.cc -- implement Gourlay_breaking
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8 #include <math.h>               // rint
   9
  10 #include "gourlay-breaking.hh"
  11 #include "column-x-positions.hh"
  12 #include "debug.hh"
  13 #include "paper-column.hh"
  14 #include "paper-score.hh"
  15 #include "paper-def.hh"
  16 #include "simple-spacer.hh"
  17 #include "line-of-score.hh"
  18
  19 /// How often to print operator pacification marks?
  20 const int HAPPY_DOTS_I = 3;
  21
  22 /**
  23   Helper to trace back an optimal path
  24  */
  25 struct Break_node {
  26   /** this was the previous. If negative, this break should not be
  27     considered: this path has infinite energy
  28
  29     */
  30   int prev_break_i_;
  31   /**
  32      Which system number so far?
  33    */
  34   int line_i_;
  35
  36   Real demerits_f_;
  37   Column_x_positions line_config_;
  38
  39   Break_node ()
  40   {
  41     prev_break_i_ = -1;
  42     line_i_ = 0;
  43     demerits_f_ = 0;
  44   }
  45 };
  46
  47 /**
  48   This algorithms is adapted from the OSU Tech report on breaking lines.
  49
  50   this function is longish, but not very complicated.
  51
  52  */
  53 Array<Column_x_positions>
  54 Gourlay_breaking::do_solve () const
  55 {
  56   Array<Break_node> optimal_paths;
  57   Link_array<Grob> all =
  58     pscore_l_->line_l_->column_l_arr ();
  59
  60   Array<int> breaks = find_break_indices ();
  61
  62   optimal_paths.set_size (breaks.size ());
  63
  64   Break_node first_node ;
  65
  66   optimal_paths[0] = first_node;
  67   int break_idx=1;
  68
  69   Real worst_force = 0.0;
  70
  71   for (; break_idx< breaks.size (); break_idx++)
  72     {
  73       /*
  74         start with a short line, add measures. At some point
  75         the line becomes infeasible. Then we don't try to add more
  76         */
  77       int minimal_start_idx = -1;
  78       Column_x_positions minimal_sol;
  79       Column_x_positions backup_sol;
  80
  81       Real minimal_demerits = infinity_f;
  82
  83       for (int start_idx = break_idx; start_idx--;)
  84         {
  85           Link_array<Grob> line = all.slice (breaks[start_idx], breaks[break_idx]+1);
  86
  87           line[0]     = dynamic_cast<Item*> (line[0])    ->find_prebroken_piece (RIGHT);
  88           line.top () = dynamic_cast<Item*> (line.top ())->find_prebroken_piece (LEFT);
  89
  90           Column_x_positions cp;
  91           cp.cols_ = line;
  92
  93           Interval line_dims
  94             = pscore_l_->paper_l_->line_dimensions_int (optimal_paths[start_idx].line_i_);
  95           Simple_spacer * sp = generate_spacing_problem (line, line_dims);
  96           sp->solve (&cp);
  97           delete sp;
  98
  99           if (cp.force_f_ > worst_force)
 100             worst_force = cp.force_f_;
 101
 102           /*
 103             We remember this solution as a "should always work
 104             solution", in case everything fucks up.  */
 105           if (start_idx == break_idx - 1)
 106             backup_sol = cp;
 107           if (!cp.satisfies_constraints_b_)
 108             {
 109               /*
 110                 If it doesn't satisfy constraints, we make this one
 111                 really unattractive.
 112               */
 113               cp.force_f_ += worst_force;
 114               cp.force_f_ *= 10;
 115             }
 116
 117           Real this_demerits;
 118
 119           if (optimal_paths[start_idx].demerits_f_ >= infinity_f)
 120             this_demerits = infinity_f;
 121           else
 122             this_demerits = combine_demerits (optimal_paths[start_idx].line_config_, cp)
 123               + optimal_paths[start_idx].demerits_f_;
 124
 125           if (this_demerits < minimal_demerits)
 126             {
 127               minimal_start_idx = start_idx;
 128               minimal_sol = cp;
 129               minimal_demerits = this_demerits;
 130             }
 131
 132           /*
 133             we couldn't satisfy the constraints, this won't get better
 134             if we add more columns, so we get on with the next one
 135           */
 136           if (!cp.satisfies_constraints_b_)
 137             break ;
 138         }
 139
 140       int prev =break_idx - 1;
 141       if (minimal_start_idx < 0)
 142         {
 143           optimal_paths[break_idx].demerits_f_ = infinity_f;
 144           optimal_paths[break_idx].line_config_ = backup_sol;
 145         }
 146       else
 147         {
 148           prev = minimal_start_idx;
 149           optimal_paths[break_idx].line_config_ = minimal_sol;
 150           optimal_paths[break_idx].demerits_f_ = minimal_demerits;
 151         }
 152       optimal_paths[break_idx].prev_break_i_ = prev;
 153       optimal_paths[break_idx].line_i_ = optimal_paths[prev].line_i_ + 1;
 154
 155       if (! (break_idx % HAPPY_DOTS_I))
 156         progress_indication (String ("[") + to_str (break_idx) + "]");
 157     }
 158
 159   /* do the last one */
 160   if (break_idx % HAPPY_DOTS_I)
 161     progress_indication (String ("[") + to_str (break_idx) + "]");
 162
 163
 164   progress_indication ("\n");
 165
 166   Array<int> final_breaks;
 167   Array<Column_x_positions> lines;
 168
 169   /* skip 0-th element, since it is a "dummy" elt*/
 170   for (int i = optimal_paths.size ()-1; i> 0;)
 171     {
 172       final_breaks.push (i);
 173       int prev = optimal_paths[i].prev_break_i_;
 174       assert (i > prev);
 175       i = prev;
 176     }
 177
 178   if (optimal_paths.top ().demerits_f_ >= infinity_f)
 179     warning (_ ("No feasible line breaking found"));
 180
 181   for (int i= final_breaks.size (); i--;)
 182     {
 183       Column_x_positions cp (optimal_paths[final_breaks[i]].line_config_);
 184
 185       lines.push (cp);
 186       if(!cp.satisfies_constraints_b_)
 187         warning ("Could not find line breaking that satisfies constraints.");
 188     }
 189   return lines;
 190 }
 191
 192
 193 Gourlay_breaking::Gourlay_breaking ()
 194 {
 195 }
 196
 197
 198
 199 /*
 200   TODO: uniformity parameter to control rel. importance of spacing differences.
 201  */
 202 Real
 203 Gourlay_breaking::combine_demerits (Column_x_positions const &prev,
 204                                     Column_x_positions const &this_one) const
 205 {
 206   Real break_penalties = 0.0;
 207   Grob * pc = this_one.cols_.top ();
 208   if (pc->original_l_)
 209     {
 210       SCM pen = pc->get_grob_property ("penalty");
 211       if (gh_number_p (pen))
 212         {
 213           break_penalties += gh_scm2double (pen);
 214         }
 215     }
 216
 217   return abs (this_one.force_f_) + abs (prev.force_f_ - this_one.force_f_)
 218     + break_penalties;
 219 }
 220