]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/music.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / music.cc
index fefeda054dbe86d8beeba3a5a3aaa94fab817a57..02a9876b1c2f6779f1df43b5ff11b63170bf4293 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2004 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 "ly-smobs.icc"
 
+#include "context.hh"
+#include "dispatcher.hh"
+#include "duration.hh"
+#include "input-smob.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);
+/*
+  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
+Music::internal_is_music_type (SCM k) const
 {
-  SCM ifs = get_mus_property ("types");
+  SCM ifs = get_property ("types");
 
-  return scm_memq (k, ifs) != SCM_BOOL_F;
+  return scm_c_memq (k, ifs) != SCM_BOOL_F;
 }
 
-String
-Music::name () const
+Music::Music (SCM init)
+  : Prob (ly_symbol2scm ("Music"), init)
 {
-  SCM nm = get_mus_property ("name");
-  if (gh_symbol_p (nm))
-    {
-      return ly_symbol2string (nm);
-    }
-  else
-    {
-      return classname (this);
-    }
-}
-
+  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;
 
+  start_callback_ = get_property ("start-callback");
+}
 
-Music::Music (Music const &m)
+void
+Music::derived_mark () const
 {
-  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.
-   */
-  smobify_self ();
-  mutable_property_alist_ = ly_deep_mus_copy (m.mutable_property_alist_);
-  set_spot (*m.origin ());
+  scm_gc_mark (length_callback_);
+  scm_gc_mark (start_callback_);
 }
 
-Music::Music ()
+SCM
+Music::copy_mutable_properties () const
 {
-  self_scm_ = SCM_EOL;
-  immutable_property_alist_ = SCM_EOL;
-  mutable_property_alist_ = SCM_EOL;
-  smobify_self ();
+  return ly_music_deep_copy (mutable_property_alist_);
 }
 
-SCM
-Music::get_property_alist (bool m) const
+void
+Music::type_check_assignment (SCM s, SCM v) const
 {
-  return (m) ? mutable_property_alist_ : immutable_property_alist_;
+  if (!::type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
+    abort ();
 }
 
-SCM
-Music::mark_smob (SCM m)
+Music::Music (Music const &m)
+  : Prob (m)
 {
-  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;
+  length_callback_ = m.length_callback_;
+  start_callback_ = m.start_callback_;
+
+  /// why? 
+  set_spot (*m.origin ());
 }
 
 Moment
 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; gh_pair_p (s); 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);
     }
 }
 
-int
-Music::print_smob (SCM s, SCM p, scm_print_state*)
-{
-  scm_puts ("#<Music ", p);
-  Music* m = unsmob_music (s);
 
-  SCM nm = m->get_mus_property ("name");
-  if (gh_symbol_p (nm) || gh_string_p (nm))
-    {
-      scm_display (nm, p);
-    }
-  else
+Pitch
+Music::generic_to_relative_octave (Pitch last)
+{
+  SCM elt = get_property ("element");
+  Pitch *old_pit = unsmob_pitch (get_property ("pitch"));
+  if (old_pit)
     {
-      scm_puts (classname (m),p);
+      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;
     }
-  
-  /*
-    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;
+  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 p)
+Music::to_relative_octave (Pitch last)
 {
-  SCM elt = get_mus_property ("element");
-
-  if (Music* m = unsmob_music (elt))
-    p = m->to_relative_octave (p);
+  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;
+    }
 
-  p = music_list_to_relative (get_mus_property ("elements"),
-                             p, false);
-  return p;
+  return generic_to_relative_octave (last);
 }
 
 void
 Music::compress (Moment factor)
 {
-  SCM elt = get_mus_property ("element");
+  SCM elt = get_property ("element");
 
-  if (Musicm = unsmob_music (elt))
+  if (Music *m = unsmob_music (elt))
     m->compress (factor);
 
-  compress_music_list (get_mus_property ("elements"), 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)
 {
-  SCM elt = get_mus_property ("element");
-
-  if (Music* m = unsmob_music (elt))
-    m->transpose (delta);
-
-  transpose_music_list (get_mus_property ("elements"), delta);
-}
-
-
-IMPLEMENT_TYPE_P (Music, "ly:music?");
+  if (to_boolean (get_property ("untransposable")))
+    return;
 
-IMPLEMENT_SMOBS (Music);
-IMPLEMENT_DEFAULT_EQUAL_P (Music);
+  for (SCM s = this->get_property_alist (true); scm_is_pair (s); s = scm_cdr (s))
+    {
+      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 ()));
+           }
+       }
+    }
 
-/****************************/
+  SCM elt = get_property ("element");
 
-SCM
-Music::internal_get_mus_property (SCM sym) const
-{
-  SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
-  if (s != SCM_BOOL_F)
-    return ly_cdr (s);
+  if (Music *m = unsmob_music (elt))
+    m->transpose (delta);
 
-  s = scm_sloppy_assq (sym, immutable_property_alist_);
-  return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s); 
-}
+  transpose_music_list (get_property ("elements"), delta);
 
-void
-Music::internal_set_mus_property (SCM s, SCM v)
-{
-  if (internal_type_checking_global_b)
-    if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
-      abort ();
-
-  mutable_property_alist_ =  scm_assq_set_x (mutable_property_alist_, s, v);
+  /*
+    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 ()));
 }
 
-#include "main.hh"
-
 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; 
-}
-
-
-Music::~Music ()
-{
-  
-}
-
-LY_DEFINE(ly_music_length,
-         "ly:music-length", 1, 0, 0,  (SCM mus),
-         "Get the length (in musical time) of music expression @var{mus}.")
-{
-  Music * sc = unsmob_music (mus);
-  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
-  return sc->get_length().smobbed_copy();
-}
-
-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}.\n"
-         "If @var{sym} is undefined, return @code{'()}.\n" )
-{
-  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);
-}
-
-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}.")
-{
-  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");  
-
-  bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
-  if (ok)
-    {
-      sc->internal_set_mus_property (sym, val);
-    }
-    
-  return SCM_UNSPECIFIED;
-}
-
-
-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);
-}
-
-
-
-// to do  property args 
-LY_DEFINE(ly_extended_make_music,
-         "ly:make-bare-music", 2, 0, 0,  (SCM type, SCM props),
-         "Make a music object/expression of type @var{type}, init with\n"
-"@var{props}. Warning: this interface will likely change in the near\n"
-"future.\n"
-"\n"
-"Music is the data type that music expressions are stored in. The data\n"
-"type does not yet offer many manipulations.\n"
-"\n"
-"WARNING: only for internal use. Please use make-music-by-name. \n"
-)
-{
-  SCM_ASSERT_TYPE(gh_string_p (type), type, SCM_ARG1, __FUNCTION__, "string");
-
-  SCM s = make_music (ly_scm2string (type))->self_scm ();
-  unsmob_music (s)->immutable_property_alist_ = props;
-  scm_gc_unprotect_object (s);
-  return s;
+  Input *ip = unsmob_input (get_property ("origin"));
+  return ip ? ip : &dummy_input_global;
 }
 
-// to do  property args 
-LY_DEFINE(ly_get_mutable_properties,
-         "ly:get-mutable-properties", 1, 0, 0,  (SCM mus),
-"Return an alist signifying the mutable properties of @var{mus}.\n"
-"The immutable properties are not available; they should be initialized\n"
-"by the functions make-music-by-name function.\n"
-)
+void
+Music::send_to_context (Context *c)
 {
-  Music *m = unsmob_music (mus);
-  SCM_ASSERT_TYPE(m, mus, SCM_ARG1, __FUNCTION__, "music");
-
-  return m->get_property_alist (true);
+  send_stream_event (c, "MusicEvent",
+                    ly_symbol2scm("music"), self_scm (), 0);
 }
 
-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.")
+Music *
+make_music_by_name (SCM sym)
 {
-  if (scm_list_p (l) != SCM_BOOL_T)
-    return SCM_BOOL_F;
-
-  while (gh_pair_p (l))
-    {
-      if (!unsmob_music (gh_car (l)))
-       return SCM_BOOL_F;
-      l =gh_cdr (l);
-    }
-  return SCM_BOOL_T;
-}
-ADD_MUSIC(Music);
-
-
+  SCM make_music_proc = ly_lily_module_constant ("make-music");
+  SCM rv = scm_call_1 (make_music_proc, sym);
 
-LY_DEFINE(ly_deep_mus_copy,
-         "ly:music-deep-copy", 1,0,0, (SCM m),
-         "Copy @var{m} and all sub expressions of @var{m}")
-{
-  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;
+  /* UGH. */
+  Music *m = unsmob_music (rv);
+  m->protect ();
+  return m;
 }
 
-LY_DEFINE(ly_music_transpose,
-         "ly:music-transpose", 2,0,0, (SCM m, SCM p),
-         "Transpose @var{m} such that central C is mapped to @var{p}. "
-"Return @var{m}.")
+MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
+SCM
+Music::duration_length_callback (SCM m)
 {
-  Music * sc = unsmob_music (m);
-  Pitch * sp = unsmob_pitch (p);
-  SCM_ASSERT_TYPE(sc, m, SCM_ARG1, __FUNCTION__, "music");
-  SCM_ASSERT_TYPE(sp, p, SCM_ARG2, __FUNCTION__, "pitch");
+  Music *me = unsmob_music (m);
+  Duration *d = unsmob_duration (me->get_property ("duration"));
 
-  sc->transpose (*sp);
-  return sc->self_scm();       // SCM_UNDEFINED ? 
+  Moment mom;
+  if (d)
+    mom = d->get_length ();
+  return mom.smobbed_copy ();
 }
 
-
-SCM make_music_proc;
-
-
-Music*
-make_music_by_name (SCM sym)
+Music *
+unsmob_music (SCM m)
 {
-  if (!make_music_proc)
-    make_music_proc = scm_primitive_eval (ly_symbol2scm ("make-music-by-name"));
-       
-  SCM rv = scm_call_1 (make_music_proc, sym);
-
-  /*
-    UGH.
-  */
-  scm_gc_protect_object (rv);
-  return unsmob_music (rv);
+  return dynamic_cast<Music*> (unsmob_prob (m));
 }