Changelog

0.4.0.2.1.4.0

  • Updates SunVox DLL to 2.1.4 (2.1.4.0 internally).

  • Adds new library function and slot method get_base_version to get the SunVox version used to create a project.

  • Adds new ShmBufferedProcess class in sunvox.buffered.shm module that uses shared memory instead of stdio for inter-process communication, providing more efficient audio buffer transfer between processes.

  • Adds Slot.get_time_map overload to accept SharedMemory as destination, enabling efficient time map retrieval in multiprocess scenarios.

  • Exports many previously-defined library functions that were missing from sunvox.dll.__all__: sync_resume, set_song_name, find_module, metamodule_load, metamodule_load_from_memory, vplayer_load, vplayer_load_from_memory, set_module_name, set_module_xy, set_module_color, set_module_finetune, set_module_relnote, get_module_type, set_module_ctl_value, get_module_ctl_group, get_module_ctl_max, get_module_ctl_min, get_module_ctl_offset, get_module_ctl_type, new_pattern, remove_pattern, set_pattern_xy, set_pattern_size, set_pattern_name, get_pattern_event, set_pattern_event, pattern_mute, and sunvox_fn.

0.3.7.2.1.2.1

  • Fixes compatibility with NumPy >= 2.0.2 by replacing deprecated numpy.fromstring with numpy.frombuffer in buffered processing.

0.3.6.2.1.2.1

  • Updates SunVox DLL to 2.1.2b (2.1.2.1 internally).

  • Adds new library functions and slot methods sv_sampler_par and sv_save_to_memory.

  • Allows auto-cleanup of a SunVox process by using a context manager.

  • Fixes missing save from sunvox.dll.__all__, which prevented a Slot of a BufferedProcess from being able to save project files to disk.

  • Fixes pat_num not being correctly passed through when calling sunvox.slot.Slot.set_pattern_event. (Thanks to Phoel Ostrum.)

  • Moves from poetry and poetry-core to uv and hatchling.

  • Switches from using black to ruff for formatting code.

0.3.5.2.1.0.3

  • Updates SunVox DLL to 2.1c (2.1.0.0 internally).

  • Adds sunvox.types.NOTECMD.PREV_TRACK command.

  • Exports sunvox.types.TIME_MAP enum from sunvox.api module.

0.3.4.2.1.0.2

  • Updates SunVox DLL to 2.1b (2.1.0.0 internally).

  • Adds new library functions and slot methods set_song_name, metamodule_load, metamodule_load_from_memory, vplayer_load, vplayer_load_from_memory, get_module_type, set_module_name, set_module_xy, set_module_color, set_module_finetune, set_module_relnote, set_module_ctl_value, get_module_ctl_min, get_module_ctl_max, get_module_ctl_offset, get_module_ctl_type, get_module_ctl_group, new_pattern, remove_pattern, set_pattern_xy, set_pattern_size, and set_pattern_name.

  • Adds documentation for get_module_ctl_value.

  • Updates documentation for module_curve, get_pattern_x, get_pattern_y, get_pattern_tracks, get_pattern_lines, and get_pattern_name.

  • Updates constants and docs in sunvox.types based on SunVox DLL 2.1b headers.

  • Fixes mapping of sunvox.dll.get_sample_rate to point to the correct C function.

0.3.3.2.0.0.0

  • Updates SunVox DLL to 2.0e (2.0.0.0 internally).

  • Adds support for M1-based Mac systems.

0.3.2.2.0.0.0

  • Updates SunVox DLL to 2.0c (2.0.0.0 internally).

  • Adds new library functions and slot methods save (save_filename when using within a slot), sync_resume, set_pattern_event, and get_pattern_event.

  • Adds new documentation to pause, resume, get_number_of_modules, get_module_inputs, get_module_outputs, and get_number_of_patterns.

0.3.1.1.9.6.1

  • Updates SunVox DLL to 1.9.6c (still 1.9.6.1 internally).

  • Increases maximum number of slots to 16.

  • Adds new library functions and slot methods pause and resume.

  • Allows passing extra initialization flags in to a BufferedProcess.

  • Allows passing an input buffer to fill_buffer.

  • Fixes loading DLL using Python 3.9 on Windows.

0.3.0.1.9.6.1

  • Update SunVox DLL to 1.9.6b (1.9.6.1).

  • Update minimum version of Python supported to 3.7.

  • Update docstrings to match new information in upstream sunvox.h.

  • Update sunvox.slot.Slot.load_module method to always use load_module_from_memory function internally.

  • Remove SV_ prefix from enums in sunvox.types.

  • Remove functions that were deprecated in DLL 1.9.5c, and remove wrapper methods in sunvox.slot.Slot when relevant:

    • sunvox.dll.get_sample_type()

    • sunvox.dll.get_module_scope()

  • Add wrappers for functions added in DLL 1.9.4c, with wrapper methods in sunvox.slot.Slot when relevant:

    • sunvox.dll.audio_callback2()

    • sunvox.dll.update_input()

    • sunvox.dll.load_module_from_memory()

    • sunvox.dll.sampler_load_from_memory()

    • sunvox.dll.get_log()

  • Add wrappers for functions added in DLL 1.9.5c, with wrapper methods in sunvox.slot.Slot when relevant:

    • sunvox.dll.get_time_map()

    • sunvox.dll.get_autostop()

    • sunvox.dll.get_sample_rate()

    • sunvox.dll.find_module()

    • sunvox.dll.find_pattern()

    • sunvox.dll.get_pattern_name()

    • sunvox.dll.get_module_finetune()

    • sunvox.dll.module_curve()

    • sunvox.dll.set_event_t()

  • Add new constants:

    • sunvox.types.MODULE.FLAG_MUTE

    • sunvox.types.MODULE.FLAG_SOLO

    • sunvox.types.MODULE.FLAG_BYPASS

  • Add type annotations to all sunvox.dll function wrappers.

  • Add type annotations and docstrings to sunvox.slot.Slot methods.

  • Add sunvox.macros module containing ports of C macros introduced in 1.9.4c and 1.9.5c:

    • sunvox.macros.GET_MODULE_XY

    • sunvox.macros.GET_MODULE_FINETUNE

    • sunvox.macros.PITCH_TO_FREQUENCY

    • sunvox.macros.FREQUENCY_TO_PITCH

  • Format code using black.

0.2.1.1.9.3.2 (2018-02-28)

  • Add Raspberry Pi version of SunVox DLL.

  • Add sunvox.SUNVOX_COPYRIGHT_NOTICE constant, for use in apps that make use of this package.

0.2.0.1.9.3.1 (2017-11-25)

  • Update SunVox DLL to 1.9.3b (1.9.3.1).

0.2.0.1.9.3.0 (2017-11-25)

  • Update SunVox DLL to 1.9.3.0.

  • Add support for Windows 64-bit.

  • Correct notation of sharps/flats to match SunVox.

  • Improvements to buffered processes.

0.1.0.1.9.2.0 (2016-11-08)

  • Initial release.