2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2011 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 (breathing_sign);
49 DECLARE_ACKNOWLEDGER (stem);
50 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
52 void process_acknowledged ();
55 bool test_moment (Direction, Moment, Moment);
56 void consider_begin (Moment, Moment);
57 void consider_end (Moment, Moment);
58 Spanner *create_beam ();
62 bool is_same_grace_state (Grob *e);
65 vector<Item *> *remove_end_stems (vsize);
67 Stream_event *forbid_;
69 shortest_mom_ is the shortest note in the beam.
72 Spanner *finished_beam_;
73 vector<Item *> *stems_;
75 int process_acknowledged_count_;
78 Projected ending of the beam we're working on.
81 Moment beam_start_moment_;
82 Moment beam_start_location_;
84 // We act as if beam were created, and start a grouping anyway.
85 Beaming_pattern *grouping_;
88 Beaming_pattern *finished_grouping_;
91 Beaming_options beaming_options_;
92 Beaming_options finished_beaming_options_;
95 void check_bar_property ();
99 Auto_beam_engraver::derived_mark () const
101 scm_gc_mark (beam_settings_);
105 Auto_beam_engraver::check_bar_property ()
107 /* Duplicated from process_music (), since
108 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
110 Moment now = now_mom ();
111 if (scm_is_string (get_property ("whichBar"))
112 && beam_start_moment_ < now)
114 consider_end (measure_position (context ()), shortest_mom_);
120 Auto_beam_engraver::process_music ()
122 Moment now = now_mom ();
124 don't beam over skips
128 if (extend_mom_ < now)
132 if (scm_is_string (get_property ("whichBar")))
134 consider_end (measure_position (context ()), shortest_mom_);
147 Auto_beam_engraver::Auto_beam_engraver ()
150 process_acknowledged_count_ = 0;
152 shortest_mom_ = Moment (Rational (1, 4));
154 finished_grouping_ = 0;
156 beam_settings_ = SCM_EOL;
159 IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
161 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
163 ASSIGN_EVENT_ONCE (forbid_, ev);
167 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
169 return scm_call_4 (get_property ("autoBeamCheck"),
170 context ()->self_scm (),
172 test_mom.smobbed_copy (),
178 Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
180 bool on = to_boolean (get_property ("autoBeaming"));
184 bool b = test_moment (START, test_mom, dur);
191 Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
195 /* Allow already started autobeam to end:
196 don't check for autoBeaming */
197 bool b = test_moment (STOP, test_mom, dur);
204 Auto_beam_engraver::create_beam ()
206 if (to_boolean (get_property ("skipTypesetting")))
209 for (vsize i = 0; i < stems_->size (); i++)
210 if (Stem::get_beam ((*stems_)[i]))
214 Can't use make_spanner () because we have to use
217 Spanner *beam = new Spanner (beam_settings_);
219 for (vsize i = 0; i < stems_->size (); i++)
220 Beam::add_stem (beam, (*stems_)[i]);
222 announce_grob (beam, (*stems_)[0]->self_scm ());
228 Auto_beam_engraver::begin_beam ()
230 if (stems_ || grouping_)
232 programming_error ("already have autobeam");
236 stems_ = new vector<Item *>;
237 grouping_ = new Beaming_pattern ();
238 beaming_options_.from_context (context ());
239 beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
241 beam_start_moment_ = now_mom ();
243 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
247 Auto_beam_engraver::junk_beam ()
256 beam_settings_ = SCM_EOL;
258 shortest_mom_ = Moment (Rational (1, 4));
262 Auto_beam_engraver::end_beam ()
264 if (stems_->size () < 2)
268 finished_beam_ = create_beam ();
272 announce_end_grob (finished_beam_, SCM_EOL);
273 finished_grouping_ = grouping_;
274 finished_beaming_options_ = beaming_options_;
279 beam_settings_ = SCM_EOL;
282 shortest_mom_ = Moment (Rational (1, 4));
286 Auto_beam_engraver::typeset_beam ()
290 if (!finished_beam_->get_bound (RIGHT))
291 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
293 finished_grouping_->beamify (finished_beaming_options_);
294 Beam::set_beaming (finished_beam_, finished_grouping_);
297 delete finished_grouping_;
298 finished_grouping_ = 0;
303 Auto_beam_engraver::stop_translation_timestep ()
306 process_acknowledged_count_ = 0;
311 Auto_beam_engraver::finalize ()
313 /* finished beams may be typeset */
315 /* but unfinished may need another announce/acknowledge pass */
322 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
324 check_bar_property ();
330 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
332 check_bar_property ();
338 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
340 check_bar_property ();
346 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
348 check_bar_property ();
354 Auto_beam_engraver::acknowledge_stem (Grob_info info)
356 check_bar_property ();
357 Item *stem = dynamic_cast<Item *> (info.grob ());
358 Stream_event *ev = info.ultimate_event_cause ();
359 if (!ev->in_event_class ("rhythmic-event"))
361 programming_error ("stem must have rhythmic structure");
366 Don't (start) auto-beam over empty stems; skips or rests
368 if (!Stem::head_count (stem))
375 if (Stem::get_beam (stem))
382 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
394 Moment now = now_mom ();
395 if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
398 Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
399 Moment measure_now = measure_position (context ());
400 bool recheck_needed = false;
402 if (dur < shortest_mom_)
404 /* new shortest moment, so store it and set recheck_needed */
406 recheck_needed = true;
409 /* end should be based on shortest_mom_, begin should be
410 based on current duration */
411 consider_end (measure_now, shortest_mom_);
412 consider_begin (measure_now, dur);
417 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
419 Stem::is_invisible (stem));
420 stems_->push_back (stem);
422 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
428 Auto_beam_engraver::recheck_beam ()
431 Recheck the beam after the shortest duration has changed
432 If shorter duration has created a new break, typeset the
433 first part of the beam and reset the current beam to just
434 the last part of the beam
436 Beaming_pattern *new_grouping_ = 0;
437 vector<Item *> *new_stems_ = 0;
438 Moment temporary_shortest_mom;
439 SCM temporary_beam_settings;
444 for (vsize i = 0; i < stems_->size () - 1;)
446 found_end = test_moment (STOP,
447 grouping_->end_moment (i),
454 Save the current beam settings and shortest_mom_
455 Necessary because end_beam destroys them
457 temporary_shortest_mom = shortest_mom_;
458 temporary_beam_settings = beam_settings_;
460 /* Eliminate (and save) the items no longer part of the first beam */
462 new_grouping_ = grouping_->split_pattern (i);
463 new_stems_ = remove_end_stems (i);
468 /* now recreate the unbeamed data structures */
470 grouping_ = new_grouping_;
471 shortest_mom_ = temporary_shortest_mom;
472 beam_settings_ = temporary_beam_settings;
482 Remove all stems with an index greater than split_index
483 from stems_, and return a vector containing all of the
487 Auto_beam_engraver::remove_end_stems (vsize split_index)
489 vector <Item *> *removed_stems = 0;
490 removed_stems = new vector <Item *>;
492 for (vsize j = split_index + 1; j < stems_->size (); j++)
493 removed_stems->push_back ((*stems_).at (j));
494 for (vsize j = split_index + 1; j < stems_->size ();)
496 return removed_stems;
500 Auto_beam_engraver::process_acknowledged ()
502 Moment now = now_mom();
503 if (extend_mom_ > now)
506 if (!process_acknowledged_count_)
508 Moment measure_now = measure_position (context ());
509 consider_end (measure_now, shortest_mom_);
511 else if (process_acknowledged_count_ > 1)
515 if ((extend_mom_ < now)
516 || ((extend_mom_ == now) && (last_add_mom_ != now)))
518 else if (!stems_->size ())
523 process_acknowledged_count_++;
526 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
527 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
528 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
529 ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
530 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
531 ADD_TRANSLATOR (Auto_beam_engraver,
533 "Generate beams based on measure characteristics and observed"
534 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
535 " @code{beamExceptions}, @code{measureLength}, and"
536 " @code{measurePosition} to decide when to start and stop a"
537 " beam. Overriding beaming is done through"
538 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
539 " @code{stemRightBeamCount}.",