Update documentation for Scarlett 4th Gen and Vocaster

This commit is contained in:
Geoffrey D. Bennett
2024-03-12 02:27:03 +10:30
parent 16e3a25f76
commit feba2f4520
35 changed files with 1135 additions and 1180 deletions

View File

@@ -4,11 +4,12 @@
the Linux kernel Focusrite Scarlett2 USB Protocol Mixer Driver.
Supported interfaces:
- Scarlett 2nd Gen 6i6, 18i8, 18i20 (the smaller interfaces are
controlled with physical buttons only)
- Scarlett 2nd Gen 6i6, 18i8, 18i20
- Scarlett 3rd Gen Solo, 2i2, 4i4, 8i6, 18i8, 18i20
- Scarlett 4th Gen Solo, 2i2, 4i4
- Clarett 2Pre, 4Pre, 8Pre USB
- Clarett+ 2Pre, 4Pre, 8Pre
- Vocaster One and Vocaster Two
## About
@@ -16,64 +17,50 @@ Supported interfaces:
The Focusrite USB audio interfaces are class compliant meaning that
they work “out of the box” on Linux as audio and MIDI interfaces
(although on Gen 3/4 you need to disable MSD mode first for full
functionality). However, except for some of the smallest models, they
have a bunch of proprietary functionality that required a kernel
(although on Gen 3/4/Vocaster you need to disable MSD mode first for
full functionality). However, except for some of the smallest models,
they have a bunch of proprietary functionality that required a kernel
driver to be written specifically for those devices.
Linux kernel support (the “ALSA Focusrite Scarlett2 USB Protocol Mixer
Driver”) for the proprietary functionality was first added in:
- Scarlett Gen 2: Linux 5.4 (bugs fixed in Linux 5.14)
- Scarlett Gen 3: Linux 5.14
- Clarett+ 8Pre: Linux 6.1
- Clarett 2Pre/4Pre/8Pre USB, Clarett+ 2Pre/4Pre: Linux 6.7
Unfortunately, actually using this functionality used to be quite an
awful experience. The existing applications like `alsamixer` and
`qasmixer` become completely user-hostile with the hundreds of
controls presented for the Gen 3 18i20. Even the smallest Gen 3 4i4
interface at last count had 84 ALSA controls.
Announcing the ALSA Scarlett Gen 2/3 (and Clarett USB/Clarett+!)
Control Panel!
Announcing the ALSA Scarlett2 Control Panel, now supporting Scarlett
Gen 2, 3, 4, Clarett, and Vocaster!
![Demonstration](img/demo.gif)
The GUI supports all features presented by the driver (if not, please
report a bug).
## Documentation
Refer to [INSTALL.md](INSTALL.md) for prerequisites, how to build,
install, and run.
Refer to [INSTALL.md](docs/INSTALL.md) for prerequisites, how to
build, install, and run.
Refer to [USAGE.md](USAGE.md) for usage information and known issues.
Refer to [USAGE.md](docs/USAGE.md) for general usage information and
known issues.
Information specific to various models:
- [Scarlett 3rd Gen Solo and 2i2](docs/iface-small.md)
- [Scarlett 2nd Gen 6i6+, 3rd Gen 4i4+, Clarett USB, and
Clarett+](docs/iface-large.md)
- [Scarlett 4th Gen](docs/iface-4th-gen.md)
## Donations
This program is Free Software, developed using my personal resources,
over hundreds of hours.
If you like this software, please consider a donation to say thank you
as it was expensive to purchase one of each model for development and
testing! Any donation is appreciated.
If you like this software, please consider a donation to say thank
you! Any donation is appreciated.
- https://liberapay.com/gdb
- https://paypal.me/gdbau
## Scarlett Gen 4 Support
Focusrite recently released 3 new “Generation 4” interfaces: Solo,
2i2, and 4i4. The first draft of kernel support is available here:
https://github.com/geoffreybennett/scarlett-gen2/releases/tag/v6.5.11-g4.1
Please contact me by email if you would like to help test.
## Vocaster Support
Vocaster One and Two support will be coming once I've completed the
Scarlett 4th Gen support.
## License
Copyright 2022-2024 Geoffrey D. Bennett