2 beam-engraver.cc -- implement Beam_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "beaming-pattern.hh"
12 #include "drul-array.hh"
13 #include "duration.hh"
14 #include "engraver.hh"
15 #include "international.hh"
19 #include "stream-event.hh"
23 #include "translator.icc"
25 class Beam_engraver : public Engraver
28 DECLARE_ACKNOWLEDGER (stem);
29 DECLARE_ACKNOWLEDGER (rest);
32 Stream_event *start_ev_;
34 Spanner *finished_beam_;
36 Stream_event *prev_start_ev_;
38 Stream_event *now_stop_ev_;
40 Beaming_pattern *beam_info_;
41 Beaming_pattern *finished_beam_info_;
43 /// location within measure where beam started.
44 Moment beam_start_location_;
46 /// moment (global time) where beam started.
47 Moment beam_start_mom_;
49 bool subdivide_beams_;
53 void set_melisma (bool);
55 Moment last_stem_added_at_;
56 void stop_translation_timestep ();
57 void start_translation_timestep ();
58 virtual void finalize ();
60 void process_music ();
62 virtual bool valid_start_point ();
63 virtual bool valid_end_point ();
65 DECLARE_TRANSLATOR_LISTENER (beam);
67 TRANSLATOR_DECLARATIONS (Beam_engraver);
71 Hmm. this isn't necessary, since grace beams and normal beams are
75 Beam_engraver::valid_start_point ()
77 Moment n = now_mom ();
79 return n.grace_part_ == Rational (0);
83 Beam_engraver::valid_end_point ()
85 return valid_start_point ();
88 Beam_engraver::Beam_engraver ()
92 finished_beam_info_ = 0;
99 IMPLEMENT_TRANSLATOR_LISTENER (Beam_engraver, beam);
101 Beam_engraver::listen_beam (Stream_event *ev)
103 Direction d = to_dir (ev->get_property ("span-direction"));
105 if (d == START && valid_start_point ())
106 ASSIGN_EVENT_ONCE (start_ev_, ev);
107 else if (d == STOP && valid_end_point ())
108 ASSIGN_EVENT_ONCE (now_stop_ev_, ev);
112 Beam_engraver::set_melisma (bool ml)
114 SCM b = get_property ("autoBeaming");
116 context ()->set_property ("beamMelismaBusy", ml ? SCM_BOOL_T : SCM_BOOL_F);
120 Beam_engraver::process_music ()
122 if (beam_ && !to_boolean (get_property ("allowBeamBreak")))
123 context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
129 start_ev_->origin ()->warning (_ ("already have a beam"));
134 prev_start_ev_ = start_ev_;
135 beam_ = make_spanner ("Beam", start_ev_->self_scm ());
136 Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
138 beam_start_location_ = mp;
139 beam_start_mom_ = now_mom ();
141 beam_info_ = new Beaming_pattern;
142 /* urg, must copy to Auto_beam_engraver too */
147 Beam_engraver::typeset_beam ()
151 if (!finished_beam_->get_bound (RIGHT))
152 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
154 finished_beam_info_->beamify (context ());
155 Beam::set_beaming (finished_beam_, finished_beam_info_);
157 delete finished_beam_info_;
158 finished_beam_info_ = 0;
164 Beam_engraver::start_translation_timestep ()
175 Beam_engraver::stop_translation_timestep ()
180 finished_beam_ = beam_;
181 finished_beam_info_ = beam_info_;
192 Beam_engraver::finalize ()
197 prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
200 we don't typeset it, (we used to, but it was commented
201 out. Reason unknown) */
208 Beam_engraver::acknowledge_rest (Grob_info info)
211 && !scm_is_number (info.grob ()->get_property_data ("staff-position")))
213 chain_offset_callback (info.grob(),
214 Beam::rest_collision_callback_proc, Y_AXIS);
221 Beam_engraver::acknowledge_stem (Grob_info info)
226 Moment now = now_mom ();
227 if (!valid_start_point ())
230 Item *stem = dynamic_cast<Item *> (info.grob ());
231 if (Stem::get_beam (stem))
236 Stream_event *ev = info.ultimate_event_cause ();
237 if (!ev->in_event_class ("rhythmic-event"))
239 info.grob ()->warning (_ ("stem must have Rhythmic structure"));
243 last_stem_added_at_ = now;
244 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
247 ev->origin ()->warning (_ ("stem does not fit in beam"));
248 prev_start_ev_->origin ()->warning (_ ("beam was started here"));
252 [r4 c8] can just as well be modern notation.
256 stem->set_property ("duration-log",
257 scm_from_int (durlog));
258 Moment stem_location = now - beam_start_mom_ + beam_start_location_;
259 beam_info_->add_stem (stem_location,
261 Beam::add_stem (beam_, stem);
264 ADD_ACKNOWLEDGER (Beam_engraver, stem);
265 ADD_ACKNOWLEDGER (Beam_engraver, rest);
267 ADD_TRANSLATOR (Beam_engraver,
270 "Handles Beam events by engraving Beams. If omitted, then notes will be "
271 "printed with flags instead of beams.",
283 class Grace_beam_engraver : public Beam_engraver
286 TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
288 DECLARE_TRANSLATOR_LISTENER (beam);
291 virtual bool valid_start_point ();
292 virtual bool valid_end_point ();
295 Grace_beam_engraver::Grace_beam_engraver ()
300 Grace_beam_engraver::valid_start_point ()
302 Moment n = now_mom ();
304 return n.grace_part_ != Rational (0);
308 Grace_beam_engraver::valid_end_point ()
310 return beam_ && valid_start_point ();
316 IMPLEMENT_TRANSLATOR_LISTENER (Grace_beam_engraver, beam);
318 Grace_beam_engraver::listen_beam (Stream_event *ev)
320 Direction d = to_dir (ev->get_property ("span-direction"));
322 if (d == START && valid_start_point ())
324 else if (d == STOP && valid_end_point ())
329 ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
330 ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
332 ADD_TRANSLATOR (Grace_beam_engraver,
336 "Handles Beam events by engraving Beams. If omitted, then notes will "
337 "be printed with flags instead of beams. Only engraves beams when we "
338 " are at grace points in time. ",