Swiftpack.co - Package - segabor/OSCCore
Swift Platform

OSCCore

OSCCore is a OpenSoundControl implementation in pure Swift. It is aimed to run on various platforms, including embedded systems like Raspberry Pi.

Using this module you can easily pass or receive OSC messages, communicate with SuperCollider or other great digital musical instruments. OSC is also great for implmenenting other protocols like TUIO.

Composing OSC Messages

To create a message simply instantiate OSCMessage class, assign address and parameters to it.

let msg = OSCMessage("/instr/osc1", ["frequency", 440.0])

OSC parameters can be any of the following

  • null value: nil
  • boolean values: true, false
  • characters: Character("a")
  • strings
  • numerical values: integers, floats and doubles
  • MIDI and RGBA values
  • OSC symbols: OSCSymbol(label: symbolName)
  • Array of parameters: [Int32(0x12345678), "hello"]
  • Blobs: [UInt8](0xde, 0xad, 0xfa, 0xce)

OSC Bundles

Bundles are mixed list of messages and other bundles. They also carry a time stamp or time tag.

The following bundle when received by SuperCollider will create a new synth instance with the given frequency and amplitude in parameters.

let synthID = Int32(4)

let synthBundle = OSCBundle(timetag: OSCTimeTag.immediate, content: [
    // "/s_new", name, node ID, pos, group ID
    OSCMessage(address: "/s_new", args: ["sine", synthID, Int32(1), Int32(1)]),
    // "/n_set", "amp", sine amplitude
    OSCMessage(address: "/n_set", args: [synthID, "amp", Float32(0.5)]),
    // "/n_set", "freq", sine frequency
    OSCMessage(address: "/n_set", args: [synthID, "freq", Float32(440.0)])
])

Sending and receiving OSC messages

OSCCore is built on top of SwiftNIO, a asynchronous event-driven network application framework developed by Apple.

For examples please see BasicListener and SuperColliderExample projects in Source folder.

Usage

OSCCore is currently provided as Swift PackageManager module. To include OSCCore to your project add the following dependency to your Package.swift file

.Package(url: "https://github.com/segabor/OSCCore.git", majorVersion: 0)

Other dependency managers like CocoaPods or Chartage is under consideration.

Version history

  • 0.9 OSC Specification 1.0
  • 0.4 Important fixes: timestamp and OSC packet detection Switch to Swift 4.0.2
  • 0.3.1 iOS support Note: this is last Swift 3 supported version
  • 0.3 Replace socket implementation to IBM's BlueSocket
  • 0.2.3 Bugfix release (see issue #5).
  • 0.2.2 Improved timetag support
  • 0.2.1 Bugfix: UDP Client now accepts bundles too
  • 0.2 Dispatch bundle messages

Github

link
Stars: 23
Help us keep the lights on

Dependencies

Used By

Total:

Releases

0.10.0 - Aug 30, 2018

OSCCore is now powered by Apple's Swift NIO! ATTENTION! This is a breaking change! Your code must also be ported to Swift NIO to use OSCCore.

0.9.0 - Jan 14, 2018

OSCCore now conforms to OSC 1.0!

0.4.0 - Jan 14, 2018

This release welcomes Swift 4. It also contains important bugfixes

  • Fix broken OSC timestamp serialization and date conversion
  • OSCBundles were not recognized

0.2.3 - May 15, 2017

This is a bugfix release that addresses issue #5.