@amazon/vinyl 3.0.1 → 3.2.0

package/dist/unit/types/current/track/filters/sampleRateFilter.test.js

@@ -2,56 +2,61 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { supportsAudioSamplingRate, createEmptyMediaQualityMetadata, throwSamplingRatesUnsupported, } from '@amazon/vinyl';
+import { withinAudioSampleRateRange, createEmptyMediaQualityMetadata, throwSamplingRatesUnsupported, } from '@amazon/vinyl';
 import { MockCapabilities } from '@amazon/vinyl/vinylTestUtil';
 import { setUserAgent } from '@amazon/vinyl-util';
-describe('supportsAudioSamplingRate', () => {
+describe('withinAudioSampleRateRange', () => {
     let capabilities;
     beforeEach(() => {
         capabilities = new MockCapabilities();
         capabilities.sampleRate = 48_000;
     });
+    // The filter only gates audio content types, so gated fixtures must declare
+    // contentType 'audio' (the empty metadata defaults it to null).
+    function audioQuality(rate) {
+        const quality = createEmptyMediaQualityMetadata();
+        quality.contentType = 'audio';
+        quality.audioSamplingRate = rate;
+        return quality;
+    }
     describe('when browser is Firefox', () => {
         beforeEach(() => {
             setUserAgent('Firefox');
         });
         it('returns false when sample rate is above supported', () => {
-            const metadata = createEmptyMediaQualityMetadata();
-            metadata.audioSamplingRate = [96_000];
-            expect(supportsAudioSamplingRate({ capabilities }, metadata, 0, [
+            const metadata = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, metadata, 0, [
                 metadata,
             ])).toBe(false);
         });
         it('returns false when sample rate is above 48kHz even if capabilities allows it', () => {
             capabilities.sampleRate = 96_000;
-            const metadata = createEmptyMediaQualityMetadata();
-            metadata.audioSamplingRate = [96_000];
-            expect(supportsAudioSamplingRate({ capabilities }, metadata, 0, [
+            const metadata = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, metadata, 0, [
                 metadata,
             ])).toBe(false);
         });
         it('returns false even when all rates are above 48kHz (no fallback to lowest)', () => {
-            const low = createEmptyMediaQualityMetadata();
-            low.audioSamplingRate = [88_200];
-            const high = createEmptyMediaQualityMetadata();
-            high.audioSamplingRate = [96_000];
-            expect(supportsAudioSamplingRate({ capabilities }, low, 0, [low, high])).toBe(false);
-            expect(supportsAudioSamplingRate({ capabilities }, high, 1, [
+            const low = audioQuality([88_200]);
+            const high = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, low, 0, [
+                low,
+                high,
+            ])).toBe(false);
+            expect(withinAudioSampleRateRange({ capabilities }, high, 1, [
                 low,
                 high,
             ])).toBe(false);
         });
         it('returns true when sample rate is at or below supported', () => {
-            const metadata = createEmptyMediaQualityMetadata();
-            metadata.audioSamplingRate = [48_000];
-            expect(supportsAudioSamplingRate({ capabilities }, metadata, 0, [
+            const metadata = audioQuality([48_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, metadata, 0, [
                 metadata,
             ])).toBe(true);
         });
         it('returns true when sample rate is not set', () => {
-            const metadata = createEmptyMediaQualityMetadata();
-            metadata.audioSamplingRate = null;
-            expect(supportsAudioSamplingRate({ capabilities }, metadata, 0, [
+            const metadata = audioQuality(null);
+            expect(withinAudioSampleRateRange({ capabilities }, metadata, 0, [
                 metadata,
             ])).toBe(true);
         });
@@ -61,32 +66,81 @@ describe('supportsAudioSamplingRate', () => {
             setUserAgent('Chrome');
         });
         it('returns true when sample rate is at or below supported', () => {
-            const metadata = createEmptyMediaQualityMetadata();
-            metadata.audioSamplingRate = [48_000];
-            expect(supportsAudioSamplingRate({ capabilities }, metadata, 0, [
+            const metadata = audioQuality([48_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, metadata, 0, [
+                metadata,
+            ])).toBe(true);
+        });
+        it('keeps everything when there is no platform max to gauge support', () => {
+            capabilities.sampleRate = null;
+            const metadata = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, metadata, 0, [
                 metadata,
             ])).toBe(true);
         });
         it('returns false when sample rate is above supported and others are below', () => {
-            const low = createEmptyMediaQualityMetadata();
-            low.audioSamplingRate = [44_100];
-            const high = createEmptyMediaQualityMetadata();
-            high.audioSamplingRate = [96_000];
-            expect(supportsAudioSamplingRate({ capabilities }, high, 1, [
+            const low = audioQuality([44_100]);
+            const high = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, high, 1, [
                 low,
                 high,
             ])).toBe(false);
         });
         it('keeps lowest sample rate when all are above supported', () => {
-            const low = createEmptyMediaQualityMetadata();
-            low.audioSamplingRate = [88_200];
-            const high = createEmptyMediaQualityMetadata();
-            high.audioSamplingRate = [96_000];
-            expect(supportsAudioSamplingRate({ capabilities }, low, 0, [low, high])).toBe(true);
-            expect(supportsAudioSamplingRate({ capabilities }, high, 1, [
+            const low = audioQuality([88_200]);
+            const high = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, low, 0, [
+                low,
+                high,
+            ])).toBe(true);
+            expect(withinAudioSampleRateRange({ capabilities }, high, 1, [
+                low,
+                high,
+            ])).toBe(false);
+        });
+        it('an explicit maxSampleRate takes precedence — raising it keeps a higher rate', () => {
+            // AudioContext reports 48kHz, which would drop the 96kHz rendition.
+            capabilities.sampleRate = 48_000;
+            const low = audioQuality([48_000]);
+            const high = audioQuality([96_000]);
+            // Without an override, 96kHz is dropped (a 48kHz alternative exists).
+            expect(withinAudioSampleRateRange({ capabilities }, high, 1, [
                 low,
                 high,
             ])).toBe(false);
+            // With maxSampleRate = 96kHz, it is kept.
+            expect(withinAudioSampleRateRange({ capabilities, maxSampleRate: 96_000 }, high, 1, [low, high])).toBe(true);
+        });
+        it('an explicit maxSampleRate takes precedence — lowering it drops a rate the platform allows', () => {
+            // AudioContext reports 192kHz, which would keep the 96kHz rendition.
+            capabilities.sampleRate = 192_000;
+            const low = audioQuality([48_000]);
+            const high = audioQuality([96_000]);
+            expect(withinAudioSampleRateRange({ capabilities }, high, 1, [
+                low,
+                high,
+            ])).toBe(true);
+            // Capping at 48kHz drops the 96kHz rendition and keeps the 48kHz one.
+            expect(withinAudioSampleRateRange({ capabilities, maxSampleRate: 48_000 }, high, 1, [low, high])).toBe(false);
+            expect(withinAudioSampleRateRange({ capabilities, maxSampleRate: 48_000 }, low, 0, [low, high])).toBe(true);
+        });
+        it('ignores non-audio qualities and keeps audio above the device rate', () => {
+            // Output device runs at 44.1kHz while the audio is standard 48kHz.
+            capabilities.sampleRate = 44_100;
+            const audio = audioQuality([48_000]);
+            // A co-present video quality is never gated and must not influence
+            // the audio keep-lowest fallback.
+            const video = createEmptyMediaQualityMetadata();
+            video.contentType = 'video';
+            video.audioSamplingRate = null;
+            expect(withinAudioSampleRateRange({ capabilities }, audio, 0, [
+                audio,
+                video,
+            ])).toBe(true);
+            expect(withinAudioSampleRateRange({ capabilities }, video, 1, [
+                audio,
+                video,
+            ])).toBe(true);
         });
     });
     it('throws correct error', () => {
@@ -100,3 +154,126 @@ describe('supportsAudioSamplingRate', () => {
         }
     });
 });
+describe('withinAudioSampleRateRange minSampleRate floor', () => {
+    let capabilities;
+    beforeEach(() => {
+        capabilities = new MockCapabilities();
+        // High enough that the upper bound never interferes with these tests.
+        capabilities.sampleRate = 192_000;
+    });
+    function audioQuality(rate) {
+        const quality = createEmptyMediaQualityMetadata();
+        quality.contentType = 'audio';
+        quality.audioSamplingRate = rate;
+        return quality;
+    }
+    // minSampleRate is passed via the options arg alongside capabilities.
+    function withinMin(metadata, index, array) {
+        return withinAudioSampleRateRange({ capabilities, minSampleRate: 48_000 }, metadata, index, array);
+    }
+    it('passes through non-audio qualities', () => {
+        const video = createEmptyMediaQualityMetadata();
+        video.contentType = 'video';
+        expect(withinMin(video, 0, [video])).toBe(true);
+    });
+    it('keeps qualities with no sampling rate', () => {
+        const quality = audioQuality(null);
+        expect(withinMin(quality, 0, [quality])).toBe(true);
+    });
+    it('drops rates below the floor when a rate at or above it exists', () => {
+        const low = audioQuality([24_000]);
+        const high = audioQuality([48_000]);
+        expect(withinMin(high, 1, [low, high])).toBe(true);
+        expect(withinMin(low, 0, [low, high])).toBe(false);
+    });
+    it('keeps the highest when every rate is below the floor', () => {
+        const low = audioQuality([16_000]);
+        const mid = audioQuality([24_000]);
+        expect(withinMin(mid, 1, [low, mid])).toBe(true);
+        expect(withinMin(low, 0, [low, mid])).toBe(false);
+    });
+    it('keeps the highest when every rate (of three) is below the floor', () => {
+        const low = audioQuality([16_000]);
+        const mid = audioQuality([24_000]);
+        const high = audioQuality([32_000]);
+        expect(withinMin(high, 2, [low, mid, high])).toBe(true);
+        expect(withinMin(mid, 1, [low, mid, high])).toBe(false);
+        expect(withinMin(low, 0, [low, mid, high])).toBe(false);
+    });
+    it('keeps the highest below-floor rate when no platform max is reported', () => {
+        // No AudioContext rate, so the floor is the only bound; with every rate
+        // below it, the highest is kept as the fallback.
+        capabilities.sampleRate = null;
+        const low = audioQuality([16_000]);
+        const high = audioQuality([32_000]);
+        expect(withinMin(high, 1, [low, high])).toBe(true);
+        expect(withinMin(low, 0, [low, high])).toBe(false);
+    });
+    it('keeps a single audio rendition below the floor', () => {
+        const only = audioQuality([24_000]);
+        expect(withinMin(only, 0, [only])).toBe(true);
+    });
+    it('ignores non-audio qualities in the floor fallback', () => {
+        const audio = audioQuality([24_000]); // below the floor
+        const video = createEmptyMediaQualityMetadata();
+        video.contentType = 'video';
+        video.audioSamplingRate = null;
+        // Below the 48kHz floor but the only audio → kept; video is ignored.
+        expect(withinMin(audio, 0, [audio, video])).toBe(true);
+        expect(withinMin(video, 1, [audio, video])).toBe(true);
+    });
+});
+// The floor and ceiling are soft together: when renditions straddle an empty
+// band (some below the floor, some above the ceiling, none in between) neither
+// bound alone must strand audio.
+describe('withinAudioSampleRateRange straddling an empty band', () => {
+    let capabilities;
+    beforeEach(() => {
+        // The soft ceiling is a non-Firefox behavior; Firefox's 48kHz cap is
+        // hard (covered above), so pin a non-Firefox UA to exercise the fallback.
+        setUserAgent('Chrome');
+        capabilities = new MockCapabilities();
+        // Ceiling at 48kHz; floor at 44.1kHz → acceptable band is [44.1k, 48k].
+        capabilities.sampleRate = 48_000;
+    });
+    function audioQuality(rate) {
+        const quality = createEmptyMediaQualityMetadata();
+        quality.contentType = 'audio';
+        quality.audioSamplingRate = rate;
+        return quality;
+    }
+    function within(metadata, index, array) {
+        return withinAudioSampleRateRange({ capabilities, minSampleRate: 44_100 }, metadata, index, array);
+    }
+    it('keeps the highest decodable rate when one is below the floor and one above the ceiling', () => {
+        const low = audioQuality([22_050]); // below the 44.1kHz floor
+        const high = audioQuality([96_000]); // above the 48kHz ceiling
+        // Empty band → the below-floor rate is decodable and kept; the
+        // above-ceiling rate is dropped, so audio is never stranded.
+        expect(within(low, 0, [low, high])).toBe(true);
+        expect(within(high, 1, [low, high])).toBe(false);
+    });
+    it('keeps the below-floor rate when the ceiling matches the output device rate', () => {
+        // Output device runs at 44.1kHz, so a 48kHz rendition is above the
+        // ceiling while a 22.05kHz rendition is below the floor.
+        capabilities.sampleRate = 44_100;
+        const low = audioQuality([22_050]);
+        const high = audioQuality([48_000]);
+        expect(within(low, 0, [low, high])).toBe(true);
+        expect(within(high, 1, [low, high])).toBe(false);
+    });
+    it('still prefers an in-band rate over the straddle fallback', () => {
+        const low = audioQuality([22_050]); // below floor
+        const mid = audioQuality([44_100]); // in band
+        const high = audioQuality([96_000]); // above ceiling
+        expect(within(mid, 1, [low, mid, high])).toBe(true);
+        expect(within(low, 0, [low, mid, high])).toBe(false);
+        expect(within(high, 2, [low, mid, high])).toBe(false);
+    });
+    it('keeps the lowest when every rate is above the ceiling', () => {
+        const low = audioQuality([88_200]);
+        const high = audioQuality([96_000]);
+        expect(within(low, 0, [low, high])).toBe(true);
+        expect(within(high, 1, [low, high])).toBe(false);
+    });
+});

package/dist/unit/types/current/track/source/SourceObjectTrack.test.js

@@ -66,7 +66,7 @@ describe('SourceObjectTrack', () => {
         });
     });
 });
-describe('createSourceTrackFactory', () => {
+describe('createSourceTrackFactory (object)', () => {
     let trackFactory;
     beforeEach(() => {
         trackFactory = createSourceObjectTrackFactory({