sOURnd Dokümanlar Motorlarınız
Bu sayfada
  1. Neler elde edersiniz
  2. 1. Modülü ve kütüphaneyi ekleyin
  3. 2. Motoru, parametrelerini ve köprüyü oluşturun
  4. 3. Bir motor seçin
  5. Bilmeye değer kurallar
  6. Sınırlar
  7. Platformlar
  8. Lisanslama

JUCE hızlı başlangıç

Bir JUCE 8 eklentisine sournd motoru ekleyin. Üç CMake satırı, üç C++ nesnesi, makinenizde Rust araç zinciri yok.

  1. İndirinJUCE modülü ve motor kütüphaneniz
  2. CMakeüç satır
  3. Üç C++ nesnesimotor, parametreler, köprü
  4. EklentinizJUCE tarafından her zamanki gibi derlenir

Neler elde edersiniz

  • sournd_engine, yalnızca juce_audio_processors ve juce_dsp modüllerine bağlı standart bir JUCE modülü (Apache-2.0). İndirin: sournd-engine-juce-module.zip.
  • Platformunuz için bir statik kütüphane (libsournd_cabi.a, Windows'ta sournd_cabi.lib) ve sournd_engine.h başlık dosyası: ücretsiz motorlar herhangi bir ücretsiz motorun sayfasından (https://sournd.com/download/free/macos, https://sournd.com/download/free/linux, https://sournd.com/download/free/windows), ücretli olanlar Motorlarınız sayfasından.
  • juce::dsp::ProcessorBase arayüzünü uygulayan SourndEngine ve motordan bir APVTS yerleşimi kurup ikisini eşit tutan SourndEngineParameters.

1. Modülü ve kütüphaneyi ekleyin

Modülün zip'ini açın ki bir sournd_engine klasörünüz olsun, motor indirmenizin zip'ini de yanına açın.

cmake
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)

Evrensel bir macOS eklentisi için -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' ile derleyin ve evrensel arşivi bağlayın.

Linux'ta indirmede mimari başına bir arşiv bulunur. Derlediğiniz makineye uygun olanı seçin ve gereken sistem kütüphanelerini ekleyin:

cmake
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. Motoru, parametrelerini ve köprüyü oluşturun

Bunları ileti iş parçacığında şu sırayla oluşturun:

cpp
#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;
};

Çalışma sırasında olanlar:

Her blok

  1. Hostdüğmeler ve otomasyon
  2. APVTSeklentinizin parametreleri
  3. bridge.applydeğişen değerler, blok başına bir kez
  4. engine.processörnek örnek yumuşatır
  5. Ses çıkışı

Kaydetme

  1. Host durumu ister
  2. getCallbackLock()processBlock çağrısını dışarıda tutar
  3. bridge.syncToEngine()
  4. engine.saveState()opak bir veri bloğu

Yükleme

  1. Host durumu geri verir
  2. getCallbackLock()
  3. engine.loadState()parametre kimliğine göre eşleşir
  4. bridge.syncFromEngine()

3. Bir motor seçin

Katalogdan ya da catalog.json dosyasından herhangi bir kimlik seçin. Bilinmeyen bir kimlik sessizlik üreten geçersiz bir motor oluşturur; bu yüzden isValid() ve lastError() değerlerini kontrol edin.

Bilmeye değer kurallar

  • Parametre kimlikleri kararlı ondalık dizelerdir: parametrenin motorun manifestosundaki sırası, her motor sayfasında gösterilir. Parametreler yalnızca eklenir, hiçbir zaman yeniden numaralandırılmaz.
  • Host aralıkları her parametrenin eğrisini izler. Logaritmik bir parametre (cutoff, süre, oran) host'un 0 ile 1 aralığını min * (max / min)^p olarak eşler; böylece otomasyon şeritleri ve genel editörler, motorun kendi düğmeleri gibi eşit oranlarda hareket eder. Doğrusal aralıklarla zaten bir eklenti yayımladıysanız, onları korumak için createLayout (engine, false) verin, çünkü host'lar otomasyonu 0 ile 1 değerleri olarak saklar.
  • bridge.apply değişen her değeri blokun başında motora verir. Motor sürekli kontrolleri örnek örnek kendisi yumuşatır, böylece ses host'un blok boyutuna bağlı olmaz (1, 32, 64 ve 512 karede bit bit sınandı). Kademeli ve boolean kontroller anında oturur.
  • Çağrı başına kare sayısı prepare işlevine verilen üst sınıra sığmalıdır. Sarmalayıcı host bloklarını bölmez.
  • Durum opaktır ve motor kimliğine bağlıdır. Ayarları saklar; delay ya da filtre geçmişini saklamaz. Motor sürümleri arasında geçiş yapar: değerler parametre kimliğine göre eşleşir, oturum kaydedildikten sonra eklenen parametreler varsayılanlarını alır ve daha yeni bir motordan gelen, bu motorda olmayan değerler yok sayılır (lastStateReport() ikisini de sayar). Bir durum, yalnızca başka bir motora aitse ya da bozuksa reddedilir ve hiçbir şey değişmez.
  • Ses iş parçacığı asla bellek ayırmaz, kilit almaz ya da ileti yöneticisini çağırmaz. İşlem iş parçacığı başına bir motor örneği kullanın.
  • Bir motora yapılan çağrılar çakışmamalıdır. processBlock dışında motora dokunan her şey (durumu kaydetme veya yükleme, prepare, reset) yukarıdaki gibi getCallbackLock() tutar; böylece ses işlenirken asla çalışmaz.

Sınırlar

Köprünün bugünkü sınırları bunlardır.

  • Ses 32 bit float'tır. Köprü yalnızca float arabelleklerini işler. supportsDoublePrecisionProcessing() işlevini varsayılan değerinde (false) bırakın, böylece host'lar eklentinize float ses verir.
  • Mono veya stereo, girişte ve çıkışta aynı. Bir ya da iki ana kanal; monodan stereoya, stereodan monoya ve surround yerleşimleri desteklenmez. Bazı motorlar yalnızca stereo çalışır, bu yüzden varsaymak yerine isBusesLayoutSupported içinde motora sorun (aşağıda). supportsChannels geçici bir örnek hazırlar, bu yüzden yanıtı ses iş parçacığında çağırmak yerine önbelleğe alın.
  • Sidechain motorları bağlı olmayan, mono ya da stereo bir yardımcı giriş kabul eder.
  • MIDI. Efektler MIDI arabelleğini yok sayar ve köprü hiçbir zaman MIDI üretmez. Enstrüman motorları nota açma, nota kapama ve tüm notaları kapama (CC 120 ve 123) mesajlarını her kanalda, örnek konumlarında okur; pitch bend, aftertouch, diğer kontrolcüler ve MPE iletilmez.
  • Örnekleme hızları 8 kHz ile 768 kHz arası ve blok başına en fazla 1.048.576 kare.
  • Gizli motor parametreleri motorun durumunda kalır ve host kontrolü değildir.
cpp
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);

Platformlar

İndirmeler macOS evrensel (arm64 ve x86_64), Linux (x86_64 ve aarch64, glibc 2.36 veya üstü) ve Windows x64 (MSVC) için derlenir. Motorlarınız sayfasından indirirken platformu seçin; bir ajan bunu platform=linux ya da platform=windows-x64 ile ister.

Windows'ta zip, sournd_cabi.lib dosyasının iki kopyasını içerir: dinamik C çalışma zamanını kullanan projeler için lib/windows-x64/ (/MD, MSVC varsayılanı) ve statik olanı kullananlar için lib/windows-x64-static-crt/ (/MT). Eklentinize uyanı bağlayın, ardından kernel32 ntdll userenv ws2_32 dbghelp ekleyin. Zip içindeki README'de CMake satırları var.

Lisanslama

JUCE modülü ve C başlık dosyası Apache-2.0'dır, bu yüzden GPL veya ticari JUCE projelerine bağlanabilir. JUCE'un kendi lisansı ve planları vardır; sournd lisansı bunları kapsamaz: JUCE 8 lisansını izleyin ve yayımladığınıza uyan JUCE planını seçin. Ücretli motorlar kapalı statik kütüphane olarak gelir. Bkz. lisanslama.