Skip to content

VoiceStudio is the open-source, fully-local ElevenLabs alternative — voice cloning, voice design, video dubbing, dictation, transcription & audiobook creation in 646 languages.

fix(ios): reserve download space and snapshot speech text

debpalash680eb6c46d85
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 62a7744fd..48447f460 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -29,6 +29,7 @@ metadata and the backend fallback mirror it.
### Fixed
+- iOS reserves storage across simultaneous model downloads and keeps saved speech paired with the submitted text (#2969)
- TestFlight builds prepare the on-device inference runtimes before archiving the iPhone app (#2969)
- Phone models can be reaccepted offline without downloading again, and Android dubbing preserves short audio gaps and overlaps (#2969)
diff --git a/docs/mobile.md b/docs/mobile.md
index 5e5aa8142..fced0cbea 100644
--- a/docs/mobile.md
+++ b/docs/mobile.md
@@ -30,6 +30,11 @@ Open **Models** and download what you need. Nothing downloads until you tap
it; files come from Hugging Face and are checked before use. Wi-Fi only unless
you allow mobile data.
+Concurrent downloads reserve their combined remaining disk space. If they will
+not fit together, finish or cancel one before starting another; completed ranges
+remain available for resume. Saved speech keeps the text submitted for that take,
+even if you edit the next script while synthesis is running.
+
| Model | For | Size | Phone memory |
|---|---|---|---|
| Kitten (English) / Kokoro (multi-language) | Speak | ~170 MB each | 2–3 GB |
diff --git a/mobile/ios/VoiceStudio/Features/SpeakView.swift b/mobile/ios/VoiceStudio/Features/SpeakView.swift
index 1089062b0..649af750f 100644
--- a/mobile/ios/VoiceStudio/Features/SpeakView.swift
+++ b/mobile/ios/VoiceStudio/Features/SpeakView.swift
@@ -170,6 +170,7 @@ struct SpeakView: View {
private var generationControls: some View {
VStack(spacing: VSTokens.spacingGap) {
Button {
+ let submittedText = text
generation = Task {
generating = true; defer { generating = false; localProgress = nil }
await model.perform(onPhone: route == .phone) {
@@ -179,16 +180,16 @@ struct SpeakView: View {
let report: EngineProgressHandler = { value in await MainActor.run { localProgress = value } }
if let voice = phoneVoice, let store = model.phone.voiceStore {
let reference = try await store.reference(voice)
- audio = try await engine.clone(model: phoneModel,text: text,reference: reference,referenceText: voice.transcript,progress: report)
+ audio = try await engine.clone(model: phoneModel,text: submittedText,reference: reference,referenceText: voice.transcript,progress: report)
} else {
- audio = try await engine.synthesize(model: phoneModel.selectingLanguage(phoneLanguage),text: text,speaker: Int(speakerID) ?? 0,speed: 1,progress: report)
+ audio = try await engine.synthesize(model: phoneModel.selectingLanguage(phoneLanguage),text: submittedText,speaker: Int(speakerID) ?? 0,speed: 1,progress: report)
}
- _ = try await model.phone.generationStore?.save(text: text,audio: audio)
+ _ = try await model.phone.generationStore?.save(text: submittedText,audio: audio)
await model.phone.refresh()
try await player.load(audio.markSynthetic(), extension: "wav")
return
}
- let result = try await model.hostState.generate(api: model.api(), text: text, profile: selection.profileID, engine: selection.engineID, language: selection.language)
+ let result = try await model.hostState.generate(api: model.api(), text: submittedText, profile: selection.profileID, engine: selection.engineID, language: selection.language)
try await player.load(result.audio, extension: "wav")
model.history = try await model.api().history()
}
diff --git a/mobile/ios/VoiceStudioKit/Sources/VoiceStudioKit/Local/ModelStore.swift b/mobile/ios/VoiceStudioKit/Sources/VoiceStudioKit/Local/ModelStore.swift
index 8061463ab..f0005fbef 100644
--- a/mobile/ios/VoiceStudioKit/Sources/VoiceStudioKit/Local/ModelStore.swift
+++ b/mobile/ios/VoiceStudioKit/Sources/VoiceStudioKit/Local/ModelStore.swift
@@ -47,6 +47,7 @@ public actor ModelStore {
public let root: URL
private var acceptances: [String: [LicenceAcceptance]] = [:]
private var active = Set<String>()
+ private var reservations: [String: [PhoneModel.File]] = [:]
private var leases: [String: Int] = [:]
private struct VerificationStamp: Equatable {
let size: Int64
@@ -143,10 +144,15 @@ public actor ModelStore {
guard model.fits(ram: ram) else { throw ClientError("mobile.local.ram_required", params: ["ram": String(model.min_ram_gb)]) }
try checkPermission(model)
guard !active.contains(model.id), leases[model.id, default: 0] == 0 else { throw ClientError("sidebarTools.wait") }
- active.insert(model.id); defer { active.remove(model.id) }
+ active.insert(model.id)
+ defer { active.remove(model.id); reservations.removeValue(forKey: model.id) }
let transport = supplied ?? ModelDownloadTransport(policy: policy)
try FileManager.default.createDirectory(at: directory(model), withIntermediateDirectories: true)
let identity = try phoneModelPin(model)
+ reservations[model.id] = try model.files.filter {
+ try !verify(directory(model).appendingPathComponent($0.path), file: $0, identity: identity)
+ }
+ try checkDownloadSpace()
var completed: Int64 = 0
for f in model.files {
try Task.checkCancellation(); try checkPermission(model)
@@ -160,7 +166,7 @@ public actor ModelStore {
let onWifi = await wifi()
guard policy.allowMobileData || onWifi else { throw ClientError("mobile.local.wifi_required") }
let offset = size(part)
- guard try available(root) >= (f.size - offset) + 16_777_216 else { throw ClientError("mobile.local.storage_required") }
+ try checkDownloadSpace()
var lastFailure: (any Error)?
var received = false
for host in ["huggingface.co", "hf-mirror.com"] {
@@ -202,11 +208,24 @@ public actor ModelStore {
verified.removeValue(forKey: part)
verified[destination] = try stamp(destination,identity: identity)
completed += f.size
+ reservations[model.id]?.removeAll { $0.path == f.path }
}
try Task.checkCancellation(); try checkPermission(model)
try JSONEncoder().encode(Dictionary(uniqueKeysWithValues: model.files.map { ($0.path, $0.sha256) })).write(to: directory(model).appendingPathComponent("verified.json"), options: .atomic)
await progress(1)
}
+ private func checkDownloadSpace() throws {
+ // Already persisted ranges occupy real disk space, so reserve only bytes still missing.
+ let remaining = reservations.reduce(Int64(0)) { total, entry in
+ total + entry.value.reduce(Int64(0)) { subtotal, file in
+ let part = root.appendingPathComponent(entry.key).appendingPathComponent(".partial/" + file.sha256)
+ return subtotal + max(0, file.size - size(part))
+ }
+ }
+ if remaining > 0 {
+ guard try available(root) >= remaining + 16_777_216 else { throw ClientError("mobile.local.storage_required") }
+ }
+ }
private func directory(_ model: PhoneModel) -> URL { root.appendingPathComponent(model.id, isDirectory: true) }
private func partial(_ model: PhoneModel, _ file: PhoneModel.File) -> URL { directory(model).appendingPathComponent(".partial/" + file.sha256) }
private func size(_ url: URL) -> Int64 { (try? FileManager.default.attributesOfItem(atPath: url.path)[.size] as? NSNumber)?.int64Value ?? 0 }
diff --git a/mobile/ios/VoiceStudioKit/Tests/VoiceStudioKitTests/LocalInferenceTests.swift b/mobile/ios/VoiceStudioKit/Tests/VoiceStudioKitTests/LocalInferenceTests.swift
index 7cde5de22..18b76a025 100644
--- a/mobile/ios/VoiceStudioKit/Tests/VoiceStudioKitTests/LocalInferenceTests.swift
+++ b/mobile/ios/VoiceStudioKit/Tests/VoiceStudioKitTests/LocalInferenceTests.swift
@@ -10,10 +10,10 @@ private func localDirectory() throws -> URL {
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
return url
}
-private func localFixture(bytes: Data = Data("model".utf8), gated: Bool = false, capability: String = "tts", fingerprint: String = String(repeating: "a", count: 64)) throws -> PhoneModel {
+private func localFixture(bytes: Data = Data("model".utf8), gated: Bool = false, capability: String = "tts", fingerprint: String = String(repeating: "a", count: 64), id: String = "fixture") throws -> PhoneModel {
let runtime = capability == "clone" ? "omnivoice.cpp" : capability == "translate" ? "llama.cpp" : "sherpa-onnx"
let object: [String: Any] = ["schema_version": 1, "models": [[
- "id": "fixture", "name": "Fixture", "capability": capability, "runtime": runtime, "repo": "owner/model", "revision": String(repeating: "b", count: 40),
+ "id": id, "name": "Fixture", "capability": capability, "runtime": runtime, "repo": "owner/model", "revision": String(repeating: "b", count: 40),
"files": [["path": "model.bin", "size": bytes.count, "sha256": SHA256.hash(data: bytes).map { String(format: "%02x", $0) }.joined(), "role": "model"]],
"total_bytes": bytes.count, "languages": ["en"], "min_ram_gb": 1,
"licence": ["id": "test", "category": gated ? "non-commercial" : "commercial-ok", "requires_acceptance": false, "credit": "Fixture", "rights_holder": "Fixture", "terms_fingerprint": fingerprint],
@@ -98,6 +98,33 @@ private actor RangeServer: HTTPTransport {
try await store.download(model, policy: DownloadPolicy(allowMobileData: true), wifi: { false }, transport: host)
#expect(await store.installed(model))
}
+@Test func concurrentModelDownloadsReserveSpaceAndReleaseItOnCancellation() async throws {
+ let root = try localDirectory(); defer { try? FileManager.default.removeItem(at: root) }
+ let first = try localFixture(), second = try localFixture(id: "second")
+ let store = try ModelStore(root: root, available: { _ in 16_777_216 + 7 })
+ let blocked = RangeServer(bytes: Data("model".utf8), slowAfter: 0)
+ let work = Task { try await store.download(first, wifi: { true }, transport: blocked) }
+ defer { work.cancel() }
+ for await count in blocked.events { if count == 1 { break } }
+ let other = RangeServer(bytes: Data("model".utf8))
+ await #expect(throws: (any Error).self) { try await store.download(second, wifi: { true }, transport: other) }
+ #expect(await other.requests.isEmpty)
+ work.cancel()
+ await #expect(throws: CancellationError.self) { try await work.value }
+ try await store.download(second, wifi: { true }, transport: other)
+ #expect(await store.installed(second))
+}
+@Test func downloadReservationDoesNotCountPersistedRangesTwice() async throws {
+ let root = try localDirectory(); defer { try? FileManager.default.removeItem(at: root) }
+ let bytes = Data(repeating: 23, count: 4_194_304 + 8), model = try localFixture(bytes: bytes)
+ let part = root.appendingPathComponent(model.id).appendingPathComponent(".partial/" + model.files[0].sha256)
+ let store = try ModelStore(root: root, available: { _ in
+ let written = (try? FileManager.default.attributesOfItem(atPath: part.path)[.size] as? NSNumber)?.int64Value ?? 0
+ return 16_777_216 + Int64(bytes.count) - written
+ })
+ try await store.download(model, wifi: { true }, transport: RangeServer(bytes: bytes))
+ #expect(await store.installed(model))
+}
@Test func localDownloadCancellationRetainsRangeForResume() async throws {
let root = try localDirectory(); defer { try? FileManager.default.removeItem(at: root) }
let bytes = Data(repeating: 19, count: 4_194_304 + 8)