feat: Add experimental reolink media support (#1694)

* feat: Add experimental rich reolink support. * Formatting fix
2024-11-25 20:19:12 -08:00
parent e898b73d63
commit dada65e008
63 changed files with 3402 additions and 483 deletions
@@ -1,24 +1,15 @@
-import { HomeAssistant } from '@dermotduffy/custom-card-helpers';
 import { StateWatcherSubscriptionInterface } from '../../card-controller/hass/state-watcher';
 import { CameraConfig } from '../../config/types';
 import { ExtendedHomeAssistant } from '../../types';
 import { canonicalizeHAURL } from '../../utils/ha';
 import { BrowseMediaManager } from '../../utils/ha/browse-media/browse-media-manager';
-import {
-  BROWSE_MEDIA_CACHE_SECONDS,
-  MEDIA_CLASS_IMAGE,
-  MEDIA_CLASS_VIDEO,
-  RichBrowseMedia,
-} from '../../utils/ha/browse-media/types';
+import { BROWSE_MEDIA_CACHE_SECONDS } from '../../utils/ha/browse-media/types';
 import { EntityRegistryManager } from '../../utils/ha/registry/entity';
 import { ResolvedMediaCache, resolveMedia } from '../../utils/ha/resolved-media';
 import { ViewMedia } from '../../view/media';
 import { RequestCache } from '../cache';
-import { Camera } from '../camera';
-import { Capabilities } from '../capabilities';
 import { CameraManagerEngine } from '../engine';
 import { GenericCameraManagerEngine } from '../generic/engine-generic';
-import { rangesOverlap } from '../range';
 import { CameraManagerReadOnlyConfigStore } from '../store';
 import {
  CameraEndpoint,
@@ -29,93 +20,8 @@ import {
  PartialEventQuery,
  QueryType,
 } from '../types';
-import { getPTZCapabilitiesFromCameraConfig } from '../utils/ptz';
-import { BrowseMediaCamera } from './camera';
-import { BrowseMediaViewMediaFactory } from './media';
 import { BrowseMediaMetadata } from './types';

-/**
- * A utility method to determine if a browse media object matches against a
- * start and end date.
- * @param media The browse media object (with rich metadata).
- * @param start The optional start date.
- * @param end The optional end date.
- * @returns `true` if the media falls within the provided dates.
- */
-export const isMediaWithinDates = (
-  media: RichBrowseMedia<BrowseMediaMetadata>,
-  start?: Date,
-  end?: Date,
-): boolean => {
-  // If no date is specified at all, everything matches.
-  const dateReference = start ?? end;
-  if (!dateReference) {
-    return true;
-  }
-
-  // If there's no metadata, nothing matches.
-  if (!media._metadata) {
-    return false;
-  }
-
-  // Determine if:
-  // - The media starts within the query timeframe.
-  // - The media ends within the query timeframe.
-  // - The media entirely encompasses the query timeframe.
-  return rangesOverlap(
-    {
-      start: media._metadata.startDate,
-      end: media._metadata.endDate,
-    },
-    {
-      start: start ?? dateReference,
-      end: end ?? dateReference,
-    },
-  );
-};
-
-export const getViewMediaFromBrowseMediaArray = (
-  browseMedia: RichBrowseMedia<BrowseMediaMetadata>[],
-): ViewMedia[] | null => {
-  const lookup: Map<string, ViewMedia> = new Map();
-  for (const browseMediaItem of browseMedia) {
-    const cameraID = browseMediaItem._metadata?.cameraID;
-    if (!cameraID) {
-      continue;
-    }
-
-    const mediaType =
-      browseMediaItem.media_class === MEDIA_CLASS_VIDEO
-        ? 'clip'
-        : browseMediaItem.media_class === MEDIA_CLASS_IMAGE
-          ? 'snapshot'
-          : null;
-
-    if (!mediaType) {
-      continue;
-    }
-    const media = BrowseMediaViewMediaFactory.createEventViewMedia(
-      mediaType,
-      browseMediaItem,
-      cameraID,
-    );
-
-    if (media) {
-      const id = media.getID();
-      const existing = lookup.get(id);
-      // De-duplicate events with precisely the same ID (same
-      // hour/minute/second) choosing clip > snapshot.
-      if (
-        !existing ||
-        (existing.getMediaType() === 'snapshot' && media.getMediaType() === 'clip')
-      ) {
-        lookup.set(id, media);
-      }
-    }
-  }
-  return [...lookup.values()];
-};
-
 /**
 * A base class for cameras that read events from HA BrowseMedia interface.
 */
@@ -143,38 +49,6 @@ export class BrowseMediaCameraManagerEngine
    this._requestCache = requestCache;
  }

-  public async createCamera(
-    hass: HomeAssistant,
-    cameraConfig: CameraConfig,
-  ): Promise<Camera> {
-    const camera = new BrowseMediaCamera(cameraConfig, this, {
-      capabilities: new Capabilities(
-        {
-          'favorite-events': false,
-          'favorite-recordings': false,
-          clips: true,
-          live: true,
-          menu: true,
-          recordings: false,
-          seek: false,
-          snapshots: true,
-          substream: true,
-          ptz: getPTZCapabilitiesFromCameraConfig(cameraConfig) ?? undefined,
-        },
-        {
-          disable: cameraConfig.capabilities?.disable,
-          disableExcept: cameraConfig.capabilities?.disable_except,
-        },
-      ),
-      eventCallback: this._eventCallback,
-    });
-    return await camera.initialize({
-      entityRegistryManager: this._entityRegistryManager,
-      hass,
-      stateWatcher: this._stateWatcher,
-    });
-  }
-
  public generateDefaultEventQuery(
    _store: CameraManagerReadOnlyConfigStore,
    cameraIDs: Set<string>,
@@ -38,7 +38,7 @@ class BrowseMediaEventViewMedia extends ViewMedia implements EventViewMedia {
    return this._browseMedia._metadata?.startDate ?? null;
  }
  public getEndTime(): Date | null {
-    return null;
+    return this._browseMedia._metadata?.endDate ?? null;
  }
  public getVideoContentType(): VideoContentType | null {
    return VideoContentType.MP4;
@@ -79,7 +79,7 @@ export class BrowseMediaViewMediaFactory {
    mediaType: 'clip' | 'snapshot',
    browseMedia: RichBrowseMedia<BrowseMediaMetadata>,
    cameraID: string,
-  ): BrowseMediaEventViewMedia | null {
+  ): BrowseMediaEventViewMedia {
    return new BrowseMediaEventViewMedia(mediaType, cameraID, browseMedia);
  }
 }
@@ -0,0 +1,49 @@
+import {
+  RichBrowseMedia,
+  MEDIA_CLASS_VIDEO,
+  MEDIA_CLASS_IMAGE,
+} from '../../../utils/ha/browse-media/types';
+import { ViewMedia } from '../../../view/media';
+import { BrowseMediaViewMediaFactory } from '../media';
+import { BrowseMediaMetadata } from '../types';
+
+export const getViewMediaFromBrowseMediaArray = (
+  browseMedia: RichBrowseMedia<BrowseMediaMetadata>[],
+): ViewMedia[] | null => {
+  const lookup: Map<string, ViewMedia> = new Map();
+  for (const browseMediaItem of browseMedia) {
+    const cameraID = browseMediaItem._metadata?.cameraID;
+    if (!cameraID) {
+      continue;
+    }
+
+    const mediaType =
+      browseMediaItem.media_class === MEDIA_CLASS_VIDEO
+        ? 'clip'
+        : browseMediaItem.media_class === MEDIA_CLASS_IMAGE
+          ? 'snapshot'
+          : null;
+
+    if (!mediaType) {
+      continue;
+    }
+    const media = BrowseMediaViewMediaFactory.createEventViewMedia(
+      mediaType,
+      browseMediaItem,
+      cameraID,
+    );
+
+    const id = media.getID();
+    const existing = lookup.get(id);
+
+    // De-duplicate events with precisely the same ID (same
+    // hour/minute/second) choosing clip > snapshot.
+    if (
+      !existing ||
+      (existing.getMediaType() === 'snapshot' && media.getMediaType() === 'clip')
+    ) {
+      lookup.set(id, media);
+    }
+  }
+  return [...lookup.values()];
+};
@@ -0,0 +1,50 @@
+import { RichBrowseMedia } from '../../../utils/ha/browse-media/types';
+import { rangesOverlap } from '../../range';
+import { BrowseMediaMetadata } from '../types';
+
+/**
+ * A utility method to determine if a browse media object matches against a
+ * start and end date.
+ * @param media The browse media object (with rich metadata).
+ * @param start The optional start date.
+ * @param end The optional end date.
+ * @returns `true` if the media falls within the provided dates.
+ */
+
+export const isMediaWithinDates = (
+  media: RichBrowseMedia<BrowseMediaMetadata>,
+  start?: Date,
+  end?: Date,
+): boolean => {
+  // If there's no metadata, nothing matches.
+  if (!media._metadata) {
+    return false;
+  }
+
+  if (start && end) {
+    // Determine if:
+    // - The media starts within the query timeframe.
+    // - The media ends within the query timeframe.
+    // - The media entirely encompasses the query timeframe.
+    return rangesOverlap(
+      {
+        start: media._metadata.startDate,
+        end: media._metadata.endDate,
+      },
+      {
+        start: start,
+        end: end,
+      },
+    );
+  }
+
+  if (!start && end) {
+    return media._metadata.startDate <= end;
+  }
+  if (start && !end) {
+    return media._metadata.startDate >= start;
+  }
+
+  // If no date is specified at all, everything matches.
+  return true;
+};