-;;;; 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
+;;;; Copyright (C) 2000--2011 Jan Nieuwenhuizen <janneke@gnu.org>
;;;;
-;;;; (c) 2000--2009 Jan Nieuwenhuizen <janneke@gnu.org>
-
-;;; specify generic beam 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 2 2 time:
- ;; use beatLength for all except 32nd notes
- ;; end beams with 32nd notes each 1 4 beat
-
- ((end 1 32 2 2) . ,(ly:make-moment 1 4))
- ((end 1 32 2 2) . ,(ly:make-moment 2 4))
- ((end 1 32 2 2) . ,(ly:make-moment 3 4))
-
- ;; in 3 2 time:
- ;; use beatLength for all except 16th and 32nd notes
- ;; end beams with 16th notes each 1 4 beat
- ;; end beams with 32nd notes each 1 8 beat
-
- ((end 1 16 3 2) . ,(ly:make-moment 1 4))
- ((end 1 16 3 2) . ,(ly:make-moment 2 4))
- ((end 1 16 3 2) . ,(ly:make-moment 3 4))
- ((end 1 16 3 2) . ,(ly:make-moment 4 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 2 8))
- ((end 1 32 3 2) . ,(ly:make-moment 3 8))
- ((end 1 32 3 2) . ,(ly:make-moment 4 8))
- ((end 1 32 3 2) . ,(ly:make-moment 5 8))
- ((end 1 32 3 2) . ,(ly:make-moment 6 8))
- ((end 1 32 3 2) . ,(ly:make-moment 7 8))
- ((end 1 32 3 2) . ,(ly:make-moment 8 8))
- ((end 1 32 3 2) . ,(ly:make-moment 9 8))
- ((end 1 32 3 2) . ,(ly:make-moment 10 8))
- ((end 1 32 3 2) . ,(ly:make-moment 11 8))
-
- ;; in 2 4 time:
- ;; use beatLength for all except 32nd notes
- ;; end beams with 32nd notes each 1 8 beat
-
- ((end 1 32 2 4) . ,(ly:make-moment 1 8))
- ((end 1 32 2 4) . ,(ly:make-moment 2 8))
- ((end 1 32 2 4) . ,(ly:make-moment 3 8))
-
- ;; in 3 4 time:
- ;; override beatLength which would end beams at 1 4 beats
- ;; end beams with 16th notes each 1 4 beat
- ;; end beams with 32nd notes each 1 8 beat
-
- ((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 2 4))
- ((end 1 32 3 4) . ,(ly:make-moment 1 8))
- ((end 1 32 3 4) . ,(ly:make-moment 2 8))
- ((end 1 32 3 4) . ,(ly:make-moment 3 8))
- ((end 1 32 3 4) . ,(ly:make-moment 4 8))
- ((end 1 32 3 4) . ,(ly:make-moment 5 8))
-
- ;; in common time:
- ;; override beatLength which would end beams at 1 4 beats
- ;; end all beams at 1 2 beat
- ;; end beams with 8th triplets each 1 4 beat
- ;; end beams with 16th notes each 1 4 beat
- ;; end beams with 32nd notes each 1 8 beat
-
- ((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 2 8))
- ((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 6 8))
- ((end 1 32 4 4) . ,(ly:make-moment 7 8))
-
- ;; in 3 8 time:
- ;; override beatLength which would end beams at 1 8 beats
-
- ((end * * 3 8) . ,(ly:make-moment 3 8))
-
- ;; in 4 8 time
- ;; override beatLength which would end beams at 1 8 beats
- ;; end all beams at 1 4 beat
- ;; end beams with 32nd notes each 1 8 beat
-
- ((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))
-
- ;; in 6 8, 9 8 and 12 8 time:
- ;; use beatGrouping for all except 32nd notes
- ;; end beams with 32nd notes each 1 8 beat
-
- ((end 1 32 6 8) . ,(ly:make-moment 1 8))
- ((end 1 32 6 8) . ,(ly:make-moment 2 8))
- ((end 1 32 6 8) . ,(ly:make-moment 3 8))
- ((end 1 32 6 8) . ,(ly:make-moment 4 8))
- ((end 1 32 6 8) . ,(ly:make-moment 5 8))
-
- ((end 1 32 9 8) . ,(ly:make-moment 1 8))
- ((end 1 32 9 8) . ,(ly:make-moment 2 8))
- ((end 1 32 9 8) . ,(ly:make-moment 3 8))
- ((end 1 32 9 8) . ,(ly:make-moment 4 8))
- ((end 1 32 9 8) . ,(ly:make-moment 5 8))
- ((end 1 32 9 8) . ,(ly:make-moment 6 8))
- ((end 1 32 9 8) . ,(ly:make-moment 7 8))
- ((end 1 32 9 8) . ,(ly:make-moment 8 8))
-
- ((end 1 32 12 8) . ,(ly:make-moment 1 8))
- ((end 1 32 12 8) . ,(ly:make-moment 2 8))
- ((end 1 32 12 8) . ,(ly:make-moment 3 8))
- ((end 1 32 12 8) . ,(ly:make-moment 4 8))
- ((end 1 32 12 8) . ,(ly:make-moment 5 8))
- ((end 1 32 12 8) . ,(ly:make-moment 6 8))
- ((end 1 32 12 8) . ,(ly:make-moment 7 8))
- ((end 1 32 12 8) . ,(ly:make-moment 8 8))
- ((end 1 32 12 8) . ,(ly:make-moment 9 8))
- ((end 1 32 12 8) . ,(ly:make-moment 10 8))
- ((end 1 32 12 8) . ,(ly:make-moment 11 8))
-
- ;; in 4 16 time
- ;; end all beams each 1 8 beat
-
- ((end * * 4 16) . ,(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))))
+;;;; 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 on the last note
+;; of a beat. 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 time determined by
-;; beatGrouping and beatLength:
-;; if beatGrouping and beatLength are consistent with measureLength,
-;; use beatGrouping to determine end of beams.
-;; if beatGrouping and beatLength are inconsistent with measureLength,
-;; use beatLength to determine end of beams.
+;; 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)))
- (define (ending-moments group-list start-beat beat-length)
+ (define (beaming<? a b)
+ (ly:moment<? (fraction->moment (car a))
+ (fraction->moment (car b))))
+
+ (define (ending-moments group-list start-beat base-moment)
(if (null? group-list)
'()
(let ((new-start (+ start-beat (car group-list))))
- (cons (ly:moment-mul (ly:make-moment new-start 1) beat-length)
- (ending-moments (cdr group-list) new-start beat-length)))))
-
- (define (make-end-settings time ending-list moment-den)
- (if (null? ending-list)
- '()
- (cons (cons (append '(end * *) time)
- (ly:make-moment (car ending-list) moment-den))
- (make-end-settings time (cdr ending-list) moment-den))))
-
+ (cons (ly:moment-mul (ly:make-moment new-start 1) base-moment)
+ (ending-moments (cdr group-list) new-start base-moment)))))
+
+ (define (larger-setting test-beam sorted-alist)
+ (if (null? sorted-alist)
+ '()
+ (let* ((first-key (caar sorted-alist))
+ (first-moment (fraction->moment first-key)))
+ (if (moment<=? test-beam first-moment)
+ (car sorted-alist)
+ (larger-setting test-beam (cdr sorted-alist))))))
+
+ (define (beat-end? moment beat-structure)
+ (pair? (member moment beat-structure))) ;; member returns a list if found, not #t
+
+ ;; Start of actual auto-beam test routine
+ ;;
+ ;;
;; 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 4)))
+ (let* ((base-moment (get 'baseMoment (ly:make-moment 1 4)))
(measure-length (get 'measureLength (ly:make-moment 1 1)))
- (measure-pos (get 'measurePosition ZERO-MOMENT))
- (beat-grouping (get 'beatGrouping '()))
- (settings (get 'autoBeamSettings '()))
- (function (list (if (= dir START) 'begin 'end)))
- ;; Calculate implied time signature based on measureLength
- ;; and beatLength for default value in get
- (num-mom (ly:moment-div 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-signature-fraction
- (get 'timeSignatureFraction (cons num den)))
- (time (list (car time-signature-fraction)
- (cdr time-signature-fraction)))
- (type (list (ly:moment-main-numerator test)
- (ly:moment-main-denominator test)))
- (pos (if (>= (ly:moment-main-numerator measure-pos) 0)
- measure-pos
- (ly:moment-add measure-length measure-pos)))
- (grouping-moments (ending-moments beat-grouping 0 beat-length))
- ;; Calculate implied measure length from beatGrouping
- ;; and beatLength
- (grouping-length (if (null? grouping-moments)
- ZERO-MOMENT
- (list-ref grouping-moments
- (1- (length grouping-moments)))))
- (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)))
- (predefined-setting (first-assoc lst settings)))
- (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 predefined-setting)
- ;; if entry matches our function + time or type, check moment
- (if predefined-setting
- (equal? measure-pos (cdr predefined-setting))
- ;; if measure-length matches grouping-length, use
- ;; grouping moments, else use beat-length
- (if (equal? measure-length grouping-length)
- (member measure-pos grouping-moments)
- (= (ly:moment-main-denominator
- (ly:moment-div pos beat-length)) 1))))))))
+ (time-signature-fraction
+ (get 'timeSignatureFraction '(4 . 4)))
+ (beat-structure (get 'beatStructure '(1 1 1 1)))
+ (beat-endings (ending-moments beat-structure 0 base-moment))
+ (exceptions (sort (assoc-get 'end
+ (get 'beamExceptions '())
+ '())
+ beaming<?))
+ (function (if (= dir START) 'begin 'end))
+ (type (moment->fraction test-beam))
+ (non-grace (ly:make-moment
+ (ly:moment-main-numerator measure-pos)
+ (ly:moment-main-denominator measure-pos)))
+ (pos (if (ly:moment<? non-grace ZERO-MOMENT)
+ (ly:moment-add measure-length non-grace)
+ non-grace))
+ (type-grouping (assoc-get type exceptions '()))
+ (default-rule (if (null? type-grouping)
+ (larger-setting test-beam exceptions)
+ '()))
+ (default-grouping (if (pair? default-rule)
+ (cdr default-rule)
+ '()))
+ (default-beat-length (if (pair? default-rule)
+ (car default-rule)
+ '()))
+ (exception-grouping (if (null? type-grouping)
+ default-grouping
+ type-grouping))
+ (grouping-moment (if (null? type-grouping)
+ (fraction->moment default-beat-length)
+ test-beam))
+ (exception-moments (ending-moments
+ exception-grouping 0 grouping-moment)))
+
+ (if (= dir START)
+ ;; Start rules
+ (or (not (equal? time-signature-fraction '(3 . 4))) ;; start anywhere if not 3/4
+ (= (ly:moment-main-numerator pos) 0) ;; start at beginning of measure
+ (not (null? exception-grouping)) ;; don't use special rules if exception
+ (beat-end? pos beat-endings) ;; are we at start of beat?
+ (and (not (equal? test-beam base-moment)) ;; is beat split?
+ (not (beat-end? (ly:moment-add pos test-beam)
+ beat-endings)))) ;; will this note end the beat
+ ;; End rules
+ (or (= (ly:moment-main-numerator pos) 0) ;; end at measure beginning
+ (if (null? exception-grouping)
+ (beat-end? pos beat-endings) ;; no exception, so check beat ending
+ (member pos exception-moments))))))) ;; check exception rule
+
projects / lilypond.git / blobdiff