scm/music-functions.scm

   1 ;;;; music-functions.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   6 ;;;;                 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8 ;; (use-modules (ice-9 optargs))
   9
  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!))
  18
  19 (define-public ly:grob-property
  20   (make-procedure-with-setter ly:grob-property
  21                               ly:grob-set-property!))
  22
  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))
  29     (if (ly:music? e)
  30         (set! (ly:music-property music 'element)
  31               (music-map function  e)))
  32     (function music)))
  33
  34 (define-public (music-filter pred? music)
  35   "Filter out music expressions that do not satisfy PRED."
  36
  37   (define (inner-music-filter pred? music)
  38     "Recursive function."
  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)
  45                            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.
  51       (if (or (pred? music)
  52               (and (eq? filtered-es '()) (not (ly:music? e))
  53                    (or (not (eq? es '()))
  54                        (ly:music? e))))
  55           (set! music '()))
  56       music))
  57
  58   (set! music (inner-music-filter pred? music))
  59   (if (ly:music? music)
  60       music
  61       (make-music 'Music)))       ;must return music.
  62
  63 (define-public (remove-tag tag)
  64   (lambda (mus)
  65     (music-filter
  66      (lambda (m)
  67        (let* ((tags (ly:music-property m 'tags))
  68               (res (memq tag tags)))
  69          res))
  70      mus)))
  71
  72 (define-public (display-music music)
  73   "Display music, not done with music-map for clarity of presentation."
  74   (display music)
  75   (display ": { ")
  76   (let ((es (ly:music-property music 'elements))
  77         (e (ly:music-property music 'element)))
  78     (display (ly:music-mutable-properties music))
  79     (if (pair? es)
  80         (begin (display "\nElements: {\n")
  81                (map display-music es)
  82                (display "}\n")))
  83     (if (ly:music? e)
  84         (begin
  85           (display "\nChild:")
  86           (display-music e))))
  87   (display " }\n")
  88   music)
  89
  90
  91 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  92
  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)))
  98     (if (ly:duration? d)
  99         (let* ((cp (ly:duration-factor d))
 100                (nd (ly:make-duration (+ shift (ly:duration-log d))
 101                                      (+ dot (ly:duration-dot-count d))
 102                                      (car cp)
 103                                      (cdr cp))))
 104           (set! (ly:music-property music 'duration) nd)))
 105     music))
 106
 107
 108
 109 (define-public (shift-duration-log music shift dot)
 110   (music-map (lambda (x) (shift-one-duration-log x shift dot))
 111              music))
 112
 113
 114 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 115 ;; clusters.
 116
 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))
 123       music))
 124
 125 (define-public (notes-to-clusters music)
 126   (music-map note-to-cluster music))
 127
 128 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 129 ;; repeats.
 130
 131 (define-public (unfold-repeats music)
 132   "
 133 This function replaces all repeats  with unfold repeats. "
 134
 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")
 139         (begin
 140
 141           (if (equal? (ly:music-property music 'iterator-ctor)
 142                       Chord_tremolo_iterator::constructor)
 143               (let*
 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))
 148                                   -1 0))
 149                    )
 150
 151                 (if (= 0 -1)
 152                     (set! count (* 2 (quotient count 3))))
 153
 154                 (shift-duration-log music (+ (if seq-arg? 1 0)
 155                                              (ly:intlog2 count)) dot-shift)
 156
 157                 (if seq-arg?
 158                     (ly:music-compress e (ly:make-moment (length (ly:music-property e 'elements)) 1)))
 159                 ))
 160
 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)))
 167
 168     (if (pair? es)
 169         (set! (ly:music-property music 'elements)
 170               (map unfold-repeats es)))
 171     (if (ly:music? e)
 172         (set! (ly:music-property music 'element)
 173               (unfold-repeats e)))
 174     music))
 175
 176
 177 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 178 ;; property setting music objs.
 179
 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
 184               'symbol grob
 185               'grob-property gprop
 186               'grob-value val
 187               'pop-first #t))
 188
 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
 193               'symbol grob
 194               'grob-property gprop
 195               'grob-value val))
 196
 197 (define-public (make-grob-property-revert grob gprop)
 198   "Revert the grob property GPROP for GROB."
 199   (make-music 'OverrideProperty
 200               'symbol grob
 201               'grob-property gprop))
 202
 203 (define direction-polyphonic-grobs
 204   '(Stem Tie Rest Slur Script TextScript Dots DotColumn
 205          ))
 206
 207 (define-public (make-voice-props-set n)
 208   (make-sequential-music
 209    (append
 210     (map (lambda (x) (make-grob-property-set x 'direction
 211                                              (if (odd? n) -1 1)))
 212          direction-polyphonic-grobs)
 213     (list
 214      (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
 215      (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))
 216
 217      ))))
 218
 219
 220 (define-public (make-voice-props-revert)
 221   (make-sequential-music
 222    (append
 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)))))
 227
 228
 229 (define*-public (context-spec-music m context #:optional id)
 230   "Add \\context CONTEXT = ID to M. "
 231   (let ((cm (make-music 'ContextSpeccedMusic
 232                         'element m
 233                         'context-type context)))
 234     (if (string? id)
 235         (set! (ly:music-property cm 'context-id) id))
 236     cm))
 237
 238
 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)
 243     cm))
 244
 245 (define-public (make-non-relative-music mus)
 246   (make-music 'UnrelativableMusic
 247               'element mus
 248   ))
 249
 250 (define-public (make-apply-context func)
 251   (make-music 'ApplyContext
 252               'procedure func))
 253
 254 (define-public (make-sequential-music elts)
 255   (make-music 'SequentialMusic
 256               'elements elts))
 257
 258 (define-public (make-simultaneous-music elts)
 259   (make-music 'SimultaneousMusic
 260               'elements elts))
 261
 262 (define-public (make-event-chord elts)
 263   (make-music 'EventChord
 264               'elements elts))
 265
 266 (define-public (make-skip-music dur)
 267   (make-music 'SkipMusic
 268               'duration dur))
 269
 270 (define-public (make-grace-music music)
 271   (make-music 'GraceMusic
 272               'element music))
 273
 274 ;;;;;;;;;;;;;;;;
 275
 276 ;; mmrest
 277 (define-public (make-multi-measure-rest duration location)
 278   (make-music 'MultiMeasureRestMusicGroup
 279               'origin location
 280               'elements (list (make-music 'BarCheck
 281                                           'origin location)
 282                               (make-event-chord (list (make-music 'MultiMeasureRestEvent
 283                                                                   'origin location
 284                                                                   'duration duration)))
 285                               (make-music 'BarCheck
 286                                           'origin location))))
 287
 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))))
 296       (if (ly:dir? dir)
 297           (set! (ly:music-property p 'direction) dir))
 298       p))
 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)))
 304         (if (pair? texts)
 305             (set! (ly:music-property music 'elements)
 306                   (cons (make-event-chord texts) others)))))
 307   music)
 308
 309
 310 (define-public (make-property-set sym val)
 311   (make-music 'PropertySet
 312               'symbol sym
 313               'value val))
 314
 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))
 322           (if (= octavation 0)
 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")
 332                                                       (1 . "8va")
 333                                                       (0 . #f)
 334                                                       (-1 . "8va bassa")
 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)))
 341
 342 (define-public (set-octavation ottavation)
 343   (ly:export (make-ottava-set ottavation)))
 344
 345 (define-public (make-time-signature-set num den . rest)
 346   "Set properties for time signature NUM/DEN.  Rest can contain a list
 347 of beat groupings "
 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)
 354                                                     (car rest)
 355                                                     '())))
 356          (basic  (list set1 set2 set3 set4)))
 357     (descend-to-context
 358      (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
 359
 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)
 364                                       'Score)
 365                   #f))
 366          (ev (make-music 'MarkEvent))
 367          (ch (make-event-chord (list ev))))
 368     (if set
 369         (make-sequential-music (list set ch))
 370         (begin
 371           (set! (ly:music-property ev 'label) label)
 372           ch))))
 373
 374 (define-public (set-time-signature num den . rest)
 375   (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
 376
 377 (define-public (make-penalty-music pen page-pen)
 378   (make-music 'BreakEvent
 379               'penalty pen
 380               'page-penalty page-pen))
 381
 382 (define-public (make-articulation name)
 383   (make-music 'ArticulationEvent
 384               'articulation-type name))
 385
 386 (define-public (make-lyric-event string duration)
 387   (make-music 'LyricEvent
 388               'duration duration
 389               'text string))
 390
 391 (define-public (make-span-event type spandir)
 392   (make-music type
 393               'span-direction spandir))
 394
 395 (define-public (set-mus-properties! m alist)
 396   "Set all of ALIST as properties of M."
 397   (if (pair? alist)
 398       (begin
 399         (set! (ly:music-property m (caar alist)) (cdar alist))
 400         (set-mus-properties! m (cdr alist)))))
 401
 402 (define-public (music-separator? m)
 403   "Is M a separator?"
 404   (let ((ts (ly:music-property m 'types)))
 405     (memq 'separator ts)))
 406
 407
 408 ;;; splitting chords into voices.
 409 (define (voicify-list lst number)
 410    "Make a list of Musics.
 411
 412    voicify-list :: [ [Music ] ] -> number -> [Music]
 413    LST is a list music-lists.
 414
 415    NUMBER is 0-base, i.e. Voice=1 (upstems) has number 0.
 416 "
 417    (if (null? lst)
 418        '()
 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)))))
 425
 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))
 431     ch))
 432
 433 (define-public (voicify-music m)
 434   "Recursively split chords that are separated with \\ "
 435   (if (not (ly:music? m))
 436       (begin (display m)
 437              (error "not music!")))
 438   (let ((es (ly:music-property m 'elements))
 439         (e (ly:music-property m 'element)))
 440     (if (pair? es)
 441         (set! (ly:music-property m 'elements) (map voicify-music es)))
 442     (if (ly:music? e)
 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)))
 447     m))
 448
 449 (define-public (empty-music)
 450   (ly:export (make-music 'Music)))
 451 ;;;
 452
 453 ; Make a function that checks score element for being of a specific type.
 454 (define-public (make-type-checker symbol)
 455   (lambda (elt)
 456     ;;(display  symbol)
 457     ;;(eq? #t (ly:grob-property elt symbol))
 458     (not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
 459
 460 (define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
 461   (if (func grob)
 462       (set! (ly:grob-property grob sym) val)))
 463
 464
 465 (define-public ((set-output-property grob-name symbol val)  grob grob-c context)
 466    "Usage:
 467
 468 \\applyoutput #(set-output-property 'Clef 'extra-offset '(0 . 1))
 469
 470 "
 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))))
 474
 475
 476 ;;
 477 (define-public (smart-bar-check n)
 478   "Make  a bar check that checks for a specific bar number.
 479 "
 480   (let ((m (make-music 'ApplyContext)))
 481     (define (checker tr)
 482       (let* ((bn (ly:context-property tr 'currentBarNumber)))
 483         (if (= bn n)
 484             #t
 485             (error
 486              (format "Bar check failed, we should have reached ~a, instead at ~a\n"
 487                      n bn)))))
 488     (set! (ly:music-property m 'procedure) checker)
 489     m))
 490
 491 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 492 ;; warn for bare chords at start.
 493
 494 (define (has-request-chord elts)
 495   (reduce (lambda (x y) (or x y)) #f
 496           (map (lambda (x)
 497                  (equal? (ly:music-name x) "Request_chord"))
 498                elts)))
 499
 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)
 504         (ly:warn msg))))
 505
 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")
 518            (if (pair? es)
 519                (check-start-chords (car es))))
 520           (else (if (ly:music? e) (check-start-chords e)))))
 521   music)
 522
 523
 524
 525 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 526 ;;
 527 ;; setting stuff for grace context.
 528 ;;
 529
 530 (define (vector-extend v x)
 531   "Make a new vector consisting of V, with X added to the end."
 532   (let*
 533       ((n (vector-length v))
 534        (nv (make-vector (+ n 1) '())))
 535     (vector-move-left! v 0 n nv 0)
 536     (vector-set! nv n x)
 537     nv))
 538
 539 (define (vector-map f v)
 540   "Map  F over V. This function returns nothing."
 541   (do ((n (vector-length v))
 542        (i 0 (+ i 1)))
 543       ((>= i n))
 544     (f (vector-ref v i))))
 545
 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)))
 549       ((< i 0))
 550     (f (vector-ref v i))))
 551
 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)))
 561
 562
 563 (define-public (set-start-grace-properties context)
 564   (define (execute-1 x)
 565     (let ((tr (ly:context-find context (car x))))
 566       (if (ly:context? tr)
 567           (ly:context-pushpop-property tr (cadr x) (caddr x) (cadddr x)))))
 568
 569   (let ((props (ly:context-property context 'graceSettings)))
 570     (if (vector? props)
 571         (vector-map execute-1 props))))
 572
 573 (define-public (set-stop-grace-properties context)
 574   (define (execute-1 x)
 575     (let ((tr (ly:context-find context (car x))))
 576       (if (ly:context? tr)
 577           (ly:context-pushpop-property tr (cadr x) (caddr x)))))
 578
 579   (let ((props (ly:context-property context 'graceSettings)))
 580     (if (vector? props)
 581         (vector-reverse-map execute-1 props))))
 582
 583 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 584 ;; switch it on here, so parsing and init isn't checked (too slow!)
 585 ;;
 586 ;; automatic music transformations.
 587
 588 (define (switch-on-debugging m)
 589   (if (defined? 'set-debug-cell-accesses!)
 590       (set-debug-cell-accesses! 15000))
 591   m)
 592
 593 (define-public toplevel-music-functions
 594   (list
 595    ;; check-start-chords ; ; no longer needed with chord syntax.
 596    voicify-music
 597    (lambda (x) (music-map glue-mm-rest-texts x))
 598    ;; switch-on-debugging
 599    ))
 600
 601 ;;;;;;;;;;;;;;;;;
 602 ;; lyrics
 603
 604 (define (apply-durations lyric-music durations)
 605   (define (apply-duration music)
 606     (if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
 607              (ly:duration?  (ly:music-property music 'duration)))
 608         (begin
 609           (set! (ly:music-property music 'duration) (car durations))
 610           (set! durations (cdr durations)))))
 611
 612   (music-map apply-duration lyric-music))
 613
 614
 615 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 616 ;;
 617
 618 (define-public ((add-balloon-text object-name text off) grob orig-context cur-context)
 619    "Usage: see input/regression/balloon.ly "
 620   (let* ((meta (ly:grob-property grob 'meta))
 621          (nm (if (pair? meta) (cdr (assoc 'name meta)) "nonexistant"))
 622          (cb (ly:grob-property grob 'print-function)))
 623     (if (equal? nm object-name)
 624         (begin
 625           (set! (ly:grob-property grob 'print-function) Balloon_interface::print)
 626           (set! (ly:grob-property grob 'balloon-original-callback) cb)
 627           (set! (ly:grob-property grob 'balloon-text) text)
 628           (set! (ly:grob-property grob 'balloon-text-offset) off)
 629           (set! (ly:grob-property grob 'balloon-text-props) '((font-family . roman)))))))
 630
 631 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 632 ;; accidentals
 633
 634 (define-public (set-accidentals-properties extra-natural
 635                                            auto-accs auto-cauts
 636                                            context)
 637   (context-spec-music
 638    (make-sequential-music
 639     (append (if (boolean? extra-natural)
 640                 (list (make-property-set 'extraNatural extra-natural))
 641                 '())
 642             (list (make-property-set 'autoAccidentals auto-accs)
 643                   (make-property-set 'autoCautionaries auto-cauts))))
 644    context))
 645
 646 (define-public (set-accidental-style style . rest)
 647   "Set accidental style to STYLE. Optionally takes a context argument,
 648 e.g. 'Staff or 'Voice. The context defaults to Voice, except for piano styles, which
 649 use GrandStaff as a context. "
 650   (let ((context (if (pair? rest)
 651                      (car rest) 'Staff))
 652         (pcontext (if (pair? rest)
 653                       (car rest) 'GrandStaff)))
 654     (ly:export
 655      (cond
 656       ;; accidentals as they were common in the 18th century.
 657       ((equal? style 'default)
 658        (set-accidentals-properties #t '(Staff (same-octave . 0))
 659                                    '() context))
 660       ;; accidentals from one voice do NOT get cancelled in other voices
 661       ((equal? style 'voice)
 662        (set-accidentals-properties #t '(Voice (same-octave . 0))
 663                                    '() context))
 664       ;; accidentals as suggested by Kurt Stone, Music Notation in the 20th century.
 665       ;; This includes all the default accidentals, but accidentals also needs cancelling
 666       ;; in other octaves and in the next measure.
 667       ((equal? style 'modern)
 668        (set-accidentals-properties #f '(Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
 669                                    '()  context))
 670       ;; the accidentals that Stone adds to the old standard as cautionaries
 671       ((equal? style 'modern-cautionary)
 672        (set-accidentals-properties #f '(Staff (same-octave . 0))
 673                                    '(Staff (any-octave . 0) (same-octave . 1))
 674                                    context))
 675       ;; Multivoice accidentals to be read both by musicians playing one voice
 676       ;; and musicians playing all voices.
 677       ;; Accidentals are typeset for each voice, but they ARE cancelled across voices.
 678       ((equal? style 'modern-voice)
 679        (set-accidentals-properties  #f
 680                                     '(Voice (same-octave . 0) (any-octave . 0) (same-octave . 1)
 681                                             Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
 682                                     '()
 683                                     context))
 684       ;; same as modernVoiceAccidental eccept that all special accidentals are typeset
 685       ;; as cautionaries
 686       ((equal? style 'modern-voice-cautionary)
 687        (set-accidentals-properties #f
 688                                    '(Voice (same-octave . 0) )
 689                                    '(Voice (any-octave . 0) (same-octave . 1)
 690                                            Staff (same-octave . 0) (any-octave . 0) (same-octave . 1))
 691                                    context))
 692       ;; stone's suggestions for accidentals on grand staff.
 693       ;; Accidentals are cancelled across the staves in the same grand staff as well
 694       ((equal? style 'piano)
 695        (set-accidentals-properties #f
 696                                    '( Staff (same-octave . 0) (any-octave . 0) (same-octave . 1)
 697                                             GrandStaff (any-octave . 0) (same-octave . 1))
 698                                    '()
 699                                    pcontext))
 700       ((equal? style 'piano-cautionary)
 701        (set-accidentals-properties #f
 702                                    '(Staff (same-octave . 0))
 703                                    '(Staff (any-octave . 0) (same-octave . 1)
 704                                            GrandStaff (any-octave . 0) (same-octave . 1))
 705                                    pcontext))
 706       ;; do not set localKeySignature when a note alterated differently from
 707       ;; localKeySignature is found.
 708       ;; Causes accidentals to be printed at every note instead of
 709       ;; remembered for the duration of a measure.
 710       ;; accidentals not being remembered, causing accidentals always to be typeset relative to the time signature
 711       ((equal? style 'forget)
 712        (set-accidentals-properties '()
 713                                    '(Staff (same-octave . -1))
 714                                    '() context))
 715       ;; Do not reset the key at the start of a measure.  Accidentals will be
 716       ;; printed only once and are in effect until overridden, possibly many
 717       ;; measures later.
 718       ((equal? style 'no-reset)
 719        (set-accidentals-properties '()
 720                                    '(Staff (same-octave . #t))
 721                                    '()
 722                                    context))
 723       (else
 724        (ly:warn (string-append "Unknown accidental style: " (symbol->string style)))
 725        (make-sequential-music '()))))))