flask app done

Author: esdandreu

README.md

@@ -6,7 +6,8 @@ camera, RODE VideoMicNTG and smartLav+ microphones
 # Setup
 
 Clone this repository to your local machine. Detailed instructions about
-cloning repositories and installing python dependencies can be found [here](https://docs.google.com/document/d/15Mj3x9Im7Yfz3sPo5f4dUjQZgabjVtIL2RBHvM2798E/edit?usp=sharing).
+cloning repositories and installing python dependencies can be found
+[here](https://docs.google.com/document/d/15Mj3x9Im7Yfz3sPo5f4dUjQZgabjVtIL2RBHvM2798E/edit?usp=sharing).
 
 ## Install Python (3.5 - 3.9)
 Do not install the latest version of Python (currently 3.10) as it is not
@@ -55,10 +56,10 @@ python vao-recorder.py config
 
 Test that the chosen audio devices are working
 ```
-python vao-recorder.py test-microphones
+python vao-recorder.py test microphone
 ```
 
-Record an experiment with the chosen devices
+Record an experiment with the configured devices
 ```
 python vao-recorder.py record
 ```

localhost-vao-recorder.py

@@ -0,0 +1,40 @@
+from recorder import Recorder, Config
+from recorder.io import yaml_dump
+
+import socket
+
+from flask import Flask
+
+app = Flask(__name__)
+
+app.secret_key = __name__
+
+# ! Workaround: Global variable because it is not JSON serializable and can't
+# ! be stored in Flask.session.
+recorder = Recorder(Config.from_yaml(), setup_name=False)
+print(yaml_dump(recorder.config))
+
+
+@app.route('/setup', methods=['GET'])
+def setup():
+    # TODO get recording name from request
+    recorder.setup()
+    return str(recorder.next_output.name)
+
+
+@app.route('/start', methods=['GET'])
+def start():
+    recorder.start()
+    return 'Recording started'
+
+
+@app.route('/stop', methods=['GET'])
+def stop():
+    return str(recorder.stop().name)
+
+
+if __name__ == "__main__":
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.connect(("8.8.8.8", 80))
+    host = s.getsockname()[0]
+    app.run(debug=True, host=host)

recorder/recorder.py

@@ -8,32 +8,63 @@
 
 
 class Recorder:
+    next_output = None
+    devices = []
 
     def __init__(
         self,
         config: Config,
         output_folder: Optional[Path] = DEFAULT_OUTPUT_FOLDER,
-        name: Optional[str] = None,
+        setup_name: Optional[str] = None,
         ):
+        """Recorder object, used to record data from configured devices.
+
+        Args:
+            config (Config): Configuration dictionary.
+
+            output_folder (Optional[Path]): Root folder for the recorded
+                output. For each recording session, a subfolder will be created
+                based on the `setup_name` provided. Defaults to
+                DEFAULT_OUTPUT_FOLDER.
+            setup_name (Optional[str]): The recorded output will be placed in a
+                subfolder of `output_folder` with the provided name. If not
+                provided, it will default to a name based on the current date
+                and time. If `False` is provided instead, the recorder will not
+                be fully initialized and an additionall call to `setup` will be
+                required.
+        """
         self.config = config
         # Initialize the output folder
-        output_folder.mkdir(parents=True, exist_ok=True)
+        self.output_folder = output_folder
+        self.output_folder.mkdir(parents=True, exist_ok=True)
+        if setup_name is not False:
+            self.setup(setup_name)
+    
+    def setup(self, name: Optional[str] = None):
+        # Initialize next recording output
         if not name:
             name = datetime.now().strftime('date_%Y-%m-%d;time_%H-%M-%S')
-        self.output_folder = output_folder / name
-        self.output_folder.mkdir(exist_ok=False)
+        self.next_output = self.output_folder / name
+        self.next_output.mkdir(exist_ok=False)
         # Initialize all devices
-        self.devices = self.config.devices(self.output_folder)
+        self.devices = self.config.devices(self.next_output)
 
     def start(self):
-        # Start the recording
+        # Start the recording. Does nothing if the recording is not setup.
         for d in self.devices:
             d.start()
 
-    def stop(self):
+    def stop(self) -> Path:
         # Stop the recording
         for d in self.devices:
             d.stop()
+        # Cleanup devices, setup must be called to start recording again
+        self.devices = []
+        if not self.next_output:
+            raise RuntimeError('Recording not setup')
+        output = Path(str(self.next_output))
+        self.next_output = None
+        return output
 
     def wait(self, seconds: Optional[int] = None):
         # Wait for user input
@@ -47,7 +78,4 @@ def wait(self, seconds: Optional[int] = None):
     def __call__(self, seconds: Optional[int] = None) -> Path:
         self.start()
         self.wait(seconds=seconds)
-        self.stop()
-        # Cleanup devices, a new instance of the recorder must be called
-        del self.devices
-        return self.output_folder
+        return self.stop()