Shamusworld >> Repos - ardour-manual/blob - include/osc58-feedback.html

   1
   2 <p>
   3   Feedback from the Ardour to the the control surface is very useful for
   4   a number of things. Motor faders need to know where the the track
   5   they have been attached to is at before they were assigned otherwise
   6   the DAW fader will jump to where the controller fader is. Likewise,
   7   the buttons on each strip need to know what their value is so they can
   8   light their LED correctly. Transport controls should let you know if
   9   they are active too. This is what feedback is all about.
  10 </p>
  11 <p>
  12   Ardour does feedback by sending the same path back that is used to
  13   control the same function. As such any controls that have feedback
  14   have a parameter that is the value of the control or its state
  15   (on or off). In the case of OSC paths listed on the main OSC page
  16   as having no parameter, if they have feedback, they will also work
  17   with a 1 for button press and 0 for button release. This is because
  18   many OSC controllers will only use exactly the same path for feedback
  19   as for control. For example:
  20 </p>
  21
  22 <table class="dl">
  23   <tr><th><kbd class="osc">/transport_stop</kbd></th>
  24   <td></td></tr>
  25 </table>
  26 <p>can be used also in the form:</p>
  27
  28 <table class="dl">
  29   <tr><th><kbd class="osc">/transport_stop <em>press</em></kbd></th>
  30   <td>where <em>press</em> is an int/bool indicating if the button is pressed or not.</td></tr>
  31 </table>
  32
  33 <p>
  34   The feedback does not have the same meaning as the control message.
  35   Where the button release sent to Ardour will be ignored and has no
  36   meaning. Both states have meaning in feedback to the controller.
  37   The feedback will be:
  38 </p>
  39
  40 <table class="dl">
  41   <tr><th><kbd class="osc">/transport_stop <em>state</em></kbd></th>
  42   <td>where <em>state</em> is an int/bool indicating if the transport is stopped or not.</td></tr>
  43 </table>
  44 <p>
  45   With feedback turned on, OSC control commands that try to change a
  46   control that does not exist will get feedback that resets that control
  47   to off. For example, sending a /strip/recenable to a buss will not work
  48   and Ardour will try to turn the controller LED off in that case. Also
  49   note that Pan operation may be limited by pan width in some cases.
  50   That is with pan width at 100% (or -100%) there is no pan position
  51   movement available.
  52 </p>
  53 <p>
  54   It may come as a surprise, but feedback often generates more network
  55   traffic than control itself does. Some things are more obvious like
  56   head position or meters. But even a simple button push like transport
  57   start sends not only a signal to turn on the play LED, but also one to
  58   turn off the stop LED, the Rewind LED, the Fast Forward LED and the
  59   Loop LED. That is still minor, think instead of a surface refresh
  60   such as happens when the surface is first connected and then most of
  61   that happens every time the fader strips are banked. This is why
  62   feedback is enabled in sections so that as little feedback as is
  63   actually needed is sent. This is also a consideration if the surface
  64   is connected via wifi.
  65 </p>
  66 <h2>List of OSC feedback messages</h2>
  67
  68 <h3>Feedback only</h3>
  69 <p>
  70   These messages are feedback only. They are sent as status from Ardour
  71   and some of them may be enabled separately from other feedback. See:
  72   <a href="@@osc58-feedback-and-strip-types-values#feedback">
  73   Calculating Feedback and Strip-types Values.</a>
  74 </p>
  75 <p class="note">
  76   See strip section below for info about ssid and wrapping it into the
  77   path. Also /master and /monitor support what the /strip does.
  78 </p>
  79 <p>
  80   In the case where Gainmode is set to position, the track name will
  81   show the dB value while values are changing.
  82 </p>
  83 <table class="dl">
  84   <tr><th><kbd class="osc">/strip/name <em>ssid</em> <em>track_name</em></kbd></th>
  85   <td>where <em>track_name</em> is a string representing the name of the track</td></tr>
  86   <tr><th><kbd class="osc">/strip/*/automation_name <em>ssid</em>  <em>name</em></kbd></th>
  87   <td>where <em>name</em> is a string representing the current automation mode for the control.
  88   <a href="@@osc58-automation">See OSC Automation.</a></td></tr>
  89   <tr><th><kbd class="osc">/session_name <em>session_name</em></kbd></th>
  90   <td>where <em>session_name</em> is a string representing the name of the session</td></tr>
  91   <tr><th><kbd class="osc">/strip/meter <em>ssid</em> <em>meter</em></kbd></th>
  92   <td>where <em>meter</em> is a value representing the current audio level.
  93   (the exact math used is determined by the feedback bits set)</td></tr>
  94   <tr><th><kbd class="osc">/strip/signal <em>ssid</em> <em>signal</em></kbd></th>
  95   <td>where <em>signal</em> is a float indicating the instantaneous
  96   audio level is -40dB or higher.</td></tr>
  97   <tr><th><kbd class="osc">/position/smpte <em>time</em></kbd></th>
  98   <td>where <em>time</em> is a string with the current play head time. Seconds as per smpte.</td></tr>
  99   <tr><th><kbd class="osc">/position/bbt <em>beat</em></kbd></th>
 100   <td>where <em>beat</em> is a string with the current play head bar/beat.</td></tr>
 101   <tr><th><kbd class="osc">/position/time <em>time</em></kbd></th>
 102   <td>where <em>time</em> is a string with the current play head time. Seconds are in milliseconds</td></tr>
 103   <tr><th><kbd class="osc">/position/samples <em>samples</em></kbd></th>
 104   <td>where <em>samples</em> is a string with the current play head position in samples.</td></tr>
 105   <tr><th><kbd class="osc">/heartbeat <em>LED</em></kbd></th>
 106   <td>where <em>LED</em> is a float that cycles 1/0 at 1 second intervals.</td></tr>
 107   <tr><th><kbd class="osc">/record_tally <em>state</em></kbd></th>
 108   <td>Some record enable is true or "ready to record". For a "Recording" sign at studio door.</td></tr>
 109 </table>
 110
 111 <h3>Transport Control</h3>
 112 <table class="dl">
 113   <tr><th><kbd class="osc">/transport_stop <em>state</em></kbd></th>
 114   <td><em>state</em> is true when transport is stopped</td></tr>
 115   <tr><th><kbd class="osc">/transport_play <em>state</em></kbd></th>
 116   <td><em>state</em> is true when transport speed is 1.0</td></tr>
 117   <tr><th><kbd class="osc">/ffwd <em>state</em></kbd></th>
 118   <td><em>state</em> is true when transport is moving forward but not at speed 1.0</td></tr>
 119   <tr><th><kbd class="osc">/rewind <em>state</em></kbd></th>
 120   <td><em>state</em> is true when transport speed is less than 0.0</td></tr>
 121   <tr><th><kbd class="osc">/marker <em>position</em></kbd></th>
 122   <td><em>position</em> is a string in the form <kbd class="osc">previous &lt;-&gt; next</kbd>
 123   or <kbd class="osc">current</kbd> (new Ardour 6.0)</td></tr>
 124   <tr><th><kbd class="osc">/loop_toggle <em>state</em></kbd></th>
 125   <td><em>state</em> is true when loop mode is true</td></tr>
 126   <tr><th><kbd class="osc">/cancel_all_solos <em>state</em></kbd></th>
 127   <td>Where <em>state</em> true indicates there are active solos that can be canceled.</td></tr>
 128   <tr><th><kbd class="osc">/jog/mode/name <em>name</em></kbd></th>
 129   <td>Where <em>name</em> is a string indicating the name of the current jog mode.</td></tr>
 130 </table>
 131
 132 <h3>Recording control</h3>
 133 <table class="dl">
 134   <!--dt><kbd class="osc">/toggle_punch_in</kbd></th>
 135   <td></td></tr>
 136   <tr><th><kbd class="osc">/toggle_punch_out</kbd></th>
 137   <td></dd-->
 138   <tr><th><kbd class="osc">/rec_enable_toggle <em>state</em></kbd></th>
 139   <td>Master record enabled.</td></tr>
 140 </table>
 141
 142 <h3>Master and monitor strips</h3>
 143 <p>
 144   Master and monitor strips are similar to track strips but do not use
 145   the SSID. Rather they use their name as part of the path:
 146 </p>
 147 <table class="dl">
 148   <tr><th><kbd class="osc">/master/gain <em>dB</em></kbd></th>
 149   <td>where <em>dB</em> is a float ranging from -193 to +6 representing the actual gain of master in dB</td></tr>
 150   <tr><th><kbd class="osc">/master/fader  <em>position</em></kbd></th>
 151   <td>where <em>position</em> is an int ranging from 0 to 1023 representing the fader control position</td></tr>
 152   <tr><th><kbd class="osc">/master/trimdB <em>dB</em></kbd></th>
 153   <td>where <em>dB</em> is a float ranging from -20 to +20 representing the actual trim for master in dB</td></tr>
 154   <tr><th><kbd class="osc">/master/pan_stereo_position <em>position</em></kbd></th>
 155   <td>where <em>position</em> is a float ranging from 0 to 1 representing the actual pan position for master</td></tr>
 156   <tr><th><kbd class="osc">/master/mute  <em>state</em></kbd></th>
 157   <td>where <em>state</em> is a bool/int representing the actual mute state of the Master strip</td></tr>
 158   <tr><th><kbd class="osc">/monitor/gain <em>dB</em></kbd></th>
 159   <td>where <em>dB</em> is a float ranging from -193 to 6 representing the actual gain of monitor in dB</td></tr>
 160   <tr><th><kbd class="osc">/monitor/fader  <em>position</em></kbd></th>
 161   <td>where <em>position</em> is an int ranging from 0 to 1023 representing the fader control position</td></tr>
 162   <tr><th><kbd class="osc">/monitor/mute  <em>state</em></kbd></th>
 163   <td>where <em>state</em> is a bool/int representing the actual mute state of the Monitor strip</td></tr>
 164   <tr><th><kbd class="osc">/monitor/dim  <em>state</em></kbd></th>
 165   <td>where <em>state</em> is a bool/int representing the actual dim state of the Monitor strip</td></tr>
 166   <tr><th><kbd class="osc">/monitor/mono  <em>state</em></kbd></th>
 167   <td>where <em>state</em> is a bool/int representing the actual mono state of the Monitor strip</td></tr>
 168 </table>
 169
 170 <h3>Track specific operations</h3>
 171 <p>
 172   For each of the following, <em>ssid</em> is the surface strip ID for the track
 173 </p>
 174 <p class="note">
 175   Some Surfaces (many Android applets) are not able to deal with more
 176   than one parameter in a command. However, the two parameter commands
 177   below can also be sent as /strip/command/ssid param. Feedback can be
 178   set to match this with the /set_surface/feedback <em>state</em>
 179   command. See <a
 180   href="@@osc58-feedback-and-strip-types-values#feedback">
 181   Calculating Feedback and Strip-types Values.</a>
 182 </p>
 183
 184 <table class="dl">
 185   <tr><th><kbd class="osc">/bank_up <em>LED</em></kbd></th>
 186   <td>where <em>LED</em> is a bool that indicates another bank_up operation is possible.</td></tr>
 187   <tr><th><kbd class="osc">/bank_down <em>LED</em></kbd></th>
 188   <td>where <em>LED</em> is a bool that indicates another bank_down operation is possible.</td></tr>
 189   <tr><th><kbd class="osc">/strip/name <em>ssid</em> <em>strip_name</em></kbd></th>
 190   <td>where <em>strip_name</em> is a string representing the name of the strip</td></tr>
 191   <tr><th><kbd class="osc">/strip/group <em>ssid</em> <em>group_name</em></kbd></th>
 192   <td>where <em>group_name</em> is a string representing the name of the group the track belongs to</td></tr>
 193   <tr><th><kbd class="osc">/strip/mute <em>ssid</em> <em>mute_st</em></kbd></th>
 194   <td>where <em>mute_st</em> is a bool/int representing the actual mute state of the track</td></tr>
 195   <tr><th><kbd class="osc">/strip/solo <em>ssid</em> <em>solo_st</em></kbd></th>
 196   <td>where <em>solo_st</em> is a bool/int representing the actual solo state of the track</td></tr>
 197   <tr><th><kbd class="osc">/strip/monitor_input <em>ssid</em> <em>monitor_st</em></kbd></th>
 198   <td>where <em>monitor_st</em> is a bool/int. True/1 meaning the track is force to monitor input</td></tr>
 199   <tr><th><kbd class="osc">/strip/monitor_disk <em>ssid</em> <em>monitor_st</em></kbd></th>
 200   <td>where <em>monitor_st</em> is a bool/int. True/1 meaning the track is force to monitor disk,
 201   where both disk and input are false/0, auto monitoring is used.</td></tr>
 202   <tr><th><kbd class="osc">/strip/recenable <em>ssid</em> <em>rec_st</em></kbd></th>
 203   <td>where <em>rec_st</em> is a bool/int representing the actual rec state of the track</td></tr>
 204   <tr><th><kbd class="osc">/strip/record_safe <em>ssid</em> <em>rec_st</em></kbd></th>
 205   <td>where <em>rec_st</em> is a bool/int representing the actual record safe state of the track</td></tr>
 206   <tr><th><kbd class="osc">/strip/gain <em>ssid</em> <em>gain</em></kbd></th>
 207   <td>where <em>gain</em> is a float ranging from -193 to 6 representing the actual gain of the track in dB.</td></tr>
 208   <tr><th><kbd class="osc">/strip/fader <em>ssid</em>  <em>position</em></kbd></th>
 209   <td>where <em>position</em> is an float ranging from 0 to 1 representing the actual fader position of the track.</td></tr>
 210   <tr><th><kbd class="osc">/strip/*/automation <em>ssid</em>  <em>mode</em></kbd></th>
 211   <td>where <em>mode</em> is an int ranging from 0 to 3 representing the actual automation mode for the control.
 212   <a href="@@osc58-automation">See OSC Automation.</a></td></tr>
 213   <tr><th><kbd class="osc">/strip/trimdB <em>ssid</em>  <em>trim_db</em></kbd></th>
 214   <td>where <em>trim_db</em> is a float ranging from -20 to 20 representing the actual trim of the track in dB.</td></tr>
 215   <tr><th><kbd class="osc">/strip/pan_stereo_position <em>ssid</em> <em>position</em></kbd></th>
 216   <td>where <em>position</em> is a float ranging from 0 to 1 representing the actual pan position of the track</td></tr>
 217 </table>
 218 <h3>Selected Operations</h3>
 219 <p>
 220   Selection feedback is the same as for strips, only the path changes
 221   from <em>/strip</em> to <em>/select</em> and there is no <em>ssid</em>.
 222   there are some extra feedback and commands that will be listed here.
 223 </p>
 224 <table class="dl">
 225   <tr><th><kbd class="osc">/select/n_inputs <em>number</em></kbd></th>
 226   <td>where <em>number</em> number of inputs for this strip</td></tr>
 227   <tr><th><kbd class="osc">/select/n_outputs <em>number</em></kbd></th>
 228   <td>where <em>number</em> number of outputs for this strip</td></tr>
 229   <tr><th><kbd class="osc">/select/comment <em>text</em></kbd></th>
 230   <td>where <em>text</em> is the strip comment</td></tr>
 231   <tr><th><kbd class="osc">/select/solo_iso <em>state</em></kbd></th>
 232   <td>where <em>state</em> is a bool/int representing the Actual solo isolate state of the track</td></tr>
 233   <tr><th><kbd class="osc">/select/solo_safe <em>state</em></kbd></th>
 234   <td>where <em>state</em> is a bool/int representing the actual solo safe/lock state of the track</td></tr>
 235   <tr><th><kbd class="osc">/select/polarity <em>invert</em></kbd></th>
 236   <td>where <em>invert</em> is a bool/int representing the actual polarity of the track</td></tr>
 237   <tr><th><kbd class="osc">/select/pan_stereo_width <em>width</em></kbd></th>
 238   <td>where <em>width</em> is a float ranging from 0 to 1 representing the actual pan width of the track</td></tr>
 239   <tr><th><kbd class="osc">/select/send_gain", <em>sendid</em> <em>send_gain</em></kbd></th>
 240   <td>where <em>sendid</em> = nth_send, <em>send_gain</em>is a float
 241   ranging from -193 to +6 representing the actual gain in dB for the send</td></tr>
 242   <tr><th><kbd class="osc">/select/send_fader", <em>sendid</em> <em>send_gain</em></kbd></th>
 243   <td>where <em>sendid</em> = nth_send, <em>send_gain</em>is a float
 244   ranging from 0 to 1 representing the actual position for the send as a fader</td></tr>
 245   <tr><th><kbd class="osc">/select/send_name <em>sendid</em> <em>send_name</em></kbd></th>
 246   <td>where <em>send_name</em> is a string representing the name of the buss
 247   this send goes to.</td></tr>
 248   <tr><th><kbd class="osc">/select/group/enable <em>state</em></kbd></th>
 249   <td>where <em>state</em> is an int representing the current enable state
 250   of the group the selected strip is a part of</td></tr>
 251   <tr><th><kbd class="osc">/select/group/gain <em>state</em></kbd></th>
 252   <td>where <em>state</em> is an int which shows the gain sharing of the
 253   group the strip belongs to. See <a href="@@track-and-bus-groups">
 254   Track and Bus Groups</a> for more details</td></tr>
 255   <tr><th><kbd class="osc">/select/group/relative <em>state</em></kbd></th>
 256   <td>where <em>state</em> is an int which shows relative state of thew
 257   group the strip belongs to. See <a href="@@track-and-bus-groups">
 258   Track and Bus Groups</a> for more details</td></tr>
 259   <tr><th><kbd class="osc">/select/group/mute <em>state</em></kbd></th>
 260   <td>where <em>state</em> is an int which shows the mute sharing of the
 261   group the strip belongs to. See <a href="@@track-and-bus-groups">
 262   Track and Bus Groups</a> for more details</td></tr>
 263   <tr><th><kbd class="osc">/select/group/solo <em>state</em></kbd></th>
 264   <td>where <em>state</em> is an int which shows the solo sharing of the
 265   group the strip belongs to. See <a href="@@track-and-bus-groups">
 266   Track and Bus Groups</a> for more details</td></tr>
 267   <tr><th><kbd class="osc">/select/group/recenable <em>state</em></kbd></th>
 268   <td>where <em>state</em> is an int which shows the recenable sharing of the
 269   group the strip belongs to. See <a href="@@track-and-bus-groups">
 270   Track and Bus Groups</a> for more details</td></tr>
 271   <tr><th><kbd class="osc">/select/group/select <em>state</em></kbd></th>
 272   <td>where <em>state</em> is an int which shows the select sharing of the
 273   group the strip belongs to. See <a href="@@track-and-bus-groups">
 274   Track and Bus Groups</a> for more details</td></tr>
 275   <tr><th><kbd class="osc">/select/group/active <em>state</em></kbd></th>
 276   <td>where <em>state</em> is an int which shows the route active sharing of the
 277   group the strip belongs to. See <a href="@@track-and-bus-groups">
 278   Track and Bus Groups</a> for more details</td></tr>
 279   <tr><th><kbd class="osc">/select/group/color <em>state</em></kbd></th>
 280   <td>where <em>state</em> is an int which shows the color sharing of the
 281   group the strip belongs to. See <a href="@@track-and-bus-groups">
 282   Track and Bus Groups</a> for more details</td></tr>
 283   <tr><th><kbd class="osc">/select/group/monitoring <em>state</em></kbd></th>
 284   <td>where <em>state</em> is an int which shows the monitoring sharing of the
 285   group the strip belongs to. See <a href="@@track-and-bus-groups">
 286   Track and Bus Groups</a> for more details</td></tr>
 287   <tr><th><kbd class="osc">/select/vcas <em>name</em> <em>state</em> ...</kbd></th>
 288   <td>where <em>name</em> is a string with the name of the VCA, and
 289   <em>state</em> is an int that determines if the named VCA will control
 290   this strip. Note that this lists all VCAs in a session. (Ardour 6.0)</td></tr>
 291 </table>
 292 <h3>Menu actions</h3>
 293 <p class="note">
 294         There is no feedback for Menu actions.
 295 </p>
 296 <p>
 297   Every single menu item in Ardour's GUI is accessible via OSC. However,
 298   there is no provision for returning the state of anything set this way.
 299   This is not a bad thing as most menu items either do not have an on/off
 300   state or that state is quite visible. Bindings that affect other parameters
 301   that OSC does track will show on those OSC controls. Examples of this
 302   might be track record enable for tracks 1 to 32, play or stop.
 303 </p>
 304