scm/framework-ps.scm

   1 ;;;; framework-ps.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2004--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6
   7 (define-module (scm framework-ps))
   8
   9 ;;; this is still too big a mess.
  10
  11 (use-modules (ice-9 regex)
  12              (ice-9 string-fun)
  13              (ice-9 format)
  14              (guile)
  15              (srfi srfi-1)
  16              (srfi srfi-13)
  17              (lily))
  18
  19 (define framework-ps-module (current-module))
  20
  21 (define (stderr string . rest)
  22   (apply format (cons (current-error-port) (cons string rest)))
  23   (force-output (current-error-port)))
  24
  25 ;;(define pdebug stderr)
  26 (define (pdebug . rest) #f)
  27
  28 (define mm-to-bigpoint
  29   (/ 72 25.4))
  30
  31 (define-public (ps-font-command font . override-coding)
  32   (let* ((name (ly:font-file-name font))
  33          (magnify (ly:font-magnification font)))
  34
  35     (string-append
  36      "magfont" (string-encode-integer (hashq  name 1000000))
  37      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  38
  39 (define (tex-font? fontname)
  40   (or
  41    (equal? (substring fontname 0 2) "cm")
  42    (equal? (substring fontname 0 2) "ec")))
  43
  44 (define (ps-embed-pfa body font-name version)
  45   (string-append
  46    (format
  47     "%%BeginResource: font ~a
  48 ~a
  49 %%EndResource\n"
  50     font-name body)))
  51
  52
  53 (define (define-fonts paper)
  54   (define font-list (ly:paper-fonts paper))
  55   (define (define-font command fontname scaling)
  56     (string-append
  57      "/" command " { /" fontname " findfont "
  58      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
  59
  60   (define (standard-tex-font? x)
  61     (or (equal? (substring x 0 2) "ms")
  62         (equal? (substring x 0 2) "cm")))
  63
  64   (define (font-load-command font)
  65     (let* ((specced-font-name (ly:font-name font))
  66            (fontname (if specced-font-name
  67                          specced-font-name
  68                          (ly:font-file-name font)))
  69            (command (ps-font-command font))
  70
  71            ;; FIXME -- see (ps-font-command )
  72            (plain (ps-font-command font #f))
  73            (designsize (ly:font-design-size font))
  74            (magnification (* (ly:font-magnification font)))
  75            (ops (ly:output-def-lookup paper 'outputscale))
  76            (scaling (* ops magnification designsize)))
  77
  78       ;; Bluesky pfbs have UPCASE names (sigh.)
  79       ;; FIXME - don't support Bluesky?
  80       (if (standard-tex-font? fontname)
  81           (set! fontname (string-upcase fontname)))
  82       (if (equal? fontname "unknown")
  83           (display (list font fontname)))
  84       (define-font plain fontname scaling)))
  85
  86
  87   (apply string-append
  88          (map (lambda (x) (font-load-command x))
  89               (filter (lambda (x) (not (ly:pango-font? x)))
  90                       font-list))))
  91
  92 ;; FIXME: duplicated in other output backends
  93 ;; FIXME: silly interface name
  94 (define (output-variables layout)
  95   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  96   (define (value->string  val)
  97     (cond
  98      ((string? val) (string-append "(" val ")"))
  99      ((symbol? val) (symbol->string val))
 100      ((number? val) (number->string val))
 101      (else "")))
 102
 103   (define (output-entry ps-key ly-key)
 104     (string-append
 105      "/" ps-key " "
 106      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
 107
 108   (string-append
 109    "/lily-output-units "
 110      (number->string mm-to-bigpoint)
 111      " def %% millimeter\n"
 112    (output-entry "staff-line-thickness" 'linethickness)
 113    (output-entry "line-width" 'linewidth)
 114    (output-entry "paper-size" 'papersizename)
 115    (output-entry "staff-height" 'staffheight)   ;junkme.
 116    "/output-scale "
 117      (number->string (ly:output-def-lookup layout 'outputscale))
 118      " def\n"
 119    (output-entry "page-height" 'vsize)
 120    (output-entry "page-width" 'hsize)))
 121
 122 (define (dump-page outputter page page-number page-count landscape?)
 123   (ly:outputter-dump-string outputter
 124                             (string-append
 125                              "%%Page: "
 126                              (number->string page-number) " " (number->string page-count) "\n"
 127
 128                              "%%BeginPageSetup\n"
 129                              (if landscape?
 130                                  "page-width output-scale
 131  lily-output-units mul
 132  mul 0 translate 90 rotate\n"
 133                                  "")
 134                              "%%EndPageSetup\n"
 135
 136                              "start-page { "
 137                              "set-ps-scale-to-lily-scale "
 138                              "\n"))
 139   (ly:outputter-dump-stencil outputter page)
 140   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 141
 142
 143 (define (supplies-or-needs paper load-fonts?)
 144   (define (extract-names font)
 145     (if (ly:pango-font? font)
 146         (map car (ly:pango-font-physical-fonts font))
 147         (list (ly:font-name font))))
 148
 149   (let* ((fonts (ly:paper-fonts paper))
 150          (names (apply append (map extract-names fonts)))
 151          )
 152
 153     (apply string-append
 154            (map (lambda (f)
 155                   (format
 156                    (if load-fonts?
 157                     "%%DocumentSuppliedResources: font ~a\n"
 158                     "%%DocumentNeededResources: font ~a\n")
 159                    f))
 160                 (uniq-list (sort names string<?))))))
 161
 162 (define (eps-header paper bbox load-fonts?)
 163     (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 164                  "%%Creator: LilyPond\n"
 165                  "%%BoundingBox: "
 166                  (string-join (map ly:number->string bbox) " ") "\n"
 167                  "%%Orientation: "
 168                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 169                      "Landscape\n"
 170                      "Portrait\n")
 171                  (supplies-or-needs paper load-fonts?)
 172                  "%%EndComments\n"))
 173
 174 (define (page-header paper page-count load-fonts?)
 175   (string-append "%!PS-Adobe-3.0\n"
 176                  "%%Creator: LilyPond\n"
 177                  "%%Pages: " (number->string page-count) "\n"
 178                  "%%PageOrder: Ascend\n"
 179                  "%%Orientation: "
 180                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 181                      "Landscape\n"
 182                      "Portrait\n")
 183                  "%%DocumentPaperSizes: "
 184                  (ly:output-def-lookup paper 'papersizename) "\n"
 185                  (supplies-or-needs paper load-fonts?)
 186                  "%%EndComments\n"))
 187
 188 (define (procset file-name)
 189   (string-append
 190    (format
 191     "%%BeginResource: procset (~a) 1 0
 192 ~a
 193 %%EndResource
 194 "
 195     file-name (cached-file-contents file-name))))
 196
 197 (define (setup paper)
 198   (string-append
 199    "\n"
 200    "%%BeginSetup\n"
 201    (define-fonts paper)
 202    (output-variables paper)
 203    "init-lilypond-parameters\n"
 204    "%%EndSetup\n"))
 205
 206 (define (write-preamble paper load-fonts? port)
 207   (define (load-fonts paper)
 208     (let* ((fonts (ly:paper-fonts paper))
 209            (all-font-names
 210             (map
 211              (lambda (font)
 212                (cond
 213                 ((string? (ly:font-file-name font)) (list (ly:font-file-name font)))
 214                 ((ly:pango-font? font)
 215                  (map cdr  (ly:pango-font-physical-fonts font)))
 216                 (else (ly:font-sub-fonts font))))
 217
 218              fonts))
 219
 220            (font-names
 221             (uniq-list
 222              (sort (apply append all-font-names) string<?)))
 223            (pfas (map
 224                   (lambda (x)
 225                     (let* ((bare-file-name (ly:find-file x))
 226                            (cffname (string-append x ".cff.ps"))
 227                            (cff-file-name (ly:find-file cffname))
 228                            )
 229                       (cond
 230                        ((and bare-file-name (string-match "\\.pfa" bare-file-name))
 231                         (cached-file-contents bare-file-name))
 232                        ((and bare-file-name (string-match "\\.pfb" bare-file-name))
 233                         (ly:pfb->pfa bare-file-name))
 234                        ((and bare-file-name
 235                              (string-match "\\.(otf|cff)" bare-file-name))
 236
 237                         ; replace with the CFF.ps, which lives in a
 238                         ; separate subdir.
 239                         (for-each (lambda (tup)  (set! bare-file-name
 240                                                        (string-regexp-substitute (car tup) (cdr tup) bare-file-name)))
 241                                   '(("/fonts/otf/" . "/ps/")
 242                                     ("/fonts/cff/" . "/ps/")
 243                                     ("\\.(otf|cff)" . ".cff.ps")))
 244
 245                         (cached-file-contents bare-file-name))
 246                        ((and bare-file-name (string-match "\\.ttf" bare-file-name))
 247                         (ly:ttf->pfa bare-file-name))
 248                        (bare-file-name (cached-file-contents bare-file-name))
 249                        (cff-file-name  (cached-file-contents cff-file-name))
 250                        (else
 251                         (ly:warn "cannot find CFF/PFA/PFB font ~S" x)
 252                         ""))))
 253                   (filter string? font-names))))
 254            pfas))
 255
 256   (display (procset "music-drawing-routines.ps") port)
 257   (display (procset "lilyponddefs.ps") port)
 258   (if load-fonts?
 259       (for-each (lambda (f) (display f port)) (load-fonts paper)))
 260   (display (setup paper) port))
 261
 262 (define-public (output-framework basename book scopes fields)
 263   (let* ((filename (format "~a.ps" basename))
 264          (outputter  (ly:make-paper-outputter filename "ps"))
 265          (paper (ly:paper-book-paper book))
 266          (pages (ly:paper-book-pages book))
 267          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 268          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 269          (page-count (length pages))
 270          (port (ly:outputter-port outputter)))
 271
 272     (output-scopes scopes fields basename)
 273     (display (page-header paper page-count #t) port)
 274     (write-preamble paper #t  port)
 275
 276     (for-each
 277      (lambda (page)
 278        (set! page-number (1+ page-number))
 279        (dump-page outputter page page-number page-count landscape?))
 280      pages)
 281
 282     (display "%%Trailer\n%%EOF\n" port)
 283     (ly:outputter-close outputter)
 284     (postprocess-output book framework-ps-module filename
 285                          (completize-formats (ly:output-formats)))
 286 ))
 287
 288 (if (not (defined? 'nan?))
 289     (define (nan? x) #f))
 290 (if (not (defined? 'inf?))
 291     (define (inf? x) #f))
 292
 293
 294 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 295   (define (mm-to-bp-box mmbox)
 296     (let*
 297         ((scale  (ly:output-def-lookup paper 'outputscale))
 298          (box (map
 299                (lambda (x)
 300                  (inexact->exact
 301                   (round (* x scale mm-to-bigpoint)))) mmbox)))
 302
 303     (list (car box) (cadr box)
 304           (max (1+ (car box)) (caddr box))
 305           (max (1+ (cadr box)) (cadddr box)))))
 306
 307   (let*
 308       ((outputter (ly:make-paper-outputter (format "~a.eps" filename)
 309                                            "ps"))
 310
 311        (port (ly:outputter-port outputter))
 312        (xext (ly:stencil-extent dump-me X))
 313        (yext (ly:stencil-extent dump-me Y))
 314
 315        (bbox
 316         (map
 317          (lambda (x)
 318            (if (or (nan? x) (inf? x))
 319                0.0 x))
 320          (list (car xext) (car yext)
 321                (cdr xext) (cdr yext))))
 322        (rounded-bbox (mm-to-bp-box bbox))
 323        (port (ly:outputter-port outputter))
 324        (header (eps-header paper rounded-bbox load-fonts?)))
 325
 326     (display header port)
 327     (write-preamble paper load-fonts? port)
 328     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 329     (ly:outputter-dump-stencil outputter dump-me)
 330     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 331     (ly:outputter-close outputter)
 332     ))
 333
 334
 335 (define-public (output-preview-framework basename book scopes fields)
 336   (let* ((paper (ly:paper-book-paper book))
 337          (systems (ly:paper-book-systems book))
 338          (scale (ly:output-def-lookup paper 'outputscale))
 339          (titles (take-while ly:paper-system-title? systems))
 340          (non-title (find (lambda (x)
 341                             (not (ly:paper-system-title? x))) systems))
 342          (dump-me
 343           (stack-stencils Y DOWN 0.0
 344                           (map ly:paper-system-stencil
 345                                (append titles (list non-title))))))
 346     (output-scopes scopes fields basename)
 347     (dump-stencil-as-EPS paper dump-me
 348                          (format "~a.preview" basename)
 349                          #t)))
 350
 351
 352
 353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 354
 355 (define-public (convert-to-pdf book name)
 356   (let* ((defs (ly:paper-book-paper book))
 357          (papersizename (ly:output-def-lookup defs 'papersizename)))
 358
 359     (if (equal? name "-")
 360         (ly:warn "Can't convert <stdout> to PDF")
 361         (postscript->pdf (if (string? papersizename) papersizename "a4")
 362                          name))))
 363
 364 (define-public (convert-to-png book name)
 365   (let* ((defs (ly:paper-book-paper book))
 366          (resolution (ly:output-def-lookup defs 'pngresolution))
 367          (papersizename (ly:output-def-lookup defs 'papersizename)))
 368
 369     (postscript->png (if (number? resolution) resolution
 370                          (ly:get-option 'resolution))
 371                      (if (string? papersizename) papersizename "a4")
 372                      name)))
 373
 374 (define-public (convert-to-dvi book name)
 375   (ly:warn "Can not generate DVI via the postscript back-end"))
 376
 377 (define-public (convert-to-tex book name)
 378   (ly:warn "Can not generate TeX via the postscript back-end"))
 379
 380 (define-public (convert-to-ps book name)
 381   #t)