Reverb Effect Instance (revfx)

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

Enumerations
enum	user_revfx_param_id_t {   k_user_revfx_param_time = 0, k_user_revfx_param_depth, k_user_revfx_param_reserved0, k_user_revfx_param_shift_depth,   k_num_user_revfx_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	REVFX_INIT   __attribute__((used)) _hook_init
#define	REVFX_PROCESS   __attribute__((used)) _hook_process
#define	REVFX_SUSPEND   __attribute__((used)) _hook_suspend
#define	REVFX_RESUME   __attribute__((used)) _hook_resume
#define	REVFX_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 userrevfx.h.

Enumeration Type Documentation

user_revfx_param_id_t

enum user_revfx_param_id_t

User facing parameters.

Enumerator
k_user_revfx_param_time	Time parameter.
k_user_revfx_param_depth	Depth parameter.
k_user_revfx_param_shift_depth	Alternative depth parameter, usually accessible via shift function.

Definition at line 67 of file userrevfx.h.

               {
    k_user_revfx_param_time = 0,
    k_user_revfx_param_depth,
    k_user_revfx_param_reserved0,
    k_user_revfx_param_shift_depth,
    k_num_user_revfx_param_id
  } user_revfx_param_id_t;

Function Documentation

_hook_init()

void _hook_init	(	uint32_t	platform,
		uint32_t	api
	)

Initialization callback.

Must be implemented by your custom effect.

Parameters

platform	Current target platform/module. See userprg.h
api	Current 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

index	Parameter ID. See user_revfx_param_id_t.
index	Parameter 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.

Reverb 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

xn	Input/output sample buffer.
frames	Size 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.