File: USAGE.md

package info (click to toggle)
alsa-scarlett-gui 0.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,816 kB
  • sloc: ansic: 8,462; makefile: 111; xml: 14
file content (156 lines) | stat: -rw-r--r-- 5,178 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# ALSA Scarlett Control Panel Usage

Refer to [INSTALL.md](INSTALL.md) for prerequisites, how to build,
install, and run.

## No interface connected

If no interface is detected (usually because there isn’t one
connected!) you’ll see this window:

![No Interface Connected](../img/iface-none.png)

Plug in an interface or select the menu option File → Interface
Simulation and load a demo file to make more interesting things
happen.

## First Time Usage

If your interface is fresh out of the box (or you haven’t updated it
using the manufacturer’s software), you may need to update the
firmware and/or disable MSD Mode first.

### Firmware Update Required

Some interfaces require a firmware update before all their
functionality is available. If the firmware is not available on your
system, you’ll see this window:

![Firmware Update Required (Firmware
Missing)](../img/firmware-missing.png)

In this case, click on the link, download and install the firmware
package, then restart `alsa-scarlett-gui`.

If a firmware update is required and the firmware is available, you’ll
see this window:

![Firmware Update Required](../img/firmware-update-required.png)

Click “Update”, then “Yes” to update the firmware.

![Firmware Update Progress](../img/firmware-updating.png)

The update will take about 15 seconds, and then your interface will
restart, showing the main window.

### MSD (Mass Storage Device/Quick Start/Easy Start) Mode

If MSD Mode is enabled (as it is from the factory) and a firmware
update is not available or required, then you’ll see this window:

![MSD Mode](../img/iface-msd.png)

Click the “Enabled” button to disable MSD Mode, then click “Reboot” to
restart the interface, and in a moment the main window will appear.

## Startup Controls

The View → Startup menu option opens a window to configure settings
that only take effect when the interface is powered on.

The options common to most interfaces are:

- **Reset Configuration**: this will reset the configuration to the
  factory defaults. This is particularly useful with the 4th Gen and
  Vocaster interfaces if you’ve made a mess of the configuration and
  want to start again.

- **Update Firmware**: if a firmware update is found in the
  `/usr/share/firmware/scarlett2` directory, then an option to update
  the firmware will be available here.

## File Menu

The File menu contains options to load and save the configuration,
load a configuration in simulation mode, and to exit the application.

### Load/Save Configuration

The entire state of the interface can be loaded and saved using the
File → Load Configuration and File → Save Configuration menu options.

Internally, this uses `alsactl`:

- **Load**: `alsactl restore USB -f <fn>`
- **Save**: `alsactl store USB -f <fn>`

The saved state files can be used to simulate an interface if you
don’t have one attached. The `demo` directory in the distribution
contains a sample file for every supported model.

### Interface Simulation Mode

The GUI can load an `alsactl` state file saved from a real interface
and display a GUI as if the corresponding interface was connected.

This is useful if you don’t have an interface connected and want to
try, develop, or debug the GUI.

Either specify the `.state` filename on the command line or select the
menu option File → Interface Simulation to load.

## Interface Controls

The controls and menu items which are available vary widely, depending
on your specific interface.

There are five broad categories of interfaces with different
capabilities; each category of interface is described in a separate
document:

- [Scarlett 1st Gen 6i6+](iface-1st-gen.md)

  Full routing and mixing capabilities, but some significant caveats.

- [Scarlett 3rd Gen Solo and 2i2](iface-small.md)

  Minimal number of controls, and they mostly accessible through
  hardware buttons anyway. Not very interesting.

- [Scarlett 2nd Gen 6i6+, 3rd Gen 4i4+, Clarett USB, and
  Clarett+](iface-large.md)

  Full routing and mixing capabilities.

- [Scarlett Small 4th Gen](iface-4th-gen-small.md)

  Full routing and mixing capabilities, remote-controlled input gain,
  but no output controls.

- [Scarlett Big 4th Gen](iface-4th-gen-big.md)

  Full routing and mixing capabilities, remote-controlled input gain
  and output volume controls.

## Known Bugs/Issues

- For interfaces using the FCP driver, alsa-scarlett-gui needs to be
  started after the interface is connected and fcp-server has started.

- Load/Save uses `alsactl` which will be confused if the ALSA
  interface name (e.g. `USB`) changes.

- Load/Save is not implemented for simulated interfaces.

- The read-only status of controls in interface simulation mode does
  not change when the HW/SW button is clicked.

- When there’s more than one main window open, closing one of them
  doesn’t free and close everything related to that card.

- There is no facility to group channels into stereo pairs (needs
  kernel support to save this information in the interface).

- There is no facility to give channels custom names (needs kernel
  support to save this information in the interface).