Skip to content

Latest commit

 

History

History
121 lines (109 loc) · 5.61 KB

RELEASE_NOTES.md

File metadata and controls

121 lines (109 loc) · 5.61 KB
Raw

Release Notes

0.2.1 (2023-03-23)

  • CLI
    • Updated the default command (m8) to now print an M8 file (also shows up as the 'view' command) (Issue #5)

0.2.0 (2023-03-23)

  • API
    • Added lib/types/M8File for all M8 types that correspond to an M8 file
    • Added lib/types/Serializable for all M8 types that should support importing/exporting to supported non-byte formats (and other formats)
    • All classes now have their own file
      • All internal types, (not associated with an M8 file type) have been put into lib/types/internal
      • All instrument types have been moved to lib/types/instruments
    • Cleaned up code for consistency
    • Converted the RGB values for each Theme color to be an actual type (lib/types/internal/RGB)
    • Refactored all instrument types:
      • env has been renamed to envelopes
      • lfo has been renamed to lfos
      • tableData has been renamed to table
    • Refactored SongStep.tracks{1-8} to be SongStep.tracks[8]
    • Refactored TableStep.fx{1-3} to be TableStep.fx[3]
    • Refactored instruments:
      • Removed lib/types/Instrument and moved each Instrument type into its own file in lib/types/instruments
      • Renamed env to envelopes
      • Renamed lfo to lfos
      • Renamed tableData to table
    • Refactored lib/types/internal/FX:
      • commandToStr now takes an instrument instead of its kind
    • Refactored lib/types/internal/MIDIMapping:
      • typeToChar is now typeToStr
    • Removed dependence upon Buffer and all APIs taking/returning a Buffer now take/return an Array<Number>
    • Removed lib/types/M8FileWriter.js (no longer provided value)
    • Updated all types to support JSON import/export (asObject and fromObject)
  • CLI
    • Added export and import commands to export to JSON and import from JSON (Issue #4)
    • Fix alignment for project mixer
    • Refactored the CLI into smaller, per-command files instead of one guargantuan file
    • Updated project midi-mapping to print the actual DEST values

v0.1.0 (2022-10-04)

  • API
    • Added helper methods to index.js for reading M8 files/types
      • loadInstrument
      • loadScale
      • loadSong
      • loadTable
      • loadTheme
    • Added helper methods to index.js for writing M8 files/types
      • dumpInstrument (Can be called with the M8FileReader used to read the Instrument to use the original values for skipped/unused bytes)
      • dumpScale
      • dumpSong (Can be called with the M8FileReader used to read the Song to use the original values for skipped/unused bytes)
      • dumpTheme
    • Added support for reading table data from an Instrument file
    • Added M8FileWriter to lib/types/
    • Moved M8FileReader from index.js to lib/types/
    • Moved all classes from lib/types.js to lib/types/ into their own files
      • lib/types/Chain.js
      • lib/types/FX.js
      • lib/types/Groove.js
      • lib/types/Instrument.js
      • lib/types/M8FileReader.js
      • lib/types/M8Version.js
      • lib/types/Phrase.js
      • lib/types/Scale.js
      • lib/types/Song.js
      • lib/types/Table.js
      • lib/types/Theme.js
    • Moved logic for sanitizing a Sampler instrument's path from lib/cli.js to lib/types/Instrument.SamplerParameters#samplePathToStr
    • Replaced readUInt8 with read for lib/types/M8FileReader.js
    • Updated lib/types/Instrument.js to exports instrument-specific types
      • FMSynth
      • Macrosynth
      • MIDIOut
      • None
      • Sampler
      • Wavsynth
    • Updated loadM8File to use M8FileReader instead of a file path
    • Updated all class constructors to initialize themselves using the default values M8 would use
    • Updated Song to default to the appropriate Scale objects
    • Updated the M8FileReader constructor to use a Buffer instead of a file path
    • Various refactorings that are too numerous to mention
  • CLI
    • Added instrument table command
    • Added instrument version command
    • Added scale version command
    • Added song phrase-at command (same as song phrase but it finds the phrase based on track/chain location so that it can resolve the "previous instrument" for commands)
    • Added theme version command
    • Fixed column alignment for instrument view and song instrument commands for empty FMSYNTH operators
    • Fixed column alignment for project effects command
    • Fixed column alignment for song table command
    • Fixed issue where booleans were being used for transports in project midi-settings
    • Fixed issue where columns were missing for song groove
    • Fixed issue where printing a MIDI OUT instrument would print BANK:PG empty values
    • Fixed issue where printing FX commands fails when relying on knowing the last instrument
    • Fixed issue where the --starting-row option was printed by mistake for project midi-mapping

v0.0.3 (2022-08-03)

  • API
    • Renamed getWaveStr in FMSynthParameters to getOscShapeStr
  • CLI
    • Added preview support for theme view
    • Added support for M8 firmwares 2.7.0 through 2.7.6 (2.7.6 is the latest releast at this time, newer versions will work assuming no breaking changes)

v0.0.2 (2022-29-07)

  • Added scale view to the CLI
  • Added song instrument to the CLI
  • Added theme view to the CLI
  • Added Theme support to the API
  • Added Theme support to the CLI
  • Renamed project details to project view in the CLI
  • Removed instrument table from the CLI
  • Updated instrument envelope and instrument view to work with M8 Instrument files

v0.0.1 (2022-27-07)

  • Initial code drop that provides all known M8 views via the CLI and initial API representation