scm/framework-ps.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 2004--2015 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 (define-module (scm framework-ps))
  19
  20 ;;; this is still too big a mess.
  21
  22 (use-modules (ice-9 string-fun)
  23              (guile)
  24              (scm page)
  25              (scm paper-system)
  26              (srfi srfi-1)
  27              (srfi srfi-13)
  28              (scm clip-region)
  29              (lily))
  30
  31 (define format ergonomic-simple-format)
  32
  33 (define framework-ps-module (current-module))
  34
  35 ;;(define pdebug stderr)
  36 (define (pdebug . rest) #f)
  37
  38 (define-public (ps-font-command font)
  39   (let* ((name (ly:font-file-name font))
  40          (magnify (ly:font-magnification font)))
  41     (string-append
  42      "magfont"
  43      (ly:string-substitute
  44       " " "_"
  45       (ly:string-substitute
  46        "/" "_"
  47        (ly:string-substitute
  48         "%" "_" name)))
  49      "m" (string-encode-integer (inexact->exact (round (* 1000 magnify)))))))
  50
  51 (define (ps-define-pango-pf pango-pf font-name scaling)
  52   "")
  53
  54 (define (ps-define-font font font-name scaling)
  55   (if (ly:bigpdfs)
  56       (string-append
  57        "/" (ps-font-command font) "-N"
  58        " { /" font-name "-N"
  59        " " (ly:number->string scaling) " output-scale div selectfont }"
  60        " bind def\n"
  61        "/" (ps-font-command font) "-S"
  62        " { /" font-name "-S"
  63        " " (ly:number->string scaling) " output-scale div selectfont }"
  64        " bind def\n"
  65        "/" (ps-font-command font) "-O"
  66        " { /" font-name "-O"
  67        " " (ly:number->string scaling) " output-scale div selectfont }"
  68        " bind def\n"
  69        "/help" font-name " {\n  gsave\n  1 setgray\n  /"
  70        font-name "-N"
  71        " 0.001 selectfont 0 0 moveto <01> show\n  /"
  72        font-name "-S"
  73        " 0.001 selectfont 0 0 moveto <01> show\n  /"
  74        font-name "-O"
  75        " 0.001 selectfont 0 0 moveto <01> show\n  grestore\n} def\n")
  76       (string-append
  77        "/" (ps-font-command font)
  78        " { /" font-name
  79        " " (ly:number->string scaling) " output-scale div selectfont }"
  80        " bind def\n")))
  81
  82 ;; FIXME: duplicated in other output backends
  83 ;; FIXME: silly interface name
  84 (define (output-variables layout)
  85   ;; FIXME: duplicates output-layout's scope-entry->string, mostly
  86   (define (value->string val)
  87     (cond
  88      ((string? val) (string-append "(" val ")"))
  89      ((symbol? val) (symbol->string val))
  90      ((number? val) (number->string val))
  91      (else "")))
  92
  93   (define (output-entry ps-key ly-key)
  94     (string-append
  95      "/" ps-key " "
  96      (value->string (ly:output-def-lookup layout ly-key)) " def\n"))
  97
  98   (string-append
  99    "/lily-output-units "
 100    (number->string (/ (ly:bp 1))) " def %% millimeter\n"
 101    (output-entry "staff-line-thickness" 'line-thickness)
 102    (output-entry "line-width" 'line-width)
 103    (output-entry "paper-size" 'papersizename)
 104    (output-entry "staff-height" 'staff-height)  ;junkme.
 105    "/output-scale "
 106    (number->string (ly:output-def-lookup layout 'output-scale)) " def\n"
 107    (output-entry "page-height" 'paper-height)
 108    (output-entry "page-width" 'paper-width)
 109    (if (ly:get-option 'strokeadjust) "true setstrokeadjust\n" "")
 110    ))
 111
 112 (define (dump-page outputter page page-number page-count landscape?)
 113   (ly:outputter-dump-string
 114    outputter
 115    (string-append
 116     (format #f "%%Page: ~a ~a\n" page-number page-number)
 117     "%%BeginPageSetup\n"
 118     (if landscape?
 119         "page-width output-scale lily-output-units mul mul 0 translate 90 rotate\n"
 120         "")
 121     "%%EndPageSetup\n"
 122     "\n"
 123     "gsave 0 paper-height translate set-ps-scale-to-lily-scale\n"
 124     "/helpEmmentaler-Brace where {pop helpEmmentaler-Brace} if\n"
 125     "/helpEmmentaler-11 where {pop helpEmmentaler-11} if\n"
 126     "/helpEmmentaler-13 where {pop helpEmmentaler-13} if\n"
 127     "/helpEmmentaler-14 where {pop helpEmmentaler-14} if\n"
 128     "/helpEmmentaler-16 where {pop helpEmmentaler-16} if\n"
 129     "/helpEmmentaler-18 where {pop helpEmmentaler-18} if\n"
 130     "/helpEmmentaler-20 where {pop helpEmmentaler-20} if\n"
 131     "/helpEmmentaler-23 where {pop helpEmmentaler-23} if\n"
 132     "/helpEmmentaler-26 where {pop helpEmmentaler-26} if\n"))
 133   (ly:outputter-dump-stencil outputter page)
 134   (ly:outputter-dump-string outputter "stroke grestore\nshowpage\n"))
 135
 136 (define (supplies-or-needs paper load-fonts?)
 137   (define (extract-names font)
 138     (if (ly:pango-font? font)
 139         (map car (ly:pango-font-physical-fonts font))
 140         (list (ly:font-name font))))
 141
 142   (let* ((fonts (ly:paper-fonts paper))
 143          (names (append-map extract-names fonts)))
 144     (string-concatenate
 145      (map (lambda (f)
 146             (format #f
 147                     (if load-fonts?
 148                         "%%DocumentSuppliedResources: font ~a\n"
 149                         "%%DocumentNeededResources: font ~a\n")
 150                     f))
 151           (uniq-list (sort names string<?))))))
 152
 153 (define (eps-header paper bbox load-fonts?)
 154   (string-append "%!PS-Adobe-2.0 EPSF-2.0\n"
 155                  "%%Creator: LilyPond " (lilypond-version) "\n"
 156                  "%%BoundingBox: "
 157                  (string-join (map ly:number->string bbox) " ") "\n"
 158                  "%%Orientation: "
 159                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 160                      "Landscape\n"
 161                      "Portrait\n")
 162                  (supplies-or-needs paper load-fonts?)
 163                  "%%EndComments\n"))
 164
 165 (define (ps-document-media paper)
 166   (let* ((w (/ (*
 167                 (ly:output-def-lookup paper 'output-scale)
 168                 (ly:output-def-lookup paper 'paper-width)) (ly:bp 1)))
 169          (h (/ (*
 170                 (ly:output-def-lookup paper 'paper-height)
 171                 (ly:output-def-lookup paper 'output-scale))
 172                (ly:bp 1)))
 173          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t)))
 174     (ly:format "%%DocumentMedia: ~a ~2f ~2f ~a ~a ~a\n"
 175                (ly:output-def-lookup paper 'papersizename)
 176                (if landscape? h w)
 177                (if landscape? w h)
 178                80   ;; weight
 179                "()" ;; color
 180                "()" ;; type
 181                )))
 182
 183 (define (file-header paper page-count load-fonts?)
 184   (string-append "%!PS-Adobe-3.0\n"
 185                  "%%Creator: LilyPond " (lilypond-version) "\n"
 186                  "%%Pages: " (number->string page-count) "\n"
 187                  "%%PageOrder: Ascend\n"
 188                  "%%Orientation: "
 189                  (if (eq? (ly:output-def-lookup paper 'landscape) #t)
 190                      "Landscape\n"
 191                      "Portrait\n")
 192                  (ps-document-media paper)
 193                  (supplies-or-needs paper load-fonts?)
 194                  "%%EndComments\n"))
 195
 196 (define (procset file-name)
 197   (format #f
 198           "%%BeginResource: procset (~a) 1 0
 199 ~a
 200 %%EndResource
 201 "
 202           file-name (cached-file-contents file-name)))
 203
 204 (define (embed-document file-name)
 205   (format #f "%%BeginDocument: ~a
 206 ~a
 207 %%EndDocument
 208 "
 209           file-name (cached-file-contents file-name)))
 210
 211 (define (setup-variables paper)
 212   (string-append
 213    "\n"
 214    (define-fonts paper ps-define-font ps-define-pango-pf)
 215    (output-variables paper)))
 216
 217 (define never-embed-font-list (list))
 218
 219 (define (cff-font? font)
 220   (let* ((cff-string (ly:otf-font-table-data font "CFF ")))
 221     (> (string-length cff-string) 0)))
 222
 223 (define-public (ps-embed-cff body font-set-name version)
 224   (let* ((binary-data
 225           (string-append
 226            (format #f "/~a ~s StartData " font-set-name (string-length body))
 227            body))
 228          (header
 229           (format #f
 230                   "%%BeginResource: font ~a
 231 %!PS-Adobe-3.0 Resource-FontSet
 232 %%DocumentNeededResources: ProcSet (FontSetInit)
 233 %%Title: (FontSet/~a)
 234 %%Version: ~s
 235 %%EndComments
 236 %%IncludeResource: ProcSet (FontSetInit)
 237 %%BeginResource: FontSet (~a)
 238 /FontSetInit /ProcSet findresource begin
 239 %%BeginData: ~s Binary Bytes
 240 "
 241                   font-set-name font-set-name version font-set-name
 242                   (string-length binary-data)))
 243          (footer "\n%%EndData
 244 %%EndResource
 245 %%EndResource\n"))
 246     (begin
 247       (set! never-embed-font-list
 248             (append never-embed-font-list (list font-set-name)))
 249       (string-append header
 250                      binary-data
 251                      footer))))
 252
 253 (define check-conflict-and-embed-cff
 254   (let ((font-list '()))
 255     (lambda (name file-name font-index)
 256       (if name
 257           (let* ((name-symbol (string->symbol name))
 258                  (args-filename-offset
 259                   (cons file-name (ly:get-cff-offset file-name font-index)))
 260                  (found-filename-offset (assq name-symbol font-list)))
 261             (if found-filename-offset
 262                 (begin
 263                   (if (equal? args-filename-offset (cdr found-filename-offset))
 264                       (ly:debug
 265                        (_ "CFF font `~a' already embedded, skipping.")
 266                        name)
 267                       (ly:warning
 268                        (_ "Different CFF fonts which have the same name `~a' has been detected. The font cannot be embedded.")
 269                        name))
 270                   "")
 271                 (begin
 272                   (ly:debug (_ "Embedding CFF font `~a'.") name)
 273                   (set! font-list
 274                         (acons name-symbol args-filename-offset font-list))
 275                   (ps-embed-cff (ly:otf->cff file-name font-index) name 0))))
 276           (begin
 277             (ly:debug (_ "Initializing embedded CFF font list."))
 278             (set! font-list '()))))))
 279
 280 (define (initialize-font-embedding)
 281   (check-conflict-and-embed-cff #f #f #f))
 282
 283 (define (write-preamble paper load-fonts? port)
 284   (define (internal-font? font-name-filename)
 285     (let* ((font (car font-name-filename))
 286            (file-name (caddr font-name-filename))
 287            (font-file-name (ly:find-file (format #f "~a.otf" file-name))))
 288       (and font
 289            (cff-font? font)
 290            font-file-name
 291            (string-contains font-file-name
 292                             (ly:get-option 'datadir)))))
 293
 294   (define (load-font-via-GS font-name-filename)
 295     (define (is-collection-font? file-name)
 296       (let* ((port (open-file file-name "rb"))
 297              (retval
 298               (if (eq? (read-char port) #\t)
 299                   (if (eq? (read-char port) #\t)
 300                       (if (eq? (read-char port) #\c)
 301                           (if (eq? (read-char port) #\f)
 302                               #t
 303                               #f)
 304                           #f)
 305                       #f)
 306                   #f)))
 307         (close-port port)
 308         retval))
 309
 310     (define (ps-load-file file-name)
 311       (if (string? file-name)
 312           (if (and (not (ly:get-option 'font-export-dir))
 313                    (string-contains file-name (ly:get-option 'datadir)))
 314               (begin
 315                 (set! file-name (ly:string-substitute (ly:get-option 'datadir)
 316                                                       "" file-name))
 317                 (format #f
 318                         "lilypond-datadir (~a) concatstrings (r) file .loadfont\n"
 319                         file-name))
 320               (format #f "(~a) (r) file .loadfont\n" file-name))
 321           (format #f "% cannot find font file: ~a\n" file-name)))
 322
 323     (let* ((font (car font-name-filename))
 324            (name (cadr font-name-filename))
 325            (file-name (caddr font-name-filename))
 326            (font-index (cadddr font-name-filename))
 327            (bare-file-name (ly:find-file file-name)))
 328       (cond
 329        ((and (number? font-index)
 330              (!= font-index 0))
 331         (ly:warning (_ "Font ~a cannot be loaded via Ghostscript because its font-index (~a) is not zero.")
 332                     name font-index)
 333         (load-font font-name-filename))
 334        ((and (string? bare-file-name)
 335              (eq? (ly:get-font-format bare-file-name font-index) 'CFF)
 336              (is-collection-font? bare-file-name))
 337         (ly:warning (_ "Font ~a cannot be loaded via Ghostscript because it is an OpenType/CFF Collection (OTC) font.")
 338                     name)
 339         (load-font font-name-filename))
 340        ((and (string? bare-file-name)
 341              (eq? (ly:get-font-format bare-file-name font-index) 'TrueType)
 342              (not (ly:has-glyph-names? bare-file-name font-index)))
 343         (ly:warning (_ "Font ~a cannot be used via Ghostscript because it is a TrueType font that does not have glyph names.")
 344                     name)
 345         (load-font font-name-filename))
 346        (else
 347         (begin
 348           (if (or (and font (cff-font? font))
 349                   (and (string? bare-file-name)
 350                        (not (eq? (ly:get-font-format
 351                                   bare-file-name
 352                                   font-index) 'TrueType))))
 353               (set! never-embed-font-list
 354                     (append never-embed-font-list (list name))))
 355           (cons name
 356                 (if (mac-font? bare-file-name)
 357                     (handle-mac-font name bare-file-name)
 358                     (cond
 359                      ((and font (cff-font? font))
 360                       (ps-load-file (ly:find-file
 361                                      (format #f "~a.otf" file-name))))
 362                      ((string? bare-file-name)
 363                       (ps-load-file file-name))
 364                      (else
 365                       (ly:warning (_ "cannot embed ~S=~S") name file-name)
 366                       "")))))))))
 367
 368   (define (dir-join a b)
 369     (if (equal? a "")
 370         b
 371         (string-append a "/" b)))
 372
 373   (define (dir-listing dir-name)
 374     (define (dir-helper dir lst)
 375       (let ((e (readdir dir)))
 376         (if (eof-object? e)
 377             lst
 378             (dir-helper dir (cons e lst)))))
 379     (reverse (dir-helper (opendir dir-name) '())))
 380
 381   (define (handle-mac-font name file-name)
 382     (let* ((dir-name (tmpnam))
 383            (files '())
 384            (status 0)
 385            (embed #f)
 386            (cwd (getcwd)))
 387       (mkdir dir-name #o700)
 388       (chdir dir-name)
 389       (set! status (ly:system (list "fondu" "-force" file-name)))
 390       (chdir cwd)
 391       (set! files (dir-listing dir-name))
 392       (for-each
 393        (lambda (f)
 394          (let* ((full-name (dir-join dir-name f)))
 395            (if (and (not embed)
 396                     (equal? 'regular (stat:type (stat full-name)))
 397                     (equal? name (ly:ttf-ps-name full-name)))
 398                (set! embed (font-file-as-ps-string name full-name 0)))
 399            (if (or (equal? "." f)
 400                    (equal? ".." f))
 401                #t
 402                (delete-file full-name))))
 403        files)
 404       (rmdir dir-name)
 405       (if (not embed)
 406           (begin
 407             (set! embed "% failed\n")
 408             (ly:warning (_ "cannot extract file matching ~a from ~a")
 409                         name file-name)))
 410       embed))
 411
 412   (define (font-file-as-ps-string name file-name font-index)
 413     (let ((font-format (ly:get-font-format file-name font-index)))
 414       (cond
 415        ((eq? font-format (string->symbol "Type 1"))
 416         ;; Type 1 (PFA and PFB) fonts
 417         (begin (set! never-embed-font-list
 418                      (append never-embed-font-list (list name)))
 419                (ly:type1->pfa file-name)))
 420        ((eq? font-format 'TrueType)
 421         ;; TrueType fonts (TTF) and TrueType Collection (TTC)
 422         (ly:ttf->pfa file-name font-index))
 423        ((eq? font-format 'CFF)
 424         ;; OpenType/CFF fonts (OTF) and OpenType/CFF Collection (OTC)
 425         (check-conflict-and-embed-cff name file-name font-index))
 426        (else
 427         (ly:warning (_ "do not know how to embed ~S=~S") name file-name)
 428         ""))))
 429
 430   (define (mac-font? bare-file-name)
 431     (and (eq? PLATFORM 'darwin)
 432          bare-file-name
 433          (or (string-endswith bare-file-name ".dfont")
 434              (= (stat:size (stat bare-file-name)) 0))))
 435
 436   (define (load-font font-psname-filename-fontindex)
 437     (let* ((font (list-ref font-psname-filename-fontindex 0))
 438            (name (list-ref font-psname-filename-fontindex 1))
 439            (file-name (list-ref font-psname-filename-fontindex 2))
 440            (font-index (list-ref font-psname-filename-fontindex 3))
 441            (bare-file-name (ly:find-file file-name)))
 442       (cons name
 443             (cond ((mac-font? bare-file-name)
 444                    (handle-mac-font name bare-file-name))
 445                   ((and font (cff-font? font))
 446                    (ps-embed-cff (ly:otf-font-table-data font "CFF ")
 447                                  name
 448                                  0))
 449                   (bare-file-name (font-file-as-ps-string
 450                                    name bare-file-name font-index))
 451                   (else
 452                    (ly:warning (_ "do not know how to embed font ~s ~s ~s")
 453                                name file-name font))))))
 454
 455   (define (load-fonts paper)
 456     (let* ((fonts (ly:paper-fonts paper))
 457
 458            ;; todo - doc format of list.
 459            (all-font-names
 460             (map
 461              (lambda (font)
 462                (cond ((string? (ly:font-file-name font))
 463                       (list (list font
 464                                   (ly:font-name font)
 465                                   (ly:font-file-name font)
 466                                   #f)))
 467                      ((ly:pango-font? font)
 468                       (map (lambda (psname-filename-fontindex)
 469                              (list #f
 470                                    (list-ref psname-filename-fontindex 0)
 471                                    (list-ref psname-filename-fontindex 1)
 472                                    (list-ref psname-filename-fontindex 2)))
 473                            (ly:pango-font-physical-fonts font)))
 474                      (else
 475                       (ly:font-sub-fonts font))))
 476              fonts))
 477            (font-names (uniq-list
 478                         (sort (concatenate all-font-names)
 479                               (lambda (x y) (string<? (cadr x) (cadr y))))))
 480
 481            ;; slightly spaghetti-ish: deciding what to load where
 482            ;; is smeared out.
 483            (font-loader
 484             (lambda (name)
 485               (cond ((ly:get-option 'gs-load-fonts)
 486                      (load-font-via-GS name))
 487                     ((ly:get-option 'gs-load-lily-fonts)
 488                      (if (or (string-contains (caddr name)
 489                                               (ly:get-option 'datadir))
 490                              (internal-font? name))
 491                          (load-font-via-GS name)
 492                          (load-font name)))
 493                     (else
 494                      (load-font name)))))
 495            (pfas (map font-loader font-names)))
 496       pfas))
 497
 498   (define (font-export name body)
 499     (let* ((filename (format #f "~a/~a.font.ps"
 500                              (ly:get-option 'font-export-dir)
 501                              name))
 502            (port-excl
 503             (catch
 504              'system-error
 505              (lambda ()
 506                ;; Exclusive file create:
 507                ;; When the file already exists, it raises system-error.
 508                (open filename (logior O_WRONLY O_CREAT O_EXCL)))
 509              (lambda stuff
 510                ;; Catch the system-error
 511                (let ((errno (system-error-errno stuff)))
 512                  (cond
 513                   ;; If the file already exists, return #f.
 514                   ((= errno EEXIST)
 515                    (begin
 516                      (ly:debug
 517                        (_ "Font file `~a' already exists, skipping.")
 518                        filename)
 519                      #f))
 520                   ;; If the cause is something else, re-throw the error.
 521                   (#t
 522                    (throw 'system-error (cdr stuff)))))))))
 523       (if port-excl
 524           ;; MinGW hack: need to have "b"inary for fonts
 525           (let ((port (open-file filename "wb")))
 526             (close port-excl)
 527             (ly:debug (_ "Exporting font file `~a'.") filename)
 528             (format port "%%BeginFont: ~a\n" name)
 529             (display body port)
 530             (display "%%EndFont\n" port)
 531             (close-port port)))))
 532
 533   (display "%%BeginProlog\n" port)
 534   (format
 535    port
 536    "/lilypond-datadir where {pop} {userdict /lilypond-datadir (~a) put } ifelse"
 537    (ly:get-option 'datadir))
 538   (set! never-embed-font-list (list))
 539   (if (ly:get-option 'font-export-dir)
 540       (let ((dirname (format #f "~a" (ly:get-option 'font-export-dir))))
 541         (ly:debug
 542          (_ "Making font export directory `~a'.") dirname)
 543         (catch
 544          'system-error
 545          (lambda ()
 546            ;; mkdir:
 547            ;; When the directory already exists, it raises system-error.
 548            (mkdir dirname))
 549          (lambda stuff
 550            ;; Catch the system-error
 551            (if (= EEXIST (system-error-errno stuff))
 552                ;; If the directory already exists, avoid error.
 553                (ly:debug
 554                 (_ "Font export directory `~a' already exists.") dirname)
 555                ;; If the cause is something else, re-throw the error.
 556                (throw 'system-error (cdr stuff)))))))
 557   (if load-fonts?
 558       (for-each (lambda (f)
 559                   (format port "\n%%BeginFont: ~a\n" (car f))
 560                   (display (cdr f) port)
 561                   (display "%%EndFont\n" port)
 562                   (if (ly:get-option 'font-export-dir)
 563                       (font-export (car f) (cdr f))))
 564                 (load-fonts paper)))
 565   (if (ly:get-option 'gs-never-embed-fonts)
 566       (begin
 567         (display "\nsystemdict /DEVICE known\n" port)
 568         (display " { systemdict /DEVICE get (pdfwrite) eq {\n" port)
 569         (display ".setpdfwrite << /NeverEmbed [" port)
 570         (display (string-concatenate
 571                   (map (lambda (f) (string-append " /" f))
 572                        never-embed-font-list)) port)
 573         (display " ] >> setdistillerparams\n" port)
 574         (display " } if } if\n" port)))
 575   (if (ly:bigpdfs)
 576       (display (procset "encodingdefs.ps") port))
 577   (display (setup-variables paper) port)
 578
 579   ;; adobe note 5002: should initialize variables before loading routines.
 580   (display (procset "music-drawing-routines.ps") port)
 581   (display (procset "lilyponddefs.ps") port)
 582   (display "%%EndProlog\n" port)
 583   (display "%%BeginSetup\ninit-lilypond-parameters\n%%EndSetup\n\n" port))
 584
 585 (define (ps-quote str)
 586   (fold
 587    (lambda (replacement-list result)
 588      (string-join
 589       (string-split
 590        result
 591        (car replacement-list))
 592       (cadr replacement-list)))
 593    str
 594    '((#\\ "\\\\") (#\( "\\(") (#\) "\\)"))))
 595
 596 ;;; Create DOCINFO pdfmark containing metadata
 597 ;;; header fields with pdf prefix override those without the prefix
 598 (define (handle-metadata header port)
 599   (define (metadata-encode val)
 600     ;; First, call ly:encode-string-for-pdf to encode the string (latin1 or
 601     ;; utf-16be), then escape all parentheses and backslashes
 602     ;;
 603     ;; NOTE: with guile-2.0+ ly:encode-string-for-pdf is not really needed and
 604     ;; could be replaced with the following code:
 605     ;;
 606     ;;    (let* ((utf16be-bom #vu8(#xFE #xFF)))
 607     ;;      (string-append (bytevector->string utf16be-bom "ISO-8859-1")
 608     ;;                     (bytevector->string (string->utf16 val 'big) "ISO-8859-1")))
 609     ;;
 610     (ps-quote (ly:encode-string-for-pdf val)))
 611   (define (metadata-lookup-output overridevar fallbackvar field)
 612     (let* ((overrideval (ly:modules-lookup (list header) overridevar))
 613            (fallbackval (ly:modules-lookup (list header) fallbackvar))
 614            (val (if overrideval overrideval fallbackval)))
 615       (if val
 616           (format port "/~a (~a)\n" field (metadata-encode (markup->string val (list header)))))))
 617
 618   (if (module? header)
 619       (begin
 620        (display "mark " port)
 621        (metadata-lookup-output 'pdfauthor 'author "Author")
 622        (format port "/Creator (LilyPond ~a)\n" (lilypond-version))
 623        (metadata-lookup-output 'pdftitle 'title "Title")
 624        (metadata-lookup-output 'pdfsubject 'subject "Subject")
 625        (metadata-lookup-output 'pdfkeywords 'keywords "Keywords")
 626        (metadata-lookup-output 'pdfmodDate 'modDate "ModDate")
 627        (metadata-lookup-output 'pdfsubtitle 'subtitle "Subtitle")
 628        (metadata-lookup-output 'pdfcomposer 'composer "Composer")
 629        (metadata-lookup-output 'pdfarranger 'arranger "Arranger")
 630        (metadata-lookup-output 'pdfpoet 'poet "Poet")
 631        (metadata-lookup-output 'pdfcopyright 'copyright "Copyright")
 632        (display "/DOCINFO pdfmark\n\n" port)))
 633
 634   (if (ly:get-option 'embed-source-code)
 635       (let ((source-list (delete-duplicates
 636                           (remove (lambda (str)
 637                                     (or
 638                                      (string-contains str
 639                                        (ly:get-option 'datadir))
 640                                      (string=? str
 641                                        "<included string>")))
 642                             (ly:source-files)))))
 643          (display "\n/pdfmark where
 644 {pop} {userdict /pdfmark /cleartomark load put} ifelse" port)
 645          (for-each (lambda (fname idx)
 646                      (format port "\n
 647 mark /_objdef {ly~a_stream} /type /stream   /OBJ pdfmark
 648 mark {ly~a_stream} << /Type /EmbeddedFile>> /PUT pdfmark
 649 mark {ly~a_stream} (~a) /PUT pdfmark
 650 mark /Name (LilyPond source file ~a)
 651 /FS << /Type /Filespec /F (~a) /EF << /F {ly~a_stream} >> >> /EMBED pdfmark
 652 mark {ly~a_stream} /CLOSE pdfmark
 653 \n"
 654                 idx idx idx
 655                 (ps-quote (ly:gulp-file fname))
 656                   idx fname idx idx))
 657           source-list (iota (length source-list))))))
 658
 659 (define-public (output-framework basename book scopes fields)
 660   (let* ((port-tmp (make-tmpfile))
 661          (tmp-name (port-filename port-tmp))
 662          (outputter (ly:make-paper-outputter
 663                      port-tmp
 664                      'ps))
 665          (paper (ly:paper-book-paper book))
 666          (header (ly:paper-book-header book))
 667          (systems (ly:paper-book-systems book))
 668          (page-stencils (map page-stencil (ly:paper-book-pages book)))
 669          (landscape? (eq? (ly:output-def-lookup paper 'landscape) #t))
 670          (page-number (1- (ly:output-def-lookup paper 'first-page-number)))
 671          (page-count (length page-stencils))
 672          (port (ly:outputter-port outputter)))
 673     (initialize-font-embedding)
 674     (if (ly:get-option 'clip-systems)
 675         (clip-system-EPSes basename book))
 676     (if (ly:get-option 'dump-signatures)
 677         (write-system-signatures basename (ly:paper-book-systems book) 1))
 678     (output-scopes scopes fields basename)
 679     (display (file-header paper page-count #t) port)
 680     ;; don't do BeginDefaults PageMedia: A4
 681     ;; not necessary and wrong
 682     (write-preamble paper #t port)
 683     (handle-metadata header port)
 684     (for-each
 685      (lambda (page)
 686        (set! page-number (1+ page-number))
 687        (dump-page outputter page page-number page-count landscape?))
 688      page-stencils)
 689     (display "%%Trailer\n%%EOF\n" port)
 690     (ly:outputter-close outputter)
 691     (postprocess-output book framework-ps-module (ly:output-formats)
 692                         basename tmp-name #f)))
 693
 694 (define-public (dump-stencil-as-EPS paper dump-me filename
 695                                     load-fonts)
 696   (let* ((xext (ly:stencil-extent dump-me X))
 697          (yext (ly:stencil-extent dump-me Y))
 698          (padding (ly:get-option 'eps-box-padding))
 699          (left-overshoot (if (number? padding)
 700                              (* -1 padding (ly:output-def-lookup paper 'mm))
 701                              #f))
 702          (bbox
 703           (map
 704            (lambda (x)
 705              (if (or (nan? x) (inf? x)
 706                      ;; FIXME: huh?
 707                      (equal? (format #f "~S" x) "+#.#")
 708                      (equal? (format #f "~S" x) "-#.#"))
 709                  0.0 x))
 710
 711            ;; the left-overshoot is to make sure that
 712            ;; bar numbers stick out of margin uniformly.
 713            ;;
 714            (list
 715             (if (number? left-overshoot)
 716                 (min left-overshoot (car xext))
 717                 (car xext))
 718             (car yext) (cdr xext) (cdr yext)))))
 719     (dump-stencil-as-EPS-with-bbox paper dump-me filename load-fonts bbox)))
 720
 721 (define-public (dump-stencil-as-EPS-with-bbox paper dump-me filename
 722                                               load-fonts
 723                                               bbox)
 724   "Create an EPS file from stencil @var{dump-me} to @var{filename}.
 725 @var{bbox} has format @code{(left-x, lower-y, right-x, upper-y)}.  If
 726 @var{load-fonts} set, include fonts inline."
 727   (define (to-rounded-bp-box box)
 728     "Convert box to 1/72 inch with rounding to enlarge the box."
 729     (let* ((scale (ly:output-def-lookup paper 'output-scale))
 730            (strip-non-number (lambda (x)
 731                                (if (or (nan? x)
 732                                        (inf? x))
 733                                    0.0
 734                                    x)))
 735            (directed-round (lambda (x rounder)
 736                              (inexact->exact
 737                               (rounder (/ (* (strip-non-number x) scale)
 738                                           (ly:bp 1)))))))
 739       (list (directed-round (car box) floor)
 740             (directed-round (cadr box) floor)
 741             (directed-round (max (1+ (car box)) (caddr box)) ceiling)
 742             (directed-round (max (1+ (cadr box)) (cadddr box)) ceiling))))
 743
 744   (let* ((outputter (ly:make-paper-outputter
 745                      ;; FIXME: better wrap open/open-file,
 746                      ;; content-mangling is always bad.
 747                      ;; MINGW hack: need to have "b"inary for embedding CFFs
 748                      (open-file (format #f "~a.eps" filename) "wb")
 749                      'ps))
 750          (port (ly:outputter-port outputter))
 751          (rounded-bbox (to-rounded-bp-box bbox))
 752          (port (ly:outputter-port outputter))
 753          (header (eps-header paper rounded-bbox load-fonts)))
 754     (initialize-font-embedding)
 755     (display header port)
 756     (write-preamble paper load-fonts port)
 757     (display "/mark_page_link { pop pop pop pop pop } bind def\n" port)
 758     (display "gsave set-ps-scale-to-lily-scale\n" port)
 759     (display "/helpEmmentaler-Brace where {pop helpEmmentaler-Brace} if\n" port)
 760     (display "/helpEmmentaler-11 where {pop helpEmmentaler-11} if\n" port)
 761     (display "/helpEmmentaler-13 where {pop helpEmmentaler-13} if\n" port)
 762     (display "/helpEmmentaler-14 where {pop helpEmmentaler-14} if\n" port)
 763     (display "/helpEmmentaler-16 where {pop helpEmmentaler-16} if\n" port)
 764     (display "/helpEmmentaler-18 where {pop helpEmmentaler-18} if\n" port)
 765     (display "/helpEmmentaler-20 where {pop helpEmmentaler-20} if\n" port)
 766     (display "/helpEmmentaler-23 where {pop helpEmmentaler-23} if\n" port)
 767     (display "/helpEmmentaler-26 where {pop helpEmmentaler-26} if\n" port)
 768     (ly:outputter-dump-stencil outputter dump-me)
 769     (display "stroke grestore\n%%Trailer\n%%EOF\n" port)
 770     (ly:outputter-close outputter)))
 771
 772 (define (clip-systems-to-region basename paper systems region do-pdf do-png)
 773   (let* ((extents-system-pairs
 774           (filtered-map (lambda (paper-system)
 775                           (let* ((x-ext (system-clipped-x-extent
 776                                          (paper-system-system-grob paper-system)
 777                                          region)))
 778                             (if x-ext
 779                                 (cons x-ext paper-system)
 780                                 #f)))
 781                         systems))
 782          (count 0))
 783     (for-each
 784      (lambda (ext-system-pair)
 785        (let* ((xext (car ext-system-pair))
 786               (paper-system (cdr ext-system-pair))
 787               (yext (paper-system-extent paper-system Y))
 788               (bbox (list (car xext) (car yext)
 789                           (cdr xext) (cdr yext)))
 790               (filename (if (< 0 count)
 791                             (format #f "~a-~a" basename count)
 792                             basename)))
 793          (set! count (1+ count))
 794          (dump-stencil-as-EPS-with-bbox paper
 795                                         (paper-system-stencil paper-system)
 796                                         filename
 797                                         (ly:get-option 'include-eps-fonts)
 798                                         bbox)
 799          (if do-pdf
 800              (postscript->pdf 0 0 filename (format #f "~a.eps" filename) #t))
 801          (if do-png
 802              (postscript->png (ly:get-option 'resolution) 0 0
 803                               filename (format #f "~a.eps" filename) #t))))
 804      extents-system-pairs)))
 805
 806 (define-public (clip-system-EPSes basename paper-book)
 807   (define do-pdf
 808     (member "pdf" (ly:output-formats)))
 809   (define do-png
 810     (member "png" (ly:output-formats)))
 811
 812   (define (clip-score-systems basename systems)
 813     (let* ((layout (ly:grob-layout (paper-system-system-grob (car systems))))
 814            (regions (ly:output-def-lookup layout 'clip-regions)))
 815       (for-each
 816        (lambda (region)
 817          (clip-systems-to-region
 818           (format #f "~a-from-~a-to-~a-clip"
 819                   basename
 820                   (rhythmic-location->file-string (car region))
 821                   (rhythmic-location->file-string (cdr region)))
 822           layout systems region
 823           do-pdf do-png))
 824        regions)))
 825
 826   ;; partition in system lists sharing their layout blocks
 827   (let* ((systems (ly:paper-book-systems paper-book))
 828          (count 0)
 829          (score-system-list '()))
 830     (fold
 831      (lambda (system last-system)
 832        (if (not (and last-system
 833                      (equal? (paper-system-layout last-system)
 834                              (paper-system-layout system))))
 835            (set! score-system-list (cons '() score-system-list)))
 836        (if (paper-system-layout system)
 837            (set-car! score-system-list (cons system (car score-system-list))))
 838        ;; pass value.
 839        system)
 840      #f
 841      systems)
 842     (for-each (lambda (system-list)
 843                 ;; filter out headers and top-level markup
 844                 (if (pair? system-list)
 845                     (clip-score-systems
 846                      (if (> count 0)
 847                          (format #f "~a-~a" basename count)
 848                          basename)
 849                      system-list)))
 850               score-system-list)))
 851
 852 (define-public (output-preview-framework basename book scopes fields)
 853   (let* ((paper (ly:paper-book-paper book))
 854          (systems (relevant-book-systems book))
 855          (to-dump-systems (relevant-dump-systems systems)))
 856     (dump-stencil-as-EPS paper
 857                          (stack-stencils Y DOWN 0.0
 858                                          (map paper-system-stencil
 859                                               (reverse to-dump-systems)))
 860                          (format #f "~a.preview" basename)
 861                          #t)
 862     (postprocess-output book framework-ps-module
 863                         (cons "png" (ly:output-formats))
 864                         (format #f "~a.preview" basename)
 865                         (format #f "~a.preview.eps" basename)
 866                         #t
 867                         )))
 868
 869 (define-public (output-crop-framework basename book scopes fields)
 870   (let* ((paper (ly:paper-book-paper book))
 871          (systems (relevant-book-systems book)))
 872     (dump-stencil-as-EPS paper
 873                          (stack-stencils Y DOWN 0.0
 874                                          (map paper-system-stencil
 875                                               (reverse (reverse systems))))
 876                          (format #f "~a.cropped" basename)
 877                          #t)
 878     (postprocess-output book framework-ps-module
 879                         (cons "png" (ly:output-formats))
 880                         (format #f "~a.cropped" basename)
 881                         (format #f "~a.cropped.eps" basename)
 882                         #t
 883                         )))
 884
 885 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 886
 887 (define (output-width-height defs)
 888   (let* ((landscape (ly:output-def-lookup defs 'landscape))
 889          (output-scale (ly:output-def-lookup defs 'output-scale))
 890          (convert (lambda (x)
 891                     (* x output-scale (/ (ly:bp 1)))))
 892          (paper-width (convert (ly:output-def-lookup defs 'paper-width)))
 893          (paper-height (convert (ly:output-def-lookup defs 'paper-height)))
 894          (w (if landscape paper-height paper-width))
 895          (h (if landscape paper-width paper-height)))
 896     (cons w h)))
 897
 898 (define (output-resolution defs)
 899   (let ((defs-resolution (ly:output-def-lookup defs 'pngresolution)))
 900     (if (number? defs-resolution)
 901         defs-resolution
 902         (ly:get-option 'resolution))))
 903
 904 (define-public (convert-to-pdf book base-name tmp-name is-eps)
 905   (let* ((defs (ly:paper-book-paper book))
 906          (width-height (output-width-height defs))
 907          (width (car width-height))
 908          (height (cdr width-height)))
 909     (postscript->pdf width height base-name tmp-name is-eps)))
 910
 911 (define-public (convert-to-png book base-name tmp-name is-eps)
 912   (let* ((defs (ly:paper-book-paper book))
 913          (resolution (output-resolution defs))
 914          (width-height (output-width-height defs))
 915          (width (car width-height))
 916          (height (cdr width-height)))
 917     (postscript->png resolution width height base-name tmp-name is-eps)))
 918
 919 (define-public (convert-to-ps book base-name tmp-name is-eps)
 920   (postscript->ps base-name tmp-name is-eps))
 921
 922 (define-public (output-classic-framework basename book scopes fields)
 923   (ly:error (_ "\nThe PostScript backend does not support the
 924 system-by-system output.  For that, use the EPS backend instead,
 925
 926   lilypond -dbackend=eps FILE
 927
 928 If you have cut & pasted a lilypond fragment from a webpage, be sure
 929 to only remove anything before
 930
 931   %% ****************************************************************
 932   %% Start cut-&-pastable-section
 933   %% ****************************************************************
 934 ")))