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

   1
   2 <p>
   3   In order to make a custom controller that knows what strips Ardour
   4   has, the controller needs to be able to query Ardour for that
   5   information. These set of commands are for smarter control surfaces
   6   That have the logic to figure out what to do with the information.
   7   These are not of value for mapped controllers like touchOSC and
   8   friends. The controller will need to send these queries to ardour
   9   as often as it needs this information. It may well make sense to use
  10   regular feedback for things that need to be updated often such as
  11   position or metering.
  12   Here are the commands used to query Ardour: (added in Ardour 5.5)
  13 </p>
  14
  15 <dl class="bindings">
  16   <dt><kbd class="osc">/strip/list</kbd></dt>
  17   <dd>Ask for a list of strips</dd>
  18   <dt><kbd class="osc">/strip/sends <em>ssid</em></kbd></dt>
  19   <dd>Asks for a list of sends on the strip <em>ssid</em></dd>
  20   <dt><kbd class="osc">/strip/receives <em>ssid</em></kbd></dt>
  21   <dd>Asks for a list of tracks that have sends to the strip <em>ssid</em> points to</dd>
  22   <dt><kbd class="osc">/strip/plugin/list <em>ssid</em></kbd></dt>
  23   <dd>Asks for a list of plug-ins for strip <em>ssid.</em></dd>
  24   <dt><kbd class="osc">/plugin/descriptor <em>ssid</em> <em>piid</em></kbd></dt>
  25   <dd>Asks for a list of descriptors for plug-in <em>piid</em> on strip <em>ssid</em></dd>
  26 </dl>
  27
  28 <h3>A list of strips</h3>
  29
  30 <p>
  31   <code>/strip/list</code> asks Ardour for a list of strips that the
  32   current session has. Ardour replies with a message for each
  33   strip with the following information:
  34   <ul>
  35     <li>Strip type</li>
  36     <li>Strip name</li>
  37     <li>Number of inputs</li>
  38     <li>Number of outputs</li>
  39     <li>Muted (bool)</li>
  40     <li>Soloed (bool)</li>
  41     <li>Ssid (strip number)</li>
  42     <li>Record enabled (bool)</li>
  43   </ul>
  44   After all the strip messages have been sent, one final message is
  45   sent with:
  46   <ul>
  47     <li>The text <code>end_route_list</code></li>
  48     <li>The session frame rate</li>
  49     <li>The last frame number of the session</li>
  50   </ul>
  51 </p>
  52 <p class="note">A bus will not have a record enable and so a bus message
  53   will have one less parameter than a track. It is the controllers
  54   responsability to deal with this.
  55 </p>
  56
  57 <h3>A list of sends</h3>
  58 <p>
  59   <code>/strip/sends <em>ssid</em></code> asks Ardour for a list of
  60   sends for strip number ssid. The reply is sent back to the
  61   controller as one message with the following information:
  62   <ul>
  63     <li>Ssid that information is for</li>
  64     <li>Each send's information:</li>
  65     <ul>
  66       <li>The send's target bus ssid</li>
  67       <li>The send's target bus name</li>
  68       <li>The send id for this strip</li>
  69       <li>The send gain as a fader possition</li>
  70       <li>The Send's enable state</li>
  71     </ul>
  72   </ul>
  73 </p>
  74 <p>
  75   The controller can tell how many sends there are from the number of
  76   parameters as each send has 5 parameters and there is one extra for
  77   ssid.
  78 </p>
  79
  80 <h3>A list if tracks that send audio to a bus</h3>
  81 <p>
  82   <code>/strip/receives <em>ssid</em></code> will return a list of
  83   tracks that have sends to the bus at the ssid. The reply will
  84   contain the following information for each track conntected to this
  85   bus:
  86   <ul>
  87     <li>The ssid of the track sending</li>
  88     <li>The name of the sending track</li>
  89     <li>The id of the send at that track</li>
  90     <li>It's gain in fader possition</li>
  91     <li>The send's enable state</li>
  92   </ul>
  93 </p>
  94
  95 <h3>A list of plug-ins for strip</h3>
  96 <p>
  97   <code>/strip/plugin/list <em>ssid</em></code> will return a list of
  98   plug-ins that strip ssid has. The reply will contain the following
  99   information:
 100   <ul>
 101     <li>Ssid that information is for</li>
 102     <li>Each plugin's information:</li>
 103     <ul>
 104       <li>The plug-in's id</li>
 105       <li>The plug-in's name</li>
 106     </ul>
 107   </ul>
 108 </p>
 109
 110 <h3>A list of a plug-in's parameters</h3>
 111 <p>
 112   <code>/plugin/descriptor <em>ssid</em> <em>piid</em></code> will
 113   return the plug-in parameters for ppid plug-in on the ssid strip. The
 114   reply will contain the following information:
 115   <ul>
 116     <li>Ssid of the strip the plug-in is in</li>
 117     <li>The plug-in id for the plug-in</li>
 118     <li>The plug-in's name</li>
 119     <li>Information about each parameter</li>
 120     <ul>
 121       <li>The parameter id</li>
 122       <li>The parameter's name</li>
 123       <li>A bitset of flags (see below)</li>
 124       <li>Data type</li>
 125       <li>Minimum value</li>
 126       <li>Maximum value</li>
 127       <li>The number of scale points</li>
 128       <li>zero or more scale points of one value and one string each</li>
 129       <li>The current parameter value</li>
 130     </ul>
 131   </ul>
 132 </p>
 133 <p>
 134   The flag bitset above has been defined as (from lsb):
 135   <ul>
 136     <li>0 - enumeration</li>
 137     <li>1 - integer step</li>
 138     <li>2 - logarithmic</li>
 139     <li>3 - max unbound</li>
 140     <li>4 - min unbound</li>
 141     <li>5 - sample rate dependent</li>
 142     <li>6 - toggled</li>
 143     <li>7 - controllable</li>
 144   </ul>
 145 </p>
 146 <p>
 147         While this seems complex, it is really not that bad. Minimum,
 148         maximum and value will in most cases give you all you need.
 149 </p>
 150