2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 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_)
192 note_dur = Duration (left_to_do_ / factor_, false).compressed (factor_);
195 orig = unsmob_duration (note_events_[0]->get_property ("duration"));
197 factor_ = note_dur.factor ();
199 Moment nb = next_barline_moment ();
200 if (nb.main_part_ && nb < note_dur.get_length ())
202 note_dur = Duration (nb.main_part_ / factor_, false).compressed (factor_);
204 do_nothing_until_ = now.main_part_ + note_dur.get_length ();
208 left_to_do_ = orig->get_length ();
210 for (vsize i = 0; left_to_do_ && i < note_events_.size (); i++)
212 bool need_clone = !orig || *orig != note_dur;
213 Stream_event *event = note_events_[i];
216 event = event->clone ();
218 SCM pits = note_events_[i]->get_property ("pitch");
220 event->set_property ("pitch", pits);
221 event->set_property ("duration", note_dur.smobbed_copy ());
222 event->set_property ("length", Moment (note_dur.get_length ()).smobbed_copy ());
223 event->set_property ("duration-log", scm_from_int (note_dur.duration_log ()));
225 Item *note = make_note_head (event);
228 notes_.push_back (note);
231 if (pending_ties_.size ()
232 && pending_ties_.front().when_ == now_mom())
234 for (vsize i = 0; i < tie_note_candidate_events_.size(); i++)
235 for (vsize j = 0; j < note_events_.size(); j++)
237 Pitch *p = unsmob_pitch (note_events_[j]->get_property ("pitch"));
239 = unsmob_pitch (tie_note_candidate_events_[j]->get_property ("pitch"));
240 if (p && p_last && *p == *p_last)
241 make_tie (tie_note_candidates_[i], notes_[j]);
245 if (prev_notes_.size () == notes_.size ())
247 for (vsize i = 0; i < notes_.size (); i++)
248 make_tie (prev_notes_[i], notes_[i]);
251 left_to_do_ -= note_dur.get_length ();
253 get_global_context ()->add_moment_to_process (now.main_part_ + note_dur.get_length());
255 don't do complicated arithmetic with grace notes.
257 if (orig && now_mom ().grace_part_)
258 left_to_do_ = Rational (0, 0);
262 Completion_heads_engraver::make_tie (Grob *left, Grob *right)
264 Grob *p = make_spanner ("Tie", SCM_EOL);
265 Tie::set_head (p, LEFT, left);
266 Tie::set_head (p, RIGHT, right);
271 Completion_heads_engraver::stop_translation_timestep ()
276 prev_notes_ = notes_;
281 Completion_heads_engraver::start_translation_timestep ()
283 Moment now = now_mom ();
284 while (pending_ties_.size() && pending_ties_.front().when_ < now)
286 pending_ties_.delmin();
288 current_tie_event_ = 0;
289 if (note_end_mom_.main_part_ <= now.main_part_)
291 tie_note_candidate_events_ = note_events_;
292 tie_note_candidates_ = prev_notes_;
294 note_events_.clear ();
295 prev_notes_.clear ();
297 context ()->set_property ("completionBusy",
298 ly_bool2scm (note_events_.size ()));
301 Completion_heads_engraver::Completion_heads_engraver ()
305 ADD_TRANSLATOR (Completion_heads_engraver,
307 "This engraver replaces @code{Note_heads_engraver}. It plays"
308 " some trickery to break long notes and automatically tie them"
309 " into the next measure.",