-;;;; fret-diagrams.scm --
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
+;;;; Copyright (C) 2004--2012 Carl D. Sorensen <c_sorensen@byu.edu>
;;;;
-;;;; (c) 2004--2009 Carl D. Sorensen <c_sorensen@byu.edu>
+;;;; 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/>.
-;
-; Utility functions
-;
-;
+;; Utility functions
(define (string-x-extent start-point end-point)
"Return the x-extent of a string that goes from start-point
(if (null? dot-list)
'()
(let ((this-list (car dot-list)))
- (cons* (list (car this-list) (- (second this-list) base-fret)
- (if (null? (cddr this-list))
- '()
- (third this-list)))
+ (cons* (list
+ ;; string
+ (car this-list)
+ ;; fret
+ (- (second this-list) base-fret)
+ ;; finger
+ (if (null? (cddr this-list))
+ '()
+ (third this-list))
+ ;; color modifier
+ (if (or (null? (cddr this-list))
+ (null? (cdddr this-list)))
+ '()
+ (fourth this-list)))
(subtract-base-fret base-fret (cdr dot-list))))))
(define (drop-paren item-list)
(define (merge-details key alist-list . default)
"Return @code{alist-list} entries for @code{key}, in one combined alist.
-There can be two @code{alist-list} entries for a given key. The first
+There can be two @code{alist-list} entries for a given key. The first
comes from the override-markup function, the second comes
from property settings during a regular override.
This is necessary because some details can be set in one
(define (helper key alist-list default)
(if (null? alist-list)
default
- (let* ((handle (assoc key (car alist-list))))
- (if (pair? handle)
- (append (cdr handle) (chain-assoc-get key (cdr alist-list) '()))
+ (let* ((entry (assoc-get key (car alist-list))))
+ (if entry
+ (append entry (chain-assoc-get key (cdr alist-list) '()))
(helper key (cdr alist-list) default)))))
(helper key alist-list
(if (pair? default) (car default) #f)))
-;
-; Conversions between fret/string coordinate system and x-y coordinate
-; system.
-;
-; Fret coordinates are measured down the fretboard from the nut,
-; starting at 0.
-;
-; String coordinates are measured from the lowest string, starting at 0.
-;
-; The x-y origin is at the intersection of the nut and the lowest string.
-;
-; X coordinates are positive to the right.
-; Y coordinates are positive up.
-;
+;; Conversions between fret/string coordinate system and x-y coordinate
+;; system.
+;;
+;; Fret coordinates are measured down the fretboard from the nut,
+;; starting at 0.
+;;
+;; String coordinates are measured from the lowest string, starting at 0.
+;;
+;; The x-y origin is at the intersection of the nut and the lowest string.
+;;
+;; X coordinates are positive to the right.
+;; Y coordinates are positive up.
(define (negate-extent extent)
"Return the extent in an axis opposite to the axis of @code{extent}."
(negate-extent (ly:stencil-extent stencil X)))
(else
(negate-extent (ly:stencil-extent stencil Y))))
- ; else -- eq? fretboard-axis 'string
+ ;; else -- eq? fretboard-axis 'string
(cond ((eq? orientation 'landscape)
(ly:stencil-extent stencil Y))
((eq? orientation 'opposing-landscape)
(define (string-thickness string thickness-factor)
(expt (1+ thickness-factor) (1- string)))
-;
-; Functions that create stencils used in the fret diagram
-;
+;; Functions that create stencils used in the fret diagram
(define (sans-serif-stencil layout props mag text)
"Create a stencil in sans-serif font based on @var{layout} and @var{props}
(prepend-alist-chain 'font-family 'sans props))))
(interpret-markup layout my-props text)))
-;;
-;;
;; markup commands and associated functions
-;;
-;;
-;;
(define (fret-parse-marking-list marking-list my-fret-count)
"Parse a fret-diagram-verbose marking list into component sublists"
(if (> fretval maxfret) (set! maxfret fretval))
(if (< fretval minfret) (set! minfret fretval))
(updatemax (cdr fret-list)))))
- (if (> maxfret my-fret-count)
+ (if (or (> maxfret my-fret-count) (> capo-fret 1))
(set! fret-range
(cons minfret
(let ((upfret (- (+ minfret my-fret-count) 1)))
(if (> maxfret upfret) maxfret upfret)))))
(set! capo-fret (1+ (- capo-fret minfret)))
- ; subtract fret from dots
+ ;; subtract fret from dots
(set! dot-list (subtract-base-fret (- (car fret-range) 1) dot-list)))
(acons 'fret-range fret-range
(acons 'barre-list barre-list
(define (make-fret-diagram layout props marking-list)
"Make a fret diagram markup"
(let* (
- ; note: here we get items from props that are needed in this routine,
- ; or that are needed in more than one of the procedures
- ; called from this routine. If they're only used in one of the
- ; sub-procedure, they're obtained in that procedure
+ ;; note: here we get items from props that are needed in this routine,
+ ;; or that are needed in more than one of the procedures
+ ;; called from this routine. If they're only used in one of the
+ ;; sub-procedure, they're obtained in that procedure
(size (chain-assoc-get 'size props 1.0)) ; needed for everything
- ;TODO -- get string-count directly from length of stringTunings;
- ; from FretBoard engraver, but not from markup call
+ ;;TODO -- get string-count directly from length of stringTunings;
+ ;; from FretBoard engraver, but not from markup call
(details (merge-details 'fret-diagram-details props '()))
(string-count
- (assoc-get 'string-count details 6)) ; needed for everything
+ (assoc-get 'string-count details 6)) ;; needed for everything
(my-fret-count
- (assoc-get 'fret-count details 4)) ; needed for everything
+ (assoc-get 'fret-count details 4)) ;; needed for everything
(orientation
- (assoc-get 'orientation details 'normal)) ; needed for everything
+ (assoc-get 'orientation details 'normal)) ;; needed for everything
(finger-code
(assoc-get
- 'finger-code details 'none)) ; needed for draw-dots and draw-barre
+ 'finger-code details 'none)) ;; needed for draw-dots and draw-barre
(default-dot-radius
- (if (eq? finger-code 'in-dot) 0.425 0.25)) ; bigger dots if labeled
+ (if (eq? finger-code 'in-dot) 0.425 0.25)) ;; bigger dots if labeled
(default-dot-position
(if (eq? finger-code 'in-dot)
(- 0.95 default-dot-radius)
0.6)) ; move up to make room for bigger dot if labeled
(dot-radius
(assoc-get
- 'dot-radius details default-dot-radius)) ; needed for draw-dots
- ; and draw-barre
+ 'dot-radius details default-dot-radius))
+ ;; needed for draw-dots and draw-barre
(dot-position
(assoc-get
- 'dot-position details default-dot-position)) ; needed for
- ; draw-dots and draw-barre
+ 'dot-position details default-dot-position))
+ ;; needed for draw-dots and draw-barre
(th
(* (ly:output-def-lookup layout 'line-thickness)
- (chain-assoc-get 'thickness props 0.5))) ; needed for draw-frets
- ; and draw-strings
+ (chain-assoc-get 'thickness props 0.5)))
+ ;; needed for draw-frets and draw-strings
(sth (* size th))
(thickness-factor (assoc-get 'string-thickness-factor details 0))
(alignment
- (chain-assoc-get 'align-dir props -0.4)) ; needed only here
- (xo-padding
- (* size (assoc-get 'xo-padding details 0.2))) ; needed only here
+ (chain-assoc-get 'align-dir props -0.4)) ;; needed only here
+ (xo-padding (assoc-get 'xo-padding details 0.2)) ;; needed only here
(parameters (fret-parse-marking-list marking-list my-fret-count))
(capo-fret (assoc-get 'capo-fret parameters 0))
- (dot-list (cdr (assoc 'dot-list parameters)))
- (xo-list (cdr (assoc 'xo-list parameters)))
- (fret-range (cdr (assoc 'fret-range parameters)))
+ (dot-list (assoc-get 'dot-list parameters))
+ (xo-list (assoc-get 'xo-list parameters))
+ (fret-range (assoc-get 'fret-range parameters))
(my-fret-count (fret-count fret-range))
- (barre-list (cdr (assoc 'barre-list parameters)))
+ (barre-list (assoc-get 'barre-list parameters))
(barre-type
(assoc-get 'barre-type details 'curved))
(fret-diagram-stencil '()))
- ;
+
;; Here are the fret diagram helper functions that depend on the
;; fret diagram parameters. The functions are here because the
;; diagram parameters are part of the lexical scope here.
(cons string-coordinate (- fret-coordinate)))))
(define (stencil-coordinate-offset fret-offset string-offset)
- "Return a pair @code{(x-offset . y-offstet)}
+ "Return a pair @code{(x-offset . y-offset)}
for translation in stencil coordinate system."
(cond
((eq? orientation 'landscape)
(right-lower-control-point
(stencil-coordinates
bottom-control-point-height cp-right-width)))
- ; order of bezier control points is:
- ; left cp low, right cp low, right end low, left end low
- ; right cp high, left cp high, left end high, right end high.
- ;
+
+ ;; order of bezier control points is:
+ ;; left cp low, right cp low, right end low, left end low
+ ;; right cp high, left cp high, left end high, right end high.
+
(list left-lower-control-point
right-lower-control-point
right-end-point
"Draw the string lines for a fret diagram with
@var{string-count} strings and frets as indicated in @var{fret-range}.
Line thickness is given by @var{th}, fret & string spacing by
-@var{size}. Orientation is determined by @var{orientation}. "
+@var{size}. Orientation is determined by @var{orientation}."
(define (helper x)
(if (null? (cdr x))
"Draw the fret lines for a fret diagram with
@var{string-count} strings and frets as indicated in @var{fret-range}.
Line thickness is given by @var{th}, fret & string spacing by
-@var{size}. Orientation is given by @var{orientation}."
+@var{size}. Orientation is given by @var{orientation}."
(define (helper x)
(if (null? (cdr x))
(fret-stencil (car x))
(+ (* size end-string-coordinate) half-thickness)))
(x-extent (cons (car box-lower-left) (car box-upper-right)))
(y-extent (cons (cdr box-lower-left) (cdr box-upper-right))))
- (ly:make-stencil
- (list 'bezier-sandwich
- `(quote ,bezier-list)
- (* size bezier-thick))
+ (make-bezier-sandwich-stencil
+ bezier-list
+ (* size bezier-thick)
x-extent
y-extent)))
(let* ( (scale-dot-radius (* size dot-radius))
(scale-dot-thick (* size th))
- (dot-color (assoc-get 'dot-color details 'black))
+ (default-dot-color (assoc-get 'dot-color details 'black))
(finger-label-padding 0.3)
(dot-label-font-mag
(* scale-dot-radius
(extent (cons (- scale-dot-radius) scale-dot-radius))
(finger (caddr mypair))
(finger (if (number? finger) (number->string finger) finger))
+ (inverted-color (eq? 'inverted (cadddr mypair)))
+ (dot-color (if (or (and (eq? default-dot-color 'black) inverted-color)
+ (and (eq? default-dot-color 'white) (not inverted-color)))
+ 'white
+ 'black))
(dot-stencil (if (eq? dot-color 'white)
(ly:stencil-add
(make-circle-stencil
(stencil-coordinates
end-fret-coordinate end-string-coordinate)))
(ly:round-filled-box
- (cons (car lower-left) (car upper-right))
- (cons (cdr lower-left) (cdr upper-right))
+ ;; Put limits in order, or else the intervals are considered empty
+ (ordered-cons (car lower-left) (car upper-right))
+ (ordered-cons (cdr lower-left) (cdr upper-right))
sth)))
(define (draw-xo xo-list)
"Put open and mute string indications on diagram, as contained in
@var{xo-list}."
(let* ((xo-font-mag
- (* size (assoc-get
- 'xo-font-magnification details
+ (assoc-get 'xo-font-magnification details
(cond ((or (eq? orientation 'landscape)
(eq? orientation 'opposing-landscape))
0.4)
- (else 0.4)))))
+ (else 0.4))))
(mypair (car xo-list))
(restlist (cdr xo-list))
(glyph-string (if (eq? (car mypair) 'mute)
(fancy-format #f "~@r" base-fret))
((equal? 'arabic number-type)
(fancy-format #f "~d" base-fret))
+ ((equal? 'custom number-type)
+ (fancy-format #f
+ (assoc-get 'fret-label-custom-format
+ details "~a")
+ base-fret))
(else (fancy-format #f "~(~@r~)" base-fret))))
(label-stencil
(centered-stencil
(ly:stencil-translate
label-stencil
(stencil-coordinates
- (1+ (* size label-vertical-offset))
+ (* size (+ 1.0 label-vertical-offset))
(if (eq? label-dir LEFT)
(- label-outside-diagram)
(+ (* size (1- string-count)) label-outside-diagram))))))
-
- ; Here is the body of make-fret-diagram
- ;
+ ;; Here is the body of make-fret-diagram
(set! fret-diagram-stencil
(ly:stencil-add (draw-strings) (draw-frets)))
xo-stencil 'fret orientation))
(xo-stencil-offset
(stencil-coordinate-offset
- (- diagram-fret-top
+ (- diagram-fret-top
xo-fret-offset
(* size xo-padding))
0)))
(case (car (string->list (substring test-string 0 1)))
((#\s) (let ((size (get-numeric-from-key test-string)))
(set! props (prepend-alist-chain 'size size props))))
+ ((#\t) (let ((th (get-numeric-from-key test-string)))
+ (set! props (prepend-alist-chain 'thickness th props))))
((#\f) (let* ((finger-code (get-numeric-from-key test-string))
(finger-id (case finger-code
((0) 'none)
(list 'open (string->number (car this-list)))
output-list)))))))
(parse-item (cdr myitems)))))
- ; add the modified details
+ ;; add the modified details
(set! props
(prepend-alist-chain 'fret-diagram-details details props))
`(,props . ,output-list))) ;ugh -- hard-coded spell -- procedure better
@var{props}, modified to include the string-count determined by the
definition-string, and
a fret-indication list with the appropriate values"
-;TODO -- change syntax to fret\string-finger
+;; TODO -- change syntax to fret\string-finger
(let* ((details (merge-details 'fret-diagram-details props '()))
(barre-start-list '())
`(,props . ,output-list))) ; ugh -- hard coded; proc is better
-(define-builtin-markup-command
+(define-markup-command
(fret-diagram-verbose layout props marking-list)
(pair?) ; argument type (list, but use pair? for speed)
- instrument-specific-markup ; markup type
- ((align-dir -0.4) ; properties and defaults
- (size 1.0)
- (fret-diagram-details)
- (thickness 0.5))
+ #:category instrument-specific-markup ; markup type
+ #:properties ((align-dir -0.4) ; properties and defaults
+ (size 1.0)
+ (fret-diagram-details)
+ (thickness 0.5))
"Make a fret diagram containing the symbols indicated in @var{marking-list}.
For example,
at fret location @var{fret-number}. Also, set fret @var{fret-number}
to be the lowest fret on the fret diagram.
-@item (place-fret @var{string-number} @var{fret-number} @var{finger-value})
+@item (place-fret @var{string-number} @var{fret-number} [@var{finger-value} [@var{color-modifier}]])
Place a fret playing indication on string @var{string-number} at fret
-@var{fret-number} with an optional fingering label @var{finger-value}.
+@var{fret-number} with an optional fingering label @var{finger-value},
+and an optional color modifier @var{color-modifier}.
By default, the fret playing indicator is a solid dot. This can be
-changed by setting the value of the variable @var{dot-color}. If the
-@var{finger} part of the @code{place-fret} element is present,
+globally changed by setting the value of the variable @var{dot-color}.
+Setting @var{color-modifier} to @code{inverted} inverts the dot color
+for a specific fingering.
+If the @var{finger} part of the @code{place-fret} element is present,
@var{finger-value} will be displayed according to the setting of the
variable @var{finger-code}. There is no limit to the number of fret
indications per string.
(make-fret-diagram layout props marking-list))
-(define-builtin-markup-command (fret-diagram layout props definition-string)
+(define-markup-command (fret-diagram layout props definition-string)
(string?) ; argument type
- instrument-specific-markup ; markup category
- (fret-diagram-verbose-markup) ; properties and defaults
+ #:category instrument-specific-markup ; markup category
+ #:properties (fret-diagram-verbose-markup) ; properties and defaults
"Make a (guitar) fret diagram. For example, say
@example
Default:@tie{}1.
@item
-@code{t:}@var{number} -- Set the line thickness (in staff spaces).
-Default:@tie{}0.05.
+@code{t:}@var{number} -- Set the line thickness (relative to normal
+line thickness).
+Default:@tie{}0.5.
@item
@code{h:}@var{number} -- Set the height of the diagram in frets.
(fret-diagram-verbose-markup
layout (car definition-list) (cdr definition-list))))
-(define-builtin-markup-command
+(define-markup-command
(fret-diagram-terse layout props definition-string)
(string?) ; argument type
- instrument-specific-markup ; markup category
- (fret-diagram-verbose-markup) ; properties
+ #:category instrument-specific-markup ; markup category
+ #:properties (fret-diagram-verbose-markup) ; properties
"Make a fret diagram markup using terse string-based syntax.
Here is an example
should be separated by spaces.
@item
-Fingerings are given by following the fret number with a @code{-},
+Fingerings are given by following the fret number with a @w{@code{-},}
followed by the finger indicator, e.g. @samp{3-2} for playing the third
fret with the second finger.
@item
Where a barre indicator is desired, follow the fret (or fingering) symbol
-with @code{-(} to start a barre and @code{-)} to end the barre.
+with @w{@code{-(}} to start a barre and @w{@code{-)}} to end the barre.
@end itemize"
;; TODO -- change syntax to fret\string-finger
projects / lilypond.git / blobdiff