diff options
author | Chris Xiong <chirs241097@gmail.com> | 2019-02-10 11:16:07 +0800 |
---|---|---|
committer | Chris Xiong <chirs241097@gmail.com> | 2019-02-10 11:16:07 +0800 |
commit | 9d3c8c0e6e1a7ba43bf3dc19350d1dca68b657a3 (patch) | |
tree | 339de0698c13e1763d3361d70fb1266621025c91 /QMidiPlayer/doc | |
download | web-9d3c8c0e6e1a7ba43bf3dc19350d1dca68b657a3.tar.xz |
Initial commit.
Diffstat (limited to 'QMidiPlayer/doc')
-rw-r--r-- | QMidiPlayer/doc/APIdoc.html | 156 | ||||
-rw-r--r-- | QMidiPlayer/doc/APIdoc.md | 217 | ||||
-rw-r--r-- | QMidiPlayer/doc/channeldialog.html | 47 | ||||
-rw-r--r-- | QMidiPlayer/doc/channeleditor.html | 51 | ||||
-rw-r--r-- | QMidiPlayer/doc/cmdargs.html | 36 | ||||
-rw-r--r-- | QMidiPlayer/doc/efxdialog.html | 36 | ||||
-rw-r--r-- | QMidiPlayer/doc/index.html | 54 | ||||
-rw-r--r-- | QMidiPlayer/doc/index_internal.html | 18 | ||||
-rw-r--r-- | QMidiPlayer/doc/license.html | 716 | ||||
-rw-r--r-- | QMidiPlayer/doc/license_internal.html | 697 | ||||
-rw-r--r-- | QMidiPlayer/doc/mainwindow.html | 59 | ||||
-rw-r--r-- | QMidiPlayer/doc/miscellaneous.html | 87 | ||||
-rw-r--r-- | QMidiPlayer/doc/optionsdialog.html | 89 | ||||
-rw-r--r-- | QMidiPlayer/doc/plistdialog.html | 36 | ||||
-rw-r--r-- | QMidiPlayer/doc/qmidiplayer | 15 | ||||
-rw-r--r-- | QMidiPlayer/doc/styles.css | 47 | ||||
-rw-r--r-- | QMidiPlayer/doc/troubleshooting.html | 71 | ||||
-rw-r--r-- | QMidiPlayer/doc/version.html | 36 | ||||
-rw-r--r-- | QMidiPlayer/doc/version_internal.html | 20 | ||||
-rw-r--r-- | QMidiPlayer/doc/visualization.html | 97 |
20 files changed, 2585 insertions, 0 deletions
diff --git a/QMidiPlayer/doc/APIdoc.html b/QMidiPlayer/doc/APIdoc.html new file mode 100644 index 0000000..ea6bfd0 --- /dev/null +++ b/QMidiPlayer/doc/APIdoc.html @@ -0,0 +1,156 @@ +<h1 id="the-api-documentation-of-qmidiplayer-for-plugin-developers">The API documentation of QMidiPlayer for plugin developers</h1> +<p><em>This manual is not yet complete. It's only a working draft for the always-changing plugin system in QMP.</em> <em>Handle with care.</em></p> +<h1 id="overview">0. Overview</h1> +<p>Plugin for QMidiPlayer is a dynamically-loaded library that exports the symbol <code>qmpPluginGetInterface</code> and <code>qmpPluginGetAPIRev</code>. Before starting developing your own plugin, make sure to have a look at the sample plugin in the "sample-plugin" folder.</p> +<h1 id="qmidiplayer-plugin-sdk">1. "QMidiPlayer Plugin SDK"</h1> +<p>SDK for developing QMidiPlayer plugins is merely the <code>qmpcorepublic.hpp</code> header found in the "include" directory in the source tree. It includes classes used by QMidiPlayer's internal plugin infrastructure.</p> +<h1 id="basics-for-a-working-plugin">2. Basics for a working plugin</h1> +<p>First of all, you should make your library distinct from other libraries that are not QMidiPlayer plugins. You can achive it by exporting the symbols <code>qmpPluginGetInterface</code> and <code>qmpPluginGetAPIRev</code>. Specifically, what you should do is to add the following snipplet to somewhere of your code:</p> +<div class="sourceCode"><pre class="sourceCode c++"><code class="sourceCode cpp"><span class="at">extern</span> <span class="st">"C"</span>{ + EXPORTSYM qmpPluginIntf* qmpPluginGetInterface(qmpPluginAPI* api) + <span class="co">//semicolon or implementation here.</span> + EXPORTSYM <span class="at">const</span> <span class="dt">char</span>* qmpPluginGetAPIRev() + {<span class="cf">return</span> QMP_PLUGIN_API_REV;} +}</code></pre></div> +<p>The <code>EXPORTSYM</code> macro tells the compiler to export the following symbol. <code>qmpPluginIntf</code> is the abstract class which every plugin class should derive from. The parameter api provides access to QMidiPlayer's plugin API, which should be stored for future use. <code>qmpPluginGetAPIRev</code> helps the core to determine whether the plugin is compatible with the API it exports.</p> +<p>Next you should create your own plugin class which implements the abstract class <code>qmpPluginIntf</code>.</p> +<h1 id="a-peek-into-the-class-qmppluginintf">3. A peek into the class <code>qmpPluginIntf</code></h1> +<p>It has 6 public members: one default constructor, one default destructor and four methods:</p> +<ul> +<li><code>void init()</code><br /> +Called on start up if the plugin is loaded successfully and enabled.</li> +<li><code>void deinit()</code><br /> +Called on shutdown if the plugin is enabled.</li> +<li><code>const char* pluginGetName()</code><br /> +This function should return the display name of the plugin.</li> +<li><code>const char* pluginGetVersion()</code><br /> +This function should return the version of the plugin, which will be shown in the plugin manager.</li> +</ul> +<p>Your plugin is expected to register handlers (hooks) and functionalities when init() is called by the host, and do clean-up jobs when deinit() is caled.</p> +<p>Currently plugins can register handlers for these functionalities:</p> +<ul> +<li>Visualization (via <code>(un)registerVisualizationIntf</code>)</li> +<li>MIDI File Reader (via <code>(un)registerFileReader</code>)</li> +</ul> +<p>...and can hooks into the following processes:</p> +<ul> +<li>Event reader, after an event is read or after the whole file reading process is completed (via <code>(un)registerEventReaderIntf</code> and <code>(un)registerFileReadFinishedHandlerIntf</code>)</li> +<li>Event handler, when an event is going to be sent by the player (via <code>(un)registerEventHandlerIntf</code>)</li> +</ul> +<p>Functionalities has their own interfaces you need to implement(<code>qmpVisualizationIntf</code> and <code>IMidiFileReader</code>, respectively), while hooks uses the universal <code>IMidiCallBack</code> interface. Functionalities are discussed later.</p> +<p>When you register a hook, you provide the core with a instance of your class that implements the <code>IMidiCallBack</code> interface and your <code>userdata</code> to be used when the core is calling the callback. When the callback is called, it will be fed with proper <code>callerdata</code> generated by the core and the <code>userdata</code> you provided. Type of <code>callerdata</code> varies by hooks. Event reader and handler hooks have <code>SEventCallBackData*</code> as their <code>callerdata</code> while file read finish hook doesn't provide <code>callerdata</code> (<code>NULL</code>).</p> +<h1 id="functionalities">4. Functionalities</h1> +<p>Plugins extend the host with extra functionalities. With hooks, handlers and the built-in core API, you can already do a lot of hacking. If that cannot make you satisfied, QMidiPlayer have several vacancies that are expected to be implemented by plugins. And with the introduction of the general functionality API, you can now virtually add anything to QMidiPlayer!</p> +<h2 id="what-is-a-functionality">4.1 What is a functionality?</h2> +<p>Have a look at the main window. By default there're three or four buttons at the bottom of it. These are functionalities. Functionalties go into two types: checkable and non-checkable. Checkable functionalities can be toggled on or off, while non-checkable functionalities have no such states. For non-checkable functionalities, only show() is called when the user invokes it. The user can arrange functionalities shown on the toolbar and the action menu to their needs.</p> +<h2 id="visualization">4.2 Visualization</h2> +<p>Visualization was once a feature of QMidiPlayer's core. But you can now write your own visualization with the Visualization interface(<code>qmpVisualizationIntf</code>). The methods in this interface should be self-explanatory.</p> +<h2 id="midi-file-reader">4.3 MIDI File Reader</h2> +<p>This is not strictly a "functionality", because its interface IMidiFileReader does not inherit qmpFuncBaseIntf. When the user requests to open a file, the core tries to load the file with registered file readers and accepts the first valid result. Therefore you can implement your own file reader, which may even add eXtended Module support to QMidiPlayer!</p> +<h2 id="midi-output-device">4.4 MIDI Output Device</h2> +<p>This is not a functionality either. By implementing the interface qmpMidiOutDevice and registering it, you can add custom MIDI Devices in the built-in MIDI mapper.</p> +<h1 id="generic-considerations">5. Generic Considerations</h1> +<ol style="list-style-type: decimal"> +<li>If you implemented a API that returns a pointer to something, you can forget about the pointer after returning it. The core will free its memory after it is no longer used. You shouldn't extend the class pointed to because if you do so, the core will not be able to destruct it correctly. Examples include IMidiFileReader::readFile which returns a pointer to a CMidiFile class.</li> +<li>However if you passed a pointer to the core through a function in qmpPluginAPI, you cannot forget about the pointer later. As these pointers are mostly polymorphic, the core cannot handle their destruction. You have to delete them yourself in the deinit() function of your plugin.</li> +<li>Do not throw exceptions to the core. The core doesn't handle exceptions and they will crash the entire program. Use the return value to indicate failure of a procedure instead.</li> +</ol> +<h1 id="reference">6. Reference</h1> +<p>Well, everything above is just nonsense compared to this one. The full reference of the API is here.</p> +<h2 id="structures-classes">Structures & Classes</h2> +<h3 id="struct-sevent">struct <code>SEvent</code></h3> +<p>Describes an MIDI event.</p> +<ul> +<li><code>uint32_t iid</code><br /> +internal id. Usually set to the size of the event pool when current event is read.</li> +<li><code>uint32_t time</code><br /> +timestamp of the event in MIDI tick.</li> +<li><code>uint32_t p1</code><br /> +parameter 1 for the midi event.</li> +<li><code>uint32_t p2</code><br /> +parameter 2 for the midi event.</li> +<li><code>uint8_t type</code><br /> +type of the event together with the channel this event goes to.</li> +<li><code>std::string str</code><br /> +Contains the raw data for string-like events.</li> +<li>default constructor: <code>SEvent()</code><br /> +sets everything to zero or empty.</li> +<li>constructor with parameters: <code>SEvent(uint32_t _iid,uint32_t _t,char _tp,uint32_t _p1,uint32_t _p2,const char* s=NULL)</code><br /> +fills the event with the parameters given.</li> +<li><code>friend bool operator <(const SEvent& a,const SEvent& b)</code><br /> +compares events by their timestamps. Ties are broken by comparing precedence in file.</li> +</ul> +<h3 id="struct-seventcallbackdata">struct <code>SEventCallBackData</code></h3> +<p>A stripped down version of SEvent that is used to pass event data in APIs.</p> +<ul> +<li><code>uint32_t time</code></li> +<li><code>uint32_t type</code></li> +<li><code>uint32_t p1</code></li> +<li><code>uint32_t p2</code></li> +</ul> +<h3 id="class-cmiditrack">class <code>CMidiTrack</code></h3> +<p>Describes a single MIDI track. A MIDI track consists of multiple MIDI events.</p> +<ul> +<li><code>std::vector<SEvent> eventList</code><br /> +Vector of SEvent's.</li> +<li><code>void appendEvent(SEvent e)</code><br /> +Append an event to the end of the event list.</li> +<li><code>SEvent& operator[](size_t sub)</code><br /> +Get the reference to the contained event with the given index.</li> +</ul> +<h3 id="class-cmidifile">class <code>CMidiFile</code></h3> +<p>Describes a MIDI file. A MIDI file consists of multiple MIDI tracks.</p> +<ul> +<li><code>bool valid</code><br /> +Is the MIDI file a valid one?</li> +<li><code>char* title</code><br /> +Title of the MIDI file.</li> +<li><code>char* copyright</code><br /> +Copyright information of the MIDI file.</li> +<li><code>std::vector<CMidiTrack> tracks</code> Tracks in the MIDI file.</li> +<li><code>uint32_t std</code><br /> +File standard of the MIDI file. +<ul> +<li>0: unknown</li> +<li>1: GM Level 1</li> +<li>2: GM Level 2</li> +<li>3: GS</li> +<li>4: XG</li> +</ul></li> +<li><code>uint32_t div</code><br /> +Ticks per quarter note. SMTPE format is not supported by QMidiPlayer.</li> +<li><code>~CMidiFile()</code><br /> +Frees memory occupied by the title and copyright string.</li> +</ul> +<h3 id="class-imidicallback">class <code>IMidiCallBack</code></h3> +<p>Generic callback function that can be used for hooking the core.</p> +<ul> +<li><code>IMidiCallBack()</code><br /> +Default empty constructor.</li> +<li><code>virtual void callBack(void* callerdata,void* userdata)=0;</code><br /> +Abstract function of the callback. callerdata is filled by the caller and userdata is set to whatever you asked for when registering the callback.</li> +<li><code>virtual ~IMidiCallBack()</code><br /> +Virtual empty destructor.</li> +</ul> +<h3 id="class-imidifilereader">class <code>IMidiFileReader</code></h3> +<p>MIDI file reader interface. Use this to implement your file importer.</p> +<ul> +<li><code>IMidiFileReader()</code><br /> +Default empty constructor.</li> +<li><code>virtual ~IMidiFileReader()</code><br /> +Virtual empty destructor.</li> +<li><code>virtual CMidiFile* readFile(const char* fn)=0</code><br /> +Abstract function to be implemented by the plugin.<br /> +This function should read file from the given path (fn) and return a pointer to the resulting CMidiFile structure. You shoudn't handle the destruction of the resulting structure as the core will handle it.<br /> +Read 5.1 for more details.<br /> +After reading each event, you should call qmpPluginAPI::callEventReaderCB to invoke event reader callbacks and process their requests.<br /> +If a file not supported by the reader is provided, this function should return a CMidiFile* whose <code>valid</code> field is <code>false</code>.</li> +<li><code>virtual void discardCurrentEvent()=0</code><br /> +Only called by event reader callbacks.<br /> +Expected behavior: Sets the discard flag for the last event you have read. If an event has its discard flag set, it shouldn't be pushed into its track.<br /> +discardCurrentEvent may be called multiple times by different event reader callbacks. In such case, there's still only one event discarded.</li> +<li><code>virtual void commitEventChange(SEventCallBackData d)=0</code><br /> +Only called by event reader callbacks.<br /> +Expected behavior: modifies the last event you have read to the provided data.<br /> +commitEventChange may be called multiple times by different event reader callbacks. In such case, only the last modification to the current event counts.</li> +</ul> diff --git a/QMidiPlayer/doc/APIdoc.md b/QMidiPlayer/doc/APIdoc.md new file mode 100644 index 0000000..be7bbc5 --- /dev/null +++ b/QMidiPlayer/doc/APIdoc.md @@ -0,0 +1,217 @@ +# The API documentation of QMidiPlayer for plugin developers + +*This manual is not yet complete. It's only a working draft for the always-changing plugin system in QMP.* +*Handle with care.* + +# 0. Overview + +Plugin for QMidiPlayer is a dynamically-loaded library that exports the symbol `qmpPluginGetInterface` and `qmpPluginGetAPIRev`. +Before starting developing your own plugin, make sure to have a look at the sample plugin in the "sample-plugin" folder. + +# 1. "QMidiPlayer Plugin SDK" + +SDK for developing QMidiPlayer plugins is merely the `qmpcorepublic.hpp` header found in the "include" directory in +the source tree. It includes classes used by QMidiPlayer's internal plugin infrastructure. + +# 2. Basics for a working plugin + +First of all, you should make your library distinct from other libraries that are not QMidiPlayer plugins. You can achive +it by exporting the symbols `qmpPluginGetInterface` and `qmpPluginGetAPIRev`. Specifically, what you should do is to add +the following snipplet to somewhere of your code: + +```C++ +extern "C"{ + EXPORTSYM qmpPluginIntf* qmpPluginGetInterface(qmpPluginAPI* api) + //semicolon or implementation here. + EXPORTSYM const char* qmpPluginGetAPIRev() + {return QMP_PLUGIN_API_REV;} +} +``` + +The `EXPORTSYM` macro tells the compiler to export the following symbol. `qmpPluginIntf` is the abstract class which every +plugin class should derive from. The parameter api provides access to QMidiPlayer's plugin API, which should be stored +for future use. `qmpPluginGetAPIRev` helps the core to determine whether the plugin is compatible with the API it exports. + +Next you should create your own plugin class which implements the abstract class `qmpPluginIntf`. + +# 3. A peek into the class `qmpPluginIntf` + +It has 6 public members: one default constructor, one default destructor and four methods: + +- `void init()` + Called on start up if the plugin is loaded successfully and enabled. +- `void deinit()` + Called on shutdown if the plugin is enabled. +- `const char* pluginGetName()` + This function should return the display name of the plugin. +- `const char* pluginGetVersion()` + This function should return the version of the plugin, which will be shown in the plugin manager. + +Your plugin is expected to register handlers (hooks) and functionalities when init() is called by the host, +and do clean-up jobs when deinit() is caled. + +Currently plugins can register handlers for these functionalities: + +- Visualization (via `(un)registerVisualizationIntf`) +- MIDI File Reader (via `(un)registerFileReader`) + +...and can hooks into the following processes: + +- Event reader, after an event is read or after the whole file reading process is completed + (via `(un)registerEventReaderIntf` and `(un)registerFileReadFinishedHandlerIntf`) +- Event handler, when an event is going to be sent by the player (via `(un)registerEventHandlerIntf`) + +Functionalities has their own interfaces you need to implement(`qmpVisualizationIntf` and `IMidiFileReader`, respectively), +while hooks uses the universal `IMidiCallBack` interface. Functionalities are discussed later. + +When you register a hook, you provide the core with a instance of your class that implements the `IMidiCallBack` interface +and your `userdata` to be used when the core is calling the callback. When the callback is called, it will be fed with +proper `callerdata` generated by the core and the `userdata` you provided. Type of `callerdata` varies by hooks. Event +reader and handler hooks have `SEventCallBackData*` as their `callerdata` while file read finish hook doesn't provide +`callerdata` (`NULL`). + +# 4. Functionalities +Plugins extend the host with extra functionalities. With hooks, handlers and the built-in core API, you can already do a +lot of hacking. If that cannot make you satisfied, QMidiPlayer have several vacancies that are expected to be implemented +by plugins. And with the introduction of the general functionality API, you can now virtually add anything to QMidiPlayer! + +## 4.1 What is a functionality? +Have a look at the main window. By default there're three or four buttons at the bottom of it. +These are functionalities. Functionalties go into two types: checkable and non-checkable. +Checkable functionalities can be toggled on or off, while non-checkable functionalities have +no such states. For non-checkable functionalities, only show() is called when the user invokes it. +The user can arrange functionalities shown on the toolbar and the action menu to their needs. + +## 4.2 Visualization +Visualization was once a feature of QMidiPlayer's core. But you can now write your own visualization with the +Visualization interface(`qmpVisualizationIntf`). The methods in this interface should be self-explanatory. + +## 4.3 MIDI File Reader +This is not strictly a "functionality", because its interface IMidiFileReader does not inherit qmpFuncBaseIntf. +When the user requests to open a file, the core tries to load the file with registered file readers and +accepts the first valid result. Therefore you can implement your own file reader, which may even add +eXtended Module support to QMidiPlayer! + +## 4.4 MIDI Output Device +This is not a functionality either. By implementing the interface qmpMidiOutDevice and registering it, you can +add custom MIDI Devices in the built-in MIDI mapper. + +# 5. Generic Considerations + +1. If you implemented a API that returns a pointer to something, you can forget about the pointer after returning +it. The core will free its memory after it is no longer used. You shouldn't extend the class pointed to because +if you do so, the core will not be able to destruct it correctly. Examples include IMidiFileReader::readFile which +returns a pointer to a CMidiFile class. +2. However if you passed a pointer to the core through a function in qmpPluginAPI, you cannot forget about the pointer +later. As these pointers are mostly polymorphic, the core cannot handle their destruction. You have to delete them +yourself in the deinit() function of your plugin. +3. Do not throw exceptions to the core. The core doesn't handle exceptions and they will crash the entire program. +Use the return value to indicate failure of a procedure instead. + +# 6. Reference +Well, everything above is just nonsense compared to this one. The full reference of the API is here. + +## Structures & Classes + +### struct `SEvent` +Describes an MIDI event. + +- `uint32_t iid` +internal id. Usually set to the size of the event pool when current event is read. +- `uint32_t time` +timestamp of the event in MIDI tick. +- `uint32_t p1` +parameter 1 for the midi event. +- `uint32_t p2` +parameter 2 for the midi event. +- `uint8_t type` +type of the event together with the channel this event goes to. +- `std::string str` +Contains the raw data for string-like events. +- default constructor: `SEvent()` +sets everything to zero or empty. +- constructor with parameters: `SEvent(uint32_t _iid,uint32_t _t,char _tp,uint32_t _p1,uint32_t _p2,const char* s=NULL)` +fills the event with the parameters given. +- `friend bool operator <(const SEvent& a,const SEvent& b)` +compares events by their timestamps. Ties are broken by comparing precedence in file. + +### struct `SEventCallBackData` +A stripped down version of SEvent that is used to pass event data in APIs. + +- `uint32_t time` +- `uint32_t type` +- `uint32_t p1` +- `uint32_t p2` + +### class `CMidiTrack` +Describes a single MIDI track. A MIDI track consists of multiple MIDI events. + +- `std::vector<SEvent> eventList` +Vector of SEvent's. +- `void appendEvent(SEvent e)` +Append an event to the end of the event list. +- `SEvent& operator[](size_t sub)` +Get the reference to the contained event with the given index. + +### class `CMidiFile` +Describes a MIDI file. A MIDI file consists of multiple MIDI tracks. + +- `bool valid` +Is the MIDI file a valid one? +- `char* title` +Title of the MIDI file. +- `char* copyright` +Copyright information of the MIDI file. +- `std::vector<CMidiTrack> tracks` +Tracks in the MIDI file. +- `uint32_t std` +File standard of the MIDI file. + - 0: unknown + - 1: GM Level 1 + - 2: GM Level 2 + - 3: GS + - 4: XG +- `uint32_t div` +Ticks per quarter note. SMTPE format is not supported by QMidiPlayer. +- `~CMidiFile()` +Frees memory occupied by the title and copyright string. + +### class `IMidiCallBack` +Generic callback function that can be used for hooking the core. + +- `IMidiCallBack()` +Default empty constructor. +- `virtual void callBack(void* callerdata,void* userdata)=0;` +Abstract function of the callback. callerdata is filled by the caller and +userdata is set to whatever you asked for when registering the callback. +- `virtual ~IMidiCallBack()` +Virtual empty destructor. + +### class `IMidiFileReader` +MIDI file reader interface. Use this to implement your file importer. + +- `IMidiFileReader()` +Default empty constructor. +- `virtual ~IMidiFileReader()` +Virtual empty destructor. +- `virtual CMidiFile* readFile(const char* fn)=0` +Abstract function to be implemented by the plugin. +This function should read file from the given path (fn) and return a +pointer to the resulting CMidiFile structure. You shoudn't handle the +destruction of the resulting structure as the core will handle it. +Read 5.1 for more details. +After reading each event, you should call qmpPluginAPI::callEventReaderCB +to invoke event reader callbacks and process their requests. +If a file not supported by the reader is provided, this function should +return a CMidiFile* whose `valid` field is `false`. +- `virtual void discardCurrentEvent()=0` +Only called by event reader callbacks. +Expected behavior: Sets the discard flag for the last event you have read. +If an event has its discard flag set, it shouldn't be pushed into its track. +discardCurrentEvent may be called multiple times by different event reader +callbacks. In such case, there's still only one event discarded. +- `virtual void commitEventChange(SEventCallBackData d)=0` +Only called by event reader callbacks. +Expected behavior: modifies the last event you have read to the provided data. +commitEventChange may be called multiple times by different event reader callbacks. +In such case, only the last modification to the current event counts. diff --git a/QMidiPlayer/doc/channeldialog.html b/QMidiPlayer/doc/channeldialog.html new file mode 100644 index 0000000..c1674a1 --- /dev/null +++ b/QMidiPlayer/doc/channeldialog.html @@ -0,0 +1,47 @@ +<!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 class="active" 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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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>Channel Dialog</h1> + <img src="../img/chanw.png"><br> + <h2>Columns in the channel table</h2> + <ul> + <li>A(Activity): Shows the activity of the corresponding channel.</li> + <li>M(Mute): Tick this to mute the corresponding channel.</li> + <li>S(Solo): Tick this to solo the corresponding channel.</li> + <li>Device: The player sends midi messages from this channel to the device selected here.</li> + <li>Preset: Displays the current preset of the corresponding channel.<br> + Preset can be changed by double clicking the cells from this column.</li> + <li>...: Brings up the channel parameter editor dialog.</li> + </ul> + <h2>Buttons</h2> + <ul> + <li>Save/Load: not yet implemented.</li> + <li>Unmute All: Remove tick mark from all mute checkboxes.</li> + <li>Unsolo All: Remove tick mark from all solo checkboxes.</li> + </ul> + <br><a href="index.html">Return</a> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/channeleditor.html b/QMidiPlayer/doc/channeleditor.html new file mode 100644 index 0000000..0c38d54 --- /dev/null +++ b/QMidiPlayer/doc/channeleditor.html @@ -0,0 +1,51 @@ +<!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 class="active" 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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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>Channel Editor</h1> + <img src="../img/chparaw.png"><br> + <h2>Controllers Explained</h2> + <ul> + <li>Cut.: Cut Off (cc#74, defined in GM2). Not supported by vanilla fluidsynth.</li> + <li>Res.: Resonance (cc#71, defined in GM2). Not supported by vanilla fluidsynth</li> + <li>Rev.: Reverb (cc#91, defined in GM1).</li> + <li>Chr.: Chorus (cc#93, defined in GM1).</li> + <li>Vol.: Volume (cc#07, defined in GM1).</li> + <li>Pan.: Panorama (cc#10, defined in GM1).</li> + <li>Atk.: Envelope attack (cc#73, defined in GM2). Not supported by vanilla fluidsynth.</li> + <li>Dec.: Envelope decay (cc#75, defined in GM2). Not supported by vanilla fluidsynth.</li> + <li>Rel.: Envelope release (cc#72, defined in GM2). Not supported by vanilla fluidsynth.</li> + <li>Rate: Vibrato rate (cc#76, defined in GM2). Not supported by vanilla fluidsynth.</li> + <li>Dep.: Vibrato depth (cc#77, defined in GM2). Not supported by vanilla fluidsynth.</li> + <li>Del.: Vibrato delay (cc#78, defined in GM2). Not supported by vanilla fluidsynth.</li> + </ul> + <h2>Notes</h2> + <ul> + <li>Changes in this page are applied immediately.</li> + <li>Vanilla fluidsynth does not support GM2 controls.</li> + </ul> + <br><a href="index.html">Return</a> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/cmdargs.html b/QMidiPlayer/doc/cmdargs.html new file mode 100644 index 0000000..afc770d --- /dev/null +++ b/QMidiPlayer/doc/cmdargs.html @@ -0,0 +1,36 @@ +<!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="visualization.html">Visualization</a></li> + <li><a class="active" href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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/QMidiPlayer/doc/efxdialog.html b/QMidiPlayer/doc/efxdialog.html new file mode 100644 index 0000000..1706fc7 --- /dev/null +++ b/QMidiPlayer/doc/efxdialog.html @@ -0,0 +1,36 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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/QMidiPlayer/doc/index.html b/QMidiPlayer/doc/index.html new file mode 100644 index 0000000..529f302 --- /dev/null +++ b/QMidiPlayer/doc/index.html @@ -0,0 +1,54 @@ +<!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 class="active" 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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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>Overview</h1> + QMidiPlayer is a cross-platform player for midi files based on fluidsynth and Qt.<br> + Key features:<br> + <ul> + <li>Playback of midi format 0/1 files.</li> + <li>Manipulate channel parameters on-the-fly.</li> + <li>Visualization of midi file playback.</li> + <li>Playlists.</li> + <li>Midi mapping.</li> + <li>Rendering midi files to wave.</li> + </ul> + <h1>Using QMidiPlayer</h1> + <ul> + <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><a href="plistdialog.html">The playlist dialog</a></li> + <li><a href="efxdialog.html">The effects dialog</a></li> + <li><a href="visualization.html">Visualization</a></li> + <li><a href="optionsdialog.html">Setting up QMidiPlayer</a></li> + </ul> + <h1>About QMidiPlayer</h1> + <ul> + <li><a href="version.html">Version information</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> +</body> +</html>
\ No newline at end of file diff --git a/QMidiPlayer/doc/index_internal.html b/QMidiPlayer/doc/index_internal.html new file mode 100644 index 0000000..17f9cc0 --- /dev/null +++ b/QMidiPlayer/doc/index_internal.html @@ -0,0 +1,18 @@ +<!DOCTYPE html> +<html> +<head> +<title>QMidiPlayer Help</title> +</head> +<body> + <h1>User manual</h1> + You can find documentation <a href="https://htmlpreview.github.io/?https://github.com/chirs241097/QMidiPlayer/blob/master/doc/index.html">here</a>.<br> + Alternatively, you can use <a href="https://chrisoft.org/QMidiPlayer/doc/index.html">the version on chrisoft.org</a> or the version installed on your computer. + <h1>Contributing to the project</h1> + Take a look at <a href="https://github.com/chirs241097/QMidiPlayer">the project's git repo</a>. + <h1>About QMidiPlayer</h1> + <ul> + <li><a href="version_internal.html">Version information</a></li> + <li><a href="license_internal.html">License</a></li> + </ul> +</body> +</html>
\ No newline at end of file diff --git a/QMidiPlayer/doc/license.html b/QMidiPlayer/doc/license.html new file mode 100644 index 0000000..3bd363d --- /dev/null +++ b/QMidiPlayer/doc/license.html @@ -0,0 +1,716 @@ + +<!DOCTYPE html> + +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>GNU General Public License v3.0 - GNU Project - Free Software Foundation (FSF)</title> + <link rel="alternate" type="application/rdf+xml" + href="http://www.gnu.org/licenses/gpl-3.0.rdf" /> + <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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</a></li> + <li><a href="version.html">Version Info.</a></li> + <li><a class="active" href="license.html">License</a></li> + </ul> + </div> + <div id="content"> +<h3 style="text-align: center;">GNU GENERAL PUBLIC LICENSE</h3> +<p style="text-align: center;">Version 3, 29 June 2007</p> + +<p>Copyright © 2007 Free Software Foundation, Inc. + <<a href="http://fsf.org/">http://fsf.org/</a>></p><p> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed.</p> + +<h3><a name="preamble"></a>Preamble</h3> + +<p>The GNU General Public License is a free, copyleft license for +software and other kinds of works.</p> + +<p>The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too.</p> + +<p>When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things.</p> + +<p>To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others.</p> + +<p>For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights.</p> + +<p>Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it.</p> + +<p>For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions.</p> + +<p>Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users.</p> + +<p>Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free.</p> + +<p>The precise terms and conditions for copying, distribution and +modification follow.</p> + +<h3><a name="terms"></a>TERMS AND CONDITIONS</h3> + +<h4><a name="section0"></a>0. Definitions.</h4> + +<p>“This License” refers to version 3 of the GNU General Public License.</p> + +<p>“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks.</p> + +<p>“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations.</p> + +<p>To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a “modified version” of the +earlier work or a work “based on” the earlier work.</p> + +<p>A “covered work” means either the unmodified Program or a work based +on the Program.</p> + +<p>To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well.</p> + +<p>To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying.</p> + +<p>An interactive user interface displays “Appropriate Legal Notices” +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion.</p> + +<h4><a name="section1"></a>1. Source Code.</h4> + +<p>The “source code” for a work means the preferred form of the work +for making modifications to it. “Object code” means any non-source +form of a work.</p> + +<p>A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language.</p> + +<p>The “System Libraries” of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it.</p> + +<p>The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work.</p> + +<p>The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source.</p> + +<p>The Corresponding Source for a work in source code form is that +same work.</p> + +<h4><a name="section2"></a>2. Basic Permissions.</h4> + +<p>All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law.</p> + +<p>You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you.</p> + +<p>Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary.</p> + +<h4><a name="section3"></a>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4> + +<p>No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures.</p> + +<p>When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures.</p> + +<h4><a name="section4"></a>4. Conveying Verbatim Copies.</h4> + +<p>You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program.</p> + +<p>You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee.</p> + +<h4><a name="section5"></a>5. Conveying Modified Source Versions.</h4> + +<p>You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions:</p> + +<ul> +<li>a) The work must carry prominent notices stating that you modified + it, and giving a relevant date.</li> + +<li>b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + “keep intact all notices”.</li> + +<li>c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it.</li> + +<li>d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so.</li> +</ul> + +<p>A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate.</p> + +<h4><a name="section6"></a>6. Conveying Non-Source Forms.</h4> + +<p>You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways:</p> + +<ul> +<li>a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange.</li> + +<li>b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge.</li> + +<li>c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b.</li> + +<li>d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements.</li> + +<li>e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d.</li> +</ul> + +<p>A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work.</p> + +<p>A “User Product” is either (1) a “consumer product”, which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, “normally used” refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product.</p> + +<p>“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made.</p> + +<p>If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM).</p> + +<p>The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network.</p> + +<p>Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying.</p> + +<h4><a name="section7"></a>7. Additional Terms.</h4> + +<p>“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions.</p> + +<p>When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission.</p> + +<p>Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms:</p> + +<ul> +<li>a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or</li> + +<li>b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or</li> + +<li>c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or</li> + +<li>d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or</li> + +<li>e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or</li> + +<li>f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors.</li> +</ul> + +<p>All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying.</p> + +<p>If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms.</p> + +<p>Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way.</p> + +<h4><a name="section8"></a>8. Termination.</h4> + +<p>You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11).</p> + +<p>However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation.</p> + +<p>Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice.</p> + +<p>Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10.</p> + +<h4><a name="section9"></a>9. Acceptance Not Required for Having Copies.</h4> + +<p>You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so.</p> + +<h4><a name="section10"></a>10. Automatic Licensing of Downstream Recipients.</h4> + +<p>Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License.</p> + +<p>An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts.</p> + +<p>You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it.</p> + +<h4><a name="section11"></a>11. Patents.</h4> + +<p>A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's “contributor version”.</p> + +<p>A contributor's “essential patent claims” are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License.</p> + +<p>Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version.</p> + +<p>In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party.</p> + +<p>If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid.</p> + +<p>If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it.</p> + +<p>A patent license is “discriminatory” if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007.</p> + +<p>Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law.</p> + +<h4><a name="section12"></a>12. No Surrender of Others' Freedom.</h4> + +<p>If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program.</p> + +<h4><a name="section13"></a>13. Use with the GNU Affero General Public License.</h4> + +<p>Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such.</p> + +<h4><a name="section14"></a>14. Revised Versions of this License.</h4> + +<p>The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns.</p> + +<p>Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License “or any later version” applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation.</p> + +<p>If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program.</p> + +<p>Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version.</p> + +<h4><a name="section15"></a>15. Disclaimer of Warranty.</h4> + +<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p> + +<h4><a name="section16"></a>16. Limitation of Liability.</h4> + +<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES.</p> + +<h4><a name="section17"></a>17. Interpretation of Sections 15 and 16.</h4> + +<p>If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee.</p> + +<p>END OF TERMS AND CONDITIONS</p> + +<h3><a name="howto"></a>How to Apply These Terms to Your New Programs</h3> + +<p>If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms.</p> + +<p>To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found.</p> + +<pre> <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. +</pre> + +<p>Also add information on how to contact you by electronic and paper mail.</p> + +<p>If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode:</p> + +<pre> <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. +</pre> + +<p>The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an “about box”.</p> + +<p>You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</p> + +<p>The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<<a href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>>.</p> + +<br><a href="index.html">Return</a></div> +</body></html> + diff --git a/QMidiPlayer/doc/license_internal.html b/QMidiPlayer/doc/license_internal.html new file mode 100644 index 0000000..b15245a --- /dev/null +++ b/QMidiPlayer/doc/license_internal.html @@ -0,0 +1,697 @@ + +<!DOCTYPE html> + +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>GNU General Public License v3.0 - GNU Project - Free Software Foundation (FSF)</title> + <link rel="alternate" type="application/rdf+xml" + href="http://www.gnu.org/licenses/gpl-3.0.rdf" /> +</head> +<body> +<h3 style="text-align: center;">GNU GENERAL PUBLIC LICENSE</h3> +<p style="text-align: center;">Version 3, 29 June 2007</p> + +<p>Copyright © 2007 Free Software Foundation, Inc. + <<a href="http://fsf.org/">http://fsf.org/</a>></p><p> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed.</p> + +<h3><a name="preamble"></a>Preamble</h3> + +<p>The GNU General Public License is a free, copyleft license for +software and other kinds of works.</p> + +<p>The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too.</p> + +<p>When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things.</p> + +<p>To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others.</p> + +<p>For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights.</p> + +<p>Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it.</p> + +<p>For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions.</p> + +<p>Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users.</p> + +<p>Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free.</p> + +<p>The precise terms and conditions for copying, distribution and +modification follow.</p> + +<h3><a name="terms"></a>TERMS AND CONDITIONS</h3> + +<h4><a name="section0"></a>0. Definitions.</h4> + +<p>“This License” refers to version 3 of the GNU General Public License.</p> + +<p>“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks.</p> + +<p>“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations.</p> + +<p>To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a “modified version” of the +earlier work or a work “based on” the earlier work.</p> + +<p>A “covered work” means either the unmodified Program or a work based +on the Program.</p> + +<p>To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well.</p> + +<p>To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying.</p> + +<p>An interactive user pinterface displays “Appropriate Legal Notices” +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the pinterface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion.</p> + +<h4><a name="section1"></a>1. Source Code.</h4> + +<p>The “source code” for a work means the preferred form of the work +for making modifications to it. “Object code” means any non-source +form of a work.</p> + +<p>A “Standard pinterface” means an pinterface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language.</p> + +<p>The “System Libraries” of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard pinterface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it.</p> + +<p>The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes pinterface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work.</p> + +<p>The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source.</p> + +<p>The Corresponding Source for a work in source code form is that +same work.</p> + +<h4><a name="section2"></a>2. Basic Permissions.</h4> + +<p>All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law.</p> + +<p>You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you.</p> + +<p>Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary.</p> + +<h4><a name="section3"></a>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4> + +<p>No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures.</p> + +<p>When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures.</p> + +<h4><a name="section4"></a>4. Conveying Verbatim Copies.</h4> + +<p>You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program.</p> + +<p>You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee.</p> + +<h4><a name="section5"></a>5. Conveying Modified Source Versions.</h4> + +<p>You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions:</p> + +<ul> +<li>a) The work must carry prominent notices stating that you modified + it, and giving a relevant date.</li> + +<li>b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + “keep intact all notices”.</li> + +<li>c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it.</li> + +<li>d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so.</li> +</ul> + +<p>A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate.</p> + +<h4><a name="section6"></a>6. Conveying Non-Source Forms.</h4> + +<p>You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways:</p> + +<ul> +<li>a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange.</li> + +<li>b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge.</li> + +<li>c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b.</li> + +<li>d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements.</li> + +<li>e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d.</li> +</ul> + +<p>A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work.</p> + +<p>A “User Product” is either (1) a “consumer product”, which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, “normally used” refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product.</p> + +<p>“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made.</p> + +<p>If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM).</p> + +<p>The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network.</p> + +<p>Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying.</p> + +<h4><a name="section7"></a>7. Additional Terms.</h4> + +<p>“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions.</p> + +<p>When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission.</p> + +<p>Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms:</p> + +<ul> +<li>a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or</li> + +<li>b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or</li> + +<li>c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or</li> + +<li>d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or</li> + +<li>e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or</li> + +<li>f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors.</li> +</ul> + +<p>All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying.</p> + +<p>If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms.</p> + +<p>Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way.</p> + +<h4><a name="section8"></a>8. Termination.</h4> + +<p>You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11).</p> + +<p>However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation.</p> + +<p>Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice.</p> + +<p>Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10.</p> + +<h4><a name="section9"></a>9. Acceptance Not Required for Having Copies.</h4> + +<p>You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so.</p> + +<h4><a name="section10"></a>10. Automatic Licensing of Downstream Recipients.</h4> + +<p>Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License.</p> + +<p>An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts.</p> + +<p>You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it.</p> + +<h4><a name="section11"></a>11. Patents.</h4> + +<p>A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's “contributor version”.</p> + +<p>A contributor's “essential patent claims” are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License.</p> + +<p>Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version.</p> + +<p>In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party.</p> + +<p>If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid.</p> + +<p>If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it.</p> + +<p>A patent license is “discriminatory” if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007.</p> + +<p>Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law.</p> + +<h4><a name="section12"></a>12. No Surrender of Others' Freedom.</h4> + +<p>If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program.</p> + +<h4><a name="section13"></a>13. Use with the GNU Affero General Public License.</h4> + +<p>Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such.</p> + +<h4><a name="section14"></a>14. Revised Versions of this License.</h4> + +<p>The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns.</p> + +<p>Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License “or any later version” applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation.</p> + +<p>If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program.</p> + +<p>Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version.</p> + +<h4><a name="section15"></a>15. Disclaimer of Warranty.</h4> + +<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p> + +<h4><a name="section16"></a>16. Limitation of Liability.</h4> + +<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES.</p> + +<h4><a name="section17"></a>17. Interpretation of Sections 15 and 16.</h4> + +<p>If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee.</p> + +<p>END OF TERMS AND CONDITIONS</p> + +<h3><a name="howto"></a>How to Apply These Terms to Your New Programs</h3> + +<p>If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms.</p> + +<p>To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found.</p> + +<pre> <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. +</pre> + +<p>Also add information on how to contact you by electronic and paper mail.</p> + +<p>If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode:</p> + +<pre> <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. +</pre> + +<p>The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI pinterface, you would use an “about box”.</p> + +<p>You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</p> + +<p>The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<<a href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>>.</p> + +<br><a href="index_internal.html">Return</a> +</body></html> + diff --git a/QMidiPlayer/doc/mainwindow.html b/QMidiPlayer/doc/mainwindow.html new file mode 100644 index 0000000..e576e7b --- /dev/null +++ b/QMidiPlayer/doc/mainwindow.html @@ -0,0 +1,59 @@ +<!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 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="plistdialog.html">Playlist</a></li> + <li><a href="efxdialog.html">Effects</a></li> + <li><a href="optionsdialog.html">Settings</a></li> + <li><a href="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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>Main Window</h1> + <img src="../img/mainw.png"><br> + <ul> + <li>1. Now playing. Right clicking here will bring up the <a href="#fileop"> file operation menu</a>.</li> + <li>2. Playing control slider. The total playing time is estimated and isn't 100% accurate.</li> + <li>3. Playing control buttons. Self-explanatory.</li> + <li>4. Settings button. Read the Settings section for details.</li> + <li>5. Dialog toggle buttons.</li> + <li>6. Master gain slider.</li> + <li>7. Polyphone indicator.</li> + <li>8. <s>It's me!</s></li> + </ul> + <h3><a name="fileop">File operation menu</a></h3> + <ul> + <li>File Information.<br> + Click an item in this dialog to copy its content. + </li> + <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.<br> + MIDI mapping does not apply to render results.</li> + <li>Panic.<br> + If somehow the player messed up, use this action to turn off all the notes. + <li>Restart fluidsynth.<br> + It's not possible to use this action unless the player is stopped.<br> + Applies settings and restart the internel fluidsynth engine when "single fluidsynth instance" + is enabled. + </li> + </ul> + <br><a href="index.html">Return</a> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/miscellaneous.html b/QMidiPlayer/doc/miscellaneous.html new file mode 100644 index 0000000..d8e90c3 --- /dev/null +++ b/QMidiPlayer/doc/miscellaneous.html @@ -0,0 +1,87 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a class="active" href="miscellaneous.html">Miscellaneous</a></li> + <li><a href="version.html">Version Info.</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div id="content"> + <ul> + <li><a href="#build">Building QMidiPlayer from source</a></li> + <li><a href="#ms">Roadmap/Milestones</a></li> + <li><a href="#faq">FAQs</a></li> + <li><a href="#contact">Contact the author</a></li> + </ul> + <h3 id="build">Building QMidiPlayer from source</h3> + Building QMidiPlayer from source is as easy as any other qmake projects.<br> + 1. Get the dependencies.<br> + Currently QMidiPlayer depends on these libraries:<br> + <pre style="background-color:#eee;padding:0.2em;">qt5, libfluidsynth(FluidSynth), librtmidi(RtMidi)</pre> + If you want to build the lite version as well, you need several QML core modules.<br> + Get the libraries for your platform, open the project with Qt Creator, configure and hit Build! + (You may also use the qmake-make way).<br> + Please note that QMidiPlayer <i>requires</i> C++11 to build. + <h3 id="ms">Roadmap/Milestones</h3> + <ul> + <li>0.5.x Basic functionality</li> + <li>0.6.x Settings and experimental Windows support</li> + <li>0.7.2 MIDI mapping, first stable version</li> + <li>0.7.8 Plugin interface, UI refactoring</li> + <li>0.8.x Visualization (the default visualization plugin).</li> + <li>0.8.5+ File reader plugin API, event filter/modifier API. </li> + <li>0.9.x API Stablization. Revive lite version.</li> + <li>1.x+ Translation, documentation, Maintaince only.</li> + </ul> + <h3 id="faq">FAQs</h3> + <h4>0. (Windows version) It complains about a missing dll!</h4> + <p> + Please download and install <a href="https://www.microsoft.com/en-us/download/details.aspx?id=48145"> + Visual Studio 2015 Runtime Library</a>. + </p> + <h4>1. Can I help translate this program?</h4> + <p> + Of course! Please make a pull request or contact me. + </p> + <h4>2. I have found a bug in this program. Where to report the bug?</h4> + <p> + Please use the <a href="https://github.com/chirs241097/QMidiPlayer/issues"> + github issue tracker</a>. Don't forget to check if the bug has already been + fixed in a newer version! + </p> + <h4>3. On what platform(s) do you develop this project?</h4> + <p> + Major platforms used: + <ul> + <li>Debian GNU/Linux unstable(sid) amd64 on custom machine (i7-2960XM, 16GB RAM, GTX960, X9SCV-QV4)</li> + <li>Arch Linux amd64 on a Lenovo ThinkPad X1 yoga 1st Gen. (i7-6600U, 16GB RAM, HD520)</li> + </ul> + Platforms for building the Windows version: + <ul> + <li>Windows 10 Insider Pro on the ThinkPad X1 yoga mentioned above.</li> + </ul> + </p> + <h3 id="contact">Contact the author</h3> + <p> + E-mail: chirs241097 'at' gmail 'dot' com<br> + Twitter: @chirs241097 + </p> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/optionsdialog.html b/QMidiPlayer/doc/optionsdialog.html new file mode 100644 index 0000000..d90cf45 --- /dev/null +++ b/QMidiPlayer/doc/optionsdialog.html @@ -0,0 +1,89 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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\<your user name>\.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. Increase if experiencing audio interruption, decrease if audio is laggy or messed up.</li> + <li>Audio Buffer Count**: Number of buffers used by the fluidsynth engine. Increase if experiencing audio interruption or messy audio, decrease if audio is laggy.</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. High polyphony limit may cause lags. </li> + <li>CPU Cores**: threads used by the internal synthesizer. Too many threads may result in instability.</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: Deprecated. Removing before 0.9.</li> + <li>Icon Theme: Leave it unchanged unless you can't see the icons on those buttons.</li> + <li>Customize toolbar: customize the functionalities shown in the main window.</li> + <li>Customize actions: customize the functionalities shown in the file action menu.</li> + </ul> + <img src="../img/options5.png"><br> + Plugin manager. View details of plugins, enable or disable them here.<br> + Enabled plugin list is applied after a restart.<br> + Plugin scanning follows the order below: + <ul> + <li>(*nix) /usr/lib/qmidiplayer</li> + <li>The folder containing QMidiPlayer's executable file.</li> + </ul> + <br><a href="index.html">Return</a> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/plistdialog.html b/QMidiPlayer/doc/plistdialog.html new file mode 100644 index 0000000..40ef542 --- /dev/null +++ b/QMidiPlayer/doc/plistdialog.html @@ -0,0 +1,36 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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 & 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/QMidiPlayer/doc/qmidiplayer b/QMidiPlayer/doc/qmidiplayer new file mode 100644 index 0000000..8dacdb1 --- /dev/null +++ b/QMidiPlayer/doc/qmidiplayer @@ -0,0 +1,15 @@ +.\" Manpage for qmidiplayer. +.TH man 1 "29 Dec 2016" "0.8.3" "qmidiplayer man page" +.SH NAME +qmidiplayer \- Plays midi file +.SH SYNOPSIS +qmidiplayer [Options] [Midi Files] +.SH DESCRIPTION +QMidiPlayer is a cross-platform midi file player based on libfluidsynth and Qt. +.SH OPTIONS +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. +.SH AUTHOR +Chris Xiong (chirs241097@gmail.com) diff --git a/QMidiPlayer/doc/styles.css b/QMidiPlayer/doc/styles.css new file mode 100644 index 0000000..dd149d9 --- /dev/null +++ b/QMidiPlayer/doc/styles.css @@ -0,0 +1,47 @@ +body { + font-family: 'FreeMono', 'Courier New', Courier, monospace; +} +#panel ul{ +padding:0; +} +#panel li a{ +display:block; +padding-left:1.5em; +padding-top:0.2em; +padding-bottom:0.2em; +list-style-type:none; +} +#panel li a.active { +background-color:#AEA; +} +#panel li a:hover:not(.active) { +background-color:#DED; +} +a:link { +color:#1194FF; +text-decoration:none; +} +a:visited { +color:#20ACFF; +text-decoration:none; +} +a:hover { +color:#3FBFFF; +text-decoration:none; +} +a:active { +color:#CCCCFF; +text-decoration:none; +} +#panel { +width:20%; +height:100%; +background-color:#EEE; +position:fixed; +top:0px; +left:0px; +overflow:auto; +} +#content { +margin-left:20%; +}
\ No newline at end of file diff --git a/QMidiPlayer/doc/troubleshooting.html b/QMidiPlayer/doc/troubleshooting.html new file mode 100644 index 0000000..b6b5a8d --- /dev/null +++ b/QMidiPlayer/doc/troubleshooting.html @@ -0,0 +1,71 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a class="active" href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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> + <h3>9. 3D visualization is upsidedown/rotated/black.</h3> + <p> + For those who see a rotated display, try setting Visualization-Video/Multisampling + to 1 or above. If that doesn't solve your problem or you see nothing at + all, please send me more details about your problem. + </p> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/version.html b/QMidiPlayer/doc/version.html new file mode 100644 index 0000000..d3b3218 --- /dev/null +++ b/QMidiPlayer/doc/version.html @@ -0,0 +1,36 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</a></li> + <li><a class="active" href="version.html">Version Info.</a></li> + <li><a href="license.html">License</a></li> + </ul> + </div> + <div id="content"> + <h1>Version information</h1> + <div style="text-align:center;"> + <img src="../img/qmidiplyr.png"><br> + QMidiPlayer documentation for version 0.8.5<br> + An MIDI player based on fluidsynth and Qt.<br> + Written by Chris Xiong.<br> + </div><br> + <a href="index.html">Return</a> + </div> +</body> +</html> diff --git a/QMidiPlayer/doc/version_internal.html b/QMidiPlayer/doc/version_internal.html new file mode 100644 index 0000000..ddd32c8 --- /dev/null +++ b/QMidiPlayer/doc/version_internal.html @@ -0,0 +1,20 @@ +<!DOCTYPE html> +<html> +<head> +<title>QMidiPlayer Help</title> +</head> +<body> + <h1>Version information</h1> + <div style="text-align:center;"> + <img src="../img/qmidiplyr.png"><br> + QMidiPlayer -- An MIDI player based on fluidsynth and Qt.<br> + Written by Chris Xiong.<br> + Version APP_VERSION<br> + Built at BUILD_DATE on BUILD_MACHINE<br> + libfluidsynth version: RT_FLUIDSYNTH_VERSION (Built against CT_FLUIDSYNTH_VERSION)<br> + Qt version: RT_QT_VERSION_STR (Built against CT_QT_VERSION_STR)<br> + </div><br> + <a href="index_internal.html">Return</a> + </td> +</body> +</html> diff --git a/QMidiPlayer/doc/visualization.html b/QMidiPlayer/doc/visualization.html new file mode 100644 index 0000000..f482744 --- /dev/null +++ b/QMidiPlayer/doc/visualization.html @@ -0,0 +1,97 @@ +<!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="visualization.html">Visualization</a></li> + <li><a href="cmdargs.html">Commandline arguments</a></li> + <li><a href="troubleshooting.html">Troubleshooting</a></li> + <li><a href="miscellaneous.html">Miscellaneous</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>Visualization</h1> + <img src="../img/visualizationss.png"><br> + The default visualization comes as a plugin of QMidiPlayer. So before using it you + have to enable it first in the plugin manager.<br> + To use the visualization, click the Visualization button in the main window.<br> + The visualization plugin adds two new option tabs. + <h3>Controls</h3> +<pre> + forward + | ↱Hold left mouse button and drag: + up | down ┌──┬──┐ Adjust viewport. + ↓ ↓ ↓ │ │ │ + Q W E R←reset viewport ├──┴──┤ + A S D │ │ + ↑ ↑ ↑ │ │ +left | right ← → │ │ + | Seek left/right └─────┘ + backward (Hold shift to seek 5% instead of 1%) +</pre> + <h3>Known problems</h3> + <p> + In some systems closing and reopening the visualization results in a crash. This is + due to a dbus-related conflict in SDL and Qt. + </p> + <h3>Options</h3> + The options listed here are applied after closing and reopening the visualization. + <ul> + <li> + Visualization-Appearance + <ul> + <li>Show Piano: Whether to show the virtual piano in the visualization scene. Currently drawing the piano is very expensive, so it is not recommended to enable this unless you have a beefy computer.</li> + <li>3D Notes: 2D notes are used when this is unchecked. Using 2D notes is less resource-hungry.</li> + <li>Arrange channels on a stair: If checked, virtual pianos will be arranged on a stair-like shape. This option has no effect if virtual piano is not shown.</li> + <li>Show channel labels: If checked, channel preset will be shown on the left side.</li> + <li>Show particles: Whether to draw particles. Very resource-intensive!</li> + <li>Horizontal Visualization: Uses a horizontal visualization style. Overrides everything above except 3D Notes.</li> + <li>2D Visualization: Tick this to use a simple 2D visualization instead. Much less resource-demanding.</li> + <li>Use spectrum instead of piano roll: Draw spectrum-like bars over the piano.</li> + <li>View distance: This option affects the maximum number of notes rendered on the screen. Only applies to the 3D visualization.</li> + <li>Note stretch: The length multiplier of notes.</li> + <li>Minimum note length: Avoid notes that are too short to be visible by adjusting this value.</li> + <li>Chequer board tint (AARRGGBB): change the color of the chequer board background.</li> + <li>Background Image: Use a background image instead of the default dull grey color.</li> + </ul> + </li> + <li> + Visualization-Video + <ul> + <li>Enable VSync: Enable vertical synchronization.</li> + <li>Save Viewport: Restore last camera configuration when the visualization is started.</li> + <li>Window Width/Height: Change the window size. If the size equals to your screen size, the visualization will start in fullscreen mode.</li> + <li>FPS: FPS limit of the visualization.</li> + <li>Supersampling: Supersample anti-aliasing. 1 means no SSAA.</li> + <li>Multisampling: Multisample anti-aliasing. 0 means no MSAA.</li> + <li>FOV: Field of view.</li> + <li>OSD Position: Change position of the on screen display, or simply disable it.</li> + <li>Font size: Change font size used by the visualization. Useful for HiDPI screens.</li> + </ul> + </li> + <li> + Key-only options<br> + Options listed here does not provide an entry in the option GUI. You have to add them to the configuration file manually if they don't exist in it. + <ul> + <li>px py pz rx ry rz (automatically created if save viewport is set to true): Doubles. Saves the last viewport. (px,py,pz): Position of the camera. (rx,ry,rz): Orientation of the camera.</li> + <li>chActiveColor<channel id 0..15> : Unsigned 32-bit integers. Colors of sounding notes.</li> + <li>chInactiveColor<channel id 0..15> : Unsigned 32-bit integers. Colors of normal notes.</li> + </ul> + </li> + </ul> + </div> +</body> +</html> |