rx-player 4.4.1 → 4.5.0-dev.2026012301

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## Current dev build: v4.5.0-dev.2026012301
+
+### Features
+
+- `MULTI_THREAD`: Allow applications to define their own complex logic worker-side [#1719]
+- Add optional `LOCAL_MANIFEST` feature to our importable worker [#1782]
+
+### Bug fixes
+
+- Fix memory leaks linked to quality changes [#1781]
+
+### Other improvements
+
+- Text track id can only be string [#1785]
+- The reload API now only throws if no `loadVideo` call has been made before [#1767]
+
 ## v4.4.1 (2025-12-10)
 
 ### Bug fixes

package/README.md

@@ -10,22 +10,11 @@
   -
   <a href="./CONTRIBUTING.md">🔧 <b>Contributing</b></a>
   <br /><br />
-  <a href="https://github.com/canalplus/rx-player/releases">
-    <img src="https://img.shields.io/badge/dynamic/json.svg?label=Latest%20release&url=https://api.github.com/repos/canalplus/rx-player/releases/latest&query=$.tag_name&colorB=blue" />
-  </a>
-  <a href="https://github.com/canalplus/rx-player/actions/workflows/checks.yml">
-    <img src="https://github.com/canalplus/rx-player/actions/workflows/checks.yml/badge.svg" />
-  </a>
-  <a href="https://sonarcloud.io/summary/new_code?id=rx-player">
-    <img src="https://sonarcloud.io/api/project_badges/measure?project=rx-player&metric=alert_status" />
-  </a>
-  <a href="https://gitter.im/canalplus/rx-player">
-    <img src="https://img.shields.io/gitter/room/canalplus/rx-player.svg" />
-  </a>
+  <a href="https://github.com/canalplus/rx-player/releases"><img src="https://img.shields.io/badge/dynamic/json.svg?label=Latest%20release&url=https://api.github.com/repos/canalplus/rx-player/releases/latest&query=$.tag_name&colorB=blue" /></a>
+  <a href="https://github.com/canalplus/rx-player/actions/workflows/checks.yml"><img src="https://github.com/canalplus/rx-player/actions/workflows/checks.yml/badge.svg" /></a>
+  <a href="https://sonarcloud.io/summary/new_code?id=rx-player"><img src="https://sonarcloud.io/api/project_badges/measure?project=rx-player&metric=alert_status" /></a>
   <br /><br />
-  <a href="https://nodei.co/npm/rx-player/">
-    <img src="https://nodei.co/npm/rx-player.png?compact=true)" />
-  </a>
+  <a href="https://nodei.co/npm/rx-player/"><img src="https://nodei.co/npm/rx-player.png?compact=true)" /></a>
 </p>
 
 The RxPlayer is a library implementing a
@@ -36,55 +25,32 @@ media player on a browser, by relying on the HTML5
 [Encrypted Media extensions](https://en.wikipedia.org/wiki/Encrypted_Media_Extensions)
 browser APIs.
 
----
-
-Originally designed to power Canal+ many applications, the RxPlayer is today used in
-production by several companies in multiple countries and runs on most devices where a
-browser can run: Computers, phones, set-top-boxes, smart TVs, game consoles and other
-peculiar environments are all supported and able to profit from its many features.
-
-Its main goals are:
-
-- **Stability**: The RxPlayer can play live and On Demand DASH and Smooth contents for
-  extended amounts of time, with or without DRM - without any performance, memory or logic
-  issue.
-
-  If you encounter a new issue while using it, we'll be very happy to help fixing it. Any
-  encountered bug is put at high priority.
-
-- **Quality of experience**: It aims to play the best possible quality without any
-  rebuffering.
+This library only implements the core, non-UI part of a media player - you provide the
+interface while it handles the streaming. See our
+[demo page](https://developers.canal-plus.com/rx-player/) for an example implementation.
 
-  Unsupported codecs and undecipherable qualities (e.g. higher qualities with more drastic
-  DRM conditions on untrusted devices) are automatically filtered out, even if this
-  happens during playback.
+Initially built for Canal+'s complex requirements across diverse devices, it prioritizes
+configurability and integration flexibility.
 
-  The player is also very resilient: any temporary network issue, fall in bandwidth,
-  poorly-packaged content or platform quirk should be properly handled with the main goal
-  of avoiding playback interruption.
-
-- **Portability**: The RxPlayer has been ported to a lot of devices, some on the lower-end
-  of performance and memory capabilities and others on the higher end.
-
-  As such, it can adapt to important memory and performance constraints while still being
-  able to retain its many features.
-
-- **Configurability**: The RxPlayer has a plethora of options to let you tweak its
-  behavior. You should be able to play any content the way you want, on any device.
+---
 
-  You should also be able to integrate complex supplementary logic like Peer-to-Peer
-  solutions.
+The RxPlayer can be seen as the "engine" providing adaptive streaming capabilities to an
+application:
 
-- **Easy to use**: We try hard to make this player easy to integrate and to use in various
-  codebases.
+- Beyond DASH and Smooth Streaming support (and HLS on devices with native support like
+  Safari), it handles complex scenarios like multiple DRM keys, fallback mechanisms for
+  undecipherable or undecodable qualities, most subtitle formats and advanced heuristics
+  to keep the playback going.
 
-  Even for the more advanced options, we aim to make our documentation as legible and as
-  complete as possible.
+- Multi-threaded architecture: core logic can be offloaded to a separate thread, keeping
+  the player from blocking your application and vice-versa.
 
-The RxPlayer has probably already all the features you want :)!
+- Production-tested across a wide device range: from low-end set-top boxes to high-end
+  computers, with optimizations for constrained environments.
 
-Even if that's not the case, we will be very pleased to exchange with you on it and look
-forward for external contributions.
+- Highly configurable with
+  [a well-documented API](https://developers.canal-plus.com/rx-player/doc/api/Overview.html):
+  player behavior can be controlled at a granular level.
 
 ## How to use it?
 
@@ -104,13 +70,8 @@ yarn add rx-player
 You can then directly import and use the RxPlayer in your code:
 
 ```js
-// import it ES6 style:
 import RxPlayer from "rx-player";
 
-// same in CommonJS style:
-// const RxPlayer = require("rx-player");
-
-// instantiate it
 const player = new RxPlayer({
   videoElement: document.querySelector("video"),
 });
@@ -155,7 +116,7 @@ RxPlayer.addFeatures([DASH, EME]);
 
 ## API
 
-We documented the API in every little details in
+We documented the API in every little detail in
 [the API documentation](https://developers.canal-plus.com/rx-player/doc/api/Overview.html).
 
 You can also refer to the documentation of our previous versions
@@ -177,72 +138,50 @@ Demo pages for our previous versions are also available
 
 ## Contribute
 
-Details on how to contribute is written in the [CONTRIBUTING.md file](./CONTRIBUTING.md)
-at the root of this repository.
-
-### Dependencies
-
-After cloning our repo, you should first install our dependencies via either
+After cloning our repo, you should first install our dependencies via
 [npm](https://www.npmjs.com/):
 
 ```sh
 npm install
 ```
 
-## Why a new player?
-
-### A need for an advanced media player
-
-Canal+ Group is a media company with many advanced needs when it comes to media playback:
-it provides both live and VoD stream with multiple encryption requirements, supports a
-very large panel of devices and has many other specificities (like adult content
-restrictions, ad-insertion, Peer-To-Peer integration, low-latency live streaming...).
-
-When the time came to switch from a plugin-based web player approach to an HTML5 one back
-in 2015, no media player had the key features we wanted, and including those needs into an
-already existing media player would not be straightforward either.
+You can then run the `list` script to see the different scripts provided to test your
+modifications, run a demo locally etc.:
 
-The R&D department of Canal+ Group thus started to work on a new featureful media-player:
-the RxPlayer. To both help and profit from the community, it also decided to share it to
-everyone under a permissive open-source licence.
+```sh
+npm run list
+```
 
-Now, more than 8 years later, the RxPlayer continues to evolve at the same fast pace to
-include a lot of features and improvements you may not find in other media players. You
-can look at our
-[API documentation](https://developers.canal-plus.com/rx-player/doc/api/Overview.html),
-[tutorials](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Quick_Start.html)
-and our [demo page](https://developers.canal-plus.com/rx-player/) (an RxPlayer instance is
-available in the console through the global `player` variable there) to see if it matches
-your need.
+Details on how to contribute is written in the [CONTRIBUTING.md file](./CONTRIBUTING.md)
+at the root of this repository.
 
-### A featureful player
+## Features
 
-With the help of a carefully-crafted and well-documented architecture, we were able to
-quickly support avanced features when we - or the community - needed them. Amongst those:
+Key features:
 
-- support for live and VoD DASH / Smooth / HLS* / Downloaded contents / MP4* / WebM\*
-  contents and more
+- live and VoD DASH (including low-latency) / Smooth / HLS* / Downloaded contents / MP4* /
+  WebM\* contents and more.
 
-- support of advanced encryption configuration, such as multiple keys in a single or
-  separate licences for a given content (with automatic fallbacks when we found an
-  un-decipherable content), persistent licenses, and other device-specific restrictions.
+- advanced encryption configuration: multiple keys in a single or separate licenses for a
+  given content, automatic fallbacks on undecipherable contents, persistent licenses,
+  complex `MediaKeySystemConfiguration`.
 
-- support for low-latency DASH streams
+- TTML, WebVTT, SAMI and SRT subtitles.
 
-- support of TTML, WebVTT, SAMI and SRT subtitles
+- multi-threading support.
 
-- an available WebAssembly-based MPD parser for DASH contents, allowing to drastically
-  reduce the loading time and memory usage of larger contents.
+- extensive APIs: audio-only, video track selection, manual garbage collection of
+  segments, Peer-To-Peer integration, quality filtering...
 
-- advanced APIs for advanced use-cases (audio-only mode, video track selection, manual
-  garbage collection of segments, Peer-To-Peer integration, quality filtering...)
+- adaptive streaming algorithms: both a network-based for quick start-up and buffer-based
+  to provide the best quality possible.
 
-- advanced adaptive streaming algorithms making use of both a network-based approach (for
-  quick start-up) and a buffer-based one (to provide the best quality possible).
+- complex segment scheduling logic: prioritizing closer media segments while making sure
+  that the bandwidth usage is always optimal and the rebuffering risks always low.
 
-- advanced optimizations for devices with low memory constraints
+- heuristics to ensure playback stays smooth, the RxPlayer monitors playback and take
+  actions if the current device has issues while decoding the stream.
 
-- a complex segment scheduling logic, prioritizing closer media segments while making sure
-  that the bandwidth usage is always optimal and the rebuffering risks always low.
+- optional WebAssembly-based MPD parser for DASH contents (for very large Manifests).
 
 \* In "directfile" mode, on compatible browsers

package/VERSION

@@ -1 +1 @@
-4.4.1
+4.5.0-dev.2026012301

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-player",
   "author": "Canal+",
-  "version": "4.4.1",
+  "version": "4.5.0-dev.2026012301",
   "description": "Canal+ HTML5 Video Player",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/es2017/index.js",
@@ -47,6 +47,16 @@
       "require": "./dist/commonjs/experimental/tools/*/index.js",
       "default": "./dist/es2017/experimental/tools/*/index.js"
     },
+    "./experimental/worker": {
+      "import": "./dist/es2017/importable_worker.js",
+      "require": "./dist/commonjs/importable_worker.js",
+      "default": "./dist/es2017/importable_worker.js"
+    },
+    "./experimental/worker/features": {
+      "import": "./dist/es2017/experimental/features/worker/index.js",
+      "require": "./dist/commonjs/experimental/features/worker/index.js",
+      "default": "./dist/es2017/experimental/features/worker/index.js"
+    },
     "./features": {
       "import": "./dist/es2017/features/list/index.js",
       "require": "./dist/commonjs/features/list/index.js",
@@ -104,6 +114,12 @@
       "experimental/tools/*": [
         "./dist/es2017/experimental/tools/*/index.d.ts"
       ],
+      "experimental/worker": [
+        "./dist/es2017/importable_worker.d.ts"
+      ],
+      "experimental/worker/features": [
+        "./dist/es2017/experimental/features/worker/index.d.ts"
+      ],
       "features": [
         "./dist/es2017/features/list/index.d.ts"
       ],
@@ -172,7 +188,6 @@
     "lint:scripts": "eslint -c eslint.config.mjs scripts",
     "lint:tests": "eslint -c eslint.config.mjs tests",
     "list": "node scripts/list-npm-scripts.mjs",
-    "prepublishOnly": "bash ./scripts/make_all_builds.sh",
     "releases:changelog": "node ./scripts/update_changelog.mjs",
     "releases:demo": "bash ./scripts/update_gh-pages_demo.sh",
     "releases:dev": "bash ./scripts/make-dev-releases.sh",
@@ -186,9 +201,9 @@
     "test:integration:edge:watch": "npm run --silent test:integration:notice && cross-env BROWSER_CONFIG=edge vitest watch tests/integration/scenarios",
     "test:integration:firefox": "npm run --silent test:integration:notice && cross-env BROWSER_CONFIG=firefox vitest run tests/integration/scenarios",
     "test:integration:firefox:watch": "npm run --silent test:integration:notice && cross-env BROWSER_CONFIG=firefox vitest watch tests/integration/scenarios",
-    "test:integration:notice": "echo \"~~~ ⚠️ NOTICE ⚠️\n~~~ Integration tests rely on the RxPlayer build.\n~~~ Make sure you called the \\`build\\` script succesfully first.\n\"",
-    "test:memory": "cross-env BROWSER_CONFIG=chrome vitest run tests/memory",
-    "test:memory:chrome:watch": "cross-env BROWSER_CONFIG=chrome vitest watch tests/memory",
+    "test:integration:notice": "echo \"~~~ ⚠️ NOTICE ⚠️\n~~~ Tests have two dependencies: a local RxPlayer build and ffmpeg.\n~~~ Make sure you:\n~~~ 1.  Have an ffmpeg executable in your path and,\n~~~ 2.  You built an up-to-date RxPlayer through the \\`build\\` npm script.\n\"",
+    "test:memory": "npm run --silent test:integration:notice && cross-env BROWSER_CONFIG=chrome vitest run tests/memory",
+    "test:memory:chrome:watch": "npm run --silent test:integration:notice && cross-env BROWSER_CONFIG=chrome vitest watch tests/memory",
     "test:unit": "vitest --config vitest.config.unit.mjs",
     "test:unit:watch": "vitest --config vitest.config.unit.mjs --watch",
     "update-version": "bash ./scripts/update-version-number.sh"
@@ -204,7 +219,7 @@
     "@types/react-dom": "19.1.7",
     "@typescript-eslint/eslint-plugin": "^8.40.0",
     "@typescript-eslint/parser": "^8.40.0",
-    "@vitest/browser": "^3.2.4",
+    "@vitest/browser-webdriverio": "^4.0.16",
     "core-js": "3.45.0",
     "cross-env": "^10.0.0",
     "esbuild": "0.25.9",
@@ -224,8 +239,7 @@
     "semver": "7.7.2",
     "typescript": "5.9.2",
     "typescript-eslint": "^8.40.0",
-    "vitest": "3.2.4",
-    "webdriverio": "^9.19.1"
+    "vitest": "^4.0.16"
   },
   "scripts-list": {
     " INFO ": "---- This field is read by the `list` npm script and allows to guide you through the RxPlayer's npm scripts ----",
@@ -267,7 +281,7 @@
         "test:unit": "Launch unit tests",
         "test:unit:watch": "Launch unit tests and restart them each one of its file changes"
       },
-      "Memory tests (test memory usage to avoid memory leaks)": {
+      "Memory tests (test memory usage to avoid memory leaks, call the `build` script BEFORE running them)": {
         "test:memory": "Launch memory tests",
         "test:memory:chrome:watch": "Launch memory tests in Chrome each times the files update"
       }