soundbox-go, branch v0.2.0Go library to interface with soundbox deviceshttps://cgit.xengineering.eu/soundbox-go/atom?h=v0.2.02024-12-08T17:37:57ZUpdate CHANGELOG.md for release v0.2.02024-12-08T17:37:57Zxegineeringme@xegineering.eu2024-12-08T17:37:57Zurn:sha1:957d98544686d87d9df522b35981d1055b83c0b9Apply go fmt2024-12-08T17:36:10Zxegineeringme@xegineering.eu2024-12-08T17:36:10Zurn:sha1:477fb59944222966b8a9fc1d92893a336e827285Add examples to overview on generated API doc2024-12-08T17:34:11Zxegineeringme@xegineering.eu2024-12-08T17:31:56Zurn:sha1:f30e3668a6a65a8e5e43b3cc0b2030788b43857d
This makes it easier for readers to find them.
Add generate-compile-commands.sh2024-12-08T17:22:14Zxegineeringme@xegineering.eu2024-11-29T15:21:46Zurn:sha1:b76ac2daffb98fe7aea14385638150381cfb031b
This documents the `bear` call required to produce a proper
`compile_commands.json` here.
The JSON file is not committed since it contains absolute paths. It is
used for language servers like `clangd`.
pipewire: Fix huge latency by dropping silence2024-12-08T17:22:14Zxegineeringme@xegineering.eu2024-12-08T16:36:28Zurn:sha1:49f47e76a85b3477835a0adec05649507d94b2e8
The current architecture uses the following processing:
- capture raw audio from PipeWire as unsigned 16 bit integers
- convert with a `ffmpeg` process to OGG / FLAC
- stream the `ffmpeg` output to multiple soundboxes via TCP
Only the first part is different for URL sources. Since using PipeWire
significant latency (up to 15 seconds) were measured.
It turned out that this happens exactly when zero bytes (silence) are
fed into the `ffmpeg` process. This commit avoids this by dropping those
empty samples.
It has to be made sure that only samples are dropped where both channels
are zero. Otherwise audible noise is the result.
pipewire: Add experimental PipeWire support2024-12-08T17:22:10Zxegineeringme@xegineering.eu2024-11-17T11:51:15Zurn:sha1:06c4f8b0120f5598f9d179b8c0fea33df35659a8
This implements a PipeWire capture device which can be used as an input
source instead of the already available URL input.
Known issues with the current PipeWire support are:
- user has to connect the monitor of the default audio sink to the
capture device manually
- correct shutdown has to be tested
- multiple instances do not work
- medium code quality requires refactoring
Since this is nevertheless usable and possible unknown bugs should be
figured out in practise soon this implementation is already added.
Bugfixes and refactoring might follow.
Update CHANGELOG.md for version 0.1.52024-11-29T09:21:31Zxegineeringme@xegineering.eu2024-11-29T09:21:31Zurn:sha1:4513eb614707d129824e60270bd45cdee9f04d06Refactor streamContext()2024-11-29T09:16:57Zxegineeringme@xegineering.eu2024-11-29T09:16:57Zurn:sha1:f5f0d12b697e71e67a403791c1b93ffdf61e272a
This avoids an unnecessary additional for loop.
Handle internal error correctly2024-11-29T09:06:01Zxegineeringme@xegineering.eu2024-11-29T09:06:01Zurn:sha1:97af30e8fee2274a437a13d8c2c19e4bfe29ddeeFix variable buffer size2024-11-29T08:16:57Zxegineeringme@xegineering.eu2024-11-29T08:16:57Zurn:sha1:49dc5ae3c12f2c696302171b54b130d94dea05e0
The switch to `io.Copy()` to pump the data to the soundbox devices
removed the control over the buffer size of this copy action.
While for generic copy actions it is even an advantage when a big buffer
is used this is a problem for the soundbox use case. A big buffer used
during copy means that the first soundbox device gets audio data
significantly earlier than the later ones since `io.MultiWriter()` works
sequentially.
Thus this commit switches to `io.CopyBuffer()` where a buffer has to
provided. For that purpose the same buffer size is used as before the
refactoring to use `io.Copy()`.
Replace custom code by io package functions2024-11-28T21:44:28Zxegineeringme@xegineering.eu2024-11-28T21:44:28Zurn:sha1:99031596efbcf004188217d2a9e53ac5ce33b511
This makes use of two functions from this package:
- io.Copy()
- io.MultiWriter()
`io.Copy()` is used to move the data from whatever reader is provided.
`io.Multiwriter()` solves the issue that we need to stream to multiple
network connections at the same time (one for each soundbox).
Handle read error after processing buffer2024-11-27T20:55:40Zxegineeringme@xegineering.eu2024-11-27T20:55:40Zurn:sha1:bb84332ef7ca114f0c608bbea7f11451f010a831
This is recommended by the Go standard library. One reason is that a
Reader might deliver the last couple of bytes together with the EOF
error. This is only handled correctly if the returned bytes are
processed first and the error is handled later.
[1]: https://pkg.go.dev/io#Reader
Introduce io.Reader-based streamContext()2024-11-27T20:38:16Zxegineeringme@xegineering.eu2024-11-27T20:29:39Zurn:sha1:6b7da29eea100b92659a3f1f5df6958ebad544c8
This prepares the switch to adding more sources than web URLs.
Everything providing an io.Reader can then simply use this internal
function in the background to avoid code duplication.
Fix streaming only via first interface candidate2024-11-17T11:48:00Zxegineeringme@xegineering.eu2024-11-17T11:45:35Zurn:sha1:d4cf5ed8e38d1e5d0b8110e8959e002c216f073fUpdate CHANGELOG.md for version 0.1.42024-11-10T15:40:19Zxegineeringme@xegineering.eu2024-11-10T15:40:19Zurn:sha1:a95013aa0813d1644aa15780f360fa4dad2223a8Add CHANGELOG.md2024-11-10T15:36:26Zxegineeringme@xegineering.eu2024-11-10T15:36:26Zurn:sha1:6f51073ecb44f5476e37e3d5ab8d87e917116bae
This keeps track of the changes to this repository.
Avoid unnecessary variable for args2024-11-10T14:54:59Zxegineeringme@xegineering.eu2024-11-10T14:54:59Zurn:sha1:93d3ce8ca7d335fb15da64981321f82891c1493cUse Go code for output network stream2024-11-10T14:53:44Zxegineeringme@xegineering.eu2024-11-08T19:56:56Zurn:sha1:36a2fda37e837bc39c88a2fa38678b0f3bded041
Calling the external program `ffmpeg` should be avoided completely in
the future to make soundbox-go a pure Go code base. `ffmpeg` provides
the following functionality to soundbox-go:
- web radio input stream transport
- re-encoding of the audio stream
- output stream transport to soundbox devices
The last part should be replaced with this commit as a first step.
Rename cmd to args2024-11-08T19:35:24Zxegineeringme@xegineering.eu2024-11-08T19:35:24Zurn:sha1:e30a1b0768d35ec70e5d2c00e6ae87c0f267b881
This variable only contains the arguments for the called program. Thus
it should be named like this.
Fix outdated README.md2024-10-31T21:37:26Zxegineeringme@xegineering.eu2024-10-31T21:37:26Zurn:sha1:702c39c9bb3a6441de366aa30842960741017615Change module name and restructure content2024-10-31T21:10:36Zxegineeringme@xegineering.eu2024-10-31T21:10:36Zurn:sha1:79eeb90079e417f0a9d040c1de8f3278c628810f
The repository names for soundbox are named as below:
- app: soundbox-app
- Go library module: soundbox-go
- Device: soundbox
The Go module names were:
- app: xengineering.eu/soundbox/app
- Go library module: xengineering.eu/soundbox
This does not make clear which module is related to which repository
since the names are different. Thus it should be changed to:
- app: xengineering.eu/soundbox-app
- Go library module: xengineering.eu/soundbox-go
The import statement for the library is then:
import "xengineering.eu/soundbox-go/soundbox"
This is a bit longer but it keeps the property that the library is
referenced inside the code by the simple name `soundbox`.
Move streaming example to stream_test.go2024-10-06T16:06:29Zxegineeringme@xegineering.eu2024-10-06T16:06:29Zurn:sha1:cbcebb47e515f900f2505098f0ce87697e2fe283
This example is completely based on the StreamURLContext() function.
Thus it should go to the respective test file.
Add missing doc string to public function2024-10-06T15:58:34Zxegineeringme@xegineering.eu2024-10-06T15:58:34Zurn:sha1:735a7863845da130e6c727136aac75c2e7bf23daAdd soundbox.StreamURLContext()2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T17:16:56Zurn:sha1:b8fed490c275487f14bff4f5b49a6072d27e5b5f
This should be the primary public API of the library to stream web radio
to soundbox devices.
Remove soundbox.Client2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T16:56:14Zurn:sha1:9b995e02371e45e8cb5806ee7c7eb8139bf24fd8
This data structure only contained a net.HardwareAddr and did not
provide much more useful functionality. Thus the net.HardwareAddr type
should be used directly.
Make soundbox.StreamingPort private2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T16:49:04Zurn:sha1:d246a58cb4473c7a311d99232a18057544219a9b
It is planned to provide a function for streaming. Thus the streaming
port is not required to be exposed. If there is a use case the streaming
port can be exposed again.
Add soundbox.getInterface()2024-10-03T18:00:04Zxegineeringme@xegineering.eu2024-10-03T15:28:10Zurn:sha1:56f3e2c3f47e796333d4de2502385a5ef27d049f
This is required as a temporary solution to guess the correct interface.
Rename Port to StreamingPort2024-10-02T19:55:24Zxegineeringme@xegineering.eu2024-10-02T19:53:51Zurn:sha1:9c81db35038fa96de6b3fda0695a463bbf69ac01
It is expected that further ports (maybe for information via HTTP) are
added in the future.
To keep the public API stable this should be taken into account before
the first release.
Fix example documentation2024-10-02T19:43:11Zxegineeringme@xegineering.eu2024-10-02T19:43:11Zurn:sha1:b6fa67af2c4478b99408bf919ba76a38400ee8d6Rename Soundbox to Client2024-10-02T19:18:51Zxegineeringme@xegineering.eu2024-10-02T19:18:51Zurn:sha1:07741b358ba75350e7be36ee76f45afa18b0461b
Since the module name is `soundbox` naming the primary type of the
module also `Soundbox` is redundant. Following similar code from the Go
standard library this struct is renamed to `Client`.