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 from typing import NamedTuple, Optional
   9 import warnings
  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 (
  50                 is_near(pixel[0], 16)
  51                 and is_near(pixel[1], 117)
  52                 and is_near(pixel[2], 196)
  53             ):
  54                 weird_orange_count += 1
  55             elif is_near(pixel[0], 0) and is_near(pixel[1], 0):
  56                 hs_zero_count += 1
  57     logger.debug(f"hszero#={hs_zero_count}, weird_orange={weird_orange_count}")
  58     return SanityCheckImageMetadata(
  59         hs_zero_count > (num_pixels * 0.75), weird_orange_count > (num_pixels * 0.75)
  60     )
  61
  62
  63 @decorator_utils.retry_if_none(tries=2, delay_sec=1, backoff=1.1)
  64 def fetch_camera_image_from_video_server(
  65     camera_name: str, *, width: int = 256, quality: int = 70
  66 ) -> Optional[bytes]:
  67     """Fetch the raw webcam image from the video server."""
  68     camera_name = camera_name.replace(".house", "")
  69     camera_name = camera_name.replace(".cabin", "")
  70     url = f"http://10.0.0.226:8080/Umtxxf1uKMBniFblqeQ9KRbb6DDzN4/jpeg/GKlT2FfiSQ/{camera_name}/s.jpg"
  71     logger.debug(f'Fetching image from {url}')
  72     try:
  73         response = requests.get(url, stream=False, timeout=10.0)
  74         if response.ok:
  75             raw = response.content
  76             logger.debug(f'Read {len(response.content)} byte image from HTTP server')
  77             tmp = np.frombuffer(raw, dtype="uint8")
  78             logger.debug(
  79                 f'Translated raw content into {tmp.shape} {type(tmp)} with element type {type(tmp[0])}.'
  80             )
  81             jpg = cv2.imdecode(tmp, cv2.IMREAD_COLOR)
  82             logger.debug(
  83                 f'Decoded into {jpg.shape} jpeg {type(jpg)} with element type {type(jpg[0][0])}'
  84             )
  85             hsv = cv2.cvtColor(jpg, cv2.COLOR_BGR2HSV)
  86             logger.debug(
  87                 f'Converted JPG into HSV {hsv.shape} HSV {type(hsv)} with element type {type(hsv[0][0])}'
  88             )
  89             (_, is_bad_image) = sanity_check_image(hsv)
  90             if not is_bad_image:
  91                 return raw
  92     except Exception as e:
  93         logger.exception(e)
  94     msg = f"Got a bad image or HTTP error from {url}; returning None."
  95     logger.warning(msg)
  96     warnings.warn(msg, stacklevel=2)
  97     return None
  98
  99
 100 def camera_name_to_hostname(camera_name: str) -> str:
 101     """Map a camera name to a hostname
 102
 103     >>> camera_name_to_hostname('driveway')
 104     'driveway.house'
 105
 106     >>> camera_name_to_hostname('cabin_driveway')
 107     'driveway.cabin'
 108
 109     """
 110     mapping = {
 111         "driveway": "driveway.house",
 112         "backyard": "backyard.house",
 113         "frontdoor": "frontdoor.house",
 114         "cabin_driveway": "driveway.cabin",
 115     }
 116     camera_name = mapping.get(camera_name, camera_name)
 117     if "." not in camera_name:
 118         hostname = platform.node()
 119         suffix = hostname.split(".")[-1]
 120         camera_name += f".{suffix}"
 121     return camera_name
 122
 123
 124 @decorator_utils.retry_if_none(tries=2, delay_sec=1, backoff=1.1)
 125 def fetch_camera_image_from_rtsp_stream(
 126     camera_name: str, *, width: int = 256
 127 ) -> Optional[bytes]:
 128     """Fetch the raw webcam image straight from the webcam's RTSP stream."""
 129     hostname = camera_name_to_hostname(camera_name)
 130     stream = f"rtsp://camera:IaLaIok@{hostname}:554/live"
 131     logger.debug(f'Fetching image from RTSP stream {stream}')
 132     try:
 133         cmd = [
 134             "/usr/bin/timeout",
 135             "-k 9s",
 136             "8s",
 137             "/usr/local/bin/ffmpeg",
 138             "-y",
 139             "-i",
 140             f"{stream}",
 141             "-f",
 142             "singlejpeg",
 143             "-vframes",
 144             "1",
 145             "-vf",
 146             f"scale={width}:-1",
 147             "-",
 148         ]
 149         with subprocess.Popen(
 150             cmd, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL
 151         ) as proc:
 152             out, _ = proc.communicate(timeout=10)
 153             return out
 154     except Exception as e:
 155         logger.exception(e)
 156     msg = f"Failed to retrieve image via RTSP {stream}, returning None."
 157     logger.warning(msg)
 158     warnings.warn(msg, stacklevel=2)
 159     return None
 160
 161
 162 @decorator_utils.timeout(seconds=30, use_signals=False)
 163 def _fetch_camera_image(
 164     camera_name: str, *, width: int = 256, quality: int = 70
 165 ) -> RawJpgHsv:
 166     """Fetch a webcam image given the camera name."""
 167     logger.debug("Trying to fetch camera image from video server")
 168     raw = fetch_camera_image_from_video_server(
 169         camera_name, width=width, quality=quality
 170     )
 171     if raw is None:
 172         logger.debug("Reading from video server failed; trying direct RTSP stream")
 173         raw = fetch_camera_image_from_rtsp_stream(camera_name, width=width)
 174     if raw is not None and len(raw) > 0:
 175         tmp = np.frombuffer(raw, dtype="uint8")
 176         jpg = cv2.imdecode(tmp, cv2.IMREAD_COLOR)
 177         hsv = cv2.cvtColor(jpg, cv2.COLOR_BGR2HSV)
 178         return RawJpgHsv(
 179             raw=raw,
 180             jpg=jpg,
 181             hsv=hsv,
 182         )
 183     msg = "Failed to retieve image from both video server and direct RTSP stream"
 184     logger.warning(msg)
 185     warnings.warn(msg, stacklevel=2)
 186     return RawJpgHsv(None, None, None)
 187
 188
 189 def fetch_camera_image(
 190     camera_name: str, *, width: int = 256, quality: int = 70
 191 ) -> RawJpgHsv:
 192     try:
 193         return _fetch_camera_image(camera_name, width=width, quality=quality)
 194     except exceptions.TimeoutError:
 195         logger.warning('Fetching camera image operation timed out.')
 196         return RawJpgHsv(None, None, None)
 197
 198
 199 if __name__ == '__main__':
 200     import doctest
 201
 202     doctest.testmod()