@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.1.4 → 0.2.1

package/types/pixelstreamingfrontend.d.ts

@@ -11,7 +11,7 @@ export { AFKController as AfkLogic } from './AFK/AFKController';
 export { LatencyTestResults } from './DataChannel/LatencyTestResults';
 export { EncoderSettings, InitialSettings, WebRTCSettings } from './DataChannel/InitialSettings';
 export { AggregatedStats } from './PeerConnectionController/AggregatedStats';
-export { UnquantizedDenormalizedUnsignedCoord as UnquantizedAndDenormalizeUnsigned } from './Util/CoordinateConverter';
+export { InputCoordTranslator, UntranslatedCoordUnsigned as UnquantizedAndDenormalizeUnsigned } from './Util/InputCoordTranslator';
 export { MessageDirection } from './UeInstanceMessage/StreamMessageController';
 export { CandidatePairStats } from './PeerConnectionController/CandidatePairStats';
 export { CandidateStat } from './PeerConnectionController/CandidateStat';

package/src/Inputs/FakeTouchController.ts

@@ -1,199 +0,0 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-
-import { CoordinateConverter } from '../Util/CoordinateConverter';
-import { StreamMessageController } from '../UeInstanceMessage/StreamMessageController';
-import { VideoPlayer } from '../VideoPlayer/VideoPlayer';
-import { ITouchController } from './ITouchController';
-import { MouseButton } from './MouseButtons';
-import { EventListenerTracker } from '../Util/EventListenerTracker';
-
-/**
- * Allows for the usage of fake touch events and implements ITouchController
- * @param dataChannelController - The controller for the Data channel
- * @param videoElementParent - The video player DOM element
- */
-export class FakeTouchController implements ITouchController {
-    fakeTouchFinger: FakeTouchFinger;
-    toStreamerMessagesProvider: StreamMessageController;
-    videoElementProvider: VideoPlayer;
-    coordinateConverter: CoordinateConverter;
-    videoElementParentClientRect: DOMRect;
-
-    // Utility for keeping track of event handlers and to unregister them.
-    private touchEventListenerTracker = new EventListenerTracker();
-
-    /**
-     * @param toStreamerMessagesProvider - Stream message instance
-     * @param videoElementProvider - Video element instance
-     * @param coordinateConverter - A coordinate converter instance
-     */
-    constructor(
-        toStreamerMessagesProvider: StreamMessageController,
-        videoElementProvider: VideoPlayer,
-        coordinateConverter: CoordinateConverter
-    ) {
-        this.toStreamerMessagesProvider = toStreamerMessagesProvider;
-        this.videoElementProvider = videoElementProvider;
-        this.coordinateConverter = coordinateConverter;
-        const ontouchstart = (ev: TouchEvent) => this.onTouchStart(ev);
-        const ontouchend = (ev: TouchEvent) => this.onTouchEnd(ev);
-        const ontouchmove = (ev: TouchEvent) => this.onTouchMove(ev);
-        document.addEventListener('touchstart', ontouchstart, { passive: false });
-        document.addEventListener('touchend', ontouchend, { passive: false });
-        document.addEventListener('touchmove', ontouchmove, { passive: false });
-        this.touchEventListenerTracker.addUnregisterCallback(
-            () => document.removeEventListener('touchstart', ontouchstart)
-        );
-        this.touchEventListenerTracker.addUnregisterCallback(
-            () => document.removeEventListener('touchend', ontouchend)
-        );
-        this.touchEventListenerTracker.addUnregisterCallback(
-            () => document.removeEventListener('touchmove', ontouchmove)
-        );
-    }
-
-    /**
-     * Unregister all touch events
-     */
-    unregisterTouchEvents() {
-        this.touchEventListenerTracker.unregisterAll();
-    }
-
-    /**
-     * Sets the video Element Parent Client Rect numbers for this class
-     * @param videoElementParentClientRect - a html ElementParentClientRect object
-     */
-    setVideoElementParentClientRect(videoElementParentClientRect: DOMRect) {
-        this.videoElementParentClientRect = videoElementParentClientRect;
-    }
-
-    /**
-     * When a touch event begins
-     * @param touch - the activating touch event
-     */
-    onTouchStart(touch: TouchEvent): void {
-        if (!this.videoElementProvider.isVideoReady() || touch.target !== this.videoElementProvider.getVideoElement()) {
-            return;
-        }
-        if (this.fakeTouchFinger == null) {
-            const first_touch = touch.changedTouches[0];
-            this.fakeTouchFinger = new FakeTouchFinger(
-                first_touch.identifier,
-                first_touch.clientX - this.videoElementParentClientRect.left,
-                first_touch.clientY - this.videoElementParentClientRect.top
-            );
-
-            const videoElementParent =
-                this.videoElementProvider.getVideoParentElement() as HTMLDivElement;
-            const mouseEvent = new MouseEvent('mouseenter', first_touch);
-            videoElementParent.dispatchEvent(mouseEvent);
-
-            const coord = this.coordinateConverter.normalizeAndQuantizeUnsigned(
-                this.fakeTouchFinger.x,
-                this.fakeTouchFinger.y
-            );
-            const toStreamerHandlers =
-                this.toStreamerMessagesProvider.toStreamerHandlers;
-            toStreamerHandlers.get('MouseDown')([
-                MouseButton.mainButton,
-                coord.x,
-                coord.y
-            ]);
-        }
-        touch.preventDefault();
-    }
-
-    /**
-     * When a touch event ends
-     * @param touchEvent - the activating touch event
-     */
-    onTouchEnd(touchEvent: TouchEvent): void {
-        if (!this.videoElementProvider.isVideoReady() || this.fakeTouchFinger == null) {
-            return;
-        }
-        const videoElementParent =
-            this.videoElementProvider.getVideoParentElement();
-        const toStreamerHandlers =
-            this.toStreamerMessagesProvider.toStreamerHandlers;
-
-        for (let t = 0; t < touchEvent.changedTouches.length; t++) {
-            const touch = touchEvent.changedTouches[t];
-            if (touch.identifier === this.fakeTouchFinger.id) {
-                const x =
-                    touch.clientX - this.videoElementParentClientRect.left;
-                const y = touch.clientY - this.videoElementParentClientRect.top;
-                const coord =
-                    this.coordinateConverter.normalizeAndQuantizeUnsigned(x, y);
-                toStreamerHandlers.get('MouseUp')([
-                    MouseButton.mainButton,
-                    coord.x,
-                    coord.y
-                ]);
-
-                const mouseEvent = new MouseEvent('mouseleave', touch);
-                videoElementParent.dispatchEvent(mouseEvent);
-                this.fakeTouchFinger = null;
-                break;
-            }
-        }
-        touchEvent.preventDefault();
-    }
-
-    /**
-     * On a Move touch event
-     * @param touchEvent - the activating touch event
-     */
-    onTouchMove(touchEvent: TouchEvent): void {
-        if (!this.videoElementProvider.isVideoReady() || this.fakeTouchFinger == null) {
-            return;
-        }
-        const toStreamerHandlers =
-            this.toStreamerMessagesProvider.toStreamerHandlers;
-
-        for (let t = 0; t < touchEvent.touches.length; t++) {
-            const touch = touchEvent.touches[t];
-            if (touch.identifier === this.fakeTouchFinger.id) {
-                const x =
-                    touch.clientX - this.videoElementParentClientRect.left;
-                const y = touch.clientY - this.videoElementParentClientRect.top;
-                const coord =
-                    this.coordinateConverter.normalizeAndQuantizeUnsigned(x, y);
-                const delta =
-                    this.coordinateConverter.normalizeAndQuantizeSigned(
-                        x - this.fakeTouchFinger.x,
-                        y - this.fakeTouchFinger.y
-                    );
-                toStreamerHandlers.get('MouseMove')([
-                    coord.x,
-                    coord.y,
-                    delta.x,
-                    delta.y
-                ]);
-                this.fakeTouchFinger.x = x;
-                this.fakeTouchFinger.y = y;
-                break;
-            }
-        }
-        touchEvent.preventDefault();
-    }
-}
-
-/**
- * The interface for finger position mapping
- */
-export class FakeTouchFinger {
-    id: number;
-    x: number;
-    y: number;
-
-    /**
-     * @param id - the button id
-     * @param x - the x axis value
-     * @param y - the y axis value
-     */
-    constructor(id: number, x: number, y: number) {
-        this.id = id;
-        this.x = x;
-        this.y = y;
-    }
-}

package/src/Inputs/HoveringMouseEvents.ts

@@ -1,192 +0,0 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-
-import { MouseController } from './MouseController';
-import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
-import { IMouseEvents } from './IMouseEvents';
-
-/**
- * Video Player mouse Hover handler
- */
-export class HoveringMouseEvents implements IMouseEvents {
-    mouseController: MouseController;
-
-    /**
-     * @param mouseController - Mouse Controller instance
-     */
-    constructor(mouseController: MouseController) {
-        this.mouseController = mouseController;
-    }
-
-    /**
-     * Unregister event handlers
-     */
-    unregisterMouseEvents(): void {
-        // empty for HoveringMouseEvents implementation
-    }
-
-    /**
-     * Handle the mouse move event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    updateMouseMovePosition(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        Logger.Log(Logger.GetStackTrace(), 'MouseMove', 6);
-        const coord =
-            this.mouseController.coordinateConverter.normalizeAndQuantizeUnsigned(
-                mouseEvent.offsetX,
-                mouseEvent.offsetY
-            );
-        const delta =
-            this.mouseController.coordinateConverter.normalizeAndQuantizeSigned(
-                mouseEvent.movementX,
-                mouseEvent.movementY
-            );
-        const toStreamerHandlers =
-            this.mouseController.toStreamerMessagesProvider.toStreamerHandlers;
-        toStreamerHandlers.get('MouseMove')([
-            coord.x,
-            coord.y,
-            delta.x,
-            delta.y
-        ]);
-        mouseEvent.preventDefault();
-    }
-
-    /**
-     * Handle the mouse Down event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handleMouseDown(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        Logger.Log(Logger.GetStackTrace(), 'onMouse Down', 6);
-        const coord =
-            this.mouseController.coordinateConverter.normalizeAndQuantizeUnsigned(
-                mouseEvent.offsetX,
-                mouseEvent.offsetY
-            );
-        const toStreamerHandlers =
-            this.mouseController.toStreamerMessagesProvider.toStreamerHandlers;
-        toStreamerHandlers.get('MouseDown')([
-            mouseEvent.button,
-            coord.x,
-            coord.y
-        ]);
-        mouseEvent.preventDefault();
-    }
-
-    /**
-     * Handle the mouse Up event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handleMouseUp(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        Logger.Log(Logger.GetStackTrace(), 'onMouse Up', 6);
-        const coord =
-            this.mouseController.coordinateConverter.normalizeAndQuantizeUnsigned(
-                mouseEvent.offsetX,
-                mouseEvent.offsetY
-            );
-        const toStreamerHandlers =
-            this.mouseController.toStreamerMessagesProvider.toStreamerHandlers;
-        toStreamerHandlers.get('MouseUp')([
-            mouseEvent.button,
-            coord.x,
-            coord.y
-        ]);
-        mouseEvent.preventDefault();
-    }
-
-    /**
-     * Consumes the mouse context event. The UE instance has no equivalent and doesn't need to be informed.
-     * @param mouseEvent - Mouse Event
-     */
-    handleContextMenu(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        mouseEvent.preventDefault();
-    }
-
-    /**
-     * Handle the mouse wheel event, sends the mouse wheel data to the UE Instance
-     * @param wheelEvent - Mouse Event
-     */
-    handleMouseWheel(wheelEvent: WheelEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        const coord =
-            this.mouseController.coordinateConverter.normalizeAndQuantizeUnsigned(
-                wheelEvent.offsetX,
-                wheelEvent.offsetY
-            );
-        const toStreamerHandlers =
-            this.mouseController.toStreamerMessagesProvider.toStreamerHandlers;
-        toStreamerHandlers.get('MouseWheel')([
-            wheelEvent.wheelDelta,
-            coord.x,
-            coord.y
-        ]);
-        wheelEvent.preventDefault();
-    }
-
-    /**
-     * Handle the mouse double click event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handleMouseDouble(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        const coord =
-            this.mouseController.coordinateConverter.normalizeAndQuantizeUnsigned(
-                mouseEvent.offsetX,
-                mouseEvent.offsetY
-            );
-        const toStreamerHandlers =
-            this.mouseController.toStreamerMessagesProvider.toStreamerHandlers;
-        toStreamerHandlers.get('MouseDouble')([
-            mouseEvent.button,
-            coord.x,
-            coord.y
-        ]);
-    }
-
-    /**
-     * Handle the press mouse buttons event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handlePressMouseButtons(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        Logger.Log(Logger.GetStackTrace(), 'onMouse press', 6);
-        this.mouseController.pressMouseButtons(
-            mouseEvent.buttons,
-            mouseEvent.offsetX,
-            mouseEvent.offsetY
-        );
-    }
-
-    /**
-     * Handle the release mouse buttons event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handleReleaseMouseButtons(mouseEvent: MouseEvent) {
-        if (!this.mouseController.videoElementProvider.isVideoReady()) {
-            return;
-        }
-        Logger.Log(Logger.GetStackTrace(), 'onMouse release', 6);
-        this.mouseController.releaseMouseButtons(
-            mouseEvent.buttons,
-            mouseEvent.offsetX,
-            mouseEvent.offsetY
-        );
-    }
-}

package/src/Inputs/IMouseEvents.ts

@@ -1,64 +0,0 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-
-/**
- * Interface for Mouse Events
- */
-export interface IMouseEvents {
-    /**
-     * Handle when the locked state Changed
-     */
-    lockStateChange?(): void;
-
-    /**
-     * Handle when the mouse move
-     * @param mouseEvent - Mouse Event
-     */
-    updateMouseMovePosition?(mouseEvent: MouseEvent): void;
-
-    /**
-     * Handle when the Button Down
-     * @param mouseEvent - Mouse Event
-     */
-    handleMouseDown(mouseEvent: MouseEvent): void;
-
-    /**
-     * Handle when the button up
-     * @param mouseEvent - Mouse Event
-     */
-    handleMouseUp(mouseEvent: MouseEvent): void;
-
-    /**
-     * Handle when the mouse wheel
-     * @param wheelEvent - Mouse wheel
-     */
-    handleMouseWheel(wheelEvent: WheelEvent): void;
-
-    /**
-     * Handle when the button double click
-     * @param mouseEvent - Mouse Event
-     */
-    handleMouseDouble(mouseEvent: MouseEvent): void;
-
-    /**
-     * Handle the press mouse buttons event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handlePressMouseButtons(mouseEvent: MouseEvent): void;
-
-    /**
-     * Handle the release mouse buttons event, sends the mouse data to the UE Instance
-     * @param mouseEvent - Mouse Event
-     */
-    handleReleaseMouseButtons(mouseEvent: MouseEvent): void;
-
-    /**
-     * Handle the mouse context menu
-     * @param mouseEvent - mouse event
-     */
-    handleContextMenu?(mouseEvent: MouseEvent): void;
-
-    /**
-     * Unregister any registered mouse event handlers
-     */
-    unregisterMouseEvents(): void;
-}

package/src/Inputs/ITouchController.ts

@@ -1,29 +0,0 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-
-/**
- * Interface for Touch Events
- */
-export interface ITouchController {
-    /**
-     * Fire when a touch event starts
-     * @param touchEvent - Touch Event Data
-     */
-    onTouchStart(touchEvent: TouchEvent): void;
-
-    /**
-     * Fire when a touch event ends
-     * @param touchEvent - Touch Event Data
-     */
-    onTouchEnd(touchEvent: TouchEvent): void;
-
-    /**
-     * Fire when touch moves
-     * @param touchEvent - Touch Event Data
-     */
-    onTouchMove(touchEvent: TouchEvent): void;
-
-    /**
-     * Unregister all touch event handlers.
-     */
-    unregisterTouchEvents(): void;
-}