2 music.cc -- implement Music
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "duration.hh"
12 #include "input-smob.hh"
13 #include "ly-smobs.icc"
15 #include "music-list.hh"
21 Music::internal_is_music_type (SCM k) const
23 SCM ifs = get_property ("types");
25 return scm_c_memq (k, ifs) != SCM_BOOL_F;
31 SCM nm = get_property ("name");
32 if (scm_is_symbol (nm))
34 return ly_symbol2string (nm);
38 return classname (this);
45 immutable_property_alist_ = SCM_EOL;
46 mutable_property_alist_ = SCM_EOL;
50 Music::Music (Music const &m)
52 immutable_property_alist_ = m.immutable_property_alist_;
53 mutable_property_alist_ = SCM_EOL;
56 /* First we smobify_self, then we copy over the stuff. If we don't,
57 stack vars that hold the copy might be optimized away, meaning
58 that they won't be protected from GC. */
60 mutable_property_alist_ = ly_music_deep_copy (m.mutable_property_alist_);
61 set_spot (*m.origin ());
71 Music::get_property_alist (bool m) const
73 return (m) ? mutable_property_alist_ : immutable_property_alist_;
77 Music::mark_smob (SCM m)
79 Music *mus = (Music*) SCM_CELL_WORD_1 (m);
80 scm_gc_mark (mus->immutable_property_alist_);
81 scm_gc_mark (mus->mutable_property_alist_);
86 Music::get_length () const
88 SCM lst = get_property ("length");
89 if (unsmob_moment (lst))
90 return *unsmob_moment (lst);
91 else if (ly_c_procedure_p (lst))
93 SCM res = scm_call_1 (lst, self_scm ());
94 return *unsmob_moment (res);
101 Music::start_mom () const
103 SCM lst = get_property ("start-moment-function");
104 if (ly_c_procedure_p (lst))
106 SCM res = scm_call_1 (lst, self_scm ());
107 return *unsmob_moment (res);
115 print_alist (SCM a, SCM port)
117 /* SCM_EOL -> catch malformed lists. */
118 for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
120 scm_display (scm_caar (s), port);
121 scm_puts (" = ", port);
122 scm_write (scm_cdar (s), port);
123 scm_puts ("\n", port);
128 Music::print_smob (SCM s, SCM p, scm_print_state*)
130 scm_puts ("#<Music ", p);
131 Music* m = unsmob_music (s);
133 SCM nm = m->get_property ("name");
134 if (scm_is_symbol (nm) || scm_is_string (nm))
137 scm_puts (classname (m),p);
139 /* Printing properties takes a lot of time, especially during backtraces.
140 For inspecting, it is better to explicitly use an inspection
148 Music::to_relative_octave (Pitch p)
150 SCM elt = get_property ("element");
152 if (Music *m = unsmob_music (elt))
153 p = m->to_relative_octave (p);
155 p = music_list_to_relative (get_property ("elements"), p, false);
160 Music::compress (Moment factor)
162 SCM elt = get_property ("element");
164 if (Music *m = unsmob_music (elt))
165 m->compress (factor);
167 compress_music_list (get_property ("elements"), factor);
171 Music::transpose (Pitch delta)
173 for (SCM s = this->get_property_alist (true); scm_is_pair (s); s = scm_cdr (s))
175 SCM entry = scm_car (s);
176 SCM val = scm_cdr (entry);
178 if (Pitch * p = unsmob_pitch (val))
180 Pitch transposed = p->transposed (delta);
181 scm_set_cdr_x (entry, transposed.smobbed_copy ());
183 if (abs (transposed.get_alteration ()) > DOUBLE_SHARP)
185 warning (_f ("Transposition by %s makes alteration larger than two",
186 delta.to_string ()));
191 SCM elt = get_property ("element");
193 if (Music* m = unsmob_music (elt))
194 m->transpose (delta);
196 transpose_music_list (get_property ("elements"), delta);
199 IMPLEMENT_TYPE_P (Music, "ly:music?");
200 IMPLEMENT_SMOBS (Music);
201 IMPLEMENT_DEFAULT_EQUAL_P (Music);
204 Music::internal_get_property (SCM sym) const
206 SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
210 s = scm_sloppy_assq (sym, immutable_property_alist_);
211 return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
215 Music::internal_set_property (SCM s, SCM v)
217 if (internal_type_checking_global_b)
218 if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
221 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
225 Music::set_spot (Input ip)
227 set_property ("origin", make_input (ip));
231 Music::origin () const
233 Input *ip = unsmob_input (get_property ("origin"));
234 return ip ? ip : & dummy_input_global;
238 Music::duration_log () const
240 if (is_mus_type ("rhythmic-event"))
241 return unsmob_duration (get_property ("duration"))->duration_log ();
246 make_music_by_name (SCM sym)
248 SCM make_music_proc = ly_scheme_function ("make-music");
249 SCM rv = scm_call_1 (make_music_proc, sym);
252 scm_gc_protect_object (rv);
253 return unsmob_music (rv);
256 LY_DEFINE (ly_music_length, "ly:music-length",
258 "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
260 Music *sc = unsmob_music (mus);
261 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
262 return sc->get_length ().smobbed_copy ();
265 LY_DEFINE (ly_music_property,
266 "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
267 "Get the property @var{sym} of music expression @var{mus}.\n"
268 "If @var{sym} is undefined, return @code{' ()}.\n" )
270 Music * sc = unsmob_music (mus);
271 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
272 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
274 return sc->internal_get_property (sym);
277 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
278 3, 0, 0, (SCM mus, SCM sym, SCM val),
279 "Set property @var{sym} in music expression @var{mus} to @var{val}.")
281 Music * sc = unsmob_music (mus);
282 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
283 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
285 bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
288 sc->internal_set_property (sym, val);
291 return SCM_UNSPECIFIED;
294 LY_DEFINE (ly_music_name, "ly:music-name",
296 "Return the name of @var{music}.")
298 Music *m = unsmob_music (mus);
299 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__ ,"music");
301 char const *nm = classname (m);
302 return scm_makfrom0str (nm);
305 /* todo: property args */
306 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
307 2, 0, 0, (SCM type, SCM props),
308 "Make a C++ music object of type @var{type}, initialize with\n"
311 "This function is for internal use, and is only called by "
312 "@code{make-music}, which is the preferred interface "
313 "for creating music objects. "
316 SCM_ASSERT_TYPE (scm_is_string (type), type, SCM_ARG1, __FUNCTION__, "string");
317 SCM s = make_music (ly_scm2string (type))->self_scm ();
318 unsmob_music (s)->immutable_property_alist_ = props;
319 scm_gc_unprotect_object (s);
323 /* todo: property args */
324 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
326 "Return an alist containing the mutable properties of @var{mus}.\n"
327 "The immutable properties are not available, since "
328 "they are constant and initialized by the "
329 "@code{make-music} function.\n")
331 Music *m = unsmob_music (mus);
332 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
333 return m->get_property_alist (true);
336 LY_DEFINE (ly_music_list_p,"ly:music-list?",
338 "Type predicate: return true if @var{lst} is a list "
341 if (scm_list_p (lst) == SCM_BOOL_T)
342 while (scm_is_pair (lst))
344 if (!unsmob_music (scm_car (lst)))
352 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
354 "Copy @var{m} and all sub expressions of @var{m}")
357 if (unsmob_music (m))
359 copy = unsmob_music (m)->clone ()->self_scm ();
360 scm_gc_unprotect_object (copy);
362 else if (scm_is_pair (m))
363 copy = scm_cons (ly_music_deep_copy (scm_car (m)),
364 ly_music_deep_copy (scm_cdr (m)));
368 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
369 2, 0, 0, (SCM m, SCM p),
370 "Transpose @var{m} such that central C is mapped to @var{p}. "
373 Music * sc = unsmob_music (m);
374 Pitch * sp = unsmob_pitch (p);
375 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
376 SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
380 return sc->self_scm ();
384 TODO: should take moment factor?
386 LY_DEFINE (ly_music_compress, "ly:music-compress",
387 2, 0, 0, (SCM m, SCM factor),
388 "Compress music object @var{m} by moment @var{factor}."
391 Music * sc = unsmob_music (m);
393 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
394 SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
396 sc->compress (*unsmob_moment (factor));
397 return sc->self_scm ();
400 LY_DEFINE (ly_music_scorify, "ly:music-scorify",
402 (SCM music, SCM parser),
403 "Return MUSIC encapsulated in SCORE.")
406 SCM_ASSERT_TYPE (ly_c_music_p (music), music, SCM_ARG1, __FUNCTION__, "music");
408 Score *score = new Score;
410 score->set_music (music, parser);
412 scm_gc_unprotect_object (score->self_scm ());
413 return score->self_scm ();