lily/music.cc

   1 /*
   2   music.cc -- implement Music
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "music.hh"
  10 #include "music-sequence.hh"
  11 #include "duration.hh"
  12 #include "input-smob.hh"
  13 #include "ly-smobs.icc"
  14 #include "main.hh"
  15 #include "pitch.hh"
  16 #include "score.hh"
  17 #include "warn.hh"
  18
  19 /*
  20   Music is anything that has duration and supports both time compression
  21   and transposition.
  22
  23   In Lily, everything that can be thought to have a length and a pitch
  24   (which has a duration which can be transposed) is considered "music",
  25 */
  26 bool
  27 Music::internal_is_music_type (SCM k) const
  28 {
  29   SCM ifs = get_property ("types");
  30
  31   return scm_c_memq (k, ifs) != SCM_BOOL_F;
  32 }
  33
  34 String
  35 Music::name () const
  36 {
  37   SCM nm = get_property ("name");
  38   if (scm_is_symbol (nm))
  39     {
  40       return ly_symbol2string (nm);
  41     }
  42   else
  43     {
  44       return classname (this);
  45     }
  46 }
  47
  48 Music::Music (SCM init)
  49 {
  50   self_scm_ = SCM_EOL;
  51   immutable_property_alist_ = init;
  52   mutable_property_alist_ = SCM_EOL;
  53   smobify_self ();
  54
  55   length_callback_ = get_property ("length-callback");
  56   if (!ly_is_procedure (length_callback_))
  57     {
  58       length_callback_ = duration_length_callback_proc;
  59     }
  60
  61   start_callback_ = get_property ("start-callback");
  62 }
  63
  64 Music::Music (Music const &m)
  65 {
  66   immutable_property_alist_ = m.immutable_property_alist_;
  67   mutable_property_alist_ = SCM_EOL;
  68   self_scm_ = SCM_EOL;
  69
  70   /* First we smobify_self, then we copy over the stuff.  If we don't,
  71      stack vars that hold the copy might be optimized away, meaning
  72      that they won't be protected from GC. */
  73   smobify_self ();
  74   mutable_property_alist_ = ly_music_deep_copy (m.mutable_property_alist_);
  75   length_callback_ = m.length_callback_;
  76   start_callback_ = m.start_callback_;
  77   set_spot (*m.origin ());
  78 }
  79
  80 Music::~Music ()
  81 {
  82 }
  83
  84
  85 SCM
  86 Music::get_property_alist (bool m) const
  87 {
  88   return (m) ? mutable_property_alist_ : immutable_property_alist_;
  89 }
  90
  91 SCM
  92 Music::mark_smob (SCM m)
  93 {
  94   Music *mus = (Music *) SCM_CELL_WORD_1 (m);
  95   scm_gc_mark (mus->immutable_property_alist_);
  96   scm_gc_mark (mus->mutable_property_alist_);
  97   return SCM_EOL;
  98 }
  99
 100 Moment
 101 Music::get_length () const
 102 {
 103   SCM lst = get_property ("length");
 104   if (unsmob_moment (lst))
 105     return *unsmob_moment (lst);
 106
 107   if (ly_is_procedure (length_callback_))
 108     {
 109       SCM res = scm_call_1 (length_callback_, self_scm ());
 110       return *unsmob_moment (res);
 111     }
 112
 113   return Moment (0);
 114 }
 115
 116 Moment
 117 Music::start_mom () const
 118 {
 119   SCM lst = start_callback_;
 120   if (ly_is_procedure (lst))
 121     {
 122       SCM res = scm_call_1 (lst, self_scm ());
 123       return *unsmob_moment (res);
 124     }
 125
 126   Moment m;
 127   return m;
 128 }
 129
 130 void
 131 print_alist (SCM a, SCM port)
 132 {
 133   /* SCM_EOL  -> catch malformed lists.  */
 134   for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
 135     {
 136       scm_display (scm_caar (s), port);
 137       scm_puts (" = ", port);
 138       scm_write (scm_cdar (s), port);
 139       scm_puts ("\n", port);
 140     }
 141 }
 142
 143 int
 144 Music::print_smob (SCM s, SCM p, scm_print_state*)
 145 {
 146   scm_puts ("#<Music ", p);
 147   Music *m = unsmob_music (s);
 148
 149   SCM nm = m->get_property ("name");
 150   if (scm_is_symbol (nm) || scm_is_string (nm))
 151     scm_display (nm, p);
 152   else
 153     scm_puts (classname (m), p);
 154
 155   /* Printing properties takes a lot of time, especially during backtraces.
 156      For inspecting, it is better to explicitly use an inspection
 157      function.  */
 158
 159   scm_puts (">", p);
 160   return 1;
 161 }
 162
 163 Pitch
 164 Music::generic_to_relative_octave (Pitch last)
 165 {
 166   SCM elt = get_property ("element");
 167   Pitch *old_pit = unsmob_pitch (get_property ("pitch"));
 168   if (old_pit)
 169     {
 170       Pitch new_pit = *old_pit;
 171       new_pit = new_pit.to_relative_octave (last);
 172
 173       SCM check = get_property ("absolute-octave");
 174       if (scm_is_number (check)
 175           && new_pit.get_octave () != scm_to_int (check))
 176         {
 177           Pitch expected_pit (scm_to_int (check),
 178                               new_pit.get_notename (),
 179                               new_pit.get_alteration ());
 180           origin ()->warning (_f ("octave check failed; expected %s, found: %s",
 181                                   expected_pit.to_string (),
 182                                   new_pit.to_string ()));
 183           new_pit = expected_pit;
 184         }
 185
 186       set_property ("pitch", new_pit.smobbed_copy ());
 187
 188       last = new_pit;
 189     }
 190
 191   if (Music *m = unsmob_music (elt))
 192     last = m->to_relative_octave (last);
 193
 194   last = music_list_to_relative (get_property ("elements"), last, false);
 195   return last;
 196 }
 197
 198 Pitch
 199 Music::to_relative_octave (Pitch last)
 200 {
 201   SCM callback = get_property ("to-relative-callback");
 202   if (ly_is_procedure (callback))
 203     {
 204       Pitch *p = unsmob_pitch (scm_call_2 (callback, self_scm (), last.smobbed_copy ()));
 205       return *p;
 206     }
 207
 208   return generic_to_relative_octave (last);
 209 }
 210
 211 void
 212 Music::compress (Moment factor)
 213 {
 214   SCM elt = get_property ("element");
 215
 216   if (Music *m = unsmob_music (elt))
 217     m->compress (factor);
 218
 219   compress_music_list (get_property ("elements"), factor);
 220   Duration *d = unsmob_duration (get_property ("duration"));
 221   if (d)
 222     set_property ("duration", d->compressed (factor.main_part_).smobbed_copy ());
 223 }
 224
 225 void
 226 Music::transpose (Pitch delta)
 227 {
 228   if (to_boolean (get_property ("untransposable")))
 229     return;
 230
 231   for (SCM s = this->get_property_alist (true); scm_is_pair (s); s = scm_cdr (s))
 232     {
 233       SCM entry = scm_car (s);
 234       SCM val = scm_cdr (entry);
 235
 236       if (Pitch *p = unsmob_pitch (val))
 237         {
 238           Pitch transposed = p->transposed (delta);
 239           scm_set_cdr_x (entry, transposed.smobbed_copy ());
 240
 241           if (abs (transposed.get_alteration ()) > DOUBLE_SHARP)
 242             {
 243               warning (_f ("transposition by %s makes alteration larger than double",
 244                            delta.to_string ()));
 245             }
 246         }
 247     }
 248
 249   SCM elt = get_property ("element");
 250
 251   if (Music *m = unsmob_music (elt))
 252     m->transpose (delta);
 253
 254   transpose_music_list (get_property ("elements"), delta);
 255
 256   /*
 257     UGH - how do this more generically?
 258   */
 259   SCM pa = get_property ("pitch-alist");
 260   if (scm_is_pair (pa))
 261     {
 262       set_property ("pitch-alist", ly_transpose_key_alist (pa, delta.smobbed_copy ()));
 263     }
 264 }
 265
 266 IMPLEMENT_TYPE_P (Music, "ly:music?");
 267 IMPLEMENT_SMOBS (Music);
 268 IMPLEMENT_DEFAULT_EQUAL_P (Music);
 269
 270 SCM
 271 Music::internal_get_property (SCM sym) const
 272 {
 273   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
 274   if (s != SCM_BOOL_F)
 275     return scm_cdr (s);
 276
 277   s = scm_sloppy_assq (sym, immutable_property_alist_);
 278   return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
 279 }
 280
 281 void
 282 Music::internal_set_property (SCM s, SCM v)
 283 {
 284   if (do_internal_type_checking_global)
 285     if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
 286       abort ();
 287
 288   mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
 289 }
 290
 291 void
 292 Music::set_spot (Input ip)
 293 {
 294   set_property ("origin", make_input (ip));
 295 }
 296
 297 Input *
 298 Music::origin () const
 299 {
 300   Input *ip = unsmob_input (get_property ("origin"));
 301   return ip ? ip : &dummy_input_global;
 302 }
 303
 304 Music *
 305 make_music_by_name (SCM sym)
 306 {
 307   SCM make_music_proc = ly_lily_module_constant ("make-music");
 308   SCM rv = scm_call_1 (make_music_proc, sym);
 309
 310   /* UGH. */
 311   scm_gc_protect_object (rv);
 312   return unsmob_music (rv);
 313 }
 314
 315
 316 MAKE_SCHEME_CALLBACK (Music, duration_length_callback, 1);
 317 SCM
 318 Music::duration_length_callback (SCM m)
 319 {
 320   Music *me = unsmob_music (m);
 321   Duration *d = unsmob_duration (me->get_property ("duration"));
 322
 323   Moment mom;
 324   if (d)
 325     {
 326       mom = d->get_length ();
 327     }
 328   return mom.smobbed_copy ();
 329 }