xmrs 0.3.5

A library to edit SoundTracker data with pleasure
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

use num_enum::{IntoPrimitive, TryFromPrimitive};
use serde::{Deserialize, Serialize};

/// How to play sample
#[derive(Default, Serialize, Deserialize, Copy, Clone, IntoPrimitive, TryFromPrimitive, Debug)]
#[repr(u8)]
pub enum LoopType {
    #[default]
    No = 0,
    Forward = 1,
    PingPong = 2,
}

/// is sample recorded with 8 or 16 bits depth
#[derive(Serialize, Deserialize, Clone, Debug)]
pub enum SampleDataType {
    Depth8(Vec<i8>),
    Depth16(Vec<i16>),
}

/// A Real Data sample
#[derive(Serialize, Deserialize, Debug)]
pub struct Sample {
    pub name: String,
    pub loop_start: u32,    // 0 <= loop_start < len()
    pub loop_length: u32,   // 1 <= loop_length <= len() - loop_start
    pub volume: f32,
    pub finetune: f32, // see relative_note
    pub flags: LoopType,
    pub panning: f32,
    pub relative_note: i8,
    pub data: SampleDataType,
}

impl Sample {
    /// return sample length
    pub fn len(&self) -> usize {
        match &self.data {
            SampleDataType::Depth8(v) => v.len(),
            SampleDataType::Depth16(v) => v.len(),
        }
    }

    /// return sample at seek
    pub fn at(&self, seek: usize) -> f32 {
        match &self.data {
            SampleDataType::Depth8(v) => v[seek] as f32 / 128.0,
            SampleDataType::Depth16(v) => v[seek] as f32 / 32768.0,
        }
    }

    /// return sample size (8 or 16 bits)
    pub fn bits(&self) -> u8 {
        match &self.data {
            SampleDataType::Depth8(_) => 8,
            SampleDataType::Depth16(_) => 16,
        }
    }
}