diff --git a/docs/CARDINAL-MODULES.md b/docs/CARDINAL-MODULES.md index 31ed1fe..eff17ca 100644 --- a/docs/CARDINAL-MODULES.md +++ b/docs/CARDINAL-MODULES.md @@ -6,20 +6,24 @@ This file contains documentation for the DISTRHO Cardinal modules. ### Audio File +![screenshot](Module_AudioFile.png) + This is a simple audio file player plugin. You can load files by using right-click menu options. -Transport is rolling as long as the plugin is enabled and a file has been loaded. +Transport is rolling as long as the plugin is enabled and a file has been loaded. You can also sync to host transport, which will play in frame-perfect sync, useful if you need a few loops playing together. Files are streamed from disk if longer than 30 seconds in length, otherwise loaded entirely on RAM. -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. +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. ### Carla +![screenshot](Module_Carla.png) + [Carla](https://kx.studio/Applications:Carla) is a fully-featured modular audio plugin host. This is a Cardinal/Rack module of Carla with 2 audio and 8 CV IO. Double-click on the panel to show the Carla's own window. @@ -29,63 +33,142 @@ This is currently not supported under Windows. MIDI input and output are possible with the use of expander modules. +By default Carla will have an offset on its CV inputs and outputs so that 0 to 10v from Carla generates -5 to 5v in Cardinal, and vice-versa. +This allows to easily route between bipolar and unipolar+ signals. +You can change this with right-click menu options, in case you want no offset to be applied. + ### Ildaeil +![screenshot](Module_Ildaeil.png) + [Ildaeil](https://github.com/DISTRHO/Ildaeil) is a mini-plugin host based on [Carla](https://kx.studio/Applications:Carla). This is Cardinal/Rack module of Ildaeil with 2 audio IO. -Currently Ildaeil supports internal (from Carla) and LV2 plugins. +Currently Ildaeil supports (Carla) internal and LV2 plugins. +More plugin support will be added in future releases. + There is no way to automate hosted plugin parameters yet. MIDI input and output are possible with the use of expander modules. ### Host Audio -For getting audio from and to your Host/DAW. +![screenshot](Module_HostAudio.png) + +A module for getting audio from and to your Host/DAW. Works just like the Rack equivalent, including a DC filter that is enabled by default on the stereo version, disabled on the 8 IO variant. -Unlike Rack, Cardinal does not provide a 16 IO audio module. +On the stereo version, connecting to the Left/Mono input jack will automatically mirror that signal on the Right, unconnected jack. +This is the same behaviour as present in Rack, but without signal delay. + +Note that, unlike Rack, Cardinal does not provide a 16 IO audio module. ### Host CV +![screenshot](Module_HostCV.png) + For getting CV from and to your Host/DAW. +Just as with the Carla module, you can enable right-click menu options to automatically apply an offset to the CV signal. +For convenience this mode is split on the 1-5 and 6-10 ports, in case you need some to be bipolar and some unipolar. + Note that this module does nothing on Cardinal's FX and Synth variants, as they do not have host-exposed CV IO. ### Host MIDI +![screenshot](Module_HostMIDI.png) + For getting regular MIDI from and to your Host/DAW. -This includes ... +It has pretty much the same options and functionality as the Rack MIDI2CV and CV2MIDI modules, but combines them into one. + +Clock pulses are not available on this module in Cardinal, prefer to use Host Time module for that. ### Host MIDI CC +![screenshot](Module_HostMIDICC.png) + For getting regular MIDI CCs from and to your Host/DAW. -This includes ... +It has pretty much the same options and functionality as the Rack MIDI-CC2CV and CV2MIDI-CC modules, but combines them into one. + +Direct channel pressure and pitchbend ports are available for convenience. ### Host MIDI Gate +![screenshot](Module_HostMIDIGate.png) + For getting regular MIDI Notes as Gates from and to your Host/DAW. -... +It has pretty much the same options and functionality as the Rack MIDI-Gate2CV and CV2MIDI-Gate modules, but combines them into one. -### Host MIDI Map +### Host MIDI CC Map + +![screenshot](Module_HostMIDIMap.png) For mapping MIDI CCs from your Host/DAW into module parameters. -This includes ... +It has pretty much the same options and functionality as the Rack MIDI-Map. ### Host Parameters +![screenshot](Module_HostParameters.png) + ### Host Time -For getting time information from your DAW as precise clock triggers +![screenshot](Module_HostTime.png) + +For getting time information from your DAW as precise clock triggers. + +Unlike Rack, Cardinal does not use PPQN (pulses per quarter note) values, but BBT (bar-beat-tick) instead. + +The top of the panel has a timer display to help understand how and what the host is doing. +The first line is the song time in seconds, and second line is the BBT. ## Extra modules -### ExpanderInputMIDI +### Blank + +![screenshot](Module_Blank.png) + +Every collection needs a blank panel. +Cardinal features Hatsune Miku on its blank panel, because yes. :) + +Actually, it is just that CC-NC artwork and resources are very common-place within the Rack plugins ecosystem. +Typically we would want to avoid those, but when you got pretty much every author using CC-NC, let's go all in then... +So yes, the design used on this panel is [CC-NC licensed](https://piapro.net/intl/en_for_creators.html). + +If you ask why Miku, well, why not. And why not even something else. +If you find other content we can use, under clear license terms, maybe it could be added as blank panel too. -### ExpanderOutputMIDI +Sometimes we just need to have fun. :) + +### Expanders MIDI + +![screenshot](Module_ExpandersMIDI.png) + +These are expanders for Carla and Ildaeil, allowing MIDI input and output. +When connected (that is, standing next to them) the graphics on Carla/Ildaeil side will change a bit to indicate it is being used. ### MPV +This is super experimental embed video player inside Cardinal. + +It is mostly just a test for embedding external windows inside Cardinal, `mpv` simply provides a nice way to do it. + +This is not intended to be a serious module in any way, purely experimental and made for development purposes. + ### glBars +![screenshot](Module_glBars.png) + +An OpenGL bars visualization, as seen in XMMS and XBMC/Kodi. + +It is purely cosmetic. + +This module was done early in Cardinal's development as a way to test drawing a module using OpenGL. +It remains as a test case and example for others to based new modules on. + ### Text Editor + +![screenshot](Module_TextEditor.png) + +A text editor inside Cardinal, with support for syntax highlighting. + +It supports the typical things you expect from an editor, such as copy&paste and undo&redo. diff --git a/docs/Module_AudioFile.png b/docs/Module_AudioFile.png new file mode 100644 index 0000000..f6b36b8 Binary files /dev/null and b/docs/Module_AudioFile.png differ diff --git a/docs/Module_Blank.png b/docs/Module_Blank.png new file mode 100644 index 0000000..f4b76a1 Binary files /dev/null and b/docs/Module_Blank.png differ diff --git a/docs/Module_Carla.png b/docs/Module_Carla.png new file mode 100644 index 0000000..4d52f9d Binary files /dev/null and b/docs/Module_Carla.png differ diff --git a/docs/Module_ExpandersMIDI.png b/docs/Module_ExpandersMIDI.png new file mode 100644 index 0000000..c9a4da5 Binary files /dev/null and b/docs/Module_ExpandersMIDI.png differ diff --git a/docs/Module_HostAudio.png b/docs/Module_HostAudio.png new file mode 100644 index 0000000..4aaecc7 Binary files /dev/null and b/docs/Module_HostAudio.png differ diff --git a/docs/Module_HostCV.png b/docs/Module_HostCV.png new file mode 100644 index 0000000..8799ca1 Binary files /dev/null and b/docs/Module_HostCV.png differ diff --git a/docs/Module_HostMIDI.png b/docs/Module_HostMIDI.png new file mode 100644 index 0000000..a4e2578 Binary files /dev/null and b/docs/Module_HostMIDI.png differ diff --git a/docs/Module_HostMIDICC.png b/docs/Module_HostMIDICC.png new file mode 100644 index 0000000..a9bf6d4 Binary files /dev/null and b/docs/Module_HostMIDICC.png differ diff --git a/docs/Module_HostMIDIGate.png b/docs/Module_HostMIDIGate.png new file mode 100644 index 0000000..50d5daf Binary files /dev/null and b/docs/Module_HostMIDIGate.png differ diff --git a/docs/Module_HostMIDIMap.png b/docs/Module_HostMIDIMap.png new file mode 100644 index 0000000..00d0c78 Binary files /dev/null and b/docs/Module_HostMIDIMap.png differ diff --git a/docs/Module_HostParameters.png b/docs/Module_HostParameters.png new file mode 100644 index 0000000..55b7780 Binary files /dev/null and b/docs/Module_HostParameters.png differ diff --git a/docs/Module_HostTime.png b/docs/Module_HostTime.png new file mode 100644 index 0000000..d58dff9 Binary files /dev/null and b/docs/Module_HostTime.png differ diff --git a/docs/Module_Ildaeil.png b/docs/Module_Ildaeil.png new file mode 100644 index 0000000..84ab546 Binary files /dev/null and b/docs/Module_Ildaeil.png differ diff --git a/docs/Module_TextEditor.png b/docs/Module_TextEditor.png new file mode 100644 index 0000000..17496bc Binary files /dev/null and b/docs/Module_TextEditor.png differ diff --git a/docs/Module_glBars.png b/docs/Module_glBars.png new file mode 100644 index 0000000..4e79465 Binary files /dev/null and b/docs/Module_glBars.png differ diff --git a/plugins/Cardinal/plugin.json b/plugins/Cardinal/plugin.json index 396ebf1..9318ad1 100644 --- a/plugins/Cardinal/plugin.json +++ b/plugins/Cardinal/plugin.json @@ -6,9 +6,9 @@ "brand": "DISTRHO", "author": "DISTRHO", "authorEmail": "falktx@falktx.com", + "authorUrl": "https://falktx.com/", "pluginUrl": "https://github.com/DISTRHO/Cardinal", - "authorUrl": "https://github.com/DISTRHO/Cardinal", - "manualUrl": "https://github.com/DISTRHO/Cardinal/wiki", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md", "sourceUrl": "https://github.com/DISTRHO/Cardinal", "changelogUrl": "", "modules": @@ -17,6 +17,7 @@ "slug": "HostAudio2", "name": "Audio 2", "description": "Exposes host-provided audio ports in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-audio", "tags": [ "External" ] @@ -25,6 +26,7 @@ "slug": "HostAudio8", "name": "Audio 8", "description": "Exposes host-provided audio ports in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-audio", "tags": [ "External" ] @@ -33,6 +35,7 @@ "slug": "HostCV", "name": "Host CV", "description": "Exposes host-provided CV ports in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-cv", "tags": [ "External" ] @@ -41,6 +44,7 @@ "slug": "HostMIDI", "name": "Host MIDI", "description": "Exposes host-provided MIDI in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-midi", "tags": [ "External", "MIDI", @@ -51,6 +55,7 @@ "slug": "HostMIDICC", "name": "Host MIDI CC", "description": "Exposes host-provided MIDI CC, channel pressure and pitchbend in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-midi-cc", "tags": [ "External", "MIDI" @@ -60,6 +65,7 @@ "slug": "HostMIDIGate", "name": "Host MIDI Gate", "description": "Exposes host-provided MIDI notes as gates in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-midi-gate", "tags": [ "External", "MIDI" @@ -69,6 +75,7 @@ "slug": "HostMIDIMap", "name": "Host MIDI CC Map", "description": "Allows host-provided MIDI CC to control other module parameters", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-midi-map", "tags": [ "External", "MIDI" @@ -78,6 +85,7 @@ "slug": "HostParameters", "name": "Host Parameters", "description": "Exposes host-controlled plugin parameters in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-parameters", "tags": [ "External" ] @@ -86,6 +94,7 @@ "slug": "HostTime", "name": "Host Time", "description": "Exposes host-provided time/transport information in a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#host-time", "tags": [ "External" ] @@ -94,6 +103,7 @@ "slug": "glBars", "name": "glBars", "description": "OpenGL bars visualization, as seen in XMMS and XBMC/Kodi", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#glbars", "tags": [ "Visual" ] @@ -102,6 +112,7 @@ "slug": "Blank", "name": "Blank", "description": "Cardinal's own blank panel, featuring Hatsune Miku", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#blank", "tags": [ "Visual" ] @@ -110,6 +121,7 @@ "slug": "ExpanderInputMIDI", "name": "ExpanderInputMIDI", "description": "MIDI input (from CV) expander for Carla Plugin Host and Ildaeil", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#expanders-midi", "tags": [ "Expander", "MIDI" @@ -119,6 +131,7 @@ "slug": "ExpanderOutputMIDI", "name": "ExpanderOutputMIDI", "description": "MIDI output (to CV) expander for Carla Plugin Host and Ildaeil", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#expanders-midi", "tags": [ "Expander", "MIDI" @@ -128,6 +141,7 @@ "slug": "AudioFile", "name": "Audio File", "description": "Audio file player as a module", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#audio-file", "tags": [ "Utility" ] @@ -136,6 +150,7 @@ "slug": "Carla", "name": "Carla Plugin Host", "description": "A modular plugin host within Cardinal", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#carla", "tags": [ "Utility" ] @@ -144,6 +159,7 @@ "slug": "Ildaeil", "name": "Ildaeil Plugin Host", "description": "A mini plugin host within Cardinal for loading any FX", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#ildaeil", "tags": [ "Utility" ] @@ -152,6 +168,7 @@ "slug": "MPV", "name": "MPV", "description": "An embed video player inside Cardinal", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#mpv", "tags": [ "Visual" ] @@ -160,6 +177,7 @@ "slug": "TextEditor", "name": "Text Editor", "description": "An embed text editor inside Cardinal", + "manualUrl": "https://github.com/DISTRHO/Cardinal/blob/main/docs/CARDINAL-MODULES.md#text-editor", "tags": [ "Utility" ]