xmrs 0.14.2

Read, edit and serialize SoundTracker music with pleasure — MOD/XM/S3M/IT/DW import plus SID & OPL chip synthesis, no_std.
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

//! `ModuleFormat` — the tag identifying which tracker authored a
//! module. Metadata only: no runtime branching reads it. Playback
//! decisions go through [`crate::core::compatibility::PlaybackQuirks`].

use serde::{Deserialize, Serialize};

/// Which tracker convention this module was imported from.
///
/// **Metadata only**. Runtime playback decisions are driven entirely
/// by [`crate::core::compatibility::PlaybackQuirks`] on
/// [`crate::core::module::Module`], which an editor can set
/// independently of the format tag.
///
/// Modules constructed from scratch leave `Module::origin` at `None`.
/// Importers populate it with the matching variant after a successful
/// load.
#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ModuleFormat {
    /// Unknown / hand-constructed / non-tracker source.
    #[default]
    Unknown,
    /// ProTracker-style MOD (Amiga Soundtracker family).
    Mod,
    /// ScreamTracker III (S3M).
    S3m,
    /// Fasttracker II (XM).
    Xm,
    /// Impulse Tracker (IT), including OpenMPT's IT extensions.
    It,
    /// MOS6581 SID (Commodore 64).
    Sid,
    /// David Whittaker custom Amiga format (`.dw`).
    Dw,
}

impl ModuleFormat {
    /// `true` when this tag is `Xm`.
    #[inline]
    pub fn is_xm(&self) -> bool {
        matches!(self, ModuleFormat::Xm)
    }

    /// `true` when this tag is `S3m`.
    #[inline]
    pub fn is_s3m(&self) -> bool {
        matches!(self, ModuleFormat::S3m)
    }

    /// `true` when this tag is `It`.
    #[inline]
    pub fn is_it(&self) -> bool {
        matches!(self, ModuleFormat::It)
    }

    /// `true` when this tag is `Mod`.
    #[inline]
    pub fn is_mod(&self) -> bool {
        matches!(self, ModuleFormat::Mod)
    }

    /// `true` when this tag is `Dw`.
    #[inline]
    pub fn is_dw(&self) -> bool {
        matches!(self, ModuleFormat::Dw)
    }
}