lily/page-turn-engraver.cc

   1 /*
   2   page-turn-engraver.cc -- implement Page_turn_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2006 Joe Neeman <joeneeman@gmail.com>
   7 */
   8
   9 #include "engraver.hh"
  10
  11 #include "context.hh"
  12 #include "duration.hh"
  13 #include "grob.hh"
  14 #include "international.hh"
  15 #include "moment.hh"
  16 #include "paper-column.hh"
  17 #include "stream-event.hh"
  18 #include "warn.hh"
  19
  20 #include "translator.icc"
  21
  22 class Page_turn_event {
  23 public:
  24   SCM permission_;
  25   Real penalty_;
  26   Interval_t<Rational> duration_;
  27
  28   Page_turn_event (Rational start, Rational end, SCM perm, Real pen)
  29   {
  30     duration_[LEFT] = start;
  31     duration_[RIGHT] = end;
  32     permission_ = perm;
  33     penalty_ = pen;
  34   }
  35
  36   /* Suppose we have decided on a possible page turn, only to change
  37      out mind later (for example, if there is a volta repeat and it
  38      would be difficult to turn the page back). Then we need to
  39      re-penalize a region of the piece. Depending on how the events
  40      intersect, we may have to split it into as many as 3 pieces.
  41   */
  42   vector<Page_turn_event> penalize (Page_turn_event const &penalty)
  43   {
  44     Interval_t<Rational> intersect = intersection (duration_, penalty.duration_);
  45     vector<Page_turn_event> ret;
  46
  47     if (intersect.is_empty ())
  48       {
  49         ret.push_back (*this);
  50         return ret;
  51       }
  52
  53     Real new_pen = max (penalty_, penalty.penalty_);
  54
  55     if (duration_[LEFT] < penalty.duration_[LEFT])
  56       ret.push_back (Page_turn_event (duration_[LEFT], penalty.duration_[LEFT], permission_, penalty_));
  57
  58     if (penalty.permission_ != SCM_EOL)
  59       ret.push_back (Page_turn_event (intersect[LEFT], intersect[RIGHT], permission_, new_pen));
  60
  61     if (penalty.duration_[RIGHT] < duration_[RIGHT])
  62       ret.push_back (Page_turn_event (penalty.duration_[RIGHT], duration_[RIGHT], permission_, penalty_));
  63
  64     return ret;
  65   }
  66 };
  67
  68 class Page_turn_engraver : public Engraver
  69 {
  70   Moment rest_begin_;
  71   Moment repeat_begin_;
  72   Moment note_end_;
  73   Rational repeat_begin_rest_length_;
  74
  75   vector<Page_turn_event> forced_breaks_;
  76   vector<Page_turn_event> automatic_breaks_;
  77   vector<Page_turn_event> repeat_penalties_;
  78
  79   /* the next 3 are in sync (ie. same number of elements, etc.) */
  80   vector<Rational> breakable_moments_;
  81   vector<Grob*> breakable_columns_;
  82   vector<bool> special_barlines_;
  83
  84   SCM max_permission (SCM perm1, SCM perm2);
  85   Real penalty (Rational rest_len);
  86   Grob *breakable_column (Page_turn_event const &);
  87
  88 protected:
  89   DECLARE_TRANSLATOR_LISTENER (break);
  90   DECLARE_ACKNOWLEDGER (note_head);
  91
  92 public:
  93   TRANSLATOR_DECLARATIONS (Page_turn_engraver);
  94   void stop_translation_timestep ();
  95   void start_translation_timestep ();
  96   void finalize ();
  97 };
  98
  99 Page_turn_engraver::Page_turn_engraver ()
 100 {
 101   repeat_begin_ = Moment (-1);
 102   repeat_begin_rest_length_ = 0;
 103   rest_begin_ = 0;
 104   note_end_ = 0;
 105 }
 106
 107 Grob*
 108 Page_turn_engraver::breakable_column (Page_turn_event const &brk)
 109 {
 110   vsize start = lower_bound (breakable_moments_, brk.duration_[LEFT], less<Rational> ());
 111   vsize end = upper_bound (breakable_moments_, brk.duration_[RIGHT], less<Rational> ());
 112
 113   if (start == breakable_moments_.size ())
 114     return NULL;
 115   if (end == 0)
 116     return NULL;
 117   end--;
 118
 119   for (vsize i = end + 1; i-- > start;)
 120     if (special_barlines_[i])
 121       return breakable_columns_[i];
 122
 123   return breakable_columns_[end];
 124 }
 125
 126 Real
 127 Page_turn_engraver::penalty (Rational rest_len)
 128 {
 129   Rational min_turn = robust_scm2moment (get_property ("minimumPageTurnLength"), Moment (1)).main_part_;
 130
 131   return (rest_len < min_turn) ? infinity_f : 0;
 132 }
 133
 134 void
 135 Page_turn_engraver::acknowledge_note_head (Grob_info gi)
 136 {
 137   SCM dur_log_scm = gi.grob ()->get_property ("duration-log");
 138   if (!scm_is_number (dur_log_scm))
 139     return;
 140
 141   int dur_log = scm_to_int (dur_log_scm);
 142   int dot_count = robust_scm2int (gi.grob ()->get_property ("dot-count"), 0);
 143
 144   if (rest_begin_ < now_mom ())
 145     {
 146       Real pen = penalty ((now_mom () - rest_begin_).main_part_);
 147       if (!isinf (pen))
 148           automatic_breaks_.push_back (Page_turn_event (rest_begin_.main_part_,
 149                                                         now_mom ().main_part_,
 150                                                         ly_symbol2scm ("allow"), 0));
 151     }
 152
 153   if (rest_begin_ <= repeat_begin_)
 154     repeat_begin_rest_length_ = (now_mom () - repeat_begin_).main_part_;
 155   note_end_ = now_mom () + Moment (Duration (dur_log, dot_count).get_length ());
 156 }
 157
 158 IMPLEMENT_TRANSLATOR_LISTENER (Page_turn_engraver, break);
 159 void
 160 Page_turn_engraver::listen_break (Stream_event *ev)
 161 {
 162   string name = ly_scm2string (scm_symbol_to_string (ev->get_property ("class")));
 163
 164   if (name == "page-turn-event")
 165     {
 166       SCM permission = ev->get_property ("break-permission");
 167       Real penalty = robust_scm2double (ev->get_property ("break-penalty"), 0);
 168       Rational now = now_mom ().main_part_;
 169
 170       forced_breaks_.push_back (Page_turn_event (now, now, permission, penalty));
 171     }
 172 }
 173
 174 void
 175 Page_turn_engraver::start_translation_timestep ()
 176 {
 177   /* What we want to do is to build a list of all the
 178      breakable paper columns. In general, paper-columns won't be marked as
 179      such until the Paper_column_engraver has done stop_translation_timestep.
 180
 181      Therefore, we just grab /all/ paper columns (in the
 182      stop_translation_timestep, since they're not created here yet)
 183      and remove the non-breakable ones at the beginning of the following
 184      timestep.
 185   */
 186
 187   if (breakable_columns_.size () && !Paper_column::is_breakable (breakable_columns_.back ()))
 188     {
 189       breakable_columns_.pop_back ();
 190       breakable_moments_.pop_back ();
 191       special_barlines_.pop_back ();
 192     }
 193 }
 194
 195 void
 196 Page_turn_engraver::stop_translation_timestep ()
 197 {
 198   Grob *pc = unsmob_grob (get_property ("currentCommandColumn"));
 199
 200   if (pc)
 201     {
 202       breakable_columns_.push_back (pc);
 203       breakable_moments_.push_back (now_mom ().main_part_);
 204
 205       SCM bar_scm = get_property ("whichBar");
 206       string bar = robust_scm2string (bar_scm, "");
 207
 208       special_barlines_.push_back (bar != "" && bar != "|");
 209     }
 210
 211   /* C&P from Repeat_acknowledge_engraver */
 212   SCM cs = get_property ("repeatCommands");
 213   bool start = false;
 214   bool end = false;
 215
 216   for (; scm_is_pair (cs); cs = scm_cdr (cs))
 217     {
 218       SCM command = scm_car (cs);
 219       if (command == ly_symbol2scm ("start-repeat"))
 220         start = true;
 221       else if (command == ly_symbol2scm ("end-repeat"))
 222         end = true;
 223     }
 224
 225   if (end && repeat_begin_.main_part_ >= Moment (0))
 226     {
 227       Rational now = now_mom ().main_part_;
 228       Real pen = penalty ((now_mom () - rest_begin_).main_part_ + repeat_begin_rest_length_);
 229       Moment *m = unsmob_moment (get_property ("minimumRepeatLengthForPageTurn"));
 230       if (m && *m > (now_mom () - repeat_begin_))
 231         pen = infinity_f;
 232
 233       if (pen == infinity_f)
 234         repeat_penalties_.push_back (Page_turn_event (repeat_begin_.main_part_, now, SCM_EOL, -infinity_f));
 235       else
 236         repeat_penalties_.push_back (Page_turn_event (repeat_begin_.main_part_, now, ly_symbol2scm ("allow"), pen));
 237
 238       repeat_begin_ = Moment (-1);
 239     }
 240
 241   if (start)
 242     {
 243       repeat_begin_ = now_mom ();
 244       repeat_begin_rest_length_ = 0;
 245     }
 246   rest_begin_ = note_end_;
 247 }
 248
 249 /* return the most permissive symbol (where force is the most permissive and
 250    forbid is the least
 251 */
 252 SCM
 253 Page_turn_engraver::max_permission (SCM perm1, SCM perm2)
 254 {
 255   if (perm1 == SCM_EOL)
 256     return perm2;
 257   if (perm1 == ly_symbol2scm ("allow") && perm2 == ly_symbol2scm ("force"))
 258     return perm2;
 259   return perm1;
 260 }
 261
 262 void
 263 Page_turn_engraver::finalize ()
 264 {
 265   vsize rep_index = 0;
 266   vector<Page_turn_event> auto_breaks;
 267
 268   /* filter the automatic breaks through the repeat penalties */
 269   for (vsize i = 0; i < automatic_breaks_.size (); i++)
 270     {
 271       Page_turn_event &brk = automatic_breaks_[i];
 272
 273       /* find the next applicable repeat penalty */
 274       for (;
 275            rep_index < repeat_penalties_.size ()
 276              && repeat_penalties_[rep_index].duration_[RIGHT] <= brk.duration_[LEFT];
 277            rep_index++)
 278         ;
 279
 280       if (rep_index >= repeat_penalties_.size ()
 281           || brk.duration_[RIGHT] <= repeat_penalties_[rep_index].duration_[LEFT])
 282         auto_breaks.push_back (brk);
 283       else
 284         {
 285           vector<Page_turn_event> split = brk.penalize (repeat_penalties_[rep_index]);
 286
 287           /* it's possible that the last of my newly-split events overlaps the next repeat_penalty,
 288              in which case we need to refilter that event */
 289           if (rep_index < repeat_penalties_.size () - 1
 290               && split.size ()
 291               && split.back ().duration_[RIGHT] > repeat_penalties_[rep_index+1].duration_[LEFT])
 292             {
 293               automatic_breaks_[i] = split.back ();
 294               split.pop_back ();
 295               i--;
 296             }
 297           auto_breaks.insert (auto_breaks.end (), split.begin (), split.end ());
 298         }
 299     }
 300
 301   /* apply the automatic breaks */
 302   for (vsize i = 0; i < auto_breaks.size (); i++)
 303     {
 304       Page_turn_event const &brk = auto_breaks[i];
 305       Grob *pc = breakable_column (auto_breaks[i]);
 306       if (pc)
 307         {
 308           SCM perm = max_permission (pc->get_property ("page-turn-permission"), brk.permission_);
 309           Real pen = min (robust_scm2double (pc->get_property ("page-turn-penalty"), infinity_f), brk.penalty_);
 310           pc->set_property ("page-turn-permission", perm);
 311           pc->set_property ("page-turn-penalty", scm_from_double (pen));
 312         }
 313     }
 314
 315   /* apply the manual breaks */
 316   for (vsize i = 0; i < forced_breaks_.size (); i++)
 317     {
 318       Page_turn_event const &brk = forced_breaks_[i];
 319       Grob *pc = breakable_column (forced_breaks_[i]);
 320       if (pc)
 321         {
 322           pc->set_property ("page-turn-permission", brk.permission_);
 323           pc->set_property ("page-turn-penalty", scm_from_double (brk.penalty_));
 324         }
 325     }
 326 }
 327
 328 ADD_ACKNOWLEDGER (Page_turn_engraver, note_head);
 329 ADD_TRANSLATOR (Page_turn_engraver,
 330                 /* doc */ "Decide where page turns are allowed to go",
 331                 /* create */ "",
 332                 /* accept */ "",
 333                 /* read */
 334                 "minimumPageTurnLength "
 335                 "minimumRepeatLengthForPageTurn ",
 336                 /* write */ ""
 337                 );