ly/music-functions-init.ly

   1 % -*-Scheme-*-
   2
   3 \version "2.10.0"
   4
   5
   6 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   7 %% this file is alphabetically sorted.
   8 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   9
  10 %% need SRFI-1 filter
  11
  12 #(use-modules (srfi srfi-1))
  13
  14 acciaccatura =
  15 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic)
  16
  17 addQuote =
  18 #(define-music-function (parser location name music) (string? ly:music?)
  19    (_i "Add a piece of music to be quoted ")
  20    (add-quotable parser name music)
  21    (make-music 'SequentialMusic 'void #t))
  22
  23 afterGraceFraction =
  24 #(cons 6 8)
  25
  26 afterGrace =
  27 #(define-music-function
  28   (parser location main grace)
  29   (ly:music? ly:music?)
  30
  31   (let*
  32       ((main-length (ly:music-length main))
  33        (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
  34
  35     (make-simultaneous-music
  36      (list
  37       main
  38       (make-sequential-music
  39        (list
  40
  41         (make-music 'SkipMusic
  42                     'duration (ly:make-duration
  43                                0 0
  44                                (* (ly:moment-main-numerator main-length)
  45                                   (car fraction))
  46                                (* (ly:moment-main-denominator main-length)
  47                                   (cdr fraction)) ))
  48         (make-music 'GraceMusic
  49                     'element grace)))))))
  50
  51 applyMusic =
  52 #(define-music-function (parser location func music) (procedure? ly:music?)
  53                (func music))
  54
  55
  56 applyOutput =
  57 #(define-music-function (parser location ctx proc) (symbol? procedure?)
  58                 (make-music 'ApplyOutputEvent
  59                   'origin location
  60                   'procedure proc
  61                   'context-type ctx))
  62
  63 appoggiatura =
  64 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic)
  65
  66
  67
  68 % for regression testing purposes.
  69 assertBeamQuant =
  70 #(define-music-function (parser location l r) (pair? pair?)
  71   (make-grob-property-override 'Beam 'positions
  72    (ly:make-simple-closure
  73     (ly:make-simple-closure
  74      (append
  75       (list chain-grob-member-functions `(,cons 0 0))
  76       (check-quant-callbacks l r))))))
  77
  78 % for regression testing purposes.
  79 assertBeamSlope =
  80 #(define-music-function (parser location comp) (procedure?)
  81   (make-grob-property-override 'Beam 'positions
  82    (ly:make-simple-closure
  83     (ly:make-simple-closure
  84      (append
  85       (list chain-grob-member-functions `(,cons 0 0))
  86       (check-slope-callbacks comp))))))
  87
  88
  89
  90 autochange =
  91 #(define-music-function (parser location music) (ly:music?)
  92                (make-autochange-music parser music))
  93
  94 applyContext =
  95 #(define-music-function (parser location proc) (procedure?)
  96                  (make-music 'ApplyContext
  97                    'origin location
  98                    'procedure proc))
  99
 100
 101 balloonText =
 102 #(define-music-function (parser location offset text) (number-pair? markup?)
 103
 104     (make-music 'AnnotateOutputEvent
 105                 'X-offset (car offset)
 106                 'Y-offset (cdr offset)
 107                 'text text))
 108
 109 balloonGrobText =
 110 #(define-music-function (parser location grob-name offset text) (symbol? number-pair? markup?)
 111
 112     (make-music 'AnnotateOutputEvent
 113                 'symbol grob-name
 114                 'X-offset (car offset)
 115                 'Y-offset (cdr offset)
 116                 'text text))
 117
 118 bar =
 119 #(define-music-function (parser location type)
 120    (string?)
 121    (context-spec-music
 122     (make-property-set 'whichBar type)
 123     'Timing))
 124
 125
 126 barNumberCheck =
 127 #(define-music-function (parser location n) (integer?)
 128    (make-music 'ApplyContext
 129                'origin location
 130                'procedure
 131                (lambda (c)
 132                  (let*
 133                      ((cbn (ly:context-property c 'currentBarNumber)))
 134                    (if (and  (number? cbn) (not (= cbn n)))
 135                        (ly:input-message location "Barcheck failed got ~a expect ~a"
 136                                          cbn n))))))
 137
 138
 139 %% why a function?
 140 breathe =
 141 #(define-music-function (parser location) ()
 142             (make-music 'EventChord
 143               'origin location
 144               'elements (list (make-music 'BreathingEvent))))
 145
 146 bendAfter =
 147 #(define-music-function (parser location delta) (integer?)
 148
 149   (make-music 'BendAfterEvent
 150    'delta-step delta))
 151
 152 clef =
 153 #(define-music-function (parser location type)
 154    (string?)
 155    (_i "Set the current clef.")
 156
 157    (make-clef-set type))
 158
 159
 160 compressMusic =
 161 #(define-music-function
 162                   (parser location fraction music) (number-pair? ly:music?)
 163                   (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction))))
 164
 165
 166 cueDuring =
 167 #(define-music-function
 168   (parser location what dir main-music)
 169   (string? ly:dir? ly:music?)
 170   (make-music 'QuoteMusic
 171               'element main-music
 172               'quoted-context-type 'Voice
 173               'quoted-context-id "cue"
 174               'quoted-music-name what
 175               'quoted-voice-direction dir
 176               'origin location))
 177
 178 displayLilyMusic =
 179 #(define-music-function (parser location music) (ly:music?)
 180    (newline)
 181    (display-lily-music music parser)
 182    music)
 183
 184 displayMusic =
 185 #(define-music-function (parser location music) (ly:music?)
 186    (newline)
 187    (display-scheme-music music)
 188    music)
 189
 190
 191 endSpanners =
 192 #(define-music-function (parser location music) (ly:music?)
 193    (if (eq? (ly:music-property music 'name) 'EventChord)
 194        (let*
 195            ((elts (ly:music-property music 'elements))
 196             (start-span-evs (filter (lambda (ev)
 197                                 (and (music-has-type ev 'span-event)
 198                                      (equal? (ly:music-property ev 'span-direction)
 199                                              START)))
 200                               elts))
 201             (stop-span-evs
 202              (map (lambda (m)
 203                     (let* ((c (music-clone m)))
 204                       (set! (ly:music-property c 'span-direction) STOP)
 205                       c))
 206                   start-span-evs))
 207             (end-ev-chord (make-music 'EventChord
 208                                       'elements stop-span-evs))
 209             (total (make-music 'SequentialMusic
 210                                'elements (list music
 211                                                end-ev-chord))))
 212          total)
 213
 214        (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a" music))))
 215
 216 featherDurations=
 217 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
 218    (_i "Rearrange durations in ARGUMENT so there is an
 219 acceleration/deceleration. ")
 220
 221    (let*
 222        ((orig-duration (ly:music-length argument))
 223         (multiplier (ly:make-moment 1 1)))
 224
 225      (music-map
 226       (lambda (mus)
 227         (if (and (eq? (ly:music-property mus 'name) 'EventChord)
 228                  (< 0 (ly:moment-main-denominator (ly:music-length mus))))
 229             (begin
 230               (ly:music-compress mus multiplier)
 231               (set! multiplier (ly:moment-mul factor multiplier)))
 232             )
 233         mus)
 234       argument)
 235
 236      (ly:music-compress
 237       argument
 238       (ly:moment-div orig-duration (ly:music-length argument)))
 239
 240      argument))
 241
 242 grace =
 243 #(def-grace-function startGraceMusic stopGraceMusic)
 244
 245
 246 "instrument-definitions" = #'()
 247
 248 addInstrumentDefinition =
 249 #(define-music-function
 250    (parser location name lst) (string? list?)
 251
 252    (set! instrument-definitions (acons name lst instrument-definitions))
 253
 254    (make-music 'SequentialMusic 'void #t))
 255
 256
 257 instrumentSwitch =
 258 #(define-music-function
 259    (parser location name) (string?)
 260    (let*
 261        ((handle  (assoc name instrument-definitions))
 262         (instrument-def (if handle (cdr handle) '()))
 263         )
 264
 265      (if (not handle)
 266          (ly:input-message "No such instrument: ~a" name))
 267      (context-spec-music
 268       (make-music 'SimultaneousMusic
 269                   'elements
 270                   (map (lambda (kv)
 271                          (make-property-set
 272                           (car kv)
 273                           (cdr kv)))
 274                        instrument-def))
 275       'Staff)))
 276
 277
 278 keepWithTag =
 279 #(define-music-function
 280   (parser location tag music) (symbol? ly:music?)
 281   (music-filter
 282    (lambda (m)
 283     (let* ((tags (ly:music-property m 'tags))
 284            (res (memq tag tags)))
 285      (or
 286       (eq? tags '())
 287       res)))
 288    music))
 289
 290
 291
 292 killCues =
 293 #(define-music-function
 294    (parser location music)
 295    (ly:music?)
 296    (music-map
 297     (lambda (mus)
 298       (if (string? (ly:music-property mus 'quoted-music-name))
 299           (ly:music-property mus 'element)
 300           mus)) music))
 301
 302
 303 makeClusters =
 304 #(define-music-function
 305                 (parser location arg) (ly:music?)
 306                 (music-map note-to-cluster arg))
 307
 308 musicMap =
 309 #(define-music-function (parser location proc mus) (procedure? ly:music?)
 310              (music-map proc mus))
 311
 312
 313
 314 oldaddlyrics =
 315 #(define-music-function (parser location music lyrics) (ly:music? ly:music?)
 316
 317               (make-music 'OldLyricCombineMusic
 318                           'origin location
 319                           'elements (list music lyrics)))
 320
 321
 322 overrideProperty =
 323 #(define-music-function (parser location name property value)
 324    (string? symbol? scheme?)
 325
 326
 327    (_i "Set @var{property} to @var{value} in all grobs named @var{name}.
 328 The @var{name} argument is a string of the form @code{\"Context.GrobName\"}
 329 or @code{\"GrobName\"}")
 330
 331    (let*
 332        ((name-components (string-split name #\.))
 333         (context-name 'Bottom)
 334         (grob-name #f))
 335
 336      (if (> 2 (length name-components))
 337          (set! grob-name (string->symbol (car name-components)))
 338          (begin
 339            (set! grob-name (string->symbol (list-ref name-components 1)))
 340            (set! context-name (string->symbol (list-ref name-components 0)))))
 341
 342      (make-music 'ApplyOutputEvent
 343                  'origin location
 344                  'context-type context-name
 345                  'procedure
 346                  (lambda (grob orig-context context)
 347                    (if (equal?
 348                         (cdr (assoc 'name (ly:grob-property grob 'meta)))
 349                         grob-name)
 350                        (set! (ly:grob-property grob property) value))))))
 351
 352
 353 removeWithTag =
 354 #(define-music-function
 355   (parser location tag music) (symbol? ly:music?)
 356   (music-filter
 357    (lambda (m)
 358     (let* ((tags (ly:music-property m 'tags))
 359            (res (memq tag tags)))
 360      (not res)))
 361  music))
 362
 363 %% Todo:
 364 %% doing
 365 %% define-music-function in a .scm causes crash.
 366
 367 octave =
 368 #(define-music-function (parser location pitch-note) (ly:music?)
 369    (_i "octave check")
 370
 371    (make-music 'RelativeOctaveCheck
 372                'origin location
 373                'pitch (pitch-of-note pitch-note)
 374                ))
 375 partcombine =
 376 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
 377                 (make-part-combine-music parser
 378                                          (list part1 part2)))
 379
 380
 381 pitchedTrill =
 382 #(define-music-function
 383    (parser location main-note secondary-note)
 384    (ly:music? ly:music?)
 385    (let*
 386        ((get-notes (lambda (ev-chord)
 387                      (filter
 388                       (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
 389                       (ly:music-property ev-chord 'elements))))
 390         (sec-note-events (get-notes secondary-note))
 391         (trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
 392                               (ly:music-property main-note 'elements)))
 393
 394         (trill-pitch
 395          (if (pair? sec-note-events)
 396              (ly:music-property (car sec-note-events) 'pitch)
 397              )))
 398
 399      (if (ly:pitch? trill-pitch)
 400          (for-each (lambda (m) (ly:music-set-property! m 'pitch trill-pitch))
 401                    trill-events)
 402          (begin
 403            (ly:warning (_ "Second argument of \\pitchedTrill should be single note: "))
 404            (display sec-note-events)))
 405
 406      main-note))
 407
 408 parenthesize =
 409 #(define-music-function (parser loc arg) (ly:music?)
 410    (_i "Tag @var{arg} to be parenthesized.")
 411
 412    (set! (ly:music-property arg 'parenthesize) #t)
 413    arg)
 414
 415 %% for lambda*
 416 #(use-modules (ice-9 optargs))
 417
 418 parallelMusic =
 419 #(define-music-function (parser location voice-ids music) (list? ly:music?)
 420   (_i "Define parallel music sequences, separated by '|' (bar check signs),
 421 and assign them to the identifiers provided in @var{voice-ids}.
 422
 423 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
 424
 425 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 426
 427 Example:
 428
 429 @verbatim
 430   \\parallelMusic #'(A B C) {
 431     c c | d d | e e |
 432     d d | e e | f f |
 433   }
 434 <==>
 435   A = { c c | d d | }
 436   B = { d d | e e | }
 437   C = { e e | f f | }
 438 @end verbatim
 439 ")
 440   (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
 441          (current-voices voices)
 442          (current-sequence (list)))
 443     ;;
 444     ;; utilities
 445     (define (push-music m)
 446       "Push the music expression into the current sequence"
 447       (set! current-sequence (cons m current-sequence)))
 448     (define (change-voice)
 449       "Stores the previously built sequence into the current voice and
 450        change to the following voice."
 451       (list-set! current-voices 0 (cons (make-music 'SequentialMusic
 452                                          'elements (reverse! current-sequence))
 453                                         (car current-voices)))
 454       (set! current-sequence (list))
 455       (set! current-voices (cdr current-voices)))
 456     (define (bar-check? m)
 457       "Checks whether m is a bar check."
 458       (eq? (ly:music-property m 'name) 'BarCheck))
 459     (define (music-origin music)
 460       "Recursively search an origin location stored in music."
 461       (cond ((null? music) #f)
 462             ((not (null? (ly:music-property music 'origin)))
 463              (ly:music-property music 'origin))
 464             (else (or (music-origin (ly:music-property music 'element))
 465                       (let ((origins (remove not (map music-origin
 466                                                       (ly:music-property music 'elements)))))
 467                         (and (not (null? origins)) (car origins)))))))
 468     ;;
 469     ;; first, split the music and fill in voices
 470     (map-in-order (lambda (m)
 471                     (push-music m)
 472                     (if (bar-check? m) (change-voice)))
 473                   (ly:music-property music 'elements))
 474     (if (not (null? current-sequence)) (change-voice))
 475     ;; un-circularize `voices' and reorder the voices
 476     (set! voices (map-in-order (lambda (dummy seqs)
 477                                  (reverse! seqs))
 478                                voice-ids voices))
 479     ;;
 480     ;; set origin location of each sequence in each voice
 481     ;; for better type error tracking
 482     (for-each (lambda (voice)
 483                 (for-each (lambda (seq)
 484                             (set! (ly:music-property seq 'origin)
 485                                   (or (music-origin seq) location)))
 486                           voice))
 487               voices)
 488     ;;
 489     ;; check sequence length
 490     (apply for-each (lambda* (#:rest seqs)
 491                       (let ((moment-reference (ly:music-length (car seqs))))
 492                         (for-each (lambda (seq moment)
 493                                     (if (not (equal? moment moment-reference))
 494                                         (ly:music-message seq
 495                                          "Bars in parallel music don't have the same length")))
 496                           seqs (map-in-order ly:music-length seqs))))
 497            voices)
 498    ;;
 499    ;; bind voice identifiers to the voices
 500    (map (lambda (voice-id voice)
 501           (ly:parser-define! parser voice-id
 502                              (make-music 'SequentialMusic
 503                                'origin location
 504                                'elements voice)))
 505         voice-ids voices))
 506  ;; Return an empty sequence. this function is actually a "void" function.
 507  (make-music 'SequentialMusic 'void #t))
 508
 509
 510
 511 quoteDuring = #
 512 (define-music-function
 513   (parser location what main-music)
 514   (string? ly:music?)
 515   (make-music 'QuoteMusic
 516               'element main-music
 517               'quoted-music-name what
 518               'origin location))
 519
 520
 521
 522 resetRelativeOctave  =
 523 #(define-music-function
 524     (parser location reference-note)
 525     (ly:music?)
 526     (_i "Set the octave inside a \\relative section.")
 527
 528    (let*
 529     ((notes (ly:music-property reference-note 'elements))
 530      (pitch (ly:music-property (car notes) 'pitch)))
 531
 532     (set! (ly:music-property reference-note 'elements) '())
 533     (set! (ly:music-property reference-note
 534        'to-relative-callback)
 535        (lambda (music last-pitch)
 536         pitch))
 537
 538     reference-note))
 539
 540
 541
 542 shiftDurations =
 543 #(define-music-function (parser location dur dots arg) (integer? integer? ly:music?)
 544    (_i "")
 545
 546    (music-map
 547     (lambda (x)
 548       (shift-one-duration-log x dur dots)) arg))
 549
 550 spacingTweaks =
 551 #(define-music-function (parser location parameters) (list?)
 552    (_i "Set the system stretch, by reading the 'system-stretch property of
 553 the `parameters' assoc list.")
 554    #{
 555       \overrideProperty #"Score.NonMusicalPaperColumn"
 556         #'line-break-system-details
 557         #$(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
 558                 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
 559    #})
 560
 561 %% Parser used to read page-layout file, and then retreive score tweaks.
 562 #(define page-layout-parser #f)
 563
 564 includePageLayoutFile =
 565 #(define-music-function (parser location) ()
 566    (_i "If page breaks and tweak dump is not asked, and the file
 567 <basename>-page-layout.ly exists, include it.")
 568    (if (not (ly:get-option 'dump-tweaks))
 569        (let ((tweak-filename (format #f "~a-page-layout.ly"
 570                                      (ly:parser-output-name parser))))
 571          (if (access? tweak-filename R_OK)
 572              (begin
 573                (ly:message "Including tweak file ~a" tweak-filename)
 574                (set! page-layout-parser (ly:parser-clone parser))
 575                (ly:parser-parse-string page-layout-parser
 576                                        (format #f "\\include \"~a\""
 577                                                tweak-filename))))))
 578    (make-music 'SequentialMusic 'void #t))
 579
 580
 581 rightHandFinger =
 582 #(define-music-function (parser location finger) (number-or-string?)
 583    (_i "Define a StrokeFingerEvent")
 584
 585    (apply make-music
 586           (append
 587            (list
 588             'StrokeFingerEvent
 589             'origin location)
 590            (if  (string? finger)
 591                 (list 'text finger)
 592                 (list 'digit finger)))))
 593
 594 scoreTweak =
 595 #(define-music-function (parser location name) (string?)
 596    (_i "Include the score tweak, if exists.")
 597    (if (and page-layout-parser (not (ly:get-option 'dump-tweaks)))
 598        (let ((tweak-music (ly:parser-lookup page-layout-parser
 599                                             (string->symbol name))))
 600          (if (ly:music? tweak-music)
 601              tweak-music
 602              (make-music 'SequentialMusic)))
 603        (make-music 'SequentialMusic)))
 604
 605 transposedCueDuring =
 606 #(define-music-function
 607   (parser location what dir pitch-note main-music)
 608   (string? ly:dir? ly:music? ly:music?)
 609
 610   (_i "Insert notes from the part @var{what} into a voice called @code{cue},
 611 using the transposition defined by @var{pitch-note}.  This happens
 612 simultaneously with @var{main-music}, which is usually a rest.  The
 613 argument @var{dir} determines whether the cue notes should be notated
 614 as a first or second voice.")
 615
 616   (make-music 'QuoteMusic
 617               'element main-music
 618               'quoted-context-type 'Voice
 619               'quoted-context-id "cue"
 620               'quoted-music-name what
 621               'quoted-voice-direction dir
 622               'quoted-transposition (pitch-of-note pitch-note)
 623               'origin location))
 624
 625
 626
 627 transposition =
 628 #(define-music-function (parser location pitch-note) (ly:music?)
 629    (_i "Set instrument transposition")
 630
 631    (context-spec-music
 632     (make-property-set 'instrumentTransposition
 633                        (ly:pitch-negate (pitch-of-note pitch-note)))
 634         'Staff))
 635
 636 tweak = #(define-music-function (parser location sym val arg)
 637            (symbol? scheme? ly:music?)
 638
 639            (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.")
 640
 641            (set!
 642             (ly:music-property arg 'tweaks)
 643             (acons sym val
 644                    (ly:music-property arg 'tweaks)))
 645            arg)
 646
 647 tag = #(define-music-function (parser location tag arg)
 648    (symbol? ly:music?)
 649
 650    (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
 651
 652    (set!
 653     (ly:music-property arg 'tags)
 654     (cons tag
 655           (ly:music-property arg 'tags)))
 656    arg)
 657
 658
 659 unfoldRepeats =
 660 #(define-music-function (parser location music) (ly:music?)
 661                   (unfold-repeats music))
 662
 663
 664
 665 withMusicProperty =
 666 #(define-music-function (parser location sym val music) (symbol? scheme? ly:music?)
 667    (_i "Set @var{sym} to @var{val} in @var{music}.")
 668
 669    (set! (ly:music-property music sym) val)
 670    music)
 671
 672