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"
30 #include "rhythmic-head.hh"
31 #include "score-engraver.hh"
33 #include "staff-symbol-referencer.hh"
34 #include "stream-event.hh"
38 #include "translator.icc"
41 TODO: make matching rest engraver.
47 When we catch the note, we predict the end of the note. We keep the
48 events living until we reach the predicted end-time.
50 Every time process_music () is called and there are note events, we
51 figure out how long the note to typeset should be. It should be no
52 longer than what's specified, than what is left to do and it should
55 We copy the events into scratch note events, to make sure that we get
56 all durations exactly right.
59 class Completion_heads_engraver : public Engraver
62 vector<Item*> prev_notes_;
63 // Must remember notes for explicit ties.
64 vector<Item*> tie_note_candidates_;
65 vector<Stream_event*> tie_note_candidate_events_;
67 vector<Stream_event*> note_events_;
71 Rational do_nothing_until_;
74 Moment next_barline_moment ();
75 Item *make_note_head (Stream_event*);
78 TRANSLATOR_DECLARATIONS (Completion_heads_engraver);
81 virtual void initialize ();
82 void make_tie (Grob *, Grob *);
83 void start_translation_timestep ();
84 void process_music ();
85 void stop_translation_timestep ();
86 DECLARE_TRANSLATOR_LISTENER (note);
90 Completion_heads_engraver::initialize ()
95 IMPLEMENT_TRANSLATOR_LISTENER (Completion_heads_engraver, note);
97 Completion_heads_engraver::listen_note (Stream_event *ev)
99 note_events_.push_back (ev);
102 Moment now = now_mom ();
103 Moment musiclen = get_event_length (ev, now);
105 note_end_mom_ = max (note_end_mom_, (now + musiclen));
106 do_nothing_until_ = Rational (0, 0);
110 The duration _until_ the next barline.
113 Completion_heads_engraver::next_barline_moment ()
115 Moment *e = unsmob_moment (get_property ("measurePosition"));
116 Moment *l = unsmob_moment (get_property ("measureLength"));
117 if (!e || !l || !to_boolean (get_property ("timing")))
119 return Moment (0, 0);
126 Completion_heads_engraver::make_note_head (Stream_event *ev)
128 Item *note = make_item ("NoteHead", ev->self_scm ());
129 Pitch *pit = unsmob_pitch (ev->get_property ("pitch"));
131 int pos = pit->steps ();
132 SCM c0 = get_property ("middleCPosition");
133 if (scm_is_number (c0))
134 pos += scm_to_int (c0);
136 note->set_property ("staff-position", scm_from_int (pos));
142 Completion_heads_engraver::process_music ()
144 if (!is_first_ && !left_to_do_)
149 Moment now = now_mom ();
150 if (do_nothing_until_ > now.main_part_)
158 note that note_dur may be strictly less than left_to_do_
159 (say, if left_to_do_ == 5/8)
161 if (factor_.denominator () == 1 && factor_ > Rational (1, 1))
162 note_dur = Duration (left_to_do_, false);
164 note_dur = Duration (left_to_do_ / factor_, false).compressed (factor_);
168 orig = unsmob_duration (note_events_[0]->get_property ("duration"));
170 factor_ = note_dur.factor ();
171 left_to_do_ = orig->get_length ();
173 Moment nb = next_barline_moment ();
174 if (nb.main_part_ && nb < note_dur.get_length ())
176 if (factor_.denominator () == 1 && factor_ > Rational (1, 1))
177 note_dur = Duration (nb.main_part_, false);
179 note_dur = Duration (nb.main_part_ / factor_, false).compressed (factor_);
182 do_nothing_until_ = now.main_part_ + note_dur.get_length ();
184 for (vsize i = 0; left_to_do_ && i < note_events_.size (); i++)
186 bool need_clone = !orig || *orig != note_dur;
187 Stream_event *event = note_events_[i];
190 event = event->clone ();
192 SCM pits = note_events_[i]->get_property ("pitch");
193 event->set_property ("pitch", pits);
194 event->set_property ("duration", note_dur.smobbed_copy ());
195 event->set_property ("length", Moment (note_dur.get_length ()).smobbed_copy ());
196 event->set_property ("duration-log", scm_from_int (note_dur.duration_log ()));
199 The Completion_heads_engraver splits an event into a group of consecutive events.
200 For each event in the group, the property "autosplit-end" denotes whether the current event
201 was truncated during splitting. Based on "autosplit-end", the Tie_engraver decides whether a
202 tie event should be processed.
204 event->set_property ("autosplit-end",
205 ly_bool2scm (left_to_do_ - note_dur.get_length () > Rational (0)));
207 Item *note = make_note_head (event);
210 notes_.push_back (note);
213 if (prev_notes_.size () == notes_.size ())
215 for (vsize i = 0; i < notes_.size (); i++)
216 make_tie (prev_notes_[i], notes_[i]);
219 left_to_do_ -= note_dur.get_length ();
221 get_global_context ()->add_moment_to_process (now.main_part_ + note_dur.get_length());
223 don't do complicated arithmetic with grace notes.
225 if (orig && now_mom ().grace_part_)
226 left_to_do_ = Rational (0, 0);
230 Completion_heads_engraver::make_tie (Grob *left, Grob *right)
232 Grob *p = make_spanner ("Tie", SCM_EOL);
233 Tie::set_head (p, LEFT, left);
234 Tie::set_head (p, RIGHT, right);
239 Completion_heads_engraver::stop_translation_timestep ()
244 prev_notes_ = notes_;
249 Completion_heads_engraver::start_translation_timestep ()
251 Moment now = now_mom ();
252 if (note_end_mom_.main_part_ <= now.main_part_)
254 tie_note_candidate_events_ = note_events_;
255 tie_note_candidates_ = prev_notes_;
257 note_events_.clear ();
258 prev_notes_.clear ();
260 context ()->set_property ("completionBusy",
261 ly_bool2scm (note_events_.size ()));
264 Completion_heads_engraver::Completion_heads_engraver ()
268 ADD_TRANSLATOR (Completion_heads_engraver,
270 "This engraver replaces @code{Note_heads_engraver}. It plays"
271 " some trickery to break long notes and automatically tie them"
272 " into the next measure."