listeners

Author: esdandreu

.gitignore

@@ -1,7 +1,7 @@
 .vscode
-output/
+recordings/
 
-vao-recorder.yaml
+python-recorder.yaml
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

localhost-vao-recorder.py

@@ -16,18 +16,17 @@ typer = {extras = ["all"], version = "^0.4.0"}
 PyInquirer = "^1.0.3"
 PyYAML = "^5.1"
 numpy = "^1.22.2"
-sounddevice = {version = "^0.4.4", optional = true}
+sounddevice = "^0.4.4"
 pyrealsense2 = {version = "^2.50.0", optional = true}
-Flask = {version = "^2.1.1", optional = true}
+Flask = "^2.1.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.1.1"
+yapf = "^0.32.0"
 
 [tool.poetry.extras]
 realsense = ["pyrealsense2"]
-microphone = ["sounddevice"]
-localhost = ["Flask"]
-all = ["pyrealsense2", "sounddevice", "Flask"]
+all = ["pyrealsense2"]
 
 [build-system]
 requires = ["poetry>=0.12"]

pyproject.toml

@@ -1,5 +1,6 @@
 from recorder.config import DEFAULT_CONFIG_PATH, DEFAULT_OUTPUT_FOLDER
 from recorder.device import Device, DEVICE_CLASSES
+from recorder.listener import Listener, LISTENER_CLASSES
 from recorder.io import yaml_dump
 from recorder import Recorder, Config
 
@@ -25,7 +26,6 @@
     DEFAULT_CONFIG_PATH,
     help="Path to a `yaml` config file. Run `config` command to generate one."
     )
-
 DEVICE_CLASS_ARGUMENT = typer.Argument(
     None,
     metavar='DEVICE_CLASS',
@@ -41,6 +41,14 @@
         "Numerical id of the device to use. Use the show command to see the available devices for each device class."
         )
     )
+LISTENER_CLASS_ARGUMENT = typer.Argument(
+    'localhost',
+    metavar='LISTENER_CLASS',
+    help=(
+        "Case independent name of the listener class to use. Available "
+        f"options: {[d for d in DEVICE_CLASSES.keys()]}."
+        )
+    )
 VERBOSE_OPTION = typer.Option(False, "--verbose", "-v", help="Verbose output.")
 
 
@@ -58,7 +66,7 @@ def choose(message: str, choices: list):
         })['choice']
 
 
-def get_device_class(name: str):
+def get_device_class(name: str) -> Device:
     try:
         return DEVICE_CLASSES[name.lower()]
     except KeyError:
@@ -68,6 +76,16 @@ def get_device_class(name: str):
             )
 
 
+def get_listener_class(name: str) -> Listener:
+    try:
+        return LISTENER_CLASSES[name.lower()]
+    except KeyError:
+        raise RuntimeError(
+            f"Invalid listener class `{name}`. Available options: "
+            f"{list(LISTENER_CLASSES.keys())}"
+            )
+
+
 @app.command(help="Display the available devices")
 def show(
         device_class: Optional[str] = DEVICE_CLASS_ARGUMENT,
@@ -138,6 +156,7 @@ def record(
     seconds: int = typer.Argument(None, help="Number of seconds to record"),
     config_path: Optional[Path] = DEFAULT_CONFIG_PATH_OPTION,
     output_folder: Optional[Path] = DEFAULT_OUTPUT_FOLDER_OPTION,
+    # TODO pass kwargs to listener. Or make subcommands for each listener
     ):
     config = get_config(config_path)
     recorder = Recorder(config, output_folder)
@@ -146,6 +165,18 @@ def record(
         typer.echo(f"Recording finished, data saved to {output_folder}")
 
 
+@app.command(help='Listen to an external command to start recording')
+def listen(
+    listener_class: str = LISTENER_CLASS_ARGUMENT,
+    config_path: Optional[Path] = DEFAULT_CONFIG_PATH_OPTION,
+    output_folder: Optional[Path] = DEFAULT_OUTPUT_FOLDER_OPTION,
+    ):
+    config = get_config(config_path)
+    recorder = Recorder(config, output_folder)
+    listener = get_listener_class(listener_class)(recorder)
+    listener.listen()
+
+
 @app.command(help="Test device recording")
 def test(
     device_class: Optional[str] = DEVICE_CLASS_ARGUMENT,
@@ -184,9 +215,6 @@ def test(
         recorder = Recorder(config, output_folder)
         output_folder = recorder(seconds=5)
 
-@app.command(help='Listen to an external command to start recording')
-def listen(to: str):
-    raise NotImplementedError(f"Listen to {to} is not implemented.")
 
 def main():
     # Launch the command line application

recorder/__main__.py

@@ -1 +1,10 @@
-LISTENER_CLASSES = []
+from .listener import Listener
+
+try:
+    from .localhost import Localhost
+except ImportError as e:
+    class Localhost:
+        def __init__(self, *args, **kwargs) -> None:
+            raise e
+
+LISTENER_CLASSES = {repr(cls): cls for cls in Listener.__subclasses__()}

recorder/listener/__init__.py

@@ -0,0 +1,20 @@
+from recorder import Recorder
+from abc import ABC, ABCMeta, abstractmethod
+
+
+class MetaListener(ABCMeta):
+
+    def __str__(cls) -> str:
+        return cls.__name__
+
+    def __repr__(cls) -> str:
+        return cls.__name__.lower()
+
+class Listener(ABC, metaclass=MetaListener):
+
+    def __init__(self, recorder: Recorder) -> None:
+        self.recorder = recorder
+
+    @abstractmethod
+    def listen(self) -> None:
+        pass

recorder/listener/listener.py

@@ -0,0 +1,56 @@
+from recorder.listener import Listener
+
+import socket
+
+from flask import Flask, request, Response
+
+# Troubleshooting:
+# https://stackoverflow.com/questions/62705271/connect-to-flask-server-from-other-devices-on-same-network
+
+
+class EndpointAction(object):
+
+    def __init__(self, action):
+        self.action = action
+
+    def __call__(self, *args):
+        # Perform the action
+        answer = self.action()
+        # Create the answer (bundle it in a correctly formatted HTTP answer)
+        self.response = Response(answer, status=200, headers={})
+        # Send it
+        return self.response
+
+
+class Localhost(Listener):
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self.app = Flask('python-recorder')
+        self.app.add_url_rule(
+            '/setup', '/setup', EndpointAction(self.setup), methods=['GET']
+            )
+        self.app.add_url_rule(
+            '/start', '/start', EndpointAction(self.start), methods=['GET']
+            )
+        self.app.add_url_rule(
+            '/stop', '/stop', EndpointAction(self.stop), methods=['GET']
+            )
+
+    def setup(self):
+        name = request.args.get('name', None)
+        self.recorder.setup(name=name)
+        return str(self.recorder.next_output.name)
+
+    def start(self):
+        self.recorder.start()
+        return 'Recording started'
+
+    def stop(self):
+        return str(self.recorder.stop().name)
+
+    def listen(self):
+        s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        s.connect(("8.8.8.8", 80))
+        host = s.getsockname()[0]
+        self.app.run(debug=True, host=host)