|
cannam@89
|
1 README for PortAudio Loopback Test
|
|
cannam@89
|
2
|
|
cannam@89
|
3 Copyright (c) 1999-2010 Phil Burk and Ross Bencina
|
|
cannam@89
|
4 See complete license at end of file.
|
|
cannam@89
|
5
|
|
cannam@89
|
6 This folder contains code for a single executable that does a standalone test of PortAudio.
|
|
cannam@89
|
7 It does not require a human to listen to the result. Instead it listens to itself using
|
|
cannam@89
|
8 a loopback cable connected between the audio output and the audio input. Special pop detectors
|
|
cannam@89
|
9 and phase analysers can detect errors in the audio stream.
|
|
cannam@89
|
10
|
|
cannam@89
|
11 This test can be run from a script as part of a nightly build and test.
|
|
cannam@89
|
12
|
|
cannam@89
|
13 --- How To Run Test ---
|
|
cannam@89
|
14
|
|
cannam@89
|
15 Connect stereo cables from one or more output audio devices to audio input devices.
|
|
cannam@89
|
16 The test will scan all the ports and find the cables.
|
|
cannam@89
|
17
|
|
cannam@89
|
18 Adjust the volume levels of the hardware so you get a decent signal that will not clip.
|
|
cannam@89
|
19
|
|
cannam@89
|
20 Run the test from the command line with the following options:
|
|
cannam@89
|
21
|
|
cannam@89
|
22 -i# Input device ID. Will scan for loopback if not specified.
|
|
cannam@89
|
23 -o# Output device ID. Will scan for loopback if not specified.
|
|
cannam@89
|
24 -r# Sample Rate in Hz. Will use multiple common rates if not specified.
|
|
cannam@89
|
25 -s# Size of callback buffer in frames, framesPerBuffer.
|
|
cannam@89
|
26 -w Save bad recordings in a WAV file.
|
|
cannam@89
|
27 -dDir Path for Directory for WAV files. Default is current directory.
|
|
cannam@89
|
28 -m Just test the DSP Math code and not the audio devices.
|
|
cannam@89
|
29
|
|
cannam@89
|
30 If the -w option is set then any tests that fail will save the recording of the broken
|
|
cannam@89
|
31 channel in a WAV file. The files will be numbered and shown in the report.
|
|
cannam@89
|
32
|
|
cannam@89
|
33 --- ToDo ---
|
|
cannam@89
|
34
|
|
cannam@89
|
35 * Add check for harmonic and enharmonic distortion.
|
|
cannam@89
|
36 * Measure min/max peak values.
|
|
cannam@89
|
37 * Detect DC bias.
|
|
cannam@89
|
38 * Test against matrix of devices/APIs and settings.
|
|
cannam@89
|
39 * Detect mono vs stereo loopback.
|
|
cannam@89
|
40 * More command line options
|
|
cannam@89
|
41 --quick
|
|
cannam@89
|
42 --latency
|
|
cannam@89
|
43 --duration
|
|
cannam@89
|
44 * Automated build and test script with cron job.
|
|
cannam@89
|
45 * Test on Windows.
|
|
cannam@89
|
46
|
|
cannam@89
|
47
|
|
cannam@89
|
48 /*
|
|
cannam@89
|
49 * PortAudio Portable Real-Time Audio Library
|
|
cannam@89
|
50 * Latest Version at: http://www.portaudio.com
|
|
cannam@89
|
51 *
|
|
cannam@89
|
52 * Copyright (c) 1999-2008 Phil Burk and Ross Bencina
|
|
cannam@89
|
53 *
|
|
cannam@89
|
54 * Permission is hereby granted, free of charge, to any person obtaining
|
|
cannam@89
|
55 * a copy of this software and associated documentation files
|
|
cannam@89
|
56 * (the "Software"), to deal in the Software without restriction,
|
|
cannam@89
|
57 * including without limitation the rights to use, copy, modify, merge,
|
|
cannam@89
|
58 * publish, distribute, sublicense, and/or sell copies of the Software,
|
|
cannam@89
|
59 * and to permit persons to whom the Software is furnished to do so,
|
|
cannam@89
|
60 * subject to the following conditions:
|
|
cannam@89
|
61 *
|
|
cannam@89
|
62 * The above copyright notice and this permission notice shall be
|
|
cannam@89
|
63 * included in all copies or substantial portions of the Software.
|
|
cannam@89
|
64 *
|
|
cannam@89
|
65 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
cannam@89
|
66 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
cannam@89
|
67 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
cannam@89
|
68 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
|
cannam@89
|
69 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
cannam@89
|
70 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
cannam@89
|
71 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
cannam@89
|
72 */
|
|
cannam@89
|
73
|
|
cannam@89
|
74 /*
|
|
cannam@89
|
75 * The text above constitutes the entire PortAudio license; however,
|
|
cannam@89
|
76 * the PortAudio community also makes the following non-binding requests:
|
|
cannam@89
|
77 *
|
|
cannam@89
|
78 * Any person wishing to distribute modifications to the Software is
|
|
cannam@89
|
79 * requested to send the modifications to the original developer so that
|
|
cannam@89
|
80 * they can be incorporated into the canonical version. It is also
|
|
cannam@89
|
81 * requested that these non-binding requests be included along with the
|
|
cannam@89
|
82 * license above.
|
|
cannam@89
|
83 */
|
