Refactor sources of data

dist/martins.js

@@ -5,7 +5,7 @@
  * https://github.com/alemart/martins-js
  *
  * @license AGPL-3.0-only
- * Date: 2024-01-10T13:47:03.478Z
+ * Date: 2024-01-23T23:03:16.650Z
  */
 (function webpackUniversalModuleDefinition(root, factory) {
 	if(typeof exports === 'object' && typeof module === 'object')
@@ -26913,7 +26913,7 @@ class TrackerFactory {
     }
 }
 
-;// CONCATENATED MODULE: ./src/sources/media-source.ts
+;// CONCATENATED MODULE: ./src/sources/video-source.ts
 /*
  * MARTINS.js Free Edition
  * GPU-accelerated Augmented Reality for the web
@@ -26932,22 +26932,23 @@ class TrackerFactory {
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
- * media-source.ts
- * SpeedyMedia-based source of data
+ * video-source.ts
+ * HTMLVideoElement-based source of data
  */
 
 
 
 /**
- * SpeedyMedia-based source of data
+ * HTMLVideoElement-based source of data
  */
-class MediaSource {
+class VideoSource {
     /**
      * Constructor
      */
-    constructor(source) {
+    constructor(video) {
+        Utils.assert(video instanceof HTMLVideoElement, 'Expected a video element');
+        this._video = video;
         this._media = null;
-        this._source = source;
     }
     /**
      * A type-identifier of the source of data
@@ -26966,13 +26967,25 @@ class MediaSource {
         return this._media;
     }
     /**
+     * Stats related to this source of data
+     * @internal
+     */
+    get _stats() {
+        const media = this._media;
+        if (media != null)
+            return `${media.width}x${media.height} video`;
+        else
+            return 'uninitialized video';
+    }
+    /**
      * Initialize this source of data
      * @returns a promise that resolves as soon as this source of data is initialized
      * @internal
      */
     _init() {
-        return speedy_vision_default().load(this._source).then(media => {
-            Utils.log(`Source of data is ${media.width}x${media.height}`);
+        this._video.setAttribute('playsinline', '');
+        return speedy_vision_default().load(this._video).then(media => {
+            Utils.log(`Source of data is a ${media.width}x${media.height} ${this._type}`);
             this._media = media;
         });
     }
@@ -26987,19 +27000,9 @@ class MediaSource {
         this._media = null;
         return speedy_vision_default().Promise.resolve();
     }
-    /**
-     * A string featuring the size of the media, in pixels
-     */
-    get _size() {
-        const media = this._media;
-        if (media != null)
-            return `${media.width}x${media.height}`;
-        else
-            return '-';
-    }
 }
 
-;// CONCATENATED MODULE: ./src/sources/video-source.ts
+;// CONCATENATED MODULE: ./src/sources/canvas-source.ts
 /*
  * MARTINS.js Free Edition
  * GPU-accelerated Augmented Reality for the web
@@ -27018,72 +27021,72 @@ class MediaSource {
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
- * video-source.ts
- * <video>-based source of data
+ * canvas-source.ts
+ * HTMLCanvasElement-based source of data
  */
 
 
+
 /**
- * <video>-based source of data
+ * HTMLCanvasElement-based source of data
  */
-class VideoSource extends MediaSource {
+class CanvasSource {
     /**
      * Constructor
      */
-    constructor(video) {
-        Utils.assert(video instanceof HTMLVideoElement, 'Expected a video element');
-        super(video);
+    constructor(canvas) {
+        Utils.assert(canvas instanceof HTMLCanvasElement, 'Expected a canvas element');
+        this._canvas = canvas;
+        this._media = null;
     }
     /**
-     * Stats related to this source of data
+     * A type-identifier of the source of data
      * @internal
      */
-    get _stats() {
-        return `${this._size} video`;
+    get _type() {
+        return 'canvas';
     }
-}
-
-;// CONCATENATED MODULE: ./src/sources/canvas-source.ts
-/*
- * MARTINS.js Free Edition
- * GPU-accelerated Augmented Reality for the web
- * Copyright (C) 2022  Alexandre Martins <alemartf(at)gmail.com>
- * https://github.com/alemart/martins-js
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License version 3
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * canvas-source.ts
- * <canvas>-based source of data
- */
-
-
-/**
- * <canvas>-based source of data
- */
-class CanvasSource extends MediaSource {
     /**
-     * Constructor
+     * Get media
+     * @internal
      */
-    constructor(canvas) {
-        Utils.assert(canvas instanceof HTMLCanvasElement, 'Expected a canvas element');
-        super(canvas);
+    get _data() {
+        if (this._media == null)
+            throw new IllegalOperationError(`The media of the source of data isn't loaded`);
+        return this._media;
     }
     /**
      * Stats related to this source of data
      * @internal
      */
     get _stats() {
-        return `${this._size} canvas`;
+        const media = this._media;
+        if (media != null)
+            return `${media.width}x${media.height} canvas`;
+        else
+            return 'uninitialized canvas';
+    }
+    /**
+     * Initialize this source of data
+     * @returns a promise that resolves as soon as this source of data is initialized
+     * @internal
+     */
+    _init() {
+        return speedy_vision_default().load(this._canvas).then(media => {
+            Utils.log(`Source of data is a ${media.width}x${media.height} ${this._type}`);
+            this._media = media;
+        });
+    }
+    /**
+     * Release this source of data
+     * @returns a promise that resolves as soon as this source of data is released
+     * @internal
+     */
+    _release() {
+        if (this._media)
+            this._media.release();
+        this._media = null;
+        return speedy_vision_default().Promise.resolve();
     }
 }
 
@@ -27129,7 +27132,7 @@ class CameraSource extends VideoSource {
     constructor(options) {
         const video = document.createElement('video');
         super(video);
-        this._video = video;
+        this._cameraVideo = video;
         this._options = Object.assign({}, DEFAULT_CAMERA_OPTIONS, options);
     }
     /**
@@ -27139,13 +27142,6 @@ class CameraSource extends VideoSource {
         return this._options.resolution;
     }
     /**
-     * Stats related to this source of data
-     * @internal
-     */
-    get _stats() {
-        return `${this._size} webcam`;
-    }
-    /**
      * Initialize this source of data
      * @returns a promise that resolves as soon as this source of data is initialized
      * @internal
@@ -27165,14 +27161,16 @@ class CameraSource extends VideoSource {
         // load camera stream
         return new (speedy_vision_default()).Promise((resolve, reject) => {
             navigator.mediaDevices.getUserMedia(constraints).then(stream => {
-                const video = this._video;
+                const video = this._cameraVideo;
                 video.onloadedmetadata = () => {
                     video.play();
                     Utils.log('Access to the webcam has been granted.');
                     resolve(video);
                 };
+                video.setAttribute('playsinline', '');
+                video.setAttribute('autoplay', '');
+                video.setAttribute('muted', '');
                 video.srcObject = stream;
-                video.muted = true;
             }).catch(err => {
                 reject(new AccessDeniedError('Please give access to the webcam and reload the page.', err));
             });
@@ -27184,12 +27182,12 @@ class CameraSource extends VideoSource {
      * @internal
      */
     _release() {
-        const stream = this._video.srcObject;
+        const stream = this._cameraVideo.srcObject;
         const tracks = stream.getTracks();
         // stop camera feed
         tracks.forEach(track => track.stop());
-        this._video.onloadedmetadata = null;
-        this._video.srcObject = null;
+        this._cameraVideo.onloadedmetadata = null;
+        this._cameraVideo.srcObject = null;
         // release the media
         return super._release();
     }

src/sources/camera-source.ts

@@ -23,7 +23,6 @@
 import Speedy from 'speedy-vision';
 import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
-import { SpeedySize } from 'speedy-vision/types/core/speedy-size';
 import { Utils } from '../utils/utils';
 import { Resolution } from '../core/resolution';
 import { NotSupportedError, AccessDeniedError } from '../utils/errors';
@@ -60,7 +59,7 @@ const DEFAULT_CAMERA_OPTIONS: Readonly<Required<CameraSourceOptions>> = {
 export class CameraSource extends VideoSource
 {
     /** Video element */
-    private _video: HTMLVideoElement;
+    private _cameraVideo: HTMLVideoElement;
 
     /** Options of the constructor */
     private _options: Required<CameraSourceOptions>;
@@ -75,7 +74,7 @@ export class CameraSource extends VideoSource
         const video = document.createElement('video');
 
         super(video);
-        this._video = video;
+        this._cameraVideo = video;
         this._options = Object.assign({}, DEFAULT_CAMERA_OPTIONS, options);
     }
 
@@ -88,15 +87,6 @@ export class CameraSource extends VideoSource
     }
 
     /**
-     * Stats related to this source of data
-     * @internal
-     */
-    get _stats(): string
-    {
-        return `${this._size} webcam`;
-    }
-
-    /**
      * Initialize this source of data
      * @returns a promise that resolves as soon as this source of data is initialized
      * @internal
@@ -124,14 +114,16 @@ export class CameraSource extends VideoSource
         // load camera stream
         return new Speedy.Promise<HTMLVideoElement>((resolve, reject) => {
             navigator.mediaDevices.getUserMedia(constraints).then(stream => {
-                const video = this._video;
+                const video = this._cameraVideo;
                 video.onloadedmetadata = () => {
                     video.play();
                     Utils.log('Access to the webcam has been granted.');
                     resolve(video);
                 };
+                video.setAttribute('playsinline', '');
+                video.setAttribute('autoplay', '');
+                video.setAttribute('muted', '');
                 video.srcObject = stream;
-                video.muted = true;
             }).catch(err => {
                 reject(new AccessDeniedError(
                     'Please give access to the webcam and reload the page.',
@@ -148,13 +140,13 @@ export class CameraSource extends VideoSource
      */
     _release(): SpeedyPromise<void>
     {
-        const stream = this._video.srcObject as MediaStream;
+        const stream = this._cameraVideo.srcObject as MediaStream;
         const tracks = stream.getTracks();
 
         // stop camera feed
         tracks.forEach(track => track.stop());
-        this._video.onloadedmetadata = null;
-        this._video.srcObject = null;
+        this._cameraVideo.onloadedmetadata = null;
+        this._cameraVideo.srcObject = null;
 
         // release the media
         return super._release();

src/sources/canvas-source.ts

@@ -17,24 +17,59 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
  * canvas-source.ts
- * <canvas>-based source of data
+ * HTMLCanvasElement-based source of data
  */
 
-import { Utils } from '../utils/utils';
-import { MediaSource } from './media-source';
+import Speedy from 'speedy-vision';
+import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
+import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
+import { Utils, Nullable } from '../utils/utils';
+import { IllegalOperationError } from '../utils/errors';
+import { Source } from './source';
 
 /**
- * <canvas>-based source of data
+ * HTMLCanvasElement-based source of data
  */
-export class CanvasSource extends MediaSource
+export class CanvasSource implements Source
 {
+    /** canvas element */
+    private _canvas: HTMLCanvasElement;
+
+    /** media source */
+    protected _media: Nullable<SpeedyMedia>;
+
+
+
     /**
      * Constructor
      */
     constructor(canvas: HTMLCanvasElement)
     {
         Utils.assert(canvas instanceof HTMLCanvasElement, 'Expected a canvas element');
-        super(canvas);
+
+        this._canvas = canvas;
+        this._media = null;
+    }
+
+    /**
+     * A type-identifier of the source of data
+     * @internal
+     */
+    get _type(): string
+    {
+        return 'canvas';
+    }
+
+    /**
+     * Get media
+     * @internal
+     */
+    get _data(): SpeedyMedia
+    {
+        if(this._media == null)
+            throw new IllegalOperationError(`The media of the source of data isn't loaded`);
+
+        return this._media;
     }
 
     /**
@@ -43,6 +78,38 @@ export class CanvasSource extends MediaSource
      */
     get _stats(): string
     {
-        return `${this._size} canvas`;
+        const media = this._media;
+
+        if(media != null)
+            return `${media.width}x${media.height} canvas`;
+        else
+            return 'uninitialized canvas';
+    }
+
+    /**
+     * Initialize this source of data
+     * @returns a promise that resolves as soon as this source of data is initialized
+     * @internal
+     */
+    _init(): SpeedyPromise<void>
+    {
+        return Speedy.load(this._canvas).then(media => {
+            Utils.log(`Source of data is a ${media.width}x${media.height} ${this._type}`);
+            this._media = media;
+        });
+    }
+
+    /**
+     * Release this source of data
+     * @returns a promise that resolves as soon as this source of data is released
+     * @internal
+     */
+    _release(): SpeedyPromise<void>
+    {
+        if(this._media)
+            this._media.release();
+
+        this._media = null;
+        return Speedy.Promise.resolve();
     }
 }

src/sources/media-source.ts

@@ -1,121 +0,0 @@
-/*
- * MARTINS.js Free Edition
- * GPU-accelerated Augmented Reality for the web
- * Copyright (C) 2022  Alexandre Martins <alemartf(at)gmail.com>
- * https://github.com/alemart/martins-js
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License version 3
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * media-source.ts
- * SpeedyMedia-based source of data
- */
-
-import Speedy from 'speedy-vision';
-import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
-import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
-import { SpeedySize } from 'speedy-vision/types/core/speedy-size';
-import { Utils, Nullable } from '../utils/utils';
-import { Resolution } from '../core/resolution';
-import { IllegalOperationError, NotSupportedError, AccessDeniedError } from '../utils/errors';
-import { Source } from './source';
-
-
-/**
- * SpeedyMedia-based source of data
- */
-export abstract class MediaSource implements Source
-{
-    /** source element */
-    private _source: HTMLVideoElement | HTMLCanvasElement;
-
-    /** media source */
-    protected _media: Nullable<SpeedyMedia>;
-
-
-
-    /**
-     * Constructor
-     */
-    constructor(source: HTMLVideoElement | HTMLCanvasElement)
-    {
-        this._media = null;
-        this._source = source;
-    }
-
-    /**
-     * A type-identifier of the source of data
-     * @internal
-     */
-    get _type(): string
-    {
-        return 'video';
-    }
-
-    /**
-     * Get media
-     * @internal
-     */
-    get _data(): SpeedyMedia
-    {
-        if(this._media == null)
-            throw new IllegalOperationError(`The media of the source of data isn't loaded`);
-
-        return this._media;
-    }
-
-    /**
-     * Stats related to this source of data
-     * @internal
-     */
-    abstract get _stats(): string;
-
-    /**
-     * Initialize this source of data
-     * @returns a promise that resolves as soon as this source of data is initialized
-     * @internal
-     */
-    _init(): SpeedyPromise<void>
-    {
-        return Speedy.load(this._source).then(media => {
-            Utils.log(`Source of data is ${media.width}x${media.height}`);
-            this._media = media;
-        });
-    }
-
-    /**
-     * Release this source of data
-     * @returns a promise that resolves as soon as this source of data is released
-     * @internal
-     */
-    _release(): SpeedyPromise<void>
-    {
-        if(this._media)
-            this._media.release();
-
-        this._media = null;
-        return Speedy.Promise.resolve();
-    }
-
-    /**
-     * A string featuring the size of the media, in pixels
-     */
-    protected get _size(): string
-    {
-        const media = this._media;
-
-        if(media != null)
-            return `${media.width}x${media.height}`;
-        else
-            return '-';
-    }
-}

src/sources/video-source.ts

@@ -17,24 +17,60 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
  * video-source.ts
- * <video>-based source of data
+ * HTMLVideoElement-based source of data
  */
 
-import { Utils } from '../utils/utils';
-import { MediaSource } from './media-source';
+import Speedy from 'speedy-vision';
+import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
+import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
+import { Utils, Nullable } from '../utils/utils';
+import { IllegalOperationError } from '../utils/errors';
+import { Source } from './source';
+
 
 /**
- * <video>-based source of data
+ * HTMLVideoElement-based source of data
  */
-export class VideoSource extends MediaSource
+export class VideoSource implements Source
 {
+    /** video element */
+    private _video: HTMLVideoElement;
+
+    /** media source */
+    protected _media: Nullable<SpeedyMedia>;
+
+
+
     /**
      * Constructor
      */
     constructor(video: HTMLVideoElement)
     {
         Utils.assert(video instanceof HTMLVideoElement, 'Expected a video element');
-        super(video);
+
+        this._video = video;
+        this._media = null;
+    }
+
+    /**
+     * A type-identifier of the source of data
+     * @internal
+     */
+    get _type(): string
+    {
+        return 'video';
+    }
+
+    /**
+     * Get media
+     * @internal
+     */
+    get _data(): SpeedyMedia
+    {
+        if(this._media == null)
+            throw new IllegalOperationError(`The media of the source of data isn't loaded`);
+
+        return this._media;
     }
 
     /**
@@ -43,6 +79,40 @@ export class VideoSource extends MediaSource
      */
     get _stats(): string
     {
-        return `${this._size} video`;
+        const media = this._media;
+
+        if(media != null)
+            return `${media.width}x${media.height} video`;
+        else
+            return 'uninitialized video';
+    }
+
+    /**
+     * Initialize this source of data
+     * @returns a promise that resolves as soon as this source of data is initialized
+     * @internal
+     */
+    _init(): SpeedyPromise<void>
+    {
+        this._video.setAttribute('playsinline', '');
+
+        return Speedy.load(this._video).then(media => {
+            Utils.log(`Source of data is a ${media.width}x${media.height} ${this._type}`);
+            this._media = media;
+        });
+    }
+
+    /**
+     * Release this source of data
+     * @returns a promise that resolves as soon as this source of data is released
+     * @internal
+     */
+    _release(): SpeedyPromise<void>
+    {
+        if(this._media)
+            this._media.release();
+
+        this._media = null;
+        return Speedy.Promise.resolve();
     }
 }