File: opcodes.org

package info (click to toggle)
fst 0.177.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 732 kB
  • sloc: cpp: 1,531; ansic: 1,312; sh: 79; makefile: 73; python: 71
file content (257 lines) | stat: -rw-r--r-- 30,769 bytes parent folder | download | duplicates (2)
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

* opcode tables

** host

| opcode | value                                  | notes                                                                             |
|--------+----------------------------------------+-----------------------------------------------------------------------------------|
|      0 | audioMasterAutomate                    |                                                                                   |
|      1 | audioMasterVersion                     | :JUCE returns 2400                                                                |
|      2 | audioMasterCurrentId?                  | :REAPER returns 0xDEAD                                                            |
|        |                                        | :REAPER-plugins call this in the ctor                                             |
|      6 | audioMasterWantMidi                    | :called as response to effMainsChanged with ivalue=1                              |
|        |                                        | :REAPER returns 1                                                                 |
|      7 | audioMasterGetTime                     | :called by hypercyclic/tonespace as response to effMainsChanged with ivalue=65024 |
|        |                                        | :REAPER returns an address                                                        |
|      8 | audioMasterProcessEvents               | :REAPER returns 1                                                                 |
|        |                                        | :REAPER crashes with tained VstEvents-data                                        |
|     10 | audioMasterTempoAt                     |                                                                                   |
|     11 | ?                                      | :REAPER returns 0x10000 (65536)                                                   |
|     12 | ?                                      | :REAPER returns 1                                                                 |
|     13 | ?                                      | :called with 0-args in Protoverb:main and hypercyclic:eff:12                      |
|    13? | ?                                      | :Protoverb calls in main (and as response to effcode:30514?)                      |
|     14 | ?                                      | :Renoise_Redux calls this (without args) in main                                  |
|        |                                        | :REAPER returns 0                                                                 |
|     15 | audioMasterSizeWindow                  |                                                                                   |
|     16 | audioMasterGetSampleRate               |                                                                                   |
|     17 | audioMasterGetBlockSize                |                                                                                   |
|     19 | ?                                      | :REAPER returns 0x2800,  0x33FF, 0x2FFF, 0x3400, 0x3000 when called...            |
|        |                                        | :...repeatedly while handling effProcessEvents (args are ignored)                 |
|     23 | audioMasterGetCurrentProcessLevel      | :called by JUCE-plugins with 0-args as response to effMainsChanged                |
|     32 | audioMasterGetVendorString             |                                                                                   |
|     33 | audioMasterGetProductString            |                                                                                   |
|     34 | audioMasterGetVendorVersion            | :JUCE returns 0x0101 (257)                                                        |
|     37 | audioMasterCanDo                       |                                                                                   |
|     42 | ?                                      | :Protoverb calls as response to effSetProgramName                                 |
|     43 | audioMasterBeginEdit                   | :called by JUCE-plugins with index of a GUI-changed parameter (no more args)      |
|     44 | audioMasterEndEdit                     | :called by JUCE-plugins with index of a GUI-changed parameter (no more args)      |
|     48 | audioMasterGetDirectory?               | :REAPER returns filename of reaper-project file (.RPP)                            |
|--------+----------------------------------------+-----------------------------------------------------------------------------------|
|        | audioMasterCurrentId?                  |                                                                                   |
|        | audioMasterGetDirectory?               |                                                                                   |
|        | audioMasterUpdateDisplay               |                                                                                   |
|        | audioMasterGetAutomationState          |                                                                                   |
|        | audioMasterGetNumAutomatableParameters |                                                                                   |
|        | audioMasterIdle                        |                                                                                   |
|        | audioMasterIOChanged                   |                                                                                   |
|        | audioMasterNeedIdle                    |                                                                                   |
|        | audioMasterPinConnected                |                                                                                   |
|        | audioMasterSetOutputSampleRate         |                                                                                   |
|--------+----------------------------------------+-----------------------------------------------------------------------------------|
|        | audioMasterGetLanguage                 | JUCE-ignore                                                                       |
|        | audioMasterGetOutputSpeakerArrangement | JUCE-ignore                                                                       |
|        | audioMasterGetParameterQuantization    | JUCE-ignore                                                                       |
|        | audioMasterGetPreviousPlug             | JUCE-ignore                                                                       |
|        | audioMasterGetNextPlug                 | JUCE-ignore                                                                       |
|        | audioMasterSetTime                     | JUCE-ignore                                                                       |
|        | audioMasterWillReplaceOrAccumulate     | JUCE-ignore                                                                       |
|        | audioMasterGetInputLatency             | JUCE-ignore                                                                       |
|        | audioMasterGetOutputLatency            | JUCE-ignore                                                                       |
|        | audioMasterOpenWindow                  | JUCE-ignore                                                                       |
|        | audioMasterCloseWindow                 | JUCE-ignore                                                                       |
|        | audioMasterSetIcon                     | JUCE-ignore                                                                       |
|        | audioMasterOfflineGetCurrentMetaPass   | JUCE-ignore                                                                       |
|        | audioMasterOfflineGetCurrentPass       | JUCE-ignore                                                                       |
|        | audioMasterOfflineRead                 | JUCE-ignore                                                                       |
|        | audioMasterOfflineStart                | JUCE-ignore                                                                       |
|        | audioMasterOfflineWrite                | JUCE-ignore                                                                       |
|        | audioMasterVendorSpecific              | JUCE-ignore                                                                       |
|        |                                        |                                                                                   |



** plugin


|     opcode | value                       | notes                                                                                                   |
|------------+-----------------------------+---------------------------------------------------------------------------------------------------------|
|          0 | effOpen                     | :REAPER calls with 0 (at the very beginning)                                                            |
|          1 | effClose                    | :CRASH                                                                                                  |
|            |                             | :REAPER calls with 0 (at the very end)                                                                  |
|          2 | effSetProgram               | set program# via ivalue                                                                                 |
|          3 | effGetProgram               | returns current program#                                                                                |
|          4 | effSetProgramName           | :needs a valid ptr, Protoverb calls hostCode:42                                                         |
|          5 | effGetProgramName           | writes current program name into ptr                                                                    |
|          6 | effGetParamLabel            | unit (e.g. "dB")                                                                                        |
|          7 | effGetParamDisplay          | string representation of current value (e.g. "-23")                                                     |
|          8 | effGetParamName             | human readable name (e.g. "Gain")                                                                       |
|          9 |                             |                                                                                                         |
|         10 | effSetSampleRate            | :Protoverb prints "AM_AudioMan::reset()"                                                                |
|         11 | effSetBlockSize             |                                                                                                         |
|         12 | effMainsChanged             | :Protoverb does resume/reset and calls audioMasterWantMidi                                              |
|            |                             | :Digits calls audioMasterWantMidi                                                                       |
|            |                             | :BowEcho/Danaides calls audioMasterWantMidi, audioMasterGetCurrentProcessLevel                          |
|            |                             | :hypercyclic/tonespace calls audioMasterWantMidi, audioMasterGetTime, audioMasterGetCurrentProcessLevel |
|            |                             | :REAPER calls with ivalue=1/0                                                                           |
|         13 | effEditGetRect              | :Protoverb prints "AM_VST_Editor::getRect" and CRASH                                                    |
|         14 | effEditOpen                 | :Protoverb prints "AM_VST_Editor::open" and EXIT                                                        |
|         15 | effEditClose                | :Protoverb prints "closed editor."                                                                      |
|         19 | effEditIdle                 | :REAPER calls repeatedly every 50ms                                                                     |
|            |                             | :JUCE (>=7?) requires polling for GUI                                                                   |
|         22 | effIdentify                 | :Protoverv returns 0x4E764566                                                                           |
|         23 | effGetChunk                 | :Protoverb returns 0x317 (or 0x307) and writes an address into ptr                                      |
|         24 | effSetChunk                 | :Protoverb returns 1                                                                                    |
|         25 | effProcessEvents            | :Protoverb returns 1                                                                                    |
|         26 |                             | :Protoverb returns 1                                                                                    |
|         29 | effGetProgramNameIndexed    | :Protoverb returns 1 and ptr:"initialize"                                                               |
|         33 | effGetInputProperties       | :Protoverb returns 1 and ptr:"Protoverb-In0"                                                            |
|         34 | effGetOutputProperties      | :Protoverb returns 1 and ptr:"Protoverb-Out0"                                                           |
|         35 | effGetPlugCategory          | :JUCE RETURNS VstPlugCategory                                                                           |
|         35 |                             | :REAPER calls with 0                                                                                    |
|            |                             | :InstaLooper returns 0                                                                                  |
|            |                             | :Protoverb/BowEcho/Danaides/reacom.vst returns 1                                                        |
|            |                             | :Digits/hypercyclic/tonespace returns 2                                                                 |
|         41 |                             | :crashes when called with (0,0,"name41",0)                                                              |
|         45 | effGetEffectName            | :Protoverb returns 1 and ptr:"Protoverb"                                                                |
|         47 | effGetVendorString          | :Protoverb returns 1 and ptr:"u-he"; prints getVendorString()                                           |
|         48 | effGetProductString         | :Protoverb returns 1 and ptr:"Protoverb 1.0.0"                                                          |
|         49 | effGetVendorVersion         | :Protoverb returns 0x10000                                                                              |
|         50 | effVendorSpecific           | :REAPER only calls this if 'hasCockosExtensions' is supported                                          |
|         51 | effCanDo                    | :Protoverb returns 0xFFFFFFFFFFFFFFFF (with ptr:"")                                                     |
|         53 |                             | :REAPER calls repeatedly every 50ms                                                                     |
|         56 |                             | :REAPER calls with ptr to zeroed memory                                                                 |
|            |                             | :all return 0                                                                                           |
|         58 | effGetVstVersion            | :Protoverb returns 2400 (0x960)                                                                         |
|         59 | effKeysRequired?            | :Protoverb prints "u-he plugin doesn't use key"                                                         |
|         63 |                             | :Protoverb returns  0xFFFFFFFFFFFFFFFF (with ptr:"")                                                    |
|         71 |                             | :REAPER calls with 0                                                                                    |
|            |                             | :Protoverb returns 1, rest returns 0                                                                    |
|         72 |                             | :REAPER calls with 0                                                                                    |
|         77 | effSetProcessPrecision      | :REAPER calls with 1                                                                                    |
|            |                             | :Protoverb returns 1, rest returns 0                                                                    |
|      30514 |                             | :Protoverb calls hostCode:13                                                                            |
| 0xDEADBEEF |                             | :REAPER ask for function?                                                                               |
|------------+-----------------------------+---------------------------------------------------------------------------------------------------------|
|            | effGetTailSize              |                                                                                                         |
|            | effGetCurrentMidiProgram    |                                                                                                         |
|            | effGetSpeakerArrangement    |                                                                                                         |
|            | effGetNumMidiInputChannels  |                                                                                                         |
|            | effGetNumMidiOutputChannels |                                                                                                         |
|            |                             |                                                                                                         |
|            | effCanBeAutomated           | :takes index                                                                                            |
|            | effString2Parameter         |                                                                                                         |
|            | effSetSpeakerArrangement    |                                                                                                         |
|            | effSetBypass                |                                                                                                         |
|            | effSetTotalSampleToProcess  |                                                                                                         |
|            | effConnectInput             |                                                                                                         |
|            | effConnectOutput            |                                                                                                         |
|            | effIdle                     |                                                                                                         |
|            | effShellGetNextPlugin       |                                                                                                         |
|            | effStartProcess             |                                                                                                         |
|            | effStopProcess              |                                                                                                         |
|            | effEditDraw                 |                                                                                                         |
|            | effEditMouse                |                                                                                                         |
|            | effEditSleep                |                                                                                                         |
|            | effEditTop                  |                                                                                                         |

** flags

| bit | name                       | notes                 |
|-----+----------------------------+-----------------------|
|   1 | effFlagsHasEditor          |                       |
|   2 |                            | always 0              |
|   3 |                            | always 0              |
|   4 |                            | always 0              |
|   5 | ??                         | always 1              |
|   6 | ??                         | InstaLooper=0, else 1 |
|   7 |                            | always 0              |
|   8 |                            | always 0              |
|   9 | effFlagsIsSynth            |                       |
|  10 | ??                         |                       |
|  11 |                            | always 0              |
|  12 |                            | always 0              |
|  13 |                            | always 0              |
|  14 |                            | always 0              |
|  15 |                            | always 0              |
|  16 |                            | always 0              |
|-----+----------------------------+-----------------------|
|   ? | effFlagsCanDoubleReplacing |                       |
|   ? | effFlagsCanReplacing       |                       |
|   ? | effFlagsNoSoundInStop      |                       |
|   ? | effFlagsProgramChunks      |                       |


* Host opcodes and how they are handled by JUCE


| audioMaster-opcode                     | IN               | OUT         |           return | notes                                                           |
|----------------------------------------+------------------+-------------+------------------+-----------------------------------------------------------------|
| audioMasterAutomate                    | index, fvalue    | -           |                0 |                                                                 |
| audioMasterProcessEvents               | ptr(VstEvents*)) | -           |                0 |                                                                 |
| audioMasterGetTime                     | -                | -           |         &vsttime |                                                                 |
| audioMasterIdle                        | -                | -           |                0 |                                                                 |
| audioMasterSizeWindow                  | index, value     |             |                1 | setWindowSize(index,value)                                      |
| audioMasterUpdateDisplay               | -                | -           |                0 | triggerAsyncUpdate()                                            |
| audioMasterIOChanged                   | -                | -           |                0 | setLatencyDelay                                                 |
| audioMasterNeedIdle                    | -                | -           |                0 | startTimer(50)                                                  |
| audioMasterGetSampleRate               | -                | -           |       samplerate |                                                                 |
| audioMasterGetBlockSize                | -                | -           |        blocksize |                                                                 |
| audioMasterWantMidi                    | -                | -           |                0 | wantsMidi=true                                                  |
| audioMasterGetDirectory                | -                | -           | (char*)directory |                                                                 |
| audioMasterTempoAt                     | -                | -           |        10000*bpm |                                                                 |
| audioMasterGetAutomationState          | -                | -           |        0/1/2/3/4 | 0 = not supported, 1 = off, 2 = read, 3 = write, 4 = read/write |
| audioMasterBeginEdit                   | index            | -           |                0 | gesture                                                         |
| audioMasterEndEdit                     | index            | -           |                0 | gesture                                                         |
| audioMasterPinConnected                | index,value      | -           |              0/1 | 0=true; value=direction                                         |
| audioMasterGetCurrentProcessLevel      | -                | -           |              4/0 | 4 if not realtime                                               |
|----------------------------------------+------------------+-------------+------------------+-----------------------------------------------------------------|
| audioMasterCanDo                       | ptr(char[])      | -           |              1/0 | 1 if we can handle feature                                      |
| audioMasterVersion                     | -                | -           |             2400 |                                                                 |
| audioMasterCurrentId                   | -                | -           | shellUIDToCreate |                                                                 |
| audioMasterGetNumAutomatableParameters | -                | -           |                0 |                                                                 |
| audioMasterGetVendorVersion            | -                | -           |           0x0101 |                                                                 |
| audioMasterGetVendorString             | -                | ptr(char[]) |              ptr | getHostName()                                                   |
| audioMasterGetProductString            | -                | ptr(char[]) |              ptr | getHostName()                                                   |
| audioMasterSetOutputSampleRate         | -                | -           |                0 |                                                                 |
|----------------------------------------+------------------+-------------+------------------+-----------------------------------------------------------------|
| audioMasterGetLanguage                 |                  |             |                  | JUCE-ignore                                                     |
| audioMasterGetOutputSpeakerArrangement |                  |             |                  | JUCE-ignore                                                     |
| audioMasterGetParameterQuantization    |                  |             |                  | JUCE-ignore                                                     |
| audioMasterGetPreviousPlug             |                  |             |                  | JUCE-ignore                                                     |
| audioMasterGetNextPlug                 |                  |             |                  | JUCE-ignore                                                     |
| audioMasterSetTime                     |                  |             |                  | JUCE-ignore                                                     |
| audioMasterWillReplaceOrAccumulate     |                  |             |                  | JUCE-ignore                                                     |
| audioMasterGetInputLatency             |                  |             |                  | JUCE-ignore                                                     |
| audioMasterGetOutputLatency            |                  |             |                  | JUCE-ignore                                                     |
| audioMasterOpenWindow                  |                  |             |                  | JUCE-ignore                                                     |
| audioMasterCloseWindow                 |                  |             |                  | JUCE-ignore                                                     |
| audioMasterSetIcon                     |                  |             |                  | JUCE-ignore                                                     |
| audioMasterOfflineGetCurrentMetaPass   |                  |             |                  | JUCE-ignore                                                     |
| audioMasterOfflineGetCurrentPass       |                  |             |                  | JUCE-ignore                                                     |
| audioMasterOfflineRead                 |                  |             |                  | JUCE-ignore                                                     |
| audioMasterOfflineStart                |                  |             |                  | JUCE-ignore                                                     |
| audioMasterOfflineWrite                |                  |             |                  | JUCE-ignore                                                     |
| audioMasterVendorSpecific              |                  |             |                  | JUCE-ignore                                                     |
|                                        |                  |             |                  |                                                                 |


* effcode:12 effMainsChanged

** JUCE resume
   - isProcessLevelOffline()
     - hostCallback (&vstEffect, Vst2::audioMasterGetCurrentProcessLevel, 0, 0, 0, 0);
   - deleteTempChannels()
   - hostCallback (&vstEffect, Vst2::audioMasterWantMidi, 0, 1, 0, 0);
   -


23/autioMasterGetTime/6
- 23: audioMasterGetCurrentProcessLevel
-  6: audioMasterWantMidi


| opcode                            | value |
|-----------------------------------+-------|
| effMainsChanged                   |    12 |
| audioMasterWantMidi               |     6 |
| audioMasterGetCurrentProcessLevel |    23 |