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 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
// All casts in this file are intended or safe within the context of this library.
//
// One can change `allow` to `warn` to review them if necessary.
#![allow(
clippy::cast_lossless,
clippy::cast_possible_truncation,
clippy::cast_sign_loss
)]
// TODO: Re-check if bpm related casts are accurate.
// TODO: Correctly represent unset values in pattern, trig, track.
// TODO: Check if we can get info about if this pattern has a kit assigned and which?
pub(crate) mod de;
pub(crate) mod plock;
/// Holds the structure to represent a track.
pub mod track;
/// Holds the types used in pattern.
pub mod types;
use self::{
plock::ParameterLockPool,
types::{Speed, TimeMode},
};
use crate::{
defaults::default_tracks,
error::{ParameterError, RytmError, SysexConversionError},
impl_sysex_compatible,
object::pattern::track::Track,
sysex::{SysexCompatible, SysexMeta, SysexType, PATTERN_SYSEX_SIZE},
util::{arc_mutex_owner, assemble_u32_from_u8_array_be, from_s_u16_t, to_s_u16_t_union_b},
};
use crate::{util::break_u32_into_u8_array_be, AnySysexType};
use derivative::Derivative;
use rytm_rs_macro::parameter_range;
use rytm_sys::{ar_pattern_raw_to_syx, ar_pattern_t, ar_pattern_track_t, ar_sysex_meta_t};
use serde::Serialize;
use std::sync::{Arc, Mutex};
pub use track::{
trig::{types::*, Trig},
types::*,
};
impl_sysex_compatible!(
Pattern,
ar_pattern_t,
ar_pattern_raw_to_syx,
SysexType::Pattern,
PATTERN_SYSEX_SIZE
);
/// Represents a pattern in the analog rytm.
///
/// It does not map identically to the structure in the firmware.
#[derive(Derivative, Clone, Serialize)]
#[derivative(Debug)]
pub struct Pattern {
#[derivative(Debug = "ignore")]
sysex_meta: SysexMeta,
/// Index of this pattern.
///
/// Range `0..=127` or 0 for the pattern at work buffer.
pub(crate) index: usize,
/// Version of the pattern structure.
version: u32,
/// Fx Track
#[serde(serialize_with = "arc_mutex_owner::serialize")]
pub(crate) fx_track: Arc<Mutex<Track>>,
/// Tracks
///
/// 12 tracks of analog rytm excluding the FX track.
tracks: [Track; 12],
/// Master Length
///
/// Range `1..=1024`
///
/// - `1` = `Infinite`
/// - `2` = `2`
///
/// and onwards.
master_length: u16,
/// Master Change
///
/// Range `1..=1024`
///
/// - `1` = `OFF`
/// - `2` = `2`
///
/// and onwards.
master_change: u16,
/// Pattern Kit Number
///
/// Range `0..=127`
/// Unset 0xFF
kit_number: u8,
/// Pattern Swing Amount
///
/// Range `0..=30`
///
/// - `0` = 50%
/// - `30` = 80%
swing_amount: u8,
/// Pattern Time Mode
///
/// - Normal = `0`
/// - Advanced = `1`
time_mode: TimeMode,
/// Pattern Speed
///
/// - 1x
/// - 2x
/// - 3/2x
/// - 3/4x
/// - 1/2x
/// - 1/4x
/// - 1/8x
speed: Speed,
/// Pattern Global Quantize
///
/// Range `0..=127`
global_quantize: u8,
/// Pattern BPM
///
/// Range `30.0..=300.0`
bpm: f32,
// 1=apply to all tracks, 0=apply only to current track
pad_scale_per_pattern: u8,
/// Parameter Lock Pool
#[derivative(Debug = "ignore")]
#[serde(serialize_with = "arc_mutex_owner::serialize")]
pub(crate) parameter_lock_pool: Arc<Mutex<ParameterLockPool>>,
}
impl From<&Pattern> for ar_pattern_t {
fn from(pattern: &Pattern) -> Self {
let mut tracks: [ar_pattern_track_t; 13] = [ar_pattern_track_t::default(); 13];
for (i, track) in pattern.tracks.iter().enumerate() {
if i == 12 {
let borrow = pattern.fx_track.lock().unwrap();
tracks[i] = (&*borrow).into();
break;
}
tracks[i] = track.into();
}
let bpm = (pattern.bpm * 120.0) as u16;
Self {
magic: break_u32_into_u8_array_be(pattern.version),
tracks,
plock_seqs: pattern.parameter_lock_pool.lock().unwrap().as_raw(),
master_length: to_s_u16_t_union_b(pattern.master_length),
master_chg_msb: (pattern.master_change >> 8) as u8,
master_chg_lsb: pattern.master_change as u8,
kit_number: pattern.kit_number,
swing_amount: pattern.swing_amount,
time_mode: pattern.time_mode.into(),
master_speed: pattern.speed.into(),
global_quantize: pattern.global_quantize,
bpm_msb: (bpm >> 8) as u8,
bpm_lsb: bpm as u8,
pad_scale_per_pattern: pattern.pad_scale_per_pattern,
}
}
}
impl Pattern {
#[allow(clippy::too_many_arguments)]
pub(crate) fn try_from_raw(
sysex_meta: SysexMeta,
raw_pattern: &ar_pattern_t,
) -> Result<Self, RytmError> {
let is_targeting_work_buffer = sysex_meta.is_targeting_work_buffer();
let index = sysex_meta.get_normalized_object_index();
let parameter_lock_pool = Arc::new(Mutex::new(ParameterLockPool::from_raw(
&raw_pattern.plock_seqs,
index,
is_targeting_work_buffer,
)));
let fx_track = Arc::new(Mutex::new(Track::try_from_raw(
12,
&raw_pattern.tracks[12],
¶meter_lock_pool,
None,
)?));
// Parameters does not matter here since they're going to be replaced.
// We just provide dummy values.
let mut tracks: [Track; 12] = default_tracks(0, false, None);
for (i, track) in raw_pattern.tracks.iter().enumerate() {
if i == 12 {
break;
}
tracks[i] =
Track::try_from_raw(i, track, ¶meter_lock_pool, Some(Arc::clone(&fx_track)))?;
}
let version = assemble_u32_from_u8_array_be(&raw_pattern.magic);
let bpm = ((raw_pattern.bpm_msb as u16) << 8) | (raw_pattern.bpm_lsb as u16);
let bpm = bpm as f32 / 120.0;
let master_change =
((raw_pattern.master_chg_msb as u16) << 8) | (raw_pattern.master_chg_lsb as u16);
Ok(Self {
index,
sysex_meta,
version,
tracks,
fx_track,
parameter_lock_pool,
master_length: unsafe { from_s_u16_t(raw_pattern.master_length) },
master_change,
kit_number: raw_pattern.kit_number,
swing_amount: raw_pattern.swing_amount,
time_mode: raw_pattern.time_mode.try_into()?,
speed: raw_pattern.master_speed.try_into()?,
global_quantize: raw_pattern.global_quantize,
bpm,
pad_scale_per_pattern: raw_pattern.pad_scale_per_pattern,
})
}
pub(crate) fn as_raw_parts(&self) -> (SysexMeta, ar_pattern_t) {
(self.sysex_meta, self.into())
}
/// Makes a new pattern with the project defaults.
#[parameter_range(range = "index:0..=127")]
pub fn try_default(index: usize) -> Result<Self, RytmError> {
let parameter_lock_pool = Arc::new(Mutex::new(ParameterLockPool::default()));
let mut fx_track = Track::try_default(12, index, false, None).unwrap();
fx_track.parameter_lock_pool = Some(Arc::clone(¶meter_lock_pool));
let fx_track = Arc::new(Mutex::new(fx_track));
let mut tracks = default_tracks(0, true, Some(Arc::clone(&fx_track)));
for track in &mut tracks {
track.parameter_lock_pool = Some(Arc::clone(¶meter_lock_pool));
for trig in track.trigs_mut() {
trig.parameter_lock_pool = Some(Arc::clone(¶meter_lock_pool));
}
}
Ok(Self {
sysex_meta: SysexMeta::try_default_for_pattern(index, None)?,
index,
version: 5,
tracks,
fx_track,
parameter_lock_pool,
master_length: 16,
master_change: 1,
kit_number: 0,
swing_amount: 0,
time_mode: TimeMode::Normal,
speed: Speed::default(),
global_quantize: 0,
bpm: 120.0,
pad_scale_per_pattern: 0x01,
})
}
// This function can not panic.
#[allow(clippy::missing_panics_doc)]
/// Makes a new pattern with the project defaults as if it is in the work buffer..
pub fn work_buffer_default() -> Self {
let parameter_lock_pool = Arc::new(Mutex::new(ParameterLockPool::default()));
let mut fx_track = Track::try_default(12, 0, true, None).unwrap();
fx_track.parameter_lock_pool = Some(Arc::clone(¶meter_lock_pool));
let fx_track = Arc::new(Mutex::new(fx_track));
let mut tracks = default_tracks(0, true, Some(Arc::clone(&fx_track)));
for track in &mut tracks {
track.parameter_lock_pool = Some(Arc::clone(¶meter_lock_pool));
for trig in track.trigs_mut() {
trig.parameter_lock_pool = Some(Arc::clone(¶meter_lock_pool));
}
}
Self {
sysex_meta: SysexMeta::default_for_pattern_in_work_buffer(None),
index: 0,
version: 5,
tracks,
fx_track,
parameter_lock_pool,
master_length: 16,
master_change: 1,
kit_number: 0,
swing_amount: 0,
time_mode: TimeMode::Normal,
speed: Speed::default(),
global_quantize: 0,
bpm: 120.0,
pad_scale_per_pattern: 0x01,
}
}
/// Returns a mutable reference to the tracks which this pattern contains.
///
/// 13th element is the FX track.
pub fn tracks_mut(&mut self) -> &mut [Track] {
&mut self.tracks
}
/// Sets master length for the pattern.
///
/// Range `1..=1024`
///
/// - `1` = `Infinite`
/// - `2` = `2`
///
/// and onwards.
#[parameter_range(range = "master_length:1..=1024")]
pub fn set_master_length(&mut self, master_length: usize) -> Result<(), RytmError> {
self.master_length = master_length as u16;
Ok(())
}
/// Sets swing amount for the pattern.
///
/// Range `50..=80`
///
/// Range denotes percentage.
#[parameter_range(range = "swing_amount:50..=80")]
pub fn set_swing_amount(&mut self, swing_amount: usize) -> Result<(), RytmError> {
// Internally, swing amount is stored as 0..=30
self.swing_amount = (swing_amount - 50) as u8;
Ok(())
}
/// Sets the speed for the pattern.
///
/// Check [`Speed`] for options.
pub fn set_speed(&mut self, speed: Speed) {
self.speed = speed;
}
/// Sets the global quantize for the pattern.
///
/// Range `0..=127`
#[parameter_range(range = "global_quantize:0..=127")]
pub fn set_global_quantize(&mut self, global_quantize: usize) -> Result<(), RytmError> {
self.global_quantize = global_quantize as u8;
Ok(())
}
/// Sets the kit number for the pattern.
///
/// Range `0..=127`
#[parameter_range(range = "kit_number:0..=127")]
pub fn set_kit_number(&mut self, kit_number: usize) -> Result<(), RytmError> {
self.kit_number = kit_number as u8;
Ok(())
}
/// Sets the time mode for the pattern.
///
/// Check [`TimeMode`] for options.
pub fn set_time_mode(&mut self, time_mode: TimeMode) {
self.time_mode = time_mode;
}
/// Sets the master change for the pattern.
///
/// Range `1..=1024`
///
/// - `1` = `OFF`
/// - `2` = `2`
///
/// and onwards.
#[parameter_range(range = "master_change:1..=1024")]
pub fn set_master_change(&mut self, master_change: usize) -> Result<(), RytmError> {
self.master_change = master_change as u16;
Ok(())
}
/// Sets the BPM for the pattern.
///
/// Range `30.0..=300.0`
///
/// This is only effective when pattern level bpm is enabled.
#[parameter_range(range = "bpm:30.0..=300.0")]
pub fn set_bpm(&mut self, bpm: f32) -> Result<(), RytmError> {
self.bpm = bpm;
Ok(())
}
/// Returns a reference to the tracks which this pattern contains.
///
/// 13th element is the FX track.
pub const fn tracks(&self) -> &[Track] {
&self.tracks
}
/// Returns the master length for the pattern.
///
/// Range `1..=1024`
///
/// - `1` = `Infinite`
/// - `2` = `2`
///
/// and onwards.
pub const fn master_length(&self) -> usize {
self.master_length as usize
}
/// Returns the swing amount for the pattern.
///
/// Range `50..=80`
///
/// Range denotes percentage.
pub const fn swing_amount(&self) -> usize {
// Internally, swing amount is stored as 0..=30
self.swing_amount as usize + 50
}
/// Returns the speed for the pattern.
///
/// Check [`Speed`] for options.
pub const fn speed(&self) -> Speed {
self.speed
}
/// Returns the global quantize for the pattern.
///
/// Range `0..=127`
pub const fn global_quantize(&self) -> usize {
self.global_quantize as usize
}
/// Returns the kit number for the pattern.
///
/// Range `0..=127`
pub const fn kit_number(&self) -> usize {
self.kit_number as usize
}
/// Returns the time mode for the pattern.
///
/// Check [`TimeMode`] for options.
pub const fn time_mode(&self) -> TimeMode {
self.time_mode
}
/// Returns the master change for the pattern.
///
/// Range `1..=1024`
///
/// - `1` = `OFF`
/// - `2` = `2`
///
/// and onwards.
pub const fn master_change(&self) -> usize {
self.master_change as usize
}
/// Returns the BPM for the pattern.
///
/// Range `30.0..=300.0`
///
/// This is only effective when pattern level bpm is enabled.
pub const fn bpm(&self) -> f32 {
self.bpm
}
/// Returns the index of the pattern.
pub const fn index(&self) -> usize {
self.index
}
/// Checks if this pattern is the pattern at work buffer.
pub const fn is_work_buffer_pattern(&self) -> bool {
self.sysex_meta.is_targeting_work_buffer()
}
/// Returns the version of the pattern structure.
pub const fn structure_version(&self) -> u32 {
self.version
}
/// Clears all the parameter locks for this pattern.
pub fn clear_all_plocks(&mut self) {
self.parameter_lock_pool.lock().unwrap().clear_all_plocks();
}
/// Clears all the parameter locks for the given track in this pattern.
///
/// Range `0..=12`
#[parameter_range(range = "track_index:0..=12")]
pub fn clear_all_plocks_for_track(&mut self, track_index: u8) -> Result<(), RytmError> {
self.parameter_lock_pool
.lock()
.unwrap()
.clear_all_plocks_for_track(track_index);
Ok(())
}
}