xwax.1 7.36 KB
Newer Older
Mark Hills's avatar
Mark Hills committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
.TH XWAX "1"
.SH NAME
xwax \- Digital vinyl on Linux
.SH SYNOPSIS
.B xwax
[\fIoptions\fR]
.SH DESCRIPTION
.P
xwax is vinyl emulation software for Linux. It allows DJs and
turntablists to playback digital audio files (MP3, Ogg Vorbis, FLAC,
AAC and more), controlled using a normal pair of turntables via
timecoded vinyls.
.SH OPTIONS
.P
Mark Hills's avatar
Mark Hills committed
15
The ordering of options is important. Most options apply to
Mark Hills's avatar
Mark Hills committed
16
17
18
19
20
21
subsequent music libraries or decks, which can be given multiple times.
See the
.B EXAMPLES
below.
.TP
.B \-l \fIpath\fR
Mark Hills's avatar
Mark Hills committed
22
Scan the music library or playlist at the given path.
Mark Hills's avatar
Mark Hills committed
23
24
.TP
.B \-t \fIname\fR
25
Use the named timecode for subsequent decks. See \-h for a list of
Mark Hills's avatar
Mark Hills committed
26
27
valid timecodes. You will need the corresponding timecode signal on
vinyl to control playback.
28
29
30
31
32
33
34
35
.TP
.B \-33
Set the reference playback speed for subsequent decks to 33 and one
third revolutions per minute. This is the default.
.TP
.B \-45
Set the reference playback speed for subsequent decks to 45
revolutions per minute.
36
37
38
39
40
41
42
43
44
45
.TP
.B \-c
Protect subsequent decks against certain operations during
playback.
.TP
.B \-u
Allow all operations on a deck during playback. This is the inverse
of the
.B \-c
option, and is the default.
46
.TP
Mark Hills's avatar
Mark Hills committed
47
.B \-\-phono
48
49
50
51
52
53
Adjust the noise thresholds of subsequent decks to tolerate a
cartridge-level signal connected to a line-level audio interface. This
is a 'software pre-amp'. Unless your audio path has low noise, this
will give worse results or may not work at all; a true phono
pre-amplifier is always preferred.
.TP
Mark Hills's avatar
Mark Hills committed
54
.B \-\-line
55
56
Set noise thresholds of subsequent decks to standard audio levels.
This reverses the effect of the
Mark Hills's avatar
Mark Hills committed
57
.B \-\-phono
58
option, and is the default.
Mark Hills's avatar
Mark Hills committed
59
60
61
62
63
64
.TP
.B \-i \fIpath\fR
Use the given importer executable for subsequent decks.
.TP
.B \-s \fIpath\fR
Use the given scanner executable to scan subsequent music libraries.
Mark Hills's avatar
Mark Hills committed
65
66
67
68
.TP
.B \-\-dummy
Create a deck which is not connected to any audio device, used
for testing.
69
70
71
72
73
74
75
.TP
.B \-k
Lock into RAM any memory required for real-time use.
This includes audio tracks held in memory which can be large.
Use
.B ulimit \-l
to raise the kernel's memory limit to allow this.
76
77
78
79
.TP
.B \-q \fIn\fR
Change the real-time priority of the process. A priority of 0 gives
the process no priority, and is used for testing only.
80
.TP
81
82
83
84
.B \-g [\fIn\fRx\fIn\fR][+\fIn\fR+\fIn\fR][/\fIf\fR]
Change the geometry of the display in size, position and scale (zoom)
respectively.
The size and position is passed
Mark Hills's avatar
Mark Hills committed
85
to SDL, which may use it to set the display mode, or size of an X window.
86
87
See the
.B EXAMPLES.
Mark Hills's avatar
Mark Hills committed
88
.TP
89
90
91
92
93
94
95
.B \-\-no\-decor
Request to the window manager to create a 'frameless' window which
does not have the regular controls such as title bars and buttons.
This can be useful in conjunction with the
.B \-g
flag for dedicated xwax installations.
.TP
Mark Hills's avatar
Mark Hills committed
96
97
.B \-h
Display the help message and default values.
Mark Hills's avatar
Mark Hills committed
98
.SH "ALSA DEVICE OPTIONS"
Mark Hills's avatar
Mark Hills committed
99
100
101
102
103
104
105
106
107
108
109
110
.P
The following options are available only when xwax is compiled with
ALSA support.
.TP
.B \-a \fIdevice\fR
Create a deck which uses the given ALSA device (eg. plughw:0).
.TP
.B \-r \fIhz\fR
Set the sample rate for subsequent decks.
.TP
.B \-m \fImilliseconds\fR
Set the ALSA buffer time for subsequent decks.
Mark Hills's avatar
Mark Hills committed
111
.SH "JACK DEVICE OPTIONS"
Mark Hills's avatar
Mark Hills committed
112
113
114
115
116
117
118
119
120
121
.P
The following options are available only when xwax is compiled with
JACK support.
.TP
.B \-j \fIname\fR
Create a deck which connects to JACK and registers under the given
name.
.P
xwax does not set the sample rate for JACK devices; it uses the sample
rate given in the global JACK configuration.
Mark Hills's avatar
Mark Hills committed
122
.SH "OSS DEVICE OPTIONS"
Mark Hills's avatar
Mark Hills committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
.P
The following options are available only when xwax is compiled with
OSS support.
.TP
.B \-d \fIpathname\fR
Create a deck which uses the given OSS device (eg. /dev/dsp).
.TP
.B \-r \fIhz\fR
Set the sample rate for subsequent decks.
.TP
.B \-b \fIn\fR
Set the number of OSS buffers for subsequent decks.
.TP
.B \-f \fIn\fR
Set the OSS buffer size (2^n bytes).
138
139
140
141
142
.SH HARDWARE CONTROLLER OPTIONS
.P
The following options are available only when xwax is compiled
with ALSA support.
.TP
143
.B \-\-dicer \fIdevice\fR
144
145
146
147
148
149
150
151
Use one or two Dicer controllers connected as the given ALSA device
(eg. hw:Dicer). See the section
.B NOVATION DICER CONTROLS
for more information.
.P
Adding a hardware controller results in control over subsequent decks,
up to the limit of the hardware.
.SH KEYBOARD CONTROLS
Mark Hills's avatar
Mark Hills committed
152
153
154
155
.P
The playback of each deck (direction, speed and position) is
controlled via the incoming timecode signal from the turntables.
The keyboard provides additional controls.
Mark Hills's avatar
Mark Hills committed
156
157
.P
"C-" and "S-" means a keypress is combined with
Mark Hills's avatar
Mark Hills committed
158
the 'Control' or 'Shift' key, respectively.
Mark Hills's avatar
Mark Hills committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
.P
Record selection controls:
.TP
cursor up, cursor down
Move highlighted record up/down by one.
.TP
page up, page down
Scroll the record listing up/down by one page.
.TP
left cursor, right cursor
Switch to the previous/next crate of records.
.TP
tab
Toggle between the current crate and the 'All records' crate.
Mark Hills's avatar
Mark Hills committed
173
174
175
176
177
.TP
C-tab
Toggle sort mode between: artist/track name, BPM and 'playlist'
order. Playlist order is the order in which records were returned
from the scanner.
Mark Hills's avatar
Mark Hills committed
178
179
180
.TP
C-S-tab
Re-scan the currently selected crate.
Mark Hills's avatar
Mark Hills committed
181
182
183
184
185
186
187
188
189
190
191
.P
To filter the current list of records type a portion of a record
name. Separate multiple searches with a space, and use backspace to
delete.
.P
Deck-specific controls:
.TS
l l l l.
Deck 0	Deck 1	Deck 2
F1	F5	F9	Load currently selected track to this deck
F2	F6	F10	Reset start of track to the current position
192
F3	F7	F11	Toggle timecode control on/off
193
C-F3	C-F7	C-F11	Cycle between available timecodes
Mark Hills's avatar
Mark Hills committed
194
.TE
195
196
197
.P
The "available timecodes" are those which have been the subject of any
.B \-t
Mark Hills's avatar
Mark Hills committed
198
flag on the command line.
Mark Hills's avatar
Mark Hills committed
199
200
Audio display controls:
.TP
201
+, \-
Mark Hills's avatar
Mark Hills committed
202
Zoom in/out the close-up audio meters for all decks.
203
204
205
206
207
208
209
210
.SH NOVATION DICER CONTROLS
.P
The Novation Dicer provides hardware control of cue points. The controls
are:
.TP
cue mode: dice button (1-5)
Jump to the specified cue point, or set it if unset.
.TP
Mark Hills's avatar
Mark Hills committed
211
212
213
214
215
loop-roll mode: dicer button (1-5)
"Punch" to the specified cue point, or set it if unset. Returns playback
to normal when the button is released.
.TP
mode button + dice button (1-5)
216
217
218
219
Clear the specified cue point.
.P
The dice buttons are lit to show that the corresponding cue point is
set.
Mark Hills's avatar
Mark Hills committed
220
221
222
223
224
.SH EXAMPLES
.P
2-deck setup using one directory of music and OSS devices:
.sp
.RS
225
xwax \-l ~/music \-d /dev/dsp \-d /dev/dsp1
Mark Hills's avatar
Mark Hills committed
226
227
228
229
230
.RE
.P
As above, but using ALSA devices:
.sp
.RS
231
xwax \-l ~/music \-d hw:0 \-d hw:1
Mark Hills's avatar
Mark Hills committed
232
233
234
235
236
.RE
.P
2-deck setup using a different timecode on each deck:
.sp
.RS
237
xwax \-l ~/music \-t serato_2a \-d hw:0 \-t mixvibes_v2 \-d hw:1
Mark Hills's avatar
Mark Hills committed
238
.RE
239
240
241
242
.P
As above, but with the second deck at 45 RPM:
.sp
.RS
243
xwax \-l ~/music \-t serato_2a \-d hw:0 \-t mixvibes_v2 \-45 \-d hw:1
244
.RE
245
246
247
248
249
250
.P
Default to the same timecode, but allow switching at runtime:
.sp
.RS
xwax \-l ~/music \-t serato_2a \-t mixvibes_v2 \-d hw:0 \-d hw:1
.RE
Mark Hills's avatar
Mark Hills committed
251
252
253
254
.P
3-deck setup with the third deck at a higher sample rate:
.sp
.RS
255
xwax \-l ~/music \-r 48000 \-a hw:0 \-a hw:1 \-r 96000 \-a hw:2
Mark Hills's avatar
Mark Hills committed
256
257
258
259
260
.RE
.P
Using all three device types simultaneously, one deck on each:
.sp
.RS
261
xwax \-l ~/music \-a hw:0 \-d /dev/dsp1 \-j jack0
Mark Hills's avatar
Mark Hills committed
262
263
264
265
266
.RE
.P
Scan multiple music libraries:
.sp
.RS
267
xwax \-l ~/music \-l ~/sounds \-l ~/mixes \-a hw:0
Mark Hills's avatar
Mark Hills committed
268
269
270
271
272
.RE
.P
Scan a second music library using a custom script:
.sp
.RS
273
xwax \-l ~/music \-i ./custom-scan \-l ~/sounds \-a hw:0
Mark Hills's avatar
Mark Hills committed
274
.RE
275
276
277
278
.P
Control two decks with Dicer hardware:
.sp
.RS
Mark Hills's avatar
Mark Hills committed
279
xwax \-\-dicer hw:Dicer \-a hw:0 \-a hw:1
280
.RE
281
282
283
284
285
286
.P
Use a high resolution and enlarge the user interface:
.sp
.RS
xwax -g 1920x1200/1.8 -a hw:0
.RE
Mark Hills's avatar
Mark Hills committed
287
.SH HOMEPAGE
Mark Hills's avatar
Mark Hills committed
288
http://xwax.org/
Mark Hills's avatar
Mark Hills committed
289
.SH AUTHOR
Mark Hills's avatar
Mark Hills committed
290
Mark Hills <mark@xwax.org>