An open API service indexing awesome lists of open source software.

https://github.com/chenyuhao0628/displayweave

Turn iPhone, iPad, and Android into a second display for macOS / 将 iPhone、iPad 和 Android 变成 Mac 第二屏。Open source, local-first, HEVC, experimental high refresh.
https://github.com/chenyuhao0628/displayweave

120hz android external-display h264 hevc ios ipad iphone macos mediacodec open-source screen-streaming screencapturekit second-screen videotoolbox virtual-display

Last synced: 8 days ago
JSON representation

Turn iPhone, iPad, and Android into a second display for macOS / 将 iPhone、iPad 和 Android 变成 Mac 第二屏。Open source, local-first, HEVC, experimental high refresh.

Awesome Lists containing this project

README

          

[English](README.md) | [简体中文](README.zh-CN.md)

# DisplayWeave

**One Mac. A woven field of useful screens.**

DisplayWeave is an independently maintained, GPL-3.0, local-first second-display project derived from [OpenDisplay](https://github.com/peetzweg/opendisplay). It turns iPhone, iPad, and Android devices into extended or mirrored displays for a Mac.

## Current capabilities

- Apple receivers: USB through `usbmuxd` and local WiFi, using the H.264 path.
- Android receiver: local WiFi or per-device dynamic `adb forward` USB, HEVC/H.265 with H.264 fallback, and 30/60/90/120fps negotiation.
- Transport selector: Auto, USB, or WiFi. Auto prefers wired USB, performs bounded recovery, falls back only to WiFi with the same install ID, and upgrades back to USB when the cable returns.
- Input: tap, drag, cursor, and two-finger scrolling return to macOS.
- Recovery: receiver foreground/surface return, cable unplug/replug, ADB restart, and authorization revoke/reallow were verified on the available OnePlus Android device.
- Mixed receivers: one current DisplayWeave iPhone over WiFi and one Android receiver ran concurrently.
- Runtime evidence: capture, encode, send, receive, decode, render, queue, drop, and latency metrics.
- Performance controls: Auto/Manual/experimental Benchmark bitrate, bounded adaptive changes, quality-aware send queues, and transport-aware keyframe intervals.

Android high refresh remains experimental. One OnePlus HEVC/120 WiFi run measured about 109–111 rendered FPS; this does not guarantee stable 120 FPS on other devices or conditions.

The physical-device recovery and high-refresh observations below were recorded
during Preview 2 validation and remain prior evidence; they were not rerun on a
second Android device for this release.

## Download `v0.2.1-p3`

[GitHub Release](https://github.com/chenyuhao0628/displayweave/releases/tag/v0.2.1-p3)

| Platform | Asset | Distribution boundary |
| --- | --- | --- |
| macOS | `DisplayWeave-macOS.dmg` | Recommended guided first-install package; ad-hoc signed and not notarized |
| macOS update | `DisplayWeave-macOS.zip` | Sparkle update payload and equivalent manual install option |
| Android | `DisplayWeave-Android.apk` | Offline v2-signed APK; future in-app downloads are verified before system confirmation |
| iOS/iPadOS | `DisplayWeave-Preview-0.1-iOS-unsigned-resigning-input.ipa` | Unsigned re-signing input; cannot be installed directly |
| Mac feed | `appcast.xml` | Sparkle feed authenticated by the public key embedded in the Mac app |
| Android feed | `android-update.json` | HTTPS metadata with size, hash, version, package, and pinned certificate |
| Verification | `SHA256SUMS.txt` | SHA-256 for all Release files |

This is a development preview, not a production-signed store release. Verify the checksum before use. Android users should also compare the certificate fingerprint in the [release checklist](docs/release-checklist.md).

The guided Mac packaging flow produces `DisplayWeave-macOS.dmg` beside the ZIP.
The DMG is the recommended first-install package: drag
DisplayWeave into Applications and follow the first-run guidance shown in its
background. The ZIP remains the Sparkle update payload and an equivalent manual
install option. Both containers hold the same `DisplayWeave.app`, so either
installation receives later Sparkle updates after the app is in `/Applications`.

The refreshed Mac build uses a DisplayWeave-owned application identity. Settings migrate from the legacy OpenDisplay/OpenSidecar preference domains, but macOS will require Screen Recording, Accessibility, and Local Network permission to be granted again after the upgrade.

### One-time migration and later updates

- **Mac:** manually replace the old app with this build in `/Applications`.
Gatekeeper may require Control-click → **Open** or Privacy & Security →
**Open Anyway**. Do not enable **Anywhere** globally. Later releases are
checked and verified through Sparkle, but the app remains ad-hoc signed and
not notarized.
- **Android:** install this APK over the existing package once. The receiver
then checks at most daily, with a manual check in **Settings & Help**.
Downloads are verified by size, SHA-256, package, version, minimum SDK, and
the pinned signing certificate before Android shows its system installer.
- **iOS/iPadOS:** the unsigned re-signing input and existing OpenDisplay
receiver protocol are unchanged by the Mac/Android update channel.

See [automatic updates](docs/automatic-updates.md) for migration and recovery.

## Android USB quick start

1. Enable Developer options and USB debugging on the Android device.
2. Connect a data-capable cable, open DisplayWeave Receiver, and allow the Mac's RSA debugging identity.
3. Open DisplayWeave on the Mac and choose **Auto** (recommended) or **USB**.
4. Auto uses only a true wired `usb:` ADB device. Wireless-debugging endpoints never create a USB session.
5. If the cable is removed, Auto completes protocol grace and bounded recovery before falling back to the same app installation over WiFi. USB mode does not silently fall back.

ADB authorization grants the Mac broad debugging access, not only DisplayWeave access. Revoke it in Android Developer options when it is no longer needed.

## Build from source

Apple targets:

```bash
./generate.sh
xcodebuild -project OpenSidecar.xcodeproj -scheme OpenSidecarMac \
-configuration Debug -derivedDataPath build-run \
-clonedSourcePackagesDirPath build-run/SourcePackages build
```

Android:

```bash
cd AndroidReceiver
./gradlew clean test assembleDebug
```

Create the complete offline Preview package set:

```bash
python3 -m pip install -r tools/dmg-requirements.txt
./tools/package-preview-0.1.sh
```

Android release signing uses a keystore stored outside the repository. See [development preview distribution](docs/development-preview.md).

## Documentation

- [Documentation index](docs/README.md)
- [Architecture](ARCHITECTURE.md)
- [Roadmap](ROADMAP.md)
- [Android receiver](AndroidReceiver/README.md)
- [Release checklist](docs/release-checklist.md)
- [Stability evidence](docs/stability-test-report.md)
- [USB/WiFi benchmark protocol](docs/usb-vs-wifi-benchmark.md)
- [Bitrate modes](docs/bitrate-modes.md) and [adaptive bitrate](docs/adaptive-bitrate.md)
- [Queue analysis](docs/low-latency-queue-analysis.md) and [keyframe strategy](docs/keyframe-strategy.md)
- [Android decoder throughput, reference recovery, and Surface-rate mapping](docs/android-decoder-throughput-recovery.md)
- [Security policy](SECURITY.md)
- [Contributing](CONTRIBUTING.md)
- [Third-party notices](THIRD_PARTY_NOTICES.md)

## Current limits

- iOS/iPadOS 120Hz is not implemented.
- Current WiFi TCP video/control traffic is not production-encrypted; use a trusted LAN.
- Two simultaneous Android devices, the controlled same-condition USB/WiFi benchmark, and 30-minute/2-hour endurance runs remain incomplete.
- macOS uses private `CGVirtualDisplay` behavior that may change in future macOS versions.
- Public macOS and iOS packages are not Developer ID/App Store signed.

## Origin and license

DisplayWeave preserves the applicable OpenDisplay history, copyright notices, and GPL-3.0 obligations. Some high-refresh and measurement approaches were informed by the MIT-licensed SideScreen project. See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). DisplayWeave itself is distributed under [GPL-3.0](LICENSE).