1 ;;;; music-functions.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
8 ;; (use-modules (ice-9 optargs))
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!))
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)))
24 (define-public ly:grob-property
25 (make-procedure-with-setter ly:grob-property
26 ly:grob-set-property!))
28 (define-public ly:prob-property
29 (make-procedure-with-setter ly:prob-property
30 ly:prob-set-property!))
32 (define-public (music-map function music)
33 "Apply @var{function} to @var{music} and all of the music it contains.
35 First it recurses over the children, then the function is applied to MUSIC.
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))
42 (set! (ly:music-property music 'element)
43 (music-map function e)))
46 (define-public (music-filter pred? music)
47 "Filter out music expressions that do not satisfy PRED."
49 (define (inner-music-filter pred? music)
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)
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 '()))
70 (set! music (inner-music-filter pred? music))
73 (make-music 'Music))) ;must return music.
75 (define-public (display-music music)
76 "Display music, not done with music-map for clarity of presentation."
80 (let ((es (ly:music-property music 'elements))
81 (e (ly:music-property music 'element)))
82 (display (ly:music-mutable-properties music))
84 (begin (display "\nElements: {\n")
85 (map display-music es)
95 ;;; A scheme music pretty printer
97 (define (markup-expression->make-markup markup-expression)
98 "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
100 \\markup \\bold \\italic hello
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))
115 (define (inner-markup->make-markup mrkup)
118 (let ((cmd (proc->command-keyword (car mrkup)))
119 (args (map transform-arg (cdr mrkup))))
122 (if (string? markup-expression)
124 `(markup ,@(inner-markup->make-markup markup-expression))))
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
131 (markup-expression->make-markup obj))
135 ',(ly:music-property obj 'name)
136 ,@(apply append (map (lambda (prop)
138 ,(music->make-music (cdr prop))))
139 (remove (lambda (prop)
140 (eqv? (car prop) 'origin))
141 (ly:music-mutable-properties 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)))
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))))
156 `(ly:make-pitch ,(ly:pitch-octave obj)
157 ,(ly:pitch-notename obj)
158 ,(ly:pitch-alteration obj)))
161 (or (procedure-name obj) obj))
162 (;; a symbol (avoid having an unquoted symbol)
165 (;; an empty list (avoid having an unquoted empty list)
170 `(list ,@(map music->make-music obj)))
173 `(cons ,(music->make-music (car obj))
174 ,(music->make-music (cdr obj))))
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.
185 (pretty-print (music->make-music obj) port)
190 ;;; Scheme music expression --> Lily-syntax-using string translator
192 (use-modules (srfi srfi-39)
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))
204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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)))
212 (let* ((cp (ly:duration-factor d))
213 (nd (ly:make-duration (+ shift (ly:duration-log d))
214 (+ dot (ly:duration-dot-count d))
217 (set! (ly:music-property music 'duration) nd)))
220 (define-public (shift-duration-log music shift dot)
221 (music-map (lambda (x) (shift-one-duration-log x shift dot))
224 (define-public (make-repeat name times main alts)
225 "create a repeat music expression, with all properties initialized properly"
226 (let ((talts (if (< times (length alts))
228 (ly:warning (_ "More alternatives than repeats. Junking excess alternatives"))
231 (r (make-repeated-music name)))
232 (set! (ly:music-property r 'element) main)
233 (set! (ly:music-property r 'repeat-count) (max times 1))
234 (set! (ly:music-property r 'elements) talts)
235 (if (equal? name "tremolo")
236 (let* ((dots (1- (logcount times)))
237 (mult (/ (* times (ash 1 dots)) (1- (ash 2 dots))))
238 (shift (- (ly:intlog2 (floor mult)))))
239 (if (not (integer? mult))
240 (ly:warning (_ "invalid tremolo repeat count: ~a") times))
241 (if (memq 'sequential-music (ly:music-property main 'types))
242 ;; \repeat "tremolo" { c4 d4 }
243 (let ((children (length (ly:music-property main 'elements))))
245 ;; fixme: should be more generic.
246 (if (and (not (= children 2))
247 (not (= children 1)))
248 (ly:warning (_ "expecting 2 elements for chord tremolo, found ~a") children))
249 (ly:music-compress r (ly:make-moment 1 children))
250 (shift-duration-log r
251 (if (= children 2) (1- shift) shift)
253 ;; \repeat "tremolo" c4
254 (shift-duration-log r shift dots)))
257 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
260 (define-public (note-to-cluster music)
261 "Replace NoteEvents by ClusterNoteEvents."
262 (if (eq? (ly:music-property music 'name) 'NoteEvent)
263 (make-music 'ClusterNoteEvent
264 'pitch (ly:music-property music 'pitch)
265 'duration (ly:music-property music 'duration))
268 (define-public (notes-to-clusters music)
269 (music-map note-to-cluster music))
271 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
274 (define-public (unfold-repeats music)
276 This function replaces all repeats with unfold repeats. "
278 (let ((es (ly:music-property music 'elements))
279 (e (ly:music-property music 'element))
281 (if (memq 'repeated-music (ly:music-property music 'types))
283 ((props (ly:music-mutable-properties music))
284 (old-name (ly:music-property music 'name))
285 (flattened (flatten-alist props)))
287 (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
290 (if (equal? old-name 'TremoloRepeatedMusic)
291 (let* ((seq-arg? (memq 'sequential-music
292 (ly:music-property e 'types)))
293 (count (ly:music-property music 'repeat-count))
294 (dot-shift (if (= 0 (remainder count 3))
298 (set! count (* 2 (quotient count 3))))
300 (shift-duration-log music (+ (if seq-arg? 1 0)
301 (ly:intlog2 count)) dot-shift)
304 (ly:music-compress e (ly:make-moment (length (ly:music-property
305 e 'elements)) 1)))))))
309 (set! (ly:music-property music 'elements)
310 (map unfold-repeats es)))
312 (set! (ly:music-property music 'element)
316 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
317 ;; property setting music objs.
319 (define-public (make-grob-property-set grob gprop val)
320 "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
321 i.e. this is not an override"
322 (make-music 'OverrideProperty
328 (define-public (make-grob-property-override grob gprop val)
329 "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
330 i.e. this is not an override"
331 (make-music 'OverrideProperty
336 (define-public (make-grob-property-revert grob gprop)
337 "Revert the grob property GPROP for GROB."
338 (make-music 'RevertProperty
340 'grob-property gprop))
342 (define direction-polyphonic-grobs
356 (define-safe-public (make-voice-props-set n)
357 (make-sequential-music
359 (map (lambda (x) (make-grob-property-set x 'direction
361 direction-polyphonic-grobs)
363 (make-property-set 'graceSettings
364 ;; TODO: take this from voicedGraceSettings or similar.
365 '((Voice Stem font-size -3)
366 (Voice NoteHead font-size -3)
367 (Voice Dots font-size -3)
368 (Voice Stem length-fraction 0.8)
369 (Voice Stem no-stem-extend #t)
370 (Voice Beam thickness 0.384)
371 (Voice Beam length-fraction 0.8)
372 (Voice Accidental font-size -4)
373 (Voice AccidentalCautionary font-size -4)
374 (Voice Script font-size -3)
375 (Voice Fingering font-size -8)
376 (Voice StringNumber font-size -8)))
378 (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
379 (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
381 (define-safe-public (make-voice-props-revert)
382 (make-sequential-music
384 (map (lambda (x) (make-grob-property-revert x 'direction))
385 direction-polyphonic-grobs)
386 (list (make-property-unset 'graceSettings)
387 (make-grob-property-revert 'NoteColumn 'horizontal-shift)
388 (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
391 (define-safe-public (context-spec-music m context #:optional id)
392 "Add \\context CONTEXT = ID to M. "
393 (let ((cm (make-music 'ContextSpeccedMusic
395 'context-type context)))
397 (set! (ly:music-property cm 'context-id) id))
400 (define-public (descend-to-context m context)
401 "Like context-spec-music, but only descending. "
402 (let ((cm (context-spec-music m context)))
403 (ly:music-set-property! cm 'descend-only #t)
406 (define-public (make-non-relative-music mus)
407 (make-music 'UnrelativableMusic
410 (define-public (make-apply-context func)
411 (make-music 'ApplyContext
414 (define-public (make-sequential-music elts)
415 (make-music 'SequentialMusic
418 (define-public (make-simultaneous-music elts)
419 (make-music 'SimultaneousMusic
422 (define-safe-public (make-event-chord elts)
423 (make-music 'EventChord
426 (define-public (make-skip-music dur)
427 (make-music 'SkipMusic
430 (define-public (make-grace-music music)
431 (make-music 'GraceMusic
437 (define-public (make-multi-measure-rest duration location)
438 (make-music 'MultiMeasureRestMusic
442 (define-public (make-property-set sym val)
443 (make-music 'PropertySet
447 (define-public (make-property-unset sym)
448 (make-music 'PropertyUnset
451 (define-public (make-ottava-set octavation)
452 (let ((m (make-music 'ApplyContext)))
453 (define (ottava-modify context)
454 "Either reset middleCPosition to the stored original, or remember
455 old middleCPosition, add OCTAVATION to middleCPosition, and set
456 OTTAVATION to `8va', or whatever appropriate."
457 (if (number? (ly:context-property context 'middleCOffset))
458 (let ((where (ly:context-property-where-defined context 'middleCOffset)))
459 (ly:context-unset-property where 'middleCOffset)
460 (ly:context-unset-property where 'ottavation)))
462 (let* ((offset (* -7 octavation))
463 (string (cdr (assoc octavation '((2 . "15ma")
468 (ly:context-set-property! context 'middleCOffset offset)
469 (ly:context-set-property! context 'ottavation string)
470 (ly:set-middle-C! context)))
471 (set! (ly:music-property m 'procedure) ottava-modify)
472 (context-spec-music m 'Staff)))
474 (define-public (set-octavation ottavation)
475 (ly:export (make-ottava-set ottavation)))
477 (define-public (make-time-signature-set num den . rest)
478 "Set properties for time signature NUM/DEN. Rest can contain a list
481 (define (standard-beat-grouping num den)
483 "Some standard subdivisions for time signatures."
485 ((key (cons num den))
487 ; Simple time signatures
490 ; Compound time signatures
496 (( 9 . 16) . (3 3 3))
497 ((12 . 4) . (3 3 3 3))
498 ((12 . 8) . (3 3 3 3))
499 ((12 . 16) . (3 3 3 3))
500 ; Some common irregular time signatures
509 (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
510 (beat (ly:make-moment 1 den))
511 (len (ly:make-moment num den))
512 (set2 (make-property-set 'beatLength beat))
513 (set3 (make-property-set 'measureLength len))
514 (set4 (make-property-set 'beatGrouping (if (pair? rest)
516 (standard-beat-grouping num den))))
517 (basic (list set1 set2 set3 set4)))
519 (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
521 (define-public (make-mark-set label)
522 "Make the music for the \\mark command."
523 (let* ((set (if (integer? label)
524 (context-spec-music (make-property-set 'rehearsalMark label)
527 (ev (make-music 'MarkEvent))
528 (ch (make-event-chord (list ev))))
530 (make-sequential-music (list set ch))
532 (set! (ly:music-property ev 'label) label)
535 (define-public (set-time-signature num den . rest)
536 (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
538 (define-safe-public (make-articulation name)
539 (make-music 'ArticulationEvent
540 'articulation-type name))
542 (define-public (make-lyric-event string duration)
543 (make-music 'LyricEvent
547 (define-safe-public (make-span-event type span-dir)
549 'span-direction span-dir))
551 (define-public (set-mus-properties! m alist)
552 "Set all of ALIST as properties of M."
555 (set! (ly:music-property m (caar alist)) (cdar alist))
556 (set-mus-properties! m (cdr alist)))))
558 (define-public (music-separator? m)
560 (let ((ts (ly:music-property m 'types)))
561 (memq 'separator ts)))
563 ;;; splitting chords into voices.
564 (define (voicify-list lst number)
565 "Make a list of Musics.
567 voicify-list :: [ [Music ] ] -> number -> [Music]
568 LST is a list music-lists.
570 NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
574 (cons (context-spec-music
575 (make-sequential-music
576 (list (make-voice-props-set number)
577 (make-simultaneous-music (car lst))))
578 'Voice (number->string (1+ number)))
579 (voicify-list (cdr lst) (1+ number)))))
581 (define (voicify-chord ch)
582 "Split the parts of a chord into different Voices using separator"
583 (let ((es (ly:music-property ch 'elements)))
584 (set! (ly:music-property ch 'elements)
585 (voicify-list (split-list-by-separator es music-separator?) 0))
588 (define-public (voicify-music m)
589 "Recursively split chords that are separated with \\ "
590 (if (not (ly:music? m))
591 (ly:error (_ "music expected: ~S") m))
592 (let ((es (ly:music-property m 'elements))
593 (e (ly:music-property m 'element)))
596 (set! (ly:music-property m 'elements) (map voicify-music es)))
598 (set! (ly:music-property m 'element) (voicify-music e)))
599 (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
600 (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
601 (set! m (context-spec-music (voicify-chord m) 'Staff)))
604 (define-public (empty-music)
605 (ly:export (make-music 'Music)))
607 ;; Make a function that checks score element for being of a specific type.
608 (define-public (make-type-checker symbol)
611 ;;(eq? #t (ly:grob-property elt symbol))
612 (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
614 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
616 (set! (ly:grob-property grob sym) val)))
619 (define-public ((set-output-property grob-name symbol val) grob grob-c context)
622 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
625 (let ((meta (ly:grob-property grob 'meta)))
626 (if (equal? (cdr (assoc 'name meta)) grob-name)
627 (set! (ly:grob-property grob symbol) val))))
631 (define-public (smart-bar-check n)
632 "Make a bar check that checks for a specific bar number.
634 (let ((m (make-music 'ApplyContext)))
636 (let* ((bn (ly:context-property tr 'currentBarNumber)))
640 ;; FIXME: uncomprehensable message
641 (_ "Bar check failed. Expect to be at ~a, instead at ~a")
643 (set! (ly:music-property m 'procedure) checker)
647 (define-public (skip->rest mus)
649 "Replace MUS by RestEvent of the same duration if it is a
650 SkipEvent. Useful for extracting parts from crowded scores"
652 (if (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
653 (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
657 (define-public (music-has-type music type)
658 (memq type (ly:music-property music 'types)))
660 (define-public (music-clone music)
661 (define (alist->args alist acc)
664 (alist->args (cdr alist)
665 (cons (caar alist) (cons (cdar alist) acc)))))
669 (ly:music-property music 'name)
670 (alist->args (ly:music-mutable-properties music) '())))
672 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
673 ;; warn for bare chords at start.
676 (define-public (ly:music-message music msg)
677 (let ((ip (ly:music-property music 'origin)))
678 (if (ly:input-location? ip)
679 (ly:input-message ip msg)
682 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
684 ;; setting stuff for grace context.
687 (define (vector-extend v x)
688 "Make a new vector consisting of V, with X added to the end."
689 (let* ((n (vector-length v))
690 (nv (make-vector (+ n 1) '())))
691 (vector-move-left! v 0 n nv 0)
695 (define (vector-map f v)
696 "Map F over V. This function returns nothing."
697 (do ((n (vector-length v))
700 (f (vector-ref v i))))
702 (define (vector-reverse-map f v)
703 "Map F over V, N to 0 order. This function returns nothing."
704 (do ((i (- (vector-length v) 1) (- i 1)))
706 (f (vector-ref v i))))
708 (define-public (add-grace-property context-name grob sym val)
709 "Set SYM=VAL for GROB in CONTEXT-NAME. "
710 (define (set-prop context)
711 (let* ((where (ly:context-property-where-defined context 'graceSettings))
712 (current (ly:context-property where 'graceSettings))
713 (new-settings (append current
714 (list (list context-name grob sym val)))))
715 (ly:context-set-property! where 'graceSettings new-settings)))
716 (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
718 (define-public (remove-grace-property context-name grob sym)
719 "Remove all SYM for GROB in CONTEXT-NAME. "
720 (define (sym-grob-context? property sym grob context-name)
721 (and (eq? (car property) context-name)
722 (eq? (cadr property) grob)
723 (eq? (caddr property) sym)))
724 (define (delete-prop context)
725 (let* ((where (ly:context-property-where-defined context 'graceSettings))
726 (current (ly:context-property where 'graceSettings))
727 (prop-settings (filter
728 (lambda(x) (sym-grob-context? x sym grob context-name))
730 (new-settings current))
732 (set! new-settings (delete x new-settings)))
734 (ly:context-set-property! where 'graceSettings new-settings)))
735 (ly:export (context-spec-music (make-apply-context delete-prop) 'Voice)))
739 (defmacro-public def-grace-function (start stop . docstring)
740 "Helper macro for defining grace music"
741 `(define-music-function (parser location music) (ly:music?)
743 (make-music 'GraceMusic
745 'element (make-music 'SequentialMusic
746 'elements (list (ly:music-deep-copy ,start)
748 (ly:music-deep-copy ,stop))))))
750 (defmacro-public define-music-function (args signature . body)
751 "Helper macro for `ly:make-music-function'.
753 (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
756 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
757 ;; When the music function definition contains a i10n doc string,
758 ;; (_i "doc string"), keep the literal string only
759 (let ((docstring (cadar body))
761 `(ly:make-music-function (list ,@signature)
765 `(ly:make-music-function (list ,@signature)
770 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
772 (define-public (cue-substitute quote-music)
773 "Must happen after quote-substitute."
775 (if (vector? (ly:music-property quote-music 'quoted-events))
776 (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
777 (main-voice (if (eq? 1 dir) 1 0))
778 (cue-voice (if (eq? 1 dir) 0 1))
779 (main-music (ly:music-property quote-music 'element))
780 (return-value quote-music))
782 (if (or (eq? 1 dir) (eq? -1 dir))
784 ;; if we have stem dirs, change both quoted and main music
785 ;; to have opposite stems.
789 ;; cannot context-spec Quote-music, since context
790 ;; for the quotes is determined in the iterator.
791 (make-sequential-music
793 (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
795 (context-spec-music (make-voice-props-revert) 'CueVoice "cue"))))
797 (make-sequential-music
799 (make-voice-props-set main-voice)
801 (make-voice-props-revert))))
802 (set! (ly:music-property quote-music 'element) main-music)))
807 (define-public ((quote-substitute quote-tab) music)
808 (let* ((quoted-name (ly:music-property music 'quoted-music-name))
809 (quoted-vector (if (string? quoted-name)
810 (hash-ref quote-tab quoted-name #f)
814 (if (string? quoted-name)
815 (if (vector? quoted-vector)
817 (set! (ly:music-property music 'quoted-events) quoted-vector)
818 (set! (ly:music-property music 'iterator-ctor)
819 ly:quote-iterator::constructor))
820 (ly:warning (_ "cannot find quoted music: `~S'") quoted-name)))
824 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
825 ;; switch it on here, so parsing and init isn't checked (too slow!)
827 ;; automatic music transformations.
829 (define (switch-on-debugging m)
830 (if (defined? 'set-debug-cell-accesses!)
831 (set-debug-cell-accesses! 15000))
834 (define (music-check-error music)
837 (if (and (ly:music? m)
838 (eq? (ly:music-property m 'error-found) #t))
841 (for-each signal (ly:music-property music 'elements))
842 (signal (ly:music-property music 'element))
845 (set! (ly:music-property music 'error-found) #t))
848 (define (precompute-music-length music)
849 (set! (ly:music-property music 'length)
850 (ly:music-length music))
853 (define-public (make-duration-of-length moment)
854 "Make duration of the given MOMENT length."
855 (ly:make-duration 0 0
856 (ly:moment-main-numerator moment)
857 (ly:moment-main-denominator moment)))
859 (define (skip-this moment)
860 "set skipTypesetting, make SkipMusic of the given MOMENT length,
861 and then unset skipTypesetting."
862 (make-sequential-music
864 (context-spec-music (make-property-set 'skipTypesetting #t)
866 (make-music 'SkipMusic 'duration
867 (make-duration-of-length moment))
868 (context-spec-music (make-property-set 'skipTypesetting #f)
871 (define (unskip-this moment)
872 "unset skipTypesetting, make SkipMusic of the given MOMENT length,
873 and then set skipTypesetting."
874 (make-sequential-music
876 (context-spec-music (make-property-set 'skipTypesetting #f)
878 (make-music 'SkipMusic 'duration
879 (make-duration-of-length moment))
880 (context-spec-music (make-property-set 'skipTypesetting #t)
883 (define (skip-as-needed music parser)
885 << { \\set skipTypesetting = ##f
886 LENGTHOF(\\showFirstLength)
887 \\set skipTypesetting = ##t
888 LENGTHOF(\\showLastLength) }
892 When only showFirstLength is set,
893 the 'length property of the music is
894 overridden to speed up compiling."
896 ((show-last (ly:parser-lookup parser 'showLastLength))
897 (show-first (ly:parser-lookup parser 'showFirstLength)))
900 ;; both properties may be set.
901 ((and (ly:music? show-first) (ly:music? show-last))
903 ((orig-length (ly:music-length music))
904 (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))
905 (begin-length (ly:music-length show-first)))
906 (make-simultaneous-music
908 (make-sequential-music
910 (skip-this skip-length)
911 ;; let's draw a separator between the beginning and the end
912 (context-spec-music (make-property-set 'whichBar "||")
914 (unskip-this begin-length)
917 ;; we may only want to print the last length
918 ((ly:music? show-last)
920 ((orig-length (ly:music-length music))
921 (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
922 (make-simultaneous-music
924 (skip-this skip-length)
927 ;; we may only want to print the beginning; in this case
928 ;; only the first length will be processed (much faster).
929 ((ly:music? show-first)
931 ((orig-length (ly:music-length music))
932 (begin-length (ly:music-length show-first)))
933 ;; the first length must not exceed the original length.
934 (if (ly:moment<? begin-length orig-length)
935 (set! (ly:music-property music 'length)
936 (ly:music-length show-first)))
942 (define-public toplevel-music-functions
944 (lambda (music parser) (voicify-music music))
945 (lambda (x parser) (music-map music-check-error x))
946 (lambda (x parser) (music-map precompute-music-length x))
947 (lambda (music parser)
949 (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes)) music))
951 ;; switch-on-debugging
952 (lambda (x parser) (music-map cue-substitute x))
955 (skip-as-needed x parser)
959 ;;; general purpose music functions
961 (define (shift-octave pitch octave-shift)
962 (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
964 (+ (ly:pitch-octave pitch) octave-shift)
965 (ly:pitch-notename pitch)
966 (ly:pitch-alteration pitch)))
972 (define (apply-durations lyric-music durations)
973 (define (apply-duration music)
974 (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
975 (ly:duration? (ly:music-property music 'duration)))
977 (set! (ly:music-property music 'duration) (car durations))
978 (set! durations (cdr durations)))))
980 (music-map apply-duration lyric-music))
983 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
986 (define (recent-enough? bar-number alteration-def laziness)
987 (if (or (number? alteration-def)
988 (equal? laziness #t))
990 (<= bar-number (+ (cadr alteration-def) laziness))))
992 (define (is-tied? alteration-def)
993 (let* ((def (if (pair? alteration-def)
997 (if (equal? def 'tied) #t #f)))
999 (define (extract-alteration alteration-def)
1000 (cond ((number? alteration-def)
1002 ((pair? alteration-def)
1003 (car alteration-def))
1006 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1007 "Checks the need for an accidental and a @q{restore} accidental against
1008 @code{localKeySignature}. The @var{laziness} is the number of measures
1009 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1010 only cancel accidentals in the same measure; if @var{laziness} is three,
1011 we cancel accidentals up to three measures after they first appear.
1012 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1013 specifies whether accidentals should be canceled in different octaves."
1014 (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1015 ((equal? octaveness 'same-octave) #f)
1017 (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1018 (ly:warning (_ "Defaulting to 'any-octave."))
1020 (key-sig (ly:context-property context 'keySignature))
1021 (local-key-sig (ly:context-property context 'localKeySignature))
1022 (notename (ly:pitch-notename pitch))
1023 (octave (ly:pitch-octave pitch))
1024 (pitch-handle (cons octave notename))
1026 (need-accidental #f)
1027 (previous-alteration #f)
1028 (from-other-octaves #f)
1029 (from-same-octave (ly:assoc-get pitch-handle local-key-sig))
1030 (from-key-sig (ly:assoc-get notename local-key-sig)))
1032 ;; If no key signature match is found from localKeySignature, we may have a custom
1033 ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1034 ;; instead of (pitch . alteration). Since this type cannot coexist with entries in
1035 ;; localKeySignature, try extracting from keySignature instead.
1036 (if (equal? from-key-sig #f)
1037 (set! from-key-sig (ly:assoc-get pitch-handle key-sig)))
1039 ;; loop through localKeySignature to search for a notename match from other octaves
1040 (let loop ((l local-key-sig))
1042 (let ((entry (car l)))
1043 (if (and (pair? (car entry))
1044 (= (cdar entry) notename))
1045 (set! from-other-octaves (cdr entry))
1048 ;; find previous alteration-def for comparison with pitch
1050 ;; from same octave?
1051 ((and (eq? ignore-octave #f)
1052 (not (equal? from-same-octave #f))
1053 (recent-enough? barnum from-same-octave laziness))
1054 (set! previous-alteration from-same-octave))
1057 ((and (eq? ignore-octave #t)
1058 (not (equal? from-other-octaves #f))
1059 (recent-enough? barnum from-other-octaves laziness))
1060 (set! previous-alteration from-other-octaves))
1062 ;; not recent enough, extract from key signature/local key signature
1063 ((not (equal? from-key-sig #f))
1064 (set! previous-alteration from-key-sig)))
1066 (if (is-tied? previous-alteration)
1067 (set! need-accidental #t)
1069 (let* ((prev-alt (extract-alteration previous-alteration))
1070 (this-alt (ly:pitch-alteration pitch)))
1072 (if (not (= this-alt prev-alt))
1074 (set! need-accidental #t)
1075 (if (and (not (= this-alt 0))
1076 (or (< (abs this-alt) (abs prev-alt))
1077 (< (* prev-alt this-alt) 0)))
1078 (set! need-restore #t))))))
1080 (cons need-restore need-accidental)))
1082 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1083 "Creates an accidental rule that makes its decision based on the octave of the note
1084 and a laziness value.
1085 octaveness is either 'same-octave or 'any-octave and defines whether the rule should
1086 respond to accidental changes in other octaves than the current. 'same-octave is the
1087 normal way to typeset accidentals - an accidental is made if the alteration is different
1088 from the last active pitch in the same octave. 'any-octave looks at the last active pitch
1090 laziness states over how many bars an accidental should be remembered.
1091 0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
1092 A positive integer means that the accidental lasts over that many bar lines.
1093 -1 is 'forget immediately', that is, only look at key signature.
1095 (check-pitch-against-signature context pitch barnum laziness octaveness))
1097 (define (key-entry-notename entry)
1098 "Return the pitch of an entry in localKeySignature. The entry is either of the form
1099 '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))."
1100 (if (number? (car entry))
1104 (define (key-entry-octave entry)
1105 "Return the octave of an entry in localKeySignature (or #f if the entry does not have
1107 (and (pair? (car entry)) (caar entry)))
1109 (define (key-entry-bar-number entry)
1110 "Return the bar number of an entry in localKeySignature (or #f if the entry does not
1111 have a bar number)."
1112 (and (pair? (car entry)) (caddr entry)))
1114 (define (key-entry-measure-position entry)
1115 "Return the measure position of an entry in localKeySignature (or #f if the entry does
1116 not have a measure position)."
1117 (and (pair? (car entry)) (cdddr entry)))
1119 (define (key-entry-alteration entry)
1120 "Return the alteration of an entry in localKeySignature."
1121 (if (number? (car entry))
1125 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1126 "Return the first entry in keysig that matches the pitch.
1127 accept-global states whether key signature entries should be included.
1128 accept-local states whether local accidentals should be included.
1129 if no matching entry is found, #f is returned."
1131 (let* ((entry (car keysig))
1132 (entryoct (key-entry-octave entry))
1133 (entrynn (key-entry-notename entry))
1134 (oct (ly:pitch-octave pitch))
1135 (nn (ly:pitch-notename pitch)))
1136 (if (and (equal? nn entrynn)
1137 (or (and accept-global (equal? #f entryoct))
1138 (and accept-local (equal? oct entryoct))))
1140 (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))
1143 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1144 "an accidental rule that typesets an accidental if it differs from the key signature
1145 AND does not directly follow a note on the same staff-line.
1146 This rule should not be used alone because it does neither look at bar lines
1147 nor different accidentals at the same notename"
1148 (let* ((keysig (ly:context-property context 'localKeySignature))
1149 (entry (find-pitch-entry keysig pitch #t #t)))
1150 (if (equal? #f entry)
1152 (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1153 (key-acc (if (equal? global-entry #f)
1155 (key-entry-alteration global-entry)))
1156 (acc (ly:pitch-alteration pitch))
1157 (entrymp (key-entry-measure-position entry))
1158 (entrybn (key-entry-bar-number entry)))
1159 (cons #f (not (or (equal? acc key-acc)
1160 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1162 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1163 "an accidental rule that typesets a cautionary accidental
1164 if it is included in the key signature AND does not directly follow
1165 a note on the same staff-line."
1166 (let* ((keysig (ly:context-property context 'localKeySignature))
1167 (entry (find-pitch-entry keysig pitch #t #t)))
1168 (if (equal? #f entry)
1170 (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1171 (key-acc (if (equal? global-entry #f)
1173 (key-entry-alteration global-entry)))
1174 (acc (ly:pitch-alteration pitch))
1175 (entrymp (key-entry-measure-position entry))
1176 (entrybn (key-entry-bar-number entry)))
1177 (cons #f (not (or (equal? acc key-acc)
1178 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1180 (define-public (set-accidentals-properties extra-natural
1181 auto-accs auto-cauts
1184 (make-sequential-music
1185 (append (if (boolean? extra-natural)
1186 (list (make-property-set 'extraNatural extra-natural))
1188 (list (make-property-set 'autoAccidentals auto-accs)
1189 (make-property-set 'autoCautionaries auto-cauts))))
1192 (define-public (set-accidental-style style . rest)
1193 "Set accidental style to STYLE. Optionally takes a context argument,
1194 e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which
1195 use GrandStaff as a context. "
1196 (let ((context (if (pair? rest)
1198 (pcontext (if (pair? rest)
1199 (car rest) 'GrandStaff)))
1202 ;; accidentals as they were common in the 18th century.
1203 ((equal? style 'default)
1204 (set-accidentals-properties #t
1205 `(Staff ,(make-accidental-rule 'same-octave 0))
1208 ;; accidentals from one voice do NOT get cancelled in other voices
1209 ((equal? style 'voice)
1210 (set-accidentals-properties #t
1211 `(Voice ,(make-accidental-rule 'same-octave 0))
1214 ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1215 ;; This includes all the default accidentals, but accidentals also needs cancelling
1216 ;; in other octaves and in the next measure.
1217 ((equal? style 'modern)
1218 (set-accidentals-properties #f
1219 `(Staff ,(make-accidental-rule 'same-octave 0)
1220 ,(make-accidental-rule 'any-octave 0)
1221 ,(make-accidental-rule 'same-octave 1))
1224 ;; the accidentals that Stone adds to the old standard as cautionaries
1225 ((equal? style 'modern-cautionary)
1226 (set-accidentals-properties #f
1227 `(Staff ,(make-accidental-rule 'same-octave 0))
1228 `(Staff ,(make-accidental-rule 'any-octave 0)
1229 ,(make-accidental-rule 'same-octave 1))
1231 ;; same as modern, but accidentals different from the key signature are always
1232 ;; typeset - unless they directly follow a note of the same pitch.
1233 ((equal? style 'neo-modern)
1234 (set-accidentals-properties #f
1235 `(Staff ,(make-accidental-rule 'same-octave 0)
1236 ,(make-accidental-rule 'any-octave 0)
1237 ,(make-accidental-rule 'same-octave 1)
1238 ,neo-modern-accidental-rule)
1241 ((equal? style 'neo-modern-cautionary)
1242 (set-accidentals-properties #f
1243 `(Staff ,(make-accidental-rule 'same-octave 0))
1244 `(Staff ,(make-accidental-rule 'any-octave 0)
1245 ,(make-accidental-rule 'same-octave 1)
1246 ,neo-modern-accidental-rule)
1248 ;; Accidentals as they were common in dodecaphonic music with no tonality.
1249 ;; Each note gets one accidental.
1250 ((equal? style 'dodecaphonic)
1251 (set-accidentals-properties #f
1252 `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1255 ;; Multivoice accidentals to be read both by musicians playing one voice
1256 ;; and musicians playing all voices.
1257 ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
1258 ((equal? style 'modern-voice)
1259 (set-accidentals-properties #f
1260 `(Voice ,(make-accidental-rule 'same-octave 0)
1261 ,(make-accidental-rule 'any-octave 0)
1262 ,(make-accidental-rule 'same-octave 1)
1263 Staff ,(make-accidental-rule 'same-octave 0)
1264 ,(make-accidental-rule 'any-octave 0)
1265 ,(make-accidental-rule 'same-octave 1))
1268 ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1270 ((equal? style 'modern-voice-cautionary)
1271 (set-accidentals-properties #f
1272 `(Voice ,(make-accidental-rule 'same-octave 0))
1273 `(Voice ,(make-accidental-rule 'any-octave 0)
1274 ,(make-accidental-rule 'same-octave 1)
1275 Staff ,(make-accidental-rule 'same-octave 0)
1276 ,(make-accidental-rule 'any-octave 0)
1277 ,(make-accidental-rule 'same-octave 1))
1279 ;; stone's suggestions for accidentals on grand staff.
1280 ;; Accidentals are cancelled across the staves in the same grand staff as well
1281 ((equal? style 'piano)
1282 (set-accidentals-properties #f
1283 `(Staff ,(make-accidental-rule 'same-octave 0)
1284 ,(make-accidental-rule 'any-octave 0)
1285 ,(make-accidental-rule 'same-octave 1)
1287 ,(make-accidental-rule 'any-octave 0)
1288 ,(make-accidental-rule 'same-octave 1))
1291 ((equal? style 'piano-cautionary)
1292 (set-accidentals-properties #f
1293 `(Staff ,(make-accidental-rule 'same-octave 0))
1294 `(Staff ,(make-accidental-rule 'any-octave 0)
1295 ,(make-accidental-rule 'same-octave 1)
1297 ,(make-accidental-rule 'any-octave 0)
1298 ,(make-accidental-rule 'same-octave 1))
1301 ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1302 ;; tones specified by the key signature.
1303 ((equal? style 'teaching)
1304 (set-accidentals-properties #f
1305 `(Staff ,(make-accidental-rule 'same-octave 0))
1306 `(Staff ,(make-accidental-rule 'same-octave 1)
1307 ,teaching-accidental-rule)
1310 ;; do not set localKeySignature when a note alterated differently from
1311 ;; localKeySignature is found.
1312 ;; Causes accidentals to be printed at every note instead of
1313 ;; remembered for the duration of a measure.
1314 ;; accidentals not being remembered, causing accidentals always to
1315 ;; be typeset relative to the time signature
1316 ((equal? style 'forget)
1317 (set-accidentals-properties '()
1318 `(Staff ,(make-accidental-rule 'same-octave -1))
1321 ;; Do not reset the key at the start of a measure. Accidentals will be
1322 ;; printed only once and are in effect until overridden, possibly many
1324 ((equal? style 'no-reset)
1325 (set-accidentals-properties '()
1326 `(Staff ,(make-accidental-rule 'same-octave #t))
1330 (ly:warning (_ "unknown accidental style: ~S") style)
1331 (make-sequential-music '()))))))
1333 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1335 (define-public (skip-of-length mus)
1336 "Create a skip of exactly the same length as MUS."
1340 'duration (ly:make-duration 0 0))))
1342 (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1344 (define-public (mmrest-of-length mus)
1345 "Create a mmrest of exactly the same length as MUS."
1348 (make-multi-measure-rest
1349 (ly:make-duration 0 0) '())))
1350 (ly:music-compress skip (ly:music-length mus))
1353 (define-public (pitch-of-note event-chord)
1356 ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
1357 (ly:music-property event-chord 'elements))))
1360 (ly:music-property (car evs) 'pitch)
1363 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1365 (define-public (extract-named-music music music-name)
1366 "Return a flat list of all music named @code{music-name}
1368 (let ((extracted-list
1369 (if (ly:music? music)
1370 (if (eq? (ly:music-property music 'name) music-name)
1372 (let ((elt (ly:music-property music 'element))
1373 (elts (ly:music-property music 'elements)))
1375 (extract-named-music elt music-name)
1379 (extract-named-music x music-name ))
1382 (flatten-list extracted-list)))
1384 (define-public (event-chord-notes event-chord)
1385 "Return a list of all notes from @{event-chord}."
1387 (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1388 (ly:music-property event-chord 'elements)))
1390 (define-public (event-chord-pitches event-chord)
1391 "Return a list of all pitches from @{event-chord}."
1392 (map (lambda (x) (ly:music-property x 'pitch))
1393 (event-chord-notes event-chord)))