From 95ce8f20a9bdc8c5ab21ddffbf8c4106e9e5563f Mon Sep 17 00:00:00 2001 From: Len Ovens Date: Sat, 29 Oct 2016 10:28:01 -0700 Subject: [PATCH] OSC: Add documentation for the GUI. --- .../01_controlling-ardour-with-osc.html | 12 ++ .../02_feedback-in-osc.html | 4 + ...ating-feedback-and-strip-types-values.html | 5 +- .../06_osc-setup-dialog.html | 113 ++++++++++++++++++ .../03_midi-binding-maps.html | 2 + 5 files changed, 135 insertions(+), 1 deletion(-) create mode 100644 _manual/22_using-control-surfaces/01_controlling-ardour-with-osc/06_osc-setup-dialog.html diff --git a/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc.html b/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc.html index 5eda3aff..8d7fda10 100644 --- a/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc.html +++ b/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc.html @@ -69,6 +69,18 @@ here"/> strip's controls are sent (or refreshed) as well. This will also refresh the Master feedback setup.

+

+ Surface Port Setting is available in the OSC GUI. +

+

+ As of Ardour 5.1, There is now a GUI setup in response to those using + tablets with applications such as touchOSC or AndrOSC who need to be + able to set a port for Ardour to send to. It can also change the + default setting for set_surface. For more information about Ardour's + OSC configuration GUI please read + Ardour's Setup Dialog. +

If /set_surface is not sent, the default values are used:

So using a value of 19 would turn on feedback for strip and master diff --git a/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc/06_osc-setup-dialog.html b/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc/06_osc-setup-dialog.html new file mode 100644 index 00000000..7512fad3 --- /dev/null +++ b/_manual/22_using-control-surfaces/01_controlling-ardour-with-osc/06_osc-setup-dialog.html @@ -0,0 +1,113 @@ +--- +layout: default +title: Using the OSC Setup Dialog +--- + +

+ Starting with Ardour 5.1 OSC has a graphic setup dialog. This dialog + can be accessed from Preferences->Control Surfaces. Select OSC and + click on the Show Protocol Settings. +

+

+ The Ardour OSC dialog has three tabs. The main tab, the Strip Types + tab and the Feedback tab. +

+

+ Many OSC devices get their IP from a DHCP making it difficult to set + an IP in Ardour's OSC settings. Therefore, most of the settings are + default settings. Values are set and the next OSC surface to + send a /set_surface* message to Ardour will use those settings. An OSC + surface that has previously sent a message to Ardour will retain the + settings it already had. The Clear OSC Devices will reset all + device settings. A /refresh message will both reset the + device settings as well as set that device to any new settings. The + Use of /set_surface will override all settings except + Port Mode. +

+

Dialog settings

+

OSC setup tab

+

Connection:

+

+ This field is informational only. It shows where Ardour will receive + OSC messages. The system Name and the Port are the most important parts. +

+

Port Mode:

+

+ This drop down allows the choice of Auto or Manual outbound port + setting. The default Auto port mode, will send OSC messages back to + the port messages from that surface are received from. This setting + allows two surfaces on the same IP to operate independently. However, + there are a number of OSC control surfaces that do not monitor the + same port they send from and in fact may change ports they send from + as well. Manual allows the outgoing port (the port the surface will + receive on, to be manually set. In Manual port mode only one control + surface per IP can work. Most phone or tablet OSC controllers like + touchOSC or Control need Manual port mode. More than one controller + can be used so long as each has it's own IP. +

+

Manual Port:

+

+ This is an Entry box for setting the outgoing port when in + Manual port mode. +

+

Bank Size:

+

+ This sets the default bank size for the next surface to send a + /set_surface/* OSC message. Bank size 0 (the default) sets + no banking and allows controlling all strips included in strip_types + at once. +

+

Gain Mode:

+

+ Sets the faders (and sends faders) feedback math to position where a + value between 0 and 1 represents the fader position of the same fader + in the mixer GUI or dB where the feedback from fader movement will be + returned as a dB value. When the Gain Mode is set to position, the + /*/name feedback for the channel will show dB values in text while the + fader is being adjusted and then return the the name text. +

+

Debug:

+

+ For debugging purposes this allows logging either good OSC messages + Ardour receives or invalid messages received or none. +

+

Preset:

+

+ Ardour now allows the use of preset settings. The default settings + used are the settings from the last session or the factory defaults + the first time OSC is enabled. As soon as any of these settings are + changed, the Preset will change to "User" and the new settings will be + save to the osc directory Ardour configuration directory as + user.preset. This preset file can be renamed for future use. + It is suggested to also change the name value inside to avoid confusion + in the preset listing. Ardour will ship with some of it's own presets + that go with some popular OSC control and map combinations. +

+

Clear OSC Devices

+

+ This button clears operating device profiles so that Ardour will reset + all devices settings to use the new defaults from changed settings. a + device may still override these new settings with the /set_surface set + of commands. The reason for setting defaults settings is that some OSC + controllers are not able to send more than one parameter at a time and + so having correct defaults allows one "Connect" button rather than 4. +

+

Default Strip Types tab

+

+ This allows selecting which of Ardour's mixer strips will be available + for control. The Factory default is all strips except master, monitor + and hidden strips. If it is desired to only see input tracks the + others can be deselected. It is also possible to change these settings + from the control surface. A set of buttons could select showing only + inputs or only buses. If a group is selected in the GUI then showing + only selected strips will show only that group. Showing hidden tracks + is handy for cases where a groups of tracks that grouped to a bus or + controlled by a VCA are hidden, but one of those tracks needs a tweak. +

+

Default Feedback tab

+

+ This allows setting up which controls provide feedback. The Factory + default is none. If the controller is unable to receive feedback, this + should be left blank. In the case of metering, Metering as a LED strip + only works if Metering as a Float is disabled. +

diff --git a/_manual/22_using-control-surfaces/03_midi-binding-maps.html b/_manual/22_using-control-surfaces/03_midi-binding-maps.html index e5d71d18..a1459df7 100644 --- a/_manual/22_using-control-surfaces/03_midi-binding-maps.html +++ b/_manual/22_using-control-surfaces/03_midi-binding-maps.html @@ -174,6 +174,8 @@ bindings"> The sysex= and msg= bindings will only work with function= or action= control addresses. They will not work with the uri= control addresses. + Controls used with uri= require a Value which is + only available in a known place with channel mode MIDI events.

Control address