xmrsplayer 0.10.3

XMrsPlayer is a safe no-std soundtracker music player
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

#![forbid(unsafe_code)]
#![cfg_attr(not(feature = "std"), no_std)]

extern crate alloc;

// `no_std` builds need a float math backend because `f32`'s transcendental
// methods (`sqrt`, `sin`, `log2`, ...) live in `std`. Users must opt into
// exactly one of `libm` or `micromath` when `std` is disabled.
#[cfg(not(any(feature = "std", feature = "libm", feature = "micromath")))]
::core::compile_error!(
    "xmrsplayer: with `std` disabled, enable exactly one float math backend: \
     feature `libm` or feature `micromath`."
);

pub(crate) mod effect;
pub(crate) mod triggerkeep;

pub(crate) mod effect_arpeggio;
pub(crate) mod effect_vibrato_tremolo;

pub mod channel;
pub(crate) mod helper;
pub mod prelude;
pub(crate) mod state_auto_vibrato;
pub(crate) mod state_envelope;
pub(crate) mod state_filter;
pub(crate) mod state_instr_default;
pub(crate) mod state_sample;
pub(crate) mod voice;

/// Generational arena of `Voice`s, indexed by opaque `VoiceId`
/// handles. Owns every live and ghost voice the player has in
/// flight; channels carry only handles. Capacity is configurable
/// at construction (default 256, mirroring schism's `MAX_VOICES`)
/// and the pool falls back to lowest-audible-volume eviction when
/// full — see [`voice_pool::VoicePool::allocate_live`] /
/// [`voice_pool::VoicePool::allocate_ghost`].
pub(crate) mod voice_pool;

// --- Post-refactor modules (0.10) ---

/// Song cursor and tick clock. Consumes navigation-side global effects
/// (`Fxx`, `Bxx`, `Dxx`, `E6y`, `EEy`, `BPM`, `BPMSlide`) directly from
/// pattern cells, without going through channels.
pub mod sequencer;

/// Audio engine: per-channel state, mixer gain, and sample generation.
/// Consumes volume-side global effects (`Volume`, `VolumeSlide`).
pub mod voices;

/// Subscription API — `PlayerObserver` trait and event context structs.
pub mod observer;

/// Audio-side subscription API — `MixObserver` and `ChannelsObserver`
/// traits for consumers of the produced audio stream (VU-meters,
/// oscilloscopes, recorders, analyzers).
pub mod audio_observer;

/// MIDI-side subscription API — `MidiObserver` trait for consumers
/// of MIDI events emitted by the IT macro interpreter (`Zxx` macros
/// that encode Note On/Off, CC, Program Change, SysEx, etc.).
pub mod midi_observer;

/// Built-in observer that prints pattern/row changes. Requires `std`.
#[cfg(feature = "std")]
pub mod debug_observer;

/// Built-in MIDI observer that prints MIDI events to stdout. Requires
/// `std`. Mirrors `debug_observer` but for the `MidiObserver` trait.
#[cfg(feature = "std")]
pub mod debug_midi_observer;

pub mod xmrsplayer;