Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp broadcast IPC #565

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open

Revamp broadcast IPC #565

wants to merge 27 commits into from

Conversation

ladvoc
Copy link
Contributor

@ladvoc ladvoc commented Jan 29, 2025

This PR revamps inter-process communication between the main app and the broadcast extension, replacing deprecated Core Foundation APIs. Additionally, it enhances testability, enables bi-directional communication, and introduces a more flexible message structure.

Summary of new types:

  • IPCChannel: An abstraction for inter-process communication, built on top of the Network framework. Allows asynchronous sending and receiving of messages consisting of a dynamic header (any type conforming to Codable) and a data payload.
  • BroadcastImageCodec: Encapsulates functionality for encoding/decoding image samples for transport. For now, this uses the same method of JPEG encoding/decoding as the current implementation.
  • BroadcastUploader: Sends samples from ReplayKit to the main app, built on top of IPCChannel.
  • BroadcastReceiver: Receives samples from the broadcast extension, built on top of IPCChannel.

This PR sets the groundwork for adding support for audio samples, but I decided to submit that in a separate PR as this is a large change (though not breaking).

ladvoc added 18 commits January 24, 2025 09:21
- Rename `SocketConnectionFrameReader` to `SocketConnectionSampleReader`.
- Utilize the new `HTTPMessageReader` and `BroadcastSampleDecoder` types.
- Replaces the functionality of the existing `Message` class.
- `didCapture` now emits a `BroadcastSample`.
- General refactoring for enhanced readability.
- Uses the Network framework
- Enables bi-directional communication and dynamic message headers
- Create `BroadcastUploader` and `BroadcastReceiver` utilizing `IPCChannel`
- Separates concerns of socket communication, message format, and sample encoding/decoding
- Integrate into existing code
- Remove old components
@ladvoc ladvoc marked this pull request as draft January 29, 2025 01:13
Ensure proper handling of channel closure initiated either by the capture ending or the broadcast ending.
- Fix socket tests for iOS by using relative paths
@ladvoc ladvoc marked this pull request as ready for review February 3, 2025 18:07
Copy link
Contributor

@bcherry bcherry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks pretty good, no comments on it from a first pass read-through. i'm going to come back once the other PR lands and you merge it in here and I will test it and then leave more comments if needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants