Updated generic midi encoder documentation

This commit is contained in:
Len Ovens 2020-10-25 07:52:45 -07:00
parent 4a7c729106
commit 719642dbc6
2 changed files with 33 additions and 40 deletions

View File

@ -2,8 +2,7 @@
<p> <p>
Encoders are showing up more frequently on controllers. However, they use Encoders are showing up more frequently on controllers. However, they use
the same MIDI events as Continuous Controllers and they have no standard the same MIDI events as Continuous Controllers and they have no standard
way of sending that information as MIDI events. Ardour 4.2 has implemented way of sending that information as MIDI events.
4 of the more common ways of sending encoder information.
</p> </p>
<p> <p>
Encoders that send the same continuous values as a pot would are not Encoders that send the same continuous values as a pot would are not
@ -14,30 +13,34 @@
DAW will add to or subtract from the current value. DAW will add to or subtract from the current value.
</p> </p>
<p> <p>
The 4 kinds of encoder supported are: The 4 kinds of 7 bit encoders supported are:
</p> </p>
<ul> <ul>
<li> <li>
enc-r: On the bcr/bcf2000 this is called "Relative Signed Bit". The most enc-r: Relative Signed Bit. If the most sign bit is set, Then
significant bit sets positive and the lower 6 significant bits are the the offset is positive. The lower 6 significant bits are the
offset. offset. <code>&lt;Binding channel="1" enc-r="13" &hellip;</code>
The offset value is formed as <code>0svvvvvv</code>. Where s is the
sign or direction and vvvvvv is the number of ticks turned.
</li> </li>
<li> <li>
enc-l: The bcr2000 calls this "Relative Signed Bit 2". The most enc-l: Relative Signed Bit 2". If the most sign bit is unset,
significant bit sets negative and the lower 6 significant bits are the Then the offset is positive. The lower 6 significant bits are the
offset. If you are using one of these two and the values are right but offset. This is the same as enc-r but with the direction of turn
reversed, use the other. This one is the one the Mackie Control Protocol reversed. This is the method the Mackie Control Protocol
uses. uses. <code>&lt;Binding channel="1" enc-l="13" &hellip;</code>
The offset value is formed as <code>0svvvvvv</code>. Where s is the
sign or direction and vvvvvv is the number of ticks turned.</li>
<li>
enc-2: Relative 2s Complement. Positive offsets are sent as normal
from 1 to 64 and negative offsets are sent as 2s complement negative
numbers. This is a signed 7 bit int.
<code>&lt;Binding channel="1" enc-2="13" &hellip;</code>
</li> </li>
<li> <li>
enc-2: The bcr2000 calls this one "Relative 2s Complement". Positive enc-b: Relative Binary Offset. Positive offsets are sent as offset
offsets are sent as normal from 1 to 64 and negative offsets are sent as plus 64 and negative offsets are sent as 64 minus offset. 64 is zero,
2s complement negative numbers. 65 is +1, 63 is -1. <code>&lt;Binding channel="1" enc-b="13" &hellip;</code>
</li>
<li>
enc-b: The bcr2000 calls this one "Relative Binary Offset". Positive
offsets are sent as offset plus 64 and negative offsets are sent as 64
minus offset.
</li> </li>
</ul> </ul>
<p> <p>
@ -51,3 +54,10 @@
the surface. the surface.
</p> </p>
14 bit encoders are also supported with:
<ul>
<li>rpn-delta - The value is expected to be a signed 14bit value
that is added to the current value. For use with encoders</li>
<li>nrpn-delta - The value is expected to be a signed 14bit value
that is added to the current value. For use with encoders</li>
</ul>

View File

@ -152,29 +152,12 @@ bindings"&gt;
that is added to the current value. For use with encoders</li> that is added to the current value. For use with encoders</li>
<li>nrpn-delta - The value is expected to be a signed 14bit value <li>nrpn-delta - The value is expected to be a signed 14bit value
that is added to the current value. For use with encoders</li> that is added to the current value. For use with encoders</li>
<li>enc-r, enc-l, enc-2 and enc-b - For 7 bit encoders. See below</li> <li>enc-r, enc-l, enc-2 and enc-b - For 7 bit encoders.
<a href="@@generic-midi-and-encoders"> Learn more about working
with encoders </a></li>
</ul> </ul>
</p> </p>
<p>
As of Ardour 4.2, <code>enc-r</code>, <code>enc-l</code>, <code>enc-2</code> and
<code>enc-b</code> may be used for surfaces that have encoders that send
offsets rather than values. These accept Continuous Controller messages
but treat them as offsets. These are good for banked controls as they are
always at the right spot to start adjusting. (
<a href="@@generic-midi-and-encoders">
Learn more about working with encoders
</a>)
</p>
<p>
<ul>
<li><code>&lt;Binding channel="1" enc-r="13" &hellip;</code></li>
<li><code>&lt;Binding channel="1" enc-l="13" &hellip;</code></li>
<li><code>&lt;Binding channel="1" enc-2="13" &hellip;</code></li>
<li><code>&lt;Binding channel="1" enc-b="13" &hellip;</code></li>
</ul>
The <code>enc-*</code> value is the CC number used by the encoder.
Encoders only work with CC messages.
</p>
<p class="note"> <p class="note">
Ardour 5.12 has a bug with the encoder detection where the first Ardour 5.12 has a bug with the encoder detection where the first
encoder message resets the control to 0. Setting "Enable Feedback" encoder message resets the control to 0. Setting "Enable Feedback"