Change README to mention Kirika usage

This commit is contained in:
DataHoarder 2022-02-22 13:21:13 +01:00
parent 6f5ffbbb0d
commit b11ab900d8

View file

@ -1,17 +1,9 @@
# [![](resources/hibikis.png)](resources/hibiki.png) Hibiki
Implementation of [Panako](https://github.com/JorenSix/Panako) in Go, and other audio utilities.
Implementation of [Panako](https://github.com/JorenSix/Panako) in Go, and other utilities.
Panako is an acoustic fingerprinting system.
In addition to fingerprinting, Hibiki has these utilities:
* channel-based audio consumption chain
* Audio resampler
* FLAC stream decoder and encoder
* MP3 stream decoder
* Opus stream decoder
* Several storage systems for fingerprints
## Dependencies
### Go >= 1.18
### [c-gaborator](https://git.gammaspectra.live/S.O.N.G/c-gaborator) (required by [goborator](https://git.gammaspectra.live/S.O.N.G/goborator))
@ -25,17 +17,7 @@ make
sudo make install
```
### [libFLAC](https://github.com/xiph/flac) (required by [goflac](https://github.com/cocoonlife/goflac))
```shell
sudo apt install libflac-dev
```
### [Kirika](https://git.gammaspectra.live/S.O.N.G/Kirika) dependencies
Collection of audio utilities for decoding/encoding files and streams.
### [libopus](https://github.com/xiph/opus) and [libopusfile](https://github.com/xiph/opusfile) (required by [go-pus](https://git.gammaspectra.live/S.O.N.G/go-pus))
```shell
sudo apt install libopus-dev libopusfile-dev
```
### [libsamplerate](https://github.com/libsndfile/libsamplerate) (required by [gosamplerate](https://github.com/dh1tw/gosamplerate))
```shell
sudo apt install libsamplerate0-dev
```
Check its native dependencies that must be installed before usage.