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