2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
23 #include "dot-column.hh"
25 #include "duration.hh"
26 #include "global-context.hh"
28 #include "output-def.hh"
31 #include "rhythmic-head.hh"
32 #include "score-engraver.hh"
34 #include "staff-symbol-referencer.hh"
35 #include "stream-event.hh"
39 #include "translator.icc"
42 TODO: make matching rest engraver.
47 Stream_event* tie_event_;
48 Pending_tie() { tie_event_ = 0; }
51 int compare(Pending_tie const &a, Pending_tie const &b)
53 return compare(a.when_, b.when_);
60 When we catch the note, we predict the end of the note. We keep the
61 events living until we reach the predicted end-time.
63 Every time process_music () is called and there are note events, we
64 figure out how long the note to typeset should be. It should be no
65 longer than what's specified, than what is left to do and it should
68 We copy the events into scratch note events, to make sure that we get
69 all durations exactly right.
72 class Completion_heads_engraver : public Engraver
75 vector<Item*> prev_notes_;
77 // Must remember notes for explicit ties.
78 vector<Item*> tie_note_candidates_;
79 vector<Stream_event*> tie_note_candidate_events_;
81 PQueue<Pending_tie> pending_ties_;
82 vector<Stream_event*> note_events_;
84 Stream_event *current_tie_event_;
88 Rational do_nothing_until_;
92 Moment next_barline_moment ();
93 Item *make_note_head (Stream_event*);
96 TRANSLATOR_DECLARATIONS (Completion_heads_engraver);
99 virtual void initialize ();
100 void make_tie (Grob *, Grob *);
101 void start_translation_timestep ();
102 void process_music ();
103 void stop_translation_timestep ();
104 DECLARE_TRANSLATOR_LISTENER (note);
105 DECLARE_TRANSLATOR_LISTENER (tie);
109 Completion_heads_engraver::initialize ()
112 current_tie_event_ = 0;
115 IMPLEMENT_TRANSLATOR_LISTENER (Completion_heads_engraver, note);
117 Completion_heads_engraver::listen_note (Stream_event *ev)
119 note_events_.push_back (ev);
122 Moment now = now_mom ();
123 Moment musiclen = get_event_length (ev, now);
125 note_end_mom_ = max (note_end_mom_, (now + musiclen));
126 do_nothing_until_ = Rational (0, 0);
129 IMPLEMENT_TRANSLATOR_LISTENER (Completion_heads_engraver, tie);
131 Completion_heads_engraver::listen_tie (Stream_event *ev)
134 current_tie_event_ = ev;
138 The duration _until_ the next barline.
141 Completion_heads_engraver::next_barline_moment ()
143 Moment *e = unsmob_moment (get_property ("measurePosition"));
144 Moment *l = unsmob_moment (get_property ("measureLength"));
145 if (!e || !l || !to_boolean (get_property ("timing")))
147 return Moment (0, 0);
154 Completion_heads_engraver::make_note_head (Stream_event *ev)
156 Item *note = make_item ("NoteHead", ev->self_scm ());
157 Pitch *pit = unsmob_pitch (ev->get_property ("pitch"));
159 int pos = pit->steps ();
160 SCM c0 = get_property ("middleCPosition");
161 if (scm_is_number (c0))
162 pos += scm_to_int (c0);
164 note->set_property ("staff-position", scm_from_int (pos));
170 Completion_heads_engraver::process_music ()
172 if (!is_first_ && !left_to_do_)
175 if (current_tie_event_)
178 pending.when_ = note_end_mom_;
179 pending.tie_event_ = current_tie_event_;
180 pending_ties_.insert (pending);
185 Moment now = now_mom ();
186 if (do_nothing_until_ > now.main_part_)
194 note that note_dur may be strictly less than left_to_do_
195 (say, if left_to_do_ == 5/8)
197 note_dur = Duration (left_to_do_ / factor_, false).compressed (factor_);
201 orig = unsmob_duration (note_events_[0]->get_property ("duration"));
203 factor_ = note_dur.factor ();
204 left_to_do_ = orig->get_length ();
206 Moment nb = next_barline_moment ();
207 if (nb.main_part_ && nb < note_dur.get_length ())
208 note_dur = Duration (nb.main_part_ / factor_, false).compressed (factor_);
210 do_nothing_until_ = now.main_part_ + note_dur.get_length ();
212 for (vsize i = 0; left_to_do_ && i < note_events_.size (); i++)
214 bool need_clone = !orig || *orig != note_dur;
215 Stream_event *event = note_events_[i];
218 event = event->clone ();
220 SCM pits = note_events_[i]->get_property ("pitch");
221 Duration appearance = note_dur;
222 if (factor_.denominator () == 1 && factor_ > Rational (1, 1))
223 appearance = Duration (note_dur.get_length (), false);
225 event->set_property ("pitch", pits);
226 event->set_property ("duration", appearance.smobbed_copy ());
227 event->set_property ("length", Moment (appearance.get_length ()).smobbed_copy ());
228 event->set_property ("duration-log", scm_from_int (appearance.duration_log ()));
230 Item *note = make_note_head (event);
233 notes_.push_back (note);
236 if (pending_ties_.size ()
237 && pending_ties_.front().when_ == now_mom())
239 for (vsize i = 0; i < tie_note_candidate_events_.size(); i++)
240 for (vsize j = 0; j < note_events_.size(); j++)
242 Pitch *p = unsmob_pitch (note_events_[j]->get_property ("pitch"));
244 = unsmob_pitch (tie_note_candidate_events_[j]->get_property ("pitch"));
245 if (p && p_last && *p == *p_last)
246 make_tie (tie_note_candidates_[i], notes_[j]);
250 if (prev_notes_.size () == notes_.size ())
252 for (vsize i = 0; i < notes_.size (); i++)
253 make_tie (prev_notes_[i], notes_[i]);
256 left_to_do_ -= note_dur.get_length ();
258 get_global_context ()->add_moment_to_process (now.main_part_ + note_dur.get_length());
260 don't do complicated arithmetic with grace notes.
262 if (orig && now_mom ().grace_part_)
263 left_to_do_ = Rational (0, 0);
267 Completion_heads_engraver::make_tie (Grob *left, Grob *right)
269 Grob *p = make_spanner ("Tie", SCM_EOL);
270 Tie::set_head (p, LEFT, left);
271 Tie::set_head (p, RIGHT, right);
276 Completion_heads_engraver::stop_translation_timestep ()
281 prev_notes_ = notes_;
286 Completion_heads_engraver::start_translation_timestep ()
288 Moment now = now_mom ();
289 while (pending_ties_.size() && pending_ties_.front().when_ < now)
291 pending_ties_.delmin();
293 current_tie_event_ = 0;
294 if (note_end_mom_.main_part_ <= now.main_part_)
296 tie_note_candidate_events_ = note_events_;
297 tie_note_candidates_ = prev_notes_;
299 note_events_.clear ();
300 prev_notes_.clear ();
302 context ()->set_property ("completionBusy",
303 ly_bool2scm (note_events_.size ()));
306 Completion_heads_engraver::Completion_heads_engraver ()
310 ADD_TRANSLATOR (Completion_heads_engraver,
312 "This engraver replaces @code{Note_heads_engraver}. It plays"
313 " some trickery to break long notes and automatically tie them"
314 " into the next measure.",