@desklink/react-native 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,18 @@
+desklink React Native client
+Copyright the desklink authors. Licensed under the Apache License, Version 2.0.
+
+  react-native-webrtc           MIT
+    The WebRTC binding the consuming application already ships. This package
+    compiles against its `org.webrtc` classes and never mutates its global
+    decoder factory, so a single native library serves both.
+
+  WebRTC (libwebrtc)            BSD-3-Clause
+    Reached through the application's existing binding; not redistributed by
+    this package.
+
+  expo / expo-modules-core      MIT
+    The native module and view plumbing.
+
+The client package contains no code from Sunshine, Moonlight, Apollo or
+RustDesk. Its decoder selection, session lifecycle and gesture model were written
+from the documented WebRTC and platform APIs.

package/README.md

@@ -0,0 +1,131 @@
+# @desklink/react-native
+
+Show a live desktop in a React Native app, and drive it from the phone.
+
+The package is a **view and a session**, not a screen: it renders the picture and
+turns touch, the keyboard and the clipboard into that session's input. Where it
+sits, how it starts, what the buttons look like and where "back" goes belong to
+the application.
+
+## Install
+
+The package contains native code and is not an Expo Go package. Inside this
+repository it resolves through the workspace; anywhere else, install it from npm:
+
+```sh
+npx expo install @desklink/react-native      # or yarn add, then prebuild/rebuild
+```
+
+Android as a native module, plus the browser, which brings its own WebRTC.
+`expo-module.config.json` declares the native side honestly rather than
+compiling an untested stub for other platforms; `ios/DEFERRED.md` lists exactly
+what an iOS backend has to implement.
+
+It compiles against the WebRTC binding the app already ships
+(`react-native-webrtc`) so there is one `org.webrtc` copy in the binary, and it
+never touches that binding's process-global decoder factory.
+
+## Use
+
+```tsx
+import { DesktopView, useDesktopSession, CONTROL_PERMISSIONS } from '@desklink/react-native';
+
+const desktop = useDesktopSession({
+    authorize: async () => ({
+        signaling,                                   // your authenticated channel to the host
+        session: { permissions: CONTROL_PERMISSIONS },
+    }),
+});
+
+// Opening is a user action, so the app decides when it happens.
+await desktop.connect();
+
+<DesktopView sessionId={desktop.nativeId} style={{ flex: 1 }} keyboardClearance={96} />;
+// On a deliberate control action, once the picture is live:
+desktop.setInputEnabled(true);
+desktop.showKeyboard();
+desktop.setOrientation('landscape');   // Android: hold the screen on its side; 'auto' to follow the phone
+await desktop.pasteLocalToRemote(await Clipboard.getStringAsync());
+```
+
+A screen that only decides *whether* to offer a desktop does not need the
+session: import the flag from its own entry, which is a constant on web and a
+check for the platform module elsewhere, so the hook and the view stay out of
+the first paint.
+
+```tsx
+import { desktopAvailable } from '@desklink/react-native/availability';
+
+{desktopAvailable && <ComputerAction onPress={openDesktop} />}
+```
+
+### What the package guarantees
+
+- **Hardware-first decoding.** The session builds its own peer connection with
+  a hardware-first decoder factory for VP9, falling back to software on phones
+  without a VP9 hardware decoder. No other WebRTC user in the app is affected.
+- **A sharp, zoomable picture.** The desktop fits the view by default; a pinch
+  zooms up to 2.5 view pixels per desktop pixel and one finger moves around the
+  zoomed desktop. On Android the decoded frame is copied once into the view's
+  own texture and drawn with a multi-tap filter when it is shown smaller than
+  its size, so a fitted 4K desktop does not alias and a pinch redraws at once.
+  `fitToView()` shows the whole desktop again.
+- **A pointer a phone can see.** Once a touch has sent the desktop's pointer
+  somewhere, the view draws it there at a readable size, over a picture whose
+  own cursor is a few pixels tall or not captured at all. A mouse keeps its own.
+- **The picture above the keyboard.** While the phone's keyboard is up, the
+  picture sits above it and above the room the app keeps for its own controls
+  (`keyboardClearance`), moving with the keyboard as it slides. A picture too
+  tall for what is left keeps the pointer, where a tap just put the caret, in
+  sight.
+- **Contained geometry.** Touch maps through the picture's actual placement.
+  A one-finger drag starting in the letterbox does not move the pointer; a
+  second finger on the picture can still start a pinch or scroll. A drag that
+  leaves the picture is held to its edge rather than released somewhere unseen.
+- **The gestures remote-desktop viewers settled on,** decided natively with a
+  slop threshold: tap to click, and a second tap close by is a double click on
+  the same point; hold and release for a right click where the finger rested
+  (every desktop app's context menu); hold then drag for the left button
+  (select text, move a window); on the whole desktop a finger that moves
+  carries the pointer with it, without a button, and the drawn pointer stays
+  under the finger while the picture catches up; two fingers scroll the desktop
+  under them, or pinch; a quick two-finger tap is a right click too. Scrolling
+  is fractional wheel steps, smooth where the desktop supports high-resolution
+  wheels. Under congestion, only the latest unsent pointer position is kept;
+  other input follows that position in order.
+- **The keys a phone lacks.** `modifiers`, `tapModifier` and `pressKey` give
+  sticky Ctrl and Shift: tap arms one for the next key, tap again locks it.
+  While one is armed, the next key or character the phone's keyboard types is
+  sent as that key's chord, so Ctrl then v is Ctrl+V. The app draws the keys.
+- **Readiness is a rendered frame.** `status: 'live'` is set by the first frame
+  actually presented, not by a track arriving or ICE connecting.
+- **Control starts off.** `setInputEnabled(true)` enables pointer, keyboard and
+  clipboard input; `setInputEnabled(false)` blocks new input, releases held keys
+  and buttons, and resets pending gestures. The app decides when to enable it
+  after a deliberate action and must disable it on background or lost readiness;
+  a clipboard write already in flight may still finish.
+- **Released state.** The app disables input on background and unmount;
+  session close and a lost control channel release what the desktop was holding.
+- **Explicit clipboard.** Two methods, called on a user action while control is
+  enabled. The package never polls the clipboard or uses it as a way to type.
+
+### `Signaling`
+
+The one thing the app must supply. It carries the engine's local protocol over
+whatever authenticated channel the app already has:
+
+```ts
+interface Signaling {
+    request<T>(method: string, params?: Record<string, unknown>): Promise<T>;
+    subscribe(handler: (event: SessionEvent) => void): () => void;
+}
+```
+
+`method` is one of `session.open`, `session.description`, `session.candidate`,
+`session.close`; `SessionEvent` is the engine's offer, candidates, state and
+revocation. Pixels and input do **not** use this channel — they are the
+desktop's own WebRTC session.
+
+## Licence
+
+Apache-2.0. See `NOTICE`.

package/android/build.gradle

@@ -0,0 +1,29 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+group = 'expo.modules.desklink'
+version = '0.1.0'
+
+android {
+  namespace 'expo.modules.desklink'
+  compileSdk rootProject.ext.has('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+  defaultConfig {
+    minSdk rootProject.ext.has('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+  }
+  kotlinOptions { jvmTarget = '17' }
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
+  }
+}
+
+dependencies {
+  implementation project(':expo-modules-core')
+  implementation 'androidx.core:core-ktx:1.17.0'
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:${kotlinVersion}"
+  testImplementation 'junit:junit:4.13.2'
+  // The app's existing WebRTC binding, so the org.webrtc classes and the single
+  // native library are shared rather than a second copy being linked in. This
+  // package never mutates that binding's global decoder factory.
+  implementation project(':react-native-webrtc')
+}

package/android/gradle.properties

@@ -0,0 +1 @@
+# Kept empty so the package does not impose build settings on its consumer.

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" />

package/android/src/main/java/expo/modules/desklink/DesklinkModule.kt

@@ -0,0 +1,199 @@
+package expo.modules.desklink
+
+import android.app.Activity
+import android.content.pm.ActivityInfo
+import android.content.res.Configuration
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+import java.util.concurrent.ConcurrentHashMap
+
+/**
+ * The client half of the desktop package.
+ *
+ * The module owns session objects; the view owns the pixels and the gestures.
+ * Everything an application does goes through this small surface:
+ * open → negotiate → show → drive → close.
+ */
+class DesklinkModule : Module() {
+  private val sessions = ConcurrentHashMap<String, DesktopSession>()
+  private var nextId = 0
+
+  private val eglContext = lazy {
+    // One shared EGL context for every session's renderer: a second display
+    // connection would cost a GPU context per session for no benefit.
+    org.webrtc.EglBase.create().eglBaseContext
+  }
+
+  override fun definition() = ModuleDefinition {
+    Name("Desklink")
+
+    Events("onSessionEvent")
+
+    Function("createSession") { iceServersJson: String? ->
+      val context = appContext.reactContext ?: return@Function null
+      val id = "desklink-${++nextId}"
+      val session = DesktopSession(
+        context = context,
+        eglBase = eglContext.value,
+        onEvent = { name, payload -> emit(name, id, payload) },
+      )
+      sessions[id] = session
+      session.start(iceServersJson ?: "[]")
+      id
+    }
+
+    Function("setRemoteDescription") { id: String, type: String, sdp: String ->
+      sessions[id]?.setRemoteDescription(type, sdp)
+      true
+    }
+
+    Function("addRemoteCandidate") { id: String, candidate: String, sdpMid: String?, sdpMLineIndex: Int? ->
+      sessions[id]?.addRemoteCandidate(candidate, sdpMid, sdpMLineIndex ?: 0)
+      true
+    }
+
+    Function("sendControl") { id: String, message: String ->
+      sessions[id]?.sendStamped(message)
+      true
+    }
+
+    Function("setInputEnabled") { id: String, enabled: Boolean ->
+      sessions[id]?.setInputEnabled(enabled)
+      if (!enabled) postToView(id) { it.disarmInput() }
+      true
+    }
+
+    Function("showKeyboard") { id: String ->
+      postToView(id) { it.showKeyboard() }
+      true
+    }
+
+    Function("hideKeyboard") { id: String ->
+      postToView(id) { it.hideKeyboard() }
+      true
+    }
+
+    Function("captureKeyboard") { id: String, captured: Boolean ->
+      postToView(id) { it.captureKeyboard(captured) }
+      true
+    }
+
+    Function("setOrientation") { mode: String ->
+      val activity = appContext.currentActivity ?: return@Function false
+      activity.runOnUiThread {
+        landscapeWanted = mode == "landscape"
+        if (landscapeWanted) holdLandscape(activity) else releaseLandscape(activity)
+      }
+      true
+    }
+
+    // The hold is the desktop's, not the phone's: the home screen and other
+    // apps never inherit it, and it comes back with the app.
+    OnActivityEntersBackground { appContext.currentActivity?.let { releaseLandscape(it) } }
+
+    OnActivityEntersForeground {
+      if (landscapeWanted) appContext.currentActivity?.let { holdLandscape(it) }
+    }
+
+    Function("fitToView") { id: String ->
+      postToView(id) { it.fitToView() }
+      true
+    }
+
+    Function("setSurfaceSize") { id: String, width: Int, height: Int ->
+      postToView(id) { it.setSurfaceSize(width, height) }
+      true
+    }
+
+    Function("closeSession") { id: String ->
+      sessions.remove(id)?.shutdown()
+      views.remove(id)
+      true
+    }
+
+    Function("isAvailable") { true }
+
+    View(DesktopView::class) {
+      Name("DesklinkSurface")
+
+      Prop("sessionId") { view: DesktopView, id: String? ->
+        val session = id?.let { sessions[it] }
+        view.setSession(session)
+        if (id != null) views[id] = view
+      }
+
+      Prop("keyboardClearance") { view: DesktopView, clearance: Float? ->
+        view.setKeyboardClearance(clearance ?: 0f)
+      }
+
+      OnViewDestroys { view: DesktopView -> view.release() }
+
+      OnViewDidUpdateProps { view: DesktopView ->
+        // Props are applied before the view is measured; a session that arrived
+        // with the prop has to be told about the view it will render into.
+        view.requestGeometryRefresh()
+      }
+    }
+
+    OnDestroy {
+      for (session in sessions.values) session.shutdown()
+      sessions.clear()
+      views.clear()
+    }
+  }
+
+  private val views = ConcurrentHashMap<String, DesktopView>()
+
+  // Main thread only. `orientationBefore` is what the app asked for before the
+  // first hold; it outlives a release still on its way upright.
+  private var landscapeWanted = false
+  private var holding = false
+  private var orientationBefore: Int? = null
+  private var portraitBefore = false
+
+  private fun holdLandscape(activity: Activity) {
+    if (orientationBefore == null) {
+      orientationBefore = activity.requestedOrientation
+      portraitBefore = activity.resources.configuration.orientation == Configuration.ORIENTATION_PORTRAIT
+    }
+    holding = true
+    activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE
+  }
+
+  private fun releaseLandscape(activity: Activity) {
+    val before = orientationBefore
+    if (!holding || before == null) return
+    holding = false
+    val restore = {
+      if (!holding) {
+        activity.requestedOrientation = before
+        orientationBefore = null
+      }
+    }
+    if (!portraitBefore) return restore()
+    // With auto-rotate off, Android keeps whatever rotation is on screen when
+    // an app stops asking for one, and makes it the phone's locked rotation.
+    // Turn upright first, then hand back the orientation the app had.
+    activity.requestedOrientation = ActivityInfo.SCREEN_ORIENTATION_PORTRAIT
+    activity.window.decorView.post(restore)
+  }
+
+  // Synchronous module functions run on JS, not Android's UI thread. Ignore
+  // queued work if the session/view was closed or replaced in the meantime.
+  private fun postToView(id: String, action: (DesktopView) -> Unit) {
+    views[id]?.let { view ->
+      view.post { if (views[id] === view) action(view) }
+    }
+  }
+
+  private fun emit(name: String, id: String, payload: Map<String, Any?>) {
+    sendEvent(
+      "onSessionEvent",
+      mapOf(
+        "sessionId" to id,
+        "name" to name,
+        "payload" to payload,
+      ),
+    )
+  }
+}