Skip to main content

This python package provides the necessary tools to use an OptiTrack optical tracking system for different applications of the SoundScape Renderer (SSR) including listener position and orientation tracking in local sound field synthesis.

It contains several modules including a module to connect to the OptiTrack system (opti_client) and a seperate one to connect to and control instances of the SSR (ssr_client). The module that connects these aforementioned ones and implements sequence and desired functionality is also part of the package (bridges).

Note that the optirx 1.10 library is included here with only minor changes from the original source and that the modules ssr_client and opti_client respectively are designed to be used independently in other projects as well.

Documentation:

http://opti-ssr.rtfd.io/

Source code:

https://github.com/OptiTools/opti_ssr

Python Package Index:

http://pypi.python.org/pypi/opti_ssr/

Example files to set up the SSR:

https://github.com/OptiTools/opti_ssr-examples

License:

MIT – see the file LICENSE for details.

Installation

Aside from Python itself, NumPy and pyquaternion are needed. It should work with both Python3 as well as Python2.

The easiest way to install this package is using pip to download the latest release from PyPi:

pip install opti_ssr

Usage

To use opti_ssr you can use a demo function like the basic one below. Simply instantiate the necessary class objects according to the given parameters and start the thread in the class that contains the functionality. Ready-to-use demo functions to demonstrate head orientation tracking in binaural synthesis or listener tracking in local sound field synthesis are available at the github repository. The SoundScape Renderer has to be started prior to opti_ssr.

import opti_ssr

def demo(ssr_ip, ssr_port, opti_unicast_ip, opti_multicast_ip, opti_port, ssr_end_message):
    optitrack = opti_ssr.OptiTrackClient(opti_unicast_ip, opti_multicast_ip, opti_port)
    ssr = opti_ssr.SSRClient(ssr_ip, ssr_port, ssr_end_message)
    headtracker = opti_ssr.HeadTracker(optitrack, ssr)
    headtracker.start()

if __name__ == "__main__":
    demo()

Release files for opti-ssr 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opti-ssr 0.1.4
File Size Uploaded
opti_ssr-0.1.4.tar.gz 11.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for opti-ssr 0.1.4
File Interpreter ABI Platform
opti_ssr-0.1.4-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 25.4 kB

Release files / opti_ssr-0.1.4.tar.gz

Download URL opti_ssr-0.1.4.tar.gz
Size 11.8 kB
Tags Source
SHA-256 checksum
How to use checksums
897dd2c3e07dec5cc3535dea178d957fd8a402b6721e415efd61ca0078e1b8bb
BLAKE2b-256 checksum
How to use checksums
7f52b4bb773c23cc2f1c881e534260581cf4392c6dca0242d21de5877c36a1a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / opti_ssr-0.1.4-py2.py3-none-any.whl

Download URL opti_ssr-0.1.4-py2.py3-none-any.whl
Size 13.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7d12c4c07e4d1de027dfb42400d70009da9158f0dd4f75344265ef320b37ddad
BLAKE2b-256 checksum
How to use checksums
4d717394e716a7fc63f803d65777f0fe0fe28a6b8fde46de1db01076cc90f257
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page