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.
8 The Ardour OSC dialog has three tabs. The main tab, the Strip Types
9 tab and the Feedback tab.
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
25 <h2>Dialog settings</h2>
26 <h3>OSC setup tab</h3>
29 <img alt="The OSC configuration dialog" src="/images/osc-dialog.png">
31 The OSC configuration dialog
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.
46 <img alt="Port Mode Dropdown" src="/images/osc-portmode.png">
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.
67 This is an Entry box for setting the outgoing port when in
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).
78 <h4>Send Page Size:</h4>
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.
84 <h4>Plugin Page Size:</h4>
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
95 <img alt="Gain Mode Dropdown" src="/images/osc-gainmode.png">
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.
112 <img alt="Debug Mode Dropdown" src="/images/osc-debug.png">
119 For debugging purposes this allows logging either all OSC messages
120 Ardour receives or invalid messages received or none.
125 <img alt="Preset Loader" src="/images/osc-preset.png">
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.
143 <h4>Clear OSC Devices</h4>
145 This button has been removed after Ardour 5.10. Instead this action
146 is triggered by any change in the settings.
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.
156 <h3>Default Strip Types tab</h3>
159 <img alt="The Default Strip Types tab" src="/images/osc-strip-types.png">
161 The Default Strip Types tab
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.
176 <h3>Default Feedback tab</h3>
179 <img alt="The Default Feedback tab" src="/images/osc-feedbackdefault.png">
181 The Default Feedback tab
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.