]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/part-combine-music-iterator.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / part-combine-music-iterator.cc
index ceeadef5d617909eeee985f5c4ec7b4c102ca244..11a0a75bff81af93b5212ab183a13e0b8df09290 100644 (file)
@@ -3,65 +3,95 @@
 
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 2000--2002 Jan Nieuwenhuizen <janneke@gnu.org>
  */
 
 #include "part-combine-music.hh"
 #include "part-combine-music-iterator.hh"
 #include "translator-group.hh"
 #include "musical-request.hh"
+#include "music-sequence.hh"
+#include "lily-guile.hh"
 #include "warn.hh"
 
 Part_combine_music_iterator::Part_combine_music_iterator ()
 {
-  combined_b_ = false;
+  first_iter_ = 0;
+  second_iter_ = 0;
+  first_until_ = 0;
+  second_until_ = 0;
 
-  first_iter_p_ = 0;
-  second_iter_p_ = 0;
+  state_ = 0;
 }
 
-Part_combine_music_iterator::~Part_combine_music_iterator ()
+void
+Part_combine_music_iterator::derived_mark () const
 {
-  delete second_iter_p_;
-  delete first_iter_p_;
+  if (first_iter_)
+    scm_gc_mark (first_iter_->self_scm());
+  if (second_iter_)
+    scm_gc_mark(second_iter_->self_scm());
 }
 
-Moment
-Part_combine_music_iterator::next_moment () const
+void
+Part_combine_music_iterator::do_quit ()
 {
-  Moment first_next = first_iter_p_->next_moment ();
-  Moment second_next = second_iter_p_->next_moment ();
-  return first_next <? second_next;
+  if (first_iter_)
+    first_iter_->quit();
+  if (second_iter_)
+    second_iter_->quit();
 }
 
-bool
-Part_combine_music_iterator::ok () const
+Part_combine_music_iterator::Part_combine_music_iterator (Part_combine_music_iterator const &src)
+  : Music_iterator (src)
 {
-  //hmm
-  return first_iter_p_->ok ();
+  first_iter_ = src.first_iter_ ? src.first_iter_->clone () : 0;
+  second_iter_ = src.second_iter_ ? src.second_iter_->clone () : 0;
+
+  first_until_ = src.first_until_;
+  second_until_ = src.second_until_;
+  state_ = src.state_;
+  suffix_ = src.suffix_;
+
+  if (first_iter_)
+    scm_gc_unprotect_object (first_iter_->self_scm());
+  if (second_iter_)
+    scm_gc_unprotect_object (second_iter_->self_scm());
 }
 
-void
-Part_combine_music_iterator::do_print () const
+Moment
+Part_combine_music_iterator::pending_moment () const
+{
+  Moment p;
+  p.set_infinite (1);
+  if (first_iter_->ok ())
+    p = p <? first_iter_->pending_moment ();
+
+  if (second_iter_->ok ())
+    p = p <? second_iter_->pending_moment ();
+  return p;
+}
+
+bool
+Part_combine_music_iterator::ok () const
 {
-  first_iter_p_->print ();
-  second_iter_p_->print ();
+  return first_iter_->ok () || second_iter_->ok ();
 }
 
 void
 Part_combine_music_iterator::construct_children ()
 {
-  Part_combine_music const * m = dynamic_cast<Part_combine_music const*> (music_l_);
+  Part_combine_music const * m = dynamic_cast<Part_combine_music const*> (get_music ());
   
-  first_iter_p_ = get_iterator_p (m->first_l ());
-  second_iter_p_ = get_iterator_p (m->second_l ());
+  first_iter_ = unsmob_iterator (get_iterator (m->get_first ()));
+  second_iter_ = unsmob_iterator (get_iterator (m->get_second ()));
 }
 
 void
 Part_combine_music_iterator::change_to (Music_iterator *it, String to_type,
                                        String to_id)
 {
-  Translator_group * current = it->report_to_l ();
+  Translator_group * current = it->report_to ();
   Translator_group * last = 0;
 
   /*
@@ -74,13 +104,13 @@ Part_combine_music_iterator::change_to (Music_iterator *it, String to_type,
      
      If \translator Staff = bass, then look for Staff = *
    */
-  while  (current && current->type_str_ != to_type)
+  while (current && current->type_string_ != to_type)
     {
       last = current;
-      current = current->daddy_trans_l_;
+      current = current->daddy_trans_;
     }
 
-  if (current && current->id_str_ == to_id)
+  if (current && current->id_string_ == to_id)
     {
       String msg;
       msg += _ ("Can't switch translators, I'm there already");
@@ -90,9 +120,9 @@ Part_combine_music_iterator::change_to (Music_iterator *it, String to_type,
     if (last)
       {
        Translator_group * dest = 
-         it->report_to_l ()->find_create_translator_l (to_type, to_id);
-       current->remove_translator_p (last);
-       dest->add_translator (last);
+         it->report_to ()->find_create_translator (to_type, to_id);
+       current->remove_translator (last);
+       dest->add_used_group_translator (last);
       }
     else
       {
@@ -100,188 +130,343 @@ Part_combine_music_iterator::change_to (Music_iterator *it, String to_type,
          We could change the current translator's id, but that would make 
          errors hard to catch
          
-          last->translator_id_str_  = change_l ()->change_to_id_str_;
+          last->translator_id_string_  = get_change ()->change_to_id_string_;
        */
-       error (_f ("I'm one myself: `%s'", to_type.ch_C ()));
+       error (_f ("I'm one myself: `%s'", to_type.to_str0 ()));
       }
   else
-    error (_f ("none of these in my family: `%s'", to_id.ch_C ()));
+    error (_f ("none of these in my family: `%s'", to_id.to_str0 ()));
 }
 
-Pitch_interrogate_req* first_spanish_inquisition; // nobody expects it
-Pitch_interrogate_req* second_spanish_inquisition; // won't strike twice
 
-void
-Part_combine_music_iterator::do_process_and_next (Moment m)
+// SCM*, moet / kan dat niet met set_x ofzo?
+static void
+get_music_info (Moment m, Music_iterator* iter, SCM *pitches, SCM *durations)
 {
-  Moment first_next = first_iter_p_->next_moment ();
-  Moment second_next = second_iter_p_->next_moment ();
-
-  Part_combine_music const * p = dynamic_cast<Part_combine_music const* > (music_l_);
-
-  /*
-    different rhythm for combined voices: separate 
-    same rhythm for separated voices: combine
-
-    Arg.  Voices should be separated for small intervals, eg < 3.
-    This should be \property settable, and, we need the outcome
-    of the spanish_inquisition's...
+  if (iter->ok ())
+    {
+      for (SCM i = iter->get_pending_events (m); gh_pair_p (i); i = ly_cdr (i))
+       {
+         Music *m = unsmob_music (ly_car (i));
+         if (Melodic_req *r = dynamic_cast<Melodic_req *> (m))
+           *pitches = gh_cons (r->get_mus_property ("pitch"), *pitches);
+         if (Rhythmic_req *r = dynamic_cast<Rhythmic_req *> (m))
+           {
+             SCM d = r->get_mus_property ("duration");
+             if (d == SCM_EOL)
+               r->origin ()->warning ("Rhythmic_req has no duration\n");
+               else
+                 // *durations = gh_cons (r->get_mus_property ("duration"), *durations);
+                 *durations = gh_cons (d, *durations);
+           }
+       }
+    }
+}
+  
+int
+Part_combine_music_iterator::get_state (Moment)
+{
+  int state = UNKNOWN;
+  Part_combine_music const *p = dynamic_cast<Part_combine_music const* > (get_music ());
 
-    Can't we first do a process_and_next go into a fake/tmp tree,
-    use + junk the result, and then do the real process_and_next...?
+  String w = ly_scm2string (p->get_mus_property ("what"));
     
-  */
-
-
-  if (first_next <= m)
-    first_iter_p_->process_and_next (m);
+  
+  Translator_group *first_translator = first_iter_->report_to ()->find_create_translator (w, "one" + suffix_);
 
-  if (second_next <= m)
-    second_iter_p_->process_and_next (m);
+  SCM s = first_translator->get_property ("changeMoment");
+  if (!gh_pair_p (s))
+    return state;
 
-  Music_iterator::do_process_and_next (m);
+  Moment change_mom = *unsmob_moment (ly_car (s));
+  Moment diff_mom = *unsmob_moment (ly_cdr (s));
+  
+  Moment now = pending_moment ();
 
-  /*
-    TODO:
+  if (!now.main_part_.mod_rat (change_mom.main_part_))
+    {
+      SCM interval = SCM_BOOL_F;
+      if (first_until_ < now)
+       first_until_ = now;
+      if (second_until_ < now)
+       second_until_ = now;
 
-    * setting of stem directions by a2-engraver don't work !!
+      Moment first_mom = first_until_;
+      Moment second_mom = second_until_;
+      Moment diff_until = diff_mom + now;
 
-    * check setting/resetting of properties
 
-    * use some unexpectedly handy abrvs.
-    
-    (customise) * separate for small ( <3 ?) intervals too
+      bool first = true;
+      Music_iterator *first_iter = first_iter_->clone ();
+      Music_iterator *second_iter = second_iter_->clone ();
       
-    Later (because currently, we only handle thread switching, really):
-
-    Maybe different modes exist?
+      Moment last_pending (-1);
+      Moment pending = now;
+      while (now < diff_until
+             && (first_iter->ok () || second_iter->ok ())
+
+            // urg, this is a hack, haven't caught this case yet
+            && (pending != last_pending))
+       {
+         if (!second_iter->ok ())
+           pending = first_iter->pending_moment ();
+         else if (!first_iter->ok ())
+           pending = second_iter->pending_moment ();
+         else
+           pending = first_iter->pending_moment () <? second_iter->pending_moment ();
+         last_pending = pending;
+
+         SCM first_pitches = SCM_EOL;
+         SCM first_durations = SCM_EOL;
+         get_music_info (pending, first_iter,
+                         &first_pitches, &first_durations);
+      
+         SCM second_pitches = SCM_EOL;
+         SCM second_durations = SCM_EOL;
+         get_music_info (pending, second_iter,
+                         &second_pitches, &second_durations);
+
+         if (first_pitches != SCM_EOL && second_pitches != SCM_EOL)
+           {
+             scm_sort_list_x (first_pitches,
+                              scm_primitive_eval (ly_symbol2scm ("Pitch::less_p")));
+             scm_sort_list_x (second_pitches,
+                              scm_primitive_eval (ly_symbol2scm ("Pitch::less_p")));
+
+             interval = gh_int2scm (unsmob_pitch (ly_car (first_pitches))->steps ()
+                                    - unsmob_pitch (ly_car (scm_last_pair (second_pitches)))->steps ());
+           }
+
+         if (first_durations != SCM_EOL)
+           {
+             scm_sort_list_x (first_durations,
+                              scm_primitive_eval (ly_symbol2scm ("Duration::less_p")));
+             first_mom += unsmob_duration (ly_car (first_durations))->length_mom ();
+           }
+         
+         if (second_durations != SCM_EOL)
+           {
+             scm_sort_list_x (second_durations,
+                              scm_primitive_eval (ly_symbol2scm ("Duration::less_p")));
+             second_mom += unsmob_duration (ly_car (second_durations))->length_mom ();
+           }
+         
+         if (first_pitches != SCM_EOL && second_pitches == SCM_EOL
+                 && ! (second_until_ > now))
+           {
+             state |= UNRELATED;
+             state &= ~UNISILENCE;
+             if (! (state & ~ (UNRELATED | SOLO1 | UNISILENCE)))
+               state |= SOLO1;
+           }
+         else
+           state &= ~SOLO1;
+
+         if (first_pitches == SCM_EOL && second_pitches != SCM_EOL
+             && ! (first_until_ > now))
+           {
+             state |= UNRELATED;
+             state &= ~UNISILENCE;
+             if (! (state & ~ (UNRELATED | SOLO2 | UNISILENCE)))
+               state |= SOLO2;
+           }
+         else
+           state &= ~SOLO2;
+
+         if (gh_equal_p (first_durations, second_durations))
+           {
+             state &= ~UNISILENCE;
+             if (! (state & ~ (UNIRHYTHM | UNISON)))
+               state |= UNIRHYTHM;
+           }
+         else
+           state &= ~ (UNIRHYTHM | UNISILENCE);
+         
+         if (first_pitches != SCM_EOL
+             && gh_equal_p (first_pitches, second_pitches))
+           {
+             state &= ~UNISILENCE;
+             if (! (state & ~ (UNIRHYTHM | UNISON)))
+               state |= UNISON;
+           }
+         else
+           state &= ~ (UNISON);
+           
+         if (first_pitches == SCM_EOL && second_pitches == SCM_EOL)
+           {
+             if (! (state & ~ (UNIRHYTHM | UNISILENCE)))
+               state |= UNISILENCE;
+           }
+         else if (!state)
+           state |= UNRELATED;
+         else
+           state &= ~ (UNISILENCE);
+
+         if (gh_number_p (interval))
+           {
+             SCM s = first_translator->get_property ("splitInterval");
+             int i = gh_scm2int (interval);
+             if (gh_pair_p (s)
+                 && gh_number_p (ly_car (s))
+                 && gh_number_p (ly_cdr (s))
+                 && i >= gh_scm2int (ly_car (s))
+                 && i <= gh_scm2int (ly_cdr (s)))
+               {
+                 if (! (state & ~ (SPLIT_INTERVAL | UNIRHYTHM | UNISON)))
+                   state |= SPLIT_INTERVAL;
+               }
+             else
+               state &= ~ (SPLIT_INTERVAL);
+           }
+
+         if (first && first_pitches != SCM_EOL)
+           first_until_ = first_mom;
+         if (first && second_pitches != SCM_EOL)
+           second_until_ = second_mom;
+         first = false;
+
+         if (first_iter->ok ())
+           first_iter->skip (pending);
+         if (second_iter->ok ())
+           second_iter->skip (pending);
+         now = pending;
+       }
+      scm_gc_unprotect_object (first_iter->self_scm ());
+      scm_gc_unprotect_object (second_iter->self_scm ());
+    }
 
-    * Wind instruments (Flute I/II)
-    * Hymnals:  
+  return state;
+}
 
+static Span_req* abort_req = NULL;
 
-      Rules for Hymnals/SATB (John Henckel <henckel@iname.com>):
+void
+Part_combine_music_iterator::process (Moment m)
+{
 
-      1. if S and A differ by less than a third, the stems should be up/down.
-      2. else if S and A have different values, the stems should be up/down.
-      3. else if A sings "la" or higher, both S and A stems should be down.
-      4. else both stems should be up
+  /*
+    TODO:
+    - Use three named contexts (be it Thread or Voice): one, two, solo.
+      Let user pre-set (pushproperty) stem direction, remove
+      dynamic-engraver, and such.
 
-    * This may get really tricky: combining voices/staffs: string instruments
+      **** Tried this, but won't work:
 
+s      Consider thread switching: threads "one", "two" and "both".
+      User can't pre-set the (most important) stem direction at
+      thread level!
    */
+  if (suffix_.empty_b ())
+    suffix_ = first_iter_->report_to ()
+      ->daddy_trans_->id_string_.cut_string (3, INT_MAX);
+
+  int state = get_state (m);
+  if (state)
+    state_ = state;
+  else
+    state = state_;
   
-  if (!first_spanish_inquisition)
-    first_spanish_inquisition = new Pitch_interrogate_req;
-  Music_iterator* fit = first_iter_p_->try_music (first_spanish_inquisition);
-
-  if (!second_spanish_inquisition)
-    second_spanish_inquisition = new Pitch_interrogate_req;
-  Music_iterator* sit = second_iter_p_->try_music (second_spanish_inquisition);
-
-  SCM interval = SCM_BOOL_F;
-  if (first_spanish_inquisition->pitch_arr_.size ()
-      && second_spanish_inquisition->pitch_arr_.size ())
-    {
-      first_spanish_inquisition->pitch_arr_.sort (Musical_pitch::compare);
-      second_spanish_inquisition->pitch_arr_.sort (Musical_pitch::compare);
-      interval = gh_int2scm (first_spanish_inquisition->pitch_arr_.top ().semitone_pitch ());
-    }
-
-
-  Translator_group * fir = first_iter_p_->report_to_l ();
-  Translator_group * sir = second_iter_p_->report_to_l ();
-
-  bool solo = (first_spanish_inquisition->pitch_arr_.empty ()
-              != second_spanish_inquisition->pitch_arr_.empty ());
-
-  bool unirhythm_b = (first_next == second_next) && !solo;
+  Part_combine_music const *p =
+    dynamic_cast<Part_combine_music const* > (get_music ());
 
-  bool too_close_b = false;
-  if (gh_number_p (interval) && gh_scm2int (interval) < 3)
-    too_close_b = true;
 
-  String to_id =  combined_b_ ? "one" : "two";
-  if ((!unirhythm_b && combined_b_)
-      || (unirhythm_b && !combined_b_)
-      || (too_close_b && combined_b_)
-      || (solo && combined_b_))
-    {
-      combined_b_ = !combined_b_;
-      to_id =  combined_b_ ? "one" : "two";
-      change_to (second_iter_p_, p->what_str_, to_id);
-    }
-
-  if (!combined_b_)
-    sir = second_iter_p_->report_to_l ();
+  bool previously_combined_b = first_iter_->report_to ()->daddy_trans_
+    == second_iter_->report_to ()->daddy_trans_;
 
-  Translator_group * fd = fir->find_create_translator_l (p->what_str_, "one");
-  Translator_group * sd = sir->find_create_translator_l (p->what_str_, "two");
+  bool combine_b = previously_combined_b;
 
-  fd->set_property ("unirhythm", unirhythm_b ? SCM_BOOL_T : SCM_BOOL_F);
-  sd->set_property ("unirhythm", unirhythm_b ? SCM_BOOL_T : SCM_BOOL_F);
-  fir->set_property ("unirhythm", unirhythm_b ? SCM_BOOL_T : SCM_BOOL_F);
-  sir->set_property ("unirhythm", unirhythm_b ? SCM_BOOL_T : SCM_BOOL_F);
-
-  if (unirhythm_b
-      && !compare (&first_spanish_inquisition->pitch_arr_,
-                  &second_spanish_inquisition->pitch_arr_))
-    {
-      fd->set_property ("unison", SCM_BOOL_T);
-      sd->set_property ("unison", SCM_BOOL_T);
-      fir->set_property ("unison", SCM_BOOL_T);
-      sir->set_property ("unison", SCM_BOOL_T);
-    }
-  else
-    {
-      fd->set_property ("unison", SCM_BOOL_F);
-      sd->set_property ("unison", SCM_BOOL_F);
-      fir->set_property ("unison", SCM_BOOL_F);
-      sir->set_property ("unison", SCM_BOOL_F);
-    }
-
-  fd->set_property ("interval", interval);
-  sd->set_property ("interval", interval);
-  fir->set_property ("interval", interval);
-  sir->set_property ("interval", interval);
-      
-  if (first_spanish_inquisition->pitch_arr_.size ()
-      && !second_spanish_inquisition->pitch_arr_.size ())
-    {
-      fd->set_property ("solo", SCM_BOOL_T);
-      fir->set_property ("solo", SCM_BOOL_T);
-    }
-  else
-    {
-      fd->set_property ("solo", SCM_BOOL_F);
-      fir->set_property ("solo", SCM_BOOL_F);
-    }
+  if (! (state & UNIRHYTHM)
+      || (state & SPLIT_INTERVAL)
+      || (state & (SOLO1 | SOLO2)))
+    combine_b = false;
+  else if (state & (UNIRHYTHM | UNISILENCE))
+    combine_b = true;
 
+  /*
+    When combining, abort all running spanners
+   */
 
-  if (!first_spanish_inquisition->pitch_arr_.size ()
-      && second_spanish_inquisition->pitch_arr_.size ())
+  if (!abort_req)
     {
-      sd->set_property ("solo", SCM_BOOL_T);
-      sir->set_property ("solo", SCM_BOOL_T);
+      abort_req = new Span_req;
+      abort_req->set_mus_property ("span-type", scm_makfrom0str ("abort"));
     }
-  else
+  
+  if (combine_b && combine_b != previously_combined_b)
     {
-      sd->set_property ("solo", SCM_BOOL_F);
-      sir->set_property ("solo", SCM_BOOL_F);
-    }
-
+      if (second_iter_ && second_iter_->ok ())
+       second_iter_->try_music (abort_req);
+     }
+  String w = ly_scm2string (p->get_mus_property ("what"));
+  if (combine_b != previously_combined_b)
+    change_to (second_iter_, w, (combine_b ? "one" : "two")
+              + suffix_);
+  
+  Translator_group *first_translator = first_iter_->report_to ()->find_create_translator (w, "one" + suffix_);
+  Translator_group *second_translator = second_iter_->report_to ()->find_create_translator (w, "two" + suffix_);
+  
 
-  first_spanish_inquisition->pitch_arr_.clear ();
-  second_spanish_inquisition->pitch_arr_.clear ();
+  /* Hmm */
+  first_translator->set_property ("combineParts", SCM_BOOL_T);
+  second_translator ->set_property ("combineParts", SCM_BOOL_T);
+  /* hmm */
+  SCM b = (state & UNIRHYTHM) ? SCM_BOOL_T : SCM_BOOL_F;
+  first_translator->set_property ("unirhythm", b);
+  second_translator->set_property ("unirhythm", b);
+
+  b = (state & SPLIT_INTERVAL) ? SCM_BOOL_T : SCM_BOOL_F;
+  first_translator->set_property ("split-interval", b);
+  second_translator->set_property ("split-interval",  b);
+
+  b = (state & UNISILENCE) ? SCM_BOOL_T : SCM_BOOL_F;
+  first_translator->set_property ("unisilence", b);
+  second_translator->set_property ("unisilence", b);
+
+  // difference in definition...
+  //b = ((state & UNISON) ? SCM_BOOL_T : SCM_BOOL_F;
+  b = ((state & UNISON) && (state & UNIRHYTHM)) ? SCM_BOOL_T : SCM_BOOL_F;
+  first_translator->set_property ("unison", b);
+  second_translator->set_property ("unison", b);
+
+  SCM b1 = (state & SOLO1) ? SCM_BOOL_T : SCM_BOOL_F;
+  SCM b2 = (state & SOLO2) ? SCM_BOOL_T : SCM_BOOL_F;
+  first_translator->set_property ("solo", b1);
+  second_translator->set_property ("solo", b2);
+
+  /* Can't these be computed? */
+  first_translator->set_property ("othersolo", b2);
+  second_translator->set_property ("othersolo", b1);
+
+  if (first_iter_->ok ())
+    first_iter_->process (m);
+  
+  if (second_iter_->ok ())
+    second_iter_->process (m);
 }
 
 Music_iterator*
 Part_combine_music_iterator::try_music_in_children (Music *m) const
 {
-  Music_iterator * i =  first_iter_p_->try_music (m);
+  Music_iterator * i =  first_iter_->try_music (m);
   if (i)
     return i;
   else
-    return second_iter_p_->try_music (m);
+    return second_iter_->try_music (m);
+}
+
+
+SCM
+Part_combine_music_iterator::get_pending_events (Moment m)const
+{
+  SCM s = SCM_EOL;
+  if (first_iter_)
+    s = gh_append2 (s,first_iter_->get_pending_events (m));
+  if (second_iter_)
+    s = gh_append2 (second_iter_->get_pending_events (m),s);
+  return s;
 }
 
+IMPLEMENT_CTOR_CALLBACK (Part_combine_music_iterator);