Return json with:

• rocd version
• rocd git commit
• go version
• os
• arch
• device backend (pulseaudio, pipewire)
• device backend version

Also show this info in /admin.

1. Declare common error types in models package (e.g. NotFound, ServiceUnavailable).
2. Use them when reporting errors in device manager, stream manager, etc.
3. Translate them to HTTP responses in server.go

Check that js code builds and doesn't differ from committed files.

Check that code generation works. Check that after generation and formatting there are no changed files, i.e. committed files are uptodate.

Add yaml config that allows user to configure stream devices and streams statically, without need to use http.

On start, rocd should read stream devices and streams from config and create or update actual devices & streams to match them.

Such devices & streams should be readonly, and it shouldn't be possible to modify or delete them via http.

(We can also add readonly: true/false to json)

We also need /reload endpoint to re-read config.

We need to implement StreamManager. See USAGE#streams for more details.

Stream:

• Is a virtual object that maps connects some Device (by UID) -- reader -- to a list of peers -- writers (each peer has 1 to 3 interfaces). On diagram below, it is a sender-to-recerver part of the pipeline.
• In MVP Stream may be implemented as a goroutine that manages a number of subprocesses: roc-send, roc-recv.
• Should be stored persistently and restored on daemon start.
• Should be able to be updated through API. The payload accepts a subset of parameters that are being updated.
• StreamManager should handle situations when subprocesses are crashed. (This should be analyzed.)
• There are 2 Stream types:
  • sending Stream: is has from_device and to_address paarameters
  • receiving Stream: is has from_address and to_device paarameters
• Initially there are no Streams.

graph LR
  microphone --> input
  subgraph roc_sender
    input --> sender1
    input --> sender2
  end
  sender1 -- AU_SRC --> receiver1
  sender1 -- AU_RPR --> receiver1
  sender1 <-- AU_CTL --> receiver1

  sender2 -- AU_SRC --> receiver2
  sender2 -- AU_RPR --> receiver2
  sender2 <-- AU_CTL --> receiver2

  subgraph roc_receiver1
    receiver1 --> output1
  end
  subgraph roc_receiver2
    receiver2 --> output2
  end

  output1 --> speaker1
  output2 --> speaker2

Steps

• Implement StreamManager methods.
• ...

Out of scope

• Choose storage format for Streams.

Docs

• https://roc-streaming.org/toolkit/docs/tools/command_line_tools.html
• https://roc-streaming.org/toolkit/docs/api/examples.html
• https://roc-streaming.org/toolkit/docs/api/reference.html

See arm32 and arm64 targets.

Options:

• path to state file
• path to config file
• ip
• port
• force specific device backend

Also add --help and --version.

Use some simple key-value db instead of yaml file, to avoid scaling problems when number of streams is high.

Ideally choose pure go implementation to avoid cgo dependencies.

To serialize structs into kv db we could use msgpack.

• GET /beacons
• POST /beacons
• GET /beacons/uid
• PUT /beacons/uid
• DELETE /beacons/uid