375 lines
No EOL
12 KiB
Python
375 lines
No EOL
12 KiB
Python
import time
|
|
import os
|
|
import io
|
|
import threading
|
|
import copy
|
|
import datetime
|
|
import uuid
|
|
from PIL import Image
|
|
|
|
try:
|
|
from greenlet import getcurrent as get_ident
|
|
except ImportError:
|
|
try:
|
|
from thread import get_ident
|
|
except ImportError:
|
|
from _thread import get_ident
|
|
|
|
# Slightly crappy debugger logging
|
|
DEBUG = True
|
|
|
|
|
|
def log(s):
|
|
if DEBUG:
|
|
print('DEBUG: {}'.format(s))
|
|
|
|
|
|
class StreamObject(object):
|
|
def __init__(self, write_to_file: bool=None, filename: str=None, folder: str=None, fmt: str='file') -> None:
|
|
# Store a nice ID
|
|
self.id = uuid.uuid4().hex
|
|
log("Created {}".format(self.id))
|
|
|
|
# Create file name
|
|
iterator = 0
|
|
f_name = self.build_file_path(filename, folder, fmt)
|
|
|
|
while os.path.isfile(f_name): # While file already exists
|
|
iterator += 1 # Add a file name iterator
|
|
f_name = self.build_file_path(filename, folder, fmt, iterator=iterator) # Rebuild file name
|
|
|
|
self.file = f_name
|
|
|
|
# Byte stream properties
|
|
self.stream = io.BytesIO() # Byte stream that data will be written to
|
|
|
|
# Set default write target
|
|
self.write_to_file = write_to_file
|
|
if self.write_to_file is False:
|
|
log("Default target for {} set to 'stream'".format(self.id))
|
|
self.target = self.stream
|
|
else:
|
|
log("Default target for {} set to 'file'".format(self.id))
|
|
self.target = self.file
|
|
|
|
# Keep on disk after close by default
|
|
self.keep_on_disk = True
|
|
|
|
# Object lock
|
|
self.locked = False # Is the StreamObject locked for writing? (Handled by StreamingCamera)
|
|
|
|
def __enter__(self):
|
|
log("Entering context for {}.\
|
|
Stored files will be cleaned up automatically.".format(self.id))
|
|
self.keep_on_disk = False # Flag file to be removed on close.
|
|
return self
|
|
|
|
def __exit__(self, *args):
|
|
log("Cleaning up {}".format(self.id))
|
|
self.close()
|
|
|
|
def build_file_path(self, filename: str, folder: str, fmt: str, iterator: int=0) -> str:
|
|
"""
|
|
Construct a full file path, based on filename, folder, and file format.
|
|
|
|
Defaults to datestamp. Iterator adds a numeric increment to the file name.
|
|
"""
|
|
if filename:
|
|
file_name = "{}.{}".format(filename, fmt)
|
|
else:
|
|
file_name_base = datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
|
|
if iterator:
|
|
file_name_base = "{}_{}".format(file_name_base, iterator)
|
|
file_name = "{}.{}".format(file_name_base, fmt)
|
|
|
|
# Create folder and file
|
|
if folder:
|
|
if not os.path.exists(folder):
|
|
os.mkdir(folder)
|
|
|
|
file_path = os.path.join(folder, file_name)
|
|
else:
|
|
file_path = file_name
|
|
|
|
return file_path
|
|
|
|
def lock(self):
|
|
"""Set locked flag to True."""
|
|
self.locked = True
|
|
|
|
def unlock(self):
|
|
"""Set locked flag to False."""
|
|
self.locked = False
|
|
|
|
@property
|
|
def stream_exists(self, auto_rewind=True) -> bool:
|
|
"""Check if BytesIO stream is empty"""
|
|
if auto_rewind:
|
|
self.stream.seek(0) # Rewind the data bytes for reading
|
|
if self.stream.getvalue(): # If data stream contains data
|
|
self.stream.seek(0) # Rewind the data bytes for reading
|
|
return True
|
|
else:
|
|
self.stream.seek(0) # Rewind the data bytes for reading
|
|
return False
|
|
|
|
@property
|
|
def file_exists(self) -> bool:
|
|
"""Check if corresponding file exists"""
|
|
if os.path.isfile(self.file):
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
@property
|
|
def metadata(self) -> dict:
|
|
d = {
|
|
'id': self.id,
|
|
'locked': self.locked,
|
|
'keep_on_disk': self.keep_on_disk,
|
|
'path': self.file,
|
|
}
|
|
|
|
# Get file path
|
|
if self.file_exists:
|
|
d['file'] = self.file
|
|
else:
|
|
d['file'] = None
|
|
|
|
# Check stream
|
|
if self.stream_exists:
|
|
d['stream'] = True
|
|
else:
|
|
d['stream'] = False
|
|
|
|
# Check if file was manually deleted
|
|
if self.keep_on_disk and not self.file_exists:
|
|
d['path'] = "{} (Deleted)".format(d['path'])
|
|
|
|
return d
|
|
|
|
@property
|
|
def data(self) -> io.BytesIO:
|
|
"""Return a byte string of the capture data."""
|
|
self.stream.seek(0) # Rewind the data bytes for reading
|
|
|
|
if self.stream_exists: # If data stream contains data
|
|
data = io.BytesIO(self.stream.getbuffer()) # Create a copy of the stream bytes
|
|
|
|
else: # If data stream is empty
|
|
if self.file_exists: # If data file exists
|
|
# TODO: Streamline this bit
|
|
log("No stream data. Opening from file {}".format(self.file))
|
|
with open(self.file, 'rb') as f:
|
|
d = io.BytesIO(f.read()) # Load bytes from file in disk
|
|
d.seek(0) # Rewind loaded stream
|
|
data = io.BytesIO(d.getbuffer()) # Create a copy of the stream bytes
|
|
else:
|
|
data = None
|
|
|
|
return data # Read and return bytes data
|
|
|
|
@property
|
|
def binary(self) -> bytes:
|
|
"""Return a byte string of the capture data."""
|
|
return self.data.getvalue()
|
|
|
|
def load_file(self) -> bool:
|
|
"""Load data stored on disk to the in-memory stream."""
|
|
if self.file_exists: # If data file exists
|
|
# TODO: Streamline this bit
|
|
with open(self.file, 'rb') as f:
|
|
self.stream = io.BytesIO(f.read()) # Load bytes from file in disk
|
|
self.stream.seek(0) # Rewind data bytes again
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def save_file(self) -> bool:
|
|
"""
|
|
Write the StreamObjects stream to a file.
|
|
"""
|
|
if self.stream_exists: # If there's a stream to save
|
|
with open(self.file, 'ab') as f: # Load file as bytes
|
|
log("Writing stream to file {}".format(self.file))
|
|
f.seek(0, 0) # Seek to the start of the file
|
|
f.write(self.binary) # Write data bytes to file
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
def delete_stream(self):
|
|
"""Clears the BytesIO stream of the StreamObject."""
|
|
self.stream = io.BytesIO()
|
|
|
|
def delete_file(self) -> bool:
|
|
"""
|
|
If the StreamObject has been saved to disk, deletes the file and returns True.
|
|
"""
|
|
if os.path.isfile(self.file):
|
|
log("Deleting file {}".format(self.file))
|
|
os.remove(self.file)
|
|
return True
|
|
else:
|
|
log("File not found {}".format(self.file))
|
|
return False
|
|
|
|
def shunt(self):
|
|
"""Demote the StreamObject from being stored in memory."""
|
|
if not self.file_exists: # If file doesn't already exist
|
|
self.save_file() # Save stream to disk, if it exists
|
|
self.delete_stream() # Delete the stream from memory
|
|
|
|
def close(self):
|
|
"""Both clear the stream, and delete any associated on-disk data"""
|
|
self.delete_stream()
|
|
if not self.keep_on_disk:
|
|
self.delete_file()
|
|
|
|
|
|
class CameraEvent(object):
|
|
"""An Event-like class that signals all active clients when a new frame is
|
|
available.
|
|
"""
|
|
def __init__(self):
|
|
self.events = {}
|
|
|
|
def wait(self, timeout: int=5):
|
|
"""Invoked from each client's thread to wait for the next frame."""
|
|
ident = get_ident()
|
|
if ident not in self.events:
|
|
# this is a new client
|
|
# add an entry for it in the self.events dict
|
|
# each entry has two elements, a threading.Event() and a timestamp
|
|
self.events[ident] = [threading.Event(), time.time()]
|
|
return self.events[ident][0].wait(timeout)
|
|
|
|
def set(self):
|
|
"""Invoked by the camera thread when a new frame is available."""
|
|
now = time.time()
|
|
remove = None
|
|
for ident, event in self.events.items():
|
|
if not event[0].isSet():
|
|
# if this client's event is not set, then set it
|
|
# also update the last set timestamp to now
|
|
event[0].set()
|
|
event[1] = now
|
|
else:
|
|
# if the client's event is already set, it means the client
|
|
# did not process a previous frame
|
|
# if the event stays set for more than 5 seconds, then assume
|
|
# the client is gone and remove it
|
|
if now - event[1] > 5:
|
|
remove = ident
|
|
if remove:
|
|
del self.events[remove]
|
|
|
|
def clear(self):
|
|
"""Invoked from each client's thread after a frame was processed."""
|
|
self.events[get_ident()][0].clear()
|
|
|
|
|
|
class BaseCamera(object):
|
|
thread = None # Background thread that reads frames from camera
|
|
camera = None # Camera object, for direct access to camera
|
|
|
|
frame = None # Current frame is stored here by background thread
|
|
last_access = 0 # Time of last client access to the camera
|
|
event = CameraEvent()
|
|
|
|
def __init__(self):
|
|
self.state = {} # Create dict for capture state
|
|
self.settings = {} # Create dict to store settings
|
|
|
|
def start_worker(self, timeout: int=5) -> bool:
|
|
"""Start the background camera thread if it isn't running yet."""
|
|
timeout_time = time.time() + timeout
|
|
|
|
self.last_access = time.time()
|
|
self.stop = False
|
|
|
|
if self.thread is None:
|
|
# start background frame thread
|
|
self.thread = threading.Thread(target=self._thread)
|
|
self.thread.start()
|
|
|
|
# wait until frames are available
|
|
log("Waiting for frames")
|
|
while self.get_frame() is None:
|
|
if time.time() > timeout_time:
|
|
raise TimeoutError("Timeout waiting for frames.")
|
|
break
|
|
else:
|
|
time.sleep(0)
|
|
return True
|
|
|
|
def stop_worker(self, timeout: int=5) -> bool:
|
|
"""Flags worker thread for stop. Waits for thread to close, or times out."""
|
|
timeout_time = time.time() + timeout
|
|
|
|
self.stop = True
|
|
while self.thread:
|
|
if time.time() > timeout_time:
|
|
raise TimeoutError("Timeout waiting for worker thread to close.")
|
|
break
|
|
else:
|
|
time.sleep(0)
|
|
return True
|
|
|
|
def get_frame(self):
|
|
"""Return the current camera frame."""
|
|
self.last_access = time.time()
|
|
|
|
# wait for a signal from the camera thread
|
|
self.event.wait()
|
|
self.event.clear()
|
|
|
|
return self.frame
|
|
|
|
def frames(self):
|
|
"""Generator that returns frames from the camera."""
|
|
raise RuntimeError('Must be implemented by subclasses.')
|
|
|
|
def close(self):
|
|
"""Handles closing the StreamingCamera"""
|
|
self.stop_worker()
|
|
|
|
def __enter__(self):
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
"""Close camera stream on context exit."""
|
|
self.close()
|
|
|
|
def _thread(self):
|
|
"""Camera background thread."""
|
|
self.frames_iterator = self.frames()
|
|
|
|
# Update state
|
|
self.state['stream_active'] = True
|
|
|
|
for frame in self.frames_iterator:
|
|
self.frame = frame
|
|
self.event.set() # send signal to clients
|
|
time.sleep(0)
|
|
|
|
# if there hasn't been any clients asking for frames in
|
|
# the last 10 seconds then stop the thread
|
|
if time.time() - self.last_access > 20:
|
|
self.frames_iterator.close()
|
|
break
|
|
|
|
try:
|
|
if self.stop is True:
|
|
self.frames_iterator.close()
|
|
break
|
|
|
|
except AttributeError:
|
|
pass
|
|
|
|
# Reset thread
|
|
self.thread = None
|
|
# Destroy any stored camera object (used especially for handling Pi cameras)
|
|
self.camera = None
|
|
# Update state
|
|
self.state['stream_active'] = False |