lily/music.cc

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