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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
use super::*; use std::convert::TryFrom; use std::fmt::{self, Debug, Display}; use std::num::TryFromIntError; use std::str; /// Pattern /// /// Each pattern is represented by a table, consisting of rows (time) and columns (simultaneously /// playing channels). Patterns contain note data for triggering samples (instruments), but they /// can also contain effect commands that change global, local or channel-local playback /// parameters. /// /// Patterns are stored as a list of [`Row`]s. /// /// **This API will change in the future because it doesn't impose the invariant that /// `active_channels` and `rows` stay in sync.** #[derive(Clone, Debug)] pub struct Pattern { /// Active channels /// /// Channel is active if it contains any command in any row of the pattern. Currently skipping /// rows with effects is not accounted for. pub active_channels: ActiveChannels, /// Pattern rows pub rows: Vec<Row>, } /// Pattern row /// /// Row is represented by a sparse vector. It can be iterated or indexed by a [`Channel`]. #[derive(Clone)] pub struct Row { map: Vec<(Channel, Command)>, } /// Pattern command /// /// Command is one cell on the pattern table. #[derive(Clone, Debug)] pub struct Command { pub note: Option<NoteCmd>, pub instrument: Option<InstrumentId>, pub volume: Option<VolumeCmd>, pub effect: Option<EffectCmd>, } /// Note column commands #[derive(Clone, Copy, Debug)] pub enum NoteCmd { Play(Note), Off, Cut, Fade, } /// Note pitch representation /// /// Ranges from C-0 to B-9, only exact pitches can be represented. #[derive(Clone, Copy)] pub struct Note(u8); /// Volume column commands /// /// All parameters are displayed in **decimal**. #[derive(Clone, Copy, Debug)] pub enum VolumeCmd { /// `vxx` Set volume /// /// Sets the current note volume to `xx`. SetVolume(RangedU8<0, 64>), /// `pxx` Set panning /// /// Sets the current channel's panning possition to `xx`. Panning(RangedU8<0, 64>), /// `a0x` Fine volume slide up /// /// Functions like `DxF` ([`VolumeSlide::FineUp`]]). /// /// Slides the volume up `x` units on the first tick. /// /// `None` uses the last value, memory is shared with all `Dxy` commands. FineVolumeUp(Option<RangedU8<1, 9>>), /// `b0x` Fine volume slide down /// /// Functions like `DFy` ([`VolumeSlide::FineDown`]]). /// /// Slides the volume down `x` units on the first tick. /// /// `None` uses the last value, memory is shared with all `Dxy` commands. FineVolumeDown(Option<RangedU8<1, 9>>), /// `c0x` Volume slide up /// /// Functions like `Dx0` ([`VolumeSlide::Up`]). /// /// Slides the volume up `x` units on all ticks except the first. /// /// `None` uses the last value, memory is shared with all `Dxy` commands. VolumeSlideUp(Option<RangedU8<1, 9>>), /// `d0x` Volume slide down /// /// Functions like `D0y` ([`VolumeSlide::Down`]). /// /// Slides the volume down `x` units on all ticks except the first. /// /// `None` uses the last value, memory is shared with all `Dxy` commands. VolumeSlideDown(Option<RangedU8<1, 9>>), /// `e0x` Portamento down /// /// Similar to `Exx` ([`EffectCmd::PortamentoDown`]). /// /// Compared to `Exx`, parameters are 4 times more coarse (e.g. `e01 == E04`). /// /// `None` uses the last value, memory is shared with `Exx`. PortamentoDown(Option<RangedU8<1, 9>>), /// `f0x` Portamento up /// /// Similar to `Fxx`. /// /// Compared to `Fxx`, parameters are 4 times more coarse (e.g. `f01 == F04`). /// /// `None` uses the last value, memory is shared with `Fxx`. PortamentoUp(Option<RangedU8<1, 9>>), /// `g0x` Portamento to next note speed /// /// Similar to `Gxx`. /// /// The paramets of `g0x` are mapped to paramets of `Gxx` using the following table. /// `0` and `00` are represented with `None`. /// ```txt /// g0x Gxx g0x Gxx /// 0 00 5 20 /// 1 01 6 40 /// 2 04 7 60 /// 3 08 8 80 /// 4 10 9 FF /// ``` /// /// `None` uses the last value. // TODO is memory is shared with `Gxx`? TonePortamento(Option<RangedU8<1, 9>>), /// `h0x` Vibrato depth /// /// Executes a vibrato with depth `x` and speed from the last `Hxy` or `Uxy` command. /// /// `None` uses the last value, memory is shared with `Hxy` and `Uxy`. Vibrato(Option<RangedU8<1, 9>>), } /// Effect column commands /// /// All parameters are displayed in **hexadecimal**. /// /// Parameters are parsed by nibbles and masks on them. Each command has one byte of parameter data /// to work with. `Axx` means the command `A` uses the whole byte as its argument, `Hxy` means the /// command `H` uses the first nibble as parameter `x` and second nibble as parameter `y`. /// /// Some commands like `D` use masks to further granularize the command, however some commands only /// use a subset of the values `u8` can have. /// /// The parser should be handling of out-of-range values by canonicalizing them into some in range /// value and this behaviour should be documented for each value in a "Canonicalization" section. /// Parser should never crash because of an out-of-range value and the representation should not /// allow for out-of-range values to get through. /// /// ## Additional resources /// - <https://wiki.openmpt.org/Manual:_Effect_Reference> /// - <https://modarchive.org/forums/index.php?topic=2222.0> // Documentation for these is adapted from the Schism Tracker help text and OpenMPT wiki. #[derive(Clone, Copy, Debug, PartialEq)] pub enum EffectCmd { /// `Axx` Set Speed /// /// Sets the module Speed (ticks per row). /// /// ## Canonicalization /// The value `0` does nothing so the effect command get skipped by the parser. SetSpeed(RangedU8<1, 255>), /// `Bxx` Jump to Order /// /// Causes playback to jump to pattern position `xx`. /// /// `B00` would restart a song from the beginning (first pattern in the Order List). /// /// If `Cxx` is on the same row, the pattern specified by `Bxx` will be /// the pattern `Cxx` jumps into. JumpOrder(u8), /// `Cxx` Break to row `xx` of next pattern /// /// Jumps to row `xx` of the next pattern in the Order List. /// /// If the current pattern is the last pattern in the Order List, `Cxx` will jump to row `xx` /// of the first pattern. /// /// If `Bxx` is on the same row, the pattern specified by `Bxx` will be /// the pattern `Cxx` jumps into. /// /// Ranges from `0x00` to the next pattern's row length, higher values are to be treated as `0x00`. BreakRow(u8), /// `Dxx` Volume Slide or Fine Volume Slide /// /// Slides the current volume up or down. /// /// `None` uses the last value, memory is shared with `Hxy` and `Uxy`. VolumeSlide(Option<VolumeSlide>), /// `Exx` Portamento down /// /// See [`Portamento`] for more details. /// /// `None` uses the last value, memory is shared with the `e0x` volume command. PortamentoDown(Option<Portamento>), /// `Fxx` Portamento up /// /// See [`Portamento`] for more details. /// /// `None` uses the last value, memory is shared with the `f0x` volume command. PortamentoUp(Option<Portamento>), /// `Gxx` Slide to note with speed `xx` /// /// Slides the pitch of the previous note towards the current note by `xx` units on every tick /// of the row except the first. /// /// Slide can be either smooth or semitone-wise, see [`Special::SetGlissando`] for details. /// /// `None` uses the last value. // TODO describe frequency units TonePortamento(Option<RangedU8<1, 0xFF>>), /// `Hxy` Vibrato with speed `x`, depth `y` /// /// Executes vibrato with speed `x` and depth `y` on the current note. /// /// Modulates with selected vibrato waveform [`Special::SetVibratoWaveform`]. /// /// `None` uses the last value, each parameter has its separate memory. /// Memory is shared with `Uxy`. Vibrato(Option<RangedU8<1, 0x0F>>, Option<RangedU8<1, 0x0F>>), /// `Ixy` Tremor with ontime `x` and offtime `y` /// /// `None` uses the last value. Tremor(Option<(RangedU8<1, 0x0F>, RangedU8<1, 0x0F>)>), /// `Jxy` Arpeggio with halftones `x` and `y` /// /// Plays an arpeggiation of three notes in one row, cycling between the current note, current /// note + `x` semitones, and current note + `y` semitones. /// /// `None` uses the last value. Currently `None` gets parsed only if both parameters are 0. /// Serialization is not implemented yet and this type will very likely change before it is. /// For more information see the notes below. /// /// ## Notes /// /// We remember reading somewhere (even the code had it that way) that the arpeggiation was /// only between two notes if `x == y`. Now we can't find it either on the OpenMPT wiki Effect /// Reference page, nor in OpenMPT or Schism Tracker source code. This might be just /// misremembering but we'll be leaving this note here for now in case somebody finds somewhere /// mentioning that thing. Sorry. /// /// Ok! We found something. In OpenMPT (master, rev `70efda227`) /// file `soundlib/Sndmix.cpp`, function `CSoundFile::ProcessArpeggio` ([link]): /// /// [link]: https://github.com/OpenMPT/openmpt/blob/70efda227f77485ec595aff8246cbc9a37f0b539/soundlib/Sndmix.cpp#L1444-L1465 /// /// ```c /// // Trigger new note: /// // - If there's an arpeggio on this row and /// // - the note to trigger is not the same as the previous arpeggio note or /// // - a pattern note has just been triggered on this tick /// // - If there's no arpeggio /// // - but an arpeggio note is still active and /// // - there's no note stop or new note that would stop it anyway /// if((arpOnRow && chn.nArpeggioLastNote != chn.nArpeggioBaseNote + step && (!m_SongFlags[SONG_FIRSTTICK] || !chn.rowCommand.IsNote())) /// || (!arpOnRow && chn.rowCommand.note == NOTE_NONE && chn.nArpeggioLastNote != NOTE_NONE)) /// SendMIDINote(nChn, chn.nArpeggioBaseNote + step, static_cast<uint16>(chn.nVolume)); /// // Stop note: /// // - If some arpeggio note is still registered or /// // - When starting an arpeggio on a row with no other note on it, stop some possibly still playing note. /// if(chn.nArpeggioLastNote != NOTE_NONE) /// SendMIDINote(nChn, chn.nArpeggioLastNote + NOTE_MAX_SPECIAL, 0); /// else if(arpOnRow && m_SongFlags[SONG_FIRSTTICK] && !chn.rowCommand.IsNote() && ModCommand::IsNote(lastNote)) /// SendMIDINote(nChn, lastNote + NOTE_MAX_SPECIAL, 0); /// /// if(chn.rowCommand.command == CMD_ARPEGGIO) /// chn.nArpeggioLastNote = chn.nArpeggioBaseNote + step; /// else /// chn.nArpeggioLastNote = NOTE_NONE; /// ``` /// /// If we read this correctly it means arpeggio can have either `None` (reuse last effect) or /// can make 0, 1 or 2 retriggers, or even act like a note cut if the command doesn't have any /// base note. // TODO Use the proper types here, it is probably going to be an // `Option<ArrayVec<[RangedU8<0, 0x0F>; 2]>>`. Arpeggio(Option<(RangedU8<0, 0x0F>, RangedU8<0, 0x0F>)>), /// `Kxy` Dual Command: `H00` & `Dxy` /// /// Functions like `Dxy` with `H00`. Parameters are used the same way as `Dxy`. /// /// `None` uses the last value. // TODO Is the memory shared with `Dxy` or not? VolumeSlideAndVibrato(Option<VolumeSlide>), /// `Lxx` Dual Command: `G00` & `Dxy` /// /// Functions like `Dxy` with `G00`. Parameters are used the same way as `Dxy`. /// /// `None` uses the last value. // TODO Is the memory shared with `Dxy` or not? VolumeSlideAndPortamento(Option<VolumeSlide>), /// `Mxx` Set channel volume to `xx` /// /// Sets the current channel volume, which multiplies all note volumes it encompasses. /// /// ## Canonicalization /// All values above `0x40` are clipped to `0x40`. SetChannelVolume(RangedU8<0, 0x40>), /// `Nxy` Channel volume slide /// /// Similar to `Dxy`, but applies to the current channel's volume. /// /// `None` uses the last value. ChannelVolumeSlide(Option<VolumeSlide>), /// `Oxx` Set sample offset to `0xyxx00`, `SAy` Set high value of sample offset `0xyxx00` /// /// See [`SetSampleOffset`] for more details. SetSampleOffset(SetSampleOffset), /// `Pxx` Panning slide /// /// See [`PanningSlide`] for more details. /// /// `None` uses the last value. PanningSlide(Option<PanningSlide>), /// `Qxy` Retrigger note every `y` ticks with volume modifier `x` /// /// Values for `x`: /// ```txt /// 0: No volume change 8: Not used /// 1: -1 9: +1 /// 2: -2 A: +2 /// 3: -4 B: +4 /// 4: -8 C: +8 /// 5: -16 D: +16 /// 6: *2/3 E: *3/2 /// 7: *1/2 F: *2 /// ``` /// /// `None` uses the last value. /// /// ## Canonicalization /// Value `8` is replaced by `0` during parsing. // TODO Find a reasonable way to express the disjoint interval for `x` in the type. Retrigger(Option<(RangedU8<1, 0x0F>, RangedU8<1, 0x0F>)>), /// `Rxy` Tremolo with speed `x`, depth `y` /// /// Executes tremolo weith speed `x` and depth `y` on the current note. /// /// Modulates with selected tremolo waveform [`Special::SetTremoloWaveform`]. /// /// `None` uses the last value, each parameter has its separate memory. /// Memory is shared with `Uxy`. Tremolo(Option<RangedU8<1, 0x0F>>, Option<RangedU8<1, 0x0F>>), /// `Sxx` Special commands /// /// `None` uses the last value, memory is shared by all `Sxx` subcommands. /// /// ## Canonicalization /// The second nibble is ignored when parsing the special subcommand, any value in range /// `S00..=S0F` will be parsed as `None`, but it will only be serialized as `S00`. Special(Option<Special>), /// `Txx` Change tempo /// /// See [`Tempo`] for more details. /// /// `None` uses last value. Tempo(Option<Tempo>), /// `Uxy` Fine vibrato with speed `x`, depth `y` /// /// Similar to `Hxy`, but with 4 times the precision. /// /// See [`EffectCmd::Vibrato`] for more details. /// /// `None` uses the last value, each parameter has its separate memory. /// Memory is shared with `Hxy`. FineVibrato(Option<RangedU8<1, 0x0F>>, Option<RangedU8<1, 0x0F>>), /// `Vxx` Set global volume to `xx` /// /// ## Canonicalization /// All values above `0x80` are clipped to `0x80`. SetGlobalVolume(RangedU8<0, 0x80>), /// `Wxx` Global volume slide /// /// Similar to `Dxy`, but applies to global volume. /// /// `None` uses the last value. GlobalVolumeSlide(Option<VolumeSlide>), /// `Xxx` Set panning position /// /// Sets the current channel's panning position. /// /// Ranges from `0x00` (left) to `0xFF` (right). // TODO What is the center position? Can we be panned more to one side than the other? Ugh... // Schism Tracker has 0-256 in their comment, that's either an non-inclusive range or // there is something funky going on (they store the value in an `int32_t` so 256 fits). SetPanningPosition(u8), /// `Yxy` Panbrello with speed `x`, depth `y` /// /// Executes panbrello with speed `x` and depth `y` on the current note. /// /// Modulates with selected panbrello waveform [`Special::SetPanbrelloWaveform`]. /// /// `None` uses the last value, each parameter has its separate memory. /// Memory is shared with `Uxy`. Panbrello(Option<RangedU8<1, 0x0F>>, Option<RangedU8<1, 0x0F>>), /// `Zxx` MIDI Macros /// /// Executes a MIDI macro. /// /// This effect is rather complicated so we don't attempt to parse it any further. For more /// information see the [OpenMPT wiki article](https://wiki.openmpt.org/Manual:_Zxx_Macros). MIDI(u8), } /// Effect category /// /// OpenMPT categorizes effects into groups which are then used in the UI for color highlighting. /// These don't have any effect on parsing and are purely determined from the effect code. /// /// Categorization is taken from OpenMPT wiki. #[derive(Clone, Copy, Debug, PartialEq)] pub enum EffectCategory { GlobalTiming, GlobalPattern, Volume, Pitch, Panning, Misc, } /// Effects `Dxx`, `Kxx`, `Lxx`, `Nxx`, `Wxx` /// /// All of these commands perform a volume slide but on different mixers. /// /// - `Dxx`, `Kxx`, `Lxx` - note volume slide /// - `Nxx` - channel volume slide /// - `Wxx` - global volume slide /// /// ## Canonicalization /// Values where both nibbles are in `1..=0xE` at the same time don't have a defined meaning, these /// get skipped by the parser. // TODO describe volume slide units #[derive(Clone, Copy, Debug, PartialEq)] pub enum VolumeSlide { /// `D0x`, `K0x`, `L0x`, `N0x`, `W0x` Volume slide down by `x` /// /// Decreases mixer volume by `x` units on every tick of the row except the first. /// If `x` is `0xF`, volume decreases on every tick (including the first). Down(RangedU8<1, 0x0F>), /// `Dx0`, `Kx0`, `Lx0`, `Nx0`, `Wx0` Volume slide up by `x` /// /// Increases mixer volume by `x` units on every tick of the row except the first. /// Volume will not exceed `0x40`. Up(RangedU8<1, 0x0F>), /// `DFx`, `KFx`, `LFx`, `NFx`, `WFx` Fine volume slide down by `x` /// /// Finely decreases mixer volume by only applying `x` units on the first tick of the row. FineDown(RangedU8<1, 0x0E>), /// `DxF`, `KxF`, `LxF`, `NxF`, `WxF` Fine volume slide up by `x` /// /// Finely increases mixer volume by only applying `x` units on the first tick of the row. /// /// OpenMPT documents that this value cannot be `0xF` however both OpenMPT and Schism Tracker /// parse it this way so we allow it too. FineUp(RangedU8<1, 0x0F>), } /// Effects `Exx`, `Fxx` /// /// Portamento down or up in coarse, fine or extra fine steps. /// /// Slide can be either smooth or semitone-wise, see [`Special::SetGlissando`] for details. // TODO describe frequency units #[derive(Clone, Copy, Debug, PartialEq)] pub enum Portamento { /// `Exx`, `Fxx` Pitch slide down/up by `xx` /// /// Decreases/increases current note pitch by `xx` units on every tick of the row except the /// first. // 0xDF is the highest parameter value not matched by the following two effects, therefore we // assume it's divided up into ranges. Coarse(RangedU8<1, 0xDF>), /// `EFx`, `FFx` Fine pitch slide down/up by `x` /// /// Finely decreases/increases note pitch by only applying `x` units on the first tick of the /// row. Fine(RangedU8<0, 0x0F>), /// `EEx`, `FEx` Extra fine pitch slide down/up by `x` /// /// Extra-finely decreases/increases note pitch by applying with 4 times the precision of /// `EFx`/`FFx` ([`Portamento::Fine`]). ExtraFine(RangedU8<0, 0x0F>), } /// Effects `Oxx` and `SAy` combined /// /// The offset into the sample is represented in the number of samples, in hexadecimal `0xyxx00`, /// where `y` is configured by [`SetSampleOffset::High`] and `xx` by [`SetSampleOffset::Low`]. /// /// We're not going to be handling memory with `Option`s the type system like with other commands /// here because the handling is a bit inconsistent. /// /// Recalling of the `High` part can be done using [`EffectCmd::Set(None)`] if it was the /// previously used `Sxx` command. /// /// Recalling of the `Low` part can be done with `EffectCmd::Offset(SetSampleOffset::Low(0x0))` /// this makes it impossible to use an offset of for example `O00` + `SA1` (`0x10000`), which the /// OpenMPT GUI happily hints at but then it doesn't actually work in the player. `O00` does recall /// the last value and it's weirdly stateful in that even if you remove all the other instances of /// `SAy` and `Oxx` and play the pattern from the beginning it seems to remember the last offset. /// /// We leave this encoded as a full range `u8` and don't treat the zero specially. #[derive(Clone, Copy, Debug, PartialEq)] pub enum SetSampleOffset { Low(u8), High(RangedU8<0, 0x0F>), } /// Effect `Pxx` Panning slide /// /// Slides the current channel's panning position left or right. /// /// ## Canonicalization /// Values where both nibbles are in `1..=0xE` at the same time don't have a defined meaning, these /// get skipped by the parser. #[derive(Clone, Copy, Debug, PartialEq)] pub enum PanningSlide { /// `P0x` Panning slide to right by `x` Right(RangedU8<1, 0x0F>), /// `Px0` Panning slide to left by `x` Left(RangedU8<1, 0x0F>), /// `PFx` Fine panning slide to right by `x` FineRight(RangedU8<1, 0x0F>), /// `PxF` Fine panning slide to left by `x` FineLeft(RangedU8<1, 0x0F>), } /// Effect `Sxx` Special commands /// /// `SAy` is represented using [`SetSampleOffset::High`] in Rust. /// /// All the `Sxx` commands share the same memory, this should include the `SAy` command. #[derive(Clone, Copy, Debug, PartialEq)] pub enum Special { // Schism Tracker and OpenMPT (IT Effects) documentation disagree on this one. OpenMPT says // `S00` recalls `Sxx` command memory but Schism Tracker says `S0x` sets filter, it is marked // in red which probably means we don't need to worry about it, at least for now. // // /// `S0x` Set filter // Filter(RangedU8<1, 0x0F>), /// `S1x` Set glissando on/off /// /// Configures whether tone portamento effects slide by semitones or smoothly. /// - `S10` *disables* glissando, portamento slides smoothly. /// - `S11` *enables* glissando, portamento behaves like glissando and snaps to semitones. /// /// ## Canonicalization /// When the value `y` is more than `1` it gets converted to `true`. SetGlissando(bool), /// `S2x` Set finetune /// /// *Considered a legacy command.* /// /// Overrides the current sample's C-5 frequency with a MOD finetune value. /// /// TODO link to _what is_ MOD finetune value SetFinetune(RangedU8<0, 0x0F>), /// `S3x` Set vibrato waveform to type `x` /// /// Sets the waveform of future [`Vibrato`](EffectCmd::Vibrato) effects. SetVibratoWaveform(Waveform), /// `S4x` Set tremolo waveform to type `x` /// /// Sets the waveform of future [`Tremolo`](EffectCmd::Tremolo) effects. SetTremoloWaveform(Waveform), /// `S5x` Set panbrello waveform to type `x` /// /// Sets the waveform of future [`Panbrello`](EffectCmd::Panbrello) effects. SetPanbrelloWaveform(Waveform), /// `S6x` Pattern delay for `x` ticks /// /// Extends the current row by `x` ticks. If multiple `S6x` commands are on the same row, the /// sum of their parameters is used. PatternTickDelay(RangedU8<0, 0x0F>), /// `S70`, `S71`, `S72` Past note cut, off or fade PastNote(SetPastNote), /// `S73`, `S74`, `S75`, `S76` - Set NNA to note cut, continue, off or fade SetNewNoteAction(SetNewNoteAction), /// `S77`, `S78` Turn off/on volume envelope SetVolumeEnvelope(bool), /// `S79`, `S7A` Turn off/on panning envelope SetPanningEnvelope(bool), /// `S7B`, `S7C` Turn off/on pitch envelope SetPitchEnvelope(bool), /// `S8x` Set panning position to `x` SetPanning(RangedU8<0, 0x0F>), /// `S90`, `S91` Turn off/on surround sound /// /// Only `S91` (`Set::Surround(true)`) is supported in the original Impulse Tracker, /// other `S9x` commands are MPTM extensions. SetSurround(bool), /// `S98`, `S99` Turn off/on reverb /// /// *MPTM extension* SetReverb(bool), // Collides with `Set::Reverb(true)`, this is from the Schism Tracker help but is listed // in red and marked as not implemented. // // /// `S99` Toggle duck modulator // ToggleDuckModulator, /// `S9A`, `S9B` Set Surround mode to Center or Quad /// /// *MPTM extension* SetSurroundMode(SurroundMode), /// `S9C`, `S9D` Set filter mode to Global or Local /// /// *MPTM extension* SetFilterMode(FilterMode), /// `S9E`, `S9F` Play Forward or Backward /// /// *MPTM extension* SetDirection(PlayDirection), // SAy is handled by [`SetSampleOffset`] together with the Oxx command. /// `SB0` Set loopback point SetLoopbackPoint, /// `SBx` Loop `x` times to loopback point LoopbackTimes(RangedU8<0x01, 0x0F>), /// `SCx` Note cut after `x` ticks NoteCut(RangedU8<0, 0x0F>), /// `SDx` Note delay for `x` ticks NoteDelay(RangedU8<0, 0x0F>), /// `SEx` Pattern delay for `x` rows PatternRowDelay(RangedU8<0, 0x0F>), /// `SFx` Set parameterised MIDI Macro SetMIDIParam(RangedU8<0, 0x0F>), } /// Oscillator waveforms for commands `S3x`, `S4x` and `S5x` /// /// IT retriggers the waveforms for each note - they start playing from their starting point when a /// new note is played. /// /// Every oscillator waveform is 64 points long, and the speed parameter denotes by how many points /// per tick the play position is advanced. So at a vibrato speed of 2, the vibrato waveform /// repeats after 32 ticks. /// /// ## Canonicalization /// The valid values for waveforms are `0..=3`, all out-of-range values are parsed as `3`. #[derive(Clone, Copy, Debug, PartialEq)] pub enum Waveform { /// Sine wave `0` Sine, /// Sawtooth (ramp-down) wave `1` Sawtooth, /// Square wave `2` Square, /// White noise `3` Random, } #[derive(Clone, Copy, Debug, PartialEq)] pub enum SetPastNote { Cut, Off, Fade, } #[derive(Clone, Copy, Debug, PartialEq)] pub enum SetNewNoteAction { Cut, Off, Fade, Continue, } #[derive(Clone, Copy, Debug, PartialEq)] pub enum SurroundMode { /// `S9A` Sets the surround mode to Center Surround for all channels. /// /// This is the default mode. The `S91` command will place the channel in the center of /// the rear channels. Any panning command will bring it back to the front channels. Center, /// `S9B` Sets the surround mode to Quad Surround for all channels. /// /// In this mode, panning commands can adjust the position of the rear channels. Switching /// between the front and rear channels can only be done by using the `S91` and `S90` commands. Quad, } #[derive(Clone, Copy, Debug, PartialEq)] pub enum FilterMode { /// `S9C` Sets filter mode to Global on all channels (Impulse Tracker behaviour). /// /// In this mode, when resonant filters are enabled with a `Zxx` effect, they will stay active /// until explicitly disabled by setting the cutoff frequency to the maximum (`Z7F`), and the /// resonance to the minimum (`Z80`). Global, /// `S9D` Sets filter mode to Local on all channels. /// /// In this mode, the resonant filter will only affect the current note and will revert when /// a new note is played. Local, } #[derive(Clone, Copy, Debug, PartialEq)] pub enum PlayDirection { /// `S9E` Forces the current sample to play forward. Forward, /// `S9F` Forces the current sample to play backward. Backward, } /// Effect `Txx` Change tempo /// /// OpenMPT documents only the `Set` variant. Schism Tracker sets tempo on the first tick of the /// row if it got the `Set` variant, or increases/decreases the tempo on every other tick of the /// row by `x` and clipping it to `0x20..=0xFF`. /// /// ## Canonicalization /// `0x00` is used for memory and parses as `None`, but `0x10` would increase tempo by 0 which is /// useless so the parser just skips the effect. #[derive(Clone, Copy, Debug, PartialEq)] pub enum Tempo { /// `T0x` Tempo slide down by `x` SlideDown(RangedU8<1, 0x0F>), /// `T1x` Tempo slide up by `x` SlideUp(RangedU8<1, 0x0F>), /// `Txx` Set Tempo to `xx` Set(RangedU8<0x20, 0xFF>), } impl Row { /// Create new empty row pub const fn empty() -> Row { Row { map: Vec::new() } } pub(crate) fn from_vec(mut vec: Vec<(Channel, Command)>) -> Row { vec.sort_unstable_by_key(|(chan, _)| *chan); Row { map: vec } } pub fn iter(&self) -> impl Iterator<Item=(Channel, &Command)> + '_ { self.map .iter() .map(|(chan, command)| (*chan, command)) } } impl Debug for Row { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_map() .entries( self.map .iter() .map(|pair| (&pair.0, &pair.1)) ) .finish() } } impl Get<Channel> for Row { type Output = Command; fn get(&self, index: Channel) -> Option<&Self::Output> { self.map .binary_search_by_key(&index, |(chan, _)| *chan) .ok() .map(|idx| &self.map[idx].1) } } impl_index_from_get!(Row, Channel); impl TryFrom<u8> for Note { type Error = TryFromIntError; fn try_from(raw: u8) -> Result<Self, Self::Error> { if (0..=119).contains(&raw) { Ok(Note(raw)) } else { // There is no public constructor for `TryFromIntError` so we obtain it through a // definitely-out-of-range cast ... :/ // // TODO make a custom error for the ranged integers and replace this nonsense. Err(u8::try_from(u16::MAX).unwrap_err()) } } } impl From<Note> for u8 { fn from(note: Note) -> u8 { note.0 } } /// Creates a formatted string for the note in the given buffer const fn note_string(Note(idx): Note, buf: &mut [u8; 3]) -> &str { if idx >= 120 { panic!("Note inner value is out of range of 0..=119"); } const NAMES: [&[u8; 2]; 12] = [b"C-", b"C#", b"D-", b"D#", b"E-", b"F-", b"F#", b"G-", b"G#", b"A-", b"A#", b"B-"]; let name = NAMES[(idx % 12) as usize]; let octave = b'0' + (idx / 12); buf[0] = name[0]; buf[1] = name[1]; buf[2] = octave; // SAFETY This function fills the buffer with valid UTF-8 itself. unsafe { str::from_utf8_unchecked(&*buf) } } impl Debug for Note { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut buf = [0; 3]; f.write_str(note_string(*self, &mut buf)) } } impl Display for Note { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut buf = [0; 3]; f.write_str(note_string(*self, &mut buf)) } } impl Note { /// Convert note into its frequency in A=440Hz tuning pub fn freq(&self) -> f32 { let (Note(idx), Note(base)) = (*self, Note::A_4); let exp = ((idx as f32) - (base as f32)) / 12.0f32; 440.0f32 * 2.0f32.powf(exp) } } /// Helper macro for defining all the notes as associated constants. macro_rules! define_notes { // "User" API ( $( $notes: ident ),* $(,)? ) => { #[allow(non_upper_case_globals)] impl Note { define_notes!( @(0) $( $notes, )* ); } }; // Base-case, empty list. ( @($_: expr) ) => {}; // Recursive-case, pops one note from the list and adds one to the accumulator expression. ( @($acc: expr) $note: ident, $( $notes: ident ),* $(,)? ) => { pub const $note: Note = Note($acc); define_notes!( @($acc + 1) $( $notes, )* ); }; } define_notes! { C_0, Cs0, D_0, Ds0, E_0, F_0, Fs0, G_0, Gs0, A_0, As0, B_0, C_1, Cs1, D_1, Ds1, E_1, F_1, Fs1, G_1, Gs1, A_1, As1, B_1, C_2, Cs2, D_2, Ds2, E_2, F_2, Fs2, G_2, Gs2, A_2, As2, B_2, C_3, Cs3, D_3, Ds3, E_3, F_3, Fs3, G_3, Gs3, A_3, As3, B_3, C_4, Cs4, D_4, Ds4, E_4, F_4, Fs4, G_4, Gs4, A_4, As4, B_4, C_5, Cs5, D_5, Ds5, E_5, F_5, Fs5, G_5, Gs5, A_5, As5, B_5, C_6, Cs6, D_6, Ds6, E_6, F_6, Fs6, G_6, Gs6, A_6, As6, B_6, C_7, Cs7, D_7, Ds7, E_7, F_7, Fs7, G_7, Gs7, A_7, As7, B_7, C_8, Cs8, D_8, Ds8, E_8, F_8, Fs8, G_8, Gs8, A_8, As8, B_8, C_9, Cs9, D_9, Ds9, E_9, F_9, Fs9, G_9, Gs9, A_9, As9, B_9, } impl VolumeCmd { pub fn category(&self) -> EffectCategory { match self { VolumeCmd::FineVolumeUp(_) | VolumeCmd::FineVolumeDown(_) | VolumeCmd::VolumeSlideUp(_) | VolumeCmd::VolumeSlideDown(_) | VolumeCmd::SetVolume(_) => EffectCategory::Volume, VolumeCmd::PortamentoDown(_) | VolumeCmd::PortamentoUp(_) | VolumeCmd::TonePortamento(_) | VolumeCmd::Vibrato(_) => EffectCategory::Pitch, VolumeCmd::Panning(_) => EffectCategory::Panning, } } } impl EffectCmd { pub fn category(&self) -> EffectCategory { match self { EffectCmd::SetSpeed(_) | EffectCmd::Tempo(_) => EffectCategory::GlobalTiming, EffectCmd::JumpOrder(_) | EffectCmd::BreakRow(_) | EffectCmd::Special(Some(Special::PatternTickDelay(_))) | EffectCmd::Special(Some(Special::SetLoopbackPoint)) | EffectCmd::Special(Some(Special::LoopbackTimes(_))) | EffectCmd::Special(Some(Special::PatternRowDelay(_))) => EffectCategory::GlobalPattern, EffectCmd::VolumeSlide(_) | EffectCmd::Tremor(_) | EffectCmd::SetChannelVolume(_) | EffectCmd::ChannelVolumeSlide(_) | EffectCmd::Tremolo(_, _) | EffectCmd::Special(Some(Special::SetTremoloWaveform(_))) | EffectCmd::SetGlobalVolume(_) | EffectCmd::GlobalVolumeSlide(_) => EffectCategory::Volume, EffectCmd::PortamentoDown(_) | EffectCmd::PortamentoUp(_) | EffectCmd::TonePortamento(_) | EffectCmd::Vibrato(_, _) | EffectCmd::Arpeggio(_) | EffectCmd::Special(Some(Special::SetGlissando(_))) | EffectCmd::Special(Some(Special::SetFinetune(_))) | EffectCmd::Special(Some(Special::SetVibratoWaveform(_))) | EffectCmd::Special(Some(Special::SetPanbrelloWaveform(_))) | EffectCmd::FineVibrato(_, _) => EffectCategory::Pitch, EffectCmd::PanningSlide(_) | EffectCmd::Special(Some(Special::SetPanning(_))) | EffectCmd::SetPanningPosition(_) | EffectCmd::Panbrello(_, _) => EffectCategory::Panning, _ => EffectCategory::Misc, } } }