Merge pull request #212 from FoxxMD/playerStateCleanup

feat(player): Real time positional player state

Author: FoxxMD

src/backend/common/infrastructure/Atomic.ts

@@ -4,7 +4,7 @@ import { Dayjs } from "dayjs";
 import { Request, Response } from "express";
 import { NextFunction, ParamsDictionary, Query } from "express-serve-static-core";
 import { FixedSizeList } from 'fixed-size-list';
-import { PlayMeta, PlayObject } from "../../../core/Atomic.js";
+import { isPlayObject, PlayMeta, PlayObject } from "../../../core/Atomic.js";
 import TupleMap from "../TupleMap.js";
 
 export type SourceType =
@@ -122,13 +122,9 @@ export interface PlayerStateDataMaybePlay {
     timestamp?: Dayjs
 }
 
-export const asPlayerStateData = (obj: object): obj is PlayerStateData => {
-    return 'platformId' in obj && 'play' in obj;
-}
+export const asPlayerStateData = (obj: object): obj is PlayerStateData => asPlayerStateDataMaybePlay(obj) && 'play' in obj && isPlayObject(obj.play)
 
-export const asPlayerStateDataMaybePlay = (obj: object): obj is PlayerStateDataMaybePlay => {
-    return 'platformId' in obj;
-}
+export const asPlayerStateDataMaybePlay = (obj: object): obj is PlayerStateDataMaybePlay => 'platformId' in obj
 
 export interface FormatPlayObjectOptions {
     newFromSource?: boolean

src/backend/sources/ChromecastSource.ts

@@ -34,7 +34,7 @@ import { difference, genGroupIdStr, parseBool } from "../utils.js";
 import { findCauseByReference } from "../utils/ErrorUtils.js";
 import { discoveryAvahi, discoveryNative } from "../utils/MDNSUtils.js";
 import { RecentlyPlayedOptions } from "./AbstractSource.js";
-import MemorySource from "./MemorySource.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
 interface ChromecastDeviceInfo {
     mdns: MdnsDeviceInfo
@@ -46,7 +46,7 @@ interface ChromecastDeviceInfo {
     applications: Map<string, PlatformApplicationWithContext>
 }
 
-export class ChromecastSource extends MemorySource {
+export class ChromecastSource extends MemoryPositionalSource {
 
     declare config: ChromecastSourceConfig;
 

src/backend/sources/JRiverSource.ts

@@ -7,9 +7,9 @@ import { FormatPlayObjectOptions, InternalConfig } from "../common/infrastructur
 import { JRiverSourceConfig } from "../common/infrastructure/config/source/jriver.js";
 import { Info, JRiverApiClient, PLAYER_STATE } from "../common/vendor/JRiverApiClient.js";
 import { RecentlyPlayedOptions } from "./AbstractSource.js";
-import MemorySource from "./MemorySource.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
-export class JRiverSource extends MemorySource {
+export class JRiverSource extends MemoryPositionalSource {
     declare config: JRiverSourceConfig;
 
     url: URL;

src/backend/sources/JellyfinApiSource.ts

@@ -52,13 +52,11 @@ import {
 import { JellyApiSourceConfig } from "../common/infrastructure/config/source/jellyfin.js";
 import { combinePartsToString, genGroupIdStr, getPlatformIdFromData, joinedUrl, parseBool, } from "../utils.js";
 import { parseArrayFromMaybeString } from "../utils/StringUtils.js";
-import MemorySource from "./MemorySource.js";
-import { PlayerStateOptions } from "./PlayerState/AbstractPlayerState.js";
-import { JellyfinPlayerState } from "./PlayerState/JellyfinPlayerState.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
 const shortDeviceId = truncateStringToLength(10, '');
 
-export default class JellyfinApiSource extends MemorySource {
+export default class JellyfinApiSource extends MemoryPositionalSource {
     users: string[] = [];
 
     client: Jellyfin
@@ -476,7 +474,6 @@ export default class JellyfinApiSource extends MemorySource {
         }
     }
 
-    getNewPlayer = (logger: Logger, id: PlayPlatformId, opts: PlayerStateOptions) => new JellyfinPlayerState(logger, id, opts)
 }
 
 /**

src/backend/sources/KodiSource.ts

@@ -4,9 +4,9 @@ import { FormatPlayObjectOptions, InternalConfig } from "../common/infrastructur
 import { KodiSourceConfig } from "../common/infrastructure/config/source/kodi.js";
 import { KodiApiClient } from "../common/vendor/KodiApiClient.js";
 import { RecentlyPlayedOptions } from "./AbstractSource.js";
-import MemorySource from "./MemorySource.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
-export class KodiSource extends MemorySource {
+export class KodiSource extends MemoryPositionalSource {
     declare config: KodiSourceConfig;
 
     client: KodiApiClient;

src/backend/sources/MPDSource.ts

@@ -19,7 +19,7 @@ import {
 } from "../common/infrastructure/config/source/mpd.js";
 import { isPortReachable } from "../utils/NetworkUtils.js";
 import { RecentlyPlayedOptions } from "./AbstractSource.js";
-import MemorySource from "./MemorySource.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
 const mpdClient = mpdapiNS.default;
 
@@ -29,7 +29,7 @@ const CLIENT_PLAYER_STATE: Record<PlayerState, ReportedPlayerStatus> = {
     'stop': REPORTED_PLAYER_STATUSES.stopped,
 }
 
-export class MPDSource extends MemorySource {
+export class MPDSource extends MemoryPositionalSource {
     declare config: MPDSourceConfig;
 
     host?: string

src/backend/sources/MemoryPositionalSource.ts

@@ -0,0 +1,9 @@
+import { Logger } from "@foxxmd/logging";
+import { PlayPlatformId } from "../common/infrastructure/Atomic.js";
+import MemorySource from "./MemorySource.js";
+import { PlayerStateOptions } from "./PlayerState/AbstractPlayerState.js";
+import { PositionalPlayerState } from "./PlayerState/PositionalPlayerState.js";
+
+export class MemoryPositionalSource extends MemorySource {
+    getNewPlayer = (logger: Logger, id: PlayPlatformId, opts: PlayerStateOptions) => new PositionalPlayerState(logger, id, opts)
+}

src/backend/sources/MemorySource.ts

@@ -90,7 +90,7 @@ export default class MemorySource extends AbstractSource {
         return record;
     }
 
-    getNewPlayer = (logger: Logger, id: PlayPlatformId, opts: PlayerStateOptions) => new GenericPlayerState(logger, id, opts)
+    getNewPlayer = (logger: Logger, id: PlayPlatformId, opts: PlayerStateOptions): AbstractPlayerState => new GenericPlayerState(logger, id, opts)
 
     setNewPlayer = (idStr: string, logger: Logger, id: PlayPlatformId, opts: PlayerStateOptions = {}) => {
         this.players.set(idStr, this.getNewPlayer(this.logger, id, {
@@ -167,7 +167,17 @@ export default class MemorySource extends AbstractSource {
                 }
                 incomingData = relevantDatas[0];
 
-                const [currPlay, prevPlay] = asPlayerStateDataMaybePlay(incomingData) ? player.setState(incomingData.status, incomingData.play) : player.setState(undefined, incomingData);
+                let playerState: PlayerStateDataMaybePlay;
+                if(asPlayerStateDataMaybePlay(incomingData)) {
+                    playerState = incomingData;
+                } else {
+                    playerState = {play: incomingData, platformId: getPlatformIdFromData(incomingData)};
+                }
+                if(playerState.position === undefined && playerState.play !== undefined && playerState.play.meta.trackProgressPosition !== undefined) {
+                    playerState.position = playerState.play.meta?.trackProgressPosition;
+                }
+
+                const [currPlay, prevPlay] = player.update(playerState);
                 const candidate = prevPlay !== undefined ? prevPlay : currPlay;
                 const playChanged = prevPlay !== undefined;
 

src/backend/sources/MopidySource.ts

@@ -15,9 +15,9 @@ import {
 } from "../common/infrastructure/Atomic.js";
 import { MopidySourceConfig } from "../common/infrastructure/config/source/mopidy.js";
 import { RecentlyPlayedOptions } from "./AbstractSource.js";
-import MemorySource from "./MemorySource.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
-export class MopidySource extends MemorySource {
+export class MopidySource extends MemoryPositionalSource {
     declare config: MopidySourceConfig;
 
     albumBlacklist: string[] = [];

src/backend/sources/MusikcubeSource.ts

@@ -22,7 +22,7 @@ import {
 } from "../common/infrastructure/config/source/musikcube.js";
 import { sleep } from "../utils.js";
 import { RecentlyPlayedOptions } from "./AbstractSource.js";
-import MemorySource from "./MemorySource.js";
+import { MemoryPositionalSource } from "./MemoryPositionalSource.js";
 
 const CLIENT_STATE = {
     0: 'connecting',
@@ -31,7 +31,7 @@ const CLIENT_STATE = {
     3: 'closed'
 }
 
-export class MusikcubeSource extends MemorySource {
+export class MusikcubeSource extends MemoryPositionalSource {
     declare config: MusikcubeSourceConfig;
 
     url: URL;