X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fmusic-functions.scm;h=ff0e768c0a0e4a9f74a6e2635661b3179e19e1bc;hb=97d537aafa81497e8df9fdd5fb2808414876fb39;hp=b19cc5cf88315e3ce73e7208714809dd6493726c;hpb=322acc3c4bd05d0a9e952267d80246818514893a;p=lilypond.git diff --git a/scm/music-functions.scm b/scm/music-functions.scm index b19cc5cf88..ff0e768c0a 100644 --- a/scm/music-functions.scm +++ b/scm/music-functions.scm @@ -2,7 +2,7 @@ ;;;; ;;;; source file of the GNU LilyPond music typesetter ;;;; -;;;; (c) 1998--2004 Jan Nieuwenhuizen +;;;; (c) 1998--2006 Jan Nieuwenhuizen ;;;; Han-Wen Nienhuys ;; (use-modules (ice-9 optargs)) @@ -16,10 +16,19 @@ (make-procedure-with-setter ly:music-property ly:music-set-property!)) +(define-safe-public (music-is-of-type? mus type) + "Does @code{mus} belong to the music class @code{type}?" + (memq type (ly:music-property mus 'types))) + +;; TODO move this (define-public ly:grob-property (make-procedure-with-setter ly:grob-property ly:grob-set-property!)) +(define-public ly:prob-property + (make-procedure-with-setter ly:prob-property + ly:prob-set-property!)) + (define-public (music-map function music) "Apply @var{function} to @var{music} and all of the music it contains. @@ -81,10 +90,103 @@ First it recurses over the children, then the function is applied to MUSIC. (display " }\n") music) +;;; +;;; A scheme music pretty printer +;;; +(define (markup-expression->make-markup markup-expression) + "Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression. +For instance, + \\markup \\bold \\italic hello +==> + (markup #:line (#:bold (#:italic (#:simple \"hello\"))))" + (define (proc->command-keyword proc) + "Return a keyword, eg. `#:bold', from the `proc' function, eg. #" + (let ((cmd-markup (symbol->string (procedure-name proc)))) + (symbol->keyword (string->symbol (substring cmd-markup 0 (- (string-length cmd-markup) + (string-length "-markup"))))))) + (define (transform-arg arg) + (cond ((and (pair? arg) (markup? (car arg))) ;; a markup list + (apply append (map inner-markup->make-markup arg))) + ((and (not (string? arg)) (markup? arg)) ;; a markup + (inner-markup->make-markup arg)) + (else ;; scheme arg + arg))) + (define (inner-markup->make-markup mrkup) + (let ((cmd (proc->command-keyword (car mrkup))) + (args (map transform-arg (cdr mrkup)))) + `(,cmd ,@args))) + ;; body: + (if (string? markup-expression) + markup-expression + `(markup ,@(inner-markup->make-markup markup-expression)))) + +(define-public (music->make-music obj) + "Generate a expression that, once evaluated, may return an object equivalent to `obj', +that is, for a music expression, a (make-music ...) form." + (cond (;; markup expression + (markup? obj) + (markup-expression->make-markup obj)) + (;; music expression + (ly:music? obj) + `(make-music + ',(ly:music-property obj 'name) + ,@(apply append (map (lambda (prop) + `(',(car prop) + ,(music->make-music (cdr prop)))) + (remove (lambda (prop) + (eqv? (car prop) 'origin)) + (ly:music-mutable-properties obj)))))) + (;; moment + (ly:moment? obj) + `(ly:make-moment ,(ly:moment-main-numerator obj) + ,(ly:moment-main-denominator obj) + ,(ly:moment-grace-numerator obj) + ,(ly:moment-grace-denominator obj))) + (;; note duration + (ly:duration? obj) + `(ly:make-duration ,(ly:duration-log obj) + ,(ly:duration-dot-count obj) + ,(car (ly:duration-factor obj)) + ,(cdr (ly:duration-factor obj)))) + (;; note pitch + (ly:pitch? obj) + `(ly:make-pitch ,(ly:pitch-octave obj) + ,(ly:pitch-notename obj) + ,(ly:pitch-alteration obj))) + (;; scheme procedure + (procedure? obj) + (or (procedure-name obj) obj)) + (;; a symbol (avoid having an unquoted symbol) + (symbol? obj) + `',obj) + (;; an empty list (avoid having an unquoted empty list) + (null? obj) + `'()) + (;; a proper list + (list? obj) + `(list ,@(map music->make-music obj))) + (;; a pair + (pair? obj) + `(cons ,(music->make-music (car obj)) + ,(music->make-music (cdr obj)))) + (else + obj))) + +(use-modules (ice-9 pretty-print)) +(define*-public (display-scheme-music obj #:optional (port (current-output-port))) + "Displays `obj', typically a music expression, in a friendly fashion, +which often can be read back in order to generate an equivalent expression. + +Returns `obj'. +" + (pretty-print (music->make-music obj) port) + (newline) + obj) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define (shift-one-duration-log music shift dot) - " add SHIFT to ly:duration-log and optionally +(define-public (shift-one-duration-log music shift dot) + " add SHIFT to duration-log of 'duration in music and optionally a dot to any note encountered. This scales the music up by a factor 2^shift * (2 - (1/2)^dot)" (let ((d (ly:music-property music 'duration))) @@ -97,12 +199,40 @@ First it recurses over the children, then the function is applied to MUSIC. (set! (ly:music-property music 'duration) nd))) music)) - - (define-public (shift-duration-log music shift dot) (music-map (lambda (x) (shift-one-duration-log x shift dot)) music)) +(define-public (make-repeat name times main alts) + "create a repeat music expression, with all properties initialized properly" + (let ((talts (if (< times (length alts)) + (begin + (ly:warning (_ "More alternatives than repeats. Junking excess alternatives")) + (take alts times)) + alts)) + (r (make-repeated-music name))) + (set! (ly:music-property r 'element) main) + (set! (ly:music-property r 'repeat-count) (max times 1)) + (set! (ly:music-property r 'elements) talts) + (if (equal? name "tremolo") + (let* ((dot? (zero? (modulo times 3))) + (dots (if dot? 1 0)) + (mult (if dot? + (quotient (* times 2) 3) + times)) + (shift (- (ly:intlog2 mult)))) + + (if (memq 'sequential-music (ly:music-property main 'types)) + ;; \repeat "tremolo" { c4 d4 } + (let ((children (length (ly:music-property main 'elements)))) + (if (not (= children 2)) + (ly:warning (_ "expecting 2 elements for chord tremolo, found ~a") children)) + (ly:music-compress r (ly:make-moment 1 children)) + (shift-duration-log r (1- shift) dots)) + ;; \repeat "tremolo" c4 + (shift-duration-log r shift dots))) + r))) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; clusters. @@ -123,15 +253,20 @@ First it recurses over the children, then the function is applied to MUSIC. (define-public (unfold-repeats music) " This function replaces all repeats with unfold repeats. " - + (let ((es (ly:music-property music 'elements)) (e (ly:music-property music 'element)) - (n (ly:music-name music))) - (if (equal? n "Repeated_music") - (begin - - (if (equal? (ly:music-property music 'iterator-ctor) - Chord_tremolo_iterator::constructor) + ) + (if (memq 'repeated-music (ly:music-property music 'types)) + (let* + ((props (ly:music-mutable-properties music)) + (old-name (ly:music-property music 'name)) + (flattened (flatten-alist props))) + + (set! music (apply make-music (cons 'UnfoldedRepeatedMusic + flattened))) + + (if (equal? old-name 'TremoloRepeatedMusic) (let* ((seq-arg? (memq 'sequential-music (ly:music-property e 'types))) (count (ly:music-property music 'repeat-count)) @@ -145,14 +280,9 @@ This function replaces all repeats with unfold repeats. " (ly:intlog2 count)) dot-shift) (if seq-arg? - (ly:music-compress e (ly:make-moment (length (ly:music-property e 'elements)) 1))))) + (ly:music-compress e (ly:make-moment (length (ly:music-property + e 'elements)) 1))))))) - (set! (ly:music-property music 'length) - Repeated_music::unfolded_music_length) - (set! (ly:music-property music 'start-moment-function) - Repeated_music::first_start) - (set! (ly:music-property music 'iterator-ctor) - Unfolded_repeat_iterator::constructor))) (if (pair? es) (set! (ly:music-property music 'elements) @@ -184,14 +314,14 @@ i.e. this is not an override" (define-public (make-grob-property-revert grob gprop) "Revert the grob property GPROP for GROB." - (make-music 'OverrideProperty + (make-music 'RevertProperty 'symbol grob 'grob-property gprop)) (define direction-polyphonic-grobs - '(Stem Tie Rest Slur Script TextScript Dots DotColumn Fingering)) + '(Stem Tie Rest Slur PhrasingSlur Script TextScript Dots DotColumn Fingering)) -(define-public (make-voice-props-set n) +(define-safe-public (make-voice-props-set n) (make-sequential-music (append (map (lambda (x) (make-grob-property-set x 'direction @@ -201,7 +331,7 @@ i.e. this is not an override" (make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2)) (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4)))))) -(define-public (make-voice-props-revert) +(define-safe-public (make-voice-props-revert) (make-sequential-music (append (map (lambda (x) (make-grob-property-revert x 'direction)) @@ -210,7 +340,7 @@ i.e. this is not an override" (list (make-grob-property-revert 'MultiMeasureRest 'staff-position))))) -(define*-public (context-spec-music m context #:optional id) +(define-safe-public (context-spec-music m context #:optional id) "Add \\context CONTEXT = ID to M. " (let ((cm (make-music 'ContextSpeccedMusic 'element m @@ -241,7 +371,7 @@ i.e. this is not an override" (make-music 'SimultaneousMusic 'elements elts)) -(define-public (make-event-chord elts) +(define-safe-public (make-event-chord elts) (make-music 'EventChord 'elements elts)) @@ -257,43 +387,19 @@ i.e. this is not an override" ;; mmrest (define-public (make-multi-measure-rest duration location) - (make-music 'MultiMeasureRestMusicGroup + (make-music 'MultiMeasureRestMusic 'origin location - 'elements (list (make-music 'BarCheck - 'origin location) - (make-event-chord (list (make-music 'MultiMeasureRestEvent - 'origin location - 'duration duration))) - (make-music 'BarCheck - 'origin location)))) - -(define-public (glue-mm-rest-texts music) - "Check if we have R1*4-\\markup { .. }, and if applicable convert to -a property set for MultiMeasureRestNumber." - (define (script-to-mmrest-text script-music) - "Extract 'direction and 'text from SCRIPT-MUSIC, and transform into property sets." - (let ((dir (ly:music-property script-music 'direction)) - (p (make-music 'MultiMeasureTextEvent - 'text (ly:music-property script-music 'text)))) - (if (ly:dir? dir) - (set! (ly:music-property p 'direction) dir)) - p)) - (if (eq? (ly:music-property music 'name) 'MultiMeasureRestMusicGroup) - (let* ((text? (lambda (x) (memq 'script-event (ly:music-property x 'types)))) - (es (ly:music-property music 'elements)) - (texts (map script-to-mmrest-text (filter text? es))) - (others (remove text? es))) - (if (pair? texts) - (set! (ly:music-property music 'elements) - (cons (make-event-chord texts) others))))) - music) - + 'duration duration)) (define-public (make-property-set sym val) (make-music 'PropertySet 'symbol sym 'value val)) +(define-public (make-property-unset sym) + (make-music 'PropertyUnset + 'symbol sym)) + (define-public (make-ottava-set octavation) (let ((m (make-music 'ApplyContext))) (define (ottava-modify context) @@ -327,6 +433,23 @@ OTTAVATION to `8va', or whatever appropriate." (define-public (make-time-signature-set num den . rest) "Set properties for time signature NUM/DEN. Rest can contain a list of beat groupings " + + (define (standard-beat-grouping num den) + + "Some standard subdivisions for time signatures." + (let* + ((key (cons num den)) + (entry (assoc key '(((6 . 8) . (3 3)) + ((5 . 8) . (3 2)) + ((9 . 8) . (3 3 3)) + ((12 . 8) . (3 3 3 3)) + ((8 . 8) . (3 3 2)) + )))) + + (if entry + (cdr entry) + '()))) + (let* ((set1 (make-property-set 'timeSignatureFraction (cons num den))) (beat (ly:make-moment 1 den)) (len (ly:make-moment num den)) @@ -334,7 +457,7 @@ of beat groupings " (set3 (make-property-set 'measureLength len)) (set4 (make-property-set 'beatGrouping (if (pair? rest) (car rest) - '()))) + (standard-beat-grouping num den)))) (basic (list set1 set2 set3 set4))) (descend-to-context (context-spec-music (make-sequential-music basic) 'Timing) 'Score))) @@ -356,12 +479,7 @@ of beat groupings " (define-public (set-time-signature num den . rest) (ly:export (apply make-time-signature-set `(,num ,den . ,rest)))) -(define-public (make-penalty-music pen page-pen) - (make-music 'BreakEvent - 'penalty pen - 'page-penalty page-pen)) - -(define-public (make-articulation name) +(define-safe-public (make-articulation name) (make-music 'ArticulationEvent 'articulation-type name)) @@ -370,7 +488,7 @@ of beat groupings " 'duration duration 'text string)) -(define-public (make-span-event type spandir) +(define-safe-public (make-span-event type spandir) (make-music type 'span-direction spandir)) @@ -386,7 +504,6 @@ of beat groupings " (let ((ts (ly:music-property m 'types))) (memq 'separator ts))) - ;;; splitting chords into voices. (define (voicify-list lst number) "Make a list of Musics. @@ -415,15 +532,15 @@ of beat groupings " (define-public (voicify-music m) "Recursively split chords that are separated with \\ " (if (not (ly:music? m)) - (begin (display m) - (error "not music!"))) + (ly:error (_ "music expected: ~S") m)) (let ((es (ly:music-property m 'elements)) (e (ly:music-property m 'element))) + (if (pair? es) (set! (ly:music-property m 'elements) (map voicify-music es))) (if (ly:music? e) (set! (ly:music-property m 'element) (voicify-music e))) - (if (and (equal? (ly:music-name m) "Simultaneous_music") + (if (and (equal? (ly:music-property m 'name) 'SimultaneousMusic) (reduce (lambda (x y ) (or x y)) #f (map music-separator? es))) (set! m (context-spec-music (voicify-chord m) 'Staff))) m)) @@ -464,39 +581,51 @@ of beat groupings " (let* ((bn (ly:context-property tr 'currentBarNumber))) (if (= bn n) #t - (error - (format "Bar check failed, we should have reached ~a, instead at ~a\n" - n bn))))) + (ly:error + ;; FIXME: uncomprehensable message + (_ "Bar check failed. Expect to be at ~a, instead at ~a") + n bn)))) (set! (ly:music-property m 'procedure) checker) m)) + +(define-public (skip->rest mus) + + "Replace MUS by RestEvent of the same duration if it is a +SkipEvent. Useful for extracting parts from crowded scores" + + (if (equal? (ly:music-property mus 'name) 'SkipEvent) + (make-music 'RestEvent 'duration (ly:music-property mus 'duration)) + mus)) + + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; warn for bare chords at start. (define (has-request-chord elts) (reduce (lambda (x y) (or x y)) #f (map (lambda (x) - (equal? (ly:music-name x) "Request_chord")) + (equal? (ly:music-property x 'name) 'RequestChord)) elts))) -(define (ly:music-message music msg) +(define-public (ly:music-message music msg) (let ((ip (ly:music-property music 'origin))) (if (ly:input-location? ip) (ly:input-message ip msg) - (ly:warn msg)))) + (ly:warning msg)))) (define (check-start-chords music) "Check music expression for a Simultaneous_music containing notes\n(ie. Request_chords), without context specification. Called from parser." (let ((es (ly:music-property music 'elements)) (e (ly:music-property music 'element)) - (name (ly:music-name music))) + (name (ly:music-property music 'name))) (cond ((equal? name "Context_specced_music") #t) ((equal? name "Simultaneous_music") (if (has-request-chord es) - (ly:music-message music "Starting score with a chord.\nPlease insert an explicit \\context before chord") + (ly:music-message music "Starting score with a chord.\nInsert an explicit \\context before chord") (map check-start-chords es))) - ((equal? name "Sequential_music") + ((equal? name "SequentialMusic") (if (pair? es) (check-start-chords (car es)))) (else (if (ly:music? e) (check-start-chords e))))) @@ -544,7 +673,7 @@ without context specification. Called from parser." (defmacro-public def-grace-function (start stop) - `(def-music-function (parser location music) (ly:music?) + `(define-music-function (parser location music) (ly:music?) (make-music 'GraceMusic 'origin location 'element (make-music 'SequentialMusic @@ -552,10 +681,10 @@ without context specification. Called from parser." music (ly:music-deep-copy ,stop)))))) -(defmacro-public def-music-function (args signature . body) +(defmacro-public define-music-function (args signature . body) "Helper macro for `ly:make-music-function'. Syntax: - (def-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...) + (define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...) ...function body...) " `(ly:make-music-function (list ,@signature) @@ -574,7 +703,7 @@ Syntax: (cue-voice (if (eq? 1 dir) 0 1)) (main-music (ly:music-property quote-music 'element)) (return-value quote-music)) - + (if (or (eq? 1 dir) (eq? -1 dir)) ;; if we have stem dirs, change both quoted and main music @@ -586,9 +715,9 @@ Syntax: ;; for the quotes is determined in the iterator. (make-sequential-music (list - (context-spec-music (make-voice-props-set cue-voice) 'Voice "cue") + (context-spec-music (make-voice-props-set cue-voice) 'CueVoice "cue") quote-music - (context-spec-music (make-voice-props-revert) 'Voice "cue")))) + (context-spec-music (make-voice-props-revert) 'CueVoice "cue")))) (set! main-music (make-sequential-music (list @@ -605,12 +734,15 @@ Syntax: (quoted-vector (if (string? quoted-name) (hash-ref quote-tab quoted-name #f) #f))) + (if (string? quoted-name) - (if (vector? quoted-vector) - (set! (ly:music-property music 'quoted-events) quoted-vector) - (ly:warn "Cannot find quoted music `~S'" quoted-name))) - + (if (vector? quoted-vector) + (begin + (set! (ly:music-property music 'quoted-events) quoted-vector) + (set! (ly:music-property music 'iterator-ctor) + ly:quote-iterator::constructor)) + (ly:warning (_ "can't find quoted music `~S'" quoted-name)))) music)) @@ -643,18 +775,55 @@ Syntax: (ly:music-length music)) music) +(define (skip-to-last music parser) + + "Replace MUSIC by + +<< { \\set skipTypesetting = ##t + LENGTHOF(\\showLastLength) + \\set skipTypesetting = ##t } + MUSIC >> + +if appropriate. + " + (let* + ((show-last (ly:parser-lookup parser 'showLastLength))) + + (if (ly:music? show-last) + (let* + ((orig-length (ly:music-length music)) + (skip-length (ly:moment-sub orig-length (ly:music-length show-last)))) + + (make-simultaneous-music + (list + (make-sequential-music + (list + (context-spec-music (make-property-set 'skipTypesetting #t) 'Score) + (make-music 'SkipMusic 'duration + (ly:make-duration 0 0 + (ly:moment-main-numerator skip-length) + (ly:moment-main-denominator skip-length))) + (context-spec-music (make-property-set 'skipTypesetting #f) 'Score))) + music))) + music))) + + (define-public toplevel-music-functions (list - ;; check-start-chords ; ; no longer needed with chord syntax. (lambda (music parser) (voicify-music music)) - (lambda (x parser) (music-map glue-mm-rest-texts x)) (lambda (x parser) (music-map music-check-error x)) (lambda (x parser) (music-map precompute-music-length x)) (lambda (music parser) (music-map (quote-substitute (ly:parser-lookup parser 'musicQuotes)) music)) + ;; switch-on-debugging - (lambda (x parser) (music-map cue-substitute x)))) + (lambda (x parser) (music-map cue-substitute x)) + + (lambda (x parser) + (skip-to-last x parser) + ))) + ;;;;;;;;;;;;;;;;; ;; lyrics @@ -676,12 +845,13 @@ Syntax: (define-public ((add-balloon-text object-name text off) grob orig-context cur-context) "Usage: see input/regression/balloon.ly " (let* ((meta (ly:grob-property grob 'meta)) - (nm (if (pair? meta) (cdr (assoc 'name meta)) "nonexistant")) - (cb (ly:grob-property grob 'print-function))) - (if (equal? nm object-name) + (cb (ly:grob-property-data grob 'stencil)) + (nm (if (pair? meta) (cdr (assoc 'name meta)) "nonexistant"))) + (if (and (equal? nm object-name) + (procedure? cb)) (begin - (set! (ly:grob-property grob 'print-function) Balloon_interface::print) - (set! (ly:grob-property grob 'balloon-original-callback) cb) + (ly:grob-set-property! grob 'stencil ly:balloon-interface::print) + (set! (ly:grob-property grob 'original-stencil) cb) (set! (ly:grob-property grob 'balloon-text) text) (set! (ly:grob-property grob 'balloon-text-offset) off) (set! (ly:grob-property grob 'balloon-text-props) '((font-family . roman))))))) @@ -780,7 +950,7 @@ use GrandStaff as a context. " '() context)) (else - (ly:warn "Unknown accidental style: ~S" (symbol->string style)) + (ly:warning (_ "unknown accidental style: ~S" style)) (make-sequential-music '())))))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -802,3 +972,14 @@ use GrandStaff as a context. " (ly:make-duration 0 0) '()))) (ly:music-compress skip (ly:music-length mus)) skip)) + +(define-public (pitch-of-note event-chord) + + (let* + ((evs (filter (lambda (x) (memq 'note-event (ly:music-property x 'types))) + (ly:music-property event-chord 'elements)))) + + (if (pair? evs) + (ly:music-property (car evs) 'pitch) + #f))) +