Add frame by frame compression and test this compression - Nikita Ostapenko #30

catmajor · 2025-06-10T15:27:56Z

Create basic CLI client for ARFlow in python
Provide a variety of APIs, some of which closely resemble those found in the Unity Client to provide functions for clients

-Some nuances are not in this version such as the logger middleware/advanced http options

-I am not sure about what model is so I am leaving it as the concatenation of the operating system name and its version -Type needs to be changed later to be assigned propertly, for now only uses 3 as this is for the cli which only runs on desktops

-Currently unable to gather data (coming soon) -Will not leave sessions (will be implemented with data gathering)

…llow CamelCase from the original GrpcClient.cs

-Currently only able to collect color frames

YiqinZhao

Some changes are needed. Overall, you did great! I made some changes on code styling, documentations, and formatting.

YiqinZhao · 2025-06-11T22:57:27Z

python/client/GrpcClient.py

@@ -0,0 +1,76 @@
+import grpc


We should always add a leading docstring for Python scripts.

Please check https://github.com/catmajor/ARFlow/pull/1/files for some changes I made to this file. Overall, you did great. I made some changes on code styling, documentations, and formatting.

YiqinZhao · 2025-06-11T23:06:13Z

python/client/GrpcClient.py

+class GrpcClient:
+    def __init__(self, url):
+        self.channel = grpc.insecure_channel(url)
+    async def create_session_async(self, name: str, device: Device, save_path: str = "") -> CreateSessionResponse:


Change return type in the function definition to Awaitable[CreateSessionResponse].

YiqinZhao · 2025-06-11T23:06:29Z

python/client/GrpcClient.py

+            session_metadata=SessionMetadata(name=name, save_path=save_path),
+            device=device
+        )
+        response: Awaitable[CreateSessionResponse] = ARFlowServiceStub(self.channel).CreateSession(request)


ARFlowServiceStub can be reused?

YiqinZhao · 2025-06-11T23:06:53Z

python/client/GrpcClient.py

+        )
+        response: Awaitable[CreateSessionResponse] = ARFlowServiceStub(self.channel).CreateSession(request)
+        return response
+    async def delete_session_async(self, session_id: str) -> DeleteSessionResponse:


Need an empty line between L35 and L34.

YiqinZhao · 2025-06-11T23:07:47Z

python/client/clients/cli.py

@@ -0,0 +1,136 @@
+
+
+from GrpcClient import GrpcClient


Please follow my changes in https://github.com/catmajor/ARFlow/pull/1/files to update this and other files as well.

new: code style and docstring improvements.

merge individual frame work and tests into my main branch

catmajor · 2025-07-10T04:35:49Z

Frame by Frame compression

We discussed adding frame by frame compression to ARFlow as H264 compression creates a challenge in integrating chunked and compressed byte processing into existing one frame one display results. Here they are. I have incorporated a decently modified version of one of Vedant Saran's tests.

I have left in print statements despite ruff's complaints as they are not used for debugging, but rather in the application itself to display messages and UIs.

Overall Results

Uncompressed frames were by far the worst, in HD the FPS cannot even get above 5. The method requires lots of processing power and bandwidth.

PNG frames were slightly better, the HD version nearly doubled the FPS to 7, but the overall effect compared to the original H264 compression is also quite bad. However, unlike the raw frames, this method is actually bottlenecked by the processing power required to compress individual images into PNG format. This is visible through the difference between memory use between the SD and HD versions where the amount of memory actually went down due to the main bottleneck being created by compression speed rather than bandwidth use.

JPG saw the closest results to the extreme efficiency seen with H264 compression. There was a ~90% reduction in bandwidth and the frame rate actually stayed near 30 FPS for both SD and HD tests. It is important to note that JPG compression still requires heavy CPU use and for the HD version this occupied nearly 40% of my total cpu's output.

YiqinZhao

Please see the comments for some minor formatting issues.

YiqinZhao · 2025-07-10T17:59:34Z

python/client/clients/cli.py

+
+    async def __manage_sessions(self):
+        while True:
+            print("Available Sessions:")


This Ruff (T201) error needs to be addressed. Try adding either # ruff: noqa: T201 to the top of the file or using the following statements to disable the error messages on a code block:

# ruff: noqa: T201 print("This is allowed") # Ruff will ignore T201 here print("This is also allowed") # ruff: enable

YiqinZhao · 2025-07-10T18:00:01Z

python/client/GrpcClient.py

+        return response
+
+    def close(self):
+        """Close the channel."""


Address this Ruff error.

cleanup small ruff formatting issue

YiqinZhao

LGTM

catmajor added 9 commits June 6, 2025 15:59

Update sample demo code to work with ARFlow v0.4

e2ab122

Rewrote the basic functionality of the C# GrpcClient Class

c00afdd

-Some nuances are not in this version such as the logger middleware/advanced http options

Add basic CLI client

cd14cba

-Currently unable to gather data (coming soon) -Will not leave sessions (will be implemented with data gathering)

Update Grpc client to use snake_case as it was formatted before to fo…

59020e6

…llow CamelCase from the original GrpcClient.cs

Forgot to add the leave_session function to this file

4657e4a

Create basic CLI client

6cec12e

-Currently only able to collect color frames

fix formatting on some of the inputs

4262e0a

fix leaving the session while recording running not ending recording

e8ed83a

YiqinZhao self-requested a review June 11, 2025 22:39

new: code style and docstring improvements.

f9c6bc9

YiqinZhao reviewed Jun 11, 2025

View reviewed changes

catmajor and others added 11 commits June 16, 2025 17:38

Merge pull request #1 from cake-lab/pr/catmajor/30

cd67515

new: code style and docstring improvements.

Merge branch 'main' of https://github.com/catmajor/ARFlow

1b817a3

Add the rgb support from the other branch

1f7135e

add jpg/png support clientside

d3b518e

Update protobuffers to have available enum fields

629f7a1

add support for png/jpg image transfer capability

b9eb139

add vedant saran's test and modify it to test for frame-by-frame

2aa0050

fix ruff's checks

2637016

readd the correctly commented grpcclient code

ee35455

Merge branch 'main' into individual-frame

fb480f0

merge individual frame work and tests into my main branch

11fc6c8

merge individual frame work and tests into my main branch

catmajor changed the title ~~Add ARFlow python client APIs and basic CLI client~~ Add frame by frame compression and test this compression - Nikita Ostapenko Jul 10, 2025

catmajor marked this pull request as ready for review July 10, 2025 04:36

YiqinZhao requested changes Jul 10, 2025

View reviewed changes

catmajor added 2 commits July 10, 2025 20:44

Merge branch 'main' of https://github.com/catmajor/ARFlow

93d3b90

Finish up frame by frame compression

510f478

cleanup small ruff formatting issue

YiqinZhao approved these changes Jul 11, 2025

View reviewed changes

YiqinZhao merged commit 6133c27 into cake-lab:main Jul 11, 2025
1 check passed

Add frame by frame compression and test this compression - Nikita Ostapenko #30

Add frame by frame compression and test this compression - Nikita Ostapenko #30

Uh oh!

Conversation

catmajor commented Jun 10, 2025

Uh oh!

YiqinZhao left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

catmajor commented Jul 10, 2025

Frame by Frame compression

Overall Results

Uh oh!

YiqinZhao left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

YiqinZhao left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants