/* Copyright 2012 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 { createPromiseCapability, RenderingCancelledException } from 'pdfjs-lib'; import { getOutputScale, NullL10n } from './ui_utils'; import { RenderingStates } from './pdf_rendering_queue'; const MAX_NUM_SCALING_STEPS = 3; const THUMBNAIL_CANVAS_BORDER_WIDTH = 1; // px const THUMBNAIL_WIDTH = 98; // px /** * @typedef {Object} PDFThumbnailViewOptions * @property {HTMLDivElement} container - The viewer element. * @property {number} id - The thumbnail's unique ID (normally its number). * @property {PageViewport} defaultViewport - The page viewport. * @property {IPDFLinkService} linkService - The navigation/linking service. * @property {PDFRenderingQueue} renderingQueue - The rendering queue object. * @property {boolean} disableCanvasToImageConversion - (optional) Don't convert * the canvas thumbnails to images. This prevents `toDataURL` calls, * but increases the overall memory usage. The default value is `false`. * @property {IL10n} l10n - Localization service. */ const TempImageFactory = (function TempImageFactoryClosure() { let tempCanvasCache = null; return { getCanvas(width, height) { let tempCanvas = tempCanvasCache; if (!tempCanvas) { tempCanvas = document.createElement('canvas'); tempCanvasCache = tempCanvas; } tempCanvas.width = width; tempCanvas.height = height; // Since this is a temporary canvas, we need to fill it with a white // background ourselves. `_getPageDrawContext` uses CSS rules for this. if (typeof PDFJSDev === 'undefined' || PDFJSDev.test('MOZCENTRAL || FIREFOX || GENERIC')) { tempCanvas.mozOpaque = true; } let ctx = tempCanvas.getContext('2d', { alpha: false, }); ctx.save(); ctx.fillStyle = 'rgb(255, 255, 255)'; ctx.fillRect(0, 0, width, height); ctx.restore(); return tempCanvas; }, destroyCanvas() { let tempCanvas = tempCanvasCache; if (tempCanvas) { // Zeroing the width and height causes Firefox to release graphics // resources immediately, which can greatly reduce memory consumption. tempCanvas.width = 0; tempCanvas.height = 0; } tempCanvasCache = null; }, }; })(); /** * @implements {IRenderableView} */ class PDFThumbnailView { /** * @param {PDFThumbnailViewOptions} options */ constructor({ container, id, defaultViewport, linkService, renderingQueue, disableCanvasToImageConversion = false, l10n = NullL10n, }) { this.id = id; this.renderingId = 'thumbnail' + id; this.pageLabel = null; this.pdfPage = null; this.rotation = 0; this.viewport = defaultViewport; this.pdfPageRotate = defaultViewport.rotation; this.linkService = linkService; this.renderingQueue = renderingQueue; this.renderTask = null; this.renderingState = RenderingStates.INITIAL; this.resume = null; this.disableCanvasToImageConversion = disableCanvasToImageConversion; this.pageWidth = this.viewport.width; this.pageHeight = this.viewport.height; this.pageRatio = this.pageWidth / this.pageHeight; this.canvasWidth = THUMBNAIL_WIDTH; this.canvasHeight = (this.canvasWidth / this.pageRatio) | 0; this.scale = this.canvasWidth / this.pageWidth; this.l10n = l10n; let anchor = document.createElement('a'); anchor.href = linkService.getAnchorUrl('#page=' + id); this.l10n.get('thumb_page_title', { page: id, }, 'Page {{page}}'). then((msg) => { anchor.title = msg; }); anchor.onclick = function() { linkService.page = id; return false; }; this.anchor = anchor; let div = document.createElement('div'); div.className = 'thumbnail'; div.setAttribute('data-page-number', this.id); this.div = div; let ring = document.createElement('div'); ring.className = 'thumbnailSelectionRing'; let borderAdjustment = 2 * THUMBNAIL_CANVAS_BORDER_WIDTH; ring.style.width = this.canvasWidth + borderAdjustment + 'px'; ring.style.height = this.canvasHeight + borderAdjustment + 'px'; this.ring = ring; div.appendChild(ring); anchor.appendChild(div); container.appendChild(anchor); } setPdfPage(pdfPage) { this.pdfPage = pdfPage; this.pdfPageRotate = pdfPage.rotate; let totalRotation = (this.rotation + this.pdfPageRotate) % 360; this.viewport = pdfPage.getViewport({ scale: 1, rotation: totalRotation, }); this.reset(); } reset() { this.cancelRendering(); this.renderingState = RenderingStates.INITIAL; this.pageWidth = this.viewport.width; this.pageHeight = this.viewport.height; this.pageRatio = this.pageWidth / this.pageHeight; this.canvasHeight = (this.canvasWidth / this.pageRatio) | 0; this.scale = (this.canvasWidth / this.pageWidth); this.div.removeAttribute('data-loaded'); let ring = this.ring; let childNodes = ring.childNodes; for (let i = childNodes.length - 1; i >= 0; i--) { ring.removeChild(childNodes[i]); } let borderAdjustment = 2 * THUMBNAIL_CANVAS_BORDER_WIDTH; ring.style.width = this.canvasWidth + borderAdjustment + 'px'; ring.style.height = this.canvasHeight + borderAdjustment + 'px'; if (this.canvas) { // Zeroing the width and height causes Firefox to release graphics // resources immediately, which can greatly reduce memory consumption. this.canvas.width = 0; this.canvas.height = 0; delete this.canvas; } if (this.image) { this.image.removeAttribute('src'); delete this.image; } } update(rotation) { if (typeof rotation !== 'undefined') { this.rotation = rotation; } let totalRotation = (this.rotation + this.pdfPageRotate) % 360; this.viewport = this.viewport.clone({ scale: 1, rotation: totalRotation, }); this.reset(); } /** * PLEASE NOTE: Most likely you want to use the `this.reset()` method, * rather than calling this one directly. */ cancelRendering() { if (this.renderTask) { this.renderTask.cancel(); this.renderTask = null; } this.resume = null; } /** * @private */ _getPageDrawContext(noCtxScale = false) { let canvas = document.createElement('canvas'); // Keep the no-thumbnail outline visible, i.e. `data-loaded === false`, // until rendering/image conversion is complete, to avoid display issues. this.canvas = canvas; if (typeof PDFJSDev === 'undefined' || PDFJSDev.test('MOZCENTRAL || FIREFOX || GENERIC')) { canvas.mozOpaque = true; } let ctx = canvas.getContext('2d', { alpha: false, }); let outputScale = getOutputScale(ctx); canvas.width = (this.canvasWidth * outputScale.sx) | 0; canvas.height = (this.canvasHeight * outputScale.sy) | 0; canvas.style.width = this.canvasWidth + 'px'; canvas.style.height = this.canvasHeight + 'px'; if (!noCtxScale && outputScale.scaled) { ctx.scale(outputScale.sx, outputScale.sy); } return ctx; } /** * @private */ _convertCanvasToImage() { if (!this.canvas) { return; } if (this.renderingState !== RenderingStates.FINISHED) { return; } let id = this.renderingId; let className = 'thumbnailImage'; if (this.disableCanvasToImageConversion) { this.canvas.id = id; this.canvas.className = className; this.l10n.get('thumb_page_canvas', { page: this.pageId, }, 'Thumbnail of Page {{page}}').then((msg) => { this.canvas.setAttribute('aria-label', msg); }); this.div.setAttribute('data-loaded', true); this.ring.appendChild(this.canvas); return; } let image = document.createElement('img'); image.id = id; image.className = className; this.l10n.get('thumb_page_canvas', { page: this.pageId, }, 'Thumbnail of Page {{page}}'). then((msg) => { image.setAttribute('aria-label', msg); }); image.style.width = this.canvasWidth + 'px'; image.style.height = this.canvasHeight + 'px'; image.src = this.canvas.toDataURL(); this.image = image; this.div.setAttribute('data-loaded', true); this.ring.appendChild(image); // Zeroing the width and height causes Firefox to release graphics // resources immediately, which can greatly reduce memory consumption. this.canvas.width = 0; this.canvas.height = 0; delete this.canvas; } draw() { if (this.renderingState !== RenderingStates.INITIAL) { console.error('Must be in new state before drawing'); return Promise.resolve(undefined); } this.renderingState = RenderingStates.RUNNING; let renderCapability = createPromiseCapability(); let finishRenderTask = (error) => { // The renderTask may have been replaced by a new one, so only remove // the reference to the renderTask if it matches the one that is // triggering this callback. if (renderTask === this.renderTask) { this.renderTask = null; } if (error instanceof RenderingCancelledException) { renderCapability.resolve(undefined); return; } this.renderingState = RenderingStates.FINISHED; this._convertCanvasToImage(); if (!error) { renderCapability.resolve(undefined); } else { renderCapability.reject(error); } }; let ctx = this._getPageDrawContext(); let drawViewport = this.viewport.clone({ scale: this.scale, }); let renderContinueCallback = (cont) => { if (!this.renderingQueue.isHighestPriority(this)) { this.renderingState = RenderingStates.PAUSED; this.resume = () => { this.renderingState = RenderingStates.RUNNING; cont(); }; return; } cont(); }; let renderContext = { canvasContext: ctx, viewport: drawViewport, }; let renderTask = this.renderTask = this.pdfPage.render(renderContext); renderTask.onContinue = renderContinueCallback; renderTask.promise.then(function() { finishRenderTask(null); }, function(error) { finishRenderTask(error); }); return renderCapability.promise; } setImage(pageView) { if (this.renderingState !== RenderingStates.INITIAL) { return; } let img = pageView.canvas; if (!img) { return; } if (!this.pdfPage) { this.setPdfPage(pageView.pdfPage); } this.renderingState = RenderingStates.FINISHED; let ctx = this._getPageDrawContext(true); let canvas = ctx.canvas; if (img.width <= 2 * canvas.width) { ctx.drawImage(img, 0, 0, img.width, img.height, 0, 0, canvas.width, canvas.height); this._convertCanvasToImage(); return; } // drawImage does an awful job of rescaling the image, doing it gradually. let reducedWidth = canvas.width << MAX_NUM_SCALING_STEPS; let reducedHeight = canvas.height << MAX_NUM_SCALING_STEPS; let reducedImage = TempImageFactory.getCanvas(reducedWidth, reducedHeight); let reducedImageCtx = reducedImage.getContext('2d'); while (reducedWidth > img.width || reducedHeight > img.height) { reducedWidth >>= 1; reducedHeight >>= 1; } reducedImageCtx.drawImage(img, 0, 0, img.width, img.height, 0, 0, reducedWidth, reducedHeight); while (reducedWidth > 2 * canvas.width) { reducedImageCtx.drawImage(reducedImage, 0, 0, reducedWidth, reducedHeight, 0, 0, reducedWidth >> 1, reducedHeight >> 1); reducedWidth >>= 1; reducedHeight >>= 1; } ctx.drawImage(reducedImage, 0, 0, reducedWidth, reducedHeight, 0, 0, canvas.width, canvas.height); this._convertCanvasToImage(); } get pageId() { return (this.pageLabel !== null ? this.pageLabel : this.id); } /** * @param {string|null} label */ setPageLabel(label) { this.pageLabel = (typeof label === 'string' ? label : null); this.l10n.get('thumb_page_title', { page: this.pageId, }, 'Page {{page}}').then((msg) => { this.anchor.title = msg; }); if (this.renderingState !== RenderingStates.FINISHED) { return; } this.l10n.get('thumb_page_canvas', { page: this.pageId, }, 'Thumbnail of Page {{page}}').then((ariaLabel) => { if (this.image) { this.image.setAttribute('aria-label', ariaLabel); } else if (this.disableCanvasToImageConversion && this.canvas) { this.canvas.setAttribute('aria-label', ariaLabel); } }); } static cleanup() { TempImageFactory.destroyCanvas(); } } export { PDFThumbnailView, };