Python SDK: Add Stream Feature Abstraction (#752)

Author: tcamise-gpsw

demos/python/sdk_wireless_camera_control/docs/api.rst

@@ -76,14 +76,17 @@ These should not be imported directly and instead should be accessed using the r
 Abstracted Features
 -------------------
 
-.. automodule:: open_gopro.features.cohn_feature
+.. autoclass:: open_gopro.features.CohnFeature
 
-.. automodule:: open_gopro.features.access_point_feature
+.. autoclass:: open_gopro.features.AccessPointFeature
+
+.. autoclass:: open_gopro.features.StreamFeature
 
 Base Types
 ----------
 
-.. automodule:: open_gopro.domain.types
+.. automodule:: open_gopro.models.types
+   :undoc-members:
 
 GoPro Enum
 ^^^^^^^^^^
@@ -183,36 +186,14 @@ These are the various models that are returned in responses, used in commands, e
 
    from open_gopro import models
 
-.. autopydantic_model:: open_gopro.models.media_list.MediaPath
-
-.. autopydantic_model:: open_gopro.models.media_list.MediaMetadata
-
-.. autopydantic_model:: open_gopro.models.media_list.PhotoMetadata
-   :show-inheritance:
-
-.. autopydantic_model:: open_gopro.models.media_list.VideoMetadata
-   :show-inheritance:
-
-.. autopydantic_model:: open_gopro.models.media_list.MediaItem
-
-.. autopydantic_model:: open_gopro.models.media_list.GroupedMediaItem
-   :show-inheritance:
-
-.. autopydantic_model:: open_gopro.models.media_list.MediaFileSystem
-
-.. autopydantic_model:: open_gopro.models.media_list.MediaList
-
-.. autopydantic_model:: open_gopro.models.general.TzDstDateTime
-
-.. autopydantic_model:: open_gopro.models.general.CameraInfo
-
-.. autopydantic_model:: open_gopro.models.general.WebcamResponse
-
-.. autopydantic_model:: open_gopro.models.general.SupportedOption
+.. automodule:: open_gopro.models.media_list
+   :undoc-members:
 
-.. autopydantic_model:: open_gopro.models.general.CohnInfo
+.. automodule:: open_gopro.models.streaming
+   :undoc-members:
 
-.. autoclass:: open_gopro.models.general.ScheduledCapture
+.. automodule:: open_gopro.models.general
+   :undoc-members:
 
 Constants
 =========

demos/python/sdk_wireless_camera_control/docs/conf.py

@@ -85,13 +85,14 @@ def is_on(self) -> bool:
 nitpicky = True
 
 TYPE_ALIASES = {
-    "CameraState": "open_gopro.domain.types.CameraState",
-    "UpdateCb": "open_gopro.domain.types.UpdateCb",
-    "UpdateType": "open_gopro.domain.types.UpdateType",
+    "CameraState": "open_gopro.models.types.CameraState",
+    "UpdateCb": "open_gopro.models.types.UpdateCb",
+    "UpdateType": "open_gopro.models.types.UpdateType",
     "JsonDict": "open_gopro.JsonDict",
-    "ResponseType": "open_gopro.domain.types.ResponseType",
-    "Protobuf": "open_gopro.domain.types.Protobuf",
-    "IdType": "open_gopro.domain.types.IdType",
+    "ResponseType": "open_gopro.models.types.ResponseType",
+    "Protobuf": "open_gopro.models.types.Protobuf",
+    "IdType": "open_gopro.models.types.IdType",
+    "StreamOptions": "open_gopro.models.types.StreamOptions",
     "SyncAction": "open_gopro.observable.SyncAction",
     "AsyncAction": "open_gopro.observable.AsyncAction",
     "SyncFilter": "open_gopro.observable.SyncFilter",

demos/python/sdk_wireless_camera_control/open_gopro/api/ble_commands.py

@@ -40,7 +40,6 @@
 )
 from open_gopro.domain.gopro_observable import GoProObservable
 from open_gopro.domain.parser_interface import GlobalParsers, Parser
-from open_gopro.domain.types import CameraState
 from open_gopro.models import CameraInfo, GoProResp, TzDstDateTime, constants, proto
 from open_gopro.models.constants import (
     ActionId,
@@ -50,6 +49,7 @@
     SettingId,
     StatusId,
 )
+from open_gopro.models.types import CameraState
 from open_gopro.parsers.bytes import (
     ConstructByteParserBuilder,
     DateTimeByteParserBuilder,

demos/python/sdk_wireless_camera_control/open_gopro/api/builders.py

@@ -34,7 +34,6 @@
     GlobalParsers,
     Parser,
 )
-from open_gopro.domain.types import CameraState, JsonDict, Protobuf
 from open_gopro.models import GoProResp
 from open_gopro.models.constants import (
     ActionId,
@@ -45,6 +44,7 @@
     SettingId,
     StatusId,
 )
+from open_gopro.models.types import CameraState, JsonDict, Protobuf
 from open_gopro.network.ble import BleUUID
 from open_gopro.parsers.bytes import (
     ConstructByteParserBuilder,

demos/python/sdk_wireless_camera_control/open_gopro/api/http_commands.py

@@ -22,17 +22,18 @@
     MessageRules,
 )
 from open_gopro.domain.parser_interface import Parser
-from open_gopro.domain.types import CameraState, JsonDict
 from open_gopro.models import (
     CameraInfo,
     GoProResp,
     MediaList,
     MediaMetadata,
     MediaPath,
-    WebcamResponse,
     constants,
     proto,
+    streaming,
 )
+from open_gopro.models.streaming import WebcamResponse
+from open_gopro.models.types import CameraState, JsonDict
 from open_gopro.parsers.json import (
     CameraStateJsonParser,
     LambdaJsonParser,
@@ -424,18 +425,18 @@ async def webcam_preview(self) -> GoProResp[WebcamResponse]:
     async def webcam_start(
         self,
         *,
-        resolution: constants.WebcamResolution | None = None,
-        fov: constants.WebcamFOV | None = None,
+        resolution: streaming.WebcamResolution | None = None,
+        fov: streaming.WebcamFOV | None = None,
         port: int | None = None,
-        protocol: constants.WebcamProtocol | None = None,
+        protocol: streaming.WebcamProtocol | None = None,
     ) -> GoProResp[WebcamResponse]:
         """Start the webcam.
 
         Args:
-            resolution (constants.WebcamResolution | None): resolution to use. If not set, camera default will be used.
-            fov (constants.WebcamFOV | None): field of view to use. If not set, camera default will be used.
+            resolution (streaming.WebcamResolution | None): resolution to use. If not set, camera default will be used.
+            fov (streaming.WebcamFOV | None): field of view to use. If not set, camera default will be used.
             port (int | None): port to use for streaming. If not set, camera default of 8554 will be used.
-            protocol (constants.WebcamProtocol | None): streaming protocol to use. If not set, camera default of TS will
+            protocol (streaming.WebcamProtocol | None): streaming protocol to use. If not set, camera default of TS will
                 be used.
 
         Returns:

demos/python/sdk_wireless_camera_control/open_gopro/demos/gui/livestream.py

@@ -5,12 +5,11 @@
 
 import argparse
 import asyncio
-from typing import Any
 
 from rich.console import Console
 
 from open_gopro import WirelessGoPro
-from open_gopro.models import constants, proto
+from open_gopro.models import proto, streaming
 from open_gopro.util import add_cli_args_and_parse, ainput
 from open_gopro.util.logger import setup_logging
 
@@ -20,48 +19,36 @@
 async def main(args: argparse.Namespace) -> None:
     setup_logging(__name__, args.log)
 
-    async with WirelessGoPro(args.identifier, enable_wifi=False) as gopro:
-        await gopro.ble_command.set_shutter(shutter=constants.Toggle.DISABLE)
-        await gopro.ble_command.register_livestream_status(
-            register=[proto.EnumRegisterLiveStreamStatus.REGISTER_LIVE_STREAM_STATUS_STATUS]
-        )
-
+    async with WirelessGoPro(
+        args.identifier,
+        enable_wifi=False,
+        interfaces={WirelessGoPro.Interface.BLE},
+    ) as gopro:
         console.print(f"[yellow]Connecting to {args.ssid}...")
         await gopro.access_point.connect(args.ssid, args.password)
 
-        # Start livestream
-        livestream_is_ready = asyncio.Event()
-
-        async def wait_for_livestream_start(_: Any, update: proto.NotifyLiveStreamStatus) -> None:
-            if update.live_stream_status == proto.EnumLiveStreamStatus.LIVE_STREAM_STATE_READY:
-                livestream_is_ready.set()
-
-        console.print("[yellow]Configuring livestream...")
-        gopro.register_update(wait_for_livestream_start, constants.ActionId.LIVESTREAM_STATUS_NOTIF)
-        await gopro.ble_command.set_livestream_mode(
-            url=args.url,
-            window_size=args.resolution,
-            minimum_bitrate=args.min_bit,
-            maximum_bitrate=args.max_bit,
-            starting_bitrate=args.start_bit,
-            encode=args.encode,
-            lens=args.fov,
+        console.print(f"[yellow]Starting livestream to {args.url}...")
+        await gopro.streaming.start_stream(
+            streaming.StreamType.LIVE,
+            streaming.LivestreamOptions(
+                url=args.url,
+                minimum_bitrate=args.min_bit,
+                maximum_bitrate=args.max_bit,
+                starting_bitrate=args.start_bit,
+                resolution=args.resolution if args.resolution else None,
+                fov=args.fov if args.fov else None,
+                encode=args.encode,
+            ),
+        )
+        assert gopro.streaming.url
+        console.print(
+            f"[yellow]Livestream to {gopro.streaming.url} is now streaming and should be available for viewing at."
         )
-
-        # Wait to receive livestream started status
-        console.print("[yellow]Waiting for livestream to be ready...\n")
-        await livestream_is_ready.wait()
-
-        # TODO Is this still needed?
-        await asyncio.sleep(2)
-
-        console.print("[yellow]Starting livestream")
-        assert (await gopro.ble_command.set_shutter(shutter=constants.Toggle.ENABLE)).ok
-
-        console.print("[yellow]Livestream is now streaming and should be available for viewing.")
         await ainput("Press enter to stop livestreaming...\n")
 
-        await gopro.ble_command.set_shutter(shutter=constants.Toggle.DISABLE)
+        await gopro.streaming.stop_active_stream()
+
+        # TODO merge this into access point feature
         await gopro.ble_command.release_network()
 
 

demos/python/sdk_wireless_camera_control/open_gopro/demos/gui/preview_stream.py

@@ -9,8 +9,8 @@
 from rich.console import Console
 
 from open_gopro import WirelessGoPro
-from open_gopro.demos.gui.util import display_video_blocking
-from open_gopro.models import constants
+from open_gopro.demos.gui.video_display import BufferlessVideoCapture
+from open_gopro.models import streaming
 from open_gopro.util import add_cli_args_and_parse
 from open_gopro.util.logger import setup_logging
 
@@ -21,14 +21,22 @@ async def main(args: argparse.Namespace) -> None:
     setup_logging(__name__, args.log)
 
     async with WirelessGoPro(args.identifier) as gopro:
-        await gopro.http_command.set_preview_stream(mode=constants.Toggle.DISABLE)
-        await gopro.ble_command.set_shutter(shutter=constants.Toggle.DISABLE)
-        assert (await gopro.http_command.set_preview_stream(mode=constants.Toggle.ENABLE, port=args.port)).ok
+        console.print("Starting preview stream...")
+        await gopro.streaming.start_stream(
+            streaming.StreamType.PREVIEW,
+            streaming.PreviewStreamOptions(port=args.port),
+        )
 
         console.print("Displaying the preview stream...")
-        display_video_blocking(f"udp://127.0.0.1:{args.port}", printer=console.print)
-
-        await gopro.http_command.set_preview_stream(mode=constants.Toggle.DISABLE)
+        assert gopro.streaming.url
+        BufferlessVideoCapture(
+            source=gopro.streaming.url,
+            protocol=BufferlessVideoCapture.Protocol.TS,
+            printer=console.print,
+        ).display_blocking()
+
+        console.print("Stopping preview stream...")
+        await gopro.streaming.stop_active_stream()
 
 
 def parse_arguments() -> argparse.Namespace: