ptcow 0.2.1

Library for editing and playback of PxTone (.ptcop) music
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

#![doc = include_str!("../README.md")]
// When we return an error type, the possible errors are encoded within it.
#![allow(clippy::missing_errors_doc)]

mod delay;
mod event;
mod herd;
mod io;
mod master;
mod noise_builder;
mod overdrive;
mod point;
mod pulse_frequency;
mod pulse_oscillator;
mod result;
pub mod timing;
mod unit;
mod voice;

mod voice_data {
    pub mod noise;
    pub mod oggv;
    pub mod pcm;
    pub mod wave;
}

mod util {
    mod array_len_ext;
    pub use array_len_ext::ArrayLenExt;
}

pub use {
    delay::{Delay, DelayUnit},
    event::{EveList, Event, EventPayload, Key},
    herd::{
        FmtInfo, FmtKind, FmtVer, Herd, MooInstructions, Song, Text,
        moo::{MooPlan, StartPosPlan, current_tick, do_event, moo_prepare},
        read_song, rebuild_tones, serialize_project,
    },
    master::Master,
    noise_builder::{NoiseDesignOscillator, NoiseTable, NoiseType, noise_to_pcm},
    overdrive::Overdrive,
    point::EnvPt,
    pulse_oscillator::{OsciArgs, OsciPt},
    pulse_oscillator::{coord, overtone},
    result::{ProjectReadError, ReadResult},
    timing::{Meas, SampleT, SamplesPerTick, Tick, Tick16, Timing},
    unit::{GroupIdx, PanTimeBuf, PanTimeOff, Unit, UnitIdx},
    voice::{EnvelopeSrc, Voice, VoiceData, VoiceFlags, VoiceInstance, VoiceTone, VoiceUnit},
    voice_data::{
        noise::{NoiseData, NoiseDesignUnit},
        oggv::OggVData,
        pcm::PcmData,
        wave::WaveData,
    },
};

/// Channel number (mono or stereo)
#[derive(Default, Clone, Copy, PartialEq, Eq, Debug)]
pub enum ChNum {
    /// Monaural, one channel
    #[default]
    Mono = 1,
    /// Stereo, two channels
    Stereo = 2,
}

/// Bits per sample
#[derive(Clone, Copy, Default, PartialEq, Eq, Debug)]
#[repr(u8)]
pub enum Bps {
    /// 8 bits per sample
    #[default]
    B8 = 8,
    /// 16 bits per sample (little endian)
    B16 = 16,
}

/// Wide enough to represent 48 Khz
pub type SampleRate = u16;
/// Some sources (Ogg/Vorbis) can have high sample rates (96 khz for example)
pub type SourceSampleRate = u32;
/// The sample rate `PxTone` internally works with
pub const NATIVE_SAMPLE_RATE: SampleRate = 44_100;

#[cfg(target_endian = "big")]
const _: () = panic!("Only little endian architectures are supported currently.");