aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/channeldialog.html8
-rw-r--r--doc/channeleditor.html8
-rw-r--r--doc/cmdargs.html34
-rw-r--r--doc/efxdialog.html34
-rw-r--r--doc/index.html14
-rw-r--r--doc/license.html8
-rw-r--r--doc/mainwindow.html11
-rw-r--r--doc/optionsdialog.html77
-rw-r--r--doc/plistdialog.html34
-rw-r--r--doc/troubleshooting.html63
-rw-r--r--doc/version.html8
11 files changed, 277 insertions, 22 deletions
diff --git a/doc/channeldialog.html b/doc/channeldialog.html
index ee5a577..a4e5fd2 100644
--- a/doc/channeldialog.html
+++ b/doc/channeldialog.html
@@ -11,9 +11,11 @@
<li><a href="mainwindow.html">Main Window</a></li>
<li><a class="active" href="channeldialog.html">Channels Dialog</a></li>
<li><a href="channeleditor.html">Channel Editor</a></li>
- <li><a href="#">Playlist</a></li>
- <li><a href="#">Effects</a></li>
- <li><a href="#">Settings</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/channeleditor.html b/doc/channeleditor.html
index 34f9a19..fb50cc5 100644
--- a/doc/channeleditor.html
+++ b/doc/channeleditor.html
@@ -11,9 +11,11 @@
<li><a href="mainwindow.html">Main Window</a></li>
<li><a href="channeldialog.html">Channels Dialog</a></li>
<li><a class="active" href="channeleditor.html">Channel Editor</a></li>
- <li><a href="#">Playlist</a></li>
- <li><a href="#">Effects</a></li>
- <li><a href="#">Settings</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
diff --git a/doc/cmdargs.html b/doc/cmdargs.html
new file mode 100644
index 0000000..753ba2a
--- /dev/null
+++ b/doc/cmdargs.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+ <div id="panel">
+ <ul>
+ <li><a href="index.html">Overview</a></li>
+ <li><a href="mainwindow.html">Main Window</a></li>
+ <li><a href="channeldialog.html">Channels Dialog</a></li>
+ <li><a href="channeleditor.html">Channel Editor</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a class="active" href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="version.html">Version Info.</a></li>
+ <li><a href="license.html">License</a></li>
+ </ul>
+ </div>
+ <div id="content">
+ <pre>
+Usage: qmidiplayer [Options] [Midi Files]
+Possible options are:
+ -l, --load-all-files Load all files from the same folder.
+ --help Show this help and exit.
+ --version Show this version information and exit.
+ </pre>
+ <br><a href="index.html">Return</a>
+ </div>
+</body>
+</html>
diff --git a/doc/efxdialog.html b/doc/efxdialog.html
new file mode 100644
index 0000000..4f95849
--- /dev/null
+++ b/doc/efxdialog.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+ <div id="panel">
+ <ul>
+ <li><a href="index.html">Overview</a></li>
+ <li><a href="mainwindow.html">Main Window</a></li>
+ <li><a href="channeldialog.html">Channels Dialog</a></li>
+ <li><a href="channeleditor.html">Channel Editor</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a class="active" href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="version.html">Version Info.</a></li>
+ <li><a href="license.html">License</a></li>
+ </ul>
+ </div>
+ <div id="content">
+ <h1>Effects Dialog</h1>
+ <img src="../img/effectw.png"><br>
+ Adjest effect parameters of the internal fluidsynth here.
+ <ul>
+ <li>Changes in this dialog will be applied immediately.</li>
+ <li>These changes will also affect rendered wave files.</li>
+ </ul>
+ <br><a href="index.html">Return</a>
+ </div>
+</body>
+</html>
diff --git a/doc/index.html b/doc/index.html
index 7fbfb40..ad21637 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -11,9 +11,11 @@
<li><a href="mainwindow.html">Main Window</a></li>
<li><a href="channeldialog.html">Channels Dialog</a></li>
<li><a href="channeleditor.html">Channel Editor</a></li>
- <li><a href="#">Playlist</a></li>
- <li><a href="#">Effects</a></li>
- <li><a href="#">Settings</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
@@ -35,10 +37,10 @@
<li><a href="mainwindow.html">The main window</a></li>
<li><a href="channeldialog.html">The channels dialog</a></li>
<li><a href="channeleditor.html">The channels parameters editor</a></li>
- <li>The playlist dialog</li>
- <li>The effects dialog</li>
+ <li><a href="plistdialog.html">The playlist dialog</a></li>
+ <li><a href="efxdialog.html">The effects dialog</a></li>
<li>Visualization</li>
- <li>Setting up QMidiPlayer</li>
+ <li><a href="optionsdialog.html">Setting up QMidiPlayer</a></li>
</ul>
<h1>About QMidiPlayer</h1>
<ul>
diff --git a/doc/license.html b/doc/license.html
index c01d5fb..fcba8cf 100644
--- a/doc/license.html
+++ b/doc/license.html
@@ -15,9 +15,11 @@
<li><a href="mainwindow.html">Main Window</a></li>
<li><a href="channeldialog.html">Channels Dialog</a></li>
<li><a href="channeleditor.html">Channel Editor</a></li>
- <li><a href="#">Playlist</a></li>
- <li><a href="#">Effects</a></li>
- <li><a href="#">Settings</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a class="active" href="license.html">License</a></li>
</ul>
diff --git a/doc/mainwindow.html b/doc/mainwindow.html
index 5fd074c..a054c58 100644
--- a/doc/mainwindow.html
+++ b/doc/mainwindow.html
@@ -11,9 +11,11 @@
<li><a class="active" href="mainwindow.html">Main Window</a></li>
<li><a href="channeldialog.html">Channels Dialog</a></li>
<li><a href="channeleditor.html">Channel Editor</a></li>
- <li><a href="#">Playlist</a></li>
- <li><a href="#">Effects</a></li>
- <li><a href="#">Settings</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>
@@ -37,7 +39,8 @@
<li>Render to Wave.<br>
It's not possible to use this action unless the player is stopped.<br>
The output wave file, with the name (source file name)+'.wav', <br>
- is always placed in the folder that the source midi file is in.</li>
+ is always placed in the folder that the source midi file is in.<br>
+ MIDI mapping does not apply to render results.</li>
</ul>
<br><a href="index.html">Return</a>
</div>
diff --git a/doc/optionsdialog.html b/doc/optionsdialog.html
new file mode 100644
index 0000000..a033261
--- /dev/null
+++ b/doc/optionsdialog.html
@@ -0,0 +1,77 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+ <div id="panel">
+ <ul>
+ <li><a href="index.html">Overview</a></li>
+ <li><a href="mainwindow.html">Main Window</a></li>
+ <li><a href="channeldialog.html">Channels Dialog</a></li>
+ <li><a href="channeleditor.html">Channel Editor</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a class="active" href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="version.html">Version Info.</a></li>
+ <li><a href="license.html">License</a></li>
+ </ul>
+ </div>
+ <div id="content">
+ <h1>Settings Dialog</h1>
+ Settings are stored in $HOME/.config/qmprc<br>
+ For Windows users, $HOME refers to X:\Users\&lt;your user name&gt;\.config, where X is the system drive of your
+ Windows installation.<br>
+ Options with one asterisk will be applied after restarting QMidiPlayer.<br>
+ Options with two asterisks will be applied after the internal fluidsynth is restarted.<br>
+ Other options are applied immediately.<br>
+ <img src="../img/options1.png"><br>
+ <ul>
+ <li>Default Output Device*: specify the default midi device to use.</li>
+ <li>Disable Midi Mapping*: only use the default output device.</li>
+ <li>Send SysEx: whether to send system exclusive messages or not.</li>
+ <li>Wait for remaining voices before stopping:<br>
+ If checked, the player will not stop until the current polyphone reaches 0.<br>
+ Otherwise it will stop immediately after the last event is sent.
+ </li>
+ <li>Text encoding: text encoding used in the midi file.</li>
+ </ul>
+ <img src="../img/options2.png"><br>
+ <ul>
+ <li>Audio Driver**: specify the audio backend used by the internal synthesizer.</li>
+ <li>Audio Buffer Size**: Size per buffer used by the fluidsynth engine.</li>
+ <li>Audio Buffer Count**: Number of buffers used by the fluidsynth engine.</li>
+ <li>Audio Format**: audio output format of the fluidsynth engine.</li>
+ <li>Audio Frequency**: audio output sampling frequency of the fluidsynth engine.</li>
+ <li>Max Polyphony**: maximum simultaniously played voices of synthesizer.</li>
+ <li>CPU Cores**: threads used by the internal synthesizer.</li>
+ <li>Auto bank select mode:<br>
+ If checked, the player will choose the appropriate bank selecting mode
+ according to the file standard. If the file doesn't specify the standard
+ the player will fallback to the default bank select mode.
+ Otherwise the player will only use the default bank select mode.
+ </li>
+ <li>(Fallback) Bank Select Mode: the default bank select mode.</li>
+ </ul>
+ <img src="../img/options3.png"><br>
+ You can manage soundfont used by the internal fluidsynth engine here.<br>
+ If multiple soundfonts provide instruments with the same bank numbers and preset numbers,
+ the preset provided by the top most soundfont will be used.<br>
+ <img src="../img/options4.png"><br>
+ <ul>
+ <li>Restore last playlist on startup*: If checked and QMidiPlayer is started without files
+ to open, the playlist from the last session will be used instead of an empty playlist.</li>
+ <li>Load files in the same folder*: If checked, QMidiPlayer will add all midi files in the
+ same folder to the playlist when started with a file.</li>
+ <li>Save dialog status*: Save dialog positions and restore on start up.</li>
+ <li>Save parameters in effects window</li>
+ <li>Persistent fluidsynth instance*: If checked, the synthesizer engine will keep running
+ through the whole session. Otherwise it is restarted every time when a new song is played.</li>
+ </ul>
+ <br><a href="index.html">Return</a>
+ </div>
+</body>
+</html>
diff --git a/doc/plistdialog.html b/doc/plistdialog.html
new file mode 100644
index 0000000..ae14678
--- /dev/null
+++ b/doc/plistdialog.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+ <div id="panel">
+ <ul>
+ <li><a href="index.html">Overview</a></li>
+ <li><a href="mainwindow.html">Main Window</a></li>
+ <li><a href="channeldialog.html">Channels Dialog</a></li>
+ <li><a href="channeleditor.html">Channel Editor</a></li>
+ <li><a class="active" href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="version.html">Version Info.</a></li>
+ <li><a href="license.html">License</a></li>
+ </ul>
+ </div>
+ <div id="content">
+ <h1>Playlist Dialog</h1>
+ <img src="../img/playlistw.png"><br>
+ <h2>Notes</h2>
+ <ul>
+ <li>Drag &amp; drop to sort.</li>
+ <li>This dialog (together with the main window) also accepts file drops.</li>
+ </ul>
+ <br><a href="index.html">Return</a>
+ </div>
+</body>
+</html>
diff --git a/doc/troubleshooting.html b/doc/troubleshooting.html
new file mode 100644
index 0000000..f98e768
--- /dev/null
+++ b/doc/troubleshooting.html
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+ <div id="panel">
+ <ul>
+ <li><a href="index.html">Overview</a></li>
+ <li><a href="mainwindow.html">Main Window</a></li>
+ <li><a href="channeldialog.html">Channels Dialog</a></li>
+ <li><a href="channeleditor.html">Channel Editor</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a class="active" href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="version.html">Version Info.</a></li>
+ <li><a href="license.html">License</a></li>
+ </ul>
+ </div>
+ <div id="content">
+ If troubleshooting cannot solve your problem, please don't hesitate to report an issue.
+ <h3>1. I can't hear anything!</h3>
+ <p>
+ 1) Check current audio driver in the option dialog. Do not use an audio driver
+ that is not installed on your system.<br>
+ 2) If no soundfont is loaded, the synthesizer won't make any sound...<br>
+ 3) Check audio buffer settings in the synth section.<br>
+ 4) Check if your midi file is valid.
+ </p>
+ <h3>2. The playback is intermittent.</h3>
+ <p>
+ Try increasing audio buffer size and/or audio buffer count in synth options.
+ </p>
+ <h3>3. MIDI timing is messed up.</h3>
+ <p>
+ This is a known issue under Windows. Try decreasing audio buffer size and
+ increasing audio buffer count.
+ </p>
+ <h3>4. Some files cannot be played.</h3>
+ <h3>5. Some soundfonts cannot be loaded.</h3>
+ <p>
+ Files names with characters unsupported by the system locale
+ won't load correctly in Windows. This is a known issue.
+ </p>
+ <h3>6. Sound is distorted.</h3>
+ <p>
+ Try reducing the master volume.
+ </p>
+ <h3>7. Bank selecting is incorrect for the internal synth.</h3>
+ <p>
+ Change default midi mapping if necessary.
+ </p>
+ <h3>8. Bank selecting is incorrect for external devices.</h3>
+ <p>
+ Bank selecting to external devices is sent in raw format. The midi
+ file may be incompatible with your device.
+ </p>
+ </div>
+</body>
+</html> \ No newline at end of file
diff --git a/doc/version.html b/doc/version.html
index fff816f..050ab09 100644
--- a/doc/version.html
+++ b/doc/version.html
@@ -11,9 +11,11 @@
<li><a href="mainwindow.html">Main Window</a></li>
<li><a href="channeldialog.html">Channels Dialog</a></li>
<li><a href="channeleditor.html">Channel Editor</a></li>
- <li><a href="#">Playlist</a></li>
- <li><a href="#">Effects</a></li>
- <li><a href="#">Settings</a></li>
+ <li><a href="plistdialog.html">Playlist</a></li>
+ <li><a href="efxdialog.html">Effects</a></li>
+ <li><a href="optionsdialog.html">Settings</a></li>
+ <li><a href="cmdargs.html">Commandline arguments</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a class="active" href="version.html">Version Info.</a></li>
<li><a href="license.html">License</a></li>
</ul>