scm/music-functions.scm

   1 ;;;; music-functions.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2009 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 ;;; Scheme music expression --> Lily-syntax-using string translator
 191 ;;;
 192 (use-modules (srfi srfi-39)
 193              (scm display-lily))
 194
 195 (define*-public (display-lily-music expr parser #:key force-duration)
 196   "Display the music expression using LilyPond syntax"
 197   (memoize-clef-names supported-clefs)
 198   (parameterize ((*indent* 0)
 199                  (*previous-duration* (ly:make-duration 2))
 200                  (*force-duration* force-duration))
 201     (display (music->lily-string expr parser))
 202     (newline)))
 203
 204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 205
 206 (define-public (shift-one-duration-log music shift dot)
 207   "  add SHIFT to duration-log of 'duration in music and optionally
 208   a dot to any note encountered. This scales the music up by a factor
 209   2^shift * (2 - (1/2)^dot)"
 210   (let ((d (ly:music-property music 'duration)))
 211     (if (ly:duration? d)
 212         (let* ((cp (ly:duration-factor d))
 213                (nd (ly:make-duration (+ shift (ly:duration-log d))
 214                                      (+ dot (ly:duration-dot-count d))
 215                                      (car cp)
 216                                      (cdr cp))))
 217           (set! (ly:music-property music 'duration) nd)))
 218     music))
 219
 220 (define-public (shift-duration-log music shift dot)
 221   (music-map (lambda (x) (shift-one-duration-log x shift dot))
 222              music))
 223
 224 (define-public (make-repeat name times main alts)
 225   "create a repeat music expression, with all properties initialized properly"
 226   (define (first-note-duration music)
 227     "Finds the duration of the first NoteEvent by searching depth-first
 228 through MUSIC."
 229     (if (memq 'note-event (ly:music-property music 'types))
 230         (ly:music-property music 'duration)
 231         (let loop ((elts (if (ly:music? (ly:music-property music 'element))
 232                              (list (ly:music-property music 'element))
 233                              (ly:music-property music 'elements))))
 234           (and (pair? elts)
 235                (let ((dur (first-note-duration (car elts))))
 236                  (if (ly:duration? dur)
 237                      dur
 238                      (loop (cdr elts))))))))
 239
 240   (let ((talts (if (< times (length alts))
 241                    (begin
 242                      (ly:warning (_ "More alternatives than repeats.  Junking excess alternatives"))
 243                      (take alts times))
 244                    alts))
 245         (r (make-repeated-music name)))
 246     (set! (ly:music-property r 'element) main)
 247     (set! (ly:music-property r 'repeat-count) (max times 1))
 248     (set! (ly:music-property r 'elements) talts)
 249     (if (equal? name "tremolo")
 250         (let* ((dots (1- (logcount times)))
 251                (mult (/ (* times (ash 1 dots)) (1- (ash 2 dots))))
 252                (shift (- (ly:intlog2 (floor mult))))
 253                (note-duration (first-note-duration r))
 254                (duration-log (if (ly:duration? note-duration)
 255                                  (ly:duration-log note-duration)
 256                                  1))
 257                (tremolo-type (ash 1 duration-log)))
 258           (set! (ly:music-property r 'tremolo-type) tremolo-type)
 259           (if (not (integer?  mult))
 260               (ly:warning (_ "invalid tremolo repeat count: ~a") times))
 261           (if (memq 'sequential-music (ly:music-property main 'types))
 262               ;; \repeat "tremolo" { c4 d4 }
 263               (let ((children (length (ly:music-property main 'elements))))
 264
 265                 ;; fixme: should be more generic.
 266                 (if (and (not (= children 2))
 267                          (not (= children 1)))
 268                     (ly:warning (_ "expecting 2 elements for chord tremolo, found ~a") children))
 269                 (ly:music-compress r (ly:make-moment 1 children))
 270                 (shift-duration-log r
 271                                     (if (= children 2)  (1- shift) shift)
 272                                     dots))
 273               ;; \repeat "tremolo" c4
 274               (shift-duration-log r shift dots)))
 275         r)))
 276
 277 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 278 ;; clusters.
 279
 280 (define-public (note-to-cluster music)
 281   "Replace NoteEvents by ClusterNoteEvents."
 282   (if (eq? (ly:music-property music 'name) 'NoteEvent)
 283       (make-music 'ClusterNoteEvent
 284                   'pitch (ly:music-property music 'pitch)
 285                   'duration (ly:music-property music 'duration))
 286       music))
 287
 288 (define-public (notes-to-clusters music)
 289   (music-map note-to-cluster music))
 290
 291 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 292 ;; repeats.
 293
 294 (define-public (unfold-repeats music)
 295   "
 296 This function replaces all repeats  with unfold repeats. "
 297
 298   (let ((es (ly:music-property music 'elements))
 299         (e  (ly:music-property music 'element))
 300         )
 301     (if (memq 'repeated-music (ly:music-property music 'types))
 302         (let*
 303             ((props (ly:music-mutable-properties music))
 304              (old-name (ly:music-property music 'name))
 305              (flattened  (flatten-alist props)))
 306
 307           (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
 308                                               flattened)))
 309
 310           (if (equal? old-name 'TremoloRepeatedMusic)
 311               (let* ((seq-arg? (memq 'sequential-music
 312                                      (ly:music-property e 'types)))
 313                      (count  (ly:music-property music 'repeat-count))
 314                      (dot-shift (if (= 0 (remainder count 3))
 315                                     -1 0)))
 316
 317                 (if (= 0 -1)
 318                     (set! count (* 2 (quotient count 3))))
 319
 320                 (shift-duration-log music (+ (if seq-arg? 1 0)
 321                                              (ly:intlog2 count)) dot-shift)
 322
 323                 (if seq-arg?
 324                     (ly:music-compress e (ly:make-moment (length (ly:music-property
 325                                                                   e 'elements)) 1)))))))
 326
 327
 328     (if (pair? es)
 329         (set! (ly:music-property music 'elements)
 330               (map unfold-repeats es)))
 331     (if (ly:music? e)
 332         (set! (ly:music-property music 'element)
 333               (unfold-repeats e)))
 334     music))
 335
 336 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 337 ;; property setting music objs.
 338
 339 (define-public (make-grob-property-set grob gprop val)
 340   "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
 341 i.e.  this is not an override"
 342   (make-music 'OverrideProperty
 343               'symbol grob
 344               'grob-property gprop
 345               'grob-value val
 346               'pop-first #t))
 347
 348 (define-public (make-grob-property-override grob gprop val)
 349   "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
 350 i.e.  this is not an override"
 351   (make-music 'OverrideProperty
 352               'symbol grob
 353               'grob-property gprop
 354               'grob-value val))
 355
 356 (define-public (make-grob-property-revert grob gprop)
 357   "Revert the grob property GPROP for GROB."
 358   (make-music 'RevertProperty
 359               'symbol grob
 360               'grob-property gprop))
 361
 362 (define direction-polyphonic-grobs
 363   '(DotColumn
 364     Dots
 365     Fingering
 366     LaissezVibrerTie
 367     PhrasingSlur
 368     RepeatTie
 369     Rest
 370     Script
 371     Slur
 372     Stem
 373     TextScript
 374     Tie))
 375
 376 (define-safe-public (make-voice-props-set n)
 377   (make-sequential-music
 378    (append
 379     (map (lambda (x) (make-grob-property-set x 'direction
 380                                              (if (odd? n) -1 1)))
 381          direction-polyphonic-grobs)
 382     (list
 383      (make-property-set 'graceSettings
 384                         ;; TODO: take this from voicedGraceSettings or similar.
 385                         '((Voice Stem font-size -3)
 386                           (Voice NoteHead font-size -3)
 387                           (Voice Dots font-size -3)
 388                           (Voice Stem length-fraction 0.8)
 389                           (Voice Stem no-stem-extend #t)
 390                           (Voice Beam thickness 0.384)
 391                           (Voice Beam length-fraction 0.8)
 392                           (Voice Accidental font-size -4)
 393                           (Voice AccidentalCautionary font-size -4)
 394                           (Voice Script font-size -3)
 395                           (Voice Fingering font-size -8)
 396                           (Voice StringNumber font-size -8)))
 397
 398      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
 399      (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
 400
 401 (define-safe-public (make-voice-props-revert)
 402   (make-sequential-music
 403    (append
 404     (map (lambda (x) (make-grob-property-revert x 'direction))
 405          direction-polyphonic-grobs)
 406     (list (make-property-unset 'graceSettings)
 407           (make-grob-property-revert 'NoteColumn 'horizontal-shift)
 408           (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
 409
 410
 411 (define-safe-public (context-spec-music m context #:optional id)
 412   "Add \\context CONTEXT = ID to M. "
 413   (let ((cm (make-music 'ContextSpeccedMusic
 414                         'element m
 415                         'context-type context)))
 416     (if (string? id)
 417         (set! (ly:music-property cm 'context-id) id))
 418     cm))
 419
 420 (define-public (descend-to-context m context)
 421   "Like context-spec-music, but only descending. "
 422   (let ((cm (context-spec-music m context)))
 423     (ly:music-set-property! cm 'descend-only #t)
 424     cm))
 425
 426 (define-public (make-non-relative-music mus)
 427   (make-music 'UnrelativableMusic
 428               'element mus))
 429
 430 (define-public (make-apply-context func)
 431   (make-music 'ApplyContext
 432               'procedure func))
 433
 434 (define-public (make-sequential-music elts)
 435   (make-music 'SequentialMusic
 436               'elements elts))
 437
 438 (define-public (make-simultaneous-music elts)
 439   (make-music 'SimultaneousMusic
 440               'elements elts))
 441
 442 (define-safe-public (make-event-chord elts)
 443   (make-music 'EventChord
 444               'elements elts))
 445
 446 (define-public (make-skip-music dur)
 447   (make-music 'SkipMusic
 448               'duration dur))
 449
 450 (define-public (make-grace-music music)
 451   (make-music 'GraceMusic
 452               'element music))
 453
 454 ;;;;;;;;;;;;;;;;
 455
 456 ;; mmrest
 457 (define-public (make-multi-measure-rest duration location)
 458   (make-music 'MultiMeasureRestMusic
 459               'origin location
 460               'duration duration))
 461
 462 (define-public (make-property-set sym val)
 463   (make-music 'PropertySet
 464               'symbol sym
 465               'value val))
 466
 467 (define-public (make-property-unset sym)
 468   (make-music 'PropertyUnset
 469               'symbol sym))
 470
 471 (define-public (make-ottava-set octavation)
 472   (let ((m (make-music 'ApplyContext)))
 473     (define (ottava-modify context)
 474       "Either reset middleCPosition to the stored original, or remember
 475 old middleCPosition, add OCTAVATION to middleCPosition, and set
 476 OTTAVATION to `8va', or whatever appropriate."
 477       (if (number? (ly:context-property  context 'middleCOffset))
 478           (let ((where (ly:context-property-where-defined context 'middleCOffset)))
 479             (ly:context-unset-property where 'middleCOffset)
 480             (ly:context-unset-property where 'ottavation)))
 481
 482       (let* ((offset (* -7 octavation))
 483              (string (cdr (assoc octavation '((2 . "15ma")
 484                                               (1 . "8va")
 485                                               (0 . #f)
 486                                               (-1 . "8vb")
 487                                               (-2 . "15mb"))))))
 488         (ly:context-set-property! context 'middleCOffset offset)
 489         (ly:context-set-property! context 'ottavation string)
 490         (ly:set-middle-C! context)))
 491     (set! (ly:music-property m 'procedure) ottava-modify)
 492     (context-spec-music m 'Staff)))
 493
 494 (define-public (set-octavation ottavation)
 495   (ly:export (make-ottava-set ottavation)))
 496
 497 (define-public (make-time-signature-set num den . rest)
 498   "Set properties for time signature NUM/DEN.  Rest can contain a list
 499 of beat groupings "
 500
 501   (define (standard-beat-grouping num den)
 502
 503     "Some standard subdivisions for time signatures."
 504     (let*
 505         ((key (cons num den))
 506          (entry (assoc key '(
 507                ; Simple time signatures
 508                (( 3 .  8) . (3))
 509                (( 4 .  8) . (2 2))
 510                ; Compound time signatures
 511                (( 6 .  4) . (3 3))
 512                (( 6 .  8) . (3 3))
 513                (( 6 . 16) . (3 3))
 514                (( 9 .  4) . (3 3 3))
 515                (( 9 .  8) . (3 3 3))
 516                (( 9 . 16) . (3 3 3))
 517                ((12 .  4) . (3 3 3 3))
 518                ((12 .  8) . (3 3 3 3))
 519                ((12 . 16) . (3 3 3 3))
 520                ; Some common irregular time signatures
 521                (( 5 .  8) . (3 2))
 522                (( 8 .  8) . (3 3 2))
 523                ))))
 524
 525       (if entry
 526           (cdr entry)
 527           '())))
 528
 529   (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
 530          (beat (ly:make-moment 1 den))
 531          (len  (ly:make-moment num den))
 532          (set2 (make-property-set 'beatLength beat))
 533          (set3 (make-property-set 'measureLength len))
 534          (set4 (make-property-set 'beatGrouping (if (pair? rest)
 535                                                     (car rest)
 536                                                     (standard-beat-grouping num den))))
 537          (basic  (list set1 set2 set3 set4)))
 538     (descend-to-context
 539      (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
 540
 541 (define-public (make-mark-set label)
 542   "Make the music for the \\mark command."
 543   (let* ((set (if (integer? label)
 544                   (context-spec-music (make-property-set 'rehearsalMark label)
 545                                       'Score)
 546                   #f))
 547          (ev (make-music 'MarkEvent))
 548          (ch (make-event-chord (list ev))))
 549     (if set
 550         (make-sequential-music (list set ch))
 551         (begin
 552           (set! (ly:music-property ev 'label) label)
 553           ch))))
 554
 555 (define-public (set-time-signature num den . rest)
 556   (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
 557
 558 (define-safe-public (make-articulation name)
 559   (make-music 'ArticulationEvent
 560               'articulation-type name))
 561
 562 (define-public (make-lyric-event string duration)
 563   (make-music 'LyricEvent
 564               'duration duration
 565               'text string))
 566
 567 (define-safe-public (make-span-event type span-dir)
 568   (make-music type
 569               'span-direction span-dir))
 570
 571 (define-public (set-mus-properties! m alist)
 572   "Set all of ALIST as properties of M."
 573   (if (pair? alist)
 574       (begin
 575         (set! (ly:music-property m (caar alist)) (cdar alist))
 576         (set-mus-properties! m (cdr alist)))))
 577
 578 (define-public (music-separator? m)
 579   "Is M a separator?"
 580   (let ((ts (ly:music-property m 'types)))
 581     (memq 'separator ts)))
 582
 583 ;;; splitting chords into voices.
 584 (define (voicify-list lst number)
 585   "Make a list of Musics.
 586
 587    voicify-list :: [ [Music ] ] -> number -> [Music]
 588    LST is a list music-lists.
 589
 590    NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
 591 "
 592   (if (null? lst)
 593       '()
 594       (cons (context-spec-music
 595              (make-sequential-music
 596               (list (make-voice-props-set number)
 597                     (make-simultaneous-music (car lst))))
 598              'Voice  (number->string (1+ number)))
 599             (voicify-list (cdr lst) (1+ number)))))
 600
 601 (define (voicify-chord ch)
 602   "Split the parts of a chord into different Voices using separator"
 603   (let ((es (ly:music-property ch 'elements)))
 604     (set! (ly:music-property  ch 'elements)
 605           (voicify-list (split-list-by-separator es music-separator?) 0))
 606     ch))
 607
 608 (define-public (voicify-music m)
 609   "Recursively split chords that are separated with \\ "
 610   (if (not (ly:music? m))
 611       (ly:error (_ "music expected: ~S") m))
 612   (let ((es (ly:music-property m 'elements))
 613         (e (ly:music-property m 'element)))
 614
 615     (if (pair? es)
 616         (set! (ly:music-property m 'elements) (map voicify-music es)))
 617     (if (ly:music? e)
 618         (set! (ly:music-property m 'element)  (voicify-music e)))
 619     (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
 620              (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
 621         (set! m (context-spec-music (voicify-chord m) 'Staff)))
 622     m))
 623
 624 (define-public (empty-music)
 625   (ly:export (make-music 'Music)))
 626
 627 ;; Make a function that checks score element for being of a specific type.
 628 (define-public (make-type-checker symbol)
 629   (lambda (elt)
 630     ;;(display  symbol)
 631     ;;(eq? #t (ly:grob-property elt symbol))
 632     (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
 633
 634 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 635   (if (func grob)
 636       (set! (ly:grob-property grob sym) val)))
 637
 638
 639 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 640   "Usage:
 641
 642 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
 643
 644 "
 645   (let ((meta (ly:grob-property grob 'meta)))
 646     (if (equal?  (cdr (assoc 'name meta)) grob-name)
 647         (set! (ly:grob-property grob symbol) val))))
 648
 649
 650 ;;
 651 (define-public (smart-bar-check n)
 652   "Make  a bar check that checks for a specific bar number.
 653 "
 654   (let ((m (make-music 'ApplyContext)))
 655     (define (checker tr)
 656       (let* ((bn (ly:context-property tr 'currentBarNumber)))
 657         (if (= bn n)
 658             #t
 659             (ly:error
 660              ;; FIXME: uncomprehensable message
 661              (_ "Bar check failed.  Expect to be at ~a, instead at ~a")
 662              n bn))))
 663     (set! (ly:music-property m 'procedure) checker)
 664     m))
 665
 666
 667 (define-public (skip->rest mus)
 668
 669   "Replace MUS by RestEvent of the same duration if it is a
 670 SkipEvent. Useful for extracting parts from crowded scores"
 671
 672   (if  (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
 673    (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
 674    mus))
 675
 676
 677 (define-public (music-has-type music type)
 678   (memq type (ly:music-property music 'types)))
 679
 680 (define-public (music-clone music)
 681   (define (alist->args alist acc)
 682     (if (null? alist)
 683         acc
 684         (alist->args (cdr alist)
 685                      (cons (caar alist) (cons (cdar alist) acc)))))
 686
 687   (apply
 688    make-music
 689    (ly:music-property music 'name)
 690    (alist->args (ly:music-mutable-properties music) '())))
 691
 692 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 693 ;; warn for bare chords at start.
 694
 695
 696 (define-public (ly:music-message music msg)
 697   (let ((ip (ly:music-property music 'origin)))
 698     (if (ly:input-location? ip)
 699         (ly:input-message ip msg)
 700         (ly:warning msg))))
 701
 702 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 703 ;;
 704 ;; setting stuff for grace context.
 705 ;;
 706
 707 (define (vector-extend v x)
 708   "Make a new vector consisting of V, with X added to the end."
 709   (let* ((n (vector-length v))
 710          (nv (make-vector (+ n 1) '())))
 711     (vector-move-left! v 0 n nv 0)
 712     (vector-set! nv n x)
 713     nv))
 714
 715 (define (vector-map f v)
 716   "Map  F over V. This function returns nothing."
 717   (do ((n (vector-length v))
 718        (i 0 (+ i 1)))
 719       ((>= i n))
 720     (f (vector-ref v i))))
 721
 722 (define (vector-reverse-map f v)
 723   "Map  F over V, N to 0 order. This function returns nothing."
 724   (do ((i (- (vector-length v) 1) (- i 1)))
 725       ((< i 0))
 726     (f (vector-ref v i))))
 727
 728 (define-public (add-grace-property context-name grob sym val)
 729   "Set SYM=VAL for GROB in CONTEXT-NAME. "
 730   (define (set-prop context)
 731     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 732            (current (ly:context-property where 'graceSettings))
 733            (new-settings (append current
 734                                  (list (list context-name grob sym val)))))
 735       (ly:context-set-property! where 'graceSettings new-settings)))
 736   (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
 737
 738 (define-public (remove-grace-property context-name grob sym)
 739   "Remove all SYM for GROB in CONTEXT-NAME. "
 740   (define (sym-grob-context? property sym grob context-name)
 741     (and (eq? (car property) context-name)
 742          (eq? (cadr property) grob)
 743          (eq? (caddr property) sym)))
 744   (define (delete-prop context)
 745     (let* ((where (ly:context-property-where-defined context 'graceSettings))
 746            (current (ly:context-property where 'graceSettings))
 747            (prop-settings (filter
 748                             (lambda(x) (sym-grob-context? x sym grob context-name))
 749                             current))
 750            (new-settings current))
 751       (for-each (lambda(x)
 752                  (set! new-settings (delete x new-settings)))
 753                prop-settings)
 754       (ly:context-set-property! where 'graceSettings new-settings)))
 755   (ly:export (context-spec-music (make-apply-context delete-prop) 'Voice)))
 756
 757
 758
 759 (defmacro-public def-grace-function (start stop . docstring)
 760   "Helper macro for defining grace music"
 761   `(define-music-function (parser location music) (ly:music?)
 762      ,@docstring
 763      (make-music 'GraceMusic
 764                  'origin location
 765                  'element (make-music 'SequentialMusic
 766                                       'elements (list (ly:music-deep-copy ,start)
 767                                                       music
 768                                                       (ly:music-deep-copy ,stop))))))
 769
 770 (defmacro-public define-music-function (args signature . body)
 771   "Helper macro for `ly:make-music-function'.
 772 Syntax:
 773   (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
 774     ...function body...)
 775 "
 776 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
 777       ;; When the music function definition contains a i10n doc string,
 778       ;; (_i "doc string"), keep the literal string only
 779       (let ((docstring (cadar body))
 780             (body (cdr body)))
 781         `(ly:make-music-function (list ,@signature)
 782                                  (lambda (,@args)
 783                                    ,docstring
 784                                    ,@body)))
 785       `(ly:make-music-function (list ,@signature)
 786                                (lambda (,@args)
 787                                  ,@body))))
 788
 789
 790 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 791
 792 (define-public (cue-substitute quote-music)
 793   "Must happen after quote-substitute."
 794
 795   (if (vector? (ly:music-property quote-music 'quoted-events))
 796       (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
 797              (main-voice (if (eq? 1 dir) 1 0))
 798              (cue-voice (if (eq? 1 dir) 0 1))
 799              (main-music (ly:music-property quote-music 'element))
 800              (return-value quote-music))
 801
 802         (if (or (eq? 1 dir) (eq? -1 dir))
 803
 804             ;; if we have stem dirs, change both quoted and main music
 805             ;; to have opposite stems.
 806             (begin
 807               (set! return-value
 808
 809                     ;; cannot context-spec Quote-music, since context
 810                     ;; for the quotes is determined in the iterator.
 811                     (make-sequential-music
 812                      (list
 813                       (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
 814                       quote-music
 815                       (context-spec-music (make-voice-props-revert)  'CueVoice "cue"))))
 816               (set! main-music
 817                     (make-sequential-music
 818                      (list
 819                       (make-voice-props-set main-voice)
 820                       main-music
 821                       (make-voice-props-revert))))
 822               (set! (ly:music-property quote-music 'element) main-music)))
 823
 824         return-value)
 825       quote-music))
 826
 827 (define-public ((quote-substitute quote-tab) music)
 828   (let* ((quoted-name (ly:music-property music 'quoted-music-name))
 829          (quoted-vector (if (string? quoted-name)
 830                             (hash-ref quote-tab quoted-name #f)
 831                             #f)))
 832
 833
 834     (if (string? quoted-name)
 835         (if (vector? quoted-vector)
 836             (begin
 837               (set! (ly:music-property music 'quoted-events) quoted-vector)
 838               (set! (ly:music-property music 'iterator-ctor)
 839                     ly:quote-iterator::constructor))
 840             (ly:warning (_ "cannot find quoted music: `~S'") quoted-name)))
 841     music))
 842
 843
 844 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 845 ;; switch it on here, so parsing and init isn't checked (too slow!)
 846 ;;
 847 ;; automatic music transformations.
 848
 849 (define (switch-on-debugging m)
 850   (if (defined? 'set-debug-cell-accesses!)
 851       (set-debug-cell-accesses! 15000))
 852   m)
 853
 854 (define (music-check-error music)
 855   (define found #f)
 856   (define (signal m)
 857     (if (and (ly:music? m)
 858              (eq? (ly:music-property m 'error-found) #t))
 859         (set! found #t)))
 860
 861   (for-each signal (ly:music-property music 'elements))
 862   (signal (ly:music-property music 'element))
 863
 864   (if found
 865       (set! (ly:music-property music 'error-found) #t))
 866   music)
 867
 868 (define (precompute-music-length music)
 869   (set! (ly:music-property music 'length)
 870         (ly:music-length music))
 871   music)
 872
 873 (define-public (make-duration-of-length moment)
 874  "Make duration of the given MOMENT length."
 875  (ly:make-duration 0 0
 876   (ly:moment-main-numerator moment)
 877   (ly:moment-main-denominator moment)))
 878
 879 (define (skip-this moment)
 880  "set skipTypesetting, make SkipMusic of the given MOMENT length,
 881  and then unset skipTypesetting."
 882  (make-sequential-music
 883   (list
 884    (context-spec-music (make-property-set 'skipTypesetting #t)
 885     'Score)
 886    (make-music 'SkipMusic 'duration
 887     (make-duration-of-length moment))
 888    (context-spec-music (make-property-set 'skipTypesetting #f)
 889     'Score))))
 890
 891 (define (unskip-this moment)
 892  "unset skipTypesetting, make SkipMusic of the given MOMENT length,
 893  and then set skipTypesetting."
 894  (make-sequential-music
 895   (list
 896    (context-spec-music (make-property-set 'skipTypesetting #f)
 897     'Score)
 898    (make-music 'SkipMusic 'duration
 899     (make-duration-of-length moment))
 900    (context-spec-music (make-property-set 'skipTypesetting #t)
 901     'Score))))
 902
 903 (define (skip-as-needed music parser)
 904  "Replace MUSIC by
 905  << {  \\set skipTypesetting = ##f
 906  LENGTHOF(\\showFirstLength)
 907  \\set skipTypesetting = ##t
 908  LENGTHOF(\\showLastLength) }
 909  MUSIC >>
 910  if appropriate.
 911
 912  When only showFirstLength is set,
 913  the 'length property of the music is
 914  overridden to speed up compiling."
 915  (let*
 916   ((show-last (ly:parser-lookup parser 'showLastLength))
 917    (show-first (ly:parser-lookup parser 'showFirstLength)))
 918   (cond
 919
 920    ;; both properties may be set.
 921    ((and (ly:music? show-first) (ly:music? show-last))
 922     (let*
 923      ((orig-length (ly:music-length music))
 924       (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))
 925       (begin-length (ly:music-length show-first)))
 926      (make-simultaneous-music
 927       (list
 928        (make-sequential-music
 929         (list
 930          (skip-this skip-length)
 931          ;; let's draw a separator between the beginning and the end
 932          (context-spec-music (make-property-set 'whichBar "||")
 933           'Timing)))
 934        (unskip-this begin-length)
 935        music))))
 936
 937    ;; we may only want to print the last length
 938    ((ly:music? show-last)
 939     (let*
 940      ((orig-length (ly:music-length music))
 941       (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
 942      (make-simultaneous-music
 943       (list
 944        (skip-this skip-length)
 945        music))))
 946
 947    ;; we may only want to print the beginning; in this case
 948    ;; only the first length will be processed (much faster).
 949    ((ly:music? show-first)
 950     (let*
 951      ((orig-length (ly:music-length music))
 952       (begin-length (ly:music-length show-first)))
 953      ;; the first length must not exceed the original length.
 954      (if (ly:moment<? begin-length orig-length)
 955       (set! (ly:music-property music 'length)
 956        (ly:music-length show-first)))
 957      music))
 958
 959    (else music))))
 960
 961
 962 (define-public toplevel-music-functions
 963   (list
 964    (lambda (music parser) (voicify-music music))
 965    (lambda (x parser) (music-map music-check-error x))
 966    (lambda (x parser) (music-map precompute-music-length x))
 967    (lambda (music parser)
 968
 969      (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes))  music))
 970
 971    ;; switch-on-debugging
 972    (lambda (x parser) (music-map cue-substitute x))
 973
 974    (lambda (x parser)
 975      (skip-as-needed x parser)
 976    )))
 977
 978 ;;;;;;;;;;
 979 ;;; general purpose music functions
 980
 981 (define (shift-octave pitch octave-shift)
 982   (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
 983   (ly:make-pitch
 984      (+ (ly:pitch-octave pitch) octave-shift)
 985      (ly:pitch-notename pitch)
 986      (ly:pitch-alteration pitch)))
 987
 988
 989 ;;;;;;;;;;;;;;;;;
 990 ;; lyrics
 991
 992 (define (apply-durations lyric-music durations)
 993   (define (apply-duration music)
 994     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
 995              (ly:duration?  (ly:music-property music 'duration)))
 996         (begin
 997           (set! (ly:music-property music 'duration) (car durations))
 998           (set! durations (cdr durations)))))
 999
1000   (music-map apply-duration lyric-music))
1001
1002
1003 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1004 ;; accidentals
1005
1006 (define (recent-enough? bar-number alteration-def laziness)
1007   (if (or (number? alteration-def)
1008           (equal? laziness #t))
1009       #t
1010       (<= bar-number (+ (cadr alteration-def) laziness))))
1011
1012 (define (is-tied? alteration-def)
1013   (let* ((def (if (pair? alteration-def)
1014                  (car alteration-def)
1015                  alteration-def)))
1016
1017     (if (equal? def 'tied) #t #f)))
1018
1019 (define (extract-alteration alteration-def)
1020   (cond ((number? alteration-def)
1021          alteration-def)
1022         ((pair? alteration-def)
1023          (car alteration-def))
1024         (else 0)))
1025
1026 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1027   "Checks the need for an accidental and a @q{restore} accidental against
1028 @code{localKeySignature}. The @var{laziness} is the number of measures
1029 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1030 only cancel accidentals in the same measure; if @var{laziness} is three,
1031 we cancel accidentals up to three measures after they first appear.
1032 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1033 specifies whether accidentals should be canceled in different octaves."
1034   (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1035                               ((equal? octaveness 'same-octave) #f)
1036                               (else
1037                                (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1038                                (ly:warning (_ "Defaulting to 'any-octave."))
1039                                #t)))
1040          (key-sig (ly:context-property context 'keySignature))
1041          (local-key-sig (ly:context-property context 'localKeySignature))
1042          (notename (ly:pitch-notename pitch))
1043          (octave (ly:pitch-octave pitch))
1044          (pitch-handle (cons octave notename))
1045          (need-restore #f)
1046          (need-accidental #f)
1047          (previous-alteration #f)
1048          (from-other-octaves #f)
1049          (from-same-octave (ly:assoc-get pitch-handle local-key-sig))
1050          (from-key-sig (ly:assoc-get notename local-key-sig)))
1051
1052     ;; If no key signature match is found from localKeySignature, we may have a custom
1053     ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1054     ;; instead of (pitch . alteration).  Since this type cannot coexist with entries in
1055     ;; localKeySignature, try extracting from keySignature instead.
1056     (if (equal? from-key-sig #f)
1057         (set! from-key-sig (ly:assoc-get pitch-handle key-sig)))
1058
1059     ;; loop through localKeySignature to search for a notename match from other octaves
1060     (let loop ((l local-key-sig))
1061       (if (pair? l)
1062           (let ((entry (car l)))
1063             (if (and (pair? (car entry))
1064                      (= (cdar entry) notename))
1065                 (set! from-other-octaves (cdr entry))
1066                 (loop (cdr l))))))
1067
1068     ;; find previous alteration-def for comparison with pitch
1069     (cond
1070      ;; from same octave?
1071      ((and (eq? ignore-octave #f)
1072            (not (equal? from-same-octave #f))
1073            (recent-enough? barnum from-same-octave laziness))
1074       (set! previous-alteration from-same-octave))
1075
1076      ;; from any octave?
1077      ((and (eq? ignore-octave #t)
1078            (not (equal? from-other-octaves #f))
1079            (recent-enough? barnum from-other-octaves laziness))
1080       (set! previous-alteration from-other-octaves))
1081
1082      ;; not recent enough, extract from key signature/local key signature
1083      ((not (equal? from-key-sig #f))
1084       (set! previous-alteration from-key-sig)))
1085
1086     (if (is-tied? previous-alteration)
1087         (set! need-accidental #t)
1088
1089         (let* ((prev-alt (extract-alteration previous-alteration))
1090                (this-alt (ly:pitch-alteration pitch)))
1091
1092           (if (not (= this-alt prev-alt))
1093               (begin
1094                 (set! need-accidental #t)
1095                 (if (and (not (= this-alt 0))
1096                          (or (< (abs this-alt) (abs prev-alt))
1097                              (< (* prev-alt this-alt) 0)))
1098                     (set! need-restore #t))))))
1099
1100     (cons need-restore need-accidental)))
1101
1102 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1103   "Creates an accidental rule that makes its decision based on the octave of the note
1104   and a laziness value.
1105   octaveness is either 'same-octave or 'any-octave and defines whether the rule should
1106   respond to accidental changes in other octaves than the current. 'same-octave is the
1107   normal way to typeset accidentals - an accidental is made if the alteration is different
1108   from the last active pitch in the same octave. 'any-octave looks at the last active pitch
1109   in any octave.
1110   laziness states over how many bars an accidental should be remembered.
1111   0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
1112   A positive integer means that the accidental lasts over that many bar lines.
1113   -1 is 'forget immediately', that is, only look at key signature.
1114   #t is forever."
1115   (check-pitch-against-signature context pitch barnum laziness octaveness))
1116
1117 (define (key-entry-notename entry)
1118   "Return the pitch of an entry in localKeySignature. The entry is either of the form
1119   '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))."
1120   (if (number? (car entry))
1121       (car entry)
1122       (cdar entry)))
1123
1124 (define (key-entry-octave entry)
1125   "Return the octave of an entry in localKeySignature (or #f if the entry does not have
1126   an octave)."
1127   (and (pair? (car entry)) (caar entry)))
1128
1129 (define (key-entry-bar-number entry)
1130   "Return the bar number of an entry in localKeySignature (or #f if the entry does not
1131   have a bar number)."
1132   (and (pair? (car entry)) (caddr entry)))
1133
1134 (define (key-entry-measure-position entry)
1135   "Return the measure position of an entry in localKeySignature (or #f if the entry does
1136   not have a measure position)."
1137   (and (pair? (car entry)) (cdddr entry)))
1138
1139 (define (key-entry-alteration entry)
1140   "Return the alteration of an entry in localKeySignature."
1141   (if (number? (car entry))
1142       (cdr entry)
1143       (cadr entry)))
1144
1145 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1146   "Return the first entry in keysig that matches the pitch.
1147   accept-global states whether key signature entries should be included.
1148   accept-local states whether local accidentals should be included.
1149   if no matching entry is found, #f is returned."
1150   (if (pair? keysig)
1151       (let* ((entry (car keysig))
1152              (entryoct (key-entry-octave entry))
1153              (entrynn (key-entry-notename entry))
1154              (oct (ly:pitch-octave pitch))
1155              (nn (ly:pitch-notename pitch)))
1156         (if (and (equal? nn entrynn)
1157                  (or (and accept-global (equal? #f entryoct))
1158                      (and accept-local (equal? oct entryoct))))
1159             entry
1160             (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))
1161       #f))
1162
1163 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1164   "an accidental rule that typesets an accidental if it differs from the key signature
1165    AND does not directly follow a note on the same staff-line.
1166    This rule should not be used alone because it does neither look at bar lines
1167    nor different accidentals at the same notename"
1168   (let* ((keysig (ly:context-property context 'localKeySignature))
1169          (entry (find-pitch-entry keysig pitch #t #t)))
1170     (if (equal? #f entry)
1171         (cons #f #f)
1172         (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1173                (key-acc (if (equal? global-entry #f)
1174                             0
1175                             (key-entry-alteration global-entry)))
1176                (acc (ly:pitch-alteration pitch))
1177                (entrymp (key-entry-measure-position entry))
1178                (entrybn (key-entry-bar-number entry)))
1179           (cons #f (not (or (equal? acc key-acc)
1180                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1181
1182 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1183   "an accidental rule that typesets a cautionary accidental
1184   if it is included in the key signature AND does not directly follow
1185   a note on the same staff-line."
1186   (let* ((keysig (ly:context-property context 'localKeySignature))
1187          (entry (find-pitch-entry keysig pitch #t #t)))
1188     (if (equal? #f entry)
1189         (cons #f #f)
1190         (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1191                (key-acc (if (equal? global-entry #f)
1192                             0
1193                             (key-entry-alteration global-entry)))
1194                (acc (ly:pitch-alteration pitch))
1195                (entrymp (key-entry-measure-position entry))
1196                (entrybn (key-entry-bar-number entry)))
1197           (cons #f (not (or (equal? acc key-acc)
1198                             (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1199
1200 (define-public (set-accidentals-properties extra-natural
1201                                            auto-accs auto-cauts
1202                                            context)
1203   (context-spec-music
1204    (make-sequential-music
1205     (append (if (boolean? extra-natural)
1206                 (list (make-property-set 'extraNatural extra-natural))
1207                 '())
1208             (list (make-property-set 'autoAccidentals auto-accs)
1209                   (make-property-set 'autoCautionaries auto-cauts))))
1210    context))
1211
1212 (define-public (set-accidental-style style . rest)
1213   "Set accidental style to STYLE. Optionally takes a context argument,
1214 e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which
1215 use GrandStaff as a context. "
1216   (let ((context (if (pair? rest)
1217                      (car rest) 'Staff))
1218         (pcontext (if (pair? rest)
1219                       (car rest) 'GrandStaff)))
1220     (ly:export
1221      (cond
1222       ;; accidentals as they were common in the 18th century.
1223       ((equal? style 'default)
1224        (set-accidentals-properties #t
1225                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1226                                    '()
1227                                    context))
1228       ;; accidentals from one voice do NOT get cancelled in other voices
1229       ((equal? style 'voice)
1230        (set-accidentals-properties #t
1231                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1232                                    '()
1233                                    context))
1234       ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1235       ;; This includes all the default accidentals, but accidentals also needs cancelling
1236       ;; in other octaves and in the next measure.
1237       ((equal? style 'modern)
1238        (set-accidentals-properties #f
1239                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1240                                            ,(make-accidental-rule 'any-octave 0)
1241                                            ,(make-accidental-rule 'same-octave 1))
1242                                    '()
1243                                    context))
1244       ;; the accidentals that Stone adds to the old standard as cautionaries
1245       ((equal? style 'modern-cautionary)
1246        (set-accidentals-properties #f
1247                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1248                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1249                                            ,(make-accidental-rule 'same-octave 1))
1250                                    context))
1251       ;; same as modern, but accidentals different from the key signature are always
1252       ;; typeset - unless they directly follow a note of the same pitch.
1253       ((equal? style 'neo-modern)
1254        (set-accidentals-properties #f
1255                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1256                                            ,(make-accidental-rule 'any-octave 0)
1257                                            ,(make-accidental-rule 'same-octave 1)
1258                                            ,neo-modern-accidental-rule)
1259                                    '()
1260                                    context))
1261       ((equal? style 'neo-modern-cautionary)
1262        (set-accidentals-properties #f
1263                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1264                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1265                                            ,(make-accidental-rule 'same-octave 1)
1266                                            ,neo-modern-accidental-rule)
1267                                    context))
1268       ;; Accidentals as they were common in dodecaphonic music with no tonality.
1269       ;; Each note gets one accidental.
1270       ((equal? style 'dodecaphonic)
1271        (set-accidentals-properties #f
1272                                    `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1273                                    '()
1274                                    context))
1275       ;; Multivoice accidentals to be read both by musicians playing one voice
1276       ;; and musicians playing all voices.
1277       ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
1278       ((equal? style 'modern-voice)
1279        (set-accidentals-properties  #f
1280                                     `(Voice ,(make-accidental-rule 'same-octave 0)
1281                                             ,(make-accidental-rule 'any-octave 0)
1282                                             ,(make-accidental-rule 'same-octave 1)
1283                                       Staff ,(make-accidental-rule 'same-octave 0)
1284                                             ,(make-accidental-rule 'any-octave 0)
1285                                             ,(make-accidental-rule 'same-octave 1))
1286                                     '()
1287                                     context))
1288       ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1289       ;; as cautionaries
1290       ((equal? style 'modern-voice-cautionary)
1291        (set-accidentals-properties #f
1292                                    `(Voice ,(make-accidental-rule 'same-octave 0))
1293                                    `(Voice ,(make-accidental-rule 'any-octave 0)
1294                                            ,(make-accidental-rule 'same-octave 1)
1295                                      Staff ,(make-accidental-rule 'same-octave 0)
1296                                            ,(make-accidental-rule 'any-octave 0)
1297                                            ,(make-accidental-rule 'same-octave 1))
1298                                    context))
1299       ;; stone's suggestions for accidentals on grand staff.
1300       ;; Accidentals are cancelled across the staves in the same grand staff as well
1301       ((equal? style 'piano)
1302        (set-accidentals-properties #f
1303                                    `(Staff ,(make-accidental-rule 'same-octave 0)
1304                                            ,(make-accidental-rule 'any-octave 0)
1305                                            ,(make-accidental-rule 'same-octave 1)
1306                                      GrandStaff
1307                                            ,(make-accidental-rule 'any-octave 0)
1308                                            ,(make-accidental-rule 'same-octave 1))
1309                                    '()
1310                                    pcontext))
1311       ((equal? style 'piano-cautionary)
1312        (set-accidentals-properties #f
1313                                    `(Staff ,(make-accidental-rule 'same-octave 0))
1314                                    `(Staff ,(make-accidental-rule 'any-octave 0)
1315                                            ,(make-accidental-rule 'same-octave 1)
1316                                      GrandStaff
1317                                            ,(make-accidental-rule 'any-octave 0)
1318                                            ,(make-accidental-rule 'same-octave 1))
1319                                    pcontext))
1320
1321       ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1322       ;; tones specified by the key signature.
1323        ((equal? style 'teaching)
1324        (set-accidentals-properties #f
1325                                     `(Staff ,(make-accidental-rule 'same-octave 0))
1326                                     `(Staff ,(make-accidental-rule 'same-octave 1)
1327                                            ,teaching-accidental-rule)
1328                                    context))
1329
1330       ;; do not set localKeySignature when a note alterated differently from
1331       ;; localKeySignature is found.
1332       ;; Causes accidentals to be printed at every note instead of
1333       ;; remembered for the duration of a measure.
1334       ;; accidentals not being remembered, causing accidentals always to
1335       ;; be typeset relative to the time signature
1336       ((equal? style 'forget)
1337        (set-accidentals-properties '()
1338                                    `(Staff ,(make-accidental-rule 'same-octave -1))
1339                                    '()
1340                                    context))
1341       ;; Do not reset the key at the start of a measure.  Accidentals will be
1342       ;; printed only once and are in effect until overridden, possibly many
1343       ;; measures later.
1344       ((equal? style 'no-reset)
1345        (set-accidentals-properties '()
1346                                    `(Staff ,(make-accidental-rule 'same-octave #t))
1347                                    '()
1348                                    context))
1349       (else
1350        (ly:warning (_ "unknown accidental style: ~S") style)
1351        (make-sequential-music '()))))))
1352
1353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1354
1355 (define-public (skip-of-length mus)
1356   "Create a skip of exactly the same length as MUS."
1357   (let* ((skip
1358           (make-music
1359            'SkipEvent
1360            'duration (ly:make-duration 0 0))))
1361
1362     (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1363
1364 (define-public (mmrest-of-length mus)
1365   "Create a mmrest of exactly the same length as MUS."
1366
1367   (let* ((skip
1368           (make-multi-measure-rest
1369            (ly:make-duration 0 0) '())))
1370     (ly:music-compress skip (ly:music-length mus))
1371     skip))
1372
1373 (define-public (pitch-of-note event-chord)
1374
1375   (let*
1376       ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
1377                     (ly:music-property event-chord 'elements))))
1378
1379     (if (pair? evs)
1380         (ly:music-property (car evs) 'pitch)
1381         #f)))
1382
1383 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1384
1385 (define-public (extract-named-music music music-name)
1386 "Return a flat list of all music named @code{music-name}
1387 from @code{music}."
1388    (let ((extracted-list
1389           (if (ly:music? music)
1390               (if (eq? (ly:music-property music 'name) music-name)
1391                   (list music)
1392                   (let ((elt (ly:music-property music 'element))
1393                         (elts (ly:music-property music 'elements)))
1394                     (if (ly:music? elt)
1395                         (extract-named-music elt music-name)
1396                         (if (null? elts)
1397                             '()
1398                             (map (lambda(x)
1399                                     (extract-named-music x music-name ))
1400                              elts)))))
1401               '())))
1402      (flatten-list extracted-list)))
1403
1404 (define-public (event-chord-notes event-chord)
1405 "Return a list of all notes from @{event-chord}."
1406   (filter
1407     (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1408     (ly:music-property event-chord 'elements)))
1409
1410 (define-public (event-chord-pitches event-chord)
1411 "Return a list of all pitches from @{event-chord}."
1412   (map (lambda (x) (ly:music-property x 'pitch))
1413        (event-chord-notes event-chord)))