diff --git a/01_unit_index.md b/01_unit_index.md index 904ede6c..b2bf2bbf 100644 --- a/01_unit_index.md +++ b/01_unit_index.md @@ -13,5 +13,6 @@ The unit index has been split into pages for each unit type: * [Delay Effects](06_delfx_index.md) * [Reverb Effects](07_revfx_index.md) * [Master Effects](08_masterfx_index.md) - * [Miscellaneous](09_misc_index.md) + * [Generic Effects](09_genericfx_index.md) + * [Miscellaneous](10_misc_index.md) diff --git a/01_unit_index_ja.md b/01_unit_index_ja.md index c6e017d1..dcf0ed45 100644 --- a/01_unit_index_ja.md +++ b/01_unit_index_ja.md @@ -15,4 +15,6 @@ has_children: true * [ディレーエフェクト](06_delfx_index_ja.md) * [リバーブエフェクト](07_revfx_index_ja.md) * [マスターエフェクト](08_masterfx_index_ja.md) - * [その他](09_misc_index_ja.md) + * [ジェネリックエフェクト](09_genericfx_index_ja.md) + * [その他](10_misc_index_ja.md) + diff --git a/08_masterfx_index.md b/08_masterfx_index.md index 8d8272ca..270229a5 100644 --- a/08_masterfx_index.md +++ b/08_masterfx_index.md @@ -1,6 +1,7 @@ --- layout: page title: Master Effects +title_long: Master Effect Units permalink: /unit-index/masterfx/ last_modified_on: 2022-10-27 12:35:00 +9000 parent: Unit Index diff --git a/08_masterfx_index_ja.md b/08_masterfx_index_ja.md index 2eea23e3..cd9ef075 100644 --- a/08_masterfx_index_ja.md +++ b/08_masterfx_index_ja.md @@ -1,7 +1,6 @@ --- layout: page_ja title: Master Effects -title_long: Master Effect Units title_long: マスタエフェクトユニット覧 permalink: /ja/unit-index/masterfx/ language: ja diff --git a/09_genericfx_index.md b/09_genericfx_index.md new file mode 100644 index 00000000..d73815c5 --- /dev/null +++ b/09_genericfx_index.md @@ -0,0 +1,15 @@ +--- +layout: page +title: Generic Effects +title_long: Generic Effect Units +permalink: /unit-index/genericfx/ +last_modified_on: 2024-01-23 11:45:00 +9000 +parent: Unit Index +nav_order: 2 +--- + +_Note: Additions, corrections, broken links? Let us know at logue-sdk@korg.co.jp_ + +| Name | Developer | Description | Platforms | | +| | | | | | + diff --git a/09_genericfx_index_ja.md b/09_genericfx_index_ja.md new file mode 100644 index 00000000..61caa992 --- /dev/null +++ b/09_genericfx_index_ja.md @@ -0,0 +1,16 @@ +--- +layout: page_ja +title: Generic Effects +title_long: ジェネリックエフェクトユニット覧 +permalink: /ja/unit-index/genericfx/ +language: ja +last_modified_on: 2024-01-23 11:45:00 +9000 +parent: Unit Index +nav_order: 2 +--- + +_Note: 追加,訂正，リンク切れについては logue-sdk@korg.co.jp までご連絡下さい._ + +| 名前 | 開発者 | 備考 | プラットフォーム | | +| | | | | | + diff --git a/09_misc_index.md b/10_misc_index.md similarity index 100% rename from 09_misc_index.md rename to 10_misc_index.md diff --git a/09_misc_index_ja.md b/10_misc_index_ja.md similarity index 100% rename from 09_misc_index_ja.md rename to 10_misc_index_ja.md diff --git a/index.md b/index.md index 0850d26f..3536f000 100644 --- a/index.md +++ b/index.md @@ -4,27 +4,40 @@ layout: home --- -The *logue SDK* is a software development kit and API that allows to create custom oscillators, synths, and effects for the KORG [prologue](https://www.korg.com/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd), [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1) and [drumlogue](https://www.korg.com/products/drums/drumlogue). +The *logue SDK* is a software development kit and API that allows to create custom oscillators, synths, and effects for the KORG [prologue](https://www.korg.com/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd), [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1), [Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/products/dj/nts_1_mk2), [Nu:Tekt NTS-3 kaoss pad kit](https://www.korg.com/products/dj/nts_3) and [drumlogue](https://www.korg.com/products/drums/drumlogue). Singular pieces of custom content created with the SDK are commonly refered to as *units*. Each target platform can support certain unit types and not others, depending on the instrument's design and signal path. -## prologue, minilogue-xd, and NTS-1 +## prologue, minilogue-xd, and NTS-1 digital kit (mkI and mkII) -Four types of custom units can be created for these platforms: oscillators, modulation effects, delay effects, and reverb effects. - -These platforms' APIs are essentially the same and are binary compatible. However, in order to compensate for performance differences, custom units should be optimized and built for each platform separately. +These products allow four types of custom units to be loaded: oscillators, modulation effects, delay effects, and reverb effects. ### Oscillators Custom oscillators are self contained sound generators, which are expected to provide a steady audio signal via a buffer processing callback. These are processed as part of the target platform's voice structure, meaning that articulation and filtering is already taken care of, the oscillator need only to provide a waveform according to the specified pitch information, and other available parameters. +On the [prologue](https://www.korg.com/products/synthesizers/prologue) and [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd), an oscillator unit runtime is provided for each analog voice, which signals are mixed through the analog path along with the analog voice. On the [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1) and [Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/products/dj/nts_1_mkii), a single oscillator runtime is provided, integreted with the all-digital signal path. + ### Modulation Effects -Modulation effects are insert effects processed after voice articulation and filtering, and before delay and reverb effects. Note that in order to support the [prologue](https://www.korg.com/products/synthesizers/prologue)'s dual timbre feature, the API provides two processing buffers which must be handled in the same manner. On [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd) and [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1), the second buffer can be safely ignored. +Modulation effects are insert effects processed after voice articulation and filtering, and before delay and reverb effects. + +To support the [prologue](https://www.korg.com/products/synthesizers/prologue)'s dual timbre feature, the API provides two processing buffers which must be handled in the same manner. On [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd) and [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1), the second buffer can be safely ignored. + +On the [Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/products/dj/nts_1_mk2), the second buffer is not present and the processing API has been uniformized with that of other effects. ### Delay and Reverb Effects -Delay and reverb effects are both send effects that are processed after the modulation effects. On the [prologue](https://www.korg.com/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd), and [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1), custom delay and reverb effects are loaded into the same runtime, hence when both delay and reverb effects are enabled, only one of them can be a custom effect. However, any combination of internal and custom delay and reverb effects is allowed. +Delay and reverb effects are both send effects that are processed after the modulation effects. + +On the [prologue](https://www.korg.com/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd), and [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1), custom delay and reverb effects are loaded into the same runtime, hence when both delay and reverb effects are enabled, only one of them can be a custom effect. However, any combination of internal and custom delay and reverb effects is allowed. + +On the [Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/products/dj/nts_1_mk2), delay and reverb runtimes are independent from each other and thus units can be loaded without restrictions. + +### Binary Compatibility + +Units built for [prologue](https://www.korg.com/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd), and first generation [Nu:Tekt NTS-1 digital kit](https://www.korg.com/products/dj/nts_1) are binary compatible accross these products. +However, it is recommended that units be optimized for each product, and thus if a product-specific unit build is available it should be preferred. ### Further Platform Details @@ -32,7 +45,21 @@ Delay and reverb effects are both send effects that are processed after the modu * [prologue platform](https://github.com/korginc/logue-sdk/tree/master/platform/prologue/README.md) * [minilogue-xd platform](https://github.com/korginc/logue-sdk/tree/master/platform/minilogue-xd/README.md) - * [NTS-1 platform](https://github.com/korginc/logue-sdk/tree/master/platform/nutekt-digital/README.md) + * [NTS-1 digital kit platform](https://github.com/korginc/logue-sdk/tree/master/platform/nutekt-digital/README.md) + * [NTS-1 digital kit mkII platform](https://github.com/korginc/logue-sdk/tree/master/platform/nts-1_mkii/README.md) + +## NTS-3 kaoss pad kit + +The [Nu:Tekt NTS-3 kaoss pad kit](https://www.korg.com/products/dj/nts_3) provides four identical effects runtimes in which *generic effects* units can be loaded. + +### Generic Effects + +These effects are meant to be purpose-agnostic and the [Nu:Tekt NTS-3 kaoss pad kit](https://www.korg.com/products/dj/nts_3) allows to freely combine them using various routings. +In addition to the general purpose effect APIs, some [Nu:Tekt NTS-3 kaoss pad kit](https://www.korg.com/products/dj/nts_3)-specific APIs are provided to receive touch events, and access other platform specific features. + +### Further Platform Details + + Refer to the [NTS-3 kaoss pad kit platform README](https://github.com/korginc/logue-sdk/tree/master/platform/nts-3_kaoss/README.md) for further details. ## drumlogue diff --git a/index_ja.md b/index_ja.md index f66931fa..e6bb5cdb 100644 --- a/index_ja.md +++ b/index_ja.md @@ -5,16 +5,14 @@ layout: home_ja permalink: /ja/ --- -*logue SDK* とは KORG [prologue](https://www.korg.com/jp/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/jp/products/synthesizers/minilogue_xd), [Nu:Tekt NTS-1 digital kit](https://www.korg.com/jp/products/dj/nts_1), [drumlogue](https://www.korg.com/jp/products/drums/drumlogue/) のカスタムオシレーターやシンセ, エフェクトを作成可能なソフト開発キットとAPIです. +*logue SDK* とは KORG [prologue](https://www.korg.com/jp/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/jp/products/synthesizers/minilogue_xd), [Nu:Tekt NTS-1 digital kit](https://www.korg.com/jp/products/dj/nts_1), [Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/jp/products/dj/nts_1_mk2), [Nu:Tekt NTS-3 kaoss pad kit](https://www.korg.com/jp/products/dj/nts_3), [drumlogue](https://www.korg.com/jp/products/drums/drumlogue/) のカスタムオシレーターやシンセ, エフェクトを作成可能なソフト開発キットとAPIです. SDKで作成された単一のカスタムコンテンツは *"ユニット"* と呼ばれます. 各プラットフォームは製品の設計と信号経路に応じた特定のユニットに対応しており, 他のユニットには対応しないことがあります. -## prologueとminilogue-xd, NTS-1 +## prologueとminilogue-xd, NTS-1 digital kit (mkI and mkII) これらの機種では, オシレーター, モジュレーションエフェクト, ディレイエフェクト, リバーブエフェクトの4種類のカスタムユニットを作成することができます. -これらの機種のAPIは基本的に同じものでありバイナリ互換性があります. しかし機種間でスペックに違いがあるため, カスタムユニットは各機種ごとに個別に最適化しビルドする必要があります. - ### カスタムオシレーター カスタムオシレーターは, バッファ処理コールバックを介して安定したオーディオ信号を提供することが期待される自己完結型のサウンドジェネレーターです. @@ -25,17 +23,34 @@ SDKで作成された単一のカスタムコンテンツは *"ユニット"* モジュレーションエフェクトは、ボイスのアーティキュレーションとフィルタリングの後, ディレイとリバーブエフェクトの前に処理されるインサートエフェクトです. [prologue](https://www.korg.com/jp/products/synthesizers/prologue) ではデュアルティンバー機能をサポートするために, APIは二つのバッファーを提供し, 同様の処理をする必要であることに注意してください. [minilogue xd](https://www.korg.com/jp/products/synthesizers/minilogue_xd) と [Nu:Tekt NTS-1 digital kit](https://www.korg.com/jp/products/dj/nts_1) では二つ目のバッファーは安全に省略することができます. +[Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/jp/products/dj/nts_1_mk2)ではAPIが他のエフェクトと統一されて, 2つ目のバッファーは存在しません. + ### ディレイエフェクトとリバーブエフェクト ディレイエフェクトとリバーブエフェクトは, どちらもモジュレーションエフェクトの後に処理されるセンドエフェクトです. [prologue](https://www.korg.com/jp/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/jp/products/synthesizers/minilogue_xd), [Nu:Tekt NTS-1 digital kit](https://www.korg.com/jp/products/dj/nts_1) ではカスタムディレイとリバーブエフェクトが同じランタイムにロードされるため, ディレイとリバーブの両方が有効であってもカスタムエフェクトは片方だけしか使用することができません. ただし内部エフェクトとカスタムディレイ, リバーブエフェクトは自由に組み合わせることができます. +[Nu:Tekt NTS-1 digital kit mkII](https://www.korg.com/jp/products/dj/nts_1_mk2)では, ディレーとリバーブそれぞれの個別ランタイムがあるため, 制限なく利用できます. + +### バイナリ互換性について + +[prologue](https://www.korg.com/jp/products/synthesizers/prologue), [minilogue xd](https://www.korg.com/jp/products/synthesizers/minilogue_xd), [Nu:Tekt NTS-1 digital kit](https://www.korg.com/jp/products/dj/nts_1)の機種に限ってバイナリ互換性があります. しかし機種間でスペックに違いがあるため, カスタムユニットは各機種ごとに個別に最適化しビルドする必要があります. + ### 各プラットフォームの詳細 より詳しい情報は下記のREADMEファイルに記載しています. * [prologue platform](https://github.com/korginc/logue-sdk/tree/master/platform/prologue/README_ja.md) * [minilogue-xd platform](https://github.com/korginc/logue-sdk/tree/master/platform/minilogue-xd/README_ja.md) - * [NTS-1 platform](https://github.com/korginc/logue-sdk/tree/master/platform/nutekt-digital/README_ja.md) + * [NTS-1 digital kit platform](https://github.com/korginc/logue-sdk/tree/master/platform/nutekt-digital/README_ja.md) + * [NTS-1 digital kit mkII platform](https://github.com/korginc/logue-sdk/tree/master/platform/nts-1_mkii/README.md) (日本語版準備中) + +## NTS-3 kaoss pad kit + +[Nu:Tekt NTS-3 kaoss pad kit](https://www.korg.com/jp/products/dj/nts_3)では４つのエフェクトランタイムがあって, その環境用に作成されたエフェクトは*ジェネリックエフェクト*と呼ばれます. + +### 詳細な情報 + + より詳細な情報は [NTS-3 kaoss pad kit platform README](https://github.com/korginc/logue-sdk/tree/master/platform/nts-3_kaoss/README.md) ファイルをご参照ください. (日本語版準備中) ## drumlogue