source file of the GNU LilyPond music typesetter
- (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
+#include "music.hh"
+
+#include "context.hh"
+#include "dispatcher.hh"
#include "duration.hh"
-#include "input-smob.hh"
+#include "input.hh"
+#include "international.hh"
#include "ly-smobs.icc"
#include "main.hh"
-#include "music-list.hh"
-#include "music.hh"
-#include "pitch.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
{
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_property ("name");
- if (scm_is_symbol (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;
-Music::Music ()
-{
- self_scm_ = SCM_EOL;
- immutable_property_alist_ = SCM_EOL;
- mutable_property_alist_ = SCM_EOL;
- smobify_self ();
+ 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_music_deep_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
{
+ return ly_music_deep_copy (mutable_property_alist_);
}
-ADD_MUSIC (Music);
-
-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_;
+ ::type_check_assignment (s, v, ly_symbol2scm ("music-type?"));
}
-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
SCM lst = get_property ("length");
if (unsmob_moment (lst))
return *unsmob_moment (lst);
- else if (ly_c_procedure_p (lst))
+
+ if (ly_is_procedure (length_callback_))
{
- SCM res = scm_call_1 (lst, 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 lst = get_property ("start-moment-function");
- if (ly_c_procedure_p (lst))
+ SCM lst = start_callback_;
+ if (ly_is_procedure (lst))
{
SCM res = scm_call_1 (lst, self_scm ());
return *unsmob_moment (res);
}
}
-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 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 nm = m->get_property ("name");
- if (scm_is_symbol (nm) || scm_is_string (nm))
- scm_display (nm, p);
- else
- scm_puts (classname (m),p);
+ 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;
+ }
- /* Printing properties takes a lot of time, especially during backtraces.
- For inspecting, it is better to explicitly use an inspection
- function. */
+ set_property ("pitch", new_pit.smobbed_copy ());
- scm_puts (">",p);
- return 1;
+ 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 p)
+Music::to_relative_octave (Pitch last)
{
- SCM elt = get_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_property ("elements"), p, false);
- return p;
+ return generic_to_relative_octave (last);
}
void
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
-Music::transpose (Pitch delta)
+transpose_mutable (SCM alist, Pitch delta)
{
- for (SCM s = this->get_property_alist (true); scm_is_pair (s); s = scm_cdr (s))
+ 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))
+ SCM new_val = val;
+
+ 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)
+ Pitch transposed = p->transposed (delta);
+ if (transposed.get_alteration ().abs () > Rational (1,1))
{
- warning (_f ("Transposition by %s makes alteration larger than two",
+ warning (_f ("transposition by %s makes alteration larger than double",
delta.to_string ()));
}
+
+ 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);
}
-
- SCM elt = get_property ("element");
-
- if (Music* m = unsmob_music (elt))
- m->transpose (delta);
-
- transpose_music_list (get_property ("elements"), delta);
-}
-
-IMPLEMENT_TYPE_P (Music, "ly:music?");
-IMPLEMENT_SMOBS (Music);
-IMPLEMENT_DEFAULT_EQUAL_P (Music);
-
-SCM
-Music::internal_get_property (SCM sym) const
-{
- SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
- if (s != SCM_BOOL_F)
- return scm_cdr (s);
-
- s = scm_sloppy_assq (sym, immutable_property_alist_);
- return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
}
void
-Music::internal_set_property (SCM s, SCM v)
+Music::transpose (Pitch delta)
{
- if (internal_type_checking_global_b)
- if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
- abort ();
+ if (to_boolean (get_property ("untransposable")))
+ return;
- mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
+ transpose_mutable (mutable_property_alist_, delta);
}
void
set_property ("origin", make_input (ip));
}
-Input*
+Input *
Music::origin () const
{
Input *ip = unsmob_input (get_property ("origin"));
- return ip ? ip : & dummy_input_global;
-}
-
-int
-Music::duration_log () const
-{
- if (is_mus_type ("rhythmic-event"))
- return unsmob_duration (get_property ("duration"))->duration_log ();
- return 0;
-}
-
-Music*
-make_music_by_name (SCM sym)
-{
- SCM make_music_proc = ly_scheme_function ("make-music");
- SCM rv = scm_call_1 (make_music_proc, sym);
-
- /* UGH. */
- scm_gc_protect_object (rv);
- return unsmob_music (rv);
+ return ip ? ip : &dummy_input_global;
}
-LY_DEFINE (ly_music_length, "ly:music-length",
- 1, 0, 0, (SCM mus),
- "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
+/*
+ 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");
- return sc->get_length ().smobbed_copy ();
-}
+ SCM class_name = ly_camel_case_2_lisp_identifier (get_property ("name"));
-LY_DEFINE (ly_music_property,
- "ly:music-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 (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
+ // catch programming mistakes.
+ if (!internal_is_music_type (class_name))
+ {
+ programming_error ("Not a music type");
+ }
- return sc->internal_get_property (sym);
-}
+ 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 ());
-LY_DEFINE (ly_music_set_property, "ly:music-set-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 (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
-
- bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
- if (ok)
+ // articulations as events.
+ SCM art_mus = e->get_property ("articulations");
+ if (scm_is_pair (art_mus))
{
- sc->internal_set_property (sym, val);
+ 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));
}
- return SCM_UNSPECIFIED;
-}
+ /*
+ ES TODO: This is a temporary fix. Stream_events should not be
+ aware of music.
+ */
+ e->set_property ("music-cause", self_scm ());
-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");
-
- char const *nm = classname (m);
- return scm_makfrom0str (nm);
+ return e;
}
-/* todo: property args */
-LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
- 2, 0, 0, (SCM type, SCM props),
- "Make a C++ music object of type @var{type}, initialize with\n"
- "@var{props}. \n\n"
- ""
- "This function is for internal use, and is only called by "
- "@code{make-music}, which is the preferred interface "
- "for creating music objects. "
- )
+void
+Music::send_to_context (Context *c)
{
- SCM_ASSERT_TYPE (scm_is_string (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;
+ Stream_event *ev = to_event ();
+ c->event_source ()->broadcast (ev);
+ ev->unprotect ();
}
-/* todo: property args */
-LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
- 1, 0, 0, (SCM mus),
- "Return an alist containing the mutable properties of @var{mus}.\n"
- "The immutable properties are not available, since "
- "they are constant and initialized by the "
- "@code{make-music} function.\n")
+Music *
+make_music_by_name (SCM sym)
{
- Music *m = unsmob_music (mus);
- SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
- return m->get_property_alist (true);
-}
+ SCM make_music_proc = ly_lily_module_constant ("make-music");
+ SCM rv = scm_call_1 (make_music_proc, sym);
-LY_DEFINE (ly_music_list_p,"ly:music-list?",
- 1, 0, 0, (SCM lst),
- "Type predicate: return true if @var{lst} is a list "
- "of music objects.")
-{
- if (scm_list_p (lst) == SCM_BOOL_T)
- while (scm_is_pair (lst))
- {
- if (!unsmob_music (scm_car (lst)))
- return SCM_BOOL_F;
- lst = scm_cdr (lst);
- }
-
- return SCM_BOOL_T;
+ /* UGH. */
+ Music *m = unsmob_music (rv);
+ m->protect ();
+ return m;
}
-LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
- 1, 0, 0, (SCM m),
- "Copy @var{m} and all sub expressions of @var{m}")
+MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
+SCM
+Music::duration_length_callback (SCM m)
{
- SCM copy = m;
- if (unsmob_music (m))
- {
- copy = unsmob_music (m)->clone ()->self_scm ();
- scm_gc_unprotect_object (copy);
- }
- else if (scm_is_pair (m))
- copy = scm_cons (ly_music_deep_copy (scm_car (m)),
- ly_music_deep_copy (scm_cdr (m)));
- return copy;
-}
+ Music *me = unsmob_music (m);
+ Duration *d = unsmob_duration (me->get_property ("duration"));
-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}.")
-{
- 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");
-
- sc->transpose (*sp);
- // SCM_UNDEFINED ?
- return sc->self_scm ();
+ Moment mom;
+ if (d)
+ mom = d->get_length ();
+ return mom.smobbed_copy ();
}
-/*
- TODO: should take moment factor?
- */
-LY_DEFINE (ly_music_compress, "ly:music-compress",
- 2, 0, 0, (SCM m, SCM factor),
- "Compress music object @var{m} by moment @var{factor}."
- )
+Music *
+unsmob_music (SCM m)
{
- Music * sc = unsmob_music (m);
-
- SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
- SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
-
- sc->compress (*unsmob_moment (factor));
- return sc->self_scm ();
+ return dynamic_cast<Music*> (unsmob_prob (m));
}
-LY_DEFINE (ly_music_scorify, "ly:music-scorify",
- 2, 0, 0,
- (SCM music, SCM parser),
- "Return MUSIC encapsulated in SCORE.")
-{
-#if 0
- SCM_ASSERT_TYPE (ly_c_music_p (music), music, SCM_ARG1, __FUNCTION__, "music");
-#endif
- Score *score = new Score;
-
- score->set_music (music, parser);
-
- scm_gc_unprotect_object (score->self_scm ());
- return score->self_scm ();
-}