Files
advanced-camera-card/tests/utils/live-provider.test.ts
T
Dermot Duffy 11cc543406 fix: Hold the 2-way audio backchannel open for the shortest possible time (#2697)
The card claimed a camera's ONVIF audio backchannel in two places that
had
nothing to do with a call: the capability probe at camera init
(`&microphone`),
and a pre-armed `sendonly` audio transceiver on every live WebRTC offer.
Merely
looking at a dashboard occupied the camera's speaker line. Outbound
audio now
travels on its own audio-only WebRTC connection, opened when a call is
answered
and closed when it ends.

- The backchannel is claimed only for the duration of a call. Idle
viewing
  claims nothing.
- Two-way audio now works in `mse`, `mp4` and `mjpeg` modes (note: the
outbound
  audio still traverses WebRTC).
- No renegotiation and no video blink at call start or end.
- A call that cannot carry audio now reports it and ends, instead of
showing a
  live microphone that goes nowhere.
- `live.microphone.always_connected` is now purely about the browser
microphone
  permission prompt.
- Call setup measured at 66ms (LAN) and ~260ms (cellular) for ICE and
DTLS, plus
  ~300ms for `go2rtc` to open an RTSP backchannel.

Verified against a live Frigate + `go2rtc` instance, and by unit tests
at 100%
coverage.

 - Closes #2691
 - Closes #2039
 - Closes #2178

Ref #2299 -- the probe no longer opens a backchannel, but it still runs
per
camera on every load and reconnect, and still dials the camera on the
direct-`go2rtc` path. Caching remains to be done.

Ref AlexxIT/go2rtc#1860 -- once a call has opened a backchannel,
`go2rtc` keeps
that media set up on the camera's RTSP session for the life of the
producer.

Diagnoses #2678
2026-08-21 20:13:58 -07:00

153 lines
4.4 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from 'vitest';
import * as go2rtcAudio from '../../src/go2rtc/audio';
import {
getResolvedLiveProvider,
isGo2RTCLiveProvider,
liveProviderSupports2WayAudio,
} from '../../src/utils/live-provider';
import { createCameraConfig } from '../config/test-utils';
import { createHASS } from '../test-utils';
vi.mock('../../src/go2rtc/audio');
describe('live-provider utils', () => {
beforeEach(() => {
vi.clearAllMocks();
});
describe('getResolvedLiveProvider', () => {
it('should resolve webrtc-card with entity', () => {
const config = createCameraConfig({
live_provider: 'auto',
webrtc_card: { entity: 'camera.test' },
});
expect(getResolvedLiveProvider(config)).toBe('webrtc-card');
});
it('should resolve webrtc-card with url', () => {
const config = createCameraConfig({
live_provider: 'auto',
webrtc_card: { url: 'http://test' },
});
expect(getResolvedLiveProvider(config)).toBe('webrtc-card');
});
it('should resolve ha', () => {
const config = createCameraConfig({
live_provider: 'auto',
camera_entity: 'camera.test',
});
expect(getResolvedLiveProvider(config)).toBe('ha');
});
it('should resolve jsmpeg', () => {
const config = createCameraConfig({
live_provider: 'auto',
frigate: { camera_name: 'test' },
});
expect(getResolvedLiveProvider(config)).toBe('jsmpeg');
});
it('should resolve image by default for auto', () => {
const config = createCameraConfig({
live_provider: 'auto',
});
expect(getResolvedLiveProvider(config)).toBe('image');
});
it('should return explicitly configured provider', () => {
const config = createCameraConfig({
live_provider: 'go2rtc',
});
expect(getResolvedLiveProvider(config)).toBe('go2rtc');
});
it('should return image if config is undefined', () => {
expect(getResolvedLiveProvider(undefined)).toBe('image');
});
});
describe('isGo2RTCLiveProvider', () => {
it('should return true for go2rtc', () => {
expect(isGo2RTCLiveProvider('go2rtc')).toBe(true);
});
it('should return true for go2rtc-experimental', () => {
expect(isGo2RTCLiveProvider('go2rtc-experimental')).toBe(true);
});
it('should return false for other providers', () => {
expect(isGo2RTCLiveProvider('ha')).toBe(false);
});
});
describe('liveProviderSupports2WayAudio', () => {
it('should return false if resolved provider is not go2rtc', async () => {
const config = createCameraConfig({
live_provider: 'ha',
});
const hass = createHASS();
const result = await liveProviderSupports2WayAudio(
hass,
config,
config.go2rtc.metadata_fetch_timeout_seconds,
);
expect(result).toBe(false);
});
it('should return result from go2rtcSupports2WayAudio', async () => {
const config = createCameraConfig({
live_provider: 'go2rtc',
});
const hass = createHASS();
vi.mocked(go2rtcAudio.supports2WayAudio).mockResolvedValue(true);
const result = await liveProviderSupports2WayAudio(
hass,
config,
config.go2rtc.metadata_fetch_timeout_seconds,
);
expect(result).toBe(true);
expect(go2rtcAudio.supports2WayAudio).toHaveBeenCalledWith(
hass,
2,
undefined,
undefined,
);
});
it('should support 2-way audio for the experimental provider', async () => {
const config = createCameraConfig({
live_provider: 'go2rtc-experimental',
});
const hass = createHASS();
vi.mocked(go2rtcAudio.supports2WayAudio).mockResolvedValue(true);
const result = await liveProviderSupports2WayAudio(
hass,
config,
config.go2rtc.metadata_fetch_timeout_seconds,
);
expect(result).toBe(true);
});
it('should pass metadata fetch timeout through to go2rtc detection', async () => {
const config = createCameraConfig({
live_provider: 'go2rtc',
});
const hass = createHASS();
vi.mocked(go2rtcAudio.supports2WayAudio).mockResolvedValue(true);
await liveProviderSupports2WayAudio(hass, config, 30);
expect(go2rtcAudio.supports2WayAudio).toHaveBeenCalledWith(
hass,
30,
undefined,
undefined,
);
});
});
});