@xiboplayer/renderer 0.5.18 → 0.5.20

package/docs/RENDERER_COMPARISON.md

@@ -1,6 +1,6 @@
 # Renderer Comparison: XLR vs Arexibo vs RendererLite
 
-**Date**: 2026-02-06
+**Date**: 2026-02-28
 **Purpose**: Comprehensive feature comparison to identify gaps and validate implementation
 
 ---
@@ -35,6 +35,7 @@
 | Text/HTML | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Complete |
 | Ticker | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Complete |
 | PDF | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Complete |
+| PDF multi-page cycling | ❌ No | ❌ No | ✅ Yes | ✅ Timed transitions |
 | Webpage (iframe) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Complete |
 | Clock | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Complete |
 | Weather | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Complete |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiboplayer/renderer",
-  "version": "0.5.18",
+  "version": "0.5.20",
   "description": "RendererLite - Fast, efficient XLF layout rendering engine",
   "type": "module",
   "main": "./src/index.js",
@@ -13,8 +13,8 @@
   "dependencies": {
     "nanoevents": "^9.1.0",
     "pdfjs-dist": "^4.10.38",
-    "@xiboplayer/utils": "0.5.18",
-    "@xiboplayer/cache": "0.5.18"
+    "@xiboplayer/cache": "0.5.20",
+    "@xiboplayer/utils": "0.5.20"
   },
   "devDependencies": {
     "vitest": "^2.0.0",

package/src/layout.js

@@ -515,8 +515,8 @@ ${mediaJS}
             video.play();
           }
         };
+        video._retryOnCache = retryOnCache;
         window.addEventListener('media-cached', retryOnCache);
-        video.dataset.cacheListener = 'attached';
 
         region.innerHTML = '';
         region.appendChild(video);
@@ -536,6 +536,11 @@ ${mediaJS}
         const region = document.getElementById('region_${regionId}');
         const video = document.querySelector('#region_${regionId} video');
         if (video) {
+          // Remove global media-cached listener to prevent leak
+          if (video._retryOnCache) {
+            window.removeEventListener('media-cached', video._retryOnCache);
+            video._retryOnCache = null;
+          }
           const transOut = ${transOut};
           if (transOut && window.Transitions) {
             const regionRect = region.getBoundingClientRect();
@@ -871,7 +876,7 @@ ${mediaJS}
         break;
 
       case 'webpage':
-        const url = media.options.uri;
+        const url = decodeURIComponent(media.options.uri || '');
         startFn = `() => {
         const region = document.getElementById('region_${regionId}');
         const iframe = document.createElement('iframe');

package/src/renderer-lite.js

@@ -642,13 +642,17 @@ export class RendererLite {
    * @param {string} blobUrl - Blob URL to track
    */
   trackBlobUrl(blobUrl) {
-    if (!this.currentLayoutId) return;
+    const layoutId = this.currentLayoutId || 0;
 
-    if (!this.layoutBlobUrls.has(this.currentLayoutId)) {
-      this.layoutBlobUrls.set(this.currentLayoutId, new Set());
+    if (!layoutId) {
+      this.log.warn('trackBlobUrl called without currentLayoutId, tracking under key 0');
     }
 
-    this.layoutBlobUrls.get(this.currentLayoutId).add(blobUrl);
+    if (!this.layoutBlobUrls.has(layoutId)) {
+      this.layoutBlobUrls.set(layoutId, new Set());
+    }
+
+    this.layoutBlobUrls.get(layoutId).add(blobUrl);
   }
 
   /**
@@ -1369,15 +1373,16 @@ export class RendererLite {
         return Promise.resolve();
       }
       return new Promise((resolve) => {
-        const timer = setTimeout(() => {
-          this.log.warn(`Image ready timeout for widget ${widget.id}`);
-          resolve();
-        }, READY_TIMEOUT);
         const onLoad = () => {
           imgEl.removeEventListener('load', onLoad);
           clearTimeout(timer);
           resolve();
         };
+        const timer = setTimeout(() => {
+          imgEl.removeEventListener('load', onLoad);
+          this.log.warn(`Image ready timeout for widget ${widget.id}`);
+          resolve();
+        }, READY_TIMEOUT);
         imgEl.addEventListener('load', onLoad);
       });
     }
@@ -1592,12 +1597,39 @@ export class RendererLite {
       videoEl.srcObject = null;
     }
 
+    // Destroy HLS.js instance to free worker + buffers
+    if (videoEl?._hlsInstance) {
+      videoEl._hlsInstance.destroy();
+      videoEl._hlsInstance = null;
+    }
+
+    // Remove event listeners to prevent accumulation across widget cycles
+    if (videoEl?._eventCleanup) {
+      for (const [event, handler] of videoEl._eventCleanup) {
+        videoEl.removeEventListener(event, handler);
+      }
+      videoEl._eventCleanup = null;
+    }
+
     const audioEl = widgetElement.querySelector('audio');
     if (audioEl && widget.options.loop !== '1') audioEl.pause();
 
+    // Remove audio event listeners
+    if (audioEl?._eventCleanup) {
+      for (const [event, handler] of audioEl._eventCleanup) {
+        audioEl.removeEventListener(event, handler);
+      }
+      audioEl._eventCleanup = null;
+    }
+
     // Stop audio overlays attached to this widget
     this._stopAudioOverlays(widget.id);
 
+    // Stop PDF page cycling timers
+    if (widgetElement._pdfCleanup) {
+      widgetElement._pdfCleanup();
+    }
+
     return { widget, animPromise };
   }
 
@@ -1887,22 +1919,20 @@ export class RendererLite {
     video.controls = false; // Hidden by default — toggle with V key in PWA
     video.playsInline = true; // Prevent fullscreen on mobile
 
+    // Get media URL from cache (already pre-fetched!) or fetch on-demand
+    const fileId = parseInt(widget.fileId || widget.id);
+
     // Handle video end - pause on last frame instead of showing black
     // Widget cycling will restart the video via updateMediaElement()
-    video.addEventListener('ended', () => {
+    const onEnded = () => {
       if (widget.options.loop === '1') {
-        // For looping videos: seek back to start but stay paused on first frame
-        // This avoids black frames - shows first frame until widget cycles
         video.currentTime = 0;
         this.log.info(`Video ${fileId} ended - reset to start, waiting for widget cycle to replay`);
       } else {
-        // For non-looping videos: stay paused on last frame
         this.log.info(`Video ${fileId} ended - paused on last frame`);
       }
-    });
-
-    // Get media URL from cache (already pre-fetched!) or fetch on-demand
-    const fileId = parseInt(widget.fileId || widget.id);
+    };
+    video.addEventListener('ended', onEnded);
     let videoSrc = this.mediaUrlCache.get(fileId);
 
     if (!videoSrc && this.options.getMediaUrl) {
@@ -1953,49 +1983,49 @@ export class RendererLite {
     // loadedmetadata fires (e.g. video was preloaded for next layout), we must
     // NOT update the current layout's duration with a different layout's video.
     const createdForLayoutId = this.currentLayoutId;
-    video.addEventListener('loadedmetadata', () => {
+    const onLoadedMetadata = () => {
       const videoDuration = Math.floor(video.duration);
       this.log.info(`Video ${fileId} duration detected: ${videoDuration}s`);
 
-      // Always update widget duration — it's the widget's own data, safe
-      // even if this video was preloaded for a different layout.
       if (widget.duration === 0 || widget.useDuration === 0) {
         widget.duration = videoDuration;
         this.log.info(`Updated widget ${widget.id} duration to ${videoDuration}s (useDuration=0)`);
 
-        // Only recalculate current layout's timer if this video belongs to it.
-        // Preloaded layouts will pick up the corrected widget.duration when
-        // they start playing (via updateLayoutDuration() in swapToPreloadedLayout).
         if (this.currentLayoutId === createdForLayoutId) {
           this.updateLayoutDuration();
         } else {
           this.log.info(`Video ${fileId} duration set but layout timer not updated (preloaded for layout ${createdForLayoutId}, current is ${this.currentLayoutId})`);
         }
       }
-    });
+    };
+    video.addEventListener('loadedmetadata', onLoadedMetadata);
 
-    // Debug video loading
-    video.addEventListener('loadeddata', () => {
+    const onLoadedData = () => {
       this.log.info('Video loaded and ready:', fileId);
-    });
+    };
+    video.addEventListener('loadeddata', onLoadedData);
 
-    // Handle video errors
-    video.addEventListener('error', (e) => {
+    const onError = () => {
       const error = video.error;
       const errorCode = error?.code;
       const errorMessage = error?.message || 'Unknown error';
-
-      // Log all video errors for debugging, but never show to users
-      // These are often transient codec warnings that don't prevent playback
       this.log.warn(`Video error (non-fatal, logged only): ${fileId}, code: ${errorCode}, time: ${video.currentTime.toFixed(1)}s, message: ${errorMessage}`);
+    };
+    video.addEventListener('error', onError);
 
-      // Do NOT emit error events - video errors are logged but not surfaced to UI
-      // Video will either recover (transient decode error) or fail completely (handled elsewhere)
-    });
-
-    video.addEventListener('playing', () => {
+    const onPlaying = () => {
       this.log.info('Video playing:', fileId);
-    });
+    };
+    video.addEventListener('playing', onPlaying);
+
+    // Store listener references for cleanup in _hideWidget()
+    video._eventCleanup = [
+      ['ended', onEnded],
+      ['loadedmetadata', onLoadedMetadata],
+      ['loadeddata', onLoadedData],
+      ['error', onError],
+      ['playing', onPlaying],
+    ];
 
     this.log.info('Video element created:', fileId, video.src);
 
@@ -2095,18 +2125,19 @@ export class RendererLite {
     audio.src = audioSrc;
 
     // Handle audio end - similar to video ended handling
-    audio.addEventListener('ended', () => {
+    const onAudioEnded = () => {
       if (widget.options.loop === '1') {
         audio.currentTime = 0;
         this.log.info(`Audio ${fileId} ended - reset to start, waiting for widget cycle to replay`);
       } else {
         this.log.info(`Audio ${fileId} ended - playback complete`);
       }
-    });
+    };
+    audio.addEventListener('ended', onAudioEnded);
 
     // Detect audio duration for dynamic layout timing (when useDuration=0)
     const audioCreatedForLayoutId = this.currentLayoutId;
-    audio.addEventListener('loadedmetadata', () => {
+    const onAudioLoadedMetadata = () => {
       const audioDuration = Math.floor(audio.duration);
       this.log.info(`Audio ${fileId} duration detected: ${audioDuration}s`);
 
@@ -2120,13 +2151,22 @@ export class RendererLite {
           this.log.info(`Audio ${fileId} duration set but layout timer not updated (preloaded for layout ${audioCreatedForLayoutId}, current is ${this.currentLayoutId})`);
         }
       }
-    });
+    };
+    audio.addEventListener('loadedmetadata', onAudioLoadedMetadata);
 
     // Handle audio errors
-    audio.addEventListener('error', () => {
+    const onAudioError = () => {
       const error = audio.error;
       this.log.warn(`Audio error (non-fatal): ${fileId}, code: ${error?.code}, message: ${error?.message || 'Unknown'}`);
-    });
+    };
+    audio.addEventListener('error', onAudioError);
+
+    // Store listener references for cleanup in _hideWidget()
+    audio._eventCleanup = [
+      ['ended', onAudioEnded],
+      ['loadedmetadata', onAudioLoadedMetadata],
+      ['error', onAudioError],
+    ];
 
     // Visual feedback
     const icon = document.createElement('div');
@@ -2255,29 +2295,72 @@ export class RendererLite {
       pdfUrl = `${window.location.origin}/player/cache/media/${widget.options.uri}`;
     }
 
-    // Render PDF
+    // Render PDF with multi-page cycling
     try {
       const loadingTask = window.pdfjsLib.getDocument(pdfUrl);
       const pdf = await loadingTask.promise;
-      const page = await pdf.getPage(1); // Render first page
-
-      const viewport = page.getViewport({ scale: 1 });
-      const scale = Math.min(
-        region.width / viewport.width,
-        region.height / viewport.height
-      );
-      const scaledViewport = page.getViewport({ scale });
+      const totalPages = pdf.numPages;
+      const duration = widget.duration || 60;
+      const timePerPage = (duration * 1000) / totalPages;
+      this.log.info(`[pdf] PDF loaded: ${totalPages} pages, ${duration}s duration, ${(timePerPage / 1000).toFixed(1)}s/page`);
+
+      // Single reused canvas — render each page on-demand, call page.cleanup()
+      // after each render to release PDF.js internal buffers. Sequential rendering
+      // (one page at a time via setTimeout) avoids the "Cannot use the same canvas
+      // during multiple render() operations" error.
+      const page1 = await pdf.getPage(1);
+      const viewport0 = page1.getViewport({ scale: 1 });
+      const scale = Math.min(region.width / viewport0.width, region.height / viewport0.height);
+      page1.cleanup();
 
       const canvas = document.createElement('canvas');
-      canvas.width = scaledViewport.width;
-      canvas.height = scaledViewport.height;
-      canvas.style.display = 'block';
-      canvas.style.margin = 'auto';
+      canvas.className = 'pdf-page';
+      canvas.width = Math.floor(viewport0.width * scale);
+      canvas.height = Math.floor(viewport0.height * scale);
+      canvas.style.cssText = 'display:block;margin:auto;position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);';
+      const ctx = canvas.getContext('2d');
+      container.appendChild(canvas);
 
-      const context = canvas.getContext('2d');
-      await page.render({ canvasContext: context, viewport: scaledViewport }).promise;
+      // Page indicator (bottom-right)
+      const indicator = document.createElement('div');
+      indicator.style.cssText = 'position:absolute;bottom:8px;right:12px;color:rgba(255,255,255,0.6);font:12px system-ui;z-index:1;';
+      container.appendChild(indicator);
+
+      let currentPage = 1;
+      let cycleTimer = null;
+      let stopped = false;
+
+      const cyclePage = async () => {
+        if (stopped) return;
+        indicator.textContent = `${currentPage} / ${totalPages}`;
+
+        const page = await pdf.getPage(currentPage);
+        const scaledViewport = page.getViewport({ scale });
+        ctx.clearRect(0, 0, canvas.width, canvas.height);
+        await page.render({ canvasContext: ctx, viewport: scaledViewport }).promise;
+        page.cleanup(); // Release PDF.js internal page buffers
+
+        // Schedule next page (only after current render completes)
+        if (totalPages > 1 && !stopped) {
+          cycleTimer = setTimeout(() => {
+            currentPage = currentPage >= totalPages ? 1 : currentPage + 1;
+            cyclePage();
+          }, timePerPage);
+        }
+      };
 
-      container.appendChild(canvas);
+      await cyclePage();
+
+      // Store cleanup function on container for when widget is removed
+      container._pdfCleanup = () => {
+        stopped = true;
+        if (cycleTimer) clearTimeout(cycleTimer);
+        cycleTimer = null;
+        canvas.width = 0;
+        canvas.height = 0;
+        pdf.cleanup();
+        pdf.destroy();
+      };
 
     } catch (error) {
       this.log.error('PDF render failed:', error);
@@ -2305,7 +2388,9 @@ export class RendererLite {
     iframe.style.height = '100%';
     iframe.style.border = 'none';
     iframe.style.opacity = '0';
-    iframe.src = widget.options.uri;
+    // CMS may percent-encode the URI in XLF (e.g. https%3A%2F%2F → https://)
+    const uri = decodeURIComponent(widget.options.uri || '');
+    iframe.src = uri;
 
     return iframe;
   }

package/src/renderer-lite.overlays.test.js

@@ -486,8 +486,9 @@ describe('RendererLite - Overlay Rendering', () => {
     it('should track blob URLs per overlay layout', async () => {
       await renderer.renderOverlay(overlayXLF, 200, 10);
 
-      // Blob URLs should be tracked
-      expect(renderer.layoutBlobUrls.has(200) || renderer.layoutBlobUrls.size === 0).toBe(true);
+      // Blob URLs should be tracked (under overlay ID 200, or fallback key 0 if
+      // currentLayoutId wasn't set, or empty if no blob URLs were created)
+      expect(renderer.layoutBlobUrls.has(200) || renderer.layoutBlobUrls.has(0) || renderer.layoutBlobUrls.size === 0).toBe(true);
     });
   });
 });