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 "duration.hh"
  10 #include "input-smob.hh"
  11 #include "ly-smobs.icc"
  12 #include "main.hh"
  13 #include "music-list.hh"
  14 #include "music.hh"
  15 #include "pitch.hh"
  16 #include "score.hh"
  17 #include "warn.hh"
  18
  19 bool
  20 Music::internal_is_music_type (SCM k) const
  21 {
  22   SCM ifs = get_property ("types");
  23
  24   return scm_c_memq (k, ifs) != SCM_BOOL_F;
  25 }
  26
  27 String
  28 Music::name () const
  29 {
  30   SCM nm = get_property ("name");
  31   if (scm_is_symbol (nm))
  32     {
  33       return ly_symbol2string (nm);
  34     }
  35   else
  36     {
  37       return classname (this);
  38     }
  39 }
  40
  41 Music::Music ()
  42 {
  43   self_scm_ = SCM_EOL;
  44   immutable_property_alist_ = SCM_EOL;
  45   mutable_property_alist_ = SCM_EOL;
  46   smobify_self ();
  47 }
  48
  49 Music::Music (Music const &m)
  50 {
  51   immutable_property_alist_ = m.immutable_property_alist_;
  52   mutable_property_alist_ = SCM_EOL;
  53   self_scm_ = SCM_EOL;
  54
  55   /* First we smobify_self, then we copy over the stuff.  If we don't,
  56      stack vars that hold the copy might be optimized away, meaning
  57      that they won't be protected from GC. */
  58   smobify_self ();
  59   mutable_property_alist_ = ly_deep_mus_copy (m.mutable_property_alist_);
  60   set_spot (*m.origin ());
  61 }
  62
  63 Music::~Music ()
  64 {
  65 }
  66
  67 ADD_MUSIC (Music);
  68
  69 SCM
  70 Music::get_property_alist (bool m) const
  71 {
  72   return (m) ? mutable_property_alist_ : immutable_property_alist_;
  73 }
  74
  75 SCM
  76 Music::mark_smob (SCM m)
  77 {
  78   Music *mus = (Music*) SCM_CELL_WORD_1 (m);
  79   scm_gc_mark (mus->immutable_property_alist_);
  80   scm_gc_mark (mus->mutable_property_alist_);
  81   return SCM_EOL;
  82 }
  83
  84 Moment
  85 Music::get_length () const
  86 {
  87   SCM lst = get_property ("length");
  88   if (unsmob_moment (lst))
  89     return *unsmob_moment (lst);
  90   else if (ly_c_procedure_p (lst))
  91     {
  92       SCM res = scm_call_1 (lst, self_scm ());
  93       return *unsmob_moment (res);
  94     }
  95
  96   return 0;
  97 }
  98
  99 Moment
 100 Music::start_mom () const
 101 {
 102   SCM lst = get_property ("start-moment-function");
 103   if (ly_c_procedure_p (lst))
 104     {
 105       SCM res = scm_call_1 (lst, self_scm ());
 106       return *unsmob_moment (res);
 107     }
 108
 109   Moment m;
 110   return m;
 111 }
 112
 113 void
 114 print_alist (SCM a, SCM port)
 115 {
 116   /* SCM_EOL  -> catch malformed lists.  */
 117   for (SCM s = a; ly_c_pair_p (s); s = ly_cdr (s))
 118     {
 119       scm_display (ly_caar (s), port);
 120       scm_puts (" = ", port);
 121       scm_write (ly_cdar (s), port);
 122       scm_puts ("\n", port);
 123     }
 124 }
 125
 126 int
 127 Music::print_smob (SCM s, SCM p, scm_print_state*)
 128 {
 129   scm_puts ("#<Music ", p);
 130   Music* m = unsmob_music (s);
 131
 132   SCM nm = m->get_property ("name");
 133   if (scm_is_symbol (nm) || scm_is_string (nm))
 134     scm_display (nm, p);
 135   else
 136     scm_puts (classname (m),p);
 137
 138   /* Printing properties takes a lot of time, especially during backtraces.
 139      For inspecting, it is better to explicitly use an inspection
 140      function.  */
 141
 142   scm_puts (">",p);
 143   return 1;
 144 }
 145
 146 Pitch
 147 Music::to_relative_octave (Pitch p)
 148 {
 149   SCM elt = get_property ("element");
 150
 151   if (Music *m = unsmob_music (elt))
 152     p = m->to_relative_octave (p);
 153
 154   p = music_list_to_relative (get_property ("elements"), p, false);
 155   return p;
 156 }
 157
 158 void
 159 Music::compress (Moment factor)
 160 {
 161   SCM elt = get_property ("element");
 162
 163   if (Music *m = unsmob_music (elt))
 164     m->compress (factor);
 165
 166   compress_music_list (get_property ("elements"), factor);
 167 }
 168
 169 void
 170 Music::transpose (Pitch delta)
 171 {
 172   SCM elt = get_property ("element");
 173
 174   if (Music* m = unsmob_music (elt))
 175     m->transpose (delta);
 176
 177   transpose_music_list (get_property ("elements"), delta);
 178 }
 179
 180 IMPLEMENT_TYPE_P (Music, "ly:music?");
 181 IMPLEMENT_SMOBS (Music);
 182 IMPLEMENT_DEFAULT_EQUAL_P (Music);
 183
 184 SCM
 185 Music::internal_get_property (SCM sym) const
 186 {
 187   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
 188   if (s != SCM_BOOL_F)
 189     return ly_cdr (s);
 190
 191   s = scm_sloppy_assq (sym, immutable_property_alist_);
 192   return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s);
 193 }
 194
 195 void
 196 Music::internal_set_property (SCM s, SCM v)
 197 {
 198   if (internal_type_checking_global_b)
 199     if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
 200       abort ();
 201
 202   mutable_property_alist_ =  scm_assq_set_x (mutable_property_alist_, s, v);
 203 }
 204
 205 void
 206 Music::set_spot (Input ip)
 207 {
 208   set_property ("origin", make_input (ip));
 209 }
 210
 211 Input*
 212 Music::origin () const
 213 {
 214   Input *ip = unsmob_input (get_property ("origin"));
 215   return ip ? ip : & dummy_input_global;
 216 }
 217
 218 int
 219 Music::duration_log () const
 220 {
 221   if (is_mus_type ("rhythmic-event"))
 222     return unsmob_duration (get_property ("duration"))->duration_log ();
 223   return 0;
 224 }
 225
 226 Music*
 227 make_music_by_name (SCM sym)
 228 {
 229   SCM make_music_proc = ly_scheme_function ("make-music");
 230   SCM rv = scm_call_1 (make_music_proc, sym);
 231
 232   /* UGH. */
 233   scm_gc_protect_object (rv);
 234   return unsmob_music (rv);
 235 }
 236
 237 LY_DEFINE (ly_music_length, "ly:music-length",
 238            1, 0, 0, (SCM mus),
 239           "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
 240 {
 241   Music *sc = unsmob_music (mus);
 242   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
 243   return sc->get_length ().smobbed_copy ();
 244 }
 245
 246 LY_DEFINE (ly_music_property,
 247           "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
 248           "Get the property @var{sym} of music expression @var{mus}.\n"
 249           "If @var{sym} is undefined, return @code{' ()}.\n" )
 250 {
 251   Music * sc = unsmob_music (mus);
 252   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
 253   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 254
 255   return sc->internal_get_property (sym);
 256 }
 257
 258 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
 259           3, 0, 0, (SCM mus, SCM sym, SCM val),
 260           "Set property @var{sym} in music expression @var{mus} to @var{val}.")
 261 {
 262   Music * sc = unsmob_music (mus);
 263   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
 264   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 265
 266   bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
 267   if (ok)
 268     {
 269       sc->internal_set_property (sym, val);
 270     }
 271
 272   return SCM_UNSPECIFIED;
 273 }
 274
 275 LY_DEFINE (ly_music_name, "ly:music-name",
 276            1, 0, 0, (SCM mus),
 277            "Return the name of @var{music}.")
 278 {
 279   Music *m = unsmob_music (mus);
 280   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__ ,"music");
 281
 282   char const *nm = classname (m);
 283   return scm_makfrom0str (nm);
 284 }
 285
 286 /* todo:  property args */
 287 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
 288            2, 0, 0, (SCM type, SCM props),
 289           "Make a C++ music object of type @var{type}, initialize with\n"
 290           "@var{props}. \n\n"
 291           ""
 292           "This function is for internal use, and is only called by "
 293           "@code{make-music}, which is the preferred interface "
 294           "for creating music objects. "
 295           )
 296 {
 297   SCM_ASSERT_TYPE (scm_is_string (type), type, SCM_ARG1, __FUNCTION__, "string");
 298   SCM s = make_music (ly_scm2string (type))->self_scm ();
 299   unsmob_music (s)->immutable_property_alist_ = props;
 300   scm_gc_unprotect_object (s);
 301   return s;
 302 }
 303
 304 /* todo: property args */
 305 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
 306           1, 0, 0, (SCM mus),
 307           "Return an alist containing the mutable properties of @var{mus}.\n"
 308           "The immutable properties are not available, since "
 309           "they are constant and initialized by the "
 310            "@code{make-music} function.\n")
 311 {
 312   Music *m = unsmob_music (mus);
 313   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
 314   return m->get_property_alist (true);
 315 }
 316
 317 LY_DEFINE (ly_music_list_p,"ly:music-list?",
 318            1, 0, 0, (SCM lst),
 319            "Type predicate: return true if @var{lst} is a list "
 320            "of music objects.")
 321 {
 322   if (scm_list_p (lst) == SCM_BOOL_T)
 323     while (ly_c_pair_p (lst))
 324       {
 325         if (!unsmob_music (ly_car (lst)))
 326           return SCM_BOOL_F;
 327         lst = ly_cdr (lst);
 328       }
 329
 330   return SCM_BOOL_T;
 331 }
 332
 333 LY_DEFINE (ly_deep_mus_copy, "ly:music-deep-copy",
 334           1, 0, 0, (SCM m),
 335           "Copy @var{m} and all sub expressions of @var{m}")
 336 {
 337   SCM copy = m;
 338   if (unsmob_music (m))
 339     {
 340       copy = unsmob_music (m)->clone ()->self_scm ();
 341       scm_gc_unprotect_object (copy);
 342     }
 343   else if (ly_c_pair_p (m))
 344     copy = scm_cons (ly_deep_mus_copy (ly_car (m)),
 345                     ly_deep_mus_copy (ly_cdr (m)));
 346   return copy;
 347 }
 348
 349 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
 350           2, 0, 0, (SCM m, SCM p),
 351           "Transpose @var{m} such that central C is mapped to @var{p}. "
 352           "Return @var{m}.")
 353 {
 354   Music * sc = unsmob_music (m);
 355   Pitch * sp = unsmob_pitch (p);
 356   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 357   SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
 358
 359   sc->transpose (*sp);
 360   // SCM_UNDEFINED ?
 361   return sc->self_scm ();
 362 }
 363
 364 /*
 365   TODO: should take moment factor?
 366  */
 367 LY_DEFINE (ly_music_compress, "ly:music-compress",
 368           2, 0, 0, (SCM m, SCM factor),
 369           "Compress music object @var{m} by moment @var{factor}."
 370            )
 371 {
 372   Music * sc = unsmob_music (m);
 373
 374   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 375   SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
 376
 377   sc->compress (*unsmob_moment (factor));
 378   return sc->self_scm ();
 379 }
 380
 381 LY_DEFINE (ly_music_scorify, "ly:music-scorify",
 382            2, 0, 0,
 383            (SCM music, SCM parser),
 384            "Return MUSIC encapsulated in SCORE.")
 385 {
 386 #if 0
 387   SCM_ASSERT_TYPE (ly_c_music_p (music), music, SCM_ARG1, __FUNCTION__, "music");
 388 #endif
 389   Score *score = new Score;
 390
 391   score->set_music (music, parser);
 392
 393   scm_gc_unprotect_object (score->self_scm ());
 394   return score->self_scm ();
 395 }