2 music-scheme.cc -- implement Music bindings
4 source file of the GNU LilyPond music typesetter
6 (c) 2005--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
11 #include "duration.hh"
14 LY_DEFINE (ly_music_length, "ly:music-length",
16 "Get the length of music expression @var{mus} and return"
17 " it as a @code{Moment} object.")
19 LY_ASSERT_TYPE (unsmob_music, mus, 1);
20 Music *sc = unsmob_music (mus);
21 return sc->get_length ().smobbed_copy ();
24 LY_DEFINE (ly_music_property, "ly:music-property",
25 2, 1, 0, (SCM mus, SCM sym, SCM val),
26 "Return the value for property @var{sym} of music expression"
27 " @var{mus}. If no value is found, return @var{val} or"
28 " @code{'()} if @var{val} is not specified.")
30 LY_ASSERT_TYPE (unsmob_music, mus, 1);
31 return ly_prob_property (mus, sym, val);
34 LY_DEFINE (ly_music_set_property_x, "ly:music-set-property!",
35 3, 0, 0, (SCM mus, SCM sym, SCM val),
36 "Set property @var{sym} in music expression @var{mus} to"
39 LY_ASSERT_TYPE (unsmob_music, mus, 1);
41 return ly_prob_set_property_x (mus, sym, val);
45 /* todo: property args */
46 LY_DEFINE (ly_make_music, "ly:make-music",
48 "Make a C++ @code{Music} object and initialize it with"
51 "This function is for internal use and is only called by"
52 " @code{make-music}, which is the preferred interface"
53 " for creating music objects.")
55 Music *ms = new Music (props);
56 return ms->unprotect ();
59 LY_DEFINE (ly_music_p, "ly:music?",
63 return scm_from_bool (unsmob_music (obj));
66 /* todo: property args */
67 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
69 "Return an alist containing the mutable properties of @var{mus}."
70 " The immutable properties are not available, since they are"
71 " constant and initialized by the @code{make-music} function.")
73 LY_ASSERT_TYPE (unsmob_music, mus, 1);
74 Music *m = unsmob_music (mus);
75 return m->get_property_alist (true);
78 LY_DEFINE (ly_music_list_p, "ly:music-list?",
80 "Type predicate: Return true if @var{lst} is a list"
83 if (scm_list_p (lst) == SCM_BOOL_T)
84 while (scm_is_pair (lst))
86 if (!unsmob_music (scm_car (lst)))
94 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
96 "Copy @var{m} and all sub expressions of@tie{}@var{m}.")
101 Music *mcopy = unsmob_music (m)->clone ();
102 copy = mcopy->unprotect ();
104 else if (scm_is_pair (m))
105 copy = scm_cons (ly_music_deep_copy (scm_car (m)),
106 ly_music_deep_copy (scm_cdr (m)));
110 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
111 2, 0, 0, (SCM m, SCM p),
112 "Transpose @var{m} such that central@tie{}C is mapped"
113 " to@tie{}@var{p}. Return@tie{}@var{m}.")
115 LY_ASSERT_TYPE (unsmob_music, m, 1);
116 LY_ASSERT_SMOB (Pitch, p, 2);
118 Music *sc = unsmob_music (m);
119 Pitch *sp = unsmob_pitch (p);
123 return sc->self_scm ();
127 TODO: should take moment factor?
129 LY_DEFINE (ly_music_compress, "ly:music-compress",
130 2, 0, 0, (SCM m, SCM factor),
131 "Compress music object@tie{}@var{m} by moment @var{factor}.")
133 LY_ASSERT_TYPE (unsmob_music, m, 1);
134 LY_ASSERT_TYPE (unsmob_moment, factor, 2);
136 Music *sc = unsmob_music (m);
137 sc->compress (*unsmob_moment (factor));
138 return sc->self_scm ();
141 LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0,
143 "Extract the duration field from @var{mus} and return the"
146 LY_ASSERT_TYPE (unsmob_music, mus, 1);
147 Music *m = unsmob_music (mus);
149 Duration *d = unsmob_duration (m->get_property ("duration"));
153 len = d->get_length ();
155 programming_error ("music has no duration");
156 return len.smobbed_copy ();
159 LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0,
161 "Compress @var{mus} by factor @var{fact}, which is a"
164 LY_ASSERT_TYPE (unsmob_music, mus, 1);
165 LY_ASSERT_SMOB (Moment, fact, 2);
167 Music *m = unsmob_music (mus);
168 Moment *f = unsmob_moment (fact);
170 Duration *d = unsmob_duration (m->get_property ("duration"));
172 m->set_property ("duration", d->compressed (f->main_part_).smobbed_copy ());
173 return SCM_UNSPECIFIED;
177 This is hairy, since the scale in a key-change event may contain
181 TODO: this should use ly:pitch.
183 LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist",
184 2, 0, 0, (SCM l, SCM pit),
185 "Make a new key alist of@tie{}@var{l} transposed by"
188 SCM newlist = SCM_EOL;
189 Pitch *p = unsmob_pitch (pit);
191 for (SCM s = l; scm_is_pair (s); s = scm_cdr (s))
193 SCM key = scm_caar (s);
194 SCM alter = scm_cdar (s);
195 if (scm_is_pair (key))
197 Pitch orig (scm_to_int (scm_car (key)),
198 scm_to_int (scm_cdr (key)),
199 ly_scm2rational (alter));
201 orig = orig.transposed (*p);
203 SCM key = scm_cons (scm_from_int (orig.get_octave ()),
204 scm_from_int (orig.get_notename ()));
206 newlist = scm_cons (scm_cons (key, ly_rational2scm (orig.get_alteration ())),
209 else if (scm_is_number (key))
211 Pitch orig (0, scm_to_int (key), ly_scm2rational (alter));
212 orig = orig.transposed (*p);
214 key = scm_from_int (orig.get_notename ());
215 alter = ly_rational2scm (orig.get_alteration ());
216 newlist = scm_cons (scm_cons (key, alter), newlist);
219 return scm_reverse_x (newlist, SCM_EOL);