Feature: Getters for scenevideo and gazedata urls (#64)

* Add getters for scenevideo and gazedata urls

* Add cSpell words

* Add tests for scenevideo and gazedata url getters

* Add aiohttp requirement

* Add aiohttp dependency in pyproject.toml

* Remove comments

* Improve error handling

* Move InvalidResponseError to g3pylib folder

* Change context encapsulation

Co-authored-by: Markus Wesslén <mw2013@tobii.com>

Author: osode

.vscode/settings.json

@@ -5,24 +5,29 @@
     "python.languageServer": "Pylance",
     "python.sortImports.path": "isort",
     "cSpell.words": [
+        "aiohttp",
         "asyncio",
         "autouse",
         "coro",
         "Docstrings",
         "dotenv",
+        "gazedata",
         "isort",
         "keepalive",
+        "pylib",
         "pyright",
         "pytest",
         "PYTHONDEVMODE",
         "rtsp",
+        "scenecamera",
+        "scenevideo",
         "setuptools",
         "subprotocol",
         "subprotocols",
         "tobii",
         "unsubscription",
         "websockets",
         "zeroconf"
-],
+    ],
     "cSpell.language": "en,sv-SE",
 }

pyproject.toml

@@ -22,7 +22,8 @@ dependencies = [
     "websockets ~= 10.3",
     "zeroconf ~= 0.38.7",
     "aiortsp @ git+https://github.com/m4reko/aiortsp@master",
-    "av ~= 9.2.0"
+    "av ~= 9.2.0",
+    "aiohttp ~= 3.8.1"
 ]
 dynamic = ["version", "description"]
 

requirements.txt

@@ -2,3 +2,4 @@ websockets ~= 10.3
 zeroconf ~= 0.38.7
 aiortsp @ git+https://github.com/m4reko/aiortsp@master
 av ~= 9.2.0
+aiohttp ~= 3.8.1

src/g3pylib/exceptions.py

@@ -0,0 +1,2 @@
+class InvalidResponseError(Exception):
+    """Raised when the server responds with an invalid message."""

src/g3pylib/recordings/recording.py

@@ -1,7 +1,12 @@
+import json
+import logging
 from datetime import datetime, timedelta
 from typing import List, Optional, cast
 
+import aiohttp
+
 from g3pylib._utils import APIComponent, EndpointKind
+from g3pylib.exceptions import InvalidResponseError
 from g3pylib.g3typing import URI
 from g3pylib.websocket import G3WebSocketClientProtocol
 
@@ -12,6 +17,7 @@ def __init__(
     ):
         self._connection = connection
         self._uuid = uuid
+        self.logger: logging.Logger = logging.getLogger(__name__)
         super().__init__(URI(f"{api_base_uri}/{uuid}"))
 
     async def get_created(self) -> datetime:
@@ -159,3 +165,35 @@ async def move(self, folder: str) -> bool:
     def uuid(self) -> str:
         """The uuid of the recording."""
         return self._uuid
+
+    async def get_scenevideo_url(self) -> str:
+        """Returns a URL to the recording's video file."""
+        host_address = self._connection.remote_address[0]
+        data_url = f"http://{host_address}{await self.get_http_path()}"
+        async with aiohttp.ClientSession() as session:
+            async with session.get(data_url) as response:
+                data = json.loads(await response.text())
+        try:
+            scenevideo_file_name = data["scenecamera"]["file"]
+        except KeyError:
+            self.logger.warning(
+                f"Could not retrieve file name for recording from recording data collected from {data_url}."
+            )
+            raise InvalidResponseError
+        return f"{data_url}/{scenevideo_file_name}"
+
+    async def get_gazedata_url(self) -> str:
+        """Returns a URL to the recording's decompressed gaze data file."""
+        host_address = self._connection.remote_address[0]
+        data_url = f"http://{host_address}{await self.get_http_path()}"
+        async with aiohttp.ClientSession() as session:
+            async with session.get(data_url) as response:
+                data = json.loads(await response.text())
+        try:
+            gaze_file_name = data["gaze"]["file"]
+        except KeyError:
+            self.logger.warning(
+                f"Could not retrieve file name for gaze data from recording data collected from {data_url}."
+            )
+            raise InvalidResponseError
+        return f"{data_url}/{gaze_file_name}?use-content-encoding=true"

src/g3pylib/websocket/__init__.py

@@ -14,6 +14,7 @@
 from websockets.typing import Subprotocol
 
 from g3pylib import _utils
+from g3pylib.exceptions import InvalidResponseError
 from g3pylib.g3typing import (
     URI,
     JSONDict,
@@ -23,12 +24,7 @@
     SignalId,
     SubscriptionId,
 )
-from g3pylib.websocket.exceptions import (
-    GlassesError,
-    InvalidResponseError,
-    SubscribeError,
-    UnsubscribeError,
-)
+from g3pylib.websocket.exceptions import GlassesError, SubscribeError, UnsubscribeError
 
 
 def connect(ws_url: str) -> websockets.legacy.client.Connect:

src/g3pylib/websocket/exceptions.py

@@ -6,10 +6,6 @@ class UnsubscribeError(Exception):
     """Raised when unsubscribing to a signal is unsuccessful."""
 
 
-class InvalidResponseError(Exception):
-    """Raised when the server responds with an invalid message."""
-
-
 class GlassesError(Exception):
     """Raised when the glasses responds with an error websocket message."""
 

tests/api_components/test_recording.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 from typing import cast
 
+import aiohttp
 import pytest
 
 from g3pylib import Glasses3
@@ -96,3 +97,17 @@ async def test_meta_data(recording: Recording):
     assert meta_keys == ["RuVersion", "HuSerial", "RuSerial", "key1"]
     non_existing_message = await recording.meta_lookup("key3")
     assert non_existing_message == None
+
+
+async def test_get_scenevideo_url(recording: Recording):
+    url = await recording.get_scenevideo_url()
+    async with aiohttp.ClientSession() as session:
+        async with session.get(url) as response:
+            assert response.status == 200
+
+
+async def test_get_gazedata_url(recording: Recording):
+    url = await recording.get_gazedata_url()
+    async with aiohttp.ClientSession() as session:
+        async with session.get(url) as response:
+            assert response.status == 200