Skip to content

Commit

Permalink
Update GenericDrum manual
Browse files Browse the repository at this point in the history
  • Loading branch information
ryukau committed Oct 20, 2023
1 parent 6900427 commit e40d75e
Show file tree
Hide file tree
Showing 8 changed files with 78 additions and 54 deletions.
81 changes: 40 additions & 41 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED True)

project(UhhyouPlugins
VERSION 0.57.0)
VERSION 0.58.0)

option(SMTG_ADD_VST3_HOSTING_SAMPLES OFF)
option(SMTG_ENABLE_VST3_PLUGIN_EXAMPLES OFF)
Expand All @@ -16,47 +16,46 @@ add_subdirectory(common)
add_subdirectory(lib/vst3sdk)
smtg_enable_vst3_sdk()

# add_subdirectory(AccumulativeRingMod)
# add_subdirectory(BasicLimiter)
# add_subdirectory(BasicLimiterAutoMake)
# add_subdirectory(ClangCymbal)
# add_subdirectory(ClangSynth)
# add_subdirectory(CollidingCombSynth)
# add_subdirectory(CombDistortion)
# add_subdirectory(CubicPadSynth)
# add_subdirectory(EnvelopedSine)
# add_subdirectory(EsPhaser)
# add_subdirectory(FDN64Reverb)
# add_subdirectory(FDNCymbal)
# add_subdirectory(FeedbackPhaser)
# add_subdirectory(FoldShaper)
add_subdirectory(AccumulativeRingMod)
add_subdirectory(BasicLimiter)
add_subdirectory(BasicLimiterAutoMake)
add_subdirectory(ClangCymbal)
add_subdirectory(ClangSynth)
add_subdirectory(CollidingCombSynth)
add_subdirectory(CombDistortion)
add_subdirectory(CubicPadSynth)
add_subdirectory(EnvelopedSine)
add_subdirectory(EsPhaser)
add_subdirectory(FDN64Reverb)
add_subdirectory(FDNCymbal)
add_subdirectory(FeedbackPhaser)
add_subdirectory(FoldShaper)
add_subdirectory(GenericDrum)

# add_subdirectory(IterativeSinCluster)
# add_subdirectory(L3Reverb)
# add_subdirectory(L4Reverb)
# add_subdirectory(LatticeReverb)
# add_subdirectory(LightPadSynth)
# add_subdirectory(LongPhaser)
# add_subdirectory(MatrixShifter)
# add_subdirectory(MaybeSnare)
# add_subdirectory(MembraneSynth)
# add_subdirectory(MiniCliffEQ)
# add_subdirectory(ModuloShaper)
# add_subdirectory(NarrowingDelay)
# add_subdirectory(OddPowShaper)
# add_subdirectory(OrdinaryPhaser)
# add_subdirectory(ParallelComb)
# add_subdirectory(ParallelDetune)
# add_subdirectory(PitchShiftDelay)
# add_subdirectory(RingModSpacer)
# add_subdirectory(SevenDelay)
# add_subdirectory(SoftClipper)
# add_subdirectory(SyncSawSynth)
# add_subdirectory(TrapezoidSynth)
# add_subdirectory(UltraSynth)
# add_subdirectory(UltrasonicRingMod)
# add_subdirectory(WaveCymbal)
add_subdirectory(IterativeSinCluster)
add_subdirectory(L3Reverb)
add_subdirectory(L4Reverb)
add_subdirectory(LatticeReverb)
add_subdirectory(LightPadSynth)
add_subdirectory(LongPhaser)
add_subdirectory(MatrixShifter)
add_subdirectory(MaybeSnare)
add_subdirectory(MembraneSynth)
add_subdirectory(MiniCliffEQ)
add_subdirectory(ModuloShaper)
add_subdirectory(NarrowingDelay)
add_subdirectory(OddPowShaper)
add_subdirectory(OrdinaryPhaser)
add_subdirectory(ParallelComb)
add_subdirectory(ParallelDetune)
add_subdirectory(PitchShiftDelay)
add_subdirectory(RingModSpacer)
add_subdirectory(SevenDelay)
add_subdirectory(SoftClipper)
add_subdirectory(SyncSawSynth)
add_subdirectory(TrapezoidSynth)
add_subdirectory(UltraSynth)
add_subdirectory(UltrasonicRingMod)
add_subdirectory(WaveCymbal)

# ## Below are prototype plugins. Breaking changes will be introduced.
# add_subdirectory(TestBedSynth)
Expand Down
Binary file modified GenericDrum/resource/97B971DA2A0E4E0B9B3F1278DC9BFB60_snapshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion GenericDrum/source/parameter.hpp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// (c) 2021-2023 Takamitsu Endo
// (c) 2023 Takamitsu Endo
//
// This file is part of GenericDrum.
//
Expand Down
9 changes: 9 additions & 0 deletions docs/manual/GenericDrum/GenericDrum.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,20 @@
"latest_version": "0.1.1",
"urls": {
"plugin_url": [
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.58.0/GenericDrum_0.1.1.zip",
"https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.57.0/GenericDrum_0.1.0.zip"
],
"preset_url": "https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.57.0/GenericDrumPresets.zip"
},
"changelog": {
"0.1.1": {
"en": [
"Added a button to randomize parameters."
],
"ja": [
"パラメータをランダム化するボタンを追加。"
]
},
"0.1.0": {
"en": [
"Initial release."
Expand Down
20 changes: 14 additions & 6 deletions docs/manual/GenericDrum/GenericDrum_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="2023-10-09" />
<meta name="dcterms.date" content="2023-10-20" />
<title>GenericDrum_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: 2023-10-09
Update: 2023-10-20
</p>
<details>
<summary translate="yes">Table of Contents</summary>
Expand Down Expand Up @@ -346,14 +346,14 @@ <h1 id="genericdrum">GenericDrum</h1>
but it’s not as good as more lower drum sounds.</p>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.57.0/GenericDrum_0.1.0.zip">Download
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.58.0/GenericDrum_0.1.1.zip">Download
GenericDrum 0.1.1 <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.57.0/GenericDrum_0.1.0_macOS.zip">Download
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.58.0/GenericDrum_0.1.1_macOS.zip">Download
GenericDrum 0.1.1 <code>macOS</code> - VST 3 (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
Expand Down Expand Up @@ -699,7 +699,7 @@ <h2 id="mechanism-overview">Mechanism Overview</h2>
sound is white noise followed by a lowpass. <code>Echo</code> can
imitate the clanking sound made by collisions between a drum and
something like a stand.</p>
<p>Wire is a part intended for the snare drum, and it collides only to
<p>Wire is a part intended for snare drums, and it collides only to
primary. It consists of delays connected in series.
<code>Collision Distance</code> controls the distance between wire and
primary. <code>Rattle-Squeak Mix</code> changes the texture of the
Expand Down Expand Up @@ -1119,13 +1119,21 @@ <h3 id="secondary-membrane">Secondary Membrane</h3>
</dl>
<h2 id="change-log">Change Log</h2>
<ul>
<li>0.1.1
<ul>
<li>Added a button to randomize parameters.</li>
</ul></li>
<li>0.1.0
<ul>
<li>Initial release.</li>
</ul></li>
</ul>
<h2 id="old-versions">Old Versions</h2>
<p>N/A.</p>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.57.0/GenericDrum_0.1.0.zip">GenericDrum
0.1.0 - VST 3 (github.com)</a></li>
</ul>
<h2 id="license">License</h2>
<p>GenericDrum is licensed under GPLv3. Complete licenses are linked
below.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/GenericDrum/GenericDrum_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To imitate the sound of a drum, it's better to start from a structure similar to

Drums produce sound by hitting a membrane with a hand or a stick. Impact section generates a noise that resembles the impact of a hit. The sound is white noise followed by a lowpass. `Echo` can imitate the clanking sound made by collisions between a drum and something like a stand.

Wire is a part intended for the snare drum, and it collides only to primary. It consists of delays connected in series. `Collision Distance` controls the distance between wire and primary. `Rattle-Squeak Mix` changes the texture of the collision. It can produce a sound similar to a cuíca, especially when the value is set closer to the squeak side (1.0), but there is no mechanism to control the rubbing.
Wire is a part intended for snare drums, and it collides only to primary. It consists of delays connected in series. `Collision Distance` controls the distance between wire and primary. `Rattle-Squeak Mix` changes the texture of the collision. It can produce a sound similar to a cuíca, especially when the value is set closer to the squeak side (1.0), but there is no mechanism to control the rubbing.

An impact hits both the primary and secondary membranes at the same time. This behavior is unrealistic, but makes a nice sound. One membrane consists of a feedback delay network (FDN). A bandpass filter is placed for each feedback path on the FDN. The texture of membranes can be changed by the combination of bandpass cutoff, bandpass Q, and delay times. In particular, lowering the Q produces a brighter sound.

Expand Down
18 changes: 13 additions & 5 deletions docs/manual/GenericDrum/GenericDrum_ja.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="2023-10-09" />
<meta name="dcterms.date" content="2023-10-20" />
<title>GenericDrum_ja</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: 2023-10-09
Update: 2023-10-20
</p>
<details>
<summary translate="yes">Table of Contents</summary>
Expand Down Expand Up @@ -342,14 +342,14 @@ <h1 id="genericdrum">GenericDrum</h1>
はディレイを使った汎用ドラムシンセサイザです。バスドラムやスネアドラムについては良い音が出ます。シンバルの音も出せますが、低いドラムの音ほど良くはありません。</p>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.57.0/GenericDrum_0.1.0.zip">GenericDrum
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.58.0/GenericDrum_0.1.1.zip">GenericDrum
0.1.1 <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.57.0/GenericDrum_0.1.0_macOS.zip">GenericDrum
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.58.0/GenericDrum_0.1.1_macOS.zip">GenericDrum
0.1.1 <code>macOS</code> - VST 3 をダウンロード (github.com)</a> <img
src="img/VST_Compatible_Logo_Steinberg_negative.svg"
alt="VST compatible logo."
Expand Down Expand Up @@ -1078,13 +1078,21 @@ <h3 id="secondary-membrane">Secondary Membrane</h3>
</dl>
<h2 id="チェンジログ">チェンジログ</h2>
<ul>
<li>0.1.1
<ul>
<li>パラメータをランダム化するボタンを追加。</li>
</ul></li>
<li>0.1.0
<ul>
<li>初期リリース。</li>
</ul></li>
</ul>
<h2 id="旧バージョン">旧バージョン</h2>
<p>旧バージョンはありません。</p>
<ul>
<li><a
href="https://github.com/ryukau/VSTPlugins/releases/download/UhhyouPlugins0.57.0/GenericDrum_0.1.0.zip">GenericDrum
0.1.0 - VST 3 (github.com)</a></li>
</ul>
<h2 id="ライセンス">ライセンス</h2>
<p>GenericDrum のライセンスは GPLv3 です。 GPLv3
の詳細と、利用したライブラリのライセンスは次のリンクにまとめています。</p>
Expand Down
Binary file modified docs/manual/GenericDrum/img/GenericDrum.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e40d75e

Please sign in to comment.