Browse Source

Update docs

Signed-off-by: falkTX <falktx@falktx.com>
tags/22.05
falkTX 3 years ago
parent
commit
c4b53659f7
Signed by: falkTX <falktx@falktx.com> GPG Key ID: CDBAA37ABC74FBA0
6 changed files with 25 additions and 5 deletions
  1. +5
    -5
      README.md
  2. +19
    -0
      docs/CARDINAL-MODULES.md
  3. +1
    -0
      docs/DIFFERENCES.md
  4. BIN
      docs/Module_AudioToCVPitch.png
  5. BIN
      docs/Screenshot_Fundamental.png
  6. BIN
      docs/Screenshot_Init-Patch.png

+ 5
- 5
README.md View File

@@ -86,10 +86,6 @@ Plugin type is set as regular "effect".
Because people will ask for it. It is, well... Rack.
But a couple of modules background's have their colors flipped, because damn we want proper dark mode!

### Init / Default patch

![screenshot](docs/Screenshot_Init-Patch.png "Screenshot")

### Module browser

![screenshot](docs/Screenshot_Module-Browser.png "Screenshot")
@@ -102,6 +98,10 @@ But a couple of modules background's have their colors flipped, because damn we

![screenshot](docs/Screenshot_Carla+Ildaeil.png "Screenshot")

### Custom Fundamental modules design

![screenshot](docs/Screenshot_Fundamental.png "Screenshot")


## Included modules

@@ -169,7 +169,7 @@ At the moment the following 3rd-party modules are provided:
- ZetaCarinae
- ZZC

Additionally Cardinal provides its own modules for DAW/Host automation, time position and internal plugin hosting.
Additionally Cardinal provides its own modules for DAW/Host automation, time position, audio to CV pitch conversion and internal plugin hosting.

### Adding modules



+ 19
- 0
docs/CARDINAL-MODULES.md View File

@@ -20,6 +20,25 @@ Even though this player plugin can loop files, it is not an audio looper.
Audio can loop back to the beginning if enabled, but it does not resample or pitch-shift to fit the host BPM.
The audio files are played back as-is, with resampling only done when needed to match the host sample rate.

### Audio To CV Pitch

![screenshot](Module_AudioToCVPitch.png)

The Audio To CV Pitch module is a tool that turns your audio signal into CV pitch and CV gate signals.
This allows audio from instruments (such as guitars) to play and control synth sounds and effects.

It detects the pitch in your incoming audio signal and outputs a 1V/Oct CV pitch signal on the "Pitch Out" CV port.
The "Gate" CV port sends out 10V while a pitch is detected, and resets to 0V when the pitch can no longer be detected.

There is an Octave right-click option that allows you to shift the detected pitch up or down by a maximum of 4 octaves.
When set to 0, it will output the same pitch as is detected on the input.

Then the "Hold Output Pitch" right-click option sets whether the plugin resets its outputs to 0, or holds the last detected pitch.

The Sensitivity parameter can be increased to detect quieter signals, or decreased to reduce artifacts.
The Confidence Threshold can be increased to make sure the correct pitch is being output, or decrease it to get a faster response time.
And finally, the Tolerance parameter influences how quickly you can change pitch, turn it down for a more accurate pitch output, or turn it up to make it easier to jump from one pitch to the next.

### Carla

![screenshot](Module_Carla.png)


+ 1
- 0
docs/DIFFERENCES.md View File

@@ -48,6 +48,7 @@ Additionally, Cardinal contains the following built-in modules not present in th
* mscHack (never updated to v2)
* rackwindows
* Audio File
* Audio to CV Pitch converter
* Carla Plugin Host
* Ildaeil Host
* glBars (OpenGL bars visualization, as seen in XMMS and XBMC/Kodi)


BIN
docs/Module_AudioToCVPitch.png View File

Before After
Width: 260  |  Height: 760  |  Size: 64KB

BIN
docs/Screenshot_Fundamental.png View File

Before After
Width: 2889  |  Height: 1684  |  Size: 1.1MB

BIN
docs/Screenshot_Init-Patch.png View File

Before After
Width: 1276  |  Height: 734  |  Size: 120KB

Loading…
Cancel
Save