mirror of
https://github.com/mudler/LocalAI.git
synced 2026-07-31 10:28:43 -04:00
2f6e0481f7
AudioTranscriptionLive holds the model's inference lane for the whole stream,
which is correct (the streaming session is stateful and a concurrent run would
interleave two callers' audio) and newly dangerous. Every other RPC holds the
lane across compute, or across a write to a slow reader, and both of those
terminate on their own. A live stream instead blocks in a client-driven read,
and a peer that goes silent WITHOUT closing the stream never terminates
anything: the lane stays taken and every other request against that model queues
behind a client that stopped speaking.
live_watchdog is a one-shot idle timer that ends the stream when no frame has
arrived inside a window. It is standard library only, so it is unit tested
without an engine. gRPC's synchronous Read has no timeout and cannot be given
one, so the only way to unblock it is ServerContext::TryCancel, which decides
the wire status itself: the client sees CANCELLED rather than the
DEADLINE_EXCEEDED the handler returns, the reason is logged, and the lane coming
back is the point. When it fires the read loop throws rather than reporting
end-of-input, so the driver does not go on to finalize a decode nobody is
waiting for.
It is armed only after the lane is taken and disarmed as soon as the read side
closes, and both ends matter. Arming earlier would cover acquire(), which
legitimately blocks while another live stream runs, so a queued caller would be
cancelled for waiting its turn. Disarming later would cover our own decode,
where a window overrun is not a peer going quiet and cancelling would throw away
the transcript the client is waiting for.
The window is the new live_idle_timeout_ms option, 30 s by default, 0 meaning no
limit. core/http/endpoints/openai/realtime.go drives a 300 ms ticker and feeds
every tick that produced new audio while a turn is open, so 30 s of silence is a
hundred ticks that delivered nothing. It is also longer than any pause a speaker
takes mid-utterance, which is the case that must never be cut off, and
backend.proto lets one stream span many utterances, so a client that pauses
longer between them raises the option rather than discovering it.
Two smaller corrections in the same handler:
- check_can_serve now runs BEFORE the sample rate check.
pkg/grpc/grpcerrors/errors.go degrades to the file path on UNIMPLEMENTED and
on nothing else, so a live-incapable model asked at a wrong rate was
answering INVALID_ARGUMENT and costing the caller its fallback.
- a negative sample rate is refused instead of silently becoming 16000. Zero
still means 16000, which is what the proto documents; -1 is malformed rather
than absent and gets the same refusal every other bad rate gets.
And one thing recorded rather than changed, at the handler: "live" here means
incremental INPUT, not low latency, and with the pinned families it does not yet
mean incremental OUTPUT either. nemotron_asr's process_audio_chunk only appends
to its buffer, so its whole decode and every delta happen inside finalize(),
after the client closes its send side. The policy-window buffering is inert for
that family and matters only for vibevoice_asr and higgs_audio_stt.
Verified on the wire with live_idle_timeout_ms:3000. A silent client acked at
371 ms and was cancelled at 3.371 s; a second live stream opened one second
later received its ack 2.37 s in, i.e. at the instant the first was cancelled,
and then transcribed successfully on the same cached session. Without the
watchdog it would still be waiting. Re-ran the live transcription (ready first,
59 incremental deltas, concat equal to the final text, word timestamps in
nanoseconds, eou and eob false), the citrinet refusal at both a right and a
wrong rate (UNIMPLEMENTED either way now), and Task 12's AudioTranscriptionStream
on nemotron_asr, which is unchanged.
Mutation testing the watchdog found a weakness in its own test: the destructor
test slept past the window inside the watched scope, so a destructor that
DETACHED the thread instead of joining it passed unnoticed. The test now uses a
window longer than the scope, which kills that mutant, and says why.
Assisted-by: Claude:claude-opus-5 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
67 lines
3.0 KiB
C++
67 lines
3.0 KiB
C++
#pragma once
|
|
|
|
// Parses the model YAML's `options:` list (ModelOptions.Options in
|
|
// backend.proto) into a struct. Standard library only: this unit is compiled
|
|
// and tested by backend/cpp/run-unit-tests.sh without an audio.cpp checkout.
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace audiocpp_backend {
|
|
|
|
struct ModelOptions {
|
|
// audio.cpp model family. Empty means "derive from the GGUF's embedded
|
|
// audiocpp.model_spec.family key"; a non-GGUF path with an empty family is
|
|
// rejected at load time, not here.
|
|
std::string family;
|
|
// Pins the audio.cpp task, overriding RPC-based routing. Empty means route.
|
|
std::string task;
|
|
// ggml backend: cpu, cuda, vulkan, metal, best.
|
|
std::string backend = "cpu";
|
|
int device = 0;
|
|
// True once a `device:` entry has been seen. 0 is both the default and a
|
|
// legitimate device index, so the value alone cannot tell an explicit
|
|
// `device:0` from an unset option, and a caller merging in its own fallback
|
|
// would silently override the explicit choice.
|
|
bool device_set = false;
|
|
// 0 means "let the runtime decide".
|
|
int threads = 0;
|
|
std::string model_spec_override;
|
|
// 0 disables the run guard's fail-fast, restoring an unbounded wait.
|
|
int busy_timeout_ms = 0;
|
|
// How long AudioTranscriptionLive waits for the next audio frame before it
|
|
// cancels the stream and gives the model's lane back. 0 means NO LIMIT.
|
|
//
|
|
// It exists because that RPC holds the lane for the whole stream, so a peer
|
|
// that stops sending WITHOUT closing blocks every other request against this
|
|
// model for as long as its socket stays up. No other RPC can do that: they
|
|
// hold the lane across compute, which ends on its own.
|
|
//
|
|
// 30 seconds, and the number is picked from what the only in-tree client
|
|
// does. core/http/endpoints/openai/realtime.go drives a 300 ms ticker and
|
|
// feeds every tick that produced new audio while a turn is open, so 30 s of
|
|
// silence is a hundred ticks that delivered nothing: the peer is gone, or
|
|
// its socket is wedged. It is also comfortably longer than any pause a
|
|
// speaker takes mid-utterance, which is the case that must never be cut off,
|
|
// and backend.proto allows one stream to span many utterances, so a client
|
|
// that pauses for longer than this between them should raise it rather than
|
|
// discover it. Lowering it below a few seconds risks cancelling a live
|
|
// speaker; 0 turns the limit off for a client that legitimately idles.
|
|
int live_idle_timeout_ms = 30000;
|
|
// `load.<key>:<value>` entries, prefix stripped.
|
|
std::map<std::string, std::string> load_options;
|
|
// `session.<key>:<value>` entries, prefix stripped.
|
|
std::map<std::string, std::string> session_options;
|
|
};
|
|
|
|
struct ParsedOptions {
|
|
ModelOptions options;
|
|
// Non-empty means the caller must fail the load with INVALID_ARGUMENT.
|
|
std::string error;
|
|
};
|
|
|
|
ParsedOptions parse_model_options(const std::vector<std::string> &entries);
|
|
|
|
} // namespace audiocpp_backend
|