Slightly delay cleanup, after rendering, in documents with large images
Currently in PDF documents with large images we immediately cleanup once rendering has finished, in order to reduce memory-usage. Normally that shouldn't be a big problem, however when e.g. repeated zooming happens in the viewer that could easily lead to a lot of wasted resources (and waiting). Hence this patch, which introduces a new `PDFPageProxy` method that will slightly delay cleanup after rendering.
This commit is contained in:
parent
e7a7f02f4c
commit
15d9faba57
@ -66,6 +66,7 @@ import { XfaText } from "./xfa_text.js";
|
|||||||
|
|
||||||
const DEFAULT_RANGE_CHUNK_SIZE = 65536; // 2^16 = 65536
|
const DEFAULT_RANGE_CHUNK_SIZE = 65536; // 2^16 = 65536
|
||||||
const RENDERING_CANCELLED_TIMEOUT = 100; // ms
|
const RENDERING_CANCELLED_TIMEOUT = 100; // ms
|
||||||
|
const DELAYED_CLEANUP_TIMEOUT = 5000; // ms
|
||||||
|
|
||||||
let DefaultCanvasFactory = DOMCanvasFactory;
|
let DefaultCanvasFactory = DOMCanvasFactory;
|
||||||
let DefaultCMapReaderFactory = DOMCMapReaderFactory;
|
let DefaultCMapReaderFactory = DOMCMapReaderFactory;
|
||||||
@ -1262,6 +1263,8 @@ class PDFDocumentProxy {
|
|||||||
* Proxy to a `PDFPage` in the worker thread.
|
* Proxy to a `PDFPage` in the worker thread.
|
||||||
*/
|
*/
|
||||||
class PDFPageProxy {
|
class PDFPageProxy {
|
||||||
|
#delayedCleanupTimeout = null;
|
||||||
|
|
||||||
#pendingCleanup = false;
|
#pendingCleanup = false;
|
||||||
|
|
||||||
constructor(pageIndex, pageInfo, transport, pdfBug = false) {
|
constructor(pageIndex, pageInfo, transport, pdfBug = false) {
|
||||||
@ -1274,7 +1277,7 @@ class PDFPageProxy {
|
|||||||
this.commonObjs = transport.commonObjs;
|
this.commonObjs = transport.commonObjs;
|
||||||
this.objs = new PDFObjects();
|
this.objs = new PDFObjects();
|
||||||
|
|
||||||
this.cleanupAfterRender = false;
|
this._maybeCleanupAfterRender = false;
|
||||||
this._intentStates = new Map();
|
this._intentStates = new Map();
|
||||||
this.destroyed = false;
|
this.destroyed = false;
|
||||||
}
|
}
|
||||||
@ -1414,8 +1417,10 @@ class PDFPageProxy {
|
|||||||
printAnnotationStorage
|
printAnnotationStorage
|
||||||
);
|
);
|
||||||
// If there was a pending destroy, cancel it so no cleanup happens during
|
// If there was a pending destroy, cancel it so no cleanup happens during
|
||||||
// this call to render.
|
// this call to render...
|
||||||
this.#pendingCleanup = false;
|
this.#pendingCleanup = false;
|
||||||
|
// ... and ensure that a delayed cleanup is always aborted.
|
||||||
|
this.#abortDelayedCleanup();
|
||||||
|
|
||||||
if (!optionalContentConfigPromise) {
|
if (!optionalContentConfigPromise) {
|
||||||
optionalContentConfigPromise = this._transport.getOptionalContentConfig();
|
optionalContentConfigPromise = this._transport.getOptionalContentConfig();
|
||||||
@ -1456,11 +1461,11 @@ class PDFPageProxy {
|
|||||||
intentState.renderTasks.delete(internalRenderTask);
|
intentState.renderTasks.delete(internalRenderTask);
|
||||||
|
|
||||||
// Attempt to reduce memory usage during *printing*, by always running
|
// Attempt to reduce memory usage during *printing*, by always running
|
||||||
// cleanup once rendering has finished (regardless of cleanupAfterRender).
|
// cleanup immediately once rendering has finished.
|
||||||
if (this.cleanupAfterRender || intentPrint) {
|
if (this._maybeCleanupAfterRender || intentPrint) {
|
||||||
this.#pendingCleanup = true;
|
this.#pendingCleanup = true;
|
||||||
}
|
}
|
||||||
this.#tryCleanup();
|
this.#tryCleanup(/* delayed = */ !intentPrint);
|
||||||
|
|
||||||
if (error) {
|
if (error) {
|
||||||
internalRenderTask.capability.reject(error);
|
internalRenderTask.capability.reject(error);
|
||||||
@ -1683,6 +1688,8 @@ class PDFPageProxy {
|
|||||||
}
|
}
|
||||||
this.objs.clear();
|
this.objs.clear();
|
||||||
this.#pendingCleanup = false;
|
this.#pendingCleanup = false;
|
||||||
|
this.#abortDelayedCleanup();
|
||||||
|
|
||||||
return Promise.all(waitOn);
|
return Promise.all(waitOn);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1695,31 +1702,53 @@ class PDFPageProxy {
|
|||||||
*/
|
*/
|
||||||
cleanup(resetStats = false) {
|
cleanup(resetStats = false) {
|
||||||
this.#pendingCleanup = true;
|
this.#pendingCleanup = true;
|
||||||
return this.#tryCleanup(resetStats);
|
const success = this.#tryCleanup(/* delayed = */ false);
|
||||||
|
|
||||||
|
if (resetStats && success) {
|
||||||
|
this._stats &&= new StatTimer();
|
||||||
|
}
|
||||||
|
return success;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Attempts to clean up if rendering is in a state where that's possible.
|
* Attempts to clean up if rendering is in a state where that's possible.
|
||||||
|
* @param {boolean} [delayed] - Delay the cleanup, to e.g. improve zooming
|
||||||
|
* performance in documents with large images.
|
||||||
|
* The default value is `false`.
|
||||||
|
* @returns {boolean} Indicates if clean-up was successfully run.
|
||||||
*/
|
*/
|
||||||
#tryCleanup(resetStats = false) {
|
#tryCleanup(delayed = false) {
|
||||||
|
this.#abortDelayedCleanup();
|
||||||
|
|
||||||
if (!this.#pendingCleanup) {
|
if (!this.#pendingCleanup) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
if (delayed) {
|
||||||
|
this.#delayedCleanupTimeout = setTimeout(() => {
|
||||||
|
this.#delayedCleanupTimeout = null;
|
||||||
|
this.#tryCleanup(/* delayed = */ false);
|
||||||
|
}, DELAYED_CLEANUP_TIMEOUT);
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
for (const { renderTasks, operatorList } of this._intentStates.values()) {
|
for (const { renderTasks, operatorList } of this._intentStates.values()) {
|
||||||
if (renderTasks.size > 0 || !operatorList.lastChunk) {
|
if (renderTasks.size > 0 || !operatorList.lastChunk) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this._intentStates.clear();
|
this._intentStates.clear();
|
||||||
this.objs.clear();
|
this.objs.clear();
|
||||||
if (resetStats && this._stats) {
|
|
||||||
this._stats = new StatTimer();
|
|
||||||
}
|
|
||||||
this.#pendingCleanup = false;
|
this.#pendingCleanup = false;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#abortDelayedCleanup() {
|
||||||
|
if (this.#delayedCleanupTimeout) {
|
||||||
|
clearTimeout(this.#delayedCleanupTimeout);
|
||||||
|
this.#delayedCleanupTimeout = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
@ -1756,7 +1785,7 @@ class PDFPageProxy {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (operatorListChunk.lastChunk) {
|
if (operatorListChunk.lastChunk) {
|
||||||
this.#tryCleanup();
|
this.#tryCleanup(/* delayed = */ true);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1814,7 +1843,7 @@ class PDFPageProxy {
|
|||||||
for (const internalRenderTask of intentState.renderTasks) {
|
for (const internalRenderTask of intentState.renderTasks) {
|
||||||
internalRenderTask.operatorListChanged();
|
internalRenderTask.operatorListChanged();
|
||||||
}
|
}
|
||||||
this.#tryCleanup();
|
this.#tryCleanup(/* delayed = */ true);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (intentState.displayReadyCapability) {
|
if (intentState.displayReadyCapability) {
|
||||||
@ -2793,7 +2822,7 @@ class WorkerTransport {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (length > MAX_IMAGE_SIZE_TO_STORE) {
|
if (length > MAX_IMAGE_SIZE_TO_STORE) {
|
||||||
pageProxy.cleanupAfterRender = true;
|
pageProxy._maybeCleanupAfterRender = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user