lily/tie-engraver.cc

   1 /*
   2   tie-engraver.cc --  implement Tie_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "tie-engraver.hh"
  11 #include "command-request.hh"
  12 #include "rhythmic-head.hh"
  13 #include "musical-request.hh"
  14 #include "tie.hh"
  15 #include "translator-group.hh"
  16 #include "spanner.hh"
  17 #include "tie-column.hh"
  18 #include "pqueue.hh"
  19 #include "engraver.hh"
  20 #include "item.hh"
  21
  22 struct CHead_melodic_tuple {
  23   Melodic_req *req_l_ ;
  24   Grob *head_l_;
  25   Moment end_;
  26   CHead_melodic_tuple ();
  27   CHead_melodic_tuple (Grob*, Melodic_req*, Moment);
  28   static int pitch_compare (CHead_melodic_tuple const &, CHead_melodic_tuple const &);
  29   static int time_compare (CHead_melodic_tuple const &, CHead_melodic_tuple const &);
  30 };
  31
  32 inline int compare (CHead_melodic_tuple const &a, CHead_melodic_tuple const &b)
  33 {
  34   return CHead_melodic_tuple::time_compare (a,b);
  35 }
  36
  37
  38 /**
  39    Manufacture ties.  Acknowledge noteheads, and put them into a
  40    priority queue. If we have a Tie_req, connect the notes that finish
  41    just at this time, and note that start at this time.
  42
  43    TODO: junk the pq.
  44  */
  45 class Tie_engraver : public Engraver
  46 {
  47   bool done_;
  48   PQueue<CHead_melodic_tuple> past_notes_pq_;
  49   Moment end_mom_;
  50   Moment next_end_mom_;
  51
  52   Tie_req *req_l_;
  53   Array<CHead_melodic_tuple> now_heads_;
  54   Array<CHead_melodic_tuple> stopped_heads_;
  55   Link_array<Grob> tie_p_arr_;
  56
  57   Spanner * tie_column_p_;
  58
  59   void set_melisma (bool);
  60
  61 protected:
  62   virtual void start_translation_timestep ();
  63   virtual void stop_translation_timestep ();
  64   virtual void acknowledge_grob (Grob_info);
  65   virtual bool try_music (Music*);
  66   virtual void create_grobs ();
  67   void typeset_tie (Grob*);
  68 public:
  69   VIRTUAL_COPY_CONS(Translator);
  70   Tie_engraver();
  71 };
  72
  73
  74
  75 Tie_engraver::Tie_engraver()
  76 {
  77   req_l_ = 0;
  78   tie_column_p_ = 0;
  79 }
  80
  81
  82 bool
  83 Tie_engraver::try_music (Music *m)
  84 {
  85   if (Tie_req * c = dynamic_cast<Tie_req*> (m))
  86     {
  87       /*      if (end_mom_ > now_mom ())
  88        return false;
  89       */
  90       req_l_ = c;
  91       SCM m = get_property ("automaticMelismata");
  92       bool am = gh_boolean_p (m) &&gh_scm2bool (m);
  93       if (am)
  94         {
  95           set_melisma (true);
  96         }
  97       return true;
  98     }
  99   return false;
 100 }
 101
 102 void
 103 Tie_engraver::set_melisma (bool m)
 104 {
 105   daddy_trans_l_->set_property ("tieMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
 106 }
 107
 108 void
 109 Tie_engraver::acknowledge_grob (Grob_info i)
 110 {
 111   if (Rhythmic_head::has_interface (i.elem_l_))
 112     {
 113       Note_req * m = dynamic_cast<Note_req* > (i.req_l_);
 114       if (!m)
 115         return;
 116       now_heads_.push (CHead_melodic_tuple (i.elem_l_, m, now_mom()+ m->length_mom ()));
 117     }
 118 }
 119
 120 void
 121 Tie_engraver::create_grobs ()
 122 {
 123   if (req_l_ && !done_)
 124     {
 125       Moment now = now_mom ();
 126       stopped_heads_.clear ();
 127       while (past_notes_pq_.size ()
 128              && past_notes_pq_.front ().end_ == now)
 129         stopped_heads_.push (past_notes_pq_.get ());
 130       done_ = true;
 131       return;
 132     }
 133
 134   if (req_l_)
 135     {
 136       now_heads_.sort (CHead_melodic_tuple::pitch_compare);
 137       stopped_heads_.sort(CHead_melodic_tuple::pitch_compare);
 138
 139       SCM head_list = SCM_EOL;
 140
 141       int j = stopped_heads_.size ()-1;
 142       int i = now_heads_.size ()-1;
 143
 144       while  (i >= 0 && j >=0)
 145         {
 146           int comp
 147             = Pitch::compare (*unsmob_pitch (now_heads_[i].req_l_->get_mus_property ("pitch") ),
 148                                       *unsmob_pitch (stopped_heads_[j].req_l_->get_mus_property ("pitch")));
 149
 150           if (comp)
 151             {
 152               (comp < 0) ? j -- : i--;
 153               continue;
 154             }
 155           else
 156             {
 157               head_list  = gh_cons (gh_cons (stopped_heads_[j].head_l_->self_scm (),
 158                                              now_heads_[i].head_l_->self_scm ()),
 159                                     head_list);
 160
 161               past_notes_pq_. insert (now_heads_[i]);
 162               now_heads_.del (i);
 163               stopped_heads_.del (j);
 164               i--;
 165               j--;
 166             }
 167         }
 168
 169       SCM basic = get_property ("Tie");
 170       SCM sparse = get_property ("sparseTies");
 171       if (to_boolean (sparse))
 172         {
 173           int i = scm_ilength (head_list);
 174
 175           if (!i)
 176             return;
 177
 178           SCM pair = gh_list_ref (head_list, gh_int2scm (i/2));
 179
 180           Spanner * p = new Spanner (basic);
 181           Tie::set_head (p,LEFT, dynamic_cast<Item*> (unsmob_element (gh_car (pair))));
 182           Tie::set_head (p,RIGHT, dynamic_cast<Item*> (unsmob_element (gh_cdr (pair))));
 183
 184           tie_p_arr_.push (p);
 185           announce_grob (p, req_l_);
 186         }
 187       else for (SCM s = head_list; gh_pair_p (s); s = gh_cdr (s))
 188         {
 189           Grob * p = new Spanner (basic);
 190           Tie::set_interface (p);
 191
 192           Tie::set_head (p, LEFT, dynamic_cast<Item*> (unsmob_element (gh_caar (s))));
 193           Tie::set_head (p, RIGHT, dynamic_cast<Item*> (unsmob_element (gh_cdar (s))));
 194
 195           tie_p_arr_.push (p);
 196           announce_grob (p, req_l_);
 197         }
 198
 199       if (!tie_p_arr_.size ())
 200         {
 201           req_l_->origin ()->warning (_ ("No ties were created!"));
 202         }
 203       else if (tie_p_arr_.size () > 1 && !tie_column_p_)
 204         {
 205           tie_column_p_ = new Spanner (get_property ("TieColumn"));
 206           Tie_column::set_interface (tie_column_p_);
 207           for (int i = tie_p_arr_.size (); i--; )
 208             Tie_column::add_tie (tie_column_p_,tie_p_arr_ [i]);
 209           announce_grob (tie_column_p_, 0);
 210         }
 211     }
 212 }
 213
 214
 215 void
 216 Tie_engraver::stop_translation_timestep ()
 217 {
 218   for (int i=0; i < now_heads_.size (); i++)
 219     {
 220       past_notes_pq_.insert (now_heads_[i]);
 221     }
 222   now_heads_.clear ();
 223
 224   for (int i=0; i<  tie_p_arr_.size (); i++)
 225    {
 226       typeset_tie (tie_p_arr_[i]);
 227     }
 228   tie_p_arr_.clear ();
 229   if (tie_column_p_)
 230     {
 231       typeset_grob (tie_column_p_);
 232       tie_column_p_ =0;
 233     }
 234 }
 235
 236 void
 237 Tie_engraver::typeset_tie (Grob *her)
 238 {
 239   if (!(Tie::head (her,LEFT) && Tie::head (her,RIGHT)))
 240     warning (_ ("lonely tie"));
 241
 242   Direction d = LEFT;
 243   Drul_array<Grob *> new_head_drul;
 244   new_head_drul[LEFT] = Tie::head(her,LEFT);
 245   new_head_drul[RIGHT] = Tie::head (her,RIGHT);
 246   do {
 247     if (!Tie::head (her,d))
 248       new_head_drul[d] = Tie::head(her,(Direction)-d);
 249   } while (flip(&d) != LEFT);
 250
 251   index_set_cell (her->get_grob_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm () );
 252   index_set_cell (her->get_grob_property ("heads"), RIGHT, new_head_drul[RIGHT]->self_scm () );
 253
 254   typeset_grob (her);
 255 }
 256
 257 void
 258 Tie_engraver::start_translation_timestep ()
 259 {
 260   SCM m = get_property ("automaticMelismata");
 261   if (to_boolean (m))
 262     {
 263       set_melisma (false);
 264     }
 265   req_l_ = 0;
 266   done_ = false;
 267   Moment now = now_mom ();
 268   while (past_notes_pq_.size () && past_notes_pq_.front ().end_ < now)
 269     past_notes_pq_.delmin ();
 270 }
 271
 272 ADD_THIS_TRANSLATOR(Tie_engraver);
 273
 274
 275 CHead_melodic_tuple::CHead_melodic_tuple ()
 276 {
 277   head_l_ =0;
 278   req_l_ =0;
 279   end_ = 0;
 280 }
 281
 282 CHead_melodic_tuple::CHead_melodic_tuple (Grob *h, Melodic_req*m, Moment mom)
 283 {
 284   head_l_ = h;
 285   req_l_ = m;
 286   end_ = mom;
 287 }
 288
 289 int
 290 CHead_melodic_tuple::pitch_compare (CHead_melodic_tuple const&h1,
 291                              CHead_melodic_tuple const &h2)
 292 {
 293   SCM p1  = h1.req_l_->get_mus_property ("pitch");
 294   SCM p2  = h2.req_l_->get_mus_property ("pitch");
 295
 296   return Pitch::equal_p (p1,p2) == SCM_BOOL_T;
 297 }
 298
 299 int
 300 CHead_melodic_tuple::time_compare (CHead_melodic_tuple const&h1,
 301                              CHead_melodic_tuple const &h2)
 302 {
 303   return (h1.end_ - h2.end_ ).sign ();
 304 }