pen.rs 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. use std::path::PathBuf;
  2. use ezcad::{
  3. pen::Pen,
  4. types::{PulseWidth, Rgba},
  5. };
  6. use itertools::Itertools;
  7. use log::debug;
  8. use rand::{seq::SliceRandom, Rng};
  9. use serde::{Deserialize, Serialize};
  10. use strum::IntoEnumIterator;
  11. const SPEED_MIN: f64 = 0.0;
  12. const SPEED_MAX: f64 = 100000.0;
  13. const POWER_MIN: f64 = 0.0;
  14. const POWER_MAX: f64 = 100.0;
  15. const FREQUENCY_MIN: u32 = 20_000;
  16. const FREQUENCY_MAX: u32 = 4_000_000;
  17. #[derive(Debug, Serialize, Deserialize)]
  18. #[serde(rename_all = "PascalCase")]
  19. pub struct Patch {
  20. color: Option<(u8, u8, u8)>,
  21. enabled: Option<bool>,
  22. loop_count: Option<u32>,
  23. speed: Option<f64>,
  24. power: Option<f64>,
  25. frequency: Option<u32>,
  26. pulse_width: Option<PulseWidth>,
  27. }
  28. impl Patch {
  29. fn patch(&self, pen: &mut Pen) {
  30. self.color.map(|color| {
  31. debug!("Patching pen color to {:?}", color);
  32. *pen.color = color.into()
  33. });
  34. self.enabled.map(|enabled| {
  35. debug!("Patching pen enablement to {}", enabled);
  36. *pen.disabled = !enabled as u32;
  37. });
  38. self.loop_count.map(|loop_count| {
  39. debug!("Patching pen loop count to {}", loop_count);
  40. assert!(loop_count > 0, "Pen loop count must be greater than zero");
  41. *pen.loop_count = loop_count;
  42. });
  43. self.speed.map(|speed| {
  44. debug!("Patching pen speed to {}", speed);
  45. assert!(
  46. speed > SPEED_MIN && speed <= SPEED_MAX,
  47. "Pen speed must be between {} and {}",
  48. SPEED_MIN,
  49. SPEED_MAX
  50. );
  51. *pen.speed = speed;
  52. });
  53. self.power.map(|power| {
  54. debug!("Patching pen power to {}", power);
  55. assert!(
  56. power > POWER_MIN && power <= POWER_MAX,
  57. "Pen power must be between {} and {}",
  58. POWER_MIN,
  59. POWER_MAX
  60. );
  61. *pen.power = power;
  62. });
  63. self.frequency.map(|frequency| {
  64. debug!("Patching pen frequency to {}", frequency);
  65. assert!(
  66. frequency >= FREQUENCY_MIN && frequency <= FREQUENCY_MAX,
  67. "Pen frequency must be between {} and {}",
  68. FREQUENCY_MIN,
  69. FREQUENCY_MAX
  70. );
  71. *pen.frequency = frequency;
  72. *pen.frequency_2 = frequency.try_into().unwrap();
  73. });
  74. self.pulse_width.map(|width| {
  75. let width: u32 = width.into();
  76. debug!("Patching pen pulse width to {}ns", width);
  77. *pen.pulse_width = width.into();
  78. *pen.pulse_width_2 = width.try_into().unwrap();
  79. });
  80. // Always enable custom settings for pen
  81. *pen.use_default = 0;
  82. }
  83. }
  84. #[derive(Debug, Serialize, Deserialize)]
  85. #[serde(rename_all = "PascalCase")]
  86. pub struct PatchPen {
  87. pen: usize,
  88. #[serde(flatten)]
  89. patch: Patch,
  90. }
  91. impl PatchPen {
  92. pub fn patch(&self, pens: &mut Vec<Pen>) {
  93. debug!("Patching pen #{}", self.pen);
  94. let pen: &mut Pen = pens.get_mut(self.pen).expect("Invalid pen index");
  95. self.patch.patch(pen);
  96. pen.valid_settings();
  97. }
  98. }
  99. #[derive(Debug, Serialize, Deserialize)]
  100. #[serde(rename_all = "PascalCase")]
  101. pub struct ClonePen {
  102. from: usize,
  103. to: usize,
  104. inclusive: Option<bool>,
  105. patch: Option<Patch>,
  106. }
  107. impl ClonePen {
  108. pub fn clone(&self, pens: &mut Vec<Pen>) {
  109. debug!(
  110. "Cloning pen #{} to #{}{}",
  111. self.from,
  112. self.to,
  113. match self.inclusive {
  114. Some(true) => format!(" (inclusive)"),
  115. _ => format!(""),
  116. }
  117. );
  118. // Clone pen
  119. let src: Pen = pens.get(self.from).expect("Invalid pen index").clone();
  120. match self.inclusive {
  121. Some(true) => {
  122. assert!(
  123. self.to > self.from,
  124. "Target pen(s) must be greater than source pen"
  125. );
  126. // Clone pen (randomize color)
  127. for idx in (self.from..=self.to).skip(1) {
  128. let dst: &mut Pen = pens.get_mut(idx).expect("Invalid pen index");
  129. *dst = src.clone();
  130. *dst.color = Rgba::random().into();
  131. // Patch pen if needed
  132. self.patch.as_ref().map(|patch| {
  133. debug!("Patching pen #{}", idx);
  134. patch.patch(dst);
  135. });
  136. }
  137. }
  138. _ => {
  139. let dst: &mut Pen = pens.get_mut(self.to).expect("Invalid pen index");
  140. *dst = src;
  141. // Patch pen if needed
  142. self.patch.as_ref().map(|patch| {
  143. debug!("Patching pen #{}", self.to);
  144. patch.patch(dst);
  145. });
  146. }
  147. }
  148. }
  149. }
  150. #[derive(Debug, Serialize, Deserialize)]
  151. pub enum PatternField {
  152. Loops(i32),
  153. Speed(f64),
  154. Power(f64),
  155. Frequency(i32),
  156. PulseWidth(u32),
  157. }
  158. impl PatternField {
  159. pub fn pattern(&self, pens: &mut dyn Iterator<Item = (usize, &mut Pen)>) {
  160. // Obtain settings from source (first) pen
  161. let (src_idx, src) = pens.next().expect("Pattern must involve at least one pen");
  162. let mut setting: PatternField = match self {
  163. PatternField::Loops(_) => {
  164. debug!(
  165. "Initial loop count from pen #{} is {}",
  166. src_idx, *src.loop_count
  167. );
  168. PatternField::Loops((*src.loop_count).try_into().unwrap())
  169. }
  170. PatternField::Speed(_) => {
  171. debug!("Initial speed from pen #{} is {}", src_idx, *src.speed);
  172. PatternField::Speed(*src.speed)
  173. }
  174. PatternField::Power(_) => {
  175. debug!("Initial power from pen #{} is {}", src_idx, *src.power);
  176. PatternField::Power(*src.power)
  177. }
  178. PatternField::Frequency(_) => {
  179. debug!(
  180. "Initial frequency from pen #{} is {}",
  181. src_idx, *src.frequency
  182. );
  183. PatternField::Frequency((*src.frequency).try_into().unwrap())
  184. }
  185. PatternField::PulseWidth(_) => {
  186. debug!(
  187. "Initial pulse width from pen #{} is {}ns",
  188. src_idx, *src.pulse_width
  189. );
  190. PatternField::PulseWidth(*src.pulse_width)
  191. }
  192. };
  193. for (idx, dst) in pens {
  194. // Calculate new setting
  195. setting = match (setting, self) {
  196. (PatternField::Loops(prev), PatternField::Loops(incr)) => {
  197. let value: i32 = prev + incr;
  198. debug!("Patching loop count for pen #{} to {}", idx, value);
  199. assert!(value > 0, "Pen loop count must be greater than zero");
  200. PatternField::Loops(value)
  201. }
  202. (PatternField::Speed(prev), PatternField::Speed(incr)) => {
  203. let value: f64 = prev + incr;
  204. debug!("Patching speed for pen #{} to {}", idx, value);
  205. assert!(
  206. value > SPEED_MIN && value <= SPEED_MAX,
  207. "Pen speed must be between {} and {}",
  208. SPEED_MIN,
  209. SPEED_MAX
  210. );
  211. PatternField::Speed(value)
  212. }
  213. (PatternField::Power(prev), PatternField::Power(incr)) => {
  214. let value: f64 = prev + incr;
  215. debug!("Patching power for pen #{} to {}", idx, value);
  216. assert!(
  217. value > POWER_MIN && value <= POWER_MAX,
  218. "Pen power must be between {} and {}",
  219. POWER_MIN,
  220. POWER_MAX
  221. );
  222. PatternField::Power(value)
  223. }
  224. (PatternField::Frequency(prev), PatternField::Frequency(incr)) => {
  225. let value: i32 = prev + incr;
  226. debug!("Patching frequency for pen #{} to {}", idx, value);
  227. assert!(
  228. value >= FREQUENCY_MIN.try_into().unwrap()
  229. && value <= FREQUENCY_MAX.try_into().unwrap(),
  230. "Pen frequency must be between {} and {}",
  231. FREQUENCY_MIN,
  232. FREQUENCY_MAX
  233. );
  234. PatternField::Frequency(value)
  235. }
  236. (PatternField::PulseWidth(prev), PatternField::PulseWidth(incr)) => {
  237. let mut pw = PulseWidth::iter();
  238. let _ = pw
  239. .find(|x| u32::from(*x) == prev)
  240. .expect("Unknown pulse width");
  241. let mut pw = pw.skip((*incr - 1).try_into().unwrap());
  242. let next: u32 = pw.next().expect("Pulse width out of bounds").into();
  243. debug!("Patching pulse width for pen #{} to {}ns", idx, next);
  244. PatternField::PulseWidth(next)
  245. }
  246. _ => unreachable!(),
  247. };
  248. // Patch updated value
  249. match setting {
  250. PatternField::Loops(x) => *dst.loop_count = x.try_into().unwrap(),
  251. PatternField::Speed(x) => *dst.speed = x,
  252. PatternField::Power(x) => *dst.power = x,
  253. PatternField::Frequency(x) => {
  254. *dst.frequency = x.try_into().unwrap();
  255. *dst.frequency_2 = x.try_into().unwrap();
  256. }
  257. PatternField::PulseWidth(x) => {
  258. *dst.pulse_width = x;
  259. *dst.pulse_width_2 = x.try_into().unwrap();
  260. }
  261. }
  262. // Randomize pen color
  263. *dst.color = Rgba::random().into();
  264. // Always enable custom settings for pen
  265. *dst.use_default = 0;
  266. dst.valid_settings();
  267. }
  268. }
  269. }
  270. #[derive(Debug, Serialize, Deserialize)]
  271. #[serde(rename_all = "PascalCase")]
  272. pub struct PatternPen {
  273. index: usize,
  274. count: usize,
  275. field: PatternField,
  276. }
  277. impl PatternPen {
  278. pub fn pattern(&self, pens: &mut Vec<Pen>) {
  279. debug!(
  280. "Patterning from pen #{} to #{}",
  281. self.index,
  282. self.index + self.count - 1
  283. );
  284. self.field.pattern(
  285. &mut pens
  286. .iter_mut()
  287. .enumerate()
  288. .skip(self.index)
  289. .take(self.count),
  290. )
  291. }
  292. }
  293. #[derive(Copy, Clone, Default, PartialEq)]
  294. struct RandomizedSetting {
  295. speed: Option<f64>,
  296. power: Option<f64>,
  297. frequency: Option<u32>,
  298. pulse_width: Option<PulseWidth>,
  299. }
  300. impl RandomizedSetting {
  301. fn apply(&self, pen: &mut Pen) {
  302. self.speed.map(|speed| *pen.speed = speed);
  303. self.power.map(|power| *pen.power = power);
  304. self.frequency.map(|freq| {
  305. *pen.frequency = freq;
  306. *pen.frequency_2 = freq.try_into().unwrap();
  307. });
  308. self.pulse_width.map(|pw| {
  309. let pw: u32 = pw.into();
  310. *pen.pulse_width = pw;
  311. *pen.pulse_width_2 = pw.try_into().unwrap();
  312. });
  313. }
  314. }
  315. #[derive(Debug, Serialize, Deserialize)]
  316. #[serde(rename_all = "PascalCase")]
  317. pub struct RandomizePen {
  318. index: usize,
  319. count: usize,
  320. speed: Option<(f64, f64, f64)>,
  321. power: Option<(f64, f64, f64)>,
  322. frequency: Option<(u32, u32, u32)>,
  323. pulse_width: Option<(PulseWidth, PulseWidth, usize)>,
  324. }
  325. impl RandomizePen {
  326. pub fn random(&self, pens: &mut Vec<Pen>) {
  327. debug!(
  328. "Randomizing from pen #{} to #{}",
  329. self.index,
  330. self.index + self.count - 1
  331. );
  332. let mut generated: Vec<RandomizedSetting> = vec![];
  333. const MAX_ATTEMPTS: usize = 1000;
  334. for (index, pen) in pens
  335. .iter_mut()
  336. .skip(self.index)
  337. .take(self.count)
  338. .enumerate()
  339. {
  340. for attempt in 0..=MAX_ATTEMPTS {
  341. let mut setting: RandomizedSetting = RandomizedSetting::default();
  342. if let Some((min, max, step)) = self.speed {
  343. let offset: usize =
  344. rand::thread_rng().gen_range(0..=((max - min) / step) as usize);
  345. let value: f64 = min + step * offset as f64;
  346. debug!("Randomizing speed for pen #{} to {}", index, value);
  347. setting.speed = Some(value);
  348. }
  349. if let Some((min, max, step)) = self.power {
  350. let offset: usize =
  351. rand::thread_rng().gen_range(0..=((max - min) / step) as usize);
  352. let value: f64 = min + step * offset as f64;
  353. debug!("Randomizing power for pen #{} to {}", index, value);
  354. setting.power = Some(value);
  355. }
  356. if let Some((min, max, step)) = self.frequency {
  357. let offset: usize =
  358. rand::thread_rng().gen_range(0..=((max - min) / step) as usize);
  359. let value: u32 = min + step * offset as u32;
  360. debug!("Randomizing frequency for pen #{} to {}", index, value);
  361. setting.frequency = Some(value);
  362. }
  363. if let Some((min, max, step)) = self.pulse_width {
  364. let mut pw = PulseWidth::iter();
  365. let mut values: Vec<PulseWidth> = vec![pw.find(|x| *x == min).unwrap()];
  366. values.extend(
  367. pw.skip(step - 1)
  368. .step_by(step)
  369. .take_while_inclusive(|x| *x != max)
  370. .collect_vec(),
  371. );
  372. let width: &PulseWidth = values
  373. .choose_multiple(&mut rand::thread_rng(), 1)
  374. .next()
  375. .unwrap();
  376. let value: u32 = (*width).into();
  377. debug!("Randomizing pulse width for pen #{} to {}", index, value);
  378. setting.pulse_width = Some(*width);
  379. }
  380. if !generated.contains(&setting) {
  381. generated.push(setting);
  382. setting.apply(pen);
  383. if !pen.valid_settings() {
  384. debug!("Retrying..");
  385. } else {
  386. break;
  387. }
  388. } else {
  389. debug!("Duplicate random setting");
  390. }
  391. if attempt == MAX_ATTEMPTS {
  392. panic!(
  393. "Exceeded maximum number of {} randommization attempts",
  394. MAX_ATTEMPTS
  395. );
  396. }
  397. }
  398. pen.valid_settings();
  399. }
  400. }
  401. }
  402. #[derive(Debug, Serialize, Deserialize)]
  403. #[serde(rename_all = "PascalCase")]
  404. pub struct ImportExportPen {
  405. index: usize,
  406. path: PathBuf,
  407. }
  408. impl ImportExportPen {
  409. pub fn export(&self, pens: &mut Vec<Pen>) {
  410. debug!(
  411. "Exporting pen #{} to '{}'",
  412. self.index,
  413. self.path.to_string_lossy()
  414. );
  415. let pen = pens.get(self.index).expect("Invalid pen index");
  416. pen.write_to_file(&self.path);
  417. }
  418. pub fn import(&self, pens: &mut Vec<Pen>) {
  419. debug!(
  420. "Importing pen #{} from '{}'",
  421. self.index,
  422. self.path.to_string_lossy()
  423. );
  424. let pen: Pen = Pen::read_from_file(&self.path);
  425. let dst: &mut Pen = pens.get_mut(self.index).expect("Invalid pen index");
  426. *dst = pen;
  427. }
  428. }