soundfont 0.1.0

sf2 file parser
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

use super::super::utils::Reader;
use crate::riff::{Chunk, ScratchReader};
use crate::{error::Error, riff::ChunkId};
use std::io::{Read, Seek};

#[derive(Debug, Clone)]
pub struct SampleHeader {
    pub name: String,

    pub start: u32,
    pub end: u32,
    pub loop_start: u32,
    pub loop_end: u32,
    pub sample_rate: u32,

    pub origpitch: u8,
    pub pitchadj: i8,
    pub sample_link: u16,
    pub sample_type: SampleLink,
}

impl SampleHeader {
    pub(crate) fn read(reader: &mut Reader) -> Result<Self, Error> {
        let name: String = reader.read_string(20)?.trim_end().to_owned();
        // 20

        let start: u32 = reader.read_u32()?;
        // 24
        let end: u32 = reader.read_u32()?;
        // 28
        let loop_start: u32 = reader.read_u32()?;
        // 32
        let loop_end: u32 = reader.read_u32()?;
        // 36

        let sample_rate: u32 = reader.read_u32()?;
        // 40

        let origpitch: u8 = reader.read_u8()?;
        // 41
        let pitchadj: i8 = reader.read_i8()?;
        // 42
        let sample_link: u16 = reader.read_u16()?;
        // 44
        let sample_type: u16 = reader.read_u16()?;

        let sample_type = match sample_type {
            0 => SampleLink::None,
            1 => SampleLink::MonoSample,
            2 => SampleLink::RightSample,
            4 => SampleLink::LeftSample,
            8 => SampleLink::LinkedSample,
            0x8001 => SampleLink::RomMonoSample,
            0x8002 => SampleLink::RomRightSample,
            0x8004 => SampleLink::RomLeftSample,
            0x8008 => SampleLink::RomLinkedSample,
            0x11 => SampleLink::VorbisMonoSample,
            0x12 => SampleLink::VorbisRightSample,
            0x14 => SampleLink::VorbisLeftSample,
            0x18 => SampleLink::VorbisLinkedSample,

            v => {
                return Err(Error::UnknownSampleType(v));
            }
        };

        Ok(Self {
            name,
            start,
            end,
            loop_start,
            loop_end,
            sample_rate,
            origpitch,
            pitchadj,
            sample_link,
            sample_type,
        })
    }

    pub(crate) fn read_all(
        phdr: &Chunk,
        file: &mut ScratchReader<impl Read + Seek>,
    ) -> Result<Vec<Self>, Error> {
        assert_eq!(phdr.id(), ChunkId::shdr);

        let size = phdr.len();
        if size % 46 != 0 || size == 0 {
            Err(Error::InvalidSampleChunkSize(size))
        } else {
            let amount = size / 46;

            let data = phdr.read_contents(file)?;
            let mut reader = Reader::new(data);

            (0..amount).map(|_| Self::read(&mut reader)).collect()
        }
    }
}

#[repr(u16)]
#[derive(Debug, Clone, Copy)]
pub enum SampleLink {
    None = 0,

    /// Value used for mono samples
    MonoSample = 0x1,
    /// Value used for right samples of a stereo pair    
    RightSample = 0x2,
    /// Value used for left samples of a stereo pair
    LeftSample = 0x4,
    /// Value used for linked sample
    LinkedSample = 0x8,

    RomMonoSample = 0x8001,
    RomRightSample = 0x8002,
    RomLeftSample = 0x8004,
    RomLinkedSample = 0x8008,

    VorbisMonoSample = 0x11,
    VorbisRightSample = 0x12,
    VorbisLeftSample = 0x14,
    VorbisLinkedSample = 0x18,
}

impl SampleLink {
    pub fn is_mono(&self) -> bool {
        matches!(
            self,
            Self::MonoSample | Self::RomMonoSample | Self::VorbisMonoSample
        )
    }

    pub fn is_right(&self) -> bool {
        matches!(
            self,
            Self::RightSample | Self::RomRightSample | Self::VorbisRightSample
        )
    }

    pub fn is_left(&self) -> bool {
        matches!(
            self,
            Self::LeftSample | Self::RomLeftSample | Self::VorbisLeftSample
        )
    }

    pub fn is_linked(&self) -> bool {
        matches!(
            self,
            Self::LinkedSample | Self::RomLinkedSample | Self::VorbisLinkedSample
        )
    }

    pub fn is_rom(&self) -> bool {
        matches!(
            self,
            Self::RomMonoSample
                | Self::RomRightSample
                | Self::RomLeftSample
                | Self::RomLinkedSample
        )
    }

    pub fn is_vorbis(&self) -> bool {
        matches!(
            self,
            Self::VorbisMonoSample
                | Self::VorbisRightSample
                | Self::VorbisLeftSample
                | Self::VorbisLinkedSample
        )
    }
}