sim-lib-sound-render 0.1.2

Offline PCM rendering, WAV encoding, and render diagnostics for sound objects.
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

use thiserror::Error;

/// Error raised by sound rendering and WAV encoding.
#[derive(Debug, Error, Clone, PartialEq, Eq)]
pub enum SoundRenderError {
    /// The sample rate was zero.
    #[error("sample rate must be positive")]
    InvalidSampleRate,
    /// The channel count was neither mono (1) nor stereo (2).
    #[error("renderer only supports mono or stereo output")]
    InvalidChannelCount,
    /// The sample buffer length was not divisible by the renderer channel count.
    #[error("audio buffer length is not aligned to the renderer channel count")]
    ChannelMisalignedSamples,
    /// The audio buffer exceeded the size encodable in a WAV header.
    #[error("audio buffer too large to encode")]
    BufferTooLarge,
    /// The timbre policy rejected the requested preview pitch.
    #[error("timbre policy rejected preview pitch")]
    TimbrePreviewRejected,
    /// The timbre did not yield any renderable partials.
    #[error("timbre preview has no renderable partials")]
    EmptyTimbrePreview,
}