m8-files 0.3.1

Parse the Dirtywave M8's file formats
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

//! This library lets you parse Dirtywave M8 data
//!
//! See, in particular, the `read` method available on:
//! - [`Song::read`]
//! - [`Instrument::read`]
//! - [`Scale::read`]
//! - [`Theme::read`]
//!
//! E.g.:
//! ```
//! use m8_files::*;
//!
//! let mut f = std::fs::File::open("./examples/songs/TEST-FILE.m8s").unwrap();
//! let song = Song::read(&mut f).unwrap();
//! dbg!(song);
//! ```
//!
//! For song writing and file manipulation, you will need to load
//! the whole file in memory, in order to be able to overwrite it
//!
//! ```
//! use m8_files::*;
//! use m8_files::remapper::Remapper;
//! let mut song_data = std::fs::read("./examples/songs/V4EMPTY.m8s").unwrap();
//! let mut song_reader = reader::Reader::new(song_data.clone());
//! let mut song = Song::read_from_reader(&mut song_reader).unwrap();
//!
//! // let's renumber an instrument
//! let mut remapper = Remapper::default_ver(song.version);
//! let instrument : usize = 4;
//! let to_instrument = 10;
//! remapper.instrument_mapping.mapping[instrument] = to_instrument;
//! remapper.instrument_mapping.to_move.push(instrument as u8);
//! remapper.renumber(&mut song);
//!
//! dbg!(&song);
//!
//! let mut output_writer = writer::Writer::new(song_data);
//!
//! song.write(&mut output_writer);
//! // ready to be written elsewhere
//! let output_song_data = output_writer.finish();
//! ```
//!
//! You also can perform more complex copies of chain, that
//! will copy intrument/eq/table definitions required to copy
//! a chain from a song to another
//!
//! ```
//! use m8_files::*;
//! use m8_files::remapper::Remapper;
//!
//! let mut from_file = std::fs::File::open("./examples/songs/TEST-FILE.m8s").unwrap();
//! let from_song = Song::read(&mut from_file).unwrap();
//! let mut empty_file = std::fs::File::open("./examples/songs/V4EMPTY.m8s").unwrap();
//! let mut to_song = Song::read(&mut empty_file).unwrap();
//! let chain : u8 = 12;
//! let mapping =
//!     Remapper::create(&from_song, &to_song, vec![chain].iter()).unwrap();
//! // you can inspec the mapping here if needed.
//! // and apply the remapping
//! mapping.apply(&from_song, &mut to_song);
//! // you now have the chain 12 in to_song, and you can edit a song
//! // cell to write it
//! let final_chain = mapping.out_chain(chain);
//! to_song.song.steps[2] = final_chain;
//! ```
mod eq;
mod fx;
mod instruments;
pub mod reader;
pub mod remapper;
mod scale;
mod settings;
mod songs;
mod theme;
mod version;
pub mod writer;

pub use eq::*;
pub use fx::*;
pub use instruments::*;
pub use scale::*;
pub use settings::*;
pub use songs::*;
pub use theme::*;
pub use version::*;