8 Commits

Author SHA1 Message Date
6e59efdef5 wip: dynamic event size 2026-02-11 10:01:23 -08:00
8328b510c6 16x bigger blocks 2026-02-11 09:58:54 -08:00
e92d718c81 zero-indexed Ids 2026-02-11 09:58:46 -08:00
c1979c23e5 fixed block header and event order 2026-02-11 09:55:28 -08:00
17df73b640 style setting 2026-02-11 09:41:40 -08:00
a0e2aa0c55 u32 Time 2026-02-11 09:34:29 -08:00
c38f326483 remove trey float 2026-02-11 09:34:29 -08:00
34b9eb7f33 copy v0 2026-02-11 09:32:47 -08:00
5 changed files with 1026 additions and 204 deletions

2
Cargo.lock generated
View File

@@ -85,7 +85,7 @@ dependencies = [
[[package]]
name = "strafesnet_roblox_bot_file"
version = "0.9.4"
version = "0.8.1"
dependencies = [
"binrw",
"bitflags",

View File

@@ -1,6 +1,6 @@
[package]
name = "strafesnet_roblox_bot_file"
version = "0.9.4"
version = "0.8.1"
edition = "2024"
[dependencies]

View File

@@ -1,6 +1,7 @@
pub use binrw::Error as BinrwError;
pub mod v0;
pub mod v1;
#[cfg(test)]
mod tests;

296
src/v0.rs
View File

@@ -5,26 +5,26 @@ use binrw::BinReaderExt;
use crate::BinrwError;
// the bit chunks are deposited in reverse
const fn read_trey_float(bits:u32)->f32{
fn read_trey_float(bits:u32)->f32{
let s=bits&1;
let e=(bits>>1)&((1<<8)-1);
let m=(bits>>(1+8))&((1<<23)-1);
f32::from_bits(m|(e<<23)|(s<<31))
}
const fn write_trey_float(value:&f32)->u32{
fn write_trey_float(value:&f32)->u32{
let bits=value.to_bits();
let s=(bits>>31)&1;
let e=(bits>>23)&((1<<8)-1);
let m=bits&((1<<23)-1);
m<<(1+8)|(e<<1)|s
}
const fn read_trey_double(bits:u64)->f64{
fn read_trey_double(bits:u64)->f64{
let s=bits&1;
let e=(bits>>1)&((1<<11)-1);
let m=(bits>>(1+11))&((1<<52)-1);
f64::from_bits(m|(e<<52)|(s<<63))
}
const fn write_trey_double(value:&f64)->u64{
fn write_trey_double(value:&f64)->u64{
let bits=value.to_bits();
let s=(bits>>63)&1;
let e=(bits>>52)&((1<<11)-1);
@@ -34,7 +34,7 @@ const fn write_trey_double(value:&f64)->u64{
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy)]
#[derive(Debug,Clone)]
pub struct Vector2{
#[br(map=read_trey_float)]
#[bw(map=write_trey_float)]
@@ -45,7 +45,7 @@ pub struct Vector2{
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy)]
#[derive(Debug,Clone)]
pub struct Vector3{
#[br(map=read_trey_float)]
#[bw(map=write_trey_float)]
@@ -350,7 +350,6 @@ pub enum FlagReason{
#[brw(magic=9u32)]
Practice,
}
/// Creates a new run when the player enters a start zone.
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
@@ -413,91 +412,47 @@ pub enum RunEvent{
}
// camera
/// Punches the camera when the player has an intense collision.
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct CameraEventCameraPunch{
pub rot_velocity:Vector3,
}
/// Rotates the camera when the player goes through a wormhole.
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct CameraEventTransform{
pub axis_angle:Vector3,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub enum CameraEvent{
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum CameraEventType{
#[brw(magic=0u32)]
CameraPunch(CameraEventCameraPunch),
CameraPunch,
#[brw(magic=1u32)]
Transform(CameraEventTransform),
Transform,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct CameraEvent{
pub camera_event_type:CameraEventType,
pub value:Vector3,
}
// setting
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventFieldOfView{
#[br(map=read_trey_double)]
#[bw(map=write_trey_double)]
pub fov:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventSensitivity{
#[br(map=read_trey_double)]
#[bw(map=write_trey_double)]
pub sensitivity:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventVerticalSensitivityMultiplier{
#[br(map=read_trey_double)]
#[bw(map=write_trey_double)]
pub multiplier:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventAbsoluteSensitivity{
#[br(map=|v:u64|read_trey_double(v)==1.0)]
#[bw(map=|&enabled:&bool|
if enabled{
write_trey_double(&1.0)
}else{
write_trey_double(&0.0)
}
)]
pub enabled:bool,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventTurnSpeed{
#[br(map=read_trey_double)]
#[bw(map=write_trey_double)]
pub turn_speed:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub enum SettingEvent{
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum SettingType{
#[brw(magic=0u32)]
FieldOfView(SettingEventFieldOfView),
FieldOfView,
#[brw(magic=1u32)]
Sensitivity(SettingEventSensitivity),
Sensitivity,
#[brw(magic=2u32)]
VerticalSensitivityMultiplier(SettingEventVerticalSensitivityMultiplier),
VerticalSensitivityMultiplier,
#[brw(magic=3u32)]
AbsoluteSensitivity(SettingEventAbsoluteSensitivity),
AbsoluteSensitivity,
#[brw(magic=4u32)]
TurnSpeed(SettingEventTurnSpeed),
TurnSpeed,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEvent{
pub setting_type:SettingType,
#[br(map=read_trey_double)]
#[bw(map=write_trey_double)]
pub value:f64,
}
/// A segment of event timelines.
@@ -517,7 +472,7 @@ pub struct Block{
#[binrw]
#[brw(little)]
#[derive(Clone,Copy)]
pub enum EventType{
enum EventType{
#[brw(magic=1u32)]
Input,
#[brw(magic=2u32)]
@@ -775,96 +730,12 @@ pub fn read_all_to_block<R:BinReaderExt>(mut data:R)->Result<Block,Error>{
Ok(block)
}
const NUM_EVENT_TYPES:usize=8;
#[derive(Clone,Copy)]
pub struct Head([usize;NUM_EVENT_TYPES]);
impl Head{
pub const fn new()->Self{
Self([0;NUM_EVENT_TYPES])
}
/// Use `Head::partition_point` instead.
#[deprecated]
pub fn after_time(block:&Block,time:f64)->Self{
Self([
block.input_events.partition_point(|event|event.time<=time),
block.output_events.partition_point(|event|event.time<=time),
block.sound_events.partition_point(|event|event.time<=time),
block.world_events.partition_point(|event|event.time<=time),
block.gravity_events.partition_point(|event|event.time<=time),
block.run_events.partition_point(|event|event.time<=time),
block.camera_events.partition_point(|event|event.time<=time),
block.setting_events.partition_point(|event|event.time<=time),
])
}
/// Uses a binary search to initialize the head positions according to a predicate.
/// You probably want `|event_time|event_time<=time`
pub fn partition_point(block:&Block,pred:impl Fn(f64)->bool)->Self{
Self([
block.input_events.partition_point(|event|pred(event.time)),
block.output_events.partition_point(|event|pred(event.time)),
block.sound_events.partition_point(|event|pred(event.time)),
block.world_events.partition_point(|event|pred(event.time)),
block.gravity_events.partition_point(|event|pred(event.time)),
block.run_events.partition_point(|event|pred(event.time)),
block.camera_events.partition_point(|event|pred(event.time)),
block.setting_events.partition_point(|event|pred(event.time)),
])
}
// compare an event at the head of the plan to the best event collected so far.
fn collect_event<E>(
&self,
event_type:EventType,
list:&[Timed<E>],
best:&mut Option<Timed<EventType>>,
)
where
E:for<'a>binrw::BinRead<Args<'a>=()>,
E:for<'a>binrw::BinWrite<Args<'a>=()>,
{
if let Some(event)=list.get(self.get_event_index(event_type))
&&best.as_ref().is_none_or(|b|event.time<b.time)
{
*best=Some(Timed{time:event.time,event:event_type});
}
}
fn collect_offline(&self,block:&Block,next_event:&mut Option<Timed<EventType>>){
self.collect_event(EventType::World,&block.world_events,next_event);
self.collect_event(EventType::Gravity,&block.gravity_events,next_event);
self.collect_event(EventType::Run,&block.run_events,next_event);
self.collect_event(EventType::Camera,&block.camera_events,next_event);
self.collect_event(EventType::Setting,&block.setting_events,next_event);
}
fn collect_realtime(&self,block:&Block,next_event:&mut Option<Timed<EventType>>){
self.collect_event(EventType::Input,&block.input_events,next_event);
self.collect_event(EventType::Output,&block.output_events,next_event);
self.collect_event(EventType::Sound,&block.sound_events,next_event);
}
pub fn next_event(&self,block:&Block)->Option<Timed<EventType>>{
let mut next_event=None;
// This order is particular.
// Setting must appear before Input for strafe client resimulation to work.
self.collect_offline(block,&mut next_event);
self.collect_realtime(block,&mut next_event);
next_event
}
pub const fn get_event_index(&self,event_type:EventType)->usize{
self.0[event_type as usize]
}
pub const fn set_event_index(&mut self,event_type:EventType,index:usize){
self.0[event_type as usize]=index;
}
/// Add the new event.
pub const fn push(&mut self,event_type:EventType){
self.0[event_type as usize]+=1;
}
}
#[cfg(feature="itertools")]
pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),BinrwError>{
use std::ops::Range;
const MAX_BLOCK_SIZE:usize=1<<14;
const FILE_VERSION:u32=0;
const EVENT_TYPES:[EventType;NUM_EVENT_TYPES]=[
const EVENT_TYPES:[EventType;8]=[
EventType::Input,
EventType::Output,
EventType::Sound,
@@ -874,7 +745,7 @@ pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),B
EventType::Camera,
EventType::Setting,
];
const EVENT_SIZE:[usize;NUM_EVENT_TYPES]=[
const EVENT_SIZE:[usize;8]=[
8+4+2*4, // Input
8+4+4*3*4, // Output
8+4+4, // Sound
@@ -884,12 +755,26 @@ pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),B
8+4+3*4, // Camera
8+4+8, // Setting
];
// A plan of what range of events to include in a data block.
struct Plan([Range<usize>;NUM_EVENT_TYPES]);
impl Plan{
fn new(start:&Head,end:&Head)->Self{
Plan(core::array::from_fn(|i|start.0[i]..end.0[i]))
#[derive(Clone,Default)]
struct Plan<T>([T;8]);
// A plan of how many events of each type to include in a data block.
impl Plan<usize>{
/// Predict the size increment from adding a new event.
fn size_increase(&self,event_type:EventType)->usize{
let new_chunk_header=self.0[event_type as usize]==0;
let mask=(-(new_chunk_header as isize)) as usize;
EVENT_SIZE[event_type as usize]+(mask&size_of::<EventChunkHeader>())
}
/// Add the new event.
fn accumulate(&mut self,event_type:EventType){
self.0[event_type as usize]+=1;
}
fn range(&self,end:&Plan<usize>)->Plan<Range<usize>>{
Plan(core::array::from_fn(|i|self.0[i]..end.0[i]))
}
}
// A plan of what range of events to include in a data block.
impl Plan<Range<usize>>{
/// Calculate the predicted size of the planned block.
fn size(&self)->usize{
self.0.iter()
@@ -901,42 +786,43 @@ pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),B
.sum()
}
}
impl IntoIterator for Plan{
type IntoIter=core::iter::Zip<
core::array::IntoIter<EventType,NUM_EVENT_TYPES>,
core::array::IntoIter<Range<usize>,NUM_EVENT_TYPES>,
>;
type Item=(EventType,Range<usize>);
fn into_iter(self)->Self::IntoIter{
EVENT_TYPES.into_iter().zip(self.0)
// compare an event at the head of the plan to the best event collected so far.
fn collect_event<E>(
best:&mut Option<(f64,EventType)>,
list:&[Timed<E>],
plan:&Plan<usize>,
event_type:EventType,
)
where
E:for<'a>binrw::BinRead<Args<'a>=()>,
E:for<'a>binrw::BinWrite<Args<'a>=()>,
{
if let Some(event)=list.get(plan.0[event_type as usize])
&&best.is_none_or(|(time,_)|event.time<time)
{
*best=Some((event.time,event_type));
}
}
/// Predict the size increment from adding a new event.
fn predict_size_increment(head:&Head,event_type:EventType)->usize{
let new_chunk_header=head.get_event_index(event_type)==0;
let mask=(-(new_chunk_header as isize)) as usize;
EVENT_SIZE[event_type as usize]+(mask&size_of::<EventChunkHeader>())
}
// plan a single block: collect events until the block is full
fn plan_block(head:&mut Head,next_event:impl Fn(&Head)->Option<Timed<EventType>>)->Option<f64>{
fn plan_block(plan:&mut Plan<usize>,next_event:impl Fn(&Plan<usize>)->Option<(f64,EventType)>)->Option<f64>{
let mut size=0;
let first=next_event(head)?;
let (start_time,first_event)=next_event(plan)?;
size+=predict_size_increment(head,first.event);
size+=plan.size_increase(first_event);
if MAX_BLOCK_SIZE<size{
return None;
}
head.push(first.event);
plan.accumulate(first_event);
while let Some(event)=next_event(head){
size+=predict_size_increment(head,event.event);
while let Some((_,event_type))=next_event(plan){
size+=plan.size_increase(event_type);
if MAX_BLOCK_SIZE<size{
break;
}
head.push(event.event);
plan.accumulate(event_type);
}
Some(first.time)
Some(start_time)
}
struct PlannedBlock{
@@ -944,24 +830,24 @@ pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),B
// It is list-local for both plan_offline and plan_realtime.
index:usize,
time:f64,
plan:Plan,
plan:Plan<Range<usize>>,
}
fn plan_timeline<F>(next_event:F)->std::collections::VecDeque<PlannedBlock>
where
F:Copy,
F:Fn(&Head)->Option<Timed<EventType>>
F:Fn(&Plan<usize>)->Option<(f64,EventType)>
{
let mut timeline=std::collections::VecDeque::new();
let mut head=Head::new();
let mut last_head=head.clone();
let mut plan=Plan::default();
let mut last_plan=plan.clone();
let mut index=0;
while let Some(time)=plan_block(&mut head,next_event){
while let Some(time)=plan_block(&mut plan,next_event){
timeline.push_back(PlannedBlock{
index,
time,
plan:Plan::new(&last_head,&head),
plan:last_plan.range(&plan),
});
last_head=head.clone();
last_plan=plan.clone();
index+=1;
}
timeline
@@ -970,12 +856,18 @@ pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),B
// each plan describes the range of events included in the block.
let mut plan_offline=plan_timeline(|plan|{
let mut next_event=None;
plan.collect_offline(block,&mut next_event);
collect_event(&mut next_event,&block.world_events,plan,EventType::World);
collect_event(&mut next_event,&block.gravity_events,plan,EventType::Gravity);
collect_event(&mut next_event,&block.run_events,plan,EventType::Run);
collect_event(&mut next_event,&block.camera_events,plan,EventType::Camera);
collect_event(&mut next_event,&block.setting_events,plan,EventType::Setting);
next_event
});
let mut plan_realtime=plan_timeline(|plan|{
let mut next_event=None;
plan.collect_realtime(block,&mut next_event);
collect_event(&mut next_event,&block.input_events,plan,EventType::Input);
collect_event(&mut next_event,&block.output_events,plan,EventType::Output);
collect_event(&mut next_event,&block.sound_events,plan,EventType::Sound);
next_event
});
@@ -1050,7 +942,7 @@ pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),B
file_header.write_le(writer)?;
block_timelines.write_le(writer)?;
for plan in plan_order{
for (event_type,range) in plan{
for (range,event_type) in plan.0.into_iter().zip(EVENT_TYPES){
let num_events=range.len();
if num_events==0{
continue;

929
src/v1.rs Normal file
View File

@@ -0,0 +1,929 @@
use std::io::{SeekFrom,Error as IoError};
use binrw::binrw;
use binrw::io::{TakeSeek,TakeSeekExt};
use binrw::BinReaderExt;
use crate::BinrwError;
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy)]
pub struct Time(u32);
impl PartialEq for Time{
fn eq(&self,other:&Self)->bool{
self.0.eq(&other.0)
}
}
impl PartialOrd for Time{
fn partial_cmp(&self,other:&Self)->Option<core::cmp::Ordering>{
self.0.partial_cmp(&other.0)
}
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct Vector2{
pub x:f32,
pub y:f32,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct Vector3{
pub x:f32,
pub y:f32,
pub z:f32,
}
bitflags::bitflags!{
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub struct GameControls:u32{
const MoveForward=1<<0;
const MoveLeft=1<<1;
const MoveBack=1<<2;
const MoveRight=1<<3;
const MoveUp=1<<4;
const MoveDown=1<<5;
const LookUp=1<<6;
const LookLeft=1<<7;
const LookDown=1<<8;
const LookRight=1<<9;
const Jump=1<<10;
const Crouch=1<<11;
const Sprint=1<<12;
const Zoom=1<<13;
const Use=1<<14;
const Action1=1<<15;
const Action2=1<<16;
}
}
#[derive(Debug)]
pub struct GameControlsError;
impl std::fmt::Display for GameControlsError{
fn fmt(&self,f:&mut std::fmt::Formatter<'_>)->std::fmt::Result{
write!(f,"{self:?}")
}
}
impl std::error::Error for GameControlsError{}
impl GameControls{
fn try_from_bits(bits:u32)->Result<Self,GameControlsError>{
Self::from_bits(bits).ok_or(GameControlsError)
}
}
// generic timed event
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct Timed<E>
where
E:for<'a>binrw::BinRead<Args<'a>=()>,
E:for<'a>binrw::BinWrite<Args<'a>=()>,
{
pub time:Time,
pub event:E,
}
impl<A,B> PartialEq<Timed<B>> for Timed<A>
where
A:for<'a>binrw::BinRead<Args<'a>=()>,
A:for<'a>binrw::BinWrite<Args<'a>=()>,
B:for<'a>binrw::BinRead<Args<'a>=()>,
B:for<'a>binrw::BinWrite<Args<'a>=()>,
{
fn eq(&self,other:&Timed<B>)->bool{
self.time.eq(&other.time)
}
}
impl<A,B> PartialOrd<Timed<B>> for Timed<A>
where
A:for<'a>binrw::BinRead<Args<'a>=()>,
A:for<'a>binrw::BinWrite<Args<'a>=()>,
B:for<'a>binrw::BinRead<Args<'a>=()>,
B:for<'a>binrw::BinWrite<Args<'a>=()>,
{
fn partial_cmp(&self,other:&Timed<B>)->Option<core::cmp::Ordering>{
self.time.partial_cmp(&other.time)
}
}
// input
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct InputEvent{
#[br(try_map=GameControls::try_from_bits)]
#[bw(map=GameControls::bits)]
pub game_controls:GameControls,
pub mouse_pos:Vector2,
}
// output
bitflags::bitflags!{
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub struct TickInfo:u32{
const TickEnd=1<<0;
const Jump=1<<1;
const Strafe=1<<2;
const Touching=1<<3;
}
}
#[derive(Debug)]
pub struct TickInfoError;
impl std::fmt::Display for TickInfoError{
fn fmt(&self,f:&mut std::fmt::Formatter<'_>)->std::fmt::Result{
write!(f,"{self:?}")
}
}
impl std::error::Error for TickInfoError{}
impl TickInfo{
fn try_from_bits(bits:u32)->Result<Self,TickInfoError>{
Self::from_bits(bits).ok_or(TickInfoError)
}
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct OutputEvent{
#[br(try_map=TickInfo::try_from_bits)]
#[bw(map=TickInfo::bits)]
pub tick_info:TickInfo,
pub angles:Vector3,
pub position:Vector3,
pub velocity:Vector3,
pub acceleration:Vector3,
}
// sound
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum SoundType{
#[brw(magic=101u32)]
TrackGround,
#[brw(magic=102u32)]
TrackLadder,
#[brw(magic=103u32)]
TrackWater,
#[brw(magic=104u32)]
TrackAir,
#[brw(magic=201u32)]
JumpGround,
#[brw(magic=202u32)]
JumpLadder,
#[brw(magic=301u32)]
SmashGround,
#[brw(magic=302u32)]
SmashWall,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SoundEvent{
pub sound_type:SoundType,
/// Roblox enum
pub material:u32,
}
// world
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct WorldEventReset{
pub position:Vector3,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct WorldEventButton{
pub button_id:u32,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct WorldEventSetTime{
pub time:Time,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct WorldEventSetPaused{
#[br(map=|paused:u32|paused!=0)]
#[bw(map=|&paused:&bool|paused as u32)]
pub paused:bool,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub enum WorldEvent{
#[brw(magic=0u32)]
Reset(WorldEventReset),
#[brw(magic=1u32)]
Button(WorldEventButton),
#[brw(magic=2u32)]
SetTime(WorldEventSetTime),
#[brw(magic=3u32)]
SetPaused(WorldEventSetPaused),
}
// gravity
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct GravityEvent{
pub gravity:Vector3,
}
// run
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub struct ModeID(pub u32);
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum ModeSpec{
Exactly(ModeID),
#[brw(magic=-1i32)]
All,
#[brw(magic=-2i32)]
Invalid,
#[brw(magic=-3i32)]
InProgress,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum Style{
#[brw(magic=1u32)]
Autohop,
#[brw(magic=2u32)]
Scroll,
#[brw(magic=3u32)]
Sideways,
#[brw(magic=4u32)]
HalfSideways,
#[brw(magic=5u32)]
WOnly,
#[brw(magic=6u32)]
AOnly,
#[brw(magic=7u32)]
Backwards,
#[brw(magic=8u32)]
Faste,
#[brw(magic=14u32)]
LowGravity,
#[brw(magic=501u32)]
Fly,
#[brw(magic=502u32)]
FlySustain,
#[brw(magic=503u32)]
Rocket,
#[brw(magic=504u32)]
Style3DStrafe,
#[brw(magic=505u32)]
RocketStrafe,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum FlagReason{
#[brw(magic=0u32)]
Anticheat,
#[brw(magic=1u32)]
StyleChange,
#[brw(magic=2u32)]
Clock,
#[brw(magic=3u32)]
Pause,
#[brw(magic=4u32)]
Flying,
#[brw(magic=5u32)]
Gravity,
#[brw(magic=6u32)]
Timescale,
#[brw(magic=7u32)]
Timetravel,
#[brw(magic=8u32)]
Teleport,
#[brw(magic=9u32)]
Practice,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct RunEventPrepare{
pub mode:ModeID,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct RunEventZone{
pub mode:ModeID,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct RunEventClear{
pub mode:ModeSpec,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct RunEventFlag{
pub mode:ModeSpec,
pub flag_reason:FlagReason,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct RunEventPractice{
pub mode:ModeSpec,
pub state_id:u32,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub enum RunEvent{
#[brw(magic=0u32)]
Prepare(RunEventPrepare),
#[brw(magic=1u32)]
Start(RunEventZone),
#[brw(magic=2u32)]
Finish(RunEventZone),
#[brw(magic=3u32)]
Clear(RunEventClear),
#[brw(magic=4u32)]
Flag(RunEventFlag),
#[brw(magic=5u32)]
LoadState(RunEventPractice),
#[brw(magic=6u32)]
SaveState(RunEventPractice),
}
// camera
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy,Hash,Eq,PartialEq)]
pub enum CameraEventType{
#[brw(magic=0u32)]
CameraPunch,
#[brw(magic=1u32)]
Transform,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct CameraEvent{
pub camera_event_type:CameraEventType,
pub value:Vector3,
}
// setting
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventFieldOfView{
pub fov:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventSensitivity{
pub sensitivity_x:f64,
pub sensitivity_y:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventTurnSpeed{
pub turn_speed:f64,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub struct SettingEventStyle{
pub style:Style,
}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
pub enum SettingEvent{
#[brw(magic=0u32)]
FieldOfView(SettingEventFieldOfView),
#[brw(magic=1u32)]
Sensitivity(SettingEventSensitivity),
#[brw(magic=2u32)]
TurnSpeed(SettingEventTurnSpeed),
#[brw(magic=3u32)]
Style(SettingEventStyle),
}
/// A segment of event timelines.
/// Timelines are always be sorted.
#[derive(Default)]
pub struct Block{
pub input_events:Vec<Timed<InputEvent>>,
pub output_events:Vec<Timed<OutputEvent>>,
pub sound_events:Vec<Timed<SoundEvent>>,
pub world_events:Vec<Timed<WorldEvent>>,
pub gravity_events:Vec<Timed<GravityEvent>>,
pub run_events:Vec<Timed<RunEvent>>,
pub camera_events:Vec<Timed<CameraEvent>>,
pub setting_events:Vec<Timed<SettingEvent>>,
}
#[binrw]
#[brw(little)]
#[derive(Clone,Copy)]
enum EventType{
#[brw(magic=1u32)]
Input,
#[brw(magic=2u32)]
Output,
#[brw(magic=3u32)]
Sound,
#[brw(magic=4u32)]
World,
#[brw(magic=5u32)]
Gravity,
#[brw(magic=6u32)]
Run,
#[brw(magic=7u32)]
Camera,
#[brw(magic=8u32)]
Setting,
}
#[binrw]
#[brw(little)]
struct BlockHeader{
num_input_events:u16,
num_output_events:u16,
num_sound_events:u16,
num_world_events:u16,
num_gravity_events:u16,
num_run_events:u16,
num_camera_events:u16,
num_setting_events:u16,
}
// binread args tech has been further refined
fn read_data_into_events<R,T,F>(
data:&mut R,
events:&mut Vec<T>,
num_events:usize,
reserve_fn:F,
)->Result<(),BinrwError>
where
R:BinReaderExt,
T:for<'a> binrw::BinRead<Args<'a>=()>,
F:Fn(&mut Vec<T>,usize),
{
reserve_fn(events,num_events);
for _ in 0..num_events{
events.push(data.read_le()?);
}
Ok(())
}
impl Block{
pub fn from_reader<R:BinReaderExt>(data:R)->Result<Block,BinrwError>{
let mut block=Block::default();
// there is only supposed to be at most one of each type
// of event chunk per block, so allocate the size exactly.
block.extend_from_reader_exact(data)?;
Ok(block)
}
/// Read a complete data block and append the elements to the timelines in this block.
/// Reserves exactly enough information for the new data.
pub fn extend_from_reader_exact<R:BinReaderExt>(&mut self,mut data:R)->Result<(),BinrwError>{
let block_header:BlockHeader=data.read_le()?;
read_data_into_events(&mut data,&mut self.input_events,block_header.num_input_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.output_events,block_header.num_output_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.sound_events,block_header.num_sound_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.world_events,block_header.num_world_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.gravity_events,block_header.num_gravity_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.run_events,block_header.num_run_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.camera_events,block_header.num_camera_events as usize,Vec::reserve_exact)?;
read_data_into_events(&mut data,&mut self.setting_events,block_header.num_setting_events as usize,Vec::reserve_exact)?;
Ok(())
}
/// Read a complete data block and append the elements to the timelines in this block.
pub fn extend_from_reader<R:BinReaderExt>(&mut self,mut data:R)->Result<(),BinrwError>{
// sad code duplication
let block_header:BlockHeader=data.read_le()?;
read_data_into_events(&mut data,&mut self.input_events,block_header.num_input_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.output_events,block_header.num_output_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.sound_events,block_header.num_sound_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.world_events,block_header.num_world_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.gravity_events,block_header.num_gravity_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.run_events,block_header.num_run_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.camera_events,block_header.num_camera_events as usize,Vec::reserve)?;
read_data_into_events(&mut data,&mut self.setting_events,block_header.num_setting_events as usize,Vec::reserve)?;
Ok(())
}
fn extend_from_block_id_iter<'a,R:BinReaderExt>(&mut self,mut data:R,block_timelines:&BlockTimelines,blocks:impl IntoIterator<Item=&'a Timed<BlockId>>)->Result<(),Error>{
for timed in blocks{
let take_seek=block_timelines
.block_info(timed.event)?
.take_seek(&mut data)
.map_err(Error::Seek)?;
self.extend_from_reader(take_seek).map_err(Error::InvalidData)?;
}
Ok(())
}
}
#[derive(Debug)]
pub enum Error{
InvalidBlockId(InvalidBlockId),
Seek(IoError),
InvalidData(BinrwError),
}
impl std::fmt::Display for Error{
fn fmt(&self,f:&mut std::fmt::Formatter<'_>)->std::fmt::Result{
write!(f,"{self:?}")
}
}
impl std::error::Error for Error{}
#[binrw]
#[brw(little)]
#[derive(Debug,Clone,Copy)]
pub struct BlockId(u32);
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
struct BlockPosition(u32);
#[derive(Debug)]
pub struct InvalidBlockId(pub BlockId);
impl std::fmt::Display for InvalidBlockId{
fn fmt(&self,f:&mut std::fmt::Formatter<'_>)->std::fmt::Result{
write!(f,"{self:?}")
}
}
impl std::error::Error for InvalidBlockId{}
impl From<InvalidBlockId> for Error{
fn from(value:InvalidBlockId)->Self{
Self::InvalidBlockId(value)
}
}
/// The first 16 bytes of the file.
#[binrw]
#[brw(little)]
#[brw(magic=b"qbot")]
#[derive(Debug,Clone)]
pub struct FileHeader{
file_version:u32,
num_offline_blocks:u32,
num_realtime_blocks:u32,
}
impl FileHeader{
pub fn from_reader<R:BinReaderExt>(mut data:R)->Result<Self,BinrwError>{
data.read_le()
}
fn block_position_count(&self)->u32{
self.num_offline_blocks+self.num_realtime_blocks+1
}
/// Get BlockInfo for the BlockTimelines.
/// BlockTimelines is not really a "Block" per se, but BlockInfo is just a byte range.
pub fn block_timelines_info(&self)->BlockInfo{
const BLOCK_POSITION_SIZE:u32=size_of::<BlockPosition>() as u32;
const TIMED_BLOCKID_SIZE:u32=8+4;
let size=BLOCK_POSITION_SIZE*self.block_position_count()
+TIMED_BLOCKID_SIZE*self.num_offline_blocks
+TIMED_BLOCKID_SIZE*self.num_realtime_blocks;
let start=16;
let end=start+size;
BlockInfo(start..end)
}
}
/// Information about "Blocks" of data. Appears immediately after FileHeader.
/// Contains all the information required to implement streaming download, decode, and playback.
#[binrw]
#[brw(little)]
#[derive(Debug,Clone)]
#[br(import_raw(header:&FileHeader))]
pub struct BlockTimelines{
#[br(count=header.block_position_count())]
block_positions:Vec<BlockPosition>,
#[br(count=header.num_offline_blocks)]
offline_blocks_timeline:Vec<Timed<BlockId>>,
#[br(count=header.num_realtime_blocks)]
realtime_blocks_timeline:Vec<Timed<BlockId>>,
}
impl BlockTimelines{
pub fn from_reader<R:BinReaderExt>(header:&FileHeader,mut data:R)->Result<Self,BinrwError>{
data.read_le_args(header)
}
/// "Offline" blocks (containing World, Gravity, Run, Camera, and Setting events) in chronological order.
pub fn offline_blocks(&self)->&[Timed<BlockId>]{
&self.offline_blocks_timeline
}
/// "Realtime" blocks (containing Input, Output, and Sound events) in chronological order.
pub fn realtime_blocks(&self)->&[Timed<BlockId>]{
&self.realtime_blocks_timeline
}
/// Get BlockInfo for a specfic BlockId.
pub fn block_info(&self,block_id:BlockId)->Result<BlockInfo,InvalidBlockId>{
let BlockId(id)=block_id;
if self.block_positions.len() as u32<=id{
return Err(InvalidBlockId(block_id));
}
let BlockPosition(start)=self.block_positions[id as usize];
let BlockPosition(end)=self.block_positions[id as usize+1];
Ok(BlockInfo(start..end))
}
}
/// The range of data for a specific Block, relative to the start of the file.
#[derive(Debug,Clone)]
pub struct BlockInfo(core::ops::Range<u32>);
impl BlockInfo{
/// Create an adapter which seeks to the block start and reads at most the block length.
pub fn take_seek<R:BinReaderExt>(&self,mut data:R)->Result<TakeSeek<R>,IoError>{
data.seek(SeekFrom::Start(self.start as u64))?;
Ok(data.take_seek(self.len() as u64))
}
}
impl core::ops::Deref for BlockInfo{
type Target=core::ops::Range<u32>;
fn deref(&self)->&Self::Target{
&self.0
}
}
/// Read offline blocks and combine the timelines into a single Block.
/// Note that this reads the blocks in chronological order, not the order they appear in the file, so there is some seeking involved.
pub fn read_offline_to_block<R:BinReaderExt>(mut data:R)->Result<Block,Error>{
let header=FileHeader::from_reader(&mut data).map_err(Error::InvalidData)?;
let block_timelines=BlockTimelines::from_reader(&header,&mut data).map_err(Error::InvalidData)?;
let mut block=Block::default();
block.extend_from_block_id_iter(data,&block_timelines,block_timelines.offline_blocks())?;
Ok(block)
}
/// Read realtime blocks and combine the timelines into a single Block.
/// Note that this reads the blocks in chronological order, not the order they appear in the file, so there is some seeking involved.
pub fn read_realtime_to_block<R:BinReaderExt>(mut data:R)->Result<Block,Error>{
let header=FileHeader::from_reader(&mut data).map_err(Error::InvalidData)?;
let block_timelines=BlockTimelines::from_reader(&header,&mut data).map_err(Error::InvalidData)?;
let mut block=Block::default();
block.extend_from_block_id_iter(data,&block_timelines,block_timelines.realtime_blocks())?;
Ok(block)
}
/// Read the entire file and combine the timelines into a single Block.
/// Note that this reads the blocks in chronological order, not the order they appear in the file, so there is some seeking involved.
pub fn read_all_to_block<R:BinReaderExt>(mut data:R)->Result<Block,Error>{
let header=FileHeader::from_reader(&mut data).map_err(Error::InvalidData)?;
let block_timelines=BlockTimelines::from_reader(&header,&mut data).map_err(Error::InvalidData)?;
let mut block=Block::default();
block.extend_from_block_id_iter(&mut data,&block_timelines,block_timelines.offline_blocks())?;
block.extend_from_block_id_iter(&mut data,&block_timelines,block_timelines.realtime_blocks())?;
Ok(block)
}
#[cfg(feature="itertools")]
pub fn serialize<W:binrw::BinWriterExt>(block:&Block,writer:&mut W)->Result<(),BinrwError>{
use std::ops::Range;
const MAX_BLOCK_SIZE:usize=1<<18;
const FILE_VERSION:u32=0;
const EVENT_TYPES:[EventType;8]=[
EventType::Input,
EventType::Output,
EventType::Sound,
EventType::World,
EventType::Gravity,
EventType::Run,
EventType::Camera,
EventType::Setting,
];
const EVENT_SIZE:[usize;8]=[
8+4+2*4, // Input
8+4+4*3*4, // Output
8+4+4, // Sound
8+4+12, // World
8+3*4, // Gravity
8+4+4+4, // Run
8+4+3*4, // Camera
8+4+8, // Setting
];
#[derive(Clone,Default)]
struct Plan<T>([T;8]);
// A plan of how many events of each type to include in a data block.
impl Plan<usize>{
/// Predict the size increment from adding a new event.
fn size_increase(&self,event_type:EventType)->usize{
EVENT_SIZE[event_type as usize]
}
/// Add the new event.
fn accumulate(&mut self,event_type:EventType){
self.0[event_type as usize]+=1;
}
fn range(&self,end:&Plan<usize>)->Plan<Range<usize>>{
Plan(core::array::from_fn(|i|self.0[i]..end.0[i]))
}
}
// A plan of what range of events to include in a data block.
impl Plan<Range<usize>>{
/// Calculate the predicted size of the planned block.
fn size(&self)->usize{
self.0.iter()
.zip(EVENT_SIZE)
.map(|(range,event_size)|event_size*range.len())
.sum::<usize>()
+size_of::<BlockHeader>()
}
fn header(&self)->BlockHeader{
BlockHeader{
num_input_events:self.0[EventType::Input as usize].len() as u16,
num_output_events:self.0[EventType::Output as usize].len() as u16,
num_sound_events:self.0[EventType::Sound as usize].len() as u16,
num_world_events:self.0[EventType::World as usize].len() as u16,
num_gravity_events:self.0[EventType::Gravity as usize].len() as u16,
num_run_events:self.0[EventType::Run as usize].len() as u16,
num_camera_events:self.0[EventType::Camera as usize].len() as u16,
num_setting_events:self.0[EventType::Setting as usize].len() as u16,
}
}
}
// compare an event at the head of the plan to the best event collected so far.
fn collect_event<E>(
best:&mut Option<(Time,EventType)>,
list:&[Timed<E>],
plan:&Plan<usize>,
event_type:EventType,
)
where
E:for<'a>binrw::BinRead<Args<'a>=()>,
E:for<'a>binrw::BinWrite<Args<'a>=()>,
{
if let Some(event)=list.get(plan.0[event_type as usize])
&&best.is_none_or(|(time,_)|event.time<time)
{
*best=Some((event.time,event_type));
}
}
// plan a single block: collect events until the block is full
fn plan_block(plan:&mut Plan<usize>,next_event:impl Fn(&Plan<usize>)->Option<(Time,EventType)>)->Option<Time>{
let mut size=0;
let (start_time,first_event)=next_event(plan)?;
size+=plan.size_increase(first_event);
if MAX_BLOCK_SIZE<size{
return None;
}
plan.accumulate(first_event);
while let Some((_,event_type))=next_event(plan){
size+=plan.size_increase(event_type);
if MAX_BLOCK_SIZE<size{
break;
}
plan.accumulate(event_type);
}
Some(start_time)
}
struct PlannedBlock{
// index is not the same as BlockId.
// It is list-local for both plan_offline and plan_realtime.
index:usize,
time:Time,
plan:Plan<Range<usize>>,
}
fn plan_timeline<F>(next_event:F)->std::collections::VecDeque<PlannedBlock>
where
F:Copy,
F:Fn(&Plan<usize>)->Option<(Time,EventType)>
{
let mut timeline=std::collections::VecDeque::new();
let mut plan=Plan::default();
let mut last_plan=plan.clone();
let mut index=0;
while let Some(time)=plan_block(&mut plan,next_event){
timeline.push_back(PlannedBlock{
index,
time,
plan:last_plan.range(&plan),
});
last_plan=plan.clone();
index+=1;
}
timeline
}
// plan events into segments without spilling over max size threshold
// each plan describes the range of events included in the block.
let mut plan_offline=plan_timeline(|plan|{
let mut next_event=None;
collect_event(&mut next_event,&block.world_events,plan,EventType::World);
collect_event(&mut next_event,&block.gravity_events,plan,EventType::Gravity);
collect_event(&mut next_event,&block.run_events,plan,EventType::Run);
collect_event(&mut next_event,&block.camera_events,plan,EventType::Camera);
collect_event(&mut next_event,&block.setting_events,plan,EventType::Setting);
next_event
});
let mut plan_realtime=plan_timeline(|plan|{
let mut next_event=None;
collect_event(&mut next_event,&block.input_events,plan,EventType::Input);
collect_event(&mut next_event,&block.output_events,plan,EventType::Output);
collect_event(&mut next_event,&block.sound_events,plan,EventType::Sound);
next_event
});
let file_header=FileHeader{
file_version:FILE_VERSION,
num_offline_blocks:plan_offline.len() as u32,
num_realtime_blocks:plan_realtime.len() as u32,
};
let mut plan_order=Vec::with_capacity(plan_offline.len()+plan_realtime.len());
let mut block_positions=Vec::with_capacity(file_header.block_position_count() as usize);
// Fill the timelines with dummy values, we don't know the block ids yet.
// This can be done with Vec::spare_capacity_mut and unsafe, but whatever.
const DUMMY_BLOCK:Timed<BlockId>=Timed{time:Time(0),event:BlockId(0)};
let mut offline_blocks_timeline=vec![DUMMY_BLOCK;plan_offline.len()];
let mut realtime_blocks_timeline=vec![DUMMY_BLOCK;plan_realtime.len()];
{
// position starts after the *predicted* end of the BlockTimelines
let mut position=file_header.block_timelines_info().end;
let mut block_id=0;
let mut push_block=|timeline:&mut Vec<Timed<BlockId>>,planned:PlannedBlock|{
block_positions.push(BlockPosition(position));
position+=planned.plan.size() as u32;
// write the block id to the correct index
timeline[planned.index]=Timed{
time:planned.time,
event:BlockId(block_id),
};
block_id+=1;
plan_order.push(planned.plan);
};
// the first block in the file is an offline block to
// initialize the state of things like the current style
if let Some(plan)=plan_offline.pop_front(){
push_block(&mut offline_blocks_timeline,plan);
}
// the second block is the first realtime block which
// includes the starting position of the replay
if let Some(plan)=plan_realtime.pop_front(){
push_block(&mut realtime_blocks_timeline,plan);
}
// the third block is the last realtime block which
// is used by the game client to determine the duration
if let Some(plan)=plan_realtime.pop_back(){
push_block(&mut realtime_blocks_timeline,plan);
}
// push the remaining blocks in chronological order
for either_plan in itertools::merge_join_by(
plan_offline,
plan_realtime,
|offline,realtime|offline.time<=realtime.time,
){
match either_plan{
itertools::Either::Left(offline)=>push_block(&mut offline_blocks_timeline,offline),
itertools::Either::Right(realtime)=>push_block(&mut realtime_blocks_timeline,realtime),
}
}
// final position
block_positions.push(BlockPosition(position));
}
let block_timelines=BlockTimelines{
block_positions,
offline_blocks_timeline,
realtime_blocks_timeline,
};
use binrw::BinWrite;
file_header.write_le(writer)?;
block_timelines.write_le(writer)?;
for plan in plan_order{
let block_header=plan.header();
block_header.write_le(writer)?;
for (range,event_type) in plan.0.into_iter().zip(EVENT_TYPES){
let num_events=range.len();
if num_events==0{
continue;
}
match event_type{
EventType::Input=>block.input_events[range].write_le(writer)?,
EventType::Output=>block.output_events[range].write_le(writer)?,
EventType::Sound=>block.sound_events[range].write_le(writer)?,
EventType::World=>block.world_events[range].write_le(writer)?,
EventType::Gravity=>block.gravity_events[range].write_le(writer)?,
EventType::Run=>block.run_events[range].write_le(writer)?,
EventType::Camera=>block.camera_events[range].write_le(writer)?,
EventType::Setting=>block.setting_events[range].write_le(writer)?,
}
}
}
Ok(())
}