|
| 1 | +import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.7'; |
| 2 | +import { Config, Flags, NumericParameters } from '../Config/Config'; |
| 3 | +import { mockRTCRtpReceiver, unmockRTCRtpReceiver } from '../__test__/mockRTCRtpReceiver'; |
| 4 | +import { VideoPlayer } from './VideoPlayer'; |
| 5 | + |
| 6 | +/** |
| 7 | + * Tests for the ViewportResScale numeric parameter added to VideoPlayer. |
| 8 | + * |
| 9 | + * The callback onMatchViewportResolutionCallback is invoked with the scaled |
| 10 | + * viewport dimensions when MatchViewportResolution is enabled. We validate: |
| 11 | + * - default scale (1.0) leaves dimensions unchanged |
| 12 | + * - explicit scale multiplies both dimensions |
| 13 | + * - non-integer products are rounded to integers |
| 14 | + * - dimensions > 4096 emit a warning via Logger |
| 15 | + * - a Config missing the setting falls back to 1.0 instead of throwing |
| 16 | + */ |
| 17 | +describe('VideoPlayer.updateVideoStreamSize — ViewportResScale', () => { |
| 18 | + let parent: HTMLDivElement; |
| 19 | + let config: Config; |
| 20 | + let player: VideoPlayer; |
| 21 | + let callback: jest.Mock; |
| 22 | + |
| 23 | + const setViewportSize = (w: number, h: number) => { |
| 24 | + Object.defineProperty(parent, 'clientWidth', { configurable: true, value: w }); |
| 25 | + Object.defineProperty(parent, 'clientHeight', { configurable: true, value: h }); |
| 26 | + }; |
| 27 | + |
| 28 | + beforeEach(() => { |
| 29 | + mockRTCRtpReceiver(); |
| 30 | + parent = document.createElement('div'); |
| 31 | + document.body.appendChild(parent); |
| 32 | + |
| 33 | + config = new Config({ initialSettings: { [Flags.MatchViewportResolution]: true } }); |
| 34 | + |
| 35 | + player = new VideoPlayer(parent, config); |
| 36 | + callback = jest.fn(); |
| 37 | + player.onMatchViewportResolutionCallback = callback; |
| 38 | + |
| 39 | + // Bypass the 300ms throttle in updateVideoStreamSize. |
| 40 | + (player as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 41 | + }); |
| 42 | + |
| 43 | + afterEach(() => { |
| 44 | + player.destroy(); |
| 45 | + parent.remove(); |
| 46 | + unmockRTCRtpReceiver(); |
| 47 | + jest.restoreAllMocks(); |
| 48 | + }); |
| 49 | + |
| 50 | + it('passes viewport dimensions through unchanged when scale is 1.0 (default)', () => { |
| 51 | + setViewportSize(375, 667); |
| 52 | + player.updateVideoStreamSize(); |
| 53 | + expect(callback).toHaveBeenCalledWith(375, 667); |
| 54 | + }); |
| 55 | + |
| 56 | + it('multiplies both dimensions by the configured scale', () => { |
| 57 | + config.setNumericSetting(NumericParameters.ViewportResScale, 2.0); |
| 58 | + setViewportSize(375, 667); |
| 59 | + |
| 60 | + // lastTimeResized was updated on construction, reset again. |
| 61 | + (player as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 62 | + player.updateVideoStreamSize(); |
| 63 | + |
| 64 | + expect(callback).toHaveBeenCalledWith(750, 1334); |
| 65 | + }); |
| 66 | + |
| 67 | + it('rounds non-integer products to integers', () => { |
| 68 | + config.setNumericSetting(NumericParameters.ViewportResScale, 1.5); |
| 69 | + setViewportSize(375, 667); |
| 70 | + |
| 71 | + (player as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 72 | + player.updateVideoStreamSize(); |
| 73 | + |
| 74 | + // 375 * 1.5 = 562.5 → 563, 667 * 1.5 = 1000.5 → 1001 |
| 75 | + expect(callback).toHaveBeenCalledWith(563, 1001); |
| 76 | + const [w, h] = callback.mock.calls[0] as [number, number]; |
| 77 | + expect(Number.isInteger(w)).toBe(true); |
| 78 | + expect(Number.isInteger(h)).toBe(true); |
| 79 | + }); |
| 80 | + |
| 81 | + it('logs a warning when scaled width or height exceeds 4096', () => { |
| 82 | + const warnSpy = jest.spyOn(Logger, 'Warning').mockImplementation(() => {}); |
| 83 | + |
| 84 | + config.setNumericSetting(NumericParameters.ViewportResScale, 3.0); |
| 85 | + setViewportSize(2000, 1000); // 2000*3 = 6000 > 4096 |
| 86 | + |
| 87 | + (player as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 88 | + player.updateVideoStreamSize(); |
| 89 | + |
| 90 | + expect(warnSpy).toHaveBeenCalledTimes(1); |
| 91 | + expect(warnSpy.mock.calls[0][0]).toContain('4096'); |
| 92 | + expect(warnSpy.mock.calls[0][0]).toContain('6000'); |
| 93 | + expect(callback).toHaveBeenCalledWith(6000, 3000); |
| 94 | + }); |
| 95 | + |
| 96 | + it('does not warn when scaled dimensions stay within the encoder limit', () => { |
| 97 | + const warnSpy = jest.spyOn(Logger, 'Warning').mockImplementation(() => {}); |
| 98 | + |
| 99 | + config.setNumericSetting(NumericParameters.ViewportResScale, 2.0); |
| 100 | + setViewportSize(1920, 1080); // 3840 x 2160, under 4096 |
| 101 | + |
| 102 | + (player as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 103 | + player.updateVideoStreamSize(); |
| 104 | + |
| 105 | + expect(warnSpy).not.toHaveBeenCalled(); |
| 106 | + }); |
| 107 | + |
| 108 | + it('falls back to scale 1.0 when the setting is not registered on the Config', () => { |
| 109 | + const strippedConfig = new Config({ initialSettings: { [Flags.MatchViewportResolution]: true } }); |
| 110 | + // Remove the registration to simulate a custom Config subclass that omits it. |
| 111 | + const params = (strippedConfig as unknown as { numericParameters: Map<string, unknown> }) |
| 112 | + .numericParameters; |
| 113 | + params.delete(NumericParameters.ViewportResScale); |
| 114 | + |
| 115 | + const strippedParent = document.createElement('div'); |
| 116 | + document.body.appendChild(strippedParent); |
| 117 | + const strippedPlayer = new VideoPlayer(strippedParent, strippedConfig); |
| 118 | + const strippedCallback = jest.fn(); |
| 119 | + strippedPlayer.onMatchViewportResolutionCallback = strippedCallback; |
| 120 | + |
| 121 | + Object.defineProperty(strippedParent, 'clientWidth', { configurable: true, value: 500 }); |
| 122 | + Object.defineProperty(strippedParent, 'clientHeight', { configurable: true, value: 400 }); |
| 123 | + |
| 124 | + (strippedPlayer as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 125 | + expect(() => strippedPlayer.updateVideoStreamSize()).not.toThrow(); |
| 126 | + expect(strippedCallback).toHaveBeenCalledWith(500, 400); |
| 127 | + |
| 128 | + strippedPlayer.destroy(); |
| 129 | + strippedParent.remove(); |
| 130 | + }); |
| 131 | + |
| 132 | + it('does not invoke the callback when MatchViewportResolution is disabled', () => { |
| 133 | + config.setFlagEnabled(Flags.MatchViewportResolution, false); |
| 134 | + setViewportSize(375, 667); |
| 135 | + |
| 136 | + (player as unknown as { lastTimeResized: number }).lastTimeResized = 0; |
| 137 | + player.updateVideoStreamSize(); |
| 138 | + |
| 139 | + expect(callback).not.toHaveBeenCalled(); |
| 140 | + }); |
| 141 | +}); |
0 commit comments