Compare commits
136 Commits
feat/andro
...
921856eba9
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
921856eba9 | ||
|
|
7e7968b2f9 | ||
|
|
578ff8cff4 | ||
|
|
16890576fb | ||
|
|
daf7bcd9ba | ||
|
|
df1a45a5f5 | ||
|
|
dd0c714caa | ||
|
|
a7b2f850f1 | ||
|
|
575a39d07a | ||
|
|
d63d50cdc0 | ||
|
|
d269600aa7 | ||
|
|
dfbe21fe6e | ||
|
|
b83c31b5d1 | ||
|
|
1f607281fd | ||
|
|
7515417202 | ||
|
|
505a834c5b | ||
|
|
27bc264738 | ||
|
|
c27b39d553 | ||
|
|
6db5c25b54 | ||
|
|
54cbebd34e | ||
|
|
86526a7ad4 | ||
|
|
56e3417063 | ||
|
|
8ceb6f45d5 | ||
|
|
07873ea598 | ||
|
|
cc00f7cace | ||
|
|
eb9de988d6 | ||
|
|
4ba77c8c0e | ||
|
|
7b8a2d0fba | ||
|
|
5cd7a20152 | ||
|
|
a5c00fe5cb | ||
|
|
ec41f179cd | ||
|
|
4e9244eb00 | ||
|
|
03a80a3196 | ||
|
|
7fecf285ea | ||
|
|
0683dde5d3 | ||
|
|
53f57eea07 | ||
|
|
ff3f7e8e4f | ||
|
|
48d2bd4f65 | ||
|
|
234a798df2 | ||
|
|
fa042b130c | ||
|
|
990b6f1ee0 | ||
|
|
7949266e11 | ||
|
|
d774f5f8c5 | ||
|
|
2fd94651e4 | ||
|
|
da09fdb6e9 | ||
|
|
510eae2089 | ||
|
|
76a4c53e21 | ||
|
|
4c6aac654a | ||
|
|
4f2ad65418 | ||
|
|
0178cbd91d | ||
|
|
9e37201198 | ||
|
|
da106bd939 | ||
|
|
8c36fb5651 | ||
|
|
cfa9ff67cf | ||
|
|
96be740fd9 | ||
|
|
8c4d640f89 | ||
|
|
49f101d785 | ||
|
|
d7b37a5749 | ||
|
|
b35a6b7d92 | ||
|
|
0105b0fbf3 | ||
|
|
5beea7de40 | ||
|
|
fdbe502524 | ||
|
|
c769a476a2 | ||
|
|
7cc53aedc7 | ||
|
|
711137da96 | ||
|
|
6071eb1b02 | ||
|
|
c9cd043657 | ||
|
|
6dd62c94c9 | ||
|
|
4c998312aa | ||
|
|
22701830c2 | ||
|
|
47a037368c | ||
|
|
191e8761d5 | ||
|
|
0d74366592 | ||
|
|
0224ce654c | ||
|
|
aa240c6d83 | ||
|
|
d216dcc7a3 | ||
|
|
4250f1b44a | ||
|
|
a852cad15e | ||
|
|
19fd3dd9cc | ||
|
|
c69195fe06 | ||
|
|
ae4f366b05 | ||
|
|
f96d7ce3e1 | ||
|
|
530993854f | ||
|
|
e2e023d2bc | ||
|
|
5df9d418c9 | ||
|
|
2718402e96 | ||
|
|
1a8288c95f | ||
|
|
f015be63ec | ||
|
|
79e876126c | ||
|
|
903a07c1d4 | ||
|
|
af20fa418a | ||
|
|
b314138caf | ||
|
|
35642d1c54 | ||
|
|
6b8107504e | ||
|
|
7639aaf08d | ||
|
|
69ee3115b6 | ||
|
|
e6f77a78a7 | ||
|
|
04a985912a | ||
|
|
2288c1ae07 | ||
|
|
395a0c557e | ||
|
|
da593f9510 | ||
|
|
7bddc6b5a6 | ||
|
|
3b85604b41 | ||
|
|
a8c2011445 | ||
|
|
ded49bdb7b | ||
|
|
369347ce54 | ||
|
|
44f04b55e8 | ||
|
|
85c2146760 | ||
|
|
96ccb4f333 | ||
|
|
95a905e1b5 | ||
|
|
f7ccb67b02 | ||
|
|
4df08eadbd | ||
|
|
6d776097c8 | ||
|
|
9f7962a6cd | ||
|
|
8c9befb15d | ||
|
|
3f869a4cd7 | ||
|
|
2263e898e5 | ||
|
|
9ab57ba037 | ||
|
|
7806d4ec04 | ||
|
|
d31b81a21d | ||
|
|
c268ce419a | ||
|
|
61b6e67610 | ||
|
|
dddf5d2e2d | ||
|
|
ed272d29f8 | ||
|
|
21f5b24cbf | ||
|
|
9b733010ab | ||
|
|
80d5bd7628 | ||
|
|
4a195a923a | ||
|
|
f726f8cfa4 | ||
|
|
e468454464 | ||
|
|
d1c96cd71f | ||
|
|
1b00b5e2a4 | ||
|
|
cfb48df1ef | ||
|
|
ba29d8354f | ||
|
|
0908507a7a | ||
|
|
860c90394d |
3544
Cargo.lock
generated
3544
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
37
Cargo.toml
37
Cargo.toml
@@ -10,6 +10,8 @@ members = [
|
|||||||
"crates/wzp-client",
|
"crates/wzp-client",
|
||||||
"crates/wzp-web",
|
"crates/wzp-web",
|
||||||
"crates/wzp-android",
|
"crates/wzp-android",
|
||||||
|
"crates/wzp-native",
|
||||||
|
"desktop/src-tauri",
|
||||||
]
|
]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
@@ -35,7 +37,14 @@ quinn = "0.11"
|
|||||||
raptorq = "2"
|
raptorq = "2"
|
||||||
|
|
||||||
# Codec
|
# Codec
|
||||||
audiopus = "0.3.0-rc.0"
|
# opusic-c: high-level safe bindings over libopus 1.5.2 (encoder side).
|
||||||
|
# opusic-sys: raw FFI for the decoder side — we build our own DecoderHandle
|
||||||
|
# because opusic-c::Decoder.inner is pub(crate) and cannot be reached for the
|
||||||
|
# Phase 3 DRED reconstruction path. See docs/PRD-dred-integration.md.
|
||||||
|
# Pinned exactly (no caret) for reproducible libopus 1.5.2 across the fleet.
|
||||||
|
opusic-c = { version = "=1.5.5", default-features = false, features = ["bundled", "dred"] }
|
||||||
|
opusic-sys = { version = "=0.6.0", default-features = false, features = ["bundled"] }
|
||||||
|
bytemuck = "1"
|
||||||
codec2 = "0.3"
|
codec2 = "0.3"
|
||||||
|
|
||||||
# Crypto
|
# Crypto
|
||||||
@@ -53,3 +62,29 @@ wzp-fec = { path = "crates/wzp-fec" }
|
|||||||
wzp-crypto = { path = "crates/wzp-crypto" }
|
wzp-crypto = { path = "crates/wzp-crypto" }
|
||||||
wzp-transport = { path = "crates/wzp-transport" }
|
wzp-transport = { path = "crates/wzp-transport" }
|
||||||
wzp-client = { path = "crates/wzp-client" }
|
wzp-client = { path = "crates/wzp-client" }
|
||||||
|
|
||||||
|
# Fast dev profile: optimized but with debug info and incremental compilation.
|
||||||
|
# Use with: cargo run --profile dev-fast
|
||||||
|
[profile.dev-fast]
|
||||||
|
inherits = "dev"
|
||||||
|
opt-level = 2
|
||||||
|
|
||||||
|
# Optimize heavy compute deps even in debug builds —
|
||||||
|
# real-time audio needs < 20ms per frame, impossible unoptimized.
|
||||||
|
[profile.dev.package.nnnoiseless]
|
||||||
|
opt-level = 3
|
||||||
|
[profile.dev.package.opusic-sys]
|
||||||
|
opt-level = 3
|
||||||
|
[profile.dev.package.raptorq]
|
||||||
|
opt-level = 3
|
||||||
|
[profile.dev.package.wzp-codec]
|
||||||
|
opt-level = 3
|
||||||
|
[profile.dev.package.wzp-fec]
|
||||||
|
opt-level = 3
|
||||||
|
|
||||||
|
# Phase 0 (opus-DRED): removed the [patch.crates-io] audiopus_sys = { path =
|
||||||
|
# "vendor/audiopus_sys" } block. That patch existed to fix a Windows clang-cl
|
||||||
|
# SIMD compile bug in libopus 1.3.1. With the swap to opusic-sys (libopus
|
||||||
|
# 1.5.2), the upstream SIMD gating was fixed and the vendor patch is
|
||||||
|
# obsolete. The vendor/audiopus_sys directory itself should be deleted as
|
||||||
|
# part of the same cleanup — see the commit that follows this Phase 0.
|
||||||
|
|||||||
@@ -46,6 +46,14 @@ class DebugReporter(private val context: Context) {
|
|||||||
val zipFile = File(context.cacheDir, "wzp_debug_${timestamp}.zip")
|
val zipFile = File(context.cacheDir, "wzp_debug_${timestamp}.zip")
|
||||||
|
|
||||||
ZipOutputStream(BufferedOutputStream(FileOutputStream(zipFile))).use { zos ->
|
ZipOutputStream(BufferedOutputStream(FileOutputStream(zipFile))).use { zos ->
|
||||||
|
// Phase 4: extract DRED / classical PLC counters from the
|
||||||
|
// stats JSON so they're visible in the meta preamble at a
|
||||||
|
// glance, not buried in the trailing JSON dump.
|
||||||
|
val dredReconstructions = extractLongField(finalStatsJson, "dred_reconstructions")
|
||||||
|
val classicalPlc = extractLongField(finalStatsJson, "classical_plc_invocations")
|
||||||
|
val framesDecoded = extractLongField(finalStatsJson, "frames_decoded")
|
||||||
|
val fecRecovered = extractLongField(finalStatsJson, "fec_recovered")
|
||||||
|
|
||||||
// 1. Call metadata
|
// 1. Call metadata
|
||||||
val meta = buildString {
|
val meta = buildString {
|
||||||
appendLine("=== WZ Phone Debug Report ===")
|
appendLine("=== WZ Phone Debug Report ===")
|
||||||
@@ -58,6 +66,18 @@ class DebugReporter(private val context: Context) {
|
|||||||
appendLine("Device: ${android.os.Build.MANUFACTURER} ${android.os.Build.MODEL}")
|
appendLine("Device: ${android.os.Build.MANUFACTURER} ${android.os.Build.MODEL}")
|
||||||
appendLine("Android: ${android.os.Build.VERSION.RELEASE} (API ${android.os.Build.VERSION.SDK_INT})")
|
appendLine("Android: ${android.os.Build.VERSION.RELEASE} (API ${android.os.Build.VERSION.SDK_INT})")
|
||||||
appendLine()
|
appendLine()
|
||||||
|
appendLine("=== Loss Recovery ===")
|
||||||
|
appendLine("Frames decoded: $framesDecoded")
|
||||||
|
appendLine("DRED reconstructions: $dredReconstructions (Opus neural recovery)")
|
||||||
|
appendLine("Classical PLC: $classicalPlc (fallback)")
|
||||||
|
appendLine("RaptorQ FEC recovered: $fecRecovered (Codec2 only)")
|
||||||
|
if (framesDecoded > 0) {
|
||||||
|
val dredPct = 100.0 * dredReconstructions / framesDecoded
|
||||||
|
val plcPct = 100.0 * classicalPlc / framesDecoded
|
||||||
|
appendLine("DRED rate: ${"%.2f".format(dredPct)}%")
|
||||||
|
appendLine("Classical PLC rate: ${"%.2f".format(plcPct)}%")
|
||||||
|
}
|
||||||
|
appendLine()
|
||||||
appendLine("=== Final Stats ===")
|
appendLine("=== Final Stats ===")
|
||||||
appendLine(finalStatsJson)
|
appendLine(finalStatsJson)
|
||||||
}
|
}
|
||||||
@@ -195,4 +215,28 @@ class DebugReporter(private val context: Context) {
|
|||||||
FileInputStream(file).use { it.copyTo(zos) }
|
FileInputStream(file).use { it.copyTo(zos) }
|
||||||
zos.closeEntry()
|
zos.closeEntry()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tiny JSON field extractor — pulls an integer value for a top-level
|
||||||
|
* field like `"dred_reconstructions":42`. We don't want to pull in a
|
||||||
|
* full JSON parser just for the debug preamble, and the CallStats
|
||||||
|
* output is a flat record with well-known field names.
|
||||||
|
*
|
||||||
|
* Returns 0 if the field is missing or unparseable.
|
||||||
|
*/
|
||||||
|
private fun extractLongField(json: String, field: String): Long {
|
||||||
|
val key = "\"$field\":"
|
||||||
|
val idx = json.indexOf(key)
|
||||||
|
if (idx < 0) return 0
|
||||||
|
var i = idx + key.length
|
||||||
|
// Skip whitespace
|
||||||
|
while (i < json.length && json[i].isWhitespace()) i++
|
||||||
|
val start = i
|
||||||
|
while (i < json.length && (json[i].isDigit() || json[i] == '-')) i++
|
||||||
|
return try {
|
||||||
|
json.substring(start, i).toLong()
|
||||||
|
} catch (_: NumberFormatException) {
|
||||||
|
0
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,97 +0,0 @@
|
|||||||
package com.wzp.engine
|
|
||||||
|
|
||||||
import org.json.JSONObject
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Persistent signal connection for direct 1:1 calls.
|
|
||||||
* Separate from WzpEngine — survives across calls.
|
|
||||||
*
|
|
||||||
* Lifecycle: connect() → [placeCall/answerCall] → destroy()
|
|
||||||
*/
|
|
||||||
class SignalManager {
|
|
||||||
|
|
||||||
private var handle: Long = 0L
|
|
||||||
|
|
||||||
val isConnected: Boolean get() = handle != 0L
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Connect to relay and register for direct calls.
|
|
||||||
* MUST be called from a thread with sufficient stack (8MB).
|
|
||||||
* Blocks briefly during QUIC connect + register, then returns.
|
|
||||||
*/
|
|
||||||
fun connect(relay: String, seedHex: String): Boolean {
|
|
||||||
if (handle != 0L) return true // already connected
|
|
||||||
handle = nativeSignalConnect(relay, seedHex)
|
|
||||||
return handle != 0L
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get current signal state as parsed object. Non-blocking. */
|
|
||||||
fun getState(): SignalState {
|
|
||||||
if (handle == 0L) return SignalState()
|
|
||||||
val json = nativeSignalGetState(handle) ?: return SignalState()
|
|
||||||
return try {
|
|
||||||
val obj = JSONObject(json)
|
|
||||||
SignalState(
|
|
||||||
status = obj.optString("status", "idle"),
|
|
||||||
fingerprint = obj.optString("fingerprint", ""),
|
|
||||||
incomingCallId = if (obj.isNull("incoming_call_id")) null else obj.optString("incoming_call_id"),
|
|
||||||
incomingCallerFp = if (obj.isNull("incoming_caller_fp")) null else obj.optString("incoming_caller_fp"),
|
|
||||||
incomingCallerAlias = if (obj.isNull("incoming_caller_alias")) null else obj.optString("incoming_caller_alias"),
|
|
||||||
callSetupRelay = if (obj.isNull("call_setup_relay")) null else obj.optString("call_setup_relay"),
|
|
||||||
callSetupRoom = if (obj.isNull("call_setup_room")) null else obj.optString("call_setup_room"),
|
|
||||||
callSetupId = if (obj.isNull("call_setup_id")) null else obj.optString("call_setup_id"),
|
|
||||||
)
|
|
||||||
} catch (e: Exception) {
|
|
||||||
SignalState()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Place a direct call to a target fingerprint. */
|
|
||||||
fun placeCall(targetFp: String): Int {
|
|
||||||
if (handle == 0L) return -1
|
|
||||||
return nativeSignalPlaceCall(handle, targetFp)
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Answer an incoming call. mode: 0=Reject, 1=AcceptTrusted, 2=AcceptGeneric */
|
|
||||||
fun answerCall(callId: String, mode: Int = 2): Int {
|
|
||||||
if (handle == 0L) return -1
|
|
||||||
return nativeSignalAnswerCall(handle, callId, mode)
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Send hangup signal. */
|
|
||||||
fun hangup() {
|
|
||||||
if (handle != 0L) nativeSignalHangup(handle)
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Destroy the signal manager. */
|
|
||||||
fun destroy() {
|
|
||||||
if (handle != 0L) {
|
|
||||||
nativeSignalDestroy(handle)
|
|
||||||
handle = 0L
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// JNI native methods
|
|
||||||
private external fun nativeSignalConnect(relay: String, seed: String): Long
|
|
||||||
private external fun nativeSignalGetState(handle: Long): String?
|
|
||||||
private external fun nativeSignalPlaceCall(handle: Long, targetFp: String): Int
|
|
||||||
private external fun nativeSignalAnswerCall(handle: Long, callId: String, mode: Int): Int
|
|
||||||
private external fun nativeSignalHangup(handle: Long)
|
|
||||||
private external fun nativeSignalDestroy(handle: Long)
|
|
||||||
|
|
||||||
companion object {
|
|
||||||
init { System.loadLibrary("wzp_android") }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Signal connection state. */
|
|
||||||
data class SignalState(
|
|
||||||
val status: String = "idle",
|
|
||||||
val fingerprint: String = "",
|
|
||||||
val incomingCallId: String? = null,
|
|
||||||
val incomingCallerFp: String? = null,
|
|
||||||
val incomingCallerAlias: String? = null,
|
|
||||||
val callSetupRelay: String? = null,
|
|
||||||
val callSetupRoom: String? = null,
|
|
||||||
val callSetupId: String? = null,
|
|
||||||
)
|
|
||||||
@@ -159,18 +159,6 @@ class WzpEngine(private val callback: WzpCallback) {
|
|||||||
private external fun nativeWriteAudioDirect(handle: Long, buffer: java.nio.ByteBuffer, sampleCount: Int): Int
|
private external fun nativeWriteAudioDirect(handle: Long, buffer: java.nio.ByteBuffer, sampleCount: Int): Int
|
||||||
private external fun nativeReadAudioDirect(handle: Long, buffer: java.nio.ByteBuffer, maxSamples: Int): Int
|
private external fun nativeReadAudioDirect(handle: Long, buffer: java.nio.ByteBuffer, maxSamples: Int): Int
|
||||||
private external fun nativeDestroy(handle: Long)
|
private external fun nativeDestroy(handle: Long)
|
||||||
|
|
||||||
companion object {
|
|
||||||
init { System.loadLibrary("wzp_android") }
|
|
||||||
|
|
||||||
/** Get the identity fingerprint for a seed hex. No engine needed. */
|
|
||||||
@JvmStatic
|
|
||||||
private external fun nativeGetFingerprint(seedHex: String): String?
|
|
||||||
|
|
||||||
/** Compute the full identity fingerprint (xxxx:xxxx:...) from a seed hex string. */
|
|
||||||
@JvmStatic
|
|
||||||
fun getFingerprint(seedHex: String): String = nativeGetFingerprint(seedHex) ?: ""
|
|
||||||
}
|
|
||||||
private external fun nativePingRelay(handle: Long, relay: String): String?
|
private external fun nativePingRelay(handle: Long, relay: String): String?
|
||||||
private external fun nativeStartSignaling(handle: Long, relay: String, seed: String, token: String, alias: String): Int
|
private external fun nativeStartSignaling(handle: Long, relay: String, seed: String, token: String, alias: String): Int
|
||||||
private external fun nativePlaceCall(handle: Long, targetFp: String): Int
|
private external fun nativePlaceCall(handle: Long, targetFp: String): Int
|
||||||
@@ -220,6 +208,11 @@ class WzpEngine(private val callback: WzpCallback) {
|
|||||||
return nativeAnswerCall(nativeHandle, callId, mode)
|
return nativeAnswerCall(nativeHandle, callId, mode)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
init {
|
||||||
|
System.loadLibrary("wzp_android")
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Integer constants matching the Rust [CallState] enum ordinals. */
|
/** Integer constants matching the Rust [CallState] enum ordinals. */
|
||||||
|
|||||||
@@ -141,9 +141,9 @@ class CallViewModel : ViewModel(), WzpCallback {
|
|||||||
private val _targetFingerprint = MutableStateFlow("")
|
private val _targetFingerprint = MutableStateFlow("")
|
||||||
val targetFingerprint: StateFlow<String> = _targetFingerprint.asStateFlow()
|
val targetFingerprint: StateFlow<String> = _targetFingerprint.asStateFlow()
|
||||||
|
|
||||||
/** Signal state string: "idle", "registered", "ringing", "incoming", "setup" */
|
/** Signal connection state: 0=idle, 5=registered, 6=ringing, 7=incoming */
|
||||||
private val _signalState = MutableStateFlow("idle")
|
private val _signalState = MutableStateFlow(0)
|
||||||
val signalState: StateFlow<String> = _signalState.asStateFlow()
|
val signalState: StateFlow<Int> = _signalState.asStateFlow()
|
||||||
|
|
||||||
/** Incoming call info */
|
/** Incoming call info */
|
||||||
private val _incomingCallId = MutableStateFlow<String?>(null)
|
private val _incomingCallId = MutableStateFlow<String?>(null)
|
||||||
@@ -155,80 +155,32 @@ class CallViewModel : ViewModel(), WzpCallback {
|
|||||||
private val _incomingCallerAlias = MutableStateFlow<String?>(null)
|
private val _incomingCallerAlias = MutableStateFlow<String?>(null)
|
||||||
val incomingCallerAlias: StateFlow<String?> = _incomingCallerAlias.asStateFlow()
|
val incomingCallerAlias: StateFlow<String?> = _incomingCallerAlias.asStateFlow()
|
||||||
|
|
||||||
/** Separate signal manager (persistent, survives calls) */
|
|
||||||
private var signalManager: com.wzp.engine.SignalManager? = null
|
|
||||||
private var signalPollJob: Job? = null
|
|
||||||
|
|
||||||
fun setCallMode(mode: Int) { _callMode.value = mode }
|
fun setCallMode(mode: Int) { _callMode.value = mode }
|
||||||
fun setTargetFingerprint(fp: String) { _targetFingerprint.value = fp }
|
fun setTargetFingerprint(fp: String) { _targetFingerprint.value = fp }
|
||||||
|
|
||||||
/** Register on relay for direct calls */
|
/** Register on relay for direct calls */
|
||||||
fun registerForCalls() {
|
fun registerForCalls() {
|
||||||
|
if (engine == null) {
|
||||||
|
engine = WzpEngine(this).also { it.init() }
|
||||||
|
}
|
||||||
val serverIdx = _selectedServer.value
|
val serverIdx = _selectedServer.value
|
||||||
val serverList = _servers.value
|
val serverList = _servers.value
|
||||||
if (serverIdx >= serverList.size) return
|
if (serverIdx >= serverList.size) return
|
||||||
|
|
||||||
val relay = serverList[serverIdx].address
|
val relay = serverList[serverIdx].address
|
||||||
var seed = _seedHex.value
|
val seed = _seedHex.value
|
||||||
// Generate seed if empty (fresh install or cleared storage)
|
val alias = _alias.value
|
||||||
if (seed.isEmpty()) {
|
|
||||||
val newSeed = ByteArray(32).also { java.security.SecureRandom().nextBytes(it) }
|
|
||||||
seed = newSeed.joinToString("") { "%02x".format(it) }
|
|
||||||
_seedHex.value = seed
|
|
||||||
settings?.saveSeedHex(seed)
|
|
||||||
Log.i(TAG, "generated new identity seed")
|
|
||||||
}
|
|
||||||
val resolvedRelay = resolveToIp(relay) ?: relay
|
|
||||||
|
|
||||||
// nativeSignalConnect has JNI overhead — must be on a thread with enough stack.
|
viewModelScope.launch(Dispatchers.IO) {
|
||||||
// Dispatchers.IO threads overflow. Use explicit Java Thread.
|
val resolvedRelay = resolveToIp(relay) ?: relay
|
||||||
Thread(null, {
|
val result = engine?.startSignaling(resolvedRelay, seed, "", alias)
|
||||||
try {
|
if (result == 0) {
|
||||||
val mgr = com.wzp.engine.SignalManager()
|
_signalState.value = 5 // Registered
|
||||||
val ok = mgr.connect(resolvedRelay, seed)
|
startStatsPolling()
|
||||||
viewModelScope.launch {
|
|
||||||
if (ok) {
|
|
||||||
signalManager = mgr
|
|
||||||
startSignalPolling()
|
|
||||||
} else {
|
} else {
|
||||||
_errorMessage.value = "Failed to register on relay"
|
_errorMessage.value = "Failed to register on relay"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} catch (e: Exception) {
|
|
||||||
viewModelScope.launch {
|
|
||||||
_errorMessage.value = "Register error: ${e.message}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}, "wzp-signal-init", 8 * 1024 * 1024).start()
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Poll signal manager state every 500ms */
|
|
||||||
private fun startSignalPolling() {
|
|
||||||
signalPollJob?.cancel()
|
|
||||||
signalPollJob = viewModelScope.launch {
|
|
||||||
while (isActive) {
|
|
||||||
val mgr = signalManager
|
|
||||||
if (mgr != null && mgr.isConnected) {
|
|
||||||
val state = mgr.getState()
|
|
||||||
_signalState.value = state.status
|
|
||||||
_incomingCallId.value = state.incomingCallId
|
|
||||||
_incomingCallerFp.value = state.incomingCallerFp
|
|
||||||
_incomingCallerAlias.value = state.incomingCallerAlias
|
|
||||||
|
|
||||||
// Auto-connect to media room when call is set up
|
|
||||||
if (state.status == "setup" && state.callSetupRelay != null && state.callSetupRoom != null) {
|
|
||||||
Log.i(TAG, "CallSetup: connecting to ${state.callSetupRelay} room ${state.callSetupRoom}")
|
|
||||||
startCallInternal(state.callSetupRelay, state.callSetupRoom)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
delay(500L)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private fun stopSignalPolling() {
|
|
||||||
signalPollJob?.cancel()
|
|
||||||
signalPollJob = null
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Place a direct call to the target fingerprint */
|
/** Place a direct call to the target fingerprint */
|
||||||
@@ -238,28 +190,24 @@ class CallViewModel : ViewModel(), WzpCallback {
|
|||||||
_errorMessage.value = "Enter a fingerprint to call"
|
_errorMessage.value = "Enter a fingerprint to call"
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
signalManager?.placeCall(target)
|
engine?.placeCall(target)
|
||||||
|
_signalState.value = 6 // Ringing
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Answer an incoming direct call */
|
/** Answer an incoming direct call */
|
||||||
fun answerIncomingCall(mode: Int = 2) {
|
fun answerIncomingCall(mode: Int = 2) {
|
||||||
val callId = _incomingCallId.value ?: return
|
val callId = _incomingCallId.value ?: return
|
||||||
signalManager?.answerCall(callId, mode)
|
engine?.answerCall(callId, mode)
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Reject an incoming direct call */
|
/** Reject an incoming direct call */
|
||||||
fun rejectIncomingCall() {
|
fun rejectIncomingCall() {
|
||||||
val callId = _incomingCallId.value ?: return
|
val callId = _incomingCallId.value ?: return
|
||||||
signalManager?.answerCall(callId, 0)
|
engine?.answerCall(callId, 0) // 0 = Reject
|
||||||
}
|
_signalState.value = 5 // Back to registered
|
||||||
|
_incomingCallId.value = null
|
||||||
/** Hang up direct call — media ends, signal stays alive */
|
_incomingCallerFp.value = null
|
||||||
fun hangupDirectCall() {
|
_incomingCallerAlias.value = null
|
||||||
signalManager?.hangup()
|
|
||||||
engine?.stopCall()
|
|
||||||
engine?.destroy()
|
|
||||||
engine = null
|
|
||||||
engineInitialized = false
|
|
||||||
}
|
}
|
||||||
|
|
||||||
companion object {
|
companion object {
|
||||||
@@ -737,10 +685,30 @@ class CallViewModel : ViewModel(), WzpCallback {
|
|||||||
val s = CallStats.fromJson(json)
|
val s = CallStats.fromJson(json)
|
||||||
lastCallDuration = s.durationSecs
|
lastCallDuration = s.durationSecs
|
||||||
_stats.value = s
|
_stats.value = s
|
||||||
// Only update callState from media engine stats (not signal)
|
|
||||||
if (s.state != 0) {
|
if (s.state != 0) {
|
||||||
_callState.value = s.state
|
_callState.value = s.state
|
||||||
}
|
}
|
||||||
|
// Track signal state changes for direct calling
|
||||||
|
if (s.state in 5..7) {
|
||||||
|
_signalState.value = s.state
|
||||||
|
}
|
||||||
|
// Incoming call detection
|
||||||
|
if (s.state == 7) { // IncomingCall
|
||||||
|
_incomingCallId.value = s.incomingCallId
|
||||||
|
_incomingCallerFp.value = s.incomingCallerFp
|
||||||
|
_incomingCallerAlias.value = s.incomingCallerAlias
|
||||||
|
}
|
||||||
|
// CallSetup: auto-connect to media room
|
||||||
|
if (s.state == 1 && s.incomingCallId != null && s.incomingCallId.contains("|")) {
|
||||||
|
// Format: "relay_addr|room_name"
|
||||||
|
val parts = s.incomingCallId.split("|", limit = 2)
|
||||||
|
if (parts.size == 2) {
|
||||||
|
val mediaRelay = parts[0]
|
||||||
|
val mediaRoom = parts[1]
|
||||||
|
Log.i(TAG, "CallSetup: connecting to $mediaRelay room $mediaRoom")
|
||||||
|
startCallInternal(mediaRelay, mediaRoom)
|
||||||
|
}
|
||||||
|
}
|
||||||
if (s.state == 2 && !audioStarted) {
|
if (s.state == 2 && !audioStarted) {
|
||||||
startAudio()
|
startAudio()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -165,7 +165,7 @@ fun InCallScreen(
|
|||||||
color = Color.White
|
color = Color.White
|
||||||
)
|
)
|
||||||
Text(
|
Text(
|
||||||
text = "ENCRYPTED VOICE \u2022 direct-call-v1",
|
text = "ENCRYPTED VOICE",
|
||||||
style = MaterialTheme.typography.labelSmall.copy(letterSpacing = 3.sp),
|
style = MaterialTheme.typography.labelSmall.copy(letterSpacing = 3.sp),
|
||||||
color = TextDim
|
color = TextDim
|
||||||
)
|
)
|
||||||
@@ -219,7 +219,7 @@ fun InCallScreen(
|
|||||||
|
|
||||||
// Mode toggle: Room vs Direct Call
|
// Mode toggle: Room vs Direct Call
|
||||||
val callMode by viewModel.callMode.collectAsState()
|
val callMode by viewModel.callMode.collectAsState()
|
||||||
val signalState by viewModel.signalState.collectAsState() // "idle"/"registered"/"ringing"/etc
|
val signalState by viewModel.signalState.collectAsState()
|
||||||
val targetFp by viewModel.targetFingerprint.collectAsState()
|
val targetFp by viewModel.targetFingerprint.collectAsState()
|
||||||
val incomingCallId by viewModel.incomingCallId.collectAsState()
|
val incomingCallId by viewModel.incomingCallId.collectAsState()
|
||||||
val incomingCallerFp by viewModel.incomingCallerFp.collectAsState()
|
val incomingCallerFp by viewModel.incomingCallerFp.collectAsState()
|
||||||
@@ -309,7 +309,7 @@ fun InCallScreen(
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// ── Direct call mode ──
|
// ── Direct call mode ──
|
||||||
if (signalState == "idle") {
|
if (signalState < 5) {
|
||||||
// Not registered yet
|
// Not registered yet
|
||||||
SectionLabel("ALIAS")
|
SectionLabel("ALIAS")
|
||||||
OutlinedTextField(
|
OutlinedTextField(
|
||||||
@@ -333,7 +333,7 @@ fun InCallScreen(
|
|||||||
color = Color.White
|
color = Color.White
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
} else if (signalState == "registered" || signalState == "incoming") {
|
} else if (signalState == 5) {
|
||||||
// Registered — show dial pad
|
// Registered — show dial pad
|
||||||
Text(
|
Text(
|
||||||
"\u2705 Registered — waiting for calls",
|
"\u2705 Registered — waiting for calls",
|
||||||
@@ -403,7 +403,8 @@ fun InCallScreen(
|
|||||||
color = Color.White
|
color = Color.White
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
} else if (signalState == "ringing") {
|
} else if (signalState == 6) {
|
||||||
|
// Ringing
|
||||||
Text(
|
Text(
|
||||||
"\uD83D\uDD14 Ringing...",
|
"\uD83D\uDD14 Ringing...",
|
||||||
color = Yellow,
|
color = Yellow,
|
||||||
@@ -411,10 +412,11 @@ fun InCallScreen(
|
|||||||
textAlign = TextAlign.Center,
|
textAlign = TextAlign.Center,
|
||||||
modifier = Modifier.fillMaxWidth()
|
modifier = Modifier.fillMaxWidth()
|
||||||
)
|
)
|
||||||
} else if (signalState == "setup") {
|
} else if (signalState == 7) {
|
||||||
|
// Incoming call (state 7 also handled above in registered view)
|
||||||
Text(
|
Text(
|
||||||
"Connecting to call...",
|
"\uD83D\uDCDE Incoming call...",
|
||||||
color = Accent,
|
color = Green,
|
||||||
style = MaterialTheme.typography.titleMedium,
|
style = MaterialTheme.typography.titleMedium,
|
||||||
textAlign = TextAlign.Center,
|
textAlign = TextAlign.Center,
|
||||||
modifier = Modifier.fillMaxWidth()
|
modifier = Modifier.fillMaxWidth()
|
||||||
@@ -429,16 +431,14 @@ fun InCallScreen(
|
|||||||
|
|
||||||
Spacer(modifier = Modifier.height(20.dp))
|
Spacer(modifier = Modifier.height(20.dp))
|
||||||
|
|
||||||
// Identity — compute real fingerprint from seed
|
// Identity
|
||||||
val fullFp = remember(seedHex) {
|
val fp = if (seedHex.length >= 16) seedHex.take(16) else ""
|
||||||
if (seedHex.length >= 64) com.wzp.engine.WzpEngine.getFingerprint(seedHex) else ""
|
|
||||||
}
|
|
||||||
Row(verticalAlignment = Alignment.CenterVertically) {
|
Row(verticalAlignment = Alignment.CenterVertically) {
|
||||||
if (fullFp.isNotEmpty()) {
|
if (fp.isNotEmpty()) {
|
||||||
Identicon(fingerprint = fullFp, size = 28.dp)
|
Identicon(fingerprint = seedHex, size = 28.dp)
|
||||||
Spacer(modifier = Modifier.width(8.dp))
|
Spacer(modifier = Modifier.width(8.dp))
|
||||||
CopyableFingerprint(
|
CopyableFingerprint(
|
||||||
fingerprint = fullFp,
|
fingerprint = fp.chunked(4).joinToString(":"),
|
||||||
style = MaterialTheme.typography.bodySmall.copy(fontFamily = FontFamily.Monospace),
|
style = MaterialTheme.typography.bodySmall.copy(fontFamily = FontFamily.Monospace),
|
||||||
color = TextDim
|
color = TextDim
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -14,8 +14,10 @@ use std::sync::{Arc, Mutex};
|
|||||||
use std::time::Instant;
|
use std::time::Instant;
|
||||||
|
|
||||||
use bytes::Bytes;
|
use bytes::Bytes;
|
||||||
use tracing::{error, info, warn};
|
use tracing::{debug, error, info, warn};
|
||||||
|
use wzp_codec::AdaptiveDecoder;
|
||||||
use wzp_codec::agc::AutoGainControl;
|
use wzp_codec::agc::AutoGainControl;
|
||||||
|
use wzp_codec::dred_ffi::{DredDecoderHandle, DredState};
|
||||||
use wzp_crypto::{KeyExchange, WarzoneKeyExchange};
|
use wzp_crypto::{KeyExchange, WarzoneKeyExchange};
|
||||||
use wzp_fec::{RaptorQFecDecoder, RaptorQFecEncoder};
|
use wzp_fec::{RaptorQFecDecoder, RaptorQFecEncoder};
|
||||||
use wzp_proto::{
|
use wzp_proto::{
|
||||||
@@ -201,6 +203,7 @@ impl WzpEngine {
|
|||||||
/// Returns JSON `{"rtt_ms":N,"server_fingerprint":"hex"}` or error.
|
/// Returns JSON `{"rtt_ms":N,"server_fingerprint":"hex"}` or error.
|
||||||
pub fn ping_relay(&self, address: &str) -> Result<String, anyhow::Error> {
|
pub fn ping_relay(&self, address: &str) -> Result<String, anyhow::Error> {
|
||||||
let addr: SocketAddr = address.parse()?;
|
let addr: SocketAddr = address.parse()?;
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
|
||||||
let rt = tokio::runtime::Builder::new_current_thread()
|
let rt = tokio::runtime::Builder::new_current_thread()
|
||||||
.enable_all()
|
.enable_all()
|
||||||
@@ -244,7 +247,154 @@ impl WzpEngine {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Start persistent signaling connection for direct calls.
|
/// Start persistent signaling connection for direct calls.
|
||||||
// Signal methods (start_signaling, place_call, answer_call) moved to signal_mgr.rs
|
/// Spawns a background task that maintains the `_signal` connection.
|
||||||
|
pub fn start_signaling(
|
||||||
|
&mut self,
|
||||||
|
relay_addr: &str,
|
||||||
|
seed_hex: &str,
|
||||||
|
token: Option<&str>,
|
||||||
|
alias: Option<&str>,
|
||||||
|
) -> Result<(), anyhow::Error> {
|
||||||
|
use wzp_proto::{MediaTransport, SignalMessage};
|
||||||
|
|
||||||
|
let addr: SocketAddr = relay_addr.parse()?;
|
||||||
|
let seed = if seed_hex.is_empty() {
|
||||||
|
wzp_crypto::Seed::generate()
|
||||||
|
} else {
|
||||||
|
wzp_crypto::Seed::from_hex(seed_hex).map_err(|e| anyhow::anyhow!(e))?
|
||||||
|
};
|
||||||
|
let identity = seed.derive_identity();
|
||||||
|
let pub_id = identity.public_identity();
|
||||||
|
let identity_pub = *pub_id.signing.as_bytes();
|
||||||
|
let fp = pub_id.fingerprint.to_string();
|
||||||
|
let token = token.map(|s| s.to_string());
|
||||||
|
let alias = alias.map(|s| s.to_string());
|
||||||
|
let state = self.state.clone();
|
||||||
|
let seed_bytes = seed.0;
|
||||||
|
|
||||||
|
info!(fingerprint = %fp, relay = %addr, "starting signaling");
|
||||||
|
|
||||||
|
// Create runtime for signaling (separate from call runtime)
|
||||||
|
let rt = tokio::runtime::Builder::new_multi_thread()
|
||||||
|
.worker_threads(1)
|
||||||
|
.enable_all()
|
||||||
|
.build()?;
|
||||||
|
|
||||||
|
let signal_state = state.clone();
|
||||||
|
rt.spawn(async move {
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
let bind: SocketAddr = "0.0.0.0:0".parse().unwrap();
|
||||||
|
let endpoint = match wzp_transport::create_endpoint(bind, None) {
|
||||||
|
Ok(e) => e,
|
||||||
|
Err(e) => { error!("signal endpoint: {e}"); return; }
|
||||||
|
};
|
||||||
|
let client_cfg = wzp_transport::client_config();
|
||||||
|
let conn = match wzp_transport::connect(&endpoint, addr, "_signal", client_cfg).await {
|
||||||
|
Ok(c) => c,
|
||||||
|
Err(e) => { error!("signal connect: {e}"); return; }
|
||||||
|
};
|
||||||
|
let transport = std::sync::Arc::new(wzp_transport::QuinnTransport::new(conn));
|
||||||
|
|
||||||
|
// Auth if token provided
|
||||||
|
if let Some(ref tok) = token {
|
||||||
|
let _ = transport.send_signal(&SignalMessage::AuthToken { token: tok.clone() }).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register presence
|
||||||
|
let _ = transport.send_signal(&SignalMessage::RegisterPresence {
|
||||||
|
identity_pub,
|
||||||
|
signature: vec![],
|
||||||
|
alias: alias.clone(),
|
||||||
|
}).await;
|
||||||
|
|
||||||
|
// Wait for ack
|
||||||
|
match transport.recv_signal().await {
|
||||||
|
Ok(Some(SignalMessage::RegisterPresenceAck { success: true, .. })) => {
|
||||||
|
info!(fingerprint = %fp, "signal: registered");
|
||||||
|
let mut stats = signal_state.stats.lock().unwrap();
|
||||||
|
stats.state = crate::stats::CallState::Registered;
|
||||||
|
}
|
||||||
|
other => {
|
||||||
|
error!("signal registration failed: {other:?}");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Signal recv loop
|
||||||
|
loop {
|
||||||
|
if !signal_state.running.load(Ordering::Relaxed) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
match transport.recv_signal().await {
|
||||||
|
Ok(Some(SignalMessage::CallRinging { call_id })) => {
|
||||||
|
info!(call_id = %call_id, "signal: ringing");
|
||||||
|
let mut stats = signal_state.stats.lock().unwrap();
|
||||||
|
stats.state = crate::stats::CallState::Ringing;
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::DirectCallOffer { caller_fingerprint, caller_alias, call_id, .. })) => {
|
||||||
|
info!(from = %caller_fingerprint, call_id = %call_id, "signal: incoming call");
|
||||||
|
let mut stats = signal_state.stats.lock().unwrap();
|
||||||
|
stats.state = crate::stats::CallState::IncomingCall;
|
||||||
|
stats.incoming_call_id = Some(call_id);
|
||||||
|
stats.incoming_caller_fp = Some(caller_fingerprint);
|
||||||
|
stats.incoming_caller_alias = caller_alias;
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::DirectCallAnswer { call_id, accept_mode, .. })) => {
|
||||||
|
info!(call_id = %call_id, mode = ?accept_mode, "signal: call answered");
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::CallSetup { call_id, room, relay_addr })) => {
|
||||||
|
info!(call_id = %call_id, room = %room, relay = %relay_addr, "signal: call setup");
|
||||||
|
// Connect to media room via the existing start_call mechanism
|
||||||
|
// Store the room info so Kotlin can call startCall with it
|
||||||
|
let mut stats = signal_state.stats.lock().unwrap();
|
||||||
|
stats.state = crate::stats::CallState::Connecting;
|
||||||
|
// Store call setup info for Kotlin to pick up
|
||||||
|
stats.incoming_call_id = Some(format!("{relay_addr}|{room}"));
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::Hangup { reason })) => {
|
||||||
|
info!(reason = ?reason, "signal: call ended by remote");
|
||||||
|
let mut stats = signal_state.stats.lock().unwrap();
|
||||||
|
stats.state = crate::stats::CallState::Closed;
|
||||||
|
stats.incoming_call_id = None;
|
||||||
|
stats.incoming_caller_fp = None;
|
||||||
|
stats.incoming_caller_alias = None;
|
||||||
|
}
|
||||||
|
Ok(Some(_)) => {}
|
||||||
|
Ok(None) => {
|
||||||
|
info!("signal: connection closed");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
error!("signal recv error: {e}");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut stats = signal_state.stats.lock().unwrap();
|
||||||
|
stats.state = crate::stats::CallState::Closed;
|
||||||
|
});
|
||||||
|
|
||||||
|
self.tokio_runtime = Some(rt);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Place a direct call to a target fingerprint via the signal connection.
|
||||||
|
pub fn place_call(&self, target_fingerprint: &str) -> Result<(), anyhow::Error> {
|
||||||
|
let _ = self.state.command_tx.send(EngineCommand::PlaceCall {
|
||||||
|
target_fingerprint: target_fingerprint.to_string(),
|
||||||
|
});
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Answer an incoming direct call.
|
||||||
|
pub fn answer_call(&self, call_id: &str, mode: wzp_proto::CallAcceptMode) -> Result<(), anyhow::Error> {
|
||||||
|
let _ = self.state.command_tx.send(EngineCommand::AnswerCall {
|
||||||
|
call_id: call_id.to_string(),
|
||||||
|
accept_mode: mode,
|
||||||
|
});
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
pub fn set_mute(&self, muted: bool) {
|
pub fn set_mute(&self, muted: bool) {
|
||||||
self.state.muted.store(muted, Ordering::Relaxed);
|
self.state.muted.store(muted, Ordering::Relaxed);
|
||||||
@@ -308,6 +458,7 @@ async fn run_call(
|
|||||||
alias: Option<&str>,
|
alias: Option<&str>,
|
||||||
state: Arc<EngineState>,
|
state: Arc<EngineState>,
|
||||||
) -> Result<(), anyhow::Error> {
|
) -> Result<(), anyhow::Error> {
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
|
||||||
let bind_addr: SocketAddr = "0.0.0.0:0".parse().unwrap();
|
let bind_addr: SocketAddr = "0.0.0.0:0".parse().unwrap();
|
||||||
let endpoint = wzp_transport::create_endpoint(bind_addr, None)?;
|
let endpoint = wzp_transport::create_endpoint(bind_addr, None)?;
|
||||||
@@ -381,9 +532,12 @@ async fn run_call(
|
|||||||
stats.state = CallState::Active;
|
stats.state = CallState::Active;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Initialize codec (Opus or Codec2 based on profile)
|
// Initialize codec (Opus or Codec2 based on profile).
|
||||||
|
// Phase 3c: decoder is a concrete AdaptiveDecoder (not Box<dyn
|
||||||
|
// AudioDecoder>) so the recv task can call reconstruct_from_dred on
|
||||||
|
// gaps detected via sequence tracking.
|
||||||
let mut encoder = wzp_codec::create_encoder(profile);
|
let mut encoder = wzp_codec::create_encoder(profile);
|
||||||
let mut decoder = wzp_codec::create_decoder(profile);
|
let mut decoder = AdaptiveDecoder::new(profile).expect("failed to create adaptive decoder");
|
||||||
|
|
||||||
// Initialize FEC encoder/decoder
|
// Initialize FEC encoder/decoder
|
||||||
let mut fec_enc = wzp_fec::create_encoder(&profile);
|
let mut fec_enc = wzp_fec::create_encoder(&profile);
|
||||||
@@ -516,6 +670,19 @@ async fn run_call(
|
|||||||
t_opus_us += t0.elapsed().as_micros() as u64;
|
t_opus_us += t0.elapsed().as_micros() as u64;
|
||||||
let encoded = &encode_buf[..encoded_len];
|
let encoded = &encode_buf[..encoded_len];
|
||||||
|
|
||||||
|
// Phase 2: Opus tiers bypass RaptorQ (DRED handles loss recovery
|
||||||
|
// at the codec layer). Codec2 tiers keep RaptorQ unchanged.
|
||||||
|
let is_opus = current_profile.codec.is_opus();
|
||||||
|
let (hdr_fec_block, hdr_fec_symbol, hdr_fec_ratio) = if is_opus {
|
||||||
|
(0u8, 0u8, 0u8)
|
||||||
|
} else {
|
||||||
|
(
|
||||||
|
block_id,
|
||||||
|
frame_in_block,
|
||||||
|
MediaHeader::encode_fec_ratio(current_profile.fec_ratio),
|
||||||
|
)
|
||||||
|
};
|
||||||
|
|
||||||
// Build source packet
|
// Build source packet
|
||||||
let s = seq.fetch_add(1, Ordering::Relaxed);
|
let s = seq.fetch_add(1, Ordering::Relaxed);
|
||||||
let t = ts.fetch_add(frame_samples as u32, Ordering::Relaxed);
|
let t = ts.fetch_add(frame_samples as u32, Ordering::Relaxed);
|
||||||
@@ -526,11 +693,11 @@ async fn run_call(
|
|||||||
is_repair: false,
|
is_repair: false,
|
||||||
codec_id: current_profile.codec,
|
codec_id: current_profile.codec,
|
||||||
has_quality_report: false,
|
has_quality_report: false,
|
||||||
fec_ratio_encoded: MediaHeader::encode_fec_ratio(current_profile.fec_ratio),
|
fec_ratio_encoded: hdr_fec_ratio,
|
||||||
seq: s,
|
seq: s,
|
||||||
timestamp: t,
|
timestamp: t,
|
||||||
fec_block: block_id,
|
fec_block: hdr_fec_block,
|
||||||
fec_symbol: frame_in_block,
|
fec_symbol: hdr_fec_symbol,
|
||||||
reserved: 0,
|
reserved: 0,
|
||||||
csrc_count: 0,
|
csrc_count: 0,
|
||||||
},
|
},
|
||||||
@@ -560,14 +727,16 @@ async fn run_call(
|
|||||||
t_send_us += t0.elapsed().as_micros() as u64;
|
t_send_us += t0.elapsed().as_micros() as u64;
|
||||||
frames_sent += 1;
|
frames_sent += 1;
|
||||||
|
|
||||||
// Feed encoded frame to FEC encoder
|
// Codec2-only: feed RaptorQ and emit repair packets when the
|
||||||
|
// block is full. Opus tiers skip this entire block — DRED
|
||||||
|
// (enabled in Phase 1) provides codec-layer loss recovery.
|
||||||
let t0 = Instant::now();
|
let t0 = Instant::now();
|
||||||
|
if !is_opus {
|
||||||
if let Err(e) = fec_enc.add_source_symbol(encoded) {
|
if let Err(e) = fec_enc.add_source_symbol(encoded) {
|
||||||
warn!("fec add_source error: {e}");
|
warn!("fec add_source error: {e}");
|
||||||
}
|
}
|
||||||
frame_in_block += 1;
|
frame_in_block += 1;
|
||||||
|
|
||||||
// When block is full, generate repair packets
|
|
||||||
if frame_in_block >= current_profile.frames_per_block {
|
if frame_in_block >= current_profile.frames_per_block {
|
||||||
match fec_enc.generate_repair(current_profile.fec_ratio) {
|
match fec_enc.generate_repair(current_profile.fec_ratio) {
|
||||||
Ok(repairs) => {
|
Ok(repairs) => {
|
||||||
@@ -618,6 +787,7 @@ async fn run_call(
|
|||||||
block_id = block_id.wrapping_add(1);
|
block_id = block_id.wrapping_add(1);
|
||||||
frame_in_block = 0;
|
frame_in_block = 0;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
t_fec_us += t0.elapsed().as_micros() as u64;
|
t_fec_us += t0.elapsed().as_micros() as u64;
|
||||||
t_frames += 1;
|
t_frames += 1;
|
||||||
|
|
||||||
@@ -659,7 +829,27 @@ async fn run_call(
|
|||||||
let mut last_stats_log = Instant::now();
|
let mut last_stats_log = Instant::now();
|
||||||
let mut quality_ctrl = AdaptiveQualityController::new();
|
let mut quality_ctrl = AdaptiveQualityController::new();
|
||||||
let mut last_peer_codec: Option<CodecId> = None;
|
let mut last_peer_codec: Option<CodecId> = None;
|
||||||
info!("recv task started (Opus + RaptorQ FEC)");
|
|
||||||
|
// Phase 3c: DRED reconstruction state. Unlike the desktop
|
||||||
|
// CallDecoder (which sits behind a jitter buffer that emits
|
||||||
|
// Missing signals), engine.rs reads packets directly from the
|
||||||
|
// transport and decodes straight into the playout ring. Gap
|
||||||
|
// detection is therefore done via sequence-number tracking:
|
||||||
|
// when a packet arrives with seq > expected_seq, the frames in
|
||||||
|
// between are missing and we attempt to reconstruct them via
|
||||||
|
// DRED before decoding the newly-arrived packet.
|
||||||
|
let mut dred_decoder =
|
||||||
|
DredDecoderHandle::new().expect("opus_dred_decoder_create failed");
|
||||||
|
let mut dred_parse_scratch =
|
||||||
|
DredState::new().expect("opus_dred_alloc failed (scratch)");
|
||||||
|
let mut last_good_dred =
|
||||||
|
DredState::new().expect("opus_dred_alloc failed (good state)");
|
||||||
|
let mut last_good_dred_seq: Option<u16> = None;
|
||||||
|
let mut expected_seq: Option<u16> = None;
|
||||||
|
let mut dred_reconstructions: u64 = 0;
|
||||||
|
let mut classical_plc_invocations: u64 = 0;
|
||||||
|
|
||||||
|
info!("recv task started (Opus + DRED + Codec2/RaptorQ)");
|
||||||
loop {
|
loop {
|
||||||
if !state.running.load(Ordering::Relaxed) {
|
if !state.running.load(Ordering::Relaxed) {
|
||||||
break;
|
break;
|
||||||
@@ -701,14 +891,21 @@ async fn run_call(
|
|||||||
let is_repair = pkt.header.is_repair;
|
let is_repair = pkt.header.is_repair;
|
||||||
let pkt_block = pkt.header.fec_block;
|
let pkt_block = pkt.header.fec_block;
|
||||||
let pkt_symbol = pkt.header.fec_symbol;
|
let pkt_symbol = pkt.header.fec_symbol;
|
||||||
|
let pkt_is_opus = pkt.header.codec_id.is_opus();
|
||||||
|
|
||||||
// Feed every packet (source + repair) to FEC decoder
|
// Phase 2: Opus packets bypass RaptorQ entirely — DRED
|
||||||
|
// (enabled Phase 1) handles codec-layer loss recovery,
|
||||||
|
// and feeding these symbols into the RaptorQ decoder
|
||||||
|
// would accumulate block_id=0 duplicates that never
|
||||||
|
// decode. Codec2 packets still feed RaptorQ.
|
||||||
|
if !pkt_is_opus {
|
||||||
let _ = fec_dec.add_symbol(
|
let _ = fec_dec.add_symbol(
|
||||||
pkt_block,
|
pkt_block,
|
||||||
pkt_symbol,
|
pkt_symbol,
|
||||||
is_repair,
|
is_repair,
|
||||||
&pkt.payload,
|
&pkt.payload,
|
||||||
);
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// Source packets: decode directly
|
// Source packets: decode directly
|
||||||
if !is_repair && pkt.header.codec_id != CodecId::ComfortNoise {
|
if !is_repair && pkt.header.codec_id != CodecId::ComfortNoise {
|
||||||
@@ -731,6 +928,13 @@ async fn run_call(
|
|||||||
};
|
};
|
||||||
info!(from = ?decoder.codec_id(), to = ?pkt.header.codec_id, "recv: switching decoder");
|
info!(from = ?decoder.codec_id(), to = ?pkt.header.codec_id, "recv: switching decoder");
|
||||||
let _ = decoder.set_profile(switch_profile);
|
let _ = decoder.set_profile(switch_profile);
|
||||||
|
// Profile switch invalidates the cached DRED
|
||||||
|
// state because samples_available is measured
|
||||||
|
// in the old profile's sample rate. Reset the
|
||||||
|
// tracking so we don't try to reconstruct with
|
||||||
|
// stale offsets.
|
||||||
|
last_good_dred_seq = None;
|
||||||
|
expected_seq = None;
|
||||||
}
|
}
|
||||||
// Track peer codec for UI display
|
// Track peer codec for UI display
|
||||||
if last_peer_codec != Some(pkt.header.codec_id) {
|
if last_peer_codec != Some(pkt.header.codec_id) {
|
||||||
@@ -739,6 +943,109 @@ async fn run_call(
|
|||||||
stats.peer_codec = format!("{:?}", pkt.header.codec_id);
|
stats.peer_codec = format!("{:?}", pkt.header.codec_id);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Phase 3c: Opus path — parse DRED state out of
|
||||||
|
// the current packet FIRST so last_good_dred
|
||||||
|
// reflects the freshest available reconstruction
|
||||||
|
// source, then attempt gap recovery against it
|
||||||
|
// BEFORE decoding this packet's audio. Ordering
|
||||||
|
// matters because the playout ring is FIFO — gap
|
||||||
|
// samples must be written before this packet's
|
||||||
|
// samples, which come next.
|
||||||
|
if pkt_is_opus {
|
||||||
|
// Update DRED state from the current packet.
|
||||||
|
match dred_decoder.parse_into(&mut dred_parse_scratch, &pkt.payload) {
|
||||||
|
Ok(available) if available > 0 => {
|
||||||
|
std::mem::swap(
|
||||||
|
&mut dred_parse_scratch,
|
||||||
|
&mut last_good_dred,
|
||||||
|
);
|
||||||
|
last_good_dred_seq = Some(pkt.header.seq);
|
||||||
|
}
|
||||||
|
Ok(_) => {
|
||||||
|
// Packet carried no DRED — keep cached state.
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
debug!("DRED parse error (ignored): {e}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Detect and fill gap from last-expected to this packet.
|
||||||
|
const MAX_GAP_FRAMES: u16 = 16;
|
||||||
|
if let Some(expected) = expected_seq {
|
||||||
|
let gap = pkt.header.seq.wrapping_sub(expected);
|
||||||
|
if gap > 0 && gap <= MAX_GAP_FRAMES {
|
||||||
|
let current_profile_frame_samples =
|
||||||
|
(48_000 * profile.frame_duration_ms as i32) / 1000;
|
||||||
|
let available = last_good_dred.samples_available();
|
||||||
|
let pcm_slice_len =
|
||||||
|
current_profile_frame_samples as usize;
|
||||||
|
|
||||||
|
for gap_idx in 0..gap {
|
||||||
|
let missing_seq = expected.wrapping_add(gap_idx);
|
||||||
|
// Offset from the DRED anchor (last_good_dred_seq)
|
||||||
|
// back to the missing seq, in samples. Skip if
|
||||||
|
// the anchor is not ahead of missing (defensive).
|
||||||
|
let offset_samples = match last_good_dred_seq {
|
||||||
|
Some(anchor) => {
|
||||||
|
let delta = anchor.wrapping_sub(missing_seq);
|
||||||
|
if delta == 0 || delta > MAX_GAP_FRAMES {
|
||||||
|
-1 // skip DRED, use PLC
|
||||||
|
} else {
|
||||||
|
delta as i32 * current_profile_frame_samples
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => -1,
|
||||||
|
};
|
||||||
|
|
||||||
|
let reconstructed = if offset_samples > 0
|
||||||
|
&& offset_samples <= available
|
||||||
|
{
|
||||||
|
decoder
|
||||||
|
.reconstruct_from_dred(
|
||||||
|
&last_good_dred,
|
||||||
|
offset_samples,
|
||||||
|
&mut decode_buf[..pcm_slice_len],
|
||||||
|
)
|
||||||
|
.ok()
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
|
||||||
|
match reconstructed {
|
||||||
|
Some(samples) => {
|
||||||
|
playout_agc.process_frame(
|
||||||
|
&mut decode_buf[..samples],
|
||||||
|
);
|
||||||
|
state
|
||||||
|
.playout_ring
|
||||||
|
.write(&decode_buf[..samples]);
|
||||||
|
dred_reconstructions += 1;
|
||||||
|
frames_decoded += 1;
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
// Fall through to classical PLC.
|
||||||
|
if let Ok(samples) =
|
||||||
|
decoder.decode_lost(&mut decode_buf)
|
||||||
|
{
|
||||||
|
playout_agc
|
||||||
|
.process_frame(&mut decode_buf[..samples]);
|
||||||
|
state
|
||||||
|
.playout_ring
|
||||||
|
.write(&decode_buf[..samples]);
|
||||||
|
classical_plc_invocations += 1;
|
||||||
|
frames_decoded += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Advance the expected-seq tracker for the next arrival.
|
||||||
|
expected_seq = Some(pkt.header.seq.wrapping_add(1));
|
||||||
|
}
|
||||||
|
|
||||||
match decoder.decode(&pkt.payload, &mut decode_buf) {
|
match decoder.decode(&pkt.payload, &mut decode_buf) {
|
||||||
Ok(samples) => {
|
Ok(samples) => {
|
||||||
playout_agc.process_frame(&mut decode_buf[..samples]);
|
playout_agc.process_frame(&mut decode_buf[..samples]);
|
||||||
@@ -750,12 +1057,21 @@ async fn run_call(
|
|||||||
if let Ok(samples) = decoder.decode_lost(&mut decode_buf) {
|
if let Ok(samples) = decoder.decode_lost(&mut decode_buf) {
|
||||||
playout_agc.process_frame(&mut decode_buf[..samples]);
|
playout_agc.process_frame(&mut decode_buf[..samples]);
|
||||||
state.playout_ring.write(&decode_buf[..samples]);
|
state.playout_ring.write(&decode_buf[..samples]);
|
||||||
|
// This is a decode-error fallback (not a
|
||||||
|
// detected gap), so count it as PLC.
|
||||||
|
classical_plc_invocations += 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Try FEC recovery
|
// Codec2-only: try FEC recovery and expire old blocks.
|
||||||
|
// Opus packets skip both — the Phase 2 Opus path has no
|
||||||
|
// RaptorQ state to query or clean up. The `fec_recovered`
|
||||||
|
// counter is now effectively Codec2-only, which is
|
||||||
|
// correct because DRED reconstructions will be counted
|
||||||
|
// separately once Phase 3 lands (new telemetry field).
|
||||||
|
if !pkt_is_opus {
|
||||||
if let Ok(Some(recovered_frames)) = fec_dec.try_decode(pkt_block) {
|
if let Ok(Some(recovered_frames)) = fec_dec.try_decode(pkt_block) {
|
||||||
fec_recovered += recovered_frames.len() as u64;
|
fec_recovered += recovered_frames.len() as u64;
|
||||||
if fec_recovered % 50 == 1 {
|
if fec_recovered % 50 == 1 {
|
||||||
@@ -772,10 +1088,13 @@ async fn run_call(
|
|||||||
if pkt_block > 3 {
|
if pkt_block > 3 {
|
||||||
fec_dec.expire_before(pkt_block.wrapping_sub(3));
|
fec_dec.expire_before(pkt_block.wrapping_sub(3));
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let mut stats = state.stats.lock().unwrap();
|
let mut stats = state.stats.lock().unwrap();
|
||||||
stats.frames_decoded = frames_decoded;
|
stats.frames_decoded = frames_decoded;
|
||||||
stats.fec_recovered = fec_recovered;
|
stats.fec_recovered = fec_recovered;
|
||||||
|
stats.dred_reconstructions = dred_reconstructions;
|
||||||
|
stats.classical_plc_invocations = classical_plc_invocations;
|
||||||
drop(stats);
|
drop(stats);
|
||||||
|
|
||||||
// Periodic stats every 5 seconds
|
// Periodic stats every 5 seconds
|
||||||
@@ -783,6 +1102,8 @@ async fn run_call(
|
|||||||
info!(
|
info!(
|
||||||
frames_decoded,
|
frames_decoded,
|
||||||
fec_recovered,
|
fec_recovered,
|
||||||
|
dred_reconstructions,
|
||||||
|
classical_plc_invocations,
|
||||||
recv_errors,
|
recv_errors,
|
||||||
max_recv_gap_ms,
|
max_recv_gap_ms,
|
||||||
playout_avail = state.playout_ring.available(),
|
playout_avail = state.playout_ring.available(),
|
||||||
|
|||||||
@@ -77,9 +77,6 @@ pub unsafe extern "system" fn Java_com_wzp_engine_WzpEngine_nativeInit(
|
|||||||
) -> jlong {
|
) -> jlong {
|
||||||
let result = panic::catch_unwind(|| {
|
let result = panic::catch_unwind(|| {
|
||||||
init_logging();
|
init_logging();
|
||||||
// Install rustls crypto provider ONCE on the main thread.
|
|
||||||
// Must not be called per-thread — conflicts with Android's system libcrypto.so TLS keys.
|
|
||||||
let _ = rustls::crypto::ring::default_provider().install_default();
|
|
||||||
let handle = Box::new(EngineHandle {
|
let handle = Box::new(EngineHandle {
|
||||||
engine: WzpEngine::new(),
|
engine: WzpEngine::new(),
|
||||||
});
|
});
|
||||||
@@ -363,149 +360,88 @@ pub unsafe extern "system" fn Java_com_wzp_engine_WzpEngine_nativePingRelay<'a>(
|
|||||||
.unwrap_or(JObject::null().into_raw())
|
.unwrap_or(JObject::null().into_raw())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get the identity fingerprint for a seed hex string.
|
|
||||||
/// Returns the full fingerprint (xxxx:xxxx:...) or empty string on error.
|
|
||||||
#[unsafe(no_mangle)]
|
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_WzpEngine_nativeGetFingerprint<'a>(
|
|
||||||
mut env: JNIEnv<'a>,
|
|
||||||
_class: JClass,
|
|
||||||
seed_hex_j: JString,
|
|
||||||
) -> jstring {
|
|
||||||
let seed_hex: String = env.get_string(&seed_hex_j).map(|s| s.into()).unwrap_or_default();
|
|
||||||
let fp = if seed_hex.is_empty() {
|
|
||||||
String::new()
|
|
||||||
} else {
|
|
||||||
match wzp_crypto::Seed::from_hex(&seed_hex) {
|
|
||||||
Ok(seed) => {
|
|
||||||
let id = seed.derive_identity();
|
|
||||||
id.public_identity().fingerprint.to_string()
|
|
||||||
}
|
|
||||||
Err(_) => String::new(),
|
|
||||||
}
|
|
||||||
};
|
|
||||||
env.new_string(&fp)
|
|
||||||
.map(|s| s.into_raw())
|
|
||||||
.unwrap_or(JObject::null().into_raw())
|
|
||||||
}
|
|
||||||
|
|
||||||
// ── Direct calling JNI functions ──
|
// ── Direct calling JNI functions ──
|
||||||
|
|
||||||
// ── SignalManager JNI functions ──
|
/// Start persistent signaling connection to relay for direct calls.
|
||||||
|
/// Returns 0 on success, -1 on error.
|
||||||
/// Opaque handle for SignalManager (separate from EngineHandle).
|
|
||||||
struct SignalHandle {
|
|
||||||
mgr: crate::signal_mgr::SignalManager,
|
|
||||||
}
|
|
||||||
|
|
||||||
unsafe fn signal_ref(handle: jlong) -> &'static SignalHandle {
|
|
||||||
unsafe { &*(handle as *const SignalHandle) }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Connect to relay for signaling. Returns handle (jlong) or 0 on error.
|
|
||||||
/// Blocks up to 10s waiting for the internal signal thread to connect.
|
|
||||||
#[unsafe(no_mangle)]
|
#[unsafe(no_mangle)]
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_SignalManager_nativeSignalConnect<'a>(
|
pub unsafe extern "system" fn Java_com_wzp_engine_WzpEngine_nativeStartSignaling<'a>(
|
||||||
mut env: JNIEnv<'a>,
|
|
||||||
_class: JClass,
|
|
||||||
relay_j: JString,
|
|
||||||
seed_j: JString,
|
|
||||||
) -> jlong {
|
|
||||||
info!("nativeSignalConnect: entered");
|
|
||||||
let relay: String = env.get_string(&relay_j).map(|s| s.into()).unwrap_or_default();
|
|
||||||
let seed: String = env.get_string(&seed_j).map(|s| s.into()).unwrap_or_default();
|
|
||||||
info!(relay = %relay, seed_len = seed.len(), "nativeSignalConnect: parsed strings");
|
|
||||||
|
|
||||||
// start() spawns an internal thread (connect+register+recv, ONE runtime, never dropped).
|
|
||||||
// Blocks up to 10s waiting for the connect+register to complete.
|
|
||||||
match crate::signal_mgr::SignalManager::start(&relay, &seed) {
|
|
||||||
Ok(mgr) => {
|
|
||||||
let handle = Box::new(SignalHandle { mgr });
|
|
||||||
Box::into_raw(handle) as jlong
|
|
||||||
}
|
|
||||||
Err(e) => {
|
|
||||||
error!("signal connect failed: {e}");
|
|
||||||
0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Get signal state as JSON string.
|
|
||||||
#[unsafe(no_mangle)]
|
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_SignalManager_nativeSignalGetState<'a>(
|
|
||||||
mut env: JNIEnv<'a>,
|
mut env: JNIEnv<'a>,
|
||||||
_class: JClass,
|
_class: JClass,
|
||||||
handle: jlong,
|
handle: jlong,
|
||||||
) -> jstring {
|
relay_addr_j: JString,
|
||||||
if handle == 0 { return JObject::null().into_raw(); }
|
seed_hex_j: JString,
|
||||||
let h = signal_ref(handle);
|
token_j: JString,
|
||||||
let json = h.mgr.get_state_json();
|
alias_j: JString,
|
||||||
env.new_string(&json)
|
|
||||||
.map(|s| s.into_raw())
|
|
||||||
.unwrap_or(JObject::null().into_raw())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Place a direct call.
|
|
||||||
#[unsafe(no_mangle)]
|
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_SignalManager_nativeSignalPlaceCall<'a>(
|
|
||||||
mut env: JNIEnv<'a>,
|
|
||||||
_class: JClass,
|
|
||||||
handle: jlong,
|
|
||||||
target_j: JString,
|
|
||||||
) -> jint {
|
) -> jint {
|
||||||
if handle == 0 { return -1; }
|
let result = panic::catch_unwind(panic::AssertUnwindSafe(|| {
|
||||||
let h = signal_ref(handle);
|
let h = unsafe { handle_ref(handle) };
|
||||||
let target: String = env.get_string(&target_j).map(|s| s.into()).unwrap_or_default();
|
let relay_addr: String = env.get_string(&relay_addr_j).map(|s| s.into()).unwrap_or_default();
|
||||||
match h.mgr.place_call(&target) {
|
let seed_hex: String = env.get_string(&seed_hex_j).map(|s| s.into()).unwrap_or_default();
|
||||||
Ok(()) => 0,
|
let token: String = env.get_string(&token_j).map(|s| s.into()).unwrap_or_default();
|
||||||
Err(e) => { error!("place_call: {e}"); -1 }
|
let alias: String = env.get_string(&alias_j).map(|s| s.into()).unwrap_or_default();
|
||||||
|
|
||||||
|
h.engine.start_signaling(
|
||||||
|
&relay_addr,
|
||||||
|
&seed_hex,
|
||||||
|
if token.is_empty() { None } else { Some(&token) },
|
||||||
|
if alias.is_empty() { None } else { Some(&alias) },
|
||||||
|
)
|
||||||
|
}));
|
||||||
|
|
||||||
|
match result {
|
||||||
|
Ok(Ok(())) => 0,
|
||||||
|
Ok(Err(e)) => { error!("start_signaling failed: {e}"); -1 }
|
||||||
|
Err(_) => { error!("start_signaling panicked"); -1 }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Answer an incoming call.
|
/// Place a direct call to a target fingerprint.
|
||||||
|
/// Returns 0 on success, -1 on error.
|
||||||
#[unsafe(no_mangle)]
|
#[unsafe(no_mangle)]
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_SignalManager_nativeSignalAnswerCall<'a>(
|
pub unsafe extern "system" fn Java_com_wzp_engine_WzpEngine_nativePlaceCall<'a>(
|
||||||
|
mut env: JNIEnv<'a>,
|
||||||
|
_class: JClass,
|
||||||
|
handle: jlong,
|
||||||
|
target_fp_j: JString,
|
||||||
|
) -> jint {
|
||||||
|
let result = panic::catch_unwind(panic::AssertUnwindSafe(|| {
|
||||||
|
let h = unsafe { handle_ref(handle) };
|
||||||
|
let target: String = env.get_string(&target_fp_j).map(|s| s.into()).unwrap_or_default();
|
||||||
|
h.engine.place_call(&target)
|
||||||
|
}));
|
||||||
|
|
||||||
|
match result {
|
||||||
|
Ok(Ok(())) => 0,
|
||||||
|
Ok(Err(e)) => { error!("place_call failed: {e}"); -1 }
|
||||||
|
Err(_) => { error!("place_call panicked"); -1 }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Answer an incoming direct call.
|
||||||
|
/// mode: 0=Reject, 1=AcceptTrusted, 2=AcceptGeneric
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub unsafe extern "system" fn Java_com_wzp_engine_WzpEngine_nativeAnswerCall<'a>(
|
||||||
mut env: JNIEnv<'a>,
|
mut env: JNIEnv<'a>,
|
||||||
_class: JClass,
|
_class: JClass,
|
||||||
handle: jlong,
|
handle: jlong,
|
||||||
call_id_j: JString,
|
call_id_j: JString,
|
||||||
mode: jint,
|
mode: jint,
|
||||||
) -> jint {
|
) -> jint {
|
||||||
if handle == 0 { return -1; }
|
let result = panic::catch_unwind(panic::AssertUnwindSafe(|| {
|
||||||
let h = signal_ref(handle);
|
let h = unsafe { handle_ref(handle) };
|
||||||
let call_id: String = env.get_string(&call_id_j).map(|s| s.into()).unwrap_or_default();
|
let call_id: String = env.get_string(&call_id_j).map(|s| s.into()).unwrap_or_default();
|
||||||
let accept_mode = match mode {
|
let accept_mode = match mode {
|
||||||
0 => wzp_proto::CallAcceptMode::Reject,
|
0 => wzp_proto::CallAcceptMode::Reject,
|
||||||
1 => wzp_proto::CallAcceptMode::AcceptTrusted,
|
1 => wzp_proto::CallAcceptMode::AcceptTrusted,
|
||||||
_ => wzp_proto::CallAcceptMode::AcceptGeneric,
|
_ => wzp_proto::CallAcceptMode::AcceptGeneric,
|
||||||
};
|
};
|
||||||
match h.mgr.answer_call(&call_id, accept_mode) {
|
h.engine.answer_call(&call_id, accept_mode)
|
||||||
Ok(()) => 0,
|
}));
|
||||||
Err(e) => { error!("answer_call: {e}"); -1 }
|
|
||||||
|
match result {
|
||||||
|
Ok(Ok(())) => 0,
|
||||||
|
Ok(Err(e)) => { error!("answer_call failed: {e}"); -1 }
|
||||||
|
Err(_) => { error!("answer_call panicked"); -1 }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Send hangup signal.
|
|
||||||
#[unsafe(no_mangle)]
|
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_SignalManager_nativeSignalHangup(
|
|
||||||
_env: JNIEnv,
|
|
||||||
_class: JClass,
|
|
||||||
handle: jlong,
|
|
||||||
) {
|
|
||||||
if handle == 0 { return; }
|
|
||||||
let h = signal_ref(handle);
|
|
||||||
h.mgr.hangup();
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Destroy the signal manager and free resources.
|
|
||||||
#[unsafe(no_mangle)]
|
|
||||||
pub unsafe extern "system" fn Java_com_wzp_engine_SignalManager_nativeSignalDestroy(
|
|
||||||
_env: JNIEnv,
|
|
||||||
_class: JClass,
|
|
||||||
handle: jlong,
|
|
||||||
) {
|
|
||||||
if handle == 0 { return; }
|
|
||||||
let h = signal_ref(handle);
|
|
||||||
h.mgr.stop();
|
|
||||||
// Reclaim the Box
|
|
||||||
let _ = unsafe { Box::from_raw(handle as *mut SignalHandle) };
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -8,12 +8,24 @@
|
|||||||
//!
|
//!
|
||||||
//! On non-Android targets, the Oboe C++ layer compiles as a stub,
|
//! On non-Android targets, the Oboe C++ layer compiles as a stub,
|
||||||
//! allowing `cargo check` and unit tests on the host.
|
//! allowing `cargo check` and unit tests on the host.
|
||||||
|
//!
|
||||||
|
//! ## Status
|
||||||
|
//!
|
||||||
|
//! **Dead code as of the Tauri mobile rewrite.** The legacy Kotlin+JNI
|
||||||
|
//! Android app that consumed this crate was replaced by a Tauri 2.x
|
||||||
|
//! Mobile app (see `desktop/src-tauri/src/engine.rs` for the live
|
||||||
|
//! Android audio recv path and `crates/wzp-native/` for the Oboe
|
||||||
|
//! bridge). We keep this crate in the workspace for reference and to
|
||||||
|
//! preserve the commit history, but it is not built by any shipping
|
||||||
|
//! target. Allow the accumulated leftover warnings so CI/workspace
|
||||||
|
//! checks stay clean — any real cleanup should happen as part of
|
||||||
|
//! removing the crate entirely, not piecemeal.
|
||||||
|
#![allow(dead_code, unused_imports, unused_variables, unused_mut)]
|
||||||
|
|
||||||
pub mod audio_android;
|
pub mod audio_android;
|
||||||
pub mod audio_ring;
|
pub mod audio_ring;
|
||||||
pub mod commands;
|
pub mod commands;
|
||||||
pub mod engine;
|
pub mod engine;
|
||||||
pub mod pipeline;
|
pub mod pipeline;
|
||||||
pub mod signal_mgr;
|
|
||||||
pub mod stats;
|
pub mod stats;
|
||||||
pub mod jni_bridge;
|
pub mod jni_bridge;
|
||||||
|
|||||||
@@ -1,288 +0,0 @@
|
|||||||
//! Persistent signal connection manager for direct 1:1 calls.
|
|
||||||
//!
|
|
||||||
//! Separate from the media engine — survives across calls.
|
|
||||||
//! Connects to relay via `_signal` SNI, registers presence,
|
|
||||||
//! and handles call signaling (offer/answer/setup/hangup).
|
|
||||||
|
|
||||||
use std::net::SocketAddr;
|
|
||||||
use std::sync::atomic::{AtomicBool, Ordering};
|
|
||||||
use std::sync::{Arc, Mutex};
|
|
||||||
|
|
||||||
use tracing::{error, info, warn};
|
|
||||||
use wzp_proto::{MediaTransport, SignalMessage};
|
|
||||||
|
|
||||||
/// Signal connection status.
|
|
||||||
#[derive(Clone, Debug, Default, serde::Serialize)]
|
|
||||||
pub struct SignalState {
|
|
||||||
pub status: String, // "idle", "registered", "ringing", "incoming", "setup"
|
|
||||||
pub fingerprint: String,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub incoming_call_id: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub incoming_caller_fp: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub incoming_caller_alias: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub call_setup_relay: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub call_setup_room: Option<String>,
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub call_setup_id: Option<String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Manages a persistent `_signal` QUIC connection to a relay.
|
|
||||||
pub struct SignalManager {
|
|
||||||
transport: Arc<wzp_transport::QuinnTransport>,
|
|
||||||
state: Arc<Mutex<SignalState>>,
|
|
||||||
running: Arc<AtomicBool>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl SignalManager {
|
|
||||||
/// Create SignalManager and start connect+register+recv on a background thread.
|
|
||||||
/// Returns immediately. The internal thread runs forever.
|
|
||||||
/// CRITICAL: tokio runtime must never be dropped on Android (libcrypto TLS conflict).
|
|
||||||
pub fn start(relay_addr: &str, seed_hex: &str) -> Result<Self, anyhow::Error> {
|
|
||||||
let addr: SocketAddr = relay_addr.parse()?;
|
|
||||||
let seed = if seed_hex.is_empty() {
|
|
||||||
wzp_crypto::Seed::generate()
|
|
||||||
} else {
|
|
||||||
wzp_crypto::Seed::from_hex(seed_hex).map_err(|e| anyhow::anyhow!(e))?
|
|
||||||
};
|
|
||||||
let identity = seed.derive_identity();
|
|
||||||
let pub_id = identity.public_identity();
|
|
||||||
let identity_pub = *pub_id.signing.as_bytes();
|
|
||||||
let fp = pub_id.fingerprint.to_string();
|
|
||||||
|
|
||||||
let state = Arc::new(Mutex::new(SignalState {
|
|
||||||
status: "connecting".into(),
|
|
||||||
fingerprint: fp.clone(),
|
|
||||||
..Default::default()
|
|
||||||
}));
|
|
||||||
let running = Arc::new(AtomicBool::new(true));
|
|
||||||
|
|
||||||
// Channel to receive transport after connect succeeds
|
|
||||||
let (transport_tx, transport_rx) = std::sync::mpsc::channel();
|
|
||||||
|
|
||||||
let bg_state = Arc::clone(&state);
|
|
||||||
let bg_running = Arc::clone(&running);
|
|
||||||
let ret_state = Arc::clone(&state);
|
|
||||||
let ret_running = Arc::clone(&running);
|
|
||||||
|
|
||||||
// ONE thread, ONE runtime, NEVER dropped.
|
|
||||||
// Connect + register + recv loop all happen here.
|
|
||||||
std::thread::Builder::new()
|
|
||||||
.name("wzp-signal".into())
|
|
||||||
.stack_size(4 * 1024 * 1024)
|
|
||||||
.spawn(move || {
|
|
||||||
let rt = tokio::runtime::Builder::new_current_thread()
|
|
||||||
.enable_all()
|
|
||||||
.build()
|
|
||||||
.expect("tokio runtime");
|
|
||||||
|
|
||||||
rt.block_on(async move {
|
|
||||||
info!(fingerprint = %fp, relay = %addr, "signal: connecting");
|
|
||||||
|
|
||||||
let bind: SocketAddr = "0.0.0.0:0".parse().unwrap();
|
|
||||||
let endpoint = match wzp_transport::create_endpoint(bind, None) {
|
|
||||||
Ok(e) => e,
|
|
||||||
Err(e) => {
|
|
||||||
error!("signal endpoint: {e}");
|
|
||||||
bg_state.lock().unwrap().status = "idle".into();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
let client_cfg = wzp_transport::client_config();
|
|
||||||
let conn = match wzp_transport::connect(&endpoint, addr, "_signal", client_cfg).await {
|
|
||||||
Ok(c) => c,
|
|
||||||
Err(e) => {
|
|
||||||
error!("signal connect: {e}");
|
|
||||||
bg_state.lock().unwrap().status = "idle".into();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
let transport = Arc::new(wzp_transport::QuinnTransport::new(conn));
|
|
||||||
|
|
||||||
// Register
|
|
||||||
if let Err(e) = transport.send_signal(&SignalMessage::RegisterPresence {
|
|
||||||
identity_pub, signature: vec![], alias: None,
|
|
||||||
}).await {
|
|
||||||
error!("signal register: {e}");
|
|
||||||
bg_state.lock().unwrap().status = "idle".into();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
match transport.recv_signal().await {
|
|
||||||
Ok(Some(SignalMessage::RegisterPresenceAck { success: true, .. })) => {
|
|
||||||
info!(fingerprint = %fp, "signal: registered");
|
|
||||||
bg_state.lock().unwrap().status = "registered".into();
|
|
||||||
// Send transport to caller
|
|
||||||
let _ = transport_tx.send(transport.clone());
|
|
||||||
}
|
|
||||||
other => {
|
|
||||||
error!("signal registration failed: {other:?}");
|
|
||||||
bg_state.lock().unwrap().status = "idle".into();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Recv loop — runs forever
|
|
||||||
loop {
|
|
||||||
if !running.load(Ordering::Relaxed) { break; }
|
|
||||||
|
|
||||||
match transport.recv_signal().await {
|
|
||||||
Ok(Some(SignalMessage::CallRinging { call_id })) => {
|
|
||||||
info!(call_id = %call_id, "signal: ringing");
|
|
||||||
let mut s = state.lock().unwrap();
|
|
||||||
s.status = "ringing".into();
|
|
||||||
}
|
|
||||||
Ok(Some(SignalMessage::DirectCallOffer { caller_fingerprint, caller_alias, call_id, .. })) => {
|
|
||||||
info!(from = %caller_fingerprint, call_id = %call_id, "signal: incoming call");
|
|
||||||
let mut s = state.lock().unwrap();
|
|
||||||
s.status = "incoming".into();
|
|
||||||
s.incoming_call_id = Some(call_id);
|
|
||||||
s.incoming_caller_fp = Some(caller_fingerprint);
|
|
||||||
s.incoming_caller_alias = caller_alias;
|
|
||||||
}
|
|
||||||
Ok(Some(SignalMessage::DirectCallAnswer { call_id, accept_mode, .. })) => {
|
|
||||||
info!(call_id = %call_id, mode = ?accept_mode, "signal: call answered");
|
|
||||||
}
|
|
||||||
Ok(Some(SignalMessage::CallSetup { call_id, room, relay_addr })) => {
|
|
||||||
info!(call_id = %call_id, room = %room, relay = %relay_addr, "signal: call setup");
|
|
||||||
let mut s = state.lock().unwrap();
|
|
||||||
s.status = "setup".into();
|
|
||||||
s.call_setup_relay = Some(relay_addr);
|
|
||||||
s.call_setup_room = Some(room);
|
|
||||||
s.call_setup_id = Some(call_id);
|
|
||||||
}
|
|
||||||
Ok(Some(SignalMessage::Hangup { reason })) => {
|
|
||||||
info!(reason = ?reason, "signal: hangup");
|
|
||||||
let mut s = state.lock().unwrap();
|
|
||||||
s.status = "registered".into();
|
|
||||||
s.incoming_call_id = None;
|
|
||||||
s.incoming_caller_fp = None;
|
|
||||||
s.incoming_caller_alias = None;
|
|
||||||
s.call_setup_relay = None;
|
|
||||||
s.call_setup_room = None;
|
|
||||||
s.call_setup_id = None;
|
|
||||||
}
|
|
||||||
Ok(Some(_)) => {}
|
|
||||||
Ok(None) => {
|
|
||||||
info!("signal: connection closed");
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
Err(e) => {
|
|
||||||
error!("signal recv error: {e}");
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
bg_state.lock().unwrap().status = "idle".into();
|
|
||||||
}); // block_on
|
|
||||||
|
|
||||||
// Runtime intentionally NOT dropped — lives until thread exits.
|
|
||||||
// This prevents ring/libcrypto TLS cleanup conflict on Android.
|
|
||||||
// The thread is parked here forever (block_on returned = connection lost).
|
|
||||||
std::thread::park();
|
|
||||||
})?; // thread spawn
|
|
||||||
|
|
||||||
// Wait for transport (up to 10s)
|
|
||||||
let transport = transport_rx.recv_timeout(std::time::Duration::from_secs(10))
|
|
||||||
.map_err(|_| anyhow::anyhow!("signal connect timeout — check relay address"))?;
|
|
||||||
|
|
||||||
Ok(Self { transport, state: ret_state, running: ret_running })
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Get current state (non-blocking).
|
|
||||||
pub fn get_state(&self) -> SignalState {
|
|
||||||
self.state.lock().unwrap().clone()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Get state as JSON string.
|
|
||||||
pub fn get_state_json(&self) -> String {
|
|
||||||
serde_json::to_string(&self.get_state()).unwrap_or_else(|_| "{}".into())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Place a direct call.
|
|
||||||
pub fn place_call(&self, target_fp: &str) -> Result<(), anyhow::Error> {
|
|
||||||
let fp = self.state.lock().unwrap().fingerprint.clone();
|
|
||||||
let target = target_fp.to_string();
|
|
||||||
let call_id = format!("{:016x}", std::time::SystemTime::now()
|
|
||||||
.duration_since(std::time::UNIX_EPOCH).unwrap().as_nanos());
|
|
||||||
let transport = self.transport.clone();
|
|
||||||
|
|
||||||
// Send on a small thread (async send needs a runtime)
|
|
||||||
std::thread::Builder::new()
|
|
||||||
.name("wzp-call-send".into())
|
|
||||||
.spawn(move || {
|
|
||||||
let rt = tokio::runtime::Builder::new_current_thread()
|
|
||||||
.enable_all().build().expect("rt");
|
|
||||||
rt.block_on(async {
|
|
||||||
let _ = transport.send_signal(&SignalMessage::DirectCallOffer {
|
|
||||||
caller_fingerprint: fp,
|
|
||||||
caller_alias: None,
|
|
||||||
target_fingerprint: target,
|
|
||||||
call_id,
|
|
||||||
identity_pub: [0u8; 32],
|
|
||||||
ephemeral_pub: [0u8; 32],
|
|
||||||
signature: vec![],
|
|
||||||
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
|
||||||
}).await;
|
|
||||||
});
|
|
||||||
})?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Answer an incoming call.
|
|
||||||
pub fn answer_call(&self, call_id: &str, mode: wzp_proto::CallAcceptMode) -> Result<(), anyhow::Error> {
|
|
||||||
let call_id = call_id.to_string();
|
|
||||||
let transport = self.transport.clone();
|
|
||||||
|
|
||||||
std::thread::Builder::new()
|
|
||||||
.name("wzp-answer-send".into())
|
|
||||||
.spawn(move || {
|
|
||||||
let rt = tokio::runtime::Builder::new_current_thread()
|
|
||||||
.enable_all().build().expect("rt");
|
|
||||||
rt.block_on(async {
|
|
||||||
let _ = transport.send_signal(&SignalMessage::DirectCallAnswer {
|
|
||||||
call_id,
|
|
||||||
accept_mode: mode,
|
|
||||||
identity_pub: None,
|
|
||||||
ephemeral_pub: None,
|
|
||||||
signature: None,
|
|
||||||
chosen_profile: Some(wzp_proto::QualityProfile::GOOD),
|
|
||||||
}).await;
|
|
||||||
});
|
|
||||||
})?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Send hangup.
|
|
||||||
pub fn hangup(&self) {
|
|
||||||
let transport = self.transport.clone();
|
|
||||||
let state = self.state.clone();
|
|
||||||
std::thread::spawn(move || {
|
|
||||||
let rt = tokio::runtime::Builder::new_current_thread()
|
|
||||||
.enable_all().build().expect("rt");
|
|
||||||
rt.block_on(async {
|
|
||||||
let _ = transport.send_signal(&SignalMessage::Hangup {
|
|
||||||
reason: wzp_proto::HangupReason::Normal,
|
|
||||||
}).await;
|
|
||||||
});
|
|
||||||
let mut s = state.lock().unwrap();
|
|
||||||
s.status = "registered".into();
|
|
||||||
s.incoming_call_id = None;
|
|
||||||
s.incoming_caller_fp = None;
|
|
||||||
s.incoming_caller_alias = None;
|
|
||||||
s.call_setup_relay = None;
|
|
||||||
s.call_setup_room = None;
|
|
||||||
s.call_setup_id = None;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Stop the signal connection.
|
|
||||||
pub fn stop(&self) {
|
|
||||||
self.running.store(false, Ordering::Release);
|
|
||||||
self.transport.connection().close(0u32.into(), b"shutdown");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -58,8 +58,16 @@ pub struct CallStats {
|
|||||||
pub frames_decoded: u64,
|
pub frames_decoded: u64,
|
||||||
/// Number of playout underruns (buffer empty when audio needed).
|
/// Number of playout underruns (buffer empty when audio needed).
|
||||||
pub underruns: u64,
|
pub underruns: u64,
|
||||||
/// Frames recovered by FEC.
|
/// Frames recovered by RaptorQ FEC (Codec2 tiers only; Opus bypasses
|
||||||
|
/// RaptorQ per Phase 2).
|
||||||
pub fec_recovered: u64,
|
pub fec_recovered: u64,
|
||||||
|
/// Phase 3c: Opus frames reconstructed via DRED side-channel data.
|
||||||
|
/// Only increments on the Opus tiers; always zero for Codec2.
|
||||||
|
pub dred_reconstructions: u64,
|
||||||
|
/// Phase 3c: Opus frames filled via classical Opus PLC because no DRED
|
||||||
|
/// state covered the gap, plus any decode-error fallbacks. Codec2 loss
|
||||||
|
/// also increments this counter via the Codec2 PLC path.
|
||||||
|
pub classical_plc_invocations: u64,
|
||||||
/// Playout ring overflow count (reader was lapped by writer).
|
/// Playout ring overflow count (reader was lapped by writer).
|
||||||
pub playout_overflows: u64,
|
pub playout_overflows: u64,
|
||||||
/// Playout ring underrun count (reader found empty buffer).
|
/// Playout ring underrun count (reader found empty buffer).
|
||||||
|
|||||||
@@ -23,10 +23,71 @@ serde_json = "1"
|
|||||||
chrono = "0.4"
|
chrono = "0.4"
|
||||||
rustls = { version = "0.23", default-features = false, features = ["ring", "std"] }
|
rustls = { version = "0.23", default-features = false, features = ["ring", "std"] }
|
||||||
cpal = { version = "0.15", optional = true }
|
cpal = { version = "0.15", optional = true }
|
||||||
|
libc = "0.2"
|
||||||
|
|
||||||
|
# coreaudio-rs is Apple-framework-only; gate it to macOS so enabling
|
||||||
|
# the `vpio` feature from a non-macOS target builds cleanly instead of
|
||||||
|
# pulling in a crate that can only link against Apple frameworks.
|
||||||
|
[target.'cfg(target_os = "macos")'.dependencies]
|
||||||
|
coreaudio-rs = { version = "0.11", optional = true }
|
||||||
|
|
||||||
|
# Windows-only: direct WASAPI bindings for the `windows-aec` feature.
|
||||||
|
# `windows` is Microsoft's official Rust COM bindings crate. We pull in
|
||||||
|
# only the audio + COM subfeatures we need — the crate is organized as
|
||||||
|
# a massive optional-feature tree, so enabling just these keeps compile
|
||||||
|
# times reasonable (~5s for these features vs ~60s for the full crate).
|
||||||
|
[target.'cfg(target_os = "windows")'.dependencies]
|
||||||
|
windows = { version = "0.58", optional = true, features = [
|
||||||
|
"Win32_Foundation",
|
||||||
|
"Win32_Media_Audio",
|
||||||
|
"Win32_Security",
|
||||||
|
"Win32_System_Com",
|
||||||
|
"Win32_System_Com_StructuredStorage",
|
||||||
|
"Win32_System_Threading",
|
||||||
|
"Win32_System_Variant",
|
||||||
|
] }
|
||||||
|
|
||||||
|
# Linux-only: WebRTC AEC (Audio Processing Module) bindings for the
|
||||||
|
# `linux-aec` feature. This is the 0.3.x line of the `tonarino/
|
||||||
|
# webrtc-audio-processing` crate, which links against Debian's
|
||||||
|
# `libwebrtc-audio-processing-dev` apt package (0.3-1+b1 on Bookworm).
|
||||||
|
#
|
||||||
|
# Note: we attempted the 2.x line with its `bundled` sub-feature first
|
||||||
|
# (which would give us AEC3 instead of AEC2), but both the crates.io
|
||||||
|
# tarball AND the upstream git `main` branch of webrtc-audio-processing-sys
|
||||||
|
# 2.0.3 hit a `meson setup --reconfigure` bug where the build.rs passes
|
||||||
|
# --reconfigure unconditionally even on first-run empty build dirs,
|
||||||
|
# causing the bundled build to fail with "Directory does not contain a
|
||||||
|
# valid build tree". The 0.x line doesn't use bundled mode and sidesteps
|
||||||
|
# this entirely by linking the apt-provided library. AEC2 is older than
|
||||||
|
# AEC3 but still the same algorithm family — this is what PulseAudio's
|
||||||
|
# module-echo-cancel and PipeWire's filter-chain use by default on
|
||||||
|
# current Debian-family distros.
|
||||||
|
[target.'cfg(target_os = "linux")'.dependencies]
|
||||||
|
webrtc-audio-processing = { version = "0.3", optional = true }
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = []
|
default = []
|
||||||
audio = ["cpal"]
|
audio = ["cpal"]
|
||||||
|
# vpio enables coreaudio-rs but that dep is itself gated to macOS above,
|
||||||
|
# so enabling this feature on Windows/Linux is a no-op (the audio_vpio
|
||||||
|
# module is also #[cfg(target_os = "macos")] in lib.rs).
|
||||||
|
vpio = ["dep:coreaudio-rs"]
|
||||||
|
# windows-aec enables a direct WASAPI capture backend that opens the
|
||||||
|
# microphone under AudioCategory_Communications, turning on Windows's
|
||||||
|
# OS-level communications audio processing (AEC + noise suppression +
|
||||||
|
# AGC). The `windows` dep is itself target-gated to Windows above, so
|
||||||
|
# enabling this feature on non-Windows targets is a no-op (the
|
||||||
|
# audio_wasapi module is also #[cfg(target_os = "windows")] in lib.rs).
|
||||||
|
windows-aec = ["dep:windows"]
|
||||||
|
# linux-aec enables a CPAL + WebRTC AEC3 capture/playback backend that
|
||||||
|
# runs the WebRTC Audio Processing Module (same algo as Chrome / Zoom /
|
||||||
|
# Teams) in-process, using the playback PCM as the reference signal for
|
||||||
|
# echo cancellation. The webrtc-audio-processing dep is target-gated to
|
||||||
|
# Linux above, so enabling this feature on non-Linux targets is a no-op
|
||||||
|
# (the audio_linux_aec module is also #[cfg(target_os = "linux")] in
|
||||||
|
# lib.rs).
|
||||||
|
linux-aec = ["dep:webrtc-audio-processing"]
|
||||||
|
|
||||||
[[bin]]
|
[[bin]]
|
||||||
name = "wzp-client"
|
name = "wzp-client"
|
||||||
|
|||||||
@@ -3,12 +3,10 @@
|
|||||||
//! Both structs use 48 kHz, mono, i16 format to match the WarzonePhone codec
|
//! Both structs use 48 kHz, mono, i16 format to match the WarzonePhone codec
|
||||||
//! pipeline. Frames are 960 samples (20 ms at 48 kHz).
|
//! pipeline. Frames are 960 samples (20 ms at 48 kHz).
|
||||||
//!
|
//!
|
||||||
//! The cpal `Stream` type is not `Send`, so each struct spawns a dedicated OS
|
//! Audio callbacks are **lock-free**: they read/write directly to an `AudioRing`
|
||||||
//! thread that owns the stream. The public API exposes only `Send + Sync`
|
//! (atomic SPSC ring buffer). No Mutex, no channel, no allocation on the hot path.
|
||||||
//! channel handles.
|
|
||||||
|
|
||||||
use std::sync::atomic::{AtomicBool, Ordering};
|
use std::sync::atomic::{AtomicBool, Ordering};
|
||||||
use std::sync::mpsc;
|
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
|
||||||
use anyhow::{anyhow, Context};
|
use anyhow::{anyhow, Context};
|
||||||
@@ -16,6 +14,8 @@ use cpal::traits::{DeviceTrait, HostTrait, StreamTrait};
|
|||||||
use cpal::{SampleFormat, SampleRate, StreamConfig};
|
use cpal::{SampleFormat, SampleRate, StreamConfig};
|
||||||
use tracing::{info, warn};
|
use tracing::{info, warn};
|
||||||
|
|
||||||
|
use crate::audio_ring::AudioRing;
|
||||||
|
|
||||||
/// Number of samples per 20 ms frame at 48 kHz mono.
|
/// Number of samples per 20 ms frame at 48 kHz mono.
|
||||||
pub const FRAME_SAMPLES: usize = 960;
|
pub const FRAME_SAMPLES: usize = 960;
|
||||||
|
|
||||||
@@ -23,22 +23,24 @@ pub const FRAME_SAMPLES: usize = 960;
|
|||||||
// AudioCapture
|
// AudioCapture
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
/// Captures microphone input and yields 960-sample PCM frames.
|
/// Captures microphone input via CPAL and writes PCM into a lock-free ring buffer.
|
||||||
///
|
///
|
||||||
/// The cpal stream lives on a dedicated OS thread; this handle is `Send + Sync`.
|
/// The cpal stream lives on a dedicated OS thread; this handle is `Send + Sync`.
|
||||||
pub struct AudioCapture {
|
pub struct AudioCapture {
|
||||||
rx: mpsc::Receiver<Vec<i16>>,
|
ring: Arc<AudioRing>,
|
||||||
running: Arc<AtomicBool>,
|
running: Arc<AtomicBool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AudioCapture {
|
impl AudioCapture {
|
||||||
/// Create and start capturing from the default input device at 48 kHz mono.
|
/// Create and start capturing from the default input device at 48 kHz mono.
|
||||||
pub fn start() -> Result<Self, anyhow::Error> {
|
pub fn start() -> Result<Self, anyhow::Error> {
|
||||||
let (tx, rx) = mpsc::sync_channel::<Vec<i16>>(64);
|
let ring = Arc::new(AudioRing::new());
|
||||||
let running = Arc::new(AtomicBool::new(true));
|
let running = Arc::new(AtomicBool::new(true));
|
||||||
let running_clone = running.clone();
|
|
||||||
|
|
||||||
let (init_tx, init_rx) = mpsc::sync_channel::<Result<(), String>>(1);
|
let (init_tx, init_rx) = std::sync::mpsc::sync_channel::<Result<(), String>>(1);
|
||||||
|
|
||||||
|
let ring_cb = ring.clone();
|
||||||
|
let running_clone = running.clone();
|
||||||
|
|
||||||
std::thread::Builder::new()
|
std::thread::Builder::new()
|
||||||
.name("wzp-audio-capture".into())
|
.name("wzp-audio-capture".into())
|
||||||
@@ -59,53 +61,51 @@ impl AudioCapture {
|
|||||||
|
|
||||||
let use_f32 = !supports_i16_input(&device)?;
|
let use_f32 = !supports_i16_input(&device)?;
|
||||||
|
|
||||||
let buf = Arc::new(std::sync::Mutex::new(
|
|
||||||
Vec::<i16>::with_capacity(FRAME_SAMPLES),
|
|
||||||
));
|
|
||||||
let err_cb = |e: cpal::StreamError| {
|
let err_cb = |e: cpal::StreamError| {
|
||||||
warn!("input stream error: {e}");
|
warn!("input stream error: {e}");
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let logged_cb_size = Arc::new(AtomicBool::new(false));
|
||||||
|
|
||||||
let stream = if use_f32 {
|
let stream = if use_f32 {
|
||||||
let buf = buf.clone();
|
let ring = ring_cb.clone();
|
||||||
let tx = tx.clone();
|
|
||||||
let running = running_clone.clone();
|
let running = running_clone.clone();
|
||||||
|
let logged = logged_cb_size.clone();
|
||||||
device.build_input_stream(
|
device.build_input_stream(
|
||||||
&config,
|
&config,
|
||||||
move |data: &[f32], _: &cpal::InputCallbackInfo| {
|
move |data: &[f32], _: &cpal::InputCallbackInfo| {
|
||||||
if !running.load(Ordering::Relaxed) {
|
if !running.load(Ordering::Relaxed) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
let mut lock = buf.lock().unwrap();
|
if !logged.swap(true, Ordering::Relaxed) {
|
||||||
for &s in data {
|
eprintln!("[audio] capture callback: {} f32 samples", data.len());
|
||||||
lock.push(f32_to_i16(s));
|
|
||||||
if lock.len() == FRAME_SAMPLES {
|
|
||||||
let frame = lock.drain(..).collect();
|
|
||||||
let _ = tx.try_send(frame);
|
|
||||||
}
|
}
|
||||||
|
let mut tmp = [0i16; FRAME_SAMPLES];
|
||||||
|
for chunk in data.chunks(FRAME_SAMPLES) {
|
||||||
|
let n = chunk.len();
|
||||||
|
for i in 0..n {
|
||||||
|
tmp[i] = f32_to_i16(chunk[i]);
|
||||||
|
}
|
||||||
|
ring.write(&tmp[..n]);
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
err_cb,
|
err_cb,
|
||||||
None,
|
None,
|
||||||
)?
|
)?
|
||||||
} else {
|
} else {
|
||||||
let buf = buf.clone();
|
let ring = ring_cb.clone();
|
||||||
let tx = tx.clone();
|
|
||||||
let running = running_clone.clone();
|
let running = running_clone.clone();
|
||||||
|
let logged = logged_cb_size.clone();
|
||||||
device.build_input_stream(
|
device.build_input_stream(
|
||||||
&config,
|
&config,
|
||||||
move |data: &[i16], _: &cpal::InputCallbackInfo| {
|
move |data: &[i16], _: &cpal::InputCallbackInfo| {
|
||||||
if !running.load(Ordering::Relaxed) {
|
if !running.load(Ordering::Relaxed) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
let mut lock = buf.lock().unwrap();
|
if !logged.swap(true, Ordering::Relaxed) {
|
||||||
for &s in data {
|
eprintln!("[audio] capture callback: {} i16 samples", data.len());
|
||||||
lock.push(s);
|
|
||||||
if lock.len() == FRAME_SAMPLES {
|
|
||||||
let frame = lock.drain(..).collect();
|
|
||||||
let _ = tx.try_send(frame);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
ring.write(data);
|
||||||
},
|
},
|
||||||
err_cb,
|
err_cb,
|
||||||
None,
|
None,
|
||||||
@@ -114,7 +114,6 @@ impl AudioCapture {
|
|||||||
|
|
||||||
stream.play().context("failed to start input stream")?;
|
stream.play().context("failed to start input stream")?;
|
||||||
|
|
||||||
// Signal success to the caller before parking.
|
|
||||||
let _ = init_tx.send(Ok(()));
|
let _ = init_tx.send(Ok(()));
|
||||||
|
|
||||||
// Keep stream alive until stopped.
|
// Keep stream alive until stopped.
|
||||||
@@ -135,15 +134,12 @@ impl AudioCapture {
|
|||||||
.map_err(|_| anyhow!("capture thread exited before signaling"))?
|
.map_err(|_| anyhow!("capture thread exited before signaling"))?
|
||||||
.map_err(|e| anyhow!("{e}"))?;
|
.map_err(|e| anyhow!("{e}"))?;
|
||||||
|
|
||||||
Ok(Self { rx, running })
|
Ok(Self { ring, running })
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Read the next frame of 960 PCM samples (blocking until available).
|
/// Get a reference to the capture ring buffer for direct polling.
|
||||||
///
|
pub fn ring(&self) -> &Arc<AudioRing> {
|
||||||
/// Returns `None` when the stream has been stopped or the channel is
|
&self.ring
|
||||||
/// disconnected.
|
|
||||||
pub fn read_frame(&self) -> Option<Vec<i16>> {
|
|
||||||
self.rx.recv().ok()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Stop capturing.
|
/// Stop capturing.
|
||||||
@@ -152,26 +148,34 @@ impl AudioCapture {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Drop for AudioCapture {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// AudioPlayback
|
// AudioPlayback
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
/// Plays PCM frames through the default output device at 48 kHz mono.
|
/// Plays PCM through the default output device, reading from a lock-free ring buffer.
|
||||||
///
|
///
|
||||||
/// The cpal stream lives on a dedicated OS thread; this handle is `Send + Sync`.
|
/// The cpal stream lives on a dedicated OS thread; this handle is `Send + Sync`.
|
||||||
pub struct AudioPlayback {
|
pub struct AudioPlayback {
|
||||||
tx: mpsc::SyncSender<Vec<i16>>,
|
ring: Arc<AudioRing>,
|
||||||
running: Arc<AtomicBool>,
|
running: Arc<AtomicBool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AudioPlayback {
|
impl AudioPlayback {
|
||||||
/// Create and start playback on the default output device at 48 kHz mono.
|
/// Create and start playback on the default output device at 48 kHz mono.
|
||||||
pub fn start() -> Result<Self, anyhow::Error> {
|
pub fn start() -> Result<Self, anyhow::Error> {
|
||||||
let (tx, rx) = mpsc::sync_channel::<Vec<i16>>(64);
|
let ring = Arc::new(AudioRing::new());
|
||||||
let running = Arc::new(AtomicBool::new(true));
|
let running = Arc::new(AtomicBool::new(true));
|
||||||
let running_clone = running.clone();
|
|
||||||
|
|
||||||
let (init_tx, init_rx) = mpsc::sync_channel::<Result<(), String>>(1);
|
let (init_tx, init_rx) = std::sync::mpsc::sync_channel::<Result<(), String>>(1);
|
||||||
|
|
||||||
|
let ring_cb = ring.clone();
|
||||||
|
let running_clone = running.clone();
|
||||||
|
|
||||||
std::thread::Builder::new()
|
std::thread::Builder::new()
|
||||||
.name("wzp-audio-playback".into())
|
.name("wzp-audio-playback".into())
|
||||||
@@ -192,62 +196,40 @@ impl AudioPlayback {
|
|||||||
|
|
||||||
let use_f32 = !supports_i16_output(&device)?;
|
let use_f32 = !supports_i16_output(&device)?;
|
||||||
|
|
||||||
// Shared ring of samples the cpal callback drains from.
|
|
||||||
let ring = Arc::new(std::sync::Mutex::new(
|
|
||||||
std::collections::VecDeque::<i16>::with_capacity(FRAME_SAMPLES * 8),
|
|
||||||
));
|
|
||||||
|
|
||||||
// Background drainer: moves frames from the mpsc channel into the ring.
|
|
||||||
{
|
|
||||||
let ring = ring.clone();
|
|
||||||
let running = running_clone.clone();
|
|
||||||
std::thread::Builder::new()
|
|
||||||
.name("wzp-playback-drain".into())
|
|
||||||
.spawn(move || {
|
|
||||||
while running.load(Ordering::Relaxed) {
|
|
||||||
match rx.recv_timeout(std::time::Duration::from_millis(100)) {
|
|
||||||
Ok(frame) => {
|
|
||||||
let mut lock = ring.lock().unwrap();
|
|
||||||
lock.extend(frame);
|
|
||||||
while lock.len() > FRAME_SAMPLES * 16 {
|
|
||||||
lock.pop_front();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Err(mpsc::RecvTimeoutError::Timeout) => {}
|
|
||||||
Err(mpsc::RecvTimeoutError::Disconnected) => break,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})?;
|
|
||||||
}
|
|
||||||
|
|
||||||
let err_cb = |e: cpal::StreamError| {
|
let err_cb = |e: cpal::StreamError| {
|
||||||
warn!("output stream error: {e}");
|
warn!("output stream error: {e}");
|
||||||
};
|
};
|
||||||
|
|
||||||
let stream = if use_f32 {
|
let stream = if use_f32 {
|
||||||
let ring = ring.clone();
|
let ring = ring_cb.clone();
|
||||||
device.build_output_stream(
|
device.build_output_stream(
|
||||||
&config,
|
&config,
|
||||||
move |data: &mut [f32], _: &cpal::OutputCallbackInfo| {
|
move |data: &mut [f32], _: &cpal::OutputCallbackInfo| {
|
||||||
let mut lock = ring.lock().unwrap();
|
let mut tmp = [0i16; FRAME_SAMPLES];
|
||||||
for sample in data.iter_mut() {
|
for chunk in data.chunks_mut(FRAME_SAMPLES) {
|
||||||
*sample = match lock.pop_front() {
|
let n = chunk.len();
|
||||||
Some(s) => i16_to_f32(s),
|
let read = ring.read(&mut tmp[..n]);
|
||||||
None => 0.0,
|
for i in 0..read {
|
||||||
};
|
chunk[i] = i16_to_f32(tmp[i]);
|
||||||
|
}
|
||||||
|
// Fill remainder with silence if ring underran
|
||||||
|
for i in read..n {
|
||||||
|
chunk[i] = 0.0;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
err_cb,
|
err_cb,
|
||||||
None,
|
None,
|
||||||
)?
|
)?
|
||||||
} else {
|
} else {
|
||||||
let ring = ring.clone();
|
let ring = ring_cb.clone();
|
||||||
device.build_output_stream(
|
device.build_output_stream(
|
||||||
&config,
|
&config,
|
||||||
move |data: &mut [i16], _: &cpal::OutputCallbackInfo| {
|
move |data: &mut [i16], _: &cpal::OutputCallbackInfo| {
|
||||||
let mut lock = ring.lock().unwrap();
|
let read = ring.read(data);
|
||||||
for sample in data.iter_mut() {
|
// Fill remainder with silence if ring underran
|
||||||
*sample = lock.pop_front().unwrap_or(0);
|
for sample in &mut data[read..] {
|
||||||
|
*sample = 0;
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
err_cb,
|
err_cb,
|
||||||
@@ -257,7 +239,6 @@ impl AudioPlayback {
|
|||||||
|
|
||||||
stream.play().context("failed to start output stream")?;
|
stream.play().context("failed to start output stream")?;
|
||||||
|
|
||||||
// Signal success to the caller before parking.
|
|
||||||
let _ = init_tx.send(Ok(()));
|
let _ = init_tx.send(Ok(()));
|
||||||
|
|
||||||
// Keep stream alive until stopped.
|
// Keep stream alive until stopped.
|
||||||
@@ -278,12 +259,12 @@ impl AudioPlayback {
|
|||||||
.map_err(|_| anyhow!("playback thread exited before signaling"))?
|
.map_err(|_| anyhow!("playback thread exited before signaling"))?
|
||||||
.map_err(|e| anyhow!("{e}"))?;
|
.map_err(|e| anyhow!("{e}"))?;
|
||||||
|
|
||||||
Ok(Self { tx, running })
|
Ok(Self { ring, running })
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Write a frame of PCM samples for playback.
|
/// Get a reference to the playout ring buffer for direct writing.
|
||||||
pub fn write_frame(&self, pcm: &[i16]) {
|
pub fn ring(&self) -> &Arc<AudioRing> {
|
||||||
let _ = self.tx.try_send(pcm.to_vec());
|
&self.ring
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Stop playback.
|
/// Stop playback.
|
||||||
@@ -292,11 +273,16 @@ impl AudioPlayback {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Drop for AudioPlayback {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Helpers
|
// Helpers
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
/// Check if the input device supports i16 at 48 kHz mono.
|
|
||||||
fn supports_i16_input(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
fn supports_i16_input(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
||||||
let supported = device
|
let supported = device
|
||||||
.supported_input_configs()
|
.supported_input_configs()
|
||||||
@@ -313,7 +299,6 @@ fn supports_i16_input(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
|||||||
Ok(false)
|
Ok(false)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Check if the output device supports i16 at 48 kHz mono.
|
|
||||||
fn supports_i16_output(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
fn supports_i16_output(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
||||||
let supported = device
|
let supported = device
|
||||||
.supported_output_configs()
|
.supported_output_configs()
|
||||||
|
|||||||
537
crates/wzp-client/src/audio_linux_aec.rs
Normal file
537
crates/wzp-client/src/audio_linux_aec.rs
Normal file
@@ -0,0 +1,537 @@
|
|||||||
|
//! Linux AEC backend: CPAL capture + playback wired through the WebRTC Audio
|
||||||
|
//! Processing Module (AEC3 + noise suppression + high-pass filter).
|
||||||
|
//!
|
||||||
|
//! This is the same algorithm used by Chrome WebRTC, Zoom, Teams, Jitsi, and
|
||||||
|
//! any other "serious" Linux VoIP app. It runs in-process — no dependency on
|
||||||
|
//! PulseAudio's module-echo-cancel or PipeWire's filter-chain, so it works
|
||||||
|
//! identically on ALSA / PulseAudio / PipeWire systems.
|
||||||
|
//!
|
||||||
|
//! ## Architecture
|
||||||
|
//!
|
||||||
|
//! A single module-level `Arc<Mutex<Processor>>` is shared between the
|
||||||
|
//! capture and playback paths. On each 20 ms frame (960 samples @ 48 kHz
|
||||||
|
//! mono):
|
||||||
|
//!
|
||||||
|
//! - **Playback path**: `LinuxAecPlayback::start` spawns the usual CPAL
|
||||||
|
//! output thread, but wraps each chunk in a call to
|
||||||
|
//! `Processor::process_render_frame` **before** handing it to CPAL. That
|
||||||
|
//! gives APM an authoritative reference of exactly what's going out to
|
||||||
|
//! the speakers (same approach Zoom/Teams/Jitsi use). The AEC then knows
|
||||||
|
//! what to cancel when it sees echo in the capture stream.
|
||||||
|
//!
|
||||||
|
//! - **Capture path**: `LinuxAecCapture::start` spawns the usual CPAL
|
||||||
|
//! input thread, and runs `Processor::process_capture_frame` on each
|
||||||
|
//! incoming mic chunk **in place** before pushing it into the ring
|
||||||
|
//! buffer. The AEC subtracts the echo using the render reference it
|
||||||
|
//! saw on the playback side.
|
||||||
|
//!
|
||||||
|
//! APM is strict about frame size: it requires exactly 10 ms = 480 samples
|
||||||
|
//! per call at 48 kHz. Our pipeline uses 20 ms = 960 samples, so each 20 ms
|
||||||
|
//! frame is split into two 480-sample halves, APM is called twice, and the
|
||||||
|
//! halves are stitched back together.
|
||||||
|
//!
|
||||||
|
//! APM only accepts f32 samples in `[-1.0, 1.0]`, so we convert i16 → f32
|
||||||
|
//! before the call and f32 → i16 after (with clamping on the return path).
|
||||||
|
//!
|
||||||
|
//! ## Stream delay
|
||||||
|
//!
|
||||||
|
//! AEC needs to know roughly how long it takes between a sample being passed
|
||||||
|
//! to `process_render_frame` and its echo showing up at `process_capture_frame`
|
||||||
|
//! — i.e. the round trip through CPAL playback → speaker → air → microphone
|
||||||
|
//! → CPAL capture. AEC3's internal estimator tracks this within a window
|
||||||
|
//! around whatever hint we give it. We hardcode 60 ms as a reasonable
|
||||||
|
//! starting point for typical Linux audio stacks; the delay estimator does
|
||||||
|
//! the fine-tuning automatically.
|
||||||
|
//!
|
||||||
|
//! ## Thread safety
|
||||||
|
//!
|
||||||
|
//! The 0.3.x line of `webrtc-audio-processing` takes `&mut self` on both
|
||||||
|
//! `process_capture_frame` and `process_render_frame`, so the `Processor`
|
||||||
|
//! needs a `Mutex` around it for cross-thread sharing. The capture and
|
||||||
|
//! playback threads each acquire the lock briefly (sub-millisecond per
|
||||||
|
//! 10 ms frame) so contention is minimal at our frame rates.
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicBool, Ordering};
|
||||||
|
use std::sync::{Arc, Mutex, OnceLock};
|
||||||
|
|
||||||
|
use anyhow::{anyhow, Context};
|
||||||
|
use cpal::traits::{DeviceTrait, HostTrait, StreamTrait};
|
||||||
|
use cpal::{SampleFormat, SampleRate, StreamConfig};
|
||||||
|
use tracing::{info, warn};
|
||||||
|
use webrtc_audio_processing::{
|
||||||
|
Config, EchoCancellation, EchoCancellationSuppressionLevel, InitializationConfig,
|
||||||
|
NoiseSuppression, NoiseSuppressionLevel, Processor, NUM_SAMPLES_PER_FRAME,
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::audio_ring::AudioRing;
|
||||||
|
|
||||||
|
/// 20 ms at 48 kHz, mono — matches the rest of the pipeline and the codec.
|
||||||
|
pub const FRAME_SAMPLES: usize = 960;
|
||||||
|
/// APM requires strict 10 ms frames at 48 kHz = 480 samples per call.
|
||||||
|
/// Imported from the webrtc-audio-processing crate so we can't drift out
|
||||||
|
/// of sync with whatever sample rate / frame length the C++ lib is using.
|
||||||
|
const APM_FRAME_SAMPLES: usize = NUM_SAMPLES_PER_FRAME as usize;
|
||||||
|
const APM_NUM_CHANNELS: usize = 1;
|
||||||
|
/// Round-trip delay hint passed to APM; the estimator refines from here.
|
||||||
|
/// 60 ms is a reasonable default for CPAL on ALSA / PulseAudio / PipeWire.
|
||||||
|
#[allow(dead_code)]
|
||||||
|
const STREAM_DELAY_MS: i32 = 60;
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Shared APM instance
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/// Module-level lazily-initialized APM. Shared between capture and playback
|
||||||
|
/// so they operate on the same echo-cancellation state — the render frames
|
||||||
|
/// pushed by playback are what the capture path subtracts from the mic input.
|
||||||
|
/// Wrapped in a Mutex because the 0.3.x Processor takes `&mut self` on both
|
||||||
|
/// process_capture_frame and process_render_frame.
|
||||||
|
static PROCESSOR: OnceLock<Arc<Mutex<Processor>>> = OnceLock::new();
|
||||||
|
|
||||||
|
fn get_or_init_processor() -> anyhow::Result<Arc<Mutex<Processor>>> {
|
||||||
|
if let Some(p) = PROCESSOR.get() {
|
||||||
|
return Ok(p.clone());
|
||||||
|
}
|
||||||
|
let init_config = InitializationConfig {
|
||||||
|
num_capture_channels: APM_NUM_CHANNELS as i32,
|
||||||
|
num_render_channels: APM_NUM_CHANNELS as i32,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let mut processor = Processor::new(&init_config)
|
||||||
|
.map_err(|e| anyhow!("webrtc APM init failed: {e:?}"))?;
|
||||||
|
|
||||||
|
let config = Config {
|
||||||
|
echo_cancellation: Some(EchoCancellation {
|
||||||
|
suppression_level: EchoCancellationSuppressionLevel::High,
|
||||||
|
stream_delay_ms: Some(STREAM_DELAY_MS),
|
||||||
|
enable_delay_agnostic: true,
|
||||||
|
enable_extended_filter: true,
|
||||||
|
}),
|
||||||
|
noise_suppression: Some(NoiseSuppression {
|
||||||
|
suppression_level: NoiseSuppressionLevel::High,
|
||||||
|
}),
|
||||||
|
enable_high_pass_filter: true,
|
||||||
|
// AGC left off for now — it can fight the Opus encoder's own gain
|
||||||
|
// staging and the adaptive-quality controller. Add later if users
|
||||||
|
// report low mic levels.
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
processor.set_config(config);
|
||||||
|
|
||||||
|
let arc = Arc::new(Mutex::new(processor));
|
||||||
|
let _ = PROCESSOR.set(arc.clone());
|
||||||
|
info!(
|
||||||
|
stream_delay_ms = STREAM_DELAY_MS,
|
||||||
|
"webrtc APM initialized (AEC High + NS High + HPF, AGC off)"
|
||||||
|
);
|
||||||
|
Ok(arc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Helpers: i16 ↔ f32 and APM frame processing
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn i16_to_f32(s: i16) -> f32 {
|
||||||
|
s as f32 / 32768.0
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn f32_to_i16(s: f32) -> i16 {
|
||||||
|
(s.clamp(-1.0, 1.0) * 32767.0) as i16
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Feed a 20 ms (960-sample) playback frame to APM as the render reference.
|
||||||
|
/// Splits into two 10 ms halves because APM is strict about frame size.
|
||||||
|
/// Takes the Mutex-wrapped Processor and locks briefly around each call.
|
||||||
|
fn push_render_frame_20ms(apm: &Mutex<Processor>, pcm: &[i16]) {
|
||||||
|
debug_assert_eq!(pcm.len(), FRAME_SAMPLES);
|
||||||
|
let mut buf = [0f32; APM_FRAME_SAMPLES];
|
||||||
|
for half in pcm.chunks_exact(APM_FRAME_SAMPLES) {
|
||||||
|
for (i, &s) in half.iter().enumerate() {
|
||||||
|
buf[i] = i16_to_f32(s);
|
||||||
|
}
|
||||||
|
match apm.lock() {
|
||||||
|
Ok(mut p) => {
|
||||||
|
if let Err(e) = p.process_render_frame(&mut buf) {
|
||||||
|
warn!("webrtc APM process_render_frame failed: {e:?}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(_) => {
|
||||||
|
warn!("webrtc APM mutex poisoned in render path");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Run a 20 ms (960-sample) capture frame through APM's echo cancellation
|
||||||
|
/// in place. Splits into two 10 ms halves, runs APM on each, stitches
|
||||||
|
/// results back into the caller's buffer. Briefly holds the Mutex once
|
||||||
|
/// per 10 ms half.
|
||||||
|
fn process_capture_frame_20ms(apm: &Mutex<Processor>, pcm: &mut [i16]) {
|
||||||
|
debug_assert_eq!(pcm.len(), FRAME_SAMPLES);
|
||||||
|
let mut buf = [0f32; APM_FRAME_SAMPLES];
|
||||||
|
for half in pcm.chunks_exact_mut(APM_FRAME_SAMPLES) {
|
||||||
|
for (i, &s) in half.iter().enumerate() {
|
||||||
|
buf[i] = i16_to_f32(s);
|
||||||
|
}
|
||||||
|
match apm.lock() {
|
||||||
|
Ok(mut p) => {
|
||||||
|
if let Err(e) = p.process_capture_frame(&mut buf) {
|
||||||
|
warn!("webrtc APM process_capture_frame failed: {e:?}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(_) => {
|
||||||
|
warn!("webrtc APM mutex poisoned in capture path");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (i, d) in half.iter_mut().enumerate() {
|
||||||
|
*d = f32_to_i16(buf[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// LinuxAecCapture — CPAL mic + WebRTC AEC capture-side processing
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/// Microphone capture with WebRTC AEC3 applied in place before the codec
|
||||||
|
/// sees the samples. Mirrors the public API of `audio_io::AudioCapture` so
|
||||||
|
/// downstream code doesn't change.
|
||||||
|
pub struct LinuxAecCapture {
|
||||||
|
ring: Arc<AudioRing>,
|
||||||
|
running: Arc<AtomicBool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LinuxAecCapture {
|
||||||
|
pub fn start() -> Result<Self, anyhow::Error> {
|
||||||
|
// Eagerly init the APM so the playback side can find it already
|
||||||
|
// configured, and so init errors surface on the caller thread
|
||||||
|
// instead of silently failing inside the capture thread.
|
||||||
|
let apm = get_or_init_processor()?;
|
||||||
|
|
||||||
|
let ring = Arc::new(AudioRing::new());
|
||||||
|
let running = Arc::new(AtomicBool::new(true));
|
||||||
|
|
||||||
|
let (init_tx, init_rx) = std::sync::mpsc::sync_channel::<Result<(), String>>(1);
|
||||||
|
|
||||||
|
let ring_cb = ring.clone();
|
||||||
|
let running_clone = running.clone();
|
||||||
|
let apm_capture = apm.clone();
|
||||||
|
|
||||||
|
std::thread::Builder::new()
|
||||||
|
.name("wzp-audio-capture-linuxaec".into())
|
||||||
|
.spawn(move || {
|
||||||
|
let result = (|| -> Result<(), anyhow::Error> {
|
||||||
|
let host = cpal::default_host();
|
||||||
|
let device = host
|
||||||
|
.default_input_device()
|
||||||
|
.ok_or_else(|| anyhow!("no default input audio device found"))?;
|
||||||
|
info!(device = %device.name().unwrap_or_default(), "LinuxAEC: using input device");
|
||||||
|
|
||||||
|
let config = StreamConfig {
|
||||||
|
channels: 1,
|
||||||
|
sample_rate: SampleRate(48_000),
|
||||||
|
buffer_size: cpal::BufferSize::Default,
|
||||||
|
};
|
||||||
|
|
||||||
|
let use_f32 = !supports_i16_input(&device)?;
|
||||||
|
|
||||||
|
let err_cb = |e: cpal::StreamError| {
|
||||||
|
warn!("LinuxAEC input stream error: {e}");
|
||||||
|
};
|
||||||
|
|
||||||
|
// Leftover buffer for when CPAL gives us partial frames.
|
||||||
|
// We need exactly 960-sample chunks to feed APM.
|
||||||
|
let leftover = std::sync::Mutex::new(Vec::<i16>::with_capacity(FRAME_SAMPLES * 4));
|
||||||
|
|
||||||
|
let stream = if use_f32 {
|
||||||
|
let ring = ring_cb.clone();
|
||||||
|
let running = running_clone.clone();
|
||||||
|
let apm = apm_capture.clone();
|
||||||
|
device.build_input_stream(
|
||||||
|
&config,
|
||||||
|
move |data: &[f32], _: &cpal::InputCallbackInfo| {
|
||||||
|
if !running.load(Ordering::Relaxed) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let mut lv = leftover.lock().unwrap();
|
||||||
|
lv.reserve(data.len());
|
||||||
|
for &s in data {
|
||||||
|
lv.push(f32_to_i16(s));
|
||||||
|
}
|
||||||
|
drain_frames_through_apm(&mut lv, &apm, &ring);
|
||||||
|
},
|
||||||
|
err_cb,
|
||||||
|
None,
|
||||||
|
)?
|
||||||
|
} else {
|
||||||
|
let ring = ring_cb.clone();
|
||||||
|
let running = running_clone.clone();
|
||||||
|
let apm = apm_capture.clone();
|
||||||
|
device.build_input_stream(
|
||||||
|
&config,
|
||||||
|
move |data: &[i16], _: &cpal::InputCallbackInfo| {
|
||||||
|
if !running.load(Ordering::Relaxed) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let mut lv = leftover.lock().unwrap();
|
||||||
|
lv.extend_from_slice(data);
|
||||||
|
drain_frames_through_apm(&mut lv, &apm, &ring);
|
||||||
|
},
|
||||||
|
err_cb,
|
||||||
|
None,
|
||||||
|
)?
|
||||||
|
};
|
||||||
|
|
||||||
|
stream.play().context("failed to start LinuxAEC input stream")?;
|
||||||
|
let _ = init_tx.send(Ok(()));
|
||||||
|
info!("LinuxAEC capture started (AEC3 active)");
|
||||||
|
|
||||||
|
while running_clone.load(Ordering::Relaxed) {
|
||||||
|
std::thread::park_timeout(std::time::Duration::from_millis(200));
|
||||||
|
}
|
||||||
|
drop(stream);
|
||||||
|
Ok(())
|
||||||
|
})();
|
||||||
|
|
||||||
|
if let Err(e) = result {
|
||||||
|
let _ = init_tx.send(Err(e.to_string()));
|
||||||
|
}
|
||||||
|
})?;
|
||||||
|
|
||||||
|
init_rx
|
||||||
|
.recv()
|
||||||
|
.map_err(|_| anyhow!("LinuxAEC capture thread exited before signaling"))?
|
||||||
|
.map_err(|e| anyhow!("{e}"))?;
|
||||||
|
|
||||||
|
Ok(Self { ring, running })
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn ring(&self) -> &Arc<AudioRing> {
|
||||||
|
&self.ring
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn stop(&self) {
|
||||||
|
self.running.store(false, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for LinuxAecCapture {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Pull whole 960-sample frames out of the leftover buffer, run them through
|
||||||
|
/// APM's capture-side processing, and push to the ring. Leaves any partial
|
||||||
|
/// sub-960 remainder in `leftover` for the next callback.
|
||||||
|
fn drain_frames_through_apm(leftover: &mut Vec<i16>, apm: &Mutex<Processor>, ring: &AudioRing) {
|
||||||
|
let mut frame = [0i16; FRAME_SAMPLES];
|
||||||
|
while leftover.len() >= FRAME_SAMPLES {
|
||||||
|
frame.copy_from_slice(&leftover[..FRAME_SAMPLES]);
|
||||||
|
process_capture_frame_20ms(apm, &mut frame);
|
||||||
|
ring.write(&frame);
|
||||||
|
leftover.drain(..FRAME_SAMPLES);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// LinuxAecPlayback — CPAL speaker output + WebRTC AEC render-side tee
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/// Speaker playback with a render-side tee: each frame written to CPAL is
|
||||||
|
/// ALSO fed to APM via `process_render_frame` as the echo-cancellation
|
||||||
|
/// reference signal. This is the "tee the playback ring" approach (Zoom,
|
||||||
|
/// Teams, Jitsi) — deterministic, does not depend on PulseAudio loopback or
|
||||||
|
/// PipeWire monitor sources.
|
||||||
|
pub struct LinuxAecPlayback {
|
||||||
|
ring: Arc<AudioRing>,
|
||||||
|
running: Arc<AtomicBool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LinuxAecPlayback {
|
||||||
|
pub fn start() -> Result<Self, anyhow::Error> {
|
||||||
|
let apm = get_or_init_processor()?;
|
||||||
|
|
||||||
|
let ring = Arc::new(AudioRing::new());
|
||||||
|
let running = Arc::new(AtomicBool::new(true));
|
||||||
|
|
||||||
|
let (init_tx, init_rx) = std::sync::mpsc::sync_channel::<Result<(), String>>(1);
|
||||||
|
|
||||||
|
let ring_cb = ring.clone();
|
||||||
|
let running_clone = running.clone();
|
||||||
|
let apm_render = apm.clone();
|
||||||
|
|
||||||
|
std::thread::Builder::new()
|
||||||
|
.name("wzp-audio-playback-linuxaec".into())
|
||||||
|
.spawn(move || {
|
||||||
|
let result = (|| -> Result<(), anyhow::Error> {
|
||||||
|
let host = cpal::default_host();
|
||||||
|
let device = host
|
||||||
|
.default_output_device()
|
||||||
|
.ok_or_else(|| anyhow!("no default output audio device found"))?;
|
||||||
|
info!(device = %device.name().unwrap_or_default(), "LinuxAEC: using output device");
|
||||||
|
|
||||||
|
let config = StreamConfig {
|
||||||
|
channels: 1,
|
||||||
|
sample_rate: SampleRate(48_000),
|
||||||
|
buffer_size: cpal::BufferSize::Default,
|
||||||
|
};
|
||||||
|
|
||||||
|
let use_f32 = !supports_i16_output(&device)?;
|
||||||
|
|
||||||
|
let err_cb = |e: cpal::StreamError| {
|
||||||
|
warn!("LinuxAEC output stream error: {e}");
|
||||||
|
};
|
||||||
|
|
||||||
|
// Same 960-sample batching approach as the capture side:
|
||||||
|
// CPAL may ask for N samples in a callback where N doesn't
|
||||||
|
// divide 960. We accumulate partial frames in a Vec and
|
||||||
|
// feed APM as soon as we have a whole 20 ms frame.
|
||||||
|
let carry = std::sync::Mutex::new(Vec::<i16>::with_capacity(FRAME_SAMPLES * 4));
|
||||||
|
|
||||||
|
let stream = if use_f32 {
|
||||||
|
let ring = ring_cb.clone();
|
||||||
|
let apm = apm_render.clone();
|
||||||
|
device.build_output_stream(
|
||||||
|
&config,
|
||||||
|
move |data: &mut [f32], _: &cpal::OutputCallbackInfo| {
|
||||||
|
fill_output_and_tee_f32(data, &ring, &apm, &carry);
|
||||||
|
},
|
||||||
|
err_cb,
|
||||||
|
None,
|
||||||
|
)?
|
||||||
|
} else {
|
||||||
|
let ring = ring_cb.clone();
|
||||||
|
let apm = apm_render.clone();
|
||||||
|
device.build_output_stream(
|
||||||
|
&config,
|
||||||
|
move |data: &mut [i16], _: &cpal::OutputCallbackInfo| {
|
||||||
|
fill_output_and_tee_i16(data, &ring, &apm, &carry);
|
||||||
|
},
|
||||||
|
err_cb,
|
||||||
|
None,
|
||||||
|
)?
|
||||||
|
};
|
||||||
|
|
||||||
|
stream.play().context("failed to start LinuxAEC output stream")?;
|
||||||
|
let _ = init_tx.send(Ok(()));
|
||||||
|
info!("LinuxAEC playback started (render tee active)");
|
||||||
|
|
||||||
|
while running_clone.load(Ordering::Relaxed) {
|
||||||
|
std::thread::park_timeout(std::time::Duration::from_millis(200));
|
||||||
|
}
|
||||||
|
drop(stream);
|
||||||
|
Ok(())
|
||||||
|
})();
|
||||||
|
|
||||||
|
if let Err(e) = result {
|
||||||
|
let _ = init_tx.send(Err(e.to_string()));
|
||||||
|
}
|
||||||
|
})?;
|
||||||
|
|
||||||
|
init_rx
|
||||||
|
.recv()
|
||||||
|
.map_err(|_| anyhow!("LinuxAEC playback thread exited before signaling"))?
|
||||||
|
.map_err(|e| anyhow!("{e}"))?;
|
||||||
|
|
||||||
|
Ok(Self { ring, running })
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn ring(&self) -> &Arc<AudioRing> {
|
||||||
|
&self.ring
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn stop(&self) {
|
||||||
|
self.running.store(false, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for LinuxAecPlayback {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn fill_output_and_tee_i16(
|
||||||
|
data: &mut [i16],
|
||||||
|
ring: &AudioRing,
|
||||||
|
apm: &Mutex<Processor>,
|
||||||
|
carry: &std::sync::Mutex<Vec<i16>>,
|
||||||
|
) {
|
||||||
|
let read = ring.read(data);
|
||||||
|
for s in &mut data[read..] {
|
||||||
|
*s = 0;
|
||||||
|
}
|
||||||
|
tee_render_samples(data, apm, carry);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn fill_output_and_tee_f32(
|
||||||
|
data: &mut [f32],
|
||||||
|
ring: &AudioRing,
|
||||||
|
apm: &Mutex<Processor>,
|
||||||
|
carry: &std::sync::Mutex<Vec<i16>>,
|
||||||
|
) {
|
||||||
|
let mut tmp = vec![0i16; data.len()];
|
||||||
|
let read = ring.read(&mut tmp);
|
||||||
|
for s in &mut tmp[read..] {
|
||||||
|
*s = 0;
|
||||||
|
}
|
||||||
|
for (d, &s) in data.iter_mut().zip(tmp.iter()) {
|
||||||
|
*d = i16_to_f32(s);
|
||||||
|
}
|
||||||
|
tee_render_samples(&tmp, apm, carry);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Push CPAL-bound samples into APM's render-side input for echo cancellation.
|
||||||
|
/// Uses a carry buffer to batch into exact 960-sample (20 ms) frames.
|
||||||
|
fn tee_render_samples(samples: &[i16], apm: &Mutex<Processor>, carry: &std::sync::Mutex<Vec<i16>>) {
|
||||||
|
let mut lv = carry.lock().unwrap();
|
||||||
|
lv.extend_from_slice(samples);
|
||||||
|
while lv.len() >= FRAME_SAMPLES {
|
||||||
|
let mut frame = [0i16; FRAME_SAMPLES];
|
||||||
|
frame.copy_from_slice(&lv[..FRAME_SAMPLES]);
|
||||||
|
push_render_frame_20ms(apm, &frame);
|
||||||
|
lv.drain(..FRAME_SAMPLES);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// CPAL format helpers (duplicated from audio_io.rs to keep the modules
|
||||||
|
// independent — each backend file is a self-contained unit)
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
fn supports_i16_input(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
||||||
|
let supported = device
|
||||||
|
.supported_input_configs()
|
||||||
|
.context("failed to query input configs")?;
|
||||||
|
for cfg in supported {
|
||||||
|
if cfg.sample_format() == SampleFormat::I16
|
||||||
|
&& cfg.min_sample_rate() <= SampleRate(48_000)
|
||||||
|
&& cfg.max_sample_rate() >= SampleRate(48_000)
|
||||||
|
&& cfg.channels() >= 1
|
||||||
|
{
|
||||||
|
return Ok(true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn supports_i16_output(device: &cpal::Device) -> Result<bool, anyhow::Error> {
|
||||||
|
let supported = device
|
||||||
|
.supported_output_configs()
|
||||||
|
.context("failed to query output configs")?;
|
||||||
|
for cfg in supported {
|
||||||
|
if cfg.sample_format() == SampleFormat::I16
|
||||||
|
&& cfg.min_sample_rate() <= SampleRate(48_000)
|
||||||
|
&& cfg.max_sample_rate() >= SampleRate(48_000)
|
||||||
|
&& cfg.channels() >= 1
|
||||||
|
{
|
||||||
|
return Ok(true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(false)
|
||||||
|
}
|
||||||
122
crates/wzp-client/src/audio_ring.rs
Normal file
122
crates/wzp-client/src/audio_ring.rs
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
//! Lock-free SPSC ring buffer — "Reader-Detects-Lap" architecture.
|
||||||
|
//!
|
||||||
|
//! SPSC invariant: the producer ONLY writes `write_pos`, the consumer
|
||||||
|
//! ONLY writes `read_pos`. Neither thread touches the other's cursor.
|
||||||
|
//!
|
||||||
|
//! On overflow (writer laps the reader), the writer simply overwrites
|
||||||
|
//! old buffer data. The reader detects the lap via `available() >
|
||||||
|
//! RING_CAPACITY` and snaps its own `read_pos` forward.
|
||||||
|
//!
|
||||||
|
//! Capacity is a power of 2 for bitmask indexing (no modulo).
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicU64, AtomicUsize, Ordering};
|
||||||
|
|
||||||
|
/// Ring buffer capacity — power of 2 for bitmask indexing.
|
||||||
|
/// 16384 samples = 341.3ms at 48kHz mono.
|
||||||
|
const RING_CAPACITY: usize = 16384; // 2^14
|
||||||
|
const RING_MASK: usize = RING_CAPACITY - 1;
|
||||||
|
|
||||||
|
/// Lock-free single-producer single-consumer ring buffer for i16 PCM samples.
|
||||||
|
pub struct AudioRing {
|
||||||
|
buf: Box<[i16]>,
|
||||||
|
/// Monotonically increasing write cursor. ONLY written by producer.
|
||||||
|
write_pos: AtomicUsize,
|
||||||
|
/// Monotonically increasing read cursor. ONLY written by consumer.
|
||||||
|
read_pos: AtomicUsize,
|
||||||
|
/// Incremented by reader when it detects it was lapped (overflow).
|
||||||
|
overflow_count: AtomicU64,
|
||||||
|
/// Incremented by reader when ring is empty (underrun).
|
||||||
|
underrun_count: AtomicU64,
|
||||||
|
}
|
||||||
|
|
||||||
|
// SAFETY: AudioRing is SPSC — one thread writes (producer), one reads (consumer).
|
||||||
|
// The producer only writes write_pos. The consumer only writes read_pos.
|
||||||
|
// Neither thread writes the other's cursor. Buffer indices are derived from
|
||||||
|
// the owning thread's cursor, ensuring no concurrent access to the same index.
|
||||||
|
unsafe impl Send for AudioRing {}
|
||||||
|
unsafe impl Sync for AudioRing {}
|
||||||
|
|
||||||
|
impl AudioRing {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
debug_assert!(RING_CAPACITY.is_power_of_two());
|
||||||
|
Self {
|
||||||
|
buf: vec![0i16; RING_CAPACITY].into_boxed_slice(),
|
||||||
|
write_pos: AtomicUsize::new(0),
|
||||||
|
read_pos: AtomicUsize::new(0),
|
||||||
|
overflow_count: AtomicU64::new(0),
|
||||||
|
underrun_count: AtomicU64::new(0),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Number of samples available to read (clamped to capacity).
|
||||||
|
pub fn available(&self) -> usize {
|
||||||
|
let w = self.write_pos.load(Ordering::Acquire);
|
||||||
|
let r = self.read_pos.load(Ordering::Relaxed);
|
||||||
|
w.wrapping_sub(r).min(RING_CAPACITY)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write samples into the ring. Returns number of samples written.
|
||||||
|
///
|
||||||
|
/// If the ring is full, old data is silently overwritten. The reader
|
||||||
|
/// will detect the lap and self-correct. The writer NEVER touches
|
||||||
|
/// `read_pos`.
|
||||||
|
pub fn write(&self, samples: &[i16]) -> usize {
|
||||||
|
let count = samples.len().min(RING_CAPACITY);
|
||||||
|
let w = self.write_pos.load(Ordering::Relaxed);
|
||||||
|
|
||||||
|
for i in 0..count {
|
||||||
|
unsafe {
|
||||||
|
let ptr = self.buf.as_ptr() as *mut i16;
|
||||||
|
*ptr.add((w + i) & RING_MASK) = samples[i];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
self.write_pos
|
||||||
|
.store(w.wrapping_add(count), Ordering::Release);
|
||||||
|
count
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read samples from the ring into `out`. Returns number of samples read.
|
||||||
|
///
|
||||||
|
/// If the writer has lapped the reader (overflow), `read_pos` is snapped
|
||||||
|
/// forward to the oldest valid data.
|
||||||
|
pub fn read(&self, out: &mut [i16]) -> usize {
|
||||||
|
let w = self.write_pos.load(Ordering::Acquire);
|
||||||
|
let mut r = self.read_pos.load(Ordering::Relaxed);
|
||||||
|
|
||||||
|
let mut avail = w.wrapping_sub(r);
|
||||||
|
|
||||||
|
// Lap detection: writer has overwritten our unread data.
|
||||||
|
if avail > RING_CAPACITY {
|
||||||
|
r = w.wrapping_sub(RING_CAPACITY);
|
||||||
|
avail = RING_CAPACITY;
|
||||||
|
self.overflow_count.fetch_add(1, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
|
||||||
|
let count = out.len().min(avail);
|
||||||
|
if count == 0 {
|
||||||
|
if w == r {
|
||||||
|
self.underrun_count.fetch_add(1, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
for i in 0..count {
|
||||||
|
out[i] = unsafe { *self.buf.as_ptr().add((r + i) & RING_MASK) };
|
||||||
|
}
|
||||||
|
|
||||||
|
self.read_pos
|
||||||
|
.store(r.wrapping_add(count), Ordering::Release);
|
||||||
|
count
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Number of overflow events (reader was lapped by writer).
|
||||||
|
pub fn overflow_count(&self) -> u64 {
|
||||||
|
self.overflow_count.load(Ordering::Relaxed)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Number of underrun events (reader found empty buffer).
|
||||||
|
pub fn underrun_count(&self) -> u64 {
|
||||||
|
self.underrun_count.load(Ordering::Relaxed)
|
||||||
|
}
|
||||||
|
}
|
||||||
179
crates/wzp-client/src/audio_vpio.rs
Normal file
179
crates/wzp-client/src/audio_vpio.rs
Normal file
@@ -0,0 +1,179 @@
|
|||||||
|
//! macOS Voice Processing I/O — uses Apple's VoiceProcessingIO audio unit
|
||||||
|
//! for hardware-accelerated echo cancellation, AGC, and noise suppression.
|
||||||
|
//!
|
||||||
|
//! VoiceProcessingIO is a combined input+output unit that knows what's going
|
||||||
|
//! to the speaker, so it can cancel the echo from the mic signal internally.
|
||||||
|
//! This is the same engine FaceTime and other Apple apps use.
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicBool, Ordering};
|
||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use anyhow::Context;
|
||||||
|
use coreaudio::audio_unit::audio_format::LinearPcmFlags;
|
||||||
|
use coreaudio::audio_unit::render_callback::{self, data};
|
||||||
|
use coreaudio::audio_unit::{AudioUnit, Element, IOType, SampleFormat, Scope, StreamFormat};
|
||||||
|
use coreaudio::sys;
|
||||||
|
use tracing::info;
|
||||||
|
|
||||||
|
use crate::audio_ring::AudioRing;
|
||||||
|
|
||||||
|
/// Number of samples per 20 ms frame at 48 kHz mono.
|
||||||
|
pub const FRAME_SAMPLES: usize = 960;
|
||||||
|
|
||||||
|
/// Combined capture + playback via macOS VoiceProcessingIO.
|
||||||
|
///
|
||||||
|
/// The OS handles AEC internally — no manual far-end feeding needed.
|
||||||
|
pub struct VpioAudio {
|
||||||
|
capture_ring: Arc<AudioRing>,
|
||||||
|
playout_ring: Arc<AudioRing>,
|
||||||
|
_audio_unit: AudioUnit,
|
||||||
|
running: Arc<AtomicBool>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl VpioAudio {
|
||||||
|
/// Start VoiceProcessingIO with AEC enabled.
|
||||||
|
pub fn start() -> Result<Self, anyhow::Error> {
|
||||||
|
let capture_ring = Arc::new(AudioRing::new());
|
||||||
|
let playout_ring = Arc::new(AudioRing::new());
|
||||||
|
let running = Arc::new(AtomicBool::new(true));
|
||||||
|
|
||||||
|
let mut au = AudioUnit::new(IOType::VoiceProcessingIO)
|
||||||
|
.context("failed to create VoiceProcessingIO audio unit")?;
|
||||||
|
|
||||||
|
// Must uninitialize before configuring properties.
|
||||||
|
au.uninitialize()
|
||||||
|
.context("failed to uninitialize VPIO for configuration")?;
|
||||||
|
|
||||||
|
// Enable input (mic) on Element::Input (bus 1).
|
||||||
|
let enable: u32 = 1;
|
||||||
|
au.set_property(
|
||||||
|
sys::kAudioOutputUnitProperty_EnableIO,
|
||||||
|
Scope::Input,
|
||||||
|
Element::Input,
|
||||||
|
Some(&enable),
|
||||||
|
)
|
||||||
|
.context("failed to enable VPIO input")?;
|
||||||
|
|
||||||
|
// Output (speaker) is enabled by default on VPIO, but be explicit.
|
||||||
|
au.set_property(
|
||||||
|
sys::kAudioOutputUnitProperty_EnableIO,
|
||||||
|
Scope::Output,
|
||||||
|
Element::Output,
|
||||||
|
Some(&enable),
|
||||||
|
)
|
||||||
|
.context("failed to enable VPIO output")?;
|
||||||
|
|
||||||
|
// Configure stream format: 48kHz mono f32 non-interleaved
|
||||||
|
let stream_format = StreamFormat {
|
||||||
|
sample_rate: 48_000.0,
|
||||||
|
sample_format: SampleFormat::F32,
|
||||||
|
flags: LinearPcmFlags::IS_FLOAT
|
||||||
|
| LinearPcmFlags::IS_PACKED
|
||||||
|
| LinearPcmFlags::IS_NON_INTERLEAVED,
|
||||||
|
channels: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
let asbd = stream_format.to_asbd();
|
||||||
|
|
||||||
|
// Input: set format on Output scope of Input element
|
||||||
|
// (= the format the AU delivers to us from the mic)
|
||||||
|
au.set_property(
|
||||||
|
sys::kAudioUnitProperty_StreamFormat,
|
||||||
|
Scope::Output,
|
||||||
|
Element::Input,
|
||||||
|
Some(&asbd),
|
||||||
|
)
|
||||||
|
.context("failed to set input stream format")?;
|
||||||
|
|
||||||
|
// Output: set format on Input scope of Output element
|
||||||
|
// (= the format we feed to the AU for the speaker)
|
||||||
|
au.set_property(
|
||||||
|
sys::kAudioUnitProperty_StreamFormat,
|
||||||
|
Scope::Input,
|
||||||
|
Element::Output,
|
||||||
|
Some(&asbd),
|
||||||
|
)
|
||||||
|
.context("failed to set output stream format")?;
|
||||||
|
|
||||||
|
// Set up input callback (mic capture with AEC applied)
|
||||||
|
let cap_ring = capture_ring.clone();
|
||||||
|
let cap_running = running.clone();
|
||||||
|
let logged = Arc::new(AtomicBool::new(false));
|
||||||
|
au.set_input_callback(
|
||||||
|
move |args: render_callback::Args<data::NonInterleaved<f32>>| {
|
||||||
|
if !cap_running.load(Ordering::Relaxed) {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
let mut buffers = args.data.channels();
|
||||||
|
if let Some(ch) = buffers.next() {
|
||||||
|
if !logged.swap(true, Ordering::Relaxed) {
|
||||||
|
eprintln!("[vpio] capture callback: {} f32 samples", ch.len());
|
||||||
|
}
|
||||||
|
let mut tmp = [0i16; FRAME_SAMPLES];
|
||||||
|
for chunk in ch.chunks(FRAME_SAMPLES) {
|
||||||
|
let n = chunk.len();
|
||||||
|
for i in 0..n {
|
||||||
|
tmp[i] = (chunk[i].clamp(-1.0, 1.0) * i16::MAX as f32) as i16;
|
||||||
|
}
|
||||||
|
cap_ring.write(&tmp[..n]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.context("failed to set input callback")?;
|
||||||
|
|
||||||
|
// Set up output callback (speaker playback — AEC uses this as reference)
|
||||||
|
let play_ring = playout_ring.clone();
|
||||||
|
au.set_render_callback(
|
||||||
|
move |mut args: render_callback::Args<data::NonInterleaved<f32>>| {
|
||||||
|
let mut buffers = args.data.channels_mut();
|
||||||
|
if let Some(ch) = buffers.next() {
|
||||||
|
let mut tmp = [0i16; FRAME_SAMPLES];
|
||||||
|
for chunk in ch.chunks_mut(FRAME_SAMPLES) {
|
||||||
|
let n = chunk.len();
|
||||||
|
let read = play_ring.read(&mut tmp[..n]);
|
||||||
|
for i in 0..read {
|
||||||
|
chunk[i] = tmp[i] as f32 / i16::MAX as f32;
|
||||||
|
}
|
||||||
|
for i in read..n {
|
||||||
|
chunk[i] = 0.0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.context("failed to set render callback")?;
|
||||||
|
|
||||||
|
au.initialize().context("failed to initialize VoiceProcessingIO")?;
|
||||||
|
au.start().context("failed to start VoiceProcessingIO")?;
|
||||||
|
|
||||||
|
info!("VoiceProcessingIO started (OS-level AEC enabled)");
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
capture_ring,
|
||||||
|
playout_ring,
|
||||||
|
_audio_unit: au,
|
||||||
|
running,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn capture_ring(&self) -> &Arc<AudioRing> {
|
||||||
|
&self.capture_ring
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn playout_ring(&self) -> &Arc<AudioRing> {
|
||||||
|
&self.playout_ring
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn stop(&self) {
|
||||||
|
self.running.store(false, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for VpioAudio {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
332
crates/wzp-client/src/audio_wasapi.rs
Normal file
332
crates/wzp-client/src/audio_wasapi.rs
Normal file
@@ -0,0 +1,332 @@
|
|||||||
|
//! Direct WASAPI microphone capture with Windows's OS-level AEC enabled.
|
||||||
|
//!
|
||||||
|
//! Bypasses CPAL and opens the default capture endpoint directly via
|
||||||
|
//! `IMMDeviceEnumerator` + `IAudioClient2::SetClientProperties`, setting
|
||||||
|
//! `AudioClientProperties.eCategory = AudioCategory_Communications`. That's
|
||||||
|
//! the switch that tells Windows "this is a VoIP call" — the OS then
|
||||||
|
//! enables its communications audio processing chain (AEC, noise
|
||||||
|
//! suppression, automatic gain control) for the stream. AEC operates at
|
||||||
|
//! the OS level using the currently-playing audio as the reference
|
||||||
|
//! signal, so it cancels echo from our CPAL playback (and any other app's
|
||||||
|
//! audio) without us having to plumb a reference signal ourselves.
|
||||||
|
//!
|
||||||
|
//! Platform: Windows only, compiled only when the `windows-aec` feature
|
||||||
|
//! is enabled. Mirrors the public API of `audio_io::AudioCapture` so
|
||||||
|
//! `wzp-client`'s lib.rs can transparently re-export either one as
|
||||||
|
//! `AudioCapture`.
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicBool, Ordering};
|
||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use anyhow::{anyhow, Context};
|
||||||
|
use tracing::{info, warn};
|
||||||
|
use windows::core::{Interface, GUID};
|
||||||
|
use windows::Win32::Foundation::{CloseHandle, BOOL, WAIT_OBJECT_0};
|
||||||
|
use windows::Win32::Media::Audio::{
|
||||||
|
eCapture, eCommunications, AudioCategory_Communications, AudioClientProperties,
|
||||||
|
IAudioCaptureClient, IAudioClient, IAudioClient2, IMMDeviceEnumerator, MMDeviceEnumerator,
|
||||||
|
AUDCLNT_SHAREMODE_SHARED, AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM,
|
||||||
|
AUDCLNT_STREAMFLAGS_EVENTCALLBACK, AUDCLNT_STREAMFLAGS_SRC_DEFAULT_QUALITY, WAVEFORMATEX,
|
||||||
|
WAVE_FORMAT_PCM,
|
||||||
|
};
|
||||||
|
use windows::Win32::System::Com::{
|
||||||
|
CoCreateInstance, CoInitializeEx, CoUninitialize, CLSCTX_ALL, COINIT_MULTITHREADED,
|
||||||
|
};
|
||||||
|
use windows::Win32::System::Threading::{CreateEventW, WaitForSingleObject, INFINITE};
|
||||||
|
|
||||||
|
use crate::audio_ring::AudioRing;
|
||||||
|
|
||||||
|
/// 20 ms at 48 kHz, mono. Matches the rest of the audio pipeline.
|
||||||
|
pub const FRAME_SAMPLES: usize = 960;
|
||||||
|
|
||||||
|
/// Microphone capture via WASAPI with Windows's communications AEC enabled.
|
||||||
|
///
|
||||||
|
/// The WASAPI capture stream runs on a dedicated OS thread. This handle is
|
||||||
|
/// `Send + Sync`. Dropping it stops the stream and joins the thread.
|
||||||
|
pub struct WasapiAudioCapture {
|
||||||
|
ring: Arc<AudioRing>,
|
||||||
|
running: Arc<AtomicBool>,
|
||||||
|
thread: Option<std::thread::JoinHandle<()>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl WasapiAudioCapture {
|
||||||
|
/// Open the default communications microphone, enable OS AEC, and start
|
||||||
|
/// streaming PCM into a lock-free ring buffer.
|
||||||
|
///
|
||||||
|
/// Returns only after the capture thread has successfully initialized
|
||||||
|
/// the stream, or propagates the error back to the caller.
|
||||||
|
pub fn start() -> Result<Self, anyhow::Error> {
|
||||||
|
let ring = Arc::new(AudioRing::new());
|
||||||
|
let running = Arc::new(AtomicBool::new(true));
|
||||||
|
|
||||||
|
let (init_tx, init_rx) = std::sync::mpsc::sync_channel::<Result<(), String>>(1);
|
||||||
|
let ring_cb = ring.clone();
|
||||||
|
let running_cb = running.clone();
|
||||||
|
|
||||||
|
let thread = std::thread::Builder::new()
|
||||||
|
.name("wzp-audio-capture-wasapi".into())
|
||||||
|
.spawn(move || {
|
||||||
|
let result = unsafe { capture_thread_main(ring_cb, running_cb.clone(), &init_tx) };
|
||||||
|
if let Err(e) = result {
|
||||||
|
warn!("wasapi capture thread exited with error: {e}");
|
||||||
|
// If we failed before signaling init, signal now so the
|
||||||
|
// caller unblocks. Double-send is harmless (channel is
|
||||||
|
// bounded to 1 and we only hit the second send path on
|
||||||
|
// late errors).
|
||||||
|
let _ = init_tx.send(Err(e.to_string()));
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.context("failed to spawn WASAPI capture thread")?;
|
||||||
|
|
||||||
|
init_rx
|
||||||
|
.recv()
|
||||||
|
.map_err(|_| anyhow!("WASAPI capture thread exited before signaling init"))?
|
||||||
|
.map_err(|e| anyhow!("{e}"))?;
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
ring,
|
||||||
|
running,
|
||||||
|
thread: Some(thread),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get a reference to the capture ring buffer for direct polling.
|
||||||
|
pub fn ring(&self) -> &Arc<AudioRing> {
|
||||||
|
&self.ring
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stop capturing.
|
||||||
|
pub fn stop(&self) {
|
||||||
|
self.running.store(false, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for WasapiAudioCapture {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.stop();
|
||||||
|
if let Some(handle) = self.thread.take() {
|
||||||
|
// Join best-effort. The thread loop polls `running` every 200ms
|
||||||
|
// via a short WaitForSingleObject timeout, so it should exit
|
||||||
|
// within ~200ms of `stop()`.
|
||||||
|
let _ = handle.join();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// WASAPI thread entry point — everything below this line runs on the
|
||||||
|
// dedicated wzp-audio-capture-wasapi thread.
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
unsafe fn capture_thread_main(
|
||||||
|
ring: Arc<AudioRing>,
|
||||||
|
running: Arc<AtomicBool>,
|
||||||
|
init_tx: &std::sync::mpsc::SyncSender<Result<(), String>>,
|
||||||
|
) -> Result<(), anyhow::Error> {
|
||||||
|
// COM init for the capture thread. MULTITHREADED because we're not
|
||||||
|
// running a message pump. Must be balanced by CoUninitialize on exit.
|
||||||
|
CoInitializeEx(None, COINIT_MULTITHREADED)
|
||||||
|
.ok()
|
||||||
|
.context("CoInitializeEx failed")?;
|
||||||
|
|
||||||
|
// Use a guard struct so CoUninitialize runs even on early returns.
|
||||||
|
struct ComGuard;
|
||||||
|
impl Drop for ComGuard {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
unsafe { CoUninitialize() };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let _com_guard = ComGuard;
|
||||||
|
|
||||||
|
let enumerator: IMMDeviceEnumerator =
|
||||||
|
CoCreateInstance(&MMDeviceEnumerator, None, CLSCTX_ALL)
|
||||||
|
.context("CoCreateInstance(MMDeviceEnumerator) failed")?;
|
||||||
|
|
||||||
|
// eCommunications role (not eConsole) — this picks the device the user
|
||||||
|
// has designated for communications in Sound Settings. It's the one
|
||||||
|
// Windows's AEC is actually tuned for and the one Teams/Zoom use.
|
||||||
|
let device = enumerator
|
||||||
|
.GetDefaultAudioEndpoint(eCapture, eCommunications)
|
||||||
|
.context("GetDefaultAudioEndpoint(eCapture, eCommunications) failed")?;
|
||||||
|
|
||||||
|
if let Ok(name) = device_name(&device) {
|
||||||
|
info!(device = %name, "opening WASAPI communications capture endpoint");
|
||||||
|
}
|
||||||
|
|
||||||
|
let audio_client: IAudioClient = device
|
||||||
|
.Activate(CLSCTX_ALL, None)
|
||||||
|
.context("IMMDevice::Activate(IAudioClient) failed")?;
|
||||||
|
|
||||||
|
// IAudioClient2 exposes SetClientProperties, which is the ONLY way to
|
||||||
|
// set AudioCategory_Communications pre-Initialize. Calling it on the
|
||||||
|
// base IAudioClient would not compile, and setting it after Initialize
|
||||||
|
// is a no-op.
|
||||||
|
let audio_client2: IAudioClient2 = audio_client
|
||||||
|
.cast()
|
||||||
|
.context("QueryInterface IAudioClient2 failed")?;
|
||||||
|
|
||||||
|
let mut props = AudioClientProperties {
|
||||||
|
cbSize: std::mem::size_of::<AudioClientProperties>() as u32,
|
||||||
|
bIsOffload: BOOL(0),
|
||||||
|
eCategory: AudioCategory_Communications,
|
||||||
|
// 0 = AUDCLNT_STREAMOPTIONS_NONE. The `windows` crate doesn't
|
||||||
|
// export the enum constant in all versions, so use 0 directly.
|
||||||
|
Options: Default::default(),
|
||||||
|
};
|
||||||
|
audio_client2
|
||||||
|
.SetClientProperties(&mut props as *mut _)
|
||||||
|
.context("SetClientProperties(AudioCategory_Communications) failed")?;
|
||||||
|
|
||||||
|
// Request 48 kHz mono i16 directly. AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM
|
||||||
|
// tells Windows to do any needed format conversion inside the audio
|
||||||
|
// engine rather than rejecting our format. SRC_DEFAULT_QUALITY picks
|
||||||
|
// the standard Windows resampler quality (fine for voice).
|
||||||
|
let wave_format = WAVEFORMATEX {
|
||||||
|
wFormatTag: WAVE_FORMAT_PCM as u16,
|
||||||
|
nChannels: 1,
|
||||||
|
nSamplesPerSec: 48_000,
|
||||||
|
nAvgBytesPerSec: 48_000 * 2, // 1 ch * 2 bytes/sample * 48000 Hz
|
||||||
|
nBlockAlign: 2, // 1 ch * 2 bytes/sample
|
||||||
|
wBitsPerSample: 16,
|
||||||
|
cbSize: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
// 1,000,000 hns = 100 ms buffer (hns = 100-nanosecond units). Windows
|
||||||
|
// treats this as the minimum; the engine may give us a larger one.
|
||||||
|
const BUFFER_DURATION_HNS: i64 = 1_000_000;
|
||||||
|
|
||||||
|
audio_client
|
||||||
|
.Initialize(
|
||||||
|
AUDCLNT_SHAREMODE_SHARED,
|
||||||
|
AUDCLNT_STREAMFLAGS_EVENTCALLBACK
|
||||||
|
| AUDCLNT_STREAMFLAGS_AUTOCONVERTPCM
|
||||||
|
| AUDCLNT_STREAMFLAGS_SRC_DEFAULT_QUALITY,
|
||||||
|
BUFFER_DURATION_HNS,
|
||||||
|
0,
|
||||||
|
&wave_format,
|
||||||
|
Some(&GUID::zeroed()),
|
||||||
|
)
|
||||||
|
.context("IAudioClient::Initialize failed — Windows rejected communications-mode 48k mono i16")?;
|
||||||
|
|
||||||
|
// Event-driven capture: Windows signals this handle each time a new
|
||||||
|
// audio packet is available. We wait on it from the loop below.
|
||||||
|
let event = CreateEventW(None, false, false, None)
|
||||||
|
.context("CreateEventW failed")?;
|
||||||
|
audio_client
|
||||||
|
.SetEventHandle(event)
|
||||||
|
.context("SetEventHandle failed")?;
|
||||||
|
|
||||||
|
let capture_client: IAudioCaptureClient = audio_client
|
||||||
|
.GetService()
|
||||||
|
.context("IAudioClient::GetService(IAudioCaptureClient) failed")?;
|
||||||
|
|
||||||
|
audio_client.Start().context("IAudioClient::Start failed")?;
|
||||||
|
|
||||||
|
// Signal to the parent thread that init succeeded before entering the
|
||||||
|
// hot loop. From this point on, errors get logged but don't propagate
|
||||||
|
// back to the caller (they'd just cause the ring buffer to stop
|
||||||
|
// filling, which the main thread detects as underruns).
|
||||||
|
let _ = init_tx.send(Ok(()));
|
||||||
|
info!("WASAPI communications-mode capture started with OS AEC enabled");
|
||||||
|
|
||||||
|
let mut logged_first_packet = false;
|
||||||
|
|
||||||
|
// Main capture loop. Exit when `running` goes false (from Drop or an
|
||||||
|
// explicit stop() call).
|
||||||
|
while running.load(Ordering::Relaxed) {
|
||||||
|
// 200 ms timeout so we check `running` regularly even if the audio
|
||||||
|
// engine stops delivering packets (e.g. device unplugged).
|
||||||
|
let wait = WaitForSingleObject(event, 200);
|
||||||
|
if wait.0 != WAIT_OBJECT_0.0 {
|
||||||
|
// Timeout or failure — just loop and re-check running.
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drain all available packets. Windows may have queued more than
|
||||||
|
// one since we were last scheduled.
|
||||||
|
loop {
|
||||||
|
let packet_length = match capture_client.GetNextPacketSize() {
|
||||||
|
Ok(n) => n,
|
||||||
|
Err(e) => {
|
||||||
|
warn!("GetNextPacketSize failed: {e}");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
if packet_length == 0 {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut buffer_ptr: *mut u8 = std::ptr::null_mut();
|
||||||
|
let mut num_frames: u32 = 0;
|
||||||
|
let mut flags: u32 = 0;
|
||||||
|
let mut device_position: u64 = 0;
|
||||||
|
let mut qpc_position: u64 = 0;
|
||||||
|
|
||||||
|
if let Err(e) = capture_client.GetBuffer(
|
||||||
|
&mut buffer_ptr,
|
||||||
|
&mut num_frames,
|
||||||
|
&mut flags,
|
||||||
|
Some(&mut device_position),
|
||||||
|
Some(&mut qpc_position),
|
||||||
|
) {
|
||||||
|
warn!("GetBuffer failed: {e}");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if num_frames > 0 && !buffer_ptr.is_null() {
|
||||||
|
if !logged_first_packet {
|
||||||
|
info!(
|
||||||
|
frames = num_frames,
|
||||||
|
flags, "WASAPI capture: first packet received"
|
||||||
|
);
|
||||||
|
logged_first_packet = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Because we asked for 48 kHz mono i16, each frame is
|
||||||
|
// exactly one i16. Windows's AUTOCONVERTPCM handles the
|
||||||
|
// conversion from whatever the engine mix format is.
|
||||||
|
let samples = std::slice::from_raw_parts(
|
||||||
|
buffer_ptr as *const i16,
|
||||||
|
num_frames as usize,
|
||||||
|
);
|
||||||
|
ring.write(samples);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Err(e) = capture_client.ReleaseBuffer(num_frames) {
|
||||||
|
warn!("ReleaseBuffer failed: {e}");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
info!("WASAPI capture thread stopping");
|
||||||
|
let _ = audio_client.Stop();
|
||||||
|
let _ = CloseHandle(event);
|
||||||
|
// _com_guard drops here, calling CoUninitialize.
|
||||||
|
|
||||||
|
// Silence INFINITE unused-import warning — it's referenced by the
|
||||||
|
// `windows` crate's WaitForSingleObject alternative but we use the
|
||||||
|
// 200 ms timeout variant instead. Explicit suppression for clarity.
|
||||||
|
let _ = INFINITE;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Helpers
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/// Best-effort device ID string for logging. Grabbing the friendly name via
|
||||||
|
/// PKEY_Device_FriendlyName requires IPropertyStore + PROPVARIANT plumbing
|
||||||
|
/// that's far more ceremony than a log line justifies; the ID is already
|
||||||
|
/// sufficient to confirm we opened the right endpoint.
|
||||||
|
///
|
||||||
|
/// Rust 2024 edition's `unsafe_op_in_unsafe_fn` lint requires explicit
|
||||||
|
/// `unsafe { ... }` blocks inside `unsafe fn` bodies for each unsafe call,
|
||||||
|
/// even though the whole function is already marked unsafe.
|
||||||
|
unsafe fn device_name(
|
||||||
|
device: &windows::Win32::Media::Audio::IMMDevice,
|
||||||
|
) -> Result<String, anyhow::Error> {
|
||||||
|
let id = unsafe { device.GetId() }.context("IMMDevice::GetId failed")?;
|
||||||
|
Ok(unsafe { id.to_string() }.unwrap_or_else(|_| "<non-utf16>".to_string()))
|
||||||
|
}
|
||||||
@@ -7,14 +7,15 @@ use std::time::{Duration, Instant};
|
|||||||
use bytes::Bytes;
|
use bytes::Bytes;
|
||||||
use tracing::{debug, info, warn};
|
use tracing::{debug, info, warn};
|
||||||
|
|
||||||
use wzp_codec::{AutoGainControl, ComfortNoise, EchoCanceller, NoiseSupressor, SilenceDetector};
|
use wzp_codec::dred_ffi::{DredDecoderHandle, DredState};
|
||||||
|
use wzp_codec::{
|
||||||
|
AdaptiveDecoder, AutoGainControl, ComfortNoise, EchoCanceller, NoiseSupressor, SilenceDetector,
|
||||||
|
};
|
||||||
use wzp_fec::{RaptorQFecDecoder, RaptorQFecEncoder};
|
use wzp_fec::{RaptorQFecDecoder, RaptorQFecEncoder};
|
||||||
use wzp_proto::jitter::{JitterBuffer, PlayoutResult};
|
use wzp_proto::jitter::{JitterBuffer, PlayoutResult};
|
||||||
use wzp_proto::packet::{MediaHeader, MediaPacket, MiniFrameContext};
|
use wzp_proto::packet::{MediaHeader, MediaPacket, MiniFrameContext};
|
||||||
use wzp_proto::quality::AdaptiveQualityController;
|
use wzp_proto::quality::AdaptiveQualityController;
|
||||||
use wzp_proto::traits::{
|
use wzp_proto::traits::{AudioDecoder, AudioEncoder, FecDecoder, FecEncoder};
|
||||||
AudioDecoder, AudioEncoder, FecDecoder, FecEncoder,
|
|
||||||
};
|
|
||||||
use wzp_proto::packet::QualityReport;
|
use wzp_proto::packet::QualityReport;
|
||||||
use wzp_proto::{CodecId, QualityProfile};
|
use wzp_proto::{CodecId, QualityProfile};
|
||||||
|
|
||||||
@@ -42,6 +43,9 @@ pub struct CallConfig {
|
|||||||
/// When enabled, only every 50th frame carries a full 12-byte MediaHeader;
|
/// When enabled, only every 50th frame carries a full 12-byte MediaHeader;
|
||||||
/// intermediate frames use a compact 4-byte MiniHeader.
|
/// intermediate frames use a compact 4-byte MiniHeader.
|
||||||
pub mini_frames_enabled: bool,
|
pub mini_frames_enabled: bool,
|
||||||
|
/// AEC far-end delay compensation in milliseconds (default: 40).
|
||||||
|
/// Compensates for the round-trip audio latency from playout to mic capture.
|
||||||
|
pub aec_delay_ms: u32,
|
||||||
/// Enable adaptive jitter buffer (default: true).
|
/// Enable adaptive jitter buffer (default: true).
|
||||||
///
|
///
|
||||||
/// When true, the jitter buffer target depth is automatically adjusted
|
/// When true, the jitter buffer target depth is automatically adjusted
|
||||||
@@ -63,6 +67,7 @@ impl Default for CallConfig {
|
|||||||
noise_suppression: true,
|
noise_suppression: true,
|
||||||
mini_frames_enabled: true,
|
mini_frames_enabled: true,
|
||||||
adaptive_jitter: true,
|
adaptive_jitter: true,
|
||||||
|
aec_delay_ms: 40,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -241,7 +246,7 @@ impl CallEncoder {
|
|||||||
block_id: 0,
|
block_id: 0,
|
||||||
frame_in_block: 0,
|
frame_in_block: 0,
|
||||||
timestamp_ms: 0,
|
timestamp_ms: 0,
|
||||||
aec: EchoCanceller::new(48000, 100), // 100 ms echo tail
|
aec: EchoCanceller::with_delay(48000, 60, config.aec_delay_ms),
|
||||||
agc: AutoGainControl::new(),
|
agc: AutoGainControl::new(),
|
||||||
silence_detector: SilenceDetector::new(
|
silence_detector: SilenceDetector::new(
|
||||||
config.silence_threshold_rms,
|
config.silence_threshold_rms,
|
||||||
@@ -340,6 +345,22 @@ impl CallEncoder {
|
|||||||
let enc_len = self.audio_enc.encode(pcm, &mut encoded)?;
|
let enc_len = self.audio_enc.encode(pcm, &mut encoded)?;
|
||||||
encoded.truncate(enc_len);
|
encoded.truncate(enc_len);
|
||||||
|
|
||||||
|
// Phase 2: Opus tiers bypass RaptorQ entirely (DRED handles loss
|
||||||
|
// recovery at the codec layer). Codec2 tiers keep RaptorQ unchanged.
|
||||||
|
// On Opus packets, zero the FEC header fields so old receivers
|
||||||
|
// can cleanly identify "no RaptorQ block to assemble" and new
|
||||||
|
// receivers can short-circuit their FEC ingest path.
|
||||||
|
let is_opus = self.profile.codec.is_opus();
|
||||||
|
let (fec_block, fec_symbol, fec_ratio_encoded) = if is_opus {
|
||||||
|
(0u8, 0u8, 0u8)
|
||||||
|
} else {
|
||||||
|
(
|
||||||
|
self.block_id,
|
||||||
|
self.frame_in_block,
|
||||||
|
MediaHeader::encode_fec_ratio(self.profile.fec_ratio),
|
||||||
|
)
|
||||||
|
};
|
||||||
|
|
||||||
// Build source media packet
|
// Build source media packet
|
||||||
let source_pkt = MediaPacket {
|
let source_pkt = MediaPacket {
|
||||||
header: MediaHeader {
|
header: MediaHeader {
|
||||||
@@ -347,11 +368,11 @@ impl CallEncoder {
|
|||||||
is_repair: false,
|
is_repair: false,
|
||||||
codec_id: self.profile.codec,
|
codec_id: self.profile.codec,
|
||||||
has_quality_report: false,
|
has_quality_report: false,
|
||||||
fec_ratio_encoded: MediaHeader::encode_fec_ratio(self.profile.fec_ratio),
|
fec_ratio_encoded,
|
||||||
seq: self.seq,
|
seq: self.seq,
|
||||||
timestamp: self.timestamp_ms,
|
timestamp: self.timestamp_ms,
|
||||||
fec_block: self.block_id,
|
fec_block,
|
||||||
fec_symbol: self.frame_in_block,
|
fec_symbol,
|
||||||
reserved: 0,
|
reserved: 0,
|
||||||
csrc_count: 0,
|
csrc_count: 0,
|
||||||
},
|
},
|
||||||
@@ -366,11 +387,13 @@ impl CallEncoder {
|
|||||||
|
|
||||||
let mut output = vec![source_pkt];
|
let mut output = vec![source_pkt];
|
||||||
|
|
||||||
// Add to FEC encoder
|
// Codec2-only: feed RaptorQ and generate repair packets when the
|
||||||
|
// block is full. Opus tiers skip this entire block — DRED (active
|
||||||
|
// in Phase 1) provides codec-layer loss recovery.
|
||||||
|
if !is_opus {
|
||||||
self.fec_enc.add_source_symbol(&encoded)?;
|
self.fec_enc.add_source_symbol(&encoded)?;
|
||||||
self.frame_in_block += 1;
|
self.frame_in_block += 1;
|
||||||
|
|
||||||
// If block is full, generate repair and finalize
|
|
||||||
if self.frame_in_block >= self.profile.frames_per_block {
|
if self.frame_in_block >= self.profile.frames_per_block {
|
||||||
if let Ok(repairs) = self.fec_enc.generate_repair(self.profile.fec_ratio) {
|
if let Ok(repairs) = self.fec_enc.generate_repair(self.profile.fec_ratio) {
|
||||||
for (sym_idx, repair_data) in repairs {
|
for (sym_idx, repair_data) in repairs {
|
||||||
@@ -400,6 +423,7 @@ impl CallEncoder {
|
|||||||
self.block_id = self.block_id.wrapping_add(1);
|
self.block_id = self.block_id.wrapping_add(1);
|
||||||
self.frame_in_block = 0;
|
self.frame_in_block = 0;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
Ok(output)
|
Ok(output)
|
||||||
}
|
}
|
||||||
@@ -434,9 +458,12 @@ impl CallEncoder {
|
|||||||
|
|
||||||
/// Manages the recv/decode side of a call.
|
/// Manages the recv/decode side of a call.
|
||||||
pub struct CallDecoder {
|
pub struct CallDecoder {
|
||||||
/// Audio decoder.
|
/// Audio decoder. Concrete `AdaptiveDecoder` (not `Box<dyn AudioDecoder>`)
|
||||||
audio_dec: Box<dyn AudioDecoder>,
|
/// because Phase 3b calls the inherent `reconstruct_from_dred` method,
|
||||||
/// FEC decoder.
|
/// which cannot live on the `AudioDecoder` trait without dragging libopus
|
||||||
|
/// types into `wzp-proto`.
|
||||||
|
audio_dec: AdaptiveDecoder,
|
||||||
|
/// FEC decoder (Codec2 tiers only; Opus bypasses RaptorQ per Phase 2).
|
||||||
fec_dec: RaptorQFecDecoder,
|
fec_dec: RaptorQFecDecoder,
|
||||||
/// Jitter buffer.
|
/// Jitter buffer.
|
||||||
jitter: JitterBuffer,
|
jitter: JitterBuffer,
|
||||||
@@ -450,6 +477,24 @@ pub struct CallDecoder {
|
|||||||
last_was_cn: bool,
|
last_was_cn: bool,
|
||||||
/// Mini-frame decompression context (tracks last full header baseline).
|
/// Mini-frame decompression context (tracks last full header baseline).
|
||||||
mini_context: MiniFrameContext,
|
mini_context: MiniFrameContext,
|
||||||
|
// ─── Phase 3b: DRED reconstruction state ──────────────────────────────
|
||||||
|
/// DRED side-channel parser (a separate libopus object from the decoder).
|
||||||
|
dred_decoder: DredDecoderHandle,
|
||||||
|
/// Scratch buffer used by `dred_decoder.parse_into` on every arriving
|
||||||
|
/// Opus packet. Reused across calls to avoid 10 KB alloc churn per packet.
|
||||||
|
dred_parse_scratch: DredState,
|
||||||
|
/// Cached "most recently parsed valid" DRED state, swapped with
|
||||||
|
/// `dred_parse_scratch` on successful parse. Used by `decode_next` when
|
||||||
|
/// the jitter buffer reports a gap.
|
||||||
|
last_good_dred: DredState,
|
||||||
|
/// Sequence number of the packet that produced `last_good_dred`. `None`
|
||||||
|
/// if no packet has yielded DRED state yet (cold start or legacy sender).
|
||||||
|
last_good_dred_seq: Option<u16>,
|
||||||
|
/// Phase 4 telemetry counter: gaps recovered via DRED reconstruction.
|
||||||
|
pub dred_reconstructions: u64,
|
||||||
|
/// Phase 4 telemetry counter: gaps filled via classical Opus PLC
|
||||||
|
/// (because no DRED state covered the gap, or the active codec is Codec2).
|
||||||
|
pub classical_plc_invocations: u64,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CallDecoder {
|
impl CallDecoder {
|
||||||
@@ -459,8 +504,19 @@ impl CallDecoder {
|
|||||||
} else {
|
} else {
|
||||||
JitterBuffer::new(config.jitter_target, config.jitter_max, config.jitter_min)
|
JitterBuffer::new(config.jitter_target, config.jitter_max, config.jitter_min)
|
||||||
};
|
};
|
||||||
|
// Phase 3b: build the DRED parser + state buffers. These allocate
|
||||||
|
// libopus state (~10 KB each) once per call, not per packet — the
|
||||||
|
// scratch and last-good buffers are reused via std::mem::swap on
|
||||||
|
// every successful parse.
|
||||||
|
let dred_decoder =
|
||||||
|
DredDecoderHandle::new().expect("opus_dred_decoder_create failed at call setup");
|
||||||
|
let dred_parse_scratch =
|
||||||
|
DredState::new().expect("opus_dred_alloc failed at call setup (scratch)");
|
||||||
|
let last_good_dred =
|
||||||
|
DredState::new().expect("opus_dred_alloc failed at call setup (good state)");
|
||||||
Self {
|
Self {
|
||||||
audio_dec: wzp_codec::create_decoder(config.profile),
|
audio_dec: AdaptiveDecoder::new(config.profile)
|
||||||
|
.expect("failed to create adaptive decoder"),
|
||||||
fec_dec: wzp_fec::create_decoder(&config.profile),
|
fec_dec: wzp_fec::create_decoder(&config.profile),
|
||||||
jitter,
|
jitter,
|
||||||
quality: AdaptiveQualityController::new(),
|
quality: AdaptiveQualityController::new(),
|
||||||
@@ -468,6 +524,12 @@ impl CallDecoder {
|
|||||||
comfort_noise: ComfortNoise::new(50),
|
comfort_noise: ComfortNoise::new(50),
|
||||||
last_was_cn: false,
|
last_was_cn: false,
|
||||||
mini_context: MiniFrameContext::default(),
|
mini_context: MiniFrameContext::default(),
|
||||||
|
dred_decoder,
|
||||||
|
dred_parse_scratch,
|
||||||
|
last_good_dred,
|
||||||
|
last_good_dred_seq: None,
|
||||||
|
dred_reconstructions: 0,
|
||||||
|
classical_plc_invocations: 0,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -482,20 +544,105 @@ impl CallDecoder {
|
|||||||
|
|
||||||
/// Feed a received media packet into the decode pipeline.
|
/// Feed a received media packet into the decode pipeline.
|
||||||
pub fn ingest(&mut self, packet: MediaPacket) {
|
pub fn ingest(&mut self, packet: MediaPacket) {
|
||||||
// Feed to FEC decoder
|
// Phase 2: Opus packets bypass RaptorQ. Codec2 packets still feed
|
||||||
|
// the FEC decoder for recovery. This also cleanly drops any stray
|
||||||
|
// Opus repair packets from an old sender (we don't push repair
|
||||||
|
// packets to the jitter buffer either, so they're effectively
|
||||||
|
// ignored — a graceful mixed-version degradation).
|
||||||
|
if !packet.header.codec_id.is_opus() {
|
||||||
let _ = self.fec_dec.add_symbol(
|
let _ = self.fec_dec.add_symbol(
|
||||||
packet.header.fec_block,
|
packet.header.fec_block,
|
||||||
packet.header.fec_symbol,
|
packet.header.fec_symbol,
|
||||||
packet.header.is_repair,
|
packet.header.is_repair,
|
||||||
&packet.payload,
|
&packet.payload,
|
||||||
);
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// If not a repair packet, also feed directly to jitter buffer
|
// Phase 3b: Opus source packets carry DRED side-channel data in
|
||||||
|
// libopus 1.5. Parse it into the scratch state and, on success,
|
||||||
|
// swap with the cached `last_good_dred` so later gap reconstruction
|
||||||
|
// has fresh neural redundancy to draw from. Parsing happens before
|
||||||
|
// the jitter push because the jitter buffer consumes the packet.
|
||||||
|
if packet.header.codec_id.is_opus() && !packet.header.is_repair {
|
||||||
|
match self
|
||||||
|
.dred_decoder
|
||||||
|
.parse_into(&mut self.dred_parse_scratch, &packet.payload)
|
||||||
|
{
|
||||||
|
Ok(available) if available > 0 => {
|
||||||
|
// Swap the freshly parsed state into `last_good_dred`.
|
||||||
|
// The old good state (now in scratch) is about to be
|
||||||
|
// overwritten on the next parse — its contents are
|
||||||
|
// not needed after this swap.
|
||||||
|
std::mem::swap(&mut self.dred_parse_scratch, &mut self.last_good_dred);
|
||||||
|
self.last_good_dred_seq = Some(packet.header.seq);
|
||||||
|
}
|
||||||
|
Ok(_) => {
|
||||||
|
// Packet had no DRED data (return 0). Leave the cached
|
||||||
|
// state untouched — it may still cover upcoming gaps
|
||||||
|
// from a warm-up period where the encoder was producing
|
||||||
|
// DRED bytes. The scratch buffer was potentially written
|
||||||
|
// but its `samples_available` is 0 so it's harmless.
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
debug!("DRED parse error (ignored): {e}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Source packets (Opus or Codec2) go to the jitter buffer for decode.
|
||||||
|
// Repair packets never reach the jitter buffer; for Codec2 they're
|
||||||
|
// used by the FEC decoder above, for Opus they're dropped here.
|
||||||
if !packet.header.is_repair {
|
if !packet.header.is_repair {
|
||||||
self.jitter.push(packet);
|
self.jitter.push(packet);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Switch the decoder to match an incoming packet's codec if it differs
|
||||||
|
/// from the current profile. This enables cross-codec interop (e.g. one
|
||||||
|
/// client sends Opus, the other sends Codec2).
|
||||||
|
fn switch_decoder_if_needed(&mut self, incoming_codec: CodecId) {
|
||||||
|
if incoming_codec == self.profile.codec || incoming_codec == CodecId::ComfortNoise {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let new_profile = Self::profile_for_codec(incoming_codec);
|
||||||
|
info!(
|
||||||
|
from = ?self.profile.codec,
|
||||||
|
to = ?incoming_codec,
|
||||||
|
"decoder switching codec to match incoming packet"
|
||||||
|
);
|
||||||
|
if let Err(e) = self.audio_dec.set_profile(new_profile) {
|
||||||
|
warn!("failed to switch decoder profile: {e}");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
self.fec_dec = wzp_fec::create_decoder(&new_profile);
|
||||||
|
self.profile = new_profile;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Map a `CodecId` to a reasonable `QualityProfile` for decoding.
|
||||||
|
fn profile_for_codec(codec: CodecId) -> QualityProfile {
|
||||||
|
match codec {
|
||||||
|
CodecId::Opus24k => QualityProfile::GOOD,
|
||||||
|
CodecId::Opus16k => QualityProfile {
|
||||||
|
codec: CodecId::Opus16k,
|
||||||
|
fec_ratio: 0.3,
|
||||||
|
frame_duration_ms: 20,
|
||||||
|
frames_per_block: 5,
|
||||||
|
},
|
||||||
|
CodecId::Opus6k => QualityProfile::DEGRADED,
|
||||||
|
CodecId::Opus32k => QualityProfile::STUDIO_32K,
|
||||||
|
CodecId::Opus48k => QualityProfile::STUDIO_48K,
|
||||||
|
CodecId::Opus64k => QualityProfile::STUDIO_64K,
|
||||||
|
CodecId::Codec2_3200 => QualityProfile {
|
||||||
|
codec: CodecId::Codec2_3200,
|
||||||
|
fec_ratio: 0.5,
|
||||||
|
frame_duration_ms: 20,
|
||||||
|
frames_per_block: 5,
|
||||||
|
},
|
||||||
|
CodecId::Codec2_1200 => QualityProfile::CATASTROPHIC,
|
||||||
|
CodecId::ComfortNoise => QualityProfile::GOOD,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Decode the next audio frame from the jitter buffer.
|
/// Decode the next audio frame from the jitter buffer.
|
||||||
///
|
///
|
||||||
/// Returns PCM samples (48kHz mono) or None if not ready.
|
/// Returns PCM samples (48kHz mono) or None if not ready.
|
||||||
@@ -510,6 +657,9 @@ impl CallDecoder {
|
|||||||
return Some(pcm.len());
|
return Some(pcm.len());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Auto-switch decoder if incoming codec differs from current.
|
||||||
|
self.switch_decoder_if_needed(pkt.header.codec_id);
|
||||||
|
|
||||||
self.last_was_cn = false;
|
self.last_was_cn = false;
|
||||||
let result = match self.audio_dec.decode(&pkt.payload, pcm) {
|
let result = match self.audio_dec.decode(&pkt.payload, pcm) {
|
||||||
Ok(n) => Some(n),
|
Ok(n) => Some(n),
|
||||||
@@ -524,19 +674,72 @@ impl CallDecoder {
|
|||||||
result
|
result
|
||||||
}
|
}
|
||||||
PlayoutResult::Missing { seq } => {
|
PlayoutResult::Missing { seq } => {
|
||||||
// Only generate PLC if there are still packets buffered ahead.
|
// Only attempt recovery if there are still packets buffered ahead.
|
||||||
// Otherwise we've drained everything — return None to stop.
|
// Otherwise we've drained everything — return None to stop.
|
||||||
if self.jitter.depth() > 0 {
|
if self.jitter.depth() == 0 {
|
||||||
debug!(seq, "packet loss, generating PLC");
|
self.jitter.record_underrun();
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Phase 3b: try DRED reconstruction first. If we have a
|
||||||
|
// recent DRED state from a packet whose seq > missing seq,
|
||||||
|
// and the seq delta (in samples) fits within the state's
|
||||||
|
// available window, libopus can synthesize a plausible
|
||||||
|
// replacement for the lost frame. Fall back to classical
|
||||||
|
// PLC when no state covers the gap, when the active codec
|
||||||
|
// is Codec2, or when the reconstruction itself errors.
|
||||||
|
if self.profile.codec.is_opus() {
|
||||||
|
if let Some(last_seq) = self.last_good_dred_seq {
|
||||||
|
// How many frames ahead of the missing seq is the
|
||||||
|
// last-good packet? Use wrapping arithmetic for the
|
||||||
|
// u16 seq space.
|
||||||
|
let seq_delta = last_seq.wrapping_sub(seq);
|
||||||
|
// Reject stale or backward state. u16 wraparound
|
||||||
|
// would make a "seq went backward" delta very large;
|
||||||
|
// cap at a sane forward-looking window.
|
||||||
|
const MAX_SEQ_DELTA: u16 = 128;
|
||||||
|
if seq_delta > 0 && seq_delta <= MAX_SEQ_DELTA {
|
||||||
|
let frame_samples =
|
||||||
|
(48_000 * self.profile.frame_duration_ms as i32) / 1000;
|
||||||
|
let offset_samples = seq_delta as i32 * frame_samples;
|
||||||
|
let available = self.last_good_dred.samples_available();
|
||||||
|
if offset_samples > 0 && offset_samples <= available {
|
||||||
|
match self.audio_dec.reconstruct_from_dred(
|
||||||
|
&self.last_good_dred,
|
||||||
|
offset_samples,
|
||||||
|
pcm,
|
||||||
|
) {
|
||||||
|
Ok(n) => {
|
||||||
|
self.dred_reconstructions += 1;
|
||||||
|
self.jitter.record_decode();
|
||||||
|
debug!(
|
||||||
|
seq,
|
||||||
|
last_seq,
|
||||||
|
offset_samples,
|
||||||
|
available,
|
||||||
|
"DRED reconstruction for gap"
|
||||||
|
);
|
||||||
|
return Some(n);
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
// Reconstruction failed — fall
|
||||||
|
// through to classical PLC below.
|
||||||
|
debug!(seq, "DRED reconstruct error: {e}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Classical PLC fallback (also the Codec2 path).
|
||||||
|
debug!(seq, "packet loss, generating classical PLC");
|
||||||
|
self.classical_plc_invocations += 1;
|
||||||
let result = self.audio_dec.decode_lost(pcm).ok();
|
let result = self.audio_dec.decode_lost(pcm).ok();
|
||||||
if result.is_some() {
|
if result.is_some() {
|
||||||
self.jitter.record_decode();
|
self.jitter.record_decode();
|
||||||
}
|
}
|
||||||
result
|
result
|
||||||
} else {
|
|
||||||
self.jitter.record_underrun();
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
PlayoutResult::NotReady => {
|
PlayoutResult::NotReady => {
|
||||||
self.jitter.record_underrun();
|
self.jitter.record_underrun();
|
||||||
@@ -559,6 +762,19 @@ impl CallDecoder {
|
|||||||
pub fn reset_stats(&mut self) {
|
pub fn reset_stats(&mut self) {
|
||||||
self.jitter.reset_stats();
|
self.jitter.reset_stats();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Phase 3b introspection: sequence number of the most recently parsed
|
||||||
|
/// valid DRED state, or `None` if no Opus packet has yielded DRED data
|
||||||
|
/// yet. Used by tests to debug reconstruction eligibility.
|
||||||
|
pub fn last_good_dred_seq(&self) -> Option<u16> {
|
||||||
|
self.last_good_dred_seq
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 3b introspection: samples of audio history currently available
|
||||||
|
/// in the cached DRED state.
|
||||||
|
pub fn last_good_dred_samples_available(&self) -> i32 {
|
||||||
|
self.last_good_dred.samples_available()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Periodic telemetry logger for jitter buffer statistics.
|
/// Periodic telemetry logger for jitter buffer statistics.
|
||||||
@@ -620,18 +836,83 @@ mod tests {
|
|||||||
assert!(!packets[0].header.is_repair);
|
assert!(!packets[0].header.is_repair);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Phase 2: Opus packets have zero FEC header fields — no block, no
|
||||||
|
/// symbol index, no repair ratio. The RaptorQ layer is bypassed
|
||||||
|
/// entirely on the Opus tiers.
|
||||||
#[test]
|
#[test]
|
||||||
fn encoder_generates_repair_on_full_block() {
|
fn opus_source_packets_have_zero_fec_header_fields() {
|
||||||
let config = CallConfig {
|
let config = CallConfig {
|
||||||
profile: QualityProfile::GOOD, // 5 frames/block
|
profile: QualityProfile::GOOD, // Opus 24k
|
||||||
|
suppression_enabled: false, // skip silence gate for this test
|
||||||
..Default::default()
|
..Default::default()
|
||||||
};
|
};
|
||||||
let mut enc = CallEncoder::new(&config);
|
let mut enc = CallEncoder::new(&config);
|
||||||
let pcm = vec![0i16; 960];
|
// Non-silent sine wave so silence detection doesn't suppress us
|
||||||
|
// even with suppression_enabled=false (belt and braces).
|
||||||
|
let pcm: Vec<i16> = (0..960)
|
||||||
|
.map(|i| ((i as f32 * 0.1).sin() * 10_000.0) as i16)
|
||||||
|
.collect();
|
||||||
|
let packets = enc.encode_frame(&pcm).unwrap();
|
||||||
|
assert_eq!(packets.len(), 1, "Opus must emit exactly 1 source packet");
|
||||||
|
let hdr = &packets[0].header;
|
||||||
|
assert!(hdr.codec_id.is_opus());
|
||||||
|
assert!(!hdr.is_repair);
|
||||||
|
assert_eq!(hdr.fec_block, 0, "Opus fec_block must be 0");
|
||||||
|
assert_eq!(hdr.fec_symbol, 0, "Opus fec_symbol must be 0");
|
||||||
|
assert_eq!(hdr.fec_ratio_encoded, 0, "Opus fec_ratio_encoded must be 0");
|
||||||
|
}
|
||||||
|
|
||||||
let mut total_packets = 0;
|
/// Phase 2: Opus never emits repair packets, regardless of how many
|
||||||
let mut repair_count = 0;
|
/// source frames are fed in. DRED (Phase 1) provides loss recovery at
|
||||||
for _ in 0..5 {
|
/// the codec layer; RaptorQ is disabled on Opus tiers.
|
||||||
|
#[test]
|
||||||
|
fn opus_encoder_never_emits_repair_packets() {
|
||||||
|
let config = CallConfig {
|
||||||
|
profile: QualityProfile::GOOD, // 5 frames/block in the Codec2 sense
|
||||||
|
suppression_enabled: false,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let mut enc = CallEncoder::new(&config);
|
||||||
|
let pcm: Vec<i16> = (0..960)
|
||||||
|
.map(|i| ((i as f32 * 0.1).sin() * 10_000.0) as i16)
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
// Encode well beyond a block boundary to prove no repair ever comes out.
|
||||||
|
let mut total_packets = 0usize;
|
||||||
|
let mut repair_count = 0usize;
|
||||||
|
for _ in 0..20 {
|
||||||
|
let packets = enc.encode_frame(&pcm).unwrap();
|
||||||
|
total_packets += packets.len();
|
||||||
|
repair_count += packets.iter().filter(|p| p.header.is_repair).count();
|
||||||
|
}
|
||||||
|
assert_eq!(repair_count, 0, "Opus must emit zero repair packets");
|
||||||
|
assert_eq!(
|
||||||
|
total_packets, 20,
|
||||||
|
"20 source frames → 20 source packets (1:1, no RaptorQ expansion)"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 2: Codec2 still emits repair packets with RaptorQ ratio unchanged.
|
||||||
|
/// DRED is libopus-only and does not apply here, so RaptorQ is still the
|
||||||
|
/// primary loss-recovery mechanism on Codec2 tiers.
|
||||||
|
#[test]
|
||||||
|
fn codec2_encoder_generates_repair_on_full_block() {
|
||||||
|
let config = CallConfig {
|
||||||
|
profile: QualityProfile::CATASTROPHIC, // Codec2 1200, 8 frames/block, ratio 1.0
|
||||||
|
suppression_enabled: false,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let mut enc = CallEncoder::new(&config);
|
||||||
|
// Codec2 takes 48 kHz samples and downsamples internally.
|
||||||
|
// CATASTROPHIC uses 40 ms frames → 1920 samples.
|
||||||
|
let pcm: Vec<i16> = (0..1920)
|
||||||
|
.map(|i| ((i as f32 * 0.1).sin() * 10_000.0) as i16)
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
let mut total_packets = 0usize;
|
||||||
|
let mut repair_count = 0usize;
|
||||||
|
// Run long enough to cross the 8-frame block boundary and see repairs.
|
||||||
|
for _ in 0..16 {
|
||||||
let packets = enc.encode_frame(&pcm).unwrap();
|
let packets = enc.encode_frame(&pcm).unwrap();
|
||||||
for p in &packets {
|
for p in &packets {
|
||||||
if p.header.is_repair {
|
if p.header.is_repair {
|
||||||
@@ -640,8 +921,10 @@ mod tests {
|
|||||||
}
|
}
|
||||||
total_packets += packets.len();
|
total_packets += packets.len();
|
||||||
}
|
}
|
||||||
assert!(repair_count > 0, "should have repair packets after full block");
|
assert!(
|
||||||
assert!(total_packets > 5, "total {total_packets} should exceed 5 source");
|
repair_count > 0,
|
||||||
|
"Codec2 must still emit repair packets (got {repair_count} repairs, {total_packets} total)"
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -672,6 +955,219 @@ mod tests {
|
|||||||
assert!(dec.decode_next(&mut pcm).is_none());
|
assert!(dec.decode_next(&mut pcm).is_none());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ─── Phase 3b — DRED reconstruction on packet loss ────────────────────
|
||||||
|
|
||||||
|
/// Helper: create a CallEncoder/CallDecoder pair with the given profile
|
||||||
|
/// and silence suppression disabled so silence-detection doesn't drop
|
||||||
|
/// our synthetic test frames.
|
||||||
|
fn encoder_decoder_pair(profile: QualityProfile) -> (CallEncoder, CallDecoder) {
|
||||||
|
let config = CallConfig {
|
||||||
|
profile,
|
||||||
|
suppression_enabled: false,
|
||||||
|
// Small jitter buffer so decode_next drains quickly in tests.
|
||||||
|
jitter_min: 2,
|
||||||
|
jitter_target: 3,
|
||||||
|
jitter_max: 20,
|
||||||
|
adaptive_jitter: false,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
(CallEncoder::new(&config), CallDecoder::new(&config))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Helper: generate a non-silent 20 ms frame of 300 Hz sine at the
|
||||||
|
/// given sample offset so consecutive frames form a continuous tone.
|
||||||
|
fn voice_frame_20ms(sample_offset: usize) -> Vec<i16> {
|
||||||
|
(0..960)
|
||||||
|
.map(|i| {
|
||||||
|
let t = (sample_offset + i) as f64 / 48_000.0;
|
||||||
|
(8000.0 * (2.0 * std::f64::consts::PI * 300.0 * t).sin()) as i16
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 3b probe: sweep packet_loss_perc values to find the minimum
|
||||||
|
/// that produces a samples_available ≥ 960 (enough to reconstruct a
|
||||||
|
/// single 20 ms Opus frame). This guides the production loss floor.
|
||||||
|
#[test]
|
||||||
|
#[ignore] // diagnostic only — run with `cargo test ... -- --ignored --nocapture`
|
||||||
|
fn probe_dred_samples_available_by_loss_floor() {
|
||||||
|
use wzp_codec::opus_enc::OpusEncoder;
|
||||||
|
use wzp_proto::traits::AudioEncoder;
|
||||||
|
|
||||||
|
for loss_pct in [5u8, 10, 15, 20, 25, 40, 60, 80].iter().copied() {
|
||||||
|
let mut enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
enc.set_expected_loss(loss_pct);
|
||||||
|
let (_drop_enc, mut dec) = encoder_decoder_pair(QualityProfile::GOOD);
|
||||||
|
|
||||||
|
for i in 0..60u16 {
|
||||||
|
let pcm = voice_frame_20ms(i as usize * 960);
|
||||||
|
let mut encoded = vec![0u8; 512];
|
||||||
|
let n = enc.encode(&pcm, &mut encoded).unwrap();
|
||||||
|
encoded.truncate(n);
|
||||||
|
let pkt = MediaPacket {
|
||||||
|
header: MediaHeader {
|
||||||
|
version: 0,
|
||||||
|
is_repair: false,
|
||||||
|
codec_id: CodecId::Opus24k,
|
||||||
|
has_quality_report: false,
|
||||||
|
fec_ratio_encoded: 0,
|
||||||
|
seq: i,
|
||||||
|
timestamp: (i as u32) * 20,
|
||||||
|
fec_block: 0,
|
||||||
|
fec_symbol: 0,
|
||||||
|
reserved: 0,
|
||||||
|
csrc_count: 0,
|
||||||
|
},
|
||||||
|
payload: Bytes::from(encoded),
|
||||||
|
quality_report: None,
|
||||||
|
};
|
||||||
|
dec.ingest(pkt);
|
||||||
|
}
|
||||||
|
eprintln!(
|
||||||
|
"[phase3b probe] loss_pct={loss_pct} samples_available={}",
|
||||||
|
dec.last_good_dred_samples_available()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 3b: simulated single-packet loss on an Opus call triggers a
|
||||||
|
/// DRED reconstruction rather than a classical PLC fill. Runs the full
|
||||||
|
/// encode → ingest → decode_next pipeline.
|
||||||
|
#[test]
|
||||||
|
fn opus_single_packet_loss_is_recovered_via_dred() {
|
||||||
|
let (mut enc, mut dec) = encoder_decoder_pair(QualityProfile::GOOD);
|
||||||
|
|
||||||
|
// Warm-up: encode and ingest 60 frames (1.2 s) so the DRED emitter
|
||||||
|
// has had time to fill its 200 ms window and at least one
|
||||||
|
// successful DRED parse has happened on the decoder side.
|
||||||
|
let warmup_frames = 60;
|
||||||
|
for i in 0..warmup_frames {
|
||||||
|
let pcm = voice_frame_20ms(i * 960);
|
||||||
|
let packets = enc.encode_frame(&pcm).unwrap();
|
||||||
|
for pkt in packets {
|
||||||
|
dec.ingest(pkt);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drain the warm-up frames through the decoder to advance the
|
||||||
|
// jitter buffer cursor past them.
|
||||||
|
let mut out = vec![0i16; 960];
|
||||||
|
while dec.decode_next(&mut out).is_some() {}
|
||||||
|
|
||||||
|
// Encode the next three frames but skip ingesting the middle one.
|
||||||
|
let base_offset = warmup_frames * 960;
|
||||||
|
let pcm_a = voice_frame_20ms(base_offset);
|
||||||
|
let pcm_b = voice_frame_20ms(base_offset + 960);
|
||||||
|
let pcm_c = voice_frame_20ms(base_offset + 1920);
|
||||||
|
|
||||||
|
let pkts_a = enc.encode_frame(&pcm_a).unwrap();
|
||||||
|
let pkts_b = enc.encode_frame(&pcm_b).unwrap(); // DROP THIS ONE
|
||||||
|
let pkts_c = enc.encode_frame(&pcm_c).unwrap();
|
||||||
|
|
||||||
|
for pkt in pkts_a {
|
||||||
|
dec.ingest(pkt);
|
||||||
|
}
|
||||||
|
// Skip pkts_b entirely — this is the "packet loss".
|
||||||
|
drop(pkts_b);
|
||||||
|
for pkt in pkts_c {
|
||||||
|
dec.ingest(pkt);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drain again. Somewhere in here decode_next will hit Missing()
|
||||||
|
// for the dropped packet and attempt DRED reconstruction.
|
||||||
|
let baseline_dred = dec.dred_reconstructions;
|
||||||
|
let baseline_plc = dec.classical_plc_invocations;
|
||||||
|
eprintln!(
|
||||||
|
"[phase3b probe] pre-drain: last_good_seq={:?} samples_available={}",
|
||||||
|
dec.last_good_dred_seq(),
|
||||||
|
dec.last_good_dred_samples_available()
|
||||||
|
);
|
||||||
|
while dec.decode_next(&mut out).is_some() {}
|
||||||
|
|
||||||
|
let dred_delta = dec.dred_reconstructions - baseline_dred;
|
||||||
|
let plc_delta = dec.classical_plc_invocations - baseline_plc;
|
||||||
|
eprintln!(
|
||||||
|
"[phase3b probe] post-drain: dred_delta={dred_delta} plc_delta={plc_delta}"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
dred_delta >= 1,
|
||||||
|
"expected ≥1 DRED reconstruction on single-packet loss, \
|
||||||
|
got dred_delta={dred_delta} plc_delta={plc_delta}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 3b: lossless stream never triggers DRED reconstruction or PLC.
|
||||||
|
/// Baseline behavior — verifies the Missing() branch is not spuriously taken.
|
||||||
|
#[test]
|
||||||
|
fn opus_lossless_ingest_never_triggers_dred_or_plc() {
|
||||||
|
let (mut enc, mut dec) = encoder_decoder_pair(QualityProfile::GOOD);
|
||||||
|
|
||||||
|
// Encode + ingest 40 frames with no drops.
|
||||||
|
for i in 0..40 {
|
||||||
|
let pcm = voice_frame_20ms(i * 960);
|
||||||
|
let packets = enc.encode_frame(&pcm).unwrap();
|
||||||
|
for pkt in packets {
|
||||||
|
dec.ingest(pkt);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut out = vec![0i16; 960];
|
||||||
|
while dec.decode_next(&mut out).is_some() {}
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
dec.dred_reconstructions, 0,
|
||||||
|
"lossless stream should not reconstruct"
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
dec.classical_plc_invocations, 0,
|
||||||
|
"lossless stream should not PLC"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 3b: Codec2 calls fall through to classical PLC on loss.
|
||||||
|
/// DRED is libopus-only, so even if the decoder's DRED state were
|
||||||
|
/// populated (it won't be — Codec2 packets don't carry DRED bytes),
|
||||||
|
/// `reconstruct_from_dred` rejects Codec2 at the AdaptiveDecoder
|
||||||
|
/// level. This test guards the Codec2 side of the protection split.
|
||||||
|
#[test]
|
||||||
|
fn codec2_loss_falls_through_to_classical_plc() {
|
||||||
|
let (mut enc, mut dec) = encoder_decoder_pair(QualityProfile::CATASTROPHIC);
|
||||||
|
|
||||||
|
// Codec2 1200 uses 40 ms frames → 1920 samples at 48 kHz (before
|
||||||
|
// the downsample inside the codec). Encode 20 frames (~0.8 s).
|
||||||
|
let make_frame = |offset: usize| -> Vec<i16> {
|
||||||
|
(0..1920)
|
||||||
|
.map(|i| {
|
||||||
|
let t = (offset + i) as f64 / 48_000.0;
|
||||||
|
(8000.0 * (2.0 * std::f64::consts::PI * 300.0 * t).sin()) as i16
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
};
|
||||||
|
|
||||||
|
for i in 0..20 {
|
||||||
|
let pcm = make_frame(i * 1920);
|
||||||
|
let packets = enc.encode_frame(&pcm).unwrap();
|
||||||
|
for pkt in packets {
|
||||||
|
// Drop every 5th source packet to simulate loss.
|
||||||
|
if !pkt.header.is_repair && i % 5 == 3 {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
dec.ingest(pkt);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut out = vec![0i16; 1920];
|
||||||
|
while dec.decode_next(&mut out).is_some() {}
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
dec.dred_reconstructions, 0,
|
||||||
|
"Codec2 must never reconstruct via DRED"
|
||||||
|
);
|
||||||
|
// classical_plc_invocations may or may not trigger depending on
|
||||||
|
// whether the jitter buffer sees Missing before draining — the key
|
||||||
|
// assertion is that DRED is not used. PLC count is advisory.
|
||||||
|
}
|
||||||
|
|
||||||
// ---- QualityAdapter tests ----
|
// ---- QualityAdapter tests ----
|
||||||
|
|
||||||
/// Helper: build a QualityReport from human-readable loss% and RTT ms.
|
/// Helper: build a QualityReport from human-readable loss% and RTT ms.
|
||||||
|
|||||||
@@ -626,11 +626,21 @@ async fn run_live(transport: Arc<wzp_transport::QuinnTransport>) -> anyhow::Resu
|
|||||||
.spawn(move || {
|
.spawn(move || {
|
||||||
let config = CallConfig::default();
|
let config = CallConfig::default();
|
||||||
let mut encoder = CallEncoder::new(&config);
|
let mut encoder = CallEncoder::new(&config);
|
||||||
|
let mut frame = vec![0i16; FRAME_SAMPLES];
|
||||||
loop {
|
loop {
|
||||||
let frame = match capture.read_frame() {
|
// Pull a full 20 ms frame from the capture ring. The ring
|
||||||
Some(f) => f,
|
// may return a partial read when the CPAL callback hasn't
|
||||||
None => break,
|
// produced enough samples yet — keep reading until we
|
||||||
};
|
// accumulate a whole frame, sleeping briefly on empty
|
||||||
|
// returns so we don't hot-spin the CPU.
|
||||||
|
let mut filled = 0usize;
|
||||||
|
while filled < FRAME_SAMPLES {
|
||||||
|
let n = capture.ring().read(&mut frame[filled..]);
|
||||||
|
filled += n;
|
||||||
|
if n == 0 {
|
||||||
|
std::thread::sleep(std::time::Duration::from_millis(2));
|
||||||
|
}
|
||||||
|
}
|
||||||
let packets = match encoder.encode_frame(&frame) {
|
let packets = match encoder.encode_frame(&frame) {
|
||||||
Ok(p) => p,
|
Ok(p) => p,
|
||||||
Err(e) => {
|
Err(e) => {
|
||||||
@@ -661,7 +671,13 @@ async fn run_live(transport: Arc<wzp_transport::QuinnTransport>) -> anyhow::Resu
|
|||||||
// Repair packets feed the FEC decoder but don't produce audio.
|
// Repair packets feed the FEC decoder but don't produce audio.
|
||||||
if !is_repair {
|
if !is_repair {
|
||||||
if let Some(_n) = decoder.decode_next(&mut pcm_buf) {
|
if let Some(_n) = decoder.decode_next(&mut pcm_buf) {
|
||||||
playback.write_frame(&pcm_buf);
|
// Push the decoded frame into the playback
|
||||||
|
// ring. The CPAL output callback drains from
|
||||||
|
// here on its own clock; if the ring is full
|
||||||
|
// (rare in CLI live mode) the write returns
|
||||||
|
// a short count and the tail is dropped,
|
||||||
|
// which is the correct real-time behavior.
|
||||||
|
playback.ring().write(&pcm_buf);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -760,7 +776,6 @@ async fn run_signal_mode(
|
|||||||
// Signal recv loop — handle incoming signals
|
// Signal recv loop — handle incoming signals
|
||||||
let signal_transport = transport.clone();
|
let signal_transport = transport.clone();
|
||||||
let relay = relay_addr;
|
let relay = relay_addr;
|
||||||
let my_fp = fp.clone();
|
|
||||||
let my_seed = seed.0;
|
let my_seed = seed.0;
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
|
|||||||
@@ -96,6 +96,7 @@ pub fn signal_to_call_type(signal: &SignalMessage) -> CallSignalType {
|
|||||||
SignalMessage::Hangup { .. } => CallSignalType::Hangup,
|
SignalMessage::Hangup { .. } => CallSignalType::Hangup,
|
||||||
SignalMessage::Rekey { .. } => CallSignalType::Offer, // reuse
|
SignalMessage::Rekey { .. } => CallSignalType::Offer, // reuse
|
||||||
SignalMessage::QualityUpdate { .. } => CallSignalType::Offer, // reuse
|
SignalMessage::QualityUpdate { .. } => CallSignalType::Offer, // reuse
|
||||||
|
SignalMessage::LossRecoveryUpdate { .. } => CallSignalType::Offer, // reuse (telemetry)
|
||||||
SignalMessage::Ping { .. } | SignalMessage::Pong { .. } => CallSignalType::Offer,
|
SignalMessage::Ping { .. } | SignalMessage::Pong { .. } => CallSignalType::Offer,
|
||||||
SignalMessage::AuthToken { .. } => CallSignalType::Offer,
|
SignalMessage::AuthToken { .. } => CallSignalType::Offer,
|
||||||
SignalMessage::Hold => CallSignalType::Hold,
|
SignalMessage::Hold => CallSignalType::Hold,
|
||||||
@@ -119,6 +120,12 @@ pub fn signal_to_call_type(signal: &SignalMessage) -> CallSignalType {
|
|||||||
SignalMessage::CallRinging { .. } => CallSignalType::Ringing,
|
SignalMessage::CallRinging { .. } => CallSignalType::Ringing,
|
||||||
SignalMessage::RegisterPresence { .. }
|
SignalMessage::RegisterPresence { .. }
|
||||||
| SignalMessage::RegisterPresenceAck { .. } => CallSignalType::Offer, // relay-only
|
| SignalMessage::RegisterPresenceAck { .. } => CallSignalType::Offer, // relay-only
|
||||||
|
// NAT reflection is a client↔relay control exchange that
|
||||||
|
// never crosses the featherChat bridge — if it ever reaches
|
||||||
|
// this mapper something is wrong, but we still have to give
|
||||||
|
// an answer. "Offer" is the generic catch-all.
|
||||||
|
SignalMessage::Reflect
|
||||||
|
| SignalMessage::ReflectResponse { .. } => CallSignalType::Offer, // control-plane
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -8,6 +8,24 @@
|
|||||||
|
|
||||||
#[cfg(feature = "audio")]
|
#[cfg(feature = "audio")]
|
||||||
pub mod audio_io;
|
pub mod audio_io;
|
||||||
|
#[cfg(feature = "audio")]
|
||||||
|
pub mod audio_ring;
|
||||||
|
// VoiceProcessingIO is an Apple Core Audio API — only compile the module
|
||||||
|
// when the `vpio` feature is on AND we're targeting macOS. Enabling the
|
||||||
|
// feature on Windows/Linux was previously silently broken.
|
||||||
|
#[cfg(all(feature = "vpio", target_os = "macos"))]
|
||||||
|
pub mod audio_vpio;
|
||||||
|
// WASAPI-direct capture with Windows's OS-level AEC (AudioCategory_Communications).
|
||||||
|
// Only compiled when `windows-aec` feature is on AND target is Windows. The
|
||||||
|
// `windows` dependency is itself gated to Windows in Cargo.toml, so enabling
|
||||||
|
// this feature on non-Windows targets is a no-op.
|
||||||
|
#[cfg(all(feature = "windows-aec", target_os = "windows"))]
|
||||||
|
pub mod audio_wasapi;
|
||||||
|
// WebRTC AEC3 (Audio Processing Module) wrapper around CPAL capture + playback
|
||||||
|
// on Linux. Only compiled when `linux-aec` feature is on AND target is Linux.
|
||||||
|
// The webrtc-audio-processing dep is itself gated to Linux in Cargo.toml.
|
||||||
|
#[cfg(all(feature = "linux-aec", target_os = "linux"))]
|
||||||
|
pub mod audio_linux_aec;
|
||||||
pub mod bench;
|
pub mod bench;
|
||||||
pub mod call;
|
pub mod call;
|
||||||
pub mod drift_test;
|
pub mod drift_test;
|
||||||
@@ -17,7 +35,48 @@ pub mod handshake;
|
|||||||
pub mod metrics;
|
pub mod metrics;
|
||||||
pub mod sweep;
|
pub mod sweep;
|
||||||
|
|
||||||
#[cfg(feature = "audio")]
|
// AudioPlayback: three possible backends depending on feature flags.
|
||||||
pub use audio_io::{AudioCapture, AudioPlayback};
|
// 1. Default CPAL (`audio_io::AudioPlayback`) — baseline on every platform.
|
||||||
|
// 2. Linux AEC (`audio_linux_aec::LinuxAecPlayback`) — CPAL + WebRTC APM
|
||||||
|
// render-side tee, so echo from speakers gets cancelled from the mic.
|
||||||
|
//
|
||||||
|
// On macOS and Windows we always use the default CPAL playback because:
|
||||||
|
// - macOS: VoiceProcessingIO handles AEC at the capture side (Apple's
|
||||||
|
// native hardware AEC uses its own reference signal handling).
|
||||||
|
// - Windows: WASAPI AudioCategory_Communications AEC uses the system
|
||||||
|
// render mix as reference — no per-process plumbing needed.
|
||||||
|
//
|
||||||
|
// Linux is the only platform where the in-app approach is necessary, so
|
||||||
|
// the AEC playback path is gated to target_os = "linux".
|
||||||
|
|
||||||
|
#[cfg(all(
|
||||||
|
feature = "audio",
|
||||||
|
any(not(feature = "linux-aec"), not(target_os = "linux"))
|
||||||
|
))]
|
||||||
|
pub use audio_io::AudioPlayback;
|
||||||
|
|
||||||
|
#[cfg(all(feature = "linux-aec", target_os = "linux"))]
|
||||||
|
pub use audio_linux_aec::LinuxAecPlayback as AudioPlayback;
|
||||||
|
|
||||||
|
// AudioCapture: three possible backends depending on feature flags.
|
||||||
|
// 1. Default CPAL (`audio_io::AudioCapture`) — baseline on every platform.
|
||||||
|
// 2. Windows AEC (`audio_wasapi::WasapiAudioCapture`) — direct WASAPI
|
||||||
|
// with AudioCategory_Communications, OS APO chain does AEC.
|
||||||
|
// 3. Linux AEC (`audio_linux_aec::LinuxAecCapture`) — CPAL + WebRTC APM
|
||||||
|
// capture-side echo cancellation using the playback tee as reference.
|
||||||
|
// All three expose the same public API (`start`, `ring`, `stop`, `Drop`).
|
||||||
|
|
||||||
|
#[cfg(all(
|
||||||
|
feature = "audio",
|
||||||
|
any(not(feature = "windows-aec"), not(target_os = "windows")),
|
||||||
|
any(not(feature = "linux-aec"), not(target_os = "linux"))
|
||||||
|
))]
|
||||||
|
pub use audio_io::AudioCapture;
|
||||||
|
|
||||||
|
#[cfg(all(feature = "windows-aec", target_os = "windows"))]
|
||||||
|
pub use audio_wasapi::WasapiAudioCapture as AudioCapture;
|
||||||
|
|
||||||
|
#[cfg(all(feature = "linux-aec", target_os = "linux"))]
|
||||||
|
pub use audio_linux_aec::LinuxAecCapture as AudioCapture;
|
||||||
pub use call::{CallConfig, CallDecoder, CallEncoder};
|
pub use call::{CallConfig, CallDecoder, CallEncoder};
|
||||||
pub use handshake::perform_handshake;
|
pub use handshake::perform_handshake;
|
||||||
|
|||||||
@@ -83,12 +83,12 @@ async fn full_handshake_both_sides_derive_same_session() {
|
|||||||
|
|
||||||
// Run client and relay handshakes concurrently.
|
// Run client and relay handshakes concurrently.
|
||||||
let (client_result, relay_result) = tokio::join!(
|
let (client_result, relay_result) = tokio::join!(
|
||||||
wzp_client::handshake::perform_handshake(client_transport_clone.as_ref(), &client_seed),
|
wzp_client::handshake::perform_handshake(client_transport_clone.as_ref(), &client_seed, None),
|
||||||
wzp_relay::handshake::accept_handshake(relay_transport_clone.as_ref(), &relay_seed),
|
wzp_relay::handshake::accept_handshake(relay_transport_clone.as_ref(), &relay_seed),
|
||||||
);
|
);
|
||||||
|
|
||||||
let mut client_session = client_result.expect("client handshake should succeed");
|
let mut client_session = client_result.expect("client handshake should succeed");
|
||||||
let (mut relay_session, chosen_profile) =
|
let (mut relay_session, chosen_profile, _caller_fp, _caller_alias) =
|
||||||
relay_result.expect("relay handshake should succeed");
|
relay_result.expect("relay handshake should succeed");
|
||||||
|
|
||||||
// Verify a profile was chosen.
|
// Verify a profile was chosen.
|
||||||
@@ -151,6 +151,7 @@ async fn handshake_rejects_tampered_signature() {
|
|||||||
ephemeral_pub,
|
ephemeral_pub,
|
||||||
signature: bad_signature,
|
signature: bad_signature,
|
||||||
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
||||||
|
alias: None,
|
||||||
};
|
};
|
||||||
client_transport_clone
|
client_transport_clone
|
||||||
.send_signal(&offer)
|
.send_signal(&offer)
|
||||||
|
|||||||
@@ -10,8 +10,17 @@ description = "WarzonePhone audio codec layer — Opus + Codec2 encoding/decodin
|
|||||||
wzp-proto = { workspace = true }
|
wzp-proto = { workspace = true }
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
|
|
||||||
# Opus bindings
|
# Opus bindings — libopus 1.5.2.
|
||||||
audiopus = { workspace = true }
|
# opusic-c for the encoder (set_dred_duration lives here in Phase 1).
|
||||||
|
# opusic-sys for the decoder — we wrap the raw *mut OpusDecoder ourselves
|
||||||
|
# because opusic-c::Decoder.inner is pub(crate), blocking the unified
|
||||||
|
# decoder + DRED path we need in Phase 3.
|
||||||
|
opusic-c = { workspace = true }
|
||||||
|
opusic-sys = { workspace = true }
|
||||||
|
|
||||||
|
# Zero-cost slice reinterpretation for the i16 ↔ u16 boundary between
|
||||||
|
# our PCM buffers and opusic-c's encode API.
|
||||||
|
bytemuck = { workspace = true }
|
||||||
|
|
||||||
# Pure-Rust Codec2 implementation
|
# Pure-Rust Codec2 implementation
|
||||||
codec2 = { workspace = true }
|
codec2 = { workspace = true }
|
||||||
|
|||||||
@@ -199,6 +199,27 @@ impl AdaptiveDecoder {
|
|||||||
fn codec2_frame_samples(&self) -> usize {
|
fn codec2_frame_samples(&self) -> usize {
|
||||||
self.codec2.frame_samples()
|
self.codec2.frame_samples()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Reconstruct a lost frame from a previously parsed DRED state.
|
||||||
|
///
|
||||||
|
/// Phase 3b entry point for gap reconstruction. Dispatches to the
|
||||||
|
/// inner Opus decoder when active. Returns an error if the active
|
||||||
|
/// codec is Codec2 — DRED is libopus-only and has no Codec2 equivalent,
|
||||||
|
/// so callers must fall back to classical PLC on Codec2 tiers.
|
||||||
|
pub fn reconstruct_from_dred(
|
||||||
|
&mut self,
|
||||||
|
state: &crate::dred_ffi::DredState,
|
||||||
|
offset_samples: i32,
|
||||||
|
output: &mut [i16],
|
||||||
|
) -> Result<usize, CodecError> {
|
||||||
|
if is_codec2(self.active) {
|
||||||
|
return Err(CodecError::DecodeFailed(
|
||||||
|
"DRED reconstruction is Opus-only; Codec2 must use classical PLC".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
self.opus
|
||||||
|
.reconstruct_from_dred(state, offset_samples, output)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ─── Tests ───────────────────────────────────────────────────────────────────
|
// ─── Tests ───────────────────────────────────────────────────────────────────
|
||||||
|
|||||||
@@ -1,53 +1,127 @@
|
|||||||
//! Acoustic Echo Cancellation using NLMS adaptive filter.
|
//! Acoustic Echo Cancellation — delay-compensated leaky NLMS with
|
||||||
//! Processes 480-sample (10ms) sub-frames at 48kHz.
|
//! Geigel double-talk detection.
|
||||||
|
//!
|
||||||
|
//! Key insight: on a laptop, the round-trip audio latency (playout → speaker
|
||||||
|
//! → air → mic → capture) is 30–50ms. The far-end reference must be delayed
|
||||||
|
//! by this amount so the adaptive filter models the *echo path*, not the
|
||||||
|
//! *system delay + echo path*.
|
||||||
|
//!
|
||||||
|
//! The leaky coefficient decay prevents the filter from diverging when the
|
||||||
|
//! echo path changes (e.g. hand near laptop) or when the delay estimate
|
||||||
|
//! is slightly off.
|
||||||
|
|
||||||
/// NLMS (Normalized Least Mean Squares) adaptive filter echo canceller.
|
/// Delay-compensated leaky NLMS echo canceller with Geigel DTD.
|
||||||
///
|
|
||||||
/// Removes acoustic echo by modelling the echo path between the far-end
|
|
||||||
/// (speaker) signal and the near-end (microphone) signal, then subtracting
|
|
||||||
/// the estimated echo from the near-end in real time.
|
|
||||||
pub struct EchoCanceller {
|
pub struct EchoCanceller {
|
||||||
filter_coeffs: Vec<f32>,
|
// --- Adaptive filter ---
|
||||||
|
filter: Vec<f32>,
|
||||||
filter_len: usize,
|
filter_len: usize,
|
||||||
far_end_buf: Vec<f32>,
|
/// Circular buffer of far-end reference samples (after delay).
|
||||||
far_end_pos: usize,
|
far_buf: Vec<f32>,
|
||||||
|
far_pos: usize,
|
||||||
|
/// NLMS step size.
|
||||||
mu: f32,
|
mu: f32,
|
||||||
|
/// Leakage factor: coefficients are multiplied by (1 - leak) each frame.
|
||||||
|
/// Prevents unbounded growth / divergence. 0.0001 is gentle.
|
||||||
|
leak: f32,
|
||||||
enabled: bool,
|
enabled: bool,
|
||||||
|
|
||||||
|
// --- Delay buffer ---
|
||||||
|
/// Raw far-end samples before delay compensation.
|
||||||
|
delay_ring: Vec<f32>,
|
||||||
|
delay_write: usize,
|
||||||
|
delay_read: usize,
|
||||||
|
/// Delay in samples (e.g. 1920 = 40ms at 48kHz).
|
||||||
|
delay_samples: usize,
|
||||||
|
/// Capacity of the delay ring.
|
||||||
|
delay_cap: usize,
|
||||||
|
|
||||||
|
// --- Double-talk detection (Geigel) ---
|
||||||
|
/// Peak far-end level over the last filter_len samples.
|
||||||
|
far_peak: f32,
|
||||||
|
/// Geigel threshold: if |near| > threshold * far_peak, assume double-talk.
|
||||||
|
geigel_threshold: f32,
|
||||||
|
/// Holdover counter: keep DTD active for a few frames after detection.
|
||||||
|
dtd_holdover: u32,
|
||||||
|
dtd_hold_frames: u32,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl EchoCanceller {
|
impl EchoCanceller {
|
||||||
/// Create a new echo canceller.
|
/// Create a new echo canceller.
|
||||||
///
|
///
|
||||||
/// * `sample_rate` — typically 48000
|
/// * `sample_rate` — typically 48000
|
||||||
/// * `filter_ms` — echo-tail length in milliseconds (e.g. 100 for 100 ms)
|
/// * `filter_ms` — echo-tail length in milliseconds (60ms recommended)
|
||||||
|
/// * `delay_ms` — far-end delay compensation in milliseconds (40ms for laptops)
|
||||||
pub fn new(sample_rate: u32, filter_ms: u32) -> Self {
|
pub fn new(sample_rate: u32, filter_ms: u32) -> Self {
|
||||||
|
Self::with_delay(sample_rate, filter_ms, 40)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_delay(sample_rate: u32, filter_ms: u32, delay_ms: u32) -> Self {
|
||||||
let filter_len = (sample_rate as usize) * (filter_ms as usize) / 1000;
|
let filter_len = (sample_rate as usize) * (filter_ms as usize) / 1000;
|
||||||
|
let delay_samples = (sample_rate as usize) * (delay_ms as usize) / 1000;
|
||||||
|
// Delay ring must hold at least delay_samples + one frame (960) of headroom.
|
||||||
|
let delay_cap = delay_samples + (sample_rate as usize / 10); // +100ms headroom
|
||||||
Self {
|
Self {
|
||||||
filter_coeffs: vec![0.0f32; filter_len],
|
filter: vec![0.0; filter_len],
|
||||||
filter_len,
|
filter_len,
|
||||||
far_end_buf: vec![0.0f32; filter_len],
|
far_buf: vec![0.0; filter_len],
|
||||||
far_end_pos: 0,
|
far_pos: 0,
|
||||||
mu: 0.01,
|
mu: 0.01,
|
||||||
|
leak: 0.0001,
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
|
||||||
|
delay_ring: vec![0.0; delay_cap],
|
||||||
|
delay_write: 0,
|
||||||
|
delay_read: 0,
|
||||||
|
delay_samples,
|
||||||
|
delay_cap,
|
||||||
|
|
||||||
|
far_peak: 0.0,
|
||||||
|
geigel_threshold: 0.7,
|
||||||
|
dtd_holdover: 0,
|
||||||
|
dtd_hold_frames: 5,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Feed far-end (speaker/playback) samples into the circular buffer.
|
/// Feed far-end (speaker) samples. These go into the delay buffer first;
|
||||||
///
|
/// once enough samples have accumulated, they are released to the filter's
|
||||||
/// Must be called with the audio that was played out through the speaker
|
/// circular buffer with the correct delay offset.
|
||||||
/// *before* the corresponding near-end frame is processed.
|
|
||||||
pub fn feed_farend(&mut self, farend: &[i16]) {
|
pub fn feed_farend(&mut self, farend: &[i16]) {
|
||||||
|
// Write raw samples into the delay ring.
|
||||||
for &s in farend {
|
for &s in farend {
|
||||||
self.far_end_buf[self.far_end_pos] = s as f32;
|
self.delay_ring[self.delay_write % self.delay_cap] = s as f32;
|
||||||
self.far_end_pos = (self.far_end_pos + 1) % self.filter_len;
|
self.delay_write += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Release delayed samples to the filter's far-end buffer.
|
||||||
|
while self.delay_available() >= 1 {
|
||||||
|
let sample = self.delay_ring[self.delay_read % self.delay_cap];
|
||||||
|
self.delay_read += 1;
|
||||||
|
|
||||||
|
self.far_buf[self.far_pos] = sample;
|
||||||
|
self.far_pos = (self.far_pos + 1) % self.filter_len;
|
||||||
|
|
||||||
|
// Track peak far-end level for Geigel DTD.
|
||||||
|
let abs_s = sample.abs();
|
||||||
|
if abs_s > self.far_peak {
|
||||||
|
self.far_peak = abs_s;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decay far_peak slowly (avoids stale peak from a loud burst long ago).
|
||||||
|
self.far_peak *= 0.9995;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Number of delayed samples available to release.
|
||||||
|
fn delay_available(&self) -> usize {
|
||||||
|
let buffered = self.delay_write - self.delay_read;
|
||||||
|
if buffered > self.delay_samples {
|
||||||
|
buffered - self.delay_samples
|
||||||
|
} else {
|
||||||
|
0
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Process a near-end (microphone) frame, removing the estimated echo.
|
/// Process a near-end (microphone) frame, removing the estimated echo.
|
||||||
///
|
|
||||||
/// Returns the echo-return-loss enhancement (ERLE) as a ratio: the RMS of
|
|
||||||
/// the original near-end divided by the RMS of the residual. Values > 1.0
|
|
||||||
/// mean echo was reduced.
|
|
||||||
pub fn process_frame(&mut self, nearend: &mut [i16]) -> f32 {
|
pub fn process_frame(&mut self, nearend: &mut [i16]) -> f32 {
|
||||||
if !self.enabled {
|
if !self.enabled {
|
||||||
return 1.0;
|
return 1.0;
|
||||||
@@ -56,85 +130,96 @@ impl EchoCanceller {
|
|||||||
let n = nearend.len();
|
let n = nearend.len();
|
||||||
let fl = self.filter_len;
|
let fl = self.filter_len;
|
||||||
|
|
||||||
|
// --- Geigel double-talk detection ---
|
||||||
|
// If any near-end sample exceeds threshold * far_peak, assume
|
||||||
|
// the local speaker is active and freeze adaptation.
|
||||||
|
let mut is_doubletalk = self.dtd_holdover > 0;
|
||||||
|
if !is_doubletalk {
|
||||||
|
let threshold_level = self.geigel_threshold * self.far_peak;
|
||||||
|
for &s in nearend.iter() {
|
||||||
|
if (s as f32).abs() > threshold_level && self.far_peak > 100.0 {
|
||||||
|
is_doubletalk = true;
|
||||||
|
self.dtd_holdover = self.dtd_hold_frames;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if self.dtd_holdover > 0 {
|
||||||
|
self.dtd_holdover -= 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if far-end is active (otherwise nothing to cancel).
|
||||||
|
let far_active = self.far_peak > 100.0;
|
||||||
|
|
||||||
|
// --- Leaky coefficient decay ---
|
||||||
|
// Applied once per frame for efficiency.
|
||||||
|
let decay = 1.0 - self.leak;
|
||||||
|
for c in self.filter.iter_mut() {
|
||||||
|
*c *= decay;
|
||||||
|
}
|
||||||
|
|
||||||
let mut sum_near_sq: f64 = 0.0;
|
let mut sum_near_sq: f64 = 0.0;
|
||||||
let mut sum_err_sq: f64 = 0.0;
|
let mut sum_err_sq: f64 = 0.0;
|
||||||
|
|
||||||
for i in 0..n {
|
for i in 0..n {
|
||||||
let near_f = nearend[i] as f32;
|
let near_f = nearend[i] as f32;
|
||||||
|
|
||||||
// --- estimate echo as dot(coeffs, farend_window) ---
|
// Position of far-end "now" for this near-end sample.
|
||||||
// The far-end window for this sample starts at
|
let base = (self.far_pos + fl * ((n / fl) + 2) + i - n) % fl;
|
||||||
// (far_end_pos - 1 - i) mod filter_len (most recent)
|
|
||||||
// and goes back filter_len samples.
|
// --- Echo estimation: dot(filter, far_end_window) ---
|
||||||
let mut echo_est: f32 = 0.0;
|
let mut echo_est: f32 = 0.0;
|
||||||
let mut power: f32 = 0.0;
|
let mut power: f32 = 0.0;
|
||||||
|
|
||||||
// Position of the most-recent far-end sample for this near-end sample.
|
|
||||||
// far_end_pos points to the *next write* position, so the most-recent
|
|
||||||
// sample written is at far_end_pos - 1. We have already called
|
|
||||||
// feed_farend for this block, so the relevant samples are the last
|
|
||||||
// filter_len entries ending just before the current write position,
|
|
||||||
// offset by how far we are into this near-end frame.
|
|
||||||
//
|
|
||||||
// For sample i of the near-end frame, the corresponding far-end
|
|
||||||
// "now" is far_end_pos - n + i (wrapping).
|
|
||||||
// far_end_pos points to next-write, so most recent sample is at
|
|
||||||
// far_end_pos - 1. For the i-th near-end sample we want the
|
|
||||||
// far-end "now" to be at (far_end_pos - n + i). We add fl
|
|
||||||
// repeatedly to avoid underflow on the usize subtraction.
|
|
||||||
let base = (self.far_end_pos + fl * ((n / fl) + 2) + i - n) % fl;
|
|
||||||
|
|
||||||
for k in 0..fl {
|
for k in 0..fl {
|
||||||
let fe_idx = (base + fl - k) % fl;
|
let fe_idx = (base + fl - k) % fl;
|
||||||
let fe = self.far_end_buf[fe_idx];
|
let fe = self.far_buf[fe_idx];
|
||||||
echo_est += self.filter_coeffs[k] * fe;
|
echo_est += self.filter[k] * fe;
|
||||||
power += fe * fe;
|
power += fe * fe;
|
||||||
}
|
}
|
||||||
|
|
||||||
let error = near_f - echo_est;
|
let error = near_f - echo_est;
|
||||||
|
|
||||||
// --- NLMS coefficient update ---
|
// --- NLMS adaptation (only when far-end active & no double-talk) ---
|
||||||
let norm = power + 1.0; // +1 regularisation to avoid div-by-zero
|
if far_active && !is_doubletalk && power > 10.0 {
|
||||||
let step = self.mu * error / norm;
|
let step = self.mu * error / (power + 1.0);
|
||||||
|
|
||||||
for k in 0..fl {
|
for k in 0..fl {
|
||||||
let fe_idx = (base + fl - k) % fl;
|
let fe_idx = (base + fl - k) % fl;
|
||||||
let fe = self.far_end_buf[fe_idx];
|
self.filter[k] += step * self.far_buf[fe_idx];
|
||||||
self.filter_coeffs[k] += step * fe;
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Clamp output
|
let out = error.clamp(-32768.0, 32767.0);
|
||||||
let out = error.max(-32768.0).min(32767.0);
|
|
||||||
nearend[i] = out as i16;
|
nearend[i] = out as i16;
|
||||||
|
|
||||||
sum_near_sq += (near_f as f64) * (near_f as f64);
|
sum_near_sq += (near_f as f64).powi(2);
|
||||||
sum_err_sq += (out as f64) * (out as f64);
|
sum_err_sq += (out as f64).powi(2);
|
||||||
}
|
}
|
||||||
|
|
||||||
// ERLE ratio
|
|
||||||
if sum_err_sq < 1.0 {
|
if sum_err_sq < 1.0 {
|
||||||
return 100.0; // near-perfect cancellation
|
100.0
|
||||||
}
|
} else {
|
||||||
(sum_near_sq / sum_err_sq).sqrt() as f32
|
(sum_near_sq / sum_err_sq).sqrt() as f32
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Enable or disable echo cancellation.
|
|
||||||
pub fn set_enabled(&mut self, enabled: bool) {
|
pub fn set_enabled(&mut self, enabled: bool) {
|
||||||
self.enabled = enabled;
|
self.enabled = enabled;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns whether echo cancellation is currently enabled.
|
|
||||||
pub fn is_enabled(&self) -> bool {
|
pub fn is_enabled(&self) -> bool {
|
||||||
self.enabled
|
self.enabled
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Reset the adaptive filter to its initial state.
|
|
||||||
///
|
|
||||||
/// Zeroes out all filter coefficients and the far-end circular buffer.
|
|
||||||
pub fn reset(&mut self) {
|
pub fn reset(&mut self) {
|
||||||
self.filter_coeffs.iter_mut().for_each(|c| *c = 0.0);
|
self.filter.iter_mut().for_each(|c| *c = 0.0);
|
||||||
self.far_end_buf.iter_mut().for_each(|s| *s = 0.0);
|
self.far_buf.iter_mut().for_each(|s| *s = 0.0);
|
||||||
self.far_end_pos = 0;
|
self.far_pos = 0;
|
||||||
|
self.far_peak = 0.0;
|
||||||
|
self.delay_ring.iter_mut().for_each(|s| *s = 0.0);
|
||||||
|
self.delay_write = 0;
|
||||||
|
self.delay_read = 0;
|
||||||
|
self.dtd_holdover = 0;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -143,50 +228,40 @@ mod tests {
|
|||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn aec_creates_with_correct_filter_len() {
|
fn creates_with_correct_sizes() {
|
||||||
let aec = EchoCanceller::new(48000, 100);
|
let aec = EchoCanceller::with_delay(48000, 60, 40);
|
||||||
assert_eq!(aec.filter_len, 4800);
|
assert_eq!(aec.filter_len, 2880); // 60ms @ 48kHz
|
||||||
assert_eq!(aec.filter_coeffs.len(), 4800);
|
assert_eq!(aec.delay_samples, 1920); // 40ms @ 48kHz
|
||||||
assert_eq!(aec.far_end_buf.len(), 4800);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn aec_passthrough_when_disabled() {
|
fn passthrough_when_disabled() {
|
||||||
let mut aec = EchoCanceller::new(48000, 100);
|
let mut aec = EchoCanceller::new(48000, 60);
|
||||||
aec.set_enabled(false);
|
aec.set_enabled(false);
|
||||||
assert!(!aec.is_enabled());
|
|
||||||
|
|
||||||
let original: Vec<i16> = (0..480).map(|i| (i * 10) as i16).collect();
|
let original: Vec<i16> = (0..960).map(|i| (i * 10) as i16).collect();
|
||||||
let mut frame = original.clone();
|
let mut frame = original.clone();
|
||||||
let erle = aec.process_frame(&mut frame);
|
aec.process_frame(&mut frame);
|
||||||
assert_eq!(erle, 1.0);
|
|
||||||
assert_eq!(frame, original);
|
assert_eq!(frame, original);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn aec_reset_zeroes_state() {
|
fn silence_passthrough() {
|
||||||
let mut aec = EchoCanceller::new(48000, 10); // short for test speed
|
let mut aec = EchoCanceller::with_delay(48000, 30, 0);
|
||||||
let farend: Vec<i16> = (0..480).map(|i| ((i * 37) % 1000) as i16).collect();
|
aec.feed_farend(&vec![0i16; 960]);
|
||||||
aec.feed_farend(&farend);
|
let mut frame = vec![0i16; 960];
|
||||||
|
aec.process_frame(&mut frame);
|
||||||
aec.reset();
|
assert!(frame.iter().all(|&s| s == 0));
|
||||||
|
|
||||||
assert!(aec.filter_coeffs.iter().all(|&c| c == 0.0));
|
|
||||||
assert!(aec.far_end_buf.iter().all(|&s| s == 0.0));
|
|
||||||
assert_eq!(aec.far_end_pos, 0);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn aec_reduces_echo_of_known_signal() {
|
fn reduces_echo_with_no_delay() {
|
||||||
// Use a small filter for speed. Feed a known far-end signal, then
|
// Simulate: far-end plays, echo arrives at mic attenuated by ~50%
|
||||||
// present the *same* signal as near-end (perfect echo, no room).
|
// (realistic — speaker to mic on laptop loses volume).
|
||||||
// After adaptation the output energy should drop.
|
let mut aec = EchoCanceller::with_delay(48000, 10, 0);
|
||||||
let filter_ms = 5; // 240 taps at 48 kHz
|
|
||||||
let mut aec = EchoCanceller::new(48000, filter_ms);
|
|
||||||
|
|
||||||
// Generate a simple repeating pattern.
|
let frame_len = 480;
|
||||||
let frame_len = 480usize;
|
let make_tone = |offset: usize| -> Vec<i16> {
|
||||||
let make_frame = |offset: usize| -> Vec<i16> {
|
|
||||||
(0..frame_len)
|
(0..frame_len)
|
||||||
.map(|i| {
|
.map(|i| {
|
||||||
let t = (offset + i) as f64 / 48000.0;
|
let t = (offset + i) as f64 / 48000.0;
|
||||||
@@ -195,18 +270,16 @@ mod tests {
|
|||||||
.collect()
|
.collect()
|
||||||
};
|
};
|
||||||
|
|
||||||
// Warm up the adaptive filter with several frames.
|
|
||||||
let mut last_erle = 1.0f32;
|
let mut last_erle = 1.0f32;
|
||||||
for frame_idx in 0..40 {
|
for frame_idx in 0..100 {
|
||||||
let farend = make_frame(frame_idx * frame_len);
|
let farend = make_tone(frame_idx * frame_len);
|
||||||
aec.feed_farend(&farend);
|
aec.feed_farend(&farend);
|
||||||
|
|
||||||
// Near-end = exact copy of far-end (pure echo).
|
// Near-end = attenuated copy of far-end (echo at ~50% volume).
|
||||||
let mut nearend = farend.clone();
|
let mut nearend: Vec<i16> = farend.iter().map(|&s| s / 2).collect();
|
||||||
last_erle = aec.process_frame(&mut nearend);
|
last_erle = aec.process_frame(&mut nearend);
|
||||||
}
|
}
|
||||||
|
|
||||||
// After 40 frames the ERLE should be meaningfully > 1.
|
|
||||||
assert!(
|
assert!(
|
||||||
last_erle > 1.0,
|
last_erle > 1.0,
|
||||||
"expected ERLE > 1.0 after adaptation, got {last_erle}"
|
"expected ERLE > 1.0 after adaptation, got {last_erle}"
|
||||||
@@ -214,15 +287,49 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn aec_silence_passthrough() {
|
fn preserves_nearend_during_doubletalk() {
|
||||||
let mut aec = EchoCanceller::new(48000, 10);
|
let mut aec = EchoCanceller::with_delay(48000, 30, 0);
|
||||||
// Feed silence far-end
|
|
||||||
aec.feed_farend(&vec![0i16; 480]);
|
let frame_len = 960;
|
||||||
// Near-end is silence too
|
let nearend: Vec<i16> = (0..frame_len)
|
||||||
let mut frame = vec![0i16; 480];
|
.map(|i| {
|
||||||
let erle = aec.process_frame(&mut frame);
|
let t = i as f64 / 48000.0;
|
||||||
assert!(erle >= 1.0);
|
(10000.0 * (2.0 * std::f64::consts::PI * 440.0 * t).sin()) as i16
|
||||||
// Output should still be silence
|
})
|
||||||
assert!(frame.iter().all(|&s| s == 0));
|
.collect();
|
||||||
|
|
||||||
|
// Feed silence as far-end (no echo source).
|
||||||
|
aec.feed_farend(&vec![0i16; frame_len]);
|
||||||
|
|
||||||
|
let mut frame = nearend.clone();
|
||||||
|
aec.process_frame(&mut frame);
|
||||||
|
|
||||||
|
let input_energy: f64 = nearend.iter().map(|&s| (s as f64).powi(2)).sum();
|
||||||
|
let output_energy: f64 = frame.iter().map(|&s| (s as f64).powi(2)).sum();
|
||||||
|
let ratio = output_energy / input_energy;
|
||||||
|
|
||||||
|
assert!(
|
||||||
|
ratio > 0.8,
|
||||||
|
"near-end speech should be preserved, energy ratio = {ratio:.3}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn delay_buffer_holds_samples() {
|
||||||
|
let mut aec = EchoCanceller::with_delay(48000, 10, 20);
|
||||||
|
// 20ms delay = 960 samples @ 48kHz.
|
||||||
|
// After feeding, feed_farend auto-drains available samples to far_buf.
|
||||||
|
// So delay_available() is always 0 after feed_farend returns.
|
||||||
|
// Instead, verify far_pos advances only after the delay is filled.
|
||||||
|
|
||||||
|
// Feed 960 samples (= delay amount). No samples released yet.
|
||||||
|
aec.feed_farend(&vec![1i16; 960]);
|
||||||
|
// far_buf should still be all zeros (nothing released).
|
||||||
|
assert!(aec.far_buf.iter().all(|&s| s == 0.0), "nothing should be released yet");
|
||||||
|
|
||||||
|
// Feed 480 more. 480 should be released to far_buf.
|
||||||
|
aec.feed_farend(&vec![2i16; 480]);
|
||||||
|
let non_zero = aec.far_buf.iter().filter(|&&s| s != 0.0).count();
|
||||||
|
assert!(non_zero > 0, "samples should have been released to far_buf");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
585
crates/wzp-codec/src/dred_ffi.rs
Normal file
585
crates/wzp-codec/src/dred_ffi.rs
Normal file
@@ -0,0 +1,585 @@
|
|||||||
|
//! Raw opusic-sys FFI wrappers for libopus 1.5.2 decoder + DRED reconstruction.
|
||||||
|
//!
|
||||||
|
//! # Why this module exists
|
||||||
|
//!
|
||||||
|
//! We cannot use `opusic_c::Decoder` because its inner `*mut OpusDecoder`
|
||||||
|
//! pointer is `pub(crate)` — not reachable from outside the opusic-c crate.
|
||||||
|
//! Phase 3 of the DRED integration needs to hand that same pointer to
|
||||||
|
//! `opus_decoder_dred_decode`, and running two parallel decoders (one from
|
||||||
|
//! opusic-c for normal audio, another from opusic-sys for DRED) would cause
|
||||||
|
//! the DRED-only decoder's internal state to drift out of sync with the
|
||||||
|
//! audio stream because it would not see normal decode calls.
|
||||||
|
//!
|
||||||
|
//! The fix is to own the raw decoder ourselves and use the same handle for
|
||||||
|
//! both normal decode AND DRED reconstruction. This module is the single
|
||||||
|
//! owner of `*mut OpusDecoder`, `*mut OpusDREDDecoder`, and `*mut OpusDRED`
|
||||||
|
//! in the WZP workspace.
|
||||||
|
//!
|
||||||
|
//! # Phase 3a scope
|
||||||
|
//!
|
||||||
|
//! Phase 0 added `DecoderHandle` (normal decode). Phase 3a adds:
|
||||||
|
//! - [`DredDecoderHandle`] — wraps `*mut OpusDREDDecoder` for parsing DRED
|
||||||
|
//! side-channel data out of arriving Opus packets.
|
||||||
|
//! - [`DredState`] — wraps `*mut OpusDRED` (a fixed 10,592-byte buffer
|
||||||
|
//! allocated by libopus) that holds parsed DRED state between the parse
|
||||||
|
//! and reconstruct steps.
|
||||||
|
//! - [`DredDecoderHandle::parse_into`] — wraps `opus_dred_parse`.
|
||||||
|
//! - [`DecoderHandle::reconstruct_from_dred`] — wraps `opus_decoder_dred_decode`.
|
||||||
|
//!
|
||||||
|
//! The pattern is: on every arriving Opus packet, the receiver calls
|
||||||
|
//! `parse_into` with a reusable `DredState`, then stores (seq, state_clone)
|
||||||
|
//! in a ring. On detected loss, the receiver computes the offset from the
|
||||||
|
//! freshest reachable DRED state and calls `reconstruct_from_dred` to
|
||||||
|
//! synthesize the missing audio.
|
||||||
|
|
||||||
|
use std::ptr::NonNull;
|
||||||
|
|
||||||
|
use opusic_sys::{
|
||||||
|
OPUS_OK, OpusDRED, OpusDREDDecoder, OpusDecoder as RawOpusDecoder, opus_decode,
|
||||||
|
opus_decoder_create, opus_decoder_destroy, opus_decoder_dred_decode, opus_dred_alloc,
|
||||||
|
opus_dred_decoder_create, opus_dred_decoder_destroy, opus_dred_free, opus_dred_parse,
|
||||||
|
};
|
||||||
|
use wzp_proto::CodecError;
|
||||||
|
|
||||||
|
/// libopus operates at 48 kHz for all Opus variants we use.
|
||||||
|
const SAMPLE_RATE_HZ: i32 = 48_000;
|
||||||
|
/// Mono.
|
||||||
|
const CHANNELS: i32 = 1;
|
||||||
|
|
||||||
|
/// Safe owner of a `*mut OpusDecoder` allocated via `opus_decoder_create`.
|
||||||
|
///
|
||||||
|
/// Releases the decoder in `Drop`. All FFI access goes through `&mut self`
|
||||||
|
/// methods, so there is no aliasing or race. The raw pointer is exposed via
|
||||||
|
/// [`Self::as_raw_ptr`] at a crate-internal visibility for the future Phase 3
|
||||||
|
/// DRED reconstruction path — external crates cannot reach it.
|
||||||
|
pub struct DecoderHandle {
|
||||||
|
inner: NonNull<RawOpusDecoder>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl DecoderHandle {
|
||||||
|
/// Allocate a new Opus decoder at 48 kHz mono.
|
||||||
|
pub fn new() -> Result<Self, CodecError> {
|
||||||
|
let mut error: i32 = OPUS_OK;
|
||||||
|
// SAFETY: opus_decoder_create writes to `error` and returns either a
|
||||||
|
// valid heap pointer or null. We check both before constructing the
|
||||||
|
// NonNull wrapper.
|
||||||
|
let ptr = unsafe { opus_decoder_create(SAMPLE_RATE_HZ, CHANNELS, &mut error) };
|
||||||
|
if error != OPUS_OK {
|
||||||
|
// Even if ptr is non-null on error, libopus contracts guarantee
|
||||||
|
// it is unusable — do not attempt to free it.
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_decoder_create failed: err={error}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
let inner = NonNull::new(ptr).ok_or_else(|| {
|
||||||
|
CodecError::DecodeFailed("opus_decoder_create returned null".into())
|
||||||
|
})?;
|
||||||
|
Ok(Self { inner })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Decode an Opus packet into PCM samples.
|
||||||
|
///
|
||||||
|
/// `pcm` must have enough capacity for the frame (960 for 20 ms, 1920
|
||||||
|
/// for 40 ms at 48 kHz mono). Returns the number of decoded samples
|
||||||
|
/// per channel — for mono streams this equals the total sample count.
|
||||||
|
pub fn decode(&mut self, packet: &[u8], pcm: &mut [i16]) -> Result<usize, CodecError> {
|
||||||
|
if packet.is_empty() {
|
||||||
|
return Err(CodecError::DecodeFailed("empty packet".into()));
|
||||||
|
}
|
||||||
|
if pcm.is_empty() {
|
||||||
|
return Err(CodecError::DecodeFailed("empty output buffer".into()));
|
||||||
|
}
|
||||||
|
// SAFETY: self.inner is a valid *mut OpusDecoder owned by this struct.
|
||||||
|
// `data` / `pcm` are live Rust slices, so their pointers and lengths
|
||||||
|
// are valid for the duration of the call. libopus reads len bytes
|
||||||
|
// from data and writes up to frame_size samples (per channel) to pcm.
|
||||||
|
let n = unsafe {
|
||||||
|
opus_decode(
|
||||||
|
self.inner.as_ptr(),
|
||||||
|
packet.as_ptr(),
|
||||||
|
packet.len() as i32,
|
||||||
|
pcm.as_mut_ptr(),
|
||||||
|
pcm.len() as i32,
|
||||||
|
/* decode_fec = */ 0,
|
||||||
|
)
|
||||||
|
};
|
||||||
|
if n < 0 {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_decode failed: err={n}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
Ok(n as usize)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generate packet-loss concealment audio for a missing frame.
|
||||||
|
///
|
||||||
|
/// Implemented via `opus_decode` with a null data pointer, per the
|
||||||
|
/// libopus API contract. `pcm` should be sized for the expected frame.
|
||||||
|
pub fn decode_lost(&mut self, pcm: &mut [i16]) -> Result<usize, CodecError> {
|
||||||
|
if pcm.is_empty() {
|
||||||
|
return Err(CodecError::DecodeFailed("empty output buffer".into()));
|
||||||
|
}
|
||||||
|
// SAFETY: same invariants as decode(). libopus documents that passing
|
||||||
|
// a null data pointer with len=0 triggers PLC synthesis into pcm.
|
||||||
|
let n = unsafe {
|
||||||
|
opus_decode(
|
||||||
|
self.inner.as_ptr(),
|
||||||
|
std::ptr::null(),
|
||||||
|
0,
|
||||||
|
pcm.as_mut_ptr(),
|
||||||
|
pcm.len() as i32,
|
||||||
|
/* decode_fec = */ 0,
|
||||||
|
)
|
||||||
|
};
|
||||||
|
if n < 0 {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_decode PLC failed: err={n}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
Ok(n as usize)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Reconstruct audio from a `DredState` into the `output` buffer.
|
||||||
|
///
|
||||||
|
/// `offset_samples` is the sample position (positive, measured backward
|
||||||
|
/// from the packet anchor that produced `state`) where reconstruction
|
||||||
|
/// begins. `output.len()` must match the number of samples to synthesize.
|
||||||
|
///
|
||||||
|
/// The libopus API: `opus_decoder_dred_decode(st, dred, dred_offset, pcm,
|
||||||
|
/// frame_size)` where `dred_offset` is "position of the redundancy to
|
||||||
|
/// decode, in samples before the beginning of the real audio data in the
|
||||||
|
/// packet." Valid values: `0 < offset_samples < state.samples_available()`.
|
||||||
|
///
|
||||||
|
/// Returns the number of samples actually written (should equal
|
||||||
|
/// `output.len()` on success).
|
||||||
|
pub fn reconstruct_from_dred(
|
||||||
|
&mut self,
|
||||||
|
state: &DredState,
|
||||||
|
offset_samples: i32,
|
||||||
|
output: &mut [i16],
|
||||||
|
) -> Result<usize, CodecError> {
|
||||||
|
if output.is_empty() {
|
||||||
|
return Err(CodecError::DecodeFailed(
|
||||||
|
"empty reconstruction output buffer".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
if offset_samples <= 0 {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"DRED offset must be positive (got {offset_samples})"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
if offset_samples > state.samples_available() {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"DRED offset {offset_samples} exceeds available samples {}",
|
||||||
|
state.samples_available()
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
// SAFETY: self.inner is a valid *mut OpusDecoder, state.inner is a
|
||||||
|
// valid *const OpusDRED populated by a prior parse_into call, and
|
||||||
|
// output is a live mutable slice. libopus reads from dred and writes
|
||||||
|
// exactly frame_size samples (the output.len()) to pcm.
|
||||||
|
let n = unsafe {
|
||||||
|
opus_decoder_dred_decode(
|
||||||
|
self.inner.as_ptr(),
|
||||||
|
state.inner.as_ptr(),
|
||||||
|
offset_samples,
|
||||||
|
output.as_mut_ptr(),
|
||||||
|
output.len() as i32,
|
||||||
|
)
|
||||||
|
};
|
||||||
|
if n < 0 {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_decoder_dred_decode failed: err={n}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
Ok(n as usize)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for DecoderHandle {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// SAFETY: we own the pointer and no further access happens after
|
||||||
|
// this call because Drop consumes self.
|
||||||
|
unsafe { opus_decoder_destroy(self.inner.as_ptr()) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SAFETY: The underlying OpusDecoder is a plain heap allocation with no
|
||||||
|
// thread-local or lock-free state. It is safe to move between threads
|
||||||
|
// (Send), and all method access is gated by &mut self so Rust's borrow
|
||||||
|
// checker prevents simultaneous access from multiple threads (Sync).
|
||||||
|
unsafe impl Send for DecoderHandle {}
|
||||||
|
unsafe impl Sync for DecoderHandle {}
|
||||||
|
|
||||||
|
// ─── DRED decoder (parser) ──────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Safe owner of a `*mut OpusDREDDecoder` allocated via
|
||||||
|
/// `opus_dred_decoder_create`.
|
||||||
|
///
|
||||||
|
/// The DRED decoder is a **separate** libopus object from the regular
|
||||||
|
/// `OpusDecoder`. It's used exclusively for parsing DRED side-channel data
|
||||||
|
/// out of arriving Opus packets via [`Self::parse_into`]. Actual audio
|
||||||
|
/// reconstruction from the parsed state uses the regular `DecoderHandle`
|
||||||
|
/// via [`DecoderHandle::reconstruct_from_dred`].
|
||||||
|
pub struct DredDecoderHandle {
|
||||||
|
inner: NonNull<OpusDREDDecoder>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl DredDecoderHandle {
|
||||||
|
/// Allocate a new DRED decoder.
|
||||||
|
pub fn new() -> Result<Self, CodecError> {
|
||||||
|
let mut error: i32 = OPUS_OK;
|
||||||
|
// SAFETY: opus_dred_decoder_create writes to `error` and returns
|
||||||
|
// either a valid heap pointer or null. Both are checked.
|
||||||
|
let ptr = unsafe { opus_dred_decoder_create(&mut error) };
|
||||||
|
if error != OPUS_OK {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_dred_decoder_create failed: err={error}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
let inner = NonNull::new(ptr).ok_or_else(|| {
|
||||||
|
CodecError::DecodeFailed("opus_dred_decoder_create returned null".into())
|
||||||
|
})?;
|
||||||
|
Ok(Self { inner })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Parse DRED side-channel data from an Opus packet into `state`.
|
||||||
|
///
|
||||||
|
/// Returns the number of samples of audio history available for
|
||||||
|
/// reconstruction, or 0 if the packet carries no DRED data. Subsequent
|
||||||
|
/// `DecoderHandle::reconstruct_from_dred` calls using this `state` can
|
||||||
|
/// reconstruct any sample position in `(0, samples_available]`.
|
||||||
|
///
|
||||||
|
/// libopus API: `opus_dred_parse(dred_dec, dred, data, len,
|
||||||
|
/// max_dred_samples, sampling_rate, dred_end, defer_processing)`. We
|
||||||
|
/// pass `max_dred_samples = 48000` (1 s at 48 kHz, the DRED maximum),
|
||||||
|
/// `sampling_rate = 48000`, `defer_processing = 0` (process immediately).
|
||||||
|
/// The `dred_end` output is the silence gap at the tail of the DRED
|
||||||
|
/// window; we subtract it from the total offset to give callers the
|
||||||
|
/// truly usable sample count.
|
||||||
|
pub fn parse_into(
|
||||||
|
&mut self,
|
||||||
|
state: &mut DredState,
|
||||||
|
packet: &[u8],
|
||||||
|
) -> Result<i32, CodecError> {
|
||||||
|
if packet.is_empty() {
|
||||||
|
state.samples_available = 0;
|
||||||
|
return Ok(0);
|
||||||
|
}
|
||||||
|
let mut dred_end: i32 = 0;
|
||||||
|
// SAFETY: self.inner is a valid *mut OpusDREDDecoder; state.inner is
|
||||||
|
// a valid *mut OpusDRED allocated via opus_dred_alloc; packet is a
|
||||||
|
// live slice; dred_end is a stack int. libopus reads packet bytes
|
||||||
|
// and writes parsed DRED state into *state.inner.
|
||||||
|
let ret = unsafe {
|
||||||
|
opus_dred_parse(
|
||||||
|
self.inner.as_ptr(),
|
||||||
|
state.inner.as_ptr(),
|
||||||
|
packet.as_ptr(),
|
||||||
|
packet.len() as i32,
|
||||||
|
/* max_dred_samples = */ 48_000, // 1s max per libopus 1.5
|
||||||
|
/* sampling_rate = */ 48_000,
|
||||||
|
&mut dred_end,
|
||||||
|
/* defer_processing = */ 0,
|
||||||
|
)
|
||||||
|
};
|
||||||
|
if ret < 0 {
|
||||||
|
state.samples_available = 0;
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_dred_parse failed: err={ret}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
// ret is the positive offset of the first decodable DRED sample,
|
||||||
|
// or 0 if no DRED is present. dred_end is the silence gap at the
|
||||||
|
// tail. The usable sample range is (dred_end, ret], so the count
|
||||||
|
// of usable samples is ret - dred_end. We store `ret` as the max
|
||||||
|
// usable offset — callers should pass dred_offset values in the
|
||||||
|
// range (dred_end, ret] to reconstruct_from_dred. For simplicity
|
||||||
|
// we expose just samples_available = ret and let callers treat
|
||||||
|
// the full window as valid (the silence gap is small and libopus
|
||||||
|
// handles minor boundary cases gracefully).
|
||||||
|
state.samples_available = ret;
|
||||||
|
Ok(ret)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for DredDecoderHandle {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// SAFETY: we own the pointer and no further access happens after
|
||||||
|
// this call because Drop consumes self.
|
||||||
|
unsafe { opus_dred_decoder_destroy(self.inner.as_ptr()) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SAFETY: same reasoning as DecoderHandle — heap allocation with no
|
||||||
|
// thread-local state, &mut self access discipline prevents races.
|
||||||
|
unsafe impl Send for DredDecoderHandle {}
|
||||||
|
unsafe impl Sync for DredDecoderHandle {}
|
||||||
|
|
||||||
|
// ─── DRED state buffer ──────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Safe owner of a `*mut OpusDRED` allocated via `opus_dred_alloc`.
|
||||||
|
///
|
||||||
|
/// Holds a fixed-size (10,592-byte per libopus 1.5) buffer that
|
||||||
|
/// `DredDecoderHandle::parse_into` populates from an Opus packet. The state
|
||||||
|
/// is reusable — the caller can call `parse_into` again on the same
|
||||||
|
/// `DredState` to overwrite it with a fresh packet's data.
|
||||||
|
///
|
||||||
|
/// `samples_available` tracks the last-parsed result so reconstruction
|
||||||
|
/// callers don't need to thread the return value separately. A fresh
|
||||||
|
/// state (before any `parse_into`) has `samples_available == 0`.
|
||||||
|
pub struct DredState {
|
||||||
|
inner: NonNull<OpusDRED>,
|
||||||
|
samples_available: i32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl DredState {
|
||||||
|
/// Allocate a new DRED state buffer.
|
||||||
|
pub fn new() -> Result<Self, CodecError> {
|
||||||
|
let mut error: i32 = OPUS_OK;
|
||||||
|
// SAFETY: opus_dred_alloc writes to `error` and returns either a
|
||||||
|
// valid heap pointer or null.
|
||||||
|
let ptr = unsafe { opus_dred_alloc(&mut error) };
|
||||||
|
if error != OPUS_OK {
|
||||||
|
return Err(CodecError::DecodeFailed(format!(
|
||||||
|
"opus_dred_alloc failed: err={error}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
let inner = NonNull::new(ptr)
|
||||||
|
.ok_or_else(|| CodecError::DecodeFailed("opus_dred_alloc returned null".into()))?;
|
||||||
|
Ok(Self {
|
||||||
|
inner,
|
||||||
|
samples_available: 0,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// How many samples of audio history this state currently covers.
|
||||||
|
///
|
||||||
|
/// Returns 0 if the state is fresh or the last parse found no DRED
|
||||||
|
/// data. Otherwise returns the positive offset set by the most recent
|
||||||
|
/// `DredDecoderHandle::parse_into` call — the maximum valid
|
||||||
|
/// `offset_samples` value for `DecoderHandle::reconstruct_from_dred`.
|
||||||
|
pub fn samples_available(&self) -> i32 {
|
||||||
|
self.samples_available
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Reset the state to "fresh" without freeing the underlying buffer.
|
||||||
|
/// The next `parse_into` will overwrite the contents.
|
||||||
|
pub fn reset(&mut self) {
|
||||||
|
self.samples_available = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for DredState {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
// SAFETY: we own the pointer and no further access happens after
|
||||||
|
// this call because Drop consumes self.
|
||||||
|
unsafe { opus_dred_free(self.inner.as_ptr()) };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SAFETY: same reasoning as DecoderHandle.
|
||||||
|
unsafe impl Send for DredState {}
|
||||||
|
unsafe impl Sync for DredState {}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn decoder_handle_creates_and_drops() {
|
||||||
|
let handle = DecoderHandle::new().expect("decoder create");
|
||||||
|
// Dropping the handle must not panic or leak — validated by miri
|
||||||
|
// and the absence of sanitizer complaints in CI.
|
||||||
|
drop(handle);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn decode_lost_produces_full_frame_of_silence_on_cold_start() {
|
||||||
|
let mut handle = DecoderHandle::new().unwrap();
|
||||||
|
// 20 ms @ 48 kHz mono.
|
||||||
|
let mut pcm = vec![0i16; 960];
|
||||||
|
let n = handle.decode_lost(&mut pcm).unwrap();
|
||||||
|
assert_eq!(n, 960);
|
||||||
|
// On a fresh decoder, PLC output is silence (no past audio to extend).
|
||||||
|
assert!(pcm.iter().all(|&s| s == 0));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn decode_empty_packet_errors() {
|
||||||
|
let mut handle = DecoderHandle::new().unwrap();
|
||||||
|
let mut pcm = vec![0i16; 960];
|
||||||
|
let err = handle.decode(&[], &mut pcm);
|
||||||
|
assert!(err.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Phase 3a — DRED decoder + state ────────────────────────────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_decoder_handle_creates_and_drops() {
|
||||||
|
let h = DredDecoderHandle::new().expect("dred decoder create");
|
||||||
|
drop(h);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_state_creates_and_drops() {
|
||||||
|
let s = DredState::new().expect("dred state alloc");
|
||||||
|
assert_eq!(s.samples_available(), 0);
|
||||||
|
drop(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_state_reset_zeroes_counter() {
|
||||||
|
let mut s = DredState::new().unwrap();
|
||||||
|
s.samples_available = 480; // pretend a parse populated it
|
||||||
|
assert_eq!(s.samples_available(), 480);
|
||||||
|
s.reset();
|
||||||
|
assert_eq!(s.samples_available(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Phase 3a end-to-end: encode a DRED-enabled stream, parse state out
|
||||||
|
/// of packets, and reconstruct audio at a past offset. Validates the
|
||||||
|
/// full parse → reconstruct pipeline against a real libopus 1.5.2
|
||||||
|
/// encoder so we catch FFI-layer bugs early.
|
||||||
|
#[test]
|
||||||
|
fn dred_parse_and_reconstruct_roundtrip() {
|
||||||
|
use crate::opus_enc::OpusEncoder;
|
||||||
|
use wzp_proto::{AudioEncoder, QualityProfile};
|
||||||
|
|
||||||
|
// Encoder with DRED at Opus 24k / 200 ms duration (Phase 1 default
|
||||||
|
// for GOOD profile). The loss floor is 5% per Phase 1.
|
||||||
|
let mut enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
|
||||||
|
// Decode-side handles.
|
||||||
|
let mut dec = DecoderHandle::new().unwrap();
|
||||||
|
let mut dred_dec = DredDecoderHandle::new().unwrap();
|
||||||
|
let mut state = DredState::new().unwrap();
|
||||||
|
|
||||||
|
// Generate 60 frames (1.2 s) of a voice-like 300 Hz sine wave so
|
||||||
|
// the encoder's DRED emitter has real content to encode rather
|
||||||
|
// than compressing silence.
|
||||||
|
let frame_len = 960usize; // 20 ms @ 48 kHz
|
||||||
|
let make_frame = |offset: usize| -> Vec<i16> {
|
||||||
|
(0..frame_len)
|
||||||
|
.map(|i| {
|
||||||
|
let t = (offset + i) as f64 / 48_000.0;
|
||||||
|
(8000.0 * (2.0 * std::f64::consts::PI * 300.0 * t).sin()) as i16
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
};
|
||||||
|
|
||||||
|
// Track the freshest packet that carried non-zero DRED state.
|
||||||
|
let mut best_samples_available = 0;
|
||||||
|
let mut best_packet: Option<Vec<u8>> = None;
|
||||||
|
|
||||||
|
for frame_idx in 0..60 {
|
||||||
|
let pcm = make_frame(frame_idx * frame_len);
|
||||||
|
let mut encoded = vec![0u8; 512];
|
||||||
|
let n = enc.encode(&pcm, &mut encoded).unwrap();
|
||||||
|
encoded.truncate(n);
|
||||||
|
|
||||||
|
// Run the packet through the normal decode path so dec's
|
||||||
|
// internal state mirrors the full stream — this is necessary
|
||||||
|
// for DRED reconstruction to produce meaningful output.
|
||||||
|
let mut decoded = vec![0i16; frame_len];
|
||||||
|
dec.decode(&encoded, &mut decoded).unwrap();
|
||||||
|
|
||||||
|
// Parse DRED state out of the same packet. Early packets may
|
||||||
|
// have samples_available == 0 while the DRED encoder warms up;
|
||||||
|
// later packets should carry the full window.
|
||||||
|
match dred_dec.parse_into(&mut state, &encoded) {
|
||||||
|
Ok(available) => {
|
||||||
|
if available > best_samples_available {
|
||||||
|
best_samples_available = available;
|
||||||
|
best_packet = Some(encoded.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(e) => panic!("parse_into errored unexpectedly: {e:?}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// By the time we're 60 frames in, DRED should have emitted data.
|
||||||
|
assert!(
|
||||||
|
best_samples_available > 0,
|
||||||
|
"DRED emitted zero samples across 60 frames — the encoder isn't \
|
||||||
|
producing DRED bytes (check set_dred_duration and packet_loss floor)"
|
||||||
|
);
|
||||||
|
|
||||||
|
// Parse the best packet into a fresh state and reconstruct some
|
||||||
|
// audio from somewhere inside its DRED window. We use frame_len/2
|
||||||
|
// as the offset to pick a point squarely inside the reconstructable
|
||||||
|
// range rather than at an edge.
|
||||||
|
let packet = best_packet.expect("at least one packet had DRED state");
|
||||||
|
let mut fresh_state = DredState::new().unwrap();
|
||||||
|
let available = dred_dec.parse_into(&mut fresh_state, &packet).unwrap();
|
||||||
|
assert!(available > 0, "re-parse of known-good packet returned 0");
|
||||||
|
|
||||||
|
// Need a decoder that's in the right state to reconstruct — rewind
|
||||||
|
// by creating a fresh one and feeding it the same stream up to the
|
||||||
|
// point of the best packet. Simpler: just use a fresh decoder and
|
||||||
|
// accept that the reconstructed samples may not be phase-matched.
|
||||||
|
// The test here only asserts *non-silent energy*, not signal fidelity.
|
||||||
|
let mut recon_dec = DecoderHandle::new().unwrap();
|
||||||
|
// Warm up the decoder with one frame so its internal state is valid.
|
||||||
|
let warmup_pcm = vec![0i16; frame_len];
|
||||||
|
let warmup_encoded = {
|
||||||
|
let mut warmup_enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
let mut buf = vec![0u8; 512];
|
||||||
|
let n = warmup_enc.encode(&warmup_pcm, &mut buf).unwrap();
|
||||||
|
buf.truncate(n);
|
||||||
|
buf
|
||||||
|
};
|
||||||
|
let mut throwaway = vec![0i16; frame_len];
|
||||||
|
let _ = recon_dec.decode(&warmup_encoded, &mut throwaway);
|
||||||
|
|
||||||
|
// Reconstruct 20 ms from some position inside the DRED window.
|
||||||
|
let offset = (available / 2).max(480).min(available);
|
||||||
|
let mut recon_pcm = vec![0i16; frame_len];
|
||||||
|
let n = recon_dec
|
||||||
|
.reconstruct_from_dred(&fresh_state, offset, &mut recon_pcm)
|
||||||
|
.expect("reconstruct_from_dred failed");
|
||||||
|
assert_eq!(n, frame_len);
|
||||||
|
|
||||||
|
// Energy check: reconstructed audio should not be all zeros. A
|
||||||
|
// loose threshold — the DRED reconstruction won't be phase-matched
|
||||||
|
// to our sine wave because we fed a cold decoder only one warmup
|
||||||
|
// frame, but it should still produce non-silent speech-like output
|
||||||
|
// since the DRED state was parsed from real speech content.
|
||||||
|
let energy: u64 = recon_pcm.iter().map(|&s| (s as i32).unsigned_abs() as u64).sum();
|
||||||
|
assert!(
|
||||||
|
energy > 0,
|
||||||
|
"reconstructed audio has zero total energy — DRED reconstruction produced silence"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A second roundtrip variant: offset too large errors cleanly rather
|
||||||
|
/// than crashing the FFI.
|
||||||
|
#[test]
|
||||||
|
fn reconstruct_with_out_of_range_offset_errors() {
|
||||||
|
let mut dec = DecoderHandle::new().unwrap();
|
||||||
|
let state = DredState::new().unwrap();
|
||||||
|
// state has samples_available == 0 (fresh), so any positive offset
|
||||||
|
// should be out of range.
|
||||||
|
let mut out = vec![0i16; 960];
|
||||||
|
let err = dec.reconstruct_from_dred(&state, 480, &mut out);
|
||||||
|
assert!(err.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn reconstruct_with_zero_offset_errors() {
|
||||||
|
let mut dec = DecoderHandle::new().unwrap();
|
||||||
|
let state = DredState::new().unwrap();
|
||||||
|
let mut out = vec![0i16; 960];
|
||||||
|
let err = dec.reconstruct_from_dred(&state, 0, &mut out);
|
||||||
|
assert!(err.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_parse_empty_packet_returns_zero() {
|
||||||
|
let mut dred_dec = DredDecoderHandle::new().unwrap();
|
||||||
|
let mut state = DredState::new().unwrap();
|
||||||
|
let result = dred_dec.parse_into(&mut state, &[]).unwrap();
|
||||||
|
assert_eq!(result, 0);
|
||||||
|
assert_eq!(state.samples_available(), 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -15,6 +15,7 @@ pub mod agc;
|
|||||||
pub mod codec2_dec;
|
pub mod codec2_dec;
|
||||||
pub mod codec2_enc;
|
pub mod codec2_enc;
|
||||||
pub mod denoise;
|
pub mod denoise;
|
||||||
|
pub mod dred_ffi;
|
||||||
pub mod opus_dec;
|
pub mod opus_dec;
|
||||||
pub mod opus_enc;
|
pub mod opus_enc;
|
||||||
pub mod resample;
|
pub mod resample;
|
||||||
@@ -27,6 +28,26 @@ pub use denoise::NoiseSupressor;
|
|||||||
pub use silence::{ComfortNoise, SilenceDetector};
|
pub use silence::{ComfortNoise, SilenceDetector};
|
||||||
pub use wzp_proto::{AudioDecoder, AudioEncoder, CodecId, QualityProfile};
|
pub use wzp_proto::{AudioDecoder, AudioEncoder, CodecId, QualityProfile};
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicBool, Ordering};
|
||||||
|
|
||||||
|
/// Global verbose-logging flag for DRED. Off by default — when enabled
|
||||||
|
/// (via the GUI debug toggle wired through Tauri), the encoder logs its
|
||||||
|
/// DRED config + libopus version, and the recv path logs every DRED
|
||||||
|
/// reconstruction, classical PLC fill, and parse heartbeat. Off in
|
||||||
|
/// "normal" mode keeps logcat clean.
|
||||||
|
static DRED_VERBOSE_LOGS: AtomicBool = AtomicBool::new(false);
|
||||||
|
|
||||||
|
/// Returns whether DRED verbose logging is currently enabled.
|
||||||
|
#[inline]
|
||||||
|
pub fn dred_verbose_logs() -> bool {
|
||||||
|
DRED_VERBOSE_LOGS.load(Ordering::Relaxed)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Enable/disable DRED verbose logging at runtime.
|
||||||
|
pub fn set_dred_verbose_logs(enabled: bool) {
|
||||||
|
DRED_VERBOSE_LOGS.store(enabled, Ordering::Relaxed);
|
||||||
|
}
|
||||||
|
|
||||||
/// Create an adaptive encoder starting at the given quality profile.
|
/// Create an adaptive encoder starting at the given quality profile.
|
||||||
///
|
///
|
||||||
/// The returned encoder accepts 48 kHz mono PCM regardless of the active
|
/// The returned encoder accepts 48 kHz mono PCM regardless of the active
|
||||||
|
|||||||
@@ -1,30 +1,32 @@
|
|||||||
//! Opus decoder wrapping the `audiopus` crate.
|
//! Opus decoder built on top of the raw opusic-sys `DecoderHandle`.
|
||||||
|
//!
|
||||||
|
//! Phase 0 of the DRED integration: we went straight to a custom
|
||||||
|
//! `DecoderHandle` instead of `opusic_c::Decoder` because the latter's
|
||||||
|
//! inner pointer is `pub(crate)` and we need to reach it in Phase 3 for
|
||||||
|
//! `opus_decoder_dred_decode`. See `dred_ffi.rs` for the rationale and
|
||||||
|
//! `docs/PRD-dred-integration.md` for the full plan.
|
||||||
|
|
||||||
use audiopus::coder::Decoder;
|
use crate::dred_ffi::{DecoderHandle, DredState};
|
||||||
use audiopus::{Channels, MutSignals, SampleRate};
|
|
||||||
use audiopus::packet::Packet;
|
|
||||||
use wzp_proto::{AudioDecoder, CodecError, CodecId, QualityProfile};
|
use wzp_proto::{AudioDecoder, CodecError, CodecId, QualityProfile};
|
||||||
|
|
||||||
/// Opus decoder implementing `AudioDecoder`.
|
/// Opus decoder implementing [`AudioDecoder`].
|
||||||
///
|
///
|
||||||
/// Operates at 48 kHz mono output.
|
/// Operates at 48 kHz mono output. 20 ms and 40 ms frames supported via
|
||||||
|
/// the active `QualityProfile`. Behavior is intentionally identical to
|
||||||
|
/// the pre-swap audiopus-based decoder at this phase — DRED reconstruction
|
||||||
|
/// lands in Phase 3.
|
||||||
pub struct OpusDecoder {
|
pub struct OpusDecoder {
|
||||||
inner: Decoder,
|
inner: DecoderHandle,
|
||||||
codec_id: CodecId,
|
codec_id: CodecId,
|
||||||
frame_duration_ms: u8,
|
frame_duration_ms: u8,
|
||||||
}
|
}
|
||||||
|
|
||||||
// SAFETY: Same reasoning as OpusEncoder — exclusive access via &mut self.
|
|
||||||
unsafe impl Sync for OpusDecoder {}
|
|
||||||
|
|
||||||
impl OpusDecoder {
|
impl OpusDecoder {
|
||||||
/// Create a new Opus decoder for the given quality profile.
|
/// Create a new Opus decoder for the given quality profile.
|
||||||
pub fn new(profile: QualityProfile) -> Result<Self, CodecError> {
|
pub fn new(profile: QualityProfile) -> Result<Self, CodecError> {
|
||||||
let decoder = Decoder::new(SampleRate::Hz48000, Channels::Mono)
|
let inner = DecoderHandle::new()?;
|
||||||
.map_err(|e| CodecError::DecodeFailed(format!("opus decoder init: {e}")))?;
|
|
||||||
|
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
inner: decoder,
|
inner,
|
||||||
codec_id: profile.codec,
|
codec_id: profile.codec,
|
||||||
frame_duration_ms: profile.frame_duration_ms,
|
frame_duration_ms: profile.frame_duration_ms,
|
||||||
})
|
})
|
||||||
@@ -34,6 +36,24 @@ impl OpusDecoder {
|
|||||||
pub fn frame_samples(&self) -> usize {
|
pub fn frame_samples(&self) -> usize {
|
||||||
(48_000 * self.frame_duration_ms as usize) / 1000
|
(48_000 * self.frame_duration_ms as usize) / 1000
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Reconstruct a lost frame from a previously parsed `DredState`.
|
||||||
|
///
|
||||||
|
/// Phase 3b entry point: callers (CallDecoder / engine.rs) use this to
|
||||||
|
/// synthesize audio for gaps detected by the jitter buffer when DRED
|
||||||
|
/// side-channel state from a later-arriving packet covers the gap's
|
||||||
|
/// sample offset. `offset_samples` is measured backward from the anchor
|
||||||
|
/// packet that produced `state`. See `DecoderHandle::reconstruct_from_dred`
|
||||||
|
/// for the full semantics.
|
||||||
|
pub fn reconstruct_from_dred(
|
||||||
|
&mut self,
|
||||||
|
state: &DredState,
|
||||||
|
offset_samples: i32,
|
||||||
|
output: &mut [i16],
|
||||||
|
) -> Result<usize, CodecError> {
|
||||||
|
self.inner
|
||||||
|
.reconstruct_from_dred(state, offset_samples, output)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AudioDecoder for OpusDecoder {
|
impl AudioDecoder for OpusDecoder {
|
||||||
@@ -45,15 +65,7 @@ impl AudioDecoder for OpusDecoder {
|
|||||||
pcm.len()
|
pcm.len()
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
let packet = Packet::try_from(encoded)
|
self.inner.decode(encoded, pcm)
|
||||||
.map_err(|e| CodecError::DecodeFailed(format!("invalid packet: {e}")))?;
|
|
||||||
let signals = MutSignals::try_from(pcm)
|
|
||||||
.map_err(|e| CodecError::DecodeFailed(format!("output signals: {e}")))?;
|
|
||||||
let n = self
|
|
||||||
.inner
|
|
||||||
.decode(Some(packet), signals, false)
|
|
||||||
.map_err(|e| CodecError::DecodeFailed(format!("opus decode: {e}")))?;
|
|
||||||
Ok(n)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn decode_lost(&mut self, pcm: &mut [i16]) -> Result<usize, CodecError> {
|
fn decode_lost(&mut self, pcm: &mut [i16]) -> Result<usize, CodecError> {
|
||||||
@@ -64,13 +76,7 @@ impl AudioDecoder for OpusDecoder {
|
|||||||
pcm.len()
|
pcm.len()
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
let signals = MutSignals::try_from(pcm)
|
self.inner.decode_lost(pcm)
|
||||||
.map_err(|e| CodecError::DecodeFailed(format!("output signals: {e}")))?;
|
|
||||||
let n = self
|
|
||||||
.inner
|
|
||||||
.decode(None, signals, false)
|
|
||||||
.map_err(|e| CodecError::DecodeFailed(format!("opus PLC: {e}")))?;
|
|
||||||
Ok(n)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn codec_id(&self) -> CodecId {
|
fn codec_id(&self) -> CodecId {
|
||||||
|
|||||||
@@ -1,58 +1,220 @@
|
|||||||
//! Opus encoder wrapping the `audiopus` crate.
|
//! Opus encoder wrapping the `opusic-c` crate (libopus 1.5.2).
|
||||||
|
//!
|
||||||
|
//! Phase 1 of the DRED integration: encoder-side DRED is enabled on every
|
||||||
|
//! Opus profile with a tiered duration (studio 100 ms / normal 200 ms /
|
||||||
|
//! degraded 500 ms), and Opus inband FEC (LBRR) is disabled because DRED
|
||||||
|
//! is the stronger mechanism for the same failure mode. The legacy behavior
|
||||||
|
//! is preserved behind the `AUDIO_USE_LEGACY_FEC` environment variable as a
|
||||||
|
//! runtime escape hatch for rollout. See `docs/PRD-dred-integration.md`.
|
||||||
|
//!
|
||||||
|
//! # DRED duration policy
|
||||||
|
//!
|
||||||
|
//! Rationale from the PRD:
|
||||||
|
//! - Studio tiers (Opus 32k/48k/64k): 100 ms — loss is rare on high-quality
|
||||||
|
//! networks; short window keeps decoder CPU modest.
|
||||||
|
//! - Normal tiers (Opus 16k/24k): 200 ms — balanced baseline covering common
|
||||||
|
//! VoIP loss patterns (20–150 ms bursts from wifi roam, transient congestion).
|
||||||
|
//! - Degraded tier (Opus 6k): 500 ms — users on 6k are by definition on a
|
||||||
|
//! bad link; longer DRED buys maximum burst resilience where it matters.
|
||||||
|
//!
|
||||||
|
//! # Why the 15% packet loss floor
|
||||||
|
//!
|
||||||
|
//! libopus 1.5's DRED emitter is gated on `OPUS_SET_PACKET_LOSS_PERC` and
|
||||||
|
//! scales the emitted window proportionally to the assumed loss:
|
||||||
|
//!
|
||||||
|
//! ```text
|
||||||
|
//! loss_pct samples_available effective_ms
|
||||||
|
//! 5% 720 15
|
||||||
|
//! 10% 2640 55
|
||||||
|
//! 15% 4560 95
|
||||||
|
//! 20% 6480 135
|
||||||
|
//! 25%+ 8400 (capped) 175 (≈ 87% of the 200ms configured max)
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! Measured empirically against libopus 1.5.2 on Opus 24k / 200 ms DRED
|
||||||
|
//! duration during Phase 3b. At 5% loss the window is only 15 ms — too
|
||||||
|
//! small to even reconstruct a single 20 ms Opus frame. 15% gives 95 ms
|
||||||
|
//! (enough for single-frame recovery plus modest burst margin) while
|
||||||
|
//! keeping the bitrate overhead modest compared to 25%. Real measurements
|
||||||
|
//! from the quality adapter override upward when loss exceeds the floor.
|
||||||
|
|
||||||
use audiopus::coder::Encoder;
|
use std::sync::OnceLock;
|
||||||
use audiopus::{Application, Bitrate, Channels, SampleRate, Signal};
|
|
||||||
use tracing::debug;
|
use opusic_c::{Application, Bitrate, Channels, Encoder, InbandFec, SampleRate, Signal};
|
||||||
|
use tracing::{debug, info, warn};
|
||||||
use wzp_proto::{AudioEncoder, CodecError, CodecId, QualityProfile};
|
use wzp_proto::{AudioEncoder, CodecError, CodecId, QualityProfile};
|
||||||
|
|
||||||
|
/// Logged exactly once per process the first time an OpusEncoder is built.
|
||||||
|
/// Confirms that libopus 1.5.2 (the version with DRED) is actually linked
|
||||||
|
/// at runtime — invaluable when chasing "is the new codec loaded?"
|
||||||
|
/// regressions on Android, where the only debug surface is logcat.
|
||||||
|
static LIBOPUS_VERSION_LOGGED: OnceLock<()> = OnceLock::new();
|
||||||
|
|
||||||
|
/// Minimum `OPUS_SET_PACKET_LOSS_PERC` value used in DRED mode. libopus
|
||||||
|
/// scales the DRED emission window with the assumed loss percentage:
|
||||||
|
/// empirically, 5% gives a 15 ms window (useless), 10% gives 55 ms, 15%
|
||||||
|
/// gives 95 ms, and 25%+ saturates the configured max (~175 ms at 200 ms
|
||||||
|
/// duration). 15% is the minimum value that produces a DRED window larger
|
||||||
|
/// than a single 20 ms frame, making it the minimum floor that actually
|
||||||
|
/// gives DRED something useful to reconstruct. Real loss measurements from
|
||||||
|
/// the quality adapter override this upward.
|
||||||
|
const DRED_LOSS_FLOOR_PCT: u8 = 15;
|
||||||
|
|
||||||
|
/// Environment variable that reverts Phase 1 behavior to Phase 0 (inband FEC
|
||||||
|
/// on, DRED off, no loss floor). Read once per encoder construction.
|
||||||
|
const LEGACY_FEC_ENV: &str = "AUDIO_USE_LEGACY_FEC";
|
||||||
|
|
||||||
|
/// Returns the DRED duration in 10 ms frame units for a given Opus codec.
|
||||||
|
///
|
||||||
|
/// Unit: each frame is 10 ms, so the max value of 104 corresponds to 1040 ms
|
||||||
|
/// of reconstructable history. Returns 0 for non-Opus codecs (DRED is not
|
||||||
|
/// emitted by the libopus encoder in that case anyway, but we avoid a
|
||||||
|
/// pointless FFI call).
|
||||||
|
///
|
||||||
|
/// See the DRED duration policy in the module docs for per-tier rationale.
|
||||||
|
pub fn dred_duration_for(codec: CodecId) -> u8 {
|
||||||
|
match codec {
|
||||||
|
// Studio tiers — loss is rare, short window.
|
||||||
|
CodecId::Opus32k | CodecId::Opus48k | CodecId::Opus64k => 10,
|
||||||
|
// Normal tiers — balanced baseline.
|
||||||
|
CodecId::Opus16k | CodecId::Opus24k => 20,
|
||||||
|
// Degraded tier — maximum burst resilience.
|
||||||
|
CodecId::Opus6k => 50,
|
||||||
|
// Non-Opus (Codec2 / CN): DRED is N/A.
|
||||||
|
CodecId::Codec2_1200 | CodecId::Codec2_3200 | CodecId::ComfortNoise => 0,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns whether the legacy-FEC escape hatch is active.
|
||||||
|
///
|
||||||
|
/// Read from `AUDIO_USE_LEGACY_FEC`. Any non-empty value activates legacy
|
||||||
|
/// mode; unset or empty leaves DRED enabled.
|
||||||
|
fn read_legacy_fec_env() -> bool {
|
||||||
|
match std::env::var(LEGACY_FEC_ENV) {
|
||||||
|
Ok(v) => !v.is_empty() && v != "0" && v.to_ascii_lowercase() != "false",
|
||||||
|
Err(_) => false,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Opus encoder implementing `AudioEncoder`.
|
/// Opus encoder implementing `AudioEncoder`.
|
||||||
///
|
///
|
||||||
/// Operates at 48 kHz mono. Supports frame sizes of 20 ms (960 samples)
|
/// Operates at 48 kHz mono. Supports 20 ms and 40 ms frames via the active
|
||||||
/// and 40 ms (1920 samples).
|
/// `QualityProfile`.
|
||||||
pub struct OpusEncoder {
|
pub struct OpusEncoder {
|
||||||
inner: Encoder,
|
inner: Encoder,
|
||||||
codec_id: CodecId,
|
codec_id: CodecId,
|
||||||
frame_duration_ms: u8,
|
frame_duration_ms: u8,
|
||||||
|
/// When `true`, revert to the Phase 0 behavior: inband FEC Mode1, DRED
|
||||||
|
/// disabled, no loss floor. Captured at construction time and not
|
||||||
|
/// re-read mid-call.
|
||||||
|
legacy_fec_mode: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
// SAFETY: OpusEncoder is only used via `&mut self` methods. The inner
|
// SAFETY: OpusEncoder is only used via `&mut self` methods. The inner
|
||||||
// audiopus Encoder contains a raw pointer that is !Sync, but we never
|
// opusic-c Encoder wraps a non-null pointer that is !Sync by default,
|
||||||
// share it across threads without exclusive access.
|
// but we never share it across threads without exclusive access.
|
||||||
unsafe impl Sync for OpusEncoder {}
|
unsafe impl Sync for OpusEncoder {}
|
||||||
|
|
||||||
impl OpusEncoder {
|
impl OpusEncoder {
|
||||||
/// Create a new Opus encoder for the given quality profile.
|
/// Create a new Opus encoder for the given quality profile.
|
||||||
pub fn new(profile: QualityProfile) -> Result<Self, CodecError> {
|
pub fn new(profile: QualityProfile) -> Result<Self, CodecError> {
|
||||||
let encoder = Encoder::new(SampleRate::Hz48000, Channels::Mono, Application::Voip)
|
// opusic-c argument order: (Channels, SampleRate, Application)
|
||||||
.map_err(|e| CodecError::EncodeFailed(format!("opus encoder init: {e}")))?;
|
// — different from audiopus's (SampleRate, Channels, Application).
|
||||||
|
let encoder = Encoder::new(Channels::Mono, SampleRate::Hz48000, Application::Voip)
|
||||||
|
.map_err(|e| CodecError::EncodeFailed(format!("opus encoder init: {e:?}")))?;
|
||||||
|
|
||||||
|
let legacy_fec_mode = read_legacy_fec_env();
|
||||||
|
if legacy_fec_mode {
|
||||||
|
warn!(
|
||||||
|
"AUDIO_USE_LEGACY_FEC active — reverting Opus encoder to Phase 0 \
|
||||||
|
behavior (inband FEC Mode1, no DRED)"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
let mut enc = Self {
|
let mut enc = Self {
|
||||||
inner: encoder,
|
inner: encoder,
|
||||||
codec_id: profile.codec,
|
codec_id: profile.codec,
|
||||||
frame_duration_ms: profile.frame_duration_ms,
|
frame_duration_ms: profile.frame_duration_ms,
|
||||||
|
legacy_fec_mode,
|
||||||
};
|
};
|
||||||
enc.apply_bitrate(profile.codec)?;
|
|
||||||
enc.set_inband_fec(true);
|
|
||||||
enc.set_dtx(true);
|
|
||||||
|
|
||||||
// Voice signal type hint for better compression
|
// Common setup — bitrate, DTX, signal hint, complexity. These are
|
||||||
|
// identical regardless of the protection mode below.
|
||||||
|
enc.apply_bitrate(profile.codec)?;
|
||||||
|
enc.set_dtx(true);
|
||||||
enc.inner
|
enc.inner
|
||||||
.set_signal(Signal::Voice)
|
.set_signal(Signal::Voice)
|
||||||
.map_err(|e| CodecError::EncodeFailed(format!("set signal: {e}")))?;
|
.map_err(|e| CodecError::EncodeFailed(format!("set signal: {e:?}")))?;
|
||||||
|
|
||||||
// Default complexity 7 — good quality/CPU trade-off for VoIP
|
|
||||||
enc.inner
|
enc.inner
|
||||||
.set_complexity(7)
|
.set_complexity(7)
|
||||||
.map_err(|e| CodecError::EncodeFailed(format!("set complexity: {e}")))?;
|
.map_err(|e| CodecError::EncodeFailed(format!("set complexity: {e:?}")))?;
|
||||||
|
|
||||||
|
// Protection mode: DRED (Phase 1 default) or legacy inband FEC.
|
||||||
|
enc.apply_protection_mode(profile.codec)?;
|
||||||
|
|
||||||
Ok(enc)
|
Ok(enc)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn apply_bitrate(&mut self, codec: CodecId) -> Result<(), CodecError> {
|
/// Configure the protection mode for the active codec.
|
||||||
let bps = codec.bitrate_bps() as i32;
|
///
|
||||||
|
/// In DRED mode (default): disable inband FEC, set DRED duration for the
|
||||||
|
/// codec tier, clamp packet_loss to the 5% floor so DRED stays active.
|
||||||
|
///
|
||||||
|
/// In legacy mode: enable inband FEC Mode1 (Phase 0 behavior), leave
|
||||||
|
/// DRED and packet_loss at libopus defaults.
|
||||||
|
fn apply_protection_mode(&mut self, codec: CodecId) -> Result<(), CodecError> {
|
||||||
|
if self.legacy_fec_mode {
|
||||||
self.inner
|
self.inner
|
||||||
.set_bitrate(Bitrate::BitsPerSecond(bps))
|
.set_inband_fec(InbandFec::Mode1)
|
||||||
.map_err(|e| CodecError::EncodeFailed(format!("set bitrate: {e}")))?;
|
.map_err(|e| CodecError::EncodeFailed(format!("set inband FEC: {e:?}")))?;
|
||||||
|
// Leave DRED at 0 and packet_loss at default — matches Phase 0.
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
// DRED path: disable the overlapping inband FEC, enable DRED with
|
||||||
|
// per-profile duration, floor packet_loss so DRED emits.
|
||||||
|
self.inner
|
||||||
|
.set_inband_fec(InbandFec::Off)
|
||||||
|
.map_err(|e| CodecError::EncodeFailed(format!("set inband FEC off: {e:?}")))?;
|
||||||
|
|
||||||
|
let dred_frames = dred_duration_for(codec);
|
||||||
|
self.inner
|
||||||
|
.set_dred_duration(dred_frames)
|
||||||
|
.map_err(|e| CodecError::EncodeFailed(format!("set DRED duration: {e:?}")))?;
|
||||||
|
|
||||||
|
self.inner
|
||||||
|
.set_packet_loss(DRED_LOSS_FLOOR_PCT)
|
||||||
|
.map_err(|e| CodecError::EncodeFailed(format!("set packet loss floor: {e:?}")))?;
|
||||||
|
|
||||||
|
// Both of these are gated behind the GUI debug toggle so logcat
|
||||||
|
// stays clean in normal mode. Flip "DRED verbose logs" in the
|
||||||
|
// settings panel to see the per-encoder config + libopus version.
|
||||||
|
if crate::dred_verbose_logs() {
|
||||||
|
info!(
|
||||||
|
codec = ?codec,
|
||||||
|
dred_frames,
|
||||||
|
dred_ms = dred_frames as u32 * 10,
|
||||||
|
loss_floor_pct = DRED_LOSS_FLOOR_PCT,
|
||||||
|
"opus encoder: DRED enabled"
|
||||||
|
);
|
||||||
|
|
||||||
|
// One-shot logging of the linked libopus version so we can
|
||||||
|
// confirm at a glance that opusic-c (libopus 1.5.2) is loaded.
|
||||||
|
// Pre-Phase-0 audiopus shipped libopus 1.3 which has no DRED;
|
||||||
|
// if this log says "libopus 1.3" something is very wrong.
|
||||||
|
LIBOPUS_VERSION_LOGGED.get_or_init(|| {
|
||||||
|
info!(libopus_version = %opusic_c::version(), "linked libopus version");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn apply_bitrate(&mut self, codec: CodecId) -> Result<(), CodecError> {
|
||||||
|
let bps = codec.bitrate_bps();
|
||||||
|
self.inner
|
||||||
|
.set_bitrate(Bitrate::Value(bps))
|
||||||
|
.map_err(|e| CodecError::EncodeFailed(format!("set bitrate: {e:?}")))?;
|
||||||
debug!(bitrate_bps = bps, "opus encoder bitrate set");
|
debug!(bitrate_bps = bps, "opus encoder bitrate set");
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -71,10 +233,36 @@ impl OpusEncoder {
|
|||||||
|
|
||||||
/// Hint the encoder about expected packet loss percentage (0-100).
|
/// Hint the encoder about expected packet loss percentage (0-100).
|
||||||
///
|
///
|
||||||
/// Higher values cause the encoder to use more redundancy to survive
|
/// In DRED mode, the value is floored at `DRED_LOSS_FLOOR_PCT` so the
|
||||||
/// packet loss, at the expense of slightly higher bitrate.
|
/// encoder never drops DRED emission even on a perfect network. Real
|
||||||
|
/// loss measurements from the quality adapter override upward.
|
||||||
|
///
|
||||||
|
/// In legacy mode, the value is passed through unchanged (min 0, max 100).
|
||||||
pub fn set_expected_loss(&mut self, loss_pct: u8) {
|
pub fn set_expected_loss(&mut self, loss_pct: u8) {
|
||||||
let _ = self.inner.set_packet_loss_perc(loss_pct.min(100));
|
let clamped = if self.legacy_fec_mode {
|
||||||
|
loss_pct.min(100)
|
||||||
|
} else {
|
||||||
|
loss_pct.max(DRED_LOSS_FLOOR_PCT).min(100)
|
||||||
|
};
|
||||||
|
let _ = self.inner.set_packet_loss(clamped);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Set the DRED duration in 10 ms frame units (0 disables, max 104).
|
||||||
|
///
|
||||||
|
/// No-op in legacy mode. Normally driven automatically by the active
|
||||||
|
/// quality profile via `apply_protection_mode`; this setter exists for
|
||||||
|
/// tests and for the rare case where a caller needs to override the
|
||||||
|
/// per-profile default.
|
||||||
|
pub fn set_dred_duration(&mut self, frames: u8) {
|
||||||
|
if self.legacy_fec_mode {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let _ = self.inner.set_dred_duration(frames.min(104));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Test/introspection accessor: whether legacy FEC mode is active.
|
||||||
|
pub fn is_legacy_fec_mode(&self) -> bool {
|
||||||
|
self.legacy_fec_mode
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -87,10 +275,14 @@ impl AudioEncoder for OpusEncoder {
|
|||||||
pcm.len()
|
pcm.len()
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
|
// opusic-c takes &[u16] for the sample input. Bit pattern is
|
||||||
|
// identical to i16 — the cast is zero-cost and the encoder
|
||||||
|
// interprets the bytes the same way as libopus internally.
|
||||||
|
let pcm_u16: &[u16] = bytemuck::cast_slice(pcm);
|
||||||
let n = self
|
let n = self
|
||||||
.inner
|
.inner
|
||||||
.encode(pcm, out)
|
.encode_to_slice(pcm_u16, out)
|
||||||
.map_err(|e| CodecError::EncodeFailed(format!("opus encode: {e}")))?;
|
.map_err(|e| CodecError::EncodeFailed(format!("opus encode: {e:?}")))?;
|
||||||
Ok(n)
|
Ok(n)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -104,6 +296,9 @@ impl AudioEncoder for OpusEncoder {
|
|||||||
self.codec_id = profile.codec;
|
self.codec_id = profile.codec;
|
||||||
self.frame_duration_ms = profile.frame_duration_ms;
|
self.frame_duration_ms = profile.frame_duration_ms;
|
||||||
self.apply_bitrate(profile.codec)?;
|
self.apply_bitrate(profile.codec)?;
|
||||||
|
// Refresh DRED duration for the new tier. apply_protection_mode
|
||||||
|
// is idempotent and handles the legacy-vs-DRED branch correctly.
|
||||||
|
self.apply_protection_mode(profile.codec)?;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
other => Err(CodecError::UnsupportedTransition {
|
other => Err(CodecError::UnsupportedTransition {
|
||||||
@@ -120,10 +315,190 @@ impl AudioEncoder for OpusEncoder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn set_inband_fec(&mut self, enabled: bool) {
|
fn set_inband_fec(&mut self, enabled: bool) {
|
||||||
let _ = self.inner.set_inband_fec(enabled);
|
// In DRED mode, ignore external requests to re-enable inband FEC —
|
||||||
|
// running both mechanisms wastes bitrate on overlapping protection
|
||||||
|
// and opusic-c's own docs recommend disabling inband FEC when DRED
|
||||||
|
// is on. Trait callers that genuinely want classical FEC should set
|
||||||
|
// `AUDIO_USE_LEGACY_FEC=1` and re-create the encoder.
|
||||||
|
if !self.legacy_fec_mode {
|
||||||
|
debug!(
|
||||||
|
enabled,
|
||||||
|
"set_inband_fec ignored: DRED mode is active (set AUDIO_USE_LEGACY_FEC to revert)"
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let mode = if enabled { InbandFec::Mode1 } else { InbandFec::Off };
|
||||||
|
let _ = self.inner.set_inband_fec(mode);
|
||||||
}
|
}
|
||||||
|
|
||||||
fn set_dtx(&mut self, enabled: bool) {
|
fn set_dtx(&mut self, enabled: bool) {
|
||||||
let _ = self.inner.set_dtx(enabled);
|
let _ = self.inner.set_dtx(enabled);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use wzp_proto::AudioDecoder;
|
||||||
|
|
||||||
|
/// Phase 0 acceptance gate: fail loudly if the linked libopus is not 1.5.x.
|
||||||
|
/// DRED (Phase 1+) only exists in libopus ≥ 1.5, so running against an
|
||||||
|
/// older version would silently regress the entire DRED integration.
|
||||||
|
#[test]
|
||||||
|
fn linked_libopus_is_1_5() {
|
||||||
|
let version = opusic_c::version();
|
||||||
|
assert!(
|
||||||
|
version.contains("1.5"),
|
||||||
|
"expected libopus 1.5.x, got: {version}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn encoder_creates_at_good_profile() {
|
||||||
|
let enc = OpusEncoder::new(QualityProfile::GOOD).expect("opus encoder init");
|
||||||
|
assert_eq!(enc.codec_id, CodecId::Opus24k);
|
||||||
|
assert_eq!(enc.frame_samples(), 960); // 20 ms @ 48 kHz
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn encoder_roundtrip_silence() {
|
||||||
|
let mut enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
let mut dec = crate::opus_dec::OpusDecoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
let pcm_in = vec![0i16; 960]; // 20 ms silence
|
||||||
|
let mut encoded = vec![0u8; 512];
|
||||||
|
let n = enc.encode(&pcm_in, &mut encoded).unwrap();
|
||||||
|
assert!(n > 0);
|
||||||
|
let mut pcm_out = vec![0i16; 960];
|
||||||
|
let samples = dec.decode(&encoded[..n], &mut pcm_out).unwrap();
|
||||||
|
assert_eq!(samples, 960);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Phase 1 — DRED duration policy ─────────────────────────────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_duration_for_studio_tiers_is_100ms() {
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Opus32k), 10);
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Opus48k), 10);
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Opus64k), 10);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_duration_for_normal_tiers_is_200ms() {
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Opus16k), 20);
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Opus24k), 20);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_duration_for_degraded_tier_is_500ms() {
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Opus6k), 50);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_duration_for_codec2_is_zero() {
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Codec2_3200), 0);
|
||||||
|
assert_eq!(dred_duration_for(CodecId::Codec2_1200), 0);
|
||||||
|
assert_eq!(dred_duration_for(CodecId::ComfortNoise), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Phase 1 — Legacy escape hatch ──────────────────────────────────────
|
||||||
|
|
||||||
|
/// By default (env var unset), legacy mode is off.
|
||||||
|
///
|
||||||
|
/// This test does NOT manipulate the environment to avoid flakiness
|
||||||
|
/// when the full suite runs in parallel. It only asserts on a freshly
|
||||||
|
/// created encoder in the ambient environment.
|
||||||
|
#[test]
|
||||||
|
fn default_mode_is_dred_not_legacy() {
|
||||||
|
// SAFETY: only run if the ambient env hasn't set the var externally.
|
||||||
|
if std::env::var(LEGACY_FEC_ENV).is_ok() {
|
||||||
|
return; // don't assert — someone set the env for a reason.
|
||||||
|
}
|
||||||
|
let enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
assert!(!enc.is_legacy_fec_mode());
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Phase 1 — Behavioral regression: roundtrip still works ─────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dred_mode_roundtrip_voice_pattern() {
|
||||||
|
// Use a realistic voice-like input (sine wave at speech frequencies)
|
||||||
|
// so the encoder emits meaningful DRED data rather than trivially
|
||||||
|
// compressible silence.
|
||||||
|
let mut enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
let mut dec = crate::opus_dec::OpusDecoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
|
||||||
|
let mut total_encoded_bytes = 0usize;
|
||||||
|
// Run 50 frames (1 second) so DRED fills up and starts emitting.
|
||||||
|
for frame_idx in 0..50 {
|
||||||
|
let pcm_in: Vec<i16> = (0..960)
|
||||||
|
.map(|i| {
|
||||||
|
let t = (frame_idx * 960 + i) as f64 / 48_000.0;
|
||||||
|
(8000.0 * (2.0 * std::f64::consts::PI * 300.0 * t).sin()) as i16
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
let mut encoded = vec![0u8; 512];
|
||||||
|
let n = enc.encode(&pcm_in, &mut encoded).unwrap();
|
||||||
|
assert!(n > 0);
|
||||||
|
total_encoded_bytes += n;
|
||||||
|
|
||||||
|
let mut pcm_out = vec![0i16; 960];
|
||||||
|
let samples = dec.decode(&encoded[..n], &mut pcm_out).unwrap();
|
||||||
|
assert_eq!(samples, 960);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Effective bitrate after 1 second of encoding.
|
||||||
|
// Opus 24k base + ~1 kbps DRED ≈ 25 kbps ≈ 3125 bytes/sec.
|
||||||
|
// Allow generous headroom (2000 lower bound, 8000 upper bound) —
|
||||||
|
// this is a behavioral regression check, not a tight bitrate assertion.
|
||||||
|
// The exact value is printed with --nocapture for diagnostic use.
|
||||||
|
eprintln!(
|
||||||
|
"[phase1 bitrate probe] legacy_fec_mode={} total_encoded={} bytes/sec",
|
||||||
|
enc.is_legacy_fec_mode(),
|
||||||
|
total_encoded_bytes
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
total_encoded_bytes > 2000,
|
||||||
|
"encoder output too small: {total_encoded_bytes} bytes/sec (DRED likely not emitting)"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
total_encoded_bytes < 8000,
|
||||||
|
"encoder output too large: {total_encoded_bytes} bytes/sec"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Phase 1 — set_profile updates DRED duration on tier switch ─────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn profile_switch_refreshes_dred_duration() {
|
||||||
|
// Start on GOOD (Opus 24k, DRED 20 frames), switch to DEGRADED
|
||||||
|
// (Opus 6k, DRED 50 frames). The encoder should accept both profile
|
||||||
|
// changes without error. We can't directly observe the DRED duration
|
||||||
|
// inside libopus, but apply_protection_mode returns Ok for both.
|
||||||
|
let mut enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
assert_eq!(enc.codec_id, CodecId::Opus24k);
|
||||||
|
|
||||||
|
enc.set_profile(QualityProfile::DEGRADED).unwrap();
|
||||||
|
assert_eq!(enc.codec_id, CodecId::Opus6k);
|
||||||
|
|
||||||
|
enc.set_profile(QualityProfile::STUDIO_64K).unwrap();
|
||||||
|
assert_eq!(enc.codec_id, CodecId::Opus64k);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Phase 1 — Trait set_inband_fec is a no-op in DRED mode ─────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn set_inband_fec_noop_in_dred_mode() {
|
||||||
|
if std::env::var(LEGACY_FEC_ENV).is_ok() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let mut enc = OpusEncoder::new(QualityProfile::GOOD).unwrap();
|
||||||
|
// Should not error, should not re-enable inband FEC internally.
|
||||||
|
enc.set_inband_fec(true);
|
||||||
|
// We can't directly query libopus's inband FEC state through opusic-c,
|
||||||
|
// but the call must not panic and the encoder must still work.
|
||||||
|
let pcm_in = vec![0i16; 960];
|
||||||
|
let mut encoded = vec![0u8; 512];
|
||||||
|
let n = enc.encode(&pcm_in, &mut encoded).unwrap();
|
||||||
|
assert!(n > 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -115,6 +115,7 @@ fn wzp_signal_serializes_into_fc_callsignal_payload() {
|
|||||||
ephemeral_pub: [2u8; 32],
|
ephemeral_pub: [2u8; 32],
|
||||||
signature: vec![3u8; 64],
|
signature: vec![3u8; 64],
|
||||||
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
||||||
|
alias: None,
|
||||||
};
|
};
|
||||||
|
|
||||||
// Encode as featherChat CallSignal payload
|
// Encode as featherChat CallSignal payload
|
||||||
@@ -273,13 +274,14 @@ fn auth_invalid_response_matches() {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn all_signal_types_map_correctly() {
|
fn all_signal_types_map_correctly() {
|
||||||
use wzp_client::featherchat::{signal_to_call_type, CallSignalType};
|
use wzp_client::featherchat::signal_to_call_type;
|
||||||
|
|
||||||
let cases: Vec<(wzp_proto::SignalMessage, &str)> = vec![
|
let cases: Vec<(wzp_proto::SignalMessage, &str)> = vec![
|
||||||
(
|
(
|
||||||
wzp_proto::SignalMessage::CallOffer {
|
wzp_proto::SignalMessage::CallOffer {
|
||||||
identity_pub: [0; 32], ephemeral_pub: [0; 32],
|
identity_pub: [0; 32], ephemeral_pub: [0; 32],
|
||||||
signature: vec![], supported_profiles: vec![],
|
signature: vec![], supported_profiles: vec![],
|
||||||
|
alias: None,
|
||||||
},
|
},
|
||||||
"Offer",
|
"Offer",
|
||||||
),
|
),
|
||||||
|
|||||||
29
crates/wzp-native/Cargo.toml
Normal file
29
crates/wzp-native/Cargo.toml
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
[package]
|
||||||
|
name = "wzp-native"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2024"
|
||||||
|
description = "WarzonePhone native audio library — standalone Android cdylib that eventually owns all C++ (Oboe bridge) and exposes a pure-C FFI. Built with cargo-ndk, loaded at runtime by the Tauri desktop cdylib via libloading."
|
||||||
|
|
||||||
|
# Crate-type is DELIBERATELY only cdylib (no rlib, no staticlib). This crate
|
||||||
|
# is built with `cargo ndk -t arm64-v8a build --release -p wzp-native` as a
|
||||||
|
# standalone .so, which is the same path the legacy wzp-android crate uses
|
||||||
|
# successfully on the same phone / same NDK. Keeping the crate-type single
|
||||||
|
# avoids the rust-lang/rust#104707 symbol leak that bit us when Tauri's
|
||||||
|
# desktop crate had ["staticlib", "cdylib", "rlib"] and any C++ static
|
||||||
|
# archive pulled bionic's internal pthread_create into the final .so.
|
||||||
|
[lib]
|
||||||
|
name = "wzp_native"
|
||||||
|
crate-type = ["cdylib"]
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
# cc is SAFE to use here because this crate is a single-cdylib: no
|
||||||
|
# staticlib in crate-type → no rust-lang/rust#104707 symbol leak. The
|
||||||
|
# legacy wzp-android crate uses the same setup and works.
|
||||||
|
cc = "1"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
# Phase 2: Oboe C++ audio bridge. Still no Rust deps — we do the whole
|
||||||
|
# audio pipeline via extern "C" into the bundled C++ and expose our own
|
||||||
|
# narrow extern "C" API for wzp-desktop to dlopen via libloading.
|
||||||
|
# Phase 3 can add wzp-proto/wzp-codec if we want to share codec logic
|
||||||
|
# instead of calling back into wzp-desktop via callbacks.
|
||||||
119
crates/wzp-native/build.rs
Normal file
119
crates/wzp-native/build.rs
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
//! wzp-native build.rs — Oboe C++ bridge compile on Android.
|
||||||
|
//!
|
||||||
|
//! Near-verbatim copy of crates/wzp-android/build.rs (which is known to
|
||||||
|
//! work). The crucial distinction: this crate is a single-cdylib (no
|
||||||
|
//! staticlib, no rlib in crate-type) so rust-lang/rust#104707 doesn't
|
||||||
|
//! apply — bionic's internal pthread_create / __init_tcb symbols stay
|
||||||
|
//! UND and resolve against libc.so at runtime, as they should.
|
||||||
|
//!
|
||||||
|
//! On non-Android hosts we compile `cpp/oboe_stub.cpp` (empty stubs) so
|
||||||
|
//! `cargo check --target <host>` still works for IDEs and CI.
|
||||||
|
|
||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
let target = std::env::var("TARGET").unwrap_or_default();
|
||||||
|
|
||||||
|
if target.contains("android") {
|
||||||
|
// getauxval_fix: override compiler-rt's broken static getauxval
|
||||||
|
// stub that SIGSEGVs in shared libraries.
|
||||||
|
cc::Build::new()
|
||||||
|
.file("cpp/getauxval_fix.c")
|
||||||
|
.compile("wzp_native_getauxval_fix");
|
||||||
|
|
||||||
|
let oboe_dir = fetch_oboe();
|
||||||
|
match oboe_dir {
|
||||||
|
Some(oboe_path) => {
|
||||||
|
println!("cargo:warning=wzp-native: building with Oboe from {:?}", oboe_path);
|
||||||
|
let mut build = cc::Build::new();
|
||||||
|
build
|
||||||
|
.cpp(true)
|
||||||
|
.std("c++17")
|
||||||
|
// Shared libc++ — matches legacy wzp-android setup.
|
||||||
|
.cpp_link_stdlib(Some("c++_shared"))
|
||||||
|
.include("cpp")
|
||||||
|
.include(oboe_path.join("include"))
|
||||||
|
.include(oboe_path.join("src"))
|
||||||
|
.define("WZP_HAS_OBOE", None)
|
||||||
|
.file("cpp/oboe_bridge.cpp");
|
||||||
|
add_cpp_files_recursive(&mut build, &oboe_path.join("src"));
|
||||||
|
build.compile("wzp_native_oboe_bridge");
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
println!("cargo:warning=wzp-native: Oboe not found, building stub");
|
||||||
|
cc::Build::new()
|
||||||
|
.cpp(true)
|
||||||
|
.std("c++17")
|
||||||
|
.cpp_link_stdlib(Some("c++_shared"))
|
||||||
|
.file("cpp/oboe_stub.cpp")
|
||||||
|
.include("cpp")
|
||||||
|
.compile("wzp_native_oboe_bridge");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Oboe needs log + OpenSLES backends at runtime.
|
||||||
|
println!("cargo:rustc-link-lib=log");
|
||||||
|
println!("cargo:rustc-link-lib=OpenSLES");
|
||||||
|
|
||||||
|
// Re-run if any cpp file changes
|
||||||
|
println!("cargo:rerun-if-changed=cpp/oboe_bridge.cpp");
|
||||||
|
println!("cargo:rerun-if-changed=cpp/oboe_bridge.h");
|
||||||
|
println!("cargo:rerun-if-changed=cpp/oboe_stub.cpp");
|
||||||
|
println!("cargo:rerun-if-changed=cpp/getauxval_fix.c");
|
||||||
|
} else {
|
||||||
|
// Non-Android hosts: compile the empty stub so lib.rs's extern
|
||||||
|
// declarations resolve when someone runs `cargo check` on macOS
|
||||||
|
// or Linux without an NDK.
|
||||||
|
cc::Build::new()
|
||||||
|
.cpp(true)
|
||||||
|
.std("c++17")
|
||||||
|
.file("cpp/oboe_stub.cpp")
|
||||||
|
.include("cpp")
|
||||||
|
.compile("wzp_native_oboe_bridge");
|
||||||
|
println!("cargo:rerun-if-changed=cpp/oboe_stub.cpp");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Recursively add all `.cpp` files from a directory to a cc::Build.
|
||||||
|
fn add_cpp_files_recursive(build: &mut cc::Build, dir: &std::path::Path) {
|
||||||
|
if !dir.is_dir() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for entry in std::fs::read_dir(dir).unwrap() {
|
||||||
|
let entry = entry.unwrap();
|
||||||
|
let path = entry.path();
|
||||||
|
if path.is_dir() {
|
||||||
|
add_cpp_files_recursive(build, &path);
|
||||||
|
} else if path.extension().map_or(false, |e| e == "cpp") {
|
||||||
|
build.file(&path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Fetch or find Oboe headers + sources (v1.8.1). Same logic as the
|
||||||
|
/// legacy wzp-android crate's build.rs.
|
||||||
|
fn fetch_oboe() -> Option<PathBuf> {
|
||||||
|
let out_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap());
|
||||||
|
let oboe_dir = out_dir.join("oboe");
|
||||||
|
|
||||||
|
if oboe_dir.join("include").join("oboe").join("Oboe.h").exists() {
|
||||||
|
return Some(oboe_dir);
|
||||||
|
}
|
||||||
|
|
||||||
|
let status = std::process::Command::new("git")
|
||||||
|
.args([
|
||||||
|
"clone",
|
||||||
|
"--depth=1",
|
||||||
|
"--branch=1.8.1",
|
||||||
|
"https://github.com/google/oboe.git",
|
||||||
|
oboe_dir.to_str().unwrap(),
|
||||||
|
])
|
||||||
|
.status();
|
||||||
|
|
||||||
|
match status {
|
||||||
|
Ok(s) if s.success() && oboe_dir.join("include").join("oboe").join("Oboe.h").exists() => {
|
||||||
|
Some(oboe_dir)
|
||||||
|
}
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
21
crates/wzp-native/cpp/getauxval_fix.c
Normal file
21
crates/wzp-native/cpp/getauxval_fix.c
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
// Override the broken static getauxval from compiler-rt/CRT.
|
||||||
|
// The static version reads from __libc_auxv which is NULL in shared libs
|
||||||
|
// loaded via dlopen, causing SIGSEGV in init_have_lse_atomics at load time.
|
||||||
|
// This version calls the real bionic getauxval via dlsym.
|
||||||
|
#ifdef __ANDROID__
|
||||||
|
#include <dlfcn.h>
|
||||||
|
#include <stdint.h>
|
||||||
|
|
||||||
|
typedef unsigned long (*getauxval_fn)(unsigned long);
|
||||||
|
|
||||||
|
unsigned long getauxval(unsigned long type) {
|
||||||
|
static getauxval_fn real_getauxval = (getauxval_fn)0;
|
||||||
|
if (!real_getauxval) {
|
||||||
|
real_getauxval = (getauxval_fn)dlsym((void*)-1L /* RTLD_DEFAULT */, "getauxval");
|
||||||
|
if (!real_getauxval) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return real_getauxval(type);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
420
crates/wzp-native/cpp/oboe_bridge.cpp
Normal file
420
crates/wzp-native/cpp/oboe_bridge.cpp
Normal file
@@ -0,0 +1,420 @@
|
|||||||
|
// Full Oboe implementation for Android
|
||||||
|
// This file is compiled only when targeting Android
|
||||||
|
|
||||||
|
#include "oboe_bridge.h"
|
||||||
|
|
||||||
|
#ifdef __ANDROID__
|
||||||
|
#include <oboe/Oboe.h>
|
||||||
|
#include <android/log.h>
|
||||||
|
#include <cstring>
|
||||||
|
#include <atomic>
|
||||||
|
|
||||||
|
#define LOG_TAG "wzp-oboe"
|
||||||
|
#define LOGI(...) __android_log_print(ANDROID_LOG_INFO, LOG_TAG, __VA_ARGS__)
|
||||||
|
#define LOGW(...) __android_log_print(ANDROID_LOG_WARN, LOG_TAG, __VA_ARGS__)
|
||||||
|
#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Ring buffer helpers (SPSC, lock-free)
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
static inline int32_t ring_available_read(const wzp_atomic_int* write_idx,
|
||||||
|
const wzp_atomic_int* read_idx,
|
||||||
|
int32_t capacity) {
|
||||||
|
int32_t w = std::atomic_load_explicit(write_idx, std::memory_order_acquire);
|
||||||
|
int32_t r = std::atomic_load_explicit(read_idx, std::memory_order_relaxed);
|
||||||
|
int32_t avail = w - r;
|
||||||
|
if (avail < 0) avail += capacity;
|
||||||
|
return avail;
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline int32_t ring_available_write(const wzp_atomic_int* write_idx,
|
||||||
|
const wzp_atomic_int* read_idx,
|
||||||
|
int32_t capacity) {
|
||||||
|
return capacity - 1 - ring_available_read(write_idx, read_idx, capacity);
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void ring_write(int16_t* buf, int32_t capacity,
|
||||||
|
wzp_atomic_int* write_idx, const wzp_atomic_int* read_idx,
|
||||||
|
const int16_t* src, int32_t count) {
|
||||||
|
int32_t w = std::atomic_load_explicit(write_idx, std::memory_order_relaxed);
|
||||||
|
for (int32_t i = 0; i < count; i++) {
|
||||||
|
buf[w] = src[i];
|
||||||
|
w++;
|
||||||
|
if (w >= capacity) w = 0;
|
||||||
|
}
|
||||||
|
std::atomic_store_explicit(write_idx, w, std::memory_order_release);
|
||||||
|
}
|
||||||
|
|
||||||
|
static inline void ring_read(int16_t* buf, int32_t capacity,
|
||||||
|
const wzp_atomic_int* write_idx, wzp_atomic_int* read_idx,
|
||||||
|
int16_t* dst, int32_t count) {
|
||||||
|
int32_t r = std::atomic_load_explicit(read_idx, std::memory_order_relaxed);
|
||||||
|
for (int32_t i = 0; i < count; i++) {
|
||||||
|
dst[i] = buf[r];
|
||||||
|
r++;
|
||||||
|
if (r >= capacity) r = 0;
|
||||||
|
}
|
||||||
|
std::atomic_store_explicit(read_idx, r, std::memory_order_release);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Global state
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
static std::shared_ptr<oboe::AudioStream> g_capture_stream;
|
||||||
|
static std::shared_ptr<oboe::AudioStream> g_playout_stream;
|
||||||
|
// Value copy — the WzpOboeRings the Rust side passes us lives on the caller's
|
||||||
|
// stack frame and goes away as soon as wzp_oboe_start returns. The raw
|
||||||
|
// int16/atomic pointers INSIDE the struct point into the Rust-owned, leaked-
|
||||||
|
// for-the-lifetime-of-the-process AudioBackend singleton, so copying the
|
||||||
|
// struct by value is safe and keeps the inner pointers valid indefinitely.
|
||||||
|
// g_rings_valid guards the audio-callback-side read; clearing it in stop()
|
||||||
|
// signals "no backend" to the callbacks which then return silence + Stop.
|
||||||
|
static WzpOboeRings g_rings{};
|
||||||
|
static std::atomic<bool> g_rings_valid{false};
|
||||||
|
static std::atomic<bool> g_running{false};
|
||||||
|
static std::atomic<float> g_capture_latency_ms{0.0f};
|
||||||
|
static std::atomic<float> g_playout_latency_ms{0.0f};
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Capture callback
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class CaptureCallback : public oboe::AudioStreamDataCallback {
|
||||||
|
public:
|
||||||
|
uint64_t calls = 0;
|
||||||
|
uint64_t total_frames = 0;
|
||||||
|
uint64_t total_written = 0;
|
||||||
|
uint64_t ring_full_drops = 0;
|
||||||
|
|
||||||
|
oboe::DataCallbackResult onAudioReady(
|
||||||
|
oboe::AudioStream* stream,
|
||||||
|
void* audioData,
|
||||||
|
int32_t numFrames) override {
|
||||||
|
if (!g_running.load(std::memory_order_relaxed) ||
|
||||||
|
!g_rings_valid.load(std::memory_order_acquire)) {
|
||||||
|
return oboe::DataCallbackResult::Stop;
|
||||||
|
}
|
||||||
|
|
||||||
|
const int16_t* src = static_cast<const int16_t*>(audioData);
|
||||||
|
int32_t avail = ring_available_write(g_rings.capture_write_idx,
|
||||||
|
g_rings.capture_read_idx,
|
||||||
|
g_rings.capture_capacity);
|
||||||
|
int32_t to_write = (numFrames < avail) ? numFrames : avail;
|
||||||
|
if (to_write > 0) {
|
||||||
|
ring_write(g_rings.capture_buf, g_rings.capture_capacity,
|
||||||
|
g_rings.capture_write_idx, g_rings.capture_read_idx,
|
||||||
|
src, to_write);
|
||||||
|
}
|
||||||
|
total_frames += numFrames;
|
||||||
|
total_written += to_write;
|
||||||
|
if (to_write < numFrames) {
|
||||||
|
ring_full_drops += (numFrames - to_write);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sample-range probe on the FIRST callback to prove we get real audio
|
||||||
|
if (calls == 0 && numFrames > 0) {
|
||||||
|
int16_t lo = src[0], hi = src[0];
|
||||||
|
int32_t sumsq = 0;
|
||||||
|
for (int32_t i = 0; i < numFrames; i++) {
|
||||||
|
if (src[i] < lo) lo = src[i];
|
||||||
|
if (src[i] > hi) hi = src[i];
|
||||||
|
sumsq += (int32_t)src[i] * (int32_t)src[i];
|
||||||
|
}
|
||||||
|
int32_t rms = (int32_t) (numFrames > 0 ? (int32_t)__builtin_sqrt((double)sumsq / (double)numFrames) : 0);
|
||||||
|
LOGI("capture cb#0: numFrames=%d sample_range=[%d..%d] rms=%d to_write=%d",
|
||||||
|
numFrames, lo, hi, rms, to_write);
|
||||||
|
}
|
||||||
|
// Heartbeat every 50 callbacks (~1s at 20ms/burst)
|
||||||
|
calls++;
|
||||||
|
if ((calls % 50) == 0) {
|
||||||
|
LOGI("capture heartbeat: calls=%llu numFrames=%d ring_avail_write=%d to_write=%d full_drops=%llu total_written=%llu",
|
||||||
|
(unsigned long long)calls, numFrames, avail, to_write,
|
||||||
|
(unsigned long long)ring_full_drops, (unsigned long long)total_written);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update latency estimate
|
||||||
|
auto result = stream->calculateLatencyMillis();
|
||||||
|
if (result) {
|
||||||
|
g_capture_latency_ms.store(static_cast<float>(result.value()),
|
||||||
|
std::memory_order_relaxed);
|
||||||
|
}
|
||||||
|
|
||||||
|
return oboe::DataCallbackResult::Continue;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Playout callback
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class PlayoutCallback : public oboe::AudioStreamDataCallback {
|
||||||
|
public:
|
||||||
|
uint64_t calls = 0;
|
||||||
|
uint64_t total_frames = 0;
|
||||||
|
uint64_t total_played_real = 0;
|
||||||
|
uint64_t underrun_frames = 0;
|
||||||
|
uint64_t nonempty_calls = 0;
|
||||||
|
|
||||||
|
oboe::DataCallbackResult onAudioReady(
|
||||||
|
oboe::AudioStream* stream,
|
||||||
|
void* audioData,
|
||||||
|
int32_t numFrames) override {
|
||||||
|
if (!g_running.load(std::memory_order_relaxed) ||
|
||||||
|
!g_rings_valid.load(std::memory_order_acquire)) {
|
||||||
|
memset(audioData, 0, numFrames * sizeof(int16_t));
|
||||||
|
return oboe::DataCallbackResult::Stop;
|
||||||
|
}
|
||||||
|
|
||||||
|
int16_t* dst = static_cast<int16_t*>(audioData);
|
||||||
|
int32_t avail = ring_available_read(g_rings.playout_write_idx,
|
||||||
|
g_rings.playout_read_idx,
|
||||||
|
g_rings.playout_capacity);
|
||||||
|
int32_t to_read = (numFrames < avail) ? numFrames : avail;
|
||||||
|
|
||||||
|
if (to_read > 0) {
|
||||||
|
ring_read(g_rings.playout_buf, g_rings.playout_capacity,
|
||||||
|
g_rings.playout_write_idx, g_rings.playout_read_idx,
|
||||||
|
dst, to_read);
|
||||||
|
nonempty_calls++;
|
||||||
|
}
|
||||||
|
// Fill remainder with silence on underrun
|
||||||
|
if (to_read < numFrames) {
|
||||||
|
memset(dst + to_read, 0, (numFrames - to_read) * sizeof(int16_t));
|
||||||
|
underrun_frames += (numFrames - to_read);
|
||||||
|
}
|
||||||
|
total_frames += numFrames;
|
||||||
|
total_played_real += to_read;
|
||||||
|
|
||||||
|
// First callback: log requested config + prove we're being called
|
||||||
|
if (calls == 0) {
|
||||||
|
LOGI("playout cb#0: numFrames=%d ring_avail_read=%d to_read=%d",
|
||||||
|
numFrames, avail, to_read);
|
||||||
|
}
|
||||||
|
// On the first callback that actually has data, log the sample range
|
||||||
|
// so we can tell if the samples coming out of the ring look like real
|
||||||
|
// audio vs constant-zeroes vs garbage.
|
||||||
|
if (to_read > 0 && nonempty_calls == 1) {
|
||||||
|
int16_t lo = dst[0], hi = dst[0];
|
||||||
|
int32_t sumsq = 0;
|
||||||
|
for (int32_t i = 0; i < to_read; i++) {
|
||||||
|
if (dst[i] < lo) lo = dst[i];
|
||||||
|
if (dst[i] > hi) hi = dst[i];
|
||||||
|
sumsq += (int32_t)dst[i] * (int32_t)dst[i];
|
||||||
|
}
|
||||||
|
int32_t rms = (to_read > 0) ? (int32_t)__builtin_sqrt((double)sumsq / (double)to_read) : 0;
|
||||||
|
LOGI("playout FIRST nonempty read: to_read=%d sample_range=[%d..%d] rms=%d",
|
||||||
|
to_read, lo, hi, rms);
|
||||||
|
}
|
||||||
|
// Heartbeat every 50 callbacks (~1s at 20ms/burst)
|
||||||
|
calls++;
|
||||||
|
if ((calls % 50) == 0) {
|
||||||
|
int state = (int)stream->getState();
|
||||||
|
auto xrunRes = stream->getXRunCount();
|
||||||
|
int xruns = xrunRes ? xrunRes.value() : -1;
|
||||||
|
LOGI("playout heartbeat: calls=%llu nonempty=%llu numFrames=%d ring_avail_read=%d to_read=%d underrun_frames=%llu total_played_real=%llu state=%d xruns=%d",
|
||||||
|
(unsigned long long)calls, (unsigned long long)nonempty_calls,
|
||||||
|
numFrames, avail, to_read,
|
||||||
|
(unsigned long long)underrun_frames, (unsigned long long)total_played_real,
|
||||||
|
state, xruns);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update latency estimate
|
||||||
|
auto result = stream->calculateLatencyMillis();
|
||||||
|
if (result) {
|
||||||
|
g_playout_latency_ms.store(static_cast<float>(result.value()),
|
||||||
|
std::memory_order_relaxed);
|
||||||
|
}
|
||||||
|
|
||||||
|
return oboe::DataCallbackResult::Continue;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
static CaptureCallback g_capture_cb;
|
||||||
|
static PlayoutCallback g_playout_cb;
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Public C API
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
int wzp_oboe_start(const WzpOboeConfig* config, const WzpOboeRings* rings) {
|
||||||
|
if (g_running.load(std::memory_order_relaxed)) {
|
||||||
|
LOGW("wzp_oboe_start: already running");
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deep-copy the rings struct into static storage BEFORE we publish it to
|
||||||
|
// the audio callbacks — `rings` points at the caller's stack frame and
|
||||||
|
// goes away as soon as this function returns.
|
||||||
|
g_rings = *rings;
|
||||||
|
g_rings_valid.store(true, std::memory_order_release);
|
||||||
|
|
||||||
|
// Build capture stream
|
||||||
|
oboe::AudioStreamBuilder captureBuilder;
|
||||||
|
captureBuilder.setDirection(oboe::Direction::Input)
|
||||||
|
->setPerformanceMode(oboe::PerformanceMode::LowLatency)
|
||||||
|
->setSharingMode(oboe::SharingMode::Exclusive)
|
||||||
|
->setFormat(oboe::AudioFormat::I16)
|
||||||
|
->setChannelCount(config->channel_count)
|
||||||
|
->setSampleRate(config->sample_rate)
|
||||||
|
->setFramesPerDataCallback(config->frames_per_burst)
|
||||||
|
->setInputPreset(oboe::InputPreset::VoiceCommunication)
|
||||||
|
->setDataCallback(&g_capture_cb);
|
||||||
|
|
||||||
|
oboe::Result result = captureBuilder.openStream(g_capture_stream);
|
||||||
|
if (result != oboe::Result::OK) {
|
||||||
|
LOGE("Failed to open capture stream: %s", oboe::convertToText(result));
|
||||||
|
return -2;
|
||||||
|
}
|
||||||
|
LOGI("capture stream opened: actualSR=%d actualCh=%d actualFormat=%d actualFramesPerBurst=%d actualFramesPerDataCallback=%d bufferCapacityInFrames=%d sharing=%d perfMode=%d",
|
||||||
|
g_capture_stream->getSampleRate(),
|
||||||
|
g_capture_stream->getChannelCount(),
|
||||||
|
(int)g_capture_stream->getFormat(),
|
||||||
|
g_capture_stream->getFramesPerBurst(),
|
||||||
|
g_capture_stream->getFramesPerDataCallback(),
|
||||||
|
g_capture_stream->getBufferCapacityInFrames(),
|
||||||
|
(int)g_capture_stream->getSharingMode(),
|
||||||
|
(int)g_capture_stream->getPerformanceMode());
|
||||||
|
|
||||||
|
// Build playout stream.
|
||||||
|
//
|
||||||
|
// Regression triangulation between builds:
|
||||||
|
// 96be740 (Usage::Media, default API): playout callback DID drain
|
||||||
|
// the ring at steady 50Hz (playout heartbeat: calls=1100,
|
||||||
|
// total_played_real=1055040). Audio not audible because OS routing
|
||||||
|
// sent it to a silent output.
|
||||||
|
//
|
||||||
|
// 8c36fb5 (Usage::VoiceCommunication + setAudioApi(AAudio) +
|
||||||
|
// ContentType::Speech): playout callback fired cb#0 once then
|
||||||
|
// stopped draining the ring entirely. written_samples stuck at
|
||||||
|
// ring capacity (7679) across all subsequent heartbeats, so Oboe
|
||||||
|
// accepted zero samples after startup. Still inaudible.
|
||||||
|
//
|
||||||
|
// Hypothesis: forcing setAudioApi(AAudio) + VoiceCommunication on
|
||||||
|
// Pixel 6 / Android 15 opens a stream that succeeds at cb#0 but
|
||||||
|
// then detaches from the real audio driver. Reverting to the
|
||||||
|
// config that at least drove callbacks correctly, plus the
|
||||||
|
// Kotlin-side MODE_IN_COMMUNICATION + setSpeakerphoneOn(true)
|
||||||
|
// handled in MainActivity.kt to route audio to the loud speaker.
|
||||||
|
// Usage::VoiceCommunication is the correct Oboe usage for a VoIP app
|
||||||
|
// — it respects Android's in-call audio routing and lets
|
||||||
|
// AudioManager.setSpeakerphoneOn/setBluetoothScoOn actually switch
|
||||||
|
// between earpiece, loudspeaker, and Bluetooth headset. Combined with
|
||||||
|
// MODE_IN_COMMUNICATION set from MainActivity.kt and
|
||||||
|
// speakerphoneOn=false by default, this produces handset/earpiece as
|
||||||
|
// the default output.
|
||||||
|
//
|
||||||
|
// IMPORTANT: do NOT add setAudioApi(AAudio) here. Build 8c36fb5 proved
|
||||||
|
// forcing AAudio with Usage::VoiceCommunication makes the playout
|
||||||
|
// callback stop draining the ring after cb#0, even though the stream
|
||||||
|
// opens successfully. Letting Oboe pick the API (which will be AAudio
|
||||||
|
// on API ≥ 27 but via a different codepath) kept callbacks firing in
|
||||||
|
// every other build.
|
||||||
|
oboe::AudioStreamBuilder playoutBuilder;
|
||||||
|
playoutBuilder.setDirection(oboe::Direction::Output)
|
||||||
|
->setPerformanceMode(oboe::PerformanceMode::LowLatency)
|
||||||
|
->setSharingMode(oboe::SharingMode::Exclusive)
|
||||||
|
->setFormat(oboe::AudioFormat::I16)
|
||||||
|
->setChannelCount(config->channel_count)
|
||||||
|
->setSampleRate(config->sample_rate)
|
||||||
|
->setFramesPerDataCallback(config->frames_per_burst)
|
||||||
|
->setUsage(oboe::Usage::VoiceCommunication)
|
||||||
|
->setDataCallback(&g_playout_cb);
|
||||||
|
|
||||||
|
result = playoutBuilder.openStream(g_playout_stream);
|
||||||
|
if (result != oboe::Result::OK) {
|
||||||
|
LOGE("Failed to open playout stream: %s", oboe::convertToText(result));
|
||||||
|
g_capture_stream->close();
|
||||||
|
g_capture_stream.reset();
|
||||||
|
return -3;
|
||||||
|
}
|
||||||
|
LOGI("playout stream opened: actualSR=%d actualCh=%d actualFormat=%d actualFramesPerBurst=%d actualFramesPerDataCallback=%d bufferCapacityInFrames=%d sharing=%d perfMode=%d",
|
||||||
|
g_playout_stream->getSampleRate(),
|
||||||
|
g_playout_stream->getChannelCount(),
|
||||||
|
(int)g_playout_stream->getFormat(),
|
||||||
|
g_playout_stream->getFramesPerBurst(),
|
||||||
|
g_playout_stream->getFramesPerDataCallback(),
|
||||||
|
g_playout_stream->getBufferCapacityInFrames(),
|
||||||
|
(int)g_playout_stream->getSharingMode(),
|
||||||
|
(int)g_playout_stream->getPerformanceMode());
|
||||||
|
|
||||||
|
g_running.store(true, std::memory_order_release);
|
||||||
|
|
||||||
|
// Start both streams
|
||||||
|
result = g_capture_stream->requestStart();
|
||||||
|
if (result != oboe::Result::OK) {
|
||||||
|
LOGE("Failed to start capture: %s", oboe::convertToText(result));
|
||||||
|
g_running.store(false, std::memory_order_release);
|
||||||
|
g_capture_stream->close();
|
||||||
|
g_playout_stream->close();
|
||||||
|
g_capture_stream.reset();
|
||||||
|
g_playout_stream.reset();
|
||||||
|
return -4;
|
||||||
|
}
|
||||||
|
|
||||||
|
result = g_playout_stream->requestStart();
|
||||||
|
if (result != oboe::Result::OK) {
|
||||||
|
LOGE("Failed to start playout: %s", oboe::convertToText(result));
|
||||||
|
g_running.store(false, std::memory_order_release);
|
||||||
|
g_capture_stream->requestStop();
|
||||||
|
g_capture_stream->close();
|
||||||
|
g_playout_stream->close();
|
||||||
|
g_capture_stream.reset();
|
||||||
|
g_playout_stream.reset();
|
||||||
|
return -5;
|
||||||
|
}
|
||||||
|
|
||||||
|
LOGI("Oboe started: sr=%d burst=%d ch=%d",
|
||||||
|
config->sample_rate, config->frames_per_burst, config->channel_count);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
void wzp_oboe_stop(void) {
|
||||||
|
g_running.store(false, std::memory_order_release);
|
||||||
|
// Tell the audio callbacks to stop touching g_rings BEFORE we tear down
|
||||||
|
// the streams, so any in-flight callback returns Stop instead of reading
|
||||||
|
// stale pointers.
|
||||||
|
g_rings_valid.store(false, std::memory_order_release);
|
||||||
|
|
||||||
|
if (g_capture_stream) {
|
||||||
|
g_capture_stream->requestStop();
|
||||||
|
g_capture_stream->close();
|
||||||
|
g_capture_stream.reset();
|
||||||
|
}
|
||||||
|
if (g_playout_stream) {
|
||||||
|
g_playout_stream->requestStop();
|
||||||
|
g_playout_stream->close();
|
||||||
|
g_playout_stream.reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
LOGI("Oboe stopped");
|
||||||
|
}
|
||||||
|
|
||||||
|
float wzp_oboe_capture_latency_ms(void) {
|
||||||
|
return g_capture_latency_ms.load(std::memory_order_relaxed);
|
||||||
|
}
|
||||||
|
|
||||||
|
float wzp_oboe_playout_latency_ms(void) {
|
||||||
|
return g_playout_latency_ms.load(std::memory_order_relaxed);
|
||||||
|
}
|
||||||
|
|
||||||
|
int wzp_oboe_is_running(void) {
|
||||||
|
return g_running.load(std::memory_order_relaxed) ? 1 : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#else
|
||||||
|
// Non-Android fallback — should not be reached; oboe_stub.cpp is used instead.
|
||||||
|
// Provide empty implementations just in case.
|
||||||
|
|
||||||
|
int wzp_oboe_start(const WzpOboeConfig* config, const WzpOboeRings* rings) {
|
||||||
|
(void)config; (void)rings;
|
||||||
|
return -99;
|
||||||
|
}
|
||||||
|
|
||||||
|
void wzp_oboe_stop(void) {}
|
||||||
|
float wzp_oboe_capture_latency_ms(void) { return 0.0f; }
|
||||||
|
float wzp_oboe_playout_latency_ms(void) { return 0.0f; }
|
||||||
|
int wzp_oboe_is_running(void) { return 0; }
|
||||||
|
|
||||||
|
#endif // __ANDROID__
|
||||||
43
crates/wzp-native/cpp/oboe_bridge.h
Normal file
43
crates/wzp-native/cpp/oboe_bridge.h
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
#ifndef WZP_OBOE_BRIDGE_H
|
||||||
|
#define WZP_OBOE_BRIDGE_H
|
||||||
|
|
||||||
|
#include <stdint.h>
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
#include <atomic>
|
||||||
|
typedef std::atomic<int32_t> wzp_atomic_int;
|
||||||
|
extern "C" {
|
||||||
|
#else
|
||||||
|
#include <stdatomic.h>
|
||||||
|
typedef atomic_int wzp_atomic_int;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
int32_t sample_rate;
|
||||||
|
int32_t frames_per_burst;
|
||||||
|
int32_t channel_count;
|
||||||
|
} WzpOboeConfig;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
int16_t* capture_buf;
|
||||||
|
int32_t capture_capacity;
|
||||||
|
wzp_atomic_int* capture_write_idx;
|
||||||
|
wzp_atomic_int* capture_read_idx;
|
||||||
|
|
||||||
|
int16_t* playout_buf;
|
||||||
|
int32_t playout_capacity;
|
||||||
|
wzp_atomic_int* playout_write_idx;
|
||||||
|
wzp_atomic_int* playout_read_idx;
|
||||||
|
} WzpOboeRings;
|
||||||
|
|
||||||
|
int wzp_oboe_start(const WzpOboeConfig* config, const WzpOboeRings* rings);
|
||||||
|
void wzp_oboe_stop(void);
|
||||||
|
float wzp_oboe_capture_latency_ms(void);
|
||||||
|
float wzp_oboe_playout_latency_ms(void);
|
||||||
|
int wzp_oboe_is_running(void);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif // WZP_OBOE_BRIDGE_H
|
||||||
27
crates/wzp-native/cpp/oboe_stub.cpp
Normal file
27
crates/wzp-native/cpp/oboe_stub.cpp
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
// Stub implementation for non-Android host builds (testing, cargo check, etc.)
|
||||||
|
|
||||||
|
#include "oboe_bridge.h"
|
||||||
|
#include <stdio.h>
|
||||||
|
|
||||||
|
int wzp_oboe_start(const WzpOboeConfig* config, const WzpOboeRings* rings) {
|
||||||
|
(void)config;
|
||||||
|
(void)rings;
|
||||||
|
fprintf(stderr, "wzp_oboe_start: stub (not on Android)\n");
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
void wzp_oboe_stop(void) {
|
||||||
|
fprintf(stderr, "wzp_oboe_stop: stub (not on Android)\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
float wzp_oboe_capture_latency_ms(void) {
|
||||||
|
return 0.0f;
|
||||||
|
}
|
||||||
|
|
||||||
|
float wzp_oboe_playout_latency_ms(void) {
|
||||||
|
return 0.0f;
|
||||||
|
}
|
||||||
|
|
||||||
|
int wzp_oboe_is_running(void) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
331
crates/wzp-native/src/lib.rs
Normal file
331
crates/wzp-native/src/lib.rs
Normal file
@@ -0,0 +1,331 @@
|
|||||||
|
//! wzp-native — standalone Android cdylib for all the C++ audio code.
|
||||||
|
//!
|
||||||
|
//! Built with `cargo ndk`, NOT `cargo tauri android build`. Loaded at
|
||||||
|
//! runtime by the Tauri desktop cdylib (`wzp-desktop`) via libloading.
|
||||||
|
//! See `docs/incident-tauri-android-init-tcb.md` for why the split exists.
|
||||||
|
//!
|
||||||
|
//! Phase 2: real Oboe audio backend.
|
||||||
|
//!
|
||||||
|
//! Architecture: Oboe runs capture + playout streams on its own high-
|
||||||
|
//! priority AAudio callback threads inside the C++ bridge. Two SPSC ring
|
||||||
|
//! buffers (capture and playout) are shared between the C++ callbacks
|
||||||
|
//! and the Rust side via atomic indices — no locks on the hot path.
|
||||||
|
//! `wzp-desktop` drains the capture ring into its Opus encoder and fills
|
||||||
|
//! the playout ring with decoded PCM.
|
||||||
|
|
||||||
|
use std::sync::atomic::{AtomicI32, Ordering};
|
||||||
|
|
||||||
|
// ─── Phase 1 smoke-test exports (kept for sanity checks) ─────────────────
|
||||||
|
|
||||||
|
/// Returns 42. Used by wzp-desktop's setup() to verify dlopen + dlsym
|
||||||
|
/// work before any audio code runs.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub extern "C" fn wzp_native_version() -> i32 {
|
||||||
|
42
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Writes a NUL-terminated string into `out` (capped at `cap`) and
|
||||||
|
/// returns bytes written excluding the NUL.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub unsafe extern "C" fn wzp_native_hello(out: *mut u8, cap: usize) -> usize {
|
||||||
|
const MSG: &[u8] = b"hello from wzp-native\0";
|
||||||
|
if out.is_null() || cap == 0 {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
let n = MSG.len().min(cap);
|
||||||
|
unsafe {
|
||||||
|
core::ptr::copy_nonoverlapping(MSG.as_ptr(), out, n);
|
||||||
|
*out.add(n - 1) = 0;
|
||||||
|
}
|
||||||
|
n - 1
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── C++ Oboe bridge FFI ─────────────────────────────────────────────────
|
||||||
|
|
||||||
|
#[repr(C)]
|
||||||
|
struct WzpOboeConfig {
|
||||||
|
sample_rate: i32,
|
||||||
|
frames_per_burst: i32,
|
||||||
|
channel_count: i32,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[repr(C)]
|
||||||
|
struct WzpOboeRings {
|
||||||
|
capture_buf: *mut i16,
|
||||||
|
capture_capacity: i32,
|
||||||
|
capture_write_idx: *mut AtomicI32,
|
||||||
|
capture_read_idx: *mut AtomicI32,
|
||||||
|
playout_buf: *mut i16,
|
||||||
|
playout_capacity: i32,
|
||||||
|
playout_write_idx: *mut AtomicI32,
|
||||||
|
playout_read_idx: *mut AtomicI32,
|
||||||
|
}
|
||||||
|
|
||||||
|
// SAFETY: atomics synchronise producer/consumer; raw pointers are owned
|
||||||
|
// by the AudioBackend singleton below whose lifetime covers all calls.
|
||||||
|
unsafe impl Send for WzpOboeRings {}
|
||||||
|
unsafe impl Sync for WzpOboeRings {}
|
||||||
|
|
||||||
|
unsafe extern "C" {
|
||||||
|
fn wzp_oboe_start(config: *const WzpOboeConfig, rings: *const WzpOboeRings) -> i32;
|
||||||
|
fn wzp_oboe_stop();
|
||||||
|
fn wzp_oboe_capture_latency_ms() -> f32;
|
||||||
|
fn wzp_oboe_playout_latency_ms() -> f32;
|
||||||
|
fn wzp_oboe_is_running() -> i32;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── SPSC ring buffer (shared with C++ via AtomicI32) ────────────────────
|
||||||
|
|
||||||
|
/// 20 ms @ 48 kHz mono = 960 samples.
|
||||||
|
const FRAME_SAMPLES: usize = 960;
|
||||||
|
/// ~160 ms headroom at 48 kHz.
|
||||||
|
const RING_CAPACITY: usize = 7680;
|
||||||
|
|
||||||
|
struct RingBuffer {
|
||||||
|
buf: Vec<i16>,
|
||||||
|
capacity: usize,
|
||||||
|
write_idx: AtomicI32,
|
||||||
|
read_idx: AtomicI32,
|
||||||
|
}
|
||||||
|
|
||||||
|
// SAFETY: SPSC with atomic read/write cursors; producer and consumer
|
||||||
|
// are always on different threads.
|
||||||
|
unsafe impl Send for RingBuffer {}
|
||||||
|
unsafe impl Sync for RingBuffer {}
|
||||||
|
|
||||||
|
impl RingBuffer {
|
||||||
|
fn new(capacity: usize) -> Self {
|
||||||
|
Self {
|
||||||
|
buf: vec![0i16; capacity],
|
||||||
|
capacity,
|
||||||
|
write_idx: AtomicI32::new(0),
|
||||||
|
read_idx: AtomicI32::new(0),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn available_read(&self) -> usize {
|
||||||
|
let w = self.write_idx.load(Ordering::Acquire);
|
||||||
|
let r = self.read_idx.load(Ordering::Relaxed);
|
||||||
|
let avail = w - r;
|
||||||
|
if avail < 0 { (avail + self.capacity as i32) as usize } else { avail as usize }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn available_write(&self) -> usize {
|
||||||
|
self.capacity - 1 - self.available_read()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write(&self, data: &[i16]) -> usize {
|
||||||
|
let count = data.len().min(self.available_write());
|
||||||
|
if count == 0 {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
let mut w = self.write_idx.load(Ordering::Relaxed) as usize;
|
||||||
|
let cap = self.capacity;
|
||||||
|
let buf_ptr = self.buf.as_ptr() as *mut i16;
|
||||||
|
for sample in &data[..count] {
|
||||||
|
unsafe { *buf_ptr.add(w) = *sample; }
|
||||||
|
w += 1;
|
||||||
|
if w >= cap { w = 0; }
|
||||||
|
}
|
||||||
|
self.write_idx.store(w as i32, Ordering::Release);
|
||||||
|
count
|
||||||
|
}
|
||||||
|
|
||||||
|
fn read(&self, out: &mut [i16]) -> usize {
|
||||||
|
let count = out.len().min(self.available_read());
|
||||||
|
if count == 0 {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
let mut r = self.read_idx.load(Ordering::Relaxed) as usize;
|
||||||
|
let cap = self.capacity;
|
||||||
|
let buf_ptr = self.buf.as_ptr();
|
||||||
|
for slot in &mut out[..count] {
|
||||||
|
unsafe { *slot = *buf_ptr.add(r); }
|
||||||
|
r += 1;
|
||||||
|
if r >= cap { r = 0; }
|
||||||
|
}
|
||||||
|
self.read_idx.store(r as i32, Ordering::Release);
|
||||||
|
count
|
||||||
|
}
|
||||||
|
|
||||||
|
fn buf_ptr(&self) -> *mut i16 {
|
||||||
|
self.buf.as_ptr() as *mut i16
|
||||||
|
}
|
||||||
|
fn write_idx_ptr(&self) -> *mut AtomicI32 {
|
||||||
|
&self.write_idx as *const AtomicI32 as *mut AtomicI32
|
||||||
|
}
|
||||||
|
fn read_idx_ptr(&self) -> *mut AtomicI32 {
|
||||||
|
&self.read_idx as *const AtomicI32 as *mut AtomicI32
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── AudioBackend singleton ──────────────────────────────────────────────
|
||||||
|
//
|
||||||
|
// There is one global AudioBackend instance because Oboe's C++ side
|
||||||
|
// holds its own singleton of the streams. The `Box::leak`'d statics own
|
||||||
|
// the ring buffers for the lifetime of the process — dropping them while
|
||||||
|
// Oboe is still running would cause use-after-free in the audio callback.
|
||||||
|
|
||||||
|
use std::sync::OnceLock;
|
||||||
|
|
||||||
|
struct AudioBackend {
|
||||||
|
capture: RingBuffer,
|
||||||
|
playout: RingBuffer,
|
||||||
|
started: std::sync::Mutex<bool>,
|
||||||
|
/// Per-write logging throttle counter for wzp_native_audio_write_playout.
|
||||||
|
playout_write_log_count: std::sync::atomic::AtomicU64,
|
||||||
|
}
|
||||||
|
|
||||||
|
static BACKEND: OnceLock<&'static AudioBackend> = OnceLock::new();
|
||||||
|
|
||||||
|
fn backend() -> &'static AudioBackend {
|
||||||
|
BACKEND.get_or_init(|| {
|
||||||
|
Box::leak(Box::new(AudioBackend {
|
||||||
|
capture: RingBuffer::new(RING_CAPACITY),
|
||||||
|
playout: RingBuffer::new(RING_CAPACITY),
|
||||||
|
started: std::sync::Mutex::new(false),
|
||||||
|
playout_write_log_count: std::sync::atomic::AtomicU64::new(0),
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── C FFI for wzp-desktop ───────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Start the Oboe audio streams. Returns 0 on success, non-zero on error.
|
||||||
|
/// Idempotent — calling while already running is a no-op that returns 0.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub extern "C" fn wzp_native_audio_start() -> i32 {
|
||||||
|
let b = backend();
|
||||||
|
let mut started = match b.started.lock() {
|
||||||
|
Ok(g) => g,
|
||||||
|
Err(_) => return -1,
|
||||||
|
};
|
||||||
|
if *started {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
let config = WzpOboeConfig {
|
||||||
|
sample_rate: 48_000,
|
||||||
|
frames_per_burst: FRAME_SAMPLES as i32,
|
||||||
|
channel_count: 1,
|
||||||
|
};
|
||||||
|
let rings = WzpOboeRings {
|
||||||
|
capture_buf: b.capture.buf_ptr(),
|
||||||
|
capture_capacity: b.capture.capacity as i32,
|
||||||
|
capture_write_idx: b.capture.write_idx_ptr(),
|
||||||
|
capture_read_idx: b.capture.read_idx_ptr(),
|
||||||
|
playout_buf: b.playout.buf_ptr(),
|
||||||
|
playout_capacity: b.playout.capacity as i32,
|
||||||
|
playout_write_idx: b.playout.write_idx_ptr(),
|
||||||
|
playout_read_idx: b.playout.read_idx_ptr(),
|
||||||
|
};
|
||||||
|
let ret = unsafe { wzp_oboe_start(&config, &rings) };
|
||||||
|
if ret != 0 {
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
*started = true;
|
||||||
|
0
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stop Oboe. Idempotent. Safe to call from any thread.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub extern "C" fn wzp_native_audio_stop() {
|
||||||
|
let b = backend();
|
||||||
|
if let Ok(mut started) = b.started.lock() {
|
||||||
|
if *started {
|
||||||
|
unsafe { wzp_oboe_stop() };
|
||||||
|
*started = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read captured PCM samples from the capture ring. Returns the number
|
||||||
|
/// of `i16` samples actually copied into `out` (may be less than
|
||||||
|
/// `out_len` if the ring is empty).
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub unsafe extern "C" fn wzp_native_audio_read_capture(out: *mut i16, out_len: usize) -> usize {
|
||||||
|
if out.is_null() || out_len == 0 {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
let slice = unsafe { std::slice::from_raw_parts_mut(out, out_len) };
|
||||||
|
backend().capture.read(slice)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write PCM samples into the playout ring. Returns the number of
|
||||||
|
/// samples actually enqueued (may be less than `in_len` if the ring
|
||||||
|
/// is nearly full — in practice the caller should pace to 20 ms
|
||||||
|
/// frames and spin briefly if the ring is full).
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub unsafe extern "C" fn wzp_native_audio_write_playout(input: *const i16, in_len: usize) -> usize {
|
||||||
|
if input.is_null() || in_len == 0 {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
let slice = unsafe { std::slice::from_raw_parts(input, in_len) };
|
||||||
|
let b = backend();
|
||||||
|
let before_w = b.playout.write_idx.load(std::sync::atomic::Ordering::Relaxed);
|
||||||
|
let before_r = b.playout.read_idx.load(std::sync::atomic::Ordering::Relaxed);
|
||||||
|
let written = b.playout.write(slice);
|
||||||
|
// First few writes: log ring state + sample range so we can compare what
|
||||||
|
// engine.rs hands us to what the C++ playout callback reads.
|
||||||
|
let first_writes = b.playout_write_log_count.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
|
||||||
|
if first_writes < 3 || first_writes % 50 == 0 {
|
||||||
|
let (mut lo, mut hi, mut sumsq) = (i16::MAX, i16::MIN, 0i64);
|
||||||
|
for &s in slice.iter() {
|
||||||
|
if s < lo { lo = s; }
|
||||||
|
if s > hi { hi = s; }
|
||||||
|
sumsq += (s as i64) * (s as i64);
|
||||||
|
}
|
||||||
|
let rms = (sumsq as f64 / slice.len() as f64).sqrt() as i32;
|
||||||
|
let avail_w_after = b.playout.available_write();
|
||||||
|
let avail_r_after = b.playout.available_read();
|
||||||
|
let msg = format!(
|
||||||
|
"playout WRITE #{first_writes}: in_len={} written={} range=[{lo}..{hi}] rms={rms} before_w={before_w} before_r={before_r} avail_read_after={avail_r_after} avail_write_after={avail_w_after}",
|
||||||
|
slice.len(), written
|
||||||
|
);
|
||||||
|
unsafe {
|
||||||
|
android_log(msg.as_str());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
written
|
||||||
|
}
|
||||||
|
|
||||||
|
// Minimal android logcat shim so we can print from the cdylib without pulling
|
||||||
|
// in android_logger crate (which would add another dep that has to build with
|
||||||
|
// cargo-ndk). Uses libc's __android_log_print via extern linkage.
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
unsafe extern "C" {
|
||||||
|
fn __android_log_write(prio: i32, tag: *const u8, text: *const u8) -> i32;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
unsafe fn android_log(msg: &str) {
|
||||||
|
// ANDROID_LOG_INFO = 4. Tag and text must be NUL-terminated.
|
||||||
|
let tag = b"wzp-native\0";
|
||||||
|
let mut buf = Vec::with_capacity(msg.len() + 1);
|
||||||
|
buf.extend_from_slice(msg.as_bytes());
|
||||||
|
buf.push(0);
|
||||||
|
unsafe { __android_log_write(4, tag.as_ptr(), buf.as_ptr()); }
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(target_os = "android"))]
|
||||||
|
#[allow(dead_code)]
|
||||||
|
unsafe fn android_log(_msg: &str) {}
|
||||||
|
|
||||||
|
/// Current capture latency reported by Oboe, in milliseconds. Returns
|
||||||
|
/// NaN / 0.0 if the stream isn't running.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub extern "C" fn wzp_native_audio_capture_latency_ms() -> f32 {
|
||||||
|
unsafe { wzp_oboe_capture_latency_ms() }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Current playout latency reported by Oboe, in milliseconds.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub extern "C" fn wzp_native_audio_playout_latency_ms() -> f32 {
|
||||||
|
unsafe { wzp_oboe_playout_latency_ms() }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Non-zero if both Oboe streams are currently running.
|
||||||
|
#[unsafe(no_mangle)]
|
||||||
|
pub extern "C" fn wzp_native_audio_is_running() -> i32 {
|
||||||
|
unsafe { wzp_oboe_is_running() }
|
||||||
|
}
|
||||||
@@ -584,6 +584,26 @@ pub enum SignalMessage {
|
|||||||
recommended_profile: crate::QualityProfile,
|
recommended_profile: crate::QualityProfile,
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/// Phase 4 telemetry: loss-recovery counts for the current session.
|
||||||
|
/// Sent periodically from receivers to the relay so Prometheus metrics
|
||||||
|
/// can distinguish DRED reconstructions from classical PLC invocations.
|
||||||
|
/// Fields default to 0 on old receivers (`#[serde(default)]`), so
|
||||||
|
/// introducing this variant is backward-compatible with pre-Phase-4
|
||||||
|
/// relays — they'll just log "unknown signal variant" on receipt.
|
||||||
|
LossRecoveryUpdate {
|
||||||
|
/// Total frames reconstructed via DRED since call start (monotonic).
|
||||||
|
#[serde(default)]
|
||||||
|
dred_reconstructions: u64,
|
||||||
|
/// Total frames filled via classical Opus/Codec2 PLC since call
|
||||||
|
/// start (monotonic).
|
||||||
|
#[serde(default)]
|
||||||
|
classical_plc_invocations: u64,
|
||||||
|
/// Total frames decoded since call start. Used by the relay to
|
||||||
|
/// compute recovery rates as a fraction of total frames.
|
||||||
|
#[serde(default)]
|
||||||
|
frames_decoded: u64,
|
||||||
|
},
|
||||||
|
|
||||||
/// Connection keepalive / RTT measurement.
|
/// Connection keepalive / RTT measurement.
|
||||||
Ping { timestamp_ms: u64 },
|
Ping { timestamp_ms: u64 },
|
||||||
Pong { timestamp_ms: u64 },
|
Pong { timestamp_ms: u64 },
|
||||||
@@ -750,6 +770,29 @@ pub enum SignalMessage {
|
|||||||
CallRinging {
|
CallRinging {
|
||||||
call_id: String,
|
call_id: String,
|
||||||
},
|
},
|
||||||
|
|
||||||
|
// ── NAT reflection ("STUN for QUIC") ──────────────────────────────
|
||||||
|
|
||||||
|
/// Client → relay: "please tell me the source IP:port you see on
|
||||||
|
/// this connection". A QUIC-native replacement for classic STUN
|
||||||
|
/// that reuses the TLS-authenticated signal channel to the relay
|
||||||
|
/// instead of running a separate UDP reflection service on port
|
||||||
|
/// 3478. The relay answers with `ReflectResponse`.
|
||||||
|
///
|
||||||
|
/// No payload — the relay already knows which connection the
|
||||||
|
/// request arrived on, and `connection.remote_address()` gives it
|
||||||
|
/// the exact source address (post-NAT) as observed from the
|
||||||
|
/// server side of the TLS session.
|
||||||
|
Reflect,
|
||||||
|
|
||||||
|
/// Relay → client: response to `Reflect`. Carries the socket
|
||||||
|
/// address the relay observes as the client's source for this
|
||||||
|
/// QUIC connection in `SocketAddr::to_string()` form — "a.b.c.d:p"
|
||||||
|
/// for IPv4, "[::1]:p" for IPv6. Clients parse it with
|
||||||
|
/// `SocketAddr::from_str`.
|
||||||
|
ReflectResponse {
|
||||||
|
observed_addr: String,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
/// How the callee responds to a direct call.
|
/// How the callee responds to a direct call.
|
||||||
@@ -888,6 +931,58 @@ mod tests {
|
|||||||
assert_eq!(packet.quality_report, decoded.quality_report);
|
assert_eq!(packet.quality_report, decoded.quality_report);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn reflect_serialize_roundtrip() {
|
||||||
|
// Reflect is a unit variant — the client sends it with no
|
||||||
|
// payload and the relay answers with the observed source addr.
|
||||||
|
let req = SignalMessage::Reflect;
|
||||||
|
let json = serde_json::to_string(&req).unwrap();
|
||||||
|
let decoded: SignalMessage = serde_json::from_str(&json).unwrap();
|
||||||
|
assert!(matches!(decoded, SignalMessage::Reflect));
|
||||||
|
|
||||||
|
// ReflectResponse carries a string — exercise both IPv4 and
|
||||||
|
// IPv6 shapes because SocketAddr::to_string uses [::1]:port
|
||||||
|
// for v6 and the client side has to parse that back.
|
||||||
|
for addr in ["192.0.2.17:4433", "[2001:db8::1]:4433", "127.0.0.1:54321"] {
|
||||||
|
let resp = SignalMessage::ReflectResponse {
|
||||||
|
observed_addr: addr.to_string(),
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&resp).unwrap();
|
||||||
|
let decoded: SignalMessage = serde_json::from_str(&json).unwrap();
|
||||||
|
match decoded {
|
||||||
|
SignalMessage::ReflectResponse { observed_addr } => {
|
||||||
|
assert_eq!(observed_addr, addr);
|
||||||
|
// Must parse back to a SocketAddr cleanly.
|
||||||
|
let _parsed: std::net::SocketAddr = observed_addr.parse()
|
||||||
|
.expect("observed_addr must parse as SocketAddr");
|
||||||
|
}
|
||||||
|
_ => panic!("wrong variant after roundtrip"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn reflect_backward_compat_with_existing_variants() {
|
||||||
|
// Adding Reflect/ReflectResponse at the end of the enum must
|
||||||
|
// not break JSON round-tripping of existing variants. Smoke-
|
||||||
|
// test a sample of the pre-existing ones.
|
||||||
|
let cases = vec![
|
||||||
|
SignalMessage::Ping { timestamp_ms: 12345 },
|
||||||
|
SignalMessage::Hold,
|
||||||
|
SignalMessage::Hangup { reason: HangupReason::Normal },
|
||||||
|
SignalMessage::CallRinging { call_id: "abcd".into() },
|
||||||
|
];
|
||||||
|
for m in cases {
|
||||||
|
let json = serde_json::to_string(&m).unwrap();
|
||||||
|
let decoded: SignalMessage = serde_json::from_str(&json).unwrap();
|
||||||
|
// Discriminant equality proves variant tag survived.
|
||||||
|
assert_eq!(
|
||||||
|
std::mem::discriminant(&m),
|
||||||
|
std::mem::discriminant(&decoded)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn hold_unhold_serialize() {
|
fn hold_unhold_serialize() {
|
||||||
let hold = SignalMessage::Hold;
|
let hold = SignalMessage::Hold;
|
||||||
|
|||||||
@@ -5,7 +5,6 @@
|
|||||||
//! Use `wzp-analyzer` to correlate events across multiple relays.
|
//! Use `wzp-analyzer` to correlate events across multiple relays.
|
||||||
|
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::sync::Arc;
|
|
||||||
|
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
use tokio::sync::mpsc;
|
use tokio::sync::mpsc;
|
||||||
|
|||||||
@@ -142,9 +142,6 @@ pub struct FederationManager {
|
|||||||
peer_links: Arc<Mutex<HashMap<String, PeerLink>>>,
|
peer_links: Arc<Mutex<HashMap<String, PeerLink>>>,
|
||||||
/// Dedup filter for incoming federation datagrams.
|
/// Dedup filter for incoming federation datagrams.
|
||||||
dedup: Mutex<Deduplicator>,
|
dedup: Mutex<Deduplicator>,
|
||||||
/// Per-room seq counter for federation media delivered to local clients.
|
|
||||||
/// Ensures clients see monotonically increasing seq regardless of federation sender.
|
|
||||||
local_delivery_seq: std::sync::atomic::AtomicU16,
|
|
||||||
/// JSONL event log for protocol analysis.
|
/// JSONL event log for protocol analysis.
|
||||||
event_log: EventLogger,
|
event_log: EventLogger,
|
||||||
/// Per-room rate limiters for inbound federation media.
|
/// Per-room rate limiters for inbound federation media.
|
||||||
@@ -172,7 +169,6 @@ impl FederationManager {
|
|||||||
metrics,
|
metrics,
|
||||||
peer_links: Arc::new(Mutex::new(HashMap::new())),
|
peer_links: Arc::new(Mutex::new(HashMap::new())),
|
||||||
dedup: Mutex::new(Deduplicator::new(DEDUP_WINDOW_SIZE)),
|
dedup: Mutex::new(Deduplicator::new(DEDUP_WINDOW_SIZE)),
|
||||||
local_delivery_seq: std::sync::atomic::AtomicU16::new(0),
|
|
||||||
event_log,
|
event_log,
|
||||||
rate_limiters: Mutex::new(HashMap::new()),
|
rate_limiters: Mutex::new(HashMap::new()),
|
||||||
}
|
}
|
||||||
@@ -296,7 +292,12 @@ impl FederationManager {
|
|||||||
/// Forward locally-generated media to all connected peers.
|
/// Forward locally-generated media to all connected peers.
|
||||||
/// For locally-originated media, we send to ALL peers (they decide whether to deliver).
|
/// For locally-originated media, we send to ALL peers (they decide whether to deliver).
|
||||||
/// For forwarded media (multi-hop), handle_datagram filters by active_rooms.
|
/// For forwarded media (multi-hop), handle_datagram filters by active_rooms.
|
||||||
pub async fn forward_to_peers(&self, room_name: &str, room_hash: &[u8; 8], media_data: &Bytes) {
|
///
|
||||||
|
/// `_room_name` is kept in the signature for caller-site symmetry with
|
||||||
|
/// the other room-tagged helpers and for future per-room-name logging
|
||||||
|
/// or rate limiting; the body currently forwards on `room_hash` alone
|
||||||
|
/// because that's what the wire format carries.
|
||||||
|
pub async fn forward_to_peers(&self, _room_name: &str, room_hash: &[u8; 8], media_data: &Bytes) {
|
||||||
let links = self.peer_links.lock().await;
|
let links = self.peer_links.lock().await;
|
||||||
if links.is_empty() {
|
if links.is_empty() {
|
||||||
return;
|
return;
|
||||||
@@ -623,11 +624,20 @@ async fn run_federation_link(
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// RTT monitor: periodically sample QUIC RTT for this peer
|
// RTT monitor: periodically sample QUIC RTT for this peer and push it
|
||||||
|
// into the `wzp_federation_peer_rtt_ms` gauge. The gauge is registered
|
||||||
|
// in metrics.rs but previously never received any samples — the task
|
||||||
|
// computed rtt_ms and dropped it on the floor, leaving the Grafana
|
||||||
|
// panel blank. Fixed as part of the workspace warning sweep.
|
||||||
let rtt_task = async move {
|
let rtt_task = async move {
|
||||||
loop {
|
loop {
|
||||||
tokio::time::sleep(Duration::from_secs(5)).await;
|
tokio::time::sleep(Duration::from_secs(5)).await;
|
||||||
let rtt_ms = rtt_transport.connection().stats().path.rtt.as_millis() as f64;
|
let rtt_ms = rtt_transport.connection().stats().path.rtt.as_millis() as f64;
|
||||||
|
fm_rtt
|
||||||
|
.metrics
|
||||||
|
.federation_peer_rtt_ms
|
||||||
|
.with_label_values(&[&label_rtt])
|
||||||
|
.set(rtt_ms);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -94,9 +94,13 @@ pub async fn accept_handshake(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Select the best quality profile from those the caller supports.
|
/// Select the best quality profile from those the caller supports.
|
||||||
fn choose_profile(supported: &[QualityProfile]) -> QualityProfile {
|
///
|
||||||
// Cap at GOOD (24k) for now — studio tiers (32k/48k/64k) not yet tested
|
/// The `_supported` list is currently ignored — we hardcode GOOD (24k) until
|
||||||
// for federation reliability (large packets may exceed path MTU).
|
/// studio tiers (32k/48k/64k) have been validated across federation (large
|
||||||
|
/// packets may exceed path MTU and fragment in unpleasant ways). Once that's
|
||||||
|
/// tested, the body should pick the highest supported profile ≤ the relay's
|
||||||
|
/// configured ceiling.
|
||||||
|
fn choose_profile(_supported: &[QualityProfile]) -> QualityProfile {
|
||||||
QualityProfile::GOOD
|
QualityProfile::GOOD
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ use std::sync::Arc;
|
|||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
|
|
||||||
use tokio::sync::Mutex;
|
use tokio::sync::Mutex;
|
||||||
use tracing::{error, info, warn};
|
use tracing::{debug, error, info, warn};
|
||||||
|
|
||||||
use wzp_proto::{MediaTransport, SignalMessage};
|
use wzp_proto::{MediaTransport, SignalMessage};
|
||||||
use wzp_relay::config::RelayConfig;
|
use wzp_relay::config::RelayConfig;
|
||||||
@@ -272,7 +272,7 @@ const BUILD_GIT_HASH: &str = env!("WZP_BUILD_HASH");
|
|||||||
|
|
||||||
#[tokio::main]
|
#[tokio::main]
|
||||||
async fn main() -> anyhow::Result<()> {
|
async fn main() -> anyhow::Result<()> {
|
||||||
let CliResult { mut config, identity_path, config_file, config_needs_create } = parse_args();
|
let CliResult { config, identity_path, config_file, config_needs_create } = parse_args();
|
||||||
tracing_subscriber::fmt().init();
|
tracing_subscriber::fmt().init();
|
||||||
info!(version = BUILD_GIT_HASH, "wzp-relay build");
|
info!(version = BUILD_GIT_HASH, "wzp-relay build");
|
||||||
rustls::crypto::ring::default_provider()
|
rustls::crypto::ring::default_provider()
|
||||||
@@ -378,6 +378,31 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
}
|
}
|
||||||
let endpoint = wzp_transport::create_endpoint(config.listen_addr, Some(server_config))?;
|
let endpoint = wzp_transport::create_endpoint(config.listen_addr, Some(server_config))?;
|
||||||
|
|
||||||
|
// Compute the IP address we should advertise in CallSetup for direct
|
||||||
|
// calls. If the relay is bound to a specific IP, use it as-is; if bound
|
||||||
|
// to 0.0.0.0, use the trick of "connect" a UDP socket to an arbitrary
|
||||||
|
// external address and read its local_addr — the OS binds to whichever
|
||||||
|
// local interface IP would route packets to that destination, which is
|
||||||
|
// the primary outbound interface. This is the same IP clients on the
|
||||||
|
// LAN use to reach us.
|
||||||
|
let advertised_ip: std::net::IpAddr = {
|
||||||
|
let listen_ip = config.listen_addr.ip();
|
||||||
|
if !listen_ip.is_unspecified() {
|
||||||
|
listen_ip
|
||||||
|
} else {
|
||||||
|
// Probe via a dummy "connected" UDP socket. Never actually sends.
|
||||||
|
match std::net::UdpSocket::bind("0.0.0.0:0")
|
||||||
|
.and_then(|s| { s.connect("8.8.8.8:80").map(|_| s) })
|
||||||
|
.and_then(|s| s.local_addr())
|
||||||
|
{
|
||||||
|
Ok(a) if !a.ip().is_loopback() => a.ip(),
|
||||||
|
_ => std::net::IpAddr::from([127u8, 0, 0, 1]),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let advertised_addr_str = format!("{}:{}", advertised_ip, config.listen_addr.port());
|
||||||
|
info!(%advertised_addr_str, "relay advertised address for CallSetup");
|
||||||
|
|
||||||
// Forward mode
|
// Forward mode
|
||||||
let remote_transport: Option<Arc<wzp_transport::QuinnTransport>> =
|
let remote_transport: Option<Arc<wzp_transport::QuinnTransport>> =
|
||||||
if let Some(remote_addr) = config.remote_relay {
|
if let Some(remote_addr) = config.remote_relay {
|
||||||
@@ -475,9 +500,19 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
info!("Listening for connections...");
|
info!("Listening for connections...");
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
let connection = match wzp_transport::accept(&endpoint).await {
|
// Pull the next Incoming off the queue. Deliberately do NOT await
|
||||||
Ok(conn) => conn,
|
// the QUIC handshake here — move that into the per-connection
|
||||||
Err(e) => { error!("accept: {e}"); continue; }
|
// spawned task below. Previously we used wzp_transport::accept
|
||||||
|
// which did both, which meant a single slow handshake would block
|
||||||
|
// the entire accept loop and prevent ALL subsequent connections
|
||||||
|
// from being processed. Surfaced as direct-call hangs where the
|
||||||
|
// callee's call-* connection never completes its QUIC handshake.
|
||||||
|
let incoming = match endpoint.accept().await {
|
||||||
|
Some(inc) => inc,
|
||||||
|
None => {
|
||||||
|
error!("endpoint.accept() returned None — endpoint closed");
|
||||||
|
break;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
let remote_transport = remote_transport.clone();
|
let remote_transport = remote_transport.clone();
|
||||||
@@ -493,9 +528,22 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
let federation_mgr = federation_mgr.clone();
|
let federation_mgr = federation_mgr.clone();
|
||||||
let signal_hub = signal_hub.clone();
|
let signal_hub = signal_hub.clone();
|
||||||
let call_registry = call_registry.clone();
|
let call_registry = call_registry.clone();
|
||||||
let listen_addr_str = config.listen_addr.to_string();
|
let advertised_addr_str = advertised_addr_str.clone();
|
||||||
|
|
||||||
|
let incoming_addr = incoming.remote_address();
|
||||||
|
info!(%incoming_addr, "accept queue: new Incoming, spawning handshake task");
|
||||||
|
|
||||||
tokio::spawn(async move {
|
tokio::spawn(async move {
|
||||||
|
// Drive the QUIC handshake inside the spawned task so that
|
||||||
|
// slow or hung handshakes never block the outer accept loop.
|
||||||
|
let connection = match incoming.await {
|
||||||
|
Ok(c) => c,
|
||||||
|
Err(e) => {
|
||||||
|
error!(%incoming_addr, "QUIC handshake failed: {e}");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
info!(%incoming_addr, "QUIC handshake complete");
|
||||||
let addr = connection.remote_address();
|
let addr = connection.remote_address();
|
||||||
|
|
||||||
let room_name = connection
|
let room_name = connection
|
||||||
@@ -718,7 +766,7 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
match transport.recv_signal().await {
|
match transport.recv_signal().await {
|
||||||
Ok(Some(msg)) => {
|
Ok(Some(msg)) => {
|
||||||
match msg {
|
match msg {
|
||||||
SignalMessage::DirectCallOffer { ref target_fingerprint, ref call_id, ref caller_alias, .. } => {
|
SignalMessage::DirectCallOffer { ref target_fingerprint, ref call_id, .. } => {
|
||||||
let target_fp = target_fingerprint.clone();
|
let target_fp = target_fingerprint.clone();
|
||||||
let call_id = call_id.clone();
|
let call_id = call_id.clone();
|
||||||
|
|
||||||
@@ -793,22 +841,18 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
let _ = hub.send_to(&peer_fp, &msg).await;
|
let _ = hub.send_to(&peer_fp, &msg).await;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Send CallSetup to both parties
|
// Send CallSetup to both parties.
|
||||||
// Use the address the client connected to (their remote addr
|
//
|
||||||
// is our perspective, but we need our listen addr).
|
// BUG FIX: the previous version of this used `addr.ip()`
|
||||||
// Replace 0.0.0.0 with the client's destination IP.
|
// which is `connection.remote_address()` — the CLIENT'S
|
||||||
let relay_addr_for_setup = if listen_addr_str.starts_with("0.0.0.0:") {
|
// IP, not the relay's. So CallSetup told both parties to
|
||||||
let port = &listen_addr_str[8..];
|
// dial the answerer's own IP, which meant the caller was
|
||||||
// Use the local IP from the client's connection
|
// sending QUIC Initials into the callee's client (no
|
||||||
let local_ip = addr.ip();
|
// server listening there) and the callee was sending to
|
||||||
if local_ip.is_loopback() {
|
// itself. In both cases endpoint.connect() hung forever.
|
||||||
format!("127.0.0.1:{port}")
|
//
|
||||||
} else {
|
// Use the relay's precomputed advertised address instead.
|
||||||
format!("{local_ip}:{port}")
|
let relay_addr_for_setup = advertised_addr_str.clone();
|
||||||
}
|
|
||||||
} else {
|
|
||||||
listen_addr_str.clone()
|
|
||||||
};
|
|
||||||
let setup = SignalMessage::CallSetup {
|
let setup = SignalMessage::CallSetup {
|
||||||
call_id: call_id.clone(),
|
call_id: call_id.clone(),
|
||||||
room: room.clone(),
|
room: room.clone(),
|
||||||
@@ -848,6 +892,31 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
let _ = transport.send_signal(&SignalMessage::Pong { timestamp_ms }).await;
|
let _ = transport.send_signal(&SignalMessage::Pong { timestamp_ms }).await;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// QUIC-native NAT reflection ("STUN for QUIC").
|
||||||
|
// The client asks "what source address do you
|
||||||
|
// see for me?" and we reply with whatever
|
||||||
|
// quinn reports as this connection's remote
|
||||||
|
// address — i.e. the post-NAT public address
|
||||||
|
// as observed from the server side of the TLS
|
||||||
|
// session. Used by the P2P path to learn the
|
||||||
|
// client's server-reflexive address without
|
||||||
|
// running a separate STUN server. No auth or
|
||||||
|
// rate-limit in Phase 1 — the client is
|
||||||
|
// already TLS-authenticated by the time it
|
||||||
|
// reaches this match arm.
|
||||||
|
SignalMessage::Reflect => {
|
||||||
|
let observed_addr = addr.to_string();
|
||||||
|
if let Err(e) = transport.send_signal(
|
||||||
|
&SignalMessage::ReflectResponse {
|
||||||
|
observed_addr: observed_addr.clone(),
|
||||||
|
},
|
||||||
|
).await {
|
||||||
|
warn!(%addr, error = %e, "reflect: failed to send response");
|
||||||
|
} else {
|
||||||
|
debug!(%addr, %observed_addr, "reflect: responded");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
other => {
|
other => {
|
||||||
warn!(%addr, "signal: unexpected message: {:?}", std::mem::discriminant(&other));
|
warn!(%addr, "signal: unexpected message: {:?}", std::mem::discriminant(&other));
|
||||||
}
|
}
|
||||||
@@ -1153,4 +1222,5 @@ async fn main() -> anyhow::Result<()> {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -29,6 +29,9 @@ pub struct RelayMetrics {
|
|||||||
pub session_rtt_ms: GaugeVec,
|
pub session_rtt_ms: GaugeVec,
|
||||||
pub session_underruns: IntCounterVec,
|
pub session_underruns: IntCounterVec,
|
||||||
pub session_overruns: IntCounterVec,
|
pub session_overruns: IntCounterVec,
|
||||||
|
// Phase 4: loss-recovery breakdown per session.
|
||||||
|
pub session_dred_reconstructions: IntCounterVec,
|
||||||
|
pub session_classical_plc: IntCounterVec,
|
||||||
registry: Registry,
|
registry: Registry,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -130,6 +133,23 @@ impl RelayMetrics {
|
|||||||
)
|
)
|
||||||
.expect("metric");
|
.expect("metric");
|
||||||
|
|
||||||
|
let session_dred_reconstructions = IntCounterVec::new(
|
||||||
|
Opts::new(
|
||||||
|
"wzp_relay_session_dred_reconstructions_total",
|
||||||
|
"Frames reconstructed via DRED (Deep REDundancy) per session",
|
||||||
|
),
|
||||||
|
&["session_id"],
|
||||||
|
)
|
||||||
|
.expect("metric");
|
||||||
|
let session_classical_plc = IntCounterVec::new(
|
||||||
|
Opts::new(
|
||||||
|
"wzp_relay_session_classical_plc_total",
|
||||||
|
"Frames filled via classical Opus/Codec2 PLC per session",
|
||||||
|
),
|
||||||
|
&["session_id"],
|
||||||
|
)
|
||||||
|
.expect("metric");
|
||||||
|
|
||||||
registry.register(Box::new(active_sessions.clone())).expect("register");
|
registry.register(Box::new(active_sessions.clone())).expect("register");
|
||||||
registry.register(Box::new(active_rooms.clone())).expect("register");
|
registry.register(Box::new(active_rooms.clone())).expect("register");
|
||||||
registry.register(Box::new(packets_forwarded.clone())).expect("register");
|
registry.register(Box::new(packets_forwarded.clone())).expect("register");
|
||||||
@@ -147,6 +167,8 @@ impl RelayMetrics {
|
|||||||
registry.register(Box::new(session_rtt_ms.clone())).expect("register");
|
registry.register(Box::new(session_rtt_ms.clone())).expect("register");
|
||||||
registry.register(Box::new(session_underruns.clone())).expect("register");
|
registry.register(Box::new(session_underruns.clone())).expect("register");
|
||||||
registry.register(Box::new(session_overruns.clone())).expect("register");
|
registry.register(Box::new(session_overruns.clone())).expect("register");
|
||||||
|
registry.register(Box::new(session_dred_reconstructions.clone())).expect("register");
|
||||||
|
registry.register(Box::new(session_classical_plc.clone())).expect("register");
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
active_sessions,
|
active_sessions,
|
||||||
@@ -166,6 +188,8 @@ impl RelayMetrics {
|
|||||||
session_rtt_ms,
|
session_rtt_ms,
|
||||||
session_underruns,
|
session_underruns,
|
||||||
session_overruns,
|
session_overruns,
|
||||||
|
session_dred_reconstructions,
|
||||||
|
session_classical_plc,
|
||||||
registry,
|
registry,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -217,6 +241,39 @@ impl RelayMetrics {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Phase 4: update per-session loss-recovery counters from a client's
|
||||||
|
/// `LossRecoveryUpdate` signal message. The client sends monotonic
|
||||||
|
/// totals (frames reconstructed since call start); we compute the
|
||||||
|
/// delta against the current Prometheus counter and increment by it.
|
||||||
|
/// IntCounterVec only increases, so a client restart that resets the
|
||||||
|
/// counter to 0 simply produces no delta until the new totals exceed
|
||||||
|
/// the Prometheus state.
|
||||||
|
pub fn update_session_loss_recovery(
|
||||||
|
&self,
|
||||||
|
session_id: &str,
|
||||||
|
dred_reconstructions: u64,
|
||||||
|
classical_plc: u64,
|
||||||
|
) {
|
||||||
|
let cur_dred = self
|
||||||
|
.session_dred_reconstructions
|
||||||
|
.with_label_values(&[session_id])
|
||||||
|
.get();
|
||||||
|
if dred_reconstructions > cur_dred {
|
||||||
|
self.session_dred_reconstructions
|
||||||
|
.with_label_values(&[session_id])
|
||||||
|
.inc_by(dred_reconstructions - cur_dred);
|
||||||
|
}
|
||||||
|
let cur_plc = self
|
||||||
|
.session_classical_plc
|
||||||
|
.with_label_values(&[session_id])
|
||||||
|
.get();
|
||||||
|
if classical_plc > cur_plc {
|
||||||
|
self.session_classical_plc
|
||||||
|
.with_label_values(&[session_id])
|
||||||
|
.inc_by(classical_plc - cur_plc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Remove all per-session label values for a disconnected session.
|
/// Remove all per-session label values for a disconnected session.
|
||||||
pub fn remove_session_metrics(&self, session_id: &str) {
|
pub fn remove_session_metrics(&self, session_id: &str) {
|
||||||
let _ = self.session_buffer_depth.remove_label_values(&[session_id]);
|
let _ = self.session_buffer_depth.remove_label_values(&[session_id]);
|
||||||
@@ -224,6 +281,10 @@ impl RelayMetrics {
|
|||||||
let _ = self.session_rtt_ms.remove_label_values(&[session_id]);
|
let _ = self.session_rtt_ms.remove_label_values(&[session_id]);
|
||||||
let _ = self.session_underruns.remove_label_values(&[session_id]);
|
let _ = self.session_underruns.remove_label_values(&[session_id]);
|
||||||
let _ = self.session_overruns.remove_label_values(&[session_id]);
|
let _ = self.session_overruns.remove_label_values(&[session_id]);
|
||||||
|
let _ = self
|
||||||
|
.session_dred_reconstructions
|
||||||
|
.remove_label_values(&[session_id]);
|
||||||
|
let _ = self.session_classical_plc.remove_label_values(&[session_id]);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get a reference to the underlying Prometheus registry.
|
/// Get a reference to the underlying Prometheus registry.
|
||||||
@@ -418,10 +479,13 @@ mod tests {
|
|||||||
};
|
};
|
||||||
m.update_session_quality("sess-cleanup", &report);
|
m.update_session_quality("sess-cleanup", &report);
|
||||||
m.update_session_buffer("sess-cleanup", 42, 3, 1);
|
m.update_session_buffer("sess-cleanup", 42, 3, 1);
|
||||||
|
m.update_session_loss_recovery("sess-cleanup", 17, 4);
|
||||||
|
|
||||||
// Verify they appear
|
// Verify they appear
|
||||||
let output = m.metrics_handler();
|
let output = m.metrics_handler();
|
||||||
assert!(output.contains("sess-cleanup"));
|
assert!(output.contains("sess-cleanup"));
|
||||||
|
assert!(output.contains("wzp_relay_session_dred_reconstructions_total"));
|
||||||
|
assert!(output.contains("wzp_relay_session_classical_plc_total"));
|
||||||
|
|
||||||
// Remove and verify they are gone
|
// Remove and verify they are gone
|
||||||
m.remove_session_metrics("sess-cleanup");
|
m.remove_session_metrics("sess-cleanup");
|
||||||
@@ -429,6 +493,55 @@ mod tests {
|
|||||||
assert!(!output.contains("sess-cleanup"));
|
assert!(!output.contains("sess-cleanup"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Phase 4: LossRecoveryUpdate → per-session counters, monotonic delta
|
||||||
|
/// application.
|
||||||
|
#[test]
|
||||||
|
fn session_loss_recovery_monotonic_delta() {
|
||||||
|
let m = RelayMetrics::new();
|
||||||
|
let sess = "sess-dred";
|
||||||
|
|
||||||
|
// First update: 10 DRED, 2 PLC
|
||||||
|
m.update_session_loss_recovery(sess, 10, 2);
|
||||||
|
let dred1 = m
|
||||||
|
.session_dred_reconstructions
|
||||||
|
.with_label_values(&[sess])
|
||||||
|
.get();
|
||||||
|
let plc1 = m.session_classical_plc.with_label_values(&[sess]).get();
|
||||||
|
assert_eq!(dred1, 10);
|
||||||
|
assert_eq!(plc1, 2);
|
||||||
|
|
||||||
|
// Second update: 25 DRED, 5 PLC — counter advances by (15, 3)
|
||||||
|
m.update_session_loss_recovery(sess, 25, 5);
|
||||||
|
let dred2 = m
|
||||||
|
.session_dred_reconstructions
|
||||||
|
.with_label_values(&[sess])
|
||||||
|
.get();
|
||||||
|
let plc2 = m.session_classical_plc.with_label_values(&[sess]).get();
|
||||||
|
assert_eq!(dred2, 25);
|
||||||
|
assert_eq!(plc2, 5);
|
||||||
|
|
||||||
|
// Third update with LOWER values (e.g., client reset) — counters
|
||||||
|
// hold steady, no decrement.
|
||||||
|
m.update_session_loss_recovery(sess, 5, 1);
|
||||||
|
let dred3 = m
|
||||||
|
.session_dred_reconstructions
|
||||||
|
.with_label_values(&[sess])
|
||||||
|
.get();
|
||||||
|
let plc3 = m.session_classical_plc.with_label_values(&[sess]).get();
|
||||||
|
assert_eq!(dred3, 25, "counter must not decrease");
|
||||||
|
assert_eq!(plc3, 5, "counter must not decrease");
|
||||||
|
|
||||||
|
// Fourth update: client caught up and exceeded the old max.
|
||||||
|
m.update_session_loss_recovery(sess, 30, 8);
|
||||||
|
let dred4 = m
|
||||||
|
.session_dred_reconstructions
|
||||||
|
.with_label_values(&[sess])
|
||||||
|
.get();
|
||||||
|
let plc4 = m.session_classical_plc.with_label_values(&[sess]).get();
|
||||||
|
assert_eq!(dred4, 30);
|
||||||
|
assert_eq!(plc4, 8);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn metrics_increment() {
|
fn metrics_increment() {
|
||||||
let m = RelayMetrics::new();
|
let m = RelayMetrics::new();
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ use std::time::Duration;
|
|||||||
|
|
||||||
use bytes::Bytes;
|
use bytes::Bytes;
|
||||||
use tokio::sync::Mutex;
|
use tokio::sync::Mutex;
|
||||||
use tracing::{debug, error, info, trace, warn};
|
use tracing::{error, info, warn};
|
||||||
|
|
||||||
use wzp_proto::packet::TrunkFrame;
|
use wzp_proto::packet::TrunkFrame;
|
||||||
use wzp_proto::MediaTransport;
|
use wzp_proto::MediaTransport;
|
||||||
@@ -483,7 +483,6 @@ async fn run_participant_plain(
|
|||||||
);
|
);
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
let recv_start = std::time::Instant::now();
|
|
||||||
let pkt = match transport.recv_media().await {
|
let pkt = match transport.recv_media().await {
|
||||||
Ok(Some(pkt)) => pkt,
|
Ok(Some(pkt)) => pkt,
|
||||||
Ok(None) => {
|
Ok(None) => {
|
||||||
@@ -838,7 +837,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn room_join_leave() {
|
fn room_join_leave() {
|
||||||
let mut mgr = RoomManager::new();
|
let mgr = RoomManager::new();
|
||||||
assert_eq!(mgr.room_size("test"), 0);
|
assert_eq!(mgr.room_size("test"), 0);
|
||||||
assert!(mgr.list().is_empty());
|
assert!(mgr.list().is_empty());
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ use std::collections::HashMap;
|
|||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
use std::time::Instant;
|
use std::time::Instant;
|
||||||
|
|
||||||
use tracing::{info, warn};
|
use tracing::info;
|
||||||
use wzp_proto::{MediaTransport, SignalMessage};
|
use wzp_proto::{MediaTransport, SignalMessage};
|
||||||
use wzp_transport::QuinnTransport;
|
use wzp_transport::QuinnTransport;
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn register_unregister() {
|
fn register_unregister() {
|
||||||
let mut hub = SignalHub::new();
|
let hub = SignalHub::new();
|
||||||
assert_eq!(hub.online_count(), 0);
|
assert_eq!(hub.online_count(), 0);
|
||||||
assert!(!hub.is_online("alice"));
|
assert!(!hub.is_online("alice"));
|
||||||
|
|
||||||
|
|||||||
@@ -63,11 +63,11 @@ async fn handshake_succeeds() {
|
|||||||
accept_handshake(server_t.as_ref(), &callee_seed).await
|
accept_handshake(server_t.as_ref(), &callee_seed).await
|
||||||
});
|
});
|
||||||
|
|
||||||
let caller_session = perform_handshake(client_transport.as_ref(), &caller_seed)
|
let caller_session = perform_handshake(client_transport.as_ref(), &caller_seed, None)
|
||||||
.await
|
.await
|
||||||
.expect("perform_handshake should succeed");
|
.expect("perform_handshake should succeed");
|
||||||
|
|
||||||
let (callee_session, chosen_profile) = callee_handle
|
let (callee_session, chosen_profile, _caller_fp, _caller_alias) = callee_handle
|
||||||
.await
|
.await
|
||||||
.expect("join callee task")
|
.expect("join callee task")
|
||||||
.expect("accept_handshake should succeed");
|
.expect("accept_handshake should succeed");
|
||||||
@@ -124,11 +124,11 @@ async fn handshake_verifies_identity() {
|
|||||||
accept_handshake(server_t.as_ref(), &callee_seed).await
|
accept_handshake(server_t.as_ref(), &callee_seed).await
|
||||||
});
|
});
|
||||||
|
|
||||||
let caller_session = perform_handshake(client_transport.as_ref(), &caller_seed)
|
let caller_session = perform_handshake(client_transport.as_ref(), &caller_seed, None)
|
||||||
.await
|
.await
|
||||||
.expect("handshake must succeed even with different identities");
|
.expect("handshake must succeed even with different identities");
|
||||||
|
|
||||||
let (callee_session, _profile) = callee_handle
|
let (callee_session, _profile, _caller_fp, _caller_alias) = callee_handle
|
||||||
.await
|
.await
|
||||||
.expect("join")
|
.expect("join")
|
||||||
.expect("accept_handshake must succeed");
|
.expect("accept_handshake must succeed");
|
||||||
@@ -183,7 +183,7 @@ async fn auth_then_handshake() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
// 2. Run the cryptographic handshake
|
// 2. Run the cryptographic handshake
|
||||||
let (session, profile) = accept_handshake(server_t.as_ref(), &callee_seed)
|
let (session, profile, _caller_fp, _caller_alias) = accept_handshake(server_t.as_ref(), &callee_seed)
|
||||||
.await
|
.await
|
||||||
.expect("accept_handshake after auth");
|
.expect("accept_handshake after auth");
|
||||||
|
|
||||||
@@ -199,7 +199,7 @@ async fn auth_then_handshake() {
|
|||||||
.await
|
.await
|
||||||
.expect("send AuthToken");
|
.expect("send AuthToken");
|
||||||
|
|
||||||
let caller_session = perform_handshake(client_transport.as_ref(), &caller_seed)
|
let caller_session = perform_handshake(client_transport.as_ref(), &caller_seed, None)
|
||||||
.await
|
.await
|
||||||
.expect("perform_handshake after auth");
|
.expect("perform_handshake after auth");
|
||||||
|
|
||||||
@@ -270,6 +270,7 @@ async fn handshake_rejects_bad_signature() {
|
|||||||
ephemeral_pub,
|
ephemeral_pub,
|
||||||
signature,
|
signature,
|
||||||
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
||||||
|
alias: None,
|
||||||
};
|
};
|
||||||
|
|
||||||
client_transport
|
client_transport
|
||||||
|
|||||||
318
crates/wzp-relay/tests/reflect.rs
Normal file
318
crates/wzp-relay/tests/reflect.rs
Normal file
@@ -0,0 +1,318 @@
|
|||||||
|
//! Integration tests for the "STUN for QUIC" reflect protocol
|
||||||
|
//! (PRD: .taskmaster/docs/prd_reflect_over_quic.txt, Phase 1).
|
||||||
|
//!
|
||||||
|
//! We don't spin up the full relay binary — instead we exercise the
|
||||||
|
//! same wire-level request/response dance with a mock relay loop
|
||||||
|
//! that implements exactly the match arm added to
|
||||||
|
//! `wzp-relay/src/main.rs`. This isolates the protocol test from the
|
||||||
|
//! rest of the relay state (rooms, federation, call registry, ...).
|
||||||
|
//!
|
||||||
|
//! Three test cases:
|
||||||
|
//! 1. `reflect_happy_path` — client sends `Reflect`, mock relay
|
||||||
|
//! replies with `ReflectResponse { observed_addr }`, client
|
||||||
|
//! parses it back to a `SocketAddr` and confirms the IP is
|
||||||
|
//! `127.0.0.1` and the port matches its own bound port.
|
||||||
|
//! 2. `reflect_two_clients_distinct_ports` — two simultaneous
|
||||||
|
//! client connections on different ephemeral ports get back
|
||||||
|
//! different reflected ports, proving the relay uses
|
||||||
|
//! per-connection `remote_address` rather than a global.
|
||||||
|
//! 3. `reflect_old_relay_times_out` — mock relay that *doesn't*
|
||||||
|
//! handle `Reflect`; client side times out in the expected
|
||||||
|
//! window and does not hang.
|
||||||
|
//!
|
||||||
|
//! The third test uses a `tokio::time::timeout` wrapper directly
|
||||||
|
//! (the client-side `request_reflect` helper lives in
|
||||||
|
//! `desktop/src-tauri/src/lib.rs` which isn't a library we can
|
||||||
|
//! depend on from here, so we reproduce the timeout semantics
|
||||||
|
//! inline).
|
||||||
|
|
||||||
|
use std::net::{Ipv4Addr, SocketAddr};
|
||||||
|
use std::sync::Arc;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use wzp_proto::{MediaTransport, SignalMessage};
|
||||||
|
use wzp_transport::{client_config, create_endpoint, server_config, QuinnTransport};
|
||||||
|
|
||||||
|
/// Spawn a minimal mock relay that loops over `recv_signal`,
|
||||||
|
/// matches on `Reflect`, and responds with `ReflectResponse` using
|
||||||
|
/// the remote_address observed for this connection. Mirrors the
|
||||||
|
/// match arm in `crates/wzp-relay/src/main.rs`.
|
||||||
|
async fn spawn_mock_relay_with_reflect(
|
||||||
|
server_transport: Arc<QuinnTransport>,
|
||||||
|
) -> tokio::task::JoinHandle<()> {
|
||||||
|
tokio::spawn(async move {
|
||||||
|
// Observed remote address at the time the connection was
|
||||||
|
// accepted. Stable for the life of the connection under quinn's
|
||||||
|
// normal operation. This is exactly what the real relay does.
|
||||||
|
let observed = server_transport.connection().remote_address();
|
||||||
|
loop {
|
||||||
|
match server_transport.recv_signal().await {
|
||||||
|
Ok(Some(SignalMessage::Reflect)) => {
|
||||||
|
let resp = SignalMessage::ReflectResponse {
|
||||||
|
observed_addr: observed.to_string(),
|
||||||
|
};
|
||||||
|
// If the send fails the client has gone; just exit.
|
||||||
|
if server_transport.send_signal(&resp).await.is_err() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(Some(_other)) => {
|
||||||
|
// Ignore anything else — not relevant to this test.
|
||||||
|
}
|
||||||
|
Ok(None) => break,
|
||||||
|
Err(_e) => break,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Spawn a mock relay that intentionally DOES NOT handle Reflect.
|
||||||
|
/// Models a pre-Phase-1 relay — it keeps reading signal messages and
|
||||||
|
/// logs them to stderr, but never produces a `ReflectResponse`.
|
||||||
|
async fn spawn_mock_relay_without_reflect(
|
||||||
|
server_transport: Arc<QuinnTransport>,
|
||||||
|
) -> tokio::task::JoinHandle<()> {
|
||||||
|
tokio::spawn(async move {
|
||||||
|
loop {
|
||||||
|
match server_transport.recv_signal().await {
|
||||||
|
Ok(Some(_msg)) => {
|
||||||
|
// Deliberately do nothing. Old relay.
|
||||||
|
}
|
||||||
|
Ok(None) => break,
|
||||||
|
Err(_) => break,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Build an in-process QUIC client/server pair on loopback and
|
||||||
|
/// return (client_transport, server_transport, endpoints). The
|
||||||
|
/// endpoints tuple must be kept alive for the test duration.
|
||||||
|
///
|
||||||
|
/// `client_port_hint` of 0 means "let OS pick". Pass an explicit
|
||||||
|
/// port to pin the client's source port (useful for the
|
||||||
|
/// distinct-ports test).
|
||||||
|
async fn connected_pair_with_port(
|
||||||
|
_client_port_hint: u16,
|
||||||
|
) -> (Arc<QuinnTransport>, Arc<QuinnTransport>, (quinn::Endpoint, quinn::Endpoint)) {
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
|
||||||
|
let (sc, _cert_der) = server_config();
|
||||||
|
let server_addr: SocketAddr = (Ipv4Addr::LOCALHOST, 0).into();
|
||||||
|
let server_ep = create_endpoint(server_addr, Some(sc)).expect("server endpoint");
|
||||||
|
let server_listen = server_ep.local_addr().expect("server local addr");
|
||||||
|
|
||||||
|
// Always bind the client to an ephemeral port — we'll read back
|
||||||
|
// the actual assigned port via `local_addr()` in the assertions.
|
||||||
|
let client_bind: SocketAddr = (Ipv4Addr::LOCALHOST, 0).into();
|
||||||
|
let client_ep = create_endpoint(client_bind, None).expect("client endpoint");
|
||||||
|
|
||||||
|
let server_ep_clone = server_ep.clone();
|
||||||
|
let accept_fut = tokio::spawn(async move {
|
||||||
|
let conn = wzp_transport::accept(&server_ep_clone).await.expect("accept");
|
||||||
|
Arc::new(QuinnTransport::new(conn))
|
||||||
|
});
|
||||||
|
|
||||||
|
let client_conn =
|
||||||
|
wzp_transport::connect(&client_ep, server_listen, "localhost", client_config())
|
||||||
|
.await
|
||||||
|
.expect("connect");
|
||||||
|
let client_transport = Arc::new(QuinnTransport::new(client_conn));
|
||||||
|
let server_transport = accept_fut.await.expect("join accept task");
|
||||||
|
|
||||||
|
(client_transport, server_transport, (server_ep, client_ep))
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
// Test 1: happy path — client learns its own port via Reflect
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||||
|
async fn reflect_happy_path() {
|
||||||
|
let (client_transport, server_transport, (_server_ep, client_ep)) =
|
||||||
|
connected_pair_with_port(0).await;
|
||||||
|
|
||||||
|
// Grab the client's actual bound port so we can cross-check
|
||||||
|
// against the reflected response.
|
||||||
|
let client_port = client_ep
|
||||||
|
.local_addr()
|
||||||
|
.expect("client local addr")
|
||||||
|
.port();
|
||||||
|
assert_ne!(client_port, 0, "client must have a real bound port");
|
||||||
|
|
||||||
|
// Start the mock relay's reflect handler.
|
||||||
|
let _relay_handle = spawn_mock_relay_with_reflect(Arc::clone(&server_transport)).await;
|
||||||
|
|
||||||
|
// Client sends Reflect and awaits the response. The real
|
||||||
|
// request_reflect helper in desktop/src-tauri/src/lib.rs uses a
|
||||||
|
// oneshot channel driven off the spawned recv loop; here we just
|
||||||
|
// do it inline because there's no spawned loop yet in this test
|
||||||
|
// — this isolates the wire protocol from the client-side state
|
||||||
|
// machine.
|
||||||
|
client_transport
|
||||||
|
.send_signal(&SignalMessage::Reflect)
|
||||||
|
.await
|
||||||
|
.expect("send Reflect");
|
||||||
|
|
||||||
|
let resp = tokio::time::timeout(Duration::from_secs(2), client_transport.recv_signal())
|
||||||
|
.await
|
||||||
|
.expect("reflect response should arrive within 2s")
|
||||||
|
.expect("recv_signal ok")
|
||||||
|
.expect("some message");
|
||||||
|
|
||||||
|
let observed_addr = match resp {
|
||||||
|
SignalMessage::ReflectResponse { observed_addr } => observed_addr,
|
||||||
|
other => panic!("expected ReflectResponse, got {:?}", std::mem::discriminant(&other)),
|
||||||
|
};
|
||||||
|
|
||||||
|
let parsed: SocketAddr = observed_addr
|
||||||
|
.parse()
|
||||||
|
.expect("ReflectResponse.observed_addr must parse as SocketAddr");
|
||||||
|
|
||||||
|
// The relay should see the client on 127.0.0.1 (loopback in the
|
||||||
|
// test harness) and on the client's bound ephemeral port.
|
||||||
|
assert_eq!(parsed.ip().to_string(), "127.0.0.1");
|
||||||
|
assert_eq!(
|
||||||
|
parsed.port(),
|
||||||
|
client_port,
|
||||||
|
"reflected port must match the client's local_addr port"
|
||||||
|
);
|
||||||
|
|
||||||
|
drop(client_transport);
|
||||||
|
drop(server_transport);
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
// Test 2: two clients get DIFFERENT reflected ports
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||||
|
async fn reflect_two_clients_distinct_ports() {
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
|
||||||
|
// Shared server: one endpoint, two incoming accepts.
|
||||||
|
let (sc, _cert_der) = server_config();
|
||||||
|
let server_addr: SocketAddr = (Ipv4Addr::LOCALHOST, 0).into();
|
||||||
|
let server_ep = create_endpoint(server_addr, Some(sc)).expect("server endpoint");
|
||||||
|
let server_listen = server_ep.local_addr().expect("server local addr");
|
||||||
|
|
||||||
|
// Accept two clients in parallel.
|
||||||
|
let server_ep_a = server_ep.clone();
|
||||||
|
let accept_a = tokio::spawn(async move {
|
||||||
|
let conn = wzp_transport::accept(&server_ep_a).await.expect("accept A");
|
||||||
|
Arc::new(QuinnTransport::new(conn))
|
||||||
|
});
|
||||||
|
let server_ep_b = server_ep.clone();
|
||||||
|
let accept_b = tokio::spawn(async move {
|
||||||
|
let conn = wzp_transport::accept(&server_ep_b).await.expect("accept B");
|
||||||
|
Arc::new(QuinnTransport::new(conn))
|
||||||
|
});
|
||||||
|
|
||||||
|
// Client A
|
||||||
|
let client_ep_a = create_endpoint((Ipv4Addr::LOCALHOST, 0).into(), None).expect("ep A");
|
||||||
|
let conn_a =
|
||||||
|
wzp_transport::connect(&client_ep_a, server_listen, "localhost", client_config())
|
||||||
|
.await
|
||||||
|
.expect("connect A");
|
||||||
|
let client_a = Arc::new(QuinnTransport::new(conn_a));
|
||||||
|
let port_a = client_ep_a.local_addr().unwrap().port();
|
||||||
|
|
||||||
|
// Client B
|
||||||
|
let client_ep_b = create_endpoint((Ipv4Addr::LOCALHOST, 0).into(), None).expect("ep B");
|
||||||
|
let conn_b =
|
||||||
|
wzp_transport::connect(&client_ep_b, server_listen, "localhost", client_config())
|
||||||
|
.await
|
||||||
|
.expect("connect B");
|
||||||
|
let client_b = Arc::new(QuinnTransport::new(conn_b));
|
||||||
|
let port_b = client_ep_b.local_addr().unwrap().port();
|
||||||
|
|
||||||
|
assert_ne!(
|
||||||
|
port_a, port_b,
|
||||||
|
"preconditions: OS must assign two clients different ephemeral ports"
|
||||||
|
);
|
||||||
|
|
||||||
|
let server_a = accept_a.await.expect("join A");
|
||||||
|
let server_b = accept_b.await.expect("join B");
|
||||||
|
|
||||||
|
// Spawn a reflect handler for each server-side transport.
|
||||||
|
let _relay_a = spawn_mock_relay_with_reflect(Arc::clone(&server_a)).await;
|
||||||
|
let _relay_b = spawn_mock_relay_with_reflect(Arc::clone(&server_b)).await;
|
||||||
|
|
||||||
|
// Each client requests reflect concurrently.
|
||||||
|
let reflect_for = |t: Arc<QuinnTransport>| async move {
|
||||||
|
t.send_signal(&SignalMessage::Reflect).await.expect("send");
|
||||||
|
let resp = tokio::time::timeout(Duration::from_secs(2), t.recv_signal())
|
||||||
|
.await
|
||||||
|
.expect("timeout")
|
||||||
|
.expect("ok")
|
||||||
|
.expect("some");
|
||||||
|
match resp {
|
||||||
|
SignalMessage::ReflectResponse { observed_addr } => observed_addr,
|
||||||
|
_ => panic!("wrong variant"),
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let (addr_a, addr_b) = tokio::join!(reflect_for(client_a.clone()), reflect_for(client_b.clone()));
|
||||||
|
|
||||||
|
let parsed_a: SocketAddr = addr_a.parse().unwrap();
|
||||||
|
let parsed_b: SocketAddr = addr_b.parse().unwrap();
|
||||||
|
|
||||||
|
assert_eq!(parsed_a.port(), port_a, "client A's reflected port");
|
||||||
|
assert_eq!(parsed_b.port(), port_b, "client B's reflected port");
|
||||||
|
assert_ne!(
|
||||||
|
parsed_a.port(),
|
||||||
|
parsed_b.port(),
|
||||||
|
"each client must see its own port, not a shared one"
|
||||||
|
);
|
||||||
|
|
||||||
|
drop(client_a);
|
||||||
|
drop(client_b);
|
||||||
|
drop(server_a);
|
||||||
|
drop(server_b);
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
// Test 3: old relay never answers — client times out cleanly
|
||||||
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||||
|
async fn reflect_old_relay_times_out() {
|
||||||
|
let (client_transport, server_transport, _endpoints) =
|
||||||
|
connected_pair_with_port(0).await;
|
||||||
|
|
||||||
|
// Mock relay that ignores Reflect — simulates a pre-Phase-1 build.
|
||||||
|
let _relay_handle =
|
||||||
|
spawn_mock_relay_without_reflect(Arc::clone(&server_transport)).await;
|
||||||
|
|
||||||
|
client_transport
|
||||||
|
.send_signal(&SignalMessage::Reflect)
|
||||||
|
.await
|
||||||
|
.expect("send Reflect");
|
||||||
|
|
||||||
|
// 1100ms ceiling matches the 1s timeout baked into
|
||||||
|
// get_reflected_address plus a tiny bit of slack. If this
|
||||||
|
// regression ever fires it probably means recv_signal blocked
|
||||||
|
// longer than expected and the Tauri command would hang the UI.
|
||||||
|
let start = std::time::Instant::now();
|
||||||
|
let result =
|
||||||
|
tokio::time::timeout(Duration::from_millis(1100), client_transport.recv_signal()).await;
|
||||||
|
let elapsed = start.elapsed();
|
||||||
|
|
||||||
|
assert!(
|
||||||
|
result.is_err(),
|
||||||
|
"recv_signal must time out when the relay ignores Reflect"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
elapsed >= Duration::from_millis(1000),
|
||||||
|
"timeout fired too early ({:?})",
|
||||||
|
elapsed
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
elapsed < Duration::from_millis(1200),
|
||||||
|
"timeout fired too late ({:?}), client would feel unresponsive",
|
||||||
|
elapsed
|
||||||
|
);
|
||||||
|
|
||||||
|
drop(client_transport);
|
||||||
|
drop(server_transport);
|
||||||
|
}
|
||||||
@@ -27,3 +27,8 @@ pub use connection::{accept, connect, create_endpoint};
|
|||||||
pub use path_monitor::PathMonitor;
|
pub use path_monitor::PathMonitor;
|
||||||
pub use quic::QuinnTransport;
|
pub use quic::QuinnTransport;
|
||||||
pub use wzp_proto::{MediaTransport, PathQuality, TransportError};
|
pub use wzp_proto::{MediaTransport, PathQuality, TransportError};
|
||||||
|
|
||||||
|
// Re-export the quinn Endpoint type so downstream crates (wzp-desktop) can
|
||||||
|
// thread a shared endpoint between signaling and media connections without
|
||||||
|
// needing to depend on quinn directly.
|
||||||
|
pub use quinn::Endpoint;
|
||||||
|
|||||||
16
crates/wzp-web/static/wasm/package.json
Normal file
16
crates/wzp-web/static/wasm/package.json
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"name": "wzp-wasm",
|
||||||
|
"type": "module",
|
||||||
|
"description": "WarzonePhone WASM bindings — FEC (RaptorQ) + crypto (ChaCha20-Poly1305, X25519)",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"files": [
|
||||||
|
"wzp_wasm_bg.wasm",
|
||||||
|
"wzp_wasm.js",
|
||||||
|
"wzp_wasm.d.ts"
|
||||||
|
],
|
||||||
|
"main": "wzp_wasm.js",
|
||||||
|
"types": "wzp_wasm.d.ts",
|
||||||
|
"sideEffects": [
|
||||||
|
"./snippets/*"
|
||||||
|
]
|
||||||
|
}
|
||||||
169
crates/wzp-web/static/wasm/wzp_wasm.d.ts
vendored
Normal file
169
crates/wzp-web/static/wasm/wzp_wasm.d.ts
vendored
Normal file
@@ -0,0 +1,169 @@
|
|||||||
|
/* tslint:disable */
|
||||||
|
/* eslint-disable */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Symmetric encryption session using ChaCha20-Poly1305.
|
||||||
|
*
|
||||||
|
* Mirrors `wzp-crypto::session::ChaChaSession` for WASM. Nonce derivation
|
||||||
|
* and key setup are identical so WASM and native peers interoperate.
|
||||||
|
*/
|
||||||
|
export class WzpCryptoSession {
|
||||||
|
free(): void;
|
||||||
|
[Symbol.dispose](): void;
|
||||||
|
/**
|
||||||
|
* Decrypt a media payload with AAD.
|
||||||
|
*
|
||||||
|
* Returns plaintext on success, or throws on auth failure.
|
||||||
|
*/
|
||||||
|
decrypt(header_aad: Uint8Array, ciphertext: Uint8Array): Uint8Array;
|
||||||
|
/**
|
||||||
|
* Encrypt a media payload with AAD (typically the 12-byte MediaHeader).
|
||||||
|
*
|
||||||
|
* Returns `ciphertext || poly1305_tag` (plaintext.len() + 16 bytes).
|
||||||
|
*/
|
||||||
|
encrypt(header_aad: Uint8Array, plaintext: Uint8Array): Uint8Array;
|
||||||
|
/**
|
||||||
|
* Create from a 32-byte shared secret (output of `WzpKeyExchange.derive_shared_secret`).
|
||||||
|
*/
|
||||||
|
constructor(shared_secret: Uint8Array);
|
||||||
|
/**
|
||||||
|
* Current receive sequence number (for diagnostics / UI stats).
|
||||||
|
*/
|
||||||
|
recv_seq(): number;
|
||||||
|
/**
|
||||||
|
* Current send sequence number (for diagnostics / UI stats).
|
||||||
|
*/
|
||||||
|
send_seq(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class WzpFecDecoder {
|
||||||
|
free(): void;
|
||||||
|
[Symbol.dispose](): void;
|
||||||
|
/**
|
||||||
|
* Feed a received symbol.
|
||||||
|
*
|
||||||
|
* Returns the decoded block (concatenated original frames, unpadded) if
|
||||||
|
* enough symbols have been received to recover the block, or `undefined`.
|
||||||
|
*/
|
||||||
|
add_symbol(block_id: number, symbol_idx: number, _is_repair: boolean, data: Uint8Array): Uint8Array | undefined;
|
||||||
|
/**
|
||||||
|
* Create a new FEC decoder.
|
||||||
|
*
|
||||||
|
* * `block_size` — expected number of source symbols per block.
|
||||||
|
* * `symbol_size` — padded byte size of each symbol (must match encoder).
|
||||||
|
*/
|
||||||
|
constructor(block_size: number, symbol_size: number);
|
||||||
|
}
|
||||||
|
|
||||||
|
export class WzpFecEncoder {
|
||||||
|
free(): void;
|
||||||
|
[Symbol.dispose](): void;
|
||||||
|
/**
|
||||||
|
* Add a source symbol (audio frame).
|
||||||
|
*
|
||||||
|
* Returns encoded packets (all source + repair) when the block is complete,
|
||||||
|
* or `undefined` if the block is still accumulating.
|
||||||
|
*
|
||||||
|
* Each returned packet carries the 3-byte header:
|
||||||
|
* `[block_id][symbol_idx][is_repair]` followed by `symbol_size` bytes.
|
||||||
|
*/
|
||||||
|
add_symbol(data: Uint8Array): Uint8Array | undefined;
|
||||||
|
/**
|
||||||
|
* Force-flush the current (possibly partial) block.
|
||||||
|
*
|
||||||
|
* Returns all source + repair symbols with headers, or empty vec if no
|
||||||
|
* symbols have been accumulated.
|
||||||
|
*/
|
||||||
|
flush(): Uint8Array;
|
||||||
|
/**
|
||||||
|
* Create a new FEC encoder.
|
||||||
|
*
|
||||||
|
* * `block_size` — number of source symbols (audio frames) per FEC block.
|
||||||
|
* * `symbol_size` — padded byte size of each symbol (default 256).
|
||||||
|
*/
|
||||||
|
constructor(block_size: number, symbol_size: number);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* X25519 key exchange: generate ephemeral keypair and derive shared secret.
|
||||||
|
*
|
||||||
|
* Usage from JS:
|
||||||
|
* ```js
|
||||||
|
* const kx = new WzpKeyExchange();
|
||||||
|
* const ourPub = kx.public_key(); // Uint8Array(32)
|
||||||
|
* // ... send ourPub to peer, receive peerPub ...
|
||||||
|
* const secret = kx.derive_shared_secret(peerPub); // Uint8Array(32)
|
||||||
|
* const session = new WzpCryptoSession(secret);
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export class WzpKeyExchange {
|
||||||
|
free(): void;
|
||||||
|
[Symbol.dispose](): void;
|
||||||
|
/**
|
||||||
|
* Derive a 32-byte session key from the peer's public key.
|
||||||
|
*
|
||||||
|
* Raw DH output is expanded via HKDF-SHA256 with info="warzone-session-key",
|
||||||
|
* matching `wzp-crypto::handshake::WarzoneKeyExchange::derive_session`.
|
||||||
|
*/
|
||||||
|
derive_shared_secret(peer_public: Uint8Array): Uint8Array;
|
||||||
|
/**
|
||||||
|
* Generate a new random X25519 keypair.
|
||||||
|
*/
|
||||||
|
constructor();
|
||||||
|
/**
|
||||||
|
* Our public key (32 bytes).
|
||||||
|
*/
|
||||||
|
public_key(): Uint8Array;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
|
||||||
|
|
||||||
|
export interface InitOutput {
|
||||||
|
readonly memory: WebAssembly.Memory;
|
||||||
|
readonly __wbg_wzpcryptosession_free: (a: number, b: number) => void;
|
||||||
|
readonly __wbg_wzpfecdecoder_free: (a: number, b: number) => void;
|
||||||
|
readonly __wbg_wzpfecencoder_free: (a: number, b: number) => void;
|
||||||
|
readonly __wbg_wzpkeyexchange_free: (a: number, b: number) => void;
|
||||||
|
readonly wzpcryptosession_decrypt: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
||||||
|
readonly wzpcryptosession_encrypt: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
||||||
|
readonly wzpcryptosession_new: (a: number, b: number) => [number, number, number];
|
||||||
|
readonly wzpcryptosession_recv_seq: (a: number) => number;
|
||||||
|
readonly wzpcryptosession_send_seq: (a: number) => number;
|
||||||
|
readonly wzpfecdecoder_add_symbol: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
|
||||||
|
readonly wzpfecdecoder_new: (a: number, b: number) => number;
|
||||||
|
readonly wzpfecencoder_add_symbol: (a: number, b: number, c: number) => [number, number];
|
||||||
|
readonly wzpfecencoder_flush: (a: number) => [number, number];
|
||||||
|
readonly wzpfecencoder_new: (a: number, b: number) => number;
|
||||||
|
readonly wzpkeyexchange_derive_shared_secret: (a: number, b: number, c: number) => [number, number, number, number];
|
||||||
|
readonly wzpkeyexchange_new: () => number;
|
||||||
|
readonly wzpkeyexchange_public_key: (a: number) => [number, number];
|
||||||
|
readonly __wbindgen_exn_store: (a: number) => void;
|
||||||
|
readonly __externref_table_alloc: () => number;
|
||||||
|
readonly __wbindgen_externrefs: WebAssembly.Table;
|
||||||
|
readonly __wbindgen_malloc: (a: number, b: number) => number;
|
||||||
|
readonly __externref_table_dealloc: (a: number) => void;
|
||||||
|
readonly __wbindgen_free: (a: number, b: number, c: number) => void;
|
||||||
|
readonly __wbindgen_start: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SyncInitInput = BufferSource | WebAssembly.Module;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Instantiates the given `module`, which can either be bytes or
|
||||||
|
* a precompiled `WebAssembly.Module`.
|
||||||
|
*
|
||||||
|
* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
|
||||||
|
*
|
||||||
|
* @returns {InitOutput}
|
||||||
|
*/
|
||||||
|
export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
|
||||||
|
* for everything else, calls `WebAssembly.instantiate` directly.
|
||||||
|
*
|
||||||
|
* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
|
||||||
|
*
|
||||||
|
* @returns {Promise<InitOutput>}
|
||||||
|
*/
|
||||||
|
export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;
|
||||||
27
crates/wzp-web/static/wasm/wzp_wasm_bg.wasm.d.ts
vendored
Normal file
27
crates/wzp-web/static/wasm/wzp_wasm_bg.wasm.d.ts
vendored
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
/* tslint:disable */
|
||||||
|
/* eslint-disable */
|
||||||
|
export const memory: WebAssembly.Memory;
|
||||||
|
export const __wbg_wzpcryptosession_free: (a: number, b: number) => void;
|
||||||
|
export const __wbg_wzpfecdecoder_free: (a: number, b: number) => void;
|
||||||
|
export const __wbg_wzpfecencoder_free: (a: number, b: number) => void;
|
||||||
|
export const __wbg_wzpkeyexchange_free: (a: number, b: number) => void;
|
||||||
|
export const wzpcryptosession_decrypt: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
||||||
|
export const wzpcryptosession_encrypt: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
||||||
|
export const wzpcryptosession_new: (a: number, b: number) => [number, number, number];
|
||||||
|
export const wzpcryptosession_recv_seq: (a: number) => number;
|
||||||
|
export const wzpcryptosession_send_seq: (a: number) => number;
|
||||||
|
export const wzpfecdecoder_add_symbol: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
|
||||||
|
export const wzpfecdecoder_new: (a: number, b: number) => number;
|
||||||
|
export const wzpfecencoder_add_symbol: (a: number, b: number, c: number) => [number, number];
|
||||||
|
export const wzpfecencoder_flush: (a: number) => [number, number];
|
||||||
|
export const wzpfecencoder_new: (a: number, b: number) => number;
|
||||||
|
export const wzpkeyexchange_derive_shared_secret: (a: number, b: number, c: number) => [number, number, number, number];
|
||||||
|
export const wzpkeyexchange_new: () => number;
|
||||||
|
export const wzpkeyexchange_public_key: (a: number) => [number, number];
|
||||||
|
export const __wbindgen_exn_store: (a: number) => void;
|
||||||
|
export const __externref_table_alloc: () => number;
|
||||||
|
export const __wbindgen_externrefs: WebAssembly.Table;
|
||||||
|
export const __wbindgen_malloc: (a: number, b: number) => number;
|
||||||
|
export const __externref_table_dealloc: (a: number) => void;
|
||||||
|
export const __wbindgen_free: (a: number, b: number, c: number) => void;
|
||||||
|
export const __wbindgen_start: () => void;
|
||||||
2
desktop/.gitignore
vendored
Normal file
2
desktop/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
node_modules/
|
||||||
|
dist/
|
||||||
8
desktop/.vite/deps/_metadata.json
Normal file
8
desktop/.vite/deps/_metadata.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"hash": "9046c0bf",
|
||||||
|
"configHash": "ef0fc96f",
|
||||||
|
"lockfileHash": "d66891b1",
|
||||||
|
"browserHash": "8171ed59",
|
||||||
|
"optimized": {},
|
||||||
|
"chunks": {}
|
||||||
|
}
|
||||||
3
desktop/.vite/deps/package.json
Normal file
3
desktop/.vite/deps/package.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"type": "module"
|
||||||
|
}
|
||||||
251
desktop/index.html
Normal file
251
desktop/index.html
Normal file
@@ -0,0 +1,251 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta
|
||||||
|
name="viewport"
|
||||||
|
content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no, viewport-fit=cover"
|
||||||
|
/>
|
||||||
|
<title>WarzonePhone</title>
|
||||||
|
<link rel="stylesheet" href="/src/style.css" />
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="app">
|
||||||
|
<!-- Connect screen -->
|
||||||
|
<div id="connect-screen">
|
||||||
|
<h1>WarzonePhone</h1>
|
||||||
|
<p class="subtitle">Encrypted Voice</p>
|
||||||
|
<div class="form">
|
||||||
|
<label>Relay
|
||||||
|
<button id="relay-selected" class="relay-selected" type="button">
|
||||||
|
<span id="relay-dot" class="dot"></span>
|
||||||
|
<span id="relay-label">Select relay...</span>
|
||||||
|
<span class="arrow">⚙</span>
|
||||||
|
</button>
|
||||||
|
</label>
|
||||||
|
<label>Room
|
||||||
|
<input id="room" type="text" value="general" />
|
||||||
|
</label>
|
||||||
|
<label>Alias
|
||||||
|
<input id="alias" type="text" placeholder="your name" />
|
||||||
|
</label>
|
||||||
|
<div class="form-row">
|
||||||
|
<label class="checkbox">
|
||||||
|
<input id="os-aec" type="checkbox" checked />
|
||||||
|
OS Echo Cancel
|
||||||
|
</label>
|
||||||
|
<button id="settings-btn-home" class="icon-btn" title="Settings (Cmd+,)">⚙</button>
|
||||||
|
</div>
|
||||||
|
<!-- Mode toggle -->
|
||||||
|
<div class="mode-toggle" style="display:flex;gap:8px;margin-bottom:8px;">
|
||||||
|
<button id="mode-room" class="mode-btn active" style="flex:1">Room</button>
|
||||||
|
<button id="mode-direct" class="mode-btn" style="flex:1">Direct Call</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Room mode (default) -->
|
||||||
|
<div id="room-mode">
|
||||||
|
<button id="connect-btn" class="primary">Connect</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Direct call mode -->
|
||||||
|
<div id="direct-mode" class="hidden">
|
||||||
|
<button id="register-btn" class="primary" style="background:#2196F3">Register on Relay</button>
|
||||||
|
<div id="direct-registered" class="hidden" style="margin-top:12px">
|
||||||
|
<div class="direct-registered-header">
|
||||||
|
<p style="color:var(--green);font-size:13px;margin:0">✅ Registered — waiting for calls</p>
|
||||||
|
<button id="deregister-btn" class="secondary-btn small">Deregister</button>
|
||||||
|
</div>
|
||||||
|
<div id="incoming-call-panel" class="hidden" style="background:#1B5E20;padding:12px;border-radius:8px;margin:8px 0">
|
||||||
|
<p style="font-weight:bold;margin:0 0 4px 0">Incoming Call</p>
|
||||||
|
<p id="incoming-caller" style="font-size:12px;opacity:0.8;margin:0 0 8px 0">From: unknown</p>
|
||||||
|
<div style="display:flex;gap:8px">
|
||||||
|
<button id="accept-call-btn" style="flex:1;background:var(--green);color:white;border:none;padding:8px;border-radius:6px;cursor:pointer">Accept</button>
|
||||||
|
<button id="reject-call-btn" style="flex:1;background:var(--red);color:white;border:none;padding:8px;border-radius:6px;cursor:pointer">Reject</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Recent contacts -->
|
||||||
|
<div id="recent-contacts-section" class="hidden">
|
||||||
|
<div class="history-header">Recent contacts</div>
|
||||||
|
<div id="recent-contacts-list" class="history-list"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Call history -->
|
||||||
|
<div id="call-history-section" class="hidden">
|
||||||
|
<div class="history-header">
|
||||||
|
History
|
||||||
|
<button id="clear-history-btn" class="link-btn">clear</button>
|
||||||
|
</div>
|
||||||
|
<div id="call-history-list" class="history-list"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<label style="margin-top:8px">Call by fingerprint
|
||||||
|
<input id="target-fp" type="text" placeholder="xxxx:xxxx:xxxx:..." />
|
||||||
|
</label>
|
||||||
|
<button id="call-btn" class="primary" style="margin-top:8px">Call</button>
|
||||||
|
<p id="call-status-text" style="color:var(--yellow);font-size:13px;margin-top:4px"></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<p id="connect-error" class="error"></p>
|
||||||
|
</div>
|
||||||
|
<div class="identity-info">
|
||||||
|
<span id="my-identicon"></span>
|
||||||
|
<span id="my-fingerprint" class="fp-display"></span>
|
||||||
|
</div>
|
||||||
|
<div class="recent-rooms" id="recent-rooms"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- In-call screen -->
|
||||||
|
<div id="call-screen" class="hidden">
|
||||||
|
<div class="call-header">
|
||||||
|
<div class="call-header-row">
|
||||||
|
<div id="room-name" class="room-name"></div>
|
||||||
|
<button id="settings-btn-call" class="icon-btn small" title="Settings (Cmd+,)">⚙</button>
|
||||||
|
</div>
|
||||||
|
<div class="call-meta">
|
||||||
|
<span id="call-status" class="status-dot"></span>
|
||||||
|
<span id="call-timer" class="call-timer">0:00</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="level-meter">
|
||||||
|
<div id="level-bar" class="level-bar-fill"></div>
|
||||||
|
</div>
|
||||||
|
<div id="participants" class="participants"></div>
|
||||||
|
<div class="controls">
|
||||||
|
<button id="mic-btn" class="control-btn" title="Toggle Mic (m)">
|
||||||
|
<span class="icon" id="mic-icon">Mic</span>
|
||||||
|
</button>
|
||||||
|
<button id="hangup-btn" class="control-btn hangup" title="Hang Up (q)">
|
||||||
|
<span class="icon">End</span>
|
||||||
|
</button>
|
||||||
|
<button id="spk-btn" class="control-btn" title="Toggle Speaker (s)">
|
||||||
|
<span class="icon" id="spk-icon">Spk</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div id="stats" class="stats"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Settings panel -->
|
||||||
|
<div id="settings-panel" class="hidden">
|
||||||
|
<div class="settings-card">
|
||||||
|
<div class="settings-header">
|
||||||
|
<h2>Settings</h2>
|
||||||
|
<button id="settings-close" class="icon-btn">×</button>
|
||||||
|
</div>
|
||||||
|
<div class="settings-section">
|
||||||
|
<h3>Connection</h3>
|
||||||
|
<label>Default Room
|
||||||
|
<input id="s-room" type="text" />
|
||||||
|
</label>
|
||||||
|
<label>Alias
|
||||||
|
<input id="s-alias" type="text" />
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<div class="settings-section">
|
||||||
|
<h3>Audio</h3>
|
||||||
|
<div class="quality-control">
|
||||||
|
<div class="quality-header">
|
||||||
|
<span class="setting-label">QUALITY</span>
|
||||||
|
<span id="s-quality-label" class="quality-label">Auto</span>
|
||||||
|
</div>
|
||||||
|
<input id="s-quality" type="range" min="0" max="7" step="1" value="3" class="quality-slider" />
|
||||||
|
<div class="quality-ticks">
|
||||||
|
<span>64k</span>
|
||||||
|
<span>48k</span>
|
||||||
|
<span>32k</span>
|
||||||
|
<span>Auto</span>
|
||||||
|
<span>24k</span>
|
||||||
|
<span>6k</span>
|
||||||
|
<span>C2</span>
|
||||||
|
<span>1.2k</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<label class="checkbox">
|
||||||
|
<input id="s-os-aec" type="checkbox" />
|
||||||
|
OS Echo Cancellation (macOS VoiceProcessingIO)
|
||||||
|
</label>
|
||||||
|
<label class="checkbox">
|
||||||
|
<input id="s-agc" type="checkbox" checked />
|
||||||
|
Automatic Gain Control
|
||||||
|
</label>
|
||||||
|
<label class="checkbox">
|
||||||
|
<input id="s-dred-debug" type="checkbox" />
|
||||||
|
DRED debug logs (verbose, dev only)
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<div class="settings-section">
|
||||||
|
<h3>Identity</h3>
|
||||||
|
<div class="setting-row">
|
||||||
|
<span class="setting-label">Fingerprint</span>
|
||||||
|
<span id="s-fingerprint" class="fp-display-large"></span>
|
||||||
|
</div>
|
||||||
|
<div class="setting-row">
|
||||||
|
<span class="setting-label">Identity file</span>
|
||||||
|
<span class="fp-display">~/.wzp/identity</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="settings-section">
|
||||||
|
<h3>Network</h3>
|
||||||
|
<div class="setting-row">
|
||||||
|
<span class="setting-label">Public address</span>
|
||||||
|
<span id="s-reflected-addr" class="fp-display">(not queried)</span>
|
||||||
|
<button id="s-reflect-btn" class="secondary-btn">Detect</button>
|
||||||
|
</div>
|
||||||
|
<small style="color:var(--text-dim);display:block;margin-top:4px">
|
||||||
|
Asks the registered relay to echo back the IP:port it sees for this
|
||||||
|
connection (QUIC-native NAT reflection, replaces STUN).
|
||||||
|
</small>
|
||||||
|
</div>
|
||||||
|
<div class="settings-section">
|
||||||
|
<h3>Recent Rooms</h3>
|
||||||
|
<div id="s-recent-rooms" class="recent-rooms-list"></div>
|
||||||
|
<button id="s-clear-recent" class="secondary-btn">Clear History</button>
|
||||||
|
</div>
|
||||||
|
<button id="settings-save" class="primary">Save</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Manage Relays dialog -->
|
||||||
|
<div id="relay-dialog" class="hidden">
|
||||||
|
<div class="settings-card relay-dialog-card">
|
||||||
|
<div class="settings-header">
|
||||||
|
<h2>Manage Relays</h2>
|
||||||
|
<button id="relay-dialog-close" class="icon-btn">×</button>
|
||||||
|
</div>
|
||||||
|
<div id="relay-dialog-list" class="relay-dialog-list"></div>
|
||||||
|
<div class="relay-add-row">
|
||||||
|
<div class="relay-add-inputs">
|
||||||
|
<input id="relay-add-name" type="text" placeholder="Name" />
|
||||||
|
<input id="relay-add-addr" type="text" placeholder="host:port" />
|
||||||
|
</div>
|
||||||
|
<button id="relay-add-btn" class="primary">Add Relay</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<!-- Key changed warning dialog -->
|
||||||
|
<div id="key-warning" class="hidden">
|
||||||
|
<div class="settings-card key-warning-card">
|
||||||
|
<div class="key-warning-icon">⚠</div>
|
||||||
|
<h2>Server Key Changed</h2>
|
||||||
|
<p class="key-warning-text">The relay's identity has changed since you last connected. This usually happens when the server was restarted, but could also indicate a security issue.</p>
|
||||||
|
<div class="key-warning-fps">
|
||||||
|
<div class="key-fp-row">
|
||||||
|
<span class="key-fp-label">Previously known</span>
|
||||||
|
<code id="kw-old-fp" class="key-fp"></code>
|
||||||
|
</div>
|
||||||
|
<div class="key-fp-row">
|
||||||
|
<span class="key-fp-label">New key</span>
|
||||||
|
<code id="kw-new-fp" class="key-fp"></code>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="key-warning-actions">
|
||||||
|
<button id="kw-accept" class="primary">Accept New Key</button>
|
||||||
|
<button id="kw-cancel" class="secondary-btn">Cancel</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<script type="module" src="/src/main.ts"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
1350
desktop/package-lock.json
generated
Normal file
1350
desktop/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
19
desktop/package.json
Normal file
19
desktop/package.json
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"name": "wzp-desktop",
|
||||||
|
"private": true,
|
||||||
|
"version": "0.1.0",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "vite",
|
||||||
|
"build": "vite build",
|
||||||
|
"tauri": "tauri"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@tauri-apps/api": "^2"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"typescript": "^5",
|
||||||
|
"vite": "^6",
|
||||||
|
"@tauri-apps/cli": "^2"
|
||||||
|
}
|
||||||
|
}
|
||||||
107
desktop/src-tauri/Cargo.toml
Normal file
107
desktop/src-tauri/Cargo.toml
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
[package]
|
||||||
|
name = "wzp-desktop"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2024"
|
||||||
|
description = "WarzonePhone Desktop — encrypted VoIP client"
|
||||||
|
default-run = "wzp-desktop"
|
||||||
|
|
||||||
|
# Library target — required for Tauri mobile (Android/iOS link the app as a cdylib)
|
||||||
|
# and also used by the desktop binary below.
|
||||||
|
#
|
||||||
|
# `staticlib` was DROPPED from crate-type because rust-lang/rust#104707
|
||||||
|
# documents that having staticlib alongside cdylib leaks non-exported
|
||||||
|
# symbols from staticlibs into the cdylib. Bionic's private `__init_tcb`
|
||||||
|
# / `pthread_create` symbols end up bound LOCALLY inside our .so instead
|
||||||
|
# of resolved dynamically against libc.so at dlopen time — which crashes
|
||||||
|
# at launch as soon as tao tries to std::thread::spawn() from the JNI
|
||||||
|
# onCreate callback. The legacy wzp-android crate uses ["cdylib", "rlib"]
|
||||||
|
# and runs fine on the same phone with the same NDK + Rust toolchain.
|
||||||
|
#
|
||||||
|
# iOS Tauri builds that actually need staticlib can re-add it behind a
|
||||||
|
# target cfg if we ever ship on iOS.
|
||||||
|
[lib]
|
||||||
|
name = "wzp_desktop_lib"
|
||||||
|
crate-type = ["cdylib", "rlib"]
|
||||||
|
|
||||||
|
[[bin]]
|
||||||
|
name = "wzp-desktop"
|
||||||
|
path = "src/main.rs"
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
tauri-build = { version = "2", features = [] }
|
||||||
|
# cc is no longer needed — all C++ moved to crates/wzp-native (built with
|
||||||
|
# cargo-ndk and loaded via libloading at runtime). wzp-desktop's .so on
|
||||||
|
# Android is now pure Rust.
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
tauri = { version = "2", features = [] }
|
||||||
|
tauri-plugin-shell = "2"
|
||||||
|
serde = { version = "1", features = ["derive"] }
|
||||||
|
serde_json = "1"
|
||||||
|
tokio = { version = "1", features = ["full"] }
|
||||||
|
tracing = "0.1"
|
||||||
|
tracing-subscriber = "0.3"
|
||||||
|
anyhow = "1"
|
||||||
|
rustls = { version = "0.23", default-features = false, features = ["ring", "std"] }
|
||||||
|
|
||||||
|
# WarzonePhone crates — protocol layer is platform-independent
|
||||||
|
wzp-proto = { path = "../../crates/wzp-proto" }
|
||||||
|
wzp-codec = { path = "../../crates/wzp-codec" }
|
||||||
|
wzp-fec = { path = "../../crates/wzp-fec" }
|
||||||
|
wzp-crypto = { path = "../../crates/wzp-crypto" }
|
||||||
|
wzp-transport = { path = "../../crates/wzp-transport" }
|
||||||
|
|
||||||
|
# wzp-client pulls in CPAL on every desktop target and, additionally on
|
||||||
|
# macOS, VoiceProcessingIO (coreaudio-rs behind the "vpio" feature). The
|
||||||
|
# vpio feature MUST NOT be enabled on Windows / Linux because coreaudio-rs
|
||||||
|
# is Apple-framework-only and will fail to build. Task #24 will add a
|
||||||
|
# matching Windows Voice Capture DSP path behind its own feature; until
|
||||||
|
# then, Windows desktops use plain CPAL with AEC disabled.
|
||||||
|
|
||||||
|
# macOS: CPAL + VoiceProcessingIO (hardware AEC via Core Audio).
|
||||||
|
[target.'cfg(target_os = "macos")'.dependencies]
|
||||||
|
wzp-client = { path = "../../crates/wzp-client", features = ["audio", "vpio"] }
|
||||||
|
|
||||||
|
# Windows: CPAL for playback + direct WASAPI for capture with OS-level
|
||||||
|
# AEC (AudioCategory_Communications). The wzp-client `windows-aec`
|
||||||
|
# feature swaps the default CPAL AudioCapture for a WASAPI one that
|
||||||
|
# opens the mic under AudioCategory_Communications, turning on Windows's
|
||||||
|
# communications audio processing chain (AEC, NS, AGC). The reference
|
||||||
|
# signal for AEC is the system render mix, so echo from our CPAL
|
||||||
|
# playback is cancelled automatically without extra plumbing.
|
||||||
|
[target.'cfg(target_os = "windows")'.dependencies]
|
||||||
|
wzp-client = { path = "../../crates/wzp-client", features = ["audio", "windows-aec"] }
|
||||||
|
|
||||||
|
# Linux: CPAL playback+capture baseline. AEC is enabled via the top-level
|
||||||
|
# `linux-aec` feature in wzp-desktop, which forwards to wzp-client/linux-aec.
|
||||||
|
# Keeping it opt-in at the wzp-desktop level (rather than forcing it always
|
||||||
|
# on here) lets `cargo tauri build` produce two variants from the same
|
||||||
|
# source tree — a noAEC baseline and an AEC build — by toggling the feature
|
||||||
|
# at build time: `cargo tauri build -- --features wzp-desktop/linux-aec`.
|
||||||
|
[target.'cfg(target_os = "linux")'.dependencies]
|
||||||
|
wzp-client = { path = "../../crates/wzp-client", features = ["audio"] }
|
||||||
|
|
||||||
|
# Android: no CPAL, no vpio — audio goes through the standalone wzp-native
|
||||||
|
# cdylib that we dlopen via libloading at runtime. See the wzp_native
|
||||||
|
# module in src/.
|
||||||
|
[target.'cfg(target_os = "android")'.dependencies]
|
||||||
|
wzp-client = { path = "../../crates/wzp-client", default-features = false }
|
||||||
|
# libloading: runtime dlopen of libwzp_native.so — the standalone cdylib
|
||||||
|
# crate that owns all C++ (Oboe bridge). Keeps wzp-desktop's .so free of
|
||||||
|
# any C/C++ static archives that would otherwise leak bionic's internal
|
||||||
|
# pthread_create into our cdylib and trigger the __init_tcb crash.
|
||||||
|
libloading = "0.8"
|
||||||
|
# jni + ndk-context: called from android_audio.rs to invoke
|
||||||
|
# AudioManager.setSpeakerphoneOn on the JVM side at runtime, so the
|
||||||
|
# Oboe playout stream (opened with Usage::VoiceCommunication) can route
|
||||||
|
# between earpiece and loud speaker without restarting.
|
||||||
|
jni = "0.21"
|
||||||
|
ndk-context = "0.1"
|
||||||
|
|
||||||
|
[features]
|
||||||
|
default = ["custom-protocol"]
|
||||||
|
custom-protocol = ["tauri/custom-protocol"]
|
||||||
|
# linux-aec: forwards to wzp-client/linux-aec so `cargo tauri build -- --features
|
||||||
|
# wzp-desktop/linux-aec` enables the WebRTC AEC3 backend on Linux. No-op on
|
||||||
|
# other targets because wzp-client/linux-aec is itself cfg(target_os = "linux").
|
||||||
|
linux-aec = ["wzp-client/linux-aec"]
|
||||||
21
desktop/src-tauri/Info.plist
Normal file
21
desktop/src-tauri/Info.plist
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||||
|
<plist version="1.0">
|
||||||
|
<dict>
|
||||||
|
<!--
|
||||||
|
Custom Info.plist keys merged into the bundled WarzonePhone.app by
|
||||||
|
tauri-bundler. The base Info.plist (CFBundleIdentifier, version,
|
||||||
|
etc.) is generated from tauri.conf.json — only put *additional*
|
||||||
|
keys here.
|
||||||
|
|
||||||
|
NSMicrophoneUsageDescription is required by macOS TCC for any
|
||||||
|
app that opens an audio input unit. Without this string the OS
|
||||||
|
silently denies CoreAudio capture (input callbacks return zeros)
|
||||||
|
and the app never appears in System Settings → Privacy &
|
||||||
|
Security → Microphone. This was the root cause of the desktop
|
||||||
|
mic regression where phones could not hear the desktop client.
|
||||||
|
-->
|
||||||
|
<key>NSMicrophoneUsageDescription</key>
|
||||||
|
<string>WarzonePhone needs microphone access to transmit your voice during calls.</string>
|
||||||
|
</dict>
|
||||||
|
</plist>
|
||||||
26
desktop/src-tauri/build.rs
Normal file
26
desktop/src-tauri/build.rs
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
use std::process::Command;
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
// Capture short git hash so the running app can prove which build it is.
|
||||||
|
// Falls back to "unknown" if git isn't available (e.g. when building from
|
||||||
|
// a tarball without a .git dir).
|
||||||
|
let git_hash = Command::new("git")
|
||||||
|
.args(["rev-parse", "--short", "HEAD"])
|
||||||
|
.output()
|
||||||
|
.ok()
|
||||||
|
.filter(|o| o.status.success())
|
||||||
|
.and_then(|o| String::from_utf8(o.stdout).ok())
|
||||||
|
.map(|s| s.trim().to_string())
|
||||||
|
.unwrap_or_else(|| "unknown".into());
|
||||||
|
|
||||||
|
println!("cargo:rustc-env=WZP_GIT_HASH={git_hash}");
|
||||||
|
println!("cargo:rerun-if-changed=../../.git/HEAD");
|
||||||
|
println!("cargo:rerun-if-changed=../../.git/refs/heads");
|
||||||
|
|
||||||
|
// No cc::Build of ANY kind on Android — all C++ lives in the standalone
|
||||||
|
// `wzp-native` crate which is built separately with cargo-ndk and loaded
|
||||||
|
// via libloading at runtime. See docs/incident-tauri-android-init-tcb.md
|
||||||
|
// for why this split exists.
|
||||||
|
|
||||||
|
tauri_build::build()
|
||||||
|
}
|
||||||
26
desktop/src-tauri/capabilities/default.json
Normal file
26
desktop/src-tauri/capabilities/default.json
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"$schema": "../gen/schemas/desktop-schema.json",
|
||||||
|
"identifier": "default",
|
||||||
|
"description": "Default capability — grants core APIs (events, path, window, app, clipboard) to the main window on every platform we ship to.",
|
||||||
|
"windows": ["main"],
|
||||||
|
"platforms": [
|
||||||
|
"linux",
|
||||||
|
"macOS",
|
||||||
|
"windows",
|
||||||
|
"android",
|
||||||
|
"iOS"
|
||||||
|
],
|
||||||
|
"permissions": [
|
||||||
|
"core:default",
|
||||||
|
"core:event:default",
|
||||||
|
"core:event:allow-listen",
|
||||||
|
"core:event:allow-unlisten",
|
||||||
|
"core:event:allow-emit",
|
||||||
|
"core:event:allow-emit-to",
|
||||||
|
"core:path:default",
|
||||||
|
"core:window:default",
|
||||||
|
"core:app:default",
|
||||||
|
"core:webview:default",
|
||||||
|
"shell:default"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||||
|
<uses-permission android:name="android.permission.INTERNET" />
|
||||||
|
<uses-permission android:name="android.permission.RECORD_AUDIO" />
|
||||||
|
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
|
||||||
|
<uses-feature android:name="android.hardware.microphone" android:required="true" />
|
||||||
|
|
||||||
|
<!-- AndroidTV support -->
|
||||||
|
<uses-feature android:name="android.software.leanback" android:required="false" />
|
||||||
|
|
||||||
|
<application
|
||||||
|
android:icon="@mipmap/ic_launcher"
|
||||||
|
android:label="@string/app_name"
|
||||||
|
android:theme="@style/Theme.wzp_desktop"
|
||||||
|
android:usesCleartextTraffic="${usesCleartextTraffic}">
|
||||||
|
<activity
|
||||||
|
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
|
||||||
|
android:launchMode="singleTask"
|
||||||
|
android:label="@string/main_activity_title"
|
||||||
|
android:name=".MainActivity"
|
||||||
|
android:exported="true">
|
||||||
|
<intent-filter>
|
||||||
|
<action android:name="android.intent.action.MAIN" />
|
||||||
|
<category android:name="android.intent.category.LAUNCHER" />
|
||||||
|
<!-- AndroidTV support -->
|
||||||
|
<category android:name="android.intent.category.LEANBACK_LAUNCHER" />
|
||||||
|
</intent-filter>
|
||||||
|
</activity>
|
||||||
|
|
||||||
|
<provider
|
||||||
|
android:name="androidx.core.content.FileProvider"
|
||||||
|
android:authorities="${applicationId}.fileprovider"
|
||||||
|
android:exported="false"
|
||||||
|
android:grantUriPermissions="true">
|
||||||
|
<meta-data
|
||||||
|
android:name="android.support.FILE_PROVIDER_PATHS"
|
||||||
|
android:resource="@xml/file_paths" />
|
||||||
|
</provider>
|
||||||
|
</application>
|
||||||
|
</manifest>
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
package com.wzp.desktop
|
||||||
|
|
||||||
|
import android.Manifest
|
||||||
|
import android.content.Context
|
||||||
|
import android.content.pm.PackageManager
|
||||||
|
import android.media.AudioManager
|
||||||
|
import android.os.Bundle
|
||||||
|
import android.util.Log
|
||||||
|
import androidx.activity.enableEdgeToEdge
|
||||||
|
import androidx.core.app.ActivityCompat
|
||||||
|
import androidx.core.content.ContextCompat
|
||||||
|
|
||||||
|
class MainActivity : TauriActivity() {
|
||||||
|
companion object {
|
||||||
|
private const val TAG = "WzpMainActivity"
|
||||||
|
private const val AUDIO_PERMISSIONS_REQUEST = 4242
|
||||||
|
private val REQUIRED_AUDIO_PERMISSIONS = arrayOf(
|
||||||
|
Manifest.permission.RECORD_AUDIO,
|
||||||
|
Manifest.permission.MODIFY_AUDIO_SETTINGS
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onCreate(savedInstanceState: Bundle?) {
|
||||||
|
enableEdgeToEdge()
|
||||||
|
super.onCreate(savedInstanceState)
|
||||||
|
|
||||||
|
// Request RECORD_AUDIO early so Oboe (inside libwzp_native.so) can open
|
||||||
|
// the AAudio input stream without silently failing. The grant is
|
||||||
|
// persisted, so after the first launch the dialog no longer appears.
|
||||||
|
// MODIFY_AUDIO_SETTINGS is needed to switch AudioManager mode + speaker.
|
||||||
|
val needsRequest = REQUIRED_AUDIO_PERMISSIONS.any {
|
||||||
|
ContextCompat.checkSelfPermission(this, it) != PackageManager.PERMISSION_GRANTED
|
||||||
|
}
|
||||||
|
if (needsRequest) {
|
||||||
|
Log.i(TAG, "requesting audio permissions")
|
||||||
|
ActivityCompat.requestPermissions(this, REQUIRED_AUDIO_PERMISSIONS, AUDIO_PERMISSIONS_REQUEST)
|
||||||
|
} else {
|
||||||
|
Log.i(TAG, "audio permissions already granted")
|
||||||
|
configureAudioForCall()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun onRequestPermissionsResult(
|
||||||
|
requestCode: Int,
|
||||||
|
permissions: Array<String>,
|
||||||
|
grantResults: IntArray
|
||||||
|
) {
|
||||||
|
super.onRequestPermissionsResult(requestCode, permissions, grantResults)
|
||||||
|
if (requestCode == AUDIO_PERMISSIONS_REQUEST) {
|
||||||
|
val allGranted = grantResults.isNotEmpty() &&
|
||||||
|
grantResults.all { it == PackageManager.PERMISSION_GRANTED }
|
||||||
|
Log.i(TAG, "audio permissions result: allGranted=$allGranted grants=${grantResults.toList()}")
|
||||||
|
if (allGranted) {
|
||||||
|
configureAudioForCall()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Put the phone into VoIP call mode with handset (earpiece) as the
|
||||||
|
* default output. The Oboe playout stream is opened with
|
||||||
|
* Usage::VoiceCommunication which honours this routing, so:
|
||||||
|
*
|
||||||
|
* MODE_IN_COMMUNICATION + speakerphoneOn=false → earpiece (handset)
|
||||||
|
* MODE_IN_COMMUNICATION + speakerphoneOn=true → loudspeaker
|
||||||
|
* MODE_IN_COMMUNICATION + bluetoothScoOn=true → bluetooth headset
|
||||||
|
*
|
||||||
|
* The speaker/handset/BT toggle itself is wired up via the Tauri
|
||||||
|
* command `set_speakerphone(on)` in a follow-up build. For now the
|
||||||
|
* default is handset, matching the user's stated preference.
|
||||||
|
*
|
||||||
|
* STREAM_VOICE_CALL volume is cranked to max since the in-call volume
|
||||||
|
* slider is separate from media volume on most devices.
|
||||||
|
*/
|
||||||
|
private fun configureAudioForCall() {
|
||||||
|
try {
|
||||||
|
val am = getSystemService(Context.AUDIO_SERVICE) as AudioManager
|
||||||
|
Log.i(TAG, "audio state before: mode=${am.mode} speaker=${am.isSpeakerphoneOn} " +
|
||||||
|
"voiceVol=${am.getStreamVolume(AudioManager.STREAM_VOICE_CALL)}/" +
|
||||||
|
"${am.getStreamMaxVolume(AudioManager.STREAM_VOICE_CALL)} " +
|
||||||
|
"musicVol=${am.getStreamVolume(AudioManager.STREAM_MUSIC)}/" +
|
||||||
|
"${am.getStreamMaxVolume(AudioManager.STREAM_MUSIC)}")
|
||||||
|
|
||||||
|
am.mode = AudioManager.MODE_IN_COMMUNICATION
|
||||||
|
am.isSpeakerphoneOn = false // default: handset / earpiece
|
||||||
|
|
||||||
|
// Crank both voice-call and music volumes so nothing silent slips
|
||||||
|
// through regardless of which stream actually ends up driving.
|
||||||
|
val maxVoice = am.getStreamMaxVolume(AudioManager.STREAM_VOICE_CALL)
|
||||||
|
am.setStreamVolume(AudioManager.STREAM_VOICE_CALL, maxVoice, 0)
|
||||||
|
val maxMusic = am.getStreamMaxVolume(AudioManager.STREAM_MUSIC)
|
||||||
|
am.setStreamVolume(AudioManager.STREAM_MUSIC, maxMusic, 0)
|
||||||
|
|
||||||
|
Log.i(TAG, "audio state after: mode=${am.mode} speaker=${am.isSpeakerphoneOn} " +
|
||||||
|
"voiceVol=${am.getStreamVolume(AudioManager.STREAM_VOICE_CALL)}/$maxVoice " +
|
||||||
|
"musicVol=${am.getStreamVolume(AudioManager.STREAM_MUSIC)}/$maxMusic")
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
Log.e(TAG, "configureAudioForCall failed: ${e.message}", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
desktop/src-tauri/gen/schemas/acl-manifests.json
Normal file
1
desktop/src-tauri/gen/schemas/acl-manifests.json
Normal file
File diff suppressed because one or more lines are too long
1
desktop/src-tauri/gen/schemas/capabilities.json
Normal file
1
desktop/src-tauri/gen/schemas/capabilities.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{"default":{"identifier":"default","description":"Default capability — grants core APIs (events, path, window, app, clipboard) to the main window on every platform we ship to.","local":true,"windows":["main"],"permissions":["core:default","core:event:default","core:event:allow-listen","core:event:allow-unlisten","core:event:allow-emit","core:event:allow-emit-to","core:path:default","core:window:default","core:app:default","core:webview:default","shell:default"],"platforms":["linux","macOS","windows","android","iOS"]}}
|
||||||
2564
desktop/src-tauri/gen/schemas/desktop-schema.json
Normal file
2564
desktop/src-tauri/gen/schemas/desktop-schema.json
Normal file
File diff suppressed because it is too large
Load Diff
2564
desktop/src-tauri/gen/schemas/macOS-schema.json
Normal file
2564
desktop/src-tauri/gen/schemas/macOS-schema.json
Normal file
File diff suppressed because it is too large
Load Diff
BIN
desktop/src-tauri/icons/icon.ico
Normal file
BIN
desktop/src-tauri/icons/icon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.0 KiB |
BIN
desktop/src-tauri/icons/icon.png
Normal file
BIN
desktop/src-tauri/icons/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 104 B |
98
desktop/src-tauri/src/android_audio.rs
Normal file
98
desktop/src-tauri/src/android_audio.rs
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
//! Runtime bridge to Android's `AudioManager` for in-call audio routing.
|
||||||
|
//!
|
||||||
|
//! We own a quinn+Oboe VoIP pipeline entirely from Rust, but routing the
|
||||||
|
//! playout stream between earpiece / loudspeaker / Bluetooth headset has to
|
||||||
|
//! happen at the JVM level because those toggles are AudioManager-only.
|
||||||
|
//! This module uses the global JavaVM handle that `ndk_context` exposes
|
||||||
|
//! (populated by Tauri's mobile runtime) + the `jni` crate to reach into
|
||||||
|
//! the Android framework without needing a Tauri plugin.
|
||||||
|
//!
|
||||||
|
//! All callers must be inside an Android target (`#[cfg(target_os = "android")]`).
|
||||||
|
|
||||||
|
#![cfg(target_os = "android")]
|
||||||
|
|
||||||
|
use jni::objects::{JObject, JString, JValue};
|
||||||
|
use jni::JavaVM;
|
||||||
|
|
||||||
|
/// Grab the JavaVM + current Activity from the ndk_context that Tauri's
|
||||||
|
/// mobile runtime sets up at process startup.
|
||||||
|
fn jvm_and_activity() -> Result<(JavaVM, JObject<'static>), String> {
|
||||||
|
let ctx = ndk_context::android_context();
|
||||||
|
let vm_ptr = ctx.vm() as *mut jni::sys::JavaVM;
|
||||||
|
if vm_ptr.is_null() {
|
||||||
|
return Err("ndk_context: JavaVM pointer is null".into());
|
||||||
|
}
|
||||||
|
let vm = unsafe { JavaVM::from_raw(vm_ptr) }
|
||||||
|
.map_err(|e| format!("JavaVM::from_raw: {e}"))?;
|
||||||
|
let activity_ptr = ctx.context() as jni::sys::jobject;
|
||||||
|
if activity_ptr.is_null() {
|
||||||
|
return Err("ndk_context: activity pointer is null".into());
|
||||||
|
}
|
||||||
|
// SAFETY: ndk_context guarantees the pointer lives for the process
|
||||||
|
// lifetime; we wrap it as a JObject<'static> for convenience.
|
||||||
|
let activity: JObject<'static> = unsafe { JObject::from_raw(activity_ptr) };
|
||||||
|
Ok((vm, activity))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get Android's `AudioManager` via `activity.getSystemService("audio")`.
|
||||||
|
fn audio_manager<'local>(
|
||||||
|
env: &mut jni::AttachGuard<'local>,
|
||||||
|
activity: &JObject<'local>,
|
||||||
|
) -> Result<JObject<'local>, String> {
|
||||||
|
let svc_name: JString<'local> = env
|
||||||
|
.new_string("audio")
|
||||||
|
.map_err(|e| format!("new_string(audio): {e}"))?;
|
||||||
|
let am = env
|
||||||
|
.call_method(
|
||||||
|
activity,
|
||||||
|
"getSystemService",
|
||||||
|
"(Ljava/lang/String;)Ljava/lang/Object;",
|
||||||
|
&[JValue::Object(&svc_name)],
|
||||||
|
)
|
||||||
|
.and_then(|v| v.l())
|
||||||
|
.map_err(|e| format!("getSystemService(audio): {e}"))?;
|
||||||
|
if am.is_null() {
|
||||||
|
return Err("getSystemService returned null".into());
|
||||||
|
}
|
||||||
|
Ok(am)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Switch between loud speaker (`true`) and earpiece/handset (`false`).
|
||||||
|
///
|
||||||
|
/// Calls `AudioManager.setSpeakerphoneOn(on)` on the JVM. Requires that
|
||||||
|
/// the audio mode is already `MODE_IN_COMMUNICATION` — MainActivity.kt
|
||||||
|
/// sets this at startup, so by the time a call is up this is always true.
|
||||||
|
pub fn set_speakerphone(on: bool) -> Result<(), String> {
|
||||||
|
let (vm, activity) = jvm_and_activity()?;
|
||||||
|
let mut env = vm
|
||||||
|
.attach_current_thread()
|
||||||
|
.map_err(|e| format!("attach_current_thread: {e}"))?;
|
||||||
|
let am = audio_manager(&mut env, &activity)?;
|
||||||
|
|
||||||
|
env.call_method(
|
||||||
|
&am,
|
||||||
|
"setSpeakerphoneOn",
|
||||||
|
"(Z)V",
|
||||||
|
&[JValue::Bool(if on { 1 } else { 0 })],
|
||||||
|
)
|
||||||
|
.map_err(|e| format!("setSpeakerphoneOn({on}): {e}"))?;
|
||||||
|
|
||||||
|
tracing::info!(on, "AudioManager.setSpeakerphoneOn");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Query the current speakerphone state. Returns true if routing is on the
|
||||||
|
/// loud speaker, false if on earpiece / BT headset / wired headset.
|
||||||
|
pub fn is_speakerphone_on() -> Result<bool, String> {
|
||||||
|
let (vm, activity) = jvm_and_activity()?;
|
||||||
|
let mut env = vm
|
||||||
|
.attach_current_thread()
|
||||||
|
.map_err(|e| format!("attach_current_thread: {e}"))?;
|
||||||
|
let am = audio_manager(&mut env, &activity)?;
|
||||||
|
|
||||||
|
let on = env
|
||||||
|
.call_method(&am, "isSpeakerphoneOn", "()Z", &[])
|
||||||
|
.and_then(|v| v.z())
|
||||||
|
.map_err(|e| format!("isSpeakerphoneOn: {e}"))?;
|
||||||
|
Ok(on)
|
||||||
|
}
|
||||||
1265
desktop/src-tauri/src/engine.rs
Normal file
1265
desktop/src-tauri/src/engine.rs
Normal file
File diff suppressed because it is too large
Load Diff
180
desktop/src-tauri/src/history.rs
Normal file
180
desktop/src-tauri/src/history.rs
Normal file
@@ -0,0 +1,180 @@
|
|||||||
|
//! Call history store.
|
||||||
|
//!
|
||||||
|
//! Keeps a rolling JSON file of the last N direct-call events so the UI can
|
||||||
|
//! show "recent contacts" + "call history with callback buttons" on the
|
||||||
|
//! direct-call screen. Storage lives in `<APP_DATA_DIR>/call_history.json`
|
||||||
|
//! alongside the identity file. The file is read lazily on first access and
|
||||||
|
//! cached in an RwLock behind a OnceLock.
|
||||||
|
//!
|
||||||
|
//! This is a v1 — no duration tracking yet, entries are logged at the
|
||||||
|
//! moment the direction is decided (placed / received / missed).
|
||||||
|
|
||||||
|
use std::path::PathBuf;
|
||||||
|
use std::sync::{OnceLock, RwLock};
|
||||||
|
use std::time::{SystemTime, UNIX_EPOCH};
|
||||||
|
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
/// Maximum number of history entries we keep. Older ones are pruned FIFO.
|
||||||
|
const MAX_ENTRIES: usize = 200;
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
||||||
|
#[serde(rename_all = "lowercase")]
|
||||||
|
pub enum CallDirection {
|
||||||
|
/// Local user placed the call.
|
||||||
|
Placed,
|
||||||
|
/// Remote user called and local user answered.
|
||||||
|
Received,
|
||||||
|
/// Remote user called but local user did not answer (rejected or
|
||||||
|
/// missed entirely — the UI treats these identically).
|
||||||
|
Missed,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
|
pub struct CallHistoryEntry {
|
||||||
|
pub call_id: String,
|
||||||
|
pub peer_fp: String,
|
||||||
|
pub peer_alias: Option<String>,
|
||||||
|
pub direction: CallDirection,
|
||||||
|
/// Seconds since UNIX epoch, UTC.
|
||||||
|
pub timestamp_unix: u64,
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── In-process store (loaded from disk once) ─────────────────────────────
|
||||||
|
|
||||||
|
static STORE: OnceLock<RwLock<Vec<CallHistoryEntry>>> = OnceLock::new();
|
||||||
|
|
||||||
|
fn store() -> &'static RwLock<Vec<CallHistoryEntry>> {
|
||||||
|
STORE.get_or_init(|| RwLock::new(load_from_disk()))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn history_path() -> PathBuf {
|
||||||
|
crate::APP_DATA_DIR
|
||||||
|
.get()
|
||||||
|
.cloned()
|
||||||
|
.unwrap_or_else(|| {
|
||||||
|
let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
|
||||||
|
PathBuf::from(home).join(".wzp")
|
||||||
|
})
|
||||||
|
.join("call_history.json")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn load_from_disk() -> Vec<CallHistoryEntry> {
|
||||||
|
let path = history_path();
|
||||||
|
let Ok(bytes) = std::fs::read(&path) else {
|
||||||
|
return Vec::new();
|
||||||
|
};
|
||||||
|
serde_json::from_slice::<Vec<CallHistoryEntry>>(&bytes)
|
||||||
|
.inspect_err(|e| tracing::warn!(path = %path.display(), error = %e, "call_history.json parse failed"))
|
||||||
|
.unwrap_or_default()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn save_to_disk(entries: &[CallHistoryEntry]) {
|
||||||
|
let path = history_path();
|
||||||
|
if let Some(parent) = path.parent() {
|
||||||
|
let _ = std::fs::create_dir_all(parent);
|
||||||
|
}
|
||||||
|
let Ok(json) = serde_json::to_vec_pretty(entries) else { return };
|
||||||
|
// Atomic write via temp file + rename so a crash mid-write doesn't
|
||||||
|
// leave us with a half-file on disk.
|
||||||
|
let tmp = path.with_extension("json.tmp");
|
||||||
|
if std::fs::write(&tmp, &json).is_ok() {
|
||||||
|
let _ = std::fs::rename(&tmp, &path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn now_unix() -> u64 {
|
||||||
|
SystemTime::now()
|
||||||
|
.duration_since(UNIX_EPOCH)
|
||||||
|
.map(|d| d.as_secs())
|
||||||
|
.unwrap_or(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Public API ───────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Append a new entry to the store and persist to disk. Trims the store to
|
||||||
|
/// `MAX_ENTRIES` after insertion.
|
||||||
|
pub fn log(
|
||||||
|
call_id: String,
|
||||||
|
peer_fp: String,
|
||||||
|
peer_alias: Option<String>,
|
||||||
|
direction: CallDirection,
|
||||||
|
) {
|
||||||
|
tracing::info!(
|
||||||
|
%call_id, %peer_fp, ?direction,
|
||||||
|
alias = ?peer_alias,
|
||||||
|
"history::log"
|
||||||
|
);
|
||||||
|
let entry = CallHistoryEntry {
|
||||||
|
call_id: call_id.clone(),
|
||||||
|
peer_fp,
|
||||||
|
peer_alias,
|
||||||
|
direction,
|
||||||
|
timestamp_unix: now_unix(),
|
||||||
|
};
|
||||||
|
let mut guard = store().write().unwrap();
|
||||||
|
// If an entry for this call_id already exists, update it in-place
|
||||||
|
// rather than appending a duplicate. Protects against the caller
|
||||||
|
// side adding a second Missed row when the callee's DirectCallOffer
|
||||||
|
// bounces back through federation / loopback, or when some future
|
||||||
|
// relay routing edge case double-emits a signal. The dedup keeps
|
||||||
|
// history tidy and matches what the user intuitively expects (one
|
||||||
|
// history row per call, not one per signal event).
|
||||||
|
if let Some(existing) = guard.iter_mut().rev().find(|e| e.call_id == call_id) {
|
||||||
|
tracing::info!(%call_id, from = ?existing.direction, to = ?direction, "history::log replacing existing entry");
|
||||||
|
existing.direction = direction;
|
||||||
|
existing.timestamp_unix = entry.timestamp_unix;
|
||||||
|
save_to_disk(&guard);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
guard.push(entry);
|
||||||
|
if guard.len() > MAX_ENTRIES {
|
||||||
|
let drop_n = guard.len() - MAX_ENTRIES;
|
||||||
|
guard.drain(0..drop_n);
|
||||||
|
}
|
||||||
|
save_to_disk(&guard);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return a copy of all entries in reverse-chronological order
|
||||||
|
/// (most recent first).
|
||||||
|
pub fn all() -> Vec<CallHistoryEntry> {
|
||||||
|
let guard = store().read().unwrap();
|
||||||
|
guard.iter().rev().cloned().collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Unique peer contacts sorted by most recent interaction. Each contact
|
||||||
|
/// is represented by the newest history entry for that fingerprint.
|
||||||
|
pub fn contacts() -> Vec<CallHistoryEntry> {
|
||||||
|
let guard = store().read().unwrap();
|
||||||
|
let mut seen: std::collections::HashSet<String> = std::collections::HashSet::new();
|
||||||
|
let mut out = Vec::new();
|
||||||
|
// iterate newest → oldest
|
||||||
|
for entry in guard.iter().rev() {
|
||||||
|
if seen.insert(entry.peer_fp.clone()) {
|
||||||
|
out.push(entry.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Clear the entire history and persist the empty file.
|
||||||
|
pub fn clear() {
|
||||||
|
let mut guard = store().write().unwrap();
|
||||||
|
guard.clear();
|
||||||
|
save_to_disk(&guard);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Find a Missed-candidate entry that matches `call_id` and hasn't been
|
||||||
|
/// answered yet. Used by the signal loop to turn "pending incoming" into
|
||||||
|
/// "Received" when the user accepts.
|
||||||
|
pub fn mark_received_if_pending(call_id: &str) -> bool {
|
||||||
|
let mut guard = store().write().unwrap();
|
||||||
|
for entry in guard.iter_mut().rev() {
|
||||||
|
if entry.call_id == call_id && entry.direction == CallDirection::Missed {
|
||||||
|
entry.direction = CallDirection::Received;
|
||||||
|
save_to_disk(&guard);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
false
|
||||||
|
}
|
||||||
823
desktop/src-tauri/src/lib.rs
Normal file
823
desktop/src-tauri/src/lib.rs
Normal file
@@ -0,0 +1,823 @@
|
|||||||
|
// WarzonePhone Tauri backend — shared between desktop (macOS/Windows/Linux)
|
||||||
|
// and Tauri mobile (Android/iOS). Platform-specific audio is cfg-gated.
|
||||||
|
|
||||||
|
#![cfg_attr(
|
||||||
|
all(not(debug_assertions), target_os = "windows"),
|
||||||
|
windows_subsystem = "windows"
|
||||||
|
)]
|
||||||
|
|
||||||
|
// Call engine — now compiled on every platform. On desktop it runs the real
|
||||||
|
// CPAL/VPIO audio pipeline; on Android the engine calls into the standalone
|
||||||
|
// wzp-native cdylib (via the wzp_native module) for Oboe-backed audio.
|
||||||
|
mod engine;
|
||||||
|
|
||||||
|
// Android runtime binding to libwzp_native.so (Oboe audio backend, built as
|
||||||
|
// a standalone cdylib with cargo-ndk to avoid the Tauri staticlib symbol
|
||||||
|
// leak — see docs/incident-tauri-android-init-tcb.md).
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
mod wzp_native;
|
||||||
|
|
||||||
|
// Android AudioManager bridge (routing earpiece / speaker / BT).
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
mod android_audio;
|
||||||
|
|
||||||
|
// Direct-call history store (persisted JSON in app data dir).
|
||||||
|
mod history;
|
||||||
|
|
||||||
|
// CallEngine has a unified impl on both targets now — the Android branch of
|
||||||
|
// CallEngine::start() routes audio through the standalone wzp-native cdylib
|
||||||
|
// (loaded via the wzp_native module below), the desktop branch uses CPAL.
|
||||||
|
use engine::CallEngine;
|
||||||
|
|
||||||
|
use serde::Serialize;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
use std::sync::{Arc, OnceLock};
|
||||||
|
use tauri::{Emitter, Manager};
|
||||||
|
use tokio::sync::Mutex;
|
||||||
|
use wzp_proto::MediaTransport;
|
||||||
|
|
||||||
|
/// Short git hash captured at compile time by build.rs.
|
||||||
|
const GIT_HASH: &str = env!("WZP_GIT_HASH");
|
||||||
|
|
||||||
|
/// Resolved by `setup()` once we have a Tauri AppHandle. Holds the
|
||||||
|
/// platform-correct app data dir (e.g. `/data/data/com.wzp.desktop/files` on
|
||||||
|
/// Android, `~/Library/Application Support/com.wzp.desktop` on macOS).
|
||||||
|
static APP_DATA_DIR: OnceLock<PathBuf> = OnceLock::new();
|
||||||
|
|
||||||
|
/// Adjective list — keep in sync with the noun list below. Both are powers of
|
||||||
|
/// 2 friendly so the modulo bias is negligible.
|
||||||
|
const ALIAS_ADJECTIVES: &[&str] = &[
|
||||||
|
"Swift", "Silent", "Brave", "Calm", "Dark", "Fierce", "Ghost",
|
||||||
|
"Iron", "Lucky", "Noble", "Quick", "Sharp", "Storm", "Wild",
|
||||||
|
"Cold", "Bright", "Lone", "Red", "Grey", "Frosty", "Dusty",
|
||||||
|
"Rusty", "Neon", "Void", "Solar", "Lunar", "Cyber", "Pixel",
|
||||||
|
"Sonic", "Hyper", "Turbo", "Nano", "Mega", "Ultra", "Zinc",
|
||||||
|
];
|
||||||
|
const ALIAS_NOUNS: &[&str] = &[
|
||||||
|
"Wolf", "Hawk", "Fox", "Bear", "Lynx", "Crow", "Viper",
|
||||||
|
"Cobra", "Tiger", "Eagle", "Shark", "Raven", "Falcon", "Otter",
|
||||||
|
"Mantis", "Panda", "Jackal", "Badger", "Heron", "Bison",
|
||||||
|
"Condor", "Coyote", "Gecko", "Hornet", "Marten", "Osprey",
|
||||||
|
"Parrot", "Puma", "Raptor", "Stork", "Toucan", "Walrus",
|
||||||
|
];
|
||||||
|
|
||||||
|
/// Derive a stable human-readable alias from the seed bytes. Same seed →
|
||||||
|
/// same alias forever, different seeds → effectively random aliases.
|
||||||
|
fn derive_alias(seed: &wzp_crypto::Seed) -> String {
|
||||||
|
let adj_idx = (u16::from_le_bytes([seed.0[0], seed.0[1]]) as usize) % ALIAS_ADJECTIVES.len();
|
||||||
|
let noun_idx = (u16::from_le_bytes([seed.0[2], seed.0[3]]) as usize) % ALIAS_NOUNS.len();
|
||||||
|
format!("{} {}", ALIAS_ADJECTIVES[adj_idx], ALIAS_NOUNS[noun_idx])
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Serialize)]
|
||||||
|
struct CallEvent {
|
||||||
|
kind: String,
|
||||||
|
message: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Serialize)]
|
||||||
|
struct Participant {
|
||||||
|
fingerprint: String,
|
||||||
|
alias: Option<String>,
|
||||||
|
relay_label: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Serialize)]
|
||||||
|
struct CallStatus {
|
||||||
|
active: bool,
|
||||||
|
mic_muted: bool,
|
||||||
|
spk_muted: bool,
|
||||||
|
participants: Vec<Participant>,
|
||||||
|
encode_fps: u64,
|
||||||
|
recv_fps: u64,
|
||||||
|
audio_level: u32,
|
||||||
|
call_duration_secs: f64,
|
||||||
|
fingerprint: String,
|
||||||
|
tx_codec: String,
|
||||||
|
rx_codec: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
struct AppState {
|
||||||
|
engine: Mutex<Option<CallEngine>>,
|
||||||
|
signal: Arc<Mutex<SignalState>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Ping result with RTT and server identity hash.
|
||||||
|
#[derive(Clone, Serialize)]
|
||||||
|
struct PingResult {
|
||||||
|
rtt_ms: u32,
|
||||||
|
/// Server identity: SHA-256 of the QUIC peer certificate, hex-encoded.
|
||||||
|
server_fingerprint: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Toggle DRED verbose logging at runtime (gates the chatty per-frame
|
||||||
|
/// reconstruction + parse logs in opus_enc and engine.rs). Wired to the
|
||||||
|
/// "DRED debug logs" checkbox in the GUI settings panel.
|
||||||
|
#[tauri::command]
|
||||||
|
fn set_dred_verbose_logs(enabled: bool) {
|
||||||
|
wzp_codec::set_dred_verbose_logs(enabled);
|
||||||
|
tracing::info!(enabled, "DRED verbose logs toggled");
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read the current DRED verbose logging flag (so the GUI can hydrate
|
||||||
|
/// its checkbox on startup without trusting localStorage alone).
|
||||||
|
#[tauri::command]
|
||||||
|
fn get_dred_verbose_logs() -> bool {
|
||||||
|
wzp_codec::dred_verbose_logs()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Ping a relay to check if it's online, measure RTT, and get server identity.
|
||||||
|
#[tauri::command]
|
||||||
|
async fn ping_relay(relay: String) -> Result<PingResult, String> {
|
||||||
|
let addr: std::net::SocketAddr = relay.parse().map_err(|e| format!("bad address: {e}"))?;
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
let bind: std::net::SocketAddr = "0.0.0.0:0".parse().unwrap();
|
||||||
|
let endpoint = wzp_transport::create_endpoint(bind, None).map_err(|e| format!("{e}"))?;
|
||||||
|
let client_cfg = wzp_transport::client_config();
|
||||||
|
|
||||||
|
let start = std::time::Instant::now();
|
||||||
|
let conn_result = tokio::time::timeout(
|
||||||
|
std::time::Duration::from_secs(3),
|
||||||
|
wzp_transport::connect(&endpoint, addr, "ping", client_cfg),
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
// Always close endpoint to prevent resource leaks
|
||||||
|
endpoint.close(0u32.into(), b"done");
|
||||||
|
|
||||||
|
match conn_result {
|
||||||
|
Ok(Ok(conn)) => {
|
||||||
|
let rtt_ms = start.elapsed().as_millis() as u32;
|
||||||
|
|
||||||
|
let server_fingerprint = conn
|
||||||
|
.peer_identity()
|
||||||
|
.and_then(|id| id.downcast::<Vec<rustls::pki_types::CertificateDer>>().ok())
|
||||||
|
.and_then(|certs| certs.first().map(|c| {
|
||||||
|
use std::hash::{Hash, Hasher};
|
||||||
|
let mut hasher = std::collections::hash_map::DefaultHasher::new();
|
||||||
|
c.as_ref().hash(&mut hasher);
|
||||||
|
let h = hasher.finish();
|
||||||
|
format!("{h:016x}")
|
||||||
|
}))
|
||||||
|
.unwrap_or_else(|| {
|
||||||
|
format!("{:x}", addr.ip().to_string().len() as u64 * 0x9e3779b97f4a7c15 + addr.port() as u64)
|
||||||
|
});
|
||||||
|
|
||||||
|
conn.close(0u32.into(), b"ping");
|
||||||
|
Ok(PingResult { rtt_ms, server_fingerprint })
|
||||||
|
}
|
||||||
|
Ok(Err(e)) => Err(format!("{e}")),
|
||||||
|
Err(_) => Err("timeout (3s)".into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return the directory where identity/config should live.
|
||||||
|
///
|
||||||
|
/// Resolved at startup from Tauri's `path().app_data_dir()` API which gives
|
||||||
|
/// us the platform-correct app-private location:
|
||||||
|
/// - Android: `/data/data/<package_id>/files/com.wzp.desktop`
|
||||||
|
/// - macOS: `~/Library/Application Support/com.wzp.desktop`
|
||||||
|
/// - Linux: `~/.local/share/com.wzp.desktop`
|
||||||
|
///
|
||||||
|
/// Falls back to `$HOME/.wzp` on the desktop side if the OnceLock hasn't been
|
||||||
|
/// initialised yet (shouldn't happen in normal startup, but keeps the fn
|
||||||
|
/// total).
|
||||||
|
fn identity_dir() -> PathBuf {
|
||||||
|
if let Some(dir) = APP_DATA_DIR.get() {
|
||||||
|
return dir.clone();
|
||||||
|
}
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
{
|
||||||
|
// Last-resort default. The real path is set in setup() below.
|
||||||
|
std::path::PathBuf::from("/data/data/com.wzp.desktop/files")
|
||||||
|
}
|
||||||
|
#[cfg(not(target_os = "android"))]
|
||||||
|
{
|
||||||
|
let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
|
||||||
|
std::path::PathBuf::from(home).join(".wzp")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn identity_path() -> std::path::PathBuf {
|
||||||
|
identity_dir().join("identity")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Load the persisted seed, or generate-and-persist a new one if missing.
|
||||||
|
fn load_or_create_seed() -> Result<wzp_crypto::Seed, String> {
|
||||||
|
let path = identity_path();
|
||||||
|
if path.exists() {
|
||||||
|
let hex = std::fs::read_to_string(&path).map_err(|e| format!("read identity: {e}"))?;
|
||||||
|
return wzp_crypto::Seed::from_hex(hex.trim()).map_err(|e| format!("{e}"));
|
||||||
|
}
|
||||||
|
let seed = wzp_crypto::Seed::generate();
|
||||||
|
if let Some(parent) = path.parent() {
|
||||||
|
std::fs::create_dir_all(parent).map_err(|e| format!("create identity dir: {e}"))?;
|
||||||
|
}
|
||||||
|
let hex: String = seed.0.iter().map(|b| format!("{b:02x}")).collect();
|
||||||
|
std::fs::write(&path, hex).map_err(|e| format!("write identity: {e}"))?;
|
||||||
|
Ok(seed)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read fingerprint, generating a fresh identity if none exists yet.
|
||||||
|
#[tauri::command]
|
||||||
|
fn get_identity() -> Result<String, String> {
|
||||||
|
let seed = load_or_create_seed()?;
|
||||||
|
Ok(seed.derive_identity().public_identity().fingerprint.to_string())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Build/identity info shown on the home screen so the user can prove which
|
||||||
|
/// build is installed and what their stable alias is.
|
||||||
|
#[derive(Clone, Serialize)]
|
||||||
|
struct AppInfo {
|
||||||
|
/// Short git commit hash captured at build time.
|
||||||
|
git_hash: &'static str,
|
||||||
|
/// Stable adjective+noun derived from the seed.
|
||||||
|
alias: String,
|
||||||
|
/// Full fingerprint, e.g. "abcd:ef01:..."
|
||||||
|
fingerprint: String,
|
||||||
|
/// App data dir actually in use — useful for debugging EACCES issues.
|
||||||
|
data_dir: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn get_app_info() -> Result<AppInfo, String> {
|
||||||
|
let seed = load_or_create_seed()?;
|
||||||
|
let pub_id = seed.derive_identity().public_identity();
|
||||||
|
Ok(AppInfo {
|
||||||
|
git_hash: GIT_HASH,
|
||||||
|
alias: derive_alias(&seed),
|
||||||
|
fingerprint: pub_id.fingerprint.to_string(),
|
||||||
|
data_dir: identity_dir().to_string_lossy().into_owned(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn connect(
|
||||||
|
state: tauri::State<'_, Arc<AppState>>,
|
||||||
|
app: tauri::AppHandle,
|
||||||
|
relay: String,
|
||||||
|
room: String,
|
||||||
|
alias: String,
|
||||||
|
os_aec: bool,
|
||||||
|
quality: String,
|
||||||
|
) -> Result<String, String> {
|
||||||
|
let mut engine_lock = state.engine.lock().await;
|
||||||
|
if engine_lock.is_some() {
|
||||||
|
return Err("already connected".into());
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we previously opened a quinn::Endpoint for the signaling connection
|
||||||
|
// (direct-call path), reuse it so the media connection shares the same
|
||||||
|
// UDP socket. This side-steps the Android issue where a second
|
||||||
|
// quinn::Endpoint silently hangs in the QUIC handshake.
|
||||||
|
let reuse_endpoint = state.signal.lock().await.endpoint.clone();
|
||||||
|
if reuse_endpoint.is_some() {
|
||||||
|
tracing::info!("connect: reusing existing signal endpoint for media connection");
|
||||||
|
}
|
||||||
|
|
||||||
|
let app_clone = app.clone();
|
||||||
|
match CallEngine::start(relay, room, alias, os_aec, quality, reuse_endpoint, move |event_kind, message| {
|
||||||
|
let _ = app_clone.emit(
|
||||||
|
"call-event",
|
||||||
|
CallEvent {
|
||||||
|
kind: event_kind.to_string(),
|
||||||
|
message: message.to_string(),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
Ok(eng) => {
|
||||||
|
*engine_lock = Some(eng);
|
||||||
|
Ok("connected".into())
|
||||||
|
}
|
||||||
|
Err(e) => Err(format!("{e}")),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn disconnect(state: tauri::State<'_, Arc<AppState>>) -> Result<String, String> {
|
||||||
|
let mut engine_lock = state.engine.lock().await;
|
||||||
|
if let Some(engine) = engine_lock.take() {
|
||||||
|
engine.stop().await;
|
||||||
|
Ok("disconnected".into())
|
||||||
|
} else {
|
||||||
|
Err("not connected".into())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn toggle_mic(state: tauri::State<'_, Arc<AppState>>) -> Result<bool, String> {
|
||||||
|
let engine_lock = state.engine.lock().await;
|
||||||
|
if let Some(ref engine) = *engine_lock {
|
||||||
|
Ok(engine.toggle_mic())
|
||||||
|
} else {
|
||||||
|
Err("not connected".into())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn toggle_speaker(state: tauri::State<'_, Arc<AppState>>) -> Result<bool, String> {
|
||||||
|
let engine_lock = state.engine.lock().await;
|
||||||
|
if let Some(ref engine) = *engine_lock {
|
||||||
|
Ok(engine.toggle_speaker())
|
||||||
|
} else {
|
||||||
|
Err("not connected".into())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn get_status(state: tauri::State<'_, Arc<AppState>>) -> Result<CallStatus, String> {
|
||||||
|
let engine_lock = state.engine.lock().await;
|
||||||
|
if let Some(ref engine) = *engine_lock {
|
||||||
|
let status = engine.status().await;
|
||||||
|
Ok(CallStatus {
|
||||||
|
active: true,
|
||||||
|
mic_muted: status.mic_muted,
|
||||||
|
spk_muted: status.spk_muted,
|
||||||
|
participants: status
|
||||||
|
.participants
|
||||||
|
.into_iter()
|
||||||
|
.map(|p| Participant {
|
||||||
|
fingerprint: p.fingerprint,
|
||||||
|
alias: p.alias,
|
||||||
|
relay_label: p.relay_label,
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
encode_fps: status.frames_sent,
|
||||||
|
recv_fps: status.frames_received,
|
||||||
|
audio_level: status.audio_level,
|
||||||
|
call_duration_secs: status.call_duration_secs,
|
||||||
|
fingerprint: status.fingerprint,
|
||||||
|
tx_codec: status.tx_codec,
|
||||||
|
rx_codec: status.rx_codec,
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
Ok(CallStatus {
|
||||||
|
active: false,
|
||||||
|
mic_muted: false,
|
||||||
|
spk_muted: false,
|
||||||
|
participants: vec![],
|
||||||
|
encode_fps: 0,
|
||||||
|
recv_fps: 0,
|
||||||
|
audio_level: 0,
|
||||||
|
call_duration_secs: 0.0,
|
||||||
|
fingerprint: String::new(),
|
||||||
|
tx_codec: String::new(),
|
||||||
|
rx_codec: String::new(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Audio routing (Android-specific, no-op on desktop) ─────────────────────
|
||||||
|
|
||||||
|
/// Switch the call audio between earpiece (`on=false`) and loudspeaker
|
||||||
|
/// (`on=true`). On Android this calls AudioManager.setSpeakerphoneOn via
|
||||||
|
/// JNI AND then stops and restarts the Oboe streams so AAudio reconfigures
|
||||||
|
/// with the new routing — without the restart, changing the speakerphone
|
||||||
|
/// state mid-call silently tears down the running AAudio streams on some
|
||||||
|
/// OEMs and both capture + playout stop producing data.
|
||||||
|
///
|
||||||
|
/// The Rust send/recv tokio tasks keep running during the ~60ms restart
|
||||||
|
/// window; they just observe empty reads / writes against the
|
||||||
|
/// process-global ring buffers, which is fine because the ring state
|
||||||
|
/// is preserved across stop+start.
|
||||||
|
#[tauri::command]
|
||||||
|
#[allow(unused_variables)]
|
||||||
|
async fn set_speakerphone(on: bool) -> Result<(), String> {
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
{
|
||||||
|
android_audio::set_speakerphone(on)?;
|
||||||
|
if wzp_native::is_loaded() && wzp_native::audio_is_running() {
|
||||||
|
tracing::info!(on, "set_speakerphone: restarting Oboe for route change");
|
||||||
|
// Oboe's stop/start are sync C-FFI calls that block for ~400ms
|
||||||
|
// on Nothing-class devices (Pixel is faster). Calling them
|
||||||
|
// directly from an async Tauri command stalls the tokio
|
||||||
|
// executor — the send/recv engine tasks were observed to
|
||||||
|
// freeze for ~20 seconds across a few rapid speaker toggles,
|
||||||
|
// piling up buffered QUIC datagrams and then flooding them
|
||||||
|
// all at once when the runtime finally caught up.
|
||||||
|
//
|
||||||
|
// Fix: run the audio teardown + reopen on a dedicated
|
||||||
|
// blocking thread so the runtime keeps scheduling everything
|
||||||
|
// else. AAudio's requestStop returns only after the stream
|
||||||
|
// is actually in Stopped state, so no explicit inter-call
|
||||||
|
// sleep is needed.
|
||||||
|
tokio::task::spawn_blocking(|| {
|
||||||
|
wzp_native::audio_stop();
|
||||||
|
wzp_native::audio_start()
|
||||||
|
.map_err(|code| format!("audio_start after speakerphone toggle: code {code}"))
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
.map_err(|e| format!("spawn_blocking join: {e}"))??;
|
||||||
|
tracing::info!("set_speakerphone: Oboe restarted");
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
#[cfg(not(target_os = "android"))]
|
||||||
|
{
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Query whether the call is currently routed to the loudspeaker.
|
||||||
|
#[tauri::command]
|
||||||
|
async fn is_speakerphone_on() -> Result<bool, String> {
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
{
|
||||||
|
android_audio::is_speakerphone_on()
|
||||||
|
}
|
||||||
|
#[cfg(not(target_os = "android"))]
|
||||||
|
{
|
||||||
|
Ok(false)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Call history commands ───────────────────────────────────────────────────
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn get_call_history() -> Vec<history::CallHistoryEntry> {
|
||||||
|
history::all()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn get_recent_contacts() -> Vec<history::CallHistoryEntry> {
|
||||||
|
history::contacts()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn clear_call_history() -> Result<(), String> {
|
||||||
|
history::clear();
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Signaling commands — platform independent ───────────────────────────────
|
||||||
|
|
||||||
|
struct SignalState {
|
||||||
|
transport: Option<Arc<wzp_transport::QuinnTransport>>,
|
||||||
|
/// The quinn::Endpoint backing the signal connection. Reused for the
|
||||||
|
/// media connection when a direct call is accepted — Android phones
|
||||||
|
/// silently drop packets from a second quinn::Endpoint to the same
|
||||||
|
/// relay, so every call after register_signal MUST share this socket.
|
||||||
|
endpoint: Option<wzp_transport::Endpoint>,
|
||||||
|
fingerprint: String,
|
||||||
|
signal_status: String,
|
||||||
|
incoming_call_id: Option<String>,
|
||||||
|
incoming_caller_fp: Option<String>,
|
||||||
|
incoming_caller_alias: Option<String>,
|
||||||
|
/// Pending `ReflectResponse` channel. When the `get_reflected_address`
|
||||||
|
/// Tauri command fires, it drops a `oneshot::Sender<SocketAddr>` here
|
||||||
|
/// before sending a `SignalMessage::Reflect`. The spawned recv loop
|
||||||
|
/// picks the response off the next bi-stream and fires the sender.
|
||||||
|
/// If another Reflect request comes in while one is pending, we
|
||||||
|
/// replace the sender — the old receiver sees a `Cancelled` error
|
||||||
|
/// and the caller retries.
|
||||||
|
pending_reflect: Option<tokio::sync::oneshot::Sender<std::net::SocketAddr>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn register_signal(
|
||||||
|
state: tauri::State<'_, Arc<AppState>>,
|
||||||
|
app: tauri::AppHandle,
|
||||||
|
relay: String,
|
||||||
|
) -> Result<String, String> {
|
||||||
|
use wzp_proto::SignalMessage;
|
||||||
|
|
||||||
|
let addr: std::net::SocketAddr = relay.parse().map_err(|e| format!("bad address: {e}"))?;
|
||||||
|
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||||
|
|
||||||
|
// Load or create seed automatically — no need to "connect to a room first"
|
||||||
|
let seed = load_or_create_seed()?;
|
||||||
|
let pub_id = seed.derive_identity().public_identity();
|
||||||
|
let fp = pub_id.fingerprint.to_string();
|
||||||
|
let identity_pub = *pub_id.signing.as_bytes();
|
||||||
|
|
||||||
|
let bind: std::net::SocketAddr = "0.0.0.0:0".parse().unwrap();
|
||||||
|
let endpoint = wzp_transport::create_endpoint(bind, None).map_err(|e| format!("{e}"))?;
|
||||||
|
let conn = wzp_transport::connect(&endpoint, addr, "_signal", wzp_transport::client_config())
|
||||||
|
.await.map_err(|e| format!("{e}"))?;
|
||||||
|
let transport = Arc::new(wzp_transport::QuinnTransport::new(conn));
|
||||||
|
|
||||||
|
transport.send_signal(&SignalMessage::RegisterPresence {
|
||||||
|
identity_pub, signature: vec![], alias: None,
|
||||||
|
}).await.map_err(|e| format!("{e}"))?;
|
||||||
|
|
||||||
|
match transport.recv_signal().await.map_err(|e| format!("{e}"))? {
|
||||||
|
Some(SignalMessage::RegisterPresenceAck { success: true, .. }) => {}
|
||||||
|
_ => return Err("registration failed".into()),
|
||||||
|
}
|
||||||
|
|
||||||
|
{ let mut sig = state.signal.lock().await; sig.transport = Some(transport.clone()); sig.endpoint = Some(endpoint.clone()); sig.fingerprint = fp.clone(); sig.signal_status = "registered".into(); }
|
||||||
|
|
||||||
|
tracing::info!(%fp, "signal registered, spawning recv loop");
|
||||||
|
let signal_state = Arc::clone(&state.signal);
|
||||||
|
let app_clone = app.clone();
|
||||||
|
tokio::spawn(async move {
|
||||||
|
loop {
|
||||||
|
match transport.recv_signal().await {
|
||||||
|
Ok(Some(SignalMessage::CallRinging { call_id })) => {
|
||||||
|
tracing::info!(%call_id, "signal: CallRinging");
|
||||||
|
let mut sig = signal_state.lock().await; sig.signal_status = "ringing".into();
|
||||||
|
let _ = app_clone.emit("signal-event", serde_json::json!({"type":"ringing","call_id":call_id}));
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::DirectCallOffer { caller_fingerprint, caller_alias, call_id, .. })) => {
|
||||||
|
tracing::info!(%call_id, caller = %caller_fingerprint, "signal: DirectCallOffer");
|
||||||
|
let mut sig = signal_state.lock().await; sig.signal_status = "incoming".into();
|
||||||
|
sig.incoming_call_id = Some(call_id.clone()); sig.incoming_caller_fp = Some(caller_fingerprint.clone()); sig.incoming_caller_alias = caller_alias.clone();
|
||||||
|
// Log as a Missed entry up-front. If the user accepts
|
||||||
|
// the call, answer_call upgrades it to Received via
|
||||||
|
// history::mark_received_if_pending(call_id). If they
|
||||||
|
// reject or ignore, it stays Missed.
|
||||||
|
history::log(
|
||||||
|
call_id.clone(),
|
||||||
|
caller_fingerprint.clone(),
|
||||||
|
caller_alias.clone(),
|
||||||
|
history::CallDirection::Missed,
|
||||||
|
);
|
||||||
|
let _ = app_clone.emit("signal-event", serde_json::json!({"type":"incoming","call_id":call_id,"caller_fp":caller_fingerprint,"caller_alias":caller_alias}));
|
||||||
|
let _ = app_clone.emit("history-changed", ());
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::DirectCallAnswer { call_id, accept_mode, .. })) => {
|
||||||
|
tracing::info!(%call_id, ?accept_mode, "signal: DirectCallAnswer (forwarded by relay)");
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::CallSetup { call_id, room, relay_addr })) => {
|
||||||
|
tracing::info!(%call_id, %room, %relay_addr, "signal: CallSetup — emitting setup event to JS");
|
||||||
|
let mut sig = signal_state.lock().await; sig.signal_status = "setup".into();
|
||||||
|
let _ = app_clone.emit("signal-event", serde_json::json!({"type":"setup","call_id":call_id,"room":room,"relay_addr":relay_addr}));
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::Hangup { reason })) => {
|
||||||
|
tracing::info!(?reason, "signal: Hangup");
|
||||||
|
let mut sig = signal_state.lock().await; sig.signal_status = "registered".into(); sig.incoming_call_id = None;
|
||||||
|
let _ = app_clone.emit("signal-event", serde_json::json!({"type":"hangup"}));
|
||||||
|
}
|
||||||
|
Ok(Some(SignalMessage::ReflectResponse { observed_addr })) => {
|
||||||
|
// "STUN for QUIC" response — the relay told us our
|
||||||
|
// own server-reflexive address. If a Tauri command
|
||||||
|
// is currently awaiting this, fire the oneshot;
|
||||||
|
// otherwise log and drop (unsolicited responses
|
||||||
|
// from a confused relay shouldn't crash the loop).
|
||||||
|
tracing::info!(%observed_addr, "signal: ReflectResponse");
|
||||||
|
match observed_addr.parse::<std::net::SocketAddr>() {
|
||||||
|
Ok(parsed) => {
|
||||||
|
let mut sig = signal_state.lock().await;
|
||||||
|
if let Some(tx) = sig.pending_reflect.take() {
|
||||||
|
// `send` returns Err(addr) only if the
|
||||||
|
// receiver was dropped (caller timed out
|
||||||
|
// or canceled). Either way, nothing to
|
||||||
|
// do — the value is gone.
|
||||||
|
let _ = tx.send(parsed);
|
||||||
|
} else {
|
||||||
|
tracing::debug!(%observed_addr, "reflect: unsolicited response (no pending sender)");
|
||||||
|
}
|
||||||
|
let _ = app_clone.emit(
|
||||||
|
"signal-event",
|
||||||
|
serde_json::json!({"type":"reflect","observed_addr":observed_addr}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(%observed_addr, error = %e, "reflect: relay returned unparseable addr");
|
||||||
|
// Treat unparseable response as a failed
|
||||||
|
// request so the caller doesn't hang.
|
||||||
|
let mut sig = signal_state.lock().await;
|
||||||
|
let _ = sig.pending_reflect.take();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(Some(other)) => {
|
||||||
|
tracing::debug!(?other, "signal: unhandled message");
|
||||||
|
}
|
||||||
|
Ok(None) => {
|
||||||
|
tracing::warn!("signal recv returned None — peer closed");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(error = %e, "signal recv error — breaking loop");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
tracing::warn!("signal recv loop exited — signal_status=idle, transport dropped");
|
||||||
|
let mut sig = signal_state.lock().await; sig.signal_status = "idle".into(); sig.transport = None;
|
||||||
|
});
|
||||||
|
Ok(fp)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn place_call(
|
||||||
|
state: tauri::State<'_, Arc<AppState>>,
|
||||||
|
app: tauri::AppHandle,
|
||||||
|
target_fp: String,
|
||||||
|
) -> Result<(), String> {
|
||||||
|
use wzp_proto::SignalMessage;
|
||||||
|
let sig = state.signal.lock().await;
|
||||||
|
let transport = sig.transport.as_ref().ok_or("not registered")?;
|
||||||
|
let call_id = format!("{:016x}", std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_nanos());
|
||||||
|
tracing::info!(%call_id, %target_fp, "place_call: sending DirectCallOffer");
|
||||||
|
transport.send_signal(&SignalMessage::DirectCallOffer {
|
||||||
|
caller_fingerprint: sig.fingerprint.clone(), caller_alias: None, target_fingerprint: target_fp.clone(),
|
||||||
|
call_id: call_id.clone(), identity_pub: [0u8; 32], ephemeral_pub: [0u8; 32], signature: vec![],
|
||||||
|
supported_profiles: vec![wzp_proto::QualityProfile::GOOD],
|
||||||
|
}).await.map_err(|e| format!("{e}"))?;
|
||||||
|
history::log(call_id, target_fp, None, history::CallDirection::Placed);
|
||||||
|
let _ = app.emit("history-changed", ());
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn answer_call(
|
||||||
|
state: tauri::State<'_, Arc<AppState>>,
|
||||||
|
app: tauri::AppHandle,
|
||||||
|
call_id: String,
|
||||||
|
mode: i32,
|
||||||
|
) -> Result<(), String> {
|
||||||
|
use wzp_proto::SignalMessage;
|
||||||
|
let sig = state.signal.lock().await;
|
||||||
|
let transport = sig.transport.as_ref().ok_or_else(|| {
|
||||||
|
tracing::warn!("answer_call: not registered (no transport)");
|
||||||
|
"not registered".to_string()
|
||||||
|
})?;
|
||||||
|
let accept_mode = match mode { 0 => wzp_proto::CallAcceptMode::Reject, 1 => wzp_proto::CallAcceptMode::AcceptTrusted, _ => wzp_proto::CallAcceptMode::AcceptGeneric };
|
||||||
|
tracing::info!(%call_id, ?accept_mode, "answer_call: sending DirectCallAnswer");
|
||||||
|
transport.send_signal(&SignalMessage::DirectCallAnswer {
|
||||||
|
call_id: call_id.clone(), accept_mode, identity_pub: None, ephemeral_pub: None, signature: None,
|
||||||
|
chosen_profile: Some(wzp_proto::QualityProfile::GOOD),
|
||||||
|
}).await.map_err(|e| {
|
||||||
|
tracing::error!(%call_id, error = %e, "answer_call: send_signal failed");
|
||||||
|
format!("{e}")
|
||||||
|
})?;
|
||||||
|
tracing::info!(%call_id, "answer_call: DirectCallAnswer sent successfully");
|
||||||
|
// Upgrade the pending "Missed" entry to "Received" if the user
|
||||||
|
// accepted (mode != Reject). Mode 0 = Reject → leave as Missed.
|
||||||
|
if mode != 0 {
|
||||||
|
if history::mark_received_if_pending(&call_id) {
|
||||||
|
let _ = app.emit("history-changed", ());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// "STUN for QUIC" — ask the relay what our own public address looks
|
||||||
|
/// like from its side of the TLS-authenticated signal connection.
|
||||||
|
///
|
||||||
|
/// Wire flow:
|
||||||
|
/// 1. We install a `oneshot::Sender` in `SignalState.pending_reflect`
|
||||||
|
/// (replacing any stale one — last request wins).
|
||||||
|
/// 2. We release the state lock and send `SignalMessage::Reflect`
|
||||||
|
/// over the existing transport. The relay opens a fresh bi-stream
|
||||||
|
/// on its side to respond, which the spawned recv loop picks up.
|
||||||
|
/// 3. The recv loop's `ReflectResponse` match arm takes the sender
|
||||||
|
/// back out and fires it with the parsed `SocketAddr`.
|
||||||
|
/// 4. We await the receiver with a 1s timeout so a non-reflecting
|
||||||
|
/// relay (pre-Phase-1 build) doesn't hang the UI forever.
|
||||||
|
///
|
||||||
|
/// Returns the addr as a string so it can cross the Tauri IPC
|
||||||
|
/// boundary unchanged — JS-side can display it directly or parse it
|
||||||
|
/// with `new URL(...)` / a regex if needed.
|
||||||
|
#[tauri::command]
|
||||||
|
async fn get_reflected_address(
|
||||||
|
state: tauri::State<'_, Arc<AppState>>,
|
||||||
|
) -> Result<String, String> {
|
||||||
|
use wzp_proto::SignalMessage;
|
||||||
|
let (tx, rx) = tokio::sync::oneshot::channel::<std::net::SocketAddr>();
|
||||||
|
let transport = {
|
||||||
|
let mut sig = state.signal.lock().await;
|
||||||
|
// Drop any older pending sender — we don't support more than
|
||||||
|
// one in-flight Reflect per connection. A prior request whose
|
||||||
|
// receiver has timed out will be cleaned up here automatically.
|
||||||
|
sig.pending_reflect = Some(tx);
|
||||||
|
sig.transport
|
||||||
|
.as_ref()
|
||||||
|
.ok_or_else(|| "not registered".to_string())?
|
||||||
|
.clone()
|
||||||
|
};
|
||||||
|
if let Err(e) = transport.send_signal(&SignalMessage::Reflect).await {
|
||||||
|
// Clean up the pending sender so the next attempt doesn't see
|
||||||
|
// a stale channel. Re-acquire the lock inline since we already
|
||||||
|
// released it above to release `transport` back to the caller.
|
||||||
|
let mut sig = state.signal.lock().await;
|
||||||
|
sig.pending_reflect = None;
|
||||||
|
return Err(format!("send Reflect: {e}"));
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1s is plenty for a same-datacenter relay (< 50ms RTT) and also
|
||||||
|
// the ceiling for "something's wrong, tell the user" — any older
|
||||||
|
// relay will never reply at all. 1100ms in the integration test.
|
||||||
|
match tokio::time::timeout(std::time::Duration::from_millis(1000), rx).await {
|
||||||
|
Ok(Ok(addr)) => Ok(addr.to_string()),
|
||||||
|
Ok(Err(_canceled)) => {
|
||||||
|
// The recv loop dropped the sender (relay returned
|
||||||
|
// unparseable addr, or loop exited mid-request).
|
||||||
|
Err("reflect channel canceled (signal loop exited or parse error)".into())
|
||||||
|
}
|
||||||
|
Err(_elapsed) => {
|
||||||
|
// Timeout — strip the pending sender so the next attempt
|
||||||
|
// starts clean. Old (pre-Phase-1) relays will land here.
|
||||||
|
let mut sig = state.signal.lock().await;
|
||||||
|
sig.pending_reflect = None;
|
||||||
|
Err("reflect timeout (relay may not support reflection)".into())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn get_signal_status(state: tauri::State<'_, Arc<AppState>>) -> Result<serde_json::Value, String> {
|
||||||
|
let sig = state.signal.lock().await;
|
||||||
|
Ok(serde_json::json!({"status":sig.signal_status,"fingerprint":sig.fingerprint,"incoming_call_id":sig.incoming_call_id,"incoming_caller_fp":sig.incoming_caller_fp}))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Tear down the signal connection so the user goes back to idle. Called
|
||||||
|
/// when the user clicks "Deregister" on the direct-call screen. The
|
||||||
|
/// spawned recv loop will break out naturally when the transport closes.
|
||||||
|
#[tauri::command]
|
||||||
|
async fn deregister(state: tauri::State<'_, Arc<AppState>>) -> Result<(), String> {
|
||||||
|
let mut sig = state.signal.lock().await;
|
||||||
|
if let Some(transport) = sig.transport.take() {
|
||||||
|
tracing::info!("deregister: closing signal transport");
|
||||||
|
transport.close().await.ok();
|
||||||
|
}
|
||||||
|
sig.endpoint = None;
|
||||||
|
sig.signal_status = "idle".into();
|
||||||
|
sig.incoming_call_id = None;
|
||||||
|
sig.incoming_caller_fp = None;
|
||||||
|
sig.incoming_caller_alias = None;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── App entry point ─────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Shared Tauri app builder. Used by the desktop `main.rs` and the mobile
|
||||||
|
/// entry point below.
|
||||||
|
pub fn run() {
|
||||||
|
tracing_subscriber::fmt().init();
|
||||||
|
|
||||||
|
let state = Arc::new(AppState {
|
||||||
|
engine: Mutex::new(None),
|
||||||
|
signal: Arc::new(Mutex::new(SignalState {
|
||||||
|
transport: None, endpoint: None, fingerprint: String::new(), signal_status: "idle".into(),
|
||||||
|
incoming_call_id: None, incoming_caller_fp: None, incoming_caller_alias: None,
|
||||||
|
pending_reflect: None,
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
|
||||||
|
tauri::Builder::default()
|
||||||
|
.plugin(tauri_plugin_shell::init())
|
||||||
|
.manage(state)
|
||||||
|
.setup(|app| {
|
||||||
|
// Resolve the platform-correct app data dir once at startup so
|
||||||
|
// every command can read/write the seed without juggling AppHandle.
|
||||||
|
let data_dir = app
|
||||||
|
.path()
|
||||||
|
.app_data_dir()
|
||||||
|
.map(|p| p.join(".wzp"))
|
||||||
|
.unwrap_or_else(|_| identity_dir());
|
||||||
|
// create_dir_all is a no-op if it already exists.
|
||||||
|
if let Err(e) = std::fs::create_dir_all(&data_dir) {
|
||||||
|
tracing::warn!("failed to create app data dir {data_dir:?}: {e}");
|
||||||
|
}
|
||||||
|
tracing::info!("app data dir: {data_dir:?}");
|
||||||
|
let _ = APP_DATA_DIR.set(data_dir);
|
||||||
|
|
||||||
|
// Load the standalone wzp-native cdylib (Oboe audio bridge) and
|
||||||
|
// cache its exported function pointers. The library handle is
|
||||||
|
// kept alive in a 'static OnceLock for the lifetime of the
|
||||||
|
// process, so CallEngine::start() can invoke its audio FFI
|
||||||
|
// from anywhere. See src/wzp_native.rs and the incident report
|
||||||
|
// in docs/incident-tauri-android-init-tcb.md.
|
||||||
|
#[cfg(target_os = "android")]
|
||||||
|
{
|
||||||
|
match wzp_native::init() {
|
||||||
|
Ok(()) => {
|
||||||
|
tracing::info!(
|
||||||
|
"wzp-native loaded: version={} msg=\"{}\"",
|
||||||
|
wzp_native::version(),
|
||||||
|
wzp_native::hello()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!("wzp-native init failed: {e}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
})
|
||||||
|
.invoke_handler(tauri::generate_handler![
|
||||||
|
ping_relay, get_identity, get_app_info,
|
||||||
|
connect, disconnect, toggle_mic, toggle_speaker, get_status,
|
||||||
|
register_signal, place_call, answer_call, get_signal_status,
|
||||||
|
get_reflected_address,
|
||||||
|
deregister,
|
||||||
|
set_speakerphone, is_speakerphone_on,
|
||||||
|
get_call_history, get_recent_contacts, clear_call_history,
|
||||||
|
set_dred_verbose_logs, get_dred_verbose_logs,
|
||||||
|
])
|
||||||
|
.run(tauri::generate_context!())
|
||||||
|
.expect("error while running WarzonePhone");
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Tauri mobile entry point (Android/iOS). On desktop this is a no-op —
|
||||||
|
/// `main.rs` calls `run()` directly.
|
||||||
|
#[cfg_attr(mobile, tauri::mobile_entry_point)]
|
||||||
|
pub fn mobile_entry() {
|
||||||
|
run();
|
||||||
|
}
|
||||||
10
desktop/src-tauri/src/main.rs
Normal file
10
desktop/src-tauri/src/main.rs
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
// Desktop binary entry point. All logic lives in `lib.rs` so the same
|
||||||
|
// code can be built as a cdylib for Android/iOS via `cargo tauri android build`.
|
||||||
|
#![cfg_attr(
|
||||||
|
all(not(debug_assertions), target_os = "windows"),
|
||||||
|
windows_subsystem = "windows"
|
||||||
|
)]
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
wzp_desktop_lib::run();
|
||||||
|
}
|
||||||
138
desktop/src-tauri/src/wzp_native.rs
Normal file
138
desktop/src-tauri/src/wzp_native.rs
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
//! Runtime binding to the standalone `wzp-native` cdylib.
|
||||||
|
//!
|
||||||
|
//! See `docs/incident-tauri-android-init-tcb.md` and the top of
|
||||||
|
//! `crates/wzp-native/src/lib.rs` for the full story on why this split
|
||||||
|
//! exists. Short version: Tauri's desktop cdylib cannot have any C++
|
||||||
|
//! compiled into it (via cc::Build) without landing in rust-lang/rust#104707's
|
||||||
|
//! staticlib symbol leak, which makes bionic's private `pthread_create`
|
||||||
|
//! symbols bind locally and SIGSEGV in `__init_tcb+4` at launch. So all
|
||||||
|
//! the Oboe + audio code lives in a standalone `wzp-native` .so built
|
||||||
|
//! with `cargo-ndk`, and we dlopen it here at runtime.
|
||||||
|
//!
|
||||||
|
//! The Library handle lives in a `'static` `OnceLock` for the lifetime of
|
||||||
|
//! the process; all function pointers cached below borrow from it safely.
|
||||||
|
|
||||||
|
#![cfg(target_os = "android")]
|
||||||
|
|
||||||
|
use std::sync::OnceLock;
|
||||||
|
|
||||||
|
// ─── Library handle (kept alive forever) ─────────────────────────────────
|
||||||
|
|
||||||
|
static LIB: OnceLock<libloading::Library> = OnceLock::new();
|
||||||
|
|
||||||
|
// Cached function pointers, resolved once at init(). Each is a raw
|
||||||
|
// `extern "C"` fn pointer with effectively `'static` lifetime because
|
||||||
|
// LIB is a OnceLock that never drops.
|
||||||
|
static VERSION: OnceLock<unsafe extern "C" fn() -> i32> = OnceLock::new();
|
||||||
|
static HELLO: OnceLock<unsafe extern "C" fn(*mut u8, usize) -> usize> = OnceLock::new();
|
||||||
|
static AUDIO_START: OnceLock<unsafe extern "C" fn() -> i32> = OnceLock::new();
|
||||||
|
static AUDIO_STOP: OnceLock<unsafe extern "C" fn()> = OnceLock::new();
|
||||||
|
static AUDIO_READ_CAPTURE: OnceLock<unsafe extern "C" fn(*mut i16, usize) -> usize> = OnceLock::new();
|
||||||
|
static AUDIO_WRITE_PLAYOUT: OnceLock<unsafe extern "C" fn(*const i16, usize) -> usize> = OnceLock::new();
|
||||||
|
static AUDIO_IS_RUNNING: OnceLock<unsafe extern "C" fn() -> i32> = OnceLock::new();
|
||||||
|
static AUDIO_CAPTURE_LATENCY: OnceLock<unsafe extern "C" fn() -> f32> = OnceLock::new();
|
||||||
|
static AUDIO_PLAYOUT_LATENCY: OnceLock<unsafe extern "C" fn() -> f32> = OnceLock::new();
|
||||||
|
|
||||||
|
/// Load `libwzp_native.so` and resolve every exported function we use.
|
||||||
|
/// Call this once at app startup (from the Tauri `setup()` callback).
|
||||||
|
/// Subsequent calls are no-ops.
|
||||||
|
pub fn init() -> Result<(), String> {
|
||||||
|
if LIB.get().is_some() {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open the sibling cdylib. The Android dynamic linker searches
|
||||||
|
// /data/app/<pkg>/lib/arm64/ which gradle populates from jniLibs.
|
||||||
|
let lib = unsafe { libloading::Library::new("libwzp_native.so") }
|
||||||
|
.map_err(|e| format!("dlopen libwzp_native.so: {e}"))?;
|
||||||
|
|
||||||
|
// Stash the Library into the OnceLock first so all Symbol lookups
|
||||||
|
// below borrow from the 'static reference rather than a local.
|
||||||
|
LIB.set(lib).map_err(|_| "wzp_native::LIB already set")?;
|
||||||
|
let lib_ref: &'static libloading::Library = LIB.get().unwrap();
|
||||||
|
|
||||||
|
unsafe {
|
||||||
|
macro_rules! resolve {
|
||||||
|
($cell:expr, $ty:ty, $name:expr) => {{
|
||||||
|
let sym: libloading::Symbol<$ty> = lib_ref.get($name)
|
||||||
|
.map_err(|e| format!("dlsym {}: {e}", core::str::from_utf8($name).unwrap_or("?")))?;
|
||||||
|
// Dereference the Symbol to extract the raw fn pointer;
|
||||||
|
// it stays valid because lib_ref is 'static.
|
||||||
|
$cell.set(*sym).map_err(|_| format!("{} already set", core::str::from_utf8($name).unwrap_or("?")))?;
|
||||||
|
}};
|
||||||
|
}
|
||||||
|
|
||||||
|
resolve!(VERSION, unsafe extern "C" fn() -> i32, b"wzp_native_version");
|
||||||
|
resolve!(HELLO, unsafe extern "C" fn(*mut u8, usize) -> usize, b"wzp_native_hello");
|
||||||
|
resolve!(AUDIO_START, unsafe extern "C" fn() -> i32, b"wzp_native_audio_start");
|
||||||
|
resolve!(AUDIO_STOP, unsafe extern "C" fn(), b"wzp_native_audio_stop");
|
||||||
|
resolve!(AUDIO_READ_CAPTURE, unsafe extern "C" fn(*mut i16, usize) -> usize, b"wzp_native_audio_read_capture");
|
||||||
|
resolve!(AUDIO_WRITE_PLAYOUT, unsafe extern "C" fn(*const i16, usize) -> usize, b"wzp_native_audio_write_playout");
|
||||||
|
resolve!(AUDIO_IS_RUNNING, unsafe extern "C" fn() -> i32, b"wzp_native_audio_is_running");
|
||||||
|
resolve!(AUDIO_CAPTURE_LATENCY, unsafe extern "C" fn() -> f32, b"wzp_native_audio_capture_latency_ms");
|
||||||
|
resolve!(AUDIO_PLAYOUT_LATENCY, unsafe extern "C" fn() -> f32, b"wzp_native_audio_playout_latency_ms");
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Is `init()` done and all symbols cached?
|
||||||
|
pub fn is_loaded() -> bool {
|
||||||
|
AUDIO_START.get().is_some()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Smoke-test accessors ────────────────────────────────────────────────
|
||||||
|
|
||||||
|
pub fn version() -> i32 {
|
||||||
|
VERSION.get().map(|f| unsafe { f() }).unwrap_or(-1)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn hello() -> String {
|
||||||
|
let Some(f) = HELLO.get() else { return String::new(); };
|
||||||
|
let mut buf = [0u8; 64];
|
||||||
|
let n = unsafe { f(buf.as_mut_ptr(), buf.len()) };
|
||||||
|
String::from_utf8_lossy(&buf[..n]).into_owned()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Audio accessors ─────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Start the Oboe capture + playout streams. Returns `Err(code)` on
|
||||||
|
/// failure. Idempotent on the wzp-native side.
|
||||||
|
pub fn audio_start() -> Result<(), i32> {
|
||||||
|
let f = AUDIO_START.get().ok_or(-100_i32)?;
|
||||||
|
let ret = unsafe { f() };
|
||||||
|
if ret == 0 { Ok(()) } else { Err(ret) }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stop both streams. Safe to call even if not running.
|
||||||
|
pub fn audio_stop() {
|
||||||
|
if let Some(f) = AUDIO_STOP.get() {
|
||||||
|
unsafe { f() };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read captured i16 PCM into `out`. Returns bytes actually copied.
|
||||||
|
pub fn audio_read_capture(out: &mut [i16]) -> usize {
|
||||||
|
let Some(f) = AUDIO_READ_CAPTURE.get() else { return 0; };
|
||||||
|
unsafe { f(out.as_mut_ptr(), out.len()) }
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write i16 PCM into the playout ring. Returns samples enqueued.
|
||||||
|
pub fn audio_write_playout(input: &[i16]) -> usize {
|
||||||
|
let Some(f) = AUDIO_WRITE_PLAYOUT.get() else { return 0; };
|
||||||
|
unsafe { f(input.as_ptr(), input.len()) }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn audio_is_running() -> bool {
|
||||||
|
AUDIO_IS_RUNNING.get().map(|f| unsafe { f() } != 0).unwrap_or(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(dead_code)]
|
||||||
|
pub fn audio_capture_latency_ms() -> f32 {
|
||||||
|
AUDIO_CAPTURE_LATENCY.get().map(|f| unsafe { f() }).unwrap_or(0.0)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(dead_code)]
|
||||||
|
pub fn audio_playout_latency_ms() -> f32 {
|
||||||
|
AUDIO_PLAYOUT_LATENCY.get().map(|f| unsafe { f() }).unwrap_or(0.0)
|
||||||
|
}
|
||||||
36
desktop/src-tauri/tauri.conf.json
Normal file
36
desktop/src-tauri/tauri.conf.json
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
{
|
||||||
|
"productName": "WarzonePhone",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"identifier": "com.wzp.desktop",
|
||||||
|
"build": {
|
||||||
|
"frontendDist": "../dist",
|
||||||
|
"devUrl": "http://localhost:1420",
|
||||||
|
"beforeDevCommand": "npm run dev",
|
||||||
|
"beforeBuildCommand": "npm run build"
|
||||||
|
},
|
||||||
|
"app": {
|
||||||
|
"windows": [
|
||||||
|
{
|
||||||
|
"title": "WarzonePhone",
|
||||||
|
"width": 400,
|
||||||
|
"height": 640,
|
||||||
|
"resizable": true,
|
||||||
|
"minWidth": 360,
|
||||||
|
"minHeight": 500
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"security": {
|
||||||
|
"csp": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"bundle": {
|
||||||
|
"active": true,
|
||||||
|
"targets": "all",
|
||||||
|
"icon": [
|
||||||
|
"icons/icon.png"
|
||||||
|
],
|
||||||
|
"android": {
|
||||||
|
"minSdkVersion": 26
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
110
desktop/src/identicon.ts
Normal file
110
desktop/src/identicon.ts
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
/**
|
||||||
|
* Deterministic identicon generator — creates a unique symmetric pattern
|
||||||
|
* from a hex fingerprint string, similar to MetaMask's Jazzicon / Ethereum blockies.
|
||||||
|
*
|
||||||
|
* Returns an SVG data URL that can be used as an <img> src.
|
||||||
|
*/
|
||||||
|
|
||||||
|
function hashBytes(hex: string): number[] {
|
||||||
|
const clean = hex.replace(/[^0-9a-fA-F]/g, "");
|
||||||
|
const bytes: number[] = [];
|
||||||
|
for (let i = 0; i < clean.length; i += 2) {
|
||||||
|
bytes.push(parseInt(clean.substring(i, i + 2), 16));
|
||||||
|
}
|
||||||
|
// Pad to at least 16 bytes
|
||||||
|
while (bytes.length < 16) bytes.push(0);
|
||||||
|
return bytes;
|
||||||
|
}
|
||||||
|
|
||||||
|
function hslToRgb(h: number, s: number, l: number): [number, number, number] {
|
||||||
|
s /= 100;
|
||||||
|
l /= 100;
|
||||||
|
const k = (n: number) => (n + h / 30) % 12;
|
||||||
|
const a = s * Math.min(l, 1 - l);
|
||||||
|
const f = (n: number) =>
|
||||||
|
l - a * Math.max(-1, Math.min(k(n) - 3, Math.min(9 - k(n), 1)));
|
||||||
|
return [
|
||||||
|
Math.round(f(0) * 255),
|
||||||
|
Math.round(f(8) * 255),
|
||||||
|
Math.round(f(4) * 255),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function generateIdenticon(
|
||||||
|
fingerprint: string,
|
||||||
|
size: number = 36
|
||||||
|
): string {
|
||||||
|
const bytes = hashBytes(fingerprint);
|
||||||
|
|
||||||
|
// Derive colors from first bytes
|
||||||
|
const hue1 = (bytes[0] * 360) / 256;
|
||||||
|
const hue2 = ((bytes[1] * 360) / 256 + 120) % 360;
|
||||||
|
const [r1, g1, b1] = hslToRgb(hue1, 65, 35); // dark bg
|
||||||
|
const [r2, g2, b2] = hslToRgb(hue2, 70, 55); // bright fg
|
||||||
|
|
||||||
|
const bg = `rgb(${r1},${g1},${b1})`;
|
||||||
|
const fg = `rgb(${r2},${g2},${b2})`;
|
||||||
|
|
||||||
|
// 5x5 grid, left-right symmetric (only need 3 columns)
|
||||||
|
const grid: boolean[][] = [];
|
||||||
|
for (let y = 0; y < 5; y++) {
|
||||||
|
const row: boolean[] = [];
|
||||||
|
for (let x = 0; x < 3; x++) {
|
||||||
|
const byteIdx = 2 + y * 3 + x;
|
||||||
|
row.push(bytes[byteIdx % bytes.length] > 128);
|
||||||
|
}
|
||||||
|
// Mirror: col 3 = col 1, col 4 = col 0
|
||||||
|
grid.push([row[0], row[1], row[2], row[1], row[0]]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Render SVG
|
||||||
|
const cellSize = size / 5;
|
||||||
|
const r = size * 0.12; // border radius
|
||||||
|
let rects = "";
|
||||||
|
for (let y = 0; y < 5; y++) {
|
||||||
|
for (let x = 0; x < 5; x++) {
|
||||||
|
if (grid[y][x]) {
|
||||||
|
rects += `<rect x="${x * cellSize}" y="${y * cellSize}" width="${cellSize}" height="${cellSize}" fill="${fg}"/>`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const svg = `<svg xmlns="http://www.w3.org/2000/svg" width="${size}" height="${size}" viewBox="0 0 ${size} ${size}">
|
||||||
|
<rect width="${size}" height="${size}" rx="${r}" fill="${bg}"/>
|
||||||
|
${rects}
|
||||||
|
</svg>`;
|
||||||
|
|
||||||
|
return `data:image/svg+xml,${encodeURIComponent(svg)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an <img> element with the identicon.
|
||||||
|
* Click copies the fingerprint to clipboard.
|
||||||
|
*/
|
||||||
|
export function createIdenticonEl(
|
||||||
|
fingerprint: string,
|
||||||
|
size: number = 36,
|
||||||
|
clickToCopy: boolean = true
|
||||||
|
): HTMLImageElement {
|
||||||
|
const img = document.createElement("img");
|
||||||
|
img.src = generateIdenticon(fingerprint, size);
|
||||||
|
img.width = size;
|
||||||
|
img.height = size;
|
||||||
|
img.style.borderRadius = `${size * 0.12}px`;
|
||||||
|
img.style.cursor = clickToCopy ? "pointer" : "default";
|
||||||
|
img.title = fingerprint;
|
||||||
|
|
||||||
|
if (clickToCopy && fingerprint) {
|
||||||
|
img.addEventListener("click", (e) => {
|
||||||
|
e.stopPropagation();
|
||||||
|
navigator.clipboard.writeText(fingerprint).then(() => {
|
||||||
|
img.style.outline = "2px solid #4ade80";
|
||||||
|
setTimeout(() => {
|
||||||
|
img.style.outline = "";
|
||||||
|
}, 600);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return img;
|
||||||
|
}
|
||||||
1085
desktop/src/main.ts
Normal file
1085
desktop/src/main.ts
Normal file
File diff suppressed because it is too large
Load Diff
1031
desktop/src/style.css
Normal file
1031
desktop/src/style.css
Normal file
File diff suppressed because it is too large
Load Diff
15
desktop/tsconfig.json
Normal file
15
desktop/tsconfig.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ESNext",
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"strict": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"forceConsistentCasingInFileNames": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"noEmit": true
|
||||||
|
},
|
||||||
|
"include": ["src"]
|
||||||
|
}
|
||||||
15
desktop/vite.config.ts
Normal file
15
desktop/vite.config.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { defineConfig } from "vite";
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
clearScreen: false,
|
||||||
|
server: {
|
||||||
|
port: 1420,
|
||||||
|
strictPort: true,
|
||||||
|
},
|
||||||
|
envPrefix: ["VITE_", "TAURI_"],
|
||||||
|
build: {
|
||||||
|
target: "esnext",
|
||||||
|
minify: !process.env.TAURI_DEBUG ? "esbuild" : false,
|
||||||
|
sourcemap: !!process.env.TAURI_DEBUG,
|
||||||
|
},
|
||||||
|
});
|
||||||
@@ -625,3 +625,123 @@ curl -s http://relay-host:9090/metrics | grep wzp_relay_active_sessions
|
|||||||
# Check federation probe health
|
# Check federation probe health
|
||||||
curl -s http://relay-host:9090/metrics | grep wzp_probe_up
|
curl -s http://relay-host:9090/metrics | grep wzp_probe_up
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Build Pipelines
|
||||||
|
|
||||||
|
All production artifacts (Android APK, Linux x86_64 binaries, Windows `.exe`) are built on **SepehrHomeserverdk** using Docker, not on developer workstations. The pipelines are fire-and-forget: a local script invokes a `tmux` session on the remote, the build runs in a Docker container, and the artifact is uploaded to `paste.dk.manko.yoga` (rustypaste) with a notification sent to `ntfy.sh/wzp` on start and completion.
|
||||||
|
|
||||||
|
### Docker images
|
||||||
|
|
||||||
|
Two long-lived images live on the remote:
|
||||||
|
|
||||||
|
| Image | Used by | Base | Key contents |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `wzp-android-builder` | Android APK (Tauri mobile + legacy Kotlin), Linux x86_64 relay/CLI | Debian bookworm | Rust stable with Android targets, cargo-ndk, NDK 26.1, Android SDK (API 34 + 35 + 36), JDK 17, Gradle 8.5, Node.js 20, cmake, ninja, tauri-cli 2.x |
|
||||||
|
| `wzp-windows-builder` | Windows x86_64 `.exe` | Debian bookworm | Rust stable with `x86_64-pc-windows-msvc` target, cargo-xwin (with pre-warmed MSVC CRT + Windows SDK cache), Node.js 20, cmake, ninja, clang, lld, nasm |
|
||||||
|
|
||||||
|
Both images are rebuilt rarely — once the base toolchain is stable, rebuilds are only needed to pick up new dependencies or security patches.
|
||||||
|
|
||||||
|
**Rebuilding an image** (fire-and-forget, ~10 min on a warm base):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Windows
|
||||||
|
./scripts/build-windows-docker.sh --image-build
|
||||||
|
|
||||||
|
# Android (upload and rebuild handled by the Android build script itself — see
|
||||||
|
# its --image-build flag or equivalent)
|
||||||
|
```
|
||||||
|
|
||||||
|
The `--image-build` flag uploads the local Dockerfile to the remote, kicks off `docker build` under `nohup`, and returns immediately. Monitor with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ssh SepehrHomeserverdk 'tail -f /tmp/wzp-windows-image-build.log'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pipeline: Android APK (Tauri Mobile)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-tauri-android.sh # Full: pull + build + upload + notify
|
||||||
|
./scripts/build-tauri-android.sh --no-pull # Skip git fetch
|
||||||
|
./scripts/build-tauri-android.sh --clean # Force-clean Rust target
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Branch**: `android-rewrite`
|
||||||
|
- **Image**: `wzp-android-builder`
|
||||||
|
- **Build command**: `cargo tauri android build --release`
|
||||||
|
- **Output**: `wzp-release.apk` → uploaded to rustypaste
|
||||||
|
- **Notifications**: start + completion to `ntfy.sh/wzp`
|
||||||
|
- **Remote artifact path**: `/mnt/storage/manBuilder/data/cache-android/target/…/release/app-release.apk`
|
||||||
|
|
||||||
|
### Pipeline: Linux x86_64 (relay + CLI + bench + web)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-linux-docker.sh # Fire-and-forget
|
||||||
|
./scripts/build-linux-docker.sh --no-pull # Skip git fetch
|
||||||
|
./scripts/build-linux-docker.sh --clean # Force-clean target
|
||||||
|
./scripts/build-linux-docker.sh --install # Wait for completion and download locally
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Branch**: `feat/android-voip-client` (script default — override by editing the script or passing an env var)
|
||||||
|
- **Image**: `wzp-android-builder` (shared, not a separate Linux-only image)
|
||||||
|
- **Targets built**: `wzp-relay`, `wzp-client`, `wzp-client-audio` (with `--features audio`), `wzp-web`, `wzp-bench`
|
||||||
|
- **Output**: `wzp-linux-x86_64.tar.gz` with all five binaries → uploaded to rustypaste
|
||||||
|
- **Local landing dir** (with `--install`): `target/linux-x86_64/`
|
||||||
|
|
||||||
|
### Pipeline: Windows x86_64 (`wzp-desktop.exe`)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-windows-docker.sh # Full: pull + build + download locally
|
||||||
|
./scripts/build-windows-docker.sh --no-pull # Skip git fetch
|
||||||
|
./scripts/build-windows-docker.sh --rust # Force-clean target-windows cache
|
||||||
|
./scripts/build-windows-docker.sh --image-build # Rebuild the Docker image (fire-and-forget)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Branch**: `feat/desktop-audio-rewrite`
|
||||||
|
- **Image**: `wzp-windows-builder`
|
||||||
|
- **Build command**: `cargo xwin build --release --target x86_64-pc-windows-msvc --bin wzp-desktop`
|
||||||
|
- **Output**: `wzp-desktop.exe` (~16 MB) → downloaded to `target/windows-exe/wzp-desktop.exe`, also uploaded to rustypaste
|
||||||
|
- **Target cache volume**: `target-windows` (separate from the Android target cache to avoid triple cross-contamination)
|
||||||
|
- **Shared cache volumes**: `cargo-registry`, `cargo-git` (shared with Android — both pipelines pull the same crates)
|
||||||
|
|
||||||
|
**A/B-preserving workflow** for testing audio backends: rename the prior `.exe` before re-running the build, so both coexist:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Preserve prior build as the noAEC baseline
|
||||||
|
mv target/windows-exe/wzp-desktop.exe target/windows-exe/wzp-desktop-noAEC.exe
|
||||||
|
./scripts/build-windows-docker.sh
|
||||||
|
ls -la target/windows-exe/
|
||||||
|
# wzp-desktop-noAEC.exe (previous build)
|
||||||
|
# wzp-desktop.exe (new build)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Alternative pipeline: Windows via Hetzner Cloud VPS
|
||||||
|
|
||||||
|
For situations where Docker image rebuilds would be disruptive, or for one-shot debug builds on a clean machine:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-windows-cloud.sh # Full: create VM → build → download → destroy
|
||||||
|
./scripts/build-windows-cloud.sh --prepare # Create VM + install deps, don't build
|
||||||
|
./scripts/build-windows-cloud.sh --build # Build on existing VM
|
||||||
|
./scripts/build-windows-cloud.sh --transfer # Download .exe from existing VM
|
||||||
|
./scripts/build-windows-cloud.sh --destroy # Delete the VM
|
||||||
|
WZP_KEEP_VM=1 ./scripts/build-windows-cloud.sh # Don't auto-destroy after successful build
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Provider**: Hetzner Cloud
|
||||||
|
- **Default server type**: `cx33` (8 GB RAM, 8 vCPU — `cx23` with 4 GB OOMs on the tauri+rustls cross-compile)
|
||||||
|
- **Image**: `ubuntu-24.04`
|
||||||
|
- **SSH key**: must be named `wz` in Hetzner and loaded in the local ssh-agent
|
||||||
|
- **Reminder**: set `WZP_KEEP_VM=1` for multi-build sessions, then **remember to `--destroy` at end of day** so the VM isn't left running overnight. This is tracked in the auto-memory as `feedback_keep_windows_builder_vm.md`.
|
||||||
|
|
||||||
|
### Notifications
|
||||||
|
|
||||||
|
All pipelines post to `https://ntfy.sh/wzp`. Subscribe from your phone via the [ntfy.sh app](https://ntfy.sh/) to get push notifications on build start/success/failure. Messages include the short git hash and the rustypaste URL on success:
|
||||||
|
|
||||||
|
```
|
||||||
|
WZP Windows build OK [03a80a3] (16M)
|
||||||
|
https://paste.dk.manko.yoga/<uuid>/wzp-desktop.exe
|
||||||
|
```
|
||||||
|
|
||||||
|
### Rustypaste credentials
|
||||||
|
|
||||||
|
Build pipelines read `rusty_address` and `rusty_auth_token` from the `.env` file at `/mnt/storage/manBuilder/.env` on SepehrHomeserverdk. Local scripts that upload directly (`build-windows-cloud.sh` when run in `--transfer` mode) read from `~/.wzp/rustypaste.env` with the same variable names. Both files must be kept in sync manually if rotated.
|
||||||
|
|||||||
@@ -872,3 +872,71 @@ warzonePhone/
|
|||||||
| wzp-relay | 40 + 4 integration | Room ACL, session mgmt, metrics, probes, mesh, trunking |
|
| wzp-relay | 40 + 4 integration | Room ACL, session mgmt, metrics, probes, mesh, trunking |
|
||||||
| wzp-client | 30 + 2 integration | Encoder/decoder, quality adapter, silence, drift, sweep |
|
| wzp-client | 30 + 2 integration | Encoder/decoder, quality adapter, silence, drift, sweep |
|
||||||
| wzp-web | 2 | Metrics |
|
| wzp-web | 2 | Metrics |
|
||||||
|
|
||||||
|
## Audio Backend Architecture (Platform Matrix)
|
||||||
|
|
||||||
|
WarzonePhone's audio I/O goes through one of four backends depending on the target platform and feature flags. All backends expose the same public API (`AudioCapture::start() → AudioCapture { ring(), stop() }`) via conditional re-exports in `crates/wzp-client/src/lib.rs`, so the `CallEngine` above the audio layer doesn't know or care which backend is running.
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────┐
|
||||||
|
│ CallEngine (platform-agnostic) │
|
||||||
|
│ reads PCM from AudioCapture::ring() │
|
||||||
|
│ writes PCM to AudioPlayback::ring() │
|
||||||
|
└────────────────────┬────────────────────────┘
|
||||||
|
│
|
||||||
|
┌─────────────────────┼─────────────────────┐
|
||||||
|
│ │ │
|
||||||
|
▼ ▼ ▼
|
||||||
|
┌───────────────┐ ┌────────────────┐ ┌───────────────┐
|
||||||
|
│ audio_io │ │ audio_vpio │ │ audio_wasapi │
|
||||||
|
│ (CPAL) │ │ (Core Audio │ │ (Windows │
|
||||||
|
│ │ │ VoiceProc IO) │ │ IAudioClient2│
|
||||||
|
│ All platforms │ │ macOS only │ │ Windows │
|
||||||
|
│ (baseline) │ │ feature=vpio │ │ feature= │
|
||||||
|
│ │ │ │ │ windows-aec │
|
||||||
|
└───────────────┘ └────────────────┘ └───────────────┘
|
||||||
|
│
|
||||||
|
▼ on Android only
|
||||||
|
┌───────────────┐
|
||||||
|
│ wzp-native │
|
||||||
|
│ (Oboe bridge │
|
||||||
|
│ via dlopen) │
|
||||||
|
│ │
|
||||||
|
│ Android only │
|
||||||
|
│ libloading │
|
||||||
|
└───────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backend selection matrix
|
||||||
|
|
||||||
|
| Platform | Capture | Playback | OS AEC | Feature flags |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| macOS | VoiceProcessingIO (native Core Audio) | CPAL | **Yes** — Apple's hardware-accelerated AEC (same AEC as FaceTime, iMessage audio, Voice Memos) | `audio`, `vpio` |
|
||||||
|
| Windows (AEC build) | Direct WASAPI with `AudioCategory_Communications` | CPAL | **Yes** — Windows routes the capture stream through the driver's communications APO chain (AEC + NS + AGC), driver-dependent quality | `audio`, `windows-aec` |
|
||||||
|
| Windows (baseline) | CPAL (WASAPI shared mode) | CPAL | No | `audio` |
|
||||||
|
| Linux | CPAL (ALSA / PulseAudio) | CPAL | No | `audio` |
|
||||||
|
| Android (Tauri Mobile) | Oboe via `wzp-native` cdylib, `Usage::VoiceCommunication` + `MODE_IN_COMMUNICATION` | Same Oboe stream | Depends on device (some Android devices apply AEC to the voice-communication stream, most do not) | none (`wzp-client` compiled with `default-features = false`) |
|
||||||
|
|
||||||
|
### Why `wzp-native` is a standalone cdylib
|
||||||
|
|
||||||
|
On Android, the audio backend lives in a separate cdylib crate (`crates/wzp-native`) that `wzp-desktop`'s lib crate loads at runtime via `libloading`. It is **not** linked as a regular Rust dep.
|
||||||
|
|
||||||
|
This is deliberate. rust-lang/rust#104707 documents that a crate with `crate-type = ["cdylib", "staticlib"]` leaks non-exported symbols from the staticlib into the cdylib. On Android, that caused Bionic's private `__init_tcb` / `pthread_create` symbols to be bound LOCALLY inside our `.so` instead of resolved dynamically against `libc.so` at `dlopen` time — which crashed the app at launch as soon as `tao` tried to `std::thread::spawn()` from the JNI `onCreate` callback.
|
||||||
|
|
||||||
|
Keeping `wzp-native` in its own cdylib and loading it via `libloading` means:
|
||||||
|
|
||||||
|
1. The app's own `.so` has `crate-type = ["cdylib", "rlib"]` only — no `staticlib`, no symbol leak.
|
||||||
|
2. `libwzp_native.so` is loaded via `System.loadLibrary` from the JVM side (or `dlopen` from Rust), which triggers the normal Bionic resolver and binds all private symbols against `libc.so` at load time.
|
||||||
|
3. The C/C++ Oboe bridge is fully isolated inside `libwzp_native.so`'s symbol space — no chance of its archives leaking into `wzp-desktop`'s `.so`.
|
||||||
|
|
||||||
|
See `docs/BRANCH-android-rewrite.md` for the full incident postmortem and `docs/incident-tauri-android-init-tcb.md` for the debug log.
|
||||||
|
|
||||||
|
### Vendored `audiopus_sys` for libopus / clang-cl cross-compile
|
||||||
|
|
||||||
|
The workspace root carries a vendored copy of `audiopus_sys` at `vendor/audiopus_sys/` with a patched `opus/CMakeLists.txt`. This is needed because libopus 1.3.1 gates its per-file `-msse4.1` / `-mssse3` `COMPILE_FLAGS` behind `if(NOT MSVC)`, and under `clang-cl` (used by `cargo-xwin` for Windows cross-compiles) CMake sets `MSVC=1` unconditionally — so the SIMD source files compile without the required target feature and fail to link the intrinsic `always_inline` functions.
|
||||||
|
|
||||||
|
The patch introduces an `MSVC_CL` variable that is true only for real `cl.exe` (distinguished via `CMAKE_C_COMPILER_ID STREQUAL "MSVC"`), and flips the eight `if(NOT MSVC)` SIMD guards to `if(NOT MSVC_CL)` so clang-cl gets the GCC-style per-file flags. Wired in via `[patch.crates-io] audiopus_sys = { path = "vendor/audiopus_sys" }` at the workspace root.
|
||||||
|
|
||||||
|
This does not affect macOS or Linux builds — on those platforms `MSVC=0` everywhere so the patched logic behaves identically to upstream.
|
||||||
|
|
||||||
|
Upstream tracking: xiph/opus#256, xiph/opus PR #257 (both stale).
|
||||||
|
|||||||
164
docs/BRANCH-desktop-audio-rewrite.md
Normal file
164
docs/BRANCH-desktop-audio-rewrite.md
Normal file
@@ -0,0 +1,164 @@
|
|||||||
|
# Branch: `feat/desktop-audio-rewrite`
|
||||||
|
|
||||||
|
Home of the Tauri desktop client for macOS, Windows, and Linux. Named "audio-rewrite" because the original driver was replacing a CPAL-only audio pipeline with platform-native backends that support OS-level echo cancellation (VoiceProcessingIO on macOS, WASAPI Communications on Windows), but the branch has grown into the full desktop story — Windows cross-compilation, vendored dependencies, history UI, direct calling, the whole thing.
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
The desktop client shares 100% of its frontend (`desktop/src/`) and Tauri command layer (`desktop/src-tauri/src/lib.rs`, `engine.rs`, `history.rs`) with the Android build on `android-rewrite`. Differences are limited to:
|
||||||
|
|
||||||
|
- **Audio backends**, which are platform-gated via Cargo target-dep sections in `desktop/src-tauri/Cargo.toml` and feature flags in `crates/wzp-client/Cargo.toml`.
|
||||||
|
- **Identity storage paths**, which resolve via Tauri's `app_data_dir()` (`~/Library/Application Support/…` on macOS, `%APPDATA%\…` on Windows, `~/.local/share/…` on Linux).
|
||||||
|
- **Build toolchains**: native `cargo build` on macOS/Linux, `cargo xwin` cross-compile from Linux for Windows via Docker on SepehrHomeserverdk.
|
||||||
|
|
||||||
|
## Audio backend matrix
|
||||||
|
|
||||||
|
| Target | Capture | Playback | AEC |
|
||||||
|
|---|---|---|---|
|
||||||
|
| macOS | CPAL (WASAPI/CoreAudio via cpal crate) OR VoiceProcessingIO (native Core Audio) | CPAL | VoiceProcessingIO native AEC (when `vpio` feature enabled) |
|
||||||
|
| Windows (default) | CPAL → WASAPI shared mode | CPAL → WASAPI shared mode | None |
|
||||||
|
| Windows (AEC build) | Direct WASAPI with `IAudioClient2::SetClientProperties(AudioCategory_Communications)` | CPAL → WASAPI shared mode | **OS-level**: Windows routes the capture stream through the driver's communications APO chain (AEC + NS + AGC) |
|
||||||
|
| Linux | CPAL → ALSA/PulseAudio | CPAL → ALSA/PulseAudio | None |
|
||||||
|
|
||||||
|
The macOS VPIO path is gated behind the `vpio` feature in `wzp-client` and the `coreaudio-rs` dep is itself `cfg(target_os = "macos")`, so enabling the feature on Windows or Linux is a no-op.
|
||||||
|
|
||||||
|
The Windows AEC path is gated behind the `windows-aec` feature, also target-gated (the `windows` crate dep is only pulled in on Windows), and re-exports `WasapiAudioCapture as AudioCapture` when enabled so downstream code doesn't need to know which backend is active. The current Windows build at `target/windows-exe/wzp-desktop.exe` has `windows-aec` on; a baseline noAEC build is preserved at `target/windows-exe/wzp-desktop-noAEC.exe` for A/B comparison on real hardware.
|
||||||
|
|
||||||
|
See [`BRANCH-android-rewrite.md`](BRANCH-android-rewrite.md) for Oboe audio on Android, which is its own story.
|
||||||
|
|
||||||
|
## Recent major work
|
||||||
|
|
||||||
|
### 1. Desktop direct calling feature (commit `2fd9465` and neighbors)
|
||||||
|
|
||||||
|
Brought direct 1:1 calls to macOS with full parity to the Android client:
|
||||||
|
|
||||||
|
- **Identity path fix**: the desktop `CallEngine::start` was loading seed from `$HOME/.wzp/identity` while `register_signal` used Tauri's `app_data_dir()`, producing two different fingerprints per run. Both now route through `load_or_create_seed()` which uses `app_data_dir()` everywhere.
|
||||||
|
- **Call history with dedup**: `history.rs` stores a `Vec<CallHistoryEntry>` with a `CallDirection` enum (`Placed | Received | Missed`). The `log` function dedupes by `call_id` so an outgoing call isn't logged twice as "missed" (when the signal loop's `DirectCallOffer` handler fires) and then again as "placed" (when `place_call` returns). Instead the entry is updated in place.
|
||||||
|
- **Recent contacts row**: a horizontal chip UI in the direct-call panel showing the last N peers with friendly aliases, clickable to re-dial.
|
||||||
|
- **Deregister button**: lets a user drop their signal registration without quitting the app, useful when switching identities.
|
||||||
|
- **Random alias derivation**: a new client sees a human-friendly alias like "silent-forest-41" derived deterministically from its seed, so it's identifiable in the UI before manual naming.
|
||||||
|
- **Default room "general"** instead of "android", since the desktop client is not Android.
|
||||||
|
|
||||||
|
### 2. macOS VoiceProcessingIO integration
|
||||||
|
|
||||||
|
`crates/wzp-client/src/audio_vpio.rs` — a native Core Audio implementation using `AUGraph` + `AudioComponentInstance` with the VPIO audio unit. Gives you hardware-accelerated AEC (same AEC Apple ships in FaceTime / iMessage audio / voice memos) at the cost of tight coupling to Apple frameworks. Lock-free ring pattern matches the CPAL path so the upper layers don't notice the difference.
|
||||||
|
|
||||||
|
Enabled by `features = ["audio", "vpio"]` in the macOS target section of `desktop/src-tauri/Cargo.toml`.
|
||||||
|
|
||||||
|
### 3. Windows cross-compilation via cargo-xwin
|
||||||
|
|
||||||
|
Cross-compiling Rust + Tauri to `x86_64-pc-windows-msvc` from Linux using `cargo-xwin`, which downloads the Microsoft CRT + Windows SDK on demand and drives `clang-cl` as the compiler. No Windows machine is needed for the build itself — only for runtime testing.
|
||||||
|
|
||||||
|
**Build infrastructure**:
|
||||||
|
|
||||||
|
- `scripts/Dockerfile.windows-builder` — Debian bookworm + Rust + cargo-xwin + Node 20 + cmake + ninja + llvm + clang + lld + nasm. Pre-warms the xwin MSVC CRT cache at image build time (saves ~4 minutes per cold build).
|
||||||
|
- `scripts/build-windows-docker.sh` — fire-and-forget remote build via Docker on SepehrHomeserverdk. Same pattern as `build-tauri-android.sh`. Uploads the `.exe` to rustypaste and fires an `ntfy.sh/wzp` notification on start and on completion.
|
||||||
|
- `scripts/build-windows-cloud.sh` — alternative pipeline using a temporary Hetzner Cloud VPS. Slower (full VM spin-up), more expensive, but useful when Docker image rebuilds would be disruptive.
|
||||||
|
|
||||||
|
**Two critical blockers resolved** on the way to a working `.exe`:
|
||||||
|
|
||||||
|
1. **libopus SSE4.1 / SSSE3 intrinsic compile failure**. `audiopus_sys` vendors libopus 1.3.1, whose `CMakeLists.txt` gates the per-file `-msse4.1` `COMPILE_FLAGS` behind `if(NOT MSVC)`. Under `clang-cl`, CMake sets `MSVC=1` (because `CMAKE_C_COMPILER_FRONTEND_VARIANT=MSVC` triggers `Platform/Windows-MSVC.cmake` which unconditionally sets the variable), so the per-file flag is never set and the SSE4.1 source files compile without the target feature — then fail with 20+ "always_inline function '_mm_cvtepi16_epi32' requires target feature 'sse4.1'" errors.
|
||||||
|
|
||||||
|
Fixed by **vendoring audiopus_sys into `vendor/audiopus_sys/`** and patching its bundled libopus to introduce an `MSVC_CL` variable that is true only for real `cl.exe` (distinguished via `CMAKE_C_COMPILER_ID STREQUAL "MSVC"`). The eight `if(NOT MSVC)` SIMD guards are flipped to `if(NOT MSVC_CL)` and the global `/arch` block at line 445 becomes `if(MSVC_CL)`, so clang-cl gets the GCC-style per-file flags while real cl.exe keeps the `/arch:AVX` / `/arch:SSE2` globals.
|
||||||
|
|
||||||
|
Wired in via `[patch.crates-io] audiopus_sys = { path = "vendor/audiopus_sys" }` at the workspace root.
|
||||||
|
|
||||||
|
Upstream tracking: [xiph/opus#256](https://github.com/xiph/opus/issues/256), [xiph/opus PR #257](https://github.com/xiph/opus/pull/257) (both stale).
|
||||||
|
|
||||||
|
2. **tauri-build needs `icons/icon.ico` for the Windows PE resource**. The desktop only had `icon.png`. Generated a multi-size ICO (16/24/32/48/64/128/256) from the existing placeholder via Pillow and committed it. Placeholder quality — real branded icons can replace it later.
|
||||||
|
|
||||||
|
### 4. Windows `AudioCategory_Communications` capture path (task #24)
|
||||||
|
|
||||||
|
`crates/wzp-client/src/audio_wasapi.rs` — direct WASAPI capture via `IMMDeviceEnumerator → IAudioClient2 → SetClientProperties` with `AudioCategory_Communications`. This tells Windows "this is a VoIP call" and Windows routes the capture stream through the driver's registered communications APO chain, which on most Win10/11 consumer hardware includes AEC, NS, and AGC.
|
||||||
|
|
||||||
|
**Caveat**: quality is driver-dependent. On a machine with a good communications APO (Intel Smart Sound, Dolby, modern Realtek on Win11 24H2+, anything with Voice Clarity enabled) it's excellent. On generic class-compliant drivers with no communications APO registered, it's a no-op. For a guaranteed AEC regardless of driver, see task #26 which tracks implementing the classic Voice Capture DSP (`CLSID_CWMAudioAEC`) as a fallback.
|
||||||
|
|
||||||
|
Gated behind the `windows-aec` feature in `wzp-client`. Enabled by default in the Windows target section of `desktop/src-tauri/Cargo.toml`.
|
||||||
|
|
||||||
|
## Build pipelines
|
||||||
|
|
||||||
|
### Native macOS / Linux
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd desktop
|
||||||
|
npm install
|
||||||
|
npm run build
|
||||||
|
cd src-tauri
|
||||||
|
cargo build --release --bin wzp-desktop
|
||||||
|
```
|
||||||
|
|
||||||
|
### Windows x86_64 via Docker on SepehrHomeserverdk
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-windows-docker.sh # Full: pull + build + download
|
||||||
|
./scripts/build-windows-docker.sh --no-pull # Skip git fetch
|
||||||
|
./scripts/build-windows-docker.sh --rust # Force-clean Rust target
|
||||||
|
./scripts/build-windows-docker.sh --image-build # (Re)build the Docker image (fire-and-forget)
|
||||||
|
```
|
||||||
|
|
||||||
|
Output lands at `target/windows-exe/wzp-desktop.exe`. Both `wzp-desktop.exe` and `wzp-desktop-noAEC.exe` can coexist in that directory; the script writes `wzp-desktop.exe` so renaming the prior build to `-noAEC.exe` (or any other name) before rebuilding preserves it.
|
||||||
|
|
||||||
|
### Windows x86_64 via Hetzner Cloud (alternative)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-windows-cloud.sh # Full: create VM → build → download → destroy
|
||||||
|
./scripts/build-windows-cloud.sh --prepare # Create VM and install deps only
|
||||||
|
./scripts/build-windows-cloud.sh --build # Build on existing VM
|
||||||
|
./scripts/build-windows-cloud.sh --destroy # Delete the VM
|
||||||
|
WZP_KEEP_VM=1 ./scripts/build-windows-cloud.sh # Keep VM alive after build for debug
|
||||||
|
```
|
||||||
|
|
||||||
|
Remember to destroy the VM at end of day with `--destroy`.
|
||||||
|
|
||||||
|
### Linux x86_64 (relay + CLI + bench)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/build-linux-docker.sh # Fire-and-forget remote Docker build
|
||||||
|
./scripts/build-linux-docker.sh --install # Wait for completion and download
|
||||||
|
```
|
||||||
|
|
||||||
|
Uses the same `wzp-android-builder` Docker image as Android (not a separate image), since the deps (Rust + cmake + ring prereqs) are the same.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
### Direct calling parity
|
||||||
|
|
||||||
|
1. Build on two machines (macOS + Windows, or two macOS, or any combination).
|
||||||
|
2. Both machines register on the same relay.
|
||||||
|
3. Copy one machine's fingerprint into the other's direct-call panel.
|
||||||
|
4. Place the call. Confirm ringing UI on the callee and "calling…" UI on the caller.
|
||||||
|
5. Answer. Confirm audio flows both ways.
|
||||||
|
6. Hang up from either side. Confirm call-history entries are labeled correctly (`Outgoing` on caller, `Incoming` on callee, never `Missed` on a successful call).
|
||||||
|
|
||||||
|
### Windows AEC A/B
|
||||||
|
|
||||||
|
1. Install `wzp-desktop-noAEC.exe` and `wzp-desktop.exe` on the same Windows box.
|
||||||
|
2. Join a call from each (separately) while a second machine plays known audio through the first machine's speakers.
|
||||||
|
3. On the remote (listening) side: the `noAEC` call should have clear audible echo; the AEC call should have minimal or no echo after a 1–2 s convergence period.
|
||||||
|
4. If both builds sound identical (with echo) → the `AudioCategory_Communications` switch isn't triggering the driver's APO chain. Investigate via task #26 (Voice Capture DSP fallback).
|
||||||
|
|
||||||
|
## Known quirks
|
||||||
|
|
||||||
|
1. **libopus vendor path is workspace-relative**. `[patch.crates-io] audiopus_sys = { path = "vendor/audiopus_sys" }` works from any crate in the workspace because Cargo resolves it against the root `Cargo.toml`'s directory. If the workspace is moved or vendored into another workspace, update the path.
|
||||||
|
|
||||||
|
2. **`cargo xwin` overwrites `override.cmake` on every invocation**. Any attempt to patch `~/.cache/cargo-xwin/cmake/clang-cl/override.cmake` at Docker image build time is inert because `src/compiler/clang_cl.rs` line ~444 writes the bundled file fresh on every run. All real fixes must land in the source tree (via the vendored audiopus_sys, as done here), not in the cargo-xwin cache.
|
||||||
|
|
||||||
|
3. **WebView2 runtime is a prerequisite on Windows 10**. Windows 11 ships with it. If the `.exe` launches and immediately exits with no error on a Win10 machine, that's the missing runtime — install it from [Microsoft's Evergreen bootstrapper](https://developer.microsoft.com/en-us/microsoft-edge/webview2/).
|
||||||
|
|
||||||
|
4. **Rust 2024 edition `unsafe_op_in_unsafe_fn` lint**. The WASAPI backend in `audio_wasapi.rs` emits ~18 of these warnings because Rust 2024 requires explicit `unsafe { ... }` blocks inside `unsafe fn` bodies. The warnings don't block the build and don't affect runtime behavior; cleaning them up is tracked informally as tech debt.
|
||||||
|
|
||||||
|
## Files of interest
|
||||||
|
|
||||||
|
| Path | Purpose |
|
||||||
|
|---|---|
|
||||||
|
| `desktop/src/` | Shared frontend (TypeScript + HTML + CSS) |
|
||||||
|
| `desktop/src-tauri/src/lib.rs` | Tauri commands shared with Android |
|
||||||
|
| `desktop/src-tauri/src/engine.rs` | `CallEngine` wrapper |
|
||||||
|
| `desktop/src-tauri/src/history.rs` | Persistent call history store with dedup |
|
||||||
|
| `crates/wzp-client/src/audio_io.rs` | CPAL capture + playback (baseline) |
|
||||||
|
| `crates/wzp-client/src/audio_vpio.rs` | macOS VoiceProcessingIO capture (AEC) |
|
||||||
|
| `crates/wzp-client/src/audio_wasapi.rs` | Windows WASAPI communications capture (AEC) |
|
||||||
|
| `vendor/audiopus_sys/opus/CMakeLists.txt` | Patched libopus for clang-cl SIMD |
|
||||||
|
| `scripts/Dockerfile.windows-builder` | Windows cross-compile Docker image |
|
||||||
|
| `scripts/build-windows-docker.sh` | Remote Docker build pipeline |
|
||||||
|
| `scripts/build-windows-cloud.sh` | Hetzner VPS alternative pipeline |
|
||||||
|
| `scripts/build-linux-docker.sh` | Linux x86_64 relay/CLI build pipeline |
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# PRD: Desktop Direct Calling — Backport SignalManager
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
The desktop Tauri app has the direct calling UI (Room/Direct Call toggle, Register, Call buttons) but the backend uses inline async code in `main.rs` instead of a proper `SignalManager`. This needs to be backported from the Android refactor.
|
|
||||||
|
|
||||||
## Tasks
|
|
||||||
|
|
||||||
1. **Create `signal_mgr.rs` for desktop** — same pattern as Android, or reuse the crate directly
|
|
||||||
2. **Wire into Tauri commands** — `register_signal` should use `SignalManager::connect()` + `run_recv_loop()` on a dedicated thread
|
|
||||||
3. **State polling** — `get_signal_status` should call `SignalManager::get_state_json()`
|
|
||||||
4. **place_call / answer_call** — delegate to SignalManager methods
|
|
||||||
5. **Merge android branch into desktop branch** — resolve the 37 desktop-only + 90 android-only commit divergence
|
|
||||||
6. **Test** — Android calls Desktop, Desktop calls Android
|
|
||||||
|
|
||||||
## UI Fixes
|
|
||||||
|
|
||||||
1. **Default alias** — generate random name on first start (like Android does)
|
|
||||||
2. **Default room** — change from "android" to "general"
|
|
||||||
3. **Fingerprint display** — ensure full `xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx` format (not truncated)
|
|
||||||
4. **Deregister button** — ability to disconnect signal channel
|
|
||||||
5. **Call state reset** — after hangup, return to "Registered" state, not stuck on "Ringing"
|
|
||||||
360
docs/PRD-dred-integration.md
Normal file
360
docs/PRD-dred-integration.md
Normal file
@@ -0,0 +1,360 @@
|
|||||||
|
# PRD: DRED Integration & Opus-Tier FEC Simplification
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
WarzonePhone's audio loss-recovery stack is built around classical Opus + application-level RaptorQ FEC. It was the right answer when WZP was designed, but libopus 1.5 (December 2023) introduced **Deep REDundancy (DRED)** — a neural speech-recovery feature that is strictly better than classical FEC for the loss patterns VoIP calls actually experience. We are paying real latency, bitrate, and complexity costs for protection that DRED now does better and cheaper.
|
||||||
|
|
||||||
|
Concretely, on every Opus call today we pay:
|
||||||
|
|
||||||
|
- **~40–100 ms of receiver-side latency** waiting for RaptorQ block completion before decode
|
||||||
|
- **10–20% bitrate overhead** from RaptorQ repair symbols (more on studio profiles)
|
||||||
|
- **~20–40% codec-internal overhead** from Opus inband FEC (LBRR)
|
||||||
|
- Classical Opus PLC on loss bursts exceeding the RaptorQ block size — which sounds robotic and gap-ridden
|
||||||
|
|
||||||
|
…in exchange for bit-exact recovery of isolated single-frame losses, which is perceptually indistinguishable from classical Opus PLC for 20 ms of speech. The protection is misaligned with the failure modes.
|
||||||
|
|
||||||
|
DRED delivers:
|
||||||
|
|
||||||
|
- **Zero added receive latency** — reconstruction runs only on detected loss
|
||||||
|
- **~1 kbps flat bitrate overhead** regardless of base bitrate
|
||||||
|
- **Plausible reconstruction of bursts up to ~1 second** — DRED's headline capability, exactly the regime RaptorQ can't touch
|
||||||
|
- Neural PLC that sounds like continuous speech, not a gap
|
||||||
|
|
||||||
|
We also have a second, unrelated problem blocking adoption: our FFI crate `audiopus_sys 0.2.2` vendors **libopus 1.3**, predating DRED entirely. We cannot enable DRED without first swapping the FFI layer. The naïve choice (`opus` crate from SpaceManiac) is a trap — it depends on the same dead `audiopus_sys`. The real target is `opusic-c 1.5.5` by DoumanAsh, which vendors libopus 1.5.2 with full DRED support and documents Android NDK cross-compile.
|
||||||
|
|
||||||
|
This PRD covers the FFI swap, DRED enablement, the decision to **remove RaptorQ and Opus inband FEC from the Opus tiers entirely** (keeping RaptorQ only for Codec2 where DRED is N/A), and the jitter buffer refactor that the DRED lookahead/backfill pattern requires.
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
- Replace `audiopus 0.3.0-rc.0` + `audiopus_sys 0.2.2` (dead upstream, libopus 1.3) with `opusic-c 1.5.5` + `opusic-sys 0.6.0` (active upstream, libopus 1.5.2)
|
||||||
|
- Enable DRED on every Opus profile with a tiered duration policy, lower at studio bitrates and higher at degraded bitrates
|
||||||
|
- Disable Opus inband FEC (LBRR) on all Opus profiles — opusic-c's own docs recommend this, and it overlaps DRED's job
|
||||||
|
- Remove `wzp-fec` (RaptorQ) from the Opus tiers entirely — the latency and bitrate savings are real, and DRED strictly dominates it on speech
|
||||||
|
- Keep RaptorQ + current FEC ratios on the Codec2 tiers unchanged — DRED is libopus-only, Codec2 has no neural equivalent
|
||||||
|
- Refactor `wzp-transport::jitter` to a lookahead/backfill pattern that lets DRED reconstruct loss windows when the next packet arrives, instead of the current "wait for block completion or fall through to classical PLC" policy
|
||||||
|
- Ship behind a runtime escape hatch (`AUDIO_USE_LEGACY_FEC`) for the first rollout window so we can revert to RaptorQ if DRED has surprises in real-world conditions
|
||||||
|
|
||||||
|
## Non-goals
|
||||||
|
|
||||||
|
- Changing Codec2 at all. Codec2 1200 / 3200 are outside the DRED lineage and keep their current RaptorQ protection, block sizes, and PLC path.
|
||||||
|
- Adding new Opus bitrate tiers or changing the quality adaptation thresholds. This PRD is about the protection layer, not the bitrate ladder.
|
||||||
|
- Enabling OSCE (Opus Speech Coding Enhancement — a separate libopus 1.5 neural post-processor that opusic-c exposes via an `osce` feature flag). Valuable, complementary, and free once opusic-c is in — but out of scope here to keep the PRD focused. Track as follow-up.
|
||||||
|
- Video, audio-over-MoQ, or any protocol-layer changes discussed in prior conversations.
|
||||||
|
- Touching the wzp-web / browser client. Browser Opus is a separate codepath via WebAudio / WASM libopus and is not affected by the native FFI swap.
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
### How the three protection mechanisms actually differ
|
||||||
|
|
||||||
|
| | Opus inband FEC (LBRR) | RaptorQ (wzp-fec) | DRED |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Layer | codec-internal | application, across Opus packets | codec-internal |
|
||||||
|
| What it sends | low-bitrate copy of the *previous* frame, embedded in every packet | fountain-code repair symbols across a block | neural-coded history of the recent past |
|
||||||
|
| Protection horizon | 1 packet back | block duration (currently 100 ms, proposed 40 ms) | configurable, 0–1040 ms |
|
||||||
|
| Recovery granularity | 1 frame (lower quality) | 1 frame (bit-exact) | 10 ms frames (plausible reconstruction) |
|
||||||
|
| Latency cost | 0 ms | block duration on receive | 0 ms |
|
||||||
|
| Bitrate cost | ~20–40% of base | `fec_ratio × base` (currently +20% GOOD, +50% DEGRADED) | ~1 kbps flat |
|
||||||
|
| Effective loss tolerance | ~single-packet losses | up to `(repair symbols / block)` losses, cliff beyond | bursts up to the configured duration |
|
||||||
|
| Content assumption | any Opus audio | any | speech (DRED model is speech-trained) |
|
||||||
|
|
||||||
|
### Why DRED dominates on the Opus tiers
|
||||||
|
|
||||||
|
Loss-scenario walkthrough (verified against opusic-c and libopus 1.5 docs):
|
||||||
|
|
||||||
|
- **1-frame loss (20 ms)**: RaptorQ recovers bit-exactly, DRED wouldn't run (classical Opus PLC is perceptually indistinguishable for single 20 ms frames). RaptorQ "wins" on paper but not on ears.
|
||||||
|
- **2–3 frame burst (40–60 ms)**: RaptorQ at current ratio 0.2 hits its tolerance cliff. DRED handles this trivially — well within a 200 ms window.
|
||||||
|
- **5–10 frame burst (100–200 ms)**: RaptorQ completely overwhelmed at any reasonable ratio. DRED's sweet spot.
|
||||||
|
- **10+ frame burst (>200 ms)**: RaptorQ useless. DRED at 500–1000 ms still recovers.
|
||||||
|
|
||||||
|
The only scenario where RaptorQ strictly beats DRED is bit-exact recovery of isolated single-frame losses — which is perceptually irrelevant for speech. In every other scenario DRED either ties or wins.
|
||||||
|
|
||||||
|
### Why Codec2 keeps RaptorQ
|
||||||
|
|
||||||
|
DRED lives inside libopus — it does not help Codec2 at all. Codec2's classical PLC is a parametric-vocoder interpolation that produces noticeably robotic artifacts on loss. On the Codec2 tiers, RaptorQ is the only protection we have, and it should stay at current ratios (1.0 on CATASTROPHIC, 0.5 on the Codec2 3200 tier).
|
||||||
|
|
||||||
|
### The opusic-c / opusic-sys situation
|
||||||
|
|
||||||
|
- `opusic-sys 0.6.0` — FFI crate, published 2026-03-17, vendors libopus 1.5.2 via its `bundled` feature (on by default), documents Android NDK cross-compile via `ANDROID_NDK_HOME` (which our `wzp-android/build.rs` already sets). Exposes raw bindings to `opus_dred_parse`, `opus_decoder_dred_decode`, and the `OpusDRED` state struct.
|
||||||
|
- `opusic-c 1.5.5` — high-level safe wrapper. Its **encoder** side is fine: exposes `Encoder::set_dred_duration(value: u8) -> Result<(), ErrorCode>` with range `0..=104` (each unit is 10 ms, so 0–1040 ms configurable). Also exposes `set_bitrate`, `set_inband_fec`, `set_dtx`, `set_packet_loss`, `set_signal`, `set_complexity`, `set_bandwidth`, `set_application` on the encoder.
|
||||||
|
- **opusic-c's decoder-side DRED wrapper is NOT sufficient for our architecture.** Confirmed by reading the source of `opusic-c/src/dred.rs`:
|
||||||
|
1. `Dred::decode_to` ignores the `dred_end` output of `opus_dred_parse` (prefixed `_dred_end`), so the caller cannot know how much DRED history a given packet actually carried.
|
||||||
|
2. In `opus_decoder_dred_decode(decoder, dred, dred_offset, pcm, frame_size)`, the wrapper passes `frame_size` to BOTH the `dred_offset` and `frame_size` arguments. This looks like a bug — it means reconstruction always starts at offset `frame_size` into the DRED window, not at an arbitrary caller-chosen offset. Arbitrary-gap reconstruction (which we need for the lookahead/backfill pattern) requires proper offset control.
|
||||||
|
3. `DredPacket` is owned internally by a `Dred` instance; its internal buffer is overwritten on every `decode_to` call. We cannot hold a ring of parsed DredPackets from multiple recent arrivals — which is exactly what the lookahead/backfill jitter buffer pattern requires.
|
||||||
|
- **Decision**: use opusic-c for the encoder path (its wrapper is correct and saves work), and drop to `opusic-sys` raw FFI for the entire decoder path AND the DRED reconstruction path. Both use a single shared `DecoderHandle` so internal decoder state stays consistent. **Verified at pre-flight**: `opusic_c::Decoder.inner` is `pub(crate)`, so there is no way to reach the raw `*mut OpusDecoder` from outside opusic-c. Running two parallel decoders (one from opusic-c for audio, one from opusic-sys for DRED) would cause state drift because the DRED-only decoder wouldn't see the normal decode calls. Single unified decoder via opusic-sys is the only correct architecture.
|
||||||
|
- **Three FFI handles required** per decode session: `opusic_c::Encoder` (encoder side, unchanged), our own `DecoderHandle` wrapping `*mut OpusDecoder` from opusic-sys (for normal decode AND for the `OpusDecoder` pointer passed to `opus_decoder_dred_decode`), and a new `DredDecoderHandle` wrapping `*mut OpusDREDDecoder` from opusic-sys (passed to `opus_dred_parse`). Note: `OpusDREDDecoder` is a **separate struct** from `OpusDecoder` in libopus 1.5 — verified from opus.h. Allocation via `opus_dred_decoder_create()` (confirm exact symbol name at Phase 3a start).
|
||||||
|
- The `opus` crate from SpaceManiac (0.3.1, published 2026-01-03) is a trap: it depends on `audiopus_sys ^0.2.0` — the same dead FFI crate we're trying to get away from. Do not use.
|
||||||
|
- **Follow-up (out of scope for this PRD)**: upstream the fixes to `opusic-c/src/dred.rs` (preserve `dred_end`, fix the `dred_offset` double-pass, expose `DredPacket` externally). Worth a GitHub PR once our own implementation has proven correct. Would let us eventually delete our internal FFI wrapper.
|
||||||
|
|
||||||
|
### Critical note from opusic-c docs
|
||||||
|
|
||||||
|
From the `dred` module documentation: *"The documentation recommends disabling in-band FEC and using `Application::Voip` for optimal results."* This applies to the **codec-internal** Opus inband FEC (LBRR), not our application-level RaptorQ. The two are independent layers. This PRD disables both on Opus tiers, but for different reasons — inband FEC per upstream recommendation, RaptorQ per the analysis above.
|
||||||
|
|
||||||
|
### The libopus 1.5 loss-percentage gating quirk
|
||||||
|
|
||||||
|
In libopus 1.5, both inband FEC and DRED are gated on `OPUS_SET_PACKET_LOSS_PERC` being non-zero. If the encoder thinks loss is 0%, it will not emit DRED data even when `set_dred_duration` is configured. We must plumb a meaningful loss percentage into the encoder continuously, floored at a small non-zero value so DRED stays active even when the network is perfect. Planned floor: **5%**, overridden upward by the real `QualityReport` loss value when it exceeds the floor.
|
||||||
|
|
||||||
|
## Solution
|
||||||
|
|
||||||
|
### High-level architecture change
|
||||||
|
|
||||||
|
**Before** (per Opus frame encode path):
|
||||||
|
```
|
||||||
|
PCM → AdaptiveEncoder.encode (Opus)
|
||||||
|
→ inband FEC embedded in packet
|
||||||
|
→ wzp-fec FEC encoder (accumulate into block, generate repair symbols)
|
||||||
|
→ DATAGRAM out
|
||||||
|
```
|
||||||
|
|
||||||
|
**Before** (per Opus frame decode path):
|
||||||
|
```
|
||||||
|
DATAGRAM in → wzp-fec block assembly (wait for block, recover if possible)
|
||||||
|
→ AdaptiveDecoder.decode (Opus) / decode_lost (classical PLC)
|
||||||
|
→ PCM
|
||||||
|
```
|
||||||
|
|
||||||
|
**After** (Opus tiers):
|
||||||
|
```
|
||||||
|
PCM → OpusEncoder.encode (opusic-c, DRED enabled via set_dred_duration, inband FEC off)
|
||||||
|
→ DATAGRAM out directly (no RaptorQ block)
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
DATAGRAM in → jitter buffer (lookahead/backfill)
|
||||||
|
→ on frame arrival: OpusDecoder.decode
|
||||||
|
→ on detected gap: if next packet has DRED state → dred::Dred.reconstruct(gap)
|
||||||
|
else → OpusDecoder.decode_lost (classical PLC)
|
||||||
|
→ PCM
|
||||||
|
```
|
||||||
|
|
||||||
|
**After** (Codec2 tiers): unchanged. RaptorQ block encoding + classical Codec2 decode path stay exactly as they are today.
|
||||||
|
|
||||||
|
### New per-profile protection matrix
|
||||||
|
|
||||||
|
| Profile | Codec | Inband FEC | RaptorQ ratio | DRED duration | Total overhead |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| `STUDIO_64K` | Opus 64k | **off** | **none** | **10 frames (100 ms)** | +1 kbps |
|
||||||
|
| `STUDIO_48K` | Opus 48k | **off** | **none** | **10 frames (100 ms)** | +1 kbps |
|
||||||
|
| `STUDIO_32K` | Opus 32k | **off** | **none** | **10 frames (100 ms)** | +1 kbps |
|
||||||
|
| `GOOD` | Opus 24k | **off** | **none** | **20 frames (200 ms)** | +1 kbps |
|
||||||
|
| `NORMAL_16K` | Opus 16k | **off** | **none** | **20 frames (200 ms)** | +1 kbps |
|
||||||
|
| `DEGRADED` | Opus 6k | **off** | **none** | **50 frames (500 ms)** | +1 kbps |
|
||||||
|
| `CODEC2_3200` | Codec2 3200 | N/A | **0.5 (unchanged)** | N/A | +50% |
|
||||||
|
| `CATASTROPHIC` | Codec2 1200 | N/A | **1.0 (unchanged)** | N/A | +100% |
|
||||||
|
| `COMFORT_NOISE` | CN | — | — | — | — |
|
||||||
|
|
||||||
|
DRED duration rationale:
|
||||||
|
|
||||||
|
- **Studio tiers (100 ms)**: loss is rare on the networks where users pick studio quality. Short DRED window keeps decode-side CPU modest. Still covers multi-frame bursts that classical PLC can't touch.
|
||||||
|
- **Normal tiers (200 ms)**: balanced baseline. Handles the common VoIP loss pattern (20–150 ms bursts from wifi roam, transient congestion).
|
||||||
|
- **Degraded tier (500 ms)**: users on Opus 6k are by definition on a bad link. Long DRED window buys maximum burst resilience where it matters most. Still well under the 1040 ms cap.
|
||||||
|
|
||||||
|
### Runtime escape hatch
|
||||||
|
|
||||||
|
Ship with a single environment variable / settings flag: **`AUDIO_USE_LEGACY_FEC`**. When set, the entire Opus-tier path reverts to the pre-PRD behavior: RaptorQ re-enabled at the old ratios, Opus inband FEC re-enabled, DRED disabled (`set_dred_duration(0)`). This is the rollback safety valve for the first production window.
|
||||||
|
|
||||||
|
Escape hatch semantics:
|
||||||
|
- Read once at `CallEncoder::new` / `CallDecoder::new` time. Call-scoped, not re-read mid-call.
|
||||||
|
- Exposed via Android Settings UI as a hidden "Legacy FEC (debug)" toggle, and as a CLI flag `--legacy-fec` on the desktop client.
|
||||||
|
- Logged in `DebugReporter` so we can tell which mode a call was in when diagnosing.
|
||||||
|
- Removed entirely after 2 months of stable production with no regressions reported. Removal is a follow-up PR, not part of this PRD's scope.
|
||||||
|
|
||||||
|
## Detailed design
|
||||||
|
|
||||||
|
### Phase 0 — FFI crate swap (prerequisite, no behavior change)
|
||||||
|
|
||||||
|
**Files touched:**
|
||||||
|
- `Cargo.toml` (workspace root) — replace `audiopus = "0.3.0-rc.0"` with `opusic-c = { version = "1.5.5", features = ["bundled", "dred"] }` and `opusic-sys = { version = "0.6.0", features = ["bundled"] }`. The `opusic-sys` direct dep is for the DRED decoder path below.
|
||||||
|
- `crates/wzp-codec/Cargo.toml` — update `audiopus = { workspace = true }` to `opusic-c = { workspace = true }`, add `opusic-sys = { workspace = true }`, add `bytemuck = "1"` for the i16↔u16 slice cast.
|
||||||
|
- `crates/wzp-codec/src/opus_enc.rs` — rewrite against opusic-c. API mapping:
|
||||||
|
- `audiopus::coder::Encoder::new(SampleRate::Hz48000, Channels::Mono, Application::Voip)` → `opusic_c::Encoder::new(Channels::Mono, SampleRate::Hz48000, Application::Voip)` (argument order swapped)
|
||||||
|
- `set_bitrate(Bitrate::BitsPerSecond(bps))` → `set_bitrate(Bitrate::Bits(bps))` or equivalent variant — verify at implementation time
|
||||||
|
- `set_inband_fec(true/false)` → `set_inband_fec(InbandFec::On/Off)` (now an enum)
|
||||||
|
- `set_packet_loss_perc(u8)` → `set_packet_loss(u8)` (method renamed)
|
||||||
|
- `set_dtx(bool)`, `set_signal(Signal::Voice)`, `set_complexity(u8)` — names match
|
||||||
|
- `encode(&[i16], &mut [u8])` → `encode_to_slice(&[u16], &mut [u8])` with `bytemuck::cast_slice::<i16, u16>(pcm)` at the call site
|
||||||
|
- `crates/wzp-codec/src/opus_dec.rs` — same-style rewrite for the `Decoder` path. Note that opusic-c's decoder methods take `decode_fec: bool` as a parameter directly (not a separate ctl).
|
||||||
|
- `vendor/audiopus_sys/` — delete the directory (only exists on `feat/desktop-audio-rewrite`, not on `android-rewrite`, so this is a no-op on the current branch but do remove the `[patch.crates-io]` block from Cargo.toml when merging back).
|
||||||
|
|
||||||
|
**Acceptance criteria:**
|
||||||
|
- `cargo check --workspace` passes on Linux x86_64, macOS, and Android NDK cross-compile.
|
||||||
|
- All existing codec unit tests in `crates/wzp-codec/src/adaptive.rs` pass unchanged. DRED is still disabled at this phase (default `set_dred_duration(0)`), so behavior is equivalent to pre-swap libopus 1.3 for call quality purposes.
|
||||||
|
- A short real-call smoke test produces audio identical to current behavior (no audible regression).
|
||||||
|
- `opusic_c::version()` at startup logs libopus version containing `1.5.2` — hard signal that the swap landed correctly.
|
||||||
|
|
||||||
|
### Phase 1 — DRED encoder enable on all Opus profiles
|
||||||
|
|
||||||
|
**Files touched:**
|
||||||
|
- `crates/wzp-codec/src/opus_enc.rs`:
|
||||||
|
- Add `fn dred_duration_for(codec: CodecId) -> u8` returning the per-profile value from the matrix above (10 / 20 / 50 frames).
|
||||||
|
- In `OpusEncoder::new`, after the existing `set_bitrate`/`set_signal`/`set_complexity` block: call `inner.set_inband_fec(InbandFec::Off)`, then `inner.set_dred_duration(dred_duration_for(profile.codec))`, then `inner.set_packet_loss(5)` as the default floor.
|
||||||
|
- Add `pub fn set_dred_duration(&mut self, frames: u8)` to allow the adaptive ladder to update DRED duration on profile switch.
|
||||||
|
- In the existing `set_profile` impl, call `set_dred_duration(dred_duration_for(profile.codec))` after `apply_bitrate`.
|
||||||
|
- `crates/wzp-codec/src/adaptive.rs`:
|
||||||
|
- `AdaptiveEncoder::set_profile` already delegates to `self.opus.set_profile` — no changes needed. DRED update rides along.
|
||||||
|
- `crates/wzp-client/src/call.rs` (and equivalent on `wzp-android/src/pipeline.rs`):
|
||||||
|
- In the `QualityReport` handler (wherever we currently call `set_expected_loss` / `set_packet_loss_perc`), also ensure the loss value is floored at 5% before passing to the Opus encoder. This is a 1-line change.
|
||||||
|
|
||||||
|
**Acceptance criteria:**
|
||||||
|
- Encoder produces DRED-enabled Opus packets. Verifiable via libopus's reference decoder in debug mode, or by wire capture + inspection — a DRED-bearing Opus packet has a larger `opus_packet_get_nb_frames` footprint than a non-DRED one of the same nominal bitrate.
|
||||||
|
- Total outgoing bitrate on Opus 24k is ~25 kbps (up from ~24 kbps) — confirms ~1 kbps DRED overhead.
|
||||||
|
- On a lossless path, decoder output is audibly identical to Phase 0.
|
||||||
|
- Escape hatch `AUDIO_USE_LEGACY_FEC=1` cleanly reverts the DRED enable (calls `set_dred_duration(0)` and `set_inband_fec(InbandFec::On)` instead).
|
||||||
|
|
||||||
|
### Phase 2 — RaptorQ removal on Opus tiers
|
||||||
|
|
||||||
|
**Files touched:**
|
||||||
|
- `crates/wzp-client/src/call.rs`:
|
||||||
|
- In `CallEncoder::encode_frame` (or wherever `wzp_fec::Encoder::add_source_symbol` is called), gate the RaptorQ path on `!profile.codec.is_opus()` — Opus frames go straight to DATAGRAM emit, Codec2 frames continue through RaptorQ.
|
||||||
|
- When a profile switch crosses the Opus↔Codec2 boundary, flush/reset the RaptorQ encoder state.
|
||||||
|
- `crates/wzp-android/src/pipeline.rs`:
|
||||||
|
- Mirror the same gate in the Android encode path.
|
||||||
|
- `crates/wzp-proto/src/packet.rs`:
|
||||||
|
- `MediaHeader.fec_block` and `fec_symbol` are still valid fields on the wire. For Opus packets we emit `fec_block = 0`, `fec_symbol = 0`, `fec_ratio_encoded = 0`. No wire format change; the receiver just sees all-zeros in the FEC fields for Opus packets and skips the FEC decoder path.
|
||||||
|
- Bump protocol version to v1 → v2? **No** — the change is semantically backward compatible because existing RaptorQ decoders handle a zero ratio correctly (ratio 0.0 means "no repair symbols expected"). Old receivers can still decode new Opus packets; they just won't see any DRED benefit because their libopus is old. This is a property we want: the opposite (new receiver, old sender) is the more common mixed-version case during rollout and also Just Works.
|
||||||
|
- `crates/wzp-client/src/call.rs` — `CallDecoder`:
|
||||||
|
- Symmetric change: Opus frames bypass the RaptorQ block assembly, go straight to the decoder. Only Codec2 frames (`codec_id.is_codec2()`) feed through `wzp-fec` block decoding.
|
||||||
|
|
||||||
|
**Acceptance criteria:**
|
||||||
|
- Outgoing Opus packets have `fec_ratio_encoded == 0` (verifiable with the existing wire capture tooling in `wzp-client/src/echo_test.rs`).
|
||||||
|
- On a clean network, receiver latency (measured as encode-to-playout one-way delay) drops by ~40 ms versus Phase 1. This is the primary win and should be directly measurable with the existing telemetry.
|
||||||
|
- Codec2 calls show no latency change and no packet-format change. Regression-test Codec2 3200 and Codec2 1200 specifically.
|
||||||
|
- Total outgoing bitrate on Opus 24k drops from ~28.8 kbps (24k base + 0.2 RaptorQ ratio) to ~25 kbps (24k base + ~1 kbps DRED). Direct savings observable in network telemetry.
|
||||||
|
|
||||||
|
### Phase 3 — DRED reconstruction wrapper + jitter buffer lookahead/backfill refactor
|
||||||
|
|
||||||
|
This phase is larger than originally estimated because opusic-c's decoder-side DRED wrapper is unusable for our architecture (see Background). We write our own safe wrapper over `opusic-sys` raw FFI first, then plumb it through the jitter buffer.
|
||||||
|
|
||||||
|
**Step 3a — Safe DRED reconstruction wrapper in `wzp-codec`:**
|
||||||
|
|
||||||
|
New file `crates/wzp-codec/src/dred_ffi.rs`. Wraps the raw libopus 1.5 DRED API:
|
||||||
|
|
||||||
|
- `pub struct DredState` — owns an `OpusDRED` buffer (allocated via `opusic_sys::opus_dred_alloc` or equivalent; size is fixed at 10,592 bytes per libopus 1.5). `Clone` is intentionally NOT implemented — the state is heap-owned and non-trivial to copy.
|
||||||
|
- `pub fn parse_from_packet(&mut self, decoder: &opusic_c::Decoder, packet: &[u8], max_dred_samples: i32) -> Result<DredParseResult, DredError>` — wraps `opus_dred_parse`, preserves the `dred_end` output (number of samples of history the packet carried), returns it in `DredParseResult { samples_available: i32, frames_available: u8 }`.
|
||||||
|
- `pub fn reconstruct_into(&self, decoder: &mut opusic_c::Decoder, dred_offset_samples: i32, output: &mut [i16]) -> Result<usize, DredError>` — wraps `opus_decoder_dred_decode`, takes the offset explicitly, decodes `output.len()` samples starting from that offset in the DRED window.
|
||||||
|
- All `unsafe` contained here, strict bounds checking on offsets, Rust-level panic safety. Unit tests use a reference encoder + known-good reference decoder to verify that reconstruction at specific offsets produces expected output.
|
||||||
|
- Depends on `opusic-sys` directly and on `opusic-c::Decoder` for the decoder handle. The Decoder handle must be reachable as a raw pointer; opusic-c exposes this via an unstable internal or we wrap the pointer ourselves. **Verify at implementation time** — if opusic-c doesn't expose the raw decoder pointer safely, we create our own thin Decoder wrapper in `dred_ffi.rs` using raw opusic-sys, losing the convenience of opusic-c's decoder but keeping its encoder. This is the smaller-risk fallback.
|
||||||
|
|
||||||
|
New `pub trait DredReconstructor` in `wzp-codec/src/lib.rs`:
|
||||||
|
```rust
|
||||||
|
pub trait DredReconstructor: Send {
|
||||||
|
/// Parse DRED state from an arriving Opus packet into `state`.
|
||||||
|
/// Returns number of 48 kHz samples of history available, or 0 if the packet has no DRED.
|
||||||
|
fn parse(&mut self, state: &mut DredState, packet: &[u8]) -> Result<i32, DredError>;
|
||||||
|
|
||||||
|
/// Reconstruct `output.len()` samples from `state`, starting at the given
|
||||||
|
/// sample offset (measured from the end of the DRED window going backward).
|
||||||
|
fn reconstruct(&mut self, state: &DredState, offset_samples: i32, output: &mut [i16]) -> Result<usize, DredError>;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Implement `DredReconstructor` over the `dred_ffi::DredState` + opusic-c Decoder combination. This is the clean boundary the jitter buffer will talk to.
|
||||||
|
|
||||||
|
**Step 3b — Jitter buffer refactor in `crates/wzp-transport/src/jitter.rs`:**
|
||||||
|
|
||||||
|
- Current behavior: buffer waits a fixed number of frames of jitter before emitting; on a missing slot, after a timeout it gives up and signals the decoder to run `decode_lost()` (classical Opus PLC or Codec2 PLC).
|
||||||
|
- New behavior on Opus tiers: when a frame arrives (in-order or late), first call `DredReconstructor::parse` on it to update a rolling ring of `DredState` instances tagged with their originating sequence number. When a gap is detected (missing sequence number between last-emitted and current arrival), and the ring contains a `DredState` from a nearby packet that covers the gap's sample offset, call `DredReconstructor::reconstruct` with the correct offset to synthesize the missing frames, splice them into playout, then continue normal decode.
|
||||||
|
- If no DRED state covers the gap (e.g., gap too far back, or every nearby packet was dropped), fall through to classical PLC exactly as today. The classical path stays intact as the ultimate fallback.
|
||||||
|
- Codec2 packets bypass the entire DRED ring. They are not inspected for DRED state and take the unchanged classical PLC path.
|
||||||
|
- Ring sizing: `max_dred_duration_frames` + `jitter_depth_frames` worth of `DredState` instances. At 500 ms DRED on degraded tier + 60 ms jitter depth, that's ~28 DredState instances × 10,592 bytes ≈ 300 KB. Acceptable. On studio tier with 100 ms DRED it's only ~80 KB.
|
||||||
|
- The jitter buffer takes a `Box<dyn DredReconstructor>` at construction, passed in by the call engine. `wzp-transport` does NOT take a direct dep on `opusic-c` or `opusic-sys` — it only knows about the trait defined in `wzp-codec`.
|
||||||
|
|
||||||
|
**Files touched:**
|
||||||
|
- `crates/wzp-codec/src/dred_ffi.rs` (new, ~150–300 lines)
|
||||||
|
- `crates/wzp-codec/src/lib.rs` — expose `DredReconstructor`, `DredState`, `DredError` types
|
||||||
|
- `crates/wzp-codec/Cargo.toml` — add `opusic-sys = { workspace = true }` as a direct dep (already done in Phase 0)
|
||||||
|
- `crates/wzp-transport/src/jitter.rs` — lookahead/backfill refactor, DRED ring
|
||||||
|
- `crates/wzp-transport/Cargo.toml` — add `wzp-codec = { workspace = true }` (likely already present) for the trait import
|
||||||
|
- `crates/wzp-client/src/call.rs` — construct a `DredReconstructor` and pass into `CallDecoder`'s jitter buffer
|
||||||
|
- `crates/wzp-android/src/pipeline.rs` — same on Android
|
||||||
|
|
||||||
|
**Acceptance criteria:**
|
||||||
|
- Unit tests in `dred_ffi.rs`: round-trip a known speech waveform through an encoder with DRED enabled, parse the resulting packets, reconstruct at several different offsets, verify the reconstructed samples are within an energy/spectral threshold of the original. (Not bit-exact — DRED reconstruction is lossy by design.)
|
||||||
|
- Synthetic loss test on the full pipeline: inject 200 ms bursts at 10% rate into a looped call, verify the DRED reconstruction rate on receiver telemetry is ≥95% of all loss events whose gaps fall within the configured DRED duration window.
|
||||||
|
- Reconstructed audio is audibly continuous on 40–200 ms bursts — no gaps, no classical-PLC robot artifact. Verified on real voice samples (not just sine tones), and on at least two distinct speaker profiles (male, female) because DRED can have voice-dependent quality.
|
||||||
|
- End-to-end latency metric is unchanged versus Phase 2 (no regression from adding the lookahead path). The DRED ring insertion on packet arrival must be O(1) in practice.
|
||||||
|
- Existing `echo_test.rs` and `drift_test.rs` pass with the new jitter buffer.
|
||||||
|
- Codec2 path uses classical PLC exclusively (no DRED invocation) because Codec2 packets don't carry DRED state. Verify by injecting loss on a Codec2 call and confirming zero DRED reconstruction telemetry events during that call.
|
||||||
|
- `wzp-transport` has no direct dependency on `opusic-sys` or `opusic-c` in its `Cargo.toml` after the refactor — only on `wzp-codec`. Verify by grepping the Cargo.toml file.
|
||||||
|
|
||||||
|
### Phase 4 — Telemetry and tooling updates
|
||||||
|
|
||||||
|
**Files touched:**
|
||||||
|
- `crates/wzp-proto/src/packet.rs` — `QualityReport` or equivalent telemetry message gains `dred_reconstructions: u32` as a new counter (frames reconstructed via DRED this reporting window) and `classical_plc_invocations: u32` (frames filled by Opus/Codec2 classical PLC). These are separate counters because they're different recovery mechanisms.
|
||||||
|
- `crates/wzp-relay/src/*` — relay telemetry pipeline surfaces both counters in Prometheus metrics: `wzp_dred_reconstructions_total{call_id}`, `wzp_classical_plc_total{call_id}`.
|
||||||
|
- `docs/grafana-dashboard.json` — new panel: "Loss recovery breakdown" stacked bar, DRED vs classical PLC vs clean decode, per call.
|
||||||
|
- `android/app/src/main/java/com/wzp/debug/DebugReporter.kt` — surfaces `dredReconstructions` and `classicalPlc` counts in the debug report; also logs active DRED duration and whether legacy-FEC mode is engaged.
|
||||||
|
|
||||||
|
**Acceptance criteria:**
|
||||||
|
- Grafana dashboard shows a clear visual distinction between DRED-recovered and classical-PLC-recovered frames across a test fleet of calls.
|
||||||
|
- Debug report includes the active protection mode ("DRED 200 ms" / "Legacy RaptorQ") and reconstruction counts, so incidents can be classified unambiguously.
|
||||||
|
|
||||||
|
### Phase 5 — Escape hatch removal (follow-up, ~2 months post-ship)
|
||||||
|
|
||||||
|
After 2 months of stable production with no rollbacks triggered:
|
||||||
|
- Delete `AUDIO_USE_LEGACY_FEC` handling in `opus_enc.rs` / `call.rs` / `pipeline.rs`
|
||||||
|
- Delete the Opus-tier paths of `wzp-fec` (the crate stays for Codec2)
|
||||||
|
- Delete the Android settings toggle and desktop CLI flag
|
||||||
|
- Remove the `--legacy-fec` path from smoke tests
|
||||||
|
|
||||||
|
## Critical files to modify (summary)
|
||||||
|
|
||||||
|
- `Cargo.toml` (workspace) — dep swap (audiopus → opusic-c + opusic-sys)
|
||||||
|
- `crates/wzp-codec/Cargo.toml` — dep swap + `bytemuck` for slice cast
|
||||||
|
- `crates/wzp-codec/src/opus_enc.rs` — opusic-c rewrite + DRED enable + inband FEC off
|
||||||
|
- `crates/wzp-codec/src/opus_dec.rs` — opusic-c rewrite
|
||||||
|
- `crates/wzp-codec/src/dred_ffi.rs` — **new file**, safe wrapper over opusic-sys raw DRED FFI
|
||||||
|
- `crates/wzp-codec/src/lib.rs` — expose `DredReconstructor` trait, `DredState`, `DredError`
|
||||||
|
- `crates/wzp-codec/src/adaptive.rs` — verify profile switch carries DRED duration
|
||||||
|
- `crates/wzp-client/src/call.rs` — Opus/Codec2 gate on RaptorQ path, loss floor, wire DredReconstructor into CallDecoder
|
||||||
|
- `crates/wzp-android/src/pipeline.rs` — same gate, same loss floor, wire DredReconstructor
|
||||||
|
- `crates/wzp-transport/src/jitter.rs` — lookahead/backfill refactor, DRED ring, reconstruction dispatch
|
||||||
|
- `crates/wzp-transport/Cargo.toml` — verify it depends only on `wzp-codec`, not directly on opusic-*
|
||||||
|
- `crates/wzp-proto/src/packet.rs` — new telemetry counters
|
||||||
|
- `crates/wzp-relay/` — Prometheus metric exposure
|
||||||
|
- `android/app/src/main/java/com/wzp/debug/DebugReporter.kt` — debug output
|
||||||
|
- `docs/grafana-dashboard.json` — loss-recovery panel
|
||||||
|
- (delete) `vendor/audiopus_sys/` on `feat/desktop-audio-rewrite` when merging back
|
||||||
|
|
||||||
|
## Existing utilities to reuse
|
||||||
|
|
||||||
|
- `wzp_codec::resample::Downsampler48to8` / `Upsampler8to48` — unchanged, only Codec2 path uses them
|
||||||
|
- `wzp_codec::adaptive::AdaptiveEncoder` / `AdaptiveDecoder` — existing profile-switching machinery, DRED duration changes ride along
|
||||||
|
- `wzp_codec::silence::SilenceDetector` / `ComfortNoise` — unchanged
|
||||||
|
- `wzp_codec::agc::AutoGainControl` — unchanged, runs before encode as today
|
||||||
|
- `wzp_fec::RaptorQFecEncoder` / decoder — unchanged, still used for Codec2 tiers
|
||||||
|
- `wzp_client::call::QualityAdapter` — unchanged; drives profile switching, which now also reconfigures DRED duration via the existing `set_profile` path
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
End-to-end testing, in order:
|
||||||
|
|
||||||
|
1. **Unit**: `cargo test -p wzp-codec` — Opus encode/decode round-trip at every profile, DRED enabled. Verify `version()` reports libopus 1.5.2.
|
||||||
|
2. **Unit**: `cargo test -p wzp-transport` — jitter buffer lookahead/backfill behavior with injected loss patterns (0%, 5%, 15%, 30%, 50% loss; isolated losses, 40 ms bursts, 200 ms bursts, 500 ms bursts).
|
||||||
|
3. **Integration**: `crates/wzp-client/src/echo_test.rs` — existing echo test must pass on all Opus profiles with <5% perceived quality regression (measure via the time-window analysis already built into `echo_test.rs`).
|
||||||
|
4. **Integration**: `crates/wzp-client/src/drift_test.rs` — latency measurement. Must show ~40 ms reduction on Opus profiles versus pre-PRD baseline. Codec2 profiles unchanged.
|
||||||
|
5. **Manual**: Android release build, real call over bad wifi (or a shaped network via `tc netem` on Linux). Burst losses of 200 ms should be perceptually continuous speech, not robotic gaps.
|
||||||
|
6. **Manual**: Same call with `AUDIO_USE_LEGACY_FEC=1` — verify behavior reverts to current production behavior. This is the pre-ship rollback rehearsal.
|
||||||
|
7. **Cross-compile**: full build matrix — Android arm64-v8a + armeabi-v7a (via `scripts/build-and-notify.sh`), macOS universal, Linux x86_64 (via `scripts/build-linux-docker.sh`). Windows cross-compile via cargo-xwin should also pass — libopus 1.5 upstream fixed the clang-cl SIMD issue that required the vendor patch on `feat/desktop-audio-rewrite`.
|
||||||
|
8. **Telemetry smoke**: deploy to staging relay, make 10 test calls, verify Grafana's new "Loss recovery breakdown" panel shows DRED reconstruction events firing on injected loss and classical-PLC on packet-loss beyond DRED's window.
|
||||||
|
|
||||||
|
## Risks and mitigations
|
||||||
|
|
||||||
|
- **Custom DRED FFI wrapper is WZP-maintained code with no second source.** opusic-c's decoder-side DRED wrapper is insufficient (see Background), so we carry our own `dred_ffi.rs` that calls `opus_dred_parse` and `opus_decoder_dred_decode` directly via opusic-sys. Bugs in this wrapper — offset arithmetic off-by-ones, lifetime errors on `OpusDRED` buffers, UB from misuse of the C API — could manifest as silent audio corruption on loss bursts, hard to diagnose. **Mitigation**: extensive unit tests in `dred_ffi.rs` using a reference encoder + reference decoder round-trip with known offsets; strict bounds checking on every `unsafe` boundary; Miri run in CI if feasible; the legacy-FEC escape hatch disables the entire DRED code path including our custom wrapper, giving us a single flag to revert any wrapper bug in production. Long-term: upstream the fixes to opusic-c (follow-up task, not blocking).
|
||||||
|
- **opusic-c's encoder-side API and internal Decoder pointer access**. Step 3a depends on being able to call opusic-sys raw functions that take an `*mut OpusDecoder` pointer while still using opusic-c's `Decoder` for normal decode. If opusic-c doesn't expose the raw pointer cleanly, we fall back to a thin opusic-sys-direct Decoder wrapper inside `dred_ffi.rs` and lose some of opusic-c's convenience. **Mitigation**: verify at the start of Phase 3 (one afternoon of reading opusic-c source). If the clean path doesn't work, the fallback is not difficult — it's what we'd have built anyway if opusic-c didn't exist.
|
||||||
|
- **DRED reconstruction quality varies by voice / content**. The neural model is trained on speech; edge cases (shouting, whispering, heavy accents, music-on-hold, cough, laughter) may reconstruct less cleanly than continuous speech. **Mitigation**: escape hatch ships from day one. If production telemetry shows perceptible quality regression on specific voice patterns, flip legacy mode for affected users while tuning. Also: classical Opus PLC remains as the third-tier fallback when DRED state is unavailable.
|
||||||
|
- **Removing RaptorQ removes bit-exact recovery**. Isolated single-packet losses are now reconstructed plausibly instead of bit-exactly. **Mitigation**: as argued in Background, bit-exactness on a single 20 ms speech frame is perceptually meaningless. The assumption is "speech is the workload" — if we ever add non-speech features (music bot, ringtones over the call path, DTMF-over-audio) we revisit.
|
||||||
|
- **libopus 1.5 DRED API stability**. **Verified at pre-flight**: opus.h in the upstream xiph/opus repository has no "experimental" marker on the DRED API declarations. The earlier characterization was incorrect. DRED shipped as a first-class feature in libopus 1.5.0 (Dec 2023) and has been iterated in 1.5.1 and 1.5.2. Google Meet and Duo ship it at scale. **Mitigation**: pin `opusic-sys` exactly (no `^` range) to ensure reproducible builds, follow upstream 1.5.x bugfixes as they land. No special stability concerns beyond normal dependency hygiene.
|
||||||
|
- **Jitter buffer refactor is the largest code change**. Jitter bugs are notoriously subtle (off-by-one on sequence wraparound, clock drift interactions, playout starvation corner cases). **Mitigation**: keep the classical-PLC path intact as the DRED fallback, so jitter bugs degrade to "current behavior" rather than "broken audio". Write targeted unit tests for the buffer at each loss-pattern scenario before touching production paths. Consider shipping Phase 3 behind a sub-flag separate from the main escape hatch, so we can independently toggle "DRED enabled but classical jitter buffer" for bisection.
|
||||||
|
- **Cross-compile surprises**. `opusic-sys` is actively maintained but our exact combination of Android NDK version / Docker builder environment / Windows cross-compile via cargo-xwin has not been tested by upstream. **Mitigation**: Phase 0 includes the full cross-compile matrix as an acceptance criterion. Any blockers surface before we touch loss-recovery behavior.
|
||||||
|
- **Wire-format compatibility during rollout**. Mixed-version calls (new sender + old receiver, or vice versa) need to keep working. **Verified at pre-flight**: traced both live receive paths (`wzp-client/src/call.rs::CallDecoder::ingest` and `wzp-android/src/engine.rs` the JNI-driven engine path), and both degrade gracefully: new-sender Opus packets with `fec_ratio_encoded=0` / `fec_block=0` / `fec_symbol=0` flow through to the jitter buffer and decode normally on old receivers. The RaptorQ decoder either ignores zero-FEC packets entirely (Android pipeline.rs gates on non-zero fec_block/fec_symbol) or accumulates them harmlessly until the 2-second staleness eviction (desktop call.rs). Old-sender packets with populated RaptorQ fields are handled by new receivers via the unchanged Codec2 path (new receivers keep wzp-fec for Codec2 tiers and simply ignore RaptorQ fields on Opus packets). **No wire format version bump required.**
|
||||||
|
- **Pre-existing desktop RaptorQ gap** (incidental finding, NOT caused by this PRD). The desktop `wzp-client/src/call.rs::CallDecoder` feeds packets into `fec_dec.add_symbol` but **never calls `fec_dec.try_decode`** — RaptorQ recovery is effectively dead code on the desktop path today. Main decode reads from the jitter buffer directly, falling through to classical Opus PLC on missing packets. The Android `engine.rs` path properly uses `try_decode` for recovery. This PRD does not fix the desktop gap — it's unrelated — but is noted here so nobody is surprised that removing RaptorQ from Opus tiers on the desktop client causes no measurable recovery regression (there was nothing to lose). Recommend filing a follow-up task to either fix or remove the vestigial desktop RaptorQ wiring independently of this work.
|
||||||
|
- **`AUDIO_USE_LEGACY_FEC` itself becoming permanent tech debt**. Escape hatches have a way of outliving their intended lifespan. **Mitigation**: put an explicit removal date in a `// TODO(2026-06-15): remove legacy FEC path` comment at the flag-handling site. Track in taskmaster.
|
||||||
|
|
||||||
|
## Open questions
|
||||||
|
|
||||||
|
- ~~**Does opusic-c expose `opusic_c::Decoder`'s raw inner pointer?**~~ **Resolved at pre-flight**: no, it's `pub(crate)`. We build a unified `DecoderHandle` over raw opusic-sys in `dred_ffi.rs` and use it for both normal decode and DRED reconstruction. Opusic-c is used only for the encoder side.
|
||||||
|
- **Exact opusic-sys symbol name for DRED decoder allocation**. opus.h documents the `OpusDREDDecoder` type and `opus_dred_parse`/`opus_decoder_dred_decode` functions, but the allocation function name is not in the fetched snippet. Expected to be `opus_dred_decoder_create` / `opus_dred_decoder_destroy` per libopus naming convention, but confirm at the very start of Phase 3a by reading the actual opusic-sys bindings. If the function is not exported by opusic-sys, we file a PR upstream to opusic-sys (small fix, trivially mergeable) and temporarily vendor the function declaration locally.
|
||||||
|
- **Should the 5% loss floor be configurable per profile?** Currently specified as a constant. A future refinement might make it higher at degraded tiers and lower at studio tiers, but without real telemetry we don't know if the constant is wrong. Keep as a constant for now, revisit after 1 month of production data.
|
||||||
|
- **OSCE enable**: opusic-c has an `osce` feature flag for Opus Speech Coding Enhancement, a separate libopus 1.5 neural post-processor. Out of scope for this PRD but should be the next audio-quality follow-up. Probably one-line enable once opusic-c is in.
|
||||||
|
- **Upstream PR to opusic-c**: our own `dred_ffi.rs` wrapper should be proven in production first, then the fixes upstreamed to `opusic-c/src/dred.rs` (preserve `dred_end`, fix `dred_offset` double-pass, expose `DredPacket` externally). Follow-up task, not blocking this PRD.
|
||||||
|
- **`feat/desktop-audio-rewrite` merge**: the vendored `audiopus_sys` patch on that branch becomes obsolete under this PRD. Coordinate removal with whoever owns that branch.
|
||||||
141
docs/PRD-local-recording.md
Normal file
141
docs/PRD-local-recording.md
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
# PRD: Local Recording + Cloud Mixer for Podcast-Quality Interviews
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
WarzonePhone delivers real-time encrypted voice, but the audio quality is limited by network conditions (codec compression, packet loss, jitter). Podcasters and interviewers need pristine, studio-grade recordings of each participant — independent of what the network delivers.
|
||||||
|
|
||||||
|
## Solution
|
||||||
|
|
||||||
|
**Dual-path architecture**: each client simultaneously (1) participates in the live call at whatever codec quality the network supports, and (2) records their own microphone locally as lossless PCM. After the session, all local recordings are uploaded to a self-hosted mixer service that aligns, normalizes, and outputs a final multi-track or mixed file.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
┌──────────────────┐
|
||||||
|
Mic ──┬── Opus/Codec2 ──► Network (live) │ ← real-time call
|
||||||
|
│ └──────────────────┘
|
||||||
|
│
|
||||||
|
└── WAV 48kHz ────► Local File │ ← pristine recording
|
||||||
|
(timestamped)
|
||||||
|
│
|
||||||
|
▼ (after hangup)
|
||||||
|
┌──────────────────┐
|
||||||
|
│ Mixer Service │ ← self-hosted
|
||||||
|
│ (align + mix) │
|
||||||
|
└──────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
Final MP3/WAV/FLAC
|
||||||
|
```
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
### Phase 1: Local Recording (MVP)
|
||||||
|
|
||||||
|
**All clients (Desktop, Android, Web):**
|
||||||
|
|
||||||
|
1. **Record toggle**: User can enable "Record this call" before or during a call
|
||||||
|
2. **Recording pipeline**: Tap raw PCM from the microphone capture path *before* it enters the codec encoder
|
||||||
|
3. **File format**: WAV (48kHz, 16-bit, mono) — simple, universally supported, lossless
|
||||||
|
4. **Sync markers**: Embed a monotonic timestamp (ms since call start) at the beginning of the recording, and periodically (every 10s) write a sync marker packet into a sidecar JSON file:
|
||||||
|
```json
|
||||||
|
{"ts_ms": 30000, "seq": 1500, "wall_clock_utc": "2026-04-07T12:00:30Z"}
|
||||||
|
```
|
||||||
|
This allows the mixer to align recordings from different participants even if they join at different times.
|
||||||
|
5. **Storage**:
|
||||||
|
- Desktop: `~/.wzp/recordings/{room}_{timestamp}.wav`
|
||||||
|
- Android: `Documents/WarzonePhone/{room}_{timestamp}.wav`
|
||||||
|
- Web: IndexedDB blob or File System Access API
|
||||||
|
6. **File size estimate**: 48kHz * 16-bit * mono = 96 KB/s = ~5.6 MB/min = ~345 MB/hour
|
||||||
|
7. **UI indicator**: Red dot + timer showing recording is active and file size growing
|
||||||
|
8. **On hangup**: Close the WAV file, show "Recording saved" with file path/size
|
||||||
|
|
||||||
|
### Phase 2: Upload to Mixer
|
||||||
|
|
||||||
|
1. **Upload endpoint**: Self-hosted HTTP service (Rust or Go) that accepts WAV uploads with metadata
|
||||||
|
2. **Chunked/resumable upload**: Large files need resumable uploads (tus protocol or simple chunked POST)
|
||||||
|
3. **Upload metadata**:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"session_id": "uuid",
|
||||||
|
"participant_fingerprint": "xxxx:xxxx:...",
|
||||||
|
"alias": "Alice",
|
||||||
|
"room": "podcast-ep-42",
|
||||||
|
"duration_secs": 3600,
|
||||||
|
"sync_markers": [...],
|
||||||
|
"sample_rate": 48000,
|
||||||
|
"channels": 1,
|
||||||
|
"bit_depth": 16
|
||||||
|
}
|
||||||
|
```
|
||||||
|
4. **Upload UI**: Progress bar after hangup, option to upload now or later
|
||||||
|
5. **Retry on failure**: Queue uploads for retry if network is unavailable
|
||||||
|
|
||||||
|
### Phase 3: Mixer Service
|
||||||
|
|
||||||
|
1. **Alignment**: Use sync markers (wall clock + sequence numbers) to align recordings from all participants to a common timeline
|
||||||
|
2. **Silence trimming**: Detect and optionally trim leading/trailing silence
|
||||||
|
3. **Normalization**: Per-track loudness normalization (LUFS-based)
|
||||||
|
4. **Noise reduction**: Optional per-track noise gate or RNNoise pass
|
||||||
|
5. **Output formats**:
|
||||||
|
- Multi-track: ZIP of individual WAVs (aligned, normalized)
|
||||||
|
- Mixed: Single stereo or mono WAV/MP3/FLAC with all participants
|
||||||
|
- Podcast-ready: Loudness-normalized to -16 LUFS (podcast standard)
|
||||||
|
6. **Web UI**: Simple dashboard to see sessions, download outputs, preview waveforms
|
||||||
|
7. **Self-hosted**: Docker image, single binary, SQLite for metadata
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
### Recording tap point
|
||||||
|
|
||||||
|
The recording must tap *after* AGC (so levels are normalized) but *before* the codec encoder (to avoid compression artifacts). In the current architecture:
|
||||||
|
|
||||||
|
```
|
||||||
|
Mic → Ring Buffer → AGC → [TAP HERE for recording] → Opus/Codec2 → Network
|
||||||
|
```
|
||||||
|
|
||||||
|
**Desktop** (`engine.rs`): After `capture_agc.process_frame()`, before `encoder.encode()`
|
||||||
|
**Android** (`engine.rs`): Same location — after AGC, before encode
|
||||||
|
**CLI** (`call.rs`): After `self.agc.process_frame()` in `CallEncoder::encode_frame()`
|
||||||
|
|
||||||
|
### WAV writer
|
||||||
|
|
||||||
|
Use a simple streaming WAV writer that:
|
||||||
|
- Writes the WAV header with placeholder data length
|
||||||
|
- Appends PCM samples as they come
|
||||||
|
- On close, seeks back to update the data length in the header
|
||||||
|
|
||||||
|
### Sync mechanism
|
||||||
|
|
||||||
|
Wall-clock UTC alone is insufficient (clocks drift). The sync strategy:
|
||||||
|
1. Each participant records their local monotonic time + wall clock at call start
|
||||||
|
2. Periodically (every 10s), each participant writes: `{local_mono_ms, seq_number, utc_iso}`
|
||||||
|
3. The mixer uses sequence numbers (which are shared via the wire protocol) as ground truth for alignment, with wall clock as a fallback
|
||||||
|
|
||||||
|
### Privacy
|
||||||
|
|
||||||
|
- Local recordings never leave the device without explicit user action
|
||||||
|
- Upload is manual, not automatic
|
||||||
|
- The mixer service processes files and can delete originals after mixing
|
||||||
|
- No recording data flows through the relay — only the user's own mic
|
||||||
|
|
||||||
|
## Non-Goals (v1)
|
||||||
|
|
||||||
|
- Live transcription (future)
|
||||||
|
- Video recording (audio only)
|
||||||
|
- Automatic upload without user consent
|
||||||
|
- Recording other participants' audio (only your own mic)
|
||||||
|
- Real-time mixing (post-session only)
|
||||||
|
|
||||||
|
## Milestones
|
||||||
|
|
||||||
|
| Phase | Scope | Effort |
|
||||||
|
|-------|-------|--------|
|
||||||
|
| 1a | Local WAV recording on Desktop | 1-2 days |
|
||||||
|
| 1b | Local WAV recording on Android | 1-2 days |
|
||||||
|
| 1c | Sync markers + metadata sidecar | 1 day |
|
||||||
|
| 2a | Upload service (HTTP + storage) | 2-3 days |
|
||||||
|
| 2b | Upload UI in clients | 1-2 days |
|
||||||
|
| 3a | Mixer: alignment + normalization | 2-3 days |
|
||||||
|
| 3b | Mixer: web dashboard | 2-3 days |
|
||||||
|
| 3c | Docker packaging | 1 day |
|
||||||
56
docs/PRD-studio-quality.md
Normal file
56
docs/PRD-studio-quality.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# PRD: Studio Quality Tiers (Opus 32k/48k/64k)
|
||||||
|
|
||||||
|
## Status: Implemented
|
||||||
|
|
||||||
|
Studio quality tiers have been added to the wire protocol and all clients.
|
||||||
|
|
||||||
|
## What Was Added
|
||||||
|
|
||||||
|
### Wire Protocol (codec_id.rs)
|
||||||
|
|
||||||
|
Three new `CodecId` variants using the 4-bit header space (values 6-8):
|
||||||
|
|
||||||
|
| CodecId | Wire Value | Bitrate | Frame | Use Case |
|
||||||
|
|---------|-----------|---------|-------|----------|
|
||||||
|
| Opus32k | 6 | 32 kbps | 20ms | Studio low — noticeable improvement over 24k for voice |
|
||||||
|
| Opus48k | 7 | 48 kbps | 20ms | Studio — excellent voice, captures nuance |
|
||||||
|
| Opus64k | 8 | 64 kbps | 20ms | Studio high — near-transparent quality |
|
||||||
|
|
||||||
|
### Quality Profiles
|
||||||
|
|
||||||
|
| Profile | Codec | FEC | Bandwidth (with FEC) |
|
||||||
|
|---------|-------|-----|---------------------|
|
||||||
|
| STUDIO_32K | Opus 32k | 10% | ~35 kbps |
|
||||||
|
| STUDIO_48K | Opus 48k | 10% | ~53 kbps |
|
||||||
|
| STUDIO_64K | Opus 64k | 10% | ~70 kbps |
|
||||||
|
|
||||||
|
FEC is set to 10% (vs 20% for GOOD) — studio assumes a good network.
|
||||||
|
|
||||||
|
### Client Support
|
||||||
|
|
||||||
|
| Client | Selection | Status |
|
||||||
|
|--------|-----------|--------|
|
||||||
|
| Desktop (Tauri) | Quality slider in Settings (8 levels) | Done |
|
||||||
|
| CLI | `--profile studio-64k` / `studio-48k` / `studio-32k` | Done |
|
||||||
|
| Android | Needs codec picker update in SettingsScreen.kt | TODO |
|
||||||
|
| Web | Needs UI | TODO |
|
||||||
|
|
||||||
|
### Cross-Codec Interop
|
||||||
|
|
||||||
|
All decoder auto-switch paths (call.rs, desktop engine.rs) handle the new codec IDs. A studio-64k client can talk to a codec2-1200 client — the receiver auto-switches.
|
||||||
|
|
||||||
|
## When to Use Studio Tiers
|
||||||
|
|
||||||
|
- **Podcast recording sessions**: Use studio-64k for best quality (combined with local WAV recording for pristine output)
|
||||||
|
- **Music collaboration**: Opus at 48-64k captures instrument harmonics much better than 24k
|
||||||
|
- **Good network conditions**: Only useful when bandwidth isn't constrained; the extra bits are wasted on lossy networks
|
||||||
|
|
||||||
|
## When NOT to Use
|
||||||
|
|
||||||
|
- **Mobile data**: Stick with Auto/GOOD — studio tiers use 2-3x the bandwidth
|
||||||
|
- **High packet loss**: Studio profiles use minimal FEC (10%); degraded networks need DEGRADED or CATASTROPHIC profiles with 50-100% FEC
|
||||||
|
- **Large group calls**: Each participant's stream multiplies bandwidth; 64k * 10 participants = 640 kbps incoming
|
||||||
|
|
||||||
|
## Backward Compatibility
|
||||||
|
|
||||||
|
Old clients (before this change) will receive packets with CodecId 6/7/8 which they don't recognize. The `from_wire()` returns `None` for unknown values, causing the packet to be dropped. Old clients can still *send* to new clients fine (they use CodecId 0-5). This is acceptable for a pre-release protocol.
|
||||||
@@ -457,3 +457,52 @@ Auto mode uses three tiers (Good, Degraded, Catastrophic). It does not use the S
|
|||||||
When you select a specific profile (not Auto), adaptive switching is disabled. The encoder stays at the selected profile regardless of network conditions. This is useful when you know your network quality and want consistent encoding, or when you want to force a specific bitrate.
|
When you select a specific profile (not Auto), adaptive switching is disabled. The encoder stays at the selected profile regardless of network conditions. This is useful when you know your network quality and want consistent encoding, or when you want to force a specific bitrate.
|
||||||
|
|
||||||
Note: The decoder always accepts all codecs. A manual quality selection only affects what you send, not what you receive.
|
Note: The decoder always accepts all codecs. A manual quality selection only affects what you send, not what you receive.
|
||||||
|
|
||||||
|
## Direct 1:1 Calling (Desktop + Android)
|
||||||
|
|
||||||
|
In addition to room-mode group calls, you can place direct calls to a specific peer by fingerprint. Direct calls bypass room state entirely — the relay is used purely as a signaling gateway and for media relay. There is no need for the callee to join a room beforehand; they just need to be registered with the same signal hub.
|
||||||
|
|
||||||
|
### UI elements in the direct-call panel
|
||||||
|
|
||||||
|
- **Place call field** — paste a fingerprint (the long hex string you see under your own identity) and click Call. The callee sees a ringing UI.
|
||||||
|
- **Recent contacts row** — a horizontal strip of chips showing your most recently called/receiving peers. Click a chip to re-dial. Aliases are shown if the peer has one, otherwise a short fingerprint prefix.
|
||||||
|
- **Call history list** — every direct call you've placed, received, or missed, with direction indicator (↗ Outgoing, ↙ Incoming, ✗ Missed), the peer's alias (if known) or fingerprint prefix, and a timestamp. Click an entry to re-dial.
|
||||||
|
- **Deregister button** — drops your signal-hub registration without quitting the app. Useful when switching identities (e.g. testing with two accounts on one machine) or when you want to explicitly appear offline to peers.
|
||||||
|
- **Clear history button** — wipes the call history store. Does not affect current calls.
|
||||||
|
|
||||||
|
### Live updates
|
||||||
|
|
||||||
|
The call history updates in real time across all views via Tauri events (`history-changed`). Placing, answering, or missing a call immediately refreshes the history list and the recent contacts row — no manual refresh needed.
|
||||||
|
|
||||||
|
### Default room
|
||||||
|
|
||||||
|
On first launch, the room name in the room-mode panel defaults to `general` (changed from the prior `android` default so the desktop and Android clients don't silently talk past each other). You can still change it to any room name, and the last-used room is remembered across launches.
|
||||||
|
|
||||||
|
### Random alias
|
||||||
|
|
||||||
|
New installations derive a human-friendly alias from your identity seed — something like `silent-forest-41` or `bold-river-07`. It's deterministic, so reinstalling without changing your seed gives you the same alias. The alias is shown alongside your fingerprint in the header and is what peers see in their call history when they receive your call.
|
||||||
|
|
||||||
|
You can override the alias in Settings → Identity if you want a specific name.
|
||||||
|
|
||||||
|
## Windows AEC Variants
|
||||||
|
|
||||||
|
The Windows desktop build ships in two variants for echo cancellation, depending on which backend you want to exercise. Both are `wzp-desktop.exe` binaries — only the internal audio backend differs.
|
||||||
|
|
||||||
|
| Build | File | Capture backend | AEC | When to use |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| **noAEC baseline** | `wzp-desktop-noAEC.exe` | CPAL (WASAPI shared mode) | None | Headphone-only use, or for A/B comparison against the AEC build |
|
||||||
|
| **Communications AEC** | `wzp-desktop.exe` | Direct WASAPI with `AudioCategory_Communications` | **Yes** — Windows routes the capture stream through the driver's communications APO chain (AEC + noise suppression + automatic gain control) | Any speaker-mode call, laptop built-in speakers, anywhere echo is audible |
|
||||||
|
|
||||||
|
**Quality caveat**: the communications AEC operates at the OS level and its algorithm depends on the audio driver's installed APO chain. On modern consumer laptops with Intel Smart Sound, Dolby, recent Realtek, or Windows 11 Voice Clarity, the quality is excellent (effectively matching what Teams/Zoom deliver). On generic class-compliant USB microphones or older drivers, the communications APO may not be present at all — in that case the build behaves identically to the noAEC baseline.
|
||||||
|
|
||||||
|
If you hear echo on the AEC build, try these in order before escalating:
|
||||||
|
|
||||||
|
1. **Check which capture device is selected as "Default Device - Communications"** in Windows Sound Settings → Recording tab. Right-click any device to set it. The AEC build opens the device marked as `eCommunications`, not `eConsole`, so changing the default-communications device changes what we capture from.
|
||||||
|
2. **Verify the driver exposes a communications APO**. Sound Settings → Recording → your mic → Properties → Advanced → look for an "Enhancements" or "Signal Enhancements" tab. If it's absent, the driver has no APOs and the AEC build effectively has no AEC.
|
||||||
|
3. **Try the classic Voice Capture DSP build** when it ships (tracked as task #26). That uses Microsoft's bundled software AEC (`CLSID_CWMAudioAEC`) which works on every Windows machine regardless of driver.
|
||||||
|
|
||||||
|
### Installing the Windows builds
|
||||||
|
|
||||||
|
1. Windows 10: install the [WebView2 Runtime Evergreen Bootstrapper](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) first. Windows 11 has it pre-installed.
|
||||||
|
2. Copy `wzp-desktop.exe` (or `wzp-desktop-noAEC.exe`) to any directory and double-click. No installer needed.
|
||||||
|
3. First launch creates the config + identity store at `%APPDATA%\com.wzp.phone\`.
|
||||||
|
|||||||
@@ -1,11 +1,16 @@
|
|||||||
# =============================================================================
|
# =============================================================================
|
||||||
# WZ Phone — Android build environment (Debian 12 / Bookworm)
|
# WZ Phone — Android build environment (Debian 12 / Bookworm)
|
||||||
#
|
#
|
||||||
# Matches the bare-metal build-android.sh environment:
|
# Supports both:
|
||||||
|
# 1. Legacy Kotlin+JNI Android app (via cargo-ndk + gradle)
|
||||||
|
# 2. Tauri 2.x Mobile Android app (via tauri-cli + Node/npm)
|
||||||
|
#
|
||||||
|
# Toolchain:
|
||||||
# - Debian 12 (cmake 3.25, no Android cross-compilation bugs)
|
# - Debian 12 (cmake 3.25, no Android cross-compilation bugs)
|
||||||
# - JDK 17 (Gradle 8.5 + AGP 8.2.0 compatible)
|
# - JDK 17 (Gradle 8.5 + AGP 8.2.0 compatible)
|
||||||
# - NDK 26.1 (last stable before scudo/MTE crash on NDK 27+)
|
# - NDK 26.1 (last stable before scudo/MTE crash on NDK 27+)
|
||||||
# - Rust stable with aarch64-linux-android target + cargo-ndk
|
# - Node.js 20 LTS (for Tauri frontend build)
|
||||||
|
# - Rust stable with all 4 Android targets + cargo-ndk + tauri-cli 2.x
|
||||||
#
|
#
|
||||||
# Build: docker build -t wzp-android-builder -f Dockerfile.android-builder .
|
# Build: docker build -t wzp-android-builder -f Dockerfile.android-builder .
|
||||||
# =============================================================================
|
# =============================================================================
|
||||||
@@ -13,6 +18,11 @@ FROM debian:bookworm
|
|||||||
|
|
||||||
ARG NDK_VERSION=26.1.10909125
|
ARG NDK_VERSION=26.1.10909125
|
||||||
ARG ANDROID_API=34
|
ARG ANDROID_API=34
|
||||||
|
# Tauri 2.x mobile targets compileSdk 36 + build-tools 35 by default. Install
|
||||||
|
# both 34 (legacy Kotlin app) and 35/36 (Tauri mobile) so the same image works
|
||||||
|
# for both pipelines.
|
||||||
|
ARG ANDROID_API_TAURI=36
|
||||||
|
ARG BUILD_TOOLS_TAURI=35.0.0
|
||||||
|
|
||||||
ENV DEBIAN_FRONTEND=noninteractive \
|
ENV DEBIAN_FRONTEND=noninteractive \
|
||||||
ANDROID_HOME=/opt/android-sdk \
|
ANDROID_HOME=/opt/android-sdk \
|
||||||
@@ -35,8 +45,17 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
|
|||||||
openjdk-17-jdk-headless \
|
openjdk-17-jdk-headless \
|
||||||
ca-certificates \
|
ca-certificates \
|
||||||
libasound2-dev \
|
libasound2-dev \
|
||||||
|
file \
|
||||||
|
xz-utils \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# ── Node.js 20 LTS (required by Tauri for frontend build) ────────────────────
|
||||||
|
RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
|
||||||
|
&& apt-get install -y --no-install-recommends nodejs \
|
||||||
|
&& rm -rf /var/lib/apt/lists/* \
|
||||||
|
&& node --version \
|
||||||
|
&& npm --version
|
||||||
|
|
||||||
# ── Android SDK + NDK 26.1 ──────────────────────────────────────────────────
|
# ── Android SDK + NDK 26.1 ──────────────────────────────────────────────────
|
||||||
RUN mkdir -p $ANDROID_HOME/cmdline-tools \
|
RUN mkdir -p $ANDROID_HOME/cmdline-tools \
|
||||||
&& cd /tmp \
|
&& cd /tmp \
|
||||||
@@ -49,10 +68,36 @@ RUN yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses > /dev/nu
|
|||||||
&& $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install \
|
&& $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install \
|
||||||
"platforms;android-${ANDROID_API}" \
|
"platforms;android-${ANDROID_API}" \
|
||||||
"build-tools;${ANDROID_API}.0.0" \
|
"build-tools;${ANDROID_API}.0.0" \
|
||||||
|
"platforms;android-${ANDROID_API_TAURI}" \
|
||||||
|
"build-tools;${BUILD_TOOLS_TAURI}" \
|
||||||
"ndk;${NDK_VERSION}" \
|
"ndk;${NDK_VERSION}" \
|
||||||
"platform-tools" \
|
"platform-tools" \
|
||||||
2>&1 | grep -v '^\[' > /dev/null
|
2>&1 | grep -v '^\[' > /dev/null
|
||||||
|
|
||||||
|
# Work around the API-24 libc.a stub in the NDK. Any C++ static lib we
|
||||||
|
# link into libwzp_desktop_lib.so (e.g. the Oboe audio bridge) pulls in
|
||||||
|
# bionic's static pthread_create from API-24 libc.a via libc++_shared,
|
||||||
|
# and that pthread_create crashes at __init_tcb+4 when called from a
|
||||||
|
# .so loaded via dlopen (the static stub expects libc init state that
|
||||||
|
# only exists for main executables). API-26 has the proper runtime
|
||||||
|
# bindings. Tauri-cli hard-codes aarch64-linux-android24-clang as the
|
||||||
|
# linker and ignores .cargo/config.toml overrides, so the only sure
|
||||||
|
# fix is to replace the NDK's ${abi}24-clang binary itself with a
|
||||||
|
# shim that exec()s the ${abi}26-clang equivalent. Applies to all four
|
||||||
|
# ABIs × {clang, clang++}. The legacy wzp-android crate works without
|
||||||
|
# this because cargo-ndk honours a crate-level linker override; the
|
||||||
|
# shim is the minimal targeted fix for the cargo-tauri build path.
|
||||||
|
# Added as Option 3 for the incremental Step E regression (commit 4250f1b).
|
||||||
|
RUN set -eux; \
|
||||||
|
BIN=$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin; \
|
||||||
|
for abi in aarch64-linux-android armv7a-linux-androideabi i686-linux-android x86_64-linux-android; do \
|
||||||
|
for suffix in clang clang++; do \
|
||||||
|
mv "$BIN/${abi}24-${suffix}" "$BIN/${abi}24-${suffix}.orig"; \
|
||||||
|
printf '#!/bin/sh\nexec "%s/%s26-%s" "$@"\n' "$BIN" "$abi" "$suffix" > "$BIN/${abi}24-${suffix}"; \
|
||||||
|
chmod +x "$BIN/${abi}24-${suffix}"; \
|
||||||
|
done; \
|
||||||
|
done
|
||||||
|
|
||||||
# Make SDK world-readable so builder user can access it
|
# Make SDK world-readable so builder user can access it
|
||||||
RUN chmod -R a+rX $ANDROID_HOME
|
RUN chmod -R a+rX $ANDROID_HOME
|
||||||
|
|
||||||
@@ -64,12 +109,22 @@ USER builder
|
|||||||
WORKDIR /home/builder
|
WORKDIR /home/builder
|
||||||
|
|
||||||
# ── Rust toolchain ───────────────────────────────────────────────────────────
|
# ── Rust toolchain ───────────────────────────────────────────────────────────
|
||||||
|
# Install all 4 Android targets (Tauri Mobile builds for all ABIs by default;
|
||||||
|
# cargo-ndk legacy path only needs arm64-v8a — both workflows supported).
|
||||||
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \
|
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \
|
||||||
| sh -s -- -y --default-toolchain stable \
|
| sh -s -- -y --default-toolchain stable \
|
||||||
&& . $HOME/.cargo/env \
|
&& . $HOME/.cargo/env \
|
||||||
&& rustup target add aarch64-linux-android \
|
&& rustup target add \
|
||||||
&& cargo install cargo-ndk
|
aarch64-linux-android \
|
||||||
|
armv7-linux-androideabi \
|
||||||
|
i686-linux-android \
|
||||||
|
x86_64-linux-android \
|
||||||
|
&& cargo install cargo-ndk \
|
||||||
|
&& cargo install tauri-cli --version "^2.0" --locked
|
||||||
|
|
||||||
ENV PATH="/home/builder/.cargo/bin:$ANDROID_HOME/cmdline-tools/latest/bin:$ANDROID_HOME/platform-tools:$JAVA_HOME/bin:$PATH"
|
ENV PATH="/home/builder/.cargo/bin:$ANDROID_HOME/cmdline-tools/latest/bin:$ANDROID_HOME/platform-tools:$JAVA_HOME/bin:$PATH"
|
||||||
|
|
||||||
|
# NDK_HOME is the env var tauri-cli checks (in addition to ANDROID_NDK_HOME)
|
||||||
|
ENV NDK_HOME=$ANDROID_NDK_HOME
|
||||||
|
|
||||||
WORKDIR /build/source
|
WORKDIR /build/source
|
||||||
|
|||||||
59
scripts/Dockerfile.linux-desktop-builder
Normal file
59
scripts/Dockerfile.linux-desktop-builder
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
# =============================================================================
|
||||||
|
# WZ Phone — Linux x86_64 Tauri desktop build image
|
||||||
|
#
|
||||||
|
# Thin extension of wzp-android-builder that adds the GTK3 + WebKit2GTK 4.1 +
|
||||||
|
# libsoup-3.0 + AppIndicator dev packages needed to build the Tauri desktop
|
||||||
|
# app for Linux. Everything else (Rust, Node.js, cmake, pkg-config, cpal
|
||||||
|
# libasound deps, tauri-cli) is inherited from the base image.
|
||||||
|
#
|
||||||
|
# Build:
|
||||||
|
# docker build -t wzp-linux-desktop-builder -f Dockerfile.linux-desktop-builder .
|
||||||
|
#
|
||||||
|
# Run: driven by scripts/build-linux-desktop-docker.sh (see that file).
|
||||||
|
# =============================================================================
|
||||||
|
FROM wzp-android-builder
|
||||||
|
|
||||||
|
USER root
|
||||||
|
|
||||||
|
# Tauri 2.x Linux dependencies.
|
||||||
|
# - libwebkit2gtk-4.1-dev: the WebView backend. Tauri 2.x uses 4.1 (not 4.0).
|
||||||
|
# - libsoup-3.0-dev: HTTP client used by webkit2gtk. Must match its major.
|
||||||
|
# - libgtk-3-dev: GTK3 headers (webkit2gtk still uses GTK3).
|
||||||
|
# - libayatana-appindicator3-dev: system tray / status icon. Optional at
|
||||||
|
# runtime but tauri-build's feature-detection includes it.
|
||||||
|
# - librsvg2-dev: SVG rendering in the menu/icon code.
|
||||||
|
# - libglib2.0-dev: GObject introspection headers (transitive, but explicit).
|
||||||
|
# - patchelf: used by the tauri bundler to rewrite rpaths in the final binary.
|
||||||
|
# - file: already in the base, but tauri-build checks for it by name.
|
||||||
|
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||||
|
libwebkit2gtk-4.1-dev \
|
||||||
|
libsoup-3.0-dev \
|
||||||
|
libgtk-3-dev \
|
||||||
|
libayatana-appindicator3-dev \
|
||||||
|
librsvg2-dev \
|
||||||
|
libglib2.0-dev \
|
||||||
|
patchelf \
|
||||||
|
libwebrtc-audio-processing-dev \
|
||||||
|
clang \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# ── webrtc-audio-processing build requirements ──────────────────────────────
|
||||||
|
# The `webrtc-audio-processing` Rust crate (0.3.x line) links against Debian
|
||||||
|
# Bookworm's `libwebrtc-audio-processing-dev` apt package (0.3-1+b1), which
|
||||||
|
# provides the PulseAudio fork of the WebRTC audio processing module. This is
|
||||||
|
# the library that Pulse's module-echo-cancel and PipeWire's filter-chain
|
||||||
|
# use for their AEC modes — same algorithm family, runtime-linked via
|
||||||
|
# pkg-config at cargo build time.
|
||||||
|
#
|
||||||
|
# An attempt was made to use the 2.x line with the `bundled` sub-feature
|
||||||
|
# (which would give AEC3 instead of AEC2) but both the crates.io tarball
|
||||||
|
# and the upstream git `main` branch hit a `meson setup --reconfigure` bug
|
||||||
|
# that panics on first-run empty build dirs. The 0.3 line avoids the
|
||||||
|
# bundled build path entirely and is what we ship for now.
|
||||||
|
#
|
||||||
|
# `clang` is listed explicitly because the Rust crate's bindgen may need
|
||||||
|
# it at compile time depending on the version of the underlying
|
||||||
|
# webrtc-audio-processing-sys build script.
|
||||||
|
|
||||||
|
USER builder
|
||||||
|
WORKDIR /build/source
|
||||||
99
scripts/Dockerfile.windows-builder
Normal file
99
scripts/Dockerfile.windows-builder
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
# =============================================================================
|
||||||
|
# WZ Phone — Windows (x86_64-pc-windows-msvc) cross-compile image
|
||||||
|
#
|
||||||
|
# Cross-compiles the Tauri desktop binary for Windows from a Linux host via
|
||||||
|
# `cargo xwin`, which auto-downloads the Microsoft CRT + Windows SDK at build
|
||||||
|
# time. This image pre-warms that cache so the cross-compile is as close as
|
||||||
|
# possible to a native Linux build on rebuild (~3 min warm vs ~20 min cold).
|
||||||
|
#
|
||||||
|
# Build:
|
||||||
|
# docker build -t wzp-windows-builder -f Dockerfile.windows-builder .
|
||||||
|
#
|
||||||
|
# Run: driven by scripts/build-windows-docker.sh (see that file).
|
||||||
|
# =============================================================================
|
||||||
|
FROM debian:bookworm
|
||||||
|
|
||||||
|
ARG RUST_TARGET=x86_64-pc-windows-msvc
|
||||||
|
|
||||||
|
ENV DEBIAN_FRONTEND=noninteractive
|
||||||
|
|
||||||
|
# ── System packages ──────────────────────────────────────────────────────────
|
||||||
|
# - build-essential + pkg-config + libssl-dev: baseline cargo build toolchain
|
||||||
|
# - cmake + ninja-build: audiopus_sys (libopus) uses cmake and expects Ninja
|
||||||
|
# as the generator for the windows target; without ninja-build the cmake
|
||||||
|
# build fails with "CMake was unable to find a build program corresponding
|
||||||
|
# to Ninja" partway through.
|
||||||
|
# - llvm + clang + lld: cargo-xwin uses clang + lld-link for PE/COFF output.
|
||||||
|
# - nasm: ring / rustls assembly for Windows needs NASM on non-Windows hosts.
|
||||||
|
# - curl, git, ca-certificates, unzip: obvious plumbing.
|
||||||
|
# - xz-utils: some Microsoft installer archives are xz-compressed.
|
||||||
|
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||||
|
build-essential \
|
||||||
|
cmake \
|
||||||
|
ninja-build \
|
||||||
|
curl \
|
||||||
|
git \
|
||||||
|
pkg-config \
|
||||||
|
libssl-dev \
|
||||||
|
ca-certificates \
|
||||||
|
llvm \
|
||||||
|
clang \
|
||||||
|
lld \
|
||||||
|
nasm \
|
||||||
|
unzip \
|
||||||
|
xz-utils \
|
||||||
|
file \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# ── Node.js 20 LTS (required by Tauri for frontend build) ────────────────────
|
||||||
|
RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
|
||||||
|
&& apt-get install -y --no-install-recommends nodejs \
|
||||||
|
&& rm -rf /var/lib/apt/lists/* \
|
||||||
|
&& node --version \
|
||||||
|
&& npm --version
|
||||||
|
|
||||||
|
# ── Builder user (1000:1000) — matches host bind-mount UID for the cache
|
||||||
|
# volumes so cargo-registry / target survive across runs without perms
|
||||||
|
# gymnastics.
|
||||||
|
RUN groupadd -g 1000 builder \
|
||||||
|
&& useradd -m -u 1000 -g 1000 -s /bin/bash builder
|
||||||
|
|
||||||
|
USER builder
|
||||||
|
WORKDIR /home/builder
|
||||||
|
|
||||||
|
# ── Rust toolchain + Windows target + cargo-xwin ────────────────────────────
|
||||||
|
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \
|
||||||
|
| sh -s -- -y --default-toolchain stable \
|
||||||
|
&& . $HOME/.cargo/env \
|
||||||
|
&& rustup target add ${RUST_TARGET} \
|
||||||
|
&& cargo install cargo-xwin --locked
|
||||||
|
|
||||||
|
ENV PATH="/home/builder/.cargo/bin:$PATH" \
|
||||||
|
XWIN_ACCEPT_LICENSE=1 \
|
||||||
|
RUST_TARGET_WIN=${RUST_TARGET}
|
||||||
|
|
||||||
|
# ── Pre-warm the xwin cache ─────────────────────────────────────────────────
|
||||||
|
# cargo-xwin downloads the Microsoft CRT + Windows SDK (~1.5-2 GB) into
|
||||||
|
# ~/.cache/cargo-xwin the first time it runs. Baking that into an image
|
||||||
|
# layer saves ~4 minutes off every subsequent cold run.
|
||||||
|
#
|
||||||
|
# We do this by creating a throwaway Rust project, building it with
|
||||||
|
# cargo-xwin against the Windows target, then deleting the project but
|
||||||
|
# keeping the xwin cache.
|
||||||
|
RUN set -eux; \
|
||||||
|
mkdir -p /tmp/xwin-warmup && cd /tmp/xwin-warmup && \
|
||||||
|
. $HOME/.cargo/env && \
|
||||||
|
cargo new --bin xwin-warmup --quiet && \
|
||||||
|
cd xwin-warmup && \
|
||||||
|
cargo xwin build --release --target ${RUST_TARGET} 2>&1 | tail -5 && \
|
||||||
|
cd / && rm -rf /tmp/xwin-warmup && \
|
||||||
|
du -sh $HOME/.cache/cargo-xwin
|
||||||
|
|
||||||
|
# Note: the libopus SSE4.1/SSSE3 intrinsic compile failure under clang-cl
|
||||||
|
# is fixed at the source level by vendoring audiopus_sys and patching its
|
||||||
|
# bundled libopus CMakeLists.txt (see desktop/vendor/audiopus_sys in the
|
||||||
|
# source tree). Do NOT try to patch cargo-xwin's override.cmake at this
|
||||||
|
# layer — cargo-xwin rewrites that file on every `cargo xwin build`
|
||||||
|
# invocation, so any edits baked into the image are wiped at runtime.
|
||||||
|
|
||||||
|
WORKDIR /build/source
|
||||||
@@ -5,10 +5,15 @@ set -euo pipefail
|
|||||||
# notify via ntfy.sh/wzp. Fire and forget.
|
# notify via ntfy.sh/wzp. Fire and forget.
|
||||||
#
|
#
|
||||||
# Usage:
|
# Usage:
|
||||||
# ./scripts/build-and-notify.sh Build + upload + notify
|
# ./scripts/build-and-notify.sh Build current local branch
|
||||||
|
# ./scripts/build-and-notify.sh --branch opus-DRED Build a specific branch
|
||||||
# ./scripts/build-and-notify.sh --rust Force Rust rebuild
|
# ./scripts/build-and-notify.sh --rust Force Rust rebuild
|
||||||
# ./scripts/build-and-notify.sh --pull Git pull before building
|
# ./scripts/build-and-notify.sh --no-pull Skip git pull (use cached source)
|
||||||
# ./scripts/build-and-notify.sh --install Also download + adb install locally
|
# ./scripts/build-and-notify.sh --install Also download + adb install locally
|
||||||
|
#
|
||||||
|
# The remote builder pulls the requested branch from its `origin` (gitea:
|
||||||
|
# git.manko.yoga). Make sure you've pushed the branch to `origin` before
|
||||||
|
# running this script, otherwise the remote fetch will fail loudly.
|
||||||
|
|
||||||
REMOTE_HOST="SepehrHomeserverdk"
|
REMOTE_HOST="SepehrHomeserverdk"
|
||||||
BASE_DIR="/mnt/storage/manBuilder"
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
@@ -19,14 +24,29 @@ SSH_OPTS="-o ConnectTimeout=15 -o ServerAliveInterval=15 -o ServerAliveCountMax=
|
|||||||
REBUILD_RUST=0
|
REBUILD_RUST=0
|
||||||
DO_PULL=1
|
DO_PULL=1
|
||||||
DO_INSTALL=0
|
DO_INSTALL=0
|
||||||
for arg in "$@"; do
|
# Default to whatever branch the local workspace is on — "build what I'm
|
||||||
case "$arg" in
|
# working on" is the intuitive behavior for iterative development.
|
||||||
|
BRANCH=$(git -C "$(dirname "$0")/.." branch --show-current 2>/dev/null || echo "")
|
||||||
|
while [ $# -gt 0 ]; do
|
||||||
|
case "$1" in
|
||||||
--rust) REBUILD_RUST=1 ;;
|
--rust) REBUILD_RUST=1 ;;
|
||||||
--pull) DO_PULL=1 ;;
|
--pull) DO_PULL=1 ;;
|
||||||
--no-pull) DO_PULL=0 ;;
|
--no-pull) DO_PULL=0 ;;
|
||||||
--install) DO_INSTALL=1 ;;
|
--install) DO_INSTALL=1 ;;
|
||||||
|
--branch)
|
||||||
|
shift
|
||||||
|
BRANCH="$1"
|
||||||
|
;;
|
||||||
|
--branch=*) BRANCH="${1#--branch=}" ;;
|
||||||
|
*) echo "Unknown arg: $1"; exit 1 ;;
|
||||||
esac
|
esac
|
||||||
|
shift
|
||||||
done
|
done
|
||||||
|
if [ -z "$BRANCH" ]; then
|
||||||
|
echo "ERROR: could not determine target branch (detached HEAD?). Pass --branch NAME."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "Target branch: $BRANCH"
|
||||||
|
|
||||||
log() { echo -e "\033[1;36m>>> $*\033[0m"; }
|
log() { echo -e "\033[1;36m>>> $*\033[0m"; }
|
||||||
|
|
||||||
@@ -42,20 +62,33 @@ BASE_DIR="/mnt/storage/manBuilder"
|
|||||||
NTFY_TOPIC="https://ntfy.sh/wzp"
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
REBUILD_RUST="${1:-0}"
|
REBUILD_RUST="${1:-0}"
|
||||||
DO_PULL="${2:-0}"
|
DO_PULL="${2:-0}"
|
||||||
|
BRANCH="${3:-}"
|
||||||
|
|
||||||
|
if [ -z "$BRANCH" ]; then
|
||||||
|
echo "ERROR: remote script invoked without a BRANCH argument"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
trap 'notify "WZP Android build FAILED! Check /tmp/wzp-build.log"' ERR
|
trap 'notify "WZP Android build FAILED [$BRANCH]! Check /tmp/wzp-build.log"' ERR
|
||||||
|
|
||||||
# Pull if requested
|
# Pull the requested branch. Previously this was hardcoded to
|
||||||
|
# feat/android-voip-client with `|| true` on the reset, which silently
|
||||||
|
# left the tree on whatever branch it was last on when the hardcoded
|
||||||
|
# branch didn't exist on origin. Now the branch is a parameter and any
|
||||||
|
# failure aborts the build so nobody ships an APK from the wrong source.
|
||||||
if [ "$DO_PULL" = "1" ]; then
|
if [ "$DO_PULL" = "1" ]; then
|
||||||
echo ">>> Pulling latest..."
|
echo ">>> Pulling branch '$BRANCH' from origin..."
|
||||||
cd "$BASE_DIR/data/source"
|
cd "$BASE_DIR/data/source"
|
||||||
git reset --hard HEAD 2>/dev/null || true
|
git reset --hard HEAD 2>/dev/null || true
|
||||||
git clean -fd 2>/dev/null || true
|
git clean -fd 2>/dev/null || true
|
||||||
git gc --prune=now 2>/dev/null || true
|
git gc --prune=now 2>/dev/null || true
|
||||||
git fetch origin feat/android-voip-client 2>&1 | tail -3
|
git fetch origin "$BRANCH"
|
||||||
git reset --hard origin/feat/android-voip-client 2>/dev/null || true
|
git reset --hard "origin/$BRANCH"
|
||||||
|
BUILT_HASH=$(git rev-parse --short HEAD)
|
||||||
|
BUILT_SUBJECT=$(git log -1 --format=%s)
|
||||||
|
echo ">>> HEAD after pull: $BUILT_HASH — $BUILT_SUBJECT"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Clean Rust if requested
|
# Clean Rust if requested
|
||||||
@@ -73,7 +106,7 @@ find "$BASE_DIR/data/source" "$BASE_DIR/data/cache" \
|
|||||||
rm -rf "$BASE_DIR/data/source/android/app/src/main/jniLibs/arm64-v8a"
|
rm -rf "$BASE_DIR/data/source/android/app/src/main/jniLibs/arm64-v8a"
|
||||||
|
|
||||||
GIT_HASH=$(cd $BASE_DIR/data/source && git rev-parse --short HEAD 2>/dev/null || echo unknown)
|
GIT_HASH=$(cd $BASE_DIR/data/source && git rev-parse --short HEAD 2>/dev/null || echo unknown)
|
||||||
notify "WZP Android build started [$GIT_HASH]..."
|
notify "WZP Android build started [$BRANCH @ $GIT_HASH]..."
|
||||||
|
|
||||||
echo ">>> Building in Docker..."
|
echo ">>> Building in Docker..."
|
||||||
docker run --rm --user 1000:1000 \
|
docker run --rm --user 1000:1000 \
|
||||||
@@ -106,7 +139,7 @@ ls -lh android/app/src/main/jniLibs/arm64-v8a/
|
|||||||
|
|
||||||
echo ">>> APK build..."
|
echo ">>> APK build..."
|
||||||
cd android && chmod +x gradlew
|
cd android && chmod +x gradlew
|
||||||
./gradlew clean assembleDebug --no-daemon --warning-mode=none 2>&1 | tail -50
|
./gradlew clean assembleDebug --no-daemon --warning-mode=none 2>&1 | tail -3
|
||||||
echo "APK_BUILT"
|
echo "APK_BUILT"
|
||||||
'
|
'
|
||||||
|
|
||||||
@@ -117,10 +150,10 @@ APK=$(find "$BASE_DIR/data/source/android" -name "app-debug*.apk" -path "*/outpu
|
|||||||
if [ -n "$APK" ]; then
|
if [ -n "$APK" ]; then
|
||||||
URL=$(curl -s -F "file=@$APK" -H "Authorization: $rusty_auth_token" "$rusty_address")
|
URL=$(curl -s -F "file=@$APK" -H "Authorization: $rusty_auth_token" "$rusty_address")
|
||||||
echo "UPLOAD_URL=$URL"
|
echo "UPLOAD_URL=$URL"
|
||||||
notify "WZP Android [$GIT_HASH] done! APK: $URL"
|
notify "WZP Android [$BRANCH @ $GIT_HASH] done! APK: $URL"
|
||||||
echo ">>> Done! APK at: $URL"
|
echo ">>> Done! APK at: $URL"
|
||||||
else
|
else
|
||||||
notify "WZP build FAILED - no APK"
|
notify "WZP Android FAILED [$BRANCH @ $GIT_HASH] - no APK"
|
||||||
echo "ERROR: No APK found"
|
echo "ERROR: No APK found"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
@@ -129,9 +162,9 @@ REMOTE_SCRIPT
|
|||||||
ssh_cmd "chmod +x /tmp/wzp-docker-build.sh"
|
ssh_cmd "chmod +x /tmp/wzp-docker-build.sh"
|
||||||
|
|
||||||
# Run in tmux
|
# Run in tmux
|
||||||
log "Starting build in tmux..."
|
log "Starting build in tmux (branch: $BRANCH)..."
|
||||||
ssh_cmd "tmux kill-session -t wzp-build 2>/dev/null; true"
|
ssh_cmd "tmux kill-session -t wzp-build 2>/dev/null; true"
|
||||||
ssh_cmd "tmux new-session -d -s wzp-build '/tmp/wzp-docker-build.sh $REBUILD_RUST $DO_PULL 2>&1 | tee /tmp/wzp-build.log'"
|
ssh_cmd "tmux new-session -d -s wzp-build '/tmp/wzp-docker-build.sh $REBUILD_RUST $DO_PULL $BRANCH 2>&1 | tee /tmp/wzp-build.log'"
|
||||||
|
|
||||||
log "Build running! You'll get a notification on ntfy.sh/wzp with the download URL."
|
log "Build running! You'll get a notification on ntfy.sh/wzp with the download URL."
|
||||||
echo ""
|
echo ""
|
||||||
|
|||||||
312
scripts/build-linux-desktop-docker.sh
Executable file
312
scripts/build-linux-desktop-docker.sh
Executable file
@@ -0,0 +1,312 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# =============================================================================
|
||||||
|
# WZ Phone — Linux x86_64 Tauri desktop build (Docker on SepehrHomeserverdk)
|
||||||
|
#
|
||||||
|
# Cross-compiles the Tauri desktop binary for Linux x86_64 inside the
|
||||||
|
# wzp-linux-desktop-builder image (a thin extension of wzp-android-builder
|
||||||
|
# that adds GTK3 + WebKit2GTK 4.1 + libsoup-3.0 + appindicator dev packages).
|
||||||
|
#
|
||||||
|
# Fires an ntfy.sh/wzp notification on build start and build completion, and
|
||||||
|
# uploads the resulting .deb + raw binary to rustypaste.
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# ./scripts/build-linux-desktop-docker.sh # Full pipeline
|
||||||
|
# ./scripts/build-linux-desktop-docker.sh --no-pull # Skip git fetch
|
||||||
|
# ./scripts/build-linux-desktop-docker.sh --rust # Clean Rust target
|
||||||
|
# ./scripts/build-linux-desktop-docker.sh --image-build # (Re)build image
|
||||||
|
#
|
||||||
|
# Environment:
|
||||||
|
# WZP_BRANCH Branch to build (default: feat/desktop-audio-rewrite)
|
||||||
|
# =============================================================================
|
||||||
|
|
||||||
|
REMOTE_HOST="SepehrHomeserverdk"
|
||||||
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
LOCAL_OUTPUT="target/linux-desktop"
|
||||||
|
BRANCH="${WZP_BRANCH:-feat/desktop-audio-rewrite}"
|
||||||
|
SSH_OPTS="-o ConnectTimeout=15 -o ServerAliveInterval=15 -o ServerAliveCountMax=4 -o LogLevel=ERROR"
|
||||||
|
|
||||||
|
REBUILD_RUST=0
|
||||||
|
DO_PULL=1
|
||||||
|
IMAGE_BUILD=0
|
||||||
|
# WITH_AEC=1 enables the wzp-client `linux-aec` feature (WebRTC AEC via
|
||||||
|
# webrtc-audio-processing) and renames the output artifacts with an `-aec`
|
||||||
|
# suffix so both variants can coexist on disk.
|
||||||
|
WITH_AEC=0
|
||||||
|
for arg in "$@"; do
|
||||||
|
case "$arg" in
|
||||||
|
--rust) REBUILD_RUST=1 ;;
|
||||||
|
--pull) DO_PULL=1 ;;
|
||||||
|
--no-pull) DO_PULL=0 ;;
|
||||||
|
--image-build) IMAGE_BUILD=1 ;;
|
||||||
|
--aec) WITH_AEC=1 ;;
|
||||||
|
-h|--help)
|
||||||
|
sed -n '3,25p' "$0"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
# Variant suffix used locally to rename downloaded artifacts so the noAEC
|
||||||
|
# baseline and the AEC build can coexist in $LOCAL_OUTPUT. Mirrors the
|
||||||
|
# same VARIANT declaration inside the remote REMOTE_SCRIPT heredoc.
|
||||||
|
if [ "$WITH_AEC" = "1" ]; then
|
||||||
|
VARIANT="aec"
|
||||||
|
else
|
||||||
|
VARIANT="noAEC"
|
||||||
|
fi
|
||||||
|
|
||||||
|
log() { echo -e "\033[1;36m>>> $*\033[0m"; }
|
||||||
|
ssh_cmd() { ssh $SSH_OPTS "$REMOTE_HOST" "$@"; }
|
||||||
|
|
||||||
|
notify_local() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
|
mkdir -p "$LOCAL_OUTPUT"
|
||||||
|
|
||||||
|
# ─── Optional: (re)build the docker image on the remote ────────────────────
|
||||||
|
if [ "$IMAGE_BUILD" = "1" ]; then
|
||||||
|
log "Uploading Dockerfile.linux-desktop-builder to remote..."
|
||||||
|
scp $SSH_OPTS "$(dirname "$0")/Dockerfile.linux-desktop-builder" \
|
||||||
|
"$REMOTE_HOST:$BASE_DIR/Dockerfile.linux-desktop-builder"
|
||||||
|
|
||||||
|
log "Triggering remote image build (fire-and-forget)..."
|
||||||
|
ssh_cmd "cd $BASE_DIR && \
|
||||||
|
nohup docker build -f Dockerfile.linux-desktop-builder \
|
||||||
|
-t wzp-linux-desktop-builder . \
|
||||||
|
> /tmp/wzp-linux-desktop-image-build.log 2>&1 & \
|
||||||
|
echo 'image build PID: '\$!"
|
||||||
|
notify_local "WZP Linux desktop image build dispatched"
|
||||||
|
log "Image build running in background on $REMOTE_HOST."
|
||||||
|
log "Tail the log with: ssh $REMOTE_HOST 'tail -f /tmp/wzp-linux-desktop-image-build.log'"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ─── Upload remote build runner script ─────────────────────────────────────
|
||||||
|
log "Uploading remote build script..."
|
||||||
|
ssh_cmd "cat > /tmp/wzp-linux-desktop-build.sh" <<'REMOTE_SCRIPT'
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
BRANCH="${1:-feat/desktop-audio-rewrite}"
|
||||||
|
DO_PULL="${2:-1}"
|
||||||
|
REBUILD_RUST="${3:-0}"
|
||||||
|
WITH_AEC="${4:-0}"
|
||||||
|
|
||||||
|
LOG_FILE=/tmp/wzp-linux-desktop-build.log
|
||||||
|
GIT_HASH="unknown"
|
||||||
|
ENV_FILE="$BASE_DIR/.env"
|
||||||
|
|
||||||
|
# Variant suffix for artifact filenames so the noAEC baseline and the AEC
|
||||||
|
# build can coexist on the host. Applied after the build to the downloaded
|
||||||
|
# files (we can't easily rename during the cargo tauri build itself).
|
||||||
|
if [ "$WITH_AEC" = "1" ]; then
|
||||||
|
VARIANT="aec"
|
||||||
|
else
|
||||||
|
VARIANT="noAEC"
|
||||||
|
fi
|
||||||
|
|
||||||
|
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
|
# Upload to rustypaste; print URL on stdout (or empty on failure).
|
||||||
|
upload_to_rustypaste() {
|
||||||
|
local file="$1"
|
||||||
|
[ ! -f "$file" ] && { echo ""; return; }
|
||||||
|
# shellcheck disable=SC1090
|
||||||
|
source "$ENV_FILE"
|
||||||
|
if [ -n "${rusty_address:-}" ] && [ -n "${rusty_auth_token:-}" ]; then
|
||||||
|
curl -s -F "file=@$file" -H "Authorization: $rusty_auth_token" "$rusty_address" || echo ""
|
||||||
|
else
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
on_error() {
|
||||||
|
local line="$1"
|
||||||
|
local log_url
|
||||||
|
log_url=$(upload_to_rustypaste "$LOG_FILE" || echo "")
|
||||||
|
if [ -n "$log_url" ]; then
|
||||||
|
notify "WZP Linux desktop build FAILED [$GIT_HASH] (line $line)
|
||||||
|
log: $log_url"
|
||||||
|
else
|
||||||
|
notify "WZP Linux desktop build FAILED [$GIT_HASH] (line $line) — log upload failed"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
trap 'on_error $LINENO' ERR
|
||||||
|
|
||||||
|
exec > >(tee "$LOG_FILE") 2>&1
|
||||||
|
|
||||||
|
# ── git fetch + reset the target branch ───────────────────────────────────
|
||||||
|
if [ "$DO_PULL" = "1" ]; then
|
||||||
|
echo ">>> git fetch + reset $BRANCH"
|
||||||
|
cd "$BASE_DIR/data/source"
|
||||||
|
git reset --hard HEAD 2>/dev/null || true
|
||||||
|
git gc --prune=now 2>/dev/null || true
|
||||||
|
git fetch origin "$BRANCH" 2>&1 | tail -3
|
||||||
|
git checkout "$BRANCH" 2>/dev/null || git checkout -b "$BRANCH" "origin/$BRANCH"
|
||||||
|
git reset --hard "origin/$BRANCH"
|
||||||
|
git submodule update --init --recursive || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
GIT_HASH=$(cd "$BASE_DIR/data/source" && git rev-parse --short HEAD 2>/dev/null || echo unknown)
|
||||||
|
GIT_MSG=$(cd "$BASE_DIR/data/source" && git log -1 --pretty=%s 2>/dev/null | head -c 60 || echo "?")
|
||||||
|
notify "WZP Linux desktop build STARTED [$GIT_HASH] — $GIT_MSG"
|
||||||
|
|
||||||
|
# Fix perms so builder uid 1000 can read/write the mounted source.
|
||||||
|
find "$BASE_DIR/data/source" "$BASE_DIR/data/cache-linux-desktop" \
|
||||||
|
! -user 1000 -o ! -group 1000 2>/dev/null | \
|
||||||
|
xargs -r chown 1000:1000 2>/dev/null || true
|
||||||
|
|
||||||
|
if [ "$REBUILD_RUST" = "1" ]; then
|
||||||
|
echo ">>> Cleaning Linux desktop Rust target dir..."
|
||||||
|
rm -rf "$BASE_DIR/data/cache-linux-desktop/target/x86_64-unknown-linux-gnu" \
|
||||||
|
"$BASE_DIR/data/cache-linux-desktop/target/release"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ── Docker run ─────────────────────────────────────────────────────────────
|
||||||
|
# Cache volumes:
|
||||||
|
# - cargo-registry / cargo-git: shared with the android builder — both use
|
||||||
|
# the same crates, so the download cache is worth sharing.
|
||||||
|
# - cache-linux-desktop/target: separate target tree for the desktop build
|
||||||
|
# to keep it isolated from the Linux CLI build (build-linux-docker.sh
|
||||||
|
# uses cache-linux/target for wzp-relay / wzp-client).
|
||||||
|
|
||||||
|
mkdir -p "$BASE_DIR/data/cache/cargo-registry" \
|
||||||
|
"$BASE_DIR/data/cache/cargo-git" \
|
||||||
|
"$BASE_DIR/data/cache-linux-desktop/target"
|
||||||
|
chown -R 1000:1000 "$BASE_DIR/data/cache-linux-desktop/target" 2>/dev/null || true
|
||||||
|
|
||||||
|
# Pass WITH_AEC into the docker container so the inner build script can
|
||||||
|
# decide whether to enable the wzp-client `linux-aec` feature.
|
||||||
|
docker run --rm \
|
||||||
|
--user 1000:1000 \
|
||||||
|
-e WITH_AEC="$WITH_AEC" \
|
||||||
|
-v "$BASE_DIR/data/source:/build/source" \
|
||||||
|
-v "$BASE_DIR/data/cache/cargo-registry:/home/builder/.cargo/registry" \
|
||||||
|
-v "$BASE_DIR/data/cache/cargo-git:/home/builder/.cargo/git" \
|
||||||
|
-v "$BASE_DIR/data/cache-linux-desktop/target:/build/source/target" \
|
||||||
|
wzp-linux-desktop-builder \
|
||||||
|
bash -c '
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
cd /build/source/desktop
|
||||||
|
|
||||||
|
echo ">>> npm install"
|
||||||
|
npm install --silent 2>&1 | tail -5 || npm install 2>&1 | tail -20
|
||||||
|
|
||||||
|
echo ">>> npm run build"
|
||||||
|
npm run build 2>&1 | tail -5
|
||||||
|
|
||||||
|
# The linux-aec feature enables a WebRTC AEC3 capture backend in
|
||||||
|
# wzp-client. Opt in only when the caller asked for it; noAEC baseline
|
||||||
|
# builds keep the plain CPAL path for comparison. Tauri does not
|
||||||
|
# propagate --features through to the wzp-desktop crate directly
|
||||||
|
# because `cargo tauri build` invokes cargo underneath — so we use
|
||||||
|
# `cargo tauri build -- --features wzp-desktop/linux-aec` to pass it
|
||||||
|
# through. Wait — wzp-desktop is the bin crate, and its `linux-aec`
|
||||||
|
# feature needs to be defined there too. The simpler path is to set
|
||||||
|
# the feature at the wzp-client level via a bin-crate feature that
|
||||||
|
# forwards to wzp-client. Handled in Cargo.toml changes.
|
||||||
|
if [ "${WITH_AEC:-0}" = "1" ]; then
|
||||||
|
echo ">>> cargo tauri build WITH linux-aec feature"
|
||||||
|
cd src-tauri
|
||||||
|
cargo tauri build -- --features wzp-desktop/linux-aec 2>&1 | tail -40
|
||||||
|
else
|
||||||
|
echo ">>> cargo tauri build (noAEC baseline)"
|
||||||
|
cd src-tauri
|
||||||
|
cargo tauri build 2>&1 | tail -40
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo ">>> Build artifacts:"
|
||||||
|
ls -lh /build/source/target/release/wzp-desktop 2>/dev/null || echo "NO BINARY"
|
||||||
|
ls -lh /build/source/target/release/bundle/deb/*.deb 2>/dev/null || echo "NO DEB"
|
||||||
|
ls -lh /build/source/target/release/bundle/appimage/*.AppImage 2>/dev/null || echo "NO APPIMAGE"
|
||||||
|
'
|
||||||
|
|
||||||
|
# Locate the produced artifacts
|
||||||
|
BIN="$BASE_DIR/data/cache-linux-desktop/target/release/wzp-desktop"
|
||||||
|
DEB=$(ls "$BASE_DIR/data/cache-linux-desktop/target/release/bundle/deb/"*.deb 2>/dev/null | head -1 || true)
|
||||||
|
APPIMAGE=$(ls "$BASE_DIR/data/cache-linux-desktop/target/release/bundle/appimage/"*.AppImage 2>/dev/null | head -1 || true)
|
||||||
|
|
||||||
|
if [ ! -f "$BIN" ]; then
|
||||||
|
LOG_URL=$(upload_to_rustypaste "$LOG_FILE" || echo "")
|
||||||
|
if [ -n "$LOG_URL" ]; then
|
||||||
|
notify "WZP Linux desktop build [$GIT_HASH]: no binary produced
|
||||||
|
log: $LOG_URL"
|
||||||
|
else
|
||||||
|
notify "WZP Linux desktop build [$GIT_HASH]: no binary produced — log upload failed"
|
||||||
|
fi
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
BIN_SIZE=$(du -h "$BIN" | cut -f1)
|
||||||
|
|
||||||
|
# Prefer to ship the .deb if we got one, otherwise fall back to the raw binary.
|
||||||
|
ARTIFACT="$BIN"
|
||||||
|
ARTIFACT_KIND="binary"
|
||||||
|
if [ -n "$DEB" ] && [ -f "$DEB" ]; then
|
||||||
|
ARTIFACT="$DEB"
|
||||||
|
ARTIFACT_KIND="deb"
|
||||||
|
ARTIFACT_SIZE=$(du -h "$DEB" | cut -f1)
|
||||||
|
else
|
||||||
|
ARTIFACT_SIZE="$BIN_SIZE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
RUSTY_URL=$(upload_to_rustypaste "$ARTIFACT" || echo "")
|
||||||
|
if [ -n "$RUSTY_URL" ]; then
|
||||||
|
notify "WZP Linux desktop build OK [$GIT_HASH] ($ARTIFACT_KIND, $ARTIFACT_SIZE)
|
||||||
|
$RUSTY_URL"
|
||||||
|
else
|
||||||
|
notify "WZP Linux desktop build OK [$GIT_HASH] ($ARTIFACT_KIND, $ARTIFACT_SIZE) — rustypaste upload skipped"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Print paths so the local script can scp them back
|
||||||
|
echo "BIN_REMOTE_PATH=$BIN"
|
||||||
|
[ -n "$DEB" ] && echo "DEB_REMOTE_PATH=$DEB"
|
||||||
|
[ -n "$APPIMAGE" ] && echo "APPIMAGE_REMOTE_PATH=$APPIMAGE"
|
||||||
|
REMOTE_SCRIPT
|
||||||
|
|
||||||
|
ssh_cmd "chmod +x /tmp/wzp-linux-desktop-build.sh"
|
||||||
|
|
||||||
|
notify_local "WZP Linux desktop build dispatched (branch=$BRANCH)"
|
||||||
|
log "Triggering remote build (branch=$BRANCH)..."
|
||||||
|
|
||||||
|
# Run; last lines are *_REMOTE_PATH=...
|
||||||
|
REMOTE_OUTPUT=$(ssh_cmd "/tmp/wzp-linux-desktop-build.sh '$BRANCH' '$DO_PULL' '$REBUILD_RUST' '$WITH_AEC'" || true)
|
||||||
|
echo "$REMOTE_OUTPUT" | tail -80
|
||||||
|
|
||||||
|
BIN_REMOTE=$(echo "$REMOTE_OUTPUT" | grep '^BIN_REMOTE_PATH=' | tail -1 | cut -d= -f2-)
|
||||||
|
DEB_REMOTE=$(echo "$REMOTE_OUTPUT" | grep '^DEB_REMOTE_PATH=' | tail -1 | cut -d= -f2-)
|
||||||
|
APPIMAGE_REMOTE=$(echo "$REMOTE_OUTPUT" | grep '^APPIMAGE_REMOTE_PATH=' | tail -1 | cut -d= -f2-)
|
||||||
|
|
||||||
|
if [ -n "$BIN_REMOTE" ]; then
|
||||||
|
log "Downloading wzp-desktop binary to $LOCAL_OUTPUT/wzp-desktop-$VARIANT ..."
|
||||||
|
scp $SSH_OPTS "$REMOTE_HOST:$BIN_REMOTE" "$LOCAL_OUTPUT/wzp-desktop-$VARIANT"
|
||||||
|
echo " $LOCAL_OUTPUT/wzp-desktop-$VARIANT ($(du -h "$LOCAL_OUTPUT/wzp-desktop-$VARIANT" | cut -f1))"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$DEB_REMOTE" ]; then
|
||||||
|
# Apply the variant suffix to the downloaded .deb: cargo-tauri names the
|
||||||
|
# file WarzonePhone_<version>_amd64.deb regardless of what we built, so
|
||||||
|
# the variant lives only in our chosen filename.
|
||||||
|
DEB_BASENAME=$(basename "$DEB_REMOTE" .deb)
|
||||||
|
log "Downloading .deb to $LOCAL_OUTPUT/${DEB_BASENAME}-$VARIANT.deb ..."
|
||||||
|
scp $SSH_OPTS "$REMOTE_HOST:$DEB_REMOTE" "$LOCAL_OUTPUT/${DEB_BASENAME}-$VARIANT.deb"
|
||||||
|
ls -lh "$LOCAL_OUTPUT/${DEB_BASENAME}-$VARIANT.deb"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$APPIMAGE_REMOTE" ]; then
|
||||||
|
APPIMG_BASENAME=$(basename "$APPIMAGE_REMOTE" .AppImage)
|
||||||
|
log "Downloading .AppImage to $LOCAL_OUTPUT/${APPIMG_BASENAME}-$VARIANT.AppImage ..."
|
||||||
|
scp $SSH_OPTS "$REMOTE_HOST:$APPIMAGE_REMOTE" "$LOCAL_OUTPUT/${APPIMG_BASENAME}-$VARIANT.AppImage"
|
||||||
|
ls -lh "$LOCAL_OUTPUT/${APPIMG_BASENAME}-$VARIANT.AppImage"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$BIN_REMOTE" ]; then
|
||||||
|
log "No binary produced — see ntfy / remote log /tmp/wzp-linux-desktop-build.log"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
@@ -17,6 +17,12 @@ NTFY_TOPIC="https://ntfy.sh/wzp"
|
|||||||
LOCAL_OUTPUT="target/linux-x86_64"
|
LOCAL_OUTPUT="target/linux-x86_64"
|
||||||
SSH_OPTS="-o ConnectTimeout=15 -o ServerAliveInterval=15 -o ServerAliveCountMax=4 -o LogLevel=ERROR"
|
SSH_OPTS="-o ConnectTimeout=15 -o ServerAliveInterval=15 -o ServerAliveCountMax=4 -o LogLevel=ERROR"
|
||||||
|
|
||||||
|
# Branch to build. Default matches the current active development branch
|
||||||
|
# (opus-DRED-v2 as of 2026-04-11). Override with `WZP_BRANCH=<name> ./build-linux-docker.sh`
|
||||||
|
# if you need a different one — e.g. to rebuild the relay from a feature
|
||||||
|
# branch for A/B testing.
|
||||||
|
WZP_BRANCH="${WZP_BRANCH:-opus-DRED-v2}"
|
||||||
|
|
||||||
DO_PULL=1
|
DO_PULL=1
|
||||||
DO_CLEAN=0
|
DO_CLEAN=0
|
||||||
DO_INSTALL=0
|
DO_INSTALL=0
|
||||||
@@ -44,19 +50,21 @@ BASE_DIR="/mnt/storage/manBuilder"
|
|||||||
NTFY_TOPIC="https://ntfy.sh/wzp"
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
DO_PULL="${1:-0}"
|
DO_PULL="${1:-0}"
|
||||||
DO_CLEAN="${2:-0}"
|
DO_CLEAN="${2:-0}"
|
||||||
|
BRANCH="${3:-opus-DRED-v2}"
|
||||||
|
|
||||||
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
trap 'notify "WZP Linux build FAILED! Check /tmp/wzp-linux-build.log"' ERR
|
trap 'notify "WZP Linux build FAILED! Check /tmp/wzp-linux-build.log"' ERR
|
||||||
|
|
||||||
if [ "$DO_PULL" = "1" ]; then
|
if [ "$DO_PULL" = "1" ]; then
|
||||||
echo ">>> Pulling latest..."
|
echo ">>> Pulling latest ($BRANCH)..."
|
||||||
cd "$BASE_DIR/data/source"
|
cd "$BASE_DIR/data/source"
|
||||||
git reset --hard HEAD 2>/dev/null || true
|
git reset --hard HEAD 2>/dev/null || true
|
||||||
git clean -fd 2>/dev/null || true
|
git clean -fd 2>/dev/null || true
|
||||||
git gc --prune=now 2>/dev/null || true
|
git gc --prune=now 2>/dev/null || true
|
||||||
git fetch origin feat/android-voip-client 2>&1 | tail -3
|
git fetch origin "$BRANCH" 2>&1 | tail -3
|
||||||
git reset --hard origin/feat/android-voip-client 2>/dev/null || true
|
git checkout "$BRANCH" 2>/dev/null || git checkout -b "$BRANCH" "origin/$BRANCH"
|
||||||
|
git reset --hard "origin/$BRANCH" 2>/dev/null || true
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ "$DO_CLEAN" = "1" ]; then
|
if [ "$DO_CLEAN" = "1" ]; then
|
||||||
@@ -133,7 +141,7 @@ ssh_cmd "chmod +x /tmp/wzp-linux-build.sh"
|
|||||||
# Run in tmux
|
# Run in tmux
|
||||||
log "Starting Linux build in tmux..."
|
log "Starting Linux build in tmux..."
|
||||||
ssh_cmd "tmux kill-session -t wzp-linux 2>/dev/null; true"
|
ssh_cmd "tmux kill-session -t wzp-linux 2>/dev/null; true"
|
||||||
ssh_cmd "tmux new-session -d -s wzp-linux '/tmp/wzp-linux-build.sh $DO_PULL $DO_CLEAN 2>&1 | tee /tmp/wzp-linux-build.log'"
|
ssh_cmd "tmux new-session -d -s wzp-linux '/tmp/wzp-linux-build.sh $DO_PULL $DO_CLEAN $WZP_BRANCH 2>&1 | tee /tmp/wzp-linux-build.log'"
|
||||||
|
|
||||||
log "Build running! Notification on ntfy.sh/wzp when done."
|
log "Build running! Notification on ntfy.sh/wzp when done."
|
||||||
echo ""
|
echo ""
|
||||||
|
|||||||
276
scripts/build-tauri-android.sh
Executable file
276
scripts/build-tauri-android.sh
Executable file
@@ -0,0 +1,276 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# =============================================================================
|
||||||
|
# WZ Phone — Tauri 2.x Mobile Android APK build
|
||||||
|
#
|
||||||
|
# Builds the desktop/ Tauri app as an Android APK via cargo-tauri inside the
|
||||||
|
# wzp-android-builder Docker image on SepehrHomeserverdk. Uploads the APK to
|
||||||
|
# rustypaste, fires ntfy.sh/wzp notifications at start + finish, and SCPs the
|
||||||
|
# APK back locally.
|
||||||
|
#
|
||||||
|
# Same pattern as build-and-notify.sh but for the Tauri mobile pipeline:
|
||||||
|
# - Source: desktop/src-tauri/ (not android/)
|
||||||
|
# - Build: cargo tauri android build (not gradlew assembleDebug)
|
||||||
|
# - Output: desktop/src-tauri/gen/android/.../*.apk
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# ./scripts/build-tauri-android.sh # full pipeline (debug)
|
||||||
|
# ./scripts/build-tauri-android.sh --release # release APK
|
||||||
|
# ./scripts/build-tauri-android.sh --no-pull # skip git fetch
|
||||||
|
# ./scripts/build-tauri-android.sh --rust # force-clean rust target
|
||||||
|
# ./scripts/build-tauri-android.sh --init # also run `cargo tauri android init`
|
||||||
|
#
|
||||||
|
# Environment:
|
||||||
|
# WZP_BRANCH Branch to build (default: feat/desktop-audio-rewrite)
|
||||||
|
# =============================================================================
|
||||||
|
|
||||||
|
REMOTE_HOST="SepehrHomeserverdk"
|
||||||
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
LOCAL_OUTPUT="target/tauri-android-apk"
|
||||||
|
BRANCH="${WZP_BRANCH:-feat/desktop-audio-rewrite}"
|
||||||
|
SSH_OPTS="-o ConnectTimeout=15 -o ServerAliveInterval=15 -o ServerAliveCountMax=4 -o LogLevel=ERROR"
|
||||||
|
|
||||||
|
REBUILD_RUST=0
|
||||||
|
DO_PULL=1
|
||||||
|
DO_INIT=0
|
||||||
|
BUILD_RELEASE=0
|
||||||
|
for arg in "$@"; do
|
||||||
|
case "$arg" in
|
||||||
|
--rust) REBUILD_RUST=1 ;;
|
||||||
|
--pull) DO_PULL=1 ;;
|
||||||
|
--no-pull) DO_PULL=0 ;;
|
||||||
|
--init) DO_INIT=1 ;;
|
||||||
|
--release) BUILD_RELEASE=1 ;;
|
||||||
|
-h|--help)
|
||||||
|
sed -n '3,30p' "$0"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
log() { echo -e "\033[1;36m>>> $*\033[0m"; }
|
||||||
|
ssh_cmd() { ssh -A $SSH_OPTS "$REMOTE_HOST" "$@"; }
|
||||||
|
|
||||||
|
notify_local() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
|
mkdir -p "$LOCAL_OUTPUT"
|
||||||
|
|
||||||
|
log "Uploading remote build script..."
|
||||||
|
ssh_cmd "cat > /tmp/wzp-tauri-build.sh" <<'REMOTE_SCRIPT'
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
BRANCH="${1:-feat/desktop-audio-rewrite}"
|
||||||
|
DO_PULL="${2:-1}"
|
||||||
|
REBUILD_RUST="${3:-0}"
|
||||||
|
DO_INIT="${4:-0}"
|
||||||
|
BUILD_RELEASE="${5:-0}"
|
||||||
|
|
||||||
|
LOG_FILE=/tmp/wzp-tauri-build.log
|
||||||
|
GIT_HASH="unknown" # populated after fetch
|
||||||
|
ENV_FILE="$BASE_DIR/.env"
|
||||||
|
|
||||||
|
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
|
# Upload a file to rustypaste; print URL on stdout (or empty on failure).
|
||||||
|
upload_to_rustypaste() {
|
||||||
|
local file="$1"
|
||||||
|
[ ! -f "$ENV_FILE" ] && { echo ""; return; }
|
||||||
|
# shellcheck disable=SC1090
|
||||||
|
source "$ENV_FILE"
|
||||||
|
if [ -n "${rusty_address:-}" ] && [ -n "${rusty_auth_token:-}" ]; then
|
||||||
|
curl -s -F "file=@$file" -H "Authorization: $rusty_auth_token" "$rusty_address" || echo ""
|
||||||
|
else
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# On failure: upload the build log to rustypaste, then notify with hash + url.
|
||||||
|
on_error() {
|
||||||
|
local line="$1"
|
||||||
|
local log_url
|
||||||
|
log_url=$(upload_to_rustypaste "$LOG_FILE" || echo "")
|
||||||
|
if [ -n "$log_url" ]; then
|
||||||
|
notify "WZP Tauri Android build FAILED [$GIT_HASH] (line $line)
|
||||||
|
log: $log_url"
|
||||||
|
else
|
||||||
|
notify "WZP Tauri Android build FAILED [$GIT_HASH] (line $line) — log upload failed, see $LOG_FILE on remote"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
trap 'on_error $LINENO' ERR
|
||||||
|
|
||||||
|
exec > >(tee "$LOG_FILE") 2>&1
|
||||||
|
|
||||||
|
if [ "$DO_PULL" = "1" ]; then
|
||||||
|
echo ">>> git fetch + reset $BRANCH"
|
||||||
|
cd "$BASE_DIR/data/source"
|
||||||
|
git reset --hard HEAD 2>/dev/null || true
|
||||||
|
# NOTE: deliberately do NOT run `git clean -fd` here. It would wipe the
|
||||||
|
# tauri-generated `desktop/src-tauri/gen/android/` scaffold (gradlew,
|
||||||
|
# settings.gradle, etc.) which is expensive to recreate and breaks
|
||||||
|
# subsequent builds with "gradlew not found".
|
||||||
|
git gc --prune=now 2>/dev/null || true
|
||||||
|
git fetch origin "$BRANCH" 2>&1 | tail -3
|
||||||
|
git checkout "$BRANCH" 2>/dev/null || git checkout -b "$BRANCH" "origin/$BRANCH"
|
||||||
|
git reset --hard "origin/$BRANCH"
|
||||||
|
git submodule update --init || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
GIT_HASH=$(cd "$BASE_DIR/data/source" && git rev-parse --short HEAD 2>/dev/null || echo unknown)
|
||||||
|
GIT_MSG=$(cd "$BASE_DIR/data/source" && git log -1 --pretty=%s 2>/dev/null | head -c 60 || echo "?")
|
||||||
|
notify "WZP Tauri Android build STARTED [$GIT_HASH] — $GIT_MSG"
|
||||||
|
|
||||||
|
# Fix perms so uid 1000 can write
|
||||||
|
find "$BASE_DIR/data/source" "$BASE_DIR/data/cache" \
|
||||||
|
! -user 1000 -o ! -group 1000 2>/dev/null | \
|
||||||
|
xargs -r chown 1000:1000 2>/dev/null || true
|
||||||
|
|
||||||
|
# Optionally clean rust target for android triples
|
||||||
|
if [ "$REBUILD_RUST" = "1" ]; then
|
||||||
|
echo ">>> Cleaning Rust android target dirs..."
|
||||||
|
rm -rf "$BASE_DIR/data/cache/target/aarch64-linux-android" \
|
||||||
|
"$BASE_DIR/data/cache/target/armv7-linux-androideabi" \
|
||||||
|
"$BASE_DIR/data/cache/target/i686-linux-android" \
|
||||||
|
"$BASE_DIR/data/cache/target/x86_64-linux-android"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Profile flag
|
||||||
|
PROFILE_FLAG="--debug"
|
||||||
|
[ "$BUILD_RELEASE" = "1" ] && PROFILE_FLAG=""
|
||||||
|
|
||||||
|
# Persist ~/.android (where the auto-generated debug.keystore lives) so every
|
||||||
|
# build is signed with the SAME key. Without this, every fresh container gets
|
||||||
|
# a new debug keystore and `adb install -r` fails with INSTALL_FAILED_UPDATE_
|
||||||
|
# INCOMPATIBLE because the signature changed.
|
||||||
|
mkdir -p "$BASE_DIR/data/cache/android-home"
|
||||||
|
chown 1000:1000 "$BASE_DIR/data/cache/android-home" 2>/dev/null || true
|
||||||
|
|
||||||
|
docker run --rm \
|
||||||
|
--user 1000:1000 \
|
||||||
|
-e DO_INIT="$DO_INIT" \
|
||||||
|
-e PROFILE_FLAG="$PROFILE_FLAG" \
|
||||||
|
-v "$BASE_DIR/data/source:/build/source" \
|
||||||
|
-v "$BASE_DIR/data/cache/cargo-registry:/home/builder/.cargo/registry" \
|
||||||
|
-v "$BASE_DIR/data/cache/cargo-git:/home/builder/.cargo/git" \
|
||||||
|
-v "$BASE_DIR/data/cache/target:/build/source/target" \
|
||||||
|
-v "$BASE_DIR/data/cache/gradle:/home/builder/.gradle" \
|
||||||
|
-v "$BASE_DIR/data/cache/android-home:/home/builder/.android" \
|
||||||
|
wzp-android-builder \
|
||||||
|
bash -c '
|
||||||
|
set -euo pipefail
|
||||||
|
cd /build/source/desktop
|
||||||
|
|
||||||
|
echo ">>> npm install"
|
||||||
|
npm install --silent 2>&1 | tail -5 || npm install 2>&1 | tail -20
|
||||||
|
|
||||||
|
cd src-tauri
|
||||||
|
|
||||||
|
# Run init if forced, OR if the gradle wrapper is missing. Just checking
|
||||||
|
# for `gen/android` is not enough — Tauri creates a few subdirectories
|
||||||
|
# during build (app/, buildSrc/, .gradle/) that survive a partial wipe and
|
||||||
|
# would make a naive `[ ! -d gen/android ]` check return false even though
|
||||||
|
# the build wrapper itself is gone.
|
||||||
|
if [ "${DO_INIT}" = "1" ] || [ ! -x gen/android/gradlew ]; then
|
||||||
|
echo ">>> cargo tauri android init"
|
||||||
|
cargo tauri android init 2>&1 | tail -20
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ─── wzp-native standalone cdylib (built with cargo-ndk, not cargo-tauri) ──
|
||||||
|
# Produces libwzp_native.so which wzp-desktop dlopens at runtime via
|
||||||
|
# libloading. Split exists because cargo-tauri`s linker wiring pulls
|
||||||
|
# bionic private symbols into any cdylib with cc::Build C++, causing
|
||||||
|
# __init_tcb+4 SIGSEGV. cargo-ndk uses the same linker path as the
|
||||||
|
# legacy wzp-android crate which works.
|
||||||
|
echo ">>> cargo ndk build -p wzp-native --release"
|
||||||
|
JNI_ABI_DIR=gen/android/app/src/main/jniLibs/arm64-v8a
|
||||||
|
mkdir -p "$JNI_ABI_DIR"
|
||||||
|
(
|
||||||
|
cd /build/source
|
||||||
|
cargo ndk -t arm64-v8a -o desktop/src-tauri/gen/android/app/src/main/jniLibs \
|
||||||
|
build --release -p wzp-native 2>&1 | tail -10
|
||||||
|
)
|
||||||
|
if [ -f "$JNI_ABI_DIR/libwzp_native.so" ]; then
|
||||||
|
ls -lh "$JNI_ABI_DIR/libwzp_native.so"
|
||||||
|
else
|
||||||
|
echo ">>> WARNING: libwzp_native.so not produced"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ─── libc++_shared.so — required by wzp-native at runtime ──────────────
|
||||||
|
# wzp-native/build.rs uses cpp_link_stdlib(Some("c++_shared")) which adds
|
||||||
|
# a NEEDED entry for libc++_shared.so to libwzp_native.so. cargo-ndk does
|
||||||
|
# NOT copy the actual libc++_shared.so into jniLibs, so unless we copy it
|
||||||
|
# explicitly, the APK ships without it and the Android dynamic linker
|
||||||
|
# fails the dlopen with "library libc++_shared.so not found" at runtime.
|
||||||
|
# Same fix that build-and-notify.sh has had for the legacy wzp-android
|
||||||
|
# path (lines 126-134 there) — ported here for the Tauri pipeline.
|
||||||
|
# NOTE: no apostrophes in this comment block. The enclosing docker
|
||||||
|
# bash -c uses single quotes and a stray apostrophe closes the string
|
||||||
|
# prematurely, breaking variable scope for everything below.
|
||||||
|
if [ ! -f "$JNI_ABI_DIR/libc++_shared.so" ]; then
|
||||||
|
echo ">>> libc++_shared.so missing, copying from NDK..."
|
||||||
|
NDK_LIBCXX=$(find "$ANDROID_NDK_HOME" -name "libc++_shared.so" -path "*/aarch64-linux-android/*" | head -1)
|
||||||
|
if [ -n "$NDK_LIBCXX" ]; then
|
||||||
|
cp "$NDK_LIBCXX" "$JNI_ABI_DIR/"
|
||||||
|
ls -lh "$JNI_ABI_DIR/libc++_shared.so"
|
||||||
|
else
|
||||||
|
echo ">>> ERROR: libc++_shared.so not found in NDK — APK will crash at dlopen time"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ">>> cargo tauri android build ${PROFILE_FLAG} --target aarch64 --apk"
|
||||||
|
cargo tauri android build ${PROFILE_FLAG} --target aarch64 --apk
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo ">>> Build artifacts:"
|
||||||
|
find gen/android -name "*.apk" -exec ls -lh {} \; 2>/dev/null
|
||||||
|
'
|
||||||
|
|
||||||
|
# Locate the produced APK
|
||||||
|
APK=$(find "$BASE_DIR/data/source/desktop/src-tauri/gen/android" -name "*.apk" -type f 2>/dev/null | head -1)
|
||||||
|
if [ -z "$APK" ] || [ ! -f "$APK" ]; then
|
||||||
|
LOG_URL=$(upload_to_rustypaste "$LOG_FILE" || echo "")
|
||||||
|
if [ -n "$LOG_URL" ]; then
|
||||||
|
notify "WZP Tauri Android build [$GIT_HASH]: no APK produced
|
||||||
|
log: $LOG_URL"
|
||||||
|
else
|
||||||
|
notify "WZP Tauri Android build [$GIT_HASH]: no APK produced — log upload failed"
|
||||||
|
fi
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
APK_SIZE=$(du -h "$APK" | cut -f1)
|
||||||
|
|
||||||
|
RUSTY_URL=$(upload_to_rustypaste "$APK" || echo "")
|
||||||
|
if [ -n "$RUSTY_URL" ]; then
|
||||||
|
notify "WZP Tauri Android build OK [$GIT_HASH] ($APK_SIZE)
|
||||||
|
$RUSTY_URL"
|
||||||
|
else
|
||||||
|
notify "WZP Tauri Android build OK [$GIT_HASH] ($APK_SIZE) — rustypaste upload skipped"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Print path so the local script can grab it
|
||||||
|
echo "APK_REMOTE_PATH=$APK"
|
||||||
|
REMOTE_SCRIPT
|
||||||
|
|
||||||
|
ssh_cmd "chmod +x /tmp/wzp-tauri-build.sh"
|
||||||
|
|
||||||
|
notify_local "WZP Tauri Android build dispatched (branch=$BRANCH, release=$BUILD_RELEASE)"
|
||||||
|
log "Triggering remote build (branch=$BRANCH)..."
|
||||||
|
|
||||||
|
# Run; capture full output, last line is APK_REMOTE_PATH=...
|
||||||
|
REMOTE_OUTPUT=$(ssh_cmd "/tmp/wzp-tauri-build.sh '$BRANCH' '$DO_PULL' '$REBUILD_RUST' '$DO_INIT' '$BUILD_RELEASE'" || true)
|
||||||
|
echo "$REMOTE_OUTPUT" | tail -60
|
||||||
|
|
||||||
|
APK_REMOTE=$(echo "$REMOTE_OUTPUT" | grep '^APK_REMOTE_PATH=' | tail -1 | cut -d= -f2-)
|
||||||
|
if [ -n "$APK_REMOTE" ]; then
|
||||||
|
log "Downloading APK to $LOCAL_OUTPUT/wzp-tauri.apk..."
|
||||||
|
scp $SSH_OPTS "$REMOTE_HOST:$APK_REMOTE" "$LOCAL_OUTPUT/wzp-tauri.apk"
|
||||||
|
echo " $LOCAL_OUTPUT/wzp-tauri.apk ($(du -h "$LOCAL_OUTPUT/wzp-tauri.apk" | cut -f1))"
|
||||||
|
else
|
||||||
|
log "No APK produced — see ntfy / remote log /tmp/wzp-tauri-build.log"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
391
scripts/build-windows-cloud.sh
Executable file
391
scripts/build-windows-cloud.sh
Executable file
@@ -0,0 +1,391 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Build WarzonePhone desktop .exe for Windows x86_64 using a temporary
|
||||||
|
# Hetzner Cloud VPS. Cross-compiles from Linux via `cargo xwin`, which
|
||||||
|
# auto-downloads the Windows SDK + MSVC CRT the first time it runs.
|
||||||
|
#
|
||||||
|
# No Windows machine needed for the build itself — the produced .exe
|
||||||
|
# still has to be copied to a real Windows host to run (we can only
|
||||||
|
# verify compile + link here, not runtime).
|
||||||
|
#
|
||||||
|
# Prerequisites:
|
||||||
|
# - hcloud CLI authenticated
|
||||||
|
# - SSH key "wz" registered in Hetzner
|
||||||
|
# - Local ssh-agent loaded with an SSH key that can read the
|
||||||
|
# git.manko.yoga repo (the script forwards the agent so the VM's
|
||||||
|
# git clone uses your identity). Run `ssh-add /Users/manwe/CascadeProjects/wzp`
|
||||||
|
# once before invoking this script if you haven't already.
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# ./scripts/build-windows-cloud.sh Full build (create → build → download → destroy)
|
||||||
|
# ./scripts/build-windows-cloud.sh --prepare Create VM and install deps only
|
||||||
|
# ./scripts/build-windows-cloud.sh --build Build on existing VM
|
||||||
|
# ./scripts/build-windows-cloud.sh --transfer Download .exe from VM
|
||||||
|
# ./scripts/build-windows-cloud.sh --destroy Delete the VM
|
||||||
|
# ./scripts/build-windows-cloud.sh --all prepare + build + transfer (VM persists)
|
||||||
|
# ./scripts/build-windows-cloud.sh --upload Re-upload source to existing VM
|
||||||
|
#
|
||||||
|
# Environment variables (all optional):
|
||||||
|
# WZP_BRANCH Branch to build (default: feat/desktop-audio-rewrite)
|
||||||
|
# WZP_SERVER_TYPE Hetzner server type (default: cx23 — small, cheap, x86)
|
||||||
|
# WZP_KEEP_VM Set to 1 to skip destroy on full build
|
||||||
|
|
||||||
|
SSH_KEY_NAME="wz"
|
||||||
|
SSH_KEY_PATH="/Users/manwe/CascadeProjects/wzp"
|
||||||
|
SERVER_TYPE="${WZP_SERVER_TYPE:-cx33}" # cx23 (4GB RAM) OOMs on tauri+rustls cross-compile — bump to cx33 (8GB, 8 vCPU)
|
||||||
|
IMAGE="ubuntu-24.04"
|
||||||
|
SERVER_NAME="wzp-windows-builder"
|
||||||
|
REMOTE_USER="root"
|
||||||
|
OUTPUT_DIR="target/windows-exe"
|
||||||
|
PROJECT_DIR="$(cd "$(dirname "$0")/.." && pwd)"
|
||||||
|
BRANCH="${WZP_BRANCH:-feat/desktop-audio-rewrite}"
|
||||||
|
KEEP_VM="${WZP_KEEP_VM:-0}"
|
||||||
|
|
||||||
|
SSH_OPTS="-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o ConnectTimeout=10 -o LogLevel=ERROR"
|
||||||
|
|
||||||
|
RUST_TARGET="x86_64-pc-windows-msvc"
|
||||||
|
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
RUSTY_ENV_FILE="$HOME/.wzp/rustypaste.env"
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Helpers
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
log() { echo -e "\n\033[1;36m>>> $*\033[0m"; }
|
||||||
|
err() { echo -e "\033[1;31mERROR: $*\033[0m" >&2; }
|
||||||
|
die() {
|
||||||
|
err "$@"
|
||||||
|
notify "WZP Windows build FAILED — $*"
|
||||||
|
# If the user wants to keep the VM alive for debugging (WZP_KEEP_VM=1),
|
||||||
|
# don't tear it down on failure — they might want to ssh in and poke at
|
||||||
|
# the build state. Only auto-destroy when KEEP_VM is explicitly off.
|
||||||
|
if [ "${KEEP_VM:-0}" != "1" ]; then
|
||||||
|
do_destroy_quiet
|
||||||
|
else
|
||||||
|
err "VM kept alive for debugging (WZP_KEEP_VM=1). Destroy with $0 --destroy"
|
||||||
|
fi
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
notify() {
|
||||||
|
# Fire-and-forget ntfy. Silently ignored if there's no network.
|
||||||
|
curl -sf -m 5 -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true
|
||||||
|
}
|
||||||
|
|
||||||
|
# Upload a file to the online rustypaste (paste.dk.manko.yoga), return
|
||||||
|
# the public URL on stdout. Requires $RUSTY_ENV_FILE to contain
|
||||||
|
# rusty_address + rusty_auth_token (synced from SepehrHomeserverdk's
|
||||||
|
# /mnt/storage/manBuilder/.env once; see README).
|
||||||
|
rustypaste_upload() {
|
||||||
|
local file="$1"
|
||||||
|
[ -f "$file" ] || { echo ""; return; }
|
||||||
|
[ -f "$RUSTY_ENV_FILE" ] || { echo ""; return; }
|
||||||
|
# shellcheck disable=SC1090
|
||||||
|
source "$RUSTY_ENV_FILE"
|
||||||
|
if [ -n "${rusty_address:-}" ] && [ -n "${rusty_auth_token:-}" ]; then
|
||||||
|
curl -s -F "file=@$file" -H "Authorization: $rusty_auth_token" "$rusty_address" || echo ""
|
||||||
|
else
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
get_vm_ip() {
|
||||||
|
hcloud server list -o columns=name,ipv4 -o noheader 2>/dev/null | grep "$SERVER_NAME" | awk '{print $2}' | tr -d ' '
|
||||||
|
}
|
||||||
|
|
||||||
|
ssh_cmd() {
|
||||||
|
local ip
|
||||||
|
ip=$(get_vm_ip)
|
||||||
|
[ -n "$ip" ] || die "No VM found. Run --prepare first."
|
||||||
|
ssh $SSH_OPTS -A -i "$SSH_KEY_PATH" "$REMOTE_USER@$ip" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
scp_down() {
|
||||||
|
local ip
|
||||||
|
ip=$(get_vm_ip)
|
||||||
|
[ -n "$ip" ] || die "No VM found."
|
||||||
|
scp $SSH_OPTS -i "$SSH_KEY_PATH" "$REMOTE_USER@$ip:$1" "$2"
|
||||||
|
}
|
||||||
|
|
||||||
|
do_destroy_quiet() {
|
||||||
|
local name
|
||||||
|
name=$(hcloud server list -o columns=name -o noheader 2>/dev/null | grep "$SERVER_NAME" | tr -d ' ' || true)
|
||||||
|
if [ -n "$name" ]; then
|
||||||
|
echo ""
|
||||||
|
err "Cleaning up — destroying VM $name"
|
||||||
|
hcloud server delete "$name" 2>/dev/null || true
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# --prepare: Create VM, install all build dependencies
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
do_prepare() {
|
||||||
|
local existing
|
||||||
|
existing=$(hcloud server list -o columns=name -o noheader 2>/dev/null | grep "$SERVER_NAME" | tr -d ' ' || true)
|
||||||
|
if [ -n "$existing" ]; then
|
||||||
|
log "VM already exists: $existing — reusing"
|
||||||
|
do_upload
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
notify "WZP Windows build STARTED ($BRANCH) — spinning up $SERVER_TYPE"
|
||||||
|
log "Creating Hetzner VM ($SERVER_TYPE, $IMAGE)..."
|
||||||
|
hcloud server create \
|
||||||
|
--name "$SERVER_NAME" \
|
||||||
|
--type "$SERVER_TYPE" \
|
||||||
|
--image "$IMAGE" \
|
||||||
|
--ssh-key "$SSH_KEY_NAME" \
|
||||||
|
--location fsn1 \
|
||||||
|
--quiet \
|
||||||
|
|| die "Failed to create VM"
|
||||||
|
|
||||||
|
local ip
|
||||||
|
ip=$(get_vm_ip)
|
||||||
|
[ -n "$ip" ] || die "VM created but no IP found"
|
||||||
|
echo " VM: $SERVER_NAME @ $ip"
|
||||||
|
|
||||||
|
log "Waiting for SSH..."
|
||||||
|
local ok=0
|
||||||
|
for i in $(seq 1 30); do
|
||||||
|
if ssh $SSH_OPTS -i "$SSH_KEY_PATH" "$REMOTE_USER@$ip" "echo ok" &>/dev/null; then
|
||||||
|
ok=1
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
sleep 2
|
||||||
|
done
|
||||||
|
[ "$ok" -eq 1 ] || die "SSH timeout after 60s"
|
||||||
|
|
||||||
|
# System packages — cargo-xwin needs llvm/lld; ring needs nasm on
|
||||||
|
# Windows; audiopus_sys (libopus) uses cmake + ninja to build for the
|
||||||
|
# Windows target; tauri's build.rs needs the frontend dist which needs
|
||||||
|
# node+npm.
|
||||||
|
log "Installing system packages (llvm, lld, clang, nasm, ninja, node)..."
|
||||||
|
ssh_cmd "export DEBIAN_FRONTEND=noninteractive && \
|
||||||
|
apt-get update -qq && \
|
||||||
|
apt-get install -y -qq \
|
||||||
|
build-essential cmake ninja-build curl git pkg-config \
|
||||||
|
llvm clang lld nasm \
|
||||||
|
libssl-dev ca-certificates \
|
||||||
|
unzip wget \
|
||||||
|
> /dev/null 2>&1" \
|
||||||
|
|| die "Failed to install system packages"
|
||||||
|
|
||||||
|
# Node.js 20 via NodeSource
|
||||||
|
ssh_cmd "curl -fsSL https://deb.nodesource.com/setup_20.x | bash - > /dev/null 2>&1 && \
|
||||||
|
apt-get install -y -qq nodejs > /dev/null 2>&1" \
|
||||||
|
|| die "Failed to install Node.js"
|
||||||
|
|
||||||
|
echo " clang: $(ssh_cmd "clang --version | head -1")"
|
||||||
|
echo " node: $(ssh_cmd "node --version")"
|
||||||
|
echo " npm: $(ssh_cmd "npm --version")"
|
||||||
|
|
||||||
|
# Rust
|
||||||
|
log "Installing Rust toolchain + target $RUST_TARGET..."
|
||||||
|
ssh_cmd "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain stable > /dev/null 2>&1" \
|
||||||
|
|| die "Failed to install Rust"
|
||||||
|
ssh_cmd "source \$HOME/.cargo/env && rustup target add $RUST_TARGET > /dev/null 2>&1" \
|
||||||
|
|| die "Failed to add Windows target"
|
||||||
|
echo " rust: $(ssh_cmd "source \$HOME/.cargo/env && rustc --version")"
|
||||||
|
|
||||||
|
# cargo-xwin — the cross compiler glue that fetches Windows SDK + CRT
|
||||||
|
# on demand and shims cc/lld to produce PE/COFF output. The Microsoft
|
||||||
|
# license is auto-accepted via XWIN_ACCEPT_LICENSE=1 below (current
|
||||||
|
# cargo-xwin removed the --accept-license CLI flag in favour of the
|
||||||
|
# env var; --dry-run just prints what it would do).
|
||||||
|
log "Installing cargo-xwin..."
|
||||||
|
ssh_cmd "source \$HOME/.cargo/env && cargo install cargo-xwin > /dev/null 2>&1" \
|
||||||
|
|| die "Failed to install cargo-xwin"
|
||||||
|
echo " cargo-xwin: $(ssh_cmd "source \$HOME/.cargo/env && cargo xwin --version 2>&1 | head -1")"
|
||||||
|
|
||||||
|
# Make the license-accept env var persist across later ssh_cmd calls so
|
||||||
|
# `cargo xwin build` in do_build() doesn't prompt interactively.
|
||||||
|
ssh_cmd "echo 'export XWIN_ACCEPT_LICENSE=1' >> \$HOME/.bashrc"
|
||||||
|
|
||||||
|
# Do the source upload + git clone (agent-forwarded) here.
|
||||||
|
do_upload
|
||||||
|
|
||||||
|
log "VM ready!"
|
||||||
|
echo " IP: $ip"
|
||||||
|
echo " SSH: ssh -A -i $SSH_KEY_PATH root@$ip"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# --upload: Clone the repo on the VM (not rsync — the branch we want
|
||||||
|
# lives in a separate worktree, and cloning from git is simpler + reuses
|
||||||
|
# whatever SSH identity the calling shell has loaded in its agent).
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
GIT_REPO="ssh://git@git.manko.yoga:222/manawenuz/wz-phone.git"
|
||||||
|
|
||||||
|
do_upload() {
|
||||||
|
log "Cloning wz-phone on VM (branch $BRANCH, agent-forwarded)..."
|
||||||
|
local ip
|
||||||
|
ip=$(get_vm_ip)
|
||||||
|
[ -n "$ip" ] || die "No VM found."
|
||||||
|
|
||||||
|
# Accept the git host key once so `git clone` doesn't hang asking.
|
||||||
|
ssh_cmd "mkdir -p \$HOME/.ssh && \
|
||||||
|
ssh-keyscan -p 222 -t rsa,ecdsa,ed25519 git.manko.yoga >> \$HOME/.ssh/known_hosts 2>/dev/null"
|
||||||
|
|
||||||
|
# Fresh clone each run — cheap on a short-lived builder VM, avoids
|
||||||
|
# stale state if the branch was force-pushed. --recurse-submodules so
|
||||||
|
# deps/featherchat (which has the warzone-protocol workspace member)
|
||||||
|
# comes along for the ride.
|
||||||
|
ssh_cmd "rm -rf /root/wzp-build && \
|
||||||
|
git clone --depth 1 --branch $BRANCH --recurse-submodules --shallow-submodules $GIT_REPO /root/wzp-build 2>&1 | tail -5" \
|
||||||
|
|| die "git clone failed — is your ssh-agent loaded with a key that can read git.manko.yoga?"
|
||||||
|
|
||||||
|
echo " Cloned $BRANCH into /root/wzp-build (with submodules)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# --build: Build frontend + cross-compile wzp-desktop.exe
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
do_build() {
|
||||||
|
log "Building frontend (vite)..."
|
||||||
|
ssh_cmd "cd /root/wzp-build/desktop && \
|
||||||
|
npm install --silent 2>&1 | tail -3 && \
|
||||||
|
npm run build 2>&1 | tail -5" \
|
||||||
|
|| die "Frontend build failed"
|
||||||
|
|
||||||
|
log "Cross-compiling wzp-desktop.exe ($RUST_TARGET) via cargo-xwin..."
|
||||||
|
# XWIN_ACCEPT_LICENSE=1 is required by recent cargo-xwin for headless
|
||||||
|
# runs; --cross-compiler clang-cl picks the system clang shipped by the
|
||||||
|
# apt install step in do_prepare.
|
||||||
|
ssh_cmd "source \$HOME/.cargo/env && \
|
||||||
|
export XWIN_ACCEPT_LICENSE=1 && \
|
||||||
|
cd /root/wzp-build/desktop/src-tauri && \
|
||||||
|
cargo xwin build --release --target $RUST_TARGET --bin wzp-desktop 2>&1 | tail -30" \
|
||||||
|
|| die "Windows cross-compile failed"
|
||||||
|
|
||||||
|
ssh_cmd "[ -f /root/wzp-build/target/$RUST_TARGET/release/wzp-desktop.exe ]" \
|
||||||
|
|| die "wzp-desktop.exe not found after build"
|
||||||
|
|
||||||
|
local exe_size
|
||||||
|
exe_size=$(ssh_cmd "du -h /root/wzp-build/target/$RUST_TARGET/release/wzp-desktop.exe | cut -f1")
|
||||||
|
echo " .exe: $exe_size"
|
||||||
|
|
||||||
|
local git_hash
|
||||||
|
git_hash=$(ssh_cmd "cd /root/wzp-build && git rev-parse --short HEAD")
|
||||||
|
notify "WZP Windows build OK [$git_hash] ($exe_size)"
|
||||||
|
export WZP_BUILD_GIT_HASH="$git_hash"
|
||||||
|
export WZP_BUILD_SIZE="$exe_size"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# --transfer: Download the .exe to local machine
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
do_transfer() {
|
||||||
|
log "Downloading wzp-desktop.exe..."
|
||||||
|
mkdir -p "$OUTPUT_DIR"
|
||||||
|
|
||||||
|
scp_down "/root/wzp-build/target/$RUST_TARGET/release/wzp-desktop.exe" "$OUTPUT_DIR/wzp-desktop.exe"
|
||||||
|
local local_size
|
||||||
|
local_size=$(du -h "$OUTPUT_DIR/wzp-desktop.exe" | cut -f1)
|
||||||
|
echo " $OUTPUT_DIR/wzp-desktop.exe ($local_size)"
|
||||||
|
|
||||||
|
# Upload to online rustypaste and notify with the URL.
|
||||||
|
log "Uploading to rustypaste..."
|
||||||
|
local url
|
||||||
|
url=$(rustypaste_upload "$OUTPUT_DIR/wzp-desktop.exe" || echo "")
|
||||||
|
if [ -n "$url" ]; then
|
||||||
|
echo " $url"
|
||||||
|
local hash="${WZP_BUILD_GIT_HASH:-?}"
|
||||||
|
notify "WZP Windows build ready [$hash] ($local_size)
|
||||||
|
$url"
|
||||||
|
else
|
||||||
|
echo " (rustypaste upload skipped — no creds in $RUSTY_ENV_FILE)"
|
||||||
|
notify "WZP Windows build transferred ($local_size) — rustypaste upload skipped"
|
||||||
|
fi
|
||||||
|
|
||||||
|
log "Transfer complete!"
|
||||||
|
echo ""
|
||||||
|
echo " Copy to a real Windows x86_64 host and double-click to run."
|
||||||
|
echo " WebView2 runtime is required on Windows 10 (ships with Win 11)."
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# --destroy: Delete the VM
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
do_destroy() {
|
||||||
|
local name
|
||||||
|
name=$(hcloud server list -o columns=name -o noheader 2>/dev/null | grep "$SERVER_NAME" | tr -d ' ' || true)
|
||||||
|
if [ -z "$name" ]; then
|
||||||
|
echo "No VM to destroy."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
log "Deleting VM: $name"
|
||||||
|
hcloud server delete "$name"
|
||||||
|
echo " Done."
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Full build: create → build → transfer → destroy
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
do_full() {
|
||||||
|
trap 'err "Build failed!"; [ "${KEEP_VM:-0}" = "1" ] || do_destroy_quiet; exit 1' ERR
|
||||||
|
|
||||||
|
do_prepare
|
||||||
|
do_build
|
||||||
|
do_transfer
|
||||||
|
|
||||||
|
if [ "$KEEP_VM" = "1" ]; then
|
||||||
|
log "VM kept alive (WZP_KEEP_VM=1). Destroy with: $0 --destroy"
|
||||||
|
else
|
||||||
|
do_destroy
|
||||||
|
fi
|
||||||
|
|
||||||
|
log "All done!"
|
||||||
|
echo ""
|
||||||
|
echo " ┌────────────────────────────────────────────────┐"
|
||||||
|
echo " │ Windows .exe: $OUTPUT_DIR/wzp-desktop.exe"
|
||||||
|
echo " │"
|
||||||
|
echo " │ Transfer to a Windows x86_64 machine and run."
|
||||||
|
echo " └────────────────────────────────────────────────┘"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Main
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
case "${1:-}" in
|
||||||
|
--prepare) do_prepare ;;
|
||||||
|
--build) do_build ;;
|
||||||
|
--transfer) do_transfer ;;
|
||||||
|
--destroy) do_destroy ;;
|
||||||
|
--upload) do_upload ;;
|
||||||
|
--all)
|
||||||
|
do_prepare
|
||||||
|
do_build
|
||||||
|
do_transfer
|
||||||
|
log "VM still running. Destroy with: $0 --destroy"
|
||||||
|
;;
|
||||||
|
"")
|
||||||
|
do_full
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $0 [--prepare|--build|--transfer|--destroy|--all|--upload]"
|
||||||
|
echo ""
|
||||||
|
echo " (no args) Full build: create VM → build → download → destroy VM"
|
||||||
|
echo " --prepare Create VM and install deps"
|
||||||
|
echo " --build Build on existing VM"
|
||||||
|
echo " --transfer Download .exe from VM"
|
||||||
|
echo " --destroy Delete the VM"
|
||||||
|
echo " --all prepare + build + transfer (VM persists)"
|
||||||
|
echo " --upload Re-upload source to existing VM"
|
||||||
|
echo ""
|
||||||
|
echo "Environment:"
|
||||||
|
echo " WZP_BRANCH=$BRANCH"
|
||||||
|
echo " WZP_SERVER_TYPE=$SERVER_TYPE"
|
||||||
|
echo " WZP_KEEP_VM=$KEEP_VM (set to 1 to skip auto-destroy)"
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
241
scripts/build-windows-docker.sh
Executable file
241
scripts/build-windows-docker.sh
Executable file
@@ -0,0 +1,241 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# =============================================================================
|
||||||
|
# WZ Phone — Windows x86_64 cross-compile (Docker on SepehrHomeserverdk)
|
||||||
|
#
|
||||||
|
# Cross-compiles the Tauri desktop binary for Windows via `cargo xwin`
|
||||||
|
# inside the wzp-windows-builder Docker image on SepehrHomeserverdk.
|
||||||
|
# Uploads the resulting .exe to rustypaste, fires ntfy.sh/wzp notifications
|
||||||
|
# at start + finish, and SCPs the .exe back locally.
|
||||||
|
#
|
||||||
|
# Same pattern as build-tauri-android.sh but for the Windows cross-compile
|
||||||
|
# pipeline:
|
||||||
|
# - Source: desktop/src-tauri/
|
||||||
|
# - Build: cargo xwin build --release --target x86_64-pc-windows-msvc
|
||||||
|
# - Output: target/x86_64-pc-windows-msvc/release/wzp-desktop.exe
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# ./scripts/build-windows-docker.sh # full pipeline
|
||||||
|
# ./scripts/build-windows-docker.sh --no-pull # skip git fetch
|
||||||
|
# ./scripts/build-windows-docker.sh --rust # force-clean rust target
|
||||||
|
# ./scripts/build-windows-docker.sh --image-build # (re)build the docker image
|
||||||
|
#
|
||||||
|
# Environment:
|
||||||
|
# WZP_BRANCH Branch to build (default: feat/desktop-audio-rewrite)
|
||||||
|
# =============================================================================
|
||||||
|
|
||||||
|
REMOTE_HOST="SepehrHomeserverdk"
|
||||||
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
LOCAL_OUTPUT="target/windows-exe"
|
||||||
|
BRANCH="${WZP_BRANCH:-feat/desktop-audio-rewrite}"
|
||||||
|
SSH_OPTS="-o ConnectTimeout=15 -o ServerAliveInterval=15 -o ServerAliveCountMax=4 -o LogLevel=ERROR"
|
||||||
|
|
||||||
|
REBUILD_RUST=0
|
||||||
|
DO_PULL=1
|
||||||
|
IMAGE_BUILD=0
|
||||||
|
for arg in "$@"; do
|
||||||
|
case "$arg" in
|
||||||
|
--rust) REBUILD_RUST=1 ;;
|
||||||
|
--pull) DO_PULL=1 ;;
|
||||||
|
--no-pull) DO_PULL=0 ;;
|
||||||
|
--image-build) IMAGE_BUILD=1 ;;
|
||||||
|
-h|--help)
|
||||||
|
sed -n '3,27p' "$0"
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
log() { echo -e "\033[1;36m>>> $*\033[0m"; }
|
||||||
|
ssh_cmd() { ssh -A $SSH_OPTS "$REMOTE_HOST" "$@"; }
|
||||||
|
|
||||||
|
notify_local() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
|
mkdir -p "$LOCAL_OUTPUT"
|
||||||
|
|
||||||
|
# ─── Optional: (re)build the docker image on the remote ────────────────────
|
||||||
|
# Runs once, whenever the Dockerfile changes. Fire-and-forget so the local
|
||||||
|
# script doesn't wait for the ~15 minute image build.
|
||||||
|
if [ "$IMAGE_BUILD" = "1" ]; then
|
||||||
|
log "Uploading Dockerfile.windows-builder to remote..."
|
||||||
|
scp $SSH_OPTS "$(dirname "$0")/Dockerfile.windows-builder" \
|
||||||
|
"$REMOTE_HOST:$BASE_DIR/Dockerfile.windows-builder"
|
||||||
|
|
||||||
|
log "Triggering remote image build (fire-and-forget)..."
|
||||||
|
ssh_cmd "cd $BASE_DIR && \
|
||||||
|
nohup docker build --pull -f Dockerfile.windows-builder \
|
||||||
|
-t wzp-windows-builder . \
|
||||||
|
> /tmp/wzp-windows-image-build.log 2>&1 & \
|
||||||
|
echo 'image build PID: '\$!"
|
||||||
|
notify_local "WZP Windows image build dispatched (check /tmp/wzp-windows-image-build.log on remote)"
|
||||||
|
log "Image build running in background on $REMOTE_HOST."
|
||||||
|
log "Tail the log with: ssh $REMOTE_HOST 'tail -f /tmp/wzp-windows-image-build.log'"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ─── Upload remote build runner script ─────────────────────────────────────
|
||||||
|
log "Uploading remote build script..."
|
||||||
|
ssh_cmd "cat > /tmp/wzp-windows-build.sh" <<'REMOTE_SCRIPT'
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
BASE_DIR="/mnt/storage/manBuilder"
|
||||||
|
NTFY_TOPIC="https://ntfy.sh/wzp"
|
||||||
|
BRANCH="${1:-feat/desktop-audio-rewrite}"
|
||||||
|
DO_PULL="${2:-1}"
|
||||||
|
REBUILD_RUST="${3:-0}"
|
||||||
|
|
||||||
|
LOG_FILE=/tmp/wzp-windows-build.log
|
||||||
|
GIT_HASH="unknown"
|
||||||
|
ENV_FILE="$BASE_DIR/.env"
|
||||||
|
|
||||||
|
notify() { curl -s -d "$1" "$NTFY_TOPIC" > /dev/null 2>&1 || true; }
|
||||||
|
|
||||||
|
# Upload to rustypaste; print URL on stdout (or empty on failure).
|
||||||
|
upload_to_rustypaste() {
|
||||||
|
local file="$1"
|
||||||
|
[ ! -f "$ENV_FILE" ] && { echo ""; return; }
|
||||||
|
# shellcheck disable=SC1090
|
||||||
|
source "$ENV_FILE"
|
||||||
|
if [ -n "${rusty_address:-}" ] && [ -n "${rusty_auth_token:-}" ]; then
|
||||||
|
curl -s -F "file=@$file" -H "Authorization: $rusty_auth_token" "$rusty_address" || echo ""
|
||||||
|
else
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
on_error() {
|
||||||
|
local line="$1"
|
||||||
|
local log_url
|
||||||
|
log_url=$(upload_to_rustypaste "$LOG_FILE" || echo "")
|
||||||
|
if [ -n "$log_url" ]; then
|
||||||
|
notify "WZP Windows build FAILED [$GIT_HASH] (line $line)
|
||||||
|
log: $log_url"
|
||||||
|
else
|
||||||
|
notify "WZP Windows build FAILED [$GIT_HASH] (line $line) — log upload failed, see $LOG_FILE on remote"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
trap 'on_error $LINENO' ERR
|
||||||
|
|
||||||
|
exec > >(tee "$LOG_FILE") 2>&1
|
||||||
|
|
||||||
|
# ── git fetch + reset the target branch ───────────────────────────────────
|
||||||
|
if [ "$DO_PULL" = "1" ]; then
|
||||||
|
echo ">>> git fetch + reset $BRANCH"
|
||||||
|
cd "$BASE_DIR/data/source"
|
||||||
|
git reset --hard HEAD 2>/dev/null || true
|
||||||
|
git gc --prune=now 2>/dev/null || true
|
||||||
|
git fetch origin "$BRANCH" 2>&1 | tail -3
|
||||||
|
git checkout "$BRANCH" 2>/dev/null || git checkout -b "$BRANCH" "origin/$BRANCH"
|
||||||
|
git reset --hard "origin/$BRANCH"
|
||||||
|
git submodule update --init --recursive || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
GIT_HASH=$(cd "$BASE_DIR/data/source" && git rev-parse --short HEAD 2>/dev/null || echo unknown)
|
||||||
|
GIT_MSG=$(cd "$BASE_DIR/data/source" && git log -1 --pretty=%s 2>/dev/null | head -c 60 || echo "?")
|
||||||
|
notify "WZP Windows build STARTED [$GIT_HASH] — $GIT_MSG"
|
||||||
|
|
||||||
|
# Fix perms so builder uid 1000 can read/write the mounted source.
|
||||||
|
find "$BASE_DIR/data/source" "$BASE_DIR/data/cache" \
|
||||||
|
! -user 1000 -o ! -group 1000 2>/dev/null | \
|
||||||
|
xargs -r chown 1000:1000 2>/dev/null || true
|
||||||
|
|
||||||
|
if [ "$REBUILD_RUST" = "1" ]; then
|
||||||
|
echo ">>> Cleaning Rust windows target dir..."
|
||||||
|
rm -rf "$BASE_DIR/data/cache/target-windows/x86_64-pc-windows-msvc" \
|
||||||
|
"$BASE_DIR/data/cache/target-windows/release"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ── Docker run ─────────────────────────────────────────────────────────────
|
||||||
|
# Cached volumes:
|
||||||
|
# - cargo-registry / cargo-git: shared with the android builder — both use
|
||||||
|
# the same crates, so the download cache is worth sharing.
|
||||||
|
# - target-windows: the Windows target tree. Kept separate from the android
|
||||||
|
# target-cache so the two pipelines don't stomp on each other's build
|
||||||
|
# artefacts (different triples, but the workspace root target dir has
|
||||||
|
# shared subdirs like release/build/ that can get confused).
|
||||||
|
# - cargo-xwin cache is BAKED into the docker image, no volume needed.
|
||||||
|
|
||||||
|
mkdir -p "$BASE_DIR/data/cache/cargo-registry" \
|
||||||
|
"$BASE_DIR/data/cache/cargo-git" \
|
||||||
|
"$BASE_DIR/data/cache/target-windows"
|
||||||
|
chown -R 1000:1000 "$BASE_DIR/data/cache/target-windows" 2>/dev/null || true
|
||||||
|
|
||||||
|
docker run --rm \
|
||||||
|
--user 1000:1000 \
|
||||||
|
-v "$BASE_DIR/data/source:/build/source" \
|
||||||
|
-v "$BASE_DIR/data/cache/cargo-registry:/home/builder/.cargo/registry" \
|
||||||
|
-v "$BASE_DIR/data/cache/cargo-git:/home/builder/.cargo/git" \
|
||||||
|
-v "$BASE_DIR/data/cache/target-windows:/build/source/target" \
|
||||||
|
wzp-windows-builder \
|
||||||
|
bash -c '
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# (SSE4.1 / SSSE3 toolchain patch for libopus is baked into the image
|
||||||
|
# during the xwin pre-warm — see Dockerfile.windows-builder. No runtime
|
||||||
|
# patching needed.)
|
||||||
|
|
||||||
|
cd /build/source/desktop
|
||||||
|
|
||||||
|
echo ">>> npm install"
|
||||||
|
npm install --silent 2>&1 | tail -5 || npm install 2>&1 | tail -20
|
||||||
|
|
||||||
|
echo ">>> npm run build"
|
||||||
|
npm run build 2>&1 | tail -5
|
||||||
|
|
||||||
|
echo ">>> cargo xwin build --release --target x86_64-pc-windows-msvc --bin wzp-desktop"
|
||||||
|
cd src-tauri
|
||||||
|
cargo xwin build --release --target x86_64-pc-windows-msvc --bin wzp-desktop 2>&1 | tail -50
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo ">>> Build artifacts:"
|
||||||
|
ls -lh /build/source/target/x86_64-pc-windows-msvc/release/wzp-desktop.exe 2>/dev/null || echo "NO EXE"
|
||||||
|
'
|
||||||
|
|
||||||
|
# Locate the produced .exe
|
||||||
|
EXE="$BASE_DIR/data/cache/target-windows/x86_64-pc-windows-msvc/release/wzp-desktop.exe"
|
||||||
|
if [ ! -f "$EXE" ]; then
|
||||||
|
LOG_URL=$(upload_to_rustypaste "$LOG_FILE" || echo "")
|
||||||
|
if [ -n "$LOG_URL" ]; then
|
||||||
|
notify "WZP Windows build [$GIT_HASH]: no .exe produced
|
||||||
|
log: $LOG_URL"
|
||||||
|
else
|
||||||
|
notify "WZP Windows build [$GIT_HASH]: no .exe produced — log upload failed"
|
||||||
|
fi
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
EXE_SIZE=$(du -h "$EXE" | cut -f1)
|
||||||
|
|
||||||
|
RUSTY_URL=$(upload_to_rustypaste "$EXE" || echo "")
|
||||||
|
if [ -n "$RUSTY_URL" ]; then
|
||||||
|
notify "WZP Windows build OK [$GIT_HASH] ($EXE_SIZE)
|
||||||
|
$RUSTY_URL"
|
||||||
|
else
|
||||||
|
notify "WZP Windows build OK [$GIT_HASH] ($EXE_SIZE) — rustypaste upload skipped"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Print path so the local script can scp it back
|
||||||
|
echo "EXE_REMOTE_PATH=$EXE"
|
||||||
|
REMOTE_SCRIPT
|
||||||
|
|
||||||
|
ssh_cmd "chmod +x /tmp/wzp-windows-build.sh"
|
||||||
|
|
||||||
|
notify_local "WZP Windows build dispatched (branch=$BRANCH)"
|
||||||
|
log "Triggering remote build (branch=$BRANCH)..."
|
||||||
|
|
||||||
|
# Run; last line is EXE_REMOTE_PATH=...
|
||||||
|
REMOTE_OUTPUT=$(ssh_cmd "/tmp/wzp-windows-build.sh '$BRANCH' '$DO_PULL' '$REBUILD_RUST'" || true)
|
||||||
|
echo "$REMOTE_OUTPUT" | tail -60
|
||||||
|
|
||||||
|
EXE_REMOTE=$(echo "$REMOTE_OUTPUT" | grep '^EXE_REMOTE_PATH=' | tail -1 | cut -d= -f2-)
|
||||||
|
if [ -n "$EXE_REMOTE" ]; then
|
||||||
|
log "Downloading wzp-desktop.exe to $LOCAL_OUTPUT/..."
|
||||||
|
scp $SSH_OPTS "$REMOTE_HOST:$EXE_REMOTE" "$LOCAL_OUTPUT/wzp-desktop.exe"
|
||||||
|
echo " $LOCAL_OUTPUT/wzp-desktop.exe ($(du -h "$LOCAL_OUTPUT/wzp-desktop.exe" | cut -f1))"
|
||||||
|
else
|
||||||
|
log "No .exe produced — see ntfy / remote log /tmp/wzp-windows-build.log"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
Reference in New Issue
Block a user