Don't fetch segment if endNumber is reached (Dash-Industry-Forum#4745)

bitboxer · web-flow · commit 6957423b9e08 · 2025-04-08T07:06:59.000+02:00
* Don't fetch segment if endNumber is reached Closing Dash-Industry-Forum#4710 * Improved handling of startNumber * Moved seg check to if * Improved tests for DashHandler.js
diff --git a/index.d.ts b/index.d.ts
@@ -989,6 +989,7 @@ declare namespace dashjs {
         startNumber: number;
         timescale: number;
         width: number;
+        endNumber: number | null;
     }
 
     export interface Segment {
diff --git a/src/dash/DashHandler.js b/src/dash/DashHandler.js
@@ -282,6 +282,9 @@ function DashHandler(config) {
         }
 
         let indexToRequest = lastSegment ? lastSegment.index + 1 : 0;
+        if (representation && lastSegment && representation.endNumber && lastSegment.replacementNumber && lastSegment.replacementNumber > representation.endNumber) {
+            return null;
+        }
 
         return _getRequest(mediaInfo, representation, indexToRequest);
     }
diff --git a/src/dash/constants/DashConstants.js b/src/dash/constants/DashConstants.js
@@ -84,6 +84,7 @@ export default {
     DVB_MIMETYPE : 'dvb:mimeType',
     DVB_FONTFAMILY : 'dvb:fontFamily',
     DYNAMIC: 'dynamic',
+    END_NUMBER: 'endNumber',
     ESSENTIAL_PROPERTY: 'EssentialProperty',
     EVENT: 'Event',
     EVENT_STREAM: 'EventStream',
diff --git a/src/dash/models/DashManifestModel.js b/src/dash/models/DashManifestModel.js
@@ -842,6 +842,9 @@ function DashManifestModel() {
                     } else if (baseUrl && baseUrl.availabilityTimeComplete !== undefined) {
                         voRepresentation.availabilityTimeComplete = baseUrl.availabilityTimeComplete;
                     }
+                    if (segmentInfo.hasOwnProperty(DashConstants.END_NUMBER)) {
+                        voRepresentation.endNumber = segmentInfo[DashConstants.END_NUMBER];
+                    }
                 }
 
                 voRepresentation.mseTimeOffset = calcMseTimeOffset(voRepresentation);
diff --git a/src/dash/utils/TemplateSegmentsGetter.js b/src/dash/utils/TemplateSegmentsGetter.js
@@ -75,7 +75,12 @@ function TemplateSegmentsGetter(config, isDynamic) {
         index = Math.max(index, 0);
 
         const seg = getIndexBasedSegment(timelineConverter, isDynamic, representation, index);
+
         if (seg) {
+            if (representation.endNumber && seg.replacementNumber > representation.endNumber) {
+                return null;
+            }
+
             seg.replacementTime = Math.round(index * representation.segmentDuration * representation.timescale, 10);
 
             let url = template.media;
diff --git a/src/dash/vo/Representation.js b/src/dash/vo/Representation.js
@@ -72,6 +72,7 @@ class Representation {
         this.startNumber = 1;
         this.timescale = 1;
         this.width = NaN;
+        this.endNumber = null;
     }
 
     hasInitialization() {
diff --git a/test/unit/test/dash/dash.DashHandler.js b/test/unit/test/dash/dash.DashHandler.js
@@ -34,6 +34,8 @@ describe('DashHandler', function () {
     const segmentsController = objectsHelper.getDummySegmentsController();
     const dashMetrics = new DashMetricsMock();
 
+    let dummyRepresentation;
+    let dummyMediaInfo;
 
     const config = {
         eventBus,
@@ -51,6 +53,41 @@ describe('DashHandler', function () {
     const dashHandler = DashHandler(context).create(config);
     dashHandler.initialize(streamProcessor);
 
+    beforeEach(() => {
+        dummyRepresentation = {
+            index: 0,
+            adaptation: {
+                index: 0,
+                period: {
+                    mpd: {
+                        manifest: {
+                            Period: [
+                                {
+                                    AdaptationSet: [
+                                        {
+                                            Representation: [
+                                                {
+                                                    bandwidth: 3000
+                                                }
+                                            ]
+                                        }
+                                    ]
+                                }
+                            ]
+                        }
+                    },
+                    start: 0,
+                    duration: 30,
+                    index: 0
+                }
+            },
+            segmentInfoType: 'SegmentTimeline',
+            timescale: 1,
+            segmentDuration: 2
+        };
+        dummyMediaInfo = {};
+    })
+
     it('should generate an init segment for a representation', () => {
         const representation = voHelper.getDummyRepresentation(testType);
 
@@ -93,9 +130,55 @@ describe('DashHandler', function () {
         expect(mediaSegment).to.be.null; // jshint ignore:line
     });
 
+    describe('getNextSegmentRequest', () => {
+        let segRequestStub;
+
+        beforeEach(() => {
+            segRequestStub = sinon.stub(segmentsController, 'getSegmentByIndex').callsFake((representation, index) => {
+                return {
+                    replacementNumber: index,
+                    index,
+                    duration: representation.segmentDuration,
+                    representation,
+                    media: 'http://someurl',
+                    endNumber: 2
+                }
+            });
+        })
+
+        afterEach(() => {
+            segRequestStub.restore();
+        });
+
+        it('it returns a segment request', () => {
+            const mediaSegment = dashHandler.getNextSegmentRequest({}, {segmentInfoType: DashConstants.SEGMENT_TEMPLATE, adaptation: {index: 1} });
+            expect(mediaSegment).not.to.be.null; // jshint ignore:line
+        })
+
+        it('returns null if the next segment is after @endNumber', () => {
+            const dashHandler = DashHandler(context).create(config);
+            const representation = {segmentInfoType: DashConstants.SEGMENT_TEMPLATE, adaptation: {index: 1}, endNumber: 2 };
+            dashHandler.initialize(streamProcessor);
+            dashHandler.getNextSegmentRequest({}, representation);
+            dashHandler.getNextSegmentRequest({}, representation);
+            dashHandler.getNextSegmentRequest({}, representation);
+            dashHandler.getNextSegmentRequest({}, representation);
+            const mediaSegment = dashHandler.getNextSegmentRequest({}, representation);
+            expect(mediaSegment).to.be.null; // jshint ignore:line
+        })
+
+        it('returns null if representation is null', () => {
+            const mediaSegment = dashHandler.getNextSegmentRequest({}, null);
+            expect(mediaSegment).to.be.null; // jshint ignore:line
+        })
+
+        it('returns null if representation.segmentInfoType is null', () => {
+            const mediaSegment = dashHandler.getNextSegmentRequest({}, {segmentInfoType: null});
+            expect(mediaSegment).to.be.null; // jshint ignore:line
+        })
+    })
+
     describe('getValidTimeAheadOfTargetTime()', () => {
-        let dummyRepresentation;
-        let dummyMediaInfo;
         let segRequestStub;
 
         beforeEach(() => {
@@ -111,39 +194,6 @@ describe('DashHandler', function () {
                     media: 'http://someurl'
                 }
             });
-
-            dummyRepresentation = {
-                index: 0,
-                adaptation: {
-                    index: 0,
-                    period: {
-                        mpd: {
-                            manifest: {
-                                Period: [
-                                    {
-                                        AdaptationSet: [
-                                            {
-                                                Representation: [
-                                                    {
-                                                        bandwidth: 3000
-                                                    }
-                                                ]
-                                            }
-                                        ]
-                                    }
-                                ]
-                            }
-                        },
-                        start: 0,
-                        duration: 30,
-                        index: 0
-                    }
-                },
-                segmentInfoType: 'SegmentTimeline',
-                timescale: 1,
-                segmentDuration: 2
-            };
-            dummyMediaInfo = {};
         })
 
         afterEach(() => {
diff --git a/test/unit/test/dash/dash.utils.TemplateSegmentsGetter.js b/test/unit/test/dash/dash.utils.TemplateSegmentsGetter.js
@@ -95,6 +95,50 @@ describe('TemplateSegmentsGetter', () => {
             let seg = templateSegmentsGetter.getSegmentByIndex(representation, 1 + 100 / 5);
             expect(seg).to.be.null; // jshint ignore:line
         });
+
+        it('should not return null if segment is equal to endNumber', () => {
+            const representation = voHelper.getDummyRepresentation(Constants.VIDEO);
+            representation.segmentAvailabilityWindow = {start: 0, end: 100};
+            representation.segmentDuration = 1;
+            representation.startNumber = 0;
+            representation.endNumber = 3;
+
+            let seg = templateSegmentsGetter.getSegmentByIndex(representation, 3);
+            expect(seg.index).to.equal(3);
+        })
+
+        it('should not return null if segment is equal to endNumber and startNumber is 2', () => {
+            const representation = voHelper.getDummyRepresentation(Constants.VIDEO);
+            representation.segmentAvailabilityWindow = {start: 0, end: 100};
+            representation.segmentDuration = 1;
+            representation.startNumber = 2;
+            representation.endNumber = 5;
+
+            let seg = templateSegmentsGetter.getSegmentByIndex(representation, 3);
+            expect(seg.index).to.equal(3);
+        })
+
+        it('should return null if segment is after endNumber', () => {
+            const representation = voHelper.getDummyRepresentation(Constants.VIDEO);
+            representation.segmentAvailabilityWindow = {start: 0, end: 100};
+            representation.segmentDuration = 1;
+            representation.startNumber = 0;
+            representation.endNumber = 2;
+
+            let seg = templateSegmentsGetter.getSegmentByIndex(representation, 3);
+            expect(seg).to.be.null; // jshint ignore:line
+        })
+
+        it('should return null if segment is after endNumber and startNumber is 2', () => {
+            const representation = voHelper.getDummyRepresentation(Constants.VIDEO);
+            representation.segmentAvailabilityWindow = {start: 0, end: 100};
+            representation.segmentDuration = 1;
+            representation.startNumber = 2;
+            representation.endNumber = 5;
+
+            let seg = templateSegmentsGetter.getSegmentByIndex(representation, 4);
+            expect(seg).to.be.null; // jshint ignore:line
+        })
     });
 
     describe('getSegmentByTime', () => {

Original file line number	Diff line number	Diff line change
`@@ -989,6 +989,7 @@ declare namespace dashjs {`
`989`	`989`	`startNumber: number;`
`990`	`990`	`timescale: number;`
`991`	`991`	`width: number;`
	`992`	`+ endNumber: number \| null;`
`992`	`993`	`}`
`993`	`994`
`994`	`995`	`export interface Segment {`
Original file line number	Diff line number	Diff line change
`@@ -282,6 +282,9 @@ function DashHandler(config) {`
`282`	`282`	`}`
`283`	`283`
`284`	`284`	`let indexToRequest = lastSegment ? lastSegment.index + 1 : 0;`
	`285`	`+ if (representation && lastSegment && representation.endNumber && lastSegment.replacementNumber && lastSegment.replacementNumber > representation.endNumber) {`
	`286`	`+ return null;`
	`287`	`+ }`
`285`	`288`
`286`	`289`	`return _getRequest(mediaInfo, representation, indexToRequest);`
`287`	`290`	`}`
Original file line number	Diff line number	Diff line change
`@@ -842,6 +842,9 @@ function DashManifestModel() {`
`842`	`842`	`} else if (baseUrl && baseUrl.availabilityTimeComplete !== undefined) {`
`843`	`843`	`voRepresentation.availabilityTimeComplete = baseUrl.availabilityTimeComplete;`
`844`	`844`	`}`
	`845`	`+ if (segmentInfo.hasOwnProperty(DashConstants.END_NUMBER)) {`
	`846`	`+ voRepresentation.endNumber = segmentInfo[DashConstants.END_NUMBER];`
	`847`	`+ }`
`845`	`848`	`}`
`846`	`849`
`847`	`850`	`voRepresentation.mseTimeOffset = calcMseTimeOffset(voRepresentation);`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,7 @@ class Representation {`
`72`	`72`	`this.startNumber = 1;`
`73`	`73`	`this.timescale = 1;`
`74`	`74`	`this.width = NaN;`
	`75`	`+ this.endNumber = null;`
`75`	`76`	`}`
`76`	`77`
`77`	`78`	`hasInitialization() {`