Known issues

This version is buggy! Get the 2023.3.0 version in case you run into errors.

• issues with opening the camera using the PS3 Eye open driver (please report in #1877).
• camera settings dialog's values may not persist across multiple tracking sessions (report in #1880).
• the debug info package is missing .pdb files for Qt.

Compatibility

The 64-bit build should greatly improve performance for tracker/neuralnet compared to 2023.3.0.

However, proto/fsuipc isn't supported anymore and the the legacy CL-Eye driver for the PS3 Eye can't be used. The open driver is recommended.

The 32-bit build doesn't require AVX and can be used by legacy CPUs.

Features

• tracker/neuralnet now has better performance in the 64-bit build (@DaWelter, @sthalik).
• filter/accela-hamilton added as a new filter that combines filter/hamilton's proper rotations and filter/accela's quick response time (by @DaWelter).
• core post-inverting output (i.e. replacing +180 yaw to -180) has been split into separate pre-invert (useful with mirrored camera frames) and post-invert (useful when using output through a virtual joystick or other generic method) (@sthalik).

Fixes

• core fix mapping window taking a large amount of CPU time while tracking is started (@sthalik).
• core fix multiple modules such as tracker/pt randomly failing to load on Windows 7 or even some Windows 10 machines (please report any remaining issues) (@sthalik).
• tracker/neuralnet now works on Windows 7 (see patch) (@sthalik).
• core try to fix F13-F23 keystrokes. this might not work or make things worse, please report any bugs (see #1269) (@sthalik).

Features

• filter/hamilton-accela added as a new filter that combines filter/hamilton's proper rotations and filter/accela's quick response time (by @DaWelter).
• core post-inverting output (i.e. replacing +180 yaw to -180) has been split into separate pre-invert (useful with mirrored camera frames) and post-invert (useful when using output through a virtual joystick or other generic method).

Fixes

• tracker/neuralnet now has a workaround for CPUs without AVX. You must replace onnxruntime.dll with onnxruntime-noavx.dll in order for it to work. Note that running without AVX is about twice as slow.
• tracker/neuralnet now works on Windows 7 (see patch).
• core fix mapping window taking a large amount of CPU time while tracking is started.
• core fix multiple modules such as tracker/pt randomly failing to load on Windows 7 or even some Windows 10 machines (please report any remaining issues).
• core try to fix F13-F23 keystrokes. this might not work or make things worse, please report any bugs (see #1269).

Features

• tracker/tobii: New tracker by @khoanguyen-3fc.
• tracker/neuralnet: Pre-release version 0.2 of the neural network by @DaWelter is available in settings.
• tracker/neuralnet: Fix inverted roll sign (by @DaWelter, reported by @ddzzkunye).
• tracker/hatire: Add non-standard higher baud rates (by @sthalik, explained by @GO63-samara).
• i18n: Improve the Chinese translation (by @ddzzkunye).
• contrib: Add libusbK driver kit installer. It's not being run by itself.

Fixes

• filter/ewma: Fix wrong background color in the filter settings dialog (by @ddzzkunye and @sthalik).

Changes

• fix crash on startup with very long environment PATH (issue #1661, reported by @wfurney13).
• video/opencv: apply bugfixes for Windows 11 and enable Media Foundation input.
• tracker/pt: improved color keying for overexposed pixels (issue #1665, by @tombrazier).
• tracker/eyeware-beam now has a 32-bit version (by @eyedav).
• tracker/aruco: enable 1080p resolution.
• filter/nm: new 'Natural Movement' filter (issue #1666, by @tombrazier).
• proto/simconnect: fix high CPU usage on FSX (issue #1670, by @tombrazier).
• filter/hamilton, filter/ewma: minor fixes (by @tombrazier, issues #1671 and #1667).
• proto/vjoystick: link to the fork with a working Windows 11 driver version (issue #1700, reported by @ackalker)

Discussion: #1706

Compatibility

This release build is only available as a 64-bit executable. This is because the SDK for the new tracker tracker/beam is temporarily only available as an amd64 binary.

Only CPUs supporting AVX will be able to run it. Please provide feedback on compatibility and performance compared to older releases.

Changes

• tracker/beam: new tracker for the by @eyedav (Davide Mameli) for the Eyeware Beam.
• tracker/neuralnet: tracking quality improved by @DaWelter (see 08f1fcad1c74e25f97641a0ccbd229b267ec528c for details).
• tracker/neuralnet: Russian translation by @Perlovka.
• video/ps3eye: experimentally enable retry of bulk data transfers for flaky USB controllers.
• tracker/realsense: downgrade to SDK 2016 R2.
• tracker/pt, tracker/aruco: fix tracking failing to start by not being able to select a camera when only one is available.
• proto/wine: improvements to Linux head tracking #1620 by @Priton-CE and #1616 by @fsimuser9430.

Fixes

• Fix tracker/wii not loading on some systems due to a build issue (reported by @GO63-samara, @oliverCJ and @proxlamus).

Discussion thread is #1557.

This is a bugfix release.

• Fix tracker/neuralnet position values being clobbered by the Accela filter (found by @Pieloth; issue #1349)
• Enable AVX support for the tracker/neuralnet module (issue #1359). In case you're using a CPU without AVX together with this face tracker, leave a message in the below discussion thread or open a new issue.

Discussion thread is #1548.

Features

• tracker/neuralnet: add support for operating in higher resolutions (by @DaWelter; #1476).
• module dialogs can now displayed as tabs even in low resolutions.
• options: a vendor can ship profile presets with the installer as modules/presets/*.ini. they'll be copied to the user's profile directory under Documents (but won't be copied again if they're deleted).
• contrib: add libusb installer for the ps3 eye open driver to contrib/libusbK-inf-wizard, to be used with this guide by weczi of IRTrack. this installation procedure is better than the one on the wiki, but hasn't been extensively tested. please report successes and failures in the discussion thread below.
• tracker/trackhat: implement LED tracking status indicator, add back the gain slider, and fix custom models.

Fixes

• tracker/steamvr: update to newer SDK version (report bugs in issues section or the discussion thread below).
• tracker/wii: fix tracking not working when the window is minimized and occluded

Discussion thread: #1500

Fixes

• tracker/trackhat: new tracker using a proprietary board with image processing sensor (sponsored by TrackHat)
• video: unbreak Kinect as IR camera source (reported by @ernest-cpu, @Slion; #1461)
• tracker/hatire: enable setting DTR when opening the COM port (reported by @AfromD, #139)
• tracker/pt: make dialog fit on smaller screens
• tracker/aruco: camera input MJPEG support (reported by @eexx1; #1431)
• tracker/neuralnet: camera input MJPEG support (implemented by @TheSpartaPT; #1467)
• tracker/neuralnet: don't require installing any Visual C++ redistributables
• tracker/udp: use SO_REUSEADDR
• opentrack: the default profile can now be customized as modules/presets/default.ini

Discussion: #1469

Fixes

• don't show embedded module dialogs on low resolutions; override by setting the OPENTRACK_MODULE_TABS environment variable to 0 or 1. issue #1407; reported by @00greena.
• fix handling of the Escape key with embedded module dialogs. as a consequence of this, the Escape key will now cancel and close the options dialog. report this as issue or in discussion thread if you hate this.

Features

• allow mouse shortcuts for extended buttons (not left, right, middle or mousewheel). keyboard modifiers like Ctrl or Shift are ignored for mouse shortcuts. issue #583; requested by many people.
• support multiple copies of the same camera model being connected at the same time. as a consequence of this, you may need to reselect the camera inside the tracker's options, but a migration has been added and should work in most cases. issue #1415; reported, tested and with additional help by @hrafnkelle and @nuxil.

Discussion

Discussion thread is #1419. Constructive comments and shitposts welcome. -- @sthalik

Fixes

• fix a bug introduced in opentrack 2021.1.3 that caused choppy output with the PT tracker (thanks to @dglava, @Vortex76, @Len62, @animusVoxxx, @3itZ as well as the Russian IL2 forum). it should work as well as 2021.1.2 even when not using the point filter (see 4b77e13d, f51d5339, 32720488).
• grayscale conversion methods are now clearly described in the PT tracker. obsolete averaging method is gone, and hardware-based grayscaling with the ps3eye open driver is optional and off by default (see f531c316).
• fix a bug where any selection for freetrack output other than 'enable both' caused both registry keys to be cleared (see 7c8fd629).
• the neuralnet tracker works with no VC++ redistributables installed, particularly on Windows 7 (build only fix).

Features

• module dialogs are now drawn inside the options window. sponsored by TrackHat Ltd. dialogs that haven't been converted yet are drawn normally.

Feedback

See discussion in thread #1402.

This is an old version for people with filter problems on 2021.2.0.

Notes

Workaround Windows Defender false positive by compiling the release with Visual Studio 2022 (#1371).

Features

Add another slider to the PT point filter. Setting it to a low value prevents sawtooth-like motion. The point filter greatly reduces the need for using Accela or any other generic filter.

The point filter hasn't yet been implemented for the Aruco tracker. If you're using the Aruco tracker and want it done, send a note.

Bug reports & discussion

Discuss the release in its discussion thread (https://github.com/opentrack/opentrack/discussions/1381). Send bug reports to the bug tracker (https://github.com/opentrack/opentrack/issues).

Features

• tracker/neuralnet: add a face tracker, by @DaWelter.
• new centering modes that fix the long-standing problem with yaw affecting pitch and vice versa. By @GO63-samara.
• tracker/pt: add MJPEG support
• proto/freetrack: add an easier method for dealing with Elite Dangerous library location problem, in the freetrack output settings.
• proto/freetrack: add back in the option for ephemeral freetrackclient/npclient library location
• [hotfix 3] tracker/pt: add point filter feature. this is arguably more effective than filtering after pose estimation via opentrack's regular filters. similar filter should be added to Aruco.

Fixes

• fix the Zero keybinding when using a custom center offset
• video/ps3eye: hopefully fix LED staying alight with the open driver
• [hotfix 1]: fix crash with the new PS3 Eye driver used with trackers other than PT
• [hotfix 2]: fix freetrack output not working for some users
• [hotfix 2]: tracker/pt: use color output from the open PS3 Eye driver when in color key mode
• [hotfix 3]: fix freezes on saving settings in the PT tracker while it's running
• [hotfix 3]: fix for non-zero values when deadzones are used in the mapping dialog
• [hotfix 3]: video/ps3eye: fix freeze with the open driver
• [hotfix 3]: tracker/pt: fix broken formula for point radius. you have to adjust your threshold sliders and min/max point sizes.

PS3 Eye open driver

opentrack now has a standalone driver for the PS3 Eye, and it's mature enough for its existence to be advertised more widely. Now you don't have to pay for (or pirate, for that matter) the CL Eye driver that's buggy, slow, unmaintained and broken with every other Windows 10 update. The crashes are gone and there's less CPU usage. It's also free as in beer.

• Uninstall any previous driver.
• Use the zadig program <https://zadig.akeo.ie/> to install the libusb-win32 driver onto interface 0 of the camera. Don't use the WinUSB driver!
• If it fails to work, try connecting the camera onto a USB 2.0 or a USB 3.0 controller that you haven't used yet. Then run zadig again.
• In Device Manager, make sure the driver is assigned to the device. If it's not, use the "update driver" button to select libusb (it's its own category).

Features

• Easy Tracker: Adding support for Clip models where three vertices are arranged from top to bottom (by @Slion).
• Apply dark theme on Windows if user enabled it in system settings (by @Slion).
• Now the Octopus pose is fully consistent with the aircraft pilot head pose. Also You can now see the mirror Octopus pose if set the Mirror checkbox to ON (by @GO63-samara).
• More compact size of the main window, as in Opentrack-2.3.10.

Bugs fixed

• Again, WiiPointTracker now appears in the input trackers list.
• Updated PS3 Eye open driver (by @sthalik).
• Easy Tracker: Disable Kinect distortion coefficients usage thus notably fixing badly broken Z component in translation vector (by @Slion).

Known bugs

• PS3 Eye open driver neglects to turn off the red LED after stopping tracking.

Features

• Experimental support for the PS3 Eye open driver! To use it, install libusb as the driver for "interface 0" of the camera device.
• Add color keying support for the PT tracker: you can now track plain colors (by @a1k0n).
• Switch RealSense SDK to 2016 R3 for newer camera support.
• Linux joystick tracker (by @russell).
• Some improvements to the Linux Proton output method (by @jp7677, @russell).

Bugs fixed

• Fix .csv logging crash when cancel pressed in dialog.
• Fix "start in tray" condition inverted.
• Allow dynamic pose for caps.
• Support F13-F24 as valid shortcuts on Windows on some gaming keyboards.
• Fix game detector "enabled" checkbox not reverting when cancel pressed in dialog.
• Fix yaw/roll jumping when crossing the +-180 border (by @GO63-samara).
• Add Hamilton filter (by @GO63-samara).
• Fix vjoystick again (for real this time!).
• Fix stuck keyboard shortcuts with modifiers when depressing the modifier key first.
• Update OVR SDK to 1.43.0. Now using the official binary release.

• tracker/easy: add new tracker for Kinect.
• tracker/wiimote: Fix crashes.
• camera: add Kinect video source, by @Slion.
• OSX now supports building .dmg installers, by @rvt.

See the top post of #778 for a partial changelog. There's no full changelog available at this moment, sorry. Please report old and new bugs by creating new issues on the issue tracker. It can be used as a forum as well.

I'm sorry for not crediting bug reporters at this moment. They'll be credited in 2.3.11 final. Also, hopefully this is the last beta for this release.

BETA3

• 🍰 implement Kinect tracker (by @Slion)
• 🔧 main: fix freeze in mapping window while tracking
• 🔧 tracker/pt: fix tracking for caps
• 🔧 proto/simconnect: fix it (didn't work at all)
• 🔧 proto/vjoystick: fix it (didn't work at all)
• 🔧 🍰 main: change center method

More BETA3 changes

• 🔧 main: show more ruler lines in mapping dialog
• 🔧 tracker/wii: fix crash and logic error on startup
• 🔧 main: fix camera/octopus freezes on HiDPI
• 🍰 tracker/aruco: add 50 Hz to framerate options
• 🍰 tracker/pt: scale the camera feed UI better on 320x240
• 🔧 proto/wine: more robust Wine detection in CMake
• 🔧 proto/win32-mouse: add legacy mouse move method (drifts a lot)
• 🔧 main: fix build with Qt 5.11 and above
• 🔧 main: build faster with GNU Make
• 🔧 main: show source line in debug messages
• 🔧 main: disable modules that don't work on Linux
• 🔧 main: disable modules that only work on Intel

Intro

Here's a new release after a long while. The more experimental features and rewrites were pushed into 2.4.0. This 2.3.10 release however, is intended as stable prior to any big breaking changes.

Developers needed

We need more core developers. If you're interested, send a few pull requests and you'll be granted a commit bit.

Several areas are neglected:

• The module-agnostic core code needs another hand badly.
• Linux support isn't continuously tested, breaks often, and lags behind in features
• OSX-specific code is close to nonexistent. Keybindings don't work.
• The project's bus number has been one since 2012 and this needs to change.

Compatibility issues

• Windows XP isn't supported anymore (in official builds).
• CPUs are expected to have SSE3 (in official builds). It's been a decade or so.

New features

• tracker/wiimote: by Wei Shuai @cpuwolf. Thanks for continuing development and great collaborative spirit.
• tracker/wiimote: implement automatic pairing with the Wiimote device (@cpuwolf)
• tracker/pt: the camera settings dialog now works!!! Thanks to @opencv for accepting the patch so quickly.
• tracker/pt: show brightness slider value and improve auto threshold
• tracker/pt: dynamic pose will fix itself when centering (for cap users)
• filter/accela: euthanize nonlinearity and smoothing options (confusing and useless for almost everyone)
• tracker/hatire: it's confirmed to work, and not necessary to use 2.3.1.5 anymore
• tracker/hatire: workaround bad input range on some devices
• fully portable mode (create portable.txt in program dir)
• mappings: default max pitch output to 90 in graph. show more scales with lower max input selection.
• modules: errors during tracking start are now more clear, with messages specific to each error
• reltrans: add a mode that disables reltrans when close to center (for WW2 sim users).
• gui: fix on HiDPI screens, even when changing resolution
• tray: close button must always exit the whole program (reported by @albertolg)

Deferred features

• Reorganizing some core code that is too messy to understand. Done for 2.4.0 but needs heavy testing.
• proto/freetrack: fix heavily-reported bug. Needs lots of heavy testing before release. Postponed till 2.4.0.
• tracker/tobii: initial version postponed till 2.4.0.

Future features

• Support plugins for obscure functionality (partially implemented)
• Support Linux joystick input tracker (Linux-specific, low priority, pull requests welcome)

Technical details

• this is the same version as the experimental build published some time ago
• Linux build fixes (reported by Artem Sobolev @ljgdasfhk)
• Improvements in keyboard/joystick code on Windows.
• Changes in how UI translation is handled.
• It should all work slightly faster now.
• You can test a translation by setting the OTR_FORCE_LANG environment variable to the appropriate value, e.g. zh_CN or ru_RU. This overrides your operating system's locale as well as "use English only.
• Lots of boring code changes only programmers understand. See commit log.

Thanks

Issue tracker

• @MathijsG, @Len62, @kzfr, @albertolg, @MrCapone, @cpuwolf -- bug reports
• @MathijsG, @Len62 -- answering user questions on the issue tracker

Translations

• Chinese translation -- (Wei Shuai @cpuwolf).
• updates to the Russian translation (Alex Orohovatski @mrsanchos).
• partial NL translation (Mathijs Groothuis @MathijsG).

Epilogue

Now, that was a mouthful. Please report bugs on either the issue tracker or via email, send to sthalik at misaki pl. Please use email in cases where you don't want to register on Github.

Software dedication

The software is dedicated to my late cat, Koszka. He loved sleeping on my chest, and his gentle purring made opentrack development that much more pleasant. He was a darling to all of our family and a great friend. You can see Koszka on the photo album <https://goo.gl/photos/jw7uckRKRLF1Yio97>.

Stability status

No important issues raised for 3 weeks as of 20170907.

Fixes

This is a bugfix release.

• fix sliders from 2.3.7-and-before configs being reset
• filter/accela: revert gain value changes -- reported by @petsild, #665
• tracker/pt: contours are inaccurate, revert them entirely

Non-fixes

• tracker/pt: auto threshold slider now scales point size to lower resolutions
• tracker/s2bot: new tracker interacting with the Smalltalk Squeak environment -- submitted by @achipa, #650
• fix Linux and OSX builds -- submitted by @MrCapone, #668, #669