lily/stem.cc

   1 /*
   2   stem.cc -- implement Stem
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8   TODO: This is way too hairy
   9 */
  10
  11 #include "stem.hh"
  12 #include "debug.hh"
  13 #include "paper-def.hh"
  14 #include "note-head.hh"
  15 #include "lookup.hh"
  16 #include "molecule.hh"
  17 #include "paper-column.hh"
  18 #include "misc.hh"
  19 #include "beam.hh"
  20 #include "rest.hh"
  21
  22 void
  23 Stem::set_direction (Direction d)
  24 {
  25   if  (!dir_)
  26     warning ("Stem direction set already!");
  27
  28   dir_ = d;
  29
  30   /*
  31     todo
  32   */
  33 }
  34
  35 Stem::Stem ()
  36 {
  37   beams_i_drul_[LEFT] = beams_i_drul_[RIGHT] = -1;
  38   yextent_drul_[DOWN] = yextent_drul_[UP] = 0;
  39   flag_i_ = 2;
  40   dir_ = CENTER;
  41   beam_l_ = 0;
  42 }
  43
  44 Interval_t<int>
  45 Stem::head_positions () const
  46 {
  47   /*
  48     Mysterious FreeBSD fix by John Galbraith.  Somehow, the empty intervals
  49     trigger FP exceptions on FreeBSD.  Fix: do not return infinity
  50
  51    */
  52   if (!head_l_arr_.size ())
  53     {
  54       return Interval_t<int> (100,-100);
  55     }
  56
  57   Interval_t<int> r;
  58   for (int i =0; i < head_l_arr_.size (); i++)
  59     {
  60       int p = head_l_arr_[i]->position_i_;
  61       r[BIGGER] = r[BIGGER] >? p;
  62       r[SMALLER] = r[SMALLER] <? p;
  63     }
  64   return r;
  65 }
  66
  67 void
  68 Stem::do_print () const
  69 {
  70 #ifndef NPRINT
  71   DOUT << "flag "<< flag_i_;
  72   if (beam_l_)
  73     DOUT << "beamed";
  74 #endif
  75 }
  76
  77 Real
  78 Stem::stem_length_f () const
  79 {
  80   return yextent_drul_[UP]-yextent_drul_[DOWN] ;
  81 }
  82
  83 Real
  84 Stem::stem_begin_f () const
  85 {
  86   return yextent_drul_[Direction(-dir_)];
  87 }
  88
  89 Real
  90 Stem::chord_start_f () const
  91 {
  92   return head_positions()[dir_] * staff_line_leading_f ()/2.0;
  93 }
  94
  95 Real
  96 Stem::stem_end_f () const
  97 {
  98   return yextent_drul_[dir_];
  99 }
 100
 101 void
 102 Stem::set_stemend (Real se)
 103 {
 104   // todo: margins
 105   if (dir_ && dir_ * head_positions()[dir_] >= se*dir_)
 106     warning (_ ("weird stem size; check for narrow beams"));
 107
 108
 109   yextent_drul_[dir_]  =  se;
 110   yextent_drul_[Direction(-dir_)] = head_positions()[-dir_];
 111 }
 112
 113 int
 114 Stem::type_i () const
 115 {
 116   return head_l_arr_[0]->balltype_i_;
 117 }
 118
 119 void
 120 Stem::add_head (Rhythmic_head *n)
 121 {
 122   n->stem_l_ = this;
 123   n->add_dependency (this);     // ?
 124   if (Note_head *nh = dynamic_cast<Note_head *> (n))
 125     {
 126       head_l_arr_.push (nh);
 127     }
 128   else if (Rest *r = dynamic_cast<Rest *> (n))
 129     {
 130       rest_l_arr_.push (r);
 131     }
 132 }
 133
 134 bool
 135 Stem::invisible_b () const
 136 {
 137   return (!head_l_arr_.size () ||
 138     head_l_arr_[0]->balltype_i_ <= 0);
 139 }
 140
 141 int
 142 Stem::get_center_distance (Direction d) const
 143 {
 144   int staff_center = 0;
 145   int distance = d*(head_positions()[d] - staff_center);
 146   return distance >? 0;
 147 }
 148
 149 Direction
 150 Stem::get_default_dir () const
 151 {
 152   return (get_center_distance (UP) >
 153           get_center_distance (DOWN))
 154     ? DOWN
 155     : UP;
 156 }
 157
 158 Direction
 159 Stem::get_dir () const
 160 {
 161   return dir_;
 162 }
 163
 164
 165 void
 166 Stem::set_default_stemlen ()
 167 {
 168   Real length_f = 0.;
 169   SCM scm_len = get_elt_property(length_scm_sym);
 170   if (scm_len != SCM_BOOL_F)
 171     {
 172       length_f = gh_scm2double (SCM_CDR(scm_len));
 173     }
 174   else
 175     length_f = paper_l ()->get_var ("stem_length0");
 176
 177   bool grace_b = get_elt_property (grace_scm_sym) != SCM_BOOL_F;
 178   String type_str = grace_b ? "grace_" : "";
 179
 180   Real shorten_f = paper_l ()->get_var (type_str + "forced_stem_shorten0");
 181
 182   if (!dir_)
 183     dir_ = get_default_dir ();
 184
 185   /*
 186     stems in unnatural (forced) direction should be shortened,
 187     according to [Roush & Gourlay]
 188    */
 189   if (((int)chord_start_f ())
 190       && (dir_ != get_default_dir ()))
 191     length_f -= shorten_f;
 192
 193   if (flag_i_ >= 5)
 194     length_f += 2.0;
 195   if (flag_i_ >= 6)
 196     length_f += 1.0;
 197
 198   set_stemend ((dir_ > 0) ? head_positions()[BIGGER] + length_f:
 199                head_positions()[SMALLER] - length_f);
 200
 201   if (!grace_b && (dir_ * stem_end_f () < 0))
 202     set_stemend (0);
 203 }
 204
 205 //xxx
 206 void
 207 Stem::set_default_extents ()
 208 {
 209   if (!stem_length_f ())
 210     set_default_stemlen ();
 211
 212 }
 213
 214 void
 215 Stem::set_noteheads ()
 216 {
 217   if (!head_l_arr_.size ())
 218     return;
 219   head_l_arr_.sort (Note_head::compare);
 220   if (dir_ < 0)
 221     head_l_arr_.reverse ();
 222
 223   Note_head * beginhead =   head_l_arr_[0];
 224   beginhead->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
 225   if  (beginhead !=   head_l_arr_.top ())
 226     head_l_arr_.top ()->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
 227
 228   int parity=1;
 229   int lastpos = beginhead->position_i_;
 230   for (int i=1; i < head_l_arr_.size (); i ++)
 231     {
 232       int dy =abs (lastpos- head_l_arr_[i]->position_i_);
 233
 234       if (dy <= 1)
 235         {
 236           if (parity)
 237             head_l_arr_[i]->flip_around_stem (dir_);
 238           parity = !parity;
 239         }
 240       else
 241         parity = 1;
 242       lastpos = head_l_arr_[i]->position_i_;
 243     }
 244 }
 245
 246 void
 247 Stem::do_pre_processing ()
 248 {
 249   if (yextent_drul_[DOWN]== yextent_drul_[UP])
 250     set_default_extents ();
 251   set_noteheads ();
 252
 253   if (invisible_b ())
 254     {
 255       set_elt_property (transparent_scm_sym, SCM_BOOL_T);
 256     }
 257   set_empty (invisible_b ());
 258   set_spacing_hints ();
 259 }
 260
 261
 262
 263 /**
 264    set stem directions for hinting the optical spacing correction.
 265
 266    Modifies DIR_LIST property of the Stem's Score_column
 267
 268    TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
 269  */
 270 void
 271 Stem::set_spacing_hints ()
 272 {
 273   if (!invisible_b ())
 274     {
 275       SCM scmdir  = gh_int2scm (dir_);
 276       SCM dirlist = column_l ()->get_elt_property (dir_list_scm_sym);
 277       if (dirlist == SCM_BOOL_F)
 278         dirlist = SCM_EOL;
 279       else
 280         dirlist = SCM_CDR (dirlist);
 281
 282       if (scm_sloppy_memq (scmdir, dirlist) == SCM_EOL)
 283         {
 284           dirlist = gh_cons (scmdir, dirlist);
 285           column_l ()->set_elt_property (dir_list_scm_sym, dirlist);
 286         }
 287     }
 288 }
 289
 290 Molecule
 291 Stem::flag () const
 292 {
 293   String style;
 294   SCM st = get_elt_property (style_scm_sym);
 295   if ( st != SCM_BOOL_F)
 296     {
 297       st = SCM_CDR(st);
 298       style = ly_scm2string (st);
 299     }
 300
 301   char c = (dir_ == UP) ? 'u' : 'd';
 302   Molecule m = lookup_l ()->afm_find (String ("flags-") + to_str (c) +
 303                                       to_str (flag_i_));
 304   if (!style.empty_b ())
 305     m.add_molecule(lookup_l ()->afm_find (String ("flags-") + to_str (c) + style));
 306   return m;
 307 }
 308
 309 Interval
 310 Stem::do_width () const
 311 {
 312   Interval r (0, 0);
 313   if (beam_l_ || abs (flag_i_) <= 2)
 314     ;   // TODO!
 315   else
 316     {
 317       r = flag ().dim_.x ();
 318       r += note_delta_f ();
 319     }
 320   return r;
 321 }
 322
 323
 324
 325
 326 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh!
 327
 328 Molecule*
 329 Stem::do_brew_molecule_p () const
 330 {
 331   Molecule *mol_p =new Molecule;
 332   Drul_array<Real> stem_y = yextent_drul_;
 333   Real dy = staff_line_leading_f ()/2.0;
 334
 335   Real head_wid = 0;
 336   if (head_l_arr_.size ())
 337     head_wid = head_l_arr_[0]->extent (X_AXIS).length ();
 338   stem_y[Direction(-dir_)] += dir_ * head_wid * tan(ANGLE)/(2*dy);
 339
 340   if (!invisible_b ())
 341     {
 342       Real stem_width = paper_l ()->get_var ("stemthickness");
 343       Molecule ss =lookup_l ()->filledbox (Box (Interval (-stem_width/2, stem_width/2),
 344                                                  Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
 345       mol_p->add_molecule (ss);
 346     }
 347
 348   if (!beam_l_ && abs (flag_i_) > 2)
 349     {
 350       Molecule fl = flag ();
 351       fl.translate_axis(stem_y[dir_]*dy, Y_AXIS);
 352       mol_p->add_molecule (fl);
 353     }
 354
 355   if (head_l_arr_.size())
 356     {
 357       mol_p->translate_axis (note_delta_f (), X_AXIS);
 358     }
 359   return mol_p;
 360 }
 361
 362 Real
 363 Stem::note_delta_f () const
 364 {
 365   Real r=0;
 366   if (head_l_arr_.size())
 367     {
 368       Interval head_wid(0,  head_l_arr_[0]->extent (X_AXIS).length ());
 369       Real rule_thick(paper_l ()->rule_thickness ());
 370       Interval stem_wid(-rule_thick/2, rule_thick/2);
 371       if (dir_ == CENTER)
 372         r = head_wid.center ();
 373       else
 374         r = head_wid[dir_] - stem_wid[dir_];
 375     }
 376   return r;
 377 }
 378
 379 Real
 380 Stem::hpos_f () const
 381 {
 382   return note_delta_f () + Item::hpos_f ();
 383 }
 384
 385 void
 386 Stem::do_substitute_element_pointer (Score_element*o,Score_element*n)
 387 {
 388   if (Note_head*h=dynamic_cast<Note_head*> (o))
 389     head_l_arr_.substitute (h, dynamic_cast<Note_head*>(n));
 390   if (Rest *r=dynamic_cast<Rest*> (o))
 391     rest_l_arr_.substitute (r, dynamic_cast<Rest*>(n));
 392   if (Beam* b = dynamic_cast<Beam*> (o))
 393     {
 394       if (b == beam_l_)
 395         beam_l_ = dynamic_cast<Beam*> (n);
 396     }
 397   Staff_symbol_referencer::do_substitute_element_pointer (o,n);
 398 }