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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
//! Definitions of command argument data.
use std::num::NonZeroU16;
use super::{cursor::Cursor, LexError, Result};
/// A play style of the score.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum PlayerMode {
/// For single play, a player uses 5 or 7 keys.
Single,
/// For couple play, two players use each 5 or 7 keys.
Two,
/// For double play, a player uses 10 or 14 keys.
Double,
}
impl PlayerMode {
pub(crate) fn from(c: &mut Cursor) -> Result<Self> {
Ok(match c.next_token() {
Some("1") => Self::Single,
Some("2") => Self::Two,
Some("3") => Self::Double,
_ => return Err(c.err_expected_token("one of 1, 2 or 3")),
})
}
}
/// A rank to determine judge level, but treatment differs among the BMS players.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum JudgeLevel {
/// Rank 0, the most difficult rank.
VeryHard,
/// Rank 1, the harder rank.
Hard,
/// Rank 2, the easier rank.
Normal,
/// Rank 3, the easiest rank.
Easy,
}
impl JudgeLevel {
pub(crate) fn from(c: &mut Cursor) -> Result<Self> {
Ok(match c.next_token() {
Some("0") => Self::VeryHard,
Some("1") => Self::Hard,
Some("2") => Self::Normal,
Some("3") => Self::Easy,
_ => return Err(c.err_expected_token("one of 0, 1, 2 or 3")),
})
}
}
/// An object id. Its meaning is determined by the channel belonged to.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ObjId(pub NonZeroU16);
impl std::fmt::Debug for ObjId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let digits = (self.0.get() / 36, self.0.get() % 36);
f.debug_tuple("ObjId")
.field(&format!(
"{}{}",
char::from_digit(digits.0 as u32, 36).unwrap(),
char::from_digit(digits.1 as u32, 36).unwrap()
))
.finish()
}
}
impl TryFrom<u16> for ObjId {
type Error = std::num::TryFromIntError;
fn try_from(value: u16) -> std::result::Result<Self, Self::Error> {
Ok(Self(value.try_into()?))
}
}
impl ObjId {
pub(crate) fn from(id: &str, c: &mut Cursor) -> Result<Self> {
let id = u16::from_str_radix(id, 36).map_err(|_| c.err_expected_token("[00-ZZ]"))?;
id.try_into()
.map(Self)
.map_err(|_| c.err_expected_token("non zero index"))
}
}
/// A play volume of the sound in the score. Defaults to 100.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Volume {
/// A play volume percentage of the sound.
pub relative_percent: u8,
}
impl Default for Volume {
fn default() -> Self {
Self {
relative_percent: 100,
}
}
}
/// An alpha-red-gree-blue color data.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Argb {
/// A component of alpha.
pub alpha: u8,
/// A component of red.
pub red: u8,
/// A component of green.
pub green: u8,
/// A component of blue.
pub blue: u8,
}
impl Default for Argb {
fn default() -> Self {
Self {
alpha: 255,
red: 0,
green: 0,
blue: 0,
}
}
}
/// A kind of the note.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum NoteKind {
/// A normal note can be seen by the user.
Visible,
/// A invisible note cannot be played by the user.
Invisible,
/// A long-press note (LN), requires the user to hold pressing the key.
Long,
/// A landmine note that treated as POOR judgement when
Landmine,
}
impl NoteKind {
/// Returns whether the note is a playable.
pub const fn is_playable(self) -> bool {
!matches!(self, Self::Invisible)
}
/// Returns whether the note is a long-press note.
pub const fn is_long(self) -> bool {
matches!(self, Self::Long)
}
}
/// A key of the controller or keyboard.
///
/// ```text
/// |---------|----------------------|
/// | | [K2] [K4] [K6] |
/// |(Scratch)|[K1] [K3] [K5] [K7]|
/// |---------|----------------------|
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Key {
/// The leftmost white key.
Key1,
/// The leftmost black key.
Key2,
/// The second white key from the left.
Key3,
/// The second black key from the left.
Key4,
/// The third white key from the left.
Key5,
/// The rightmost black key.
Key6,
/// The rightmost white key.
Key7,
/// The scratch disk.
Scratch,
/// The zone that the user can scratch disk freely.
FreeZone,
}
impl Key {
/// Returns whether the key appears only 7 keys.
pub fn is_extended_key(self) -> bool {
matches!(self, Self::Key6 | Self::Key7)
}
pub(crate) fn from(key: &str, c: &mut Cursor) -> Result<Self> {
use Key::*;
Ok(match key {
"1" => Key1,
"2" => Key2,
"3" => Key3,
"4" => Key4,
"5" => Key5,
"6" => Scratch,
"7" => FreeZone,
"8" => Key6,
"9" => Key7,
_ => return Err(c.err_expected_token("[1-9]")),
})
}
}
/// A POOR BGA display mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum PoorMode {
/// To hide the normal BGA and display the POOR BGA.
Interrupt,
/// To overlap the POOR BGA onto the normal BGA.
Overlay,
/// Not to display the POOR BGA.
Hidden,
}
impl Default for PoorMode {
fn default() -> Self {
Self::Interrupt
}
}
/// The channel, or lane, where the note will be on.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum Channel {
/// The BGA channel.
BgaBase,
/// The BGA channel but overlay to [`Channel::BgaBase`] channel.
BgaLayer,
/// The POOR BGA channel.
BgaPoor,
/// For the note which will be auto-played.
Bgm,
/// For the bpm change by an [`u8`] integer.
BpmChangeU8,
/// For the bpm change object.
BpmChange,
/// For the change option object.
ChangeOption,
/// For the note which the user can interact.
Note {
/// The kind of the note.
kind: NoteKind,
/// The note for the player 1.
is_player1: bool,
/// The key which corresponds to the note.
key: Key,
},
/// For the section length change object.
SectionLen,
/// For the stop object.
Stop,
}
impl Channel {
pub(crate) fn from(channel: &str, c: &mut Cursor) -> Result<Self> {
use Channel::*;
Ok(match channel.to_uppercase().as_str() {
"01" => Bgm,
"02" => SectionLen,
"03" => BpmChangeU8,
"08" => BpmChange,
"04" => BgaBase,
"06" => BgaPoor,
"07" => BgaLayer,
"09" => Stop,
player1 if player1.starts_with('1') => Note {
kind: NoteKind::Visible,
is_player1: true,
key: Key::from(&channel[1..], c)?,
},
player2 if player2.starts_with('2') => Note {
kind: NoteKind::Visible,
is_player1: false,
key: Key::from(&channel[1..], c)?,
},
player1 if player1.starts_with('3') => Note {
kind: NoteKind::Invisible,
is_player1: true,
key: Key::from(&channel[1..], c)?,
},
player2 if player2.starts_with('4') => Note {
kind: NoteKind::Invisible,
is_player1: false,
key: Key::from(&channel[1..], c)?,
},
player1 if player1.starts_with('5') => Note {
kind: NoteKind::Long,
is_player1: true,
key: Key::from(&channel[1..], c)?,
},
player2 if player2.starts_with('6') => Note {
kind: NoteKind::Long,
is_player1: false,
key: Key::from(&channel[1..], c)?,
},
player1 if player1.starts_with('D') => Note {
kind: NoteKind::Landmine,
is_player1: true,
key: Key::from(&channel[1..], c)?,
},
player2 if player2.starts_with('E') => Note {
kind: NoteKind::Landmine,
is_player1: false,
key: Key::from(&channel[1..], c)?,
},
_ => {
return Err(LexError::UnknownCommand {
line: c.line(),
col: c.col(),
})
}
})
}
}
/// A track, or bar, in the score. It must greater than 0, but some scores may include the 0 track.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Track(pub u32);