Nu:Tekt NTS-1 digital SDK  v1.1-0
Classes | Macros | Enumerations
Common

Macros

#define USER_TARGET_PLATFORM   (k_user_target_nutektdigital)
 Target platform for this user code.
 
#define USER_TARGET_PLATFORM_MASK   (0x7F<<8)
 
#define USER_TARGET_MODULE_MASK   (0x7F)
 
#define USER_TARGET_PLATFORM_IS_COMPAT(tgt)
 
#define USER_API_VERSION   (k_user_api_1_1_0)
 API version targeted by this code.
 
#define USER_API_MAJOR_MASK   (0x7F<<16)
 
#define USER_API_MINOR_MASK   (0x7F<<8)
 
#define USER_API_PATCH_MASK   (0x7F)
 
#define USER_API_MAJOR(v)   ((v)>>16 & 0x7F)
 
#define USER_API_MINOR(v)   ((v)>>8 & 0x7F)
 
#define USER_API_PATCH(v)   ((v) & 0x7F)
 
#define USER_API_IS_COMPAT(api)
 
#define USER_PRG_HEADER_SIZE   (0x400)
 
#define USER_PRG_SIG_SIZE   (0x84)
 
#define USER_PRG_MAX_PARAM_COUNT   (6)
 
#define USER_PRG_PARAM_MIN_LIMIT   (-100)
 
#define USER_PRG_PARAM_MAX_LIMIT   (100)
 
#define USER_PRG_PARAM_NAME_LEN   (12)
 
#define USER_PRG_NAME_LEN   (13)
 

Enumerations

enum  {
  k_user_module_global = 0U, k_user_module_modfx, k_user_module_delfx, k_user_module_revfx,
  k_user_module_osc, k_num_user_modules
}
 Module categories. More...
 
enum  {
  k_user_target_prologue = (1U<<8), k_user_target_prologue_global = (1U<<8) | k_user_module_global, k_user_target_prologue_modfx = (1U<<8) | k_user_module_modfx, k_user_target_prologue_delfx = (1U<<8) | k_user_module_delfx,
  k_user_target_prologue_revfx = (1U<<8) | k_user_module_revfx, k_user_target_prologue_osc = (1U<<8) | k_user_module_osc
}
 prologue specific platform/module pairs. More...
 
enum  {
  k_user_target_miniloguexd = (2U<<8), k_user_target_miniloguexd_global = (2U<<8) | k_user_module_global, k_user_target_miniloguexd_modfx = (2U<<8) | k_user_module_modfx, k_user_target_miniloguexd_delfx = (2U<<8) | k_user_module_delfx,
  k_user_target_miniloguexd_revfx = (2U<<8) | k_user_module_revfx, k_user_target_miniloguexd_osc = (2U<<8) | k_user_module_osc
}
 minilogue xd specific platform/module pairs. More...
 
enum  {
  k_user_target_nutektdigital = (3U<<8), k_user_target_nutektdigital_global = (3U<<8) | k_user_module_global, k_user_target_nutektdigital_modfx = (3U<<8) | k_user_module_modfx, k_user_target_nutektdigital_delfx = (3U<<8) | k_user_module_delfx,
  k_user_target_nutektdigital_revfx = (3U<<8) | k_user_module_revfx, k_user_target_nutektdigital_osc = (3U<<8) | k_user_module_osc
}
 Nu:Tekt NTS-1 digital specific platform/module pairs. More...
 
enum  { k_user_api_1_0_0 = ((1U<<16) | (0U<<8) | (0U)), k_user_api_1_1_0 = ((1U<<16) | (1U<<8) | (0U)) }
 Existing API versions. More...
 

Detailed Description

Macro Definition Documentation

◆ USER_API_IS_COMPAT

#define USER_API_IS_COMPAT (   api)
Value:
((((api) & USER_API_MAJOR_MASK) == (USER_API_VERSION & USER_API_MAJOR_MASK)) \
&& (((api) & USER_API_MINOR_MASK) <= (USER_API_VERSION & USER_API_MINOR_MASK)))

Definition at line 136 of file userprg.h.

◆ USER_TARGET_PLATFORM_IS_COMPAT

#define USER_TARGET_PLATFORM_IS_COMPAT (   tgt)
Value:
((((tgt)&USER_TARGET_PLATFORM_MASK)==k_user_target_prologue) \
|| (((tgt)&USER_TARGET_PLATFORM_MASK)==k_user_target_miniloguexd) \
|| (((tgt)&USER_TARGET_PLATFORM_MASK)==k_user_target_nutektdigital))

Definition at line 109 of file userprg.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Module categories.

Enumerator
k_user_module_global 

Dummy category, may be used in future.

k_user_module_modfx 

Modulation effects.

k_user_module_delfx 

Delay effects.

k_user_module_revfx 

Reverb effects.

k_user_module_osc 

Oscillators.

Definition at line 53 of file userprg.h.

53  {
64  k_num_user_modules,
65  };

◆ anonymous enum

anonymous enum

prologue specific platform/module pairs.

Passed to user code via initialization callback.

Definition at line 70 of file userprg.h.

70  {
71  k_user_target_prologue = (1U<<8),
72  k_user_target_prologue_global = (1U<<8) | k_user_module_global,
73  k_user_target_prologue_modfx = (1U<<8) | k_user_module_modfx,
74  k_user_target_prologue_delfx = (1U<<8) | k_user_module_delfx,
75  k_user_target_prologue_revfx = (1U<<8) | k_user_module_revfx,
76  k_user_target_prologue_osc = (1U<<8) | k_user_module_osc,
77  };

◆ anonymous enum

anonymous enum

minilogue xd specific platform/module pairs.

Passed to user code via initialization callback.

Definition at line 82 of file userprg.h.

82  {
83  k_user_target_miniloguexd = (2U<<8),
84  k_user_target_miniloguexd_global = (2U<<8) | k_user_module_global,
85  k_user_target_miniloguexd_modfx = (2U<<8) | k_user_module_modfx,
86  k_user_target_miniloguexd_delfx = (2U<<8) | k_user_module_delfx,
87  k_user_target_miniloguexd_revfx = (2U<<8) | k_user_module_revfx,
88  k_user_target_miniloguexd_osc = (2U<<8) | k_user_module_osc,
89  };

◆ anonymous enum

anonymous enum

Nu:Tekt NTS-1 digital specific platform/module pairs.

Passed to user code via initialization callback.

Definition at line 94 of file userprg.h.

94  {
95  k_user_target_nutektdigital = (3U<<8),
96  k_user_target_nutektdigital_global = (3U<<8) | k_user_module_global,
97  k_user_target_nutektdigital_modfx = (3U<<8) | k_user_module_modfx,
98  k_user_target_nutektdigital_delfx = (3U<<8) | k_user_module_delfx,
99  k_user_target_nutektdigital_revfx = (3U<<8) | k_user_module_revfx,
100  k_user_target_nutektdigital_osc = (3U<<8) | k_user_module_osc,
101  };

◆ anonymous enum

anonymous enum

Existing API versions.

Major: breaking changes (7bits, cap to 99) Minor: additions only (7bits, cap to 99) Sub: bugfixes only (7bits, cap to 99)

Definition at line 121 of file userprg.h.

121  {
122  k_user_api_1_0_0 = ((1U<<16) | (0U<<8) | (0U)),
123  k_user_api_1_1_0 = ((1U<<16) | (1U<<8) | (0U))
124  };
k_user_module_osc
Oscillators.
Definition: userprg.h:63
k_user_module_revfx
Reverb effects.
Definition: userprg.h:61
k_user_module_modfx
Modulation effects.
Definition: userprg.h:57
USER_API_VERSION
#define USER_API_VERSION
API version targeted by this code.
Definition: userprg.h:127
k_user_module_delfx
Delay effects.
Definition: userprg.h:59
k_user_module_global
Dummy category, may be used in future.
Definition: userprg.h:55