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 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)))
398 (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
399 (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
401 (define-safe-public (make-voice-props-revert)
402 (make-sequential-music
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)))))
411 (define-safe-public (context-spec-music m context #:optional id)
412 "Add \\context CONTEXT = ID to M. "
413 (let ((cm (make-music 'ContextSpeccedMusic
415 'context-type context)))
417 (set! (ly:music-property cm 'context-id) id))
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)
426 (define-public (make-non-relative-music mus)
427 (make-music 'UnrelativableMusic
430 (define-public (make-apply-context func)
431 (make-music 'ApplyContext
434 (define-public (make-sequential-music elts)
435 (make-music 'SequentialMusic
438 (define-public (make-simultaneous-music elts)
439 (make-music 'SimultaneousMusic
442 (define-safe-public (make-event-chord elts)
443 (make-music 'EventChord
446 (define-public (make-skip-music dur)
447 (make-music 'SkipMusic
450 (define-public (make-grace-music music)
451 (make-music 'GraceMusic
457 (define-public (make-multi-measure-rest duration location)
458 (make-music 'MultiMeasureRestMusic
462 (define-public (make-property-set sym val)
463 (make-music 'PropertySet
467 (define-public (make-property-unset sym)
468 (make-music 'PropertyUnset
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)))
482 (let* ((offset (* -7 octavation))
483 (string (cdr (assoc octavation '((2 . "15ma")
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)))
494 (define-public (set-octavation ottavation)
495 (ly:export (make-ottava-set ottavation)))
497 ;;; Need to keep this definition for \time calls from parser
498 (define-public (make-time-signature-set num den)
499 "Set properties for time signature NUM/DEN."
500 (make-beam-rule-time-signature-set num den '()))
502 ;;; Used for calls that include beat-grouping setting
503 (define-public (set-time-signature num den . rest)
504 "Set properties for time signature @var{num/den}.
505 If @var{rest} is present, it is used to make a default
506 @code{beamSetting} rule."
507 (ly:export (apply make-beam-rule-time-signature-set
508 (list num den rest))))
510 (define-public (make-beam-rule-time-signature-set num den rest)
511 "Implement settings for new time signature. Can be
512 called from either make-time-signature-set (used by \time
513 in parser) or set-time-signature (called from scheme code
514 included in .ly file."
516 (define (make-default-beaming-rule context)
517 (override-property-setting
520 (list (cons num den) 'end)
521 (list (cons '* (car rest)))))
523 (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
524 (beat (ly:make-moment 1 den))
525 (len (ly:make-moment num den))
526 (set2 (make-property-set 'beatLength beat))
527 (set3 (make-property-set 'measureLength len))
531 (list (make-apply-context make-default-beaming-rule))))
532 (output (cons* set1 set2 set3 beaming-rule)))
535 (make-sequential-music output)
539 (define-public (make-mark-set label)
540 "Make the music for the \\mark command."
541 (let* ((set (if (integer? label)
542 (context-spec-music (make-property-set 'rehearsalMark label)
545 (ev (make-music 'MarkEvent))
546 (ch (make-event-chord (list ev))))
548 (make-sequential-music (list set ch))
550 (set! (ly:music-property ev 'label) label)
553 (define-safe-public (make-articulation name)
554 (make-music 'ArticulationEvent
555 'articulation-type name))
557 (define-public (make-lyric-event string duration)
558 (make-music 'LyricEvent
562 (define-safe-public (make-span-event type span-dir)
564 'span-direction span-dir))
566 (define-public (set-mus-properties! m alist)
567 "Set all of ALIST as properties of M."
570 (set! (ly:music-property m (caar alist)) (cdar alist))
571 (set-mus-properties! m (cdr alist)))))
573 (define-public (music-separator? m)
575 (let ((ts (ly:music-property m 'types)))
576 (memq 'separator ts)))
578 ;;; splitting chords into voices.
579 (define (voicify-list lst number)
580 "Make a list of Musics.
582 voicify-list :: [ [Music ] ] -> number -> [Music]
583 LST is a list music-lists.
585 NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
589 (cons (context-spec-music
590 (make-sequential-music
591 (list (make-voice-props-set number)
592 (make-simultaneous-music (car lst))))
593 'Voice (number->string (1+ number)))
594 (voicify-list (cdr lst) (1+ number)))))
596 (define (voicify-chord ch)
597 "Split the parts of a chord into different Voices using separator"
598 (let ((es (ly:music-property ch 'elements)))
599 (set! (ly:music-property ch 'elements)
600 (voicify-list (split-list-by-separator es music-separator?) 0))
603 (define-public (voicify-music m)
604 "Recursively split chords that are separated with \\ "
605 (if (not (ly:music? m))
606 (ly:error (_ "music expected: ~S") m))
607 (let ((es (ly:music-property m 'elements))
608 (e (ly:music-property m 'element)))
611 (set! (ly:music-property m 'elements) (map voicify-music es)))
613 (set! (ly:music-property m 'element) (voicify-music e)))
614 (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic)
615 (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
616 (set! m (context-spec-music (voicify-chord m) 'Staff)))
619 (define-public (empty-music)
620 (ly:export (make-music 'Music)))
622 ;; Make a function that checks score element for being of a specific type.
623 (define-public (make-type-checker symbol)
625 (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
627 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
629 (set! (ly:grob-property grob sym) val)))
632 (define-public ((set-output-property grob-name symbol val) grob grob-c context)
635 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
638 (let ((meta (ly:grob-property grob 'meta)))
639 (if (equal? (cdr (assoc 'name meta)) grob-name)
640 (set! (ly:grob-property grob symbol) val))))
644 (define-public (smart-bar-check n)
645 "Make a bar check that checks for a specific bar number.
647 (let ((m (make-music 'ApplyContext)))
649 (let* ((bn (ly:context-property tr 'currentBarNumber)))
653 ;; FIXME: uncomprehensable message
654 (_ "Bar check failed. Expect to be at ~a, instead at ~a")
656 (set! (ly:music-property m 'procedure) checker)
660 (define-public (skip->rest mus)
662 "Replace MUS by RestEvent of the same duration if it is a
663 SkipEvent. Useful for extracting parts from crowded scores"
665 (if (memq (ly:music-property mus 'name) '(SkipEvent SkipMusic))
666 (make-music 'RestEvent 'duration (ly:music-property mus 'duration))
670 (define-public (music-has-type music type)
671 (memq type (ly:music-property music 'types)))
673 (define-public (music-clone music)
674 (define (alist->args alist acc)
677 (alist->args (cdr alist)
678 (cons (caar alist) (cons (cdar alist) acc)))))
682 (ly:music-property music 'name)
683 (alist->args (ly:music-mutable-properties music) '())))
685 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
686 ;; warn for bare chords at start.
689 (define-public (ly:music-message music msg)
690 (let ((ip (ly:music-property music 'origin)))
691 (if (ly:input-location? ip)
692 (ly:input-message ip msg)
695 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
697 ;; setting stuff for grace context.
700 (define (vector-extend v x)
701 "Make a new vector consisting of V, with X added to the end."
702 (let* ((n (vector-length v))
703 (nv (make-vector (+ n 1) '())))
704 (vector-move-left! v 0 n nv 0)
708 (define (vector-map f v)
709 "Map F over V. This function returns nothing."
710 (do ((n (vector-length v))
713 (f (vector-ref v i))))
715 (define (vector-reverse-map f v)
716 "Map F over V, N to 0 order. This function returns nothing."
717 (do ((i (- (vector-length v) 1) (- i 1)))
719 (f (vector-ref v i))))
721 (define-public (add-grace-property context-name grob sym val)
722 "Set SYM=VAL for GROB in CONTEXT-NAME. "
723 (define (set-prop context)
724 (let* ((where (ly:context-property-where-defined context 'graceSettings))
725 (current (ly:context-property where 'graceSettings))
726 (new-settings (append current
727 (list (list context-name grob sym val)))))
728 (ly:context-set-property! where 'graceSettings new-settings)))
729 (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
731 (define-public (remove-grace-property context-name grob sym)
732 "Remove all SYM for GROB in CONTEXT-NAME. "
733 (define (sym-grob-context? property sym grob context-name)
734 (and (eq? (car property) context-name)
735 (eq? (cadr property) grob)
736 (eq? (caddr property) sym)))
737 (define (delete-prop context)
738 (let* ((where (ly:context-property-where-defined context 'graceSettings))
739 (current (ly:context-property where 'graceSettings))
740 (prop-settings (filter
741 (lambda(x) (sym-grob-context? x sym grob context-name))
743 (new-settings current))
745 (set! new-settings (delete x new-settings)))
747 (ly:context-set-property! where 'graceSettings new-settings)))
748 (ly:export (context-spec-music (make-apply-context delete-prop) 'Voice)))
752 (defmacro-public def-grace-function (start stop . docstring)
753 "Helper macro for defining grace music"
754 `(define-music-function (parser location music) (ly:music?)
756 (make-music 'GraceMusic
758 'element (make-music 'SequentialMusic
759 'elements (list (ly:music-deep-copy ,start)
761 (ly:music-deep-copy ,stop))))))
763 (defmacro-public define-music-function (args signature . body)
764 "Helper macro for `ly:make-music-function'.
766 (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
769 (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
770 ;; When the music function definition contains a i10n doc string,
771 ;; (_i "doc string"), keep the literal string only
772 (let ((docstring (cadar body))
774 `(ly:make-music-function (list ,@signature)
778 `(ly:make-music-function (list ,@signature)
783 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
785 (define-public (cue-substitute quote-music)
786 "Must happen after quote-substitute."
788 (if (vector? (ly:music-property quote-music 'quoted-events))
789 (let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
790 (main-voice (if (eq? 1 dir) 1 0))
791 (cue-voice (if (eq? 1 dir) 0 1))
792 (main-music (ly:music-property quote-music 'element))
793 (return-value quote-music))
795 (if (or (eq? 1 dir) (eq? -1 dir))
797 ;; if we have stem dirs, change both quoted and main music
798 ;; to have opposite stems.
802 ;; cannot context-spec Quote-music, since context
803 ;; for the quotes is determined in the iterator.
804 (make-sequential-music
806 (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue")
808 (context-spec-music (make-voice-props-revert) 'CueVoice "cue"))))
810 (make-sequential-music
812 (make-voice-props-set main-voice)
814 (make-voice-props-revert))))
815 (set! (ly:music-property quote-music 'element) main-music)))
820 (define-public ((quote-substitute quote-tab) music)
821 (let* ((quoted-name (ly:music-property music 'quoted-music-name))
822 (quoted-vector (if (string? quoted-name)
823 (hash-ref quote-tab quoted-name #f)
827 (if (string? quoted-name)
828 (if (vector? quoted-vector)
830 (set! (ly:music-property music 'quoted-events) quoted-vector)
831 (set! (ly:music-property music 'iterator-ctor)
832 ly:quote-iterator::constructor))
833 (ly:warning (_ "cannot find quoted music: `~S'") quoted-name)))
837 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
838 ;; switch it on here, so parsing and init isn't checked (too slow!)
840 ;; automatic music transformations.
842 (define (switch-on-debugging m)
843 (if (defined? 'set-debug-cell-accesses!)
844 (set-debug-cell-accesses! 15000))
847 (define (music-check-error music)
850 (if (and (ly:music? m)
851 (eq? (ly:music-property m 'error-found) #t))
854 (for-each signal (ly:music-property music 'elements))
855 (signal (ly:music-property music 'element))
858 (set! (ly:music-property music 'error-found) #t))
861 (define (precompute-music-length music)
862 (set! (ly:music-property music 'length)
863 (ly:music-length music))
866 (define-public (make-duration-of-length moment)
867 "Make duration of the given MOMENT length."
868 (ly:make-duration 0 0
869 (ly:moment-main-numerator moment)
870 (ly:moment-main-denominator moment)))
872 (define (skip-this moment)
873 "set skipTypesetting, make SkipMusic of the given MOMENT length,
874 and then unset skipTypesetting."
875 (make-sequential-music
877 (context-spec-music (make-property-set 'skipTypesetting #t)
879 (make-music 'SkipMusic 'duration
880 (make-duration-of-length moment))
881 (context-spec-music (make-property-set 'skipTypesetting #f)
884 (define (unskip-this moment)
885 "unset skipTypesetting, make SkipMusic of the given MOMENT length,
886 and then set skipTypesetting."
887 (make-sequential-music
889 (context-spec-music (make-property-set 'skipTypesetting #f)
891 (make-music 'SkipMusic 'duration
892 (make-duration-of-length moment))
893 (context-spec-music (make-property-set 'skipTypesetting #t)
896 (define (skip-as-needed music parser)
898 << { \\set skipTypesetting = ##f
899 LENGTHOF(\\showFirstLength)
900 \\set skipTypesetting = ##t
901 LENGTHOF(\\showLastLength) }
905 When only showFirstLength is set,
906 the 'length property of the music is
907 overridden to speed up compiling."
909 ((show-last (ly:parser-lookup parser 'showLastLength))
910 (show-first (ly:parser-lookup parser 'showFirstLength)))
913 ;; both properties may be set.
914 ((and (ly:music? show-first) (ly:music? show-last))
916 ((orig-length (ly:music-length music))
917 (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))
918 (begin-length (ly:music-length show-first)))
919 (make-simultaneous-music
921 (make-sequential-music
923 (skip-this skip-length)
924 ;; let's draw a separator between the beginning and the end
925 (context-spec-music (make-property-set 'whichBar "||")
927 (unskip-this begin-length)
930 ;; we may only want to print the last length
931 ((ly:music? show-last)
933 ((orig-length (ly:music-length music))
934 (skip-length (ly:moment-sub orig-length (ly:music-length show-last))))
935 (make-simultaneous-music
937 (skip-this skip-length)
940 ;; we may only want to print the beginning; in this case
941 ;; only the first length will be processed (much faster).
942 ((ly:music? show-first)
944 ((orig-length (ly:music-length music))
945 (begin-length (ly:music-length show-first)))
946 ;; the first length must not exceed the original length.
947 (if (ly:moment<? begin-length orig-length)
948 (set! (ly:music-property music 'length)
949 (ly:music-length show-first)))
955 (define-public toplevel-music-functions
957 (lambda (music parser) (voicify-music music))
958 (lambda (x parser) (music-map music-check-error x))
959 (lambda (x parser) (music-map precompute-music-length x))
960 (lambda (music parser)
962 (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes)) music))
964 ;; switch-on-debugging
965 (lambda (x parser) (music-map cue-substitute x))
968 (skip-as-needed x parser)
972 ;;; general purpose music functions
974 (define (shift-octave pitch octave-shift)
975 (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
977 (+ (ly:pitch-octave pitch) octave-shift)
978 (ly:pitch-notename pitch)
979 (ly:pitch-alteration pitch)))
985 (define (apply-durations lyric-music durations)
986 (define (apply-duration music)
987 (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
988 (ly:duration? (ly:music-property music 'duration)))
990 (set! (ly:music-property music 'duration) (car durations))
991 (set! durations (cdr durations)))))
993 (music-map apply-duration lyric-music))
996 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
999 (define (recent-enough? bar-number alteration-def laziness)
1000 (if (or (number? alteration-def)
1001 (equal? laziness #t))
1003 (<= bar-number (+ (cadr alteration-def) laziness))))
1005 (define (is-tied? alteration-def)
1006 (let* ((def (if (pair? alteration-def)
1007 (car alteration-def)
1010 (if (equal? def 'tied) #t #f)))
1012 (define (extract-alteration alteration-def)
1013 (cond ((number? alteration-def)
1015 ((pair? alteration-def)
1016 (car alteration-def))
1019 (define (check-pitch-against-signature context pitch barnum laziness octaveness)
1020 "Checks the need for an accidental and a @q{restore} accidental against
1021 @code{localKeySignature}. The @var{laziness} is the number of measures
1022 for which reminder accidentals are used (i.e., if @var{laziness} is zero,
1023 only cancel accidentals in the same measure; if @var{laziness} is three,
1024 we cancel accidentals up to three measures after they first appear.
1025 @var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
1026 specifies whether accidentals should be canceled in different octaves."
1027 (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
1028 ((equal? octaveness 'same-octave) #f)
1030 (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
1031 (ly:warning (_ "Defaulting to 'any-octave."))
1033 (key-sig (ly:context-property context 'keySignature))
1034 (local-key-sig (ly:context-property context 'localKeySignature))
1035 (notename (ly:pitch-notename pitch))
1036 (octave (ly:pitch-octave pitch))
1037 (pitch-handle (cons octave notename))
1039 (need-accidental #f)
1040 (previous-alteration #f)
1041 (from-other-octaves #f)
1042 (from-same-octave (ly:assoc-get pitch-handle local-key-sig))
1043 (from-key-sig (ly:assoc-get notename local-key-sig)))
1045 ;; If no key signature match is found from localKeySignature, we may have a custom
1046 ;; type with octave-specific entries of the form ((octave . pitch) alteration)
1047 ;; instead of (pitch . alteration). Since this type cannot coexist with entries in
1048 ;; localKeySignature, try extracting from keySignature instead.
1049 (if (equal? from-key-sig #f)
1050 (set! from-key-sig (ly:assoc-get pitch-handle key-sig)))
1052 ;; loop through localKeySignature to search for a notename match from other octaves
1053 (let loop ((l local-key-sig))
1055 (let ((entry (car l)))
1056 (if (and (pair? (car entry))
1057 (= (cdar entry) notename))
1058 (set! from-other-octaves (cdr entry))
1061 ;; find previous alteration-def for comparison with pitch
1063 ;; from same octave?
1064 ((and (eq? ignore-octave #f)
1065 (not (equal? from-same-octave #f))
1066 (recent-enough? barnum from-same-octave laziness))
1067 (set! previous-alteration from-same-octave))
1070 ((and (eq? ignore-octave #t)
1071 (not (equal? from-other-octaves #f))
1072 (recent-enough? barnum from-other-octaves laziness))
1073 (set! previous-alteration from-other-octaves))
1075 ;; not recent enough, extract from key signature/local key signature
1076 ((not (equal? from-key-sig #f))
1077 (set! previous-alteration from-key-sig)))
1079 (if (is-tied? previous-alteration)
1080 (set! need-accidental #t)
1082 (let* ((prev-alt (extract-alteration previous-alteration))
1083 (this-alt (ly:pitch-alteration pitch)))
1085 (if (not (= this-alt prev-alt))
1087 (set! need-accidental #t)
1088 (if (and (not (= this-alt 0))
1089 (or (< (abs this-alt) (abs prev-alt))
1090 (< (* prev-alt this-alt) 0)))
1091 (set! need-restore #t))))))
1093 (cons need-restore need-accidental)))
1095 (define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
1096 "Creates an accidental rule that makes its decision based on the octave of the note
1097 and a laziness value.
1098 octaveness is either 'same-octave or 'any-octave and defines whether the rule should
1099 respond to accidental changes in other octaves than the current. 'same-octave is the
1100 normal way to typeset accidentals - an accidental is made if the alteration is different
1101 from the last active pitch in the same octave. 'any-octave looks at the last active pitch
1103 laziness states over how many bars an accidental should be remembered.
1104 0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
1105 A positive integer means that the accidental lasts over that many bar lines.
1106 -1 is 'forget immediately', that is, only look at key signature.
1108 (check-pitch-against-signature context pitch barnum laziness octaveness))
1110 (define (key-entry-notename entry)
1111 "Return the pitch of an entry in localKeySignature. The entry is either of the form
1112 '(notename . alter) or '((octave . notename) . (alter barnum . measurepos))."
1113 (if (number? (car entry))
1117 (define (key-entry-octave entry)
1118 "Return the octave of an entry in localKeySignature (or #f if the entry does not have
1120 (and (pair? (car entry)) (caar entry)))
1122 (define (key-entry-bar-number entry)
1123 "Return the bar number of an entry in localKeySignature (or #f if the entry does not
1124 have a bar number)."
1125 (and (pair? (car entry)) (caddr entry)))
1127 (define (key-entry-measure-position entry)
1128 "Return the measure position of an entry in localKeySignature (or #f if the entry does
1129 not have a measure position)."
1130 (and (pair? (car entry)) (cdddr entry)))
1132 (define (key-entry-alteration entry)
1133 "Return the alteration of an entry in localKeySignature."
1134 (if (number? (car entry))
1138 (define-public (find-pitch-entry keysig pitch accept-global accept-local)
1139 "Return the first entry in keysig that matches the pitch.
1140 accept-global states whether key signature entries should be included.
1141 accept-local states whether local accidentals should be included.
1142 if no matching entry is found, #f is returned."
1144 (let* ((entry (car keysig))
1145 (entryoct (key-entry-octave entry))
1146 (entrynn (key-entry-notename entry))
1147 (oct (ly:pitch-octave pitch))
1148 (nn (ly:pitch-notename pitch)))
1149 (if (and (equal? nn entrynn)
1150 (or (and accept-global (equal? #f entryoct))
1151 (and accept-local (equal? oct entryoct))))
1153 (find-pitch-entry (cdr keysig) pitch accept-global accept-local)))
1156 (define-public (neo-modern-accidental-rule context pitch barnum measurepos)
1157 "an accidental rule that typesets an accidental if it differs from the key signature
1158 AND does not directly follow a note on the same staff-line.
1159 This rule should not be used alone because it does neither look at bar lines
1160 nor different accidentals at the same notename"
1161 (let* ((keysig (ly:context-property context 'localKeySignature))
1162 (entry (find-pitch-entry keysig pitch #t #t)))
1163 (if (equal? #f entry)
1165 (let* ((global-entry (find-pitch-entry keysig pitch #t #f))
1166 (key-acc (if (equal? global-entry #f)
1168 (key-entry-alteration global-entry)))
1169 (acc (ly:pitch-alteration pitch))
1170 (entrymp (key-entry-measure-position entry))
1171 (entrybn (key-entry-bar-number entry)))
1172 (cons #f (not (or (equal? acc key-acc)
1173 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1175 (define-public (teaching-accidental-rule context pitch barnum measurepos)
1176 "an accidental rule that typesets a cautionary accidental
1177 if it is included in the key signature AND does not directly follow
1178 a note on the same staff-line."
1179 (let* ((keysig (ly:context-property context 'localKeySignature))
1180 (entry (find-pitch-entry keysig pitch #t #t)))
1181 (if (equal? #f entry)
1183 (let* ((global-entry (find-pitch-entry keysig pitch #f #f))
1184 (key-acc (if (equal? global-entry #f)
1186 (key-entry-alteration global-entry)))
1187 (acc (ly:pitch-alteration pitch))
1188 (entrymp (key-entry-measure-position entry))
1189 (entrybn (key-entry-bar-number entry)))
1190 (cons #f (not (or (equal? acc key-acc)
1191 (and (equal? entrybn barnum) (equal? entrymp measurepos)))))))))
1193 (define-public (set-accidentals-properties extra-natural
1194 auto-accs auto-cauts
1197 (make-sequential-music
1198 (append (if (boolean? extra-natural)
1199 (list (make-property-set 'extraNatural extra-natural))
1201 (list (make-property-set 'autoAccidentals auto-accs)
1202 (make-property-set 'autoCautionaries auto-cauts))))
1205 (define-public (set-accidental-style style . rest)
1206 "Set accidental style to STYLE. Optionally takes a context argument,
1207 e.g. 'Staff or 'Voice. The context defaults to Staff, except for piano styles, which
1208 use GrandStaff as a context. "
1209 (let ((context (if (pair? rest)
1211 (pcontext (if (pair? rest)
1212 (car rest) 'GrandStaff)))
1215 ;; accidentals as they were common in the 18th century.
1216 ((equal? style 'default)
1217 (set-accidentals-properties #t
1218 `(Staff ,(make-accidental-rule 'same-octave 0))
1221 ;; accidentals from one voice do NOT get cancelled in other voices
1222 ((equal? style 'voice)
1223 (set-accidentals-properties #t
1224 `(Voice ,(make-accidental-rule 'same-octave 0))
1227 ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
1228 ;; This includes all the default accidentals, but accidentals also needs cancelling
1229 ;; in other octaves and in the next measure.
1230 ((equal? style 'modern)
1231 (set-accidentals-properties #f
1232 `(Staff ,(make-accidental-rule 'same-octave 0)
1233 ,(make-accidental-rule 'any-octave 0)
1234 ,(make-accidental-rule 'same-octave 1))
1237 ;; the accidentals that Stone adds to the old standard as cautionaries
1238 ((equal? style 'modern-cautionary)
1239 (set-accidentals-properties #f
1240 `(Staff ,(make-accidental-rule 'same-octave 0))
1241 `(Staff ,(make-accidental-rule 'any-octave 0)
1242 ,(make-accidental-rule 'same-octave 1))
1244 ;; same as modern, but accidentals different from the key signature are always
1245 ;; typeset - unless they directly follow a note of the same pitch.
1246 ((equal? style 'neo-modern)
1247 (set-accidentals-properties #f
1248 `(Staff ,(make-accidental-rule 'same-octave 0)
1249 ,(make-accidental-rule 'any-octave 0)
1250 ,(make-accidental-rule 'same-octave 1)
1251 ,neo-modern-accidental-rule)
1254 ((equal? style 'neo-modern-cautionary)
1255 (set-accidentals-properties #f
1256 `(Staff ,(make-accidental-rule 'same-octave 0))
1257 `(Staff ,(make-accidental-rule 'any-octave 0)
1258 ,(make-accidental-rule 'same-octave 1)
1259 ,neo-modern-accidental-rule)
1261 ;; Accidentals as they were common in dodecaphonic music with no tonality.
1262 ;; Each note gets one accidental.
1263 ((equal? style 'dodecaphonic)
1264 (set-accidentals-properties #f
1265 `(Staff ,(lambda (c p bn mp) '(#f . #t)))
1268 ;; Multivoice accidentals to be read both by musicians playing one voice
1269 ;; and musicians playing all voices.
1270 ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
1271 ((equal? style 'modern-voice)
1272 (set-accidentals-properties #f
1273 `(Voice ,(make-accidental-rule 'same-octave 0)
1274 ,(make-accidental-rule 'any-octave 0)
1275 ,(make-accidental-rule 'same-octave 1)
1276 Staff ,(make-accidental-rule 'same-octave 0)
1277 ,(make-accidental-rule 'any-octave 0)
1278 ,(make-accidental-rule 'same-octave 1))
1281 ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
1283 ((equal? style 'modern-voice-cautionary)
1284 (set-accidentals-properties #f
1285 `(Voice ,(make-accidental-rule 'same-octave 0))
1286 `(Voice ,(make-accidental-rule 'any-octave 0)
1287 ,(make-accidental-rule 'same-octave 1)
1288 Staff ,(make-accidental-rule 'same-octave 0)
1289 ,(make-accidental-rule 'any-octave 0)
1290 ,(make-accidental-rule 'same-octave 1))
1292 ;; stone's suggestions for accidentals on grand staff.
1293 ;; Accidentals are cancelled across the staves in the same grand staff as well
1294 ((equal? style 'piano)
1295 (set-accidentals-properties #f
1296 `(Staff ,(make-accidental-rule 'same-octave 0)
1297 ,(make-accidental-rule 'any-octave 0)
1298 ,(make-accidental-rule 'same-octave 1)
1300 ,(make-accidental-rule 'any-octave 0)
1301 ,(make-accidental-rule 'same-octave 1))
1304 ((equal? style 'piano-cautionary)
1305 (set-accidentals-properties #f
1306 `(Staff ,(make-accidental-rule 'same-octave 0))
1307 `(Staff ,(make-accidental-rule 'any-octave 0)
1308 ,(make-accidental-rule 'same-octave 1)
1310 ,(make-accidental-rule 'any-octave 0)
1311 ,(make-accidental-rule 'same-octave 1))
1314 ;; same as modern, but cautionary accidentals are printed for all sharp or flat
1315 ;; tones specified by the key signature.
1316 ((equal? style 'teaching)
1317 (set-accidentals-properties #f
1318 `(Staff ,(make-accidental-rule 'same-octave 0))
1319 `(Staff ,(make-accidental-rule 'same-octave 1)
1320 ,teaching-accidental-rule)
1323 ;; do not set localKeySignature when a note alterated differently from
1324 ;; localKeySignature is found.
1325 ;; Causes accidentals to be printed at every note instead of
1326 ;; remembered for the duration of a measure.
1327 ;; accidentals not being remembered, causing accidentals always to
1328 ;; be typeset relative to the time signature
1329 ((equal? style 'forget)
1330 (set-accidentals-properties '()
1331 `(Staff ,(make-accidental-rule 'same-octave -1))
1334 ;; Do not reset the key at the start of a measure. Accidentals will be
1335 ;; printed only once and are in effect until overridden, possibly many
1337 ((equal? style 'no-reset)
1338 (set-accidentals-properties '()
1339 `(Staff ,(make-accidental-rule 'same-octave #t))
1343 (ly:warning (_ "unknown accidental style: ~S") style)
1344 (make-sequential-music '()))))))
1346 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1348 (define-public (skip-of-length mus)
1349 "Create a skip of exactly the same length as MUS."
1353 'duration (ly:make-duration 0 0))))
1355 (make-event-chord (list (ly:music-compress skip (ly:music-length mus))))))
1357 (define-public (mmrest-of-length mus)
1358 "Create a mmrest of exactly the same length as MUS."
1361 (make-multi-measure-rest
1362 (ly:make-duration 0 0) '())))
1363 (ly:music-compress skip (ly:music-length mus))
1366 (define-public (pitch-of-note event-chord)
1369 ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types)))
1370 (ly:music-property event-chord 'elements))))
1373 (ly:music-property (car evs) 'pitch)
1376 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1378 (define-public (extract-named-music music music-name)
1379 "Return a flat list of all music named @code{music-name}
1381 (let ((extracted-list
1382 (if (ly:music? music)
1383 (if (eq? (ly:music-property music 'name) music-name)
1385 (let ((elt (ly:music-property music 'element))
1386 (elts (ly:music-property music 'elements)))
1388 (extract-named-music elt music-name)
1392 (extract-named-music x music-name ))
1395 (flatten-list extracted-list)))
1397 (define-public (event-chord-notes event-chord)
1398 "Return a list of all notes from @{event-chord}."
1400 (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
1401 (ly:music-property event-chord 'elements)))
1403 (define-public (event-chord-pitches event-chord)
1404 "Return a list of all pitches from @{event-chord}."
1405 (map (lambda (x) (ly:music-property x 'pitch))
1406 (event-chord-notes event-chord)))