You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,35 +9,38 @@ Test in offline mode with I/O from audio file:
9
9
10
10
$ sushi -o -i input_file.wav -c config_file.json
11
11
12
-
Use JACK for realtime audio:
12
+
Use Coreaudio on macOS for realtime audio, with the default devices:
13
13
14
-
$ sushi -j -c config_file.json
14
+
$ sushi --coreaudio -c config_file.json
15
15
16
-
Use Portaudio for realtime audio, with the default devices:
16
+
Use JACK for realtime audio:
17
17
18
-
$ sushi -a -c config_file.json
18
+
$ sushi -j -c config_file.json
19
19
20
20
With JACK, Sushi creates 8 virtual input and output ports that you can connect to other programs or system outputs.
21
21
22
-
## Sushi macOS (experimental)
22
+
## Sushi macOS
23
23
Since version 1.0, Sushi can be built natively for macOS as a native binary with all the dependencies statically linked to it.
24
24
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).
26
26
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.
28
28
29
29
MIDI support is provided through RtMidi and can access directly CoreMidi devices.
30
30
31
31
LV2 support is currently not available for macOS.
32
32
33
+
33
34
## Example Sushi configuration files in repository
34
35
Under `misc/config_files` in this repository, we have a large variety of example Sushi configuration files.
35
36
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:
(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:
41
44
42
45
Otherwise, if you are building from source, the plugins used by the examples can be found under:
Configuration files are used for global host configs, track and plugins configuration, MIDI routing and mapping, events sequencing.
60
63
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).
62
65
63
66
## Building
64
67
Sushi builds are supported for native Linux systems, Yocto/OE cross-compiling toolchains targeting Elk Audio OS systems, and macOS.
This might take some time for the first build since all the vcpkg dependencies will have to be built first.
100
103
104
+
101
105
### 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).
103
107
104
108
Follow the instructions in those repositories to set up a cross-compiling SDK and build Sushi for a given target.
105
109
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.
0 commit comments