Introduction

This tutorial will teach you how to setup and use the Syntacts Python API. It is recommended that you use a Python IDE such as Visual Studio Code or PyCharm. The Python API can also be used from an IPython or Jupyter notebook.

Requirements

Basic Setup

  • Install Python 3 on your device if it is not already installed.
  • Download the latest pre-compiled Syntacts binaries for your system.
  • Extract syntacts.py and the dynamic library syntacts_c.dll (or libsyntacts_c.dylib on macOS) to a directory of your choice.
  • Create a new script in the same directory as syntacts.py and the dynamic library.
  • In your script, import Syntacts and sleep:
from syntacts import *
from time import sleep

API Overview

Session

  • Using Syntacts begins with creating a Session, or an audio-context that manages communication with an output device.
  • Devices available for opening can be enumerated and queried for information using a Session:
session = Session()

for dev in session.available_devices:
    print("Index:       ", dev.index)
    print("Name:        ", dev.name)
    print("Max Channels:", dev.max_channels)
    print("API:         ", dev.api_name)
  • Devices can be opened using the open function.
  • The no-argument overload will open the system default audio device (usually the main speakers).
  • Non-default devices can be opened by passing a device index argument or the device name and preferred API:
# open default device
session.open()   
session.close()  
# open device by index
session.open(22) 
session.close() 
# open device by name and preferred API
session.open("MOTU Pro Audio", API.ASIO)
session.close()
  • Device indices represent the combination of a device and an API it supports. Therefore, one device may have multiple indices each with a different API.
  • You can retrieve your device‚Äôs index and/or name by iterating as in the above example, or by opening the Syntacts GUI and viewing the information there.

Warning: Device indices are NOT persistent. They may change when devices are power cycled, plugged/unplugged, or when other devices are connected to the PC. If you need a persistent method of opening a device, use the name + API version of open.

Relevant Examples(s)
example_devices.py

Signals

  • Vibration waveforms are represented by one or more Signals. You can create Signals of different behaviors and lengths.
  • Sine, Square, Saw, and Triangle classes are available in Syntacts. These implement typical oscillators with normalized amplitude and infinite duration.
  • Basic oscillators can be created by calling their constructors:
sin = Sine(10)      # 10 Hz Sine wave
sqr = Square(250)   # 250 Hz Square wave
saw = Saw(175)      # 175 Hz Saw wave
tri = Triangle(440) # 440 Hz Triangle wave (audible and ok for speakers)
  • Oscillators alone have an infinite duration or length and a constant amplitude.
  • You can use the Envelope, ASR, and ADSR (Attack, (Decay), Sustain, Release) Signals to define amplitude modifiers with finite duration:
# This is a basic envelope that specifies amplitude (0.9), and duration (0.5 sec)
bas = Envelope(0.9, 0.5)
# This is an attack (0.1 sec), sustain (0.1 sec), release (0.1 sec) envelope.  
asr = ASR(0.1, 0.1, 0.1)
  • Signals can be mixed using basic arithmetic. Multiplying and adding Signals can be thought of as an element-wise operation between two vectors.
    • Multiplying two Signals creates a new Signal of duration equal to the shortest operand.
    • Adding two Signals creates a new Signal of duration equal to the longest operand.
  • Gain and bias can also be applied to Signals with scalar operands.
  • Below are basic examples of mixing the Signals from above:
sig1 = sqr * sin  # duration is infinite
sig2 = sig1 * asr # duration is 0.3 seconds
sig3 = 0.5 * (sqr + sin) * asr
  • Signals created in the above examples: Signals

  • Complete signals can be made and mixed in-place as well.

# 250 Hz square wave amplitude modulated with a 20 Hz sine wave and ASR envelope.
sig4 = Square(250) * Sine(20) * ASR(1,1,1)
  • Once you have created a complete Signal, it can be played on the Session.
session.play(0, sig1) # plays sig 1 on channel 0
sleep(3)              # sig1 plays for 3 seconds
session.stop(0)       # stop sig1

session.play(1, sig2) # plays sig2 on channel 1
sleep(sig2.length)    # sig2 plays for its length of 0.3 seconds
                      # Do not need to stop sig2 because it is finite
                       
session.play_all(sig3) # plays sig3 on all channels
sleep(sig3.length)

Note: If you want to evaluate Syntacts without tactor hardware, make sure the frequency is high enough to be audible for speakers (e.g. 440 Hz). Low frequencies can potentially damage speakers! For this reason, most of the Syntacts examples are coded with frequencies in the hearing range. If you are actually outputting to a tactor, use frequencies appropriate for it (e.g. 150-250 Hz).

Relevant Examples(s)
example_basic.py

Sequences

  • Multiple Signals can be ordered in time using Sequences.
  • You can concatenate Signals using the insertion, or left-shift, operator <<.
  • Delay and pause are achieved through the insertion of positive scalar operands.
  • Negative scalar operands move the insertion points backwards in time, allowing for the overlay or fading of Signals into each other.
  • Below is a basic example of creating Sequences:
sigA = Sine(440) * ASR(1,1,1)      # create 3 second Signal
sigB = Square(440) * ADSR(1,1,1,1) # create 4 second Signal

# 7 second Sequence with sigA before sigB
sig4 = sigA << sigB 
# 1 sec delay and 2 sec pause, 10 sec Sequence
sig5 = 1 << sigA << 2 << sigB 
# 1 sec fade/overlay between sigA and sigB, 6 sec sequence
sig6 = sigA << -1 << sigB 
  • Sequenced signals created above: Sequences

  • Sequences can also be concatenated:

# Sequence of sig4, sig5, and sig6. Note this will also modify sig4.
sig7 = sig4 << sig5 << sig6 
# Play sig7 on channel 0 for its length of 23 seconds
session.play(0, sig7)
sleep(sig7.length)
  • You can also insert Signals into an existing Sequence timeline:
# Insert 1 s of noise starts at the 4 second mark of sig5
sig5.insert(Noise() * Envelope(1), 4) 
# Play sig5 on channel 0
session.play(0, sig5) 
sleep(sig5.length)
Relevant Examples(s)
example_sequences.py

Spatializers

  • Spatializers map multiple channels to a normalized (0 to 1) continuous 1D or 2D spatial representation.
  • For example, you can configure a virtual grid to match the physical layout of a tactor array.
  • You can then set a virtual target coordinate and radius to play and blend multiple tactors at once.
  • Only channels within a target radius are played.
  • The volume of channels is interpolated according to a specified roll-off law (ie. linear, logarithmic, etc.) based on their proximity to the target location using. The roll-off law can be changed with roll_off.
  • Below is an example of creating a spatializer:
spatial = Spatializer(session)        # create 2D Spatializer

spatial.create_grid(4,6)              # Grid of 4 rows x 6 cols
spatial.set_position(18,(0.1,0.8))    # move channel 18 by x = 0.1, y = 0.8
spatial.radius = 0.3                  # effect radius
spatial.roll_off = 'linear'           # set roll off method
spatial.target = (0.2, 0.1)           # target location
spatial.play(sig1)                    # play Signal
sleep(3)                              # wait 3 seconds while the Signal plays
spatial.stop()
  • To create sweeping motions with tactile arrays, you can move the target location in a while or for loop along a predescribed path.
  • Master volume and pitch of the Spatializer can also be modified using volume and pitch.
while condition:
    spatial.target = (x,y) 
    spatial.volume = v
    spatial.pitch = p
  • The Spatializer created in the examples above: Spatializers

  • Channel positions can be set as uniform grids (as above) or individually using set_position.
  • Below is an example of custom channel positioning:
chs = session.channel_count
# set up position of channels, evenly distributed
spc = 1.0 / (chs - 1)
for i in range(chs):
    spatial.set_position(i, (i * spc, 0))
Relevant Examples(s)
example_spatializer.py

Library

  • Signals can be saved to a disk and reloaded at a later time using Library.
  • In Syntacts, the default file format is a binary representation of the serialized Signal.
    • This saves only the parameters needed to reconstruct the Signal at runtime instead of saving all individual audio samples.
    • Using this format creates smaller files which can be loaded more quickly on the fly than other audio file formats.
  • To save and import in the default location (i.e. APPDATA/Syntacts/Library), use the functions save_signal and load_signal:
# Make a Signal to save/export
out = Sine(440) * ASR(1,1,1)

# Syntacts Binary Format (Default Location, i.e. APPDATA/Syntacts/Library)
Library.save_signal(out, 'out') # file name is in quotation marks
loadedsig = Library.load_signal('out')  # load into a new signal
  • Signals can be saved and imported in other file locations using the functions export_signal and import_signal.
  • You can customize the file location by specifying the file path. This is changed using quotation marks: 'file path'.
  • Files can be saved with a relative or absolute path:
# Binary format saved in a custom location
# Export/import with a relative path
Library.export_signal(out, 'relative/folder/out.sig')
loadedsig = Library.import_signal('relative/folder/out.sig')

# Export/import with an absolute path
Library.export_signal(out, '/absolute/folder/out.sig')
loadedsig = Library.import_signal('/absolute/folder/out.sig')
  • Syntacts can also export and import JSON, WAV, and AIFF file formats to use with existing haptic libraries. CSV and TXT files can only be exported.
  • To use the above file formats, simply change the file format in your path to your desired file type:
# JSON format
Library.export_signal(out, 'folder/out.json')
loadedsig = Library.import_signal('folder/out.json')

# WAV format - can use .wav, .WAV, or .wave
Library.export_signal(out, 'folder/out.wav')
loadedsig = Library.import_signal('folder/out.wav')

# AIFF format - can use .aiff, .AIFF, or .aifc
Library.export_signal(out, 'folder/out.aiff')
loadedsig = Library.import_signal('folder/out.aiff')

# CSV format (import not yet supported)
Library.export_signal(out, 'folder/out.csv')

# TXT format (import not yet supported)
Library.export_signal(out, 'folder/out.txt')
Relevant Examples(s)
example_library.py