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
  10 #include "auto-beam-engraver.hh"
  11 #include "musical-request.hh"
  12 #include "bar.hh"
  13 #include "beam.hh"
  14 #include "rhythmic-grouping.hh"
  15 #include "rest.hh"
  16 #include "stem.hh"
  17 #include "debug.hh"
  18 #include "time-description.hh"
  19
  20 ADD_THIS_TRANSLATOR (Auto_beam_engraver);
  21
  22 Auto_beam_engraver::Auto_beam_engraver ()
  23 {
  24   stem_l_arr_p_ = 0;
  25   shortest_mom_ = 1;
  26   finished_beam_p_ = 0;
  27   finished_grouping_p_ = 0;
  28   grouping_p_ = 0;
  29 }
  30
  31 void
  32 Auto_beam_engraver::do_process_requests ()
  33 {
  34   consider_end_and_begin ();
  35 }
  36
  37 void
  38 Auto_beam_engraver::consider_end_and_begin ()
  39 {
  40   Time_description const *time = get_staff_info().time_C_;
  41   int num = time->whole_per_measure_ / time->one_beat_;
  42   int den = time->one_beat_.den_i ();
  43   String time_str = String ("time") + to_str (num) + "_" + to_str (den);
  44   String type_str;
  45   if (shortest_mom_.num () != 1)
  46     type_str = to_str (shortest_mom_.num ());
  47   if (shortest_mom_.den () != 1)
  48     type_str = type_str + "_" + to_str (shortest_mom_.den ());
  49
  50   /*
  51     Determine end moment for auto beaming (and begin, mostly 0==anywhere)
  52     In order of increasing priority:
  53
  54     i.   every beat <den>
  55     ii.  time<num>_<den>beamAutoEnd
  56     iii. time<num>_<den>beamAutoEnd<type>
  57     iv.  beamAutoEnd
  58     v.   beamAutoEnd<type>
  59
  60
  61     Rationale:
  62
  63     [to be defined in config file]
  64     i.   easy catch-all rule
  65     ii.  exceptions for time signature
  66     iii. exceptions for time signature, for specific duration type
  67
  68     [user override]
  69     iv.  generic override
  70     v.   override for specific duration type
  71
  72     The user overrides should be required for common cases.
  73    */
  74
  75   /*
  76     first guess: begin beam at any position
  77   */
  78   Moment begin_mom (0);
  79   /*
  80     first guess: end beam at end of beat
  81   */
  82   Moment end_mom = time->one_beat_;
  83
  84   /*
  85     second guess: property generic time exception
  86   */
  87   Scalar begin = get_property (time_str + "beamAutoBegin", 0);
  88   if (begin.length_i ())
  89     begin_mom = begin.to_rat ();
  90
  91   Scalar end = get_property (time_str + "beamAutoEnd", 0);
  92   if (end.length_i ())
  93     end_mom = end.to_rat ();
  94
  95   /*
  96     third guess: property time exception, specific for duration type
  97   */
  98   if (type_str.length_i ())
  99     {
 100       Scalar end_mult = get_property (time_str + "beamAutoEnd" + type_str, 0);
 101       if (end_mult.length_i ())
 102         end_mom = end_mult.to_rat ();
 103       Scalar begin_mult = get_property (time_str + "beamAutoBegin" + type_str, 0);
 104       if (begin_mult.length_i ())
 105         begin_mom = begin_mult.to_rat ();
 106     }
 107
 108   /*
 109     fourth guess [user override]: property plain generic
 110   */
 111   begin = get_property ("beamAutoBegin", 0);
 112   if (begin.length_i ())
 113     begin_mom = begin.to_rat ();
 114
 115   end = get_property ("beamAutoEnd", 0);
 116   if (end.length_i ())
 117     end_mom = end.to_rat ();
 118
 119   /*
 120     fifth guess [user override]: property plain, specific for duration type
 121   */
 122   if (type_str.length_i ())
 123     {
 124       Scalar end_mult = get_property (String ("beamAutoEnd") + type_str, 0);
 125       if (end_mult.length_i ())
 126         end_mom = end_mult.to_rat ();
 127       Scalar begin_mult = get_property (String ("beamAutoBegin") + type_str, 0);
 128       if (begin_mult.length_i ())
 129         begin_mom = begin_mult.to_rat ();
 130     }
 131
 132   Rational r;
 133   if (end_mom)
 134     r = time->whole_in_measure_.mod_rat (end_mom);
 135   else
 136     r = Moment (1);
 137
 138   if (stem_l_arr_p_ && !r)
 139     end_beam ();
 140
 141   /*
 142     Allow already started autobeam to end
 143    */
 144   Scalar on = get_property ("beamAuto", 0);
 145   if (!on.to_bool ())
 146     return;
 147
 148   if (begin_mom)
 149     r = time->whole_in_measure_.mod_rat (begin_mom);
 150   if (!stem_l_arr_p_ && (!begin_mom || !r))
 151     begin_beam ();
 152 }
 153
 154
 155 void
 156 Auto_beam_engraver::begin_beam ()
 157 {
 158   //  DOUT << String ("starting autobeam at: ") + now_mom ().str () + "\n";
 159   assert (!stem_l_arr_p_);
 160   stem_l_arr_p_ = new Array<Stem*>;
 161   assert (!grouping_p_);
 162   grouping_p_ = new Rhythmic_grouping;
 163 }
 164
 165 Beam*
 166 Auto_beam_engraver::create_beam_p ()
 167 {
 168   Beam* beam_p = new Beam;
 169
 170   for (int i = 0; i < stem_l_arr_p_->size (); i++)
 171     beam_p->add_stem ((*stem_l_arr_p_)[i]);
 172
 173   /* urg, copied from Beam_engraver */
 174   Scalar prop = get_property ("beamslopedamping", 0);
 175   if (prop.isnum_b ())
 176     beam_p->set_elt_property (damping_scm_sym, gh_int2scm( prop));
 177
 178   prop = get_property ("beamquantisation", 0);
 179   if (prop.isnum_b ())
 180     beam_p->quantisation_ = (Beam::Quantisation)(int)prop;
 181
 182   announce_element (Score_element_info (beam_p, 0));
 183   return beam_p;
 184 }
 185
 186 void
 187 Auto_beam_engraver::end_beam ()
 188 {
 189   DOUT << String ("ending autobeam at: ") + now_mom ().str () + "\n";
 190   if (stem_l_arr_p_->size () < 2)
 191     {
 192       DOUT << "junking autombeam: less than two stems\n";
 193       junk_beam ();
 194     }
 195   else
 196     {
 197       finished_beam_p_ = create_beam_p ();
 198       finished_grouping_p_ = grouping_p_;
 199       delete stem_l_arr_p_;
 200       stem_l_arr_p_ = 0;
 201       grouping_p_ = 0;
 202       shortest_mom_ = 1;
 203     }
 204 }
 205
 206 void
 207 Auto_beam_engraver::typeset_beam ()
 208 {
 209   if (finished_beam_p_)
 210     {
 211       Rhythmic_grouping const * rg_C = get_staff_info().rhythmic_C_;
 212       rg_C->extend (finished_grouping_p_->interval());
 213       finished_beam_p_->set_grouping (*rg_C, *finished_grouping_p_);
 214       typeset_element (finished_beam_p_);
 215       finished_beam_p_ = 0;
 216
 217       delete finished_grouping_p_;
 218       finished_grouping_p_= 0;
 219     }
 220 }
 221
 222 void
 223 Auto_beam_engraver::do_post_move_processing ()
 224 {
 225 }
 226
 227 void
 228 Auto_beam_engraver::do_pre_move_processing ()
 229 {
 230   typeset_beam ();
 231 }
 232
 233 void
 234 Auto_beam_engraver::do_removal_processing ()
 235 {
 236   typeset_beam ();
 237   if (stem_l_arr_p_ && stem_l_arr_p_->size ())
 238     {
 239       DOUT << "Unfinished beam\n";
 240       junk_beam ();
 241     }
 242 }
 243
 244 void
 245 Auto_beam_engraver::acknowledge_element (Score_element_info info)
 246 {
 247   if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
 248     {
 249       if (stem_l_arr_p_)
 250         {
 251           DOUT << "junking autobeam: beam encountered\n";
 252           junk_beam ();
 253         }
 254     }
 255   if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
 256     {
 257       if (stem_l_arr_p_)
 258         {
 259           DOUT << "junking autobeam: bar encountered\n";
 260           junk_beam ();
 261         }
 262     }
 263
 264   if (stem_l_arr_p_)
 265     {
 266       Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
 267       if (!rhythmic_req)
 268         return;
 269
 270       if (dynamic_cast<Rest *> (info.elem_l_))
 271         {
 272           DOUT << "junking autobeam: rest encountered\n";
 273           end_beam ();
 274           return;
 275         }
 276
 277       Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_);
 278       if (!stem_l)
 279         return;
 280
 281       if (stem_l->beam_l_)
 282         {
 283           DOUT << "junking autobeam: beamed stem encountered\n";
 284           junk_beam ();
 285           return;
 286         }
 287
 288
 289       /*
 290         now that we have last_add_mom_, perhaps we can (should) do away
 291         with these individual junk_beams
 292        */
 293       if (rhythmic_req->duration_.durlog_i_ <= 2)
 294         {
 295           DOUT << "ending autobeam: stem doesn't fit in beam\n";
 296           end_beam ();
 297           return;
 298         }
 299
 300       Moment start = get_staff_info().time_C_->whole_in_measure_;
 301       if (!grouping_p_->child_fit_b (start))
 302         {
 303           DOUT << "ending autobeam: stem doesn't fit in group\n";
 304           end_beam ();
 305         }
 306       else
 307         {
 308           /*
 309             if shortest duration would change
 310             reconsider ending/starting beam first.
 311            */
 312           Moment mom = rhythmic_req->duration_.length_mom ();
 313           if (mom < shortest_mom_)
 314             {
 315               shortest_mom_ = mom;
 316               consider_end_and_begin ();
 317             }
 318           grouping_p_->add_child (start, rhythmic_req->length_mom ());
 319
 320           //stem_l->flag_i_ = rhythmic_req->duration_.durlog_i_;
 321
 322           stem_l_arr_p_->push (stem_l);
 323           Moment now = now_mom ();
 324           last_add_mom_ = now;
 325           extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
 326         }
 327     }
 328 }
 329
 330 void
 331 Auto_beam_engraver::junk_beam ()
 332 {
 333   assert (stem_l_arr_p_);
 334   /*  for (int i = 0; i < stem_l_arr_p_->size (); i++)
 335       (*stem_l_arr_p_)[i]->flag_i_ = 0;*/
 336
 337   delete stem_l_arr_p_;
 338   stem_l_arr_p_ = 0;
 339   delete grouping_p_;
 340   grouping_p_ = 0;
 341   shortest_mom_ = 1;
 342 }
 343
 344 void
 345 Auto_beam_engraver::process_acknowledged ()
 346 {
 347   if (stem_l_arr_p_)
 348     {
 349       Moment now = now_mom ();
 350       if ((extend_mom_ < now)
 351           || ((extend_mom_ == now) && (last_add_mom_ != now )))
 352         {
 353           DOUT << String ("junking autobeam: no stem added since: ")
 354             + last_add_mom_.str () + "\n";
 355           end_beam ();
 356         }
 357       else if (!stem_l_arr_p_->size ())
 358         {
 359           DOUT << "junking started autobeam: no stems\n";
 360           junk_beam ();
 361         }
 362     }
 363 }