X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=fda74a0cf00e8c05c92458a042aa78ae6bcb11c6;hb=664070d837cc4855091455892cb942cdcedeef0c;hp=65ce4f1b5dc74d2f6643fe72c6fb26f9d3e1c7b1;hpb=bd7b422b1796049dee832848f00f9180bcc4bdf6;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index 65ce4f1b5d..fda74a0cf0 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -3,283 +3,366 @@ source file of the GNU LilyPond music typesetter - (c) 1999--2000 Jan Nieuwenhuizen + (c) 1999--2004 Jan Nieuwenhuizen */ #include "beaming.hh" -#include "musical-request.hh" +#include "event.hh" #include "beam.hh" #include "stem.hh" -#include "debug.hh" +#include "warn.hh" #include "engraver-group-engraver.hh" -#include "bar.hh" +#include "bar-line.hh" #include "rest.hh" #include "engraver.hh" #include "item.hh" #include "spanner.hh" +#include "duration.hh" +#include "context.hh" -/* - TODO: figure what to do in grace? - */ class Auto_beam_engraver : public Engraver { -public: - Auto_beam_engraver (); - VIRTUAL_COPY_CONS (Translator); - + TRANSLATOR_DECLARATIONS (Auto_beam_engraver); protected: - virtual void do_pre_move_processing (); - virtual void do_post_move_processing (); - virtual void do_removal_processing (); - virtual void acknowledge_element (Score_element_info); - virtual void process_acknowledged (); + virtual void stop_translation_timestep (); + virtual void start_translation_timestep (); + virtual void process_music (); + virtual bool try_music (Music*); + virtual void finalize (); + virtual void acknowledge_grob (Grob_info); + virtual void process_acknowledged_grobs (); 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 (Score_element* e); + bool is_same_grace_state (Grob* e); void typeset_beam (); + Music *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_; + Link_array* stems_; + + + int 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_info_list*grouping_; + SCM beam_settings_ ; // ugh. should protect ? + + Beaming_info_list*finished_grouping_; }; -ADD_THIS_TRANSLATOR (Auto_beam_engraver); - -Auto_beam_engraver::Auto_beam_engraver () -{ - stem_l_arr_p_ = 0; - shortest_mom_ = Moment (1, 8); - finished_beam_p_ = 0; - finished_grouping_p_ = 0; - grouping_p_ = 0; -} - void -Auto_beam_engraver::consider_end_and_begin (Moment test_mom) +Auto_beam_engraver::process_music () { - 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); - - 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: + if (ly_c_string_p (get_property ("whichBar"))) + { + consider_end (shortest_mom_); + junk_beam (); + } - i. every beat - ii. end * - iii. end + if (forbid_) + { + consider_end (shortest_mom_); + junk_beam (); + } +} - iv. end * * * - v. end * * +Auto_beam_engraver::Auto_beam_engraver () +{ + forbid_ = 0; + count_ = 0; + stems_ = 0; + shortest_mom_ = Moment (Rational (1, 8)); + finished_beam_ = 0; + finished_grouping_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; +} - 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 +bool +Auto_beam_engraver::try_music (Music*m) +{ + if (m->is_mus_type ("beam-forbid-event")) + { + forbid_ = m; + return true; + } - [user override] - iv. generic override - v. override for specific duration type + return false; +} - */ +/* + Determine end moment for auto beaming (or begin moment, but mostly + 0==anywhere) In order of increasing priority: - - /* - first guess: begin beam at any position - */ - Moment begin_mom (0); - /* - first guess: end beam at end of beat - */ - SCM one (get_property ("beatLength")); - - Moment end_mom; - if (unsmob_moment (one)) - end_mom = *unsmob_moment (one); - - /* - second guess: property generic time exception - */ - SCM begin = gh_assoc (gh_append3 (b, wild, time), settings); + i. begin anywhere, end at every beat + ii. end * + iii. end + + iv. end * * * + v. end * * - if (begin != SCM_BOOL_F && unsmob_moment (gh_cdr (begin))) - begin_mom = * unsmob_moment (gh_cdr (begin)); - - 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)); - - /* - 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)); + 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 + + [user override] + iv. generic override + v. override for specific duration type + +*/ +bool +Auto_beam_engraver::test_moment (Direction dir, Moment test_mom) +{ + Moment now = now_mom (); + if (dir == START + && now.grace_part_) + { + return false; + } + + SCM wild = scm_list_n (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED); + SCM function; + if (dir == START) + function = scm_list_n (ly_symbol2scm ("begin"), SCM_UNDEFINED); + else + function = scm_list_n (ly_symbol2scm ("end"), SCM_UNDEFINED); - /* - 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)); + Moment one_beat = *unsmob_moment (get_property ("beatLength")); + int num = int ((*unsmob_moment (get_property ("measureLength")) / one_beat).main_part_); + int den = one_beat.den (); + SCM time = scm_list_n (scm_int2num (num), scm_int2num (den), SCM_UNDEFINED); - 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)); + SCM type = scm_list_n (scm_int2num (test_mom.num ()), + scm_int2num (test_mom.den ()), SCM_UNDEFINED); /* - fifth guess [user override]: property plain, specific for duration type - */ - 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)); + UGH UGH. + settings aren't grob-properties. + */ + SCM settings = get_property ("autoBeamSettings"); + + /* first guess */ - 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)); + /* begin beam at any position + (and fallback for end) */ + Moment moment (0); + + /* end beam at end of beat */ + if (dir == STOP) + { + SCM beat (get_property ("beatLength")); + + if (unsmob_moment (beat)) + moment = *unsmob_moment (beat); + } + /* second guess: property generic time exception */ + SCM m = scm_assoc (ly_append3 (function, wild, time), settings); + + if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m))) + moment = * unsmob_moment (ly_cdr (m)); + + /* third guess: property time exception, specific for duration type */ + m = scm_assoc (ly_append3 (function, type, time), settings); + if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m))) + moment = * unsmob_moment (ly_cdr (m)); + + /* fourth guess [user override]: property plain generic */ + m = scm_assoc (ly_append3 (function, wild, wild), settings); + if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m))) + moment = * unsmob_moment (ly_cdr (m)); + + /* fifth guess [user override]: property plain, specific for duration type */ + m = scm_assoc (ly_append3 (function, type, wild), settings); + if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m))) + moment = * unsmob_moment (ly_cdr (m)); + Rational r; - if (end_mom) - r = unsmob_moment (get_property ("measurePosition"))->mod_rat (end_mom); + if (moment.to_bool ()) + { + /* Ugh? measurePosition can be negative, when \partial + We may have to fix this elsewhere (timing translator) + r = unsmob_moment (get_property ("measurePosition"))->mod_rat (moment); + */ + Moment pos = * unsmob_moment (get_property ("measurePosition")); + if (pos < Moment (0)) + { + Moment length = * unsmob_moment (get_property ("measureLength")); + pos = length - pos; + } + r = pos.main_part_.mod_rat (moment.main_part_); + } else - r = Moment (1); + { + if (dir == START) + /* if undefined, starting is ok */ + r = 0; + else + /* but ending is not */ + r = 1; + } - if (stem_l_arr_p_ && stem_l_arr_p_->size () > 1 && !r) - end_beam (); + return !r; +} - /* - Allow already started autobeam to end - */ - SCM on = get_property ("noAutoBeaming"); - if (to_boolean (on)) - return; - - if (begin_mom) - r = unsmob_moment (get_property ("measurePosition"))->mod_rat (begin_mom); - if (!stem_l_arr_p_ && (!begin_mom || !r)) - begin_beam (); +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 (); + } } - -Spanner* -Auto_beam_engraver::create_beam_p () + +void +Auto_beam_engraver::consider_end (Moment test_mom) { - Spanner* beam_p = new Spanner (get_property ("Beam")); - Beam::set_interface (beam_p); + if (stems_) + { + /* Allow already started autobeam to end: + don't check for autoBeaming */ + bool b = test_moment (STOP, test_mom); + if (b) + end_beam (); + } +} - for (int i = 0; i < stem_l_arr_p_->size (); i++) +Spanner* +Auto_beam_engraver::create_beam () +{ + if (to_boolean (get_property ("skipTypesetting"))) + { + return 0; + } + + Spanner* beam = new Spanner (beam_settings_); + for (int i = 0; i < stems_->size (); i++) { /* watch out for stem tremolos and abbreviation beams */ - if (Stem::beam_l ((*stem_l_arr_p_)[i])) + if (Stem::get_beam ((*stems_)[i])) { + scm_gc_unprotect_object (beam->self_scm ()); return 0; } - Beam::add_stem (beam_p,(*stem_l_arr_p_)[i]); + Beam::add_stem (beam, (*stems_)[i]); } - announce_element (beam_p, 0); + announce_grob (beam, (*stems_)[0]->self_scm ()); - return beam_p; + return 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; + if (stems_ || grouping_ ) + { + programming_error ("already have autobeam"); + return; + } + + stems_ = new Link_array; + grouping_ = new Beaming_info_list; + beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam")); + beam_start_moment_ = now_mom (); beam_start_location_ = *unsmob_moment (get_property ("measurePosition")); + subdivide_beams_ = ly_scm2bool (get_property ("subdivideBeams")); + beat_length_ = *unsmob_moment (get_property ("beatLength")); } - void Auto_beam_engraver::junk_beam () { - assert (stem_l_arr_p_); + if (!stems_) + return ; - delete stem_l_arr_p_; - stem_l_arr_p_ = 0; - delete grouping_p_; - grouping_p_ = 0; - shortest_mom_ = Moment (1, 8); + 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) + 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_element (finished_beam_p_); - finished_beam_p_ = 0; + finished_grouping_->beamify (beat_length_, subdivide_beams_); + Beam::set_beaming (finished_beam_, finished_grouping_); + finished_beam_ = 0; - delete finished_grouping_p_; - finished_grouping_p_= 0; + delete finished_grouping_; + finished_grouping_= 0; } } void -Auto_beam_engraver::do_post_move_processing () +Auto_beam_engraver::start_translation_timestep () { + count_ = 0; /* don't beam over skips */ - if (stem_l_arr_p_) + if (stems_) { Moment now = now_mom (); if (extend_mom_ < now) @@ -287,73 +370,50 @@ Auto_beam_engraver::do_post_move_processing () end_beam (); } } + forbid_ = 0; } void -Auto_beam_engraver::do_pre_move_processing () +Auto_beam_engraver::stop_translation_timestep () { - if (stem_l_arr_p_) - { - 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 (); - } - } 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 (Score_element* e) -{ - bool gr = e->get_elt_property ("grace") == SCM_BOOL_T; - SCM wg =get_property ("weAreGraceContext"); - return (to_boolean (wg)) == gr; -} void -Auto_beam_engraver::acknowledge_element (Score_element_info info) +Auto_beam_engraver::acknowledge_grob (Grob_info info) { - if (!same_grace_state_b (info.elem_l_)) - return; - - if (stem_l_arr_p_) + if (stems_) { - if (Beam::has_interface (info.elem_l_)) + if (Beam::has_interface (info.grob_)) { end_beam (); } - else if (Bar::has_interface (info.elem_l_)) + else if (Bar_line::has_interface (info.grob_)) { end_beam (); } - else if (Rest::has_interface (info.elem_l_)) + else if (Rest::has_interface (info.grob_)) { end_beam (); } } - if (Stem::has_interface (info.elem_l_)) + if (Stem::has_interface (info.grob_)) { - Item* stem_l = dynamic_cast (info.elem_l_); - - Rhythmic_req *rhythmic_req = dynamic_cast (info.req_l_); - if (!rhythmic_req) + Item* stem = dynamic_cast (info.grob_); + Music* m = info.music_cause (); + if (!m->is_mus_type ("rhythmic-event")) { programming_error ("Stem must have rhythmic structure"); return; @@ -362,61 +422,114 @@ Auto_beam_engraver::acknowledge_element (Score_element_info info) /* Don't (start) auto-beam over empty stems; skips or rests */ - if (!Stem::heads_i (stem_l)) + if (!Stem::head_count (stem)) { - if (stem_l_arr_p_) + if (stems_) end_beam (); return; } - if (Stem::beam_l (stem_l)) + if (Stem::get_beam (stem)) { - if (stem_l_arr_p_) + if (stems_) junk_beam (); return ; } - int durlog = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log (); + int durlog = unsmob_duration (m->get_property ("duration"))->duration_log (); if (durlog <= 2) { - if (stem_l_arr_p_) + if (stems_) end_beam (); return; } + /* - if shortest duration would change - reconsider ending/starting beam first. - */ - Moment mom = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom (); - consider_end_and_begin (mom); - if (!stem_l_arr_p_) - return; - if (mom < shortest_mom_) + ignore grace notes. + */ + if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_)) + return ; + + + Moment dur = unsmob_duration (m->get_property ("duration"))->get_length (); + /* FIXME: + + This comment has been here since long: + + if shortest duration would change + consider ending and beginning beam first. + + but the code didn't match: */ +#if 1 + consider_end (dur); + consider_begin (dur); + + if (dur < shortest_mom_) + shortest_mom_ = dur; +#else + /* I very much suspect that we wanted: */ + + consider_end (shortest_mom_); + if (dur < shortest_mom_) { - if (stem_l_arr_p_->size ()) - { - shortest_mom_ = mom; - consider_end_and_begin (shortest_mom_); - if (!stem_l_arr_p_) - return; - } - shortest_mom_ = mom; + shortest_mom_ = dur; + consider_end (shortest_mom_); } + consider_begin (shortest_mom_); +#endif + + if (!stems_) + return; + Moment now = now_mom (); - grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_, + grouping_->add_stem (now - beam_start_moment_ + beam_start_location_, durlog - 2); - stem_l_arr_p_->push (stem_l); + stems_->push (stem); last_add_mom_ = now; - extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom (); + extend_mom_ = (extend_mom_ >? now) + m->get_length (); } } void -Auto_beam_engraver::process_acknowledged () +Auto_beam_engraver::process_acknowledged_grobs () { - if (!stem_l_arr_p_) - consider_end_and_begin (shortest_mom_); + if (!count_) + { + consider_end (shortest_mom_); + consider_begin (shortest_mom_); + } + else if (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 (); + } + } + } + + count_ ++; } + +ENTER_DESCRIPTION (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", +/* acks */ "stem-interface rest-interface beam-interface bar-line-interface", +/* reads */ "autoBeaming autoBeamSettings beatLength subdivideBeams", +/* write */ "");