CHANGELOG.md

[UNRELEASED] - YYYY-MM-DD

Fixed

• Fix playback_lsl.py for cases where no metadata is available in the to-be-streamed XDF file ([#160] by Stefan Appelhoff)

[1.17.4] - 2026-03-25

Fixed

• Skip linear dejittering for streams flagged with can_drop_samples to prevent dropped-frame streams from being shifted too early in time (#165 by Clemens Brunner)
• Fix detection of clock sync corruption in additional cases (#167 by Alin G. Chitu)

[1.17.3] - 2026-01-20

Fixed

• Improve detection and truncation of anomalous samples causing clock synchronization corruption (#158 by Mathieu Scheltienne)

[1.17.2] - 2026-01-07

Added

• Add new case_sensitive parameter to match_streaminfos, defaulting to True to maintain previous behavior; when False, stream properties are matched more leniently (#134 by Stefan Appelhoff)
• Expose detected clock segments (used in synchronization) as stream["info"]["clock_segments"] (#131 by Jamie Forth)

Changed

• Segment at negative time intervals when dejittering by considering the absolute time difference (#140 by Benedikt Ehinger and Jamie Forth)

Fixed

• Ensure empty stream segments are initialized (#129 by Jamie Forth)
• Uniformly calculate effective sample rate as (len(time_stamps) - 1) / duration (#129 by Jamie Forth)
• Handle LinAlgError (with warning) during synchronization (#131 by Jamie Forth)
• Fix synchronization for streams with clock resets and MAD calculation used in clock value segmentation (#131 by Jamie Forth)
• Fix file playback when not looping (#136 by Chadwick Boulay)
• Fix clock synchronization corruption caused by garbage data when outlet closes before inlet (#150 by Jesse Livezey and Mathieu Scheltienne)
• Fix UserWarning emitted by numpy.divide in NumPy 2.4+ (#146 by Mathieu Scheltienne)

[1.17.1] - 2025-10-13

⚠️ YANKED: This release was yanked from PyPI on 2025-10-27 due to a severe regression regarding effective sampling frequency and clock segments calculation.

[1.17.0] - 2025-01-07

Fixed

• Expose detected segment (used in dejittering) as stream["info"]["segments"] (#117 by Robert Guggenberger)
• A non-looping playback of an XDF file will no longer lead to a TypeError (#119 by Stefan Appelhoff)
• Reported segments now have the correct sample stop, are no longer duplicated, and empty streams return segments as an empty array rather than [0, -1] (#121 by Jamie Forth)

Changed

• Rename pyxdf.examples module to pyxdf.cli (#118 by Clemens Brunner)
• Reverse logic of --loop argument in pyxdf.cli.playback_lsl.py to be more in line with standard practice: Supplying --loop will loop, whereas omitting --loop will NOT loop (#119 by Stefan Appelhoff)

[1.16.8] - 2024-07-18

Fixed

• Fix reading numeric array data on big-endian hosts (#98 by Ben Beasley)

[1.16.7] - 2024-07-17

Added

• Add clock_times and clock_values to stream dictionary (#105 by Fabian Grosch)

[1.16.6] - 2024-04-18

Changed

• Minimum required Python version is now 3.9 (#100 by Clemens Brunner)

[1.16.5] - 2024-01-12

Added

• Added compatibility with Python 3.12 (#96 by Clemens Brunner)

[1.16.4] - 2023-01-09

Fixed

• Fix invalid np.object type (#87 by Clemens Brunner)
• Fix robust fit for large timestamps (#73 by Chadwick Boulay)
• Fix loading stream with no samples when dejitter_timestamps=False (#82 by Robert Guggenberger)

[1.16.3] - 2020-08-07

Added

• Add Cython type hints (requires optional local compilation) (#17 by Tristan Stenner)

Fixed

• Handle XDF files with corrupt chunk headers (missing stream IDs) more gracefully (#62 by Robert Guggenberger)

• Treat nominal_srate field as float to fix parsing errors (#65 by Robert Guggenberger and #68 by Clemens Brunner)

Changed

• load_xdf now requires keyword-only arguments after the first two arguments (#59 by Christian Kothe)

[1.16.2] - 2019-10-23

Added

• Allow loading from already opened file objects, e.g. in-memory files or network streams (#51 by Tristan Stenner)
• Add CI tests with example data (#49 by Clemens Brunner)

Fixed

• Compare nominal to effective sampling rates only for regularly sampled streams (#47 by Clemens Brunner)
• More robust error recovery for compressed corrupted files (#50 by Tristan Stenner)

Changed

• Speed up loading of numerical data (#46 by Tristan Stenner)
• Avoid/suppress some NumPy warnings (#48 by Clemens Brunner)

[1.16.1] - 2019-09-28

Fixed

• Remove Python 2 compatibility from setup.py (#45 by Clemens Brunner)

[1.16.0] - 2019-09-27

Added

• Add option to load only specific streams (#24 by Clemens Brunner)
• Add verbose argument to load_xdf (#42 by Chadwick Boulay)

Fixed

• Fix bug in jitter removal (#35 by Alessandro D'Amico)
• Add compatibility with Python 3.5 by converting Pathlike objects to str for file open functions (#37 by hankso)

Changed

• Refactor jitter removal code to be more readable (#36 by Chadwick Boulay)

[1.15.2] - 2019-06-07

Added

• Store unique stream ID inside the ["info"]["stream_id"] dict value (#19 by Clemens Brunner)

[1.15.1] - 2019-04-26

Added

• Support pathlib objects (#7 by Clemens Brunner)
• Allow example script to be called with an optional XDF file name (e.g. python -m pyxdf.example or python -m pyxdf.example xdf_file.xdf) (#10 by Tristan Stenner)

Fixed

• Use correct data types (#2 by Tristan Stenner)
• Streams are not sorted by name anymore (#3 by Clemens Brunner)
• Support older NumPy versions < 1.14 (#4 by Clemens Brunner)
• Pass correct on_chunk argument (#5 by Clemens Brunner)
• Fix _scan_forward (#6 by Clemens Brunner)

Changed

• Pull StreamData class and chunk 3 reader out of load_xdf (#13 by Tristan Stenner)