]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/music.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / music.cc
index 313f2c56f3d8576f62654c94f39653ca9c304088..fddd57fd0a18010235af349c32fe12eb37d5a6da 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "main.hh"
-#include "input-smob.hh"
 #include "music.hh"
-#include "music-list.hh"
-#include "warn.hh"
-#include "pitch.hh"
+#include "music-sequence.hh"
+#include "duration.hh"
+#include "input-smob.hh"
 #include "ly-smobs.icc"
+#include "main.hh"
+#include "pitch.hh"
+#include "score.hh"
+#include "warn.hh"
 
-SCM
-ly_deep_mus_copy (SCM m)
+/*
+  Music is anything that has duration and supports both time compression
+  and transposition.
+
+  In Lily, everything that can be thought to have a length and a pitch
+  (which has a duration which can be transposed) is considered "music",
+*/
+bool
+Music::internal_is_music_type (SCM k) const
 {
-  if (unsmob_music (m))
-    {
-      SCM ss =  unsmob_music (m)->clone ()->self_scm ();
-      scm_gc_unprotect_object (ss);
-      return ss;
-    }
-  else if (gh_pair_p (m))
-    {
-      return gh_cons (ly_deep_mus_copy (ly_car (m)), ly_deep_mus_copy (ly_cdr (m)));
-    }
-  else
-    return m;
+  SCM ifs = get_property ("types");
+
+  return scm_c_memq (k, ifs) != SCM_BOOL_F;
 }
 
+String
+Music::name () const
+{
+  SCM nm = get_property ("name");
+  if (scm_is_symbol (nm))
+    return ly_symbol2string (nm);
+  else
+    return "Music";
+}
 
-Music::Music ()
+Music::Music (SCM init)
 {
-  immutable_property_alist_ = SCM_EOL;
+  self_scm_ = SCM_EOL;
+  immutable_property_alist_ = init;
   mutable_property_alist_ = SCM_EOL;
   smobify_self ();
+
+  length_callback_ = get_property ("length-callback");
+  if (!ly_is_procedure (length_callback_))
+    length_callback_ = duration_length_callback_proc;
+
+  start_callback_ = get_property ("start-callback");
 }
 
 Music::Music (Music const &m)
 {
   immutable_property_alist_ = m.immutable_property_alist_;
   mutable_property_alist_ = SCM_EOL;
+  self_scm_ = SCM_EOL;
 
-  /*
-    First we smobify_self, then we copy over the stuff.  If we don't,
-    stack vars that hold the copy might be optimized away, meaning
-    that they won't be protected from GC.
-   */
+  /* First we smobify_self, then we copy over the stuff.  If we don't,
+     stack vars that hold the copy might be optimized away, meaning
+     that they won't be protected from GC. */
   smobify_self ();
-  mutable_property_alist_ = ly_deep_mus_copy (m.mutable_property_alist_);
+  mutable_property_alist_ = ly_music_deep_copy (m.mutable_property_alist_);
+  length_callback_ = m.length_callback_;
+  start_callback_ = m.start_callback_;
   set_spot (*m.origin ());
 }
 
-
-Music::Music (SCM l)
+Music::~Music ()
 {
-  immutable_property_alist_ = l;
-  mutable_property_alist_ = SCM_EOL;
-  smobify_self ();
 }
 
-
 SCM
-Music::mark_smob (SCM m)
+Music::get_property_alist (bool m) const
 {
-  Music * mus = (Music *)SCM_CELL_WORD_1 (m);
-  scm_gc_mark (mus->immutable_property_alist_);
-  scm_gc_mark (mus->mutable_property_alist_);
-  return SCM_EOL;
+  return (m) ? mutable_property_alist_ : immutable_property_alist_;
 }
 
-void    
-Music::compress (Moment)
+SCM
+Music::mark_smob (SCM m)
 {
+  Music *mus = (Music *) SCM_CELL_WORD_1 (m);
+  scm_gc_mark (mus->immutable_property_alist_);
+  return mus->mutable_property_alist_;
 }
 
-
-
 Moment
-Music::length_mom () const
+Music::get_length () const
 {
-  SCM l = get_mus_property ("length");
-  if (unsmob_moment (l))
-    return *unsmob_moment (l);
-  else if (gh_procedure_p (l))
+  SCM lst = get_property ("length");
+  if (unsmob_moment (lst))
+    return *unsmob_moment (lst);
+
+  if (ly_is_procedure (length_callback_))
     {
-      SCM res = gh_call1 (l, self_scm ());
+      SCM res = scm_call_1 (length_callback_, self_scm ());
       return *unsmob_moment (res);
     }
-    
-  return 0;
+
+  return Moment (0);
 }
 
 Moment
 Music::start_mom () const
 {
-  SCM l = get_mus_property ("start-moment-function");
-  if (gh_procedure_p (l))
+  SCM lst = start_callback_;
+  if (ly_is_procedure (lst))
     {
-      SCM res = gh_call1 (l, self_scm ());
+      SCM res = scm_call_1 (lst, self_scm ());
       return *unsmob_moment (res);
     }
 
-  Moment m ;
+  Moment m;
   return m;
 }
 
 void
 print_alist (SCM a, SCM port)
 {
-  /*
-    SCM_EOL  -> catch malformed lists.
-  */
-  for (SCM s = a; s != SCM_EOL; s = ly_cdr (s))
+  /* SCM_EOL  -> catch malformed lists.  */
+  for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
     {
-      scm_display (ly_caar (s), port);
-      scm_puts (" = ", port); 
-      scm_write (ly_cdar (s), port);
+      scm_display (scm_caar (s), port);
+      scm_puts (" = ", port);
+      scm_write (scm_cdar (s), port);
       scm_puts ("\n", port);
     }
 }
@@ -127,169 +136,194 @@ int
 Music::print_smob (SCM s, SCM p, scm_print_state*)
 {
   scm_puts ("#<Music ", p);
-  Music* m = unsmob_music (s);
-  scm_puts (classname (m),p);
+  Music *m = unsmob_music (s);
+
+  SCM nm = m->get_property ("name");
+  if (scm_is_symbol (nm) || scm_is_string (nm))
+    scm_display (nm, p);
+  else
+    scm_puts ("Music", p);
 
-  print_alist (m->mutable_property_alist_, p);
-  print_alist (m->immutable_property_alist_, p);
-  
-  scm_puts (">",p);
+  /* Printing properties takes a lot of time, especially during backtraces.
+     For inspecting, it is better to explicitly use an inspection
+     function.  */
+
+  scm_puts (">", p);
   return 1;
 }
 
 Pitch
-Music::to_relative_octave (Pitch m)
+Music::generic_to_relative_octave (Pitch last)
 {
-  return m;
+  SCM elt = get_property ("element");
+  Pitch *old_pit = unsmob_pitch (get_property ("pitch"));
+  if (old_pit)
+    {
+      Pitch new_pit = *old_pit;
+      new_pit = new_pit.to_relative_octave (last);
+
+      SCM check = get_property ("absolute-octave");
+      if (scm_is_number (check)
+         && new_pit.get_octave () != scm_to_int (check))
+       {
+         Pitch expected_pit (scm_to_int (check),
+                             new_pit.get_notename (),
+                             new_pit.get_alteration ());
+         origin ()->warning (_f ("octave check failed; expected %s, found: %s",
+                                 expected_pit.to_string (),
+                                 new_pit.to_string ()));
+         new_pit = expected_pit;
+       }
+
+      set_property ("pitch", new_pit.smobbed_copy ());
+
+      last = new_pit;
+    }
+
+  if (Music *m = unsmob_music (elt))
+    last = m->to_relative_octave (last);
+
+  last = music_list_to_relative (get_property ("elements"), last, false);
+  return last;
 }
 
+Pitch
+Music::to_relative_octave (Pitch last)
+{
+  SCM callback = get_property ("to-relative-callback");
+  if (ly_is_procedure (callback))
+    {
+      Pitch *p = unsmob_pitch (scm_call_2 (callback, self_scm (), last.smobbed_copy ()));
+      return *p;
+    }
+
+  return generic_to_relative_octave (last);
+}
+
+void
+Music::compress (Moment factor)
+{
+  SCM elt = get_property ("element");
+
+  if (Music *m = unsmob_music (elt))
+    m->compress (factor);
+
+  compress_music_list (get_property ("elements"), factor);
+  Duration *d = unsmob_duration (get_property ("duration"));
+  if (d)
+    set_property ("duration", d->compressed (factor.main_part_).smobbed_copy ());
+}
 
 void
 Music::transpose (Pitch delta)
 {
-  Pitch *p = unsmob_pitch (get_mus_property ("pitch"));
-  if (!p)
-    return ;
-
-  Pitch np = *p;
-  np.transpose (delta);
-  
-  if (abs (np.alteration_) > 2)
+  if (to_boolean (get_property ("untransposable")))
+    return;
+
+  for (SCM s = this->get_property_alist (true); scm_is_pair (s); s = scm_cdr (s))
     {
-       warning (_f ("Transposition by %s makes accidental larger than two",
-         delta.string ()));
+      SCM entry = scm_car (s);
+      SCM val = scm_cdr (entry);
+
+      if (Pitch *p = unsmob_pitch (val))
+       {
+         Pitch transposed = p->transposed (delta);
+         scm_set_cdr_x (entry, transposed.smobbed_copy ());
+
+         if (abs (transposed.get_alteration ()) > DOUBLE_SHARP)
+           {
+             warning (_f ("transposition by %s makes alteration larger than double",
+                          delta.to_string ()));
+           }
+       }
     }
 
-  set_mus_property ("pitch", np.smobbed_copy ());
-}
+  SCM elt = get_property ("element");
+
+  if (Music *m = unsmob_music (elt))
+    m->transpose (delta);
 
-IMPLEMENT_TYPE_P (Music, "music?");
+  transpose_music_list (get_property ("elements"), delta);
 
+  /*
+    UGH - how do this more generically?
+  */
+  SCM pa = get_property ("pitch-alist");
+  if (scm_is_pair (pa))
+    set_property ("pitch-alist", ly_transpose_key_alist (pa, delta.smobbed_copy ()));
+}
+
+IMPLEMENT_TYPE_P (Music, "ly:music?");
 IMPLEMENT_SMOBS (Music);
 IMPLEMENT_DEFAULT_EQUAL_P (Music);
 
-/****************************/
-
 SCM
-Music::internal_get_mus_property (SCM sym) const
+Music::internal_get_property (SCM sym) const
 {
   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
   if (s != SCM_BOOL_F)
-    return ly_cdr (s);
+    return scm_cdr (s);
 
   s = scm_sloppy_assq (sym, immutable_property_alist_);
-  return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s); 
+  return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
 }
 
-void
-Music::internal_set_mus_property (SCM s, SCM v)
+SCM
+Music::internal_get_object (SCM s) const
 {
-#ifndef NDEBUG
-  if (internal_type_checking_global_b)
-    assert (type_check_assignment (s, v, ly_symbol2scm ("music-type?")));
-#endif
-
-  mutable_property_alist_ =  scm_assq_set_x (mutable_property_alist_, s, v);
+  return internal_get_property (s);
 }
 
-
-
-#include "main.hh"
-
 void
-Music::set_spot (Input ip)
+Music::internal_set_object (SCM s, SCM v)
 {
-  set_mus_property ("origin", make_input (ip));
+  return internal_set_property (s, v);
 }
 
-Input*
-Music::origin () const
+void
+Music::internal_set_property (SCM s, SCM v)
 {
-  Input *ip = unsmob_input (get_mus_property ("origin"));
-  return ip ? ip : & dummy_input_global; 
-}
-
+  if (do_internal_type_checking_global)
+    if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
+      abort ();
 
-Music::~Music ()
-{
-  
+  mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
 }
 
-LY_DEFINE(ly_get_mus_property,
-         "ly-get-mus-property", 2, 0, 0,  (SCM mus, SCM sym),
-         "Get the property @var{sym} of music expression @var{mus}.")
+void
+Music::set_spot (Input ip)
 {
-  Music * sc = unsmob_music (mus);
-  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
-  SCM_ASSERT_TYPE(gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
-
-  return sc->internal_get_mus_property (sym);
+  set_property ("origin", make_input (ip));
 }
 
-LY_DEFINE(ly_set_mus_property,
-         "ly-set-mus-property!", 3, 0, 0,
-         (SCM mus, SCM sym, SCM val),
-         "Set property @var{sym} in music expression @var{mus} to @var{val}.")
+Input *
+Music::origin () const
 {
-  Music * sc = unsmob_music (mus);
-  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE(gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
-
-  bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
-  if (ok)
-    {
-      sc->internal_set_mus_property (sym, val);
-    }
-    
-  return SCM_UNSPECIFIED;
+  Input *ip = unsmob_input (get_property ("origin"));
+  return ip ? ip : &dummy_input_global;
 }
 
-
-// to do  property args 
-LY_DEFINE(ly_make_music,
-         "ly-make-music", 1, 0, 0,  (SCM type),
-         "
-Make a music object/expression of type @var{name}. Warning: this
-interface will likely change in the near future.
-
-
-
-Music is the data type that music expressions are stored in. The data
-type does not yet offer many manipulations.
-")
+Music *
+make_music_by_name (SCM sym)
 {
-  SCM_ASSERT_TYPE(gh_string_p (type), type, SCM_ARG1, __FUNCTION__, "string");
-  
-  SCM s = make_music (ly_scm2string (type))->self_scm ();
-  scm_gc_unprotect_object (s);
-
-  return s;
-}
+  SCM make_music_proc = ly_lily_module_constant ("make-music");
+  SCM rv = scm_call_1 (make_music_proc, sym);
 
-LY_DEFINE(ly_music_name, "ly-music-name", 1, 0, 0, 
-  (SCM mus),
-  "Return the name of @var{music}.")
-{
-  Music * m = unsmob_music (mus);
-  SCM_ASSERT_TYPE(m, mus, SCM_ARG1, __FUNCTION__ ,"music");
-  
-  const char * nm = classname (m);
-  return scm_makfrom0str (nm);
+  /* UGH. */
+  Music *m = unsmob_music (rv);
+  m->protect ();
+  return m;
 }
 
-LY_DEFINE(ly_music_list_p,"music-list?", 1, 0, 0, 
-  (SCM l),"Type predicate: return true if @var{l} is a list of music objects.")
+MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
+SCM
+Music::duration_length_callback (SCM m)
 {
-  if (scm_list_p (l) != SCM_BOOL_T)
-    return SCM_BOOL_F;
+  Music *me = unsmob_music (m);
+  Duration *d = unsmob_duration (me->get_property ("duration"));
 
-  while (gh_pair_p (l))
-    {
-      if (!unsmob_music (gh_car (l)))
-       return SCM_BOOL_F;
-      l =gh_cdr (l);
-    }
-  return SCM_BOOL_T;
+  Moment mom;
+  if (d)
+    mom = d->get_length ();
+  return mom.smobbed_copy ();
 }
-ADD_MUSIC(Music);
-