camera_utils.py

   1 #!/usr/bin/env python3
   2
   3 """Utilities for dealing with webcam images."""
   4
   5 import logging
   6 import platform
   7 import subprocess
   8 import warnings
   9 from typing import NamedTuple, Optional
  10
  11 import cv2  # type: ignore
  12 import numpy as np
  13 import requests
  14
  15 import decorator_utils
  16 import exceptions
  17
  18 logger = logging.getLogger(__name__)
  19
  20
  21 class RawJpgHsv(NamedTuple):
  22     """Raw image bytes, the jpeg image and the HSV (hue saturation value) image."""
  23
  24     raw: Optional[bytes]
  25     jpg: Optional[np.ndarray]
  26     hsv: Optional[np.ndarray]
  27
  28
  29 class SanityCheckImageMetadata(NamedTuple):
  30     """Is a Blue Iris image bad (big grey borders around it) or infrared?"""
  31
  32     is_bad_image: bool
  33     is_infrared_image: bool
  34
  35
  36 def sanity_check_image(hsv: np.ndarray) -> SanityCheckImageMetadata:
  37     """See if a Blue Iris or Shinobi image is bad and infrared."""
  38
  39     def is_near(a, b) -> bool:
  40         return abs(a - b) < 3
  41
  42     rows, cols, _ = hsv.shape
  43     num_pixels = rows * cols
  44     weird_orange_count = 0
  45     hs_zero_count = 0
  46     for r in range(rows):
  47         for c in range(cols):
  48             pixel = hsv[(r, c)]
  49             if is_near(pixel[0], 16) and is_near(pixel[1], 117) and is_near(pixel[2], 196):
  50                 weird_orange_count += 1
  51             elif is_near(pixel[0], 0) and is_near(pixel[1], 0):
  52                 hs_zero_count += 1
  53     logger.debug(f"hszero#={hs_zero_count}, weird_orange={weird_orange_count}")
  54     return SanityCheckImageMetadata(
  55         hs_zero_count > (num_pixels * 0.75),
  56         weird_orange_count > (num_pixels * 0.75),
  57     )
  58
  59
  60 @decorator_utils.retry_if_none(tries=2, delay_sec=1, backoff=1.1)
  61 def fetch_camera_image_from_video_server(
  62     camera_name: str, *, width: int = 256, quality: int = 70
  63 ) -> Optional[bytes]:
  64     """Fetch the raw webcam image from the video server."""
  65     camera_name = camera_name.replace(".house", "")
  66     camera_name = camera_name.replace(".cabin", "")
  67     url = (
  68         f"http://10.0.0.226:8080/Umtxxf1uKMBniFblqeQ9KRbb6DDzN4/jpeg/GKlT2FfiSQ/{camera_name}/s.jpg"
  69     )
  70     logger.debug(f'Fetching image from {url}')
  71     try:
  72         response = requests.get(url, stream=False, timeout=10.0)
  73         if response.ok:
  74             raw = response.content
  75             logger.debug(f'Read {len(response.content)} byte image from HTTP server')
  76             tmp = np.frombuffer(raw, dtype="uint8")
  77             logger.debug(
  78                 f'Translated raw content into {tmp.shape} {type(tmp)} with element type {type(tmp[0])}.'
  79             )
  80             jpg = cv2.imdecode(tmp, cv2.IMREAD_COLOR)
  81             logger.debug(
  82                 f'Decoded into {jpg.shape} jpeg {type(jpg)} with element type {type(jpg[0][0])}'
  83             )
  84             hsv = cv2.cvtColor(jpg, cv2.COLOR_BGR2HSV)
  85             logger.debug(
  86                 f'Converted JPG into HSV {hsv.shape} HSV {type(hsv)} with element type {type(hsv[0][0])}'
  87             )
  88             (_, is_bad_image) = sanity_check_image(hsv)
  89             if not is_bad_image:
  90                 return raw
  91     except Exception as e:
  92         logger.exception(e)
  93     msg = f"Got a bad image or HTTP error from {url}; returning None."
  94     logger.warning(msg)
  95     warnings.warn(msg, stacklevel=2)
  96     return None
  97
  98
  99 def camera_name_to_hostname(camera_name: str) -> str:
 100     """Map a camera name to a hostname
 101
 102     >>> camera_name_to_hostname('driveway')
 103     'driveway.house'
 104
 105     >>> camera_name_to_hostname('cabin_driveway')
 106     'driveway.cabin'
 107
 108     """
 109     mapping = {
 110         "driveway": "driveway.house",
 111         "backyard": "backyard.house",
 112         "frontdoor": "frontdoor.house",
 113         "cabin_driveway": "driveway.cabin",
 114     }
 115     camera_name = mapping.get(camera_name, camera_name)
 116     if "." not in camera_name:
 117         hostname = platform.node()
 118         suffix = hostname.split(".")[-1]
 119         camera_name += f".{suffix}"
 120     return camera_name
 121
 122
 123 @decorator_utils.retry_if_none(tries=2, delay_sec=1, backoff=1.1)
 124 def fetch_camera_image_from_rtsp_stream(camera_name: str, *, width: int = 256) -> Optional[bytes]:
 125     """Fetch the raw webcam image straight from the webcam's RTSP stream."""
 126     hostname = camera_name_to_hostname(camera_name)
 127     stream = f"rtsp://camera:IaLaIok@{hostname}:554/live"
 128     logger.debug(f'Fetching image from RTSP stream {stream}')
 129     try:
 130         cmd = [
 131             "/usr/bin/timeout",
 132             "-k 9s",
 133             "8s",
 134             "/usr/local/bin/ffmpeg",
 135             "-y",
 136             "-i",
 137             f"{stream}",
 138             "-f",
 139             "singlejpeg",
 140             "-vframes",
 141             "1",
 142             "-vf",
 143             f"scale={width}:-1",
 144             "-",
 145         ]
 146         with subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL) as proc:
 147             out, _ = proc.communicate(timeout=10)
 148             return out
 149     except Exception as e:
 150         logger.exception(e)
 151     msg = f"Failed to retrieve image via RTSP {stream}, returning None."
 152     logger.warning(msg)
 153     warnings.warn(msg, stacklevel=2)
 154     return None
 155
 156
 157 @decorator_utils.timeout(seconds=30, use_signals=False)
 158 def _fetch_camera_image(camera_name: str, *, width: int = 256, quality: int = 70) -> RawJpgHsv:
 159     """Fetch a webcam image given the camera name."""
 160     logger.debug("Trying to fetch camera image from video server")
 161     raw = fetch_camera_image_from_video_server(camera_name, width=width, quality=quality)
 162     if raw is None:
 163         logger.debug("Reading from video server failed; trying direct RTSP stream")
 164         raw = fetch_camera_image_from_rtsp_stream(camera_name, width=width)
 165     if raw is not None and len(raw) > 0:
 166         tmp = np.frombuffer(raw, dtype="uint8")
 167         jpg = cv2.imdecode(tmp, cv2.IMREAD_COLOR)
 168         hsv = cv2.cvtColor(jpg, cv2.COLOR_BGR2HSV)
 169         return RawJpgHsv(
 170             raw=raw,
 171             jpg=jpg,
 172             hsv=hsv,
 173         )
 174     msg = "Failed to retieve image from both video server and direct RTSP stream"
 175     logger.warning(msg)
 176     warnings.warn(msg, stacklevel=2)
 177     return RawJpgHsv(None, None, None)
 178
 179
 180 def fetch_camera_image(camera_name: str, *, width: int = 256, quality: int = 70) -> RawJpgHsv:
 181     try:
 182         return _fetch_camera_image(camera_name, width=width, quality=quality)
 183     except exceptions.TimeoutError:
 184         logger.warning('Fetching camera image operation timed out.')
 185         return RawJpgHsv(None, None, None)
 186
 187
 188 if __name__ == '__main__':
 189     import doctest
 190
 191     doctest.testmod()