1 ;;;; music-functions.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; Han-Wen Nienhuys <hanwen@cs.uu.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-public ly:grob-property
20 (make-procedure-with-setter ly:grob-property
21 ly:grob-set-property!))
23 (define-public (music-map function music)
24 "Apply @var{function} to @var{music} and all of the music it contains. "
25 (let ((es (ly:music-property music 'elements))
26 (e (ly:music-property music 'element)))
27 (set! (ly:music-property music 'elements)
28 (map (lambda (y) (music-map function y)) es))
30 (set! (ly:music-property music 'element)
31 (music-map function e)))
34 (define-public (music-filter pred? music)
35 "Filter out music expressions that do not satisfy PRED."
37 (define (inner-music-filter pred? music)
39 (let* ((es (ly:music-property music 'elements))
40 (e (ly:music-property music 'element))
41 (as (ly:music-property music 'articulations))
42 (filtered-as (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) as)))
43 (filtered-e (if (ly:music? e)
44 (inner-music-filter pred? e)
46 (filtered-es (filter ly:music? (map (lambda (y) (inner-music-filter pred? y)) es))))
47 (set! (ly:music-property music 'element) filtered-e)
48 (set! (ly:music-property music 'elements) filtered-es)
49 (set! (ly:music-property music 'articulations) filtered-as)
50 ;; if filtering emptied the expression, we remove it completely.
52 (and (eq? filtered-es '()) (not (ly:music? e))
53 (or (not (eq? es '()))
58 (set! music (inner-music-filter pred? music))
61 (make-music 'Music))) ;must return music.
63 (define-public (remove-tag tag)
67 (let* ((tags (ly:music-property m 'tags))
68 (res (memq tag tags)))
72 (define-public (display-music music)
73 "Display music, not done with music-map for clarity of presentation."
76 (let ((es (ly:music-property music 'elements))
77 (e (ly:music-property music 'element)))
78 (display (ly:music-mutable-properties music))
80 (begin (display "\nElements: {\n")
81 (map display-music es)
91 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
93 (define (shift-one-duration-log music shift dot)
94 " add SHIFT to ly:duration-log and optionally
95 a dot to any note encountered. This scales the music up by a factor
96 2^shift * (2 - (1/2)^dot)"
97 (let ((d (ly:music-property music 'duration)))
99 (let* ((cp (ly:duration-factor d))
100 (nd (ly:make-duration (+ shift (ly:duration-log d))
101 (+ dot (ly:duration-dot-count d))
104 (set! (ly:music-property music 'duration) nd)))
109 (define-public (shift-duration-log music shift dot)
110 (music-map (lambda (x) (shift-one-duration-log x shift dot))
114 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
117 (define-public (note-to-cluster music)
118 "Replace NoteEvents by ClusterNoteEvents."
119 (if (eq? (ly:music-property music 'name) 'NoteEvent)
120 (make-music 'ClusterNoteEvent
121 'pitch (ly:music-property music 'pitch)
122 'duration (ly:music-property music 'duration))
125 (define-public (notes-to-clusters music)
126 (music-map note-to-cluster music))
128 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
131 (define-public (unfold-repeats music)
133 This function replaces all repeats with unfold repeats. "
135 (let ((es (ly:music-property music 'elements))
136 (e (ly:music-property music 'element))
137 (n (ly:music-name music)))
138 (if (equal? n "Repeated_music")
141 (if (equal? (ly:music-property music 'iterator-ctor)
142 Chord_tremolo_iterator::constructor)
144 ((seq-arg? (memq 'sequential-music
145 (ly:music-property e 'types)))
146 (count (ly:music-property music 'repeat-count))
147 (dot-shift (if (= 0 (remainder count 3))
152 (set! count (* 2 (quotient count 3))))
154 (shift-duration-log music (+ (if seq-arg? 1 0)
155 (ly:intlog2 count)) dot-shift)
158 (ly:music-compress e (ly:make-moment (length (ly:music-property e 'elements)) 1)))
161 (set! (ly:music-property music 'length)
162 Repeated_music::unfolded_music_length)
163 (set! (ly:music-property music 'start-moment-function)
164 Repeated_music::first_start)
165 (set! (ly:music-property music 'iterator-ctor)
166 Unfolded_repeat_iterator::constructor)))
169 (set! (ly:music-property music 'elements)
170 (map unfold-repeats es)))
172 (set! (ly:music-property music 'element)
177 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
178 ;; property setting music objs.
180 (define-public (make-grob-property-set grob gprop val)
181 "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
182 i.e. this is not an override"
183 (make-music 'OverrideProperty
189 (define-public (make-grob-property-override grob gprop val)
190 "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
191 i.e. this is not an override"
192 (make-music 'OverrideProperty
197 (define-public (make-grob-property-revert grob gprop)
198 "Revert the grob property GPROP for GROB."
199 (make-music 'OverrideProperty
201 'grob-property gprop))
203 (define direction-polyphonic-grobs
204 '(Stem Tie Rest Slur Script TextScript Dots DotColumn
207 (define-public (make-voice-props-set n)
208 (make-sequential-music
210 (map (lambda (x) (make-grob-property-set x 'direction
212 direction-polyphonic-grobs)
214 (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
215 (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))
220 (define-public (make-voice-props-revert)
221 (make-sequential-music
223 (map (lambda (x) (make-grob-property-revert x 'direction))
224 direction-polyphonic-grobs)
225 (list (make-grob-property-revert 'NoteColumn 'horizontal-shift))
226 (list (make-grob-property-revert 'MultiMeasureRest 'staff-position)))))
229 (define*-public (context-spec-music m context #:optional id)
230 "Add \\context CONTEXT = ID to M. "
231 (let ((cm (make-music 'ContextSpeccedMusic
233 'context-type context)))
235 (set! (ly:music-property cm 'context-id) id))
239 (define-public (descend-to-context m context)
240 "Like context-spec-music, but only descending. "
241 (let ((cm (context-spec-music m context)))
242 (ly:music-set-property! cm 'descend-only #t)
245 (define-public (make-non-relative-music mus)
246 (make-music 'UnrelativableMusic
250 (define-public (make-apply-context func)
251 (make-music 'ApplyContext
254 (define-public (make-sequential-music elts)
255 (make-music 'SequentialMusic
258 (define-public (make-simultaneous-music elts)
259 (make-music 'SimultaneousMusic
262 (define-public (make-event-chord elts)
263 (make-music 'EventChord
266 (define-public (make-skip-music dur)
267 (make-music 'SkipMusic
270 (define-public (make-grace-music music)
271 (make-music 'GraceMusic
277 (define-public (make-multi-measure-rest duration location)
278 (make-music 'MultiMeasureRestMusicGroup
280 'elements (list (make-music 'BarCheck
282 (make-event-chord (list (make-music 'MultiMeasureRestEvent
284 'duration duration)))
285 (make-music 'BarCheck
288 (define-public (glue-mm-rest-texts music)
289 "Check if we have R1*4-\\markup { .. }, and if applicable convert to
290 a property set for MultiMeasureRestNumber."
291 (define (script-to-mmrest-text script-music)
292 "Extract 'direction and 'text from SCRIPT-MUSIC, and transform into property sets."
293 (let ((dir (ly:music-property script-music 'direction))
294 (p (make-music 'MultiMeasureTextEvent
295 'text (ly:music-property script-music 'text))))
297 (set! (ly:music-property p 'direction) dir))
299 (if (eq? (ly:music-property music 'name) 'MultiMeasureRestMusicGroup)
300 (let* ((text? (lambda (x) (memq 'script-event (ly:music-property x 'types))))
301 (es (ly:music-property music 'elements))
302 (texts (map script-to-mmrest-text (filter text? es)))
303 (others (remove text? es)))
305 (set! (ly:music-property music 'elements)
306 (cons (make-event-chord texts) others)))))
310 (define-public (make-property-set sym val)
311 (make-music 'PropertySet
315 (define-public (make-ottava-set octavation)
316 (let ((m (make-music 'ApplyContext)))
317 (define (ottava-modify context)
318 "Either reset middleCPosition to the stored original, or remember
319 old middleCPosition, add OCTAVATION to middleCPosition, and set
320 OTTAVATION to `8va', or whatever appropriate."
321 (if (number? (ly:context-property context 'middleCPosition))
323 (let ((where (ly:context-property-where-defined context 'middleCPosition))
324 (oc0 (ly:context-property context 'originalCentralCPosition)))
325 (ly:context-set-property! context 'middleCPosition oc0)
326 (ly:context-unset-property where 'originalCentralCPosition)
327 (ly:context-unset-property where 'ottavation))
328 (let* ((where (ly:context-property-where-defined context 'middleCPosition))
329 (c0 (ly:context-property context 'middleCPosition))
330 (new-c0 (+ c0 (* -7 octavation)))
331 (string (cdr (assoc octavation '((2 . "15ma")
335 (-2 . "15ma bassa"))))))
336 (ly:context-set-property! context 'middleCPosition new-c0)
337 (ly:context-set-property! context 'originalCentralCPosition c0)
338 (ly:context-set-property! context 'ottavation string)))))
339 (set! (ly:music-property m 'procedure) ottava-modify)
340 (context-spec-music m 'Staff)))
342 (define-public (set-octavation ottavation)
343 (ly:export (make-ottava-set ottavation)))
345 (define-public (make-time-signature-set num den . rest)
346 "Set properties for time signature NUM/DEN. Rest can contain a list
348 (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den)))
349 (beat (ly:make-moment 1 den))
350 (len (ly:make-moment num den))
351 (set2 (make-property-set 'beatLength beat))
352 (set3 (make-property-set 'measureLength len))
353 (set4 (make-property-set 'beatGrouping (if (pair? rest)
356 (basic (list set1 set2 set3 set4)))
358 (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
360 (define-public (make-mark-set label)
361 "Make the music for the \\mark command."
362 (let* ((set (if (integer? label)
363 (context-spec-music (make-property-set 'rehearsalMark label)
366 (ev (make-music 'MarkEvent))
367 (ch (make-event-chord (list ev))))
369 (make-sequential-music (list set ch))
371 (set! (ly:music-property ev 'label) label)
374 (define-public (set-time-signature num den . rest)
375 (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
377 (define-public (make-penalty-music pen page-pen)
378 (make-music 'BreakEvent
380 'page-penalty page-pen))
382 (define-public (make-articulation name)
383 (make-music 'ArticulationEvent
384 'articulation-type name))
386 (define-public (make-lyric-event string duration)
387 (make-music 'LyricEvent
391 (define-public (make-span-event type spandir)
393 'span-direction spandir))
395 (define-public (set-mus-properties! m alist)
396 "Set all of ALIST as properties of M."
399 (set! (ly:music-property m (caar alist)) (cdar alist))
400 (set-mus-properties! m (cdr alist)))))
402 (define-public (music-separator? m)
404 (let ((ts (ly:music-property m 'types)))
405 (memq 'separator ts)))
408 ;;; splitting chords into voices.
409 (define (voicify-list lst number)
410 "Make a list of Musics.
412 voicify-list :: [ [Music ] ] -> number -> [Music]
413 LST is a list music-lists.
415 NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
419 (cons (context-spec-music
420 (make-sequential-music
421 (list (make-voice-props-set number)
422 (make-simultaneous-music (car lst))))
423 'Voice (number->string (1+ number)))
424 (voicify-list (cdr lst) (1+ number)))))
426 (define (voicify-chord ch)
427 "Split the parts of a chord into different Voices using separator"
428 (let ((es (ly:music-property ch 'elements)))
429 (set! (ly:music-property ch 'elements)
430 (voicify-list (split-list es music-separator?) 0))
433 (define-public (voicify-music m)
434 "Recursively split chords that are separated with \\ "
435 (if (not (ly:music? m))
437 (error "not music!")))
438 (let ((es (ly:music-property m 'elements))
439 (e (ly:music-property m 'element)))
441 (set! (ly:music-property m 'elements) (map voicify-music es)))
443 (set! (ly:music-property m 'element) (voicify-music e)))
444 (if (and (equal? (ly:music-name m) "Simultaneous_music")
445 (reduce (lambda (x y ) (or x y)) #f (map music-separator? es)))
446 (set! m (context-spec-music (voicify-chord m) 'Staff)))
449 (define-public (empty-music)
450 (ly:export (make-music 'Music)))
453 ; Make a function that checks score element for being of a specific type.
454 (define-public (make-type-checker symbol)
457 ;;(eq? #t (ly:grob-property elt symbol))
458 (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
460 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
462 (set! (ly:grob-property grob sym) val)))
465 (define-public ((set-output-property grob-name symbol val) grob grob-c context)
468 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
471 (let ((meta (ly:grob-property grob 'meta)))
472 (if (equal? (cdr (assoc 'name meta)) grob-name)
473 (set! (ly:grob-property grob symbol) val))))
477 (define-public (smart-bar-check n)
478 "Make a bar check that checks for a specific bar number.
480 (let ((m (make-music 'ApplyContext)))
482 (let* ((bn (ly:context-property tr 'currentBarNumber)))
486 (format "Bar check failed, we should have reached ~a, instead at ~a\n"
488 (set! (ly:music-property m 'procedure) checker)
491 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
492 ;; warn for bare chords at start.
494 (define (has-request-chord elts)
495 (reduce (lambda (x y) (or x y)) #f
497 (equal? (ly:music-name x) "Request_chord"))
500 (define (ly:music-message music msg)
501 (let ((ip (ly:music-property music 'origin)))
502 (if (ly:input-location? ip)
503 (ly:input-message ip msg)
506 (define (check-start-chords music)
507 "Check music expression for a Simultaneous_music containing notes\n(ie. Request_chords),
508 without context specification. Called from parser."
509 (let ((es (ly:music-property music 'elements))
510 (e (ly:music-property music 'element))
511 (name (ly:music-name music)))
512 (cond ((equal? name "Context_specced_music") #t)
513 ((equal? name "Simultaneous_music")
514 (if (has-request-chord es)
515 (ly:music-message music "Starting score with a chord.\nPlease insert an explicit \\context before chord")
516 (map check-start-chords es)))
517 ((equal? name "Sequential_music")
519 (check-start-chords (car es))))
520 (else (if (ly:music? e) (check-start-chords e)))))
525 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
527 ;; setting stuff for grace context.
530 (define (vector-extend v x)
531 "Make a new vector consisting of V, with X added to the end."
533 ((n (vector-length v))
534 (nv (make-vector (+ n 1) '())))
535 (vector-move-left! v 0 n nv 0)
539 (define (vector-map f v)
540 "Map F over V. This function returns nothing."
541 (do ((n (vector-length v))
544 (f (vector-ref v i))))
546 (define (vector-reverse-map f v)
547 "Map F over V, N to 0 order. This function returns nothing."
548 (do ((i (- (vector-length v) 1) (- i 1)))
550 (f (vector-ref v i))))
552 ;; TODO: make a remove-grace-property too.
553 (define-public (add-grace-property context-name grob sym val)
554 "Set SYM=VAL for GROB in CONTEXT-NAME. "
555 (define (set-prop context)
556 (let* ((where (ly:context-property-where-defined context 'graceSettings))
557 (current (ly:context-property where 'graceSettings))
558 (new-settings (vector-extend current (list context-name grob sym val))))
559 (ly:context-set-property! where 'graceSettings new-settings)))
560 (ly:export (context-spec-music (make-apply-context set-prop) 'Voice)))
563 (define-public (set-start-grace-properties context)
564 (define (execute-1 x)
565 (let ((tr (ly:context-find context (car x))))
567 (ly:context-pushpop-property tr (cadr x) (caddr x) (cadddr x)))))
569 (let ((props (ly:context-property context 'graceSettings)))
571 (vector-map execute-1 props))))
573 (define-public (set-stop-grace-properties context)
574 (define (execute-1 x)
575 (let ((tr (ly:context-find context (car x))))
577 (ly:context-pushpop-property tr (cadr x) (caddr x)))))
579 (let ((props (ly:context-property context 'graceSettings)))
581 (vector-reverse-map execute-1 props))))
585 (defmacro-public def-grace-function (start stop)
586 `(def-music-function (location music) (ly:music?)
587 (make-music 'GraceMusic
589 'element (make-music 'SequentialMusic
590 'elements (list (ly:music-deep-copy ,start)
592 (ly:music-deep-copy ,stop))))))
594 (defmacro-public def-music-function (args signature . body)
595 "Helper macro for `ly:make-music-function'.
597 (def-music-function (location arg1 arg2 ...) (arg1-type? arg2-type? ...)
600 `(ly:make-music-function (list ,@signature)
604 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
605 ;; switch it on here, so parsing and init isn't checked (too slow!)
607 ;; automatic music transformations.
609 (define (switch-on-debugging m)
610 (if (defined? 'set-debug-cell-accesses!)
611 (set-debug-cell-accesses! 15000))
614 (define-public toplevel-music-functions
616 ;; check-start-chords ; ; no longer needed with chord syntax.
618 (lambda (x) (music-map glue-mm-rest-texts x))
619 ;; switch-on-debugging
625 (define (apply-durations lyric-music durations)
626 (define (apply-duration music)
627 (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
628 (ly:duration? (ly:music-property music 'duration)))
630 (set! (ly:music-property music 'duration) (car durations))
631 (set! durations (cdr durations)))))
633 (music-map apply-duration lyric-music))
636 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
639 (define-public ((add-balloon-text object-name text off) grob orig-context cur-context)
640 "Usage: see input/regression/balloon.ly "
641 (let* ((meta (ly:grob-property grob 'meta))
642 (nm (if (pair? meta) (cdr (assoc 'name meta)) "nonexistant"))
643 (cb (ly:grob-property grob 'print-function)))
644 (if (equal? nm object-name)
646 (set! (ly:grob-property grob 'print-function) Balloon_interface::print)
647 (set! (ly:grob-property grob 'balloon-original-callback) cb)
648 (set! (ly:grob-property grob 'balloon-text) text)
649 (set! (ly:grob-property grob 'balloon-text-offset) off)
650 (set! (ly:grob-property grob 'balloon-text-props) '((font-family . roman)))))))
652 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
655 (define-public (set-accidentals-properties extra-natural
659 (make-sequential-music
660 (append (if (boolean? extra-natural)
661 (list (make-property-set 'extraNatural extra-natural))
663 (list (make-property-set 'autoAccidentals auto-accs)
664 (make-property-set 'autoCautionaries auto-cauts))))
667 (define-public (set-accidental-style style . rest)
668 "Set accidental style to STYLE. Optionally takes a context argument,
669 e.g. 'Staff or 'Voice. The context defaults to Voice, except for piano styles, which
670 use GrandStaff as a context. "
671 (let ((context (if (pair? rest)
673 (pcontext (if (pair? rest)
674 (car rest) 'GrandStaff)))
677 ;; accidentals as they were common in the 18th century.
678 ((equal? style 'default)
679 (set-accidentals-properties #t '(Staff (same-octave . 0))
681 ;; accidentals from one voice do NOT get cancelled in other voices
682 ((equal? style 'voice)
683 (set-accidentals-properties #t '(Voice (same-octave . 0))
685 ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
686 ;; This includes all the default accidentals, but accidentals also needs cancelling
687 ;; in other octaves and in the next measure.
688 ((equal? style 'modern)
689 (set-accidentals-properties #f '(Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
691 ;; the accidentals that Stone adds to the old standard as cautionaries
692 ((equal? style 'modern-cautionary)
693 (set-accidentals-properties #f '(Staff (same-octave . 0))
694 '(Staff (any-octave . 0) (same-octave . 1))
696 ;; Multivoice accidentals to be read both by musicians playing one voice
697 ;; and musicians playing all voices.
698 ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
699 ((equal? style 'modern-voice)
700 (set-accidentals-properties #f
701 '(Voice (same-octave . 0) (any-octave . 0) (same-octave . 1)
702 Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
705 ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
707 ((equal? style 'modern-voice-cautionary)
708 (set-accidentals-properties #f
709 '(Voice (same-octave . 0) )
710 '(Voice (any-octave . 0) (same-octave . 1)
711 Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
713 ;; stone's suggestions for accidentals on grand staff.
714 ;; Accidentals are cancelled across the staves in the same grand staff as well
715 ((equal? style 'piano)
716 (set-accidentals-properties #f
717 '( Staff (same-octave . 0) (any-octave . 0) (same-octave . 1)
718 GrandStaff (any-octave . 0) (same-octave . 1))
721 ((equal? style 'piano-cautionary)
722 (set-accidentals-properties #f
723 '(Staff (same-octave . 0))
724 '(Staff (any-octave . 0) (same-octave . 1)
725 GrandStaff (any-octave . 0) (same-octave . 1))
727 ;; do not set localKeySignature when a note alterated differently from
728 ;; localKeySignature is found.
729 ;; Causes accidentals to be printed at every note instead of
730 ;; remembered for the duration of a measure.
731 ;; accidentals not being remembered, causing accidentals always to be typeset relative to the time signature
732 ((equal? style 'forget)
733 (set-accidentals-properties '()
734 '(Staff (same-octave . -1))
736 ;; Do not reset the key at the start of a measure. Accidentals will be
737 ;; printed only once and are in effect until overridden, possibly many
739 ((equal? style 'no-reset)
740 (set-accidentals-properties '()
741 '(Staff (same-octave . #t))
745 (ly:warn "Unknown accidental style: ~S" (symbol->string style))
746 (make-sequential-music '()))))))