Talon/voice-cat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1dfe3c95eda6e7e697882e35e4d856ff9f85986b
voice-cat/clients/apple/README.md
Talon b332b0972b scaffold: M0 skeleton + agent onboarding (build, architecture, progress) 
Turn the design into a buildable, dependency-free M0 skeleton plus the
onboarding layer so a new agent can pick up instantly.

Build system:
- CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json
- Skeleton builds with just a C++20 compiler; deps stay off until needed
- .gitattributes (LF), .gitignore, .clang-format

Core (libvoicecat):
- core/include/voicecat.h: full C ABI (the client/server contract), stubbed
- core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md
- src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that
  return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc
- server/ (voicecat-server) and tools/vccli/ link the core
- tests/: CTest smoke test asserting the C ABI contract (behavior, not just build)
- clients/{apple,windows}: M4 placeholders

Onboarding for agents:
- CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules
- AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal)
- PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off"

Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00

1.1 KiB
Raw Blame History

Apple client (macOS + iOS) — placeholder

Built in M4 (see docs/roadmap.md). Swift + SwiftUI, consuming libvoicecat through the C ABI (core/include/voicecat.h).

Planned shape (see docs/architecture.md §4 and docs/tech-stack.md §2):

  • A Swift Package wrapping the core as an XCFramework (macOS + iOS device + simulator).
  • A module map exposing voicecat.h to Swift (Swift can also use C++ interop directly, but the C ABI is the stable contract).
  • SwiftUI app target for macOS and iOS.
  • iOS audio: app owns AVAudioSession (.playAndRecord / .voiceChat), mic permission, interruption/route handling, calling vc_audio_* hooks on the core.
  • iOS screen/system audio (SCREEN_AUDIO): a ReplayKit Broadcast Upload Extension capturing RPSampleBufferType.audioApp, linking a minimal core slice, sharing session state via an App Group (docs/voice.md §9).

Nothing here yet — the core must reach M2 (working voice) before the GUI is worth building.