Version 2.4.0

GitOrigin-RevId: 6726183d873fdedd821dd9539ab97f67bf7927c0

Author: Interfaced

.eslintrc.js

@@ -1,18 +1,21 @@
+const path = require('path');
+const sinonPath = path.join(path.dirname(require.resolve('sinon/package.json')), 'pkg');
+
 module.exports = {
 	extends: 'interfaced',
-	rules: {
-		'jsdoc/check-tag-names': ['error', {
-			definedTags: [
-				'suppress'
-			]
-		}]
-	},
 	overrides: [
 		{
 			files: ['zb/**', 'test/framework/*/**', 'test/tools/addons/*/lib/**', 'templates/**/*.js'],
 			extends: 'interfaced/esm',
 			settings: {
-				'import/resolver': 'zombiebox'
+				'import/resolver': {
+					'zombiebox': {},
+					'alias': {
+						'map': [
+							['sinon', sinonPath]
+						]
+					}
+				}
 			}
 		},
 		{

CHANGELOG.md

@@ -1,5 +1,89 @@
 # Change log
 
+## 2.4.0 (release date 28.12.2019)
+
+Identical to `2.0.0-rc.2`, changes since previous stable version (`2.3.0`) are listed.
+
+This release introduces `IStatefulVideo` and tis Abstract and HTML5 implementations. Stateful Video has a much stricter model that leverages more stability, standardisation and error handling. Additionally it supports DRM playback.
+Stateful Video is meant to replace current IVideo, but at this point both are available and the latte is not even deprecated.
+Migrating to Stateful Video will require a large effort as its model and APIs are vastly incompatible with previous IVideo.
+
+For more details on Stateful Video see [docs/video](./docs/video/).
+
+Other changes:
+
+* `PrincipalAxisNavigation` is now used as first spatial navigation strategy of choice
+* `EventPublisher` refactored, added `runAfterCurrentEvent` method, improved test coverage
+* QHD resolution support removed, 4K and 8K added
+* `Info.osdResolutionType` deprecated in favor of `getOSDResolution` and `getPanelResolution`
+* `Viewport.getFullScreen` deprecated in favor of `isFullScreen`
+* `AbstractStatefulVideo` and `AbstracViewport` constructors both now accept panel and app resolutions
+* `zb/http` `decodeParams` now returns properly empty object if query string is empty as opposed to object with empty keys
+
+## 2.4.0-rc.2 (release date 28.12.2019)
+
+### Framework
+* Ensure no changes in html5 engine or Video happen once Video entered `ERROR` state
+* `EVENT_ERROR` now tries to make a better message 
+
+### Tools
+* Fixed issue when errors occurred while loading custom configs could be consumed and not reported 
+
+## 2.4.0-rc.1 (release date 27.12.2019)
+
+### Framework
+* Aborting transition in `StateMachine` now restores it to previous state
+
+### Tools
+* ESLint, its configs and plugins updated
+* Fix polyfills not being included in build
+* Workaround for GCC issue that prevents object destructuring from working without native `Object.assign` 
+
+## 2.4.0-alpha.6 (release date 19.12.2019)
+
+### Framework
+* `PrincipalAxisNavigation` is now used as first spatial navigation strategy of choice
+* Improved stability of `StatefulVideo`, especially when destroying it
+* `EVENT_STATE_EXIT` now happens before asynchronous transitions. This makes `getState` return `null` in between states. `getPendingTransitions` should be used in this occasions.
+* `EventPublisher` refactored, added `runAfterCurrentEvent` method, improved test coverage
+
+## 2.4.0-alpha.5 (release date 16.12.2019)
+### Framework
+* Ensure `getUrl` always returns url in LOADING state
+* Refactor Viewport to always accept application coordinates
+* `Device.createStatefulVideo` no longer requires Rect parameter
+* QHD resolution removed support, 4K and 8K added
+* `AbstractStatefulVideo` and `AbstracViewport` constructors both now accept panel and app resolutions
+* `Info.osdResolutionType` deprecated in favor of `getOSDResolution` and `getPanelResolution`
+* `Viewport.getFullScreen` deprecated in favor of `isFullScreen`
+
+## 2.4.0-alpha.4 (release date 12.12.2019)
+### Framework
+* Added `PrepareOption` to support 4K and 8K video.
+* Added `Device.isUHD8KSupported`.
+* Fixed StatefulVideo positioning in letterbox mode. 
+
+## 2.4.0-alpha.3 (release date 05.12.2019)
+
+### Framework
+* VerimatrixClient added, support VCAS.
+
+## 2.4.0-alpha.2 (release date 02.12.2019)
+
+### Framework
+* DRM support was added. See [drm.md](./docs/video/drm.md) for more details. 
+* new `IStatefulVideo` methods: static `isDRMSupported`, static `canHandleMultiDRM`, `attachDRM`, `detachDRM`.
+* new interfaces and classes: `IDRMClient`, `AbstractDRMClient`, `PlayReadyClient`.
+* `PrepareOption.FORMAT` was renamed to `PrepareOption.TYPE` and now accepts mime-type. `MediaType` enum added with common mime types.
+
+## 2.4.0-alpha.1 (release date 19.11.2019)
+
+Unstable channel release.
+
+### Framework
+* `IStatefulVideo`, `AbstractStatefulVideo` and `StatefulHtml5Video` classes and `Device.createStatefulVideo` were added. This a new video interface expected to eventually replace `IVideo`, in foreseeable future however they will coexist. It's much more strict and standardized. See [](./docs/video)
+* `zb/http` `decodeParams` now returns properly empty object if query string is empty as opposed to object with empty keys.
+
 ## 2.3.0 (release date 02.10.2019)
 
 ### Tools

docs/video/Video States.jpg

@@ -0,0 +1 @@
+<mxfile modified="2019-12-06T11:53:30.246Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3983.0 Safari/537.36" etag="0Lyk78tJYSbXdK-Tgt5o" version="12.3.7" type="device" pages="1"><diagram id="eb7a8a20-44d6-642c-9700-ebd0be929ef0" name="Page-1">7VzRdps4EP0aP8YHSUiCRyd2s9mmbU6cbTdPPQRjm9YGFuPE7tevMMIgITsYMCE9zUMbBhBidO/MaGZID10tN9ehFcw/+RNn0YPaZNNDwx6EBiXs31iwTQQAEJRIZqE74bJMMHZ/OVyocenanTgr4cLI9xeRG4hC2/c8x44EmRWG/ot42dRfiE8NrJlTEIxta1GUfnMn0Zy/F6SZ/C/Hnc2j/fuZyZkny/45C/21x5/Xg2i6+0lOL610LP6iq7k18V9yIjTqoavQ96Pkt+XmylnEuk3Vltz34cDZ/bxDx4vK3MCX5dlarPmr3wxvR3xu0TbVB7uJqZ4dXL7M3cgZB5Ydn3lhq89k82i5YEeA/Tr1vYgvJ3syuizOh0/x2QkjZ5MT8fldO/7SicItu4SfRSl2tiJGXrKFARqXzfOLkgotDobZfuhMIewXrhO1fuC1Ng8fHPrRf7x9WOLx08VX6wLDgoJ2S+7EN8Vv7YfR3J/5nrW49f2Aq+aHE0VbrhtrHfmi4pyNG/0b397H/Ogxd2a44SPvDrb8YBVZYTSI4c4Enu85qeyDG79Qdg1/KokH8CbpHfbCWq1cOxHyW0BylLthFYX+zz0LwLE1Xfnr0OYK4XxgT5850TFd8kVyJgIji2gInYUVuc8iQessrVmA/u2XwfDm83UN9DMlXvkLP9zdhyaWY0ztvQ5zZ4htOE/Tlvhi0LcmDAVFnbL1HvNDDl17HT7vKBSr0vaXMTR3GP6xXgbStXUYluNXxjY1w9gqhNuElpqOU0FyJwU0FWQ3745a5efukXdO6LKlckI+aimKAgVHUdNs3N3K3sja5i4IfNeLVrmR72JBBuE9EjmEDUPyYvL1hng9NDUJs8kMMgTvX6UUqEHRVow+D0fD38xSGKhN1/rpw/zH+n78/N2/vNh+DyB+1J4uKCpjKRrzr9pR9pfhr2C09uYC5E0FeMVMlCIrNLpKVmyK5EOgWfKlb54j393gn/G7Zx82sKA33Cr7lH463cW84qfP5ppBr5JrNnVTcs0MMx1wzUXbUM1Po65Sn2KR+sQ87qcJlUwFathPF7ez49Ho4/uP6TEUFUe1Vm1FUa1FfWbkmLjW0vcmD3PXk5kmnqqiZW33o9Bynr3gCDGBTG0gWhPBkrxiRVR267Ute6XdNEiTYDkTAMragBxGsAIiqew0U1Hgto7FYJJACXnJ+/C7jhgJqBl90TMaFKaSdLBEEYXBqoQX5PcHt8q9lnSupwSyVcGt2Id2DNwAy5g0YQGTbQD8sIeuQYE08PyNKVARmqpdV2qL/0Cztu1FtAbwGkWXiKYjmFbA8BzAU4T8Zqdghwjp6xgTaOoawQSJqAGQ7coQNinSASKImKgpPFJIzodH+nM7u7zGOvh7+OB+gpNv0/lXVbVHsSmuXQDKIRKQ2nticT+8z1w367iRwnErs3pEL4nduraQyjAkpBTwqsSNygSKcRpWzlvpqBvvlQFOaUOp2HIdMOyvePbGoKqTplFZdkONivWEHiSLKH6/wPIEAJH/1nEzwM4+XKx2mhiwCwAONtlJ9tss/n/gxfMNFtY2bkRIx2TTSYZNLkrFT2H1BzUzXT+eQdJwkE0pOcXgEjkHX6BqMsdaBUm7yNTdxAS8nFir+Z6JIrYYEi6DNF8XD+l6swO2+iAEy2d4ABAzPEBTpIMNhT83Gkjw6MUNwHA0frj/8lgny15QthSmTQ3bsZVh2pOBdSyFaQA2o2ii4TdUNCgo+ljAm6WZc2oVsspNmsOynRjtBJgUSq5cr5hPAlAaCZjSSCfvtQ8UwmQKA6PZ9LY65KAFBHWtQCPEFKdEFO31NAmkKkWhNHqoRKEzV2QlIJq0WRzqqpRp4qkDZTCwcD3nIrURcThgMhuMD0cVsdkvFVUYcVSR1Fi0wkNAnFhUPGV0f//lPhdaJE8TZ8DEwRnCjVrFJICb8YBQ2iWZensOEJ8/1fgnq87zgkX71LHUpa5LyZ2iay7r5M3iUHK80GZGXd0FWSqR9BZdkCVR20ea0Nik9U1svorebvdAKgqr3eit2FdlOKD1htuqQHErcnc7eHz/vRJyV2MH+qrStpe36qtizMWGELprkJQk/WmuqvWuKjbpasRXuMeOEF9qfsb68aYqSKTm54Z3nammcobi2+Dm4f0bClnR7TZVKQsluDsF0ZOj29OKppV6s/r4NGtULXBW1F7TPoCOBM6Yan3dAISyAWP+iwkurGl9AAnGkCCAoQ6rhdSEkr6u6RqBGABEDfEhSKN9A2jUxDpCBqZnq8mqeVLsCT/GE+6Kmu9HKXquw1DXFGkoyRVW+kahuZ6rbu0OEQFyLwqouDvUaR9QahLKwIpNExkilCnoA6zpCOhYw6Y00Ta3jeri+Yk15Yr9B+32G5SJEysB+2j/wXlztbU8fzrFOiVhQ1Vjvfn8dXB7Mzx/KfUMtTpd+r6g1VqdcpnSb3ZOafDI7+Ws0G6Onsdbzdupv8itHGf9qFyZ0yzbF9c4j9Xfs5f6gPHPnwuQVvbo3waoFKS0s9zlvldtKadbpRLRJ6b0XbuJ3/l37aWx1I18T5rf2edvGq7WHlVHLty4Hw2Gj9XjgU6kdOTcL8qa48+R1GGH2Z/qSZYm+3tIaPQ/</diagram></mxfile>

docs/video/Video States.xml

@@ -0,0 +1,41 @@
+# DRM Playback
+ZombieBox `IStatefulVideo` supports supports DRM protected video playback. Support for DRM system varies from platform to platform, however.
+
+To detect platform support `IStatefulVideo` exposes static methods `isDRMSupported(type)` and `canHandleMultiDRM()`. Some common DRM types are listed in zb/device/drm/drm.js as `Type`, but platforms may support additional proprietary types.
+
+Some can have several DRM systems initialised at the same time and choose whichever is appropriate for the stream. `canHandleMultiDRM` detects that.
+
+## DRM initialization
+DRM is enabled with `attachDRM` method that accepts `IDRMClient`. Several `IDRMClient`s for different DRM types can be attached on platforms that support multi DRM.
+
+`attachDRM` can only be called in `IDLE` state. `detachDRM` can be called in the same state and no other.
+
+ZombieBox provides `IDRMClient` implementations for most common DRM types and use cases: 
+ * `PlayReadyClient` supports reactive PlayReady DRM with optional license acquisition server.
+
+Note that some platforms require explicit media type to enable DRM.
+ 
+### PlayReady
+Simplest PlayReady example:
+
+```javascript
+import PlayReadyClient from 'zb/device/drm/playready-client';
+import {PrepareOption, MediaType} from 'zb/device/interfaces/i-stateful-video';
+
+// Microsoft test assets
+const laServer = 'https://test.playready.microsoft.com/service/rightsmanager.asmx?PlayRight=1&UseSimpleNonPersistentLicense=1';
+const url = 'https://demo.unified-streaming.com/video/tears-of-steel/tears-of-steel-dash-playready.ism/.mpd';
+
+// Create Video instance through Device factory or otherwise
+video.attachDRM(new PlayReadyClient(laServer));
+video.prepare(url, {
+    [PrepareOption.TYPE]: MediaType.DASH
+});
+video.once(video.EVENT_READY, () => video.play());
+```
+
+## Custom `IDRMClient`
+To add custom initialization such as addition authentication you can provide your own `IDRMClient` or inherit from its descendand and use `init` and `prepare` methods. `init` is called when client is created and attached to Video instance, `prepare` is called when Video is initialized with a media file. 
+
+## Implementation notes
+Internally ZombieBox uses Hook classes to communicate with DRM. Video deals with device specific initialization in non-DRM specific way; Hook is device-specific, DRM-specific but not app/server-specific; Client is device non-specific, DRM-specific and app/server-specific.