2 music-scheme.cc -- implement Music bindings
4 source file of the GNU LilyPond music typesetter
6 (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
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, 0, 0, (SCM mus, SCM sym),
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 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
32 return sc->internal_get_property (sym);
35 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
36 3, 0, 0, (SCM mus, SCM sym, SCM val),
37 "Set property @var{sym} in music expression @var{mus} to @var{val}.")
39 Music *sc = unsmob_music (mus);
40 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
41 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
43 bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
46 sc->internal_set_property (sym, val);
49 return SCM_UNSPECIFIED;
52 LY_DEFINE (ly_music_name, "ly:music-name",
54 "Return the name of @var{music}.")
56 Music *m = unsmob_music (mus);
57 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
59 char const *nm = classname (m);
60 return scm_makfrom0str (nm);
63 /* todo: property args */
64 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
65 2, 0, 0, (SCM type, SCM props),
66 "Make a C++ music object of type @var{type}, initialize with\n"
69 "This function is for internal use, and is only called by "
70 "@code{make-music}, which is the preferred interface "
71 "for creating music objects. ")
73 SCM_ASSERT_TYPE (scm_is_string (type), type, SCM_ARG1, __FUNCTION__, "string");
74 SCM s = make_music (ly_scm2string (type), props)->self_scm ();
75 scm_gc_unprotect_object (s);
79 /* todo: property args */
80 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
82 "Return an alist containing the mutable properties of @var{mus}.\n"
83 "The immutable properties are not available, since "
84 "they are constant and initialized by the "
85 "@code{make-music} function.\n")
87 Music *m = unsmob_music (mus);
88 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
89 return m->get_property_alist (true);
92 LY_DEFINE (ly_music_list_p, "ly:music-list?",
94 "Type predicate: return true if @var{lst} is a list "
97 if (scm_list_p (lst) == SCM_BOOL_T)
98 while (scm_is_pair (lst))
100 if (!unsmob_music (scm_car (lst)))
108 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
110 "Copy @var{m} and all sub expressions of @var{m}")
113 if (unsmob_music (m))
115 copy = unsmob_music (m)->clone ()->self_scm ();
116 scm_gc_unprotect_object (copy);
118 else if (scm_is_pair (m))
119 copy = scm_cons (ly_music_deep_copy (scm_car (m)),
120 ly_music_deep_copy (scm_cdr (m)));
124 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
125 2, 0, 0, (SCM m, SCM p),
126 "Transpose @var{m} such that central C is mapped to @var{p}. "
129 Music *sc = unsmob_music (m);
130 Pitch *sp = unsmob_pitch (p);
131 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
132 SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
136 return sc->self_scm ();
140 TODO: should take moment factor?
142 LY_DEFINE (ly_music_compress, "ly:music-compress",
143 2, 0, 0, (SCM m, SCM factor),
144 "Compress music object @var{m} by moment @var{factor}.")
146 Music *sc = unsmob_music (m);
148 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
149 SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
151 sc->compress (*unsmob_moment (factor));
152 return sc->self_scm ();
155 LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0,
157 "Extract the duration field from @var{mus}, and return the length.")
159 Music *m = unsmob_music (mus);
160 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
162 Duration *d = unsmob_duration (m->get_property ("duration"));
166 len = d->get_length ();
168 programming_error ("music has no duration");
169 return len.smobbed_copy ();
172 LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0,
174 "Compress @var{mus} by factor @var{fact}, which is a @code{Moment}.")
176 Music *m = unsmob_music (mus);
177 Moment *f = unsmob_moment (fact);
178 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
179 SCM_ASSERT_TYPE (f, fact, SCM_ARG2, __FUNCTION__, "Moment");
181 Duration *d = unsmob_duration (m->get_property ("duration"));
183 m->set_property ("duration", d->compressed (f->main_part_).smobbed_copy ());
184 return SCM_UNSPECIFIED;
188 This is hairy, since the scale in a key-change event may contain
192 TODO: this should use ly:pitch.
194 LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist",
195 2, 0, 0, (SCM l, SCM pit),
196 "Make a new key alist of @var{l} transposed by pitch @var{pit}")
198 SCM newlist = SCM_EOL;
199 Pitch *p = unsmob_pitch (pit);
201 for (SCM s = l; scm_is_pair (s); s = scm_cdr (s))
203 SCM key = scm_caar (s);
204 SCM alter = scm_cdar (s);
205 if (scm_is_pair (key))
207 Pitch orig (scm_to_int (scm_car (key)),
208 scm_to_int (scm_cdr (key)),
211 orig = orig.transposed (*p);
213 SCM key = scm_cons (scm_int2num (orig.get_octave ()),
214 scm_int2num (orig.get_notename ()));
216 newlist = scm_cons (scm_cons (key, scm_int2num (orig.get_alteration ())),
219 else if (scm_is_number (key))
221 Pitch orig (0, scm_to_int (key), scm_to_int (alter));
222 orig = orig.transposed (*p);
224 key = scm_int2num (orig.get_notename ());
225 alter = scm_int2num (orig.get_alteration ());
226 newlist = scm_cons (scm_cons (key, alter), newlist);
229 return scm_reverse_x (newlist, SCM_EOL);