]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/music.cc
Doc-de: fixing linkage
[lilypond.git] / lily / music.cc
index 1c2deb27977c3901025fe378338275fb4ecee69e..cc6281addcb326eaca53aff577580e51c5a5c48f 100644 (file)
 /*
-  music.cc -- implement Music
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 #include "music.hh"
-#include "music-list.hh"
-#include "debug.hh"
-#include "musical-pitch.hh"
 
-Music::Music()
+#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 "score.hh"
+#include "warn.hh"
+
+/*
+  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
 {
+  SCM ifs = get_property ("types");
+
+  return scm_c_memq (k, ifs) != SCM_BOOL_F;
 }
 
-void    
-Music::compress (Moment)
+Music::Music (SCM init)
+  : Prob (ly_symbol2scm ("Music"), init)
 {
+  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");
 }
 
 void
-Music::do_print() const
+Music::derived_mark () const
 {
+  scm_gc_mark (length_callback_);
+  scm_gc_mark (start_callback_);
 }
 
-Moment
-Music::length_mom () const
+SCM
+Music::copy_mutable_properties () const
 {
-  return 0;
+  return ly_music_deep_copy (mutable_property_alist_);
 }
 
 void
-Music::print() const
+Music::type_check_assignment (SCM s, SCM v) const
 {
-#ifndef NPRINT
-  if (! check_debug)
-    return ;
-  DOUT << classname(this) << "{";
-  if  (translator_type_str_.length_i ())
-    DOUT << translator_type_str_ << " = " << translator_id_str_;
-  do_print();
-  DOUT << "}\n";
-#endif
+  ::type_check_assignment (s, v, ly_symbol2scm ("music-type?"));
 }
 
-Musical_pitch
-Music::to_relative_octave (Musical_pitch m)
+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::start_mom () const
 {
+  SCM lst = start_callback_;
+  if (ly_is_procedure (lst))
+    {
+      SCM res = scm_call_1 (lst, self_scm ());
+      return *unsmob_moment (res);
+    }
+
+  Moment m;
   return m;
 }
 
 void
-Music::transpose (Musical_pitch )
+print_alist (SCM a, SCM port)
+{
+  /* SCM_EOL  -> catch malformed lists.  */
+  for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
+    {
+      scm_display (scm_caar (s), port);
+      scm_puts (" = ", port);
+      scm_write (scm_cdar (s), port);
+      scm_puts ("\n", port);
+    }
+}
+
+Pitch
+Music::generic_to_relative_octave (Pitch last)
+{
+  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 ());
+}
+
+/*
+  This mutates alist.  Hence, make sure that it is not shared
+*/
+void
+transpose_mutable (SCM alist, Pitch delta)
+{
+  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);
+      SCM new_val = val;
+
+      if (Pitch *p = unsmob_pitch (val))
+        {
+          Pitch transposed = p->transposed (delta);
+          if (transposed.get_alteration ().abs () > Rational (1, 1))
+            {
+              string delta_str;
+              if (delta.get_alteration ().abs () > Rational (1, 1))
+                delta_str = (delta.normalized ().to_string ()
+                             + " " + _ ("(normalized pitch)"));
+              else
+                delta_str = delta.to_string ();
+
+              warning (_f ("Transposing %s by %s makes alteration larger than double",
+                           p->to_string (),
+                           delta_str));
+              transposed = transposed.normalized ();
+            }
+
+          new_val = transposed.smobbed_copy ();
+        }
+      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))
+        new_val = ly_transpose_key_alist (val, delta.smobbed_copy ());
+
+      if (val != new_val)
+        scm_set_cdr_x (entry, new_val);
+    }
+}
+
+void
+Music::transpose (Pitch delta)
+{
+  if (to_boolean (get_property ("untransposable")))
+    return;
+
+  transpose_mutable (mutable_property_alist_, delta);
+}
+
+void
+Music::set_spot (Input ip)
+{
+  set_property ("origin", make_input (ip));
+}
+
+Input *
+Music::origin () const
+{
+  Input *ip = unsmob_input (get_property ("origin"));
+  return ip ? ip : &dummy_input_global;
+}
+
+/*
+  ES TODO: This method should probably be reworked or junked.
+*/
+Stream_event *
+Music::to_event () const
+{
+  SCM class_name = ly_camel_case_2_lisp_identifier (get_property ("name"));
+
+  // catch programming mistakes.
+  if (!internal_is_music_type (class_name))
+    programming_error ("Not a music type");
+
+  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 ());
+
+  // articulations as events.
+  SCM art_mus = e->get_property ("articulations");
+  if (scm_is_pair (art_mus))
+    {
+      SCM art_ev = SCM_EOL;
+      for (; scm_is_pair (art_mus); art_mus = scm_cdr (art_mus))
+        {
+          Music *m = unsmob_music (scm_car (art_mus));
+          SCM ev = m ? m->to_event ()->unprotect () : scm_car (art_mus);
+          art_ev = scm_cons (ev, art_ev);
+        }
+      e->set_property ("articulations", scm_reverse_x (art_ev, SCM_EOL));
+    }
+
+  /*
+    ES TODO: This is a temporary fix. Stream_events should not be
+    aware of music.
+  */
+  e->set_property ("music-cause", self_scm ());
+
+  return e;
+}
+
+void
+Music::send_to_context (Context *c)
 {
+  Stream_event *ev = to_event ();
+  c->event_source ()->broadcast (ev);
+  ev->unprotect ();
 }
 
+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);
+
+  /* UGH. */
+  Music *m = unsmob_music (rv);
+  m->protect ();
+  return m;
+}
+
+MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
+SCM
+Music::duration_length_callback (SCM m)
+{
+  Music *me = unsmob_music (m);
+  Duration *d = unsmob_duration (me->get_property ("duration"));
+
+  Moment mom;
+  if (d)
+    mom = d->get_length ();
+  return mom.smobbed_copy ();
+}
+
+Music *
+unsmob_music (SCM m)
+{
+  return dynamic_cast<Music *> (unsmob_prob (m));
+}