/*
- auto-beam-engraver.cc -- implement Auto_beam_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1999--2014 Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1999--2005 Jan Nieuwenhuizen <janneke@gnu.org>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "engraver.hh"
-#include "beaming.hh"
+#include "beaming-pattern.hh"
#include "beam.hh"
-#include "stem.hh"
-#include "warn.hh"
-#include "bar-line.hh"
-#include "rest.hh"
-#include "item.hh"
-#include "spanner.hh"
#include "context.hh"
+#include "context-handle.hh"
#include "duration.hh"
+#include "engraver.hh"
+#include "item.hh"
+#include "rest.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "stem.hh"
+#include "warn.hh"
#include "translator.icc"
-
class Auto_beam_engraver : public Engraver
{
TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
protected:
void stop_translation_timestep ();
- void start_translation_timestep ();
- void process_music ();
- virtual bool try_music (Music *);
+ void process_acknowledged ();
+
+ virtual void process_music ();
virtual void finalize ();
+ virtual void derived_mark () const;
- DECLARE_ACKNOWLEDGER(rest);
- DECLARE_ACKNOWLEDGER(beam);
- DECLARE_ACKNOWLEDGER(bar_line);
- DECLARE_ACKNOWLEDGER(stem);
-
- void process_acknowledged ();
+ DECLARE_ACKNOWLEDGER (rest);
+ DECLARE_ACKNOWLEDGER (beam);
+ DECLARE_ACKNOWLEDGER (bar_line);
+ DECLARE_ACKNOWLEDGER (breathing_sign);
+ DECLARE_ACKNOWLEDGER (stem);
+ DECLARE_TRANSLATOR_LISTENER (beam_forbid);
private:
- bool test_moment (Direction, Moment);
- void consider_begin (Moment);
- void consider_end (Moment);
+ virtual bool test_moment (Direction, Moment, Moment);
+ void consider_begin (Moment, Moment);
+ void consider_end (Moment, Moment);
Spanner *create_beam ();
void begin_beam ();
void end_beam ();
void junk_beam ();
- bool is_same_grace_state (Grob *e);
+ virtual bool is_same_grace_state (Moment, Moment);
+ void recheck_beam ();
void typeset_beam ();
+ vector<Item *> *remove_end_stems (vsize);
- Music *forbid_;
+ Stream_event *forbid_;
/*
- shortest_mom is the shortest note in the beam.
+ shortest_mom_ is the shortest note in the beam.
*/
Moment shortest_mom_;
Spanner *finished_beam_;
- Link_array<Item> *stems_;
+ vector<Item *> *stems_;
int process_acknowledged_count_;
Moment last_add_mom_;
Moment extend_mom_;
Moment beam_start_moment_;
Moment beam_start_location_;
-
- bool subdivide_beams_;
- Moment beat_length_;
+ /*
+ Handle on the starting staff keeps it alive until beam is comlete
+ */
+ Context_handle beam_start_context_;
// We act as if beam were created, and start a grouping anyway.
- Beaming_info_list *grouping_;
- SCM beam_settings_; // ugh. should protect ?
+ Beaming_pattern *grouping_;
+ SCM beam_settings_;
+
+ Beaming_pattern *finished_grouping_;
- Beaming_info_list *finished_grouping_;
+ Beaming_options beaming_options_;
+ Beaming_options finished_beaming_options_;
void check_bar_property ();
};
+void
+Auto_beam_engraver::derived_mark () const
+{
+ scm_gc_mark (beam_settings_);
+}
void
Auto_beam_engraver::check_bar_property ()
if (scm_is_string (get_property ("whichBar"))
&& beam_start_moment_ < now)
{
- consider_end (shortest_mom_);
+ consider_end (measure_position (context ()), shortest_mom_);
junk_beam ();
}
}
void
Auto_beam_engraver::process_music ()
{
+ Moment now = now_mom ();
+ /*
+ don't beam over skips
+ */
+ if (stems_)
+ {
+ if (extend_mom_ < now)
+ end_beam ();
+ }
+
if (scm_is_string (get_property ("whichBar")))
{
- consider_end (shortest_mom_);
+ consider_end (measure_position (context ()), shortest_mom_);
junk_beam ();
}
if (forbid_)
{
- consider_end (shortest_mom_);
- junk_beam ();
+ if (stems_)
+ end_beam ();
+ else
+ junk_beam ();
}
}
forbid_ = 0;
process_acknowledged_count_ = 0;
stems_ = 0;
- shortest_mom_ = Moment (Rational (1, 8));
+ shortest_mom_ = Moment (Rational (1, 4));
finished_beam_ = 0;
finished_grouping_ = 0;
grouping_ = 0;
beam_settings_ = SCM_EOL;
}
-bool
-Auto_beam_engraver::try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
+void
+Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
{
- if (m->is_mus_type ("beam-forbid-event"))
- {
- forbid_ = m;
- return true;
- }
-
- return false;
+ ASSIGN_EVENT_ONCE (forbid_, ev);
}
bool
-Auto_beam_engraver::test_moment (Direction dir, Moment test)
+Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
{
- return scm_call_3 (get_property ("autoBeamCheck"),
- context ()->self_scm (),
- scm_from_int (dir),
- test.smobbed_copy ())
- != SCM_BOOL_F;
+ return scm_call_4 (get_property ("autoBeamCheck"),
+ context ()->self_scm (),
+ scm_from_int (dir),
+ test_mom.smobbed_copy (),
+ dur.smobbed_copy ())
+ != SCM_BOOL_F;
}
-
+
void
-Auto_beam_engraver::consider_begin (Moment test_mom)
+Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
{
bool on = to_boolean (get_property ("autoBeaming"));
if (!stems_ && on
&& !forbid_)
{
- bool b = test_moment (START, test_mom);
+ bool b = test_moment (START, test_mom, dur);
if (b)
- begin_beam ();
+ begin_beam ();
}
}
void
-Auto_beam_engraver::consider_end (Moment test_mom)
+Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
{
if (stems_)
{
/* Allow already started autobeam to end:
- don't check for autoBeaming */
- bool b = test_moment (STOP, test_mom);
+ don't check for autoBeaming */
+ bool b = test_moment (STOP, test_mom, dur);
if (b)
- end_beam ();
+ end_beam ();
}
}
if (to_boolean (get_property ("skipTypesetting")))
return 0;
- for (int i = 0; i < stems_->size (); i++)
+ for (vsize i = 0; i < stems_->size (); i++)
if (Stem::get_beam ((*stems_)[i]))
return 0;
- Spanner *beam = new Spanner (beam_settings_, context ()->get_grob_key ("Beam"));
- for (int i = 0; i < stems_->size (); i++)
- {
- Beam::add_stem (beam, (*stems_)[i]);
- }
+ /*
+ Can't use make_spanner () because we have to use
+ beam_settings_.
+ */
+ Spanner *beam = new Spanner (beam_settings_);
+
+ for (vsize i = 0; i < stems_->size (); i++)
+ Beam::add_stem (beam, (*stems_)[i]);
- announce_grob (beam, (*stems_)[0]->self_scm ());
+ Grob_info i = make_grob_info (beam, (*stems_)[0]->self_scm ());
+ i.rerouting_daddy_context_ = beam_start_context_.get_context ();
+ announce_grob (i);
return beam;
}
return;
}
- stems_ = new Link_array<Item>;
- grouping_ = new Beaming_info_list;
+ stems_ = new vector<Item *>;
+ grouping_ = new Beaming_pattern ();
+ beaming_options_.from_context (context ());
beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
+ beam_start_context_.set_context (context ()->get_parent_context ());
beam_start_moment_ = now_mom ();
beam_start_location_
= robust_scm2moment (get_property ("measurePosition"), Moment (0));
- subdivide_beams_ = ly_scm2bool (get_property ("subdivideBeams"));
- beat_length_ = robust_scm2moment (get_property ("beatLength"), Moment (1, 4));
}
void
grouping_ = 0;
beam_settings_ = SCM_EOL;
- shortest_mom_ = Moment (Rational (1, 8));
+ shortest_mom_ = Moment (Rational (1, 4));
+}
+
+bool
+Auto_beam_engraver::is_same_grace_state (Moment start, Moment now)
+{
+ return bool (start.grace_part_) == bool (now.grace_part_);
}
+
void
Auto_beam_engraver::end_beam ()
{
if (stems_->size () < 2)
- {
- junk_beam ();
- }
+ junk_beam ();
else
{
finished_beam_ = create_beam ();
+
if (finished_beam_)
- finished_grouping_ = grouping_;
+ {
+ Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
+ i.rerouting_daddy_context_ = beam_start_context_.get_context ();
+
+ announce_end_grob (i);
+ finished_grouping_ = grouping_;
+ finished_beaming_options_ = beaming_options_;
+ }
delete stems_;
stems_ = 0;
grouping_ = 0;
beam_settings_ = SCM_EOL;
}
- shortest_mom_ = Moment (Rational (1, 8));
+ beam_start_context_.set_context (NULL);
+ shortest_mom_ = Moment (Rational (1, 4));
}
void
{
if (finished_beam_)
{
- finished_grouping_->beamify (beat_length_, subdivide_beams_);
+ if (!finished_beam_->get_bound (RIGHT))
+ finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
+
+ finished_grouping_->beamify (finished_beaming_options_);
Beam::set_beaming (finished_beam_, finished_grouping_);
finished_beam_ = 0;
}
}
-void
-Auto_beam_engraver::start_translation_timestep ()
-{
- process_acknowledged_count_ = 0;
- /*
- don't beam over skips
- */
- if (stems_)
- {
- Moment now = now_mom ();
- if (extend_mom_ < now)
- {
- end_beam ();
- }
- }
- forbid_ = 0;
-}
-
void
Auto_beam_engraver::stop_translation_timestep ()
{
typeset_beam ();
+ process_acknowledged_count_ = 0;
+ forbid_ = 0;
}
void
junk_beam ();
}
-
-
+void
+Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
+{
+ check_bar_property ();
+ if (stems_)
+ end_beam ();
+}
void
-Auto_beam_engraver::acknowledge_beam (Grob_info info)
+Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
{
- (void)info;
check_bar_property ();
if (stems_)
- {
- end_beam ();
- }
+ end_beam ();
}
-
+
void
-Auto_beam_engraver::acknowledge_bar_line (Grob_info info)
+Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
{
- (void)info;
check_bar_property ();
if (stems_)
end_beam ();
}
void
-Auto_beam_engraver::acknowledge_rest (Grob_info info)
+Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
{
- (void)info;
check_bar_property ();
if (stems_)
end_beam ();
{
check_bar_property ();
Item *stem = dynamic_cast<Item *> (info.grob ());
- Music *m = info.music_cause ();
- if (!m->is_mus_type ("rhythmic-event"))
+ Stream_event *ev = info.ultimate_event_cause ();
+ if (!ev->in_event_class ("rhythmic-event"))
{
programming_error ("stem must have rhythmic structure");
return;
if (!Stem::head_count (stem))
{
if (stems_)
- end_beam ();
+ end_beam ();
return;
}
if (Stem::get_beam (stem))
{
if (stems_)
- junk_beam ();
+ junk_beam ();
return;
}
- int durlog = unsmob_duration (m->get_property ("duration"))->duration_log ();
+ int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
if (durlog <= 2)
{
if (stems_)
- end_beam ();
+ end_beam ();
return;
}
/*
- ignore grace notes.
+ ignore interspersed grace notes.
*/
Moment now = now_mom ();
- if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
+ if (!is_same_grace_state (beam_start_location_, now))
return;
- Moment dur = unsmob_duration (m->get_property ("duration"))->get_length ();
+ Duration *stem_duration = unsmob_duration (ev->get_property ("duration"));
+ Moment dur = stem_duration->get_length ();
- consider_end (dur);
- consider_begin (dur);
+ //Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
+ Moment measure_now = measure_position (context ());
+ bool recheck_needed = false;
if (dur < shortest_mom_)
- shortest_mom_ = dur;
+ {
+ /* new shortest moment, so store it and set recheck_needed */
+ shortest_mom_ = dur;
+ recheck_needed = true;
+ }
+
+ /* end should be based on shortest_mom_, begin should be
+ based on current duration */
+ consider_end (measure_now, shortest_mom_);
+ consider_begin (measure_now, dur);
if (!stems_)
return;
grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
- durlog - 2);
- stems_->push (stem);
+ durlog - 2,
+ Stem::is_invisible (stem),
+ stem_duration->factor (),
+ (stem->get_property ("tuplet-start") == SCM_BOOL_T));
+ stems_->push_back (stem);
last_add_mom_ = now;
- extend_mom_ = max (extend_mom_, now) + m->get_length ();
+ extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
+ if (recheck_needed)
+ recheck_beam ();
+}
+
+void
+Auto_beam_engraver::recheck_beam ()
+{
+ /*
+ Recheck the beam after the shortest duration has changed
+ If shorter duration has created a new break, typeset the
+ first part of the beam and reset the current beam to just
+ the last part of the beam
+ */
+ Beaming_pattern *new_grouping_ = 0;
+ vector<Item *> *new_stems_ = 0;
+ Moment temporary_shortest_mom;
+ SCM temporary_beam_settings;
+
+ bool found_end;
+
+ for (vsize i = 0; i < stems_->size () - 1;)
+ {
+ found_end = test_moment (STOP,
+ grouping_->end_moment (i),
+ shortest_mom_);
+ if (!found_end)
+ i++;
+ else
+ {
+ /*
+ Save the current beam settings and shortest_mom_
+ Necessary because end_beam destroys them
+ */
+ temporary_shortest_mom = shortest_mom_;
+ temporary_beam_settings = beam_settings_;
+
+ /* Eliminate (and save) the items no longer part of the first beam */
+
+ new_grouping_ = grouping_->split_pattern (i);
+ new_stems_ = remove_end_stems (i);
+
+ end_beam ();
+ typeset_beam ();
+
+ /* now recreate the unbeamed data structures */
+ stems_ = new_stems_;
+ grouping_ = new_grouping_;
+ shortest_mom_ = temporary_shortest_mom;
+ beam_settings_ = temporary_beam_settings;
+
+ i = 0;
+ }
+
+ }
+
+}
+
+/*
+ Remove all stems with an index greater than split_index
+ from stems_, and return a vector containing all of the
+ removed stems
+*/
+vector <Item *> *
+Auto_beam_engraver::remove_end_stems (vsize split_index)
+{
+ vector <Item *> *removed_stems = 0;
+ removed_stems = new vector <Item *>;
+
+ for (vsize j = split_index + 1; j < stems_->size (); j++)
+ removed_stems->push_back ((*stems_).at (j));
+ for (vsize j = split_index + 1; j < stems_->size ();)
+ stems_->pop_back ();
+ return removed_stems;
}
void
Auto_beam_engraver::process_acknowledged ()
{
- if (extend_mom_ > now_mom ())
- return ;
+ Moment now = now_mom ();
+ if (extend_mom_ > now)
+ return;
if (!process_acknowledged_count_)
{
- consider_end (shortest_mom_);
- consider_begin (shortest_mom_);
+ Moment measure_now = measure_position (context ());
+ consider_end (measure_now, shortest_mom_);
}
else if (process_acknowledged_count_ > 1)
{
if (stems_)
- {
- Moment now = now_mom ();
- if ((extend_mom_ < now)
- || ((extend_mom_ == now) && (last_add_mom_ != now)))
- {
- end_beam ();
- }
- else if (!stems_->size ())
- {
- junk_beam ();
- }
- }
+ {
+ if ((extend_mom_ < now)
+ || ((extend_mom_ == now) && (last_add_mom_ != now)))
+ end_beam ();
+ else if (!stems_->size ())
+ junk_beam ();
+ }
}
process_acknowledged_count_++;
}
-ADD_ACKNOWLEDGER(Auto_beam_engraver,stem);
-ADD_ACKNOWLEDGER(Auto_beam_engraver,bar_line);
-ADD_ACKNOWLEDGER(Auto_beam_engraver,beam);
-ADD_ACKNOWLEDGER(Auto_beam_engraver,rest);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
ADD_TRANSLATOR (Auto_beam_engraver,
- /* descr */ "Generate beams based on measure characteristics and observed "
- "Stems. Uses beatLength, measureLength and measurePosition to decide "
- "when to start and stop a beam. Overriding beaming is done through "
- "@ref{Stem_engraver} properties @code{stemLeftBeamCount} and "
- "@code{stemRightBeamCount}. ",
- /* creats*/ "Beam",
- /* accepts */ "beam-forbid-event",
- /* reads */ "autoBeaming autoBeamSettings beatLength subdivideBeams",
- /* write */ "");
+ /* doc */
+ "Generate beams based on measure characteristics and observed"
+ " Stems. Uses @code{baseMoment}, @code{beatStructure},"
+ " @code{beamExceptions}, @code{measureLength}, and"
+ " @code{measurePosition} to decide when to start and stop a"
+ " beam. Overriding beaming is done through"
+ " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
+ " @code{stemRightBeamCount}.",
+
+ /* create */
+ "Beam ",
+
+ /* read */
+ "autoBeaming "
+ "baseMoment "
+ "beamExceptions "
+ "beamHalfMeasure "
+ "beatStructure "
+ "subdivideBeams ",
+
+ /* write */
+ ""
+ );
+
+class Grace_auto_beam_engraver : public Auto_beam_engraver
+{
+ TRANSLATOR_DECLARATIONS (Grace_auto_beam_engraver);
+ DECLARE_TRANSLATOR_LISTENER (beam_forbid);
+
+private:
+ Moment last_grace_start_; // Full starting time of last grace group
+ Moment last_grace_position_; // Measure position of same
+ virtual void process_music ();
+ virtual bool is_same_grace_state (Moment, Moment);
+ virtual bool test_moment (Direction, Moment, Moment);
+};
+
+Grace_auto_beam_engraver::Grace_auto_beam_engraver ()
+{
+ last_grace_start_.main_part_.set_infinite (-1);
+ // grace_part_ is zero -> test_moment is false, last_grace_position_
+ // not considered.
+}
+
+IMPLEMENT_TRANSLATOR_LISTENER (Grace_auto_beam_engraver, beam_forbid);
+void
+Grace_auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
+{
+ Auto_beam_engraver::listen_beam_forbid (ev);
+}
+
+bool
+Grace_auto_beam_engraver::is_same_grace_state (Moment, Moment)
+{
+ // This is for ignoring interspersed grace notes in main note
+ // beaming. We never want to ignore something inside of grace note
+ // beaming, so return true.
+ return true;
+}
+
+void
+Grace_auto_beam_engraver::process_music ()
+{
+ Moment now = now_mom ();
+ // Update last_grace_start_ and last_grace_position_ only when the
+ // main time advances.
+ if (now.main_part_ > last_grace_start_.main_part_)
+ {
+ last_grace_start_ = now;
+ last_grace_position_ = measure_position (context ());
+ }
+
+ Auto_beam_engraver::process_music ();
+}
+
+bool
+Grace_auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment)
+{
+ // If no grace group started this main moment, we have no business
+ // beaming. Same if we have left the original main time step.
+ if (!last_grace_start_.grace_part_
+ || last_grace_position_.main_part_ != test_mom.main_part_)
+ return false;
+ // Autobeam start only when at the start of the grace group.
+ if (dir == START)
+ return last_grace_position_ == test_mom;
+ // Autobeam end only when the grace part is finished.
+ return !test_mom.grace_part_;
+}
+
+ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, stem);
+ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, bar_line);
+ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, beam);
+ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, breathing_sign);
+ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, rest);
+ADD_TRANSLATOR (Grace_auto_beam_engraver,
+ /* doc */
+ "Generates one autobeam group across an entire grace phrase. "
+ " As usual, any manual beaming or @code{\\noBeam} will block"
+ " autobeaming, just like setting the context property"
+ " @samp{autoBeaming} to @code{##f}.",
+
+ /* create */
+ "Beam ",
+
+ /* read */
+ "autoBeaming ",
+
+ /* write */
+ ""
+ );