1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
18 ;; todo: figure out how to make module,
19 ;; without breaking nested ly scopes
21 (define-class <Voice-state> ()
22 (event-list #:init-value '() #:accessor events #:init-keyword #:events)
23 (when-moment #:accessor moment #:init-keyword #:moment)
24 (tuning #:accessor tuning #:init-keyword #:tuning)
25 (split-index #:accessor split-index)
29 ;; spanner-state is an alist
30 ;; of (SYMBOL . RESULT-INDEX), which indicates where
31 ;; said spanner was started.
32 (spanner-state #:init-value '() #:accessor span-state))
34 (define-method (write (x <Voice-state> ) file)
35 (display (moment x) file)
36 (display " evs = " file)
37 (display (events x) file)
38 (display " active = " file)
39 (display (span-state x) file)
42 (define-method (note-events (vs <Voice-state>))
44 (ly:in-event-class? x 'note-event))
45 (filter f? (events vs)))
47 (define-method (previous-voice-state (vs <Voice-state>))
48 (let ((i (slot-ref vs 'vector-index))
49 (v (slot-ref vs 'state-vector)))
54 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
56 (define-class <Split-state> ()
57 ;; The automatically determined split configuration
58 (configuration #:init-value '() #:accessor configuration)
59 ;; Allow overriding split configuration, takes precedence over configuration
60 (forced-configuration #:init-value #f #:accessor forced-configuration)
61 (when-moment #:accessor moment #:init-keyword #:moment)
62 ;; voice-states are states starting with the Split-state or later
64 (is #:init-keyword #:voice-states #:accessor voice-states)
65 (synced #:init-keyword #:synced #:init-value #f #:getter synced?))
68 (define-method (write (x <Split-state> ) f)
69 (display (moment x) f)
71 (display (configuration x) f)
76 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
79 (define (previous-span-state vs)
80 (let ((p (previous-voice-state vs)))
81 (if p (span-state p) '())))
83 (define (make-voice-states evl)
84 (let ((vec (list->vector (map (lambda (v)
88 #:events (map car (cdr v))))
91 ((= i (vector-length vec)) vec)
92 (slot-set! (vector-ref vec i) 'vector-index i)
93 (slot-set! (vector-ref vec i) 'state-vector vec))))
95 (define (make-split-state vs1 vs2)
96 "Merge lists VS1 and VS2, containing Voice-state objects into vector
97 of Split-state objects, crosslinking the Split-state vector and
100 (define (helper ss-idx ss-list idx1 idx2)
101 (let* ((state1 (if (< idx1 (vector-length vs1)) (vector-ref vs1 idx1) #f))
102 (state2 (if (< idx2 (vector-length vs2)) (vector-ref vs2 idx2) #f))
103 (min (cond ((and state1 state2) (moment-min (moment state1) (moment state2)))
104 (state1 (moment state1))
105 (state2 (moment state2))
107 (inc1 (if (and state1 (equal? min (moment state1))) 1 0))
108 (inc2 (if (and state2 (equal? min (moment state2))) 1 0))
112 #:voice-states (cons state1 state2)
113 #:synced (= inc1 inc2))
116 (set! (split-index state1) ss-idx))
118 (set! (split-index state2) ss-idx))
121 (cons ss-object ss-list)
125 (list->vector (reverse! (helper 0 '() 0 0) '())))
127 (define (analyse-spanner-states voice-state-vec)
129 (define (helper index active)
130 "Analyse EVS at INDEX, given state ACTIVE."
132 (define (analyse-tie-start active ev)
133 (if (ly:in-event-class? ev 'tie-event)
134 (acons 'tie (split-index (vector-ref voice-state-vec index))
138 (define (analyse-tie-end active ev)
139 (if (ly:in-event-class? ev 'note-event)
140 (assoc-remove! active 'tie)
143 (define (analyse-absdyn-end active ev)
144 (if (or (ly:in-event-class? ev 'absolute-dynamic-event)
145 (and (ly:in-event-class? ev 'span-dynamic-event)
146 (equal? STOP (ly:event-property ev 'span-direction))))
147 (assoc-remove! (assoc-remove! active 'cresc) 'decr)
150 (define (active<? a b)
151 (cond ((symbol<? (car a) (car b)) #t)
152 ((symbol<? (car b) (car a)) #f)
153 (else (< (cdr a) (cdr b)))))
155 (define (analyse-span-event active ev)
156 (let* ((name (car (ly:event-property ev 'class)))
157 (key (cond ((equal? name 'slur-event) 'slur)
158 ((equal? name 'phrasing-slur-event) 'tie)
159 ((equal? name 'beam-event) 'beam)
160 ((equal? name 'crescendo-event) 'cresc)
161 ((equal? name 'decrescendo-event) 'decr)
163 (sp (ly:event-property ev 'span-direction)))
164 (if (and (symbol? key) (ly:dir? sp))
166 (assoc-remove! active key)
168 (split-index (vector-ref voice-state-vec index))
172 (define (analyse-events active evs)
173 "Run all analyzers on ACTIVE and EVS"
174 (define (run-analyzer analyzer active evs)
176 (run-analyzer analyzer (analyzer active (car evs)) (cdr evs))
178 (define (run-analyzers analyzers active evs)
179 (if (pair? analyzers)
180 (run-analyzers (cdr analyzers)
181 (run-analyzer (car analyzers) active evs)
184 (sort ;; todo: use fold or somesuch.
185 (run-analyzers (list analyse-absdyn-end analyse-span-event
186 ;; note: tie-start/span comes after tie-end/absdyn.
187 analyse-tie-end analyse-tie-start)
191 ;; must copy, since we use assoc-remove!
192 (if (< index (vector-length voice-state-vec))
194 (set! active (analyse-events active (events (vector-ref voice-state-vec index))))
195 (set! (span-state (vector-ref voice-state-vec index))
197 (helper (1+ index) active))))
201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
202 (define-public (recording-group-emulate music odef)
203 "Interpret @var{music} according to @var{odef}, but store all events
204 in a chronological list, similar to the @code{Recording_group_engraver} in
205 LilyPond version 2.8 and earlier."
208 (now-mom (ly:make-moment 0 0))
209 (global (ly:make-global-context odef))
210 (mom-listener (ly:make-listener
211 (lambda (tev) (set! now-mom (ly:event-property tev 'moment)))))
212 (new-context-listener
216 ((child (ly:event-property sev 'context))
217 (this-moment-list (cons (ly:context-id child) '()))
218 (dummy (set! context-list (cons this-moment-list context-list)))
220 (accumulate-event-listener
221 (ly:make-listener (lambda (ev)
222 (set! acc (cons (cons ev #t) acc)))))
224 (ly:make-listener (lambda (tev)
228 (ly:context-property child 'instrumentTransposition))
229 ;; The accumulate-event-listener above creates
230 ;; the list of events in reverse order, so we
231 ;; have to revert it to the original order again
233 (set-cdr! this-moment-list
234 (cons this-moment (cdr this-moment-list)))
236 (ly:add-listener accumulate-event-listener
237 (ly:context-event-source child) 'StreamEvent)
238 (ly:add-listener save-acc-listener
239 (ly:context-event-source global) 'OneTimeStep))))))
240 (ly:add-listener new-context-listener
241 (ly:context-events-below global) 'AnnounceNewContext)
242 (ly:add-listener mom-listener (ly:context-event-source global) 'Prepare)
243 (ly:interpret-music-expression (make-non-relative-music music) global)
246 (define-public (make-part-combine-music parser music-list direction)
247 (let* ((m (make-music 'PartCombineMusic))
248 (m1 (make-non-relative-music (context-spec-music (first music-list) 'Voice "one")))
249 (m2 (make-non-relative-music (context-spec-music (second music-list) 'Voice "two")))
250 (listener (ly:parser-lookup parser 'partCombineListener))
251 (evs2 (recording-group-emulate m2 listener))
252 (evs1 (recording-group-emulate m1 listener)))
254 (set! (ly:music-property m 'elements) (list m1 m2))
255 (set! (ly:music-property m 'direction) direction)
256 (set! (ly:music-property m 'split-list)
257 (if (and (assoc "one" evs1) (assoc "two" evs2))
258 (determine-split-list (reverse! (assoc-get "one" evs1) '())
259 (reverse! (assoc-get "two" evs2) '()))
263 (define-public (determine-split-list evl1 evl2)
264 "@var{evl1} and @var{evl2} should be ascending."
267 (voice-state-vec1 (make-voice-states evl1))
268 (voice-state-vec2 (make-voice-states evl2))
269 (result (make-split-state voice-state-vec1 voice-state-vec2)))
271 ;; Go through all moments recursively and check if the events of that
272 ;; moment contain a part-combine-force-event override. If so, store its
273 ;; value in the forced-configuration field, which will override. The
274 ;; previous configuration is used to determine non-terminated settings.
275 (define (analyse-forced-combine result-idx prev-res)
277 (define (get-forced-event x)
278 (if (ly:in-event-class? x 'part-combine-force-event)
279 (cons (ly:event-property x 'forced-type) (ly:event-property x 'once))
281 (define (part-combine-events vs)
284 (filter-map get-forced-event (events vs))))
285 ;; end part-combine-events
287 ;; forced-result: Take the previous config and analyse whether
288 ;; any change happened.... Return new once and permanent config
289 (define (forced-result evt state)
290 ;; sanity check, evt should always be (new-state . once)
291 (if (not (and (pair? evt) (pair? state)))
294 ;; Once-event, leave permanent state unchanged
295 (cons (car evt) (cdr state))
296 ;; permanent change, leave once state unchanged
297 (cons (car state) (car evt)))))
298 ;; end forced-combine-result
300 ;; body of analyse-forced-combine:
301 (if (< result-idx (vector-length result))
302 (let* ((now-state (vector-ref result result-idx)) ; current result
303 ;; Extract all part-combine force events
304 (ev1 (part-combine-events (car (voice-states now-state))))
305 (ev2 (part-combine-events (cdr (voice-states now-state))))
306 (evts (append ev1 ev2))
307 ;; result is (once-state permament-state):
308 (state (fold forced-result (cons 'automatic prev-res) evts))
309 ;; Now let once override permanent changes:
310 (force-state (if (equal? (car state) 'automatic)
313 (set! (forced-configuration (vector-ref result result-idx))
315 ;; For the next moment, ignore the once override (car stat)
316 ;; and pass on the permanent override, stored as (cdr state)
317 (analyse-forced-combine (1+ result-idx) (cdr state)))))
318 ;; end analyse-forced-combine
321 (define (analyse-time-step result-idx)
322 (define (put x . index)
323 "Put the result to X, starting from INDEX backwards.
325 Only set if not set previously.
327 (let ((i (if (pair? index) (car index) result-idx)))
329 (not (symbol? (configuration (vector-ref result i)))))
331 (set! (configuration (vector-ref result i)) x)
334 (define (copy-state-from state-vec vs)
335 (define (copy-one-state key-idx)
336 (let* ((idx (cdr key-idx))
337 (prev-ss (vector-ref result idx))
338 (prev (configuration prev-ss)))
341 (map copy-one-state (span-state vs)))
343 (define (analyse-notes now-state)
344 (let* ((vs1 (car (voice-states now-state)))
345 (vs2 (cdr (voice-states now-state)))
346 (notes1 (note-events vs1))
347 (durs1 (sort (map (lambda (x) (ly:event-property x 'duration))
350 (pitches1 (sort (map (lambda (x) (ly:event-property x 'pitch))
353 (notes2 (note-events vs2))
354 (durs2 (sort (map (lambda (x) (ly:event-property x 'duration))
357 (pitches2 (sort (map (lambda (x) (ly:event-property x 'pitch))
360 (cond ((> (length notes1) 1) (put 'apart))
361 ((> (length notes2) 1) (put 'apart))
362 ((= 1 (+ (length notes2) (length notes1))) (put 'apart))
363 ((and (= (length durs1) 1)
365 (not (equal? (car durs1) (car durs2))))
368 (if (and (= (length pitches1) (length pitches2)))
369 (if (and (pair? pitches1)
372 (< chord-threshold (ly:pitch-steps
373 (ly:pitch-diff (car pitches1)
377 (> 0 (ly:pitch-steps (ly:pitch-diff (car pitches1)
381 ;; copy previous split state from spanner state
383 (if (previous-voice-state vs1)
384 (copy-state-from voice-state-vec1
385 (previous-voice-state vs1)))
386 (if (previous-voice-state vs2)
387 (copy-state-from voice-state-vec2
388 (previous-voice-state vs2)))
389 (if (and (null? (span-state vs1)) (null? (span-state vs2)))
390 (put 'chords)))))))))
392 (if (< result-idx (vector-length result))
393 (let* ((now-state (vector-ref result result-idx))
394 (vs1 (car (voice-states now-state)))
395 (vs2 (cdr (voice-states now-state))))
397 (cond ((not vs1) (put 'apart))
398 ((not vs2) (put 'apart))
400 (let ((active1 (previous-span-state vs1))
401 (active2 (previous-span-state vs2))
402 (new-active1 (span-state vs1))
403 (new-active2 (span-state vs2)))
405 (display (list (moment now-state) result-idx
406 active1 "->" new-active1
407 active2 "->" new-active2
409 (if (and (synced? now-state)
410 (equal? active1 active2)
411 (equal? new-active1 new-active2))
412 (analyse-notes now-state)
414 ;; active states different:
417 ;; go to the next one, if it exists.
418 (analyse-time-step (1+ result-idx)))))))
420 (define (analyse-a2 result-idx)
421 (if (< result-idx (vector-length result))
422 (let* ((now-state (vector-ref result result-idx))
423 (vs1 (car (voice-states now-state)))
424 (vs2 (cdr (voice-states now-state))))
425 (if (and (equal? (configuration now-state) 'chords)
427 (let ((notes1 (note-events vs1))
428 (notes2 (note-events vs2)))
429 (cond ((and (= 1 (length notes1))
430 (= 1 (length notes2))
431 (equal? (ly:event-property (car notes1) 'pitch)
432 (ly:event-property (car notes2) 'pitch)))
433 (set! (configuration now-state) 'unisono))
434 ((and (= 0 (length notes1))
435 (= 0 (length notes2)))
436 (set! (configuration now-state) 'unisilence)))))
437 (analyse-a2 (1+ result-idx)))))
439 (define (analyse-solo12 result-idx)
441 (define (previous-config vs)
442 (let* ((pvs (previous-voice-state vs))
443 (spi (if pvs (split-index pvs) #f))
444 (prev-split (if spi (vector-ref result spi) #f)))
446 (configuration prev-split)
449 (define (put-range x a b)
450 ;; (display (list "put range " x a b "\n"))
453 (set! (configuration (vector-ref result i)) x)))
456 ;; (display (list "putting " x "\n"))
457 (set! (configuration (vector-ref result result-idx)) x))
459 (define (current-voice-state now-state voice-num)
460 (define vs ((if (= 1 voice-num) car cdr)
461 (voice-states now-state)))
462 (if (or (not vs) (equal? (moment now-state) (moment vs)))
464 (previous-voice-state vs)))
466 (define (try-solo type start-idx current-idx)
467 "Find a maximum stretch that can be marked as solo. Only set
468 the mark when there are no spanners active.
470 return next idx to analyse.
472 (if (< current-idx (vector-length result))
473 (let* ((now-state (vector-ref result current-idx))
474 (solo-state (current-voice-state now-state (if (equal? type 'solo1) 1 2)))
475 (silent-state (current-voice-state now-state (if (equal? type 'solo1) 2 1)))
476 (silent-notes (if silent-state (note-events silent-state) '()))
477 (solo-notes (if solo-state (note-events solo-state) '())))
478 ;; (display (list "trying " type " at " (moment now-state) solo-state silent-state "\n"))
479 (cond ((not (equal? (configuration now-state) 'apart))
481 ((> (length silent-notes) 0) start-idx)
483 (put-range type start-idx current-idx)
486 (null? (span-state solo-state)))
489 ;; This includes rests. This isn't a problem: long rests
490 ;; will be shared with the silent voice, and be marked
491 ;; as unisilence. Therefore, long rests won't
492 ;; accidentally be part of a solo.
494 (put-range type start-idx current-idx)
495 (try-solo type (1+ current-idx) (1+ current-idx)))
497 (try-solo type start-idx (1+ current-idx)))))
501 (define (analyse-moment result-idx)
502 "Analyse 'apart starting at RESULT-IDX. Return next index."
503 (let* ((now-state (vector-ref result result-idx))
504 (vs1 (current-voice-state now-state 1))
505 (vs2 (current-voice-state now-state 2))
506 ;; (vs1 (car (voice-states now-state)))
507 ;; (vs2 (cdr (voice-states now-state)))
508 (notes1 (if vs1 (note-events vs1) '()))
509 (notes2 (if vs2 (note-events vs2) '()))
511 (n2 (length notes2)))
512 ;; (display (list "analyzing step " result-idx " moment " (moment now-state) vs1 vs2 "\n"))
514 ;; we should always increase.
515 (cond ((and (= n1 0) (= n2 0))
519 (equal? (moment vs1) (moment now-state))
520 (null? (previous-span-state vs1)))
521 (try-solo 'solo1 result-idx result-idx))
523 (equal? (moment vs2) (moment now-state))
524 (null? (previous-span-state vs2)))
525 (try-solo 'solo2 result-idx result-idx))
527 (else (1+ result-idx)))
531 (if (< result-idx (vector-length result))
532 (if (equal? (configuration (vector-ref result result-idx)) 'apart)
533 (analyse-solo12 (analyse-moment result-idx))
534 (analyse-solo12 (1+ result-idx))))) ; analyse-solo12
536 (analyse-spanner-states voice-state-vec1)
537 (analyse-spanner-states voice-state-vec2)
540 (display voice-state-vec1)
542 (display voice-state-vec2)
547 ;; Extract all forced combine strategies, i.e. events inserted by
548 ;; \partcombine(Apart|Automatic|SoloI|SoloII|Chords)[Once]
549 ;; They will in the end override the automaically determined ones.
550 ;; Initial state for both voices is no override
551 (analyse-forced-combine 0 #f)
552 ;; Now go through all time steps in a loop and find a combination strategy
553 ;; based only on the events of that one moment (i.e. neglecting longer
554 ;; periods of solo/apart, etc.)
555 (analyse-time-step 0)
557 ;; Check for unisono or unisilence moments
563 ;; forced-configuration overrides, if it is set
564 (lambda (x) (cons (moment x) (or (forced-configuration x) (configuration x))))
565 (vector->list result)))
571 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
573 (define-public (add-quotable parser name mus)
574 (let* ((tab (eval 'musicQuotes (current-module)))
575 (voicename (get-next-unique-voice-name))
576 ;; recording-group-emulate returns an assoc list (reversed!), so
577 ;; hand it a proper unique context name and extract that key:
578 (ctx-spec (context-spec-music mus 'Voice voicename))
579 (listener (ly:parser-lookup parser 'partCombineListener))
580 (context-list (reverse (recording-group-emulate ctx-spec listener)))
581 (raw-voice (assoc voicename context-list))
582 (quote-contents (if (pair? raw-voice) (cdr raw-voice) '())))
584 ;; If the context-specced quoted music does not contain anything, try to
585 ;; use the first child, i.e. the next in context-list after voicename
586 ;; That's the case e.g. for \addQuote "x" \relative c \new Voice {...}
587 (if (null? quote-contents)
588 (let find-non-empty ((current-tail (member raw-voice context-list)))
589 ;; if voice has contents, use them, otherwise check next ctx
590 (cond ((null? current-tail) #f)
591 ((and (pair? (car current-tail))
592 (pair? (cdar current-tail)))
593 (set! quote-contents (cdar current-tail)))
594 (else (find-non-empty (cdr current-tail))))))
596 (if (not (null? quote-contents))
597 (hash-set! tab name (list->vector (reverse! quote-contents '())))
598 (ly:music-warning mus (ly:format (_ "quoted music `~a' is empty") name)))))