jsxm
v1.0.1
Published
WebAudio FastTracker 2 .XM module player
Downloads
8
Readme
xm.js
FastTracker 2 .XM player, written for fun.
There is an XM player and a visualizer which are separate components. The player API looks like this:
XMPlayer.init
-> starts up audio context; it's available asXMPlayer.audioctx
XMPlayer.load(ArrayBuffer)
-> returnstrue
if loaded, otherwise barfs randomlyXMPlayer.play()
-> starts playingXMPlayer.pause()
-> obviousXMPlayer.stop()
-> obvious; call this before loading a new one
Loading trackview.js is optional; without it, the player won't do any visualizations. Or, you can override the following to get callbacks:
XMView.pushEvent(e)
-> push an audio event onto the queue. Called once per tick (about 50Hz, controlled by song).e
contains fields:t
- audio timestampvu
- Float32Array of RMS power (volume) for each channelscopes
- [Float32Array] of oscilloscope data, one array per channel;XMView.scope_width
contains # of samples to produce heresongpos
- position in the song (# patterns played)pat
- pattern number currently playingrow
- row within pattern
XMView.pause()
- pause visualizationXMView.stop()
- stop/reset visualization
The code which defines what the buttons do and downloads songs and so
forth is in shell.js
.
The player is fairly feature-complete, but is missing a bunch of effects.
MIT license.