Shamusworld >> Repos - ardour-manual-diverged/blob - include/osc-setup-dialog.html

   1 ---
   2 layout: default
   3 title: OSC&#58; Using the Setup Dialog
   4 ---
   5
   6 <p>
   7   Starting with Ardour 5.1 OSC has a graphic setup dialog. This dialog
   8   can be accessed from Preferences->Control Surfaces. Select OSC and
   9   click on the Show Protocol Settings.
  10 </p>
  11 <p>
  12   The Ardour OSC dialog has three tabs. The main tab, the Strip Types
  13   tab and the Feedback tab.
  14 </p>
  15 <p>
  16   Many OSC devices get their IP from a DHCP making it difficult to set
  17   an IP in Ardour's OSC settings. Therefore, most of the settings are
  18   <em>default</em> settings. Values are set and the next OSC surface to
  19   send a /set_surface* message to Ardour will use those settings. An OSC
  20   surface that has previously sent a message to Ardour will retain the
  21   settings it already had. The <em>Clear OSC Devices</em> will reset all
  22   device settings. A <em>/refresh</em> message will both reset the
  23   device settings as well as set that device to any new settings. The
  24   Use of <em>/set_surface</em> will override all settings except
  25   <em>Port Mode</em>.
  26 </p>
  27 <h2>Dialog settings</h2>
  28 <h3>OSC setup tab</h3>
  29 <p>
  30 <img alt="the OSC configuration dialog"
  31      src="/images/osc-dialog.png">
  32 </p>
  33 <h4>Connection:</h4>
  34 <p>
  35   This field is informational only. It shows where Ardour will receive
  36   OSC messages. The system Name and the Port are the most important parts.
  37 </p>
  38 <h4>Port Mode:</h4>
  39 <p>
  40   This drop down allows the choice of Auto or Manual outbound port
  41   setting. The default Auto port mode, will send OSC messages back to
  42   the port messages from that surface are received from. This setting
  43   allows two surfaces on the same IP to operate independently. However,
  44   there are a number of OSC control surfaces that do not monitor the
  45   same port they send from and in fact may change ports they send from
  46   as well. Manual allows the outgoing port (the port the surface will
  47   receive on, to be manually set. In Manual port mode only one control
  48   surface per IP can work. Most phone or tablet OSC controllers like
  49   touchOSC or Control need Manual port mode. More than one controller
  50   can be used so long as each has it's own IP.
  51 </p>
  52 <h4>Manual Port:</h4>
  53 <p>
  54   This is an Entry box for setting the outgoing port when in
  55   Manual port mode.
  56 </p>
  57 <h4>Bank Size:</h4>
  58 <p>
  59   This sets the default bank size for the next surface to send a
  60   <em>/set_surface/*</em> OSC message. Bank size 0 (the default) sets
  61   no banking and allows controlling all strips included in strip_types
  62   at once.
  63 </p>
  64 <h4>Gain Mode:</h4>
  65 <p>
  66   Sets the faders (and sends faders) feedback math to position where a
  67   value between 0 and 1 represents the fader position of the same fader
  68   in the mixer GUI or dB where the feedback from fader movement will be
  69   returned as a dB value. When the Gain Mode is set to position, the
  70   /*/name feedback for the channel will show dB values in text while the
  71   fader is being adjusted and then return the the name text.
  72 </p>
  73 <h4>Debug:</h4>
  74 <p>
  75   For debugging purposes this allows logging either good OSC messages
  76   Ardour receives or invalid messages received or none.
  77 </p>
  78 <h4>Preset:</h4>
  79 <p>
  80   Ardour now allows the use of preset settings. The default settings
  81   used are the settings from the last session or the factory defaults
  82   the first time OSC is enabled. As soon as any of these settings are
  83   changed, the Preset will change to "User" and the new settings will be
  84   save to the osc directory Ardour configuration directory as
  85   <em>user.preset</em>. This preset file can be renamed for future use.
  86   It is suggested to also change the name value inside to avoid confusion
  87   in the preset listing. Ardour will ship with some of it's own presets
  88   that go with some popular OSC control and map combinations.
  89 </p>
  90 <h4>Clear OSC Devices</h4>
  91 <p>
  92   This button clears operating device profiles so that Ardour will reset
  93   all devices settings to use the new defaults from changed settings. a
  94   device may still override these new settings with the /set_surface set
  95   of commands. The reason for setting defaults settings is that some OSC
  96   controllers are not able to send more than one parameter at a time and
  97   so having correct defaults allows one "Connect" button rather than 4.
  98 </p>
  99 <h3>Default Strip Types tab</h3>
 100 <p>
 101 <img alt="the Default Strip Types tab"
 102      src="/images/osc-strip-types.png">
 103 </p>
 104 <p>
 105   This allows selecting which of Ardour's mixer strips will be available
 106   for control. The Factory default is all strips except master, monitor
 107   and hidden strips. If it is desired to only see input tracks the
 108   others can be deselected. It is also possible to change these settings
 109   from the control surface. A set of buttons could select showing only
 110   inputs or only buses. If a group is selected in the GUI then showing
 111   only selected strips will show only that group. Showing hidden tracks
 112   is handy for cases where a groups of tracks that grouped to a bus or
 113   controlled by a VCA are hidden, but one of those tracks needs a tweak.
 114 </p>
 115 <h3>Default Feedback tab</h3>
 116 <p>
 117 <img alt="the Default Feedback tab"
 118      src="/images/osc-feedbackdefault.png">
 119 </p>
 120 <p>
 121   This allows setting up which controls provide feedback. The Factory
 122   default is none. If the controller is unable to receive feedback, this
 123   should be left blank. In the case of metering, Metering as a LED strip
 124   only works if Metering as a Float is disabled.
 125 </p>