2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2009 Jan Nieuwenhuizen <janneke@gnu.org>
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/>.
20 #include "bar-line.hh"
21 #include "beaming-pattern.hh"
24 #include "duration.hh"
25 #include "engraver.hh"
29 #include "stream-event.hh"
33 #include "translator.icc"
35 class Auto_beam_engraver : public Engraver
37 TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
40 void stop_translation_timestep ();
41 void process_music ();
42 virtual void finalize ();
43 virtual void derived_mark () const;
45 DECLARE_ACKNOWLEDGER (rest);
46 DECLARE_ACKNOWLEDGER (beam);
47 DECLARE_ACKNOWLEDGER (bar_line);
48 DECLARE_ACKNOWLEDGER (stem);
49 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
51 void process_acknowledged ();
54 bool test_moment (Direction, Moment, Moment);
55 void consider_begin (Moment, Moment);
56 void consider_end (Moment, Moment);
57 Spanner *create_beam ();
61 bool is_same_grace_state (Grob *e);
64 vector<Item*> *remove_end_stems (vsize);
66 Stream_event *forbid_;
68 shortest_mom_ is the shortest note in the beam.
71 Spanner *finished_beam_;
72 vector<Item*> *stems_;
74 int process_acknowledged_count_;
77 Projected ending of the beam we're working on.
80 Moment beam_start_moment_;
81 Moment beam_start_location_;
83 // We act as if beam were created, and start a grouping anyway.
84 Beaming_pattern *grouping_;
87 Beaming_pattern *finished_grouping_;
90 Beaming_options beaming_options_;
91 Beaming_options finished_beaming_options_;
94 void check_bar_property ();
98 Auto_beam_engraver::derived_mark () const
100 scm_gc_mark (beam_settings_);
104 Auto_beam_engraver::check_bar_property ()
106 /* Duplicated from process_music (), since
107 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
109 Moment now = now_mom ();
110 if (scm_is_string (get_property ("whichBar"))
111 && beam_start_moment_ < now)
113 consider_end (measure_position (context ()), shortest_mom_);
119 Auto_beam_engraver::process_music ()
121 Moment now = now_mom ();
123 don't beam over skips
127 if (extend_mom_ < now)
131 if (scm_is_string (get_property ("whichBar")))
133 consider_end (measure_position (context ()), shortest_mom_);
139 consider_end (measure_position (context ()), shortest_mom_);
144 Auto_beam_engraver::Auto_beam_engraver ()
147 process_acknowledged_count_ = 0;
149 shortest_mom_ = Moment (Rational (1, 8));
151 finished_grouping_ = 0;
153 beam_settings_ = SCM_EOL;
156 IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
158 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
160 ASSIGN_EVENT_ONCE (forbid_, ev);
164 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
166 return scm_call_4 (get_property ("autoBeamCheck"),
167 context ()->self_scm (),
169 test_mom.smobbed_copy(),
175 Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
177 bool on = to_boolean (get_property ("autoBeaming"));
181 bool b = test_moment (START, test_mom, dur);
188 Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
192 /* Allow already started autobeam to end:
193 don't check for autoBeaming */
194 bool b = test_moment (STOP, test_mom, dur);
201 Auto_beam_engraver::create_beam ()
203 if (to_boolean (get_property ("skipTypesetting")))
206 for (vsize i = 0; i < stems_->size (); i++)
207 if (Stem::get_beam ((*stems_)[i]))
211 Can't use make_spanner_from_properties () because we have to use
214 Spanner *beam = new Spanner (beam_settings_);
216 for (vsize i = 0; i < stems_->size (); i++)
217 Beam::add_stem (beam, (*stems_)[i]);
219 announce_grob (beam, (*stems_)[0]->self_scm ());
225 Auto_beam_engraver::begin_beam ()
227 if (stems_ || grouping_)
229 programming_error ("already have autobeam");
233 stems_ = new vector<Item*>;
234 grouping_ = new Beaming_pattern ();
235 beaming_options_.from_context (context ());
236 beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
238 beam_start_moment_ = now_mom ();
240 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
244 Auto_beam_engraver::junk_beam ()
253 beam_settings_ = SCM_EOL;
255 shortest_mom_ = Moment (Rational (1, 8));
259 Auto_beam_engraver::end_beam ()
261 if (stems_->size () < 2)
265 finished_beam_ = create_beam ();
269 announce_end_grob (finished_beam_, SCM_EOL);
270 finished_grouping_ = grouping_;
271 finished_beaming_options_ = beaming_options_;
276 beam_settings_ = SCM_EOL;
279 shortest_mom_ = Moment (Rational (1, 8));
283 Auto_beam_engraver::typeset_beam ()
287 if (!finished_beam_->get_bound (RIGHT))
288 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
290 finished_grouping_->beamify (finished_beaming_options_);
291 Beam::set_beaming (finished_beam_, finished_grouping_);
294 delete finished_grouping_;
295 finished_grouping_ = 0;
300 Auto_beam_engraver::stop_translation_timestep ()
303 process_acknowledged_count_ = 0;
308 Auto_beam_engraver::finalize ()
310 /* finished beams may be typeset */
312 /* but unfinished may need another announce/acknowledge pass */
319 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
321 check_bar_property ();
327 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
329 check_bar_property ();
335 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
337 check_bar_property ();
343 Auto_beam_engraver::acknowledge_stem (Grob_info info)
345 check_bar_property ();
346 Item *stem = dynamic_cast<Item *> (info.grob ());
347 Stream_event *ev = info.ultimate_event_cause ();
348 if (!ev->in_event_class ("rhythmic-event"))
350 programming_error ("stem must have rhythmic structure");
355 Don't (start) auto-beam over empty stems; skips or rests
357 if (!Stem::head_count (stem))
364 if (Stem::get_beam (stem))
371 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
383 Moment now = now_mom ();
384 if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
387 Moment ev_dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
388 Moment dur = Rational (1, ev_dur.den ());
389 Moment measure_now = measure_position (context ());
390 bool recheck_needed = 0;
392 if (dur < shortest_mom_)
394 /* new shortest moment, so store it and set recheck_needed */
399 /* end should be based on shortest_mom_, begin should be
400 based on current duration */
401 consider_end (measure_now, shortest_mom_);
402 consider_begin (measure_now, dur);
407 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
409 Stem::is_invisible (stem));
410 stems_->push_back (stem);
412 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
413 if (recheck_needed) recheck_beam ();
417 Auto_beam_engraver::recheck_beam ()
420 Recheck the beam after the shortest duration has changed
421 If shorter duration has created a new break, typeset the
422 first part of the beam and reset the current beam to just
423 the last part of the beam
425 Beaming_pattern *new_grouping_ = 0;
426 vector<Item*> *new_stems_ = 0;
427 Moment temporary_shortest_mom;
428 SCM temporary_beam_settings;
433 for (vsize i = 0; i < stems_->size () - 1; )
435 found_end = test_moment (STOP,
436 grouping_->end_moment (i),
443 Save the current beam settings and shortest_mom_
444 Necessary because end_beam destroys them
446 temporary_shortest_mom = shortest_mom_;
447 temporary_beam_settings = beam_settings_;
449 /* Eliminate (and save) the items no longer part of the first beam */
451 new_grouping_ = grouping_->split_pattern (i);
452 new_stems_ = remove_end_stems (i);
457 /* now recreate the unbeamed data structures */
459 grouping_ = new_grouping_;
460 shortest_mom_ = temporary_shortest_mom;
461 beam_settings_ = temporary_beam_settings;
471 Remove all stems with an index greater than split_index
472 from stems_, and return a vector containing all of the
476 Auto_beam_engraver::remove_end_stems (vsize split_index)
478 vector <Item*> *removed_stems = 0;
479 removed_stems = new vector <Item*>;
481 for (vsize j=split_index + 1; j < stems_->size (); j++)
482 removed_stems->push_back ((*stems_).at (j));
483 for (vsize j=split_index + 1; j < stems_->size (); )
485 return (removed_stems);
489 Auto_beam_engraver::process_acknowledged ()
491 Moment now = now_mom();
492 if (extend_mom_ > now)
495 if (!process_acknowledged_count_)
497 Moment measure_now = measure_position (context ());
498 consider_end (measure_now, shortest_mom_);
499 consider_begin (measure_now, shortest_mom_);
501 else if (process_acknowledged_count_ > 1)
505 if ((extend_mom_ < now)
506 || ((extend_mom_ == now) && (last_add_mom_ != now)))
508 else if (!stems_->size ())
513 process_acknowledged_count_++;
516 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
517 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
518 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
519 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
520 ADD_TRANSLATOR (Auto_beam_engraver,
522 "Generate beams based on measure characteristics and observed"
523 " Stems. Uses @code{beatLength}, @code{measureLength}, and"
524 " @code{measurePosition} to decide when to start and stop a"
525 " beam. Overriding beaming is done through"
526 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
527 " @code{stemRightBeamCount}.",