Skip to content

Commit a265ee8

Browse files
committed
Update README for Elk Audio OS 1.0
1 parent 4218c2b commit a265ee8

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,38 @@ Test in offline mode with I/O from audio file:
99

1010
$ sushi -o -i input_file.wav -c config_file.json
1111

12-
Use JACK for realtime audio:
12+
Use Coreaudio on macOS for realtime audio, with the default devices:
1313

14-
$ sushi -j -c config_file.json
14+
$ sushi --coreaudio -c config_file.json
1515

16-
Use Portaudio for realtime audio, with the default devices:
16+
Use JACK for realtime audio:
1717

18-
$ sushi -a -c config_file.json
18+
$ sushi -j -c config_file.json
1919

2020
With JACK, Sushi creates 8 virtual input and output ports that you can connect to other programs or system outputs.
2121

22-
## Sushi macOS (experimental)
22+
## Sushi macOS
2323
Since version 1.0, Sushi can be built natively for macOS as a native binary with all the dependencies statically linked to it.
2424

25-
There is a new Portaudio frontend (selectable with the `-a | --portaudio` command-line option) to interface directly with Portaudio. As an alternative, Jack can be used if it is available on the system.
25+
There is a new Coreaudio frontend (selectable with the `--coreaudio` command-line option) to interface directly with Coreaudio. As an alternative, a Portaudio frontend is also available (with the `--portaudio` flag).
2626

27-
With Portaudio, you can select other devices than the default with the `--audio-input-device` and `--audio-output-device` options. To find out the right number there, you can launch Sushi with the `--dump-portaudio-devs` to get a list in JSON format printed to stdout.
27+
With Coreaudio, you can select other devices than the default with the `--audio-input-device-uid` and `--audio-output-device-uid` options. To find out the right number there, you can launch Sushi with the `--dump-portaudio-devs` to get a list in JSON format printed to stdout.
2828

2929
MIDI support is provided through RtMidi and can access directly CoreMidi devices.
3030

3131
LV2 support is currently not available for macOS.
3232

33+
3334
## Example Sushi configuration files in repository
3435
Under `misc/config_files` in this repository, we have a large variety of example Sushi configuration files.
3536

36-
They all use the mda-vst3 plugins which are built when building Sushi. If you are running one of the prebuilt packages (available on the releases sections on Github), you have everything inside the `sushi` folder there. For example, on macOS you should be able to get a simple working synthesizer with:
37+
The first one to try to check if everything is running properly, would be this one that uses the internal sequencer & synthesizer to generate a sequence:
3738
```
38-
$ ./sushi -a -c config_files/play_vst3.json
39+
$ ./sushi --coreaudio -c config_files/play_brickworks_synth.json
3940
```
40-
(on Linux with JACK, replace `-a` with -`j`).
41+
(on Linux with JACK, replace `--coreaudio` with `--jack`).
42+
43+
Many of the examples use the mda-vst3 plugins which are built when building Sushi. If you are running one of the prebuilt packages (available on the releases sections on Github), you have everything inside the `sushi` folder there. For example, on macOS you should be able to get a simple working synthesizer with:
4144

4245
Otherwise, if you are building from source, the plugins used by the examples can be found under:
4346

@@ -52,13 +55,13 @@ $ ./sushi -j -c ../../misc/config_files/play_vst3.json --base-plugin-path VST3/D
5255

5356
Or, from a macOS terminal:
5457
```
55-
$ ./sushi.app/Contents/MacOS/sushi -a -c ../../misc/config_files/play_vst3.json --base-plugin-path VST3/Release
58+
$ ./sushi --coreaudio -c ../../misc/config_files/play_vst3.json --base-plugin-path VST3/Release
5659
```
5760

5861
## Extra documentation
5962
Configuration files are used for global host configs, track and plugins configuration, MIDI routing and mapping, events sequencing.
6063

61-
More in-depth documentation is available at the [Elk Audio OS official docs page](https://elk-audio.github.io/elk-docs/html/documents/sushi_overview.html).
64+
More in-depth documentation is available at the [Elk Audio OS official docs page](https://elk-audio.github.io/elk-docs/docs/html/sushi/sushi_overview.html).
6265

6366
## Building
6467
Sushi builds are supported for native Linux systems, Yocto/OE cross-compiling toolchains targeting Elk Audio OS systems, and macOS.
@@ -98,13 +101,12 @@ $ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=../third-party/vcpkg/s
98101

99102
This might take some time for the first build since all the vcpkg dependencies will have to be built first.
100103

104+
101105
### Building with Yocto for Elk Audio OS
102-
Sushi can be built either with the provided [Elk Audio OS SDK](https://github.com/elk-audio/elkpi-sdk), or as part of a [full Elk Audio OS image build with bitbake](https://github.com/elk-audio/elkpi-yocto-layers).
106+
Sushi can be built either with the provided [Elk Audio OS SDK](https://github.com/elk-audio/elkpi-sdk), or as part of a [full Elk Audio OS image build with bitbake](https://github.com/elk-audio/elk-audio-os-builder).
103107

104108
Follow the instructions in those repositories to set up a cross-compiling SDK and build Sushi for a given target.
105109

106-
Note: Sushi version 1.0 is not currently supported with Elk Audio OS images up to 0.12.0. The most recent supported Yocto version is tagged as `1.0-rc1_yocto_build` in the repository.
107-
108110
### Useful CMake build options
109111
Option | Value | Notes
110112
--------------------------------------|----------|------------------------------------------------------------------------------------------------------

0 commit comments

Comments
 (0)