embedded-audio-core 0.2.1

no_std duty-modulated PWM audio: effect banks, tiered DSP, and mixing for Cortex-M
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
104
105
106
107
108
109
110
111
112
113
114
115

#![no_std]

//! Duty-modulated PWM audio for embedded targets: effect banks, tiered DSP, mixing.
//!
//! # Quick start
//!
//! ```ignore
//! use embedded_audio::prelude::*;
//!
//! let bank = SoundBank::parse(FLASH_BLOB)?;
//! let mut engine = AudioEngine::new(AudioConfig::default_duty());
//! engine.set_bank(bank);
//! engine.play(1, AdsrSpec::click())?;
//!
//! // In a timer ISR at `config.sample_rate_hz`:
//! let duty = engine.tick();
//! ```
//!
//! # Tiers
//!
//! | Tier | Source | Use |
//! |------|--------|-----|
//! | A | Tone / wavetable / FM synth | UI beeps, alarms |
//! | B | PCM8 / IMA ADPCM in flash | Sampled SFX |
//! | C | Packed ΣΔ bitstream | Premium short sounds |
//!
//! Build banks on the host with the `eaf-bake` tool (`std` feature).
//!
//! # Procedural extras
//!
//! Standalone building blocks, composed manually rather than driven through the bank format:
//! [`pluck::KarplusPluck`] (Karplus-Strong string) and [`fx`] (`Overdrive`, `Wavefolder`,
//! `Tremolo`) need no extra feature; [`drums`] (`AnalogBassDrum`, `AnalogSnareDrum`, `HiHat`)
//! and [`dsp`] need the `dsp` feature.

#[cfg(feature = "std")]
extern crate std;

pub mod bank;
pub mod config;
pub mod decode;
pub mod engine;
pub mod envelope;
pub mod error;
pub mod fixed;
pub mod fx;
pub mod hal;
pub mod output;
pub mod pluck;
pub mod prelude;
pub mod source;
pub mod stream;
pub mod synth;
pub mod tier;
pub mod voice;

#[cfg(feature = "std")]
pub mod encode;

#[cfg(feature = "std")]
pub mod preview;

#[cfg(feature = "fm")]
pub mod profile;

#[cfg(feature = "dsp")]
pub mod dsp;

#[cfg(feature = "dsp")]
pub mod drums;

pub use bank::{BANK_BUILD_CAP, BANK_MAGIC, BANK_VERSION, BankBuilder, EffectEntry, SoundBank};
pub use config::{
    AudioConfig, DEFAULT_PWM_CARRIER_HZ, DEFAULT_PWM_PERIOD, DEFAULT_SAMPLE_RATE_HZ,
    crossfade_step_q8,
};
pub use decode::{AdpcmDecoder, AdpcmStream, Pcm8Stream};
pub use engine::{AudioEngine, VoiceStealingPolicy};
pub use envelope::{Adsr, AdsrSpec};
pub use error::AudioError;
pub use fixed::{db_to_q8, q8_to_db};
pub use fx::{Overdrive, Tremolo, Wavefolder};
pub use hal::{
    DmaDoubleBuffer, DutyBuffer, PwmDutySink, fill_buffer_into, fill_dma_half_buffers, tick_into,
};
pub use output::{
    DutyMode, PwmMapper, SigmaDelta, SigmaDelta2ndOrder, pcm_to_dac_u8, pcm_to_dac_u12,
    pcm_to_dac_u16, pcm_to_i16, pcm_to_i32,
};
pub use pluck::KarplusPluck;
pub use source::VoiceSource;
pub use stream::SigmaDeltaBitStream;
pub use synth::{
    FmVoice, PULSE_25_TABLE, SAW_TABLE, SINE_TABLE, SQUARE_TABLE, TRIANGLE_TABLE, ToneParams,
    ToneVoice, Waveform, WavetableVoice, generate_wavetable_fixed,
};
pub use tier::{EffectKind, flags};

#[cfg(feature = "std")]
pub use preview::{render_effect_pcm, render_effect_wav};

#[cfg(feature = "fm")]
pub use output::{FmMapper, FmTick};

#[cfg(feature = "fm")]
pub use profile::markham;

#[cfg(feature = "dsp")]
pub use dsp::{
    AudioLmsFilter, AudioMeter, AudioSpectrumAnalyzer, AudioStats, BiquadAudioFilter,
    BiquadAudioFilterQ15, EnvelopeFollower, GoertzelDetector, WindowType,
};

#[cfg(feature = "dsp")]
pub use drums::{AnalogBassDrum, AnalogSnareDrum, HiHat};