forked from korginc/logue-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathusermodfx.h
190 lines (159 loc) · 5.81 KB
/
usermodfx.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*
BSD 3-Clause License
Copyright (c) 2018, KORG INC.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//*/
/**
* @file usermodfx.h
* @brief C interface header for user modulation fx.
*
* @addtogroup fx Effects
* @{
*
* @addtogroup modfx_inst Modulation Effect Instance (modfx)
* @{
*/
#ifndef __usermodfx_h
#define __usermodfx_h
#include <stdint.h>
#include "fx_api.h"
#include "userprg.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* This macro can be used to declare a memory buffer in SDRAM space.
*
* E.g.: float g_my_buffer[1024] __sdram;
*/
#define __sdram __attribute__((section(".sdram")))
/**
* User facing parameters
*/
typedef enum {
/** Time parameter */
k_user_modfx_param_time = 0,
/** Depth parameter */
k_user_modfx_param_depth,
k_num_user_modfx_param_id
} user_modfx_param_id_t;
/** @private */
typedef void (*UserModFXFuncEntry)(uint32_t platform, uint32_t api);
/** @private */
typedef void (*UserModFXFuncInit)(uint32_t platform, uint32_t api);
/** @private */
typedef void (*UserModFXFuncProcess)(const float *main_xn, float *main_yn,
const float *sub_xn, float *sub_yn,
uint32_t frames);
/** @private */
typedef void (*UserModFXSuspend)(void);
/** @private */
typedef void (*UserModFXResume)(void);
/** @private */
typedef void (*UserModFXFuncParam)(uint8_t index, int32_t value);
/** @private */
typedef void (*UserModFXFuncDummy)(void);
/** @private */
#pragma pack(push, 1)
typedef struct user_modfx_hook_table {
uint8_t magic[4];
uint32_t api;
uint8_t platform;
uint8_t reserved0[7];
UserModFXFuncEntry func_entry;
UserModFXFuncProcess func_process;
UserModFXSuspend func_suspend;
UserModFXResume func_resume;
UserModFXFuncParam func_param;
UserModFXFuncDummy reserved1[7];
} user_modfx_hook_table_t;
#pragma pack(pop)
/** @private */
#pragma pack(push, 1)
typedef struct user_modfx_data {
user_prg_header_t header;
user_modfx_hook_table_t hooks;
// code bytes following
} user_modfx_data_t;
#pragma pack(pop)
/**
* @name Core API
* @{
*/
#define MODFX_INIT __attribute__((used)) _hook_init
#define MODFX_PROCESS __attribute__((used)) _hook_process
#define MODFX_SUSPEND __attribute__((used)) _hook_suspend
#define MODFX_RESUME __attribute__((used)) _hook_resume
#define MODFX_PARAM __attribute__((used)) _hook_param
/** @private */
void _entry(uint32_t platform, uint32_t api);
/**
* Initialization callback. Must be implemented by your custom effect.
*
* @param platform Current target platform/module. See userprg.h
* @param api Current API version. See userprg.h
*/
void _hook_init(uint32_t platform, uint32_t api);
/**
* Processing callback. Must be implemented by your custom effect.
*
* @param main_xn Input sample buffer for main timbre
* @param main_yn Output sample buffer for main timbre
* @param sub_xn Input sample buffer for sub timbre
* @param sub_yn Output sample buffer for sub timbre
* @param frames Size of buffers. (2 samples per frames)
*
* @note Implementation must support at least up to 64 frames.
* @note Optimize for powers of two.
* @note On platforms that do not have a sub timbre the sub_xn / sub_yn parameters can be ignored.
*/
void _hook_process(const float *main_xn, float *main_yn,
const float *sub_xn, float *sub_yn,
uint32_t frames);
/**
* Suspend callback. Must be implemented by your custom effect.
*
* Called before effect gets suspended. While suspended the processing callback will not be called.
*/
void _hook_suspend(void);
/**
* Resume callback. Must be implemented by your custom effect.
*
* Called before calls to processing callback resume after being suspended.
*/
void _hook_resume(void);
/**
* Parameter change callback. Must be implemented by your custom effect.
*
* @param index Parameter ID. See user_modfx_param_id_t.
* @param index Parameter value.
*
* @note All parameters have 10 bit resolution.
*/
void _hook_param(uint8_t index, int32_t value);
/** @} */
#ifdef __cplusplus
} // extern "C"
#endif
#endif // __usermodfx_h
/** @} @} */