libtrackerboy is a utility library used by trackerboy, a Game Boy tracker. This library provides the core functionality needed by the UI, and is also known as the backend.
Looking for trackerboy?
This library handles:
- Game Boy APU emulation and sound synthesis
- Manipulating module data
- Module playback and exports
- Reading/Writing module files
Usage
import libtrackerboy # import everything import libtrackerboy/[data, io] # import specific modules (Recommended)
Available modules
| Module | Description |
|---|---|
| apu | Game Boy APU emulation |
| apuio | APU I/O access, provides ApuIo concept |
| common | Common types/procs used throughout the library |
| data | Data model |
| editing | Utilities for editing pattern data |
| engine | Song playback, or driver implementation |
| io | Module serialization/deserialization |
| ir | Intermediate representation for import/export |
| notes | Note lookup procs, note values |
| version | Version type and consts |
Exporter modules
Modules that provide exporting to other formats are located in the exports subfolder, libtrackerboy/exports.
| Module | Description |
|---|---|
| wav | Wav file exporter |
Note:
Modules in the private folder (libtrackerboy/private) are private to the library and should not be imported by users of the library.
See also
Exports
-
runToFrame, Pcm, setFramerate, PositiveByte, readRegister, pansRight, isNil, channelMix, init, ByteIndex, channelFrequency, PcmF32, ==, MixMode, ==, setSamplerate, takeSamples, writeRegister, removeSamples, availableSamples, setBufferSize, Apu, channelVolume, reset, ChannelId, [], ==, time, Immutable, run, setVolume, toImmutable, pansLeft, [], Pcm, PositiveByte, pansRight, isNil, PcmF32, ByteIndex, ==, MixMode, ==, ChannelId, pansLeft, ==, toImmutable, Immutable, [], [], new, isValid, editTrack, new, viewPattern, PcmF32, toEffectType, ==, contains, SomeTable, TrackId, ModulePiece, Track, init, nextUnused, defaultSpeed, $, viewTrack, isValid, EffectIndex, getTickrate, items, new, remove, InstrumentTable, isEmpty, revisionMinor, defaultTrackSize, [], MixMode, data, ==, EffectType, WaveData, version, SomeData, add, insert, capacity, editPattern, ==, remove, defaultRpb, parseSequence, len, pansRight, items, init, setInstrument, init, [], ByteIndex, ==, Tickrate, setTrack, setEffectParam, [], unitSpeed, OrderId, OrderRow, Immutable, init, moveUp, Effect, ==, init, [], []=, [], estimateSpeed, new, duplicate, speedToFloat, defaultTickrate, setLen, len, setNote, TableId, [], queryNote, SequenceKind, [], tempo, patternLen, [], [], PositiveByte, data=, init, SongList, Speed, items, []=, data=, getRow, moveDown, init, OrderSize, getTrackView, Order, [], trackIds, totalRows, Pcm, pansLeft, totalTracks, removeAllTracks, Instrument, setEffect, getRow, nextAvailableId, []=, next, len, EffectCounts, mitems, Sequence, totalRows, mitems, new, System, speedToTempo, init, isNil, swap, TrackRow, queryInstrument, defaultRpm, add, duplicate, setEffectType, SomeTrack, init, remove, data, Waveform, ==, InfoString, init, $, TrackLen, ==, setLen, wavedata, Module, parseWave, getTrack, items, Song, [], EffectColumns, add, []=, len, toInfoString, TrackView, ChannelId, add, hertz, SequenceSize, toImmutable, WaveformTable, effectTypeShortensPattern, revisionMajor, insert, isValid, save, PositiveByte, pansRight, isNil, tracks, toAnchor, PcmF32, ByteIndex, ==, contains, PatternClip, clamp, isEffect, PatternIter, columnIter, effectNumber, ==, Immutable, init, init, restore, moveTo, Pcm, TrackColumn, TrackSelect, selection, iter, MixMode, PatternSelection, ==, ColumnIter, paste, rows, ChannelId, [], hasData, PatternCursor, toImmutable, hasColumn, PatternAnchor, translate, columns, pansLeft, [], PositiveByte, pansRight, isNil, currentSong, takeOperation, ByteIndex, ==, EngineFrame, halt, currentFrame, getLocked, Engine, stepAndApply, apply, getTrackEnvelope, lock, Immutable, init, isLocked, toImmutable, Pcm, isHalted, PcmF32, Module, ApuIo, unlock, MixMode, Song, jump, ==, setup, getTrackPanning, currentNote, ChannelId, ==, [], step, getTrackTimbre, reset, play, currentState, pansLeft, [], deserialize, deserialize, FormatResult, serialize, deserialize, deserialize, serialize, serialize, serialize, NoiseNote, note, lookupToneNote, lookupNoiseNote, ToneNote, noteCut, currentVersionString, currentVersion, currentFileSerial, Version, currentFileMinor, currentFileMajor, exportWav, init, Duration, init, process, progress, WavConfig, batched, progressMax, DurationKind, WavExporter, hasWork