;;;; music-functions.scm --
;;;;
;;;; source file of the GNU LilyPond music typesetter
-;;;;
+;;;;
;;;; (c) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
-;; (use-modules (ice-9 optargs))
+;; (use-modules (ice-9 optargs))
;;; ly:music-property with setter
;;; (ly:music-property my-music 'elements)
"
(let ((es (ly:music-property music 'elements))
(e (ly:music-property music 'element)))
- (set! (ly:music-property music 'elements)
+ (set! (ly:music-property music 'elements)
(map (lambda (y) (music-map function y)) es))
(if (ly:music? e)
(set! (ly:music-property music 'element)
(define-public (music-filter pred? music)
"Filter out music expressions that do not satisfy PRED."
-
+
(define (inner-music-filter pred? music)
"Recursive function."
(let* ((es (ly:music-property music 'elements))
"Display music, not done with music-map for clarity of presentation."
(display music)
- (display ": { ")
+ (display ": { ")
(let ((es (ly:music-property music 'elements))
(e (ly:music-property music 'element)))
(display (ly:music-mutable-properties music))
;;;
(define (markup-expression->make-markup markup-expression)
"Transform `markup-expression' into an equivalent, hopefuly readable, scheme expression.
-For instance,
+For instance,
\\markup \\bold \\italic hello
==>
(markup #:line (#:bold (#:italic (#:simple \"hello\"))))"
(markup-expression->make-markup obj))
(;; music expression
(ly:music? obj)
- `(make-music
+ `(make-music
',(ly:music-property obj 'name)
,@(apply append (map (lambda (prop)
`(',(car prop)
`(list ,@(map music->make-music obj)))
(;; a pair
(pair? obj)
- `(cons ,(music->make-music (car obj))
+ `(cons ,(music->make-music (car obj))
,(music->make-music (cdr obj))))
(else
obj)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(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
+ " 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)))
(if (ly:duration? d)
(define-public (make-repeat name times main alts)
"create a repeat music expression, with all properties initialized properly"
+ (define (first-note-duration music)
+ "Finds the duration of the first NoteEvent by searching depth-first
+through MUSIC."
+ (if (memq 'note-event (ly:music-property music 'types))
+ (ly:music-property music 'duration)
+ (let loop ((elts (if (ly:music? (ly:music-property music 'element))
+ (list (ly:music-property music 'element))
+ (ly:music-property music 'elements))))
+ (and (pair? elts)
+ (let ((dur (first-note-duration (car elts))))
+ (if (ly:duration? dur)
+ dur
+ (loop (cdr elts))))))))
+
(let ((talts (if (< times (length alts))
(begin
(ly:warning (_ "More alternatives than repeats. Junking excess alternatives"))
(if (equal? name "tremolo")
(let* ((dots (1- (logcount times)))
(mult (/ (* times (ash 1 dots)) (1- (ash 2 dots))))
- (shift (- (ly:intlog2 (floor mult)))))
+ (shift (- (ly:intlog2 (floor mult))))
+ (note-duration (first-note-duration r))
+ (duration-log (if (ly:duration? note-duration)
+ (ly:duration-log note-duration)
+ 1))
+ (tremolo-type (ash 1 duration-log)))
+ (set! (ly:music-property r 'tremolo-type) tremolo-type)
(if (not (integer? mult))
(ly:warning (_ "invalid tremolo repeat count: ~a") times))
(if (memq 'sequential-music (ly:music-property main 'types))
(if (= 0 -1)
(set! count (* 2 (quotient count 3))))
-
+
(shift-duration-log music (+ (if seq-arg? 1 0)
(ly:intlog2 count)) dot-shift)
-
+
(if seq-arg?
(ly:music-compress e (ly:make-moment (length (ly:music-property
e 'elements)) 1)))))))
-
-
+
+
(if (pair? es)
(set! (ly:music-property music 'elements)
(map unfold-repeats es)))
'pop-first #t))
(define-public (make-grob-property-override grob gprop val)
- "Make a Music expression that sets GPROP to VAL in GROB. Does a pop first,
-i.e. this is not an override"
+ "Make a Music expression that overrides GPROP to VAL in GROB."
(make-music 'OverrideProperty
'symbol grob
'grob-property gprop
;; TODO: take this from voicedGraceSettings or similar.
'((Voice Stem font-size -3)
(Voice NoteHead font-size -3)
+ (Voice TabNoteHead font-size -4)
(Voice Dots font-size -3)
(Voice Stem length-fraction 0.8)
(Voice Stem no-stem-extend #t)
- (Voice Beam thickness 0.384)
+ (Voice Beam beam-thickness 0.384)
(Voice Beam length-fraction 0.8)
- (Voice Accidental font-size -4)))
-
+ (Voice Accidental font-size -4)
+ (Voice AccidentalCautionary font-size -4)
+ (Voice Script font-size -3)
+ (Voice Fingering font-size -8)
+ (Voice StringNumber font-size -8)))
+
(make-grob-property-set 'NoteColumn 'horizontal-shift (quotient n 2))
- (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
+ (make-grob-property-set 'MultiMeasureRest 'staff-position (if (odd? n) -4 4))))))
(define-safe-public (make-voice-props-revert)
(make-sequential-music
(define (ottava-modify context)
"Either reset middleCPosition to the stored original, or remember
old middleCPosition, add OCTAVATION to middleCPosition, and set
-OTTAVATION to `8va', or whatever appropriate."
+OTTAVATION to `8va', or whatever appropriate."
(if (number? (ly:context-property context 'middleCOffset))
(let ((where (ly:context-property-where-defined context 'middleCOffset)))
(ly:context-unset-property where 'middleCOffset)
(define-public (set-octavation ottavation)
(ly:export (make-ottava-set ottavation)))
-(define-public (make-time-signature-set num den . rest)
- "Set properties for time signature NUM/DEN. Rest can contain a list
-of beat groupings "
+;;; Need to keep this definition for \time calls from parser
+(define-public (make-time-signature-set num den)
+ "Set properties for time signature NUM/DEN."
+ (make-beam-rule-time-signature-set num den '()))
- (define (standard-beat-grouping num den)
+;;; Used for calls that include beat-grouping setting
+(define-public (set-time-signature num den . rest)
+ "Set properties for time signature @var{num/den}.
+If @var{rest} is present, it is used to make a default
+@code{beamSetting} rule."
+ (ly:export (apply make-beam-rule-time-signature-set
+ (list num den rest))))
+
+(define-public (make-beam-rule-time-signature-set num den rest)
+ "Implement settings for new time signature. Can be
+called from either make-time-signature-set (used by \time
+in parser) or set-time-signature (called from scheme code
+included in .ly file."
+
+ (define (make-default-beaming-rule context)
+ (override-property-setting
+ context
+ 'beamSettings
+ (list (cons num den) 'end)
+ (list (cons '* (car rest)))))
- "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))
(set2 (make-property-set 'beatLength beat))
(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)))
+ (beaming-rule
+ (if (null? rest)
+ '()
+ (list (make-apply-context make-default-beaming-rule))))
+ (output (cons* set1 set2 set3 beaming-rule)))
(descend-to-context
- (context-spec-music (make-sequential-music basic) 'Timing) 'Score)))
+ (context-spec-music
+ (make-sequential-music output)
+ 'Timing)
+ 'Score)))
(define-public (make-mark-set label)
- "Make the music for the \\mark command."
+ "Make the music for the \\mark command."
(let* ((set (if (integer? label)
(context-spec-music (make-property-set 'rehearsalMark label)
'Score)
(set! (ly:music-property ev 'label) label)
ch))))
-(define-public (set-time-signature num den . rest)
- (ly:export (apply make-time-signature-set `(,num ,den . ,rest))))
-
(define-safe-public (make-articulation name)
(make-music 'ArticulationEvent
'articulation-type name))
(make-music type
'span-direction span-dir))
-(define-public (set-mus-properties! m alist)
- "Set all of ALIST as properties of M."
+(define-public (override-head-style heads style)
+ "Override style for @var{heads} to @var{style}."
+ (make-sequential-music
+ (if (pair? heads)
+ (map (lambda (h)
+ (make-grob-property-override h 'style style))
+ heads)
+ (list (make-grob-property-override heads 'style style)))))
+
+(define-public (revert-head-style heads)
+ "Revert style for @var{heads}."
+ (make-sequential-music
+ (if (pair? heads)
+ (map (lambda (h)
+ (make-grob-property-revert h 'style))
+ heads)
+ (list (make-grob-property-revert heads 'style)))))
+
+(define-public (style-note-heads heads style music)
+ "Set @var{style} for all @var{heads} in @var{music}. Works both
+inside of and outside of chord construct."
+ ;; are we inside a <...>?
+ (if (eq? (ly:music-property music 'name) 'NoteEvent)
+ ;; yes -> use a tweak
+ (begin
+ (set! (ly:music-property music 'tweaks)
+ (acons 'style style (ly:music-property music 'tweaks)))
+ music)
+ ;; not in <...>, so use overrides
+ (make-sequential-music
+ (list
+ (override-head-style heads style)
+ music
+ (revert-head-style heads)))))
+
+ (define-public (set-mus-properties! m alist)
+ "Set all of ALIST as properties of M."
(if (pair? alist)
(begin
(set! (ly:music-property m (caar alist)) (cdar alist))
(make-sequential-music
(list (make-voice-props-set number)
(make-simultaneous-music (car lst))))
- 'Voice (number->string (1+ number)))
+ 'Bottom (number->string (1+ number)))
(voicify-list (cdr lst) (1+ number)))))
(define (voicify-chord ch)
(define-public (empty-music)
(ly:export (make-music 'Music)))
-;; Make a function that checks score element for being of a specific type.
+;; Make a function that checks score element for being of a specific type.
(define-public (make-type-checker symbol)
(lambda (elt)
- ;;(display symbol)
- ;;(eq? #t (ly:grob-property elt symbol))
(not (eq? #f (memq symbol (ly:grob-property elt 'interfaces))))))
(define-public ((outputproperty-compatibility func sym val) grob g-context ao-context)
;;
(define-public (smart-bar-check n)
- "Make a bar check that checks for a specific bar number.
+ "Make a bar check that checks for a specific bar number.
"
(let ((m (make-music 'ApplyContext)))
(define (checker tr)
(define (delete-prop context)
(let* ((where (ly:context-property-where-defined context 'graceSettings))
(current (ly:context-property where 'graceSettings))
- (prop-settings (filter
+ (prop-settings (filter
(lambda(x) (sym-grob-context? x sym grob context-name))
- current))
+ current))
(new-settings current))
- (for-each (lambda(x)
+ (for-each (lambda(x)
(set! new-settings (delete x new-settings)))
prop-settings)
(ly:context-set-property! where 'graceSettings new-settings)))
-(defmacro-public def-grace-function (start stop)
+(defmacro-public def-grace-function (start stop . docstring)
+ "Helper macro for defining grace music"
`(define-music-function (parser location music) (ly:music?)
+ ,@docstring
(make-music 'GraceMusic
'origin location
'element (make-music 'SequentialMusic
(define-music-function (parser location arg1 arg2 ...) (arg1-type? arg2-type? ...)
...function body...)
"
- (if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
+(if (and (pair? body) (pair? (car body)) (eqv? '_i (caar body)))
;; When the music function definition contains a i10n doc string,
;; (_i "doc string"), keep the literal string only
(let ((docstring (cadar body))
(define-public (cue-substitute quote-music)
"Must happen after quote-substitute."
-
+
(if (vector? (ly:music-property quote-music 'quoted-events))
(let* ((dir (ly:music-property quote-music 'quoted-voice-direction))
(main-voice (if (eq? 1 dir) 1 0))
(return-value quote-music))
(if (or (eq? 1 dir) (eq? -1 dir))
-
+
;; if we have stem dirs, change both quoted and main music
;; to have opposite stems.
(begin
(hash-ref quote-tab quoted-name #f)
#f)))
-
+
(if (string? quoted-name)
(if (vector? quoted-vector)
(begin
(if (and (ly:music? m)
(eq? (ly:music-property m 'error-found) #t))
(set! found #t)))
-
+
(for-each signal (ly:music-property music 'elements))
(signal (ly:music-property music 'element))
(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)
(skip-as-needed x parser)
)))
+;;;;;;;;;;
+;;; general purpose music functions
+
+(define (shift-octave pitch octave-shift)
+ (_i "Add @var{octave-shift} to the octave of @var{pitch}.")
+ (ly:make-pitch
+ (+ (ly:pitch-octave pitch) octave-shift)
+ (ly:pitch-notename pitch)
+ (ly:pitch-alteration pitch)))
+
;;;;;;;;;;;;;;;;;
;; lyrics
-(define (apply-durations lyric-music durations)
+(define (apply-durations lyric-music durations)
(define (apply-duration music)
(if (and (not (equal? (ly:music-length music) ZERO-MOMENT))
(ly:duration? (ly:music-property music 'duration)))
(begin
(set! (ly:music-property music 'duration) (car durations))
(set! durations (cdr durations)))))
-
+
(music-map apply-duration lyric-music))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; accidentals
-(define-public ((make-accidental-rule octaveness lazyness) context pitch barnum measurepos)
+(define (recent-enough? bar-number alteration-def laziness)
+ (if (or (number? alteration-def)
+ (equal? laziness #t))
+ #t
+ (<= bar-number (+ (cadr alteration-def) laziness))))
+
+(define (is-tied? alteration-def)
+ (let* ((def (if (pair? alteration-def)
+ (car alteration-def)
+ alteration-def)))
+
+ (if (equal? def 'tied) #t #f)))
+
+(define (extract-alteration alteration-def)
+ (cond ((number? alteration-def)
+ alteration-def)
+ ((pair? alteration-def)
+ (car alteration-def))
+ (else 0)))
+
+(define (check-pitch-against-signature context pitch barnum laziness octaveness)
+ "Checks the need for an accidental and a @q{restore} accidental against
+@code{localKeySignature}. The @var{laziness} is the number of measures
+for which reminder accidentals are used (i.e., if @var{laziness} is zero,
+only cancel accidentals in the same measure; if @var{laziness} is three,
+we cancel accidentals up to three measures after they first appear.
+@var{octaveness} is either @code{'same-octave} or @code{'any-octave} and
+specifies whether accidentals should be canceled in different octaves."
+ (let* ((ignore-octave (cond ((equal? octaveness 'any-octave) #t)
+ ((equal? octaveness 'same-octave) #f)
+ (else
+ (ly:warning (_ "Unknown octaveness type: ~S ") octaveness)
+ (ly:warning (_ "Defaulting to 'any-octave."))
+ #t)))
+ (key-sig (ly:context-property context 'keySignature))
+ (local-key-sig (ly:context-property context 'localKeySignature))
+ (notename (ly:pitch-notename pitch))
+ (octave (ly:pitch-octave pitch))
+ (pitch-handle (cons octave notename))
+ (need-restore #f)
+ (need-accidental #f)
+ (previous-alteration #f)
+ (from-other-octaves #f)
+ (from-same-octave (ly:assoc-get pitch-handle local-key-sig))
+ (from-key-sig (ly:assoc-get notename local-key-sig)))
+
+ ;; If no key signature match is found from localKeySignature, we may have a custom
+ ;; type with octave-specific entries of the form ((octave . pitch) alteration)
+ ;; instead of (pitch . alteration). Since this type cannot coexist with entries in
+ ;; localKeySignature, try extracting from keySignature instead.
+ (if (equal? from-key-sig #f)
+ (set! from-key-sig (ly:assoc-get pitch-handle key-sig)))
+
+ ;; loop through localKeySignature to search for a notename match from other octaves
+ (let loop ((l local-key-sig))
+ (if (pair? l)
+ (let ((entry (car l)))
+ (if (and (pair? (car entry))
+ (= (cdar entry) notename))
+ (set! from-other-octaves (cdr entry))
+ (loop (cdr l))))))
+
+ ;; find previous alteration-def for comparison with pitch
+ (cond
+ ;; from same octave?
+ ((and (eq? ignore-octave #f)
+ (not (equal? from-same-octave #f))
+ (recent-enough? barnum from-same-octave laziness))
+ (set! previous-alteration from-same-octave))
+
+ ;; from any octave?
+ ((and (eq? ignore-octave #t)
+ (not (equal? from-other-octaves #f))
+ (recent-enough? barnum from-other-octaves laziness))
+ (set! previous-alteration from-other-octaves))
+
+ ;; not recent enough, extract from key signature/local key signature
+ ((not (equal? from-key-sig #f))
+ (set! previous-alteration from-key-sig)))
+
+ (if (is-tied? previous-alteration)
+ (set! need-accidental #t)
+
+ (let* ((prev-alt (extract-alteration previous-alteration))
+ (this-alt (ly:pitch-alteration pitch)))
+
+ (if (not (= this-alt prev-alt))
+ (begin
+ (set! need-accidental #t)
+ (if (and (not (= this-alt 0))
+ (or (< (abs this-alt) (abs prev-alt))
+ (< (* prev-alt this-alt) 0)))
+ (set! need-restore #t))))))
+
+ (cons need-restore need-accidental)))
+
+(define-public ((make-accidental-rule octaveness laziness) context pitch barnum measurepos)
"Creates an accidental rule that makes its decision based on the octave of the note
and a laziness value.
octaveness is either 'same-octave or 'any-octave and defines whether the rule should
normal way to typeset accidentals - an accidental is made if the alteration is different
from the last active pitch in the same octave. 'any-octave looks at the last active pitch
in any octave.
- lazyness states over how many bars an accidental should be remembered.
+ laziness states over how many bars an accidental should be remembered.
0 is default - accidental lasts over 0 bar lines, that is, to the end of current measure.
A positive integer means that the accidental lasts over that many bar lines.
-1 is 'forget immediately', that is, only look at key signature.
#t is forever."
- (let ((keysig (ly:context-property context 'localKeySignature)))
- (ly:find-accidentals-simple keysig pitch barnum lazyness octaveness)))
+ (check-pitch-against-signature context pitch barnum laziness octaveness))
(define (key-entry-notename entry)
"Return the pitch of an entry in localKeySignature. The entry is either of the form
pcontext))
;; same as modern, but cautionary accidentals are printed for all sharp or flat
- ;; tones specified by the key signature.
+ ;; tones specified by the key signature.
((equal? style 'teaching)
(set-accidentals-properties #f
`(Staff ,(make-accidental-rule 'same-octave 0))
`(Staff ,(make-accidental-rule 'same-octave 1)
,teaching-accidental-rule)
context))
-
+
;; do not set localKeySignature when a note alterated differently from
;; localKeySignature is found.
;; Causes accidentals to be printed at every note instead of
(define-public (mmrest-of-length mus)
"Create a mmrest of exactly the same length as MUS."
-
+
(let* ((skip
(make-multi-measure-rest
(ly:make-duration 0 0) '())))
(if (pair? evs)
(ly:music-property (car evs) 'pitch)
#f)))
-
+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(define-public (extract-named-music music music-name)
(extract-named-music elt music-name)
(if (null? elts)
'()
- (map (lambda(x)
+ (map (lambda(x)
(extract-named-music x music-name ))
elts)))))
'())))