Lines Matching +full:no +full:- +full:unit +full:- +full:test
1 .TH AXFER\-TRANSFER 1 "28 November 2018" "alsa\-utils"
4 axfer\-transfer \- transferrer of audio data frame for sound devices and nodes.
11 .I common\-options
13 .I backend\-options
21 .I common\-options
23 .I backend\-options
25 .I \-I
27 .I \-\-separate\-channels filepath ...
34 common\-options = ( read
38 backend\-options = ( read
52 backends. This program is essentially designed to use alsa\-lib APIs
74 .I \(aq\-\(aq
87 .I \-I
89 .I \-\-separate\-channels
93 \- /dev/null
94 \- /dev/zero
95 \- /dev/full
96 \- /dev/random
97 \- /dev/urandom
102 .B \-h, \-\-help
106 .B \-q, \-\-quiet
110 .B \-v, \-\-verbose
115 .B \-d, \-\-duration=#
119 .I \-d
121 .I \-s
125 .B \-s, \-\-samples=#
129 .I \-d
131 .I \-s
135 .B \-f, \-\-format=FORMAT
140 - [S8|U8|S16|U16|S32|U32][_LE|_BE]
141 - [S24|U24][_LE|_BE]
142 - FLOAT[_LE|_BE]
143 - FLOAT64[_LE|_BE]
144 - IEC958_SUBFRAME[_LE|_BE]
145 - MU_LAW
146 - A_LAW
147 - [S20|U20][_LE|_BE]
148 - [S24|U24][_3LE|_3BE]
149 - [S20|U20][_3LE|_3BE]
150 - [S18|U18][_3LE|_3BE]
151 - DSD_U8
152 - DSD_[U16|U32][_LE|_BE]
154 If endian\-ness is omitted, host endian\-ness is used.
157 - cd (16 bit little endian, 44100, stereo) [= \-f S16_LE \-c 2 \-r 44100]
158 - cdr (16 bit big endian, 44100, stereo) [= \-f S16_BE \-c 2 \-f 44100]
159 - dat (16 bit little endian, 48000, stereo) [= \-f S16_LE \-c 2 \-r 48000]
167 unaligned to byte unit.
169 - IMA_ADPCM
170 - MPEG
171 - GSM
172 - SPECIAL
173 - G723_24
174 - G723_24_1B
175 - G723_40
176 - G723_40_1B
179 .B \-c, \-\-channels=#
190 .B \-r, \-\-rate=#
197 unit. The value should be between
206 .B \-t, \-\-file\-type=TYPE
209 - wav: Microsoft/IBM RIFF/Wave format
210 - au, sparc: Sparc AU format
211 - voc: Creative Tech. voice format
212 - raw: raw data
222 .B \-I, \-\-separate\-channels
228 is generated in a formula \(aq<filepath>\-<sequential number>[.suffix]\(aq.
232 .B \-\-dump\-hw\-params
236 .B \-\-xfer\-backend=BACKEND
239 - libasound
240 - libffado (optional if compiled)
245 .B \-D, \-\-device=NODE
255 .B \-N, \-\-nonblock
257 With this option, PCM substream is opened in non\-blocking mode. When audio
260 .I \-\-waiter\-type
264 .B \-M, \-\-mmap
270 .I \-\-waiter\-type
274 .B \-F, \-\-period\-size=#
281 from the selected PCM node, and in\-kernel driver or PCM I/O plugins.
285 plugins, in\-kernel driver, PCM I/O plugins and scheduling model. For \(aqhw\(aq
291 .B \-\-period\-time=#
296 .I \-\-period\-size
297 option, however its unit is micro\-second.
300 .B \-B, \-\-buffer\-size=#
307 PCM node, and in\-kernel driver or PCM I/O plugins.
311 plugins, in\-kernel driver and PCM I/O plugins.
314 .B \-\-buffer\-time=#
319 .I \-\-buffer\-size
320 option, however its unit is micro\-second.
323 .B \-\-waiter\-type=TYPE
342 type, Linux\-specific \(aqepoll(7)\(aq system call is used.
345 .I \-\-nonblock
347 .I \-\-mmap
351 .I \-\-sched\-model
354 .I \-\-test\-nowait
358 .B \-\-sched\-model=MODEL
371 .B \-A, \-\-avail\-min=#
374 .I avail\-min
377 substream to wake up process blocked by I/O operation. In non\-blocking mode,
378 any I/O operation returns \-EAGAIN until the available number of audio data frame reaches the thres…
381 .I \-\-mmap
385 .I \-\-sched\-model
389 .B \-R, \-\-start\-delay=#
396 .I \-\-mmap
400 .I \-\-sched\-model
415 .I \-\-mmap
419 .I \-\-sched\-model
423 .B \-T, \-\-stop\-delay=#
429 .I \-\-mmap
433 .I \-\-sched\-model
437 in buffer of PCM substream to which a driver or alsa\-lib PCM plugins write
445 of PCM substream from which a driver or alsa\-lib PCM plugins read reaches the
452 .I \-\-mmap
456 .I \-\-sched\-model
460 .B \-\-disable\-resample
462 This option has an effect for \(aqplug\(aq plugin in alsa\-lib to suppress
466 .B \-\-disable\-channels
468 This option has an effect for \(aqplug\(aq plugin in alsa\-lib to suppress
472 .B \-\-disable\-format
474 This option has an effect for \(aqplug\(aq plugin in alsa\-lib to suppress
478 .B \-\-disable\-softvol
480 This option has an effect for \(aqsoftvol\(aq plugin in alsa\-lib to suppress
484 .B \-\-fatal\-errors
490 .B \-\-test\-nowait
503 .B \-p, \-\-port=#
511 .I \-g
516 .B \-n, \-\-node=#
518 This option uses given value to decide which unit is used to communicate. This
520 .I \-p
522 specified unit.
525 .B \-g, \-\-guid=HEXADECIMAL
527 This option uses given value to decide a target unit to communicate. The value
529 (0\-9, a\-f, A\-F). Neither this option nor
530 .I \-p
536 .B \-\-frames\-per\-period=#
544 .B \-\-periods\-per\-buffer=#
550 .B \-\-slave
553 adds unit directory into configuration ROM of 1394 OHCI controller where Linux
554 system runs. The unit directory can be found by the other node on the same bus.
556 data frame to the unit. This program can receive the packet and demultiplex the
560 .B \-\-snoop
564 isochronous communication starts by any unit on the same bus, the packets can
568 .B \-\-sched\-priority=#
593 will resume it. No XRUNs are expected. With libffado backend, the suspend/resume
603 .B $ axfer transfer playback \-d 1 something
612 .I \-r
614 .I \-c
616 .I \-f
619 .I \-f
625 .B $ axfer transfer playback \-r 22050 \-c 1 \-f S16_LE \-t raw something
630 The above will transfer audio data frame in \(aqsomething\(aq file including no
643 .B $ axfer transfer capture \-d 10 \-f cd something.wav
658 .B $ axfer transfer capture \-s 1024 \-r 48000 \-c 2 \-f S32_BE \-I \-t au channels
665 named \(aqchannels\-1.au\(aq and \(aqchannels\-2.au\(aq.
670 .I period\-wakeup
672 .I no\-period\-wakeup.
675 .SS IRQ\-based scheduling model
678 .I period\-wakeup
679 mode is used. In this mode, in\-kernel drivers should operate hardware to
690 Inter\-IC sound is typically used. In this case, the controller generates the
697 External PCM plugins generated by PCM plugin SDK in alsa\-lib should also
706 .I IRQ\-based
709 .I \-\-sched\-model
714 .SS Timer\-based scheduling model
717 .I no\-period\-wakeup
719 specific feature of hardware and assist of in\-kernel driver and PCM
720 applications. In this mode, in\-kernel drivers don't operate hardware to
723 without periodical operation of the drivers; e.g. according to auto\-triggered
740 .I timer\-based
742 .I no\-period\-wakeup
744 .I \-\-sched\-model
761 Ideally, timer\-based scheduling model has some advantages than IRQ\-based
762 scheduling model. At first, no interrupt context runs for PCM substream. The
763 PCM substream is handled in any process context only. No need to care of race
773 device memory for audio serial bus. However, in timer\-based scheduling model,
779 kernel/userspace has no feature to report it.
791 .I \-I, \-\-separate\-channels
794 effect to use PCM buffer aligned to non\-interleaved order if a target device
795 supports. As of 2018, PCM buffer of non\-interleaved order is hardly used by
799 .I \-A, \-\-avail\-min=#
800 This option indicates threshold to wake up blocked process in a unit of
801 audio data frame. Against aplay(1) implementation, this option has no effect
803 .I \-\-mmap
807 .I \-\-sched\-model
811 .I \-R, \-\-start\-delay=#
812 This option indicates threshold to start prepared PCM substream in a unit of
813 audio data frame. Against aplay(1) implementation, this option has no effect
815 .I \-\-mmap
819 .I \-\-sched\-model
823 .I \-T, \-\-stop\-delay=#
824 This option indicates threshold to stop running PCM substream in a unit of
825 audio data frame. Against aplay(1) implementation, this option has no effect
827 .I \-\-mmap
831 .I \-\-sched\-model
835 .I \-\-max\-file\-time=#
838 frames as the given value by second unit, or the maximum number of data frames
845 .I \-\-use\-strftime=FORMAT
853 .I \-\-process\-id\-file=FILEPATH
861 .I \-V, \-\-vumeter=TYPE
869 .I \-i, \-\-interactive
877 .I \-m, \-\-chmap=CH1,CH2,...
880 data frames, especially for mmap operation. Furthermore, as of alsa-lib v1.1.8,
890 test from XRUN. At present, no alternative is supported for the test.
897 .I \-\-max\-file\-time
914 -------- ---------- -------------
915 device <-> | xfer | <-> | mapper | <-> | container | <-> file
916 -------- ---------- -------------
928 backend is used to perform transmission via alsa\-lib APIs. The module allows
968 has two shapes for interleaved and non\-interleaved order. For the former, the
979 some scenarios below, no copying occurs between modules.
981 - xfer(mmap/interleaved), mapper(single), container(any)
982 - xfer(mmap/non\-interleaved), mapper(multiple), containers(any)
984 .SS Unit test
990 module, unit test is available. To run the tests, execute below command:
993 $ make test
996 Each test iterates writing to file and reading to the file for many times and it
1003 axfer\-list(1),
1009 Takashi Sakamoto <o\-takashi@sakamocchi.jp>