dsf-meta 0.2.7

DSF (DSD Stream File) support for Rust
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

<!-- markdownlint-disable MD033 -->
# <img src="doc/images/logo.png" width="100" alt="Logo"/> DSD Stream File #

DSF (DSD Stream File) support in Rust. DSF files are a high-resolution
audio format that contain lossless 1-bit audio stream in delta sigma
modulation aka Direct Stream Digital (DSD). The format is intended for
1-bit DSD DACs.

This package is a mostly compatible fork of the dsf crate by Daniel J. R. May, but it focuses on reading metadata and leaves it up to the implementor to iterate over the dsd samples using the info from that metadata, such as the audio offset and number of samples. It also allows for incomplete ID3 tag reads without causing a failure to instantiate the DsfFile object.

For a crate that makes use of this library and does provide access to the audio data, see [`dsd-reader`](https://crates.io/crates/dsd-reader).

## Examples
### Read file, print metadata, or catch any fatal errors
```rust
use dsf_meta::DsfFile;
use std::path::Path;

let path = Path::new("my/music.dsf");

match DsfFile::open(path) {
    Ok(dsf_file) => {
        eprintln!("DSF file metadata:\n\n{}", dsf_file);
    }
    Err(error) => {
        eprintln!("Error: {}", error);
    }
}
```

### Checking for and reporting any ID3 tag errors
```rust
use dsf_meta::DsfFile;
use std::path::Path;

let path = Path::new("my/music.dsf");

let dsf_file = DsfFile::open(path).unwrap();
if let Some(e) = dsf_file.tag_read_err() {
    eprintln!("[Warning] Full read of ID3 tag failed. Partial read attempted: {}", e);
}
```

## References ##

* [DSF file format
specification](https://dsd-guide.com/sites/default/files/white-papers/DSFFileFormatSpec_E.pdf)