Skip to content

Commit

Permalink
Ship FlexASIOTest with the installer.
Browse files Browse the repository at this point in the history
This might help end users investigate some issues themselves.

See #7.
  • Loading branch information
dechamps committed Oct 24, 2018
1 parent 72f8a9a commit d1d9d70
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ PortAudio itself is cross-platform.

## TROUBLESHOOTING

### Logging

FlexASIO includes a logging system that describes everything that is
happening within the driver in an excruciating amount of detail. It is
especially useful for troubleshooting driver initialization failures and
Expand All @@ -145,10 +147,33 @@ it elsewhere). Indeed, logging slows down FlexASIO, which can lead to
buffer underruns (audio glitches). The logfile can also grow to a very
large size over time.

### Test program

FlexASIO includes a rudimentary self-test program that can help diagnose
issues in some cases. It attempts to emulate what a basic ASIO host
application would do in a controlled, easily reproducible environment.

The program is called `FlexASIOTest.exe` and can be found in the `x64`
(64-bit) or `x86` (32-bit) subfolder in the FlexASIO installation
folder. It is a console program that should be run from the command
line.

It is a good idea to have logging enabled while running the test (see
above).

Note that a successful test run does not necessarily mean FlexASIO is
not at fault. Indeed it might be that the ASIO host application that
you're using is triggering a pathological case in FlexASIO. If you
suspect that's the case, please feel free to ask for help (see below).

## REPORTING ISSUES

Just use the GitHub issue tracker:
https://github.com/dechamps/FlexASIO/issues
Just use the
[GitHub issue tracker](https://github.com/dechamps/FlexASIO/issues).
When asking for help, it is strongly recommended to produce a log (see
above) while the problem is occuring, and attach it to your report. The
output of `FlexASIOTest` (see above), along with its log output, might
also help.

## DEVELOPER INFORMATION

Expand Down
2 changes: 2 additions & 0 deletions installer.iss
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ LicenseFile=LICENSE.txt
[Files]
Source:"build\x64\Release\FlexASIO_x64.dll"; DestDir: "{app}\x64"; Flags: ignoreversion regserver 64bit; Check: Is64BitInstallMode
Source:"build\x64\Release\FlexASIO_x64.pdb"; DestDir: "{app}\x64"; Flags: ignoreversion 64bit; Check: Is64BitInstallMode
Source:"build\x64\Release\FlexASIOTest_x64.exe"; DestDir: "{app}\x64"; Flags: ignoreversion 64bit; Check: Is64BitInstallMode
Source:"build\x86\Release\FlexASIO_x86.dll"; DestDir: "{app}\x86"; Flags: ignoreversion regserver 32bit
Source:"build\x86\Release\FlexASIO_x86.pdb"; DestDir: "{app}\x86"; Flags: ignoreversion 32bit
Source:"build\x86\Release\FlexASIOTest_x86.exe"; DestDir: "{app}\x86"; Flags: ignoreversion 32bit
Source:"LICENSE.txt"; DestDir:"{app}"; Flags: ignoreversion
Source:"README.md"; DestDir:"{app}"; Flags: ignoreversion

Expand Down

0 comments on commit d1d9d70

Please sign in to comment.