scm/music-functions.scm

   1 ;;;; music-functions.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;;                 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 ;; (use-modules (ice-9 optargs))
   9
  10 ;;; ly:music-property with setter
  11 ;;; (ly:music-property my-music 'elements)
  12 ;;;   ==> the 'elements property
  13 ;;; (set! (ly:music-property my-music 'elements) value)
  14 ;;;   ==> set the 'elements property and return it
  15 (define-public ly:music-property
  16   (make-procedure-with-setter ly:music-property
  17                               ly:music-set-property!))
  18
  19 (define-safe-public (music-is-of-type? mus type)
  20   "Does @code{mus} belong to the music class @code{type}?"
  21   (memq type (ly:music-property mus 'types)))
  22
  23 ;; TODO move this
  24 (define-public ly:grob-property
  25   (make-procedure-with-setter ly:grob-property
  26                               ly:grob-set-property!))
  27
  28 (define-public ly:prob-property
  29   (make-procedure-with-setter ly:prob-property
  30                               ly:prob-set-property!))
  31
  32 (define-public (music-map function music)
  33   "Apply @var{function} to @var{music} and all of the music it contains.
  34
  35 First it recurses over the children, then the function is applied to MUSIC.
  36 "
  37   (let ((es (ly:music-property music 'elements))
  38         (e (ly:music-property music 'element)))
  39     (set! (ly:music-property music 'elements)
  40           (map (lambda (y) (music-map function y)) es))
  41     (if (ly:music? e)
  42         (set! (ly:music-property music 'element)
  43               (music-map function  e)))
  44     (function music)))
  45
  46 (define-public (music-filter pred? music)
  47   "Filter out music expressions that do not satisfy PRED."
  48
  49   (define (inner-music-filter pred? music)
  50     "Recursive function."
  51     (let* ((es (ly:music-property music 'elements))
  52            (e (ly:music-property music 'element))
  53            (as (ly:music-property music 'articulations))
  54            (filtered-as (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) as)))
  55            (filtered-e (if (ly:music? e)
  56                            (inner-music-filter pred? e)
  57                            e))
  58            (filtered-es (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) es))))
  59       (set! (ly:music-property music 'element) filtered-e)
  60       (set! (ly:music-property music 'elements) filtered-es)
  61       (set! (ly:music-property music 'articulations) filtered-as)
  62       ;; if filtering emptied the expression, we remove it completely.
  63       (if (or (not (pred? music))
  64               (and (eq? filtered-es '()) (not (ly:music? e))
  65                    (or (not (eq? es '()))
  66                        (ly:music? e))))
  67           (set! music '()))
  68       music))
  69
  70   (set! music (inner-music-filter pred? music))
  71   (if (ly:music? music)
  72       music
  73       (make-music 'Music)))       ;must return music.
  74
  75 (define-public (display-music music)
  76   "Display music, not done with music-map for clarity of presentation."
  77
  78   (display music)
  79   (display ": { ")
  80   (let ((es (ly:music-property music 'elements))
  81         (e (ly:music-property music 'element)))
  82     (display (ly:music-mutable-properties music))
  83     (if (pair? es)
  84         (begin (display "\nElements: {\n")
  85                (map display-music es)
  86                (display "}\n")))
  87     (if (ly:music? e)
  88         (begin
  89           (display "\nChild:")
  90           (display-music e))))
  91   (display " }\n")
  92   music)
  93
  94 ;;;
  95 ;;; A scheme music pretty printer
  96 ;;;
  97 (define (markup-expression->make-markup markup-expression)
  98   "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
  99 For instance,
 100   \\markup \\bold \\italic hello
 101 ==>
 102   (markup #:line (#:bold (#:italic (#:simple \"hello\"))))"
 103   (define (proc->command-keyword proc)
 104     "Return a keyword, eg. `#:bold', from the `proc' function, eg. #<procedure bold-markup (layout props arg)>"
 105     (let ((cmd-markup (symbol->string (procedure-name proc))))
 106       (symbol->keyword (string->symbol (substring cmd-markup 0 (- (string-length cmd-markup)
 107                                                                   (string-length "-markup")))))))
 108   (define (transform-arg arg)
 109     (cond ((and (pair? arg) (markup? (car arg))) ;; a markup list
 110            (apply append (map inner-markup->make-markup arg)))
 111           ((and (not (string? arg)) (markup? arg)) ;; a markup
 112            (inner-markup->make-markup arg))
 113           (else                                  ;; scheme arg
 114            arg)))
 115   (define (inner-markup->make-markup mrkup)
 116     (if (string? mrkup)
 117         `(#:simple ,mrkup)
 118         (let ((cmd (proc->command-keyword (car mrkup)))
 119               (args (map transform-arg (cdr mrkup))))
 120           `(,cmd ,@args))))
 121   ;; body:
 122   (if (string? markup-expression)
 123       markup-expression
 124       `(markup ,@(inner-markup->make-markup markup-expression))))
 125
 126 (define-public (music->make-music obj)
 127   "Generate a expression that, once evaluated, may return an object equivalent to `obj',
 128 that is, for a music expression, a (make-music ...) form."
 129   (cond (;; markup expression
 130          (markup? obj)
 131          (markup-expression->make-markup obj))
 132         (;; music expression
 133          (ly:music? obj)
 134          `(make-music
 135            ',(ly:music-property obj 'name)
 136            ,@(apply append (map (lambda (prop)
 137                                   `(',(car prop)
 138                                     ,(music->make-music (cdr prop))))
 139                                 (remove (lambda (prop)
 140                                           (eqv? (car prop) 'origin))
 141                                         (ly:music-mutable-properties obj))))))
 142         (;; moment
 143          (ly:moment? obj)
 144          `(ly:make-moment ,(ly:moment-main-numerator obj)
 145                           ,(ly:moment-main-denominator obj)
 146                           ,(ly:moment-grace-numerator obj)
 147                           ,(ly:moment-grace-denominator obj)))
 148         (;; note duration
 149          (ly:duration? obj)
 150          `(ly:make-duration ,(ly:duration-log obj)
 151                             ,(ly:duration-dot-count obj)
 152                             ,(car (ly:duration-factor obj))
 153                             ,(cdr (ly:duration-factor obj))))
 154         (;; note pitch
 155          (ly:pitch? obj)
 156          `(ly:make-pitch ,(ly:pitch-octave obj)
 157                          ,(ly:pitch-notename obj)
 158                          ,(ly:pitch-alteration obj)))
 159         (;; scheme procedure
 160          (procedure? obj)
 161          (or (procedure-name obj) obj))
 162         (;; a symbol (avoid having an unquoted symbol)
 163          (symbol? obj)
 164          `',obj)
 165         (;; an empty list (avoid having an unquoted empty list)
 166          (null? obj)
 167          `'())
 168         (;; a proper list
 169          (list? obj)
 170          `(list ,@(map music->make-music obj)))
 171         (;; a pair
 172          (pair? obj)
 173          `(cons ,(music->make-music (car obj))
 174                 ,(music->make-music (cdr obj))))
 175         (else
 176          obj)))
 177
 178 (use-modules (ice-9 pretty-print))
 179 (define*-public (display-scheme-music obj #:optional (port (current-output-port)))
 180   "Displays `obj', typically a music expression, in a friendly fashion,
 181 which often can be read back in order to generate an equivalent expression.
 182
 183 Returns `obj'.
 184 "
 185   (pretty-print (music->make-music obj) port)
 186   (newline)
 187   obj)
 188
 189 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 190
 191 (define-public (shift-one-duration-log music shift dot)
 192   "  add SHIFT to duration-log of 'duration in music and optionally
 193   a dot to any note encountered. This scales the music up by a factor
 194   2^shift * (2 - (1/2)^dot)"
 195   (let ((d (ly:music-property music 'duration)))
 196     (if (ly:duration? d)
 197         (let* ((cp (ly:duration-factor d))
 198                (nd (ly:make-duration (+ shift (ly:duration-log d))
 199                                      (+ dot (ly:duration-dot-count d))
 200                                      (car cp)
 201                                      (cdr cp))))
 202           (set! (ly:music-property music 'duration) nd)))
 203     music))
 204
 205 (define-public (shift-duration-log music shift dot)
 206   (music-map (lambda (x) (shift-one-duration-log x shift dot))
 207              music))
 208
 209 (define-public (make-repeat name times main alts)
 210   "create a repeat music expression, with all properties initialized properly"
 211   (let ((talts (if (< times (length alts))
 212                    (begin
 213                      (ly:warning (_ "More alternatives than repeats.  Junking excess alternatives"))
 214                      (take alts times))
 215                    alts))
 216         (r (make-repeated-music name)))
 217     (set! (ly:music-property r 'element) main)
 218     (set! (ly:music-property r 'repeat-count) (max times 1))
 219     (set! (ly:music-property r 'elements) talts)
 220     (if (equal? name "tremolo")
 221         (let* ((dot? (zero? (modulo times 3)))
 222                (dots (if dot? 1 0))
 223                (mult (if dot?
 224                          (quotient (* times 2) 3)
 225                          times))
 226                (shift (- (ly:intlog2 mult))))
 227
 228           (if (memq 'sequential-music (ly:music-property main 'types))
 229               ;; \repeat "tremolo" { c4 d4 }
 230               (let ((children (length (ly:music-property main 'elements))))
 231                 (if (not (= children 2))
 232                     (ly:warning (_ "expecting 2 elements for chord tremolo, found ~a") children))
 233                 (ly:music-compress r (ly:make-moment 1 children))
 234                 (shift-duration-log r (1- shift) dots))
 235               ;; \repeat "tremolo" c4
 236               (shift-duration-log r shift dots)))
 237         r)))
 238
 239 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 240 ;; clusters.
 241
 242 (define-public (note-to-cluster music)
 243   "Replace NoteEvents by ClusterNoteEvents."
 244   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 245       (make-music 'ClusterNoteEvent
 246                   'pitch (ly:music-property music 'pitch)
 247                   'duration (ly:music-property music 'duration))
 248       music))
 249
 250 (define-public (notes-to-clusters music)
 251   (music-map note-to-cluster music))
 252
 253 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 254 ;; repeats.
 255
 256 (define-public (unfold-repeats music)
 257   "
 258 This function replaces all repeats  with unfold repeats. "
 259
 260   (let ((es (ly:music-property music 'elements))
 261         (e  (ly:music-property music 'element))
 262         )
 263     (if (memq 'repeated-music (ly:music-property music 'types))
 264         (let*
 265             ((props (ly:music-mutable-properties music))
 266              (old-name (ly:music-property music 'name))
 267              (flattened  (flatten-alist props)))
 268
 269           (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
 270                                               flattened)))
 271
 272           (if (equal? old-name 'TremoloRepeatedMusic)
 273               (let* ((seq-arg? (memq 'sequential-music
 274                                      (ly:music-property e 'types)))
 275                      (count  (ly:music-property music 'repeat-count))
 276                      (dot-shift (if (= 0 (remainder count 3))
 277                                     -1 0)))
 278
 279                 (if (= 0 -1)
 280                     (set! count (* 2 (quotient count 3))))
 281
 282                 (shift-duration-log music (+ (if seq-arg? 1 0)
 283                                              (ly:intlog2 count)) dot-shift)
 284
 285                 (if seq-arg?
 286                     (ly:music-compress e (ly:make-moment (length (ly:music-property
 287                                                                   e 'elements)) 1)))))))
 288
 289
 290     (if (pair? es)
 291         (set! (ly:music-property music 'elements)
 292               (map unfold-repeats es)))
 293     (if (ly:music? e)
 294         (set! (ly:music-property music 'element)
 295               (unfold-repeats e)))
 296     music))
 297
 298 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 299 ;; property setting music objs.
 300
 301 (define-public (make-grob-property-set grob gprop val)
 302   "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
 303 i.e.  this is not an override"
 304   (make-music 'OverrideProperty
 305               'symbol grob
 306               'grob-property gprop
 307               'grob-value val
 308               'pop-first #t))
 309
 310 (define-public (make-grob-property-override grob gprop val)
 311   "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
 312 i.e.  this is not an override"
 313   (make-music 'OverrideProperty
 314               'symbol grob
 315               'grob-property gprop
 316               'grob-value val))
 317
 318 (define-public (make-grob-property-revert grob gprop)
 319   "Revert the grob property GPROP for GROB."
 320   (make-music 'RevertProperty
 321               'symbol grob
 322               'grob-property gprop))
 323
 324 (define direction-polyphonic-grobs
 325   '(Stem Tie Rest Slur PhrasingSlur Script TextScript Dots DotColumn Fingering))
 326
 327 (define-safe-public (make-voice-props-set n)
 328   (make-sequential-music
 329    (append
 330     (map (lambda (x) (make-grob-property-set x 'direction
 331                                              (if (odd? n) -1 1)))
 332          direction-polyphonic-grobs)
 333     (list
 334      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
 335      (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
 336
 337 (define-safe-public (make-voice-props-revert)
 338   (make-sequential-music
 339    (append
 340     (map (lambda (x) (make-grob-property-revert x 'direction))
 341          direction-polyphonic-grobs)
 342     (list (make-grob-property-revert 'NoteColumn 'horizontal-shift))
 343     (list (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
 344
 345
 346 (define-safe-public (context-spec-music m context #:optional id)
 347   "Add \\context CONTEXT = ID to M. "
 348   (let ((cm (make-music 'ContextSpeccedMusic
 349                         'element m
 350                         'context-type context)))
 351     (if (string? id)
 352         (set! (ly:music-property cm 'context-id) id))
 353     cm))
 354
 355 (define-public (descend-to-context m context)
 356   "Like context-spec-music, but only descending. "
 357   (let ((cm (context-spec-music m context)))
 358     (ly:music-set-property! cm 'descend-only #t)
 359     cm))
 360
 361 (define-public (make-non-relative-music mus)
 362   (make-music 'UnrelativableMusic
 363               'element mus))
 364
 365 (define-public (make-apply-context func)
 366   (make-music 'ApplyContext
 367               'procedure func))
 368
 369 (define-public (make-sequential-music elts)
 370   (make-music 'SequentialMusic
 371               'elements elts))
 372
 373 (define-public (make-simultaneous-music elts)
 374   (make-music 'SimultaneousMusic
 375               'elements elts))
 376
 377 (define-safe-public (make-event-chord elts)
 378   (make-music 'EventChord
 379               'elements elts))
 380
 381 (define-public (make-skip-music dur)
 382   (make-music 'SkipMusic
 383               'duration dur))
 384
 385 (define-public (make-grace-music music)
 386   (make-music 'GraceMusic
 387               'element music))
 388
 389 ;;;;;;;;;;;;;;;;
 390
 391 ;; mmrest
 392 (define-public (make-multi-measure-rest duration location)
 393   (make-music 'MultiMeasureRestMusic
 394               'origin location
 395               'duration duration))
 396
 397 (define-public (make-property-set sym val)
 398   (make-music 'PropertySet
 399               'symbol sym
 400               'value val))
 401
 402 (define-public (make-property-unset sym)
 403   (make-music 'PropertyUnset
 404               'symbol sym))
 405
 406 (define-public (make-ottava-set octavation)
 407   (let ((m (make-music 'ApplyContext)))
 408     (define (ottava-modify context)
 409       "Either reset middleCPosition to the stored original, or remember
 410 old middleCPosition, add OCTAVATION to middleCPosition, and set
 411 OTTAVATION to `8va', or whatever appropriate."
 412       (if (number? (ly:context-property  context 'middleCPosition))
 413           (if (= octavation 0)
 414               (let ((where (ly:context-property-where-defined context 'middleCPosition))
 415                     (oc0 (ly:context-property context 'originalCentralCPosition)))
 416                 (ly:context-set-property! context 'middleCPosition oc0)
 417                 (ly:context-unset-property where 'originalCentralCPosition)
 418                 (ly:context-unset-property where 'ottavation))
 419               (let* ((where (ly:context-property-where-defined context 'middleCPosition))
 420                      (c0 (ly:context-property context 'middleCPosition))
 421                      (new-c0 (+ c0 (* -7 octavation)))
 422                      (string (cdr (assoc octavation '((2 . "15ma")
 423                                                       (1 . "8va")
 424                                                       (0 . #f)
 425                                                       (-1 . "8vb")
 426                                                       (-2 . "15mb"))))))
 427                 (ly:context-set-property! context 'middleCPosition new-c0)
 428                 (ly:context-set-property! context 'originalCentralCPosition c0)
 429                 (ly:context-set-property! context 'ottavation string)))))
 430     (set! (ly:music-property m 'procedure) ottava-modify)
 431     (context-spec-music m 'Staff)))
 432
 433 (define-public (set-octavation ottavation)
 434   (ly:export (make-ottava-set ottavation)))
 435
 436 (define-public (make-time-signature-set num den . rest)
 437   "Set properties for time signature NUM/DEN.  Rest can contain a list
 438 of beat groupings "
 439
 440   (define (standard-beat-grouping num den)
 441
 442     "Some standard subdivisions for time signatures."
 443     (let*
 444         ((key (cons num den))
 445          (entry (assoc key '(((6 . 8) . (3 3))
 446                          ((5 . 8) . (3 2))
 447                          ((9 . 8) . (3 3 3))
 448                          ((12 . 8) . (3 3 3 3))
 449                          ((8 . 8) . (3 3 2))
 450                          ))))
 451
 452       (if entry
 453           (cdr entry)
 454           '())))
 455
 456   (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
 457          (beat (ly:make-moment 1 den))
 458          (len  (ly:make-moment num den))
 459          (set2 (make-property-set 'beatLength beat))
 460          (set3 (make-property-set 'measureLength len))
 461          (set4 (make-property-set 'beatGrouping (if (pair? rest)
 462                                                     (car rest)
 463                                                     (standard-beat-grouping num den))))
 464          (basic  (list set1 set2 set3 set4)))
 465     (descend-to-context
 466      (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
 467
 468 (define-public (make-mark-set label)
 469   "Make the music for the \\mark command."
 470   (let* ((set (if (integer? label)
 471                   (context-spec-music (make-property-set 'rehearsalMark label)
 472                                       'Score)
 473                   #f))
 474          (ev (make-music 'MarkEvent))
 475          (ch (make-event-chord (list ev))))
 476     (if set
 477         (make-sequential-music (list set ch))
 478         (begin
 479           (set! (ly:music-property ev 'label) label)
 480           ch))))
 481
 482 (define-public (set-time-signature num den . rest)
 483   (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
 484
 485 (define-safe-public (make-articulation name)
 486   (make-music 'ArticulationEvent
 487               'articulation-type name))
 488
 489 (define-public (make-lyric-event string duration)
 490   (make-music 'LyricEvent
 491               'duration duration
 492               'text string))
 493
 494 (define-safe-public (make-span-event type spandir)
 495   (make-music type
 496               'span-direction spandir))
 497
 498 (define-public (set-mus-properties! m alist)
 499   "Set all of ALIST as properties of M."
 500   (if (pair? alist)
 501       (begin
 502         (set! (ly:music-property m (caar alist)) (cdar alist))
 503         (set-mus-properties! m (cdr alist)))))
 504
 505 (define-public (music-separator? m)
 506   "Is M a separator?"
 507   (let ((ts (ly:music-property m 'types)))
 508     (memq 'separator ts)))
 509
 510 ;;; splitting chords into voices.
 511 (define (voicify-list lst number)
 512   "Make a list of Musics.
 513
 514    voicify-list :: [ [Music ] ] -> number -> [Music]
 515    LST is a list music-lists.
 516
 517    NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
 518 "
 519   (if (null? lst)
 520       '()
 521       (cons (context-spec-music
 522              (make-sequential-music
 523               (list (make-voice-props-set number)
 524                     (make-simultaneous-music (car lst))))
 525              'Voice  (number->string (1+ number)))
 526             (voicify-list (cdr lst) (1+ number)))))
 527
 528 (define (voicify-chord ch)
 529   "Split the parts of a chord into different Voices using separator"
 530   (let ((es (ly:music-property ch 'elements)))
 531     (set! (ly:music-property  ch 'elements)
 532           (voicify-list (split-list-by-separator es music-separator?) 0))
 533     ch))
 534
 535 (define-public (voicify-music m)
 536   "Recursively split chords that are separated with \\ "
 537   (if (not (ly:music? m))
 538       (ly:error (_ "music expected: ~S") m))
 539   (let ((es (ly:music-property m 'elements))
 540         (e (ly:music-property m 'element)))
 541
 542     (if (pair? es)
 543         (set! (ly:music-property m 'elements) (map voicify-music es)))
 544     (if (ly:music? e)
 545         (set! (ly:music-property m 'element)  (voicify-music e)))
 546     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 547              (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
 548         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 549     m))
 550
 551 (define-public (empty-music)
 552   (ly:export (make-music 'Music)))
 553 ;;;
 554
 555                                         ; Make a function that checks score element for being of a specific type.
 556 (define-public (make-type-checker symbol)
 557   (lambda (elt)
 558     ;;(display  symbol)
 559     ;;(eq? #t (ly:grob-property elt symbol))
 560     (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
 561
 562 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 563   (if (func grob)
 564       (set! (ly:grob-property grob sym) val)))
 565
 566
 567 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 568   "Usage:
 569
 570 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
 571
 572 "
 573   (let ((meta (ly:grob-property grob 'meta)))
 574     (if (equal?  (cdr (assoc 'name meta)) grob-name)
 575         (set! (ly:grob-property grob symbol) val))))
 576
 577
 578 ;;
 579 (define-public (smart-bar-check n)
 580   "Make  a bar check that checks for a specific bar number.
 581 "
 582   (let ((m (make-music 'ApplyContext)))
 583     (define (checker tr)
 584       (let* ((bn (ly:context-property tr 'currentBarNumber)))
 585         (if (= bn n)
 586             #t
 587             (ly:error
 588              ;; FIXME: uncomprehensable message
 589              (_ "Bar check failed.  Expect to be at ~a, instead at ~a")
 590              n bn))))
 591     (set! (ly:music-property m 'procedure) checker)
 592     m))
 593
 594
 595 (define-public (skip->rest mus)
 596
 597   "Replace MUS by RestEvent of the same duration if it is a
 598 SkipEvent. Useful for extracting parts from crowded scores"
 599
 600   (if (equal? (ly:music-property mus 'name) 'SkipEvent)
 601    (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 602    mus))
 603
 604
 605 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 606 ;; warn for bare chords at start.
 607
 608 (define (has-request-chord elts)
 609   (reduce (lambda (x y) (or x y)) #f
 610           (map (lambda (x)
 611                  (equal? (ly:music-property x 'name) 'RequestChord))
 612                elts)))
 613
 614 (define-public (ly:music-message music msg)
 615   (let ((ip (ly:music-property music 'origin)))
 616     (if (ly:input-location? ip)
 617         (ly:input-message ip msg)
 618         (ly:warning msg))))
 619
 620 (define (check-start-chords music)
 621   "Check music expression for a Simultaneous_music containing notes\n(ie. Request_chords),
 622 without context specification. Called  from parser."
 623   (let ((es (ly:music-property music 'elements))
 624         (e (ly:music-property music 'element))
 625         (name (ly:music-property music 'name)))
 626     (cond ((equal? name "Context_specced_music") #t)
 627           ((equal? name "Simultaneous_music")
 628            (if (has-request-chord es)
 629                (ly:music-message music "Starting score with a chord.\nInsert an explicit \\context before chord")
 630                (map check-start-chords es)))
 631           ((equal? name "SequentialMusic")
 632            (if (pair? es)
 633                (check-start-chords (car es))))
 634           (else (if (ly:music? e) (check-start-chords e)))))
 635   music)
 636
 637
 638
 639 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 640 ;;
 641 ;; setting stuff for grace context.
 642 ;;
 643
 644 (define (vector-extend v x)
 645   "Make a new vector consisting of V, with X added to the end."
 646   (let* ((n (vector-length v))
 647          (nv (make-vector (+ n 1) '())))
 648     (vector-move-left! v 0 n nv 0)
 649     (vector-set! nv n x)
 650     nv))
 651
 652 (define (vector-map f v)
 653   "Map  F over V. This function returns nothing."
 654   (do ((n (vector-length v))
 655        (i 0 (+ i 1)))
 656       ((>= i n))
 657     (f (vector-ref v i))))
 658
 659 (define (vector-reverse-map f v)
 660   "Map  F over V, N to 0 order. This function returns nothing."
 661   (do ((i (- (vector-length v) 1) (- i 1)))
 662       ((< i 0))
 663     (f (vector-ref v i))))
 664
 665 ;; TODO:  make a remove-grace-property too.
 666 (define-public (add-grace-property context-name grob sym val)
 667   "Set SYM=VAL for GROB in CONTEXT-NAME. "
 668   (define (set-prop context)
 669     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 670            (current (ly:context-property where 'graceSettings))
 671            (new-settings (append current
 672                                  (list (list context-name grob sym val)))))
 673       (ly:context-set-property! where 'graceSettings new-settings)))
 674   (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
 675
 676
 677
 678 (defmacro-public def-grace-function (start stop)
 679   `(define-music-function (parser location music) (ly:music?)
 680      (make-music 'GraceMusic
 681                  'origin location
 682                  'element (make-music 'SequentialMusic
 683                                       'elements (list (ly:music-deep-copy ,start)
 684                                                       music
 685                                                       (ly:music-deep-copy ,stop))))))
 686
 687 (defmacro-public define-music-function (args signature . body)
 688   "Helper macro for `ly:make-music-function'.
 689 Syntax:
 690   (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
 691     ...function body...)
 692 "
 693   `(ly:make-music-function (list ,@signature)
 694                            (lambda (,@args)
 695                              ,@body)))
 696
 697
 698 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 699
 700 (define-public (cue-substitute quote-music)
 701   "Must happen after quote-substitute."
 702
 703   (if (vector? (ly:music-property quote-music 'quoted-events))
 704       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
 705              (main-voice (if (eq? 1 dir) 1 0))
 706              (cue-voice (if (eq? 1 dir) 0 1))
 707              (main-music (ly:music-property quote-music 'element))
 708              (return-value quote-music))
 709
 710         (if (or (eq? 1 dir) (eq? -1 dir))
 711
 712             ;; if we have stem dirs, change both quoted and main music
 713             ;; to have opposite stems.
 714             (begin
 715               (set! return-value
 716
 717                     ;; cannot context-spec Quote-music, since context
 718                     ;; for the quotes is determined in the iterator.
 719                     (make-sequential-music
 720                      (list
 721                       (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
 722                       quote-music
 723                       (context-spec-music (make-voice-props-revert)  'CueVoice "cue"))))
 724               (set! main-music
 725                     (make-sequential-music
 726                      (list
 727                       (make-voice-props-set main-voice)
 728                       main-music
 729                       (make-voice-props-revert))))
 730               (set! (ly:music-property quote-music 'element) main-music)))
 731
 732         return-value)
 733       quote-music))
 734
 735 (define-public ((quote-substitute quote-tab) music)
 736   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
 737          (quoted-vector (if (string? quoted-name)
 738                             (hash-ref quote-tab quoted-name #f)
 739                             #f)))
 740
 741
 742     (if (string? quoted-name)
 743         (if (vector? quoted-vector)
 744             (begin
 745               (set! (ly:music-property music 'quoted-events) quoted-vector)
 746               (set! (ly:music-property music 'iterator-ctor)
 747                     ly:quote-iterator::constructor))
 748             (ly:warning (_ "cannot find quoted music: `~S'" quoted-name))))
 749     music))
 750
 751
 752 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 753 ;; switch it on here, so parsing and init isn't checked (too slow!)
 754 ;;
 755 ;; automatic music transformations.
 756
 757 (define (switch-on-debugging m)
 758   (if (defined? 'set-debug-cell-accesses!)
 759       (set-debug-cell-accesses! 15000))
 760   m)
 761
 762 (define (music-check-error music)
 763   (define found #f)
 764   (define (signal m)
 765     (if (and (ly:music? m)
 766              (eq? (ly:music-property m 'error-found) #t))
 767         (set! found #t)))
 768
 769   (for-each signal (ly:music-property music 'elements))
 770   (signal (ly:music-property music 'element))
 771
 772   (if found
 773       (set! (ly:music-property music 'error-found) #t))
 774   music)
 775
 776 (define (precompute-music-length music)
 777   (set! (ly:music-property music 'length)
 778         (ly:music-length music))
 779   music)
 780
 781 (define (skip-to-last music parser)
 782
 783   "Replace MUSIC by
 784
 785 << { \\set skipTypesetting = ##t
 786      LENGTHOF(\\showLastLength)
 787      \\set skipTypesetting = ##t  }
 788     MUSIC >>
 789
 790 if appropriate.
 791  "
 792   (let*
 793       ((show-last  (ly:parser-lookup parser 'showLastLength)))
 794
 795     (if (ly:music? show-last)
 796         (let*
 797             ((orig-length (ly:music-length music))
 798              (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
 799
 800           (make-simultaneous-music
 801            (list
 802             (make-sequential-music
 803              (list
 804               (context-spec-music (make-property-set 'skipTypesetting #t)
 805                                   'Score)
 806               (make-music 'SkipMusic 'duration
 807                           (ly:make-duration
 808                            0 0
 809                            (ly:moment-main-numerator skip-length)
 810                            (ly:moment-main-denominator skip-length)))
 811               (context-spec-music (make-property-set 'skipTypesetting #f)
 812                                   'Score)))
 813             music)))
 814         music)))
 815
 816
 817 (define-public toplevel-music-functions
 818   (list
 819    (lambda (music parser) (voicify-music music))
 820    (lambda (x parser) (music-map music-check-error x))
 821    (lambda (x parser) (music-map precompute-music-length x))
 822    (lambda (music parser)
 823
 824      (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes))  music))
 825
 826    ;; switch-on-debugging
 827    (lambda (x parser) (music-map cue-substitute x))
 828
 829    (lambda (x parser)
 830      (skip-to-last x parser)
 831    )))
 832
 833
 834 ;;;;;;;;;;;;;;;;;
 835 ;; lyrics
 836
 837 (define (apply-durations lyric-music durations)
 838   (define (apply-duration music)
 839     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
 840              (ly:duration?  (ly:music-property music 'duration)))
 841         (begin
 842           (set! (ly:music-property music 'duration) (car durations))
 843           (set! durations (cdr durations)))))
 844
 845   (music-map apply-duration lyric-music))
 846
 847
 848 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 849 ;; accidentals
 850
 851 (define-public (set-accidentals-properties extra-natural
 852                                            auto-accs auto-cauts
 853                                            context)
 854   (context-spec-music
 855    (make-sequential-music
 856     (append (if (boolean? extra-natural)
 857                 (list (make-property-set 'extraNatural extra-natural))
 858                 '())
 859             (list (make-property-set 'autoAccidentals auto-accs)
 860                   (make-property-set 'autoCautionaries auto-cauts))))
 861    context))
 862
 863 (define-public (set-accidental-style style . rest)
 864   "Set accidental style to STYLE. Optionally takes a context argument,
 865 e.g. 'Staff or 'Voice. The context defaults to Voice, except for piano styles, which
 866 use GrandStaff as a context. "
 867   (let ((context (if (pair? rest)
 868                      (car rest) 'Staff))
 869         (pcontext (if (pair? rest)
 870                       (car rest) 'GrandStaff)))
 871     (ly:export
 872      (cond
 873       ;; accidentals as they were common in the 18th century.
 874       ((equal? style 'default)
 875        (set-accidentals-properties #t '(Staff (same-octave . 0))
 876                                    '() context))
 877       ;; accidentals from one voice do NOT get cancelled in other voices
 878       ((equal? style 'voice)
 879        (set-accidentals-properties #t '(Voice (same-octave . 0))
 880                                    '() context))
 881       ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
 882       ;; This includes all the default accidentals, but accidentals also needs cancelling
 883       ;; in other octaves and in the next measure.
 884       ((equal? style 'modern)
 885        (set-accidentals-properties #f '(Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
 886                                    '()  context))
 887       ;; the accidentals that Stone adds to the old standard as cautionaries
 888       ((equal? style 'modern-cautionary)
 889        (set-accidentals-properties #f '(Staff (same-octave . 0))
 890                                    '(Staff (any-octave . 0) (same-octave . 1))
 891                                    context))
 892       ;; Multivoice accidentals to be read both by musicians playing one voice
 893       ;; and musicians playing all voices.
 894       ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
 895       ((equal? style 'modern-voice)
 896        (set-accidentals-properties  #f
 897                                     '(Voice (same-octave . 0) (any-octave . 0) (same-octave . 1)
 898                                             Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
 899                                     '()
 900                                     context))
 901       ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
 902       ;; as cautionaries
 903       ((equal? style 'modern-voice-cautionary)
 904        (set-accidentals-properties #f
 905                                    '(Voice (same-octave . 0))
 906                                    '(Voice (any-octave . 0) (same-octave . 1)
 907                                            Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
 908                                    context))
 909       ;; stone's suggestions for accidentals on grand staff.
 910       ;; Accidentals are cancelled across the staves in the same grand staff as well
 911       ((equal? style 'piano)
 912        (set-accidentals-properties #f
 913                                    '(Staff (same-octave . 0)
 914                                            (any-octave . 0) (same-octave . 1)
 915                                            GrandStaff (any-octave . 0) (same-octave . 1))
 916                                    '()
 917                                    pcontext))
 918       ((equal? style 'piano-cautionary)
 919        (set-accidentals-properties #f
 920                                    '(Staff (same-octave . 0))
 921                                    '(Staff (any-octave . 0) (same-octave . 1)
 922                                            GrandStaff (any-octave . 0) (same-octave . 1))
 923                                    pcontext))
 924       ;; do not set localKeySignature when a note alterated differently from
 925       ;; localKeySignature is found.
 926       ;; Causes accidentals to be printed at every note instead of
 927       ;; remembered for the duration of a measure.
 928       ;; accidentals not being remembered, causing accidentals always to be typeset relative to the time signature
 929       ((equal? style 'forget)
 930        (set-accidentals-properties '()
 931                                    '(Staff (same-octave . -1))
 932                                    '() context))
 933       ;; Do not reset the key at the start of a measure.  Accidentals will be
 934       ;; printed only once and are in effect until overridden, possibly many
 935       ;; measures later.
 936       ((equal? style 'no-reset)
 937        (set-accidentals-properties '()
 938                                    '(Staff (same-octave . #t))
 939                                    '()
 940                                    context))
 941       (else
 942        (ly:warning (_ "unknown accidental style: ~S" style))
 943        (make-sequential-music '()))))))
 944
 945 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 946
 947 (define-public (skip-of-length mus)
 948   "Create a skip of exactly the same length as MUS."
 949   (let* ((skip
 950           (make-music
 951            'SkipEvent
 952            'duration (ly:make-duration 0 0))))
 953
 954     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
 955
 956 (define-public (mmrest-of-length mus)
 957   "Create a mmrest of exactly the same length as MUS."
 958
 959   (let* ((skip
 960           (make-multi-measure-rest
 961            (ly:make-duration 0 0) '())))
 962     (ly:music-compress skip (ly:music-length mus))
 963     skip))
 964
 965 (define-public (pitch-of-note event-chord)
 966
 967   (let*
 968       ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
 969                     (ly:music-property event-chord 'elements))))
 970
 971     (if (pair? evs)
 972         (ly:music-property (car evs) 'pitch)
 973         #f)))
 974