File: effGetNumMidiInputChannels.md

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 (92 lines) | stat: -rw-r--r-- 3,333 bytes parent folder | download
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
effGetNumMidiInputChannels & effGetNumMidiOutputChannels
========================================================

# environment
- `FstHost` as of [today](https://git.iem.at/zmoelnig/FST/-/tree/1381a3f099df229e5c7a1ccf9061c02da54d6b9a/src/FstHost)
- [JUCE-8.0.6](https://github.com/juce-framework/JUCE/releases/tag/8.0.6) sources

## plugins
- [DecentSampler v1.12.8](https://www.decentsamples.com/product/decent-sampler-plugin/) (accessed 2025-02-18)

- [TAL-Vocoder v3.0.3.0](https://tal-software.com/downloads/plugins/TAL-Vocoder-2_64_linux.zip)
- many more plugins

# walkthrough

From the [JUCE sources](https://github.com/juce-framework/JUCE/blob/8.0.6/modules/juce_audio_plugin_client/juce_audio_plugin_client_VST2.cpp)
we know, that JUCE plugins will typically respond to the
`effGetNumMidiInputChannels` & `effGetNumMidiOutputChannels` opcodes with the value `16`:
```C++
  //
  case Vst2::effGetNumMidiInputChannels:  return handleGetNumMidiInputChannels();
  case Vst2::effGetNumMidiOutputChannels: return handleGetNumMidiOutputChannels();
  //
}
pointer_sized_int handleGetNumMidiInputChannels()
{
    if (supportsMidiIn)
    {
       #ifdef JucePlugin_VSTNumMidiInputs
        return JucePlugin_VSTNumMidiInputs;
       #else
        return 16;
       #endif
    }
    return 0;
}
pointer_sized_int handleGetNumMidiOutputChannels()
{
    if (supportsMidiOut)
    {
       #ifdef JucePlugin_VSTNumMidiOutputs
        return JucePlugin_VSTNumMidiOutputs;
       #else
        return 16;
       #endif
    }
    return 0;
}
```

This should make it simple to find these opcodes, by just trying all (yet unknown) opcodes
and see, which one return `16`.

Unfortunately most plugins I have, never return `16`.
So I decided to just test all effCodes between 9..128 on all the plugins i found on my disk,
and see whether *any* of them returns `16`.

For such batch processing, keep in mind that some opcodes require pointers to valid structures,
so we have to skip a few (unless we want to populate the various structures, which I don't).
So let's try all opcodes *except* for these
- `effEditOpen` (14)
- `effProcessEvents` (25)
- `effSetSpeakerArrangement` (42)
- `effGetSpeakerArrangement` (69)

I found 42 free-as-in-beer, commercial plugins on my disk.
Most plugins would return `0` for any yet-unknown effCode we sent to it.
But very few do not:

| opcode | result | number of plugins |
|--------|--------|-------------------|
| 44     | 1      | 37                |
| 78     | 16     | 2                 |
| 79     | 16     | 1                 |

As we can see, there's a large number of plugins that respond with `1` to the `effCode:44`.
But more importantly, we found a few that respond with `16` to some opcode.
These are the `DecentSampler` (both `effCode:78` and `effCode:79`) and the `TAL-Vocoder` (`effCode:78`).

I'm pretty sure these to are the `eff[GS]etNumMidiInputChannels` opcodes,
but which is which?

The manual of the `TAL-Vocoder` only speaks of the capability to send MIDI date to the plugin,
so I assume that `effCode:78` is `effGetNumMidiInputChannels`.
(also, in other i/o opcode pairs, the input comes right before the output).


| opcode                        | value |
|-------------------------------|-------|
| `effGetNumMidiInputChannels`  | 78    |
| `effGetNumMidiOutputChannels` | 79    |