README - OSCulator Plug-in for Logic Pro

Description

The OSCulator Plug-in for Logic Pro is a "Control Surface Plug-in" allowing control of Logic Pro using the Open Sound Control protocol (OSC).

The aim is to create a clean and documented API so OSC applications are easier to interface with Logic Pro.

Please see disclaimer, change log and copyright at the end of the document.

Compatibility

The plug-in is compatible with:

Installation

Copy the file "OSCulator.bundle" into one of the following directories:

Logic Configuration

« Logic Pro has detected a new OSC device named "computer:8000 (OSCulator)", which is supported by the control surface plug-in "OSCulator. »

Click Add, OSCulator is now ready to communicate with Logic.

OSCulator configuration

If you want to send OSC messages to Logic Pro, it must be configured as an OSC target. The OSC target is automatically added in OSCulator 2.12 and later, however you will need to add it manually in previous versions.

In OSCulator, open the Parameters Window, and navigate to the OSC Routing. Logic publishes a OSC service whose name is merely the name of your computer. If your computer's name is "tortilla" then that is what you should see in the OSC target list.

If it is not in the list, click on the gear button and pick the service from there.

Finally, make sure that the target is not the default target, otherwise the service will be replaced by another one next time OSCulator detects a OSC device on the network.

Attention TouchOSC users

If you have already setup TouchOSC as a control surface in Logic, but would like to use OSCulator to act as a bridge, then you should uninstall the TouchOSC control surface from Logic Pro.

How to stop using the OSCulator Plug-in for Logic Pro

As long as the plug-in is not uninstalled (see next section), this is only temporary and can be reconfigured again later.

Complete uninstallation

Example file: "Logic Pro - TouchOSC (using LogicTouch layout)"

The purpose of this example is to show how to use OSCulator as a bridge between TouchOSC and Logic Pro. We use the LogicTouch layout (bundled with the TouchOSC app), that was designed to work directly with Logic. If we don't use TouchOSC as a control surface, but instead use OSCulator, then we have access to the OSC messages that are exchanged between TouchOSC and Logic and can use OSCulator instead.

The example has been made with the iPhone version of this template. Adapting the example to the iPad version is left as an exercise for the reader.

OSC dictionary

The file "Logic Pro OSCulator Dictionary.oroutes" is a dictionary of OSC messages and provided to make it easier to assign mappings in OSCulator, or to explore the possible OSC calls.

To use the dictionary, in OSCulator, open the Parameters Window, and go to the OSC Routing tab. Click on the gear button and then "Import…". Choose the file named "Logic Pro OSCulator Dictionary.oroutes".

Troubleshooting

Debugging

OSCulator has a debugging mode where all OSC input and output is logged to the console. In order to enable the debugging mode, type the following line in a Terminal window:

defaults write net.osculator.OSCulator ShowDebuggingTools YES

and restart OSCulator. The menu item "Log OSC input" will become available in the Routings menu.

To remove debugging support, type in a Terminal window:

defaults delete net.osculator.OSCulator ShowDebuggingTools

OSC API Description

Unless specified, all communications are bi-directional.

(a) unidirectional message: sent from OSCulator to Logic Pro.

(b) unidirectional message: received by OSCulator from Logic Pro.

Transport

Mixer

Tracks are grouped by banks of 8 tracks. In the following messages:

Tracks:

AUX:

Track

Sends:

Inserts:

EQ:

Automation:

Instrument:

Support

For problems, bugs or requests, please post a report on the OSCulator Forum:

http://www.osculator.net/forum

Change log

Disclaimer and copyright

This is a work in progress, and as such the following disclaimer applies:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright © 2012, Wildora, all right reserved.