game-toolkit-dosaudio 0.1.6

Emulated DOS-era sound hardware for Rust games: PC speaker, AdLib/OPL3, Sound Blaster 1 to 16, MPU-401 with General MIDI and MT-32, and Tandy PSG on one shared hardware clock
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! DOS-era sound devices sharing one timestamped hardware timeline.
//!
//! Game code owns [`DosAudio`]; an audio callback owns [`AudioEngine`]. Port
//! commands cross a bounded queue with [`Tick`] timestamps from
//! `game-toolkit-dosbus`. Music is prepared before playback and sequenced on the
//! audio thread. [`OfflineMachine`] uses the same renderer without audio I/O.
//!
//! ```
//! use game_toolkit_dosaudio::{OfflineMachine, SoundConfig};
//! use std::time::Duration;
//!
//! let mut machine = OfflineMachine::new(SoundConfig::none().speaker(true), 48_000)?;
//! machine.sound(440.0)?;
//! machine.render_for(Duration::from_millis(100))?;
//! machine.nosound()?;
//! machine.render_for(Duration::from_millis(20))?;
//! let wav_bytes = machine.finish().to_bytes()?;
//! assert_eq!(&wav_bytes[..4], b"RIFF");
//! # Ok::<(), game_toolkit_dosaudio::Error>(())
//! ```
#![forbid(unsafe_code)]

mod bus;
mod capture;
mod config;
mod device;
#[cfg(feature = "sb")]
mod dma;
mod engine;
mod error;
#[cfg(feature = "formats")]
pub mod formats;
pub mod midi;
pub mod music;
mod offline;
mod speaker;
pub use speaker::{Melody, SpeakerHandle, speaker_pwm};
#[cfg(feature = "opl")]
mod opl;
#[cfg(feature = "sb")]
pub mod sfx;

pub use bus::DosAudio;
pub use capture::{Capture, MusicCapture, PortWrite};
pub use config::{OplBackend, OplChip, SbModel, SoundBlasterConfig, SoundConfig};
#[cfg(feature = "opl")]
pub use device::opl::OplCore;
#[cfg(feature = "psg")]
pub use device::psg::Psg;
#[cfg(feature = "sb")]
pub use dma::{ConventionalMemory, DmaCompletion, DmaController, DmaUnit};
pub use engine::{AudioEngine, EngineStats};
pub use error::{Error, Result};
pub use game_toolkit_dosbus::{
    DmaChannel, DmaDirection, DmaRequest, DmaWidth, IoDevice, IrqLine, IrqRequest, PortRange, Tick,
    TickAccumulator,
};
#[cfg(feature = "gm")]
pub use midi::{GmSynth, SoundFont};
pub use midi::{MidiBackend, MidiMessage, MidiSynth};
#[cfg(feature = "mt32")]
pub use midi::{Mt32Model, Mt32Roms, Mt32Synth};
pub use music::{
    MusicController, MusicDevice, MusicEvent, MusicHandle, MusicTarget, PlayOptions, PreparedMusic,
    Sequence, Soundtrack, TimedEvent,
};
pub use offline::{OfflineMachine, Wav};
#[cfg(feature = "opl")]
pub use opl::{
    Drum, Note, Opl, OplBank, OplBankEntry, OplBankKey, OplInstrument, OplMidiDriver, OplOperator,
    OplPatch,
};
#[cfg(feature = "sb")]
pub use sfx::{SfxHandle, SfxMixer, SfxVoiceHandle};

/// A stereo PCM frame, with each channel in -1 through 1.
pub type Frame = [f32; 2];

/// Common machine, device and music types.
pub mod prelude {
    #[cfg(feature = "formats")]
    pub use crate::formats::{Dro, Imf, Smf, Vgm};
    pub use crate::{
        AudioEngine, DmaChannel, DosAudio, Frame, IoDevice, MusicController, MusicEvent,
        MusicHandle, MusicTarget, OfflineMachine, OplBackend, OplChip, PlayOptions, PreparedMusic,
        SbModel, Sequence, SoundBlasterConfig, SoundConfig, Tick, TimedEvent,
    };
    #[cfg(feature = "sb")]
    pub use crate::{
        ConventionalMemory, DmaController, DmaUnit, SfxHandle, SfxMixer, SfxVoiceHandle,
    };
    #[cfg(feature = "opl")]
    pub use crate::{
        Drum, Note, Opl, OplBank, OplBankEntry, OplBankKey, OplInstrument, OplMidiDriver,
        OplOperator, OplPatch,
    };
    pub use crate::{MusicDevice, Soundtrack};
}

// Compiles the README examples, which use default-feature APIs.
#[cfg(all(doctest, feature = "sb", feature = "formats", feature = "toolkit"))]
#[doc = include_str!("../README.md")]
struct ReadmeDoctests;