flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor media classifiers.

Browse Source
This commit is contained in:
Dermot Duffy
2023-01-24 19:36:54 -08:00
parent 0f5f5b7ddf
commit 1762b5530f
9 changed files with 115 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/view/media-classifier.ts
+18 -33
View File
@@ -1,5 +1,10 @@
import { ModifyInterface } from '../utils/basic.js';
import { ViewMedia, FrigateEventViewMedia, FrigateRecordingViewMedia } from './media';
import {
ViewMedia,
FrigateEventViewMedia,
FrigateRecordingViewMedia,
RecordingViewMedia,
EventViewMedia,
} from './media';
export class ViewMediaClassifier {
public static isFrigateMedia(
@@ -15,39 +20,19 @@ export class ViewMediaClassifier {
): media is FrigateRecordingViewMedia {
return media instanceof FrigateRecordingViewMedia;
}
// Typescript conveniences.
public static isMediaWithStartEndTime(media: ViewMedia): media is ModifyInterface<
ViewMedia,
{
getStartTime(): Date;
getEndTime(): Date;
}
> {
return !!media.getStartTime() && !!media.getEndTime();
public static isEvent(media: ViewMedia): media is EventViewMedia {
return this.isClip(media) || this.isSnapshot(media);
}
public static isMediaWithStartTime(media: ViewMedia): media is ModifyInterface<
ViewMedia,
{
getStartTime(): Date;
}
> {
return !!media.getStartTime();
public static isRecording(media: ViewMedia): media is RecordingViewMedia {
return media.getMediaType() === 'recording';
}
public static isMediaWithEndTime(media: ViewMedia): media is ModifyInterface<
ViewMedia,
{
getEndTime(): Date;
}
> {
return !!media.getEndTime();
public static isClip(media: ViewMedia): boolean {
return media.getMediaType() === 'clip';
}
public static isMediaWithID(media: ViewMedia): media is ModifyInterface<
ViewMedia,
{
getID(): string;
}
> {
return !!media.getID();
public static isSnapshot(media: ViewMedia): boolean {
return media.getMediaType() === 'snapshot';
}
public static isVideo(media: ViewMedia): boolean {
return this.isClip(media) || this.isRecording(media);
}
}
src/view/media.ts
+31 -68
View File
@@ -1,6 +1,6 @@
import fromUnixTime from 'date-fns/fromUnixTime';
import isEqual from 'lodash-es/isEqual';
import { BrowseMediaSource, CameraConfig, MEDIA_TYPE_IMAGE } from '../types.js';
import { CameraConfig } from '../types.js';
import {
getEventMediaContentID,
getEventThumbnailURL,
@@ -9,9 +9,10 @@ import {
getRecordingTitle,
} from '../camera/frigate/util.js';
import { FrigateEvent, FrigateRecording } from '../camera/frigate/types.js';
import { ViewMediaClassifier } from './media-classifier.js';
export type ViewMediaType = 'clip' | 'snapshot' | 'recording';
export type ViewMediaSourceType = FrigateEvent | FrigateRecording | BrowseMediaSource;
export type ViewMediaSourceType = FrigateEvent | FrigateRecording;
class ViewMediaBase<T extends ViewMediaSourceType> {
protected _mediaType: ViewMediaType;
@@ -23,19 +24,6 @@ class ViewMediaBase<T extends ViewMediaSourceType> {
this._cameraID = cameraID;
this._source = source;
}
public isEvent(): boolean {
return this._mediaType === 'clip' || this._mediaType === 'snapshot';
}
public isRecording(): boolean {
return this._mediaType === 'recording';
}
public isClip(): boolean {
return this._mediaType === 'clip';
}
public isSnapshot(): boolean {
return this._mediaType === 'snapshot';
}
public getContentType(): 'image' | 'video' {
return this._mediaType === 'snapshot' ? 'image' : 'video';
}
@@ -45,9 +33,6 @@ class ViewMediaBase<T extends ViewMediaSourceType> {
public getMediaType(): ViewMediaType {
return this._mediaType;
}
public isVideo(): boolean {
return this.isClip() || this.isRecording();
}
public getSource(): T {
return this._source;
}
@@ -73,14 +58,6 @@ class ViewMediaBase<T extends ViewMediaSourceType> {
public getThumbnail(_cameraConfig?: CameraConfig): string | null {
return null;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public isGroupableWith(that: ViewMedia): boolean {
return (
this.getMediaType() === that.getMediaType() &&
isEqual(this.getWhere(), that.getWhere()) &&
isEqual(this.getWhat(), that.getWhat())
);
}
public isFavorite(): boolean | null {
return null;
}
@@ -91,18 +68,19 @@ class ViewMediaBase<T extends ViewMediaSourceType> {
public setFavorite(_favorite: boolean): void {
return;
}
public getWhat(): string[] | null {
return null;
}
public getWhere(): string[] | null {
return null;
}
public getScore(): number | null {
return null;
}
public getEventCount(): number | null {
return null;
}
}
export interface EventViewMedia extends ViewMedia {
getScore(): number | null;
getWhat(): string[] | null;
isGroupableWith(that: EventViewMedia): boolean;
}
export interface RecordingViewMedia extends ViewMedia {
getEventCount(): number | null;
}
// Creates a 'public interface only' version of ViewMediaBase for use elsewhere
@@ -112,26 +90,10 @@ export type ViewMedia = {
[P in keyof ViewMediaBase<ViewMediaSourceType>]: ViewMediaBase<ViewMediaSourceType>[P];
};
export class HomeAssistantBrowserViewMedia extends ViewMediaBase<BrowseMediaSource> {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public getID(_cameraConfig?: CameraConfig): string | null {
return this._source.media_content_id;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public getContentID(_cameraConfig?: CameraConfig): string | null {
return this._source.media_content_id;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public getTitle(_cameraConfig?: CameraConfig): string | null {
return this._source.title;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public getThumbnail(_cameraConfig?: CameraConfig): string | null {
return this._source.thumbnail;
}
}
export class FrigateEventViewMedia extends ViewMediaBase<FrigateEvent> {
export class FrigateEventViewMedia
extends ViewMediaBase<FrigateEvent>
implements EventViewMedia
{
public hasClip(): boolean {
return !!this._source.has_clip;
}
@@ -167,7 +129,7 @@ export class FrigateEventViewMedia extends ViewMediaBase<FrigateEvent> {
cameraConfig.frigate.client_id,
cameraConfig.frigate.camera_name,
this._source,
this.isClip() ? 'clips' : 'snapshots',
ViewMediaClassifier.isClip(this) ? 'clips' : 'snapshots',
);
}
@@ -198,9 +160,21 @@ export class FrigateEventViewMedia extends ViewMediaBase<FrigateEvent> {
public getScore(): number | null {
return this._source.top_score;
}
// eslint-disable-next-line @typescript-eslint/no-unused-vars
public isGroupableWith(that: EventViewMedia): boolean {
return (
this.getMediaType() === that.getMediaType() &&
isEqual(this.getWhere(), that.getWhere()) &&
isEqual(this.getWhat(), that.getWhat())
);
}
}
export class FrigateRecordingViewMedia extends ViewMediaBase<FrigateRecording> {
export class FrigateRecordingViewMedia
extends ViewMediaBase<FrigateRecording>
implements RecordingViewMedia
{
public getID(cameraConfig?: CameraConfig): string | null {
// ID name is derived from the real camera name (not CameraID) since the
// recordings for the same camera across multiple zones will be the same and
@@ -262,15 +236,4 @@ export class ViewMediaFactory {
): ViewMedia | null {
return new FrigateRecordingViewMedia('recording', cameraID, recording);
}
static createViewMediaFromBrowseMediaSource(
cameraID: string,
browseMedia: BrowseMediaSource,
): ViewMedia | null {
return new HomeAssistantBrowserViewMedia(
browseMedia.media_content_type === MEDIA_TYPE_IMAGE ? 'snapshot' : 'clip',
cameraID,
browseMedia,
);
}
}
src/view/view.ts
-1
View File
@@ -1,5 +1,4 @@
// Easy:
// - TODO: Are there elements of ViewMedia (e.g. getEventCount) that should be moved into subclasses (e.g. a recording subclass).
// - TODO: In MediaQueriesBase, do we need to generic? Just have T be a MediaQuery?
// - TODO: In the viewer @click handlers should I use this.selected instead of calling carouselScrollPrevious()