mirror of
https://github.com/blakeblackshear/frigate.git
synced 2025-10-27 10:52:11 +01:00
4d4d54d030
* Fix the `Any` typing hint treewide There has been confusion between the Any type[1] and the any function[2] in typing hints. [1] https://docs.python.org/3/library/typing.html#typing.Any [2] https://docs.python.org/3/library/functions.html#any * Fix typing for various frame_shape members Frame shapes are most likely defined by height and width, so a single int cannot express that. * Wrap gpu stats functions in Optional[] These can return `None`, so they need to be `Type | None`, which is what `Optional` expresses very nicely. * Fix return type in get_latest_segment_datetime Returns a datetime object, not an integer. * Make the return type of FrameManager.write optional This is necessary since the SharedMemoryFrameManager.write function can return None. * Fix total_seconds() return type in get_tz_modifiers The function returns a float, not an int. https://docs.python.org/3/library/datetime.html#datetime.timedelta.total_seconds * Account for floating point results in to_relative_box Because the function uses division the return types may either be int or float. * Resolve ruff deprecation warning The config has been split into formatter and linter, and the global options are deprecated.
64 lines
1.6 KiB
Python
64 lines
1.6 KiB
Python
"""Local only processors for handling real time object processing."""
|
|
|
|
import logging
|
|
from abc import ABC, abstractmethod
|
|
from typing import Any
|
|
|
|
import numpy as np
|
|
|
|
from frigate.config import FrigateConfig
|
|
|
|
from ..types import DataProcessorMetrics
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class RealTimeProcessorApi(ABC):
|
|
@abstractmethod
|
|
def __init__(
|
|
self,
|
|
config: FrigateConfig,
|
|
metrics: DataProcessorMetrics,
|
|
) -> None:
|
|
self.config = config
|
|
self.metrics = metrics
|
|
pass
|
|
|
|
@abstractmethod
|
|
def process_frame(self, obj_data: dict[str, Any], frame: np.ndarray) -> None:
|
|
"""Processes the frame with object data.
|
|
Args:
|
|
obj_data (dict): containing data about focused object in frame.
|
|
frame (ndarray): full yuv frame.
|
|
|
|
Returns:
|
|
None.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def handle_request(
|
|
self, topic: str, request_data: dict[str, Any]
|
|
) -> dict[str, Any] | None:
|
|
"""Handle metadata requests.
|
|
Args:
|
|
topic (str): topic that dictates what work is requested.
|
|
request_data (dict): containing data about requested change to process.
|
|
|
|
Returns:
|
|
None if request was not handled, otherwise return response.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def expire_object(self, object_id: str, camera: str) -> None:
|
|
"""Handle objects that are no longer detected.
|
|
Args:
|
|
object_id (str): id of object that is no longer detected.
|
|
camera (str): name of camera that object was detected on.
|
|
|
|
Returns:
|
|
None.
|
|
"""
|
|
pass
|