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"
36 class Auto_beam_engraver : public Engraver
38 TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
41 void stop_translation_timestep ();
42 void process_acknowledged ();
44 virtual void process_music ();
45 virtual void finalize ();
46 virtual void derived_mark () const;
48 void acknowledge_rest (Grob_info);
49 void acknowledge_beam (Grob_info);
50 void acknowledge_bar_line (Grob_info);
51 void acknowledge_breathing_sign (Grob_info);
52 void acknowledge_stem (Grob_info);
53 void listen_beam_forbid (Stream_event *);
56 virtual bool test_moment (Direction, Moment, Moment);
57 void consider_begin (Moment, Moment);
58 void consider_end (Moment, Moment);
59 Spanner *create_beam ();
63 virtual bool is_same_grace_state (Moment, Moment);
66 vector<Item *> *remove_end_stems (vsize);
68 Stream_event *forbid_;
70 shortest_mom_ is the shortest note in the beam.
73 Spanner *finished_beam_;
74 vector<Item *> *stems_;
76 int process_acknowledged_count_;
79 Projected ending of the beam we're working on.
82 Moment beam_start_moment_;
83 Moment beam_start_location_;
85 Handle on the starting staff keeps it alive until beam is comlete
87 Context_handle beam_start_context_;
89 // We act as if beam were created, and start a grouping anyway.
90 Beaming_pattern *grouping_;
93 Beaming_pattern *finished_grouping_;
95 Beaming_options beaming_options_;
96 Beaming_options finished_beaming_options_;
98 void check_bar_property ();
102 Auto_beam_engraver::derived_mark () const
104 scm_gc_mark (beam_settings_);
108 Auto_beam_engraver::check_bar_property ()
110 /* Duplicated from process_music (), since
111 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
113 Moment now = now_mom ();
114 if (scm_is_string (get_property ("whichBar"))
115 && beam_start_moment_ < now)
117 consider_end (measure_position (context ()), shortest_mom_);
123 Auto_beam_engraver::process_music ()
125 Moment now = now_mom ();
127 don't beam over skips
131 if (extend_mom_ < now)
135 if (scm_is_string (get_property ("whichBar")))
137 consider_end (measure_position (context ()), shortest_mom_);
150 Auto_beam_engraver::Auto_beam_engraver (Context *c)
154 process_acknowledged_count_ = 0;
156 shortest_mom_ = Moment (Rational (1, 4));
157 extend_mom_ = Moment (-1);
159 finished_grouping_ = 0;
161 beam_settings_ = SCM_EOL;
165 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
167 ASSIGN_EVENT_ONCE (forbid_, ev);
171 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
173 return scm_is_true (scm_call_4 (get_property ("autoBeamCheck"),
174 context ()->self_scm (),
176 test_mom.smobbed_copy (),
177 dur.smobbed_copy ()));
181 Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
183 bool on = to_boolean (get_property ("autoBeaming"));
187 bool b = test_moment (START, test_mom, dur);
194 Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
198 /* Allow already started autobeam to end:
199 don't check for autoBeaming */
200 bool b = test_moment (STOP, test_mom, dur);
207 Auto_beam_engraver::create_beam ()
209 if (to_boolean (get_property ("skipTypesetting")))
212 for (vsize i = 0; i < stems_->size (); i++)
213 if (Stem::get_beam ((*stems_)[i]))
217 Can't use make_spanner () because we have to use
220 Spanner *beam = new Spanner (beam_settings_);
222 for (vsize i = 0; i < stems_->size (); i++)
223 Beam::add_stem (beam, (*stems_)[i]);
225 Grob_info i = make_grob_info (beam, (*stems_)[0]->self_scm ());
226 announce_grob (i, beam_start_context_.get_context ());
232 Auto_beam_engraver::begin_beam ()
234 if (stems_ || grouping_)
236 programming_error ("already have autobeam");
240 stems_ = new vector<Item *>;
241 grouping_ = new Beaming_pattern ();
242 beaming_options_.from_context (context ());
243 beam_settings_ = Grob_property_info (context (), ly_symbol2scm ("Beam")).updated ();
245 beam_start_context_.set_context (context ()->get_parent_context ());
246 beam_start_moment_ = now_mom ();
248 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
252 Auto_beam_engraver::junk_beam ()
261 beam_settings_ = SCM_EOL;
263 shortest_mom_ = Moment (Rational (1, 4));
267 Auto_beam_engraver::is_same_grace_state (Moment start, Moment now)
269 return bool (start.grace_part_) == bool (now.grace_part_);
274 Auto_beam_engraver::end_beam ()
276 if (stems_->size () < 2)
280 finished_beam_ = create_beam ();
284 Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
286 announce_end_grob (i, beam_start_context_.get_context ());
287 finished_grouping_ = grouping_;
288 finished_beaming_options_ = beaming_options_;
293 beam_settings_ = SCM_EOL;
296 beam_start_context_.set_context (NULL);
297 shortest_mom_ = Moment (Rational (1, 4));
301 Auto_beam_engraver::typeset_beam ()
305 if (!finished_beam_->get_bound (RIGHT))
306 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
308 finished_grouping_->beamify (finished_beaming_options_);
309 Beam::set_beaming (finished_beam_, finished_grouping_);
312 delete finished_grouping_;
313 finished_grouping_ = 0;
318 Auto_beam_engraver::stop_translation_timestep ()
321 process_acknowledged_count_ = 0;
326 Auto_beam_engraver::finalize ()
328 /* finished beams may be typeset */
330 /* but unfinished may need another announce/acknowledge pass */
336 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
338 check_bar_property ();
344 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
346 check_bar_property ();
352 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
354 check_bar_property ();
360 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
362 check_bar_property ();
368 Auto_beam_engraver::acknowledge_stem (Grob_info info)
370 check_bar_property ();
371 Item *stem = dynamic_cast<Item *> (info.grob ());
372 Stream_event *ev = info.ultimate_event_cause ();
373 if (!ev->in_event_class ("rhythmic-event"))
375 programming_error ("stem must have rhythmic structure");
380 Don't (start) auto-beam over empty stems; skips or rests
382 if (!Stem::head_count (stem))
389 if (Stem::get_beam (stem))
396 int durlog = unsmob<Duration> (ev->get_property ("duration"))->duration_log ();
406 ignore interspersed grace notes.
408 Moment now = now_mom ();
409 if (!is_same_grace_state (beam_start_location_, now))
412 Duration *stem_duration = unsmob<Duration> (ev->get_property ("duration"));
413 Moment dur = stem_duration->get_length ();
415 //Moment dur = unsmob<Duration> (ev->get_property ("duration"))->get_length ();
416 Moment measure_now = measure_position (context ());
417 bool recheck_needed = false;
419 if (dur < shortest_mom_)
421 /* new shortest moment, so store it and set recheck_needed */
423 recheck_needed = true;
426 /* end should be based on shortest_mom_, begin should be
427 based on current duration */
428 consider_end (measure_now, shortest_mom_);
429 consider_begin (measure_now, dur);
434 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
436 Stem::is_invisible (stem),
437 stem_duration->factor (),
438 (to_boolean (stem->get_property ("tuplet-start"))));
439 stems_->push_back (stem);
441 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
447 Auto_beam_engraver::recheck_beam ()
450 Recheck the beam after the shortest duration has changed
451 If shorter duration has created a new break, typeset the
452 first part of the beam and reset the current beam to just
453 the last part of the beam
455 Beaming_pattern *new_grouping_ = 0;
456 vector<Item *> *new_stems_ = 0;
457 Moment temporary_shortest_mom;
458 SCM temporary_beam_settings;
462 for (vsize i = 0; i < stems_->size () - 1;)
464 found_end = test_moment (STOP,
465 grouping_->end_moment (i),
472 Save the current beam settings and shortest_mom_
473 Necessary because end_beam destroys them
475 temporary_shortest_mom = shortest_mom_;
476 temporary_beam_settings = beam_settings_;
478 /* Eliminate (and save) the items no longer part of the first beam */
480 new_grouping_ = grouping_->split_pattern (i);
481 new_stems_ = remove_end_stems (i);
486 /* now recreate the unbeamed data structures */
488 grouping_ = new_grouping_;
489 shortest_mom_ = temporary_shortest_mom;
490 beam_settings_ = temporary_beam_settings;
500 Remove all stems with an index greater than split_index
501 from stems_, and return a vector containing all of the
505 Auto_beam_engraver::remove_end_stems (vsize split_index)
507 vector <Item *> *removed_stems = 0;
508 removed_stems = new vector <Item *>;
510 for (vsize j = split_index + 1; j < stems_->size (); j++)
511 removed_stems->push_back ((*stems_).at (j));
512 for (vsize j = split_index + 1; j < stems_->size ();)
514 return removed_stems;
518 Auto_beam_engraver::process_acknowledged ()
520 Moment now = now_mom ();
521 if (extend_mom_ > now)
524 if (!process_acknowledged_count_)
526 Moment measure_now = measure_position (context ());
527 consider_end (measure_now, shortest_mom_);
529 else if (process_acknowledged_count_ > 1)
533 if ((extend_mom_ < now)
534 || ((extend_mom_ == now) && (last_add_mom_ != now)))
536 else if (!stems_->size ())
541 process_acknowledged_count_++;
545 Auto_beam_engraver::boot ()
547 ADD_LISTENER (Auto_beam_engraver, beam_forbid);
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);
555 ADD_TRANSLATOR (Auto_beam_engraver,
557 "Generate beams based on measure characteristics and observed"
558 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
559 " @code{beamExceptions}, @code{measureLength}, and"
560 " @code{measurePosition} to decide when to start and stop a"
561 " beam. Overriding beaming is done through"
562 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
563 " @code{stemRightBeamCount}.",
580 class Grace_auto_beam_engraver : public Auto_beam_engraver
582 TRANSLATOR_DECLARATIONS (Grace_auto_beam_engraver);
583 TRANSLATOR_INHERIT (Auto_beam_engraver);
586 Moment last_grace_start_; // Full starting time of last grace group
587 Moment last_grace_position_; // Measure position of same
588 virtual void process_music ();
589 virtual bool is_same_grace_state (Moment, Moment);
590 virtual bool test_moment (Direction, Moment, Moment);
593 Grace_auto_beam_engraver::Grace_auto_beam_engraver (Context *c)
594 : Auto_beam_engraver (c)
596 last_grace_start_.main_part_.set_infinite (-1);
597 // grace_part_ is zero -> test_moment is false, last_grace_position_
602 Grace_auto_beam_engraver::is_same_grace_state (Moment, Moment)
604 // This is for ignoring interspersed grace notes in main note
605 // beaming. We never want to ignore something inside of grace note
606 // beaming, so return true.
611 Grace_auto_beam_engraver::process_music ()
613 Moment now = now_mom ();
614 // Update last_grace_start_ and last_grace_position_ only when the
615 // main time advances.
616 if (now.main_part_ > last_grace_start_.main_part_)
618 last_grace_start_ = now;
619 last_grace_position_ = measure_position (context ());
622 Auto_beam_engraver::process_music ();
626 Grace_auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment)
628 // If no grace group started this main moment, we have no business
629 // beaming. Same if we have left the original main time step.
630 if (!last_grace_start_.grace_part_
631 || last_grace_position_.main_part_ != test_mom.main_part_)
633 // Autobeam start only when at the start of the grace group.
635 return last_grace_position_ == test_mom;
636 // Autobeam end only when the grace part is finished.
637 return !test_mom.grace_part_;
641 Grace_auto_beam_engraver::boot ()
643 ADD_LISTENER (Grace_auto_beam_engraver, beam_forbid);
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);
651 ADD_TRANSLATOR (Grace_auto_beam_engraver,
653 "Generates one autobeam group across an entire grace phrase. "
654 " As usual, any manual beaming or @code{\\noBeam} will block"
655 " autobeaming, just like setting the context property"
656 " @samp{autoBeaming} to @code{##f}.",