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_;
83 Context *beam_start_context_;
85 // We act as if beam were created, and start a grouping anyway.
86 Beaming_pattern *grouping_;
89 Beaming_pattern *finished_grouping_;
91 Beaming_options beaming_options_;
92 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_);
146 Auto_beam_engraver::Auto_beam_engraver ()
149 process_acknowledged_count_ = 0;
151 shortest_mom_ = Moment (Rational (1, 4));
153 finished_grouping_ = 0;
155 beam_settings_ = SCM_EOL;
158 IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
160 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
162 ASSIGN_EVENT_ONCE (forbid_, ev);
166 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
168 return scm_call_4 (get_property ("autoBeamCheck"),
169 context ()->self_scm (),
171 test_mom.smobbed_copy (),
177 Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
179 bool on = to_boolean (get_property ("autoBeaming"));
183 bool b = test_moment (START, test_mom, dur);
190 Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
194 /* Allow already started autobeam to end:
195 don't check for autoBeaming */
196 bool b = test_moment (STOP, test_mom, dur);
203 Auto_beam_engraver::create_beam ()
205 if (to_boolean (get_property ("skipTypesetting")))
208 for (vsize i = 0; i < stems_->size (); i++)
209 if (Stem::get_beam ((*stems_)[i]))
213 Can't use make_spanner () because we have to use
216 Spanner *beam = new Spanner (beam_settings_);
218 for (vsize i = 0; i < stems_->size (); i++)
219 Beam::add_stem (beam, (*stems_)[i]);
221 Grob_info i = make_grob_info (beam, (*stems_)[0]->self_scm ());
222 i.rerouting_daddy_context_ = beam_start_context_;
229 Auto_beam_engraver::begin_beam ()
231 if (stems_ || grouping_)
233 programming_error ("already have autobeam");
237 stems_ = new vector<Item *>;
238 grouping_ = new Beaming_pattern ();
239 beaming_options_.from_context (context ());
240 beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
242 beam_start_context_ = context ()->get_parent_context ();
243 beam_start_moment_ = now_mom ();
245 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
249 Auto_beam_engraver::junk_beam ()
258 beam_settings_ = SCM_EOL;
260 shortest_mom_ = Moment (Rational (1, 4));
264 Auto_beam_engraver::end_beam ()
266 if (stems_->size () < 2)
270 finished_beam_ = create_beam ();
274 Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
275 i.rerouting_daddy_context_ = beam_start_context_;
277 announce_end_grob (i);
278 finished_grouping_ = grouping_;
279 finished_beaming_options_ = beaming_options_;
284 beam_settings_ = SCM_EOL;
287 shortest_mom_ = Moment (Rational (1, 4));
291 Auto_beam_engraver::typeset_beam ()
295 if (!finished_beam_->get_bound (RIGHT))
296 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
298 finished_grouping_->beamify (finished_beaming_options_);
299 Beam::set_beaming (finished_beam_, finished_grouping_);
302 delete finished_grouping_;
303 finished_grouping_ = 0;
308 Auto_beam_engraver::stop_translation_timestep ()
311 process_acknowledged_count_ = 0;
316 Auto_beam_engraver::finalize ()
318 /* finished beams may be typeset */
320 /* but unfinished may need another announce/acknowledge pass */
326 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
328 check_bar_property ();
334 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
336 check_bar_property ();
342 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
344 check_bar_property ();
350 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
352 check_bar_property ();
358 Auto_beam_engraver::acknowledge_stem (Grob_info info)
360 check_bar_property ();
361 Item *stem = dynamic_cast<Item *> (info.grob ());
362 Stream_event *ev = info.ultimate_event_cause ();
363 if (!ev->in_event_class ("rhythmic-event"))
365 programming_error ("stem must have rhythmic structure");
370 Don't (start) auto-beam over empty stems; skips or rests
372 if (!Stem::head_count (stem))
379 if (Stem::get_beam (stem))
386 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
398 Moment now = now_mom ();
399 if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
402 Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
403 Moment measure_now = measure_position (context ());
404 bool recheck_needed = false;
406 if (dur < shortest_mom_)
408 /* new shortest moment, so store it and set recheck_needed */
410 recheck_needed = true;
413 /* end should be based on shortest_mom_, begin should be
414 based on current duration */
415 consider_end (measure_now, shortest_mom_);
416 consider_begin (measure_now, dur);
421 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
423 Stem::is_invisible (stem));
424 stems_->push_back (stem);
426 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
432 Auto_beam_engraver::recheck_beam ()
435 Recheck the beam after the shortest duration has changed
436 If shorter duration has created a new break, typeset the
437 first part of the beam and reset the current beam to just
438 the last part of the beam
440 Beaming_pattern *new_grouping_ = 0;
441 vector<Item *> *new_stems_ = 0;
442 Moment temporary_shortest_mom;
443 SCM temporary_beam_settings;
447 for (vsize i = 0; i < stems_->size () - 1;)
449 found_end = test_moment (STOP,
450 grouping_->end_moment (i),
457 Save the current beam settings and shortest_mom_
458 Necessary because end_beam destroys them
460 temporary_shortest_mom = shortest_mom_;
461 temporary_beam_settings = beam_settings_;
463 /* Eliminate (and save) the items no longer part of the first beam */
465 new_grouping_ = grouping_->split_pattern (i);
466 new_stems_ = remove_end_stems (i);
471 /* now recreate the unbeamed data structures */
473 grouping_ = new_grouping_;
474 shortest_mom_ = temporary_shortest_mom;
475 beam_settings_ = temporary_beam_settings;
485 Remove all stems with an index greater than split_index
486 from stems_, and return a vector containing all of the
490 Auto_beam_engraver::remove_end_stems (vsize split_index)
492 vector <Item *> *removed_stems = 0;
493 removed_stems = new vector <Item *>;
495 for (vsize j = split_index + 1; j < stems_->size (); j++)
496 removed_stems->push_back ((*stems_).at (j));
497 for (vsize j = split_index + 1; j < stems_->size ();)
499 return removed_stems;
503 Auto_beam_engraver::process_acknowledged ()
505 Moment now = now_mom ();
506 if (extend_mom_ > now)
509 if (!process_acknowledged_count_)
511 Moment measure_now = measure_position (context ());
512 consider_end (measure_now, shortest_mom_);
514 else if (process_acknowledged_count_ > 1)
518 if ((extend_mom_ < now)
519 || ((extend_mom_ == now) && (last_add_mom_ != now)))
521 else if (!stems_->size ())
526 process_acknowledged_count_++;
529 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
530 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
531 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
532 ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
533 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
534 ADD_TRANSLATOR (Auto_beam_engraver,
536 "Generate beams based on measure characteristics and observed"
537 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
538 " @code{beamExceptions}, @code{measureLength}, and"
539 " @code{measurePosition} to decide when to start and stop a"
540 " beam. Overriding beaming is done through"
541 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
542 " @code{stemRightBeamCount}.",