scm/parser-clef.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;
   5 ;;;; LilyPond is free software: you can redistribute it and/or modify
   6 ;;;; it under the terms of the GNU General Public License as published by
   7 ;;;; the Free Software Foundation, either version 3 of the License, or
   8 ;;;; (at your option) any later version.
   9 ;;;;
  10 ;;;; LilyPond is distributed in the hope that it will be useful,
  11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ;;;; GNU General Public License for more details.
  14 ;;;;
  15 ;;;; You should have received a copy of the GNU General Public License
  16 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  17
  18
  19 ;; (name . (glyph clef-position octavation))
  20 ;;
  21 ;; -- the name clefOctavation is misleading. The value 7 is 1 octave,
  22 ;; not 7 Octaves.
  23 (define-public supported-clefs
  24   '(("treble" . ("clefs.G" -2 0))
  25     ("violin" . ("clefs.G" -2 0))
  26     ("G" . ("clefs.G" -2 0))
  27     ("G2" . ("clefs.G" -2 0))
  28     ("french" . ("clefs.G" -4 0))
  29     ("soprano" . ("clefs.C" -4 0))
  30     ("mezzosoprano" . ("clefs.C" -2 0))
  31     ("alto" . ("clefs.C" 0 0))
  32     ("C" . ("clefs.C" 0 0))
  33     ("tenor" . ("clefs.C" 2 0))
  34     ("baritone" . ("clefs.C" 4 0))
  35     ("varbaritone" . ("clefs.F" 0 0))
  36     ("bass" . ("clefs.F" 2 0))
  37     ("F" . ("clefs.F" 2 0))
  38     ("subbass" . ("clefs.F" 4 0))
  39     ("percussion" . ("clefs.percussion" 0 0))
  40     ("tab" . ("clefs.tab" 0 0))
  41
  42     ;; should move mensural stuff to separate file?
  43     ("vaticana-do1" . ("clefs.vaticana.do" -1 0))
  44     ("vaticana-do2" . ("clefs.vaticana.do" 1 0))
  45     ("vaticana-do3" . ("clefs.vaticana.do" 3 0))
  46     ("vaticana-fa1" . ("clefs.vaticana.fa" -1 0))
  47
  48     ("vaticana-fa2" . ("clefs.vaticana.fa" 1 0))
  49     ("medicaea-do1" . ("clefs.medicaea.do" -1 0))
  50     ("medicaea-do2" . ("clefs.medicaea.do" 1 0))
  51     ("medicaea-do3" . ("clefs.medicaea.do" 3 0))
  52     ("medicaea-fa1" . ("clefs.medicaea.fa" -1 0))
  53     ("medicaea-fa2" . ("clefs.medicaea.fa" 1 0))
  54     ("hufnagel-do1" . ("clefs.hufnagel.do" -1 0))
  55     ("hufnagel-do2" . ("clefs.hufnagel.do" 1 0))
  56     ("hufnagel-do3" . ("clefs.hufnagel.do" 3 0))
  57     ("hufnagel-fa1" . ("clefs.hufnagel.fa" -1 0))
  58     ("hufnagel-fa2" . ("clefs.hufnagel.fa" 1 0))
  59     ("hufnagel-do-fa" . ("clefs.hufnagel.do.fa" 4 0))
  60     ("mensural-c1" . ("clefs.mensural.c" -4 0))
  61     ("mensural-c2" . ("clefs.mensural.c" -2 0))
  62     ("mensural-c3" . ("clefs.mensural.c" 0 0))
  63     ("mensural-c4" . ("clefs.mensural.c" 2 0))
  64     ("mensural-c5" . ("clefs.mensural.c" 4 0))
  65     ("blackmensural-c1" . ("clefs.blackmensural.c" -4 0))
  66     ("blackmensural-c2" . ("clefs.blackmensural.c" -2 0))
  67     ("blackmensural-c3" . ("clefs.blackmensural.c" 0 0))
  68     ("blackmensural-c4" . ("clefs.blackmensural.c" 2 0))
  69     ("blackmensural-c5" . ("clefs.blackmensural.c" 4 0))
  70     ("mensural-f" . ("clefs.mensural.f" 2 0))
  71     ("mensural-g" . ("clefs.mensural.g" -2 0))
  72     ("neomensural-c1" . ("clefs.neomensural.c" -4 0))
  73     ("neomensural-c2" . ("clefs.neomensural.c" -2 0))
  74     ("neomensural-c3" . ("clefs.neomensural.c" 0 0))
  75     ("neomensural-c4" . ("clefs.neomensural.c" 2 0))
  76     ("neomensural-c5" . ("clefs.neomensural.c" 4 0))
  77     ("petrucci-c1" . ("clefs.petrucci.c1" -4 0))
  78     ("petrucci-c2" . ("clefs.petrucci.c2" -2 0))
  79     ("petrucci-c3" . ("clefs.petrucci.c3" 0 0))
  80     ("petrucci-c4" . ("clefs.petrucci.c4" 2 0))
  81     ("petrucci-c5" . ("clefs.petrucci.c5" 4 0))
  82     ("petrucci-f3" . ("clefs.petrucci.f" 0 0))
  83     ("petrucci-f4" . ("clefs.petrucci.f" 2 0))
  84     ("petrucci-f5" . ("clefs.petrucci.f" 4 0))
  85     ("petrucci-f" . ("clefs.petrucci.f" 2 0))
  86     ("petrucci-g" . ("clefs.petrucci.g" -2 0))
  87     ("kievan-do" . ("clefs.kievan.do" 0 0))))
  88
  89 ;; "an alist mapping GLYPHNAME to the position of the middle C for
  90 ;; that symbol"
  91 (define c0-pitch-alist
  92   '(("clefs.G" . -4)
  93     ("clefs.C" . 0)
  94     ("clefs.F" . 4)
  95     ("clefs.percussion" . 0)
  96     ("clefs.tab" . 0 )
  97     ("clefs.vaticana.do" . 0)
  98     ("clefs.vaticana.fa" . 4)
  99     ("clefs.medicaea.do" . 0)
 100     ("clefs.medicaea.fa" . 4)
 101     ("clefs.hufnagel.do" . 0)
 102     ("clefs.hufnagel.fa" . 4)
 103     ("clefs.hufnagel.do.fa" . 0)
 104     ("clefs.mensural.c" . 0)
 105     ("clefs.mensural.f" . 4)
 106     ("clefs.mensural.g" . -4)
 107     ("clefs.blackmensural.c" . 0)
 108     ("clefs.neomensural.c" . 0)
 109     ("clefs.petrucci.c1" . 0)
 110     ("clefs.petrucci.c2" . 0)
 111     ("clefs.petrucci.c3" . 0)
 112     ("clefs.petrucci.c4" . 0)
 113     ("clefs.petrucci.c5" . 0)
 114     ("clefs.petrucci.f" . 4)
 115     ("clefs.petrucci.g" . -4)
 116     ("clefs.kievan.do" . 0)))
 117
 118 (define-public (make-clef-set clef-name)
 119   "Generate the clef setting commands for a clef with name @var{clef-name}."
 120   (define (make-prop-set props)
 121     (let ((m (make-music 'PropertySet)))
 122       (map (lambda (x) (set! (ly:music-property m (car x)) (cdr x))) props)
 123       m))
 124   (let ((e '())
 125         (c0 0)
 126         (oct 0)
 127         (match (string-match "^(.*)([_^])([1-9][0-9]*)$" clef-name)))
 128     (if match
 129         (begin
 130           (set! clef-name (match:substring match 1))
 131           (set! oct
 132                 (* (if (equal? (match:substring match 2) "^") -1 1)
 133                    (- (string->number (match:substring match 3)) 1)))))
 134     (set! e (assoc-get clef-name supported-clefs))
 135     (if e
 136         (let* ((musics (map make-prop-set
 137                             `(((symbol . clefGlyph) (value . ,(car e)))
 138                               ((symbol . middleCClefPosition)
 139                                (value . ,(+ oct
 140                                             (cadr e)
 141                                             (assoc-get (car e) c0-pitch-alist))))
 142                               ((symbol . clefPosition) (value . ,(cadr e)))
 143                               ((symbol . clefOctavation) (value . ,(- oct))))))
 144                (recalc-mid-C (make-music 'ApplyContext))
 145                (seq (make-music 'SequentialMusic
 146                                 'elements (append musics (list recalc-mid-C))))
 147                (csp (make-music 'ContextSpeccedMusic)))
 148           (set! (ly:music-property recalc-mid-C 'procedure) ly:set-middle-C!)
 149           (context-spec-music seq 'Staff))
 150         (begin
 151           (ly:warning (_ "unknown clef type `~a'") clef-name)
 152           (ly:warning (_ "supported clefs: ~a")
 153                       (string-join
 154                        (sort (map car supported-clefs) string<?)))
 155           (make-music 'Music)))))
 156
 157 (define-public (make-cue-clef-set clef-name)
 158   "Generate the clef setting commands for a cue clef with name
 159 @var{clef-name}."
 160   (define (make-prop-set props)
 161     (let ((m (make-music 'PropertySet)))
 162       (map (lambda (x) (set! (ly:music-property m (car x)) (cdr x))) props)
 163       m))
 164   (let ((e '())
 165         (c0 0)
 166         (oct 0)
 167         (match (string-match "^(.*)([_^])([1-9][0-9]*)$" clef-name)))
 168     (if match
 169         (begin
 170           (set! clef-name (match:substring match 1))
 171           (set! oct
 172                 (* (if (equal? (match:substring match 2) "^") -1 1)
 173                    (- (string->number (match:substring match 3)) 1)))))
 174     (set! e (assoc-get clef-name supported-clefs))
 175     (if e
 176         (let* ((musics (map make-prop-set
 177                             `(((symbol . cueClefGlyph) (value . ,(car e)))
 178                               ((symbol . middleCCuePosition)
 179                                (value . ,(+ oct
 180                                             (cadr e)
 181                                             (assoc-get (car e) c0-pitch-alist))))
 182                               ((symbol . cueClefPosition) (value . ,(cadr e)))
 183                               ((symbol . cueClefOctavation) (value . ,(- oct))))))
 184                (recalc-mid-C (make-music 'ApplyContext))
 185                (seq (make-music 'SequentialMusic
 186                                 'elements (append musics (list recalc-mid-C))))
 187                (csp (make-music 'ContextSpeccedMusic)))
 188           (set! (ly:music-property recalc-mid-C 'procedure) ly:set-middle-C!)
 189           (context-spec-music seq 'Staff))
 190         (begin
 191           (ly:warning (_ "unknown clef type `~a'") clef-name)
 192           (ly:warning (_ "supported clefs: ~a")
 193                       (string-join
 194                        (sort (map car supported-clefs) string<?)))
 195           (make-music 'Music)))))
 196
 197
 198 (define-public (make-cue-clef-unset)
 199   "Reset the clef settings for a cue clef."
 200   (define (make-prop-unset props)
 201     (let ((m (make-music 'PropertyUnset)))
 202       (set! (ly:music-property m (car props)) (cdr props))
 203       m))
 204   (let* ((musics (map make-prop-unset
 205                         `((symbol . cueClefGlyph)
 206                           (symbol . middleCCuePosition)
 207                           (symbol . cueClefPosition)
 208                           (symbol . cueClefOctavation))))
 209          (recalc-mid-C (make-music 'ApplyContext))
 210          (seq (make-music 'SequentialMusic
 211                           'elements (append musics (list recalc-mid-C))))
 212          (csp (make-music 'ContextSpeccedMusic)))
 213     (set! (ly:music-property recalc-mid-C 'procedure) ly:set-middle-C!)
 214     (context-spec-music seq 'Staff)))
 215
 216
 217 ;; a function to add new clefs at runtime
 218 (define-public (add-new-clef clef-name clef-glyph clef-position octavation c0-position)
 219   "Append the entries for a clef symbol to supported clefs and
 220 @code{c0-pitch-alist}."
 221   (set! supported-clefs
 222         (acons clef-name (list clef-glyph clef-position octavation) supported-clefs))
 223   (set! c0-pitch-alist
 224         (acons clef-glyph c0-position c0-pitch-alist)))