2 music-scheme.cc -- implement Music bindings
4 source file of the GNU LilyPond music typesetter
6 (c) 2005--2007 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 as a @code{Moment} object.")
18 Music *sc = unsmob_music (mus);
19 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
20 return sc->get_length ().smobbed_copy ();
23 LY_DEFINE (ly_music_property,
24 "ly:music-property", 2, 1, 0, (SCM mus, SCM sym, SCM dfault),
25 "Get the property @var{sym} of music expression @var{mus}.\n"
26 "If @var{sym} is undefined, return @code{'()}.\n")
28 Music *sc = unsmob_music (mus);
29 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
30 return ly_prob_property (mus,sym,dfault);
33 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
34 3, 0, 0, (SCM mus, SCM sym, SCM val),
35 "Set property @var{sym} in music expression @var{mus} to @var{val}.")
37 Music *sc = unsmob_music (mus);
38 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
39 return ly_prob_set_property_x (mus, sym, val);
43 /* todo: property args */
44 LY_DEFINE (ly_make_music, "ly:make-music",
46 "Make a C++ Music object, initialize with\n"
49 "This function is for internal use, and is only called by "
50 "@code{make-music}, which is the preferred interface "
51 "for creating music objects. ")
53 Music *ms = new Music (props);
54 return ms->unprotect ();
57 LY_DEFINE (ly_music_p, "ly:music?",
61 return scm_from_bool (unsmob_music (obj));
64 /* todo: property args */
65 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
67 "Return an alist containing the mutable properties of @var{mus}.\n"
68 "The immutable properties are not available, since "
69 "they are constant and initialized by the "
70 "@code{make-music} function.\n")
72 Music *m = unsmob_music (mus);
73 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
74 return m->get_property_alist (true);
77 LY_DEFINE (ly_music_list_p, "ly:music-list?",
79 "Type predicate: return true if @var{lst} is a list "
82 if (scm_list_p (lst) == SCM_BOOL_T)
83 while (scm_is_pair (lst))
85 if (!unsmob_music (scm_car (lst)))
93 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
95 "Copy @var{m} and all sub expressions of @var{m}")
100 Music *mcopy = unsmob_music (m)->clone ();
101 copy = mcopy->unprotect ();
103 else if (scm_is_pair (m))
104 copy = scm_cons (ly_music_deep_copy (scm_car (m)),
105 ly_music_deep_copy (scm_cdr (m)));
109 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
110 2, 0, 0, (SCM m, SCM p),
111 "Transpose @var{m} such that central C is mapped to @var{p}. "
114 Music *sc = unsmob_music (m);
115 Pitch *sp = unsmob_pitch (p);
116 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
117 SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
121 return sc->self_scm ();
125 TODO: should take moment factor?
127 LY_DEFINE (ly_music_compress, "ly:music-compress",
128 2, 0, 0, (SCM m, SCM factor),
129 "Compress music object @var{m} by moment @var{factor}.")
131 Music *sc = unsmob_music (m);
133 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
134 SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
136 sc->compress (*unsmob_moment (factor));
137 return sc->self_scm ();
140 LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0,
142 "Extract the duration field from @var{mus}, and return the length.")
144 Music *m = unsmob_music (mus);
145 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
147 Duration *d = unsmob_duration (m->get_property ("duration"));
151 len = d->get_length ();
153 programming_error ("music has no duration");
154 return len.smobbed_copy ();
157 LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0,
159 "Compress @var{mus} by factor @var{fact}, which is a @code{Moment}.")
161 Music *m = unsmob_music (mus);
162 Moment *f = unsmob_moment (fact);
163 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
164 SCM_ASSERT_TYPE (f, fact, SCM_ARG2, __FUNCTION__, "Moment");
166 Duration *d = unsmob_duration (m->get_property ("duration"));
168 m->set_property ("duration", d->compressed (f->main_part_).smobbed_copy ());
169 return SCM_UNSPECIFIED;
173 This is hairy, since the scale in a key-change event may contain
177 TODO: this should use ly:pitch.
179 LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist",
180 2, 0, 0, (SCM l, SCM pit),
181 "Make a new key alist of @var{l} transposed by pitch @var{pit}")
183 SCM newlist = SCM_EOL;
184 Pitch *p = unsmob_pitch (pit);
186 for (SCM s = l; scm_is_pair (s); s = scm_cdr (s))
188 SCM key = scm_caar (s);
189 SCM alter = scm_cdar (s);
190 if (scm_is_pair (key))
192 Pitch orig (scm_to_int (scm_car (key)),
193 scm_to_int (scm_cdr (key)),
194 ly_scm2rational (alter));
196 orig = orig.transposed (*p);
198 SCM key = scm_cons (scm_from_int (orig.get_octave ()),
199 scm_from_int (orig.get_notename ()));
201 newlist = scm_cons (scm_cons (key, ly_rational2scm (orig.get_alteration ())),
204 else if (scm_is_number (key))
206 Pitch orig (0, scm_to_int (key), ly_scm2rational (alter));
207 orig = orig.transposed (*p);
209 key = scm_from_int (orig.get_notename ());
210 alter = ly_rational2scm (orig.get_alteration ());
211 newlist = scm_cons (scm_cons (key, alter), newlist);
214 return scm_reverse_x (newlist, SCM_EOL);