lily/auto-beam-engraver.cc

   1 /*
   2   auto-beam-engraver.cc --  implement Auto_beam_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8  */
   9 #include "new-beaming.hh"
  10 #include "auto-beam-engraver.hh"
  11 #include "musical-request.hh"
  12 #include "bar.hh"
  13 #include "beam.hh"
  14 #include "abbreviation-beam.hh"
  15 #include "rest.hh"
  16 #include "stem.hh"
  17 #include "debug.hh"
  18 #include "timing-engraver.hh"
  19 #include "engraver-group-engraver.hh"
  20
  21 ADD_THIS_TRANSLATOR (Auto_beam_engraver);
  22
  23 Auto_beam_engraver::Auto_beam_engraver ()
  24 {
  25   stem_l_arr_p_ = 0;
  26   shortest_mom_ = Moment (1, 8);
  27   finished_beam_p_ = 0;
  28   finished_grouping_p_ = 0;
  29   grouping_p_ = 0;
  30   timer_l_ =0;
  31 }
  32
  33 void
  34 Auto_beam_engraver::do_creation_processing ()
  35 {
  36   Translator * t = daddy_grav_l  ()->get_simple_translator ("Timing_engraver");
  37   timer_l_ = dynamic_cast<Timing_engraver*> (t);
  38 }
  39
  40 bool
  41 Auto_beam_engraver::do_try_music (Music*)
  42 {
  43   return false;
  44 }
  45
  46 void
  47 Auto_beam_engraver::do_process_requests ()
  48 {
  49   consider_end_and_begin (shortest_mom_);
  50 }
  51
  52 void
  53 Auto_beam_engraver::consider_end_and_begin (Moment test_mom)
  54 {
  55   if (!timer_l_)
  56       return;
  57
  58   Time_description const *time = &timer_l_->time_;
  59   int num = time->whole_per_measure_ / time->one_beat_;
  60   int den = time->one_beat_.den_i ();
  61   String time_str = String ("time") + to_str (num) + "_" + to_str (den);
  62
  63   String type_str;
  64   if (test_mom.num () != 1)
  65     type_str = to_str (test_mom.num ());
  66   if (test_mom.den () != 1)
  67     type_str = type_str + "_" + to_str (test_mom.den ());
  68
  69   /*
  70     Determine end moment for auto beaming (and begin, mostly 0==anywhere)
  71     In order of increasing priority:
  72
  73     i.   every beat <den>
  74     ii.  time<num>_<den>beamAutoEnd
  75     iii. time<num>_<den>beamAutoEnd<type>
  76     iv.  beamAutoEnd
  77     v.   beamAutoEnd<type>
  78
  79
  80     Rationale:
  81
  82     [to be defined in config file]
  83     i.   easy catch-all rule
  84     ii.  exceptions for time signature
  85     iii. exceptions for time signature, for specific duration type
  86
  87     [user override]
  88     iv.  generic override
  89     v.   override for specific duration type
  90
  91     The user overrides should be required for common cases.
  92    */
  93
  94   /*
  95     first guess: begin beam at any position
  96   */
  97   Moment begin_mom (0);
  98   /*
  99     first guess: end beam at end of beat
 100   */
 101   Moment end_mom = time->one_beat_;
 102
 103   /*
 104     second guess: property generic time exception
 105   */
 106   Scalar begin = get_property (time_str + "beamAutoBegin", 0);
 107   if (begin.length_i ())
 108     begin_mom = begin.to_rat ();
 109
 110   Scalar end = get_property (time_str + "beamAutoEnd", 0);
 111   if (end.length_i ())
 112     end_mom = end.to_rat ();
 113
 114   /*
 115     third guess: property time exception, specific for duration type
 116   */
 117   if (type_str.length_i ())
 118     {
 119       Scalar end_mult = get_property (time_str + "beamAutoEnd" + type_str, 0);
 120       if (end_mult.length_i ())
 121         end_mom = end_mult.to_rat ();
 122       Scalar begin_mult = get_property (time_str + "beamAutoBegin" + type_str, 0);
 123       if (begin_mult.length_i ())
 124         begin_mom = begin_mult.to_rat ();
 125     }
 126
 127   /*
 128     fourth guess [user override]: property plain generic
 129   */
 130   begin = get_property ("beamAutoBegin", 0);
 131   if (begin.length_i ())
 132     begin_mom = begin.to_rat ();
 133
 134   end = get_property ("beamAutoEnd", 0);
 135   if (end.length_i ())
 136     end_mom = end.to_rat ();
 137
 138   /*
 139     fifth guess [user override]: property plain, specific for duration type
 140   */
 141   if (type_str.length_i ())
 142     {
 143       Scalar end_mult = get_property (String ("beamAutoEnd") + type_str, 0);
 144       if (end_mult.length_i ())
 145         end_mom = end_mult.to_rat ();
 146       Scalar begin_mult = get_property (String ("beamAutoBegin") + type_str, 0);
 147       if (begin_mult.length_i ())
 148         begin_mom = begin_mult.to_rat ();
 149     }
 150
 151   Rational r;
 152   if (end_mom)
 153     r = time->whole_in_measure_.mod_rat (end_mom);
 154   else
 155     r = Moment (1);
 156
 157   if (stem_l_arr_p_ && !r)
 158     end_beam ();
 159
 160   /*
 161     Allow already started autobeam to end
 162    */
 163   Scalar on = get_property ("beamAuto", 0);
 164   if (!on.to_bool ())
 165     return;
 166
 167   if (begin_mom)
 168     r = time->whole_in_measure_.mod_rat (begin_mom);
 169   if (!stem_l_arr_p_ && (!begin_mom || !r))
 170     begin_beam ();
 171 }
 172
 173
 174 void
 175 Auto_beam_engraver::begin_beam ()
 176 {
 177   assert (!stem_l_arr_p_);
 178   stem_l_arr_p_ = new Array<Stem*>;
 179   assert (!grouping_p_);
 180   grouping_p_ = new Beaming_info_list;
 181   beam_start_moment_ = now_mom ();
 182   beam_start_location_ = timer_l_->time_.whole_in_measure_;
 183 }
 184
 185 Beam*
 186 Auto_beam_engraver::create_beam_p ()
 187 {
 188   Beam* beam_p = new Beam;
 189
 190   for (int i = 0; i < stem_l_arr_p_->size (); i++)
 191     {
 192       /*
 193         watch out for stem tremolos and abbreviation beams
 194        */
 195       if ((*stem_l_arr_p_)[i]->beam_l_)
 196         {
 197           delete beam_p;
 198           return 0;
 199         }
 200       beam_p->add_stem ((*stem_l_arr_p_)[i]);
 201     }
 202
 203   /* urg, copied from Beam_engraver */
 204   Scalar prop = get_property ("beamslopedamping", 0);
 205   if (prop.isnum_b ())
 206     beam_p->set_elt_property (damping_scm_sym, gh_int2scm( prop));
 207
 208   prop = get_property ("beamquantisation", 0);
 209   if (prop.isnum_b ())
 210     beam_p->quantisation_ = (Beam::Quantisation)(int)prop;
 211
 212   announce_element (Score_element_info (beam_p, 0));
 213   return beam_p;
 214 }
 215
 216 void
 217 Auto_beam_engraver::end_beam ()
 218 {
 219   if (stem_l_arr_p_->size () < 2)
 220     {
 221       junk_beam ();
 222     }
 223   else
 224     {
 225       finished_beam_p_ = create_beam_p ();
 226       if (finished_beam_p_)
 227         finished_grouping_p_ = grouping_p_;
 228       delete stem_l_arr_p_;
 229       stem_l_arr_p_ = 0;
 230       grouping_p_ = 0;
 231       shortest_mom_ = Moment (1, 8);
 232     }
 233 }
 234
 235 void
 236 Auto_beam_engraver::typeset_beam ()
 237 {
 238   if (finished_beam_p_)
 239     {
 240       finished_grouping_p_->beamify ();
 241       finished_beam_p_->set_beaming (finished_grouping_p_);
 242       typeset_element (finished_beam_p_);
 243       finished_beam_p_ = 0;
 244
 245       delete finished_grouping_p_;
 246       finished_grouping_p_= 0;
 247     }
 248 }
 249
 250 void
 251 Auto_beam_engraver::do_post_move_processing ()
 252 {
 253   /*
 254     don't beam over skips
 255    */
 256   if (stem_l_arr_p_)
 257     {
 258       Moment now = now_mom ();
 259       if (extend_mom_ < now)
 260         {
 261           end_beam ();
 262         }
 263     }
 264 }
 265
 266 void
 267 Auto_beam_engraver::do_pre_move_processing ()
 268 {
 269   typeset_beam ();
 270 }
 271
 272 void
 273 Auto_beam_engraver::do_removal_processing ()
 274 {
 275   /* finished beams may be typeset */
 276   typeset_beam ();
 277   /* but unfinished may need another announce/acknoledge pass */
 278   if (stem_l_arr_p_)
 279     junk_beam ();
 280 }
 281
 282 bool
 283 Auto_beam_engraver::same_grace_state_b (Score_element* e)
 284 {
 285   bool gr = (e->get_elt_property (grace_scm_sym) != SCM_BOOL_F) ;
 286
 287   return gr == get_property ("weAreGraceContext",0).to_bool ();
 288 }
 289
 290 void
 291 Auto_beam_engraver::acknowledge_element (Score_element_info info)
 292 {
 293   if (!same_grace_state_b (info.elem_l_) || !timer_l_)
 294     return;
 295
 296   if (stem_l_arr_p_)
 297     {
 298       if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
 299         {
 300           junk_beam ();
 301         }
 302       else if (Abbreviation_beam *b = dynamic_cast<Abbreviation_beam*> (info.elem_l_))
 303         {
 304           junk_beam ();
 305         }
 306       else if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
 307         {
 308           junk_beam ();
 309         }
 310       else if (Rest* rest_l = dynamic_cast<Rest *> (info.elem_l_))
 311         {
 312           end_beam ();
 313         }
 314     }
 315
 316   if (Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_))
 317     {
 318       Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
 319       if (!rhythmic_req)
 320         {
 321           programming_error ("Stem must have rhythmic structure");
 322           return;
 323         }
 324
 325       /*
 326         Don't (start) auto-beam over empty stems; skips or rests
 327         */
 328       if (!stem_l->head_l_arr_.size ())
 329         {
 330           if (stem_l_arr_p_)
 331             end_beam ();
 332           return;
 333         }
 334
 335       if (stem_l->beam_l_)
 336         {
 337           if (stem_l_arr_p_)
 338             junk_beam ();
 339           return ;
 340         }
 341
 342       int durlog  =rhythmic_req->duration_.durlog_i_;
 343       if (durlog <= 2)
 344         {
 345           if (stem_l_arr_p_)
 346             end_beam ();
 347           return;
 348         }
 349
 350       /*
 351         if shortest duration would change
 352         reconsider ending/starting beam first.
 353       */
 354       Moment mom = rhythmic_req->duration_.length_mom ();
 355       consider_end_and_begin (mom);
 356       if (!stem_l_arr_p_)
 357         return;
 358       if (mom < shortest_mom_)
 359         {
 360           if (stem_l_arr_p_->size ())
 361             {
 362               shortest_mom_ = mom;
 363               consider_end_and_begin (shortest_mom_);
 364               if (!stem_l_arr_p_)
 365                 return;
 366             }
 367           shortest_mom_ = mom;
 368         }
 369       Moment now = now_mom ();
 370
 371       grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_,
 372                              durlog - 2);
 373       stem_l_arr_p_->push (stem_l);
 374       last_add_mom_ = now;
 375       extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
 376     }
 377 }
 378
 379 void
 380 Auto_beam_engraver::junk_beam ()
 381 {
 382   assert (stem_l_arr_p_);
 383
 384   delete stem_l_arr_p_;
 385   stem_l_arr_p_ = 0;
 386   delete grouping_p_;
 387   grouping_p_ = 0;
 388   shortest_mom_ = Moment (1, 8);
 389 }
 390
 391 void
 392 Auto_beam_engraver::process_acknowledged ()
 393 {
 394   if (stem_l_arr_p_)
 395     {
 396       Moment now = now_mom ();
 397       if ((extend_mom_ < now)
 398           || ((extend_mom_ == now) && (last_add_mom_ != now )))
 399         {
 400           end_beam ();
 401         }
 402       else if (!stem_l_arr_p_->size ())
 403         {
 404           junk_beam ();
 405         }
 406     }
 407 }