diff --git a/gulpfile.mjs b/gulpfile.mjs index 43bafdbf00d51..352dfcb77760f 100644 --- a/gulpfile.mjs +++ b/gulpfile.mjs @@ -543,6 +543,18 @@ function createWorkerBundle(defines) { .pipe(webpack2Stream(workerFileConfig)); } +function createRendererWorkerBundle(defines) { + const rendererWorkerFileConfig = createWebpackConfig(defines, { + filename: defines.MINIFIED ? "pdf.renderer.min.mjs" : "pdf.renderer.mjs", + library: { + type: "module", + }, + }); + return gulp + .src("./src/pdf.renderer.js", { encoding: false }) + .pipe(webpack2Stream(rendererWorkerFileConfig)); +} + function createWebBundle(defines, options) { const viewerFileConfig = createWebpackConfig(defines, { filename: "viewer.mjs", @@ -1055,6 +1067,7 @@ function buildGeneric(defines, dir) { return ordered([ createMainBundle(defines).pipe(gulp.dest(dir + "build")), createWorkerBundle(defines).pipe(gulp.dest(dir + "build")), + createRendererWorkerBundle(defines).pipe(gulp.dest(dir + "build")), createSandboxBundle(defines).pipe(gulp.dest(dir + "build")), createWebBundle(defines).pipe(gulp.dest(dir + "web")), gulp @@ -1215,6 +1228,7 @@ function buildMinified(defines, dir) { return ordered([ createMainBundle(defines).pipe(gulp.dest(dir + "build")), createWorkerBundle(defines).pipe(gulp.dest(dir + "build")), + createRendererWorkerBundle(defines).pipe(gulp.dest(dir + "build")), createSandboxBundle(defines).pipe(gulp.dest(dir + "build")), createImageDecodersBundle({ ...defines, IMAGE_DECODERS: true }).pipe( gulp.dest(dir + "image_decoders") @@ -1344,6 +1358,9 @@ gulp.task( createWorkerBundle(defines).pipe( gulp.dest(MOZCENTRAL_CONTENT_DIR + "build") ), + createRendererWorkerBundle(defines).pipe( + gulp.dest(MOZCENTRAL_CONTENT_DIR + "build") + ), createWebBundle(defines).pipe( gulp.dest(MOZCENTRAL_CONTENT_DIR + "web") ), @@ -1449,6 +1466,9 @@ gulp.task( createWorkerBundle(defines).pipe( gulp.dest(CHROME_BUILD_CONTENT_DIR + "build") ), + createRendererWorkerBundle(defines).pipe( + gulp.dest(CHROME_BUILD_CONTENT_DIR + "build") + ), createSandboxBundle(defines).pipe( gulp.dest(CHROME_BUILD_CONTENT_DIR + "build") ), diff --git a/src/core/document.js b/src/core/document.js index 9d65d04ac84ab..8269ae420db44 100644 --- a/src/core/document.js +++ b/src/core/document.js @@ -67,6 +67,7 @@ import { Catalog } from "./catalog.js"; import { clearGlobalCaches } from "./cleanup_helper.js"; import { DatasetReader } from "./dataset_reader.js"; import { Intersector } from "./intersector.js"; +import { isPDFFunction } from "./function.js"; import { Linearization } from "./parser.js"; import { ObjectLoader } from "./object_loader.js"; import { OperatorList } from "./operator_list.js"; @@ -128,10 +129,11 @@ class Page { }; } - #createPartialEvaluator(handler) { + #createPartialEvaluator(handler, rendererHandler = null) { return new PartialEvaluator({ xref: this.xref, handler, + rendererHandler, pageIndex: this.pageIndex, idFactory: this._localIdFactory, fontCache: this.fontCache, @@ -359,11 +361,21 @@ class Page { await Promise.all(promises); } - async saveNewAnnotations(handler, task, annotations, imagePromises, changes) { + async saveNewAnnotations( + handler, + task, + annotations, + imagePromises, + changes, + rendererHandler = null + ) { if (this.xfaFactory) { throw new Error("XFA: Cannot save new annotations."); } - const partialEvaluator = this.#createPartialEvaluator(handler); + const partialEvaluator = this.#createPartialEvaluator( + handler, + rendererHandler + ); const deletedAnnotations = new RefSetCache(); const existingAnnotations = new RefSet(); @@ -405,8 +417,17 @@ class Page { } } - async save(handler, task, annotationStorage, changes) { - const partialEvaluator = this.#createPartialEvaluator(handler); + async save( + handler, + task, + annotationStorage, + changes, + rendererHandler = null + ) { + const partialEvaluator = this.#createPartialEvaluator( + handler, + rendererHandler + ); // Fetch the page's annotations and save the content // in case of interactive form fields. @@ -459,6 +480,7 @@ class Page { async getOperatorList({ handler, + rendererHandler = null, sink, task, intent, @@ -471,7 +493,10 @@ class Page { const contentStreamPromise = this.getContentStream(); const resourcesPromise = this.loadResources(RESOURCES_KEYS_OPERATOR_LIST); - const partialEvaluator = this.#createPartialEvaluator(handler); + const partialEvaluator = this.#createPartialEvaluator( + handler, + rendererHandler + ); const newAnnotsByPage = !this.xfaFactory ? getNewAnnotationsMap(annotationStorage) @@ -550,12 +575,49 @@ class Page { RESOURCES_KEYS_OPERATOR_LIST ); const opList = new OperatorList(intent, sink); + + let hasFilterOps = false; + const extGState = resources.get("ExtGState"); + if (extGState instanceof Dict) { + for (const [, gState] of extGState) { + if (!(gState instanceof Dict)) { + continue; + } + + const tr = gState.get("TR"); + if (tr !== undefined) { + if (Array.isArray(tr)) { + const trArray = gState.getArray("TR") || tr; + if (!trArray.every(entry => isName(entry, "Identity"))) { + hasFilterOps = true; + break; + } + } else if (!isName(tr, "Identity")) { + hasFilterOps = true; + break; + } + } + + const sMask = gState.get("SMask"); + if (!sMask || isName(sMask, "None") || !(sMask instanceof Dict)) { + continue; + } + const sMaskType = sMask.get("S"); + const sMaskTR = sMask.get("TR"); + if (isName(sMaskType, "Luminosity") || isPDFFunction(sMaskTR)) { + hasFilterOps = true; + break; + } + } + } + handler.send("StartRenderPage", { transparency: partialEvaluator.hasBlendModes( resources, this.nonBlendModesSet ), pageIndex, + hasFilterOps, cacheKey, }); @@ -659,6 +721,7 @@ class Page { async extractTextContent({ handler, + rendererHandler = null, task, includeMarkedContent, disableNormalization, @@ -679,7 +742,10 @@ class Page { RESOURCES_KEYS_TEXT_CONTENT ); - const partialEvaluator = this.#createPartialEvaluator(handler); + const partialEvaluator = this.#createPartialEvaluator( + handler, + rendererHandler + ); return partialEvaluator.getTextContent({ stream: contentStream, @@ -726,7 +792,7 @@ class Page { return tree; } - async getAnnotationsData(handler, task, intent) { + async getAnnotationsData(handler, task, intent, rendererHandler = null) { const annotations = await this._parsedAnnotations; if (annotations.length === 0) { return annotations; @@ -751,7 +817,10 @@ class Page { } if (annotation.hasTextContent && isVisible) { - partialEvaluator ??= this.#createPartialEvaluator(handler); + partialEvaluator ??= this.#createPartialEvaluator( + handler, + rendererHandler + ); textContentPromises.push( annotation @@ -777,6 +846,7 @@ class Page { textContentPromises.push( this.extractTextContent({ handler, + rendererHandler, task, includeMarkedContent: false, disableNormalization: false, @@ -882,7 +952,8 @@ class Page { task, types, promises, - annotationGlobals + annotationGlobals, + rendererHandler = null ) { const { pageIndex } = this; @@ -916,7 +987,10 @@ class Page { } annotation.data.pageIndex = pageIndex; if (annotation.hasTextContent && annotation.viewable) { - const partialEvaluator = this.#createPartialEvaluator(handler); + const partialEvaluator = this.#createPartialEvaluator( + handler, + rendererHandler + ); await annotation.extractTextContent(partialEvaluator, task, [ -Infinity, -Infinity, @@ -1310,7 +1384,7 @@ class PDFDocument { this.xfaFactory.setImages(xfaImages); } - async #loadXfaFonts(handler, task) { + async #loadXfaFonts(handler, task, rendererHandler = null) { const acroForm = await this.pdfManager.ensureCatalog("acroForm"); if (!acroForm) { return; @@ -1336,6 +1410,7 @@ class PDFDocument { const partialEvaluator = new PartialEvaluator({ xref: this.xref, handler, + rendererHandler, pageIndex: -1, idFactory: this._globalIdFactory, fontCache, @@ -1448,9 +1523,9 @@ class PDFDocument { this.xfaFactory.appendFonts(pdfFonts, reallyMissingFonts); } - loadXfaResources(handler, task) { + loadXfaResources(handler, task, rendererHandler = null) { return Promise.all([ - this.#loadXfaFonts(handler, task).catch(() => { + this.#loadXfaFonts(handler, task, rendererHandler).catch(() => { // Ignore errors, to allow the document to load. }), this.#loadXfaImages(), @@ -1816,12 +1891,16 @@ class PDFDocument { } } - async fontFallback(id, handler) { + async fontFallback(id, handler, rendererHandler = null) { const { catalog, pdfManager } = this; for (const translatedFont of await Promise.all(catalog.fontCache)) { if (translatedFont.loadedName === id) { - translatedFont.fallback(handler, pdfManager.evaluatorOptions); + translatedFont.fallback( + handler, + pdfManager.evaluatorOptions, + rendererHandler + ); return; } } diff --git a/src/core/evaluator.js b/src/core/evaluator.js index 6a2ba2986ee9f..6d013a04d71c5 100644 --- a/src/core/evaluator.js +++ b/src/core/evaluator.js @@ -226,6 +226,7 @@ class PartialEvaluator { constructor({ xref, handler, + rendererHandler = null, pageIndex, idFactory, fontCache, @@ -238,6 +239,7 @@ class PartialEvaluator { }) { this.xref = xref; this.handler = handler; + this.rendererHandler = rendererHandler; this.pageIndex = pageIndex; this.idFactory = idFactory; this.fontCache = fontCache; @@ -554,20 +556,31 @@ class PartialEvaluator { ) { assert(Number.isInteger(imgData.dataLen), "Expected dataLen to be set."); } - const transfers = imgData ? [imgData.bitmap || imgData.data.buffer] : null; - if (this.parsingType3Font || cacheGlobally) { - return this.handler.send( - "commonobj", - [objId, "Image", imgData], - transfers + const action = this.parsingType3Font || cacheGlobally ? "commonobj" : "obj"; + + const buildArgs = data => + action === "commonobj" + ? [objId, "Image", data] + : [objId, this.pageIndex, "Image", data]; + + const getTransfers = data => { + if (!data) { + return null; + } + const transferable = data.bitmap || data.data?.buffer; + return transferable ? [transferable] : null; + }; + + if (this.rendererHandler) { + const clonedData = imgData ? structuredClone(imgData) : imgData; + this.rendererHandler.send( + action, + buildArgs(clonedData), + getTransfers(clonedData) ); } - return this.handler.send( - "obj", - [objId, this.pageIndex, "Image", imgData], - transfers - ); + this.handler.send(action, buildArgs(imgData), getTransfers(imgData)); } async buildPaintImageXObject({ @@ -802,6 +815,21 @@ class PartialEvaluator { this.globalImageCache.addByteSize(imageRef, localLength); return; } + + // ImageRef not found on main thread - check renderer worker if + // it exists + if (this.rendererHandler) { + const rendererLength = await this.rendererHandler.sendWithPromise( + "commonobj", + [objId, "CopyLocalImage", { imageRef }] + ); + + if (rendererLength) { + this.globalImageCache.setData(imageRef, globalCacheData); + this.globalImageCache.addByteSize(imageRef, rendererLength); + return; + } + } } } @@ -1024,7 +1052,7 @@ class PartialEvaluator { } state.font = translated.font; - translated.send(this.handler); + translated.send(this.handler, this.rendererHandler); return translated.loadedName; } @@ -1046,7 +1074,8 @@ class PartialEvaluator { font, glyphs, this.handler, - this.options + this.options, + this.rendererHandler ); } } @@ -1520,15 +1549,28 @@ class PartialEvaluator { id = `${this.idFactory.getDocId()}_type3_${id}`; } localShadingPatternCache.set(shading, id); - - if (this.parsingType3Font) { - const transfers = []; - const patternBuffer = PatternInfo.write(patternIR); - transfers.push(patternBuffer); - this.handler.send("commonobj", [id, "Pattern", patternBuffer], transfers); - } else { - this.handler.send("obj", [id, this.pageIndex, "Pattern", patternIR]); + const patternBuffer = PatternInfo.write(patternIR); + const action = this.parsingType3Font ? "commonobj" : "obj"; + if (this.rendererHandler) { + const clonedBuffer = patternBuffer.slice(0); + const clonedTransfers = clonedBuffer ? [clonedBuffer] : []; + this.rendererHandler.send( + action, + action === "commonobj" + ? [id, "Pattern", clonedBuffer] + : [id, this.pageIndex, "Pattern", clonedBuffer], + clonedTransfers + ); } + + const transfers = patternBuffer ? [patternBuffer] : []; + this.handler.send( + action, + action === "commonobj" + ? [id, "Pattern", patternBuffer] + : [id, this.pageIndex, "Pattern", patternBuffer], + transfers + ); return id; } @@ -1594,6 +1636,8 @@ class PartialEvaluator { localShadingPatternCache, }); if (objId) { + // Ensure that the Pattern is resolved before it's used + operatorList.addDependency(objId); const matrix = lookupMatrix(dict.getArray("Matrix"), null); operatorList.addOp(fn, ["Shading", objId, matrix]); } @@ -2148,6 +2192,7 @@ class PartialEvaluator { if (!patternId) { continue; } + operatorList.addDependency(patternId); args = [patternId]; fn = OPS.shadingFill; break; @@ -4728,7 +4773,13 @@ class PartialEvaluator { return new Font(fontName.name, fontFile, newProperties, this.options); } - static buildFontPaths(font, glyphs, handler, evaluatorOptions) { + static buildFontPaths( + font, + glyphs, + handler, + evaluatorOptions, + rendererHandler = null + ) { function buildPath(fontChar) { const glyphName = `${font.loadedName}_path_${fontChar}`; try { @@ -4736,6 +4787,14 @@ class PartialEvaluator { return; } const buffer = FontPathInfo.write(font.renderer.getPathJs(fontChar)); + if (rendererHandler) { + const clonedBuffer = buffer.slice(0); + rendererHandler.send( + "commonobj", + [glyphName, "FontPath", clonedBuffer], + [clonedBuffer] + ); + } handler.send("commonobj", [glyphName, "FontPath", buffer], [buffer]); } catch (reason) { if (evaluatorOptions.ignoreErrors) { @@ -4781,7 +4840,7 @@ class TranslatedFont { this.type3Dependencies = font.isType3Font ? new Set() : null; } - send(handler) { + send(handler, rendererHandler = null) { if (this.#sent) { return; } @@ -4795,6 +4854,18 @@ class TranslatedFont { fontData.data = FontInfo.write(fontData.data); transfer.push(fontData.data); } + if (rendererHandler) { + const clonedFontData = structuredClone(fontData); + const clonedTransfer = []; + if (clonedFontData.data) { + clonedTransfer.push(clonedFontData.data); + } + rendererHandler.send( + "commonobj", + [this.loadedName, "Font", clonedFontData], + clonedTransfer + ); + } handler.send("commonobj", [this.loadedName, "Font", fontData], transfer); // future path: switch to a SharedArrayBuffer // const sab = new SharedArrayBuffer(data.byteLength); @@ -4803,7 +4874,7 @@ class TranslatedFont { // handler.send("commonobj", [this.loadedName, "Font", sab]); } - fallback(handler, evaluatorOptions) { + fallback(handler, evaluatorOptions, rendererHandler = null) { if (!this.font.data) { return; } @@ -4819,7 +4890,8 @@ class TranslatedFont { this.font, /* glyphs = */ this.font.glyphCacheValues, handler, - evaluatorOptions + evaluatorOptions, + rendererHandler ); } diff --git a/src/core/pdf_manager.js b/src/core/pdf_manager.js index 83ea377bc47a2..1c9547119322d 100644 --- a/src/core/pdf_manager.js +++ b/src/core/pdf_manager.js @@ -113,8 +113,8 @@ class BasePdfManager { return this.pdfDocument.getPage(pageIndex); } - fontFallback(id, handler) { - return this.pdfDocument.fontFallback(id, handler); + fontFallback(id, handler, rendererHandler = null) { + return this.pdfDocument.fontFallback(id, handler, rendererHandler); } cleanup(manuallyTriggered = false) { diff --git a/src/core/worker.js b/src/core/worker.js index ae3c48be932c9..c55814202067a 100644 --- a/src/core/worker.js +++ b/src/core/worker.js @@ -83,6 +83,7 @@ class WorkerMessageHandler { static setup(handler, port) { let testMessageProcessed = false; + handler.on("test", data => { if (testMessageProcessed) { return; // we already processed 'test' message once @@ -97,10 +98,19 @@ class WorkerMessageHandler { setVerbosityLevel(data.verbosity); }); - handler.on("GetDocRequest", data => this.createDocumentHandler(data, port)); + handler.on("GetDocRequest", data => { + const { channelPort } = data; + if (channelPort) { + data.channelPort = null; + } + const rendererHandler = channelPort + ? new MessageHandler("worker-channel", "renderer-channel", channelPort) + : null; + return this.createDocumentHandler(data, port, rendererHandler); + }); } - static createDocumentHandler(docParams, port) { + static createDocumentHandler(docParams, port, rendererHandler = null) { // This context is actually holds references on pdfManager and handler, // until the latter is destroyed. let pdfManager; @@ -174,7 +184,11 @@ class WorkerMessageHandler { const task = new WorkerTask("loadXfaResources"); startWorkerTask(task); - await pdfManager.ensureDoc("loadXfaResources", [handler, task]); + await pdfManager.ensureDoc("loadXfaResources", [ + handler, + task, + rendererHandler, + ]); finishWorkerTask(task); } @@ -482,7 +496,8 @@ class WorkerMessageHandler { task, types, annotationPromises, - annotationGlobals + annotationGlobals, + rendererHandler ) || [] ); }) @@ -532,16 +547,18 @@ class WorkerMessageHandler { const task = new WorkerTask(`GetAnnotations: page ${pageIndex}`); startWorkerTask(task); - return page.getAnnotationsData(handler, task, intent).then( - data => { - finishWorkerTask(task); - return data; - }, - reason => { - finishWorkerTask(task); - throw reason; - } - ); + return page + .getAnnotationsData(handler, task, intent, rendererHandler) + .then( + data => { + finishWorkerTask(task); + return data; + }, + reason => { + finishWorkerTask(task); + throw reason; + } + ); }); }); @@ -717,7 +734,8 @@ class WorkerMessageHandler { task, annotations, imagePromises, - changes + changes, + rendererHandler ) .finally(function () { finishWorkerTask(task); @@ -763,7 +781,13 @@ class WorkerMessageHandler { startWorkerTask(task); return page - .save(handler, task, annotationStorage, changes) + .save( + handler, + task, + annotationStorage, + changes, + rendererHandler + ) .finally(function () { finishWorkerTask(task); }); @@ -865,6 +889,7 @@ class WorkerMessageHandler { page .getOperatorList({ handler, + rendererHandler, sink, task, intent: data.intent, @@ -913,6 +938,7 @@ class WorkerMessageHandler { page .extractTextContent({ handler, + rendererHandler, task, sink, includeMarkedContent, @@ -951,7 +977,11 @@ class WorkerMessageHandler { }); handler.on("FontFallback", function (data) { - return pdfManager.fontFallback(data.id, handler); + return pdfManager.fontFallback(data.id, handler, rendererHandler); + }); + + rendererHandler?.on("FontFallback", function (data) { + return pdfManager.fontFallback(data.id, handler, rendererHandler); }); handler.on("Cleanup", function (data) { @@ -982,6 +1012,9 @@ class WorkerMessageHandler { return Promise.all(waitOn).then(function () { // Notice that even if we destroying handler, resolved response promise // must be sent back. + rendererHandler?.destroy(); + rendererHandler?.comObj?.close?.(); + rendererHandler = null; handler.destroy(); handler = null; }); diff --git a/src/display/annotation_layer.js b/src/display/annotation_layer.js index d289fbd1852dc..7a2d427e91827 100644 --- a/src/display/annotation_layer.js +++ b/src/display/annotation_layer.js @@ -1267,6 +1267,9 @@ class TextAnnotationElement extends AnnotationElement { "data-l10n-args", JSON.stringify({ type: this.data.name }) ); + if (this.data.name !== "NoIcon" || this.data.hasOwnCanvas) { + this.hasOwnCommentButton = true; + } if (!this.data.popupRef && this.hasPopupData) { this.hasOwnCommentButton = true; diff --git a/src/display/api.js b/src/display/api.js index 9ffb982f0a512..a484b908209ef 100644 --- a/src/display/api.js +++ b/src/display/api.js @@ -46,12 +46,6 @@ import { RenderingCancelledException, StatTimer, } from "./display_utils.js"; -import { FontFaceObject, FontLoader } from "./font_loader.js"; -import { - FontInfo, - FontPathInfo, - PatternInfo, -} from "../shared/obj-bin-transform.js"; import { getDataProp, getFactoryUrlProp, @@ -74,6 +68,7 @@ import { DOMCMapReaderFactory } from "display-cmap_reader_factory"; import { DOMFilterFactory } from "./filter_factory.js"; import { DOMStandardFontDataFactory } from "display-standard_fontdata_factory"; import { DOMWasmFactory } from "display-wasm_factory"; +import { FontLoader } from "./font_loader.js"; import { GlobalWorkerOptions } from "./worker_options.js"; import { Metadata } from "./metadata.js"; import { OptionalContentConfig } from "./optional_content_config.js"; @@ -82,6 +77,7 @@ import { PDFFetchStream } from "display-fetch_stream"; import { PDFNetworkStream } from "display-network"; import { PDFNodeStream } from "display-node_stream"; import { PDFObjects } from "./pdf_objects.js"; +import { setupHandler } from "../shared/handle_objs.js"; import { TextLayer } from "./text_layer.js"; import { XfaText } from "./xfa_text.js"; @@ -233,6 +229,8 @@ const RENDERING_CANCELLED_TIMEOUT = 100; // ms * The default value is {DOMFilterFactory}. * @property {boolean} [enableHWA] - Enables hardware acceleration for * rendering. The default value is `false`. + * @property {boolean} [disableWorkerRendering] - Disables rendering of pages in + * a worker thread. The default value is `false`. */ /** @@ -341,6 +339,10 @@ function getDocument(src = {}) { ? NodeFilterFactory : DOMFilterFactory); const enableHWA = src.enableHWA === true; + const disableWorkerRendering = + src.disableWorkerRendering === true || + typeof Worker === "undefined" || + typeof MessageChannel === "undefined"; const useWasm = src.useWasm !== false; // Parameters whose default values depend on other parameters. @@ -396,6 +398,13 @@ function getDocument(src = {}) { : new WasmFactory({ baseUrl: wasmUrl }), }; + let rendererHandler = null; + let workerChannel = null; + + if (!disableWorkerRendering) { + workerChannel = new MessageChannel(); + } + if (!worker) { // Worker was not provided -- creating and owning our own. If message port // is specified in global worker options, using it. @@ -406,6 +415,12 @@ function getDocument(src = {}) { task._worker = worker; } + if (workerChannel) { + const renderer = new RendererWorker(workerChannel.port2, enableHWA); + rendererHandler = renderer.handler; + task.renderer = renderer; + } + const docParams = { docId, apiVersion: @@ -419,6 +434,7 @@ function getDocument(src = {}) { length, docBaseUrl, enableXfa, + channelPort: workerChannel?.port1, evaluatorOptions: { maxImageSize, disableFontFace, @@ -457,10 +473,17 @@ function getDocument(src = {}) { throw new Error("Worker was destroyed"); } + const transfers = []; + if (data) { + transfers.push(data.buffer); + } + if (workerChannel) { + transfers.push(workerChannel.port1); + } const workerIdPromise = worker.messageHandler.sendWithPromise( "GetDocRequest", docParams, - data ? [data.buffer] : null + transfers.length > 0 ? transfers : null ); let networkStream; @@ -511,7 +534,9 @@ function getDocument(src = {}) { task, networkStream, transportParams, - transportFactory + transportFactory, + enableHWA, + rendererHandler ); task._transport = transport; messageHandler.send("Ready", null); @@ -553,6 +578,8 @@ class PDFDocumentLoadingTask { */ _worker = null; + #renderer = null; + /** * Unique identifier for the document loading task. * @type {string} @@ -612,6 +639,8 @@ class PDFDocumentLoadingTask { this._worker?.destroy(); this._worker = null; + this.#renderer?.destroy(); + this.#renderer = null; } /** @@ -623,6 +652,17 @@ class PDFDocumentLoadingTask { async getData() { return this._transport.getData(); } + + get renderer() { + return this.#renderer; + } + + set renderer(renderer) { + if (this.#renderer) { + throw new Error("PDFDocumentLoadingTask.renderer: already set."); + } + this.#renderer = renderer; + } } /** @@ -1458,8 +1498,8 @@ class PDFPageProxy { * resolved when the page finishes rendering. */ render({ - canvasContext, - canvas = canvasContext.canvas, + canvasContext = null, + canvas = canvasContext?.canvas || null, viewport, intent = "display", annotationMode = AnnotationMode.ENABLE, @@ -1486,9 +1526,6 @@ class PDFPageProxy { // this call to render. this.#pendingCleanup = false; - optionalContentConfigPromise ||= - this._transport.getOptionalContentConfig(renderingIntent); - let intentState = this._intentStates.get(cacheKey); if (!intentState) { intentState = Object.create(null); @@ -1512,6 +1549,7 @@ class PDFPageProxy { argsArray: [], lastChunk: false, separateAnnots: null, + hasFilterOps: false, }; this._stats?.time("Page Request"); @@ -1571,6 +1609,18 @@ class PDFPageProxy { } }; + // Rendering in the worker cannot safely use the DOM/SVG `url(...)` filter + // path, hence we must fall back to main-thread rendering when such + // operations are present. + // Debugger rendering must also run on the main-thread. + const renderInWorker = + canvasContext === null && + this._transport.rendererHandler !== null && + !shouldRecordOperations && + !recordForDebugger && + pageColors === null && + intentState.operatorList.hasFilterOps === false; + const internalRenderTask = new InternalRenderTask({ callback: complete, // Only include the required properties, and *not* the entire object. @@ -1599,35 +1649,66 @@ class PDFPageProxy { pdfBug: this._pdfBug, pageColors, enableHWA: this._transport.enableHWA, + rendererHandler: this._transport.rendererHandler, operationsFilter, + renderInWorker, }); (intentState.renderTasks ||= new Set()).add(internalRenderTask); const renderTask = internalRenderTask.task; + let optionalContentConfigDataPromise = null; + + if (renderInWorker) { + optionalContentConfigDataPromise = + this._transport.getOptionalContentConfigData(); + } else { + optionalContentConfigPromise ||= + this._transport.getOptionalContentConfig(renderingIntent); + } + Promise.all([ intentState.displayReadyCapability.promise, optionalContentConfigPromise, + optionalContentConfigDataPromise, ]) - .then(([transparency, optionalContentConfig]) => { - if (this.destroyed) { - complete(); - return; - } - this._stats?.time("Rendering"); + .then( + ([transparency, optionalContentConfig, optionalContentConfigData]) => { + if (this.destroyed) { + complete(); + return; + } + this._stats?.time("Rendering"); + + if ( + optionalContentConfig && + !(optionalContentConfig.renderingIntent & renderingIntent) + ) { + throw new Error( + "Must use the same `intent`-argument when calling the `PDFPageProxy.render` " + + "and `PDFDocumentProxy.getOptionalContentConfig` methods." + ); + } - if (!(optionalContentConfig.renderingIntent & renderingIntent)) { - throw new Error( - "Must use the same `intent`-argument when calling the `PDFPageProxy.render` " + - "and `PDFDocumentProxy.getOptionalContentConfig` methods." - ); + const optionalContentConfigState = + renderInWorker && + optionalContentConfig && + !optionalContentConfig.hasInitialVisibility + ? Array.from(optionalContentConfig, ([id, group]) => [ + id, + group.visible, + ]) + : null; + internalRenderTask.initializeGraphics({ + transparency, + renderingIntent, + optionalContentConfig, + optionalContentConfigData, + optionalContentConfigState, + }); + internalRenderTask.operatorListChanged(); } - internalRenderTask.initializeGraphics({ - transparency, - optionalContentConfig, - }); - internalRenderTask.operatorListChanged(); - }) + ) .catch(complete); return renderTask; @@ -1680,6 +1761,7 @@ class PDFPageProxy { argsArray: [], lastChunk: false, separateAnnots: null, + hasFilterOps: false, }; this._stats?.time("Page Request"); @@ -1830,19 +1912,31 @@ class PDFPageProxy { this._intentStates.clear(); this.objs.clear(); this.#pendingCleanup = false; + + if (this._transport.rendererHandler) { + try { + this._transport.rendererHandler.send("cleanupPage", { + pageIndex: this._pageIndex, + }); + } catch { + // Ignore errors if the renderer worker has been destroyed. + } + } return true; } /** * @private */ - _startRenderPage(transparency, cacheKey) { + _startRenderPage(transparency, cacheKey, hasFilterOps = false) { const intentState = this._intentStates.get(cacheKey); if (!intentState) { return; // Rendering was cancelled. } this._stats?.timeEnd("Page Request"); + intentState.operatorList.hasFilterOps ||= hasFilterOps === true; + // TODO Refactor RenderPageRequest to separate rendering // and operator list logic intentState.displayReadyCapability?.resolve(transparency); @@ -2143,9 +2237,7 @@ class PDFWorker { #resolve() { this.#capability.resolve(); // Send global setting, e.g. verbosity level. - this.#messageHandler.send("configure", { - verbosity: this.verbosity, - }); + this.#messageHandler.send("configure", { verbosity: this.verbosity }); } /** @@ -2381,6 +2473,54 @@ class PDFWorker { } } +class RendererWorker { + #worker; + + #handler; + + #capability = Promise.withResolvers(); + + constructor(channelPort, enableHWA) { + const src = + GlobalWorkerOptions.rendererSrc || + // eslint-disable-next-line no-nested-ternary + (typeof PDFJSDev === "undefined" + ? new URL("../pdf.renderer.js", import.meta.url) + : PDFJSDev.test("MOZCENTRAL") + ? "resource://pdf.js/build/pdf.renderer.mjs" + : "../build/pdf.renderer.mjs"); + this.#worker = new Worker(src, { type: "module" }); + this.#handler = new MessageHandler("main", "renderer", this.#worker); + this.#handler.send( + "configure", + { channelPort, enableHWA }, + channelPort ? [channelPort] : undefined + ); + this.#handler.on("ready", () => { + this.#capability.resolve(); + }); + } + + /** + * Promise for worker initialization completion. + * @type {Promise} + */ + get promise() { + return this.#capability.promise; + } + + get handler() { + return this.#handler; + } + + destroy() { + this.#worker.terminate(); + this.#worker = null; + this.#handler.destroy(); + this.#handler = null; + } +} + /** * For internal use only. * @ignore @@ -2404,8 +2544,17 @@ class WorkerTransport { #pagesMapper = PagesMapper.instance; - constructor(messageHandler, loadingTask, networkStream, params, factory) { + constructor( + messageHandler, + loadingTask, + networkStream, + params, + factory, + enableHWA, + rendererHandler = null + ) { this.messageHandler = messageHandler; + this.rendererHandler = rendererHandler; this.loadingTask = loadingTask; this.#networkStream = networkStream; @@ -2596,6 +2745,14 @@ class WorkerTransport { const terminated = this.messageHandler.sendWithPromise("Terminate", null); waitOn.push(terminated); + if (this.rendererHandler) { + const terminatedRenderer = this.rendererHandler.sendWithPromise( + "Terminate", + null + ); + waitOn.push(terminatedRenderer); + } + Promise.all(waitOn).then(() => { this.commonObjs.clear(); this.fontLoader.clear(); @@ -2616,7 +2773,10 @@ class WorkerTransport { } setupMessageHandler() { - const { messageHandler, loadingTask } = this; + const { messageHandler, loadingTask, rendererHandler } = this; + rendererHandler?.on("continue", ({ taskID }) => { + InternalRenderTask.continueFnMap.get(taskID)?.(); + }); messageHandler.on("GetReader", (data, sink) => { assert( @@ -2777,113 +2937,21 @@ class WorkerTransport { } const page = this.#pageCache.get(data.pageIndex); - page._startRenderPage(data.transparency, data.cacheKey); - }); - - messageHandler.on("commonobj", ([id, type, exportedData]) => { - if (this.destroyed) { - return null; // Ignore any pending requests if the worker was terminated. - } - - if (this.commonObjs.has(id)) { - return null; - } - - switch (type) { - case "Font": - if ("error" in exportedData) { - const exportedError = exportedData.error; - warn(`Error during font loading: ${exportedError}`); - this.commonObjs.resolve(id, exportedError); - break; - } - - const fontData = new FontInfo(exportedData); - const inspectFont = - this._params.pdfBug && globalThis.FontInspector?.enabled - ? (font, url) => globalThis.FontInspector.fontAdded(font, url) - : null; - const font = new FontFaceObject( - fontData, - inspectFont, - exportedData.extra, - exportedData.charProcOperatorList - ); - - this.fontLoader - .bind(font) - .catch(() => messageHandler.sendWithPromise("FontFallback", { id })) - .finally(() => { - if (!font.fontExtraProperties && font.data) { - // Immediately release the `font.data` property once the font - // has been attached to the DOM, since it's no longer needed, - // rather than waiting for a `PDFDocumentProxy.cleanup` call. - // Since `font.data` could be very large, e.g. in some cases - // multiple megabytes, this will help reduce memory usage. - font.clearData(); - } - this.commonObjs.resolve(id, font); - }); - break; - case "CopyLocalImage": - const { imageRef } = exportedData; - assert(imageRef, "The imageRef must be defined."); - - for (const pageProxy of this.#pageCache.values()) { - for (const [, data] of pageProxy.objs) { - if (data?.ref !== imageRef) { - continue; - } - if (!data.dataLen) { - return null; - } - this.commonObjs.resolve(id, structuredClone(data)); - return data.dataLen; - } - } - break; - case "FontPath": - this.commonObjs.resolve(id, new FontPathInfo(exportedData)); - break; - case "Image": - this.commonObjs.resolve(id, exportedData); - break; - case "Pattern": - const pattern = new PatternInfo(exportedData); - this.commonObjs.resolve(id, pattern.getIR()); - break; - default: - throw new Error(`Got unknown common object type ${type}`); - } - - return null; + page._startRenderPage( + data.transparency, + data.cacheKey, + data.hasFilterOps + ); }); - messageHandler.on("obj", ([id, pageIndex, type, imageData]) => { - if (this.destroyed) { - // Ignore any pending requests if the worker was terminated. - return; - } - - const pageProxy = this.#pageCache.get(pageIndex); - if (pageProxy.objs.has(id)) { - return; - } - // Don't store data *after* cleanup has successfully run, see bug 1854145. - if (pageProxy._intentStates.size === 0) { - imageData?.bitmap?.close(); // Release any `ImageBitmap` data. - return; - } - - switch (type) { - case "Image": - case "Pattern": - pageProxy.objs.resolve(id, imageData); - break; - default: - throw new Error(`Got unknown object type ${type}`); - } - }); + setupHandler( + messageHandler, + () => this.destroyed, + this.commonObjs, + this.#pageCache, + this.fontLoader, + { pdfBug: this._params.pdfBug } + ); messageHandler.on("DocProgress", data => { if (this.destroyed) { @@ -3083,6 +3151,10 @@ class WorkerTransport { ); } + getOptionalContentConfigData() { + return this.#cacheSimpleMethod("GetOptionalContentConfig"); + } + getPermissions() { return this.messageHandler.sendWithPromise("GetPermissions", null); } @@ -3215,6 +3287,22 @@ class RenderTask { (separateAnnots.canvas && annotationCanvasMap?.size > 0) ); } + + /** + * The unique ID for this rendering task. + * @type {bigint} + */ + get taskID() { + return this._internalRenderTask.taskID; + } + + /** + * Whether rendering is happening in a worker thread. + * @type {boolean} + */ + get renderInWorker() { + return this._internalRenderTask._renderInWorker; + } } /** @@ -3226,6 +3314,10 @@ class InternalRenderTask { static #canvasInUse = new WeakSet(); + static #taskCounter = 0n; + + static continueFnMap = new Map(); + constructor({ callback, params, @@ -3240,8 +3332,11 @@ class InternalRenderTask { pdfBug = false, pageColors = null, enableHWA = false, + rendererHandler = null, operationsFilter = null, + renderInWorker = true, }) { + this.taskID = InternalRenderTask.#taskCounter++; this.callback = callback; this.params = params; this.objs = objs; @@ -3254,7 +3349,7 @@ class InternalRenderTask { this.filterFactory = filterFactory; this._pdfBug = pdfBug; this.pageColors = pageColors; - + this._enableHWA = enableHWA; this.running = false; this.graphicsReadyCallback = null; this.graphicsReady = false; @@ -3269,10 +3364,16 @@ class InternalRenderTask { this._scheduleNextBound = this._scheduleNext.bind(this); this._nextBound = this._next.bind(this); this._canvas = params.canvas; - this._canvasContext = params.canvas ? null : params.canvasContext; - this._enableHWA = enableHWA; + this._canvasContext = params.canvasContext ?? null; this._dependencyTracker = params.dependencyTracker; + this._renderInWorker = renderInWorker; + this.rendererHandler = rendererHandler; + InternalRenderTask.continueFnMap.set(this.taskID, this._continueBound); this._operationsFilter = operationsFilter; + this._sentOperatorListLength = 0; + this._executingInWorker = false; + this._pendingContinue = false; + this._endDrawingPromise = null; } get completed() { @@ -3282,7 +3383,20 @@ class InternalRenderTask { }); } - initializeGraphics({ transparency = false, optionalContentConfig }) { + #endDrawing() { + this._endDrawingPromise ||= this.rendererHandler.sendWithPromise("end", { + taskID: this.taskID, + }); + return this._endDrawingPromise; + } + + initializeGraphics({ + transparency = false, + renderingIntent, + optionalContentConfig = null, + optionalContentConfigData = null, + optionalContentConfigState = null, + }) { if (this.cancelled) { return; } @@ -3297,39 +3411,141 @@ class InternalRenderTask { InternalRenderTask.#canvasInUse.add(this._canvas); } - if (this._pdfBug && globalThis.StepperManager?.enabled) { - this.stepper = globalThis.StepperManager.create(this._pageIndex); - this.stepper.init(this.operatorList); - this.stepper.nextBreakPoint = this.stepper.getNextBreakPoint(); - } const { viewport, transform, background, dependencyTracker } = this.params; + if (this._renderInWorker) { + try { + const offscreen = this._canvas.transferControlToOffscreen(); + const taskID = this.taskID; + const rendererHandler = this.rendererHandler; + Object.defineProperty(this._canvas, "resetWorkerCanvas", { + value() { + try { + rendererHandler.send("resetCanvas", { taskID }); + } catch { + // Ignore errors if the renderer worker has been destroyed. + } + }, + configurable: true, + }); + Object.defineProperty(this._canvas, "getImageData", { + value(x, y, width, height) { + return rendererHandler.sendWithPromise("getImageData", { + taskID, + x, + y, + width, + height, + }); + }, + configurable: true, + }); + Object.defineProperty(this._canvas, "isCanvasMonochrome", { + value(x, y, width, height, color) { + return rendererHandler.sendWithPromise("isCanvasMonochrome", { + taskID, + x, + y, + width, + height, + color, + }); + }, + configurable: true, + }); + const initTransfers = [offscreen]; + const initParams = { + pageIndex: this._pageIndex, + canvas: offscreen, + colors: this.pageColors, + taskID: this.taskID, + transform, + viewport, + transparency, + background, + renderingIntent, + optionalContentConfig: optionalContentConfigData, + optionalContentConfigState, + dependencyTracker, + }; + + if (this.annotationCanvasMap) { + const annotationCanvases = []; + for (const [id, canvas] of this.annotationCanvasMap) { + try { + const annotationCanvas = canvas.transferControlToOffscreen(); + annotationCanvases.push([id, annotationCanvas]); + initTransfers.push(annotationCanvas); + } catch (ex) { + warn( + `Failed to transfer annotation canvas to worker: ${ex.message}. ` + ); + } + } + if (annotationCanvases.length > 0) { + initParams.annotationCanvases = annotationCanvases; + } else { + initParams.map = new Map(); + } + } + + this.rendererHandler.send("init", initParams, initTransfers); + } catch (ex) { + // If transferControlToOffscreen fails (e.g., canvas already + // has a context), fall back to main thread rendering + warn( + `Failed to transfer canvas control to worker: ${ex.message}. ` + + `Falling back to main thread rendering.` + ); + this._renderInWorker = false; + } + } - // When printing in Firefox, we get a specific context in mozPrintCallback - // which cannot be created from the canvas itself. - const canvasContext = - this._canvasContext || - this._canvas.getContext("2d", { - alpha: false, - willReadFrequently: !this._enableHWA, + if (!this._renderInWorker) { + let config = optionalContentConfig; + if (!config) { + config = new OptionalContentConfig( + optionalContentConfigData, + renderingIntent + ); + if (optionalContentConfigState) { + for (const [id, visible] of optionalContentConfigState) { + config.setVisibility(id, visible, /* preserveRB = */ false); + } + } + } + // When printing in Firefox, we get a specific context in mozPrintCallback + // which cannot be created from the canvas itself. In this case, we don't + // render in the worker and use the context directly. + if (this._pdfBug && globalThis.StepperManager?.enabled) { + this.stepper = globalThis.StepperManager.create(this._pageIndex); + this.stepper.init(this.operatorList); + this.stepper.nextBreakPoint = this.stepper.getNextBreakPoint(); + } + const canvasContext = + this._canvasContext || + this._canvas.getContext("2d", { + alpha: false, + willReadFrequently: !this._enableHWA, + }); + this.gfx = new CanvasGraphics( + canvasContext, + this.commonObjs, + this.objs, + this.canvasFactory, + this.filterFactory, + { optionalContentConfig: config }, + this.annotationCanvasMap, + this.pageColors, + dependencyTracker + ); + this.gfx.beginDrawing({ + transform, + viewport, + transparency, + background, }); + } - this.gfx = new CanvasGraphics( - canvasContext, - this.commonObjs, - this.objs, - this.canvasFactory, - this.filterFactory, - { optionalContentConfig }, - this.annotationCanvasMap, - this.pageColors, - dependencyTracker - ); - this.gfx.beginDrawing({ - transform, - viewport, - transparency, - background, - }); this.operatorListIdx = 0; this.graphicsReady = true; this.graphicsReadyCallback?.(); @@ -3338,7 +3554,21 @@ class InternalRenderTask { cancel(error = null, extraDelay = 0) { this.running = false; this.cancelled = true; - this.gfx?.endDrawing(); + + if (this.graphicsReady) { + if (this._renderInWorker) { + try { + if (!this._endDrawingPromise) { + this.rendererHandler?.send("end", { taskID: this.taskID }); + } + } catch { + // Ignore errors if the renderer worker has been destroyed. + } + } else { + this.gfx?.endDrawing(); + } + } + InternalRenderTask.continueFnMap.delete(this.taskID); if (this.#rAF) { window.cancelAnimationFrame(this.#rAF); this.#rAF = null; @@ -3359,18 +3589,34 @@ class InternalRenderTask { this.graphicsReadyCallback ||= this._continueBound; return; } - this.gfx.dependencyTracker?.growOperationsCount( - this.operatorList.fnArray.length - ); - this.stepper?.updateOperatorList(this.operatorList); - + if (!this._renderInWorker) { + this.gfx.dependencyTracker?.growOperationsCount( + this.operatorList.fnArray.length + ); + this.stepper?.updateOperatorList(this.operatorList); + } if (this.running) { return; } + + // For worker mode, only continue if there are operations to process + // OR if this is the last chunk (need to complete even if empty) + if ( + this._renderInWorker && + this.operatorListIdx >= this.operatorList.argsArray.length && + !this.operatorList.lastChunk + ) { + return; + } + this._continue(); } _continue() { + if (this._renderInWorker && this._executingInWorker) { + this._pendingContinue = true; + return; + } this.running = true; if (this.cancelled) { return; @@ -3397,18 +3643,82 @@ class InternalRenderTask { if (this.cancelled) { return; } - this.operatorListIdx = this.gfx.executeOperatorList( - this.operatorList, - this.operatorListIdx, - this._continueBound, - this.stepper, - this._operationsFilter - ); + + const { operatorList, operatorListIdx, taskID } = this; + if (this._renderInWorker) { + const operatorListArgsArrayLen = operatorList.argsArray.length; + + const sentLength = Math.min( + this._sentOperatorListLength, + operatorListArgsArrayLen + ); + const fnArray = + sentLength < operatorListArgsArrayLen + ? operatorList.fnArray.slice(sentLength, operatorListArgsArrayLen) + : null; + const argsArray = + sentLength < operatorListArgsArrayLen + ? operatorList.argsArray.slice(sentLength, operatorListArgsArrayLen) + : null; + this._executingInWorker = true; + try { + this.operatorListIdx = await this.rendererHandler.sendWithPromise( + "execute", + { + fnArray, + argsArray, + operatorListIdx, + taskID, + operationsFilter: this._operationsFilter, + } + ); + this._sentOperatorListLength = operatorListArgsArrayLen; + } finally { + this._executingInWorker = false; + } + if (this.cancelled) { + return; + } + + if (this._pendingContinue) { + this._pendingContinue = false; + this._continue(); + return; + } + + // The operatorList can grow on the main thread while we're waiting for + // the renderer worker. If the worker reached the end of what it was + // given, make sure that rendering continues for the new operations. + if ( + this.operatorListIdx === operatorListArgsArrayLen && + operatorListArgsArrayLen < operatorList.argsArray.length + ) { + this._continue(); + return; + } + } else { + this.operatorListIdx = this.gfx.executeOperatorList( + this.operatorList, + this.operatorListIdx, + this._continueBound, + this.stepper, + this._operationsFilter + ); + } + if (this.operatorListIdx === this.operatorList.argsArray.length) { this.running = false; if (this.operatorList.lastChunk) { - this.gfx.endDrawing(); + if (this._renderInWorker) { + await this.#endDrawing(); + if (this.cancelled) { + return; + } + } else { + this.gfx.endDrawing(); + } InternalRenderTask.#canvasInUse.delete(this._canvas); + InternalRenderTask.continueFnMap.delete(this.taskID); this.callback(); } } diff --git a/src/display/canvas_factory.js b/src/display/canvas_factory.js index 988e764859828..fbe02d27348a6 100644 --- a/src/display/canvas_factory.js +++ b/src/display/canvas_factory.js @@ -89,4 +89,14 @@ class DOMCanvasFactory extends BaseCanvasFactory { } } -export { BaseCanvasFactory, DOMCanvasFactory }; +class OffscreenCanvasFactory extends BaseCanvasFactory { + constructor({ enableHWA = false }) { + super({ enableHWA }); + } + + _createCanvas(width, height) { + return new OffscreenCanvas(width, height); + } +} + +export { BaseCanvasFactory, DOMCanvasFactory, OffscreenCanvasFactory }; diff --git a/src/display/filter_factory.js b/src/display/filter_factory.js index acec5d4093da4..e2a45ece958b0 100644 --- a/src/display/filter_factory.js +++ b/src/display/filter_factory.js @@ -49,6 +49,8 @@ class BaseFilterFactory { destroy(keepHCM = false) {} } +class WorkerFilterFactory extends BaseFilterFactory {} + /** * FilterFactory aims to create some SVG filters we can use when drawing an * image (or whatever) on a canvas. @@ -506,4 +508,4 @@ class DOMFilterFactory extends BaseFilterFactory { } } -export { BaseFilterFactory, DOMFilterFactory }; +export { BaseFilterFactory, DOMFilterFactory, WorkerFilterFactory }; diff --git a/src/display/renderer_worker.js b/src/display/renderer_worker.js new file mode 100644 index 0000000000000..ea1f2ee858340 --- /dev/null +++ b/src/display/renderer_worker.js @@ -0,0 +1,260 @@ +import { assert } from "../shared/util.js"; +import { CanvasGraphics } from "./canvas.js"; +import { FontLoader } from "./font_loader.js"; +import { MessageHandler } from "../shared/message_handler.js"; +import { OffscreenCanvasFactory } from "./canvas_factory.js"; +import { OptionalContentConfig } from "./optional_content_config.js"; +import { PDFObjects } from "./pdf_objects.js"; +import { setupHandler } from "../shared/handle_objs.js"; +import { WorkerFilterFactory } from "./filter_factory.js"; + +class RendererMessageHandler { + static #commonObjs = new PDFObjects(); + + static #objsMap = new Map(); + + static #tasks = new Map(); + + static #fontLoader = new FontLoader({ + ownerDocument: self, + }); + + static #canvasFactory; + + static #filterFactory; + + static #enableHWA = false; + + static { + this.initializeFromPort(self); + } + + static pageObjs(pageIndex) { + let objs = this.#objsMap.get(pageIndex); + if (!objs) { + objs = new PDFObjects(); + this.#objsMap.set(pageIndex, objs); + } + return objs; + } + + static initializeFromPort(port) { + let terminated = false; + let mainHandler = new MessageHandler("renderer", "main", port); + + mainHandler.on("configure", ({ channelPort, enableHWA }) => { + this.#enableHWA = enableHWA; + const workerHandler = new MessageHandler( + "renderer-channel", + "worker-channel", + channelPort + ); + this.#canvasFactory = new OffscreenCanvasFactory({ + enableHWA, + }); + this.#filterFactory = new WorkerFilterFactory(); + + setupHandler( + workerHandler, + () => terminated, + this.#commonObjs, + this.#objsMap, + this.#fontLoader, + { renderInWorker: true } + ); + }); + + mainHandler.on( + "init", + ({ + pageIndex, + canvas, + annotationCanvasMap, + colors, + taskID, + transform, + viewport, + transparency, + background, + renderingIntent, + optionalContentConfig: optionalContentConfigData, + optionalContentConfigState = null, + }) => { + assert(!this.#tasks.has(taskID), "Task already initialized"); + const ctx = canvas.getContext("2d", { + alpha: false, + willReadFrequently: !this.#enableHWA, + }); + const objs = this.pageObjs(pageIndex); + const optionalContentConfig = new OptionalContentConfig( + optionalContentConfigData, + renderingIntent + ); + if (optionalContentConfigState) { + for (const [id, visible] of optionalContentConfigState) { + optionalContentConfig.setVisibility(id, visible, false); + } + } + const gfx = new CanvasGraphics( + ctx, + this.#commonObjs, + objs, + this.#canvasFactory, + this.#filterFactory, + { optionalContentConfig }, + annotationCanvasMap, + colors + ); + gfx.beginDrawing({ transform, viewport, transparency, background }); + const operatorList = { + fnArray: [], + argsArray: [], + }; + this.#tasks.set(taskID, { + canvas, + ctx, + gfx, + pageIndex, + operatorList, + ended: false, + cleanupRequested: false, + }); + } + ); + + mainHandler.on("getImageData", ({ taskID, x, y, width, height }) => { + if (terminated) { + throw new Error("Renderer worker has been terminated."); + } + const task = this.#tasks.get(taskID); + assert(task !== undefined, "Task not initialized"); + return task.ctx.getImageData(x, y, width, height).data; + }); + + mainHandler.on( + "isCanvasMonochrome", + ({ taskID, x, y, width, height, color }) => { + if (terminated) { + throw new Error("Renderer worker has been terminated."); + } + const task = this.#tasks.get(taskID); + assert(task !== undefined, "Task not initialized"); + + const { data } = task.ctx.getImageData(x, y, width, height); + const view = new Uint32Array(data.buffer); + for (let i = 0, ii = view.length; i < ii; i++) { + if (view[i] !== color) { + return false; + } + } + return true; + } + ); + + mainHandler.on( + "execute", + ({ fnArray, argsArray, operatorListIdx, taskID, operationsFilter }) => { + if (terminated) { + throw new Error("Renderer worker has been terminated."); + } + const task = this.#tasks.get(taskID); + assert(task !== undefined, "Task not initialized"); + + if (fnArray) { + const { operatorList } = task; + const ii = fnArray.length; + for (let i = 0; i < ii; i++) { + operatorList.fnArray.push(fnArray[i]); + operatorList.argsArray.push(argsArray[i]); + } + } + + const continueFn = () => { + mainHandler.send("continue", { taskID }); + }; + + const newOperatorListIdx = task.gfx.executeOperatorList( + task.operatorList, + operatorListIdx, + continueFn, + undefined, + operationsFilter + ); + try { + task.ctx.commit?.(); + } catch { + // `commit` isn't supported in all environments. + } + return newOperatorListIdx; + } + ); + + mainHandler.on("cleanupPage", ({ pageIndex }) => { + if (terminated) { + throw new Error("Renderer worker has been terminated."); + } + + const objs = this.#objsMap.get(pageIndex); + if (!objs) { + return; + } + objs.clear(); + this.#objsMap.delete(pageIndex); + }); + + mainHandler.on("end", ({ taskID }) => { + if (terminated) { + throw new Error("Renderer worker has been terminated."); + } + const task = this.#tasks.get(taskID); + assert(task !== undefined, "Task not initialized"); + task.gfx.endDrawing(); + try { + task.ctx.commit?.(); + } catch { + // `commit` isn't supported in all environments. + } + task.ended = true; + task.gfx = null; + task.operatorList = null; + + if (task.cleanupRequested) { + task.canvas.width = task.canvas.height = 0; + this.#tasks.delete(taskID); + } + }); + + mainHandler.on("resetCanvas", ({ taskID }) => { + if (terminated) { + throw new Error("Renderer worker has been terminated."); + } + const task = this.#tasks.get(taskID); + if (!task) { + return; + } + task.cleanupRequested = true; + + if (task.ended) { + task.canvas.width = task.canvas.height = 0; + this.#tasks.delete(taskID); + } + }); + + mainHandler.on("Terminate", async () => { + terminated = true; + this.#commonObjs.clear(); + for (const objs of this.#objsMap.values()) { + objs.clear(); + } + this.#objsMap.clear(); + this.#tasks.clear(); + this.#fontLoader.clear(); + mainHandler.destroy(); + mainHandler = null; + }); + + mainHandler.send("ready", null); + } +} + +export { RendererMessageHandler }; diff --git a/src/display/worker_options.js b/src/display/worker_options.js index e4bbb81a6ea45..215e8ffd18fc1 100644 --- a/src/display/worker_options.js +++ b/src/display/worker_options.js @@ -18,6 +18,8 @@ class GlobalWorkerOptions { static #src = ""; + static #rendererSrc = ""; + /** * @type {Worker | null} */ @@ -59,6 +61,27 @@ class GlobalWorkerOptions { } this.#src = val; } + + /** + * @type {string} + */ + static get rendererSrc() { + return this.#rendererSrc; + } + + /** + * @param {string} rendererSrc - A string containing the path and filename of + * the renderer worker file. + * + * NOTE: The `rendererSrc` option should always be set, in order to prevent + * any issues when using the PDF.js library with worker rendering. + */ + static set rendererSrc(val) { + if (typeof val !== "string") { + throw new Error("Invalid `rendererSrc` type."); + } + this.#rendererSrc = val; + } } export { GlobalWorkerOptions }; diff --git a/src/pdf.renderer.js b/src/pdf.renderer.js new file mode 100644 index 0000000000000..5f16c287ce09b --- /dev/null +++ b/src/pdf.renderer.js @@ -0,0 +1,18 @@ +/* Copyright 2025 Mozilla Foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { RendererMessageHandler } from "./display/renderer_worker.js"; + +export { RendererMessageHandler }; diff --git a/src/shared/handle_objs.js b/src/shared/handle_objs.js new file mode 100644 index 0000000000000..9c2ebba5b0cb3 --- /dev/null +++ b/src/shared/handle_objs.js @@ -0,0 +1,148 @@ +import { assert, warn } from "../shared/util.js"; +import { + FontInfo, + FontPathInfo, + PatternInfo, +} from "../shared/obj-bin-transform.js"; +import { FontFaceObject } from "../display/font_loader.js"; +import { PDFObjects } from "../display/pdf_objects.js"; + +function setupHandler( + handler, + isDestroyed, + commonObjs, + pages, + fontLoader, + options = null +) { + const { pdfBug = false, renderInWorker = false } = + typeof options === "boolean" ? { renderInWorker: options } : options || {}; + const destroyed = + typeof isDestroyed === "function" ? isDestroyed : () => isDestroyed; + + handler.on("commonobj", ([id, type, exportedData]) => { + if (destroyed()) { + return null; // Ignore any pending requests if the worker was terminated. + } + + if (commonObjs.has(id)) { + return null; + } + + switch (type) { + case "Font": + if ("error" in exportedData) { + const exportedError = exportedData.error; + warn(`Error during font loading: ${exportedError}`); + commonObjs.resolve(id, exportedError); + break; + } + + const fontData = new FontInfo(exportedData); + const inspectFont = + pdfBug && globalThis.FontInspector?.enabled + ? (font, url) => globalThis.FontInspector.fontAdded(font, url) + : null; + const font = new FontFaceObject( + fontData, + inspectFont, + exportedData.extra, + exportedData.charProcOperatorList + ); + + fontLoader + .bind(font) + .catch(() => + handler.sendWithPromise("FontFallback", { id, renderInWorker }) + ) + .finally(() => { + if (!font.fontExtraProperties && font.data) { + // Immediately release the `font.data` property once the font + // has been attached to the DOM, since it's no longer needed, + // rather than waiting for a `PDFDocumentProxy.cleanup` call. + // Since `font.data` could be very large, e.g. in some cases + // multiple megabytes, this will help reduce memory usage. + font.clearData(); + } + commonObjs.resolve(id, font); + }); + break; + case "CopyLocalImage": + const { imageRef } = exportedData; + assert(imageRef, "The imageRef must be defined."); + + for (const pageOrObjs of pages.values()) { + const objs = pageOrObjs.objs || pageOrObjs; + for (const [, data] of objs) { + if (data?.ref !== imageRef) { + continue; + } + if (!data.dataLen) { + return null; + } + commonObjs.resolve(id, structuredClone(data)); + return data.dataLen; + } + } + break; + case "FontPath": + commonObjs.resolve(id, new FontPathInfo(exportedData)); + break; + case "Image": + commonObjs.resolve(id, exportedData); + break; + case "Pattern": + const pattern = new PatternInfo(exportedData); + commonObjs.resolve(id, pattern.getIR()); + break; + default: + throw new Error(`Got unknown common object type ${type}`); + } + + return null; + }); + + handler.on("obj", ([id, pageIndex, type, imageData]) => { + if (destroyed()) { + // Ignore any pending requests if the worker was terminated. + return; + } + + let pageOrObjs = pages.get(pageIndex); + if (!pageOrObjs) { + // Do not discard the objects if we're rendering in the worker. + if (renderInWorker) { + pageOrObjs = new PDFObjects(); + pages.set(pageIndex, pageOrObjs); + } else { + return; + } + } + + const objs = pageOrObjs.objs || pageOrObjs; + + if (objs.has(id)) { + return; + } + // Don't store data *after* cleanup has successfully run, see bug 1854145. + // Only check _intentStates if this is a page object + if (pageOrObjs._intentStates?.size === 0) { + imageData?.bitmap?.close(); // Release any `ImageBitmap` data. + return; + } + + switch (type) { + case "Image": + objs.resolve(id, imageData); + break; + case "Pattern": + const pattern = new PatternInfo(imageData); + objs.resolve(id, pattern.getIR()); + break; + default: + throw new Error(`Got unknown object type ${type}`); + } + }); +} + +export { setupHandler }; diff --git a/src/shared/message_handler.js b/src/shared/message_handler.js index a1af0aab27b54..633534087deda 100644 --- a/src/shared/message_handler.js +++ b/src/shared/message_handler.js @@ -90,6 +90,7 @@ class MessageHandler { comObj.addEventListener("message", this.#onMessage.bind(this), { signal: this.#messageAC.signal, }); + comObj.start?.(); } #onMessage({ data }) { diff --git a/test/driver.js b/test/driver.js index 612832b0951c1..b640f5d08712e 100644 --- a/test/driver.js +++ b/test/driver.js @@ -38,11 +38,14 @@ const IMAGE_RESOURCES_PATH = "/web/images/"; const VIEWER_CSS = "../build/components/pdf_viewer.css"; const VIEWER_LOCALE = "en-US"; const WORKER_SRC = "../build/generic/build/pdf.worker.mjs"; +const RENDERER_SRC = "../build/generic/build/pdf.renderer.mjs"; const RENDER_TASK_ON_CONTINUE_DELAY = 5; // ms const SVG_NS = "http://www.w3.org/2000/svg"; const md5FileMap = new Map(); +GlobalWorkerOptions.rendererSrc = RENDERER_SRC; + function loadStyles(styles) { const promises = []; @@ -487,6 +490,7 @@ class Driver { constructor(options) { // Configure the global worker options. GlobalWorkerOptions.workerSrc = WORKER_SRC; + GlobalWorkerOptions.rendererSrc = RENDERER_SRC; // We only need to initialize the `L10n`-instance here, since translation is // triggered by a `MutationObserver`; see e.g. `Rasterize.annotationLayer`. @@ -510,6 +514,9 @@ class Driver { // Create a working canvas this.canvas = document.createElement("canvas"); + // Used as the render-target when testing `renderInWorker`, since a canvas + // can only be transferred once using `transferControlToOffscreen`. + this.renderCanvas = null; } run() { @@ -1066,8 +1073,23 @@ class Driver { initPromise = Promise.resolve(); } } + // Render into a separate canvas to allow + // `transferControlToOffscreen` + if (partialCrop) { + // Rendering directly into `this.canvas` is required to support + // `recordOperations` and cropping operations. + this.renderCanvas = this.canvas; + } else { + this.renderCanvas = document.createElement("canvas"); + this.renderCanvas.width = pixelWidth; + this.renderCanvas.height = pixelHeight; + this.renderCanvas.style.width = this.canvas.style.width; + this.renderCanvas.style.height = this.canvas.style.height; + } + const renderCanvas = this.renderCanvas; + const renderContext = { - canvas: this.canvas, + canvas: renderCanvas, viewport, optionalContentConfigPromise: task.optionalContentConfigPromise, annotationCanvasMap, @@ -1087,6 +1109,14 @@ class Driver { } const completeRender = error => { + if (renderCanvas !== this.canvas) { + try { + ctx.drawImage(renderCanvas, 0, 0); + } catch (ex) { + this._info(`Unable to copy the render canvas: ${ex}`); + } + renderCanvas.resetWorkerCanvas?.(); + } // if text layer is present, compose it on top of the page if (textLayerCanvas) { if (task.type === "text") { @@ -1127,6 +1157,9 @@ class Driver { await renderTask.promise; if (partialCrop) { + // Since the renderer worker isn't used for the partial tests, + // it's safe to obtain a 2D context here. + ctx = this.canvas.getContext("2d", { alpha: false }); const clearOutsidePartial = () => { const { width, height } = ctx.canvas; // Everything above the partial area @@ -1161,7 +1194,7 @@ class Driver { clearOutsidePartial(); const baseline = ctx.canvas.toDataURL("image/png"); - this._clearCanvas(); + ctx.clearRect(0, 0, ctx.canvas.width, ctx.canvas.height); const recordedBBoxes = page.recordedBBoxes; diff --git a/test/integration/test_utils.mjs b/test/integration/test_utils.mjs index f7d0785daf07f..d2051001a0ac0 100644 --- a/test/integration/test_utils.mjs +++ b/test/integration/test_utils.mjs @@ -874,20 +874,27 @@ function waitForNoElement(page, selector) { function isCanvasMonochrome(page, pageNumber, rectangle, color) { return page.evaluate( - (rect, pageN, col) => { + async (rect, pageN, col) => { const canvas = document.querySelector( `.page[data-page-number = "${pageN}"] .canvasWrapper canvas` ); const canvasRect = canvas.getBoundingClientRect(); - const ctx = canvas.getContext("2d"); rect ||= canvasRect; - const { data } = ctx.getImageData( - rect.x - canvasRect.x, - rect.y - canvasRect.y, - rect.width, - rect.height - ); - return new Uint32Array(data.buffer).every(x => x === col); + const x = rect.x - canvasRect.x; + const y = rect.y - canvasRect.y; + const { width, height } = rect; + + try { + const ctx = canvas.getContext("2d"); + const { data } = ctx.getImageData(x, y, width, height); + return new Uint32Array(data.buffer).every(v => v === col); + } catch (ex) { + const isMonochrome = canvas.isCanvasMonochrome; + if (typeof isMonochrome !== "function") { + throw ex; + } + return isMonochrome(x, y, width, height, col); + } }, rectangle, pageNumber, diff --git a/test/integration/viewer_spec.mjs b/test/integration/viewer_spec.mjs index 68f5e69c703ff..ff2752d5fabd1 100644 --- a/test/integration/viewer_spec.mjs +++ b/test/integration/viewer_spec.mjs @@ -480,23 +480,35 @@ describe("PDF viewer", () => { }; } - function extractCanvases(pageNumber) { + async function extractCanvases(pageNumber) { const pageOne = document.querySelector( `.page[data-page-number='${pageNumber}']` ); - return Array.from(pageOne.querySelectorAll("canvas"), canvas => { - const { width, height } = canvas; - const ctx = canvas.getContext("2d"); - const topLeft = ctx.getImageData(2, 2, 1, 1).data; - const bottomRight = ctx.getImageData(width - 3, height - 3, 1, 1).data; - return { - size: width * height, - width, - height, - topLeft: globalThis.pdfjsLib.Util.makeHexColor(...topLeft), - bottomRight: globalThis.pdfjsLib.Util.makeHexColor(...bottomRight), - }; - }); + return Promise.all( + Array.from(pageOne.querySelectorAll("canvas"), async canvas => { + const { width, height } = canvas; + let topLeft, bottomRight; + try { + const ctx = canvas.getContext("2d"); + topLeft = ctx.getImageData(2, 2, 1, 1).data; + bottomRight = ctx.getImageData(width - 3, height - 3, 1, 1).data; + } catch (ex) { + const getImageData = canvas.getImageData; + if (typeof getImageData !== "function") { + throw ex; + } + topLeft = await getImageData(2, 2, 1, 1); + bottomRight = await getImageData(width - 3, height - 3, 1, 1); + } + return { + size: width * height, + width, + height, + topLeft: globalThis.pdfjsLib.Util.makeHexColor(...topLeft), + bottomRight: globalThis.pdfjsLib.Util.makeHexColor(...bottomRight), + }; + }) + ); } function waitForDetailRendered(page) { diff --git a/test/unit/jasmine-boot.js b/test/unit/jasmine-boot.js index 73abbf9f0d6bd..f37769e8ae5be 100644 --- a/test/unit/jasmine-boot.js +++ b/test/unit/jasmine-boot.js @@ -111,6 +111,8 @@ async function initializePDFJS(callback) { } // Configure the worker. GlobalWorkerOptions.workerSrc = "../../build/generic/build/pdf.worker.mjs"; + GlobalWorkerOptions.rendererSrc = + "../../build/generic/build/pdf.renderer.mjs"; callback(); } diff --git a/web/base_pdf_page_view.js b/web/base_pdf_page_view.js index c37b5e4e22c51..27c37a33a3da9 100644 --- a/web/base_pdf_page_view.js +++ b/web/base_pdf_page_view.js @@ -48,6 +48,12 @@ class BasePDFPageView extends RenderableView { renderingQueue = null; + renderTask = null; + + renderTaskID = null; + + resume = null; + constructor(options) { super(); this.eventBus = options.eventBus; @@ -116,12 +122,18 @@ class BasePDFPageView extends RenderableView { this.#showCanvas = isLastShow => { if (updateOnFirstShow) { let tempCanvas = this.#tempCanvas; - if (!isLastShow && this.#minDurationToUpdateCanvas > 0) { + if ( + !isLastShow && + this.#minDurationToUpdateCanvas > 0 && + !this.renderTask?.renderInWorker + ) { // We draw on the canvas at 60fps (in using `requestAnimationFrame`), // so if the canvas is large, updating it at 60fps can be a way too // much and can cause some serious performance issues. // To avoid that we only update the canvas every // `this.#minDurationToUpdateCanvas` ms. + // When rendering in worker, we don't need this optimization because + // the rendering is already happening off the main thread. if (Date.now() - this.#startTime < this.#minDurationToUpdateCanvas) { return; @@ -145,7 +157,6 @@ class BasePDFPageView extends RenderableView { } return; } - // Don't add the canvas until the first draw callback, or until // drawing is complete when `!this.renderingQueue`, to prevent black // flickering. @@ -159,7 +170,12 @@ class BasePDFPageView extends RenderableView { if (prevCanvas) { prevCanvas.replaceWith(canvas); - prevCanvas.width = prevCanvas.height = 0; + const resetWorkerCanvas = prevCanvas.resetWorkerCanvas; + if (typeof resetWorkerCanvas === "function") { + resetWorkerCanvas(); + } else { + prevCanvas.width = prevCanvas.height = 0; + } } else { onShow(canvas); } @@ -187,7 +203,12 @@ class BasePDFPageView extends RenderableView { return; } canvas.remove(); - canvas.width = canvas.height = 0; + const resetWorkerCanvas = canvas.resetWorkerCanvas; + if (typeof resetWorkerCanvas === "function") { + resetWorkerCanvas(); + } else { + canvas.width = canvas.height = 0; + } this.canvas = null; this.#resetTempCanvas(); } @@ -209,6 +230,8 @@ class BasePDFPageView extends RenderableView { } }; + this.renderTaskID = renderTask.taskID; + let error = null; try { await renderTask.promise; diff --git a/web/pdf_page_detail_view.js b/web/pdf_page_detail_view.js index eda8d5ceacf18..948b2a66da796 100644 --- a/web/pdf_page_detail_view.js +++ b/web/pdf_page_detail_view.js @@ -293,7 +293,12 @@ class PDFPageDetailView extends BasePDFPageView { this._getRenderingContext(canvas, transform), () => { // If the rendering is cancelled, keep the old canvas visible. - this.canvas?.remove(); + const discardedCanvas = this.canvas; + const resetWorkerCanvas = discardedCanvas?.resetWorkerCanvas; + if (typeof resetWorkerCanvas === "function") { + resetWorkerCanvas(); + } + discardedCanvas?.remove(); this.canvas = prevCanvas; }, () => { diff --git a/web/pdf_page_view.js b/web/pdf_page_view.js index 37e888ffb6f91..0ea1f4570b182 100644 --- a/web/pdf_page_view.js +++ b/web/pdf_page_view.js @@ -1091,6 +1091,10 @@ class PDFPageView extends BasePDFPageView { const resultPromise = this._drawCanvas( this._getRenderingContext(canvas, transform, recordBBoxes), () => { + const resetWorkerCanvas = prevCanvas?.resetWorkerCanvas; + if (typeof resetWorkerCanvas === "function") { + resetWorkerCanvas(); + } prevCanvas?.remove(); this._resetCanvas(); }, diff --git a/web/pdf_thumbnail_view.js b/web/pdf_thumbnail_view.js index 706febbbedfa3..444d8a7a986ef 100644 --- a/web/pdf_thumbnail_view.js +++ b/web/pdf_thumbnail_view.js @@ -305,6 +305,7 @@ class PDFThumbnailView extends RenderableView { }; const renderContext = { + canvasContext: canvas.getContext("2d", { alpha: false }), canvas, transform, viewport: drawViewport, @@ -319,6 +320,12 @@ class PDFThumbnailView extends RenderableView { await renderTask.promise; } catch (e) { if (e instanceof RenderingCancelledException) { + const resetWorkerCanvas = canvas.resetWorkerCanvas; + if (typeof resetWorkerCanvas === "function") { + resetWorkerCanvas(); + } else { + canvas.width = canvas.height = 0; + } return; } error = e; @@ -333,6 +340,12 @@ class PDFThumbnailView extends RenderableView { this.renderingState = RenderingStates.FINISHED; await this.#convertCanvasToImage(canvas); + const resetWorkerCanvas = canvas.resetWorkerCanvas; + if (typeof resetWorkerCanvas === "function") { + resetWorkerCanvas(); + } else { + canvas.width = canvas.height = 0; + } this.eventBus.dispatch("thumbnailrendered", { source: this,