2 page-turn-engraver.cc -- implement Page_turn_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2006 Joe Neeman <joeneeman@gmail.com>
12 #include "duration.hh"
14 #include "international.hh"
16 #include "paper-column.hh"
17 #include "stream-event.hh"
20 #include "translator.icc"
22 class Page_turn_event {
26 Interval_t<Rational> duration_;
28 Page_turn_event (Rational start, Rational end, SCM perm, Real pen)
30 duration_[LEFT] = start;
31 duration_[RIGHT] = end;
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.
42 vector<Page_turn_event> penalize (Page_turn_event const &penalty)
44 Interval_t<Rational> intersect = intersection (duration_, penalty.duration_);
45 vector<Page_turn_event> ret;
47 if (intersect.is_empty ())
49 ret.push_back (*this);
53 Real new_pen = max (penalty_, penalty.penalty_);
55 if (duration_[LEFT] < penalty.duration_[LEFT])
56 ret.push_back (Page_turn_event (duration_[LEFT], penalty.duration_[LEFT], permission_, penalty_));
58 if (penalty.permission_ != SCM_EOL)
59 ret.push_back (Page_turn_event (intersect[LEFT], intersect[RIGHT], permission_, new_pen));
61 if (penalty.duration_[RIGHT] < duration_[RIGHT])
62 ret.push_back (Page_turn_event (penalty.duration_[RIGHT], duration_[LEFT], permission_, penalty_));
68 class Page_turn_engraver : public Engraver
73 Rational repeat_begin_rest_length_;
75 vector<Page_turn_event> forced_breaks_;
76 vector<Page_turn_event> automatic_breaks_;
77 vector<Page_turn_event> repeat_penalties_;
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_;
84 SCM max_permission (SCM perm1, SCM perm2);
85 Real penalty (Rational rest_len);
86 Grob *breakable_column (Page_turn_event const &);
89 DECLARE_TRANSLATOR_LISTENER (break);
90 DECLARE_ACKNOWLEDGER (note_head);
93 TRANSLATOR_DECLARATIONS (Page_turn_engraver);
94 void stop_translation_timestep ();
95 void start_translation_timestep ();
99 Page_turn_engraver::Page_turn_engraver ()
101 repeat_begin_ = Moment (-1);
102 repeat_begin_rest_length_ = 0;
108 Page_turn_engraver::breakable_column (Page_turn_event const &brk)
110 vsize start = lower_bound (breakable_moments_, brk.duration_[LEFT], less<Rational> ());
111 vsize end = upper_bound (breakable_moments_, brk.duration_[RIGHT], less<Rational> ());
113 if (start == breakable_moments_.size ())
115 if (end == breakable_moments_.size () || breakable_moments_[end] > brk.duration_[RIGHT])
122 for (vsize i = end + 1; i-- > start;)
123 if (special_barlines_[i])
124 return breakable_columns_[i];
126 return breakable_columns_[end];
130 Page_turn_engraver::penalty (Rational rest_len)
132 Rational min_turn = robust_scm2moment (get_property ("minimumPageTurnLength"), Moment (1)).main_part_;
134 return (rest_len < min_turn) ? infinity_f : 0;
138 Page_turn_engraver::acknowledge_note_head (Grob_info gi)
140 SCM dur_log_scm = gi.grob ()->get_property ("duration-log");
141 if (!scm_is_number (dur_log_scm))
144 int dur_log = scm_to_int (dur_log_scm);
145 int dot_count = robust_scm2int (gi.grob ()->get_property ("dot-count"), 0);
147 if (rest_begin_ < now_mom ())
149 Real pen = penalty ((now_mom () - rest_begin_).main_part_);
151 automatic_breaks_.push_back (Page_turn_event (rest_begin_.main_part_,
152 now_mom ().main_part_,
153 ly_symbol2scm ("allow"), 0));
156 if (rest_begin_ <= repeat_begin_)
157 repeat_begin_rest_length_ = (now_mom () - repeat_begin_).main_part_;
158 note_end_ = now_mom () + Moment (Duration (dur_log, dot_count).get_length ());
161 IMPLEMENT_TRANSLATOR_LISTENER (Page_turn_engraver, break);
163 Page_turn_engraver::listen_break (Stream_event *ev)
165 string name = ly_scm2string (scm_symbol_to_string (ev->get_property ("class")));
167 if (name == "page-turn-event")
169 SCM permission = ev->get_property ("break-permission");
170 Real penalty = robust_scm2double (ev->get_property ("break-penalty"), 0);
171 Rational now = now_mom ().main_part_;
173 forced_breaks_.push_back (Page_turn_event (now, now, permission, penalty));
178 Page_turn_engraver::start_translation_timestep ()
180 /* What we want to do is to build a list of all the
181 breakable paper columns. In general, paper-columns won't be marked as
182 such until the Paper_column_engraver has done stop_translation_timestep.
184 Therefore, we just grab /all/ paper columns (in the
185 stop_translation_timestep, since they're not created here yet)
186 and remove the non-breakable ones at the beginning of the following
190 if (breakable_columns_.size () && !Paper_column::is_breakable (breakable_columns_.back ()))
192 breakable_columns_.pop_back ();
193 breakable_moments_.pop_back ();
194 special_barlines_.pop_back ();
199 Page_turn_engraver::stop_translation_timestep ()
201 Grob *pc = unsmob_grob (get_property ("currentCommandColumn"));
205 breakable_columns_.push_back (pc);
206 breakable_moments_.push_back (now_mom ().main_part_);
208 SCM bar_scm = get_property ("whichBar");
209 string bar = robust_scm2string (bar_scm, "");
211 special_barlines_.push_back (bar != "" && bar != "|");
214 /* C&P from Repeat_acknowledge_engraver */
215 SCM cs = get_property ("repeatCommands");
219 for (; scm_is_pair (cs); cs = scm_cdr (cs))
221 SCM command = scm_car (cs);
222 if (command == ly_symbol2scm ("start-repeat"))
224 else if (command == ly_symbol2scm ("end-repeat"))
228 if (end && repeat_begin_.main_part_ >= Moment (0))
230 Rational now = now_mom ().main_part_;
231 Real pen = penalty ((now_mom () - rest_begin_).main_part_ + repeat_begin_rest_length_);
232 Moment *m = unsmob_moment (get_property ("minimumRepeatLengthForPageTurn"));
233 if (m && *m > (now_mom () - repeat_begin_))
236 if (pen == infinity_f)
237 repeat_penalties_.push_back (Page_turn_event (repeat_begin_.main_part_, now, SCM_EOL, -infinity_f));
239 repeat_penalties_.push_back (Page_turn_event (repeat_begin_.main_part_, now, ly_symbol2scm ("allow"), pen));
241 repeat_begin_ = Moment (-1);
246 repeat_begin_ = now_mom ();
247 repeat_begin_rest_length_ = 0;
249 rest_begin_ = note_end_;
252 /* return the most permissive symbol (where force is the most permissive and
256 Page_turn_engraver::max_permission (SCM perm1, SCM perm2)
258 if (perm1 == SCM_EOL)
260 if (perm1 == ly_symbol2scm ("allow") && perm2 == ly_symbol2scm ("force"))
266 Page_turn_engraver::finalize ()
269 vector<Page_turn_event> auto_breaks;
271 /* filter the automatic breaks through the repeat penalties */
272 for (vsize i = 0; i < automatic_breaks_.size (); i++)
274 Page_turn_event &brk = automatic_breaks_[i];
276 /* find the next applicable repeat penalty */
278 rep_index < repeat_penalties_.size ()
279 && repeat_penalties_[rep_index].duration_[RIGHT] <= brk.duration_[LEFT];
283 if (rep_index >= repeat_penalties_.size ()
284 || brk.duration_[RIGHT] <= repeat_penalties_[rep_index].duration_[LEFT])
285 auto_breaks.push_back (brk);
288 vector<Page_turn_event> split = brk.penalize (repeat_penalties_[rep_index]);
290 /* it's possible that the last of my newly-split events overlaps the next repeat_penalty,
291 in which case we need to refilter that event */
292 if (rep_index < repeat_penalties_.size () - 1
294 && split.back ().duration_[RIGHT] > repeat_penalties_[rep_index+1].duration_[LEFT])
296 automatic_breaks_[i] = split.back ();
300 auto_breaks.insert (auto_breaks.end (), split.begin (), split.end ());
304 /* apply the automatic breaks */
305 for (vsize i = 0; i < auto_breaks.size (); i++)
307 Page_turn_event const &brk = auto_breaks[i];
308 Grob *pc = breakable_column (auto_breaks[i]);
311 SCM perm = max_permission (pc->get_property ("page-turn-permission"), brk.permission_);
312 Real pen = min (robust_scm2double (pc->get_property ("page-turn-penalty"), infinity_f), brk.penalty_);
313 pc->set_property ("page-turn-permission", perm);
314 pc->set_property ("page-turn-penalty", scm_from_double (pen));
318 /* apply the manual breaks */
319 for (vsize i = 0; i < forced_breaks_.size (); i++)
321 Page_turn_event const &brk = forced_breaks_[i];
322 Grob *pc = breakable_column (forced_breaks_[i]);
325 pc->set_property ("page-turn-permission", brk.permission_);
326 pc->set_property ("page-turn-penalty", scm_from_double (brk.penalty_));
331 ADD_ACKNOWLEDGER (Page_turn_engraver, note_head);
332 ADD_TRANSLATOR (Page_turn_engraver,
333 /* doc */ "Decide where page turns are allowed to go",
337 "minimumPageTurnLength "
338 "minimumRepeatLengthForPageTurn ",