[alsa-io] make pclamp and control out quantization configurable
[jack.git] / man / alsa_in.0
blob8841b1ddde81d3878b65ac8819a5716418a22dea
1 .TH ALSA_IO "1" "!DATE!" "!VERSION!"
2 .SH NAME
3 \fBalsa_in\fR, \fBalsa_out\fR \- Jack clients that perform I/O with an alternate audio interface
4 .SH SYNOPSIS
5 \fBalsa_in\fR [\fIoptions\fR]
6 .br
7 \fBalsa_out\fR [\fIoptions\fR]
9 .SH DESCRIPTION
10 A JACK client that opens a specified audio interface (different to the
11 one used by the JACK server, if any) and moves audio data between its
12 JACK ports and the interface. alsa_in will provide data from the
13 interface (potentially for capture); alsa_out will deliver data to it
14 (for playback).
16 The audio interface used by alsa_in/alsa_out does not need to be
17 synchronized with JACK backend (or the hardware it might be using).
18 alsa_in/alsa_out tries to resample the output stream in an attempt to
19 compensate for drift between the two clocks.
21 .SH OPTIONS
22 .TP
23 \fB\-j \fI jack_client_name\fR
24 .br
25 Set Client Name.
26 .TP
27 \fB\-d \fI alsa_device\fR  
28 .br
29 Use this Soundcard.
30 .TP
31 \fB\-c \fI channels\fR  
32 .br
33 Set Number of channels.
34 .TP
35 \fB\-r \fI sample_rate\fR  
36 .br
37 Set sample_rate. The program resamples as necessary.
38 So you can connect a 44k1 jackd to a soundcard only supporting
39 48k.
40 .TP
41 \fB\-m \fI max_diff\fR  
42 .br
43 The value when a soft xrun occurs. Basically the window, in which
44 the dma pointer may jitter. If you see "delay=" in the output of alsa_out
45 this is too small.
46 .br
47 Make sure target_delay is bigger than this.
48 .TP
49 \fB\-t \fI target_delay\fR  
50 .br
51 The delay alsa_io should try to approach. Tune this to get lower latency.
52 Must be bigger than max_diff for alsa_out, and should be bigger than max_diff+jackd_period
53 for alsa_in. 
54 .TP
55 \fB\-f \fI catch_factor\fR  
56 .br
57 This value sets how fast the samplerate will change.
58 default is 1000. Try 10000 when you have good relation between
59 your clocksources. This will make resampling inaudible for example.
60 .TP
61 \fB\-p \fI period_size\fR  
62 .br
63 Set the period size. It is not related to the jackd period_size.
64 Sometimes it affects the quality of the delay measurements.
65 Thats why its configurable.
66 .TP
67 \fB\-n \fI num_period\fR  
68 .br
69 Set number of periods. See note for period_size.
71 .SH AUTHOR
72 Torben Hohn