1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2004--2014 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 (rest-and-skip-events (vs <Voice-state>))
49 (or (ly:in-event-class? x 'rest-event)
50 (ly:in-event-class? x 'skip-event)))
51 (filter f? (events vs)))
53 (define-method (previous-voice-state (vs <Voice-state>))
54 (let ((i (slot-ref vs 'vector-index))
55 (v (slot-ref vs 'state-vector)))
60 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
62 (define-class <Split-state> ()
63 ;; The automatically determined split configuration
64 (configuration #:init-value '() #:accessor configuration)
65 ;; Allow overriding split configuration, takes precedence over configuration
66 (forced-configuration #:init-value #f #:accessor forced-configuration)
67 (when-moment #:accessor moment #:init-keyword #:moment)
68 ;; voice-states are states starting with the Split-state or later
70 (is #:init-keyword #:voice-states #:accessor voice-states)
71 (synced #:init-keyword #:synced #:init-value #f #:getter synced?))
74 (define-method (write (x <Split-state> ) f)
75 (display (moment x) f)
77 (display (configuration x) f)
82 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
85 (define (previous-span-state vs)
86 (let ((p (previous-voice-state vs)))
87 (if p (span-state p) '())))
89 (define (make-voice-states evl)
90 (let ((vec (list->vector (map (lambda (v)
94 #:events (map car (cdr v))))
97 ((= i (vector-length vec)) vec)
98 (slot-set! (vector-ref vec i) 'vector-index i)
99 (slot-set! (vector-ref vec i) 'state-vector vec))))
101 (define (make-split-state vs1 vs2)
102 "Merge lists VS1 and VS2, containing Voice-state objects into vector
103 of Split-state objects, crosslinking the Split-state vector and
106 (define (helper ss-idx ss-list idx1 idx2)
107 (let* ((state1 (if (< idx1 (vector-length vs1)) (vector-ref vs1 idx1) #f))
108 (state2 (if (< idx2 (vector-length vs2)) (vector-ref vs2 idx2) #f))
109 (min (cond ((and state1 state2) (moment-min (moment state1) (moment state2)))
110 (state1 (moment state1))
111 (state2 (moment state2))
113 (inc1 (if (and state1 (equal? min (moment state1))) 1 0))
114 (inc2 (if (and state2 (equal? min (moment state2))) 1 0))
118 #:voice-states (cons state1 state2)
119 #:synced (= inc1 inc2))
122 (set! (split-index state1) ss-idx))
124 (set! (split-index state2) ss-idx))
127 (cons ss-object ss-list)
131 (list->vector (reverse! (helper 0 '() 0 0) '())))
133 (define (analyse-spanner-states voice-state-vec)
135 (define (helper index active)
136 "Analyse EVS at INDEX, given state ACTIVE."
138 (define (analyse-tie-start active ev)
139 (if (ly:in-event-class? ev 'tie-event)
140 (acons 'tie (split-index (vector-ref voice-state-vec index))
144 (define (analyse-tie-end active ev)
145 (if (ly:in-event-class? ev 'note-event)
146 (assoc-remove! active 'tie)
149 (define (analyse-absdyn-end active ev)
150 (if (or (ly:in-event-class? ev 'absolute-dynamic-event)
151 (and (ly:in-event-class? ev 'span-dynamic-event)
152 (equal? STOP (ly:event-property ev 'span-direction))))
153 (assoc-remove! (assoc-remove! active 'cresc) 'decr)
156 (define (active<? a b)
157 (cond ((symbol<? (car a) (car b)) #t)
158 ((symbol<? (car b) (car a)) #f)
159 (else (< (cdr a) (cdr b)))))
161 (define (analyse-span-event active ev)
162 (let* ((name (car (ly:event-property ev 'class)))
163 (key (cond ((equal? name 'slur-event) 'slur)
164 ((equal? name 'phrasing-slur-event) 'tie)
165 ((equal? name 'beam-event) 'beam)
166 ((equal? name 'crescendo-event) 'cresc)
167 ((equal? name 'decrescendo-event) 'decr)
169 (sp (ly:event-property ev 'span-direction)))
170 (if (and (symbol? key) (ly:dir? sp))
172 (assoc-remove! active key)
174 (split-index (vector-ref voice-state-vec index))
178 (define (analyse-events active evs)
179 "Run all analyzers on ACTIVE and EVS"
180 (define (run-analyzer analyzer active evs)
182 (run-analyzer analyzer (analyzer active (car evs)) (cdr evs))
184 (define (run-analyzers analyzers active evs)
185 (if (pair? analyzers)
186 (run-analyzers (cdr analyzers)
187 (run-analyzer (car analyzers) active evs)
190 (sort ;; todo: use fold or somesuch.
191 (run-analyzers (list analyse-absdyn-end analyse-span-event
192 ;; note: tie-start/span comes after tie-end/absdyn.
193 analyse-tie-end analyse-tie-start)
197 ;; must copy, since we use assoc-remove!
198 (if (< index (vector-length voice-state-vec))
200 (set! active (analyse-events active (events (vector-ref voice-state-vec index))))
201 (set! (span-state (vector-ref voice-state-vec index))
203 (helper (1+ index) active))))
207 (define recording-group-functions
208 ;;Selected parts from @var{toplevel-music-functions} not requiring @code{parser}.
210 (lambda (music) (expand-repeat-chords! '(rhythmic-event) music))
211 expand-repeat-notes!))
214 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
215 (define-public (recording-group-emulate music odef)
216 "Interpret @var{music} according to @var{odef}, but store all events
217 in a chronological list, similar to the @code{Recording_group_engraver} in
218 LilyPond version 2.8 and earlier."
221 (now-mom (ly:make-moment 0 0))
222 (global (ly:make-global-context odef))
223 (mom-listener (ly:make-listener
224 (lambda (tev) (set! now-mom (ly:event-property tev 'moment)))))
225 (new-context-listener
229 ((child (ly:event-property sev 'context))
230 (this-moment-list (cons (ly:context-id child) '()))
231 (dummy (set! context-list (cons this-moment-list context-list)))
233 (accumulate-event-listener
234 (ly:make-listener (lambda (ev)
235 (set! acc (cons (cons ev #t) acc)))))
237 (ly:make-listener (lambda (tev)
241 (ly:context-property child 'instrumentTransposition))
242 ;; The accumulate-event-listener above creates
243 ;; the list of events in reverse order, so we
244 ;; have to revert it to the original order again
246 (set-cdr! this-moment-list
247 (cons this-moment (cdr this-moment-list)))
249 (ly:add-listener accumulate-event-listener
250 (ly:context-event-source child) 'StreamEvent)
251 (ly:add-listener save-acc-listener
252 (ly:context-event-source global) 'OneTimeStep))))))
253 (ly:add-listener new-context-listener
254 (ly:context-events-below global) 'AnnounceNewContext)
255 (ly:add-listener mom-listener (ly:context-event-source global) 'Prepare)
256 (ly:interpret-music-expression
257 (make-non-relative-music
258 (fold (lambda (x m) (x m)) music recording-group-functions))
262 (define-public (make-part-combine-music parser music-list direction chord-range)
263 (let* ((m (make-music 'PartCombineMusic))
264 (m1 (make-non-relative-music (context-spec-music (first music-list) 'Voice "one")))
265 (m2 (make-non-relative-music (context-spec-music (second music-list) 'Voice "two")))
266 (listener (ly:parser-lookup parser 'partCombineListener))
267 (evs2 (recording-group-emulate m2 listener))
268 (evs1 (recording-group-emulate m1 listener)))
270 (set! (ly:music-property m 'elements) (list m1 m2))
271 (set! (ly:music-property m 'direction) direction)
272 (set! (ly:music-property m 'split-list)
273 (if (and (assoc "one" evs1) (assoc "two" evs2))
274 (determine-split-list (reverse! (assoc-get "one" evs1) '())
275 (reverse! (assoc-get "two" evs2) '())
280 (define-public (determine-split-list evl1 evl2 chord-range)
281 "@var{evl1} and @var{evl2} should be ascending. @var{chord-range} is a pair of numbers (min . max) defining the distance in steps between notes that may be combined into a chord or unison."
283 (voice-state-vec1 (make-voice-states evl1))
284 (voice-state-vec2 (make-voice-states evl2))
285 (result (make-split-state voice-state-vec1 voice-state-vec2))
286 (chord-min-diff (car chord-range))
287 (chord-max-diff (cdr chord-range)))
289 ;; Go through all moments recursively and check if the events of that
290 ;; moment contain a part-combine-force-event override. If so, store its
291 ;; value in the forced-configuration field, which will override. The
292 ;; previous configuration is used to determine non-terminated settings.
293 (define (analyse-forced-combine result-idx prev-res)
295 (define (get-forced-event x)
296 (and (ly:in-event-class? x 'part-combine-force-event)
297 (cons (ly:event-property x 'forced-type)
298 (ly:event-property x 'once))))
299 (define (part-combine-events vs)
302 (filter-map get-forced-event (events vs))))
303 ;; end part-combine-events
305 ;; forced-result: Take the previous config and analyse whether
306 ;; any change happened.... Return new once and permanent config
307 (define (forced-result evt state)
308 ;; sanity check, evt should always be (new-state . once)
309 (if (not (and (pair? evt) (pair? state)))
312 ;; Once-event, leave permanent state unchanged
313 (cons (car evt) (cdr state))
314 ;; permanent change, leave once state unchanged
315 (cons (car state) (car evt)))))
316 ;; end forced-combine-result
318 ;; body of analyse-forced-combine:
319 (if (< result-idx (vector-length result))
320 (let* ((now-state (vector-ref result result-idx)) ; current result
321 ;; Extract all part-combine force events
322 (ev1 (part-combine-events (car (voice-states now-state))))
323 (ev2 (part-combine-events (cdr (voice-states now-state))))
324 (evts (append ev1 ev2))
325 ;; result is (once-state permament-state):
326 (state (fold forced-result (cons 'automatic prev-res) evts))
327 ;; Now let once override permanent changes:
328 (force-state (if (equal? (car state) 'automatic)
331 (set! (forced-configuration (vector-ref result result-idx))
333 ;; For the next moment, ignore the once override (car stat)
334 ;; and pass on the permanent override, stored as (cdr state)
335 (analyse-forced-combine (1+ result-idx) (cdr state)))))
336 ;; end analyse-forced-combine
339 (define (analyse-time-step result-idx)
340 (define (put x . index)
341 "Put the result to X, starting from INDEX backwards.
343 Only set if not set previously.
345 (let ((i (if (pair? index) (car index) result-idx)))
347 (not (symbol? (configuration (vector-ref result i)))))
349 (set! (configuration (vector-ref result i)) x)
352 (define (copy-state-from state-vec vs)
353 (define (copy-one-state key-idx)
354 (let* ((idx (cdr key-idx))
355 (prev-ss (vector-ref result idx))
356 (prev (configuration prev-ss)))
359 (for-each copy-one-state (span-state vs)))
361 (define (analyse-notes now-state)
362 (let* ((vs1 (car (voice-states now-state)))
363 (vs2 (cdr (voice-states now-state)))
364 (notes1 (note-events vs1))
365 (durs1 (sort (map (lambda (x) (ly:event-property x 'duration))
368 (pitches1 (sort (map (lambda (x) (ly:event-property x 'pitch))
371 (notes2 (note-events vs2))
372 (durs2 (sort (map (lambda (x) (ly:event-property x 'duration))
375 (pitches2 (sort (map (lambda (x) (ly:event-property x 'pitch))
378 (cond ((> (length notes1) 1) (put 'apart))
379 ((> (length notes2) 1) (put 'apart))
380 ((= 1 (+ (length notes2) (length notes1))) (put 'apart))
381 ((and (= (length durs1) 1)
383 (not (equal? (car durs1) (car durs2))))
386 (if (and (= (length pitches1) (length pitches2)))
387 (if (and (pair? pitches1)
389 ; Is the interval outside of chord-range?
390 (let ((diff (ly:pitch-steps
391 (ly:pitch-diff (car pitches1)
393 (or (< diff chord-min-diff)
394 (> diff chord-max-diff)
397 ;; copy previous split state from spanner state
399 (if (previous-voice-state vs1)
400 (copy-state-from voice-state-vec1
401 (previous-voice-state vs1)))
402 (if (previous-voice-state vs2)
403 (copy-state-from voice-state-vec2
404 (previous-voice-state vs2)))
405 (if (and (null? (span-state vs1)) (null? (span-state vs2)))
406 (put 'chords)))))))))
408 (if (< result-idx (vector-length result))
409 (let* ((now-state (vector-ref result result-idx))
410 (vs1 (car (voice-states now-state)))
411 (vs2 (cdr (voice-states now-state))))
413 (cond ((not vs1) (put 'apart))
414 ((not vs2) (put 'apart))
416 (let ((active1 (previous-span-state vs1))
417 (active2 (previous-span-state vs2))
418 (new-active1 (span-state vs1))
419 (new-active2 (span-state vs2)))
421 (display (list (moment now-state) result-idx
422 active1 "->" new-active1
423 active2 "->" new-active2
425 (if (and (synced? now-state)
426 (equal? active1 active2)
427 (equal? new-active1 new-active2))
428 (analyse-notes now-state)
430 ;; active states different:
433 ;; go to the next one, if it exists.
434 (analyse-time-step (1+ result-idx)))))))
436 (define (analyse-a2 result-idx)
437 (if (< result-idx (vector-length result))
438 (let* ((now-state (vector-ref result result-idx))
439 (vs1 (car (voice-states now-state)))
440 (vs2 (cdr (voice-states now-state))))
442 (define (analyse-silence)
443 (let ((rests1 (if vs1 (rest-and-skip-events vs1) '()))
444 (rests2 (if vs2 (rest-and-skip-events vs2) '())))
447 ;; multi-measure rests (probably), which the
448 ;; part-combine iterator handles well
449 ((and (synced? now-state)
450 (= 0 (length rests1))
451 (= 0 (length rests2)))
452 (set! (configuration now-state) 'unisilence))
454 ;; equal rests or equal skips, but not one of each
455 ((and (synced? now-state)
456 (= 1 (length rests1))
457 (= 1 (length rests2))
458 (equal? (ly:event-property (car rests1) 'class)
459 (ly:event-property (car rests2) 'class))
460 (equal? (ly:event-property (car rests1) 'duration)
461 (ly:event-property (car rests2) 'duration)))
462 (set! (configuration now-state) 'unisilence))
464 ;; rests of different durations or mixed with
465 ;; skips or multi-measure rests
467 ;; TODO When one part has a rest and the other has a
468 ;; multi-measure rest, tell the part-combine
469 ;; iterator to route the part with the rest to the
470 ;; shared voice. Until there is a way to do this,
471 ;; we print them both; it does not look very good,
472 ;; but failing to print the rest is misleading.
474 ;; Maybe do something similar for skips; route
475 ;; the rest to the shared voice and the skip to
476 ;; the voice for its part.
477 (set! (configuration now-state) 'apart-silence))
479 ;; TODO At a multi-measure rest, return to unisilence
480 ;; even after having been apart. The results are not
481 ;; good now because of the deficiency mentioned
486 (let ((notes1 (if vs1 (note-events vs1) '()))
487 (notes2 (if vs2 (note-events vs2) '())))
488 ; Todo: What about a2 chords, e.g. string multi-stops?
489 ; Sort and compare notes1 and notes2?
490 (cond ((and (equal? (configuration now-state) 'chords)
491 (= 1 (length notes1))
492 (= 1 (length notes2))
493 (equal? (ly:event-property (car notes1) 'pitch)
494 (ly:event-property (car notes2) 'pitch)))
495 (set! (configuration now-state) 'unisono))
496 ((and (= 0 (length notes1))
497 (= 0 (length notes2)))
498 (analyse-silence)))))
499 (analyse-a2 (1+ result-idx)))))
501 (define (analyse-solo12 result-idx)
503 (define (previous-config vs)
504 (let* ((pvs (previous-voice-state vs))
505 (spi (if pvs (split-index pvs) #f))
506 (prev-split (if spi (vector-ref result spi) #f)))
508 (configuration prev-split)
511 (define (put-range x a b)
512 ;; (display (list "put range " x a b "\n"))
515 (set! (configuration (vector-ref result i)) x)))
518 ;; (display (list "putting " x "\n"))
519 (set! (configuration (vector-ref result result-idx)) x))
521 (define (current-voice-state now-state voice-num)
522 (define vs ((if (= 1 voice-num) car cdr)
523 (voice-states now-state)))
524 (if (or (not vs) (equal? (moment now-state) (moment vs)))
526 (previous-voice-state vs)))
528 (define (try-solo type start-idx current-idx)
529 "Find a maximum stretch that can be marked as solo. Only set
530 the mark when there are no spanners active.
532 return next idx to analyse.
534 (if (< current-idx (vector-length result))
535 (let* ((now-state (vector-ref result current-idx))
536 (solo-state (current-voice-state now-state (if (equal? type 'solo1) 1 2)))
537 (silent-state (current-voice-state now-state (if (equal? type 'solo1) 2 1)))
538 (silent-notes (if silent-state (note-events silent-state) '()))
539 (solo-notes (if solo-state (note-events solo-state) '())))
540 ;; (display (list "trying " type " at " (moment now-state) solo-state silent-state "\n"))
541 (cond ((not (equal? (configuration now-state) 'apart))
543 ((> (length silent-notes) 0) start-idx)
545 (put-range type start-idx current-idx)
548 (null? (span-state solo-state)))
551 ;; This includes rests. This isn't a problem: long rests
552 ;; will be shared with the silent voice, and be marked
553 ;; as unisilence. Therefore, long rests won't
554 ;; accidentally be part of a solo.
556 (put-range type start-idx current-idx)
557 (try-solo type (1+ current-idx) (1+ current-idx)))
559 (try-solo type start-idx (1+ current-idx)))))
563 (define (analyse-moment result-idx)
564 "Analyse 'apart starting at RESULT-IDX. Return next index."
565 (let* ((now-state (vector-ref result result-idx))
566 (vs1 (current-voice-state now-state 1))
567 (vs2 (current-voice-state now-state 2))
568 ;; (vs1 (car (voice-states now-state)))
569 ;; (vs2 (cdr (voice-states now-state)))
570 (notes1 (if vs1 (note-events vs1) '()))
571 (notes2 (if vs2 (note-events vs2) '()))
573 (n2 (length notes2)))
574 ;; (display (list "analyzing step " result-idx " moment " (moment now-state) vs1 vs2 "\n"))
576 ;; we should always increase.
577 (cond ((and (= n1 0) (= n2 0))
581 (equal? (moment vs1) (moment now-state))
582 (null? (previous-span-state vs1)))
583 (try-solo 'solo1 result-idx result-idx))
585 (equal? (moment vs2) (moment now-state))
586 (null? (previous-span-state vs2)))
587 (try-solo 'solo2 result-idx result-idx))
589 (else (1+ result-idx)))
593 (if (< result-idx (vector-length result))
594 (if (equal? (configuration (vector-ref result result-idx)) 'apart)
595 (analyse-solo12 (analyse-moment result-idx))
596 (analyse-solo12 (1+ result-idx))))) ; analyse-solo12
598 (analyse-spanner-states voice-state-vec1)
599 (analyse-spanner-states voice-state-vec2)
602 (display voice-state-vec1)
604 (display voice-state-vec2)
609 ;; Extract all forced combine strategies, i.e. events inserted by
610 ;; \partcombine(Apart|Automatic|SoloI|SoloII|Chords)[Once]
611 ;; They will in the end override the automaically determined ones.
612 ;; Initial state for both voices is no override
613 (analyse-forced-combine 0 #f)
614 ;; Now go through all time steps in a loop and find a combination strategy
615 ;; based only on the events of that one moment (i.e. neglecting longer
616 ;; periods of solo/apart, etc.)
617 (analyse-time-step 0)
619 ;; Check for unisono or unisilence moments
625 ;; forced-configuration overrides, if it is set
626 (lambda (x) (cons (moment x) (or (forced-configuration x) (configuration x))))
627 (vector->list result)))
633 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
635 (define-public (add-quotable parser name mus)
636 (let* ((tab (eval 'musicQuotes (current-module)))
637 (voicename (get-next-unique-voice-name))
638 ;; recording-group-emulate returns an assoc list (reversed!), so
639 ;; hand it a proper unique context name and extract that key:
640 (ctx-spec (context-spec-music mus 'Voice voicename))
641 (listener (ly:parser-lookup parser 'partCombineListener))
642 (context-list (reverse (recording-group-emulate ctx-spec listener)))
643 (raw-voice (assoc voicename context-list))
644 (quote-contents (if (pair? raw-voice) (cdr raw-voice) '())))
646 ;; If the context-specced quoted music does not contain anything, try to
647 ;; use the first child, i.e. the next in context-list after voicename
648 ;; That's the case e.g. for \addQuote "x" \relative c \new Voice {...}
649 (if (null? quote-contents)
650 (let find-non-empty ((current-tail (member raw-voice context-list)))
651 ;; if voice has contents, use them, otherwise check next ctx
652 (cond ((null? current-tail) #f)
653 ((and (pair? (car current-tail))
654 (pair? (cdar current-tail)))
655 (set! quote-contents (cdar current-tail)))
656 (else (find-non-empty (cdr current-tail))))))
658 (if (not (null? quote-contents))
659 (hash-set! tab name (list->vector (reverse! quote-contents '())))
660 (ly:music-warning mus (ly:format (_ "quoted music `~a' is empty") name)))))