Shamusworld >> Repos - ardour-manual/blob - include/osc58-using-the-setup-dialog.html

   1
   2 <p>
   3   Starting with Ardour 5.1 OSC has a graphic setup dialog. This dialog
   4   can be accessed from Preferences->Control Surfaces. Select OSC and
   5   click on the Show Protocol Settings.
   6 </p>
   7 <p>
   8   The Ardour OSC dialog has three tabs. The main tab, the Strip Types
   9   tab and the Feedback tab.
  10 </p>
  11 <p>
  12   Many OSC devices get their IP from a DHCP making it difficult to set
  13   an IP in Ardour's OSC settings. Therefore, most of the settings are
  14   <em>default</em> settings. Values are set and the next OSC surface to
  15   send an OSC message to Ardour will use those settings. An OSC
  16   surface that has previously sent a message to Ardour will retain the
  17   settings it already had. Any change to a setting will reset all
  18   device settings. A <em>/refresh</em> message will set that device to
  19   any new settings. The use of <em>/set_surface</em> will override all
  20   settings except <em>Port Mode</em>. <em>Port Mode</em> affects all
  21   connected surfaces and so all surfaces must use either the set manual
  22   port or send OSC messages from the same port they expect to receive
  23   feedback on.
  24 </p>
  25 <h2>Dialog settings</h2>
  26 <h3>OSC setup tab</h3>
  27
  28 <figure>
  29         <img alt="The OSC configuration dialog" src="/images/osc-dialog.png">
  30         <figcaption>
  31                 The OSC configuration dialog
  32         </figcaption>
  33 </figure>
  34
  35 <h4>Connection:</h4>
  36 <p>
  37   This field is informational only. It shows where Ardour will receive
  38   OSC messages. The system Name and the Port are the most important parts.
  39   Normally, Ardour will use 3819 as its server port. However, if some
  40   other server is already using this port, Ardour will try to use the next
  41   port up and will keep trying up to 10 ports up.
  42 </p>
  43 <h4>Port Mode:</h4>
  44
  45 <figure>
  46         <img alt="Port Mode Dropdown" src="/images/osc-portmode.png">
  47         <figcaption>
  48                 Port Mode Dropdown
  49         </figcaption>
  50 </figure>
  51
  52 <p>
  53   This drop down allows the choice of Auto or Manual outbound port
  54   setting. The Auto port mode, will send OSC messages back to
  55   the port messages from that surface are received from. This setting
  56   allows two surfaces on the same IP to operate independently. However,
  57   there are a number of OSC control surfaces that do not monitor the
  58   same port they send from and in fact may change ports they send from
  59   as well. Manual allows the outgoing port, the port the surface will
  60   receive on, to be manually set. In Manual port mode only one control
  61   surface per IP can work. Most phone or tablet OSC controllers like
  62   touchOSC or Control need Manual port mode. More than one controller
  63   can be used so long as each has it's own IP.
  64 </p>
  65 <h4>Manual Port:</h4>
  66 <p>
  67   This is an Entry box for setting the outgoing port when in
  68   Manual port mode.
  69 </p>
  70 <h4>Bank Size:</h4>
  71 <p>
  72   This sets the default bank size for the next surface to send a
  73   <em>/set_surface/*</em> OSC message. Bank size 0 (the default) sets
  74   no banking and allows controlling all strips included in strip_types
  75   at once. The entry area will be bright blue for a port that is not
  76   valid (ports below 1024 or 3819).
  77 </p>
  78 <h4>Send Page Size:</h4>
  79 <p>
  80         This allows setting the size of pages for sends. In the case there are
  81         more sends than controls. A size of 0 is the same as no paging and
  82         all sends are directly controllable.
  83 </p>
  84 <h4>Plugin Page Size:</h4>
  85 <p>
  86         This allows setting the size of pages for plugin controls. Some
  87         plugins have hundreds of controls and so it may be necessary to page
  88         the plugin controls to a limited number of physical controls. A size
  89         of 0 is the same as no paging and all plugin controls are directly
  90         controllable.
  91 </p>
  92 <h4>Gain Mode:</h4>
  93
  94 <figure>
  95         <img alt="Gain Mode Dropdown" src="/images/osc-gainmode.png">
  96         <figcaption>
  97                 Gain Mode Dropdown
  98         </figcaption>
  99 </figure>
 100
 101 <p>
 102   Sets the faders (and sends faders) feedback math to position where a
 103   value between 0 and 1 represents the fader position of the same fader
 104   in the mixer GUI or dB where the feedback from fader movement will be
 105   returned as a dB value. When the Gain Mode is set to position, the
 106   /*/name feedback for the channel will show dB values in text while the
 107   fader is being adjusted and then return the name text.
 108 </p>
 109 <h4>Debug:</h4>
 110
 111 <figure>
 112         <img alt="Debug Mode Dropdown" src="/images/osc-debug.png">
 113         <figcaption>
 114                 Debug Mode Dropdown
 115         </figcaption>
 116 </figure>
 117
 118 <p>
 119   For debugging purposes this allows logging either all OSC messages
 120   Ardour receives or invalid messages received or none.
 121 </p>
 122 <h4>Preset:</h4>
 123
 124 <figure>
 125         <img alt="Preset Loader" src="/images/osc-preset.png">
 126         <figcaption>
 127                 Preset Loader
 128         </figcaption>
 129 </figure>
 130
 131 <p>
 132   Ardour now allows the use of preset settings. The default settings
 133   used are the settings from the last session or the factory defaults
 134   the first time OSC is enabled. As soon as any of these settings are
 135   changed, the Preset will change to "User" and the new settings will be
 136   save to the osc directory in the
 137   <a href="@@files-and-directories-ardour-knows-about">Ardour configuration directory</a> as
 138   <em>user.preset</em>. This preset file can be renamed for future use.
 139   It is suggested to also change the name value inside to avoid confusion
 140   in the preset listing. Ardour will ship with some of it's own presets
 141   that go with some popular OSC control and map combinations.
 142 </p>
 143 <h4>Clear OSC Devices</h4>
 144 <p class="note">
 145         This button has been removed after Ardour 5.10. Instead this action
 146         is triggered by any change in the settings.
 147 </p>
 148 <p>
 149   This button clears operating device profiles so that Ardour will reset
 150   all devices settings to use the new defaults from changed settings. a
 151   device may still override these new settings with the /set_surface set
 152   of commands. The reason for setting defaults settings is that some OSC
 153   controllers are not able to send more than one parameter at a time and
 154   so having correct defaults allows one "Connect" button rather than 4.
 155 </p>
 156 <h3>Default Strip Types tab</h3>
 157
 158 <figure>
 159         <img alt="The Default Strip Types tab" src="/images/osc-strip-types.png">
 160         <figcaption>
 161                 The Default Strip Types tab
 162         </figcaption>
 163 </figure>
 164
 165 <p>
 166   This allows selecting which of Ardour's mixer strips will be available
 167   for control. The Factory default is all strips except master, monitor
 168   and hidden strips. If it is desired to only see input tracks the
 169   others can be deselected. It is also possible to change these settings
 170   from the control surface. A set of buttons could select showing only
 171   inputs or only busses. If a group is selected in the GUI then showing
 172   only selected strips will show only that group. Showing hidden tracks
 173   is handy for cases where a groups of tracks that grouped to a bus or
 174   controlled by a VCA are hidden, but one of those tracks needs a tweak.
 175 </p>
 176 <h3>Default Feedback tab</h3>
 177
 178 <figure>
 179         <img alt="The Default Feedback tab" src="/images/osc-feedbackdefault.png">
 180         <figcaption>
 181                 The Default Feedback tab
 182         </figcaption>
 183 </figure>
 184
 185 <p>
 186   This allows setting up which controls provide feedback. The Factory
 187   default is none. If the controller is unable to receive feedback, this
 188   should be left blank. In the case of metering, Metering as a LED strip
 189   only works if Metering as a Float is disabled.
 190 </p>
 191