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 pdebug stderr)
  22 (define (pdebug . rest) #f)
  23
  24 (define mm-to-bigpoint
  25   (/ 72 25.4))
  26
  27 (define-public (ps-font-command font)
  28   (let* ((name (munge-lily-font-name (ly:font-file-name font)))
  29          (magnify (ly:font-magnification font)))
  30
  31     (string-append
  32      "magfont"
  33      (string-regexp-substitute "[ /%]" "_" name)
  34      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  35
  36 (define (tex-font? fontname)
  37   (or
  38    (equal? (substring fontname 0 2) "cm")
  39    (equal? (substring fontname 0 2) "ec")))
  40
  41 (define (define-fonts paper)
  42   (define font-list (ly:paper-fonts paper))
  43   (define (define-font command fontname scaling)
  44     (string-append
  45      "/" command " { /" fontname " findfont "
  46      (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
  47
  48   (define (standard-tex-font? x)
  49     (or (equal? (substring x 0 2) "ms")
  50         (equal? (substring x 0 2) "cm")))
  51
  52   (define (font-load-command font)
  53     (let* ((specced-font-name (ly:font-name font))
  54            (fontname (if specced-font-name
  55                          (munge-lily-font-name specced-font-name)
  56                          (ly:font-file-name font)))
  57            (command (ps-font-command font))
  58
  59            ;; FIXME -- see (ps-font-command )
  60            (plain (ps-font-command font))
  61            (designsize (ly:font-design-size font))
  62            (magnification (* (ly:font-magnification font)))
  63            (ops (ly:output-def-lookup paper 'outputscale))
  64            (scaling (* ops magnification designsize)))
  65
  66       ;; Bluesky pfbs have UPCASE names (sigh.)
  67       ;; FIXME - don't support Bluesky?
  68       (if (standard-tex-font? fontname)
  69           (set! fontname (string-upcase fontname)))
  70       (if (equal? fontname "unknown")
  71           (display (list font fontname)))
  72       (define-font plain fontname scaling)))
  73
  74   (apply string-append
  75          (map (lambda (x) (font-load-command x))
  76               (filter (lambda (x) (not (ly:pango-font? x)))
  77                       font-list))))
  78
  79 ;; FIXME: duplicated in other output backends
  80 ;; FIXME: silly interface name
  81 (define (output-variables layout)
  82   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  83   (define (value->string val)
  84     (cond
  85      ((string? val) (string-append "(" val ")"))
  86      ((symbol? val) (symbol->string val))
  87      ((number? val) (number->string val))
  88      (else "")))
  89
  90   (define (output-entry ps-key ly-key)
  91     (string-append
  92      "/" ps-key " "
  93      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
  94
  95   (string-append
  96    "/lily-output-units "
  97      (number->string mm-to-bigpoint)
  98      " def %% millimeter\n"
  99    (output-entry "staff-line-thickness" 'linethickness)
 100    (output-entry "line-width" 'linewidth)
 101    (output-entry "paper-size" 'papersizename)
 102    (output-entry "staff-height" 'staffheight)   ;junkme.
 103    "/output-scale "
 104      (number->string (ly:output-def-lookup layout 'outputscale))
 105      " def\n"
 106    (output-entry "page-height" 'vsize)
 107    (output-entry "page-width" 'hsize)))
 108
 109 (define (dump-page outputter page page-number page-count landscape?)
 110   (ly:outputter-dump-string
 111    outputter
 112    (string-append
 113     "%%Page: "
 114     (number->string page-number) " " (number->string page-count) "\n"
 115
 116     "%%BeginPageSetup\n"
 117     (if landscape?
 118         "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
 119         "")
 120     "%%EndPageSetup\n"
 121
 122     "start-page { "
 123     "set-ps-scale-to-lily-scale "
 124     "\n"))
 125   (ly:outputter-dump-stencil outputter page)
 126   (ly:outputter-dump-string outputter "} stop-system \nshowpage\n"))
 127
 128 (define (supplies-or-needs paper load-fonts?)
 129   (define (extract-names font)
 130     (if (ly:pango-font? font)
 131         (map car (ly:pango-font-physical-fonts font))
 132         (list (munge-lily-font-name (ly:font-name font)))))
 133
 134   (let* ((fonts (ly:paper-fonts paper))
 135          (names (apply append (map extract-names fonts))))
 136
 137     (apply string-append
 138            (map (lambda (f)
 139                   (format
 140                    (if load-fonts?
 141                     "%%DocumentSuppliedResources: font ~a\n"
 142                     "%%DocumentNeededResources: font ~a\n")
 143                    f))
 144                 (uniq-list (sort names string<?))))))
 145
 146 (define (eps-header paper bbox load-fonts?)
 147   (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 148                  "%%Creator: LilyPond\n"
 149                  "%%BoundingBox: "
 150                  (string-join (map ly:number->string bbox) " ") "\n"
 151                  "%%Orientation: "
 152                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 153                      "Landscape\n"
 154                      "Portrait\n")
 155                  (supplies-or-needs paper load-fonts?)
 156                  "%%EndComments\n"))
 157
 158 (define (page-header paper page-count load-fonts?)
 159   (string-append "%!PS-Adobe-3.0\n"
 160                  "%%Creator: LilyPond\n"
 161                  "%%Pages: " (number->string page-count) "\n"
 162                  "%%PageOrder: Ascend\n"
 163                  "%%Orientation: "
 164                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 165                      "Landscape\n"
 166                      "Portrait\n")
 167                  "%%DocumentPaperSizes: "
 168                  (ly:output-def-lookup paper 'papersizename) "\n"
 169                  (supplies-or-needs paper load-fonts?)
 170                  "%%EndComments\n"))
 171
 172 (define (procset file-name)
 173   (string-append
 174    (format
 175     "%%BeginResource: procset (~a) 1 0
 176 ~a
 177 %%EndResource
 178 "
 179     file-name (cached-file-contents file-name))))
 180
 181 (define (setup paper)
 182   (string-append
 183    "\n"
 184    "%%BeginSetup\n"
 185    (define-fonts paper)
 186    (output-variables paper)
 187    "%%EndSetup\n"))
 188
 189 (define-public (munge-lily-font-name name)
 190   (regexp-substitute/global #f "([eE]mmentaler|[aA]ybabtu)"
 191                             name 'pre "PFA" 1 'post))
 192
 193 (define (cff-font? font)
 194   (let*
 195       ((cff-string (ly:otf-font-table-data font "CFF ")))
 196     (> (string-length cff-string) 0)))
 197
 198 (define-public (ps-embed-cff body font-set-name version)
 199   (let* ((binary-data
 200           (string-append
 201            (format "/~a ~s StartData " font-set-name (string-length body))
 202            body))
 203
 204          (header
 205           (format
 206            "%%BeginResource: font ~a
 207 %!PS-Adobe-3.0 Resource-FontSet
 208 %%DocumentNeededResources: ProcSet (FontSetInit)
 209 %%Title: (FontSet/~a)
 210 %%Version: ~s
 211 %%EndComments
 212 %%IncludeResource: ProcSet (FontSetInit)
 213 %%BeginResource: FontSet (~a)
 214 /FontSetInit /ProcSet findresource begin
 215 %%BeginData: ~s Binary Bytes
 216 "
 217            font-set-name font-set-name version font-set-name
 218            (string-length binary-data)))
 219          (footer "\n%%EndData
 220 %%EndResource
 221 %%EOF
 222 %%EndResource\n"))
 223
 224     (string-append
 225      header
 226      binary-data
 227      footer)))
 228
 229
 230 (define (write-preamble paper load-fonts? port)
 231
 232   (define (load-font-via-GS font-name-filename)
 233     (define (ps-load-file name)
 234       (format
 235        (if (string? name)
 236            "(~a) (r) file .loadfont\n"
 237            "% fontfile ~a could not be found\n")
 238        name))
 239
 240     (let* ((font (car font-name-filename))
 241            (name (cadr font-name-filename))
 242            (file-name (caddr font-name-filename))
 243            (bare-file-name (ly:find-file file-name)))
 244
 245       (cons
 246        (munge-lily-font-name name)
 247        (cond
 248         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 249          (ps-load-file (ly:find-file
 250                         (format "~a.pfa" (munge-lily-font-name file-name)))))
 251         ((string? bare-file-name)
 252          (ps-load-file (munge-lily-font-name file-name)))
 253         (else
 254          (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 255           "")))))
 256
 257   (define (load-font font-name-filename)
 258     (let* ((font (car font-name-filename))
 259            (name (cadr font-name-filename))
 260            (file-name (caddr font-name-filename))
 261            (bare-file-name (ly:find-file file-name))
 262            )
 263
 264       (cons
 265        (munge-lily-font-name name)
 266        (cond
 267         ((and bare-file-name (string-match "\\.pfa" bare-file-name))
 268          (cached-file-contents bare-file-name))
 269         ((and bare-file-name (string-match "\\.pfb" bare-file-name))
 270          (ly:pfb->pfa bare-file-name))
 271         ((and bare-file-name (string-match "\\.ttf" bare-file-name))
 272          (ly:ttf->pfa bare-file-name))
 273
 274         ((string-match "([eE]mmentaler|[Aa]ybabtu)" file-name)
 275          (cached-file-contents
 276           (format "~a.pfa" (munge-lily-font-name file-name))))
 277
 278         ((and bare-file-name (string-match "\\.otf" bare-file-name))
 279          (ps-embed-cff (ly:otf->cff bare-file-name) name 0))
 280
 281         ((and bare-file-name (string-match "\\.ttf" bare-file-name))
 282          (ly:ttf->pfa bare-file-name))
 283
 284         ((and font (cff-font? font))
 285          (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 286                        name
 287                        0))
 288         (else
 289          (ly:warning (_ "don't know how to embed ~S=~S") name file-name)
 290           "")))))
 291
 292   (define (load-fonts paper)
 293     (let* ((fonts (ly:paper-fonts paper))
 294            (all-font-names
 295             (map
 296              (lambda (font)
 297                (cond
 298                 ((string? (ly:font-file-name font))
 299                  (list (list
 300                         font
 301                         (ly:font-name font)
 302                         (ly:font-file-name font))))
 303                 ((ly:pango-font? font)
 304                  (map
 305                   (lambda (name-psname-pair)
 306                     (list #f
 307                           (car name-psname-pair)
 308                           (cdr name-psname-pair)))
 309                   (ly:pango-font-physical-fonts font)))
 310
 311                 (else
 312                  (ly:font-sub-fonts font))))
 313
 314              fonts))
 315            (font-names
 316             (uniq-list
 317              (sort (apply append all-font-names)
 318                    (lambda (x y) (string<? (cadr x) (cadr y))))))
 319            ;; ttftool/fopencookie is broken on Windows,
 320            ;; possibly a stack corruption bug.
 321            (pfas (map load-font font-names)))
 322       pfas))
 323
 324   (if load-fonts?
 325       (for-each
 326        (lambda (f)
 327          (format port "\n%%BeginFont: ~a\n" (car f))
 328          (display (cdr f) port)
 329          (display "\n%%EndFont\n" port))
 330        (load-fonts paper)))
 331
 332   (display (setup paper) port)
 333
 334   ;; adobe note 5002: should initialize variables before loading routines.
 335   (display (procset "music-drawing-routines.ps") port)
 336   (display (procset "lilyponddefs.ps") port)
 337   (display "init-lilypond-parameters\n" port))
 338
 339 (define-public (output-framework basename book scopes fields)
 340   (let* ((filename (format "~a.ps" basename))
 341          (outputter (ly:make-paper-outputter filename "ps"))
 342          (paper (ly:paper-book-paper book))
 343          (pages (ly:paper-book-pages book))
 344          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 345          (page-number (1- (ly:output-def-lookup paper 'firstpagenumber)))
 346          (page-count (length pages))
 347          (port (ly:outputter-port outputter)))
 348
 349     (output-scopes scopes fields basename)
 350     (display (page-header paper page-count #t) port)
 351     (write-preamble paper #t port)
 352
 353     (for-each
 354      (lambda (page)
 355        (set! page-number (1+ page-number))
 356        (dump-page outputter page page-number page-count landscape?))
 357      pages)
 358
 359     (display "%%Trailer\n%%EOF\n" port)
 360     (ly:outputter-close outputter)
 361     (postprocess-output book framework-ps-module filename
 362                          (completize-formats (ly:output-formats)))))
 363
 364 (if (not (defined? 'nan?))
 365     (define (nan? x) #f))
 366
 367 (if (not (defined? 'inf?))
 368     (define (inf? x) #f))
 369
 370 (define-public (dump-stencil-as-EPS paper dump-me filename load-fonts?)
 371   (define (mm-to-bp-box mmbox)
 372     (let* ((scale (ly:output-def-lookup paper 'outputscale))
 373            (box (map
 374                  (lambda (x)
 375                    (inexact->exact
 376                     (round (* x scale mm-to-bigpoint)))) mmbox)))
 377
 378     (list (car box) (cadr box)
 379           (max (1+ (car box)) (caddr box))
 380           (max (1+ (cadr box)) (cadddr box)))))
 381
 382   (let* ((outputter (ly:make-paper-outputter (format "~a.eps" filename) "ps"))
 383          (port (ly:outputter-port outputter))
 384          (xext (ly:stencil-extent dump-me X))
 385          (yext (ly:stencil-extent dump-me Y))
 386          (bbox
 387           (map
 388            (lambda (x)
 389              (if (or (nan? x) (inf? x)
 390                      ;; FIXME: huh?
 391                      (equal? (format #f "~S" x) "+#.#")
 392                      (equal? (format #f "~S" x) "-#.#"))
 393                  0.0 x))
 394            (list (car xext) (car yext) (cdr xext) (cdr yext))))
 395          (rounded-bbox (mm-to-bp-box bbox))
 396          (port (ly:outputter-port outputter))
 397          (header (eps-header paper rounded-bbox load-fonts?)))
 398
 399     (display header port)
 400     (write-preamble paper load-fonts? port)
 401     (display "start-system { set-ps-scale-to-lily-scale \n" port)
 402     (ly:outputter-dump-stencil outputter dump-me)
 403     (display "} stop-system\n%%Trailer\n%%EOF\n" port)
 404     (ly:outputter-close outputter)))
 405
 406 (define-public (output-preview-framework basename book scopes fields)
 407   (let* ((paper (ly:paper-book-paper book))
 408          (systems (ly:paper-book-systems book))
 409          (scale (ly:output-def-lookup paper 'outputscale))
 410          (to-dump-systems '()))
 411
 412     ;; skip booktitles.
 413     (if (and
 414          (not
 415           (cdr (assoc
 416                'preview-include-book-title
 417                (ly:get-option 'command-line-settings))))
 418          (< 1 (length systems))
 419          (ly:paper-system-title? (list-ref systems 0))
 420          (ly:paper-system-title? (list-ref systems 1)))
 421         (set! systems (cdr systems)))
 422
 423     (for-each
 424      (lambda (sys)
 425        (if (or
 426             (ly:paper-system-title? sys)
 427             (not (pair? to-dump-systems))
 428             (ly:paper-system-title? (car to-dump-systems)))
 429            (set! to-dump-systems (cons sys to-dump-systems))))
 430      systems)
 431
 432     (dump-stencil-as-EPS
 433      paper
 434      (stack-stencils Y DOWN 0.0
 435                      (map ly:paper-system-stencil (reverse to-dump-systems)))
 436      (format "~a.preview" basename)
 437      #t)
 438
 439     (postprocess-output book framework-ps-module
 440                         (format "~a.preview.eps" basename)
 441                         (completize-formats (cons "png" (ly:output-formats))))))
 442 (if #f
 443     (define-public (output-preview-framework basename book scopes fields)
 444
 445       (let* ((paper (ly:paper-book-paper book))
 446              (systems (ly:paper-book-systems book))
 447              (scale (ly:output-def-lookup paper 'outputscale))
 448              (titles (take-while ly:paper-system-title? systems))
 449              (non-title (find (lambda (x)
 450                                 (not (ly:paper-system-title? x))) systems))
 451              (dump-me
 452               (stack-stencils Y DOWN 0.0
 453                               (map ly:paper-system-stencil
 454                                    (append titles (list non-title))))))
 455         (output-scopes scopes fields basename)
 456         (dump-stencil-as-EPS paper dump-me
 457                              (format "~a.preview" basename)
 458                              #t)
 459
 460         (postprocess-output book framework-ps-module
 461                             (format "~a.preview.eps" basename)
 462                             (completize-formats (ly:output-formats))))))
 463 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 464
 465 (define-public (convert-to-pdf book name)
 466   (let* ((defs (ly:paper-book-paper book))
 467          (papersizename (ly:output-def-lookup defs 'papersizename)))
 468
 469     (if (equal? (basename name ".ps") "-")
 470         (ly:warning (_ "can't convert <stdout> to ~S" "PDF"))
 471         (postscript->pdf (if (string? papersizename) papersizename "a4")
 472                          name))))
 473
 474 (define-public (convert-to-png book name)
 475   (let* ((defs (ly:paper-book-paper book))
 476          (defs-resolution (ly:output-def-lookup defs 'pngresolution))
 477          (resolution (if (number? defs-resolution)
 478                          defs-resolution
 479                          (cdr (assoc 'resolution
 480                                 (ly:get-option 'command-line-settings)))))
 481          (papersizename (ly:output-def-lookup defs 'papersizename)))
 482
 483     (postscript->png resolution
 484                      (if (string? papersizename) papersizename "a4")
 485                      name)))
 486
 487 (define-public (convert-to-dvi book name)
 488   (ly:warning (_ "can't generate ~S using the postscript back-end") "DVI"))
 489
 490 (define-public (convert-to-tex book name)
 491   (ly:warning (_ "can't generate ~S using the postscript back-end") "TeX"))
 492
 493 (define-public (convert-to-ps book name)
 494   #t)