1.1.0

轉換流程

最後更新


本頁說明 convert() 如何把 PDF 頁面渲染成圖片,以及解析度、輸出格式與失敗時的實際行為。

流程


  1. 設定 pdfjsLib.GlobalWorkerOptions.workerSrc 為 cdnjs 上的 pdf.worker.js
  2. 以 getDocument() 解析 file,CMap 從 cdnjs 取得(處理 CJK 等字型編碼)
  3. 解析成功後在 <body> 附加進度遮罩
  4. 所有頁面同時建立 canvas 並渲染,每完成一頁就把 Data URL 推入結果陣列並更新進度
  5. 全部完成後延遲 500ms,resolve 結果陣列並移除遮罩

解析度:scale


輸出像素尺寸 = PDF 頁面尺寸(pt)× scale。預設 1.5;US Letter(612×792 pt)在 scale: 1 時輸出 612×792,在預設值時輸出 918×1188。
  1. <script>
  2. const sample = async () => (await fetch("/assets/sample.pdf")).arrayBuffer();
  3. const size = src => new Promise(r => {
  4. const img = new Image();
  5. img.onload = () => r(img.width + "x" + img.height);
  6. img.src = src;
  7. });
  8. addEventListener("load", async () => {
  9. for (const scale of [0.5, 1, 1.5]) {
  10. const [first] = await new pdf2image({ file: await sample(), type: "png", scale }).convert();
  11. console.log("scale", scale, "->", await size(first));
  12. }
  13. });
  14. </script>
即時預覽 · @pardnchiu/pdf2image@1.1.2

輸出格式:type


type 只接受 png、jpg、webp,其他值回退為 jpg。結果由 canvas.toDataURL("image/" + type) 產生,因此:
type傳給 toDataURL實際輸出
pngimage/pngPNG
webpimage/webpWebP(瀏覽器不支援時為 PNG)
jpg(預設)image/jpgPNG:瀏覽器只認 image/jpeg,不認得的 MIME 一律回退 PNG

因此使用預設 type 時,每個 Data URL 都以 data:image/png 開頭。
  1. <script>
  2. addEventListener("load", async () => {
  3. for (const type of ["png", "jpg", "webp", "gif"]) {
  4. const buffer = await (await fetch("/assets/sample.pdf")).arrayBuffer();
  5. const [first] = await new pdf2image({ file: buffer, type, scale: 0.5 }).convert();
  6. console.log(type.padEnd(4), "->", first.slice(0, first.indexOf(";")));
  7. }
  8. });
  9. </script>
即時預覽 · @pardnchiu/pdf2image@1.1.2

結果順序


頁面是併發渲染,結果在「每頁完成時」依序推入陣列,而非依頁碼寫入對應位置。頁面複雜度差異大時,images[0] 不保證是第 1 頁。

file 只能用一次


pdf.js 會把傳入的 ArrayBuffer 轉移(transfer)給 worker,轉換後原 buffer 的 byteLength 變成 0。因此:
  • 同一個實例第二次呼叫 convert() 會以 TypeError reject,訊息為「Cannot perform Construct on a detached ArrayBuffer」;已轉換的 images 不受影響
  • 同一個 buffer 不能再交給另一個實例;需要重轉時重新讀取檔案

  1. <script>
  2. addEventListener("load", async () => {
  3. const buffer = await (await fetch("/assets/sample.pdf")).arrayBuffer();
  4. const converter = new pdf2image({ file: buffer, type: "png", scale: 0.5 });
  5. console.log("first:", (await converter.convert()).length, "pages");
  6. console.log("buffer byteLength:", buffer.byteLength);
  7. try {
  8. await converter.convert();
  9. } catch (err) {
  10. console.log("second:", String(err));
  11. }
  12. console.log("images kept:", converter.images.length);
  13. });
  14. </script>
即時預覽 · @pardnchiu/pdf2image@1.1.2

失敗行為


情境reject 的值
未提供 file字串 "error The PDF file is empty, i.e. its size is zero bytes."
不是有效的 PDF字串 "error Invalid PDF structure."
頁面渲染失敗字串 "error i is not defined":錯誤處理引用了不存在的變數,原始錯誤訊息遺失
重複使用已轉移的 bufferTypeError 物件
pdf.js 尚未載入ReferenceError 物件(見 核心概念)

reject 值有字串也有 Error,以 String(err) 處理可涵蓋兩者。pdf.js 載入失敗時,套件本身也會呼叫 console.error("error", err)。
  1. <script>
  2. addEventListener("load", async () => {
  3. const cases = { "no file": {}, "not a pdf": { file: new TextEncoder().encode("hello").buffer } };
  4. for (const [name, options] of Object.entries(cases)) {
  5. try {
  6. await new pdf2image(options).convert();
  7. } catch (err) {
  8. console.log(name, "->", typeof err, String(err));
  9. }
  10. }
  11. });
  12. </script>
即時預覽 · @pardnchiu/pdf2image@1.1.2

相關頁面


EN