Change ALSA device default to 'default' from hw:0
[zynaddsubfx-code.git] / doc / nrpn.txt
blobce1696820be39dd9ac918d27e25117f33a65fac3
1 NRPN (Non Registered Parameters Number)
2 ---------------------------------------
4 NRPNs can control all system and insertion effect parameters.
5 For example, you may change the reverb time when playing to keyboard or
6 flanger's lfo frequency.
7 You can disable the NRPN receiving by deselecting the "NRPN" checkbox from the
8 main window (near "Master Keyshift" counter).
9 The controls for system effects can be sent on any midi channel 
10 The controls for insertion effects on channel 0 are for system insertion effects 
11 the controls on channels 1 .. 15 are for the corresponding part insertion effects
13 The parameters are:
15 - NRPN coarse (99 or 0x63)sets the system/insertion effects (4 for system effects or 8 for insertion effects)
16 - NRPN fine (98 or 0x62)sets the number of the effect (first effect is 0)
17 - Data entry coarse (6) sets the parameter number of effect to change(see below)
18 - Data entry fine (26) sets the parameter of the effect
20 You have to send NRPN coarse/fine before sending Data entry coarse/fine.
21 If the effect/parameter doesn't exists or is set to none, then the NRPN is
22 ignored.
24 Example(all values in this example are hex):
26     B0 63 08 // Select the insertion effects
27     B0 62 01 // Select the second effect (remember: the first is 00 and not 01)
28     B0 06 00 // Select the effect parameter 00
29     B0 26 7F // Change the parameter of effect to the value 7F (127)
31 WARNING: Changing of some of the effect parameters produces clicks when sounds
32 passes thru these effects.
33 I advise you to change only when the sound volume that passes thru the effect to be very low (or silence).
34 Some parameters produce clicks when are changed very fast.
36 Here are the effects parameter number (for Data entry coarse).
37 The parameters that produces clicks are written in [red]#red# and have (AC)
38 after their entry (always clicks).
39 The parameter that produces clicks only when they are changed fast are written
40 in [orange]#orange# and have a (FC) after the entry (Fast Clicks).
41 Most parameters has the range from 0 to 127.
42 When parameters have another range, it is written as [low...high] .
44 Reverb
45 ~~~~~~
47 [verse]
48 +[orange]#00 - Volume or Dry/Wet (FC)#
49 [orange]#01 - Pan (FC)#
50 02 - Reverb Time
51 [orange]#03 - Initial Delay (FC)#
52 04 - Initial Delay Feedback
53 [grey]#05 - reserved#
54 [grey]#06 - reserved#
55 07 - Low Pass
56 08 - High Pass
57 09 - High Frequency Damping [64..127] 64=no damping
58 [red]#10 - Reverb Type [0..1] 0 - Random, 1 - Freeverb (AC)#
59 [red]#11 - Room Size (AC)#+
61 Echo
62 ~~~~
64 [verse]
65 +[orange]#00 - Volume or Dry/Wet (FC)#
66 [orange]#01 - Pan (FC)#
67 [red]#02 - Delay (AC)#
68 [red]#03 - Delay between left and right (AC)#
69 [orange]#04 - Left/Right Crossing (FC)#
70 05 - Feedback
71 06 - High Frequency Damp+
74 Chorus
75 ~~~~~~
77 [verse]
78 +[orange]#00 - Volume or Dry/Wet (FC)#
79 [orange]#01 - Pan (FC)#
80 02 - LFO Frequency
81 03 - LFO Randomness
82 04 - LFO Type [0..1]
83 05 - LFO Stereo Difference
84 06 - LFO Depth
85 07 - Delay
86 08 - Feedback
87 [orange]#09 - Left/Right Crossing (FC)#
88 [grey]#10 - reserved#
89 [red]#11 - Mode [0..1] (0=add, 1=subtract) (AC)#+
91 Phaser
92 ~~~~~~
94 [verse]
95 +[orange]#00 - Volume or Dry/Wet (FC)#
96 [orange]#01 - Pan (FC)#
97 02 - LFO Frequency
98 03 - LFO Randomness
99 04 - LFO Type [0..1]
100 05 - LFO Stereo Difference
101 06 - LFO Depth
102 07 - Feedback
103 [red]#08 - Number of stages [0..11] (AC)#
104 [orange]#09 - Let/Right Crossing (FC)#
105 [red]#10 - Mode [0..1] (0=add, 1=subtract) (AC)#
106 11 - Phase+
108 AlienWah
109 ~~~~~~~~
111 [verse]
112 +[orange]#00 - Volume or Dry/Wet (FC)#
113 [orange]#01 - Pan (FC)#
114 02 - LFO Frequency
115 03 - LFO Randomness
116 04 - LFO Type [0..1]
117 05 - LFO Stereo Difference
118 06 - LFO Depth
119 07 - Feedback
120 08 - Delay [0..100]
121 [orange]#09 - Left/Right Crossing (FC)#
122 10 - Phase+
124 Distortion
125 ~~~~~~~~~~
127 [verse]
128 +[orange]#00 - Volume or Dry/Wet (FC)#
129 [orange]#01 - Pan (FC)#
130 02 - Left/Right Crossing
131 [orange]#03 - Drive (FC)#
132 [orange]#04 - Level (FC)#
133 05 - Type [0..11]
134 06 - Invert the signal (negate) [0..1]
135 07 - Low Pass
136 08 - High Pass
137 09 - Mode [0.1] (0=mono,1=stereo)+
142 [verse]
143 +[orange]#00 - Gain (FC)#+
145 All other settings of the EQ are shown in a different way.
146 The N represent the band ("B." setting in the UI) and the first band is 0
147 (and not 1), like it is shown in the UI.
148 Change the "N" with the band you like.
149 If you want to change a band that doesn't exist, the NRPN will be ignored.
151 [verse]
152 +[red]#10+N*5 - Change the mode of the filter [0..9] (AC)#
153 11+N*5 - Band's filter frequency
154 12+N*5 - Band's filter gain
155 13+N*5 - Band's filter Q (bandwidth or resonance)
156 [grey]#14+N*5 - reserved#+
158 Example of setting the gain on the second band:
160 . The bands start counting from  0, so the second band is 1 => N=1.
161 .  The formula is 12+N*5 => 12+1*5=17, so the number of effect parameter
162 .  (for Data entry coarse) is 17.