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 (define (first-note-duration music)
227 "Finds the duration of the first NoteEvent by searching depth-first
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))))
235 (let ((dur (first-note-duration (car elts))))
236 (if (ly:duration? dur)
238 (loop (cdr elts))))))))
240 (let ((talts (if (< times (length alts))
242 (ly:warning (_ "More alternatives than repeats. Junking excess alternatives"))
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)
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))))
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)
273 ;; \repeat "tremolo" c4
274 (shift-duration-log r shift dots)))
277 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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))
288 (define-public (notes-to-clusters music)
289 (music-map note-to-cluster music))
291 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
294 (define-public (unfold-repeats music)
296 This function replaces all repeats with unfold repeats. "
298 (let ((es (ly:music-property music 'elements))
299 (e (ly:music-property music 'element))
301 (if (memq 'repeated-music (ly:music-property music 'types))
303 ((props (ly:music-mutable-properties music))
304 (old-name (ly:music-property music 'name))
305 (flattened (flatten-alist props)))
307 (set! music (apply make-music (cons 'UnfoldedRepeatedMusic
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))
318 (set! count (* 2 (quotient count 3))))
320 (shift-duration-log music (+ (if seq-arg? 1 0)
321 (ly:intlog2 count)) dot-shift)
324 (ly:music-compress e (ly:make-moment (length (ly:music-property
325 e 'elements)) 1)))))))
329 (set! (ly:music-property music 'elements)
330 (map unfold-repeats es)))
332 (set! (ly:music-property music 'element)
336 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
337 ;; property setting music objs.
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
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
356 (define-public (make-grob-property-revert grob gprop)
357 "Revert the grob property GPROP for GROB."
358 (make-music 'RevertProperty
360 'grob-property gprop))
362 (define direction-polyphonic-grobs
376 (define-safe-public (make-voice-props-set n)
377 (make-sequential-music
379 (map (lambda (x) (make-grob-property-set x 'direction
381 direction-polyphonic-grobs)
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 TabNoteHead font-size -4)
388 (Voice Dots font-size -3)
389 (Voice Stem length-fraction 0.8)
390 (Voice Stem no-stem-extend #t)
391 (Voice Beam thickness 0.384)
392 (Voice Beam length-fraction 0.8)
393 (Voice Accidental font-size -4)
394 (Voice AccidentalCautionary font-size -4)
395 (Voice Script font-size -3)
396 (Voice Fingering font-size -8)
397 (Voice StringNumber font-size -8)))
399 (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
400 (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
402 (define-safe-public (make-voice-props-revert)
403 (make-sequential-music
405 (map (lambda (x) (make-grob-property-revert x 'direction))
406 direction-polyphonic-grobs)
407 (list (make-property-unset 'graceSettings)
408 (make-grob-property-revert 'NoteColumn 'horizontal-shift)
409 (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
412 (define-safe-public (context-spec-music m context #:optional id)
413 "Add \\context CONTEXT = ID to M. "
414 (let ((cm (make-music 'ContextSpeccedMusic
416 'context-type context)))
418 (set! (ly:music-property cm 'context-id) id))
421 (define-public (descend-to-context m context)
422 "Like context-spec-music, but only descending. "
423 (let ((cm (context-spec-music m context)))
424 (ly:music-set-property! cm 'descend-only #t)
427 (define-public (make-non-relative-music mus)
428 (make-music 'UnrelativableMusic
431 (define-public (make-apply-context func)
432 (make-music 'ApplyContext
435 (define-public (make-sequential-music elts)
436 (make-music 'SequentialMusic
439 (define-public (make-simultaneous-music elts)
440 (make-music 'SimultaneousMusic
443 (define-safe-public (make-event-chord elts)
444 (make-music 'EventChord
447 (define-public (make-skip-music dur)
448 (make-music 'SkipMusic
451 (define-public (make-grace-music music)
452 (make-music 'GraceMusic
458 (define-public (make-multi-measure-rest duration location)
459 (make-music 'MultiMeasureRestMusic
463 (define-public (make-property-set sym val)
464 (make-music 'PropertySet
468 (define-public (make-property-unset sym)
469 (make-music 'PropertyUnset
472 (define-public (make-ottava-set octavation)
473 (let ((m (make-music 'ApplyContext)))
474 (define (ottava-modify context)
475 "Either reset middleCPosition to the stored original, or remember
476 old middleCPosition, add OCTAVATION to middleCPosition, and set
477 OTTAVATION to `8va', or whatever appropriate."
478 (if (number? (ly:context-property context 'middleCOffset))
479 (let ((where (ly:context-property-where-defined context 'middleCOffset)))
480 (ly:context-unset-property where 'middleCOffset)
481 (ly:context-unset-property where 'ottavation)))
483 (let* ((offset (* -7 octavation))
484 (string (cdr (assoc octavation '((2 . "15ma")
489 (ly:context-set-property! context 'middleCOffset offset)
490 (ly:context-set-property! context 'ottavation string)
491 (ly:set-middle-C! context)))
492 (set! (ly:music-property m 'procedure) ottava-modify)
493 (context-spec-music m 'Staff)))
495 (define-public (set-octavation ottavation)
496 (ly:export (make-ottava-set ottavation)))
498 ;;; Need to keep this definition for \time calls from parser
499 (define-public (make-time-signature-set num den)
500 "Set properties for time signature NUM/DEN."
501 (make-beam-rule-time-signature-set num den '()))
503 ;;; Used for calls that include beat-grouping setting
504 (define-public (set-time-signature num den . rest)
505 "Set properties for time signature @var{num/den}.
506 If @var{rest} is present, it is used to make a default
507 @code{beamSetting} rule."
508 (ly:export (apply make-beam-rule-time-signature-set
509 (list num den rest))))
511 (define-public (make-beam-rule-time-signature-set num den rest)
512 "Implement settings for new time signature. Can be
513 called from either make-time-signature-set (used by \time
514 in parser) or set-time-signature (called from scheme code
515 included in .ly file."
517 (define (make-default-beaming-rule context)
518 (override-property-setting
521 (list (cons num den) 'end)
522 (list (cons '* (car rest)))))
524 (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
525 (beat (ly:make-moment 1 den))
526 (len (ly:make-moment num den))
527 (set2 (make-property-set 'beatLength beat))
528 (set3 (make-property-set 'measureLength len))
532 (list (make-apply-context make-default-beaming-rule))))
533 (output (cons* set1 set2 set3 beaming-rule)))
536 (make-sequential-music output)
540 (define-public (make-mark-set label)
541 "Make the music for the \\mark command."
542 (let* ((set (if (integer? label)
543 (context-spec-music (make-property-set 'rehearsalMark label)
546 (ev (make-music 'MarkEvent))
547 (ch (make-event-chord (list ev))))
549 (make-sequential-music (list set ch))
551 (set! (ly:music-property ev 'label) label)
554 (define-safe-public (make-articulation name)
555 (make-music 'ArticulationEvent
556 'articulation-type name))
558 (define-public (make-lyric-event string duration)
559 (make-music 'LyricEvent
563 (define-safe-public (make-span-event type span-dir)
565 'span-direction span-dir))
567 (define-public (set-mus-properties! m alist)
568 "Set all of ALIST as properties of M."
571 (set! (ly:music-property m (caar alist)) (cdar alist))
572 (set-mus-properties! m (cdr alist)))))
574 (define-public (music-separator? m)
576 (let ((ts (ly:music-property m 'types)))
577 (memq 'separator ts)))
579 ;;; splitting chords into voices.
580 (define (voicify-list lst number)
581 "Make a list of Musics.
583 voicify-list :: [ [Music ] ] -> number -> [Music]
584 LST is a list music-lists.
586 NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
590 (cons (context-spec-music
591 (make-sequential-music
592 (list (make-voice-props-set number)
593 (make-simultaneous-music (car lst))))
594 'Voice (number->string (1+ number)))
595 (voicify-list (cdr lst) (1+ number)))))
597 (define (voicify-chord ch)
598 "Split the parts of a chord into different Voices using separator"
599 (let ((es (ly:music-property ch 'elements)))
600 (set! (ly:music-property ch 'elements)
601 (voicify-list (split-list-by-separator es music-separator?) 0))
604 (define-public (voicify-music m)
605 "Recursively split chords that are separated with \\ "
606 (if (not (ly:music? m))
607 (ly:error (_ "music expected: ~S") m))
608 (let ((es (ly:music-property m 'elements))
609 (e (ly:music-property m 'element)))
612 (set! (ly:music-property m 'elements) (map voicify-music es)))
614 (set! (ly:music-property m 'element) (voicify-music e)))
615 (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
616 (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
617 (set! m (context-spec-music (voicify-chord m) 'Staff)))
620 (define-public (empty-music)
621 (ly:export (make-music 'Music)))
623 ;; Make a function that checks score element for being of a specific type.
624 (define-public (make-type-checker symbol)
626 (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
628 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
630 (set! (ly:grob-property grob sym) val)))
633 (define-public ((set-output-property grob-name symbol val) grob grob-c context)
636 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
639 (let ((meta (ly:grob-property grob 'meta)))
640 (if (equal? (cdr (assoc 'name meta)) grob-name)
641 (set! (ly:grob-property grob symbol) val))))
645 (define-public (smart-bar-check n)
646 "Make a bar check that checks for a specific bar number.
648 (let ((m (make-music 'ApplyContext)))
650 (let* ((bn (ly:context-property tr 'currentBarNumber)))
654 ;; FIXME: uncomprehensable message
655 (_ "Bar check failed. Expect to be at ~a, instead at ~a")
657 (set! (ly:music-property m 'procedure) checker)
661 (define-public (skip->rest mus)
663 "Replace MUS by RestEvent of the same duration if it is a
664 SkipEvent. Useful for extracting parts from crowded scores"
666 (if (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
667 (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
671 (define-public (music-has-type music type)
672 (memq type (ly:music-property music 'types)))
674 (define-public (music-clone music)
675 (define (alist->args alist acc)
678 (alist->args (cdr alist)
679 (cons (caar alist) (cons (cdar alist) acc)))))
683 (ly:music-property music 'name)
684 (alist->args (ly:music-mutable-properties music) '())))
686 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
687 ;; warn for bare chords at start.
690 (define-public (ly:music-message music msg)
691 (let ((ip (ly:music-property music 'origin)))
692 (if (ly:input-location? ip)
693 (ly:input-message ip msg)
696 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
698 ;; setting stuff for grace context.
701 (define (vector-extend v x)
702 "Make a new vector consisting of V, with X added to the end."
703 (let* ((n (vector-length v))
704 (nv (make-vector (+ n 1) '())))
705 (vector-move-left! v 0 n nv 0)
709 (define (vector-map f v)
710 "Map F over V. This function returns nothing."
711 (do ((n (vector-length v))
714 (f (vector-ref v i))))
716 (define (vector-reverse-map f v)
717 "Map F over V, N to 0 order. This function returns nothing."
718 (do ((i (- (vector-length v) 1) (- i 1)))
720 (f (vector-ref v i))))
722 (define-public (add-grace-property context-name grob sym val)
723 "Set SYM=VAL for GROB in CONTEXT-NAME. "
724 (define (set-prop context)
725 (let* ((where (ly:context-property-where-defined context 'graceSettings))
726 (current (ly:context-property where 'graceSettings))
727 (new-settings (append current
728 (list (list context-name grob sym val)))))
729 (ly:context-set-property! where 'graceSettings new-settings)))
730 (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
732 (define-public (remove-grace-property context-name grob sym)
733 "Remove all SYM for GROB in CONTEXT-NAME. "
734 (define (sym-grob-context? property sym grob context-name)
735 (and (eq? (car property) context-name)
736 (eq? (cadr property) grob)
737 (eq? (caddr property) sym)))
738 (define (delete-prop context)
739 (let* ((where (ly:context-property-where-defined context 'graceSettings))
740 (current (ly:context-property where 'graceSettings))
741 (prop-settings (filter
742 (lambda(x) (sym-grob-context? x sym grob context-name))
744 (new-settings current))
746 (set! new-settings (delete x new-settings)))
748 (ly:context-set-property! where 'graceSettings new-settings)))
749 (ly:export (context-spec-music (make-apply-context delete-prop) 'Voice)))
753 (defmacro-public def-grace-function (start stop . docstring)
754 "Helper macro for defining grace music"
755 `(define-music-function (parser location music) (ly:music?)
757 (make-music 'GraceMusic
759 'element (make-music 'SequentialMusic
760 'elements (list (ly:music-deep-copy ,start)
762 (ly:music-deep-copy ,stop))))))
764 (defmacro-public define-music-function (args signature . body)
765 "Helper macro for `ly:make-music-function'.
767 (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
770 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
771 ;; When the music function definition contains a i10n doc string,
772 ;; (_i "doc string"), keep the literal string only
773 (let ((docstring (cadar body))
775 `(ly:make-music-function (list ,@signature)
779 `(ly:make-music-function (list ,@signature)
784 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
786 (define-public (cue-substitute quote-music)
787 "Must happen after quote-substitute."
789 (if (vector? (ly:music-property quote-music 'quoted-events))
790 (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
791 (main-voice (if (eq? 1 dir) 1 0))
792 (cue-voice (if (eq? 1 dir) 0 1))
793 (main-music (ly:music-property quote-music 'element))
794 (return-value quote-music))
796 (if (or (eq? 1 dir) (eq? -1 dir))
798 ;; if we have stem dirs, change both quoted and main music
799 ;; to have opposite stems.
803 ;; cannot context-spec Quote-music, since context
804 ;; for the quotes is determined in the iterator.
805 (make-sequential-music
807 (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
809 (context-spec-music (make-voice-props-revert) 'CueVoice "cue"))))
811 (make-sequential-music
813 (make-voice-props-set main-voice)
815 (make-voice-props-revert))))
816 (set! (ly:music-property quote-music 'element) main-music)))
821 (define-public ((quote-substitute quote-tab) music)
822 (let* ((quoted-name (ly:music-property music 'quoted-music-name))
823 (quoted-vector (if (string? quoted-name)
824 (hash-ref quote-tab quoted-name #f)
828 (if (string? quoted-name)
829 (if (vector? quoted-vector)
831 (set! (ly:music-property music 'quoted-events) quoted-vector)
832 (set! (ly:music-property music 'iterator-ctor)
833 ly:quote-iterator::constructor))
834 (ly:warning (_ "cannot find quoted music: `~S'") quoted-name)))
838 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
839 ;; switch it on here, so parsing and init isn't checked (too slow!)
841 ;; automatic music transformations.
843 (define (switch-on-debugging m)
844 (if (defined? 'set-debug-cell-accesses!)
845 (set-debug-cell-accesses! 15000))
848 (define (music-check-error music)
851 (if (and (ly:music? m)
852 (eq? (ly:music-property m 'error-found) #t))
855 (for-each signal (ly:music-property music 'elements))
856 (signal (ly:music-property music 'element))
859 (set! (ly:music-property music 'error-found) #t))
862 (define (precompute-music-length music)
863 (set! (ly:music-property music 'length)
864 (ly:music-length music))
867 (define-public (make-duration-of-length moment)
868 "Make duration of the given MOMENT length."
869 (ly:make-duration 0 0
870 (ly:moment-main-numerator moment)
871 (ly:moment-main-denominator moment)))
873 (define (skip-this moment)
874 "set skipTypesetting, make SkipMusic of the given MOMENT length,
875 and then unset skipTypesetting."
876 (make-sequential-music
878 (context-spec-music (make-property-set 'skipTypesetting #t)
880 (make-music 'SkipMusic 'duration
881 (make-duration-of-length moment))
882 (context-spec-music (make-property-set 'skipTypesetting #f)
885 (define (unskip-this moment)
886 "unset skipTypesetting, make SkipMusic of the given MOMENT length,
887 and then set skipTypesetting."
888 (make-sequential-music
890 (context-spec-music (make-property-set 'skipTypesetting #f)
892 (make-music 'SkipMusic 'duration
893 (make-duration-of-length moment))
894 (context-spec-music (make-property-set 'skipTypesetting #t)
897 (define (skip-as-needed music parser)
899 << { \\set skipTypesetting = ##f
900 LENGTHOF(\\showFirstLength)
901 \\set skipTypesetting = ##t
902 LENGTHOF(\\showLastLength) }
906 When only showFirstLength is set,
907 the 'length property of the music is
908 overridden to speed up compiling."
910 ((show-last (ly:parser-lookup parser 'showLastLength))
911 (show-first (ly:parser-lookup parser 'showFirstLength)))
914 ;; both properties may be set.
915 ((and (ly:music? show-first) (ly:music? show-last))
917 ((orig-length (ly:music-length music))
918 (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))
919 (begin-length (ly:music-length show-first)))
920 (make-simultaneous-music
922 (make-sequential-music
924 (skip-this skip-length)
925 ;; let's draw a separator between the beginning and the end
926 (context-spec-music (make-property-set 'whichBar "||")
928 (unskip-this begin-length)
931 ;; we may only want to print the last length
932 ((ly:music? show-last)
934 ((orig-length (ly:music-length music))
935 (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
936 (make-simultaneous-music
938 (skip-this skip-length)
941 ;; we may only want to print the beginning; in this case
942 ;; only the first length will be processed (much faster).
943 ((ly:music? show-first)
945 ((orig-length (ly:music-length music))
946 (begin-length (ly:music-length show-first)))
947 ;; the first length must not exceed the original length.
948 (if (ly:moment<? begin-length orig-length)
949 (set! (ly:music-property music 'length)
950 (ly:music-length show-first)))
956 (define-public toplevel-music-functions
958 (lambda (music parser) (voicify-music music))
959 (lambda (x parser) (music-map music-check-error x))
960 (lambda (x parser) (music-map precompute-music-length x))
961 (lambda (music parser)
963 (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes)) music))
965 ;; switch-on-debugging
966 (lambda (x parser) (music-map cue-substitute x))
969 (skip-as-needed x parser)
973 ;;; general purpose music functions
975 (define (shift-octave pitch octave-shift)
976 (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
978 (+ (ly:pitch-octave pitch) octave-shift)
979 (ly:pitch-notename pitch)
980 (ly:pitch-alteration pitch)))
986 (define (apply-durations lyric-music durations)
987 (define (apply-duration music)
988 (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
989 (ly:duration? (ly:music-property music 'duration)))
991 (set! (ly:music-property music 'duration) (car durations))
992 (set! durations (cdr durations)))))
994 (music-map apply-duration lyric-music))
997 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1000 (define (recent-enough? bar-number alteration-def laziness)
1001 (if (or (number? alteration-def)
1002 (equal? laziness #t))
1004 (<= bar-number (+ (cadr alteration-def) laziness))))
1006 (define (is-tied? alteration-def)
1007 (let* ((def (if (pair? alteration-def)
1008 (car alteration-def)
1011 (if (equal? def 'tied) #t #f)))
1013 (define (extract-alteration alteration-def)
1014 (cond ((number? alteration-def)
1016 ((pair? alteration-def)
1017 (car alteration-def))
1020 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1021 "Checks the need for an accidental and a @q{restore} accidental against
1022 @code{localKeySignature}. The @var{laziness} is the number of measures
1023 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1024 only cancel accidentals in the same measure; if @var{laziness} is three,
1025 we cancel accidentals up to three measures after they first appear.
1026 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1027 specifies whether accidentals should be canceled in different octaves."
1028 (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1029 ((equal? octaveness 'same-octave) #f)
1031 (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1032 (ly:warning (_ "Defaulting to 'any-octave."))
1034 (key-sig (ly:context-property context 'keySignature))
1035 (local-key-sig (ly:context-property context 'localKeySignature))
1036 (notename (ly:pitch-notename pitch))
1037 (octave (ly:pitch-octave pitch))
1038 (pitch-handle (cons octave notename))
1040 (need-accidental #f)
1041 (previous-alteration #f)
1042 (from-other-octaves #f)
1043 (from-same-octave (ly:assoc-get pitch-handle local-key-sig))
1044 (from-key-sig (ly:assoc-get notename local-key-sig)))
1046 ;; If no key signature match is found from localKeySignature, we may have a custom
1047 ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1048 ;; instead of (pitch . alteration). Since this type cannot coexist with entries in
1049 ;; localKeySignature, try extracting from keySignature instead.
1050 (if (equal? from-key-sig #f)
1051 (set! from-key-sig (ly:assoc-get pitch-handle key-sig)))
1053 ;; loop through localKeySignature to search for a notename match from other octaves
1054 (let loop ((l local-key-sig))
1056 (let ((entry (car l)))
1057 (if (and (pair? (car entry))
1058 (= (cdar entry) notename))
1059 (set! from-other-octaves (cdr entry))
1062 ;; find previous alteration-def for comparison with pitch
1064 ;; from same octave?
1065 ((and (eq? ignore-octave #f)
1066 (not (equal? from-same-octave #f))
1067 (recent-enough? barnum from-same-octave laziness))
1068 (set! previous-alteration from-same-octave))
1071 ((and (eq? ignore-octave #t)
1072 (not (equal? from-other-octaves #f))
1073 (recent-enough? barnum from-other-octaves laziness))
1074 (set! previous-alteration from-other-octaves))
1076 ;; not recent enough, extract from key signature/local key signature
1077 ((not (equal? from-key-sig #f))
1078 (set! previous-alteration from-key-sig)))
1080 (if (is-tied? previous-alteration)
1081 (set! need-accidental #t)
1083 (let* ((prev-alt (extract-alteration previous-alteration))
1084 (this-alt (ly:pitch-alteration pitch)))
1086 (if (not (= this-alt prev-alt))
1088 (set! need-accidental #t)
1089 (if (and (not (= this-alt 0))
1090 (or (< (abs this-alt) (abs prev-alt))
1091 (< (* prev-alt this-alt) 0)))
1092 (set! need-restore #t))))))
1094 (cons need-restore need-accidental)))
1096 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1097 "Creates an accidental rule that makes its decision based on the octave of the note
1098 and a laziness value.
1099 octaveness is either 'same-octave or 'any-octave and defines whether the rule should
1100 respond to accidental changes in other octaves than the current. 'same-octave is the
1101 normal way to typeset accidentals - an accidental is made if the alteration is different
1102 from the last active pitch in the same octave. 'any-octave looks at the last active pitch
1104 laziness states over how many bars an accidental should be remembered.
1105 0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
1106 A positive integer means that the accidental lasts over that many bar lines.
1107 -1 is 'forget immediately', that is, only look at key signature.
1109 (check-pitch-against-signature context pitch barnum laziness octaveness))
1111 (define (key-entry-notename entry)
1112 "Return the pitch of an entry in localKeySignature. The entry is either of the form
1113 '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))."
1114 (if (number? (car entry))
1118 (define (key-entry-octave entry)
1119 "Return the octave of an entry in localKeySignature (or #f if the entry does not have
1121 (and (pair? (car entry)) (caar entry)))
1123 (define (key-entry-bar-number entry)
1124 "Return the bar number of an entry in localKeySignature (or #f if the entry does not
1125 have a bar number)."
1126 (and (pair? (car entry)) (caddr entry)))
1128 (define (key-entry-measure-position entry)
1129 "Return the measure position of an entry in localKeySignature (or #f if the entry does
1130 not have a measure position)."
1131 (and (pair? (car entry)) (cdddr entry)))
1133 (define (key-entry-alteration entry)
1134 "Return the alteration of an entry in localKeySignature."
1135 (if (number? (car entry))
1139 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1140 "Return the first entry in keysig that matches the pitch.
1141 accept-global states whether key signature entries should be included.
1142 accept-local states whether local accidentals should be included.
1143 if no matching entry is found, #f is returned."
1145 (let* ((entry (car keysig))
1146 (entryoct (key-entry-octave entry))
1147 (entrynn (key-entry-notename entry))
1148 (oct (ly:pitch-octave pitch))
1149 (nn (ly:pitch-notename pitch)))
1150 (if (and (equal? nn entrynn)
1151 (or (and accept-global (equal? #f entryoct))
1152 (and accept-local (equal? oct entryoct))))
1154 (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))
1157 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1158 "an accidental rule that typesets an accidental if it differs from the key signature
1159 AND does not directly follow a note on the same staff-line.
1160 This rule should not be used alone because it does neither look at bar lines
1161 nor different accidentals at the same notename"
1162 (let* ((keysig (ly:context-property context 'localKeySignature))
1163 (entry (find-pitch-entry keysig pitch #t #t)))
1164 (if (equal? #f entry)
1166 (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1167 (key-acc (if (equal? global-entry #f)
1169 (key-entry-alteration global-entry)))
1170 (acc (ly:pitch-alteration pitch))
1171 (entrymp (key-entry-measure-position entry))
1172 (entrybn (key-entry-bar-number entry)))
1173 (cons #f (not (or (equal? acc key-acc)
1174 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1176 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1177 "an accidental rule that typesets a cautionary accidental
1178 if it is included in the key signature AND does not directly follow
1179 a note on the same staff-line."
1180 (let* ((keysig (ly:context-property context 'localKeySignature))
1181 (entry (find-pitch-entry keysig pitch #t #t)))
1182 (if (equal? #f entry)
1184 (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1185 (key-acc (if (equal? global-entry #f)
1187 (key-entry-alteration global-entry)))
1188 (acc (ly:pitch-alteration pitch))
1189 (entrymp (key-entry-measure-position entry))
1190 (entrybn (key-entry-bar-number entry)))
1191 (cons #f (not (or (equal? acc key-acc)
1192 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1194 (define-public (set-accidentals-properties extra-natural
1195 auto-accs auto-cauts
1198 (make-sequential-music
1199 (append (if (boolean? extra-natural)
1200 (list (make-property-set 'extraNatural extra-natural))
1202 (list (make-property-set 'autoAccidentals auto-accs)
1203 (make-property-set 'autoCautionaries auto-cauts))))
1206 (define-public (set-accidental-style style . rest)
1207 "Set accidental style to STYLE. Optionally takes a context argument,
1208 e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which
1209 use GrandStaff as a context. "
1210 (let ((context (if (pair? rest)
1212 (pcontext (if (pair? rest)
1213 (car rest) 'GrandStaff)))
1216 ;; accidentals as they were common in the 18th century.
1217 ((equal? style 'default)
1218 (set-accidentals-properties #t
1219 `(Staff ,(make-accidental-rule 'same-octave 0))
1222 ;; accidentals from one voice do NOT get cancelled in other voices
1223 ((equal? style 'voice)
1224 (set-accidentals-properties #t
1225 `(Voice ,(make-accidental-rule 'same-octave 0))
1228 ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1229 ;; This includes all the default accidentals, but accidentals also needs cancelling
1230 ;; in other octaves and in the next measure.
1231 ((equal? style 'modern)
1232 (set-accidentals-properties #f
1233 `(Staff ,(make-accidental-rule 'same-octave 0)
1234 ,(make-accidental-rule 'any-octave 0)
1235 ,(make-accidental-rule 'same-octave 1))
1238 ;; the accidentals that Stone adds to the old standard as cautionaries
1239 ((equal? style 'modern-cautionary)
1240 (set-accidentals-properties #f
1241 `(Staff ,(make-accidental-rule 'same-octave 0))
1242 `(Staff ,(make-accidental-rule 'any-octave 0)
1243 ,(make-accidental-rule 'same-octave 1))
1245 ;; same as modern, but accidentals different from the key signature are always
1246 ;; typeset - unless they directly follow a note of the same pitch.
1247 ((equal? style 'neo-modern)
1248 (set-accidentals-properties #f
1249 `(Staff ,(make-accidental-rule 'same-octave 0)
1250 ,(make-accidental-rule 'any-octave 0)
1251 ,(make-accidental-rule 'same-octave 1)
1252 ,neo-modern-accidental-rule)
1255 ((equal? style 'neo-modern-cautionary)
1256 (set-accidentals-properties #f
1257 `(Staff ,(make-accidental-rule 'same-octave 0))
1258 `(Staff ,(make-accidental-rule 'any-octave 0)
1259 ,(make-accidental-rule 'same-octave 1)
1260 ,neo-modern-accidental-rule)
1262 ;; Accidentals as they were common in dodecaphonic music with no tonality.
1263 ;; Each note gets one accidental.
1264 ((equal? style 'dodecaphonic)
1265 (set-accidentals-properties #f
1266 `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1269 ;; Multivoice accidentals to be read both by musicians playing one voice
1270 ;; and musicians playing all voices.
1271 ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
1272 ((equal? style 'modern-voice)
1273 (set-accidentals-properties #f
1274 `(Voice ,(make-accidental-rule 'same-octave 0)
1275 ,(make-accidental-rule 'any-octave 0)
1276 ,(make-accidental-rule 'same-octave 1)
1277 Staff ,(make-accidental-rule 'same-octave 0)
1278 ,(make-accidental-rule 'any-octave 0)
1279 ,(make-accidental-rule 'same-octave 1))
1282 ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1284 ((equal? style 'modern-voice-cautionary)
1285 (set-accidentals-properties #f
1286 `(Voice ,(make-accidental-rule 'same-octave 0))
1287 `(Voice ,(make-accidental-rule 'any-octave 0)
1288 ,(make-accidental-rule 'same-octave 1)
1289 Staff ,(make-accidental-rule 'same-octave 0)
1290 ,(make-accidental-rule 'any-octave 0)
1291 ,(make-accidental-rule 'same-octave 1))
1293 ;; stone's suggestions for accidentals on grand staff.
1294 ;; Accidentals are cancelled across the staves in the same grand staff as well
1295 ((equal? style 'piano)
1296 (set-accidentals-properties #f
1297 `(Staff ,(make-accidental-rule 'same-octave 0)
1298 ,(make-accidental-rule 'any-octave 0)
1299 ,(make-accidental-rule 'same-octave 1)
1301 ,(make-accidental-rule 'any-octave 0)
1302 ,(make-accidental-rule 'same-octave 1))
1305 ((equal? style 'piano-cautionary)
1306 (set-accidentals-properties #f
1307 `(Staff ,(make-accidental-rule 'same-octave 0))
1308 `(Staff ,(make-accidental-rule 'any-octave 0)
1309 ,(make-accidental-rule 'same-octave 1)
1311 ,(make-accidental-rule 'any-octave 0)
1312 ,(make-accidental-rule 'same-octave 1))
1315 ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1316 ;; tones specified by the key signature.
1317 ((equal? style 'teaching)
1318 (set-accidentals-properties #f
1319 `(Staff ,(make-accidental-rule 'same-octave 0))
1320 `(Staff ,(make-accidental-rule 'same-octave 1)
1321 ,teaching-accidental-rule)
1324 ;; do not set localKeySignature when a note alterated differently from
1325 ;; localKeySignature is found.
1326 ;; Causes accidentals to be printed at every note instead of
1327 ;; remembered for the duration of a measure.
1328 ;; accidentals not being remembered, causing accidentals always to
1329 ;; be typeset relative to the time signature
1330 ((equal? style 'forget)
1331 (set-accidentals-properties '()
1332 `(Staff ,(make-accidental-rule 'same-octave -1))
1335 ;; Do not reset the key at the start of a measure. Accidentals will be
1336 ;; printed only once and are in effect until overridden, possibly many
1338 ((equal? style 'no-reset)
1339 (set-accidentals-properties '()
1340 `(Staff ,(make-accidental-rule 'same-octave #t))
1344 (ly:warning (_ "unknown accidental style: ~S") style)
1345 (make-sequential-music '()))))))
1347 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1349 (define-public (skip-of-length mus)
1350 "Create a skip of exactly the same length as MUS."
1354 'duration (ly:make-duration 0 0))))
1356 (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1358 (define-public (mmrest-of-length mus)
1359 "Create a mmrest of exactly the same length as MUS."
1362 (make-multi-measure-rest
1363 (ly:make-duration 0 0) '())))
1364 (ly:music-compress skip (ly:music-length mus))
1367 (define-public (pitch-of-note event-chord)
1370 ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
1371 (ly:music-property event-chord 'elements))))
1374 (ly:music-property (car evs) 'pitch)
1377 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1379 (define-public (extract-named-music music music-name)
1380 "Return a flat list of all music named @code{music-name}
1382 (let ((extracted-list
1383 (if (ly:music? music)
1384 (if (eq? (ly:music-property music 'name) music-name)
1386 (let ((elt (ly:music-property music 'element))
1387 (elts (ly:music-property music 'elements)))
1389 (extract-named-music elt music-name)
1393 (extract-named-music x music-name ))
1396 (flatten-list extracted-list)))
1398 (define-public (event-chord-notes event-chord)
1399 "Return a list of all notes from @{event-chord}."
1401 (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1402 (ly:music-property event-chord 'elements)))
1404 (define-public (event-chord-pitches event-chord)
1405 "Return a list of all pitches from @{event-chord}."
1406 (map (lambda (x) (ly:music-property x 'pitch))
1407 (event-chord-notes event-chord)))