The following notes describe how to generate log files and crash mini-dumps for diagnosing problems with Cantabile.
Before continuing, please read the current release notes as the issue you're encountering may already be fixed, or a work around suggested.
Please understand that any application that hosts plugins and modules developed by others is susceptible to crashes and other problems due to different interpretations of technical specifications by the developers involved. The extensive range of VST plugins available makes it impossible for us to test Cantabile with all plugins.
Cantabile includes a logging and tracing capability to help diagnose these problems.
Generating a Cantabile Log File
Please follow these steps if you encounter a reproducible problem with Cantabile:
- Restart Cantabile if it has crashed. Cantabile will detect it didn't shutdown properly and prompt whether to reload the previous configuration. Select No.
- Click the build number in the top right hand corner of Cantabile's main window.
- Click the Diagnostics and Troubleshooting button.
- Set the logging level to Level 2 - Information (unless we've asked for a log at a higher level)
- Select the Write Log File option.
- Select the Append Existing Log File option.
- Press the Find Log File button to launch Window's Explorer at the location where the log file will be created.
- Leave Explorer running and switch back to Cantabile.
- Press OK to close the diagnostics dialog.
- Reconfigure the Audio Driver if you're restarting after a crash.
- Restart Cantabile.
- Try to reproduce the problem.
Once the problem has been reproduced, do the following:
- Close Cantabile if necessary.
- Switch to the Window's Explorer that was launched when pressing the Find Log File button above. (The location of the file varies between different builds and different operating systems).
- There will be a new file ending in ".log"
- Feel free to examine this file (its just a text file that you can open with any text editor)
- Attach the log file to an email and send it to us with a complete description of how the problem occurred (see contact for the email address) .
- If you suspect the problem is due to a compatibility problem with a particular VST plugin or audio driver, please include information about the vendor of the plugin/driver if you know it. Most like we'll need to get a copy of the plugin/driver in order to fix the issue.
Once finished, you can disable logging.
Crash Reporting with Mini-dumps
If Cantabile crashes it will automatically create a crash mini-dump file. A mini-dump captures essential information about the state of the program at the time of the crash and is an invaluable resource in resolving these crashes.
The mini-dumps generated by Cantabile have a .mdmp file extension, are time-stamped and saved in the same folder as Cantabile's log files. Use the Find Log File button in the Diagnostics and Troubleshooting dialog to locate the folder.
In some older builds, these files may be found here:
- On Windows 2000/XP - C:\Documents and Settings<yourusername>\Application Data\Topten Software\Logs
- Vista - C:\Users<yourusername>\AppData\Roaming\Topten Software\Logs
If the crash you're reporting is reproducible, please enable logging (see above) and also send the generated log file. For one-off crashes, send just the mini-dump file.
In addition to the mdmp and log files, please include a detailed description of how to reproduce the crash, including details on the audio driver you're using and all plugins used.
When reporting faults, try to include as much information as possible, including:
- Version and build number of Cantabile
- Operating system details
- Sound card type
- Audio driver details, including whether ASIO or DirectSound
- Details of any plugins that you feel may be related to the problem
- Steps to reproduce the problem
In the case of a crash, please include the mini-dump that Cantabile should have automatically created (see above).
All fault reports should be sent by email - see the contact page for details.
Thanks for your time and effort in helping improve the quality of Cantabile! We take all fault reports seriously and you can generally expect to receive a reply with 24 hours.