Nu:Tekt NTS-1 digital SDK  v1.1-0
Classes | Macros | Enumerations
Delay Effect Instance (delfx)

Macros

#define __sdram   __attribute__((section(".sdram")))
 This macro can be used to declare a memory buffer in SDRAM space. More...
 

Enumerations

enum  user_delfx_param_id_t {
  k_user_delfx_param_time = 0, k_user_delfx_param_depth, k_user_delfx_param_reserved0, k_user_delfx_param_shift_depth,
  k_num_user_delfx_param_id
}
 User facing parameters. More...
 

Core API

void _hook_init (uint32_t platform, uint32_t api)
 Initialization callback. More...
 
void _hook_process (float *xn, uint32_t frames)
 Processing callback. More...
 
void _hook_suspend (void)
 Suspend callback. More...
 
void _hook_resume (void)
 Resume callback. More...
 
void _hook_param (uint8_t index, int32_t value)
 Parameter change callback. More...
 
#define DELFX_INIT   __attribute__((used)) _hook_init
 
#define DELFX_PROCESS   __attribute__((used)) _hook_process
 
#define DELFX_SUSPEND   __attribute__((used)) _hook_suspend
 
#define DELFX_RESUME   __attribute__((used)) _hook_resume
 
#define DELFX_PARAM   __attribute__((used)) _hook_param
 

Detailed Description

Macro Definition Documentation

◆ __sdram

#define __sdram   __attribute__((section(".sdram")))

This macro can be used to declare a memory buffer in SDRAM space.

E.g.: float g_my_buffer[1024] __sdram;

Definition at line 62 of file userdelfx.h.

Enumeration Type Documentation

◆ user_delfx_param_id_t

User facing parameters.

Enumerator
k_user_delfx_param_time 

Time parameter.

k_user_delfx_param_depth 

Depth parameter.

k_user_delfx_param_shift_depth 

Alternative depth parameter, usually accessible via shift function.

Definition at line 67 of file userdelfx.h.

67  {
72  k_user_delfx_param_reserved0,
75  k_num_user_delfx_param_id

Function Documentation

◆ _hook_init()

void _hook_init ( uint32_t  platform,
uint32_t  api 
)

Initialization callback.

Must be implemented by your custom effect.

Parameters
platformCurrent target platform/module. See userprg.h
apiCurrent API version. See userprg.h

◆ _hook_param()

void _hook_param ( uint8_t  index,
int32_t  value 
)

Parameter change callback.

Must be implemented by your custom effect.

Parameters
indexParameter ID. See user_delfx_param_id_t.
indexParameter value.
Note
All parameters have 10 bit resolution.

◆ _hook_process()

void _hook_process ( float *  xn,
uint32_t  frames 
)

Processing callback.

Must be implemented by your custom effect.

Delay effects must write back their result to the input buffer and are responsible for wet/dry mix balance. Typically wet/dry balance should be controllable via the shift-depth parameter.

Parameters
xnInput/output sample buffer.
framesSize of buffer in frames. (2 samples per frames)
Note
Implementation must support at least up to 64 frames.
Optimize for powers of two.

◆ _hook_resume()

void _hook_resume ( void  )

Resume callback.

Must be implemented by your custom effect.

Called before calls to processing callback resume after being suspended.

◆ _hook_suspend()

void _hook_suspend ( void  )

Suspend callback.

Must be implemented by your custom effect.

Called before effect gets suspended. While suspended the processing callback will not be called.

k_user_delfx_param_depth
Depth parameter.
Definition: userdelfx.h:71
k_user_delfx_param_shift_depth
Alternative depth parameter, usually accessible via shift function.
Definition: userdelfx.h:74
k_user_delfx_param_time
Time parameter.
Definition: userdelfx.h:69
user_delfx_param_id_t
user_delfx_param_id_t
User facing parameters.
Definition: userdelfx.h:67