feat: Replace segment template utils with CML version

littlespex · littlespex · commit 8784b44dca5e · 2025-03-05T09:27:55.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -84,7 +84,7 @@
     "yargs": "^17.7.2"
   },
   "dependencies": {
-    "@svta/common-media-library": "^0.7.4",
+    "@svta/common-media-library": "^0.9.0",
     "bcp-47-match": "^2.0.3",
     "bcp-47-normalize": "^2.3.0",
     "codem-isoboxer": "0.3.10",
diff --git a/src/dash/DashHandler.js b/src/dash/DashHandler.js
@@ -32,12 +32,8 @@ import FragmentRequest from '../streaming/vo/FragmentRequest.js';
 import {HTTPRequest} from '../streaming/vo/metrics/HTTPRequest.js';
 import FactoryMaker from '../core/FactoryMaker.js';
 import MediaPlayerEvents from '../streaming/MediaPlayerEvents.js';
-import {
-    replaceIDForTemplate,
-    replaceTokenForTemplate,
-    unescapeDollarsInTemplate
-} from './utils/SegmentsUtils.js';
 import DashConstants from './constants/DashConstants.js';
+import {processUriTemplate} from '@svta/common-media-library/dash/processUriTemplate.js';
 
 
 const DEFAULT_ADJUST_SEEK_TIME_THRESHOLD = 0.5;
@@ -145,7 +141,7 @@ function DashHandler(config) {
         request.representation = representation;
 
         if (_setRequestUrl(request, representation.initialization, representation)) {
-            request.url = replaceTokenForTemplate(request.url, 'Bandwidth', representation.bandwidth);
+            request.url = processUriTemplate(request.url, undefined, undefined, undefined, representation.bandwidth);
             return request;
         }
     }
@@ -158,13 +154,14 @@ function DashHandler(config) {
         const request = new FragmentRequest();
         const representation = segment.representation;
         const bandwidth = representation.bandwidth;
-        let url = segment.media;
-
-        url = replaceTokenForTemplate(url, 'Number', segment.replacementNumber);
-        url = replaceTokenForTemplate(url, 'Time', segment.replacementTime);
-        url = replaceTokenForTemplate(url, 'Bandwidth', bandwidth);
-        url = replaceIDForTemplate(url, representation.id);
-        url = unescapeDollarsInTemplate(url);
+        const url = processUriTemplate(
+            segment.media,
+            representation.id,
+            segment.replacementNumber,
+            undefined,
+            bandwidth,
+            segment.replacementTime
+        );
 
         request.mediaType = getType();
         request.bandwidth = representation.bandwidth;
diff --git a/src/dash/utils/SegmentsUtils.js b/src/dash/utils/SegmentsUtils.js
@@ -29,105 +29,13 @@
  *  POSSIBILITY OF SUCH DAMAGE.
  */
 
+import {processUriTemplate} from '@svta/common-media-library/dash/processUriTemplate.js';
 import Segment from './../vo/Segment.js';
 
-function zeroPadToLength(numStr, minStrLength) {
-    while (numStr.length < minStrLength) {
-        numStr = '0' + numStr;
-    }
-    return numStr;
-}
-
 function getNumberForSegment(segment, segmentIndex) {
     return segment.representation.startNumber + segmentIndex;
 }
 
-export function unescapeDollarsInTemplate(url) {
-    return url ? url.split('$$').join('$') : url;
-}
-
-export function replaceIDForTemplate(url, value) {
-    if (!value || !url || url.indexOf('$RepresentationID$') === -1) {
-        return url;
-    }
-    let v = value.toString();
-    return url.split('$RepresentationID$').join(v);
-}
-
-export function replaceTokenForTemplate(url, token, value) {
-    const formatTag = '%0';
-
-    let startPos,
-        endPos,
-        formatTagPos,
-        specifier,
-        width,
-        paddedValue;
-
-    const tokenLen = token.length;
-    const formatTagLen = formatTag.length;
-
-    if (!url) {
-        return url;
-    }
-
-    // keep looping round until all instances of <token> have been
-    // replaced. once that has happened, startPos below will be -1
-    // and the completed url will be returned.
-    while (true) {
-
-        // check if there is a valid $<token>...$ identifier
-        // if not, return the url as is.
-        startPos = url.indexOf('$' + token);
-        if (startPos < 0) {
-            return url;
-        }
-
-        // the next '$' must be the end of the identifier
-        // if there isn't one, return the url as is.
-        endPos = url.indexOf('$', startPos + tokenLen);
-        if (endPos < 0) {
-            return url;
-        }
-
-        // now see if there is an additional format tag suffixed to
-        // the identifier within the enclosing '$' characters
-        formatTagPos = url.indexOf(formatTag, startPos + tokenLen);
-        if (formatTagPos > startPos && formatTagPos < endPos) {
-
-            specifier = url.charAt(endPos - 1);
-            width = parseInt(url.substring(formatTagPos + formatTagLen, endPos - 1), 10);
-
-            // support the minimum specifiers required by IEEE 1003.1
-            // (d, i , o, u, x, and X) for completeness
-            switch (specifier) {
-                // treat all int types as uint,
-                // hence deliberate fallthrough
-                case 'd':
-                case 'i':
-                case 'u':
-                    paddedValue = zeroPadToLength(value.toString(), width);
-                    break;
-                case 'x':
-                    paddedValue = zeroPadToLength(value.toString(16), width);
-                    break;
-                case 'X':
-                    paddedValue = zeroPadToLength(value.toString(16), width).toUpperCase();
-                    break;
-                case 'o':
-                    paddedValue = zeroPadToLength(value.toString(8), width);
-                    break;
-                default:
-                    return url;
-            }
-        } else {
-            paddedValue = value;
-        }
-
-        url = url.substring(0, startPos) + paddedValue + url.substring(endPos + 1);
-    }
-}
-
 function getSegment(representation, duration, presentationStartTime, mediaStartTime, timelineConverter, presentationEndTime, isDynamic, index) {
     let seg = new Segment();
 
@@ -222,10 +130,14 @@ export function getTimeBasedSegment(timelineConverter, isDynamic, representation
     }
 
     seg.replacementTime = tManifest ? tManifest : time;
-
-    url = replaceTokenForTemplate(url, 'Number', seg.replacementNumber);
-    url = replaceTokenForTemplate(url, 'Time', seg.replacementTime);
-    seg.media = url;
+    seg.media = processUriTemplate(
+        url,
+        undefined,
+        seg.replacementNumber,
+        undefined,
+        undefined,
+        seg.replacementTime,
+    );
     seg.mediaRange = range;
 
     return seg;
diff --git a/src/dash/utils/TemplateSegmentsGetter.js b/src/dash/utils/TemplateSegmentsGetter.js
@@ -29,9 +29,10 @@
  *  POSSIBILITY OF SUCH DAMAGE.
  */
 
+import {processUriTemplate} from '@svta/common-media-library/dash/processUriTemplate.js';
 import FactoryMaker from '../../core/FactoryMaker.js';
 import Constants from '../../streaming/constants/Constants.js';
-import {replaceTokenForTemplate, getIndexBasedSegment} from './SegmentsUtils.js';
+import {getIndexBasedSegment} from './SegmentsUtils.js';
 
 function TemplateSegmentsGetter(config, isDynamic) {
     config = config || {};
@@ -77,11 +78,14 @@ function TemplateSegmentsGetter(config, isDynamic) {
         const seg = getIndexBasedSegment(timelineConverter, isDynamic, representation, index);
         if (seg) {
             seg.replacementTime = Math.round(index * representation.segmentDuration * representation.timescale, 10);
-
-            let url = template.media;
-            url = replaceTokenForTemplate(url, 'Number', seg.replacementNumber);
-            url = replaceTokenForTemplate(url, 'Time', seg.replacementTime);
-            seg.media = url;
+            seg.media = processUriTemplate(
+                template.media,
+                undefined,
+                seg.replacementNumber,
+                undefined,
+                undefined,
+                seg.replacementTime,
+            );
         }
 
         return seg;
diff --git a/src/streaming/thumbnail/ThumbnailController.js b/src/streaming/thumbnail/ThumbnailController.js
@@ -32,7 +32,7 @@
 import FactoryMaker from '../../core/FactoryMaker.js';
 import Thumbnail from '../vo/Thumbnail.js';
 import ThumbnailTracks from './ThumbnailTracks.js';
-import {replaceTokenForTemplate, unescapeDollarsInTemplate} from '../../dash/utils/SegmentsUtils.js';
+import {processUriTemplate} from '@svta/common-media-library/dash/processUriTemplate.js';
 
 function ThumbnailController(config) {
 
@@ -119,10 +119,15 @@ function ThumbnailController(config) {
 
     function _buildUrlFromTemplate(track, seq) {
         const seqIdx = seq + track.startNumber;
-        let url = replaceTokenForTemplate(track.templateUrl, 'Number', seqIdx);
-        url = replaceTokenForTemplate(url, 'Time', (seqIdx - 1) * track.segmentDuration * track.timescale);
-        url = replaceTokenForTemplate(url, 'Bandwidth', track.bandwidth);
-        return unescapeDollarsInTemplate(url);
+        const url = processUriTemplate(
+            track.templateUrl,
+            undefined,
+            seqIdx,
+            undefined,
+            track.bandwidth,
+            (seqIdx - 1) * track.segmentDuration * track.timescale,
+        );
+        return url;
     }
 
     function setTrackByIndex(index) {
diff --git a/src/streaming/thumbnail/ThumbnailTracks.js b/src/streaming/thumbnail/ThumbnailTracks.js
@@ -33,11 +33,12 @@ import DashConstants from '../../dash/constants/DashConstants.js';
 import FactoryMaker from '../../core/FactoryMaker.js';
 import ThumbnailTrackInfo from '../vo/ThumbnailTrackInfo.js';
 import URLUtils from '../../streaming/utils/URLUtils.js';
-import {replaceIDForTemplate, getTimeBasedSegment} from '../../dash/utils/SegmentsUtils.js';
+import {getTimeBasedSegment} from '../../dash/utils/SegmentsUtils.js';
 import BoxParser from '../../streaming/utils/BoxParser.js';
 import XHRLoader from '../../streaming/net/XHRLoader.js';
 import DashHandler from '../../dash/DashHandler.js';
 import SegmentsController from '../../dash/controllers/SegmentsController.js';
+import {processUriTemplate} from '@svta/common-media-library/dash/processUriTemplate.js';
 
 function ThumbnailTracks(config) {
     const context = this.context;
@@ -260,7 +261,7 @@ function ThumbnailTracks(config) {
             return '';
         }
 
-        return replaceIDForTemplate(templateUrl, representation.id);
+        return processUriTemplate(templateUrl, representation.id);
     }
 
     function getTracks() {
diff --git a/test/unit/test/dash/dash.utils.SegmentUtils.js b/test/unit/test/dash/dash.utils.SegmentUtils.js
