-;;;; auto-beam.scm -- Auto-beam-engraver settings
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 2000--2005 Jan Nieuwenhuizen <janneke@gnu.org>
-
-;;; specify generic beam begin and end times
-
-;;; format:
-;;;
-;;; function shortest-duration-in-beam time-signature
-;;;
-;;; where
-;;;
-;;; function = begin or end
-;;; shortest-duration-in-beam = numerator denominator; e.g.: 1 16
-;;; time-signature = numerator denominator, e.g.: 4 4
-;;;
-;;; unspecified or wildcard entries for duration or time-signature
-;;; are given by * *
-
-;;; maybe do: '(end shortest-1 16 time-3 4) ?
-
-(define-public default-auto-beam-settings
- `(
- ;; in 3 2 time:
- ;; end beams each 1 2 note
- ;; end beams with 16th notes each 1 4 note
- ;; end beams with 32th notes each 1 8 note
-
- ((end * * 3 2) . ,(ly:make-moment 1 2))
- ((end * * 3 2) . ,(ly:make-moment 2 2))
-
- ((end 1 16 3 2) . ,(ly:make-moment 1 4))
- ((end 1 16 3 2) . ,(ly:make-moment 1 2))
- ((end 1 16 3 2) . ,(ly:make-moment 3 4))
- ((end 1 16 3 2) . ,(ly:make-moment 5 4))
-
- ((end 1 32 3 2) . ,(ly:make-moment 1 8))
- ((end 1 32 3 2) . ,(ly:make-moment 1 4))
- ((end 1 32 3 2) . ,(ly:make-moment 3 8))
- ((end 1 32 3 2) . ,(ly:make-moment 1 2))
- ((end 1 32 3 2) . ,(ly:make-moment 5 8))
- ((end 1 32 3 2) . ,(ly:make-moment 3 4))
- ((end 1 32 3 2) . ,(ly:make-moment 9 8))
- ((end 1 32 3 2) . ,(ly:make-moment 5 4))
- ((end 1 32 3 2) . ,(ly:make-moment 11 8))
-
- ((end * * 3 4) . ,(ly:make-moment 3 4))
-
- ((end 1 16 3 4) . ,(ly:make-moment 1 4))
- ((end 1 16 3 4) . ,(ly:make-moment 1 2))
-
- ((end 1 32 3 4) . ,(ly:make-moment 1 8))
- ((end 1 32 3 4) . ,(ly:make-moment 1 4))
- ((end 1 32 3 4) . ,(ly:make-moment 3 8))
- ((end 1 32 3 4) . ,(ly:make-moment 1 2))
- ((end 1 32 3 4) . ,(ly:make-moment 5 8))
-
- ((end * * 3 8) . ,(ly:make-moment 3 8))
-
- ;; in common time:
- ;; end beams each 1 2 note
- ;; end beams with 32th notes each 1 8 note
- ;; end beams with 1 8 triplets each 1 4 note
-
- ((end * * 4 4) . ,(ly:make-moment 1 2))
- ((end 1 12 4 4) . ,(ly:make-moment 1 4))
- ((end 1 12 4 4) . ,(ly:make-moment 3 4))
-
- ((end 1 16 4 4) . ,(ly:make-moment 1 4))
- ((end 1 16 4 4) . ,(ly:make-moment 3 4))
-
- ((end 1 32 4 4) . ,(ly:make-moment 1 8))
- ((end 1 32 4 4) . ,(ly:make-moment 1 4))
- ((end 1 32 4 4) . ,(ly:make-moment 3 8))
- ((end 1 32 4 4) . ,(ly:make-moment 5 8))
- ((end 1 32 4 4) . ,(ly:make-moment 3 4))
- ((end 1 32 4 4) . ,(ly:make-moment 7 8))
-
- ((end * * 2 4) . #f) ;; switch-off at-any-beat feature
- ((end * * 2 4) . ,(ly:make-moment 1 4))
- ((end 1 32 2 4) . ,(ly:make-moment 1 8))
- ((end 1 32 2 4) . ,(ly:make-moment 3 8))
-
- ((end * * 4 8) . #f) ;; switch-off at-any-beat feature
- ((end * * 4 8) . ,(ly:make-moment 1 4))
- ((end 1 32 4 8) . ,(ly:make-moment 1 8))
- ((end 1 32 4 8) . ,(ly:make-moment 3 8))
-
- ((end * * 4 16) . #f) ;; switch-off at-any-beat feature
- ((end * * 4 16) . ,(ly:make-moment 1 8))
-
- ((end * * 6 8) . #f) ;; switch-off at-any-beat feature
- ((end * * 6 8) . ,(ly:make-moment 3 8))
- ((end 1 32 6 8) . ,(ly:make-moment 1 8))
- ((end 1 32 6 8) . ,(ly:make-moment 1 4))
- ((end 1 32 6 8) . ,(ly:make-moment 1 2))
- ((end 1 32 6 8) . ,(ly:make-moment 5 8))
-
- ((end * * 9 8) . #f) ;; switch-off at-any-beat feature
- ((end * * 9 8) . ,(ly:make-moment 3 8))
- ((end * * 9 8) . ,(ly:make-moment 3 4))
- ((end 1 32 9 8) . ,(ly:make-moment 1 8))
- ((end 1 32 9 8) . ,(ly:make-moment 1 4))
- ((end 1 32 9 8) . ,(ly:make-moment 1 2))
- ((end 1 32 9 8) . ,(ly:make-moment 5 8))
- ((end 1 32 9 8) . ,(ly:make-moment 7 8))
- ((end 1 32 9 8) . ,(ly:make-moment 1 1))
- ((end 1 32 9 8) . ,(ly:make-moment 9 8))
-
- ((end * * 12 8) . #f) ;; switch-off at-every-beat
- ((end * * 12 8) . ,(ly:make-moment 3 8))
- ((end * * 12 8) . ,(ly:make-moment 3 4))
- ((end * * 12 8) . ,(ly:make-moment 9 8))
- ((end * * 12 8) . ,(ly:make-moment 2 1))
- ((end 1 32 12 8) . ,(ly:make-moment 1 8))
- ))
-
-(define (override-property-setting context property setting value)
- "Like the C++ code that executes \\override, but without type
-checking. "
- (ly:context-set-property!
- context property
- (cons (cons setting value) (ly:context-property context property))))
-
-(define (revert-property-setting context property setting)
- "Like the C++ code that executes \revert, but without type
-checking. "
-
- (define (revert-member alist entry new)
- "Return ALIST, with ENTRY removed. ALIST is not modified, instead
-a fresh copy of the list-head is made."
- (cond
- ((null? alist) new)
- ((equal? (car alist) entry) (revert-member (cdr alist) entry new))
- (else (revert-member (cdr alist) entry (cons (car alist) new)))))
-
- (ly:context-set-property!
- context property
- (revert-member (ly:context-property context property) setting '())))
-
-(define-public (override-auto-beam-setting setting num den . rest)
- (ly:export
- (context-spec-music
- (make-apply-context (lambda (c)
- (override-property-setting
- c 'autoBeamSettings
- setting (ly:make-moment num den))))
- (if (and (pair? rest) (symbol? (car rest)))
- (car rest)
- 'Voice))))
-
-(define-public (score-override-auto-beam-setting setting num den)
- (override-auto-beam-setting setting num den 'Score))
-
-(define-public (revert-auto-beam-setting setting num den . rest)
- (ly:export
- (context-spec-music
- (make-apply-context (lambda (c)
- (revert-property-setting
- c 'autoBeamSettings
- (cons setting (ly:make-moment num den)))))
- (if (and (pair? rest) (symbol? (car rest)))
- (car rest)
- 'Voice))))
+;;;; Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
-;; Determine end moment for auto beaming (or begin moment, but mostly
-;; 0== anywhere). In order of decreasing priority:
+;; Determine whether an auto beam should be extended to the right
+;; of the current stem. We start anywhere, except mid-measure in
+;; 3/4 time. We end according to the follwing rules, in order of
+;; decreasing priority:
;;
-;; 1. end <type> * *
-;; 2. end * * *
-;; 3. end <type> <num> <den>
-;; 4. end * <num> <den>
-;; 5. if 1-4 not specified: begin anywhere, end at every beat
+;; 1. end <type>
+;; 2. end <greater type>
+;; 3. if 1-2 not specified, end at beatStructure intervals
;;
;; Rationale:
;;
;; [user override]
;; 1. override for specific duration type
-;; 2. generic override
+;; 2. overrides apply to shorter durations
;;
-;; [to be defined in config file]
-;; 3. exceptions for specific time signature, for specific duration type
-;; 4. exceptions for specific time signature
-;; 5. easy catch-all rule for non-specified measure types
+;; defined in scm/time-signature-settings.scm:
+;; 1. Default grouping for common time signatures
-(define-public (default-auto-beam-check context dir test)
+(define-public (default-auto-beam-check context dir measure-pos test-beam)
(define (get name default)
(let ((value (ly:context-property context name)))
(if (not (null? value)) value default)))
- ;; Don't start auto beams on grace notes
- (if (and (!= (ly:moment-grace-numerator (ly:context-now context)) 0)
- (= dir START))
- #f
- (let* ((beat-length (get 'beatLength (ly:make-moment 1 1)))
- (measure-length (get 'measureLength (ly:make-moment 1 1)))
- (measure-pos (get 'measurePosition (ly:make-moment 0 1)))
- (settings (get 'autoBeamSettings '()))
- (function (list (if (= dir START) 'begin 'end)))
- (num-mom (ly:div-moment measure-length beat-length))
- (num (inexact->exact
- (round (/ (ly:moment-main-numerator num-mom)
- (ly:moment-main-denominator num-mom)))))
- (den (ly:moment-main-denominator beat-length))
- (time (list num den))
- (type (list (ly:moment-main-numerator test)
- (ly:moment-main-denominator test)))
- (pos (if (>= (ly:moment-main-numerator measure-pos) 0)
- measure-pos
- (ly:add-moment measure-length measure-pos)))
- (lst (list
- ;; Hmm, should junk user-override feature,
- ;; or split this in user-override and config section?
- (append function type '(* *))
- (append function '(* * * *))
- (append function type time)
- (append function '(* *) time))))
+ (define (ending-moments group-list base-length)
+ (let ((beat 0))
+ (map-in-order (lambda (x)
+ (set! beat (+ beat x))
+ (* base-length beat))
+ group-list)))
- (if (or
- ;; always begin or end beams at beginning/ending of measure
- (= (ly:moment-main-numerator pos) 0)
- (first-member (map (lambda (x) (cons x pos)) lst) settings))
- #t
- (if (= dir START)
- ;; if no entry matches our function + time or type,
- ;; start anywhere
- (not (first-assoc lst settings))
- ;; if no entry matches our function + time or type,
- ;; end at any beat
- (and (not (first-assoc lst settings))
- (= (ly:moment-main-denominator
- (ly:div-moment pos beat-length)) 1)))))))
+ (define (larger-setting type sorted-alist)
+ (assoc type sorted-alist <=))
+
+ (define (beat-end? moment beat-endings)
+ (pair? (memv moment beat-endings))) ;; member returns a list if found, not #t
+
+ ;; Start of actual auto-beam test routine
+ ;;
+ ;;
+ ;; Don't start auto beams on grace notes
+ (and (or (zero? (ly:moment-grace (ly:context-now context)))
+ (!= dir START))
+ (let* ((base-length (cond ((get 'baseMoment #f) => ly:moment-main)
+ (else 1/4)))
+ (measure-length (cond ((get 'measureLength #f) => ly:moment-main)
+ (else 1)))
+ (time-signature-fraction
+ (get 'timeSignatureFraction '(4 . 4)))
+ (beat-structure (get 'beatStructure '(1 1 1 1)))
+ (beat-endings (ending-moments beat-structure base-length))
+ (exceptions (sort (map
+ (lambda (a)
+ (if (pair? (car a))
+ (cons (/ (caar a) (cdar a))
+ (cdr a))
+ a))
+ (assoc-get 'end
+ (get 'beamExceptions '())
+ '()))
+ car<))
+ (function (if (= dir START) 'begin 'end))
+ (beam-half-measure (get 'beamHalfMeasure #t))
+ (type (ly:moment-main test-beam))
+ (non-grace (ly:moment-main measure-pos))
+ (pos (if (negative? non-grace)
+ (+ measure-length non-grace)
+ non-grace))
+ (type-grouping (assoc-get type exceptions '()))
+ (default-rule (and (null? type-grouping)
+ (larger-setting type exceptions)))
+ (default-grouping (and default-rule (cdr default-rule)))
+ (default-beat-length (and default-rule (car default-rule)))
+ (exception-grouping (if (null? type-grouping)
+ default-grouping
+ type-grouping))
+ (grouping-moment (if (null? type-grouping)
+ default-beat-length
+ type))
+ (exception-moments (and exception-grouping
+ (ending-moments
+ exception-grouping grouping-moment))))
+
+ (if (= dir START)
+ ;; Start rules -- #t if beam is allowed to start
+ (or beam-half-measure ;; Start anywhere, but option for mid-measure
+ (not (= (+ pos pos) measure-length))
+ (not (= 3 (car time-signature-fraction))) ;; in triple meter
+ (not (= (denominator type) ;; when the beamed note is 1/6 of a measure
+ (* 2 (cdr time-signature-fraction)))))
+ ;; End rules -- #t if beam is required to end
+ (or (zero? pos) ;; end at measure beginning
+ (if exception-grouping
+ (beat-end? pos exception-moments) ;; check exception rule
+ (beat-end? pos beat-endings))))))) ;; no exception, so check beat ending
+
+
+(define-public (extract-beam-exceptions music)
+ "Creates a value useful for setting @code{beamExceptions} from @var{music}."
+ (define (car> a b) (> (car a) (car b)))
+ (define (beatify! lst)
+ ;; takes a collection of end points, sorts them, and returns the
+ ;; non-zero differences as beaming pattern
+ (let ((s (sort-list! lst <)))
+ (remove! zero?
+ (map - s (cons 0 s)))))
+ (let ((res '()))
+ (let analyze ((m (unfold-repeats-fully (event-chord-reduce music)))
+ (pos 0))
+ ;; enter beam ends from m starting at pos into res, return new pos
+ (cond ((music-is-of-type? m 'bar-check) 0)
+ ((music-is-of-type? m 'simultaneous-music)
+ (fold (lambda (m prev) (max (analyze m pos) prev))
+ pos
+ (ly:music-property m 'elements)))
+ ((not (music-is-of-type? m 'rhythmic-event))
+ (let ((elt (ly:music-property m 'element)))
+ (fold analyze
+ (if (ly:music? elt) (analyze elt pos) pos)
+ (ly:music-property m 'elements))))
+ ;; Have rhythmic event.
+ ((any
+ (lambda (art)
+ (and (music-is-of-type? art 'beam-event)
+ (= (ly:music-property art 'span-direction START) STOP)))
+ (ly:music-property m 'articulations))
+ (let* ((len (duration-length (ly:music-property m 'duration)))
+ (pos (+ pos len))
+ (ass (assv len res)))
+ (cond ((or (zero? len) (not (integer? (/ pos len))))
+ (ly:warning m (_ "Beam end fits no pattern")))
+ (ass
+ (set-cdr! ass (cons (/ pos len) (cdr ass))))
+ (else
+ (set! res (cons (list len (/ pos len)) res))))
+ pos))
+ (else
+ (+ pos (duration-length (ly:music-property m 'duration))))))
+
+ ;; takes the output from the loop, generates actual beam exceptions
+ (list
+ (cons 'end
+ (map!
+ (lambda (l)
+ (cons (car l)
+ (beatify! (cdr l))))
+ (sort-list! res car>))))))
projects / lilypond.git / blobdiff