JUCE-pikaopas
Lisää sournd-moottori JUCE 8 -pluginiin. Kolme CMake-riviä, kolme C++-oliota, ei Rust-työkaluketjua koneellasi.
- LataaJUCE-moduuli ja moottorikirjastosi
- CMakekolme riviä
- Kolme C++-oliotamoottori, parametrit, silta
- PluginisiJUCE rakentaa tavalliseen tapaan
Mitä saat
sournd_engine, tavallinen JUCE-moduuli, joka riippuu vain moduuleistajuce_audio_processorsjajuce_dsp(Apache-2.0). Lataa se: sournd-engine-juce-module.zip.- Staattinen kirjasto alustallesi (
libsournd_cabi.atai Windowsissasournd_cabi.lib) ja otsikkotiedostosournd_engine.h: ilmaiset moottorit minkä tahansa ilmaisen moottorin sivulta (https://sournd.com/download/free/macos, https://sournd.com/download/free/linux, https://sournd.com/download/free/windows), maksulliset sivulta Moottorisi. SourndEngine, joka toteuttaa luokanjuce::dsp::ProcessorBase, jaSourndEngineParameters, joka rakentaa moottorista APVTS-asettelun ja pitää ne synkronissa.
1. Lisää moduuli ja kirjasto
Pura moduuli niin, että sinulla on sournd_engine-kansio, ja pura moottorilatauksesi sen viereen.
juce_add_module(path/to/sournd_engine)
target_include_directories(MyPlugin PRIVATE path/to/include) # sournd_engine.h
target_link_libraries(MyPlugin PRIVATE sournd_engine path/to/libsournd_cabi.a)Universal-macOS-pluginia varten rakenna asetuksella -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' ja linkitä universal-arkisto.
Linuxissa lataus sisältää yhden arkiston arkkitehtuuria kohden. Valitse se, jolle rakennat, ja lisää tarvittavat järjestelmäkirjastot:
if(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64|arm64")
set(SOURND_ARCH linux-aarch64)
else()
set(SOURND_ARCH linux-x86_64)
endif()
target_link_libraries(MyPlugin PRIVATE sournd_engine
path/to/lib/${SOURND_ARCH}/libsournd_cabi.a pthread dl m)2. Luo moottori, sen parametrit ja silta
Luo ne tässä järjestyksessä viestisäikeessä:
#include <sournd_engine/sournd_engine.h>
class MyPlugin final : public juce::AudioProcessor
{
public:
MyPlugin()
: AudioProcessor (BusesProperties().withInput ("Input", juce::AudioChannelSet::stereo())
.withOutput ("Output", juce::AudioChannelSet::stereo())),
engine ("org.sournd.reverb.roomette"),
parameters (*this, nullptr, "Parameters", sournd::SourndEngineParameters::createLayout (engine)),
bridge (engine, parameters)
{ jassert (engine.isValid()); }
void prepareToPlay (double rate, int maximumBlock) override
{
engine.prepare ({ rate, (juce::uint32) maximumBlock, (juce::uint32) getTotalNumOutputChannels() });
bridge.prepare (rate);
setLatencySamples ((int) engine.latency());
}
void processBlock (juce::AudioBuffer<float>& buffer, juce::MidiBuffer&) override
{
bridge.apply ((uint32_t) buffer.getNumSamples());
juce::dsp::AudioBlock<float> block { buffer };
engine.process (juce::dsp::ProcessContextReplacing<float> { block });
}
void getStateInformation (juce::MemoryBlock& destination) override
{
// Hosts can ask for state during playback: JUCE's callback lock keeps processBlock out
// while the engine is read (the C ABI allows one call at a time per engine).
const juce::ScopedLock lock (getCallbackLock());
bridge.syncToEngine();
destination = engine.saveState();
}
void setStateInformation (const void* data, int bytes) override
{
if (bytes < 0) return;
const juce::ScopedLock lock (getCallbackLock());
if (engine.loadState (data, (size_t) bytes)) bridge.syncFromEngine();
}
double getTailLengthSeconds() const override { return engine.tailSeconds(); }
private:
sournd::SourndEngine engine;
juce::AudioProcessorValueTreeState parameters;
sournd::SourndEngineParameters bridge;
};Mitä tapahtuu ajon aikana:
Joka lohko
- Isäntänupit ja automaatio
- APVTSpluginisi parametrit
bridge.applymuuttuneet arvot, kerran lohkossaengine.processtasoittaa näyte näytteeltä- Ääni ulos
Tallennus
- Isäntä pyytää tilaa
getCallbackLock()pitääprocessBlockloitollabridge.syncToEngine()engine.saveState()läpinäkymätön blob
Lataus
- Isäntä palauttaa tilan
getCallbackLock()engine.loadState()yhdistetään parametrin tunnisteellabridge.syncFromEngine()
3. Valitse moottori
Valitse mikä tahansa tunniste katalogista tai tiedostosta catalog.json. Tuntematon tunniste tuottaa virheellisen moottorin, joka antaa hiljaisuutta, joten tarkista isValid() ja lastError().
Hyödylliset säännöt
- Parametrien tunnisteet ovat vakaita desimaalimerkkijonoja: parametrin paikka moottorin manifestissa, näkyvissä jokaisella moottorisivulla. Parametreja vain lisätään, niitä ei koskaan numeroida uudelleen.
- Isännän alueet seuraavat kunkin parametrin käyrää. Logaritminen parametri (cutoff, aika, suhde) kuvaa isännän 0–1 muotoon
min * (max / min)^p, joten automaatioraidat ja yleiset editorit liikkuvat yhtä suurina suhteina, kuten moottorin omat nupit. Jos olet jo julkaissut pluginin lineaarisilla alueilla, annacreateLayout (engine, false)säilyttääksesi ne, sillä isännät tallentavat automaation 0–1-arvoina. bridge.applyantaa jokaisen muuttuneen arvon moottorille lohkon alussa. Moottori tasoittaa jatkuvat säätimet itse, näyte näytteeltä, joten ääni ei riipu isännän lohkokoosta (testattu bitti bitiltä 1, 32, 64 ja 512 kehyksellä). Askelmaiset ja totuusarvosäätimet hyppäävät.- Kehysten määrän kutsua kohden on mahduttava kutsulle
prepareannettuun maksimiin. Kääre ei jaa isännän lohkoja. - Tila on läpinäkymätön ja sidottu moottorin tunnisteeseen. Se tallentaa asetukset, ei viiveen tai suotimen historiaa. Se siirtyy moottoriversioiden välillä: arvot yhdistetään parametrin tunnisteella, parametrit, jotka on lisätty istunnon tallennuksen jälkeen, saavat oletusarvonsa, ja uudemman moottorin arvot, joita tältä puuttuu, ohitetaan (
lastStateReport()laskee molemmat). Tila hylätään, eikä mikään muutu, vain jos se kuuluu toiselle moottorille tai on vioittunut. - Äänisäie ei koskaan varaa muistia, lukitse eikä kutsu viestienhallintaa. Käytä yhtä moottori-instanssia kutakin prosessointisäiettä kohden.
- Kutsut yhteen moottoriin eivät saa mennä päällekkäin. Kaikki funktion
processBlockulkopuolella oleva, joka koskee moottoria (tilan tallennus tai lataus,prepare,reset), pitää lukkoagetCallbackLock(), kuten yllä, joten se ei koskaan ajaudu äänen prosessoinnin aikana.
Rajoitukset
Nämä ovat sillan rajat nykyään.
- Ääni on 32-bittistä float-muotoa. Silta prosessoi vain
float-puskureita. JätäsupportsDoublePrecisionProcessing()oletukseensa (false), jotta isännät antavat pluginillesi float-ääntä. - Mono tai stereo, sama sisääntulossa ja ulostulossa. Yksi tai kaksi pääkanavaa; mono stereoksi, stereo monoksi ja surround-asettelut eivät ole tuettuja. Jotkin moottorit toimivat vain stereona, joten kysy moottorilta funktiossa
isBusesLayoutSupportedäläkä oleta (alla).supportsChannelsvalmistelee tilapäisen instanssin, joten tallenna vastaus välimuistiin äläkä kutsu sitä äänisäikeessä. - Sidechain-moottorit hyväksyvät kytkemättömän, mono- tai stereoapusisääntulon.
- MIDI. Efektit ohittavat MIDI-puskurin, eikä silta koskaan tuota MIDIä. Soitinmoottorit lukevat note on-, note off- ja all notes off -viestit (CC 120 ja 123) niiden näytepaikoissa, kaikilla kanavilla; pitch bend, aftertouch, muut ohjaimet ja MPE eivät välity eteenpäin.
- Näytteenottotaajuudet 8 kHz:stä 768 kHz:iin ja enintään 1,048,576 kehystä lohkossa.
- Piilotetut moottoriparametrit pysyvät moottorin tilan sisällä, eivätkä ne ole isännän säätimiä.
bool isBusesLayoutSupported (const BusesLayout& layout) const override
{
const auto& in = layout.getMainInputChannelSet();
return in == layout.getMainOutputChannelSet()
&& ((in == juce::AudioChannelSet::mono() && mono) || (in == juce::AudioChannelSet::stereo() && stereo));
}
// members, after engine:
const bool mono = engine.supportsChannels (1), stereo = engine.supportsChannels (2);Alustat
Lataukset rakennetaan macOS universalille (arm64 ja x86_64), Linuxille (x86_64 ja aarch64, glibc 2.36 tai uudempi) ja Windows x64:lle (MSVC). Valitse alusta ladatessasi Moottorisi-sivulta; agentti pyytää sitä parametreilla platform=linux tai platform=windows-x64.
Windowsissa zip sisältää kaksi kopiota tiedostosta sournd_cabi.lib: lib/windows-x64/ projekteille, jotka käyttävät dynaamista C-ajoaikaa (/MD, MSVC:n oletus), ja lib/windows-x64-static-crt/ staattiselle (/MT). Linkitä pluginiisi sopiva, ja sen jälkeen kernel32 ntdll userenv ws2_32 dbghelp. Zipin README sisältää CMake-rivit.
Lisensointi
JUCE-moduuli ja C-otsikkotiedosto ovat Apache-2.0-lisensoituja, joten ne voi linkittää GPL- tai kaupallisiin JUCE-projekteihin. JUCEllä itsellään on oma lisenssinsä ja omat tilauksensa, joita sournd-lisenssi ei kata: noudata JUCE 8 -lisenssiä ja valitse JUCE-tilaus, joka sopii julkaisemaasi. Maksulliset moottorit toimitetaan suljettuina staattisina kirjastoina. Katso lisensointi.