Integrate CMCD data into outgoing requests.

.gitignore

@@ -38,3 +38,6 @@ Generated\ Files/
 _ReSharper*/
 *.[Rr]e[Ss]harper
 *.DotSettings.user
+
+# VSCode custom workspace settings
+.vscode/settings.json

api-extractor/report/hls.js.api.md

@@ -123,7 +123,7 @@ export class BaseSegment {
     // (undocumented)
     get url(): string;
     set url(value: string);
-    }
+}
 
 // Warning: (ae-missing-release-tag) "BufferAppendedData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -251,6 +251,16 @@ export class ChunkMetadata {
     readonly transmuxing: HlsChunkPerformanceTiming;
 }
 
+// Warning: (ae-missing-release-tag) "CMCDControllerConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type CMCDControllerConfig = {
+    cmcdEnabled: boolean;
+    cmcdSessionId?: string;
+    cmcdContentId?: string;
+    cmcdUseHeaders?: boolean;
+};
+
 // Warning: (ae-missing-release-tag) "CuesInterface" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -839,7 +849,7 @@ class Hls implements HlsEventEmitter {
     // (undocumented)
     readonly config: HlsConfig;
     // (undocumented)
-    createController(ControllerClass: any, fragmentTracker: any, components: any): any;
+    createController(ControllerClass: any, fragmentTracker: any, components: any, loaderContextSetup?: any): any;
     get currentLevel(): number;
     // Warning: (ae-setter-with-docs) The doc comment for the property "currentLevel" must appear on the getter, not the setter.
     set currentLevel(newLevel: number);
@@ -925,7 +935,6 @@ class Hls implements HlsEventEmitter {
     // (undocumented)
     static get version(): string;
 }
-
 export default Hls;
 
 // Warning: (ae-missing-release-tag) "HlsChunkPerformanceTiming" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -963,7 +972,7 @@ export type HlsConfig = {
     fpsController: typeof FPSController;
     progressive: boolean;
     lowLatencyMode: boolean;
-} & ABRControllerConfig & BufferControllerConfig & CapLevelControllerConfig & EMEControllerConfig & FPSControllerConfig & FragmentLoaderConfig & LevelControllerConfig & MP4RemuxerConfig & PlaylistLoaderConfig & StreamControllerConfig & LatencyControllerConfig & TimelineControllerConfig & TSDemuxerConfig;
+} & ABRControllerConfig & BufferControllerConfig & CapLevelControllerConfig & CMCDControllerConfig & EMEControllerConfig & FPSControllerConfig & FragmentLoaderConfig & LevelControllerConfig & MP4RemuxerConfig & PlaylistLoaderConfig & StreamControllerConfig & LatencyControllerConfig & TimelineControllerConfig & TSDemuxerConfig;
 
 // Warning: (ae-missing-release-tag) "HlsEventEmitter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -1426,7 +1435,7 @@ export class LevelKey {
     method: string | null;
     // (undocumented)
     get uri(): string | null;
-    }
+}
 
 // Warning: (ae-missing-release-tag) "LevelLoadedData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -1605,6 +1614,8 @@ export interface LoaderConfiguration {
 //
 // @public (undocumented)
 export interface LoaderContext {
+    // (undocumented)
+    headers?: Record<string, string>;
     // (undocumented)
     progressData?: boolean;
     // (undocumented)
@@ -2124,20 +2135,19 @@ export interface UserdataSample {
     pts: number;
 }
 
-
 // Warnings were encountered during analysis:
 //
-// src/config.ts:148:3 - (ae-forgotten-export) The symbol "ILogger" needs to be exported by the entry point hls.d.ts
-// src/config.ts:157:3 - (ae-forgotten-export) The symbol "AudioStreamController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:158:3 - (ae-forgotten-export) The symbol "AudioTrackController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:160:3 - (ae-forgotten-export) The symbol "SubtitleStreamController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:161:3 - (ae-forgotten-export) The symbol "SubtitleTrackController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:162:3 - (ae-forgotten-export) The symbol "TimelineController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:164:3 - (ae-forgotten-export) The symbol "EMEController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:166:3 - (ae-forgotten-export) The symbol "AbrController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:167:3 - (ae-forgotten-export) The symbol "BufferController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:168:3 - (ae-forgotten-export) The symbol "CapLevelController" needs to be exported by the entry point hls.d.ts
-// src/config.ts:169:3 - (ae-forgotten-export) The symbol "FPSController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:155:3 - (ae-forgotten-export) The symbol "ILogger" needs to be exported by the entry point hls.d.ts
+// src/config.ts:164:3 - (ae-forgotten-export) The symbol "AudioStreamController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:165:3 - (ae-forgotten-export) The symbol "AudioTrackController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:167:3 - (ae-forgotten-export) The symbol "SubtitleStreamController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:168:3 - (ae-forgotten-export) The symbol "SubtitleTrackController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:169:3 - (ae-forgotten-export) The symbol "TimelineController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:171:3 - (ae-forgotten-export) The symbol "EMEController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:173:3 - (ae-forgotten-export) The symbol "AbrController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:174:3 - (ae-forgotten-export) The symbol "BufferController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:175:3 - (ae-forgotten-export) The symbol "CapLevelController" needs to be exported by the entry point hls.d.ts
+// src/config.ts:176:3 - (ae-forgotten-export) The symbol "FPSController" needs to be exported by the entry point hls.d.ts
 
 // (No @packageDocumentation comment for this package)
 

demo/basic-usage.html

@@ -25,7 +25,7 @@ <h1>Hls.js demo - basic usage</h1>
         });
       }
       // hls.js is not supported on platforms that do not have Media Source Extensions (MSE) enabled.
-      // When the browser has built-in HLS support (check using `canPlayType`), we can provide an HLS manifest (i.e. .m3u8 URL) directly to the video element throught the `src` property.
+      // When the browser has built-in HLS support (check using `canPlayType`), we can provide an HLS manifest (i.e. .m3u8 URL) directly to the video element through the `src` property.
       // This is using the built-in support of the plain video element, without using hls.js.
       else if (video.canPlayType('application/vnd.apple.mpegurl')) {
         video.src = 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8';

docs/API.md

@@ -94,6 +94,10 @@
   - [`licenseResponseCallback`](#licenseResponseCallback)
   - [`drmSystemOptions`](#drmSystemOptions)
   - [`requestMediaKeySystemAccessFunc`](#requestMediaKeySystemAccessFunc)
+  - [`cmcdEnabled`](#cmcdEnabled)
+  - [`cmcdSessionId`](#cmcdSessionId)
+  - [`cmcdContentId`](#cmcdContentId)
+  - [`cmcdUseHeaders`](#cmcdUseHeaders)
 - [Video Binding/Unbinding API](#video-bindingunbinding-api)
   - [`hls.attachMedia(videoElement)`](#hlsattachmediavideoelement)
   - [`hls.detachMedia()`](#hlsdetachmedia)
@@ -391,6 +395,10 @@ var config = {
   licenseXhrSetup: undefined,
   drmSystemOptions: {},
   requestMediaKeySystemAccessFunc: requestMediaKeySystemAccess,
+  cmcdEnabled: false,
+  cmcdSessionId: undefined,
+  cmcdContentId: undefined,
+  cmcdUseHeaders: false,
 };
 
 var hls = new Hls(config);
@@ -1192,6 +1200,23 @@ With the default argument, `''` will be specified for each option (_i.e. no spec
 
 Allows for the customization of `window.navigator.requestMediaKeySystemAccess`.
 
+### `cmcdEnabled`
+
+Enabled the passing of [Common Media Client Data (CMCD)](https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf)
+on all media requests (manifests, playlists, a/v segments, timed text).
+
+### `cmcdSession`
+
+The CMCD session id. One will be automatically generated if none is provided.
+
+### `cmcdContent`
+
+The CMCD content id.
+
+### `cmcdUseHeaders`
+
+Send CMCD data in request headers instead of as query args.
+
 ## Video Binding/Unbinding API
 
 ### `hls.attachMedia(videoElement)`

src/config.ts

@@ -47,6 +47,13 @@ export type CapLevelControllerConfig = {
   capLevelToPlayerSize: boolean;
 };
 
+export type CMCDControllerConfig = {
+  cmcdEnabled: boolean;
+  cmcdSessionId?: string;
+  cmcdContentId?: string;
+  cmcdUseHeaders?: boolean;
+};
+
 export type DRMSystemOptions = {
   audioRobustness?: string;
   videoRobustness?: string;
@@ -172,6 +179,7 @@ export type HlsConfig = {
 } & ABRControllerConfig &
   BufferControllerConfig &
   CapLevelControllerConfig &
+  CMCDControllerConfig &
   EMEControllerConfig &
   FPSControllerConfig &
   FragmentLoaderConfig &
@@ -261,6 +269,10 @@ export const hlsDefaultConfig: HlsConfig = {
   testBandwidth: true,
   progressive: false,
   lowLatencyMode: true,
+  cmcdEnabled: false,
+  cmcdSessionId: undefined,
+  cmcdContentId: undefined,
+  cmcdUseHeaders: false,
 
   // Dynamic Modules
   ...timelineConfig(),

src/controller/audio-stream-controller.ts

@@ -3,7 +3,7 @@ import { Events } from '../events';
 import { BufferHelper } from '../utils/buffer-helper';
 import { FragmentState } from './fragment-tracker';
 import { Level } from '../types/level';
-import { PlaylistLevelType } from '../types/loader';
+import { FragmentLoaderContextSetup, PlaylistLevelType } from '../types/loader';
 import { Fragment, ElementaryStreamTypes, Part } from '../loader/fragment';
 import ChunkCache from '../demux/chunk-cache';
 import TransmuxerInterface from '../demux/transmuxer-interface';
@@ -56,8 +56,12 @@ class AudioStreamController
   private mainDetails: LevelDetails | null = null;
   private bufferFlushed: boolean = false;
 
-  constructor(hls: Hls, fragmentTracker: FragmentTracker) {
-    super(hls, fragmentTracker, '[audio-stream-controller]');
+  constructor(
+    hls: Hls,
+    fragmentTracker: FragmentTracker,
+    contextSetup: FragmentLoaderContextSetup
+  ) {
+    super(hls, fragmentTracker, contextSetup, '[audio-stream-controller]');
     this._registerListeners();
   }
 

src/controller/base-stream-controller.ts

@@ -35,7 +35,7 @@ import {
 } from '../types/events';
 import Decrypter from '../crypt/decrypter';
 import TimeRanges from '../utils/time-ranges';
-import { PlaylistLevelType } from '../types/loader';
+import { FragmentLoaderContextSetup, PlaylistLevelType } from '../types/loader';
 import type { FragmentTracker } from './fragment-tracker';
 import type { Level } from '../types/level';
 import type { RemuxedTrack } from '../types/remuxer';
@@ -93,18 +93,25 @@ export default class BaseStreamController
   protected initPTS: Array<number> = [];
   protected onvseeking: EventListener | null = null;
   protected onvended: EventListener | null = null;
+  protected contextSetup: FragmentLoaderContextSetup;
 
   private readonly logPrefix: string = '';
   protected log: (msg: any) => void;
   protected warn: (msg: any) => void;
 
-  constructor(hls: Hls, fragmentTracker: FragmentTracker, logPrefix: string) {
+  constructor(
+    hls: Hls,
+    fragmentTracker: FragmentTracker,
+    contextSetup: FragmentLoaderContextSetup,
+    logPrefix: string
+  ) {
     super();
     this.logPrefix = logPrefix;
     this.log = logger.log.bind(logger, `${logPrefix}:`);
     this.warn = logger.warn.bind(logger, `${logPrefix}:`);
     this.hls = hls;
-    this.fragmentLoader = new FragmentLoader(hls.config);
+    this.contextSetup = contextSetup;
+    this.fragmentLoader = new FragmentLoader(hls.config, contextSetup);
     this.fragmentTracker = fragmentTracker;
     this.config = hls.config;
     this.decrypter = new Decrypter(hls as HlsEventEmitter, hls.config);