riff 2.0.0

This crate provides utilities for reading and writing RIFF formatted files
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

extern crate riff;

use riff::Chunk;
use riff::ChunkContents;
use riff::ChunkId;

use std::fs::File;

static SMPL_ID: ChunkId = ChunkId {
    value: [0x73, 0x6D, 0x70, 0x6C],
};
static TEST_ID: ChunkId = ChunkId {
    value: [0x74, 0x65, 0x73, 0x74],
};
static TST1_ID: ChunkId = ChunkId {
    value: [0x74, 0x73, 0x74, 0x31],
};
static TST2_ID: ChunkId = ChunkId {
    value: [0x74, 0x73, 0x74, 0x32],
};

fn read_items<T>(iter: &mut riff::Iter<T>) -> Vec<Chunk>
where
    T: std::io::Read + std::io::Seek,
{
    let mut vec: Vec<Chunk> = Vec::new();
    for item in iter {
        match item {
            Ok(chunk) => vec.push(chunk),
            _ => (),
        }
    }
    vec
}

#[test]
fn read_minimal() {
    let mut file = File::open("test_assets/minimal.riff").unwrap();
    let chunk = riff::Chunk::read(&mut file, 0).unwrap();

    assert_eq!(chunk.id(), riff::RIFF_ID);
    assert_eq!(chunk.read_type(&mut file).unwrap(), SMPL_ID);

    let items = read_items(&mut chunk.iter(&mut file));

    assert_eq!(items.len(), 1);

    let item = &items[0];

    assert_eq!(item.id(), TEST_ID);
    assert_eq!(item.read_contents(&mut file).unwrap(), vec![0xFF]);
}

#[test]
fn read_minimal2() {
    let mut file = File::open("test_assets/minimal_2.riff").unwrap();
    let chunk = riff::Chunk::read(&mut file, 0).unwrap();

    assert_eq!(chunk.id(), riff::RIFF_ID);
    assert_eq!(chunk.read_type(&mut file).unwrap(), SMPL_ID);

    let items = read_items(&mut chunk.iter(&mut file));

    assert_eq!(items.len(), 2);

    let item1 = &items[0];
    let item2 = &items[1];

    assert_eq!(item1.id(), TST1_ID);
    assert_eq!(item1.read_contents(&mut file).unwrap(), vec![0xFF]);

    assert_eq!(item2.id(), TST2_ID);
    assert_eq!(item2.read_contents(&mut file).unwrap(), vec![0xEE]);
}

#[test]
fn read_test_1() {
    let mut file = File::open("test_assets/test.riff").unwrap();
    let str1 = "hey this is a test".as_bytes().to_vec();
    let str2 = "hey this is another test".as_bytes().to_vec();
    let str3 = "final test".as_bytes().to_vec();

    let smpl = Chunk::read(&mut file, 0).unwrap();
    assert_eq!(smpl.id(), riff::RIFF_ID);
    assert_eq!(smpl.read_type(&mut file).unwrap(), SMPL_ID);

    let smpl_items = read_items(&mut smpl.iter(&mut file));
    assert_eq!(smpl_items.len(), 2);

    let tst1 = &smpl_items[0];
    assert_eq!(tst1.id(), riff::LIST_ID);
    assert_eq!(tst1.read_type(&mut file).unwrap(), TST1_ID);
    let tst1_items = read_items(&mut tst1.iter(&mut file));
    assert_eq!(tst1_items.len(), 2);

    let test_1 = &tst1_items[0];
    let test_2 = &tst1_items[1];

    assert_eq!(test_1.id(), TEST_ID);
    assert_eq!(test_1.read_contents(&mut file).unwrap(), str1);

    assert_eq!(test_2.id(), TEST_ID);
    assert_eq!(test_2.read_contents(&mut file).unwrap(), str2);

    let tst2 = &smpl_items[1];
    assert_eq!(tst2.id(), riff::SEQT_ID);

    let tst2_items = read_items(&mut tst2.iter_no_type(&mut file));
    assert_eq!(tst2_items.len(), 1);

    let test_3 = &tst2_items[0];
    assert_eq!(test_3.id(), TEST_ID);
    assert_eq!(test_3.read_contents(&mut file).unwrap(), str3);
}

#[test]
fn read_test_2() {
    let mut file = File::open("test_assets/test_2.riff").unwrap();
    let str1 = "hey this is a test".as_bytes().to_vec();
    let str2 = "hey this is another test!".as_bytes().to_vec();
    let str3 = "final test".as_bytes().to_vec();

    let smpl = Chunk::read(&mut file, 0).unwrap();
    assert_eq!(smpl.id(), riff::RIFF_ID);
    assert_eq!(smpl.read_type(&mut file).unwrap(), SMPL_ID);

    let smpl_items = read_items(&mut smpl.iter(&mut file));
    assert_eq!(smpl_items.len(), 2);

    let tst1 = &smpl_items[0];
    assert_eq!(tst1.id(), riff::LIST_ID);
    assert_eq!(tst1.read_type(&mut file).unwrap(), TST1_ID);
    let tst1_items = read_items(&mut tst1.iter(&mut file));
    assert_eq!(tst1_items.len(), 2);

    let test_1 = &tst1_items[0];
    let test_2 = &tst1_items[1];

    assert_eq!(test_1.id(), TEST_ID);
    assert_eq!(test_1.read_contents(&mut file).unwrap(), str1);

    assert_eq!(test_2.id(), TEST_ID);
    assert_eq!(test_2.read_contents(&mut file).unwrap(), str2);

    let tst2 = &smpl_items[1];
    assert_eq!(tst2.id(), riff::SEQT_ID);

    let tst2_items = read_items(&mut tst2.iter_no_type(&mut file));
    assert_eq!(tst2_items.len(), 1);

    let test_3 = &tst2_items[0];
    assert_eq!(test_3.id(), TEST_ID);
    assert_eq!(test_3.read_contents(&mut file).unwrap(), str3);
}

fn read_chunk<T>(chunk: &Chunk, file: &mut T) -> ChunkContents
where
    T: std::io::Seek + std::io::Read,
{
    let id = chunk.id();
    if id == riff::RIFF_ID || id == riff::LIST_ID {
        let chunk_type = chunk.read_type(file).unwrap();
        let children = read_items(&mut chunk.iter(file));
        let mut children_contents: Vec<ChunkContents> = Vec::new();

        for child in children {
            children_contents.push(read_chunk(&child, file));
        }

        ChunkContents::Children(id, chunk_type, children_contents)
    } else if id == riff::SEQT_ID {
        let children = read_items(&mut chunk.iter_no_type(file));
        let mut children_contents: Vec<ChunkContents> = Vec::new();

        for child in children {
            children_contents.push(read_chunk(&child, file));
        }

        ChunkContents::ChildrenNoType(id, children_contents)
    } else {
        let contents = chunk.read_contents(file).unwrap();
        ChunkContents::Data(id, contents)
    }
}

#[test]
fn write_test_1() {
    let buf: Vec<u8> = vec![0; 1024];
    let chunk = {
        let mut file_read = File::open("test_assets/test.riff").unwrap();
        let chunk = Chunk::read(&mut file_read, 0).unwrap();
        read_chunk(&chunk, &mut file_read)
    };
    let mut cursor = std::io::Cursor::new(buf);
    chunk.write(&mut cursor).unwrap();

    let reread_chunk = {
        let chunk = Chunk::read(&mut cursor, 0).unwrap();
        read_chunk(&chunk, &mut cursor)
    };

    assert_eq!(chunk, reread_chunk);
}

#[test]
fn write_test_2() {
    let buf: Vec<u8> = vec![0; 1024];
    let chunk = {
        let mut file_read = File::open("test_assets/test_2.riff").unwrap();
        let chunk = Chunk::read(&mut file_read, 0).unwrap();
        read_chunk(&chunk, &mut file_read)
    };
    let mut cursor = std::io::Cursor::new(buf);
    chunk.write(&mut cursor).unwrap();

    let reread_chunk = {
        let chunk = Chunk::read(&mut cursor, 0).unwrap();
        read_chunk(&chunk, &mut cursor)
    };

    assert_eq!(chunk, reread_chunk);
}