scm/part-combiner.scm

   1 ;;;; part-combiner.scm -- Part combining, staff changes.
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2006     Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   7 ;; todo: figure out how to make module,
   8 ;; without breaking nested ly scopes
   9
  10 (define-class <Voice-state> ()
  11   (event-list #:init-value '() #:accessor events #:init-keyword #:events)
  12   (when-moment #:accessor when #:init-keyword #:when)
  13   (tuning #:accessor tuning #:init-keyword #:tuning)
  14   (split-index #:accessor split-index)
  15   (vector-index)
  16   (state-vector)
  17   ;;;
  18   ;; spanner-state is an alist
  19   ;; of (SYMBOL . RESULT-INDEX), which indicates where
  20   ;; said spanner was started.
  21   (spanner-state #:init-value '() #:accessor span-state))
  22
  23 (define-method (write (x <Voice-state> ) file)
  24   (display (when x) file)
  25   (display " evs = " file)
  26   (display (events x) file)
  27   (display " active = " file)
  28   (display (span-state x) file)
  29   (display "\n" file))
  30
  31 (define-method (note-events (vs <Voice-state>))
  32   (define (f? x)
  33     (equal? (ly:event-property  x 'class) 'note-event))
  34   (filter f? (events vs)))
  35
  36 (define-method (previous-voice-state (vs <Voice-state>))
  37   (let ((i (slot-ref vs 'vector-index))
  38         (v (slot-ref vs 'state-vector)))
  39     (if (< 0 i)
  40         (vector-ref v (1- i))
  41         #f)))
  42
  43 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  44
  45 (define-class <Split-state> ()
  46   (configuration #:init-value '() #:accessor configuration)
  47   (when-moment #:accessor when #:init-keyword #:when)
  48   ;; voice-states are states starting with the Split-state or later
  49   ;;
  50   (is #:init-keyword #:voice-states #:accessor voice-states)
  51   (synced  #:init-keyword #:synced #:init-value  #f #:getter synced?))
  52
  53
  54 (define-method (write (x <Split-state> ) f)
  55   (display (when x) f)
  56   (display " = " f)
  57   (display (configuration x) f)
  58   (if (synced? x)
  59       (display " synced "))
  60   (display "\n" f))
  61
  62 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  63
  64
  65 (define (previous-span-state vs)
  66   (let ((p (previous-voice-state vs)))
  67     (if p (span-state p) '())))
  68
  69 (define (make-voice-states evl)
  70   (let ((vec (list->vector (map (lambda (v)
  71                                   (make <Voice-state>
  72                                     #:when (caar v)
  73                                     #:tuning (cdar v)
  74                                     #:events (map car (cdr v))))
  75                                 evl))))
  76     (do ((i 0 (1+ i)))
  77         ((= i (vector-length vec)) vec)
  78       (slot-set! (vector-ref vec i) 'vector-index i)
  79       (slot-set! (vector-ref vec i) 'state-vector vec))))
  80
  81 (define (make-split-state vs1 vs2)
  82   "Merge lists VS1 and VS2, containing Voice-state objects into vector
  83 of Split-state objects, crosslinking the Split-state vector and
  84 Voice-state objects
  85 "
  86   (define (helper ss-idx ss-list idx1 idx2)
  87     (let* ((state1 (if (< idx1 (vector-length vs1)) (vector-ref vs1 idx1) #f))
  88            (state2 (if (< idx2 (vector-length vs2)) (vector-ref vs2 idx2) #f))
  89            (min (cond ((and state1 state2) (moment-min (when state1) (when state2)))
  90                       (state1 (when state1))
  91                       (state2 (when state2))
  92                       (else #f)))
  93            (inc1 (if (and state1 (equal? min (when state1))) 1 0))
  94            (inc2 (if (and state2 (equal? min (when state2))) 1 0))
  95            (ss-object (if min
  96                           (make <Split-state>
  97                             #:when min
  98                             #:voice-states (cons state1 state2)
  99                             #:synced (= inc1 inc2))
 100                           #f)))
 101       (if state1
 102           (set! (split-index state1) ss-idx))
 103       (if state2
 104           (set! (split-index state2) ss-idx))
 105       (if min
 106           (helper (1+ ss-idx)
 107                   (cons ss-object ss-list)
 108                   (+ idx1 inc1)
 109                   (+ idx2 inc2))
 110           ss-list)))
 111   (list->vector (reverse! (helper 0 '() 0  0) '())))
 112
 113 (define (analyse-spanner-states voice-state-vec)
 114
 115   (define (helper index active)
 116     "Analyse EVS at INDEX, given state ACTIVE."
 117
 118     (define (analyse-tie-start active ev)
 119       (if (equal? (ly:event-property ev 'class) 'tie-event)
 120           (acons 'tie (split-index (vector-ref voice-state-vec index))
 121                  active)
 122           active))
 123
 124     (define (analyse-tie-end active ev)
 125       (if (equal? (ly:event-property ev 'class) 'note-event)
 126           (assoc-remove! active 'tie)
 127           active))
 128
 129     (define (analyse-absdyn-end active ev)
 130       (if (or (equal? (ly:event-property ev 'class) 'absolute-dynamic-event)
 131               (and (equal? (ly:event-property ev 'class) 'crescendo-event)
 132                    (equal? STOP (ly:event-property ev 'span-direction))))
 133           (assoc-remove! (assoc-remove! active 'cresc) 'decr)
 134           active))
 135
 136     (define (active<? a b)
 137       (cond ((symbol<? (car a) (car b)) #t)
 138             ((symbol<? (car b) (car b)) #f)
 139             (else (< (cdr a) (cdr b)))))
 140
 141     (define (analyse-span-event active ev)
 142       (let* ((name (ly:event-property ev 'class))
 143              (key (cond ((equal? name 'slur-event) 'slur)
 144                         ((equal? name 'phrasing-slur-event) 'tie)
 145                         ((equal? name 'beam-event) 'beam)
 146                         ((equal? name 'crescendo-event) 'cresc)
 147                         ((equal? name 'decrescendo-event) 'decr)
 148                         (else #f)))
 149              (sp (ly:event-property ev 'span-direction)))
 150         (if (and (symbol? key) (ly:dir? sp))
 151             (if (= sp STOP)
 152                 (assoc-remove! active key)
 153                 (acons key
 154                        (split-index (vector-ref voice-state-vec index))
 155                        active))
 156             active)))
 157
 158     (define (analyse-events active evs)
 159       "Run all analyzers on ACTIVE and EVS"
 160       (define (run-analyzer analyzer active evs)
 161         (if (pair? evs)
 162             (run-analyzer analyzer (analyzer active (car evs)) (cdr evs))
 163             active))
 164       (define (run-analyzers analyzers active evs)
 165         (if (pair? analyzers)
 166             (run-analyzers (cdr analyzers)
 167                            (run-analyzer (car analyzers) active evs)
 168                            evs)
 169             active))
 170       (sort ;; todo: use fold or somesuch.
 171        (run-analyzers (list analyse-absdyn-end analyse-span-event
 172                             ;; note: tie-start/span comes after tie-end/absdyn.
 173                             analyse-tie-end analyse-tie-start)
 174                       active evs)
 175        active<?))
 176
 177     ;; must copy, since we use assoc-remove!
 178     (if (< index (vector-length voice-state-vec))
 179         (begin
 180           (set! active (analyse-events active (events (vector-ref voice-state-vec index))))
 181           (set! (span-state (vector-ref voice-state-vec index))
 182                 (list-copy active))
 183           (helper (1+ index) active))))
 184
 185   (helper 0 '()))
 186
 187 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 188 (define-public (recording-group-emulate music odef)
 189   "Interprets music according to odef, but stores all events in a chronological list, similar to the Recording_group_engraver in 2.8 and earlier"
 190   (let*
 191       ((context-list '())
 192        (now-mom (ly:make-moment 0 0))
 193        (global (ly:make-global-context odef))
 194        (mom-listener (ly:make-listener
 195                       (lambda (tev)
 196                         (set! now-mom (ly:event-property tev 'moment)))))
 197        (new-context-listener
 198         (ly:make-listener
 199          (lambda (sev)
 200              (let*
 201                  ((child (ly:event-property sev 'context))
 202                   (this-moment-list
 203                    (cons (ly:context-id child) '()))
 204                   (dummy
 205                    (set! context-list (cons this-moment-list context-list)))
 206                   (acc '())
 207                   (accumulate-event-listener
 208                    (ly:make-listener (lambda (ev)
 209                                        (set! acc (cons (cons ev #t) acc)))))
 210                   (save-acc-listener (ly:make-listener (lambda (tev)
 211                                                          (if (pair? acc)
 212                                                              (let ((this-moment (cons (cons now-mom (ly:context-property child 'instrumentTransposition))
 213                                                                                       acc)))
 214                                                                (set-cdr! this-moment-list (cons this-moment (cdr this-moment-list)))
 215                                                                (set! acc '())))))))
 216                (ly:add-listener accumulate-event-listener (ly:context-event-source child) 'music-event)
 217                (ly:add-listener save-acc-listener (ly:context-event-source global) 'OneTimeStep))))))
 218     (ly:add-listener new-context-listener (ly:context-events-below global) 'AnnounceNewContext)
 219     (ly:add-listener mom-listener (ly:context-event-source global) 'Prepare)
 220     (ly:interpret-music-expression (make-non-relative-music music) global)
 221     context-list))
 222
 223 (define noticed '())
 224 ;; todo: junk this, extract $defaultlayout from parser instead
 225 (define part-combine-listener '())
 226
 227 ; UGH - should pass noticed setter to part-combine-listener
 228 (define-safe-public (set-part-combine-listener x)
 229   (set! part-combine-listener x))
 230
 231 (define-public (notice-the-events-for-pc context lst)
 232   "add CONTEXT-ID, EVENT list to NOTICED variable."
 233
 234   (set! noticed (acons (ly:context-id context) lst noticed)))
 235
 236 (define-public (make-part-combine-music music-list)
 237   (let* ((m (make-music 'PartCombineMusic))
 238         (m1 (make-non-relative-music (context-spec-music (first music-list) 'Voice "one")))
 239         (m2  (make-non-relative-music  (context-spec-music (second music-list) 'Voice "two")))
 240         (evs2 (recording-group-emulate m2 part-combine-listener))
 241         (evs1 (recording-group-emulate m1 part-combine-listener)))
 242     (set! (ly:music-property m 'elements) (list m1 m2))
 243     (set! (ly:music-property m 'split-list)
 244           (determine-split-list (reverse! (cdr (assoc "one" evs1)) '())
 245                                 (reverse! (cdr (assoc "two" evs2)) '())))
 246     m))
 247
 248 (define-public (determine-split-list evl1 evl2)
 249   "EVL1 and EVL2 should be ascending"
 250   (let* ((pc-debug #f)
 251          (chord-threshold 8)
 252          (voice-state-vec1 (make-voice-states evl1))
 253          (voice-state-vec2 (make-voice-states evl2))
 254          (result (make-split-state voice-state-vec1 voice-state-vec2)))
 255
 256     (define (analyse-time-step result-idx)
 257       (define (put x . index)
 258         "Put the result to X, starting from INDEX backwards.
 259
 260 Only set if not set previously.
 261 "
 262         (let ((i (if (pair? index) (car index) result-idx)))
 263           (if (and (<= 0 i)
 264                    (not (symbol? (configuration (vector-ref result i)))))
 265               (begin
 266                 (set! (configuration (vector-ref result i)) x)
 267                 (put x (1- i))))))
 268
 269       (define (copy-state-from state-vec vs)
 270         (define (copy-one-state key-idx)
 271           (let* ((idx (cdr key-idx))
 272                  (prev-ss (vector-ref result idx))
 273                  (prev (configuration prev-ss)))
 274             (if (symbol? prev)
 275                 (put prev))))
 276         (map copy-one-state (span-state vs)))
 277
 278       (define (analyse-notes now-state)
 279         (let* ((vs1 (car (voice-states now-state)))
 280                (vs2 (cdr (voice-states now-state)))
 281                (notes1 (note-events vs1))
 282                (durs1 (sort (map (lambda (x) (ly:event-property x 'duration))
 283                                  notes1)
 284                             ly:duration<?))
 285                (pitches1 (sort (map (lambda (x) (ly:event-property x 'pitch))
 286                                     notes1)
 287                                ly:pitch<?))
 288                (notes2 (note-events vs2))
 289                (durs2 (sort (map (lambda (x) (ly:event-property x 'duration))
 290                                  notes2)
 291                             ly:duration<?))
 292                (pitches2 (sort (map (lambda (x) (ly:event-property x 'pitch))
 293                                     notes2)
 294                                ly:pitch<?)))
 295           (cond ((> (length notes1) 1) (put 'apart))
 296                 ((> (length notes2) 1) (put 'apart))
 297                 ((= 1 (+ (length notes2) (length notes1))) (put 'apart))
 298                 ((and (= (length durs1) 1)
 299                       (= (length durs2) 1)
 300                       (not (equal? (car durs1) (car durs2))))
 301                  (put 'apart))
 302                 (else
 303                  (if (and (= (length pitches1) (length pitches2)))
 304                      (if (and (pair? pitches1)
 305                               (pair? pitches2)
 306                               (or
 307                                (< chord-threshold (ly:pitch-steps
 308                                                    (ly:pitch-diff (car pitches1)
 309                                                                   (car pitches2))))
 310
 311                                ;; voice crossings:
 312                                (> 0 (ly:pitch-steps (ly:pitch-diff (car pitches1)
 313                                                                    (car pitches2))))
 314                                ))
 315                          (put 'apart)
 316                          ;; copy previous split state from spanner state
 317                          (begin
 318                            (if (previous-voice-state vs1)
 319                                (copy-state-from voice-state-vec1
 320                                                 (previous-voice-state vs1)))
 321                            (if (previous-voice-state vs2)
 322                                (copy-state-from voice-state-vec2
 323                                                 (previous-voice-state vs2)))
 324                            (if (and (null? (span-state vs1)) (null? (span-state vs2)))
 325                                (put 'chords)))))))))
 326
 327       (if (< result-idx (vector-length result))
 328           (let* ((now-state (vector-ref result result-idx))
 329                  (vs1 (car (voice-states now-state)))
 330                  (vs2 (cdr (voice-states now-state))))
 331
 332             (cond ((not vs1) (put 'apart))
 333                   ((not vs2) (put 'apart))
 334                   (else
 335                    (let ((active1 (previous-span-state vs1))
 336                          (active2 (previous-span-state vs2))
 337                          (new-active1 (span-state vs1))
 338                          (new-active2 (span-state vs2)))
 339                      (if #f ; debug
 340                          (display (list (when now-state) result-idx
 341                                         active1 "->" new-active1
 342                                         active2 "->" new-active2
 343                                         "\n")))
 344                      (if (and (synced? now-state)
 345                               (equal? active1 active2)
 346                               (equal? new-active1 new-active2))
 347                          (analyse-notes now-state)
 348
 349                          ;; active states different:
 350                          (put 'apart)))
 351
 352                    ;; go to the next one, if it exists.
 353                    (analyse-time-step (1+ result-idx)))))))
 354
 355     (define (analyse-a2 result-idx)
 356       (if (< result-idx (vector-length result))
 357           (let* ((now-state (vector-ref result result-idx))
 358                  (vs1 (car (voice-states now-state)))
 359                  (vs2 (cdr (voice-states now-state))))
 360             (if (and (equal? (configuration now-state) 'chords)
 361                      vs1 vs2)
 362                 (let ((notes1 (note-events vs1))
 363                       (notes2 (note-events vs2)))
 364                   (cond ((and (= 1 (length notes1))
 365                               (= 1 (length notes2))
 366                               (equal? (ly:event-property (car notes1) 'pitch)
 367                                       (ly:event-property (car notes2) 'pitch)))
 368                          (set! (configuration now-state) 'unisono))
 369                         ((and (= 0 (length notes1))
 370                               (= 0 (length notes2)))
 371                          (set! (configuration now-state) 'unisilence)))))
 372             (analyse-a2 (1+ result-idx)))))
 373
 374     (define (analyse-solo12 result-idx)
 375
 376       (define (previous-config vs)
 377         (let* ((pvs (previous-voice-state vs))
 378                (spi (if pvs (split-index pvs) #f))
 379                (prev-split (if spi (vector-ref result spi) #f)))
 380           (if prev-split
 381               (configuration prev-split)
 382               'apart)))
 383
 384       (define (put-range x a b)
 385         ;; (display (list "put range "  x a b "\n"))
 386         (do ((i a (1+ i)))
 387             ((> i b) b)
 388           (set! (configuration (vector-ref result i)) x)))
 389
 390       (define (put x)
 391         ;; (display (list "putting "  x "\n"))
 392         (set! (configuration (vector-ref result result-idx)) x))
 393
 394       (define (current-voice-state now-state voice-num)
 395         (define vs ((if (= 1 voice-num) car cdr)
 396                     (voice-states now-state)))
 397         (if (or (not vs) (equal? (when now-state) (when vs)))
 398             vs
 399             (previous-voice-state vs)))
 400
 401       (define (try-solo type start-idx current-idx)
 402         "Find a maximum stretch that can be marked as solo. Only set
 403 the mark when there are no spanners active.
 404
 405       return next idx to analyse.
 406 "
 407         (if (< current-idx (vector-length result))
 408             (let* ((now-state (vector-ref result current-idx))
 409                    (solo-state (current-voice-state now-state (if (equal? type 'solo1) 1 2)))
 410                    (silent-state (current-voice-state now-state (if (equal? type 'solo1) 2 1)))
 411                    (silent-notes (if silent-state (note-events silent-state) '()))
 412                    (solo-notes (if solo-state (note-events solo-state) '())))
 413               ;; (display (list "trying " type " at "  (when now-state) solo-state silent-state  "\n"))
 414               (cond ((not (equal? (configuration now-state) 'apart))
 415                      current-idx)
 416                     ((> (length silent-notes) 0) start-idx)
 417                     ((not solo-state)
 418                      (put-range type start-idx current-idx)
 419                      current-idx)
 420                     ((and
 421                       (null? (span-state solo-state)))
 422
 423                      ;;
 424                      ;; This includes rests. This isn't a problem: long rests
 425                      ;; will be shared with the silent voice, and be marked
 426                      ;; as unisilence. Therefore, long rests won't
 427                      ;;  accidentally be part of a solo.
 428                      ;;
 429                      (put-range type start-idx current-idx)
 430                      (try-solo type (1+ current-idx) (1+  current-idx)))
 431                     (else
 432                      (try-solo type start-idx (1+ current-idx)))))
 433             ;; try-solo
 434             start-idx))
 435
 436       (define (analyse-moment result-idx)
 437         "Analyse 'apart starting at RESULT-IDX. Return next index. "
 438         (let* ((now-state (vector-ref result result-idx))
 439                (vs1 (current-voice-state now-state 1))
 440                (vs2 (current-voice-state now-state 2))
 441                ;; (vs1 (car (voice-states now-state)))
 442                ;; (vs2 (cdr (voice-states now-state)))
 443                (notes1 (if vs1 (note-events vs1) '()))
 444                (notes2 (if vs2 (note-events vs2) '()))
 445                (n1 (length notes1))
 446                (n2 (length notes2)))
 447           ;; (display (list "analyzing step " result-idx "  moment " (when now-state) vs1 vs2  "\n"))
 448           (max
 449            ;; we should always increase.
 450            (cond ((and (= n1 0) (= n2 0))
 451                   (put 'apart-silence)
 452                   (1+ result-idx))
 453                  ((and (= n2 0)
 454                        (equal? (when vs1) (when now-state))
 455                        (null? (previous-span-state vs1)))
 456                   (try-solo 'solo1 result-idx result-idx))
 457                  ((and (= n1 0)
 458                        (equal? (when vs2) (when now-state))
 459                        (null? (previous-span-state vs2)))
 460                   (try-solo 'solo2 result-idx result-idx))
 461
 462                  (else (1+ result-idx)))
 463            ;; analyse-moment
 464            (1+ result-idx))))
 465
 466       (if (< result-idx (vector-length result))
 467           (if (equal? (configuration (vector-ref result result-idx)) 'apart)
 468               (analyse-solo12 (analyse-moment result-idx))
 469               (analyse-solo12 (1+ result-idx))))) ; analyse-solo12
 470
 471     (analyse-spanner-states voice-state-vec1)
 472     (analyse-spanner-states voice-state-vec2)
 473     (if #f
 474         (begin
 475           (display voice-state-vec1)
 476           (display "***\n")
 477           (display voice-state-vec2)
 478           (display "***\n")
 479           (display result)
 480           (display "***\n")))
 481     (analyse-time-step 0)
 482     ;; (display result)
 483     (analyse-a2 0)
 484     ;;(display result)
 485     (analyse-solo12 0)
 486     ;; (display result)
 487     (set! result (map
 488                   (lambda (x) (cons (when x) (configuration x)))
 489                   (vector->list result)))
 490     (if #f ;; pc-debug
 491          (display result))
 492     result))
 493
 494
 495 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 496
 497 (define-public (add-quotable name mus)
 498   (set! noticed '())
 499   (let* ((tab (eval 'musicQuotes (current-module)))
 500          (context-list (recording-group-emulate (context-spec-music mus 'Voice)
 501                                               part-combine-listener)))
 502     (if (pair? context-list)
 503         (hash-set! tab name
 504                    ;; cdr : skip name string
 505                    (list->vector (reverse! (cdar context-list)
 506                                            '()))))))