Skip to content

Commit

Permalink
Update manual
Browse files Browse the repository at this point in the history
  • Loading branch information
ryukau committed Dec 28, 2022
1 parent 5ae35b9 commit e23ce45
Show file tree
Hide file tree
Showing 72 changed files with 1,382 additions and 357 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,15 @@ Following plugins are experimental, or in α stage. They lack character and/or p
- Naive waveshapers with 16-fold oversampling.
- MatrixShifter
- AM frequency shifter and chorus in a plugin.

Following plugins are in β stage. They are almost finished, but lacking documentation.

- LongPhaser, OrdinaryPhaser
- Some phasers.
- CombDistortion
- Distiortion effect using self-modulating feedback comb filter.
- NarrowingDelay, ParallelDetune
- Some pitch shifters.

## Files and Directories
- `.github/workflows` and `ci`: Continuous integration (CI) scripts for GitHub Actions.
Expand Down
28 changes: 15 additions & 13 deletions docs/dev_note/vst3_dev.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<meta name="dcterms.date" content="2022-05-25" />
<meta name="dcterms.date" content="2022-12-28" />
<title>vst3_dev</title>
<style>
code { white-space: pre-wrap; }
Expand Down Expand Up @@ -262,7 +262,7 @@
<header>
<p><a href="..\index.html">Back to Index</a></p>
<p>
Update: 2022-05-25
Update: 2022-12-28
</p>
<details>
<summary translate="yes">Table of Contents</summary>
Expand Down Expand Up @@ -638,11 +638,16 @@ <h2 id="ビルド">ビルド</h2>
<li><a href="https://github.com/steinbergmedia/vst3sdk">GitHub -
steinbergmedia/vst3sdk: VST 3 Plug-In SDK</a></li>
<li><a
href="https://steinbergmedia.github.io/vst3_doc/vstinterfaces/cmakeUse.html">VST
3 Interfaces: How to use cmake for Building VST 3 Plug-ins</a></li>
href="https://steinbergmedia.github.io/vst3_dev_portal/pages/Tutorials/Using+cmake+for+building+plug-ins.html">Using
cmake for building VST 3 plug-ins - VST 3 Developer Portal</a></li>
</ul>
<p>新規プラグインの作り方は変わったようです (2022-12-28)
。以下のドキュメンテーションについては検証していません。</p>
<ul>
<li><a
href="https://steinbergmedia.github.io/vst3_doc/vstinterfaces/addownplugs.html">VST
3 Interfaces: How to add/create your own VST 3 Plug-ins</a></li>
href="https://steinbergmedia.github.io/vst3_dev_portal/pages/Tutorials/Generate+new+plug-in+with+Project+Generator.html">Generate
a new plug-in with the Project Generator App - VST 3 Developer
Portal</a></li>
</ul>
<h3 id="windows-10-1">Windows 10</h3>
<p><code>my_plugins/helloworld</code>
Expand Down Expand Up @@ -717,8 +722,8 @@ <h4 id="デプロイ">デプロイ</h4>
という名前のディレクトリにパッケージされています。</p>
<p>VST 3 プラグインは OS
ごとにインストールする場所が決まっています。詳細は <a
href="https://steinbergmedia.github.io/vst3_doc/vstinterfaces/vst3loc.html">VST
3 Interfaces: VST 3 Locations / Format</a> に書いてあります。 Windows 10
href="https://steinbergmedia.github.io/vst3_dev_portal/pages/Technical+Documentation/Locations+Format/Plugin+Locations.html">Plug-in
Locations - VST 3 Developer Portal</a> に書いてあります。 Windows 10
では <code>C:\Program Files\Common Files\VST3</code>
に配置すれば使えるようになります。</p>
<p>PowerShell
Expand Down Expand Up @@ -799,9 +804,6 @@ <h4 id="コンパイラオプションの変更">コンパイラオプション
<span id="cb18-14"><a href="#cb18-14" aria-hidden="true" tabindex="-1"></a> <span class="kw">target_compile_options</span>(<span class="dv">${target}</span> <span class="bn">PRIVATE</span> -O3 -fPIC -mfma -mavx2)</span>
<span id="cb18-15"><a href="#cb18-15" aria-hidden="true" tabindex="-1"></a> <span class="kw">endif</span>()</span>
<span id="cb18-16"><a href="#cb18-16" aria-hidden="true" tabindex="-1"></a><span class="kw">endif</span>()</span></code></pre></div>
<p>VST 3 SDK のコンパイラオプションは <a
href="https://github.com/steinbergmedia/vst3_cmake/blob/master/modules/PlatformToolset.cmake"><code>cmake/modules/PlatformToolset.cmake</code></a>
で指定されています。</p>
<h2 id="テスト">テスト</h2>
<p>ビルドを終えたらプラグインの動作をテストします。</p>
<h3 id="自動テスト">自動テスト</h3>
Expand Down Expand Up @@ -1603,8 +1605,8 @@ <h4 id="カスタムフォント">カスタムフォント</h4>
<ul>
<li><p>TODO 実装の追加</p></li>
<li><p><a
href="https://steinbergmedia.github.io/vst3_doc/vstinterfaces/vst3Automation.html#vst3automationPlayback">VST
3 Interfaces: Parameters and Automation</a></p></li>
href="https://steinbergmedia.github.io/vst3_dev_portal/pages/Technical+Documentation/Parameters+Automation/Index.html">Parameters
and Automation - VST 3 Developer Portal</a></p></li>
<li><p><a
href="https://sdk.steinberg.net/viewtopic.php?f=4&amp;t=714">Clarification
of parameter handling in VST 3 - sdk.steinberg.net</a></p></li>
Expand Down
13 changes: 7 additions & 6 deletions docs/dev_note/vst3_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,11 @@ rg -h
ビルド方法はドキュメンテーションと vst3sdk リポジトリの README.md に書いてあります。

- [GitHub - steinbergmedia/vst3sdk: VST 3 Plug-In SDK](https://github.com/steinbergmedia/vst3sdk)
- [VST 3 Interfaces: How to use cmake for Building VST 3 Plug-ins](https://steinbergmedia.github.io/vst3_doc/vstinterfaces/cmakeUse.html)
- [VST 3 Interfaces: How to add/create your own VST 3 Plug-ins](https://steinbergmedia.github.io/vst3_doc/vstinterfaces/addownplugs.html)
- [Using cmake for building VST 3 plug-ins - VST 3 Developer Portal](https://steinbergmedia.github.io/vst3_dev_portal/pages/Tutorials/Using+cmake+for+building+plug-ins.html)

新規プラグインの作り方は変わったようです (2022-12-28) 。以下のドキュメンテーションについては検証していません。

- [Generate a new plug-in with the Project Generator App - VST 3 Developer Portal](https://steinbergmedia.github.io/vst3_dev_portal/pages/Tutorials/Generate+new+plug-in+with+Project+Generator.html)

### Windows 10
`my_plugins/helloworld` にテンプレートが入っているのでコピーして適当に名前を付けることでプロジェクトを作成します。 `my_plugins` は `VST3_SDK` の1階層上のディレクトリに入っています。
Expand Down Expand Up @@ -237,7 +240,7 @@ cmake --build .
#### デプロイ
VST 3 プラグインのデバッグビルドは `build\VST3\Debug` 、リリースビルドは `build\VST3\Release` に配置されます。ビルドされたプラグインは `*.vst3` という名前のディレクトリにパッケージされています。

VST 3 プラグインは OS ごとにインストールする場所が決まっています。詳細は [VST 3 Interfaces: VST 3 Locations / Format](https://steinbergmedia.github.io/vst3_doc/vstinterfaces/vst3loc.html) に書いてあります。 Windows 10 では `C:\Program Files\Common Files\VST3` に配置すれば使えるようになります。
VST 3 プラグインは OS ごとにインストールする場所が決まっています。詳細は [Plug-in Locations - VST 3 Developer Portal](https://steinbergmedia.github.io/vst3_dev_portal/pages/Technical+Documentation/Locations+Format/Plugin+Locations.html) に書いてあります。 Windows 10 では `C:\Program Files\Common Files\VST3` に配置すれば使えるようになります。

PowerShell で関数を作って任意のプラグインをコマンド一つでデプロイできるようにします。 `$PROFILE` を開きます。 `$PROFILE` は bash の `.bashrc` に相当します。

Expand Down Expand Up @@ -319,8 +322,6 @@ elseif(UNIX)
endif()
```

VST 3 SDK のコンパイラオプションは [`cmake/modules/PlatformToolset.cmake`](https://github.com/steinbergmedia/vst3_cmake/blob/master/modules/PlatformToolset.cmake) で指定されています。

## テスト
ビルドを終えたらプラグインの動作をテストします。

Expand Down Expand Up @@ -1093,7 +1094,7 @@ SharedPointer<CFontDesc> font = new CFontDesc(

- TODO 実装の追加

- [VST 3 Interfaces: Parameters and Automation](https://steinbergmedia.github.io/vst3_doc/vstinterfaces/vst3Automation.html#vst3automationPlayback)
- [Parameters and Automation - VST 3 Developer Portal](https://steinbergmedia.github.io/vst3_dev_portal/pages/Technical+Documentation/Parameters+Automation/Index.html)
- [Clarification of parameter handling in VST 3 - sdk.steinberg.net](https://sdk.steinberg.net/viewtopic.php?f=4&t=714)

#### リフレッシュレートの設定
Expand Down
22 changes: 20 additions & 2 deletions docs/manual/BasicLimiter/BasicLimiter.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"BasicLimiter": {
"latest_version": "0.1.12",
"latest_version": "0.1.13",
"urls": {
"plugin_url": [
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.51.0/BasicLimiter_0.1.13.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiter_0.1.12.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.46.0/BasicLimiter_0.1.11.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.45.0/BasicLimiter_0.1.10.zip",
Expand All @@ -16,6 +17,14 @@
"preset_url": "https://github.com/ryukau/VSTPlugins/releases/download/BasicLimiterAndFDN64Reverb/BasicLimiterPresets.zip"
},
"changelog": {
"0.1.13": {
"en": [
"Added floor shortcut to number sliders. Shortcut is <kbd>Shift</kbd> + <kbd>Middle Click</kbd>."
],
"ja": [
"数値スライダに <kbd>Shift</kbd> + <kbd>ホイールクリック</kbd> による値の切り捨てのショートカットを追加。"
]
},
"0.1.12": {
"en": [
"Added to `virtual` to destructor of common components. This may prevent some cause of crash or memory leak."
Expand Down Expand Up @@ -101,9 +110,10 @@
}
},
"BasicLimiterAutoMake": {
"latest_version": "0.1.12",
"latest_version": "0.1.13",
"urls": {
"plugin_url": [
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.51.0/BasicLimiterAutoMake_0.1.13.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiterAutoMake_0.1.12.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.46.0/BasicLimiterAutoMake_0.1.11.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.45.0/BasicLimiterAutoMake_0.1.10.zip",
Expand All @@ -116,6 +126,14 @@
"preset_url": ""
},
"changelog": {
"0.1.13": {
"en": [
"Added floor shortcut to number sliders. Shortcut is <kbd>Shift</kbd> + <kbd>Middle Click</kbd>."
],
"ja": [
"数値スライダに <kbd>Shift</kbd> + <kbd>ホイールクリック</kbd> による値の切り捨てのショートカットを追加。"
]
},
"0.1.12": {
"en": [
"Added to `virtual` to destructor of common components. This may prevent some cause of crash or memory leak."
Expand Down
42 changes: 32 additions & 10 deletions docs/manual/BasicLimiter/BasicLimiter_en.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<meta name="dcterms.date" content="2022-12-19" />
<meta name="dcterms.date" content="2022-12-28" />
<title>BasicLimiter_en</title>
<style>
code { white-space: pre-wrap; }
Expand Down Expand Up @@ -262,7 +262,7 @@
<header>
<p><a href="..\..\index.html">Back to Index</a></p>
<p>
Update: 2022-12-19
Update: 2022-12-28
</p>
<details>
<summary translate="yes">Table of Contents</summary>
Expand Down Expand Up @@ -336,15 +336,15 @@ <h1 id="basiclimiter">BasicLimiter</h1>
new, but the design of true peak mode is a bit luxurious.</p>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiter_0.1.12.zip">Download
BasicLimiter 0.1.12 <code>full</code> - VST 3 (github.com)</a> <img
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.51.0/BasicLimiter_0.1.13.zip">Download
BasicLimiter 0.1.13 <code>full</code> - VST 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="30px"
style="display: inline-block; vertical-align: middle;"></li>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiter_0.1.12_macOS.zip">Download
BasicLimiter 0.1.12 <code>macOS</code> - VST 3 (github.com)</a> <img
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.51.0/BasicLimiter_0.1.13_macOS.zip">Download
BasicLimiter 0.1.13 <code>macOS</code> - VST 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="30px"
Expand All @@ -359,15 +359,15 @@ <h1 id="basiclimiter">BasicLimiter</h1>
times heavier than BasicLimiter.</p>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiterAutoMake_0.1.12.zip">Download
BasicLimiterAutoMake 0.1.12 full - VST 3 (github.com)</a> <img
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.51.0/BasicLimiterAutoMake_0.1.13.zip">Download
BasicLimiterAutoMake 0.1.13 full - VST 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="30px"
style="display: inline-block; vertical-align: middle;"></li>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiterAutoMake_0.1.12_macOS.zip">Download
BasicLimiterAutoMake 0.1.12 macOS - VST 3 (github.com)</a> <img
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.51.0/BasicLimiterAutoMake_0.1.13_macOS.zip">Download
BasicLimiterAutoMake 0.1.13 macOS - VST 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
width="30px"
Expand Down Expand Up @@ -631,6 +631,12 @@ <h2 id="controls">Controls</h2>
<li><kbd>Shift</kbd> + <kbd>Left Drag</kbd>: Fine adjustment.</li>
<li><kbd>Middle Click</kbd> : Rotate through minimum, default and
maximum value.</li>
<li><kbd>Shift</kbd> + <kbd>Middle Click</kbd> : Take floor of current
value.
<ul>
<li><strong>Note</strong>: For decibel (<code>dB</code>) parameters,
floor is applied after the value is converted to amplitude.</li>
</ul></li>
</ul>
<h2 id="caution">Caution</h2>
<p>The algorithm used in BasicLimiter causes over-limiting when input
Expand Down Expand Up @@ -777,6 +783,11 @@ <h3 id="basiclimiterautomake-specific-parameters">BasicLimiterAutoMake
<h2 id="change-log">Change Log</h2>
<h3 id="basiclimiter-1">BasicLimiter</h3>
<ul>
<li>0.1.13
<ul>
<li>Added floor shortcut to number sliders. Shortcut is <kbd>Shift</kbd>
+ <kbd>Middle Click</kbd>.</li>
</ul></li>
<li>0.1.12
<ul>
<li>Added to <code>virtual</code> to destructor of common components.
Expand Down Expand Up @@ -827,6 +838,11 @@ <h3 id="basiclimiter-1">BasicLimiter</h3>
</ul>
<h3 id="basiclimiterautomake">BasicLimiterAutoMake</h3>
<ul>
<li>0.1.13
<ul>
<li>Added floor shortcut to number sliders. Shortcut is <kbd>Shift</kbd>
+ <kbd>Middle Click</kbd>.</li>
</ul></li>
<li>0.1.12
<ul>
<li>Added to <code>virtual</code> to destructor of common components.
Expand Down Expand Up @@ -876,6 +892,9 @@ <h2 id="old-versions">Old Versions</h2>
<h3 id="basiclimiter-2">BasicLimiter</h3>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiter_0.1.12.zip">BasicLimiter
0.1.12 - VST 3 (github.com)</a></li>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.46.0/BasicLimiter_0.1.11.zip">BasicLimiter
0.1.11 - VST 3 (github.com)</a></li>
<li><a
Expand Down Expand Up @@ -903,6 +922,9 @@ <h3 id="basiclimiter-2">BasicLimiter</h3>
<h3 id="basiclimiterautomake-1">BasicLimiterAutoMake</h3>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.50.0/BasicLimiterAutoMake_0.1.12.zip">BasicLimiterAutoMake
0.1.12 - VST 3 (github.com)</a></li>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.46.0/BasicLimiterAutoMake_0.1.11.zip">BasicLimiterAutoMake
0.1.11 - VST 3 (github.com)</a></li>
<li><a
Expand Down
Loading

0 comments on commit e23ce45

Please sign in to comment.