]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/music.cc
* scripts/abc2ly.py (try_parse_comment): idem.
[lilypond.git] / lily / music.cc
index 64044b1f5ac9ddcb34876beffd88d974188472a5..4d71d99d98e6bfd8069936ccd88600834d563d3b 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "input-smob.hh"
 #include "music.hh"
-#include "music-list.hh"
-#include "debug.hh"
-#include "pitch.hh"
+
+#include "context.hh"
+#include "dispatcher.hh"
+#include "duration.hh"
+#include "input.hh"
+#include "international.hh"
 #include "ly-smobs.icc"
+#include "main.hh"
+#include "music-sequence.hh"
+#include "pitch.hh"
+#include "score.hh"
+#include "warn.hh"
 
-SCM
-ly_deep_mus_copy (SCM m)
+/*
+  Music is anything that has (possibly zero) 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_unprotect_object (ss);
-      return ss;
-    }
-  else if (gh_pair_p (m))
-    {
-      return gh_cons (ly_deep_mus_copy (gh_car (m)), ly_deep_mus_copy (gh_cdr (m)));
-    }
-  else
-    return m;
-}
+  SCM ifs = get_property ("types");
 
+  return scm_c_memq (k, ifs) != SCM_BOOL_F;
+}
 
-Music::Music (Music const &m)
+Music::Music (SCM init)
+  : Prob (ly_symbol2scm ("Music"), init)
 {
-  immutable_property_alist_ = m.immutable_property_alist_;
-  SCM c =ly_deep_mus_copy (m.mutable_property_alist_);
-  mutable_property_alist_ = c;
-
-  smobify_self ();
+  length_callback_ = SCM_EOL;
+  start_callback_ = SCM_EOL;
+  
+  length_callback_ = get_property ("length-callback");
+  if (!ly_is_procedure (length_callback_))
+    length_callback_ = duration_length_callback_proc;
 
-  set_spot (*m.origin ());
+  start_callback_ = get_property ("start-callback");
 }
 
-
-Music::Music (SCM l)
+void
+Music::derived_mark () const
 {
-  immutable_property_alist_ = l;
-  mutable_property_alist_ = SCM_EOL;
-  smobify_self ();
+  scm_gc_mark (length_callback_);
+  scm_gc_mark (start_callback_);
 }
 
 SCM
-Music::mark_smob (SCM m)
+Music::copy_mutable_properties () 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 ly_music_deep_copy (mutable_property_alist_);
 }
 
-void    
-Music::compress (Moment)
+void
+Music::type_check_assignment (SCM s, SCM v) const
 {
+  if (!::type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
+    abort ();
+}
+
+Music::Music (Music const &m)
+  : Prob (m)
+{
+  length_callback_ = m.length_callback_;
+  start_callback_ = m.start_callback_;
+
+  /// why? 
+  set_spot (*m.origin ());
 }
 
+Moment
+Music::get_length () const
+{
+  SCM lst = get_property ("length");
+  if (unsmob_moment (lst))
+    return *unsmob_moment (lst);
 
+  if (ly_is_procedure (length_callback_))
+    {
+      SCM res = scm_call_1 (length_callback_, self_scm ());
+      return *unsmob_moment (res);
+    }
+
+  return Moment (0);
+}
 
 Moment
-Music::length_mom () const
+Music::start_mom () const
 {
-  SCM l = get_mus_property ("length");
-  if (unsmob_moment (l))
-    return *unsmob_moment (l);
-  else 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);
     }
-    
-  return 0;
+
+  Moment m;
+  return m;
 }
 
 void
 print_alist (SCM a, SCM port)
 {
-  for (SCM s = a; gh_pair_p (s); s = gh_cdr (s))
+  /* SCM_EOL  -> catch malformed lists.  */
+  for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
     {
-      scm_display (gh_caar (s), port);
-      scm_puts (" = ", port); 
-      scm_write (gh_cdar (s), port);
+      scm_display (scm_caar (s), port);
+      scm_puts (" = ", port);
+      scm_write (scm_cdar (s), port);
       scm_puts ("\n", port);
     }
 }
 
-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);
-
-  print_alist (m->mutable_property_alist_, p);
-  print_alist (m->immutable_property_alist_, p);
-  
-  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);
 
-void
-Music::transpose (Pitch)
-{
+  last = music_list_to_relative (get_property ("elements"), last, false);
+  return last;
 }
 
-IMPLEMENT_TYPE_P (Music, "music?");
-IMPLEMENT_UNSMOB (Music,music);
-IMPLEMENT_SMOBS (Music);
-IMPLEMENT_DEFAULT_EQUAL_P (Music);
-
-/****************************/
-
-SCM
-Music::get_mus_property (const char *nm) const
+Pitch
+Music::to_relative_octave (Pitch last)
 {
-  SCM sym = ly_symbol2scm (nm);
-  return get_mus_property (sym);
+  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);
 }
 
-SCM
-Music::get_mus_property (SCM sym) const
+void
+Music::compress (Moment factor)
 {
-  SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
-  if (s != SCM_BOOL_F)
-    return gh_cdr (s);
+  SCM elt = get_property ("element");
 
-  s = scm_sloppy_assq (sym, immutable_property_alist_);
-  return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s); 
+  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 ());
 }
 
 /*
-  Remove the value associated with KEY, and return it. The result is
-  that a next call will yield SCM_EOL (and not the underlying
-  `basic' property.
+TODO: make transposition non-destructive
 */
 SCM
-Music::remove_mus_property (const char* key)
+transpose_mutable (SCM alist, Pitch delta)
 {
-  SCM val = get_mus_property (key);
-  if (val != SCM_EOL)
-    set_mus_property (key, SCM_EOL);
-  return val;
-}
+  SCM retval = SCM_EOL;
 
-void
-Music::set_mus_property (const char* k, SCM v)
-{
-  SCM s = ly_symbol2scm (k);
-  set_mus_property (s, v);
-}
+  for (SCM s = alist; scm_is_pair (s); s = scm_cdr (s))
+    {
+      SCM entry = scm_car (s);
+      SCM prop = scm_car (entry);
+      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 ()));
+           }
+       }
+      else if (prop == ly_symbol2scm ("element"))
+       {
+         if (Music *m = unsmob_music (val))
+           m->transpose (delta);
+       }
+      else if (prop == ly_symbol2scm ("elements"))
+       transpose_music_list (val, delta);
+      else if (prop == ly_symbol2scm ("pitch-alist") &&
+              scm_is_pair (val))
+       entry = scm_cons (prop, ly_transpose_key_alist (val, delta.smobbed_copy ()));
+      retval = scm_cons (entry, retval);
+    }
 
-void
-Music::set_immutable_mus_property (const char*k, SCM v)
-{
-  SCM s = ly_symbol2scm (k);
-  set_immutable_mus_property (s, v);
+  return scm_reverse_x (retval, SCM_EOL);
 }
 
 void
-Music::set_immutable_mus_property (SCM s, SCM v)
-{
-  immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
-  mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
-}
-void
-Music::set_mus_property (SCM s, SCM v)
+Music::transpose (Pitch delta)
 {
-  mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
+  if (to_boolean (get_property ("untransposable")))
+    return;
+
+  mutable_property_alist_ = transpose_mutable (mutable_property_alist_, delta);
 }
 
 void
 Music::set_spot (Input ip)
 {
-   set_mus_property ("origin", make_input (ip));
+  set_property ("origin", make_input (ip));
 }
 
-
-
-Input*
+Input *
 Music::origin () const
 {
-  Input *ip = unsmob_input (get_mus_property ("origin"));
-  return ip ? ip : & dummy_input_global; 
+  Input *ip = unsmob_input (get_property ("origin"));
+  return ip ? ip : &dummy_input_global;
 }
 
-
-
-
-
-Music::~Music ()
-{
-  
-}
-
-SCM
-ly_get_mus_property (SCM mus, SCM sym)
+/*
+  ES TODO: This method should probably be reworked or junked.
+*/
+Stream_event *
+Music::to_event () const
 {
-  Music * sc = unsmob_music (mus);
-  
-  if (sc)
+  /* UGH. Temp hack */
+  SCM orig_sym = get_property ("name");
+  char out[200];
+  string in = ly_symbol2string (orig_sym);
+  /* don't add '-' before first character */
+  out[0] = tolower (in[0]);
+  size_t outpos = 1;
+  for (size_t inpos = 1; inpos < in.size () && outpos < 190; inpos++)
     {
-      return sc->get_mus_property (sym);
+      if (isupper (in[inpos]))
+       out[outpos++] = '-';
+      out[outpos++] = tolower (in[inpos]);      
     }
-  else
+  out[outpos] = 0;
+  SCM class_name = ly_symbol2scm (out);
+
+  // catch mistakes.
+  if (!internal_is_music_type (class_name))
     {
-      warning (_ ("ly_get_mus_property (): Not a Music"));
-      scm_write (mus, scm_current_error_port ());
+      programming_error ("Not a music type");
     }
-  return SCM_EOL;
-}
 
+  Stream_event *e = new Stream_event (class_name, mutable_property_alist_);
+  Moment length = get_length ();
+  if (length.to_bool ())
+    e->set_property ("length", length.smobbed_copy ());
+
+  /*
+    ES TODO: This is a temporary fix. Stream_events should not be
+    aware of music.
+  */
+  e->set_property ("music-cause", self_scm ());
+  return e;
+}
 
-SCM
-ly_set_mus_property (SCM mus, SCM sym, SCM val)
+void
+Music::send_to_context (Context *c)
 {
-  Music * sc = unsmob_music (mus);
-
-  if (!gh_symbol_p (sym))
-    {
-      warning (_ ("ly_set_mus_property (): Not a symbol"));
-      scm_write (mus, scm_current_error_port ());      
-
-      return SCM_UNSPECIFIED;
-    }
+  /*
+    TODO: This is a work-in-progress solution. Send the event so it
+    can be read both by old-style translators and the new ones.
+  */
+  send_stream_event (c, "OldMusicEvent", origin (),
+                    ly_symbol2scm("music"), self_scm (), 0);
+
+  Stream_event *ev = to_event ();
+  c->event_source ()->broadcast (ev);
+  ev->unprotect ();
+}
 
-  if (sc)
-    {
-      sc->set_mus_property (sym, val);
-    }
-  else
-    {
-      warning (_ ("ly_set_mus_property ():  not of type Music"));
-      scm_write (mus, scm_current_error_port ());
-    }
+Music *
+make_music_by_name (SCM sym)
+{
+  SCM make_music_proc = ly_lily_module_constant ("make-music");
+  SCM rv = scm_call_1 (make_music_proc, sym);
 
-  return SCM_UNSPECIFIED;
+  /* UGH. */
+  Music *m = unsmob_music (rv);
+  m->protect ();
+  return m;
 }
 
-
-// to do  property args 
+MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
 SCM
-ly_make_music (SCM type)
+Music::duration_length_callback (SCM m)
 {
-  if (!gh_string_p (type))
-    {
-      warning (_ ("ly_make_music (): Not a string"));
-      scm_write (type, scm_current_error_port ());      
+  Music *me = unsmob_music (m);
+  Duration *d = unsmob_duration (me->get_property ("duration"));
 
-      return SCM_UNSPECIFIED;
-    }
-  else
-    {
-      SCM s =       get_music (ly_scm2string (type))->self_scm ();
-      scm_unprotect_object (s);
-      return s;
-    }
+  Moment mom;
+  if (d)
+    mom = d->get_length ();
+  return mom.smobbed_copy ();
 }
 
-static void
-init_functions ()
+Music *
+unsmob_music (SCM m)
 {
-  scm_make_gsubr ("ly-get-mus-property", 2, 0, 0, (Scheme_function_unknown)ly_get_mus_property);
-  scm_make_gsubr ("ly-set-mus-property", 3, 0, 0, (Scheme_function_unknown)ly_set_mus_property);
-  scm_make_gsubr ("ly-make-music", 1, 0, 0, (Scheme_function_unknown)ly_make_music);  
+  return dynamic_cast<Music*> (unsmob_prob (m));
 }
-ADD_SCM_INIT_FUNC (musicscm,init_functions);
+