jack2 codebase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

101 lines

  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
  5. \fBalsa_in\fR [\fIoptions\fR]
  6. .br
  7. \fBalsa_out\fR [\fIoptions\fR]
  9. A JACK client that opens a specified audio interface (different to the
  10. one used by the JACK server, if any) and moves audio data between its
  11. JACK ports and the interface. alsa_in will provide data from the
  12. interface (potentially for capture); alsa_out will deliver data to it
  13. (for playback).
  14. The audio interface used by alsa_in/alsa_out does not need to be
  15. synchronized with JACK backend (or the hardware it might be using).
  16. alsa_in/alsa_out tries to resample the output stream in an attempt to
  17. compensate for drift between the two clocks.
  18. As of jack-0.116.3 this works almost perfectly. It takes some time, to reach
  19. absolute resample-rate stability. So give it some minutes (its intended to be
  20. running permanently anyways)
  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\-v\fR
  32. .br
  33. Verbose, prints out resample coefficient and other parameters useful for debugging, every 500ms.
  34. also reports soft xruns.
  35. .TP
  36. \fB\-i\fR
  37. .br
  38. Instrumentation. This logs the 4 important parameters of the samplerate control algorithm every 1ms.
  39. You can pipe this into a file, and plot it. Should only be necessary, if it does not work as
  40. expected, and we need to adjust some of the obscure parameters, to make it work.
  41. Find me on irc.freenode.org #jack in order to set this up correctly.
  42. .TP
  43. \fB\-c \fI channels\fR
  44. .br
  45. Set Number of channels.
  46. .TP
  47. \fB\-r \fI sample_rate\fR
  48. .br
  49. Set sample_rate. The program resamples as necessary.
  50. So you can connect a 44100 jackd to a soundcard only supporting
  51. 48000. (default is jack sample_rate)
  52. .TP
  53. \fB\-p \fI period_size\fR
  54. .br
  55. Set the period size. It is not related to the jackd period_size.
  56. Sometimes it affects the quality of the delay measurements.
  57. Setting this lower than the jackd period_size will only work, if you
  58. use a higher number of periods.
  59. .TP
  60. \fB\-n \fI num_period\fR
  61. .br
  62. Set number of periods. See note for period_size.
  63. .TP
  64. \fB\-q \fI quality\fR
  65. .br
  66. Set the quality of the resampler from 0 to 4. can significanly reduce cpu usage.
  67. .TP
  68. \fB\-m \fI max_diff\fR
  69. .br
  70. The value when a soft xrun occurs. Basically the window, in which
  71. the dma pointer may jitter. I don't think its necessary to play with this anymore.
  72. .TP
  73. \fB\-t \fI target_delay\fR
  74. .br
  75. The delay alsa_io should try to approach. Same as for max_diff. It will be setup based on \-p and \-n
  76. which is generally sufficient.
  77. .TP
  78. \fB\-s \fI smooth_array_size\fR
  79. .br
  80. This parameter controls the size of the array used for smoothing the delay measurement. Its default is 256.
  81. If you use a pretty low period size, you can lower the CPU usage a bit by decreasing this parameter.
  82. However most CPU time is spent in the resampling so this will not be much.
  83. .TP
  84. \fB\-C \fI P Control Clamp\fR
  85. .br
  86. If you have a PCI card, then the default value (15) of this parameter is too high for \-p64 \-n2... Setting it to 5 should fix that.
  87. Be aware that setting this parameter too low, lets the hf noise on the delay measurement come through onto the resamplerate, so this
  88. might degrade the quality of the output. (but its a threshold value, and it has been chosen, to mask the noise of a USB card,
  89. which has an amplitude which is 50 times higher than that of a PCI card, so 5 won't lose you any quality on a PCI card)
  90. .TP
  91. \fB\-S \fI server_name\fR
  92. .br
  93. Server to connect to. This option permits to attach to a named jack2 server.
  94. .SH AUTHOR
  95. Torben Hohn