rx-player 4.1.0 → 4.2.0-dev.2024080600

package/dist/commonjs/core/cmcd/cmcd_data_builder.js

@@ -0,0 +1,341 @@
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var log_1 = require("../../log");
+var create_uuid_1 = require("../../utils/create_uuid");
+var is_null_or_undefined_1 = require("../../utils/is_null_or_undefined");
+var task_canceller_1 = require("../../utils/task_canceller");
+/**
+ * `rtp`, for "REQUESTED_MAXIMUM_THROUGHPUT", indicates the maximum throughput
+ * needed to load a given segment without experience degration.
+ * It acts as a hint to a CDN so it can scale its resources between multiple
+ * clients.
+ *
+ * We could indicate through `rtp` the exact minimum bandwidth needed, but this
+ * may lead to much higher risk of rebuffering, so we prefer to multiply that
+ * value by a safe-enough factor, this `RTP_FACTOR`.
+ */
+var RTP_FACTOR = 4;
+/**
+ * Class allowing to easily obtain "Common Media Client Data" (CMCD) properties
+ * that may be relied on while performing HTTP(S) requests on a CDN.
+ *
+ * @class CmcdDataBuilder
+ */
+var CmcdDataBuilder = /** @class */ (function () {
+    /**
+     * Create a new `CmcdDataBuilder`, linked to the given options (see type
+     * definition).
+     * @param {Object} options
+     */
+    function CmcdDataBuilder(options) {
+        var _a, _b;
+        this._sessionId = (_a = options.sessionId) !== null && _a !== void 0 ? _a : (0, create_uuid_1.default)();
+        this._contentId = (_b = options.contentId) !== null && _b !== void 0 ? _b : (0, create_uuid_1.default)();
+        this._typePreference =
+            options.communicationType === "headers"
+                ? 0 /* TypePreference.Headers */
+                : 1 /* TypePreference.QueryString */;
+        this._bufferStarvationToggle = false;
+        this._playbackObserver = null;
+        this._lastThroughput = {};
+        this._canceller = null;
+    }
+    /**
+     * Start listening to the given `playbackObserver` so the `CmcdDataBuilder`
+     * can extract some playback-linked metadata that it needs.
+     *
+     * It will keep listening for media data until `stopMonitoringPlayback` is called.
+     *
+     * If `startMonitoringPlayback` is called again, the previous monitoring is
+     * also cancelled.
+     * @param {Object} playbackObserver
+     */
+    CmcdDataBuilder.prototype.startMonitoringPlayback = function (playbackObserver) {
+        var _this = this;
+        var _a;
+        (_a = this._canceller) === null || _a === void 0 ? void 0 : _a.cancel();
+        this._canceller = new task_canceller_1.default();
+        this._playbackObserver = playbackObserver;
+        playbackObserver.listen(function (obs) {
+            if (obs.rebuffering !== null) {
+                _this._bufferStarvationToggle = true;
+            }
+        }, { includeLastObservation: true, clearSignal: this._canceller.signal });
+    };
+    /**
+     * Stop the monitoring of playback conditions started from the last
+     * `stopMonitoringPlayback` call.
+     */
+    CmcdDataBuilder.prototype.stopMonitoringPlayback = function () {
+        var _a;
+        (_a = this._canceller) === null || _a === void 0 ? void 0 : _a.cancel();
+        this._canceller = null;
+        this._playbackObserver = null;
+    };
+    /**
+     * Update the last measured throughput for a specific media type.
+     * Needed for some of CMCD's properties.
+     * @param {string} trackType
+     * @param {number|undefined} throughput - Last throughput measured for that
+     * media type. `undefined` if unknown.
+     */
+    CmcdDataBuilder.prototype.updateThroughput = function (trackType, throughput) {
+        this._lastThroughput[trackType] = throughput;
+    };
+    /**
+     * Returns the base of data that is common to all resources' requests.
+     * @param {number|undefined} lastThroughput - The last measured throughput to
+     * provide. `undefined` to provide no throughput.
+     * @returns {Object}
+     */
+    CmcdDataBuilder.prototype._getCommonCmcdData = function (lastThroughput) {
+        var _a;
+        var props = {};
+        props.bs = this._bufferStarvationToggle;
+        this._bufferStarvationToggle = false;
+        props.cid = this._contentId;
+        props.mtp =
+            lastThroughput !== undefined
+                ? Math.floor(Math.round(lastThroughput / 1000 / 100) * 100)
+                : undefined;
+        props.sid = this._sessionId;
+        var lastObservation = (_a = this._playbackObserver) === null || _a === void 0 ? void 0 : _a.getReference().getValue();
+        props.pr =
+            lastObservation === undefined || lastObservation.speed === 1
+                ? undefined
+                : lastObservation.speed;
+        if (lastObservation !== undefined) {
+            props.su = lastObservation.rebuffering !== null;
+        }
+        return props;
+    };
+    /**
+     * For the given type of Manifest, returns the corresponding CMCD payload
+     * that should be provided alongside its request.
+     * @param {string} transportType
+     * @returns {Object}
+     */
+    CmcdDataBuilder.prototype.getCmcdDataForManifest = function (transportType) {
+        var _a;
+        var props = this._getCommonCmcdData((_a = this._lastThroughput.video) !== null && _a !== void 0 ? _a : this._lastThroughput.audio);
+        props.ot = "m";
+        switch (transportType) {
+            case "dash":
+                props.sf = "d";
+                break;
+            case "smooth":
+                props.sf = "s";
+                break;
+            default:
+                props.sf = "o";
+                break;
+        }
+        return this._producePayload(props);
+    };
+    /**
+     * For the given segment information, returns the corresponding CMCD payload
+     * that should be provided alongside its request.
+     * @param {Object} content
+     * @returns {Object}
+     */
+    CmcdDataBuilder.prototype.getCmcdDataForSegmentRequest = function (content) {
+        var e_1, _a;
+        var _b, _c, _d, _e;
+        var lastObservation = (_b = this._playbackObserver) === null || _b === void 0 ? void 0 : _b.getReference().getValue();
+        var props = this._getCommonCmcdData(this._lastThroughput[content.adaptation.type]);
+        props.br = Math.round(content.representation.bitrate / 1000);
+        props.d = Math.round(content.segment.duration * 1000);
+        // TODO nor (next object request) and nrr (next range request)
+        switch (content.adaptation.type) {
+            case "video":
+                props.ot = "v";
+                break;
+            case "audio":
+                props.ot = "a";
+                break;
+            case "text":
+                props.ot = "c";
+                break;
+        }
+        if (content.segment.isInit) {
+            props.ot = "i";
+        }
+        var precizeBufferLengthMs;
+        if (lastObservation !== undefined &&
+            (props.ot === "v" || props.ot === "a" || props.ot === "av")) {
+            var bufferedForType = lastObservation.buffered[content.adaptation.type];
+            if (!(0, is_null_or_undefined_1.default)(bufferedForType)) {
+                // TODO more precize position estimate?
+                var position = (_e = (_d = (_c = this._playbackObserver) === null || _c === void 0 ? void 0 : _c.getCurrentTime()) !== null && _d !== void 0 ? _d : lastObservation.position.getWanted()) !== null && _e !== void 0 ? _e : lastObservation.position.getPolled();
+                try {
+                    for (var bufferedForType_1 = __values(bufferedForType), bufferedForType_1_1 = bufferedForType_1.next(); !bufferedForType_1_1.done; bufferedForType_1_1 = bufferedForType_1.next()) {
+                        var range = bufferedForType_1_1.value;
+                        if (position >= range.start && position < range.end) {
+                            precizeBufferLengthMs = (range.end - position) * 1000;
+                            props.bl = Math.floor(Math.round(precizeBufferLengthMs / 100) * 100);
+                            break;
+                        }
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (bufferedForType_1_1 && !bufferedForType_1_1.done && (_a = bufferedForType_1.return)) _a.call(bufferedForType_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+            }
+        }
+        var precizeDeadlineMs = precizeBufferLengthMs === undefined || lastObservation === undefined
+            ? undefined
+            : precizeBufferLengthMs / lastObservation.speed;
+        props.dl =
+            precizeDeadlineMs === undefined
+                ? undefined
+                : Math.floor(Math.round(precizeDeadlineMs / 100) * 100);
+        if (precizeDeadlineMs !== undefined) {
+            // estimate the file size, in kilobits
+            var estimatedFileSizeKb = (content.representation.bitrate * content.segment.duration) / 1000;
+            var wantedCeilBandwidthKbps = estimatedFileSizeKb / (precizeDeadlineMs / 1000);
+            props.rtp = Math.floor(Math.round((wantedCeilBandwidthKbps * RTP_FACTOR) / 100) * 100);
+        }
+        switch (content.manifest.transport) {
+            case "dash":
+                props.sf = "d";
+                break;
+            case "smooth":
+                props.sf = "s";
+                break;
+            default:
+                props.sf = "o";
+                break;
+        }
+        props.st = content.manifest.isDynamic ? "l" : "v";
+        props.tb = content.adaptation.representations.reduce(function (acc, representation) {
+            if (representation.isSupported !== true ||
+                representation.decipherable === false) {
+                return acc;
+            }
+            if (acc === undefined) {
+                return Math.round(representation.bitrate / 1000);
+            }
+            return Math.max(acc, Math.round(representation.bitrate / 1000));
+        }, undefined);
+        return this._producePayload(props);
+    };
+    /**
+     * From the given CMCD properties, produce the corresponding payload according
+     * to current settings.
+     * @param {Object} props
+     * @returns {Object}
+     */
+    CmcdDataBuilder.prototype._producePayload = function (props) {
+        var _this = this;
+        var headers = {
+            object: "",
+            request: "",
+            session: "",
+            status: "",
+        };
+        var queryStringPayload = "";
+        var addPayload = function (payload, headerName) {
+            if (_this._typePreference === 0 /* TypePreference.Headers */) {
+                headers[headerName] += payload;
+            }
+            else {
+                queryStringPayload += payload;
+            }
+        };
+        var addNumberProperty = function (prop, headerName) {
+            var val = props[prop];
+            if (val !== undefined) {
+                var toAdd = "".concat(prop, "=").concat(String(val), ",");
+                addPayload(toAdd, headerName);
+            }
+        };
+        var addBooleanProperty = function (prop, headerName) {
+            if (props[prop] === true) {
+                var toAdd = "".concat(prop, ",");
+                addPayload(toAdd, headerName);
+            }
+        };
+        var addStringProperty = function (prop, headerName) {
+            var val = props[prop];
+            if (val !== undefined) {
+                var formatted = "\"".concat(val.replace("\\", "\\\\").replace('"', '\\"'), "\"");
+                var toAdd = "prop=".concat(formatted, ",");
+                addPayload(toAdd, headerName);
+            }
+        };
+        var addTokenProperty = function (prop, headerName) {
+            var val = props[prop];
+            if (val !== undefined) {
+                var toAdd = "prop=".concat(val, ",");
+                addPayload(toAdd, headerName);
+            }
+        };
+        addNumberProperty("br", "object");
+        addNumberProperty("bl", "request");
+        addBooleanProperty("bs", "status");
+        addStringProperty("cid", "session");
+        addNumberProperty("d", "object");
+        addNumberProperty("dl", "request");
+        addNumberProperty("mtp", "request");
+        addTokenProperty("ot", "object");
+        addNumberProperty("pr", "session");
+        addNumberProperty("rtp", "status");
+        addTokenProperty("sf", "session");
+        addStringProperty("sid", "session");
+        addTokenProperty("st", "session");
+        addBooleanProperty("su", "request");
+        addNumberProperty("tb", "object");
+        if (this._typePreference === 0 /* TypePreference.Headers */) {
+            if (headers.object[headers.object.length - 1] === ",") {
+                headers.object = headers.object.substring(0, headers.object.length - 1);
+            }
+            if (headers.request[headers.request.length - 1] === ",") {
+                headers.request = headers.request.substring(0, headers.request.length - 1);
+            }
+            if (headers.session[headers.session.length - 1] === ",") {
+                headers.session = headers.session.substring(0, headers.session.length - 1);
+            }
+            if (headers.status[headers.status.length - 1] === ",") {
+                headers.status = headers.status.substring(0, headers.status.length - 1);
+            }
+            log_1.default.debug("CMCD: proposing headers payload");
+            return {
+                type: "headers",
+                value: {
+                    /* eslint-disable @typescript-eslint/naming-convention */
+                    "CMCD-Object": headers.object,
+                    "CMCD-Request": headers.request,
+                    "CMCD-Session": headers.session,
+                    "CMCD-Status": headers.status,
+                    /* eslint-enable @typescript-eslint/naming-convention */
+                },
+            };
+        }
+        if (queryStringPayload[queryStringPayload.length - 1] === ",") {
+            queryStringPayload = queryStringPayload.substring(0, queryStringPayload.length - 1);
+        }
+        queryStringPayload = encodeURIComponent(queryStringPayload);
+        log_1.default.debug("CMCD: proposing query string payload", queryStringPayload);
+        return {
+            type: "query",
+            value: [["CMCD", queryStringPayload]],
+        };
+    };
+    return CmcdDataBuilder;
+}());
+exports.default = CmcdDataBuilder;

package/dist/commonjs/core/cmcd/index.d.ts

@@ -0,0 +1,4 @@
+import CmcdDataBuilder from "./cmcd_data_builder";
+export type { ICmcdSegmentInfo, ICmcdDataBuilderPlaybackObservation, } from "./cmcd_data_builder";
+export default CmcdDataBuilder;
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/core/cmcd/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/cmcd/index.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,qBAAqB,CAAC;AAElD,YAAY,EACV,gBAAgB,EAChB,mCAAmC,GACpC,MAAM,qBAAqB,CAAC;AAC7B,eAAe,eAAe,CAAC"}

package/dist/commonjs/core/cmcd/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var cmcd_data_builder_1 = require("./cmcd_data_builder");
+exports.default = cmcd_data_builder_1.default;

package/dist/commonjs/core/fetchers/manifest/manifest_fetcher.d.ts

@@ -17,6 +17,7 @@ import Manifest from "../../../manifest/classes";
 import type { IInitialManifest, IPlayerError } from "../../../public_types";
 import type { ITransportPipelines } from "../../../transports";
 import EventEmitter from "../../../utils/event_emitter";
+import type CmcdDataBuilder from "../../cmcd";
 /**
  * Class allowing to facilitate the task of loading and parsing a Manifest, as
  * well as automatically refreshing it.
@@ -33,6 +34,8 @@ export default class ManifestFetcher extends EventEmitter<IManifestFetcherEvent>
     private _settings;
     /** URLs through which the Manifest may be reached, by order of priority. */
     private _manifestUrls;
+    /** Name of the current transport pipeline used. */
+    private _transportName;
     /**
      * Manifest loading and parsing pipelines linked to the current transport
      * protocol used.
@@ -184,6 +187,11 @@ export interface IManifestFetcherSettings {
      * request.
      */
     initialManifest: IInitialManifest | undefined;
+    /**
+     * Optional module allowing to collect "Common Media Client Data" (a.k.a. CMCD)
+     * for the CDN.
+     */
+    cmcdDataBuilder: CmcdDataBuilder | null;
 }
 /** Event sent by the `ManifestFetcher`. */
 export interface IManifestFetcherEvent {

package/dist/commonjs/core/fetchers/manifest/manifest_fetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest_fetcher.d.ts","sourceRoot":"","sources":["../../../../../src/core/fetchers/manifest/manifest_fetcher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,QAAQ,MAAM,2BAA2B,CAAC;AACjD,OAAO,KAAK,EACV,gBAAgB,EAEhB,YAAY,EACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAGV,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAQxD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,YAAY,CAAC,qBAAqB,CAAC;IAC9E;;;;OAIG;IACI,qBAAqB,EAAE,CAAC,QAAQ,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAE3E,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAA2B;IAC5C,4EAA4E;IAC5E,OAAO,CAAC,aAAa,CAAuB;IAC5C;;;OAGG;IACH,OAAO,CAAC,UAAU,CAA6B;IAC/C;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAgB;IAClC;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAU;IAC5B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAC;IAC1B,sFAAsF;IACtF,OAAO,CAAC,sBAAsB,CAAC;IAC/B;;;OAGG;IACH,OAAO,CAAC,sBAAsB,CAA4B;IAE1D;;;;;;;;;OASG;gBAED,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,EAC1B,SAAS,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,wBAAwB;IAcpC;;;;;OAKG;IACI,OAAO;IAKd;;;;;;OAMG;IACI,KAAK,IAAI,IAAI;IAiCpB;;;;;;OAMG;IACI,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI;IAW/E;;;;;;;;;;;OAWG;YACW,cAAc;IAkE5B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,KAAK;IAYb;;;;;;;;OAQG;YACW,oBAAoB;IA+FlC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IA+KnC;;;;;;OAMG;IACH,OAAO,CAAC,2BAA2B;IA2GnC,OAAO,CAAC,aAAa;CAOtB;AAqDD,+CAA+C;AAC/C,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB,iEAAiE;IACjE,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,6BAA6B,EAAE,MAAM,CAAC;IACtC;;;OAGG;IACH,eAAe,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC/C;AAED,2CAA2C;AAC3C,MAAM,WAAW,qBAAqB;IACpC,mFAAmF;IACnF,OAAO,EAAE,YAAY,CAAC;IACtB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IACf,4DAA4D;IAC5D,aAAa,EAAE,QAAQ,CAAC;CACzB;AAED,wDAAwD;AACxD,MAAM,WAAW,wBAAwB;IACvC;;;;;;;;;;;;OAYG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B"}
+{"version":3,"file":"manifest_fetcher.d.ts","sourceRoot":"","sources":["../../../../../src/core/fetchers/manifest/manifest_fetcher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,QAAQ,MAAM,2BAA2B,CAAC;AACjD,OAAO,KAAK,EACV,gBAAgB,EAEhB,YAAY,EACb,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAKV,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAIxD,OAAO,KAAK,eAAe,MAAM,YAAY,CAAC;AAK9C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,YAAY,CAAC,qBAAqB,CAAC;IAC9E;;;;OAIG;IACI,qBAAqB,EAAE,CAAC,QAAQ,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAE3E,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAA2B;IAC5C,4EAA4E;IAC5E,OAAO,CAAC,aAAa,CAAuB;IAC5C,mDAAmD;IACnD,OAAO,CAAC,cAAc,CAAiB;IACvC;;;OAGG;IACH,OAAO,CAAC,UAAU,CAA6B;IAC/C;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAgB;IAClC;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAU;IAC5B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAC;IAC1B,sFAAsF;IACtF,OAAO,CAAC,sBAAsB,CAAC;IAC/B;;;OAGG;IACH,OAAO,CAAC,sBAAsB,CAA4B;IAE1D;;;;;;;;;OASG;gBAED,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,EAC1B,SAAS,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,wBAAwB;IAepC;;;;;OAKG;IACI,OAAO;IAKd;;;;;;OAMG;IACI,KAAK,IAAI,IAAI;IAiCpB;;;;;;OAMG;IACI,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI;IAW/E;;;;;;;;;;;OAWG;YACW,cAAc;IAgE5B;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,KAAK;IAYb;;;;;;;;OAQG;YACW,oBAAoB;IA+FlC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IA+KnC;;;;;;OAMG;IACH,OAAO,CAAC,2BAA2B;IA2GnC,OAAO,CAAC,aAAa;CAOtB;AAqDD,+CAA+C;AAC/C,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB,iEAAiE;IACjE,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,+CAA+C;IAC/C,6BAA6B,EAAE,MAAM,CAAC;IACtC;;;OAGG;IACH,eAAe,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC9C;;;OAGG;IACH,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;CACzC;AAED,2CAA2C;AAC3C,MAAM,WAAW,qBAAqB;IACpC,mFAAmF;IACnF,OAAO,EAAE,YAAY,CAAC;IACtB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IACf,4DAA4D;IAC5D,aAAa,EAAE,QAAQ,CAAC;CACzB;AAED,wDAAwD;AACxD,MAAM,WAAW,wBAAwB;IACvC;;;;;;;;;;;;OAYG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B"}

package/dist/commonjs/core/fetchers/manifest/manifest_fetcher.js

@@ -109,6 +109,7 @@ var ManifestFetcher = /** @class */ (function (_super) {
         _this.scheduleManualRefresh = noop_1.default;
         _this._manifestUrls = urls;
         _this._pipelines = pipelines.manifest;
+        _this._transportName = pipelines.transportName;
         _this._settings = settings;
         _this._canceller = new task_canceller_1.default();
         _this._isStarted = false;
@@ -193,7 +194,6 @@ var ManifestFetcher = /** @class */ (function (_super) {
      * @returns {Promise}
      */
     ManifestFetcher.prototype._fetchManifest = function (url) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
             /**
              * Call the loader part of the pipeline, retrying if it fails according
@@ -203,6 +203,7 @@ var ManifestFetcher = /** @class */ (function (_super) {
              * @returns {Promise}
              */
             function callLoaderWithRetries(manifestUrl) {
+                var _a;
                 var loadManifest = pipelines.loadManifest;
                 var requestTimeout = settings.requestTimeout === undefined
                     ? config_1.default.getCurrent().DEFAULT_REQUEST_TIMEOUT
@@ -216,21 +217,23 @@ var ManifestFetcher = /** @class */ (function (_super) {
                 if (connectionTimeout < 0) {
                     connectionTimeout = undefined;
                 }
-                var callLoader = function () {
-                    return loadManifest(manifestUrl, {
-                        timeout: requestTimeout,
-                        connectionTimeout: connectionTimeout,
-                    }, cancelSignal);
+                var requestOptions = {
+                    timeout: requestTimeout,
+                    connectionTimeout: connectionTimeout,
+                    cmcdPayload: (_a = settings.cmcdDataBuilder) === null || _a === void 0 ? void 0 : _a.getCmcdDataForManifest(transportName),
                 };
+                var callLoader = function () { return loadManifest(manifestUrl, requestOptions, cancelSignal); };
                 return (0, schedule_request_1.scheduleRequestPromise)(callLoader, backoffSettings, cancelSignal);
             }
-            var cancelSignal, settings, pipelines, requestUrl, backoffSettings, response_1, err_1;
+            var cancelSignal, settings, transportName, pipelines, requestUrl, backoffSettings, response_1, err_1;
             var _this = this;
+            var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         cancelSignal = this._canceller.signal;
                         settings = this._settings;
+                        transportName = this._transportName;
                         pipelines = this._pipelines;
                         requestUrl = url !== null && url !== void 0 ? url : (_a = this._manifestUrls) === null || _a === void 0 ? void 0 : _a[0];
                         backoffSettings = this._getBackoffSetting(function (err) {
@@ -280,7 +283,6 @@ var ManifestFetcher = /** @class */ (function (_super) {
      * @returns {Promise}
      */
     ManifestFetcher.prototype._parseLoadedManifest = function (loaded, parserOptions, requestUrl) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
             /**
              * Perform a request with the same retry mechanisms and error handling
@@ -345,8 +347,9 @@ var ManifestFetcher = /** @class */ (function (_super) {
                 log_1.default.info("MF: Manifest parsed in ".concat(parsingTime, "ms"));
                 return { manifest: manifest, sendingTime: sendingTime, receivedTime: receivedTime, parsingTime: parsingTime };
             }
-            var parsingTimeStart, cancelSignal, trigger, sendingTime, receivedTime, backoffSettings, originalUrl, opts, res, _b, manifest, warnings, err_2, formattedError;
+            var parsingTimeStart, cancelSignal, trigger, sendingTime, receivedTime, backoffSettings, originalUrl, opts, res, _a, manifest, warnings, err_2, formattedError;
             var _this = this;
+            var _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -357,7 +360,7 @@ var ManifestFetcher = /** @class */ (function (_super) {
                         backoffSettings = this._getBackoffSetting(function (err) {
                             _this.trigger("warning", (0, error_selector_1.default)(err));
                         });
-                        originalUrl = requestUrl !== null && requestUrl !== void 0 ? requestUrl : (_a = this._manifestUrls) === null || _a === void 0 ? void 0 : _a[0];
+                        originalUrl = requestUrl !== null && requestUrl !== void 0 ? requestUrl : (_b = this._manifestUrls) === null || _b === void 0 ? void 0 : _b[0];
                         opts = {
                             externalClockOffset: parserOptions.externalClockOffset,
                             unsafeMode: parserOptions.unsafeMode,
@@ -372,7 +375,7 @@ var ManifestFetcher = /** @class */ (function (_super) {
                         return [2 /*return*/, finish(res.manifest, res.warnings)];
                     case 2: return [4 /*yield*/, res];
                     case 3:
-                        _b = _c.sent(), manifest = _b.manifest, warnings = _b.warnings;
+                        _a = _c.sent(), manifest = _a.manifest, warnings = _a.warnings;
                         return [2 /*return*/, finish(manifest, warnings)];
                     case 4: return [3 /*break*/, 6];
                     case 5:

package/dist/commonjs/core/fetchers/segment/prioritized_segment_fetcher.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = applyPrioritizerToSegmentFetcher;
 var log_1 = require("../../../log");
 /**
  * This function basically put in relation:
@@ -67,4 +68,3 @@ function applyPrioritizerToSegmentFetcher(prioritizer, fetcher) {
         },
     };
 }
-exports.default = applyPrioritizerToSegmentFetcher;

package/dist/commonjs/core/fetchers/segment/segment_fetcher.d.ts

@@ -18,33 +18,19 @@ import type { IPlayerError } from "../../../public_types";
 import type { ISegmentParserParsedInitChunk, ISegmentParserParsedMediaChunk, ISegmentPipeline } from "../../../transports";
 import type { CancellationSignal } from "../../../utils/task_canceller";
 import type { IMetricsCallbackPayload, IRequestBeginCallbackPayload, IRequestEndCallbackPayload, IRequestProgressCallbackPayload } from "../../adaptive";
+import type CmcdDataBuilder from "../../cmcd";
 import type { IBufferType } from "../../segment_sinks";
 import type CdnPrioritizer from "../cdn_prioritizer";
 /**
  * Create an `ISegmentFetcher` object which will allow to easily fetch and parse
  * segments.
  * An `ISegmentFetcher` also implements a retry mechanism, based on the given
- * `options` argument, which may retry a segment request when it fails.
+ * `requestOptions` argument, which may retry a segment request when it fails.
  *
- * @param {string} bufferType - Type of  buffer concerned (e.g. `"audio"`,
- * `"video"`, `"text" etc.)
- * @param {Object} pipeline - The transport-specific logic allowing to load
- * segments of the given buffer type and transport protocol (e.g. DASH).
- * @param {Object|null} cdnPrioritizer - Abstraction allowing to synchronize,
- * update and keep track of the priorization of the CDN to use to load any given
- * segment, in cases where multiple ones are available.
- *
- * Can be set to `null` in which case a minimal priorization logic will be used
- * instead.
- * @param {Object} lifecycleCallbacks - Callbacks that can be registered to be
- * informed when new requests are made, ended, new metrics are available etc.
- * This should be mainly useful to implement an adaptive logic relying on those
- * metrics and events.
- * @param {Object} options - Various tweaking options allowing to configure the
- * behavior of the returned `ISegmentFetcher`.
+ * @param {Object} args
  * @returns {Function}
  */
-export default function createSegmentFetcher<TLoadedFormat, TSegmentDataType>(bufferType: IBufferType, pipeline: ISegmentPipeline<TLoadedFormat, TSegmentDataType>, cdnPrioritizer: CdnPrioritizer | null, lifecycleCallbacks: ISegmentFetcherLifecycleCallbacks, options: ISegmentFetcherOptions): ISegmentFetcher<TSegmentDataType>;
+export default function createSegmentFetcher<TLoadedFormat, TSegmentDataType>({ bufferType, pipeline, cdnPrioritizer, cmcdDataBuilder, eventListeners, requestOptions, }: ISegmentFetcherArguments<TLoadedFormat, TSegmentDataType>): ISegmentFetcher<TSegmentDataType>;
 /**
  * Defines the `ISegmentFetcher` function which allows to load a single segment.
  *
@@ -112,7 +98,7 @@ export interface ISegmentFetcherLifecycleCallbacks {
      */
     onMetrics?: (arg: IMetricsCallbackPayload) => void;
 }
-/** Options allowing to configure an `ISegmentFetcher`'s behavior. */
+/** requestOptions allowing to configure an `ISegmentFetcher`'s behavior. */
 export interface ISegmentFetcherOptions {
     /**
      * Initial delay to wait if a request fails before making a new request, in
@@ -130,7 +116,7 @@ export interface ISegmentFetcherOptions {
      */
     maxRetry: number;
     /**
-     * Timeout after which request are aborted and, depending on other options,
+     * Timeout after which request are aborted and, depending on other requestOptions,
      * retried.
      * To set to `-1` for no timeout.
      */
@@ -143,14 +129,48 @@ export interface ISegmentFetcherOptions {
     connectionTimeout: number | undefined;
 }
 /**
- * @param {string} bufferType
- * @param {Object}
+ * @param {Object} baseOptions
  * @returns {Object}
  */
-export declare function getSegmentFetcherOptions({ maxRetry, lowLatencyMode, requestTimeout, connectionTimeout, }: {
+export declare function getSegmentFetcherRequestOptions({ maxRetry, lowLatencyMode, requestTimeout, connectionTimeout, }: {
     maxRetry?: number | undefined;
     requestTimeout?: number | undefined;
     connectionTimeout?: number | undefined;
     lowLatencyMode: boolean;
 }): ISegmentFetcherOptions;
+export interface ISegmentFetcherArguments<TLoadedFormat, TSegmentDataType> {
+    /** Type of  buffer concerned (e.g. `"audio"`, `"video"`, `"text" etc.) */
+    bufferType: IBufferType;
+    /**
+     * The transport-specific logic allowing to load segments of the given buffer
+     * type and transport protocol (e.g. DASH).
+     */
+    pipeline: ISegmentPipeline<TLoadedFormat, TSegmentDataType>;
+    /**
+     * Abstraction allowing to synchronize, update and keep track of the
+     * priorization of the CDN to use to load any given segment, in cases where
+     * multiple ones are available.
+     *
+     * Can be set to `null` in which case a minimal priorization logic will be used
+     * instead.
+     */
+    cdnPrioritizer: CdnPrioritizer | null;
+    /**
+     * Optional module allowing to collect "Common Media Client Data" (a.k.a. CMCD)
+     * for the CDN.
+     */
+    cmcdDataBuilder: CmcdDataBuilder | null;
+    /**
+     * Callbacks that can be registered to be informed when new requests are made,
+     * ended, new metrics are available etc.
+     * This should be mainly useful to implement an adaptive logic relying on those
+     * metrics and events.
+     */
+    eventListeners: ISegmentFetcherLifecycleCallbacks;
+    /**
+     * Various tweaking requestOptions allowing to configure the behavior of the returned
+     * `ISegmentFetcher` regarding segment requests.
+     */
+    requestOptions: ISegmentFetcherOptions;
+}
 //# sourceMappingURL=segment_fetcher.d.ts.map

package/dist/commonjs/core/fetchers/segment/segment_fetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"segment_fetcher.d.ts","sourceRoot":"","sources":["../../../../../src/core/fetchers/segment/segment_fetcher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,QAAQ,EACR,OAAO,EACP,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAIV,6BAA6B,EAC7B,8BAA8B,EAC9B,gBAAgB,EACjB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAExE,OAAO,KAAK,EACV,uBAAuB,EACvB,4BAA4B,EAC5B,0BAA0B,EAC1B,+BAA+B,EAChC,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,cAAc,MAAM,oBAAoB,CAAC;AAQrD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,aAAa,EAAE,gBAAgB,EAC1E,UAAU,EAAE,WAAW,EACvB,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,CAAC,EAC3D,cAAc,EAAE,cAAc,GAAG,IAAI,EACrC,kBAAkB,EAAE,iCAAiC,EACrD,OAAO,EAAE,sBAAsB,GAC9B,eAAe,CAAC,gBAAgB,CAAC,CAiSnC;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,gBAAgB,IAAI;AAC9C,yCAAyC;AACzC,OAAO,EAAE,qBAAqB;AAC9B,sEAAsE;AACtE,SAAS,EAAE,wBAAwB,CAAC,gBAAgB,CAAC;AACrD,yDAAyD;AACzD,kBAAkB,EAAE,kBAAkB,KACnC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;GAGG;AACH,MAAM,WAAW,wBAAwB,CAAC,gBAAgB;IACxD,uEAAuE;IACvE,OAAO,CACL,KAAK,EAAE,CACL,aAAa,EAAE,MAAM,GAAG,SAAS,KAE/B,6BAA6B,CAAC,gBAAgB,CAAC,GAC/C,8BAA8B,CAAC,gBAAgB,CAAC,GACnD,IAAI,CAAC;IAER;;;;;;OAMG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;CACpC;AAED,6EAA6E;AAC7E,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,WAAW,CAAC;IACxB,cAAc,EAAE,eAAe,CAAC;IAChC,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,4CAA4C;IAC5C,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,4BAA4B,KAAK,IAAI,CAAC;IAC7D,kFAAkF;IAClF,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,+BAA+B,KAAK,IAAI,CAAC;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACzD;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,uBAAuB,KAAK,IAAI,CAAC;CACpD;AAED,qEAAqE;AACrE,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,EACR,cAAc,EACd,cAAc,EACd,iBAAiB,GAClB,EAAE;IACD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,cAAc,EAAE,OAAO,CAAC;CACzB,GAAG,sBAAsB,CAqBzB"}
+{"version":3,"file":"segment_fetcher.d.ts","sourceRoot":"","sources":["../../../../../src/core/fetchers/segment/segment_fetcher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,QAAQ,EACR,OAAO,EACP,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAMV,6BAA6B,EAC7B,8BAA8B,EAC9B,gBAAgB,EACjB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAExE,OAAO,KAAK,EACV,uBAAuB,EACvB,4BAA4B,EAC5B,0BAA0B,EAC1B,+BAA+B,EAChC,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,eAAe,MAAM,YAAY,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,cAAc,MAAM,oBAAoB,CAAC;AAQrD;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAAC,aAAa,EAAE,gBAAgB,EAAE,EAC5E,UAAU,EACV,QAAQ,EACR,cAAc,EACd,eAAe,EACf,cAAc,EACd,cAAc,GACf,EAAE,wBAAwB,CACzB,aAAa,EACb,gBAAgB,CACjB,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAwSpC;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,gBAAgB,IAAI;AAC9C,yCAAyC;AACzC,OAAO,EAAE,qBAAqB;AAC9B,sEAAsE;AACtE,SAAS,EAAE,wBAAwB,CAAC,gBAAgB,CAAC;AACrD,yDAAyD;AACzD,kBAAkB,EAAE,kBAAkB,KACnC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;GAGG;AACH,MAAM,WAAW,wBAAwB,CAAC,gBAAgB;IACxD,uEAAuE;IACvE,OAAO,CACL,KAAK,EAAE,CACL,aAAa,EAAE,MAAM,GAAG,SAAS,KAE/B,6BAA6B,CAAC,gBAAgB,CAAC,GAC/C,8BAA8B,CAAC,gBAAgB,CAAC,GACnD,IAAI,CAAC;IAER;;;;;;OAMG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;CACpC;AAED,6EAA6E;AAC7E,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,WAAW,CAAC;IACxB,cAAc,EAAE,eAAe,CAAC;IAChC,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,4CAA4C;IAC5C,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,4BAA4B,KAAK,IAAI,CAAC;IAC7D,kFAAkF;IAClF,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,+BAA+B,KAAK,IAAI,CAAC;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACzD;;;;;OAKG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,uBAAuB,KAAK,IAAI,CAAC;CACpD;AAED,4EAA4E;AAC5E,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,EAC9C,QAAQ,EACR,cAAc,EACd,cAAc,EACd,iBAAiB,GAClB,EAAE;IACD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,cAAc,EAAE,OAAO,CAAC;CACzB,GAAG,sBAAsB,CAqBzB;AAED,MAAM,WAAW,wBAAwB,CAAC,aAAa,EAAE,gBAAgB;IACvE,0EAA0E;IAC1E,UAAU,EAAE,WAAW,CAAC;IACxB;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAC5D;;;;;;;OAOG;IACH,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IACtC;;;OAGG;IACH,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC;;;;;OAKG;IACH,cAAc,EAAE,iCAAiC,CAAC;IAClD;;;OAGG;IACH,cAAc,EAAE,sBAAsB,CAAC;CACxC"}