X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=aef96d8da5c3387953fd9aa5c9c74429a5e48222;hb=abbdb46061be5c0a0682059d1f86bf3e44ca5cf3;hp=ff73ee4c72fad2fa42e5f81d045a80b3463b790f;hpb=df4a7c4a55148e065d878dcc2f7e09ac27ea9c32;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index ff73ee4c72..0472c4cdec 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -1,448 +1,432 @@ -/* - auto-beam-engraver.cc -- implement Auto_beam_engraver - +/* + auto-beam-engraver.cc -- implement Auto_beam_engraver + source file of the GNU LilyPond music typesetter - - (c) 1999--2000 Jan Nieuwenhuizen - - */ -#include "beaming.hh" -#include "musical-request.hh" + (c) 1999--2006 Jan Nieuwenhuizen +*/ + +#include "bar-line.hh" +#include "beaming-pattern.hh" #include "beam.hh" -#include "stem.hh" -#include "debug.hh" -#include "engraver-group-engraver.hh" -#include "bar.hh" -#include "rest.hh" +#include "context.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" -/* - TODO: figure what to do in grace? +#include "translator.icc" - TODO: documentme. - */ class Auto_beam_engraver : public Engraver { -public: - Auto_beam_engraver (); - VIRTUAL_COPY_CONS (Translator); + TRANSLATOR_DECLARATIONS (Auto_beam_engraver); protected: - virtual void stop_translation_timestep (); - virtual void start_translation_timestep (); - virtual void do_removal_processing (); - virtual void acknowledge_grob (Grob_info); - virtual void create_grobs (); + void stop_translation_timestep (); + void start_translation_timestep (); + void process_music (); + virtual void finalize (); + virtual void derived_mark () const; + + DECLARE_ACKNOWLEDGER (rest); + DECLARE_ACKNOWLEDGER (beam); + DECLARE_ACKNOWLEDGER (bar_line); + DECLARE_ACKNOWLEDGER (stem); + DECLARE_TRANSLATOR_LISTENER (beam_forbid); + + void process_acknowledged (); private: + bool test_moment (Direction, Moment); + void consider_begin (Moment); + void consider_end (Moment); + Spanner *create_beam (); void begin_beam (); - void consider_end_and_begin (Moment test_mom); - Spanner* create_beam_p (); void end_beam (); void junk_beam (); - bool same_grace_state_b (Grob* e); + bool is_same_grace_state (Grob *e); void typeset_beam (); + Stream_event *forbid_; /* shortest_mom is the shortest note in the beam. - */ + */ Moment shortest_mom_; - Spanner *finished_beam_p_; - Link_array* stem_l_arr_p_; + Spanner *finished_beam_; + vector *stems_; - - bool first_b_; + int process_acknowledged_count_; Moment last_add_mom_; - /* Projected ending of the beam we're working on. - */ + */ Moment extend_mom_; Moment beam_start_moment_; Moment beam_start_location_; - + + bool subdivide_beams_; + Moment beat_length_; + // We act as if beam were created, and start a grouping anyway. - Beaming_info_list*grouping_p_; - Beaming_info_list*finished_grouping_p_; -}; + Beaming_pattern *grouping_; + SCM beam_settings_; -ADD_THIS_TRANSLATOR (Auto_beam_engraver); + Beaming_pattern *finished_grouping_; -Auto_beam_engraver::Auto_beam_engraver () + void check_bar_property (); +}; + +void +Auto_beam_engraver::derived_mark () const { - first_b_ = true; - stem_l_arr_p_ = 0; - shortest_mom_ = Moment (1, 8); - finished_beam_p_ = 0; - finished_grouping_p_ = 0; - grouping_p_ = 0; + scm_gc_mark (beam_settings_); } -/* - rename me: consider_end_or_begin () ? - */ void -Auto_beam_engraver::consider_end_and_begin (Moment test_mom) +Auto_beam_engraver::check_bar_property () { - SCM wild = gh_list (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED); - SCM b = gh_list (ly_symbol2scm ("begin"), SCM_UNDEFINED); - SCM e = gh_list (ly_symbol2scm ("end"), SCM_UNDEFINED); + /* Duplicated from process_music (), since + Repeat_acknowledge_engraver::process_music () may also set whichBar. */ - Moment one_beat = *unsmob_moment( get_property ("beatLength")); - int num = *unsmob_moment (get_property("measureLength")) / one_beat; - int den = one_beat.den_i (); - SCM time = gh_list (gh_int2scm (num), gh_int2scm (den), SCM_UNDEFINED); - - SCM type = gh_list (gh_int2scm (test_mom.num_i ()), - gh_int2scm (test_mom.den_i ()), SCM_UNDEFINED); - - SCM settings = get_property ("autoBeamSettings"); - - /* - Determine end moment for auto beaming (and begin, mostly 0==anywhere) - In order of increasing priority: - - i. every beat - ii. end * - iii. end - - iv. end * * * - v. end * * - - - Rationale: - - [to be defined in config file] - i. easy catch-all rule - ii. exceptions for time signature - iii. exceptions for time signature, for specific duration type + Moment now = now_mom (); + if (scm_is_string (get_property ("whichBar")) + && beam_start_moment_ < now) + { + consider_end (shortest_mom_); + junk_beam (); + } +} - [user override] - iv. generic override - v. override for specific duration type +void +Auto_beam_engraver::process_music () +{ + if (scm_is_string (get_property ("whichBar"))) + { + consider_end (shortest_mom_); + junk_beam (); + } - */ - + if (forbid_) + { + consider_end (shortest_mom_); + junk_beam (); + } +} - /* - first guess: begin beam at any position - */ - Moment begin_mom (0); - /* - first guess: end beam at end of beat - */ - SCM one (get_property ("beatLength")); +Auto_beam_engraver::Auto_beam_engraver () +{ + forbid_ = 0; + process_acknowledged_count_ = 0; + stems_ = 0; + shortest_mom_ = Moment (Rational (1, 8)); + finished_beam_ = 0; + finished_grouping_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; +} - Moment end_mom; - if (unsmob_moment (one)) - end_mom = *unsmob_moment (one); +IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid); +void +Auto_beam_engraver::listen_beam_forbid (Stream_event *ev) +{ + ASSIGN_EVENT_ONCE (forbid_, ev); +} - /* - second guess: property generic time exception - */ - SCM begin = gh_assoc (gh_append3 (b, wild, time), settings); - - if (begin != SCM_BOOL_F && unsmob_moment (gh_cdr (begin))) - begin_mom = * unsmob_moment (gh_cdr (begin)); +bool +Auto_beam_engraver::test_moment (Direction dir, Moment test) +{ + return scm_call_3 (get_property ("autoBeamCheck"), + context ()->self_scm (), + scm_from_int (dir), + test.smobbed_copy ()) + != SCM_BOOL_F; +} - SCM end = gh_assoc (gh_append3 (e, wild, time), settings); - if (end != SCM_BOOL_F && unsmob_moment (gh_cdr (end))) - end_mom = * unsmob_moment (gh_cdr (end)); +void +Auto_beam_engraver::consider_begin (Moment test_mom) +{ + bool on = to_boolean (get_property ("autoBeaming")); + if (!stems_ && on + && !forbid_) + { + bool b = test_moment (START, test_mom); + if (b) + begin_beam (); + } +} - /* - third guess: property time exception, specific for duration type - */ - SCM begin_mult = gh_assoc (gh_append3 (b, type, time), settings); - if (begin_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (begin_mult))) - begin_mom = * unsmob_moment (gh_cdr (begin_mult)); - - SCM end_mult = gh_assoc (gh_append3 (e, type, time), settings); - if (end_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (end_mult))) - end_mom = * unsmob_moment (gh_cdr (end_mult)); +void +Auto_beam_engraver::consider_end (Moment test_mom) +{ + if (stems_) + { + /* Allow already started autobeam to end: + don't check for autoBeaming */ + bool b = test_moment (STOP, test_mom); + if (b) + end_beam (); + } +} - /* - fourth guess [user override]: property plain generic - */ - begin = gh_assoc (gh_append3 (b, wild, wild), settings); - if (begin != SCM_BOOL_F && unsmob_moment (gh_cdr (begin))) - begin_mom = * unsmob_moment (gh_cdr (begin)); +Spanner * +Auto_beam_engraver::create_beam () +{ + if (to_boolean (get_property ("skipTypesetting"))) + return 0; - end = gh_assoc (gh_append3 (e, wild, wild), settings); - if (end != SCM_BOOL_F && unsmob_moment (gh_cdr (end))) - end_mom = * unsmob_moment (gh_cdr (end)); + for (vsize i = 0; i < stems_->size (); i++) + if (Stem::get_beam ((*stems_)[i])) + return 0; /* - fifth guess [user override]: property plain, specific for duration type + Can't use make_spanner_from_properties() because we have to use + beam_settings_. */ - begin_mult = gh_assoc (gh_append3 (b, type, wild), settings); - if (begin_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (begin_mult))) - begin_mom = * unsmob_moment (gh_cdr (begin_mult)); - - end_mult = gh_assoc (gh_append3 (e, type, wild), settings); - if (end_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (end_mult))) - end_mom = * unsmob_moment (gh_cdr (end_mult)); - - Rational r; - if (end_mom) - r = unsmob_moment (get_property ("measurePosition"))->mod_rat (end_mom); - else - r = Moment (1); + Spanner *beam = new Spanner (beam_settings_, + context ()->get_grob_key ("Beam")); - if (stem_l_arr_p_ && stem_l_arr_p_->size () > 1 && !r) - end_beam (); + for (vsize i = 0; i < stems_->size (); i++) + Beam::add_stem (beam, (*stems_)[i]); - /* - Allow already started autobeam to end - */ - SCM on = get_property ("noAutoBeaming"); - if (to_boolean (on)) - return; + announce_grob (beam, (*stems_)[0]->self_scm ()); - if (begin_mom) - r = unsmob_moment (get_property ("measurePosition"))->mod_rat (begin_mom); - if (!stem_l_arr_p_ && (!begin_mom || !r)) - begin_beam (); + return beam; } - -Spanner* -Auto_beam_engraver::create_beam_p () -{ - Spanner* beam_p = new Spanner (get_property ("Beam")); - Beam::set_interface (beam_p); - for (int i = 0; i < stem_l_arr_p_->size (); i++) +void +Auto_beam_engraver::begin_beam () +{ + if (stems_ || grouping_) { - /* - watch out for stem tremolos and abbreviation beams - */ - if (Stem::beam_l ((*stem_l_arr_p_)[i])) - { - scm_unprotect_object (beam_p->self_scm ()); - return 0; - } - Beam::add_stem (beam_p,(*stem_l_arr_p_)[i]); + programming_error ("already have autobeam"); + return; } - - announce_grob (beam_p, 0); - return beam_p; -} + stems_ = new vector; + grouping_ = new Beaming_pattern (); + beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam")); -void -Auto_beam_engraver::begin_beam () -{ - assert (!stem_l_arr_p_); - stem_l_arr_p_ = new Link_array; - assert (!grouping_p_); - grouping_p_ = new Beaming_info_list; beam_start_moment_ = now_mom (); - beam_start_location_ = *unsmob_moment (get_property ("measurePosition")); + beam_start_location_ + = robust_scm2moment (get_property ("measurePosition"), Moment (0)); } - void -Auto_beam_engraver::junk_beam () +Auto_beam_engraver::junk_beam () { - assert (stem_l_arr_p_); - - delete stem_l_arr_p_; - stem_l_arr_p_ = 0; - delete grouping_p_; - grouping_p_ = 0; - shortest_mom_ = Moment (1, 8); + if (!stems_) + return; + + delete stems_; + stems_ = 0; + delete grouping_; + grouping_ = 0; + beam_settings_ = SCM_EOL; + + shortest_mom_ = Moment (Rational (1, 8)); } void Auto_beam_engraver::end_beam () { - if (stem_l_arr_p_->size () < 2) - { - junk_beam (); - } + if (stems_->size () < 2) + junk_beam (); else { - finished_beam_p_ = create_beam_p (); - if (finished_beam_p_) - finished_grouping_p_ = grouping_p_; - delete stem_l_arr_p_; - stem_l_arr_p_ = 0; - grouping_p_ = 0; - shortest_mom_ = Moment (1, 8); + finished_beam_ = create_beam (); + if (finished_beam_) + finished_grouping_ = grouping_; + delete stems_; + stems_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; } + + shortest_mom_ = Moment (Rational (1, 8)); } void Auto_beam_engraver::typeset_beam () { - if (finished_beam_p_) + if (finished_beam_) { - finished_grouping_p_->beamify (); - Beam::set_beaming (finished_beam_p_, finished_grouping_p_); - typeset_grob (finished_beam_p_); - finished_beam_p_ = 0; - - delete finished_grouping_p_; - finished_grouping_p_= 0; + if (!finished_beam_->get_bound (RIGHT)) + finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT)); + + finished_grouping_->beamify (context ()); + Beam::set_beaming (finished_beam_, finished_grouping_); + finished_beam_ = 0; + + delete finished_grouping_; + finished_grouping_ = 0; } } void Auto_beam_engraver::start_translation_timestep () { - first_b_ =true; + process_acknowledged_count_ = 0; /* don't beam over skips - */ - if (stem_l_arr_p_) + */ + if (stems_) { Moment now = now_mom (); if (extend_mom_ < now) - { - end_beam (); - } + end_beam (); } + forbid_ = 0; } void Auto_beam_engraver::stop_translation_timestep () { - typeset_beam (); } void -Auto_beam_engraver::do_removal_processing () +Auto_beam_engraver::finalize () { /* finished beams may be typeset */ typeset_beam (); /* but unfinished may need another announce/acknowledge pass */ - if (stem_l_arr_p_) + if (stems_) junk_beam (); } -bool -Auto_beam_engraver::same_grace_state_b (Grob* e) + +void +Auto_beam_engraver::acknowledge_beam (Grob_info info) { - bool gr = e->get_grob_property ("grace") == SCM_BOOL_T; - SCM wg =get_property ("weAreGraceContext"); - return (to_boolean (wg)) == gr; + (void)info; + check_bar_property (); + if (stems_) + end_beam (); } void -Auto_beam_engraver::acknowledge_grob (Grob_info info) +Auto_beam_engraver::acknowledge_bar_line (Grob_info info) { - if (!same_grace_state_b (info.elem_l_)) - return; - - if (stem_l_arr_p_) + (void)info; + check_bar_property (); + if (stems_) + end_beam (); +} + +void +Auto_beam_engraver::acknowledge_rest (Grob_info info) +{ + (void)info; + check_bar_property (); + if (stems_) + end_beam (); +} + +void +Auto_beam_engraver::acknowledge_stem (Grob_info info) +{ + check_bar_property (); + Item *stem = dynamic_cast (info.grob ()); + Stream_event *ev = info.ultimate_event_cause (); + if (!ev->in_event_class ("rhythmic-event")) { - if (Beam::has_interface (info.elem_l_)) - { - end_beam (); - } - else if (Bar::has_interface (info.elem_l_)) - { - end_beam (); - } - else if (Rest::has_interface (info.elem_l_)) - { - end_beam (); - } + programming_error ("stem must have rhythmic structure"); + return; } - - if (Stem::has_interface (info.elem_l_)) + + /* + Don't (start) auto-beam over empty stems; skips or rests + */ + if (!Stem::head_count (stem)) { - Item* stem_l = dynamic_cast (info.elem_l_); - - Rhythmic_req *rhythmic_req = dynamic_cast (info.req_l_); - if (!rhythmic_req) - { - programming_error ("Stem must have rhythmic structure"); - return; - } - - /* - Don't (start) auto-beam over empty stems; skips or rests - */ - if (!Stem::heads_i (stem_l)) - { - if (stem_l_arr_p_) - end_beam (); - return; - } + if (stems_) + end_beam (); + return; + } - if (Stem::beam_l (stem_l)) - { - if (stem_l_arr_p_) - junk_beam (); - return ; - } - - int durlog = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log (); - - if (durlog <= 2) - { - if (stem_l_arr_p_) - end_beam (); - return; - } + if (Stem::get_beam (stem)) + { + if (stems_) + junk_beam (); + return; + } - /* - if shortest duration would change - reconsider ending/starting beam first. - */ - Moment dur = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom (); - consider_end_and_begin (dur); - if (!stem_l_arr_p_) - return; - - if (dur < shortest_mom_) - { - shortest_mom_ = dur; - if (stem_l_arr_p_->size ()) - { - shortest_mom_ = dur; - consider_end_and_begin (shortest_mom_); - if (!stem_l_arr_p_) - return; - } - } - - Moment now = now_mom (); - - grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_, - durlog - 2); - stem_l_arr_p_->push (stem_l); - last_add_mom_ = now; - extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom (); + int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log (); + + if (durlog <= 2) + { + if (stems_) + end_beam (); + return; } + + /* + ignore grace notes. + */ + Moment now = now_mom (); + if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_)) + return; + + Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length (); + + consider_end (dur); + consider_begin (dur); + + if (dur < shortest_mom_) + shortest_mom_ = dur; + + if (!stems_) + return; + + grouping_->add_stem (now - beam_start_moment_ + beam_start_location_, + durlog - 2); + stems_->push_back (stem); + last_add_mom_ = now; + extend_mom_ = max (extend_mom_, now) + get_event_length (ev); } void -Auto_beam_engraver::create_grobs () +Auto_beam_engraver::process_acknowledged () { - if (first_b_) + if (extend_mom_ > now_mom ()) + return; + + if (!process_acknowledged_count_) { - first_b_ = false; - consider_end_and_begin (shortest_mom_); + consider_end (shortest_mom_); + consider_begin (shortest_mom_); } - else + else if (process_acknowledged_count_ > 1) { - if (stem_l_arr_p_) + if (stems_) { Moment now = now_mom (); if ((extend_mom_ < now) - || ((extend_mom_ == now) && (last_add_mom_ != now ))) - { - end_beam (); - } - else if (!stem_l_arr_p_->size ()) - { - junk_beam (); - } - } - } + || ((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_TRANSLATOR (Auto_beam_engraver, + /* doc */ "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}. ", + /* create */ "Beam", + /* accept */ "beam-forbid-event", + /* read */ "autoBeaming autoBeamSettings beatLength subdivideBeams", + /* write */ "");