No edit summary  | 
				 Added a warning note about port collision.  | 
				||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 7: | Line 7: | ||
* Face and Eye Tracking  | * Face and Eye Tracking  | ||
* Macro Pads/Shortcut pads  | * Macro Pads/Shortcut pads  | ||
== Prerequisities ==  | |||
While OSC makes it much easier to get data in and out of Resonite, it is still a network protocol which means that there are some prerequisites:  | |||
* Basic knowledge about [[wikipedia:IP_address|IP Addresses]] and [[wikipedia:Port_(computer_networking)|Network Ports]].  | |||
* For receiving:  | |||
** An open port on the computer running Resonite.  | |||
** The IP Address of the computer running Resonite.  | |||
* For sending:  | |||
** An OSC Server reachable by Resonite on the network  | |||
* Some sort of OSC Application/Tool. See [[#Tools|tools]] for some examples.  | |||
{{Note|Resonite will port collide (In other words: Take ownership of the port number given) with other applications when using OSC, make sure to pick a port you are not using.|warning}}  | |||
== Components ==  | == Components ==  | ||
| Line 28: | Line 40: | ||
Many OSC Applications send data purely as Floats.  | Many OSC Applications send data purely as Floats.  | ||
== Multi-Dimensional Values ==  | |||
OSC Supports values which have multiple values. This is very similar to Resonite's Type system that has types such as [[Type:Float3|Float3]].   | |||
For example, an application might send a rotational value as a Multi-Dimensional value, when this occurs you can use the <code>ArgumentIndex</code> to control which value you are interacting with:  | |||
{| class="wikitable"  | |||
|-  | |||
! Path !! Argument Index !! Value !! Description  | |||
|-  | |||
| /osc/rotation || 0 || 90 ||The Pitch value of a rotation  | |||
|-  | |||
| /osc/rotation || 1 || 180 ||The Yaw value of a rotation  | |||
|-  | |||
| /osc/rotation || 2 || 0 ||The Roll value of a rotation  | |||
|}  | |||
The structure of OSC messages and data is up to the Sender, as such some applications or tools send this data in different ways.  | |||
== Tools ==  | == Tools ==  | ||
| Line 35: | Line 65: | ||
* [https://github.com/Yellow-Dog-Man/Basic-OSC-Example Basic-OSC-Example] - A very simple OSC app written in C#. Used for testing OSC Connectivity.  | * [https://github.com/Yellow-Dog-Man/Basic-OSC-Example Basic-OSC-Example] - A very simple OSC app written in C#. Used for testing OSC Connectivity.  | ||
* [[GigglePuck]] - A haptic device, that vibrates in response to Resonite based Interactions  | * [[GigglePuck]] - A haptic device, that vibrates in response to Resonite based Interactions  | ||
* [https://github.com/Andymann/ofxOscMidi ofxOscMidi] - A program to receive MIDI messages from a source such as a hardware MIDI controller or software DAW and convert them to OSC messages which Resonite can understand. Can also receive OSC input from Resonite and send to MIDI output.  | |||
== Examples ==  | == Examples ==  | ||
| Line 43: | Line 74: | ||
** [https://youtu.be/l2RmJc9Ek_A Frooxius testing OSC Support]  | ** [https://youtu.be/l2RmJc9Ek_A Frooxius testing OSC Support]  | ||
** [https://www.youtube.com/watch?v=gvbZV_x9cak Tutorial by ProbablePrime]  | ** [https://www.youtube.com/watch?v=gvbZV_x9cak Tutorial by ProbablePrime]  | ||
[[Category:Features]]  | |||
Latest revision as of 03:54, 28 September 2024
Open Sound Control(OSC) is a network protocol that allows software and hardware to send and receive data. It is traditionally used for controlling Sound related equipment such as DJ Equipment, Musical Instruments and Sliders/Faders.
However, OSC itself can be used for basically any purpose where you need to send structured data over the network. In Resonite, we're seeing this used for:
- Haptics
 - Face and Eye Tracking
 - Macro Pads/Shortcut pads
 
Prerequisities
While OSC makes it much easier to get data in and out of Resonite, it is still a network protocol which means that there are some prerequisites:
- Basic knowledge about IP Addresses and Network Ports.
 - For receiving:
- An open port on the computer running Resonite.
 - The IP Address of the computer running Resonite.
 
 - For sending:
- An OSC Server reachable by Resonite on the network
 
 - Some sort of OSC Application/Tool. See tools for some examples.
 
Components
OSC has the following Resonite Components:
- Component:OSC_Receiver - Receive data into Resonite from OSC
 - Component:OSC_Sender - Send data out of Resonite from OSC
 - Component:OSC_Value - Expose an OSC value as a regular component field
 - Component:OSC_Field - Store an OSC value in another component's value field
 
Data
OSC Supports many data types, but Resonite supports:
- Float
 - Double
 - Int
 - Long
 - String
 - Color
 - ColorX (Will convert to sRGB)
 - DateTime
 - Byte
 
Many OSC Applications send data purely as Floats.
Multi-Dimensional Values
OSC Supports values which have multiple values. This is very similar to Resonite's Type system that has types such as Float3.
For example, an application might send a rotational value as a Multi-Dimensional value, when this occurs you can use the ArgumentIndex to control which value you are interacting with:
| Path | Argument Index | Value | Description | 
|---|---|---|---|
| /osc/rotation | 0 | 90 | The Pitch value of a rotation | 
| /osc/rotation | 1 | 180 | The Yaw value of a rotation | 
| /osc/rotation | 2 | 0 | The Roll value of a rotation | 
The structure of OSC messages and data is up to the Sender, as such some applications or tools send this data in different ways.
Tools
A number of tools that support OSC already exist and are compatible with Resonite's implementation:
- OSC Controller - Control Sliders, Buttons etc on your phone and send the data via OSC
 - Sensors2OSC - Send Android Sensor data over OSC
 - Basic-OSC-Example - A very simple OSC app written in C#. Used for testing OSC Connectivity.
 - GigglePuck - A haptic device, that vibrates in response to Resonite based Interactions
 - ofxOscMidi - A program to receive MIDI messages from a source such as a hardware MIDI controller or software DAW and convert them to OSC messages which Resonite can understand. Can also receive OSC input from Resonite and send to MIDI output.
 
Examples
- Using a Phone's sensors
- Rotating an in-game box with your phone's gyroscope by Frooxius.
 - Accessing Sensors2OSC Data - Tutorial by ProbablePrime
 
 - Sliders, Buttons and a Multi-Touch System