Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ryukau committed Dec 11, 2019
1 parent efc7eb8 commit 91efdd0
Show file tree
Hide file tree
Showing 29 changed files with 2,237 additions and 734 deletions.
1,477 changes: 759 additions & 718 deletions docs/dev_note/vst3_dev.html

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@
<li><a href="#uhhyou-plugins">Uhhyou Plugins</a></li>
<li><a href="#lv2-plugins">LV2 Plugins</a></li>
<li><a href="#パッケージについて-about-packages">パッケージについて | About Packages</a><ul>
<li><a href="#iterativesincluster">IterativeSinCluster</a></li>
<li><a href="#trapezoidsynth">TrapezoidSynth</a></li>
<li><a href="#fdncymbal">FDNCymbal</a></li>
<li><a href="#wavecymbal">WaveCymbal</a></li>
Expand All @@ -165,6 +166,10 @@ <h1 id="uhhyou-plugins">Uhhyou Plugins</h1>
<p>This page is publishing <a href="#vst_logo">VST®</a> 3 plugins.</p>
<p>If you found some part of manual is not clear and/or found typo, please file issue at <a href="https://github.com/ryukau/VSTPlugins">GitHub repository</a> or send email to <code>[email protected]</code>. Note that I’m not native in English and it’s most likely that the manual contains some weird sentences. I’d like to fix it, so feel free to report those issues.</p>
<h1 id="lv2-plugins">LV2 Plugins</h1>
<p>Linux 向けに LV2 版のプラグインもあります。</p>
<ul>
<li><a href="https://github.com/ryukau/LV2Plugins">GitHub - ryukau/LV2Plugins</a></li>
</ul>
<p>For Linux, LV2 version is available.</p>
<ul>
<li><a href="https://github.com/ryukau/LV2Plugins">GitHub - ryukau/LV2Plugins</a></li>
Expand All @@ -190,6 +195,9 @@ <h1 id="パッケージについて-about-packages">パッケージについて
<p>Windows build is tested on FL Studio.</p>
<p>macOS build isn’t tested because I don’t have Mac. If you found a bug, please file a issue to <a href="https://github.com/ryukau/VSTPlugins">GitHub repository</a>.</p>
<p>Linux build is built on Ubuntu 18.0.4 and tested on Bitwig 3.0.3 and Reaper 5.983. Both seems to have problem to display GUI, therefore GUI is currently disabled for Linux build.</p>
<h2 id="iterativesincluster">IterativeSinCluster</h2>
<p><img src="manual/IterativeSinCluster/img/iterativesincluster.png" /></p>
<p>IterativeSinCluster はノート 1 つあたりで 512 のサイン波を計算する加算合成シンセサイザです。このページで配布しているバイナリを利用するには AVX2 をサポートしている CPU が必要です。</p>
<h2 id="trapezoidsynth">TrapezoidSynth</h2>
<p><img src="manual/TrapezoidSynth/img/trapezoidsynth.png" /></p>
<p>TrapezoidSynth は 4 つの PTR ランプ関数を継ぎ接ぎした台形オシレータを使ったモノフォニックシンセサイザです。継ぎ接ぎしたのが仇をなしてピッチが高くなるとノイズが乗る欠点があったので8倍にオーバーサンプリングしました。結果としてやたら重たくなっています。</p>
Expand Down
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ This page is publishing [VST®](#vst_logo) 3 plugins.
If you found some part of manual is not clear and/or found typo, please file issue at [GitHub repository](https://github.com/ryukau/VSTPlugins) or send email to `[email protected]`. Note that I'm not native in English and it's most likely that the manual contains some weird sentences. I'd like to fix it, so feel free to report those issues.

# LV2 Plugins
Linux 向けに LV2 版のプラグインもあります。

- [GitHub - ryukau/LV2Plugins](https://github.com/ryukau/LV2Plugins)

For Linux, LV2 version is available.

- [GitHub - ryukau/LV2Plugins](https://github.com/ryukau/LV2Plugins)
Expand Down Expand Up @@ -41,6 +45,11 @@ macOS build isn't tested because I don't have Mac. If you found a bug, please fi

Linux build is built on Ubuntu 18.0.4 and tested on Bitwig 3.0.3 and Reaper 5.983. Both seems to have problem to display GUI, therefore GUI is currently disabled for Linux build.

## IterativeSinCluster
![](manual/IterativeSinCluster/img/iterativesincluster.png)

IterativeSinCluster はノート 1 つあたりで 512 のサイン波を計算する加算合成シンセサイザです。このページで配布しているバイナリを利用するには AVX2 をサポートしている CPU が必要です。

## TrapezoidSynth
![](manual/TrapezoidSynth/img/trapezoidsynth.png)

Expand Down
9 changes: 8 additions & 1 deletion docs/manual/FDNCymbal/FDNCymbal_en.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h1 id="fdncymbal">FDNCymbal</h1>
<p><img src="img/fdncymbal.png" /></p>
<p>FDNCymbal is a cymbal sound synthesizer. It can also be used as an effect. Unlike the name, most of metallic texture comes from Schroeder allpass section rather than FDN (feedback delay network). FDN section makes nice impact sound when <code>FDN.Time</code> is short. Tremolo is added to simulate wobbling of cymbal.</p>
<ul>
<li><a href="https://github.com/ryukau/VSTPlugins/releases/download/MidiNoteTriggerFix/FDNCymbal0.1.1.zip">Download FDNCymbal 0.1.1 - VST® 3 (github.com)</a> <img
<li><a href="https://github.com/ryukau/VSTPlugins/releases/download/IterativeSinCluster0.1.0/FDNCymbal0.1.2.zip">Download FDNCymbal 0.1.2 - VST® 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="60px"
Expand Down Expand Up @@ -385,6 +385,13 @@ <h4 id="time-2">Time</h4>
<p>Amount of randomization to <code>Tremolo.DelayTime</code> for each note on.</p>
<h2 id="change-log">Change Log</h2>
<ul>
<li>0.1.2
<ul>
<li>Added support for synchronization between multiple GUI instances.</li>
<li>Fixed a bug that opening splash screen causes crash.</li>
<li>Fixed a bug that crash plugin when reloading.</li>
<li>Fixed GUI to follow host automation.</li>
</ul></li>
<li>0.1.1
<ul>
<li>Fixed note on/off event to be triggered at exact timing.</li>
Expand Down
7 changes: 6 additions & 1 deletion docs/manual/FDNCymbal/FDNCymbal_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

FDNCymbal is a cymbal sound synthesizer. It can also be used as an effect. Unlike the name, most of metallic texture comes from Schroeder allpass section rather than FDN (feedback delay network). FDN section makes nice impact sound when `FDN.Time` is short. Tremolo is added to simulate wobbling of cymbal.

- [Download FDNCymbal 0.1.1 - VST® 3 (github.com)](https://github.com/ryukau/VSTPlugins/releases/download/MidiNoteTriggerFix/FDNCymbal0.1.1.zip) <img
- [Download FDNCymbal 0.1.2 - VST® 3 (github.com)](https://github.com/ryukau/VSTPlugins/releases/download/IterativeSinCluster0.1.0/FDNCymbal0.1.2.zip) <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="60px"
Expand Down Expand Up @@ -154,6 +154,11 @@ Amount of randomization to `Tremolo.Frequency` for each note on.
Amount of randomization to `Tremolo.DelayTime` for each note on.

## Change Log
- 0.1.2
- Added support for synchronization between multiple GUI instances.
- Fixed a bug that opening splash screen causes crash.
- Fixed a bug that crash plugin when reloading.
- Fixed GUI to follow host automation.
- 0.1.1
- Fixed note on/off event to be triggered at exact timing.
- Fixed a bug that `Allpass.Stage1.Feedback` was disabled.
Expand Down
9 changes: 8 additions & 1 deletion docs/manual/FDNCymbal/FDNCymbal_ja.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h1 id="fdncymbal">FDNCymbal</h1>
<p><img src="img/fdncymbal.png" /></p>
<p><ruby>FDNCymbal<rt>エフディーエヌシンバル</rt></ruby> はシンバルのような音を合成するシンセサイザです。エフェクトとして使うこともできます。名前とは裏腹に金属的な質感は FDN (feedback delay network) ではなく Schroeder allpass section によって得られています。 <code>FDN.Time</code> の値を小さくすることで、わりとナイスなばちの衝突音が合成できます。シンバルの揺れをシミュレートするためにトレモロもついています。</p>
<ul>
<li><a href="https://github.com/ryukau/VSTPlugins/releases/download/MidiNoteTriggerFix/FDNCymbal0.1.1.zip">FDNCymbal 0.1.1 をダウンロード - VST® 3 (github.com)</a> <img
<li><a href="https://github.com/ryukau/VSTPlugins/releases/download/IterativeSinCluster0.1.0/FDNCymbal0.1.2.zip">FDNCymbal 0.1.2 をダウンロード - VST® 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="60px"
Expand Down Expand Up @@ -385,6 +385,13 @@ <h4 id="time-2">Time</h4>
<p>ノートオンのたびに <code>Tremolo.DelayTime</code> をランダマイズする度合いです。</p>
<h2 id="チェンジログ">チェンジログ</h2>
<ul>
<li>0.1.2
<ul>
<li>複数の GUI インスタンス間で表示を同期するように変更。</li>
<li>スプラッシュスクリーンを開くとクラッシュするバグを修正。</li>
<li>リロード時にクラッシュするバグを修正。</li>
<li>GUI がホストのオートメーションに応じて更新されるように修正。</li>
</ul></li>
<li>0.1.1
<ul>
<li>ノートオン・オフが正確なタイミングでトリガされるように修正。</li>
Expand Down
7 changes: 6 additions & 1 deletion docs/manual/FDNCymbal/FDNCymbal_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<ruby>FDNCymbal<rt>エフディーエヌシンバル</rt></ruby> はシンバルのような音を合成するシンセサイザです。エフェクトとして使うこともできます。名前とは裏腹に金属的な質感は FDN (feedback delay network) ではなく Schroeder allpass section によって得られています。 `FDN.Time` の値を小さくすることで、わりとナイスなばちの衝突音が合成できます。シンバルの揺れをシミュレートするためにトレモロもついています。

- [FDNCymbal 0.1.1 をダウンロード - VST® 3 (github.com)](https://github.com/ryukau/VSTPlugins/releases/download/MidiNoteTriggerFix/FDNCymbal0.1.1.zip) <img
- [FDNCymbal 0.1.2 をダウンロード - VST® 3 (github.com)](https://github.com/ryukau/VSTPlugins/releases/download/IterativeSinCluster0.1.0/FDNCymbal0.1.2.zip) <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="60px"
Expand Down Expand Up @@ -154,6 +154,11 @@ LFO によって変化するディレイ時間の最大値です。シンバル
ノートオンのたびに `Tremolo.DelayTime` をランダマイズする度合いです。

## チェンジログ
- 0.1.2
- 複数の GUI インスタンス間で表示を同期するように変更。
- スプラッシュスクリーンを開くとクラッシュするバグを修正。
- リロード時にクラッシュするバグを修正。
- GUI がホストのオートメーションに応じて更新されるように修正。
- 0.1.1
- ノートオン・オフが正確なタイミングでトリガされるように修正。
- `Allpass.Stage1.Feedback` が無効になっていたバグを修正。
Expand Down
Loading

0 comments on commit 91efdd0

Please sign in to comment.