2023-07-13 00:38:09 +10:00
|
|
|
use std::{collections::HashMap, error::Error, fs, path::Path};
|
|
|
|
|
2023-07-17 08:57:11 +10:00
|
|
|
use agb_tracker_interop::PatternEffect;
|
2023-07-12 21:33:15 +10:00
|
|
|
use proc_macro2::TokenStream;
|
|
|
|
use proc_macro_error::abort;
|
|
|
|
|
|
|
|
use quote::quote;
|
2023-07-13 00:38:09 +10:00
|
|
|
use syn::LitStr;
|
|
|
|
|
|
|
|
use agb_fixnum::Num;
|
|
|
|
|
|
|
|
use xmrs::{prelude::*, xm::xmmodule::XmModule};
|
2023-07-12 21:33:15 +10:00
|
|
|
|
|
|
|
pub fn agb_xm_core(args: TokenStream) -> TokenStream {
|
2023-07-13 00:38:09 +10:00
|
|
|
let input = match syn::parse::<LitStr>(args.into()) {
|
|
|
|
Ok(input) => input,
|
2023-07-24 04:08:51 +10:00
|
|
|
Err(err) => return err.to_compile_error(),
|
2023-07-13 00:38:09 +10:00
|
|
|
};
|
|
|
|
|
|
|
|
let filename = input.value();
|
|
|
|
|
|
|
|
let root = std::env::var("CARGO_MANIFEST_DIR").expect("Failed to get cargo manifest dir");
|
|
|
|
let path = Path::new(&root).join(&*filename);
|
|
|
|
|
|
|
|
let include_path = path.to_string_lossy();
|
|
|
|
|
|
|
|
let module = match load_module_from_file(&path) {
|
|
|
|
Ok(track) => track,
|
|
|
|
Err(e) => abort!(input, e),
|
|
|
|
};
|
|
|
|
|
|
|
|
let parsed = parse_module(&module);
|
2023-07-12 21:33:15 +10:00
|
|
|
|
|
|
|
quote! {
|
2023-07-13 00:38:09 +10:00
|
|
|
{
|
|
|
|
const _: &[u8] = include_bytes!(#include_path);
|
|
|
|
|
|
|
|
#parsed
|
|
|
|
}
|
2023-07-12 21:33:15 +10:00
|
|
|
}
|
|
|
|
}
|
2023-07-13 00:38:09 +10:00
|
|
|
|
|
|
|
pub fn load_module_from_file(xm_path: &Path) -> Result<Module, Box<dyn Error>> {
|
|
|
|
let file_content = fs::read(xm_path)?;
|
|
|
|
Ok(XmModule::load(&file_content)?.to_module())
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn parse_module(module: &Module) -> TokenStream {
|
|
|
|
let instruments = &module.instrument;
|
|
|
|
let mut instruments_map = HashMap::new();
|
|
|
|
|
2023-07-13 02:36:41 +10:00
|
|
|
struct SampleData {
|
|
|
|
data: Vec<u8>,
|
|
|
|
should_loop: bool,
|
|
|
|
fine_tune: f64,
|
|
|
|
relative_note: i8,
|
2023-07-17 08:12:42 +10:00
|
|
|
restart_point: u32,
|
2023-07-19 06:36:37 +10:00
|
|
|
volume: Num<i16, 4>,
|
2023-07-13 02:36:41 +10:00
|
|
|
}
|
|
|
|
|
2023-07-13 00:38:09 +10:00
|
|
|
let mut samples = vec![];
|
|
|
|
|
|
|
|
for (instrument_index, instrument) in instruments.iter().enumerate() {
|
2023-07-24 04:08:51 +10:00
|
|
|
let InstrumentType::Default(ref instrument) = instrument.instr_type else {
|
|
|
|
continue;
|
|
|
|
};
|
2023-07-13 00:38:09 +10:00
|
|
|
|
|
|
|
for (sample_index, sample) in instrument.sample.iter().enumerate() {
|
2023-07-13 02:36:41 +10:00
|
|
|
let should_loop = !matches!(sample.flags, LoopType::No);
|
|
|
|
let fine_tune = sample.finetune as f64;
|
|
|
|
let relative_note = sample.relative_note;
|
2023-07-17 08:12:42 +10:00
|
|
|
let restart_point = sample.loop_start;
|
|
|
|
let sample_len = if sample.loop_length > 0 {
|
|
|
|
(sample.loop_length + sample.loop_start) as usize
|
|
|
|
} else {
|
|
|
|
usize::MAX
|
|
|
|
};
|
2023-07-13 02:36:41 +10:00
|
|
|
|
2023-07-19 06:36:37 +10:00
|
|
|
let volume = Num::from_raw((sample.volume * (1 << 4) as f32) as i16);
|
|
|
|
|
2023-07-16 06:07:55 +10:00
|
|
|
let sample = match &sample.data {
|
2023-07-17 08:12:42 +10:00
|
|
|
SampleDataType::Depth8(depth8) => depth8
|
|
|
|
.iter()
|
|
|
|
.map(|value| *value as u8)
|
|
|
|
.take(sample_len)
|
|
|
|
.collect::<Vec<_>>(),
|
2023-07-13 00:38:09 +10:00
|
|
|
SampleDataType::Depth16(depth16) => depth16
|
|
|
|
.iter()
|
|
|
|
.map(|sample| (sample >> 8) as i8 as u8)
|
2023-07-17 08:12:42 +10:00
|
|
|
.take(sample_len)
|
2023-07-13 00:38:09 +10:00
|
|
|
.collect::<Vec<_>>(),
|
|
|
|
};
|
|
|
|
|
|
|
|
instruments_map.insert((instrument_index, sample_index), samples.len());
|
2023-07-13 02:36:41 +10:00
|
|
|
samples.push(SampleData {
|
|
|
|
data: sample,
|
|
|
|
should_loop,
|
|
|
|
fine_tune,
|
|
|
|
relative_note,
|
2023-07-17 08:12:42 +10:00
|
|
|
restart_point,
|
2023-07-19 06:36:37 +10:00
|
|
|
volume,
|
2023-07-13 02:36:41 +10:00
|
|
|
});
|
2023-07-13 00:38:09 +10:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
let mut patterns = vec![];
|
|
|
|
let mut pattern_data = vec![];
|
|
|
|
|
|
|
|
for pattern in &module.pattern {
|
2023-07-13 02:36:41 +10:00
|
|
|
let start_pos = pattern_data.len();
|
2023-07-13 00:38:09 +10:00
|
|
|
|
|
|
|
for row in pattern.iter() {
|
2023-07-17 10:19:02 +10:00
|
|
|
let mut note_and_sample = vec![None; module.get_num_channels()];
|
2023-07-17 09:27:20 +10:00
|
|
|
|
|
|
|
for (i, slot) in row.iter().enumerate() {
|
|
|
|
let channel_number = i % module.get_num_channels();
|
|
|
|
|
2023-07-13 00:38:09 +10:00
|
|
|
let sample = if slot.instrument == 0 {
|
|
|
|
0
|
|
|
|
} else {
|
|
|
|
let instrument_index = (slot.instrument - 1) as usize;
|
|
|
|
|
|
|
|
if let InstrumentType::Default(ref instrument) =
|
|
|
|
module.instrument[instrument_index].instr_type
|
|
|
|
{
|
|
|
|
let sample_slot = instrument.sample_for_note[slot.note as usize] as usize;
|
|
|
|
instruments_map
|
|
|
|
.get(&(instrument_index, sample_slot))
|
2023-07-13 02:36:41 +10:00
|
|
|
.map(|sample_idx| sample_idx + 1)
|
2023-07-13 00:38:09 +10:00
|
|
|
.unwrap_or(0)
|
|
|
|
} else {
|
|
|
|
0
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2023-07-19 06:36:37 +10:00
|
|
|
let mut effect1 = PatternEffect::None;
|
2023-07-13 08:41:30 +10:00
|
|
|
|
2023-07-19 06:36:37 +10:00
|
|
|
let maybe_note_and_sample = if matches!(slot.note, Note::KeyOff) {
|
2023-07-17 09:27:20 +10:00
|
|
|
effect1 = PatternEffect::Stop;
|
2023-07-17 10:19:02 +10:00
|
|
|
note_and_sample[channel_number] = None;
|
2023-07-19 06:36:37 +10:00
|
|
|
&None
|
2023-07-17 10:19:02 +10:00
|
|
|
} else if !matches!(slot.note, Note::None) {
|
|
|
|
if sample != 0 {
|
|
|
|
note_and_sample[channel_number] = Some((slot.note, &samples[sample - 1]));
|
|
|
|
} else if let Some((note, _)) = &mut note_and_sample[channel_number] {
|
|
|
|
*note = slot.note;
|
|
|
|
}
|
2023-07-19 06:36:37 +10:00
|
|
|
|
|
|
|
¬e_and_sample[channel_number]
|
|
|
|
} else {
|
|
|
|
¬e_and_sample[channel_number]
|
|
|
|
};
|
|
|
|
|
|
|
|
if matches!(effect1, PatternEffect::None) {
|
|
|
|
effect1 = match slot.volume {
|
|
|
|
0x10..=0x50 => PatternEffect::Volume(
|
|
|
|
(Num::new((slot.volume - 0x10) as i16) / 64)
|
|
|
|
* maybe_note_and_sample
|
|
|
|
.map(|note_and_sample| note_and_sample.1.volume)
|
|
|
|
.unwrap_or(1.into()),
|
|
|
|
),
|
|
|
|
0xC0..=0xCF => PatternEffect::Panning(
|
|
|
|
Num::new(slot.volume as i16 - (0xC0 + (0xCF - 0xC0) / 2)) / 64,
|
|
|
|
),
|
|
|
|
_ => PatternEffect::None,
|
|
|
|
};
|
2023-07-17 09:27:20 +10:00
|
|
|
}
|
|
|
|
|
2023-07-17 08:57:11 +10:00
|
|
|
let effect2 = match slot.effect_type {
|
2023-07-17 09:27:20 +10:00
|
|
|
0x0 => {
|
|
|
|
if slot.effect_parameter == 0 {
|
|
|
|
PatternEffect::None
|
2023-07-19 06:36:37 +10:00
|
|
|
} else if let Some((note, sample)) = maybe_note_and_sample {
|
2023-07-17 09:27:20 +10:00
|
|
|
let first_arpeggio = slot.effect_parameter >> 4;
|
|
|
|
let second_arpeggio = slot.effect_parameter & 0xF;
|
|
|
|
|
2023-07-17 10:19:02 +10:00
|
|
|
let first_arpeggio_speed = note_to_speed(
|
2023-07-19 06:36:37 +10:00
|
|
|
*note,
|
2023-07-17 10:19:02 +10:00
|
|
|
sample.fine_tune,
|
|
|
|
sample.relative_note + first_arpeggio as i8,
|
|
|
|
module.frequency_type,
|
|
|
|
);
|
|
|
|
let second_arpeggio_speed = note_to_speed(
|
2023-07-19 06:36:37 +10:00
|
|
|
*note,
|
2023-07-17 10:19:02 +10:00
|
|
|
sample.fine_tune,
|
|
|
|
sample.relative_note + second_arpeggio as i8,
|
|
|
|
module.frequency_type,
|
|
|
|
);
|
2023-07-17 09:27:20 +10:00
|
|
|
|
|
|
|
PatternEffect::Arpeggio(
|
2023-07-19 07:17:17 +10:00
|
|
|
first_arpeggio_speed
|
|
|
|
.try_change_base()
|
|
|
|
.expect("Arpeggio size too large"),
|
|
|
|
second_arpeggio_speed
|
|
|
|
.try_change_base()
|
|
|
|
.expect("Arpeggio size too large"),
|
2023-07-17 09:27:20 +10:00
|
|
|
)
|
|
|
|
} else {
|
|
|
|
PatternEffect::None
|
|
|
|
}
|
|
|
|
}
|
2023-07-19 22:38:32 +10:00
|
|
|
0x1 => {
|
|
|
|
let c4_speed = note_to_speed(Note::C4, 0.0, 0, module.frequency_type);
|
|
|
|
let speed = note_to_speed(
|
|
|
|
Note::C4,
|
|
|
|
slot.effect_parameter as f64,
|
|
|
|
0,
|
|
|
|
module.frequency_type,
|
|
|
|
);
|
|
|
|
|
|
|
|
let portamento_amount = speed / c4_speed;
|
|
|
|
|
|
|
|
PatternEffect::Portamento(portamento_amount.try_change_base().unwrap())
|
|
|
|
}
|
|
|
|
0x2 => {
|
|
|
|
let c4_speed = note_to_speed(Note::C4, 0.0, 0, module.frequency_type);
|
|
|
|
let speed = note_to_speed(
|
|
|
|
Note::C4,
|
|
|
|
-(slot.effect_parameter as f64),
|
|
|
|
0,
|
|
|
|
module.frequency_type,
|
|
|
|
);
|
|
|
|
|
|
|
|
let portamento_amount = speed / c4_speed;
|
|
|
|
|
|
|
|
PatternEffect::Portamento(portamento_amount.try_change_base().unwrap())
|
|
|
|
}
|
2023-07-17 08:57:11 +10:00
|
|
|
0x8 => {
|
|
|
|
PatternEffect::Panning(Num::new(slot.effect_parameter as i16 - 128) / 128)
|
|
|
|
}
|
2023-07-17 09:45:58 +10:00
|
|
|
0xA => {
|
|
|
|
let first = slot.effect_parameter >> 4;
|
|
|
|
let second = slot.effect_parameter & 0xF;
|
|
|
|
|
|
|
|
if first == 0 {
|
|
|
|
PatternEffect::VolumeSlide(-Num::new(second as i16) / 16)
|
|
|
|
} else {
|
|
|
|
PatternEffect::VolumeSlide(Num::new(first as i16) / 16)
|
|
|
|
}
|
|
|
|
}
|
2023-07-19 06:36:37 +10:00
|
|
|
0xC => {
|
|
|
|
if let Some((_, sample)) = maybe_note_and_sample {
|
|
|
|
PatternEffect::Volume(
|
|
|
|
(Num::new(slot.effect_parameter as i16) / 255) * sample.volume,
|
|
|
|
)
|
|
|
|
} else {
|
|
|
|
PatternEffect::None
|
|
|
|
}
|
|
|
|
}
|
2023-07-19 22:22:26 +10:00
|
|
|
0xE => match slot.effect_parameter >> 4 {
|
|
|
|
0xC => PatternEffect::NoteCut((slot.effect_parameter & 0xf).into()),
|
|
|
|
_ => PatternEffect::None,
|
|
|
|
},
|
2023-07-17 08:57:11 +10:00
|
|
|
_ => PatternEffect::None,
|
|
|
|
};
|
2023-07-13 02:36:41 +10:00
|
|
|
|
|
|
|
if sample == 0 {
|
2023-07-17 08:57:11 +10:00
|
|
|
pattern_data.push(agb_tracker_interop::PatternSlot {
|
|
|
|
speed: 0.into(),
|
|
|
|
sample: 0,
|
|
|
|
effect1,
|
|
|
|
effect2,
|
|
|
|
});
|
2023-07-13 02:36:41 +10:00
|
|
|
} else {
|
|
|
|
let sample_played = &samples[sample - 1];
|
|
|
|
|
|
|
|
let speed = note_to_speed(
|
|
|
|
slot.note,
|
|
|
|
sample_played.fine_tune,
|
|
|
|
sample_played.relative_note,
|
2023-07-13 08:41:30 +10:00
|
|
|
module.frequency_type,
|
2023-07-13 02:36:41 +10:00
|
|
|
);
|
|
|
|
|
|
|
|
pattern_data.push(agb_tracker_interop::PatternSlot {
|
2023-07-17 10:27:22 +10:00
|
|
|
speed: speed.try_change_base().unwrap(),
|
|
|
|
sample: sample as u16,
|
2023-07-17 08:57:11 +10:00
|
|
|
effect1,
|
|
|
|
effect2,
|
2023-07-13 02:36:41 +10:00
|
|
|
});
|
|
|
|
}
|
2023-07-13 00:38:09 +10:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-07-13 02:36:41 +10:00
|
|
|
patterns.push(agb_tracker_interop::Pattern {
|
|
|
|
length: pattern.len(),
|
|
|
|
start_position: start_pos,
|
|
|
|
});
|
2023-07-13 00:38:09 +10:00
|
|
|
}
|
|
|
|
|
|
|
|
let samples: Vec<_> = samples
|
|
|
|
.iter()
|
2023-07-13 02:36:41 +10:00
|
|
|
.map(|sample| agb_tracker_interop::Sample {
|
|
|
|
data: &sample.data,
|
|
|
|
should_loop: sample.should_loop,
|
2023-07-17 08:12:42 +10:00
|
|
|
restart_point: sample.restart_point,
|
2023-07-19 06:36:37 +10:00
|
|
|
volume: sample.volume,
|
2023-07-13 02:36:41 +10:00
|
|
|
})
|
2023-07-13 00:38:09 +10:00
|
|
|
.collect();
|
|
|
|
|
2023-07-13 04:06:55 +10:00
|
|
|
let patterns_to_play = module
|
|
|
|
.pattern_order
|
|
|
|
.iter()
|
|
|
|
.map(|order| *order as usize)
|
|
|
|
.collect::<Vec<_>>();
|
|
|
|
|
2023-07-17 06:12:12 +10:00
|
|
|
// Number 150 here deduced experimentally
|
2023-07-19 07:49:56 +10:00
|
|
|
let frames_per_tick = Num::<u32, 8>::new(150) / module.default_bpm as u32;
|
2023-07-17 06:12:12 +10:00
|
|
|
let ticks_per_step = module.default_tempo;
|
|
|
|
|
2023-07-13 00:38:09 +10:00
|
|
|
let interop = agb_tracker_interop::Track {
|
|
|
|
samples: &samples,
|
|
|
|
pattern_data: &pattern_data,
|
|
|
|
patterns: &patterns,
|
2023-07-13 03:52:29 +10:00
|
|
|
num_channels: module.get_num_channels(),
|
2023-07-13 04:06:55 +10:00
|
|
|
patterns_to_play: &patterns_to_play,
|
2023-07-13 02:36:41 +10:00
|
|
|
|
2023-07-17 06:12:12 +10:00
|
|
|
frames_per_tick,
|
2023-07-19 07:49:56 +10:00
|
|
|
ticks_per_step: ticks_per_step.into(),
|
2023-07-13 00:38:09 +10:00
|
|
|
};
|
|
|
|
|
|
|
|
quote!(#interop)
|
|
|
|
}
|
2023-07-13 02:36:41 +10:00
|
|
|
|
2023-07-13 08:41:30 +10:00
|
|
|
fn note_to_speed(
|
|
|
|
note: Note,
|
|
|
|
fine_tune: f64,
|
|
|
|
relative_note: i8,
|
|
|
|
frequency_type: FrequencyType,
|
|
|
|
) -> Num<u32, 8> {
|
|
|
|
let frequency = match frequency_type {
|
|
|
|
FrequencyType::LinearFrequencies => {
|
|
|
|
note_to_frequency_linear(note, fine_tune, relative_note)
|
|
|
|
}
|
|
|
|
FrequencyType::AmigaFrequencies => note_to_frequency_amega(note, fine_tune, relative_note),
|
|
|
|
};
|
|
|
|
|
|
|
|
let gba_audio_frequency = 18157f64;
|
|
|
|
|
|
|
|
let speed: f64 = frequency / gba_audio_frequency;
|
|
|
|
Num::from_raw((speed * (1 << 8) as f64) as u32)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn note_to_frequency_linear(note: Note, fine_tune: f64, relative_note: i8) -> f64 {
|
2023-07-13 02:36:41 +10:00
|
|
|
let real_note = (note as usize as f64) + (relative_note as f64);
|
2023-07-24 04:08:51 +10:00
|
|
|
let period = 10.0 * 12.0 * 16.0 * 4.0 - real_note * 16.0 * 4.0 - fine_tune / 2.0;
|
2023-07-13 02:36:41 +10:00
|
|
|
8363.0 * 2.0f64.powf((6.0 * 12.0 * 16.0 * 4.0 - period) / (12.0 * 16.0 * 4.0))
|
|
|
|
}
|
|
|
|
|
2023-07-13 08:41:30 +10:00
|
|
|
fn note_to_frequency_amega(note: Note, fine_tune: f64, relative_note: i8) -> f64 {
|
|
|
|
let note = (note as usize) + relative_note as usize;
|
|
|
|
let pos = (note % 12) * 8 + (fine_tune / 16.0) as usize;
|
|
|
|
let frac = (fine_tune / 16.0) - (fine_tune / 16.0).floor();
|
2023-07-13 02:36:41 +10:00
|
|
|
|
2023-07-13 08:41:30 +10:00
|
|
|
let period = ((AMEGA_FREQUENCIES[pos] as f64 * (1.0 - frac))
|
|
|
|
+ AMEGA_FREQUENCIES[pos + 1] as f64 * frac)
|
|
|
|
* 32.0 // docs say 16 here, but for some reason I need 32 :/
|
|
|
|
/ (1 << ((note as i64) / 12)) as f64;
|
2023-07-13 02:36:41 +10:00
|
|
|
|
2023-07-13 08:41:30 +10:00
|
|
|
8363.0 * 1712.0 / period
|
2023-07-13 02:36:41 +10:00
|
|
|
}
|
2023-07-13 08:41:30 +10:00
|
|
|
|
|
|
|
const AMEGA_FREQUENCIES: &[u32] = &[
|
|
|
|
907, 900, 894, 887, 881, 875, 868, 862, 856, 850, 844, 838, 832, 826, 820, 814, 808, 802, 796,
|
|
|
|
791, 785, 779, 774, 768, 762, 757, 752, 746, 741, 736, 730, 725, 720, 715, 709, 704, 699, 694,
|
|
|
|
689, 684, 678, 675, 670, 665, 660, 655, 651, 646, 640, 636, 632, 628, 623, 619, 614, 610, 604,
|
|
|
|
601, 597, 592, 588, 584, 580, 575, 570, 567, 563, 559, 555, 551, 547, 543, 538, 535, 532, 528,
|
|
|
|
524, 520, 516, 513, 508, 505, 502, 498, 494, 491, 487, 484, 480, 477, 474, 470, 467, 463, 460,
|
|
|
|
457,
|
|
|
|
];
|