X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=2044f8850010e4d96b6f35f1de0178183ddf86b0;hb=dfe0c6ad15227d6d3646bd7445df5de6aa386ff7;hp=5fb3ade2846d244ed471528060a7cf15046442a8;hpb=a4d7106c75b325441063fd9ba9c4131979784aa5;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index 5fb3ade284..2044f88500 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 1999--2000 Jan Nieuwenhuizen + (c) 1999--2001 Jan Nieuwenhuizen */ @@ -21,35 +21,43 @@ /* TODO: figure what to do in grace? + + TODO: documentme. */ class Auto_beam_engraver : public Engraver { -public: - Auto_beam_engraver (); - VIRTUAL_COPY_CONS (Translator); - + TRANSLATOR_DECLARATIONS(Auto_beam_engraver); protected: - virtual bool do_try_music (Music*); - virtual void do_pre_move_processing (); - virtual void do_post_move_processing (); - virtual void do_removal_processing (); - virtual void acknowledge_element (Score_element_info); - void deprecated_process_music (); - virtual void process_acknowledged (); + virtual void stop_translation_timestep (); + virtual void start_translation_timestep (); + virtual void finalize (); + virtual void acknowledge_grob (Grob_info); + virtual void create_grobs (); + private: - void begin_beam (); - void consider_end_and_begin (Moment test_mom); + bool test_moment (Direction, Moment); + void consider_begin (Moment); + void consider_end (Moment); Spanner* create_beam_p (); + void begin_beam (); void end_beam (); void junk_beam (); - bool same_grace_state_b (Score_element* e); + bool same_grace_state_b (Grob* e); void typeset_beam (); + /* + shortest_mom is the shortest note in the beam. + */ Moment shortest_mom_; Spanner *finished_beam_p_; Link_array* stem_l_arr_p_; - + + + int count_i_; Moment last_add_mom_; + /* + Projected ending of the beam we're working on. + */ Moment extend_mom_; Moment beam_start_moment_; Moment beam_start_location_; @@ -59,170 +67,159 @@ private: Beaming_info_list*finished_grouping_p_; }; -ADD_THIS_TRANSLATOR (Auto_beam_engraver); + Auto_beam_engraver::Auto_beam_engraver () { + count_i_ = 0; stem_l_arr_p_ = 0; - shortest_mom_ = Moment (1, 8); + shortest_mom_ = Moment (Rational (1, 8)); finished_beam_p_ = 0; finished_grouping_p_ = 0; grouping_p_ = 0; } +/* + Determine end moment for auto beaming (or begin moment, but mostly + 0==anywhere) In order of increasing priority: + + i. begin anywhere, end at 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 + + [user override] + iv. generic override + v. override for specific duration type + +*/ bool -Auto_beam_engraver::do_try_music (Music*) -{ - return false; -} - -void -Auto_beam_engraver::deprecated_process_music () -{ - consider_end_and_begin (shortest_mom_); -} - -void -Auto_beam_engraver::consider_end_and_begin (Moment test_mom) +Auto_beam_engraver::test_moment (Direction dir, Moment test_mom) { - 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); + 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); - 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); + 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 (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 type = scm_list_n (gh_int2scm (test_mom.num ()), + gh_int2scm (test_mom.den ()), 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 - - [user override] - iv. generic override - v. override for specific duration type - - */ + /* first guess */ - - /* - 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); + /* begin beam at any position + (and fallback for end) */ + Moment moment (0); - 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)); + /* end beam at end of beat */ + if (dir == STOP) + { + SCM beat (get_property ("beatLength")); + + if (unsmob_moment (beat)) + moment = *unsmob_moment (beat); + } - /* - 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)); + /* second guess: property generic time exception */ + SCM m = gh_assoc (gh_append3 (function, wild, time), settings); - 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)); - - /* - 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)); - - 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)); - - /* - 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)); + 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 = gh_assoc (gh_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 = gh_assoc (gh_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 = gh_assoc (gh_append3 (function, type, wild), settings); + if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m))) + moment = * unsmob_moment (ly_cdr (m)); - 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); + 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; + } + return !r; +} - if (stem_l_arr_p_ && !r) - end_beam (); - - /* - 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 off = to_boolean (get_property ("noAutoBeaming")); + if (!stem_l_arr_p_ && ! off) + { + bool b = test_moment (START, test_mom); + if (b) + begin_beam (); + } } - void -Auto_beam_engraver::begin_beam () +Auto_beam_engraver::consider_end (Moment test_mom) { - 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")); + if (stem_l_arr_p_) + { + /* Allow already started autobeam to end: + don't check for noAutoBeaming */ + bool b = test_moment (STOP, test_mom); + if (b) + end_beam (); + } } Spanner* Auto_beam_engraver::create_beam_p () { + if (to_boolean (get_property ("skipTypesetting"))) + { + return 0; + } + Spanner* beam_p = new Spanner (get_property ("Beam")); - Beam::set_interface (beam_p); - for (int i = 0; i < stem_l_arr_p_->size (); i++) { /* @@ -230,16 +227,44 @@ Auto_beam_engraver::create_beam_p () */ if (Stem::beam_l ((*stem_l_arr_p_)[i])) { + scm_gc_unprotect_object (beam_p->self_scm ()); return 0; } - Beam::add_stem (beam_p,(*stem_l_arr_p_)[i]); + Beam::add_stem (beam_p, (*stem_l_arr_p_)[i]); } - announce_element (beam_p, 0); + announce_grob (beam_p, 0); return beam_p; } +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")); + + +} + + +void +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 (Rational (1, 8)); +} + void Auto_beam_engraver::end_beam () { @@ -248,6 +273,7 @@ Auto_beam_engraver::end_beam () junk_beam (); } else + { finished_beam_p_ = create_beam_p (); if (finished_beam_p_) @@ -255,8 +281,9 @@ Auto_beam_engraver::end_beam () delete stem_l_arr_p_; stem_l_arr_p_ = 0; grouping_p_ = 0; - shortest_mom_ = Moment (1, 8); } + + shortest_mom_ = Moment (Rational (1, 8)); } void @@ -264,9 +291,10 @@ Auto_beam_engraver::typeset_beam () { if (finished_beam_p_) { - finished_grouping_p_->beamify (); + finished_grouping_p_->beamify(*unsmob_moment (get_property ("beatLength")), + (bool)gh_scm2bool(get_property("subdivideBeams"))); Beam::set_beaming (finished_beam_p_, finished_grouping_p_); - typeset_element (finished_beam_p_); + typeset_grob (finished_beam_p_); finished_beam_p_ = 0; delete finished_grouping_p_; @@ -275,8 +303,9 @@ Auto_beam_engraver::typeset_beam () } void -Auto_beam_engraver::do_post_move_processing () +Auto_beam_engraver::start_translation_timestep () { + count_i_ = 0; /* don't beam over skips */ @@ -291,13 +320,13 @@ Auto_beam_engraver::do_post_move_processing () } void -Auto_beam_engraver::do_pre_move_processing () +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 (); @@ -306,39 +335,29 @@ Auto_beam_engraver::do_removal_processing () 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 (Beam::has_interface (info.elem_l_)) + if (Beam::has_interface (info.grob_l_)) { end_beam (); } - else if (Bar::has_interface (info.elem_l_)) + else if (Bar::has_interface (info.grob_l_)) { end_beam (); } - else if (Rest::has_interface (info.elem_l_)) + else if (Rest::has_interface (info.grob_l_)) { end_beam (); } } - if (Stem::has_interface (info.elem_l_)) + if (Stem::has_interface (info.grob_l_)) { - Item* stem_l = dynamic_cast (info.elem_l_); + Item* stem_l = dynamic_cast (info.grob_l_); Rhythmic_req *rhythmic_req = dynamic_cast (info.req_l_); if (!rhythmic_req) @@ -373,62 +392,93 @@ Auto_beam_engraver::acknowledge_element (Score_element_info info) 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 (rhythmic_req->get_mus_property ("duration"))->length_mom (); + /* 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 (!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 (); + extend_mom_ = (extend_mom_ >? now) + rhythmic_req->length_mom (); } } void -Auto_beam_engraver::junk_beam () +Auto_beam_engraver::create_grobs () { - 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); -} - -void -Auto_beam_engraver::process_acknowledged () -{ - deprecated_process_music (); - if (stem_l_arr_p_) + if (!count_i_) { - Moment now = now_mom (); - if ((extend_mom_ < now) - || ((extend_mom_ == now) && (last_add_mom_ != now ))) - { - end_beam (); - } - else if (!stem_l_arr_p_->size ()) + consider_end (shortest_mom_); + consider_begin (shortest_mom_); + } + else if (count_i_ > 1) + { + if (stem_l_arr_p_) { - junk_beam (); - } + 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 (); + } + } } + + /* + count_i_++ -> + + auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */ + count_i_ = count_i_ + 1; } +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 stemLeftBeamCount and +stemRightBeamCount. +", +/* creats*/ "Beam", +/* acks */ "stem-interface rest-interface beam-interface bar-line-interface", +/* reads */ "noAutoBeaming autoBeamSettings", +/* write */ "");