/*
- 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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2003 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 "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.hh"
+#include "international.hh"
+#include "main.hh"
+#include "music-sequence.hh"
+#include "score.hh"
+#include "warn.hh"
-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;
-}
+/*
+ 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
+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;
-void
-Music::transpose (Pitch)
-{
+ 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::compress (Moment)
+Music::derived_mark () const
{
+ scm_gc_mark (length_callback_);
+ scm_gc_mark (start_callback_);
}
-Music::Music (Music const &m)
+SCM
+Music::copy_mutable_properties () 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 ());
+ return ly_music_deep_copy (mutable_property_alist_);
}
-Music::Music ()
+void
+Music::type_check_assignment (SCM s, SCM v) const
{
- self_scm_ = SCM_EOL;
- immutable_property_alist_ = SCM_EOL;
- mutable_property_alist_ = SCM_EOL;
- smobify_self ();
+ ::type_check_assignment (s, v, ly_symbol2scm ("music-type?"));
}
-SCM
-Music::get_property_alist (bool m) const
+Music::Music (Music const &m)
+ : Prob (m)
{
- return (m) ? mutable_property_alist_ : immutable_property_alist_;
-}
+ length_callback_ = m.length_callback_;
+ start_callback_ = m.start_callback_;
-SCM
-Music::mark_smob (SCM 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;
+ /// 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 (Moment::is_smob (lst))
+ return *Moment::unsmob (lst);
+
+ if (ly_is_procedure (length_callback_))
{
- SCM res = gh_call1 (l, self_scm ());
- return *unsmob_moment (res);
+ SCM res = scm_call_1 (length_callback_, self_scm ());
+ return *Moment::unsmob (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 ());
- return *unsmob_moment (res);
+ SCM res = scm_call_1 (lst, self_scm ());
+ return *Moment::unsmob (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*)
+Pitch
+Music::generic_to_relative_octave (Pitch last)
{
- 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
+ SCM elt = get_property ("element");
+ Pitch *old_pit = Pitch::unsmob (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 = Music::unsmob (elt))
+ last = m->to_relative_octave (last);
-Pitch
-Music::to_relative_octave (Pitch m)
-{
- return m;
+ (void) music_list_to_relative (get_property ("articulations"), last, true);
+ last = music_list_to_relative (get_property ("elements"), last, false);
+ return last;
}
-
-IMPLEMENT_TYPE_P (Music, "ly:music?");
-
-IMPLEMENT_SMOBS (Music);
-IMPLEMENT_DEFAULT_EQUAL_P (Music);
-
-/****************************/
-
-SCM
-Music::internal_get_mus_property (SCM sym) const
+Pitch
+Music::to_relative_octave (Pitch last)
{
- SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
- if (s != SCM_BOOL_F)
- return ly_cdr (s);
+ SCM callback = get_property ("to-relative-callback");
+ if (ly_is_procedure (callback))
+ {
+ Pitch *p = Pitch::unsmob (scm_call_2 (callback, self_scm (),
+ last.smobbed_copy ()));
+ return *p;
+ }
- s = scm_sloppy_assq (sym, immutable_property_alist_);
- return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s);
+ return generic_to_relative_octave (last);
}
void
-Music::internal_set_mus_property (SCM s, SCM v)
+Music::compress (Moment factor)
{
- 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);
-}
-
+ SCM elt = get_property ("element");
+ if (Music *m = Music::unsmob (elt))
+ m->compress (factor);
-#include "main.hh"
+ compress_music_list (get_property ("elements"), factor);
+ Duration *d = Duration::unsmob (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
-Music::set_spot (Input ip)
+transpose_mutable (SCM alist, Pitch delta)
{
- set_mus_property ("origin", make_input (ip));
+ 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 = Pitch::unsmob (val))
+ {
+ Pitch transposed = p->transposed (delta);
+
+ if (prop == ly_symbol2scm ("tonic"))
+ transposed = Pitch (-1, transposed.get_notename (),
+ transposed.get_alteration ());
+
+ new_val = transposed.smobbed_copy ();
+ }
+ else if (prop == ly_symbol2scm ("element"))
+ {
+ if (Music *m = Music::unsmob (val))
+ m->transpose (delta);
+ }
+ else if (prop == ly_symbol2scm ("elements")
+ || prop == ly_symbol2scm ("articulations"))
+ 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);
+ }
}
-Input*
-Music::origin () const
+void
+Music::transpose (Pitch delta)
{
- Input *ip = unsmob_input (get_mus_property ("origin"));
- return ip ? ip : & dummy_input_global;
-}
+ if (to_boolean (get_property ("untransposable")))
+ return;
-
-Music::~Music ()
-{
-
+ transpose_mutable (mutable_property_alist_, delta);
}
-LY_DEFINE(ly_get_music_length,
- "ly:get-music-length", 1, 0, 0, (SCM mus),
- "Get the length (in musical time) 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");
- return sc->get_length().smobbed_copy();
+ set_property ("origin", ip.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"
- )
+Input *
+Music::origin () const
{
- 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);
+ Input *ip = Input::unsmob (get_property ("origin"));
+ return ip ? ip : &dummy_input_global;
}
-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}.")
+/*
+ ES TODO: This method should probably be reworked or junked.
+*/
+Stream_event *
+Music::to_event () const
{
- 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)
+ 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
+ (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"), 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))
{
- sc->internal_set_mus_property (sym, val);
+ SCM art_ev = SCM_EOL;
+ for (; scm_is_pair (art_mus); art_mus = scm_cdr (art_mus))
+ {
+ Music *m = Music::unsmob (scm_car (art_mus));
+ art_ev = scm_cons (m->to_event ()->unprotect (), art_ev);
+ }
+ e->set_property ("articulations", scm_reverse_x (art_ev, SCM_EOL));
}
-
- 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");
+ /*
+ ES TODO: This is a temporary fix. Stream_events should not be
+ aware of music.
+ */
+ e->set_property ("music-cause", self_scm ());
- SCM s = make_music (ly_scm2string (type))->self_scm ();
- unsmob_music (s)->immutable_property_alist_ = props;
- scm_gc_unprotect_object (s);
- return s;
+ return e;
}
-// 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);
+ Stream_event *ev = to_event ();
+ c->event_source ()->broadcast (ev);
+ ev->unprotect ();
}
-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;
+ SCM make_music_proc = ly_lily_module_constant ("make-music");
+ SCM rv = scm_call_1 (make_music_proc, sym);
- while (gh_pair_p (l))
- {
- if (!unsmob_music (gh_car (l)))
- return SCM_BOOL_F;
- l =gh_cdr (l);
- }
- return SCM_BOOL_T;
+ /* UGH. */
+ Music *m = Music::unsmob (rv);
+ m->protect ();
+ return m;
}
-ADD_MUSIC(Music);
-
-
-SCM make_music_proc;
-
-Music*
-make_music_by_name (SCM sym)
+MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
+SCM
+Music::duration_length_callback (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);
+ Music *me = Music::unsmob (m);
+ Duration *d = Duration::unsmob (me->get_property ("duration"));
- /*
- UGH.
- */
- scm_gc_protect_object (rv);
- return unsmob_music (rv);
+ Moment mom;
+ if (d)
+ mom = d->get_length ();
+ return mom.smobbed_copy ();
}