userprg.h File Reference

Common C interface header for custom user programs. More...

#include <stdint.h>

Go to the source code of this file.

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

Common C interface header for custom user programs.

Definition in file userprg.h.