2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2015 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 "beaming-pattern.hh"
23 #include "context-handle.hh"
24 #include "duration.hh"
25 #include "engraver.hh"
26 #include "grob-properties.hh"
30 #include "stream-event.hh"
34 #include "translator.icc"
38 class Auto_beam_engraver : public Engraver
40 TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
43 void stop_translation_timestep ();
44 void process_acknowledged ();
46 virtual void process_music ();
47 virtual void finalize ();
48 virtual void derived_mark () const;
50 DECLARE_ACKNOWLEDGER (rest);
51 DECLARE_ACKNOWLEDGER (beam);
52 DECLARE_ACKNOWLEDGER (bar_line);
53 DECLARE_ACKNOWLEDGER (breathing_sign);
54 DECLARE_ACKNOWLEDGER (stem);
55 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
58 virtual bool test_moment (Direction, Moment, Moment);
59 void consider_begin (Moment, Moment);
60 void consider_end (Moment, Moment);
61 Spanner *create_beam ();
65 virtual bool is_same_grace_state (Moment, Moment);
68 vector<Item *> *remove_end_stems (vsize);
70 Stream_event *forbid_;
72 shortest_mom_ is the shortest note in the beam.
75 Spanner *finished_beam_;
76 vector<Item *> *stems_;
78 int process_acknowledged_count_;
81 Projected ending of the beam we're working on.
84 Moment beam_start_moment_;
85 Moment beam_start_location_;
87 Handle on the starting staff keeps it alive until beam is comlete
89 Context_handle beam_start_context_;
91 // We act as if beam were created, and start a grouping anyway.
92 Beaming_pattern *grouping_;
95 Beaming_pattern *finished_grouping_;
97 Beaming_options beaming_options_;
98 Beaming_options finished_beaming_options_;
100 void check_bar_property ();
104 Auto_beam_engraver::derived_mark () const
106 scm_gc_mark (beam_settings_);
110 Auto_beam_engraver::check_bar_property ()
112 /* Duplicated from process_music (), since
113 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
115 Moment now = now_mom ();
116 if (scm_is_string (get_property ("whichBar"))
117 && beam_start_moment_ < now)
119 consider_end (measure_position (context ()), shortest_mom_);
125 Auto_beam_engraver::process_music ()
127 Moment now = now_mom ();
129 don't beam over skips
133 if (extend_mom_ < now)
137 if (scm_is_string (get_property ("whichBar")))
139 consider_end (measure_position (context ()), shortest_mom_);
152 Auto_beam_engraver::Auto_beam_engraver ()
155 process_acknowledged_count_ = 0;
157 shortest_mom_ = Moment (Rational (1, 4));
158 extend_mom_ = Moment (-1);
160 finished_grouping_ = 0;
162 beam_settings_ = SCM_EOL;
165 IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
167 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
169 ASSIGN_EVENT_ONCE (forbid_, ev);
173 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
175 return scm_is_true (scm_call_4 (get_property ("autoBeamCheck"),
176 context ()->self_scm (),
178 test_mom.smobbed_copy (),
179 dur.smobbed_copy ()));
183 Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
185 bool on = to_boolean (get_property ("autoBeaming"));
189 bool b = test_moment (START, test_mom, dur);
196 Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
200 /* Allow already started autobeam to end:
201 don't check for autoBeaming */
202 bool b = test_moment (STOP, test_mom, dur);
209 Auto_beam_engraver::create_beam ()
211 if (to_boolean (get_property ("skipTypesetting")))
214 for (vsize i = 0; i < stems_->size (); i++)
215 if (Stem::get_beam ((*stems_)[i]))
219 Can't use make_spanner () because we have to use
222 Spanner *beam = new Spanner (beam_settings_);
224 for (vsize i = 0; i < stems_->size (); i++)
225 Beam::add_stem (beam, (*stems_)[i]);
227 Grob_info i = make_grob_info (beam, (*stems_)[0]->self_scm ());
228 i.rerouting_daddy_context_ = beam_start_context_.get_context ();
235 Auto_beam_engraver::begin_beam ()
237 if (stems_ || grouping_)
239 programming_error ("already have autobeam");
243 stems_ = new vector<Item *>;
244 grouping_ = new Beaming_pattern ();
245 beaming_options_.from_context (context ());
246 beam_settings_ = Grob_property_info (context (), ly_symbol2scm ("Beam")).updated ();
248 beam_start_context_.set_context (context ()->get_parent_context ());
249 beam_start_moment_ = now_mom ();
251 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
255 Auto_beam_engraver::junk_beam ()
264 beam_settings_ = SCM_EOL;
266 shortest_mom_ = Moment (Rational (1, 4));
270 Auto_beam_engraver::is_same_grace_state (Moment start, Moment now)
272 return bool (start.grace_part_) == bool (now.grace_part_);
277 Auto_beam_engraver::end_beam ()
279 if (stems_->size () < 2)
283 finished_beam_ = create_beam ();
287 Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
288 i.rerouting_daddy_context_ = beam_start_context_.get_context ();
290 announce_end_grob (i);
291 finished_grouping_ = grouping_;
292 finished_beaming_options_ = beaming_options_;
297 beam_settings_ = SCM_EOL;
300 beam_start_context_.set_context (NULL);
301 shortest_mom_ = Moment (Rational (1, 4));
305 Auto_beam_engraver::typeset_beam ()
309 if (!finished_beam_->get_bound (RIGHT))
310 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
312 finished_grouping_->beamify (finished_beaming_options_);
313 Beam::set_beaming (finished_beam_, finished_grouping_);
316 delete finished_grouping_;
317 finished_grouping_ = 0;
322 Auto_beam_engraver::stop_translation_timestep ()
325 process_acknowledged_count_ = 0;
330 Auto_beam_engraver::finalize ()
332 /* finished beams may be typeset */
334 /* but unfinished may need another announce/acknowledge pass */
340 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
342 check_bar_property ();
348 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
350 check_bar_property ();
356 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
358 check_bar_property ();
364 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
366 check_bar_property ();
372 Auto_beam_engraver::acknowledge_stem (Grob_info info)
374 check_bar_property ();
375 Item *stem = dynamic_cast<Item *> (info.grob ());
376 Stream_event *ev = info.ultimate_event_cause ();
377 if (!ev->in_event_class ("rhythmic-event"))
379 programming_error ("stem must have rhythmic structure");
384 Don't (start) auto-beam over empty stems; skips or rests
386 if (!Stem::head_count (stem))
393 if (Stem::get_beam (stem))
400 int durlog = unsmob<Duration> (ev->get_property ("duration"))->duration_log ();
410 ignore interspersed grace notes.
412 Moment now = now_mom ();
413 if (!is_same_grace_state (beam_start_location_, now))
416 Duration *stem_duration = unsmob<Duration> (ev->get_property ("duration"));
417 Moment dur = stem_duration->get_length ();
419 //Moment dur = unsmob<Duration> (ev->get_property ("duration"))->get_length ();
420 Moment measure_now = measure_position (context ());
421 bool recheck_needed = false;
423 if (dur < shortest_mom_)
425 /* new shortest moment, so store it and set recheck_needed */
427 recheck_needed = true;
430 /* end should be based on shortest_mom_, begin should be
431 based on current duration */
432 consider_end (measure_now, shortest_mom_);
433 consider_begin (measure_now, dur);
438 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
440 Stem::is_invisible (stem),
441 stem_duration->factor (),
442 (to_boolean (stem->get_property ("tuplet-start"))));
443 stems_->push_back (stem);
445 extend_mom_ = std::max (extend_mom_, now) + get_event_length (ev, now);
451 Auto_beam_engraver::recheck_beam ()
454 Recheck the beam after the shortest duration has changed
455 If shorter duration has created a new break, typeset the
456 first part of the beam and reset the current beam to just
457 the last part of the beam
459 Beaming_pattern *new_grouping_ = 0;
460 vector<Item *> *new_stems_ = 0;
461 Moment temporary_shortest_mom;
462 SCM temporary_beam_settings;
466 for (vsize i = 0; i < stems_->size () - 1;)
468 found_end = test_moment (STOP,
469 grouping_->end_moment (i),
476 Save the current beam settings and shortest_mom_
477 Necessary because end_beam destroys them
479 temporary_shortest_mom = shortest_mom_;
480 temporary_beam_settings = beam_settings_;
482 /* Eliminate (and save) the items no longer part of the first beam */
484 new_grouping_ = grouping_->split_pattern (i);
485 new_stems_ = remove_end_stems (i);
490 /* now recreate the unbeamed data structures */
492 grouping_ = new_grouping_;
493 shortest_mom_ = temporary_shortest_mom;
494 beam_settings_ = temporary_beam_settings;
504 Remove all stems with an index greater than split_index
505 from stems_, and return a vector containing all of the
509 Auto_beam_engraver::remove_end_stems (vsize split_index)
511 vector <Item *> *removed_stems = 0;
512 removed_stems = new vector <Item *>;
514 for (vsize j = split_index + 1; j < stems_->size (); j++)
515 removed_stems->push_back ((*stems_).at (j));
516 for (vsize j = split_index + 1; j < stems_->size ();)
518 return removed_stems;
522 Auto_beam_engraver::process_acknowledged ()
524 Moment now = now_mom ();
525 if (extend_mom_ > now)
528 if (!process_acknowledged_count_)
530 Moment measure_now = measure_position (context ());
531 consider_end (measure_now, shortest_mom_);
533 else if (process_acknowledged_count_ > 1)
537 if ((extend_mom_ < now)
538 || ((extend_mom_ == now) && (last_add_mom_ != now)))
540 else if (!stems_->size ())
545 process_acknowledged_count_++;
548 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
549 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
550 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
551 ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
552 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
553 ADD_TRANSLATOR (Auto_beam_engraver,
555 "Generate beams based on measure characteristics and observed"
556 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
557 " @code{beamExceptions}, @code{measureLength}, and"
558 " @code{measurePosition} to decide when to start and stop a"
559 " beam. Overriding beaming is done through"
560 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
561 " @code{stemRightBeamCount}.",
578 class Grace_auto_beam_engraver : public Auto_beam_engraver
580 TRANSLATOR_DECLARATIONS (Grace_auto_beam_engraver);
581 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
584 Moment last_grace_start_; // Full starting time of last grace group
585 Moment last_grace_position_; // Measure position of same
586 virtual void process_music ();
587 virtual bool is_same_grace_state (Moment, Moment);
588 virtual bool test_moment (Direction, Moment, Moment);
591 Grace_auto_beam_engraver::Grace_auto_beam_engraver ()
593 last_grace_start_.main_part_.set_infinite (-1);
594 // grace_part_ is zero -> test_moment is false, last_grace_position_
598 IMPLEMENT_TRANSLATOR_LISTENER (Grace_auto_beam_engraver, beam_forbid);
600 Grace_auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
602 Auto_beam_engraver::listen_beam_forbid (ev);
606 Grace_auto_beam_engraver::is_same_grace_state (Moment, Moment)
608 // This is for ignoring interspersed grace notes in main note
609 // beaming. We never want to ignore something inside of grace note
610 // beaming, so return true.
615 Grace_auto_beam_engraver::process_music ()
617 Moment now = now_mom ();
618 // Update last_grace_start_ and last_grace_position_ only when the
619 // main time advances.
620 if (now.main_part_ > last_grace_start_.main_part_)
622 last_grace_start_ = now;
623 last_grace_position_ = measure_position (context ());
626 Auto_beam_engraver::process_music ();
630 Grace_auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment)
632 // If no grace group started this main moment, we have no business
633 // beaming. Same if we have left the original main time step.
634 if (!last_grace_start_.grace_part_
635 || last_grace_position_.main_part_ != test_mom.main_part_)
637 // Autobeam start only when at the start of the grace group.
639 return last_grace_position_ == test_mom;
640 // Autobeam end only when the grace part is finished.
641 return !test_mom.grace_part_;
644 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, stem);
645 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, bar_line);
646 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, beam);
647 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, breathing_sign);
648 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, rest);
649 ADD_TRANSLATOR (Grace_auto_beam_engraver,
651 "Generates one autobeam group across an entire grace phrase. "
652 " As usual, any manual beaming or @code{\\noBeam} will block"
653 " autobeaming, just like setting the context property"
654 " @samp{autoBeaming} to @code{##f}.",