spessasynth_core 3.27.7 → 4.0.0

package/src/soundfont/basic_soundfont/basic_sample.js

@@ -1,477 +0,0 @@
-import { SpessaSynthWarn } from "../../utils/loggin.js";
-import { IndexedByteArray } from "../../utils/indexed_array.js";
-import { stbvorbis } from "../../externals/stbvorbis_sync/stbvorbis_sync.min.js";
-
-// should be reasonable for most cases
-const RESAMPLE_RATE = 48000;
-
-/**
- * @typedef {1|2|4|8|32769|32770|32772|32776} sampleTypes
- */
-
-/**
- * @enum {sampleTypes}
- */
-export const sampleTypes = {
-    monoSample: 1,
-    rightSample: 2,
-    leftSample: 4,
-    linkedSample: 8,
-    romMonoSample: 32769,
-    romRightSample: 32770,
-    romLeftSample: 32772,
-    romLinkedSample: 32776
-};
-
-/**
- * @typedef {function} SampleEncodingFunction
- * @async
- * @param audioData {Float32Array}
- * @param sampleRate {number}
- * @returns {Promise<Uint8Array>}
- */
-
-export class BasicSample
-{
-    
-    /**
-     * The sample's name
-     * @type {string}
-     */
-    sampleName;
-    
-    /**
-     * Sample rate in Hz
-     * @type {number}
-     */
-    sampleRate;
-    
-    /**
-     * Original pitch of the sample as a MIDI note number
-     * @type {number}
-     */
-    samplePitch;
-    
-    /**
-     * Pitch correction, in cents. Can be negative
-     * @type {number}
-     */
-    samplePitchCorrection;
-    
-    /**
-     * Linked sample, unused if mono
-     * @type {BasicSample|undefined}
-     */
-    linkedSample;
-    
-    /**
-     * The type of the sample
-     * @type {sampleTypes}
-     */
-    sampleType;
-    
-    /**
-     * Relative to the start of the sample in sample points
-     * @type {number}
-     */
-    sampleLoopStartIndex;
-    
-    /**
-     * Relative to the start of the sample in sample points
-     * @type {number}
-     */
-    sampleLoopEndIndex;
-    
-    /**
-     * Indicates if the sample is compressed using vorbis SF3
-     * @type {boolean}
-     */
-    isCompressed = false;
-    
-    /**
-     * The compressed sample data if the sample has been compressed
-     * @type {Uint8Array|undefined}
-     */
-    compressedData = undefined;
-    /**
-     * Sample's linked instruments (the instruments that use it)
-     * note that duplicates are allowed since one instrument can use the same sample multople times
-     * @type {BasicInstrument[]}
-     */
-    linkedInstruments = [];
-    /**
-     * The sample's audio data
-     * @type {Float32Array|undefined}
-     */
-    sampleData = undefined;
-    
-    /**
-     * Indicates if the data was overriden, so it cannot be copied back unchanged
-     * @type {boolean}
-     */
-    dataOverriden = true;
-    
-    /**
-     * The basic representation of a sample
-     * @param sampleName {string} The sample's name
-     * @param sampleRate {number} The sample's rate in Hz
-     * @param samplePitch {number} The sample's pitch as a MIDI note number
-     * @param samplePitchCorrection {number} The sample's pitch correction in cents
-     * @param sampleType {sampleTypes} The sample's type, an enum that can indicate SF3
-     * @param loopStart {number} The sample's loop start relative to the sample start in sample points
-     * @param loopEnd {number} The sample's loop end relative to the sample start in sample points
-     */
-    constructor(
-        sampleName,
-        sampleRate,
-        samplePitch,
-        samplePitchCorrection,
-        sampleType,
-        loopStart,
-        loopEnd
-    )
-    {
-        this.sampleName = sampleName;
-        this.sampleRate = sampleRate;
-        this.samplePitch = samplePitch;
-        this.samplePitchCorrection = samplePitchCorrection;
-        this.sampleLoopStartIndex = loopStart;
-        this.sampleLoopEndIndex = loopEnd;
-        this.sampleType = sampleType;
-    }
-    
-    /**
-     * If the sample is linked to another sample
-     * @returns {boolean}
-     */
-    get isLinked()
-    {
-        return this.sampleType === sampleTypes.rightSample ||
-            this.sampleType === sampleTypes.leftSample ||
-            this.sampleType === sampleTypes.linkedSample;
-    }
-    
-    /**
-     * The sample's use count
-     * @type {number}
-     */
-    get useCount()
-    {
-        return this.linkedInstruments.length;
-    }
-    
-    /**
-     * Get raw data for writing the file
-     * @param allowVorbis {boolean}
-     * @return {Uint8Array} either s16 or vorbis data
-     * @virtual
-     */
-    getRawData(allowVorbis)
-    {
-        if (this.isCompressed && allowVorbis && !this.dataOverriden)
-        {
-            return this.compressedData;
-        }
-        return this.encodeS16LE();
-    }
-    
-    resampleData(newSampleRate)
-    {
-        let audioData = this.getAudioData();
-        const ratio = newSampleRate / this.sampleRate;
-        const resampled = new Float32Array(Math.floor(audioData.length * ratio));
-        for (let i = 0; i < resampled.length; i++)
-        {
-            resampled[i] = audioData[Math.floor(i * (1 / ratio))];
-        }
-        audioData = resampled;
-        this.sampleRate = newSampleRate;
-        // adjust loop points
-        this.sampleLoopStartIndex = Math.floor(this.sampleLoopStartIndex * ratio);
-        this.sampleLoopEndIndex = Math.floor(this.sampleLoopEndIndex * ratio);
-        this.sampleData = audioData;
-    }
-    
-    /**
-     * @param encodeVorbis {SampleEncodingFunction}
-     */
-    async compressSample(encodeVorbis)
-    {
-        // no need to compress
-        if (this.isCompressed)
-        {
-            return;
-        }
-        // compress, always mono!
-        try
-        {
-            // if the sample rate is too low or too high, resample
-            let audioData = this.getAudioData();
-            if (this.sampleRate < 8000 || this.sampleRate > 96000)
-            {
-                this.resampleData(RESAMPLE_RATE);
-                audioData = this.getAudioData();
-            }
-            const compressed = await encodeVorbis(audioData, this.sampleRate);
-            this.setCompressedData(compressed);
-        }
-        catch (e)
-        {
-            SpessaSynthWarn(`Failed to compress ${this.sampleName}. Leaving as uncompressed!`, e);
-            delete this.compressedData;
-            // flag as uncompressed
-            this.isCompressed = false;
-        }
-        
-    }
-    
-    /**
-     * @param type {sampleTypes|number}
-     */
-    setSampleType(type)
-    {
-        this.sampleType = type;
-        if (!this.isLinked)
-        {
-            // unlink the other sample
-            if (this.linkedSample)
-            {
-                this.linkedSample.linkedSample = undefined;
-                this.linkedSample.sampleType = type;
-            }
-            
-            this.linkedSample = undefined;
-        }
-        if ((type & 0x8000) > 0)
-        {
-            throw new Error("ROM samples are not supported.");
-        }
-        
-    }
-    
-    deleteSample()
-    {
-        if (this.useCount > 0)
-        {
-            throw new Error(`Cannot delete sample used by: ${this.linkedInstruments.map(i => i.instrumentName)}.`);
-        }
-        this.unlinkSample();
-    }
-    
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * Unlinks a sample link
-     */
-    unlinkSample()
-    {
-        this.setSampleType(sampleTypes.monoSample);
-    }
-    
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * Links a stereo sample
-     * @param sample {BasicSample} the sample to link to
-     * @param type {sampleTypes} either left, right or linked
-     */
-    setLinkedSample(sample, type)
-    {
-        // sanity check
-        if (sample.linkedSample)
-        {
-            throw new Error(`${sample.sampleName} is linked tp ${sample.linkedSample.sampleName}. Unlink it first.`);
-        }
-        this.linkedSample = sample;
-        sample.linkedSample = this;
-        if (type === sampleTypes.leftSample)
-        {
-            this.setSampleType(sampleTypes.leftSample);
-            sample.setSampleType(sampleTypes.rightSample);
-        }
-        else if (type === sampleTypes.rightSample)
-        {
-            this.setSampleType(sampleTypes.rightSample);
-            sample.setSampleType(sampleTypes.leftSample);
-        }
-        else if (type === sampleTypes.linkedSample)
-        {
-            this.setSampleType(sampleTypes.linkedSample);
-            sample.setSampleType(sampleTypes.linkedSample);
-        }
-        else
-        {
-            throw new Error("Invalid sample type: " + type);
-        }
-    }
-    
-    /**
-     * @param instrument {BasicInstrument}
-     */
-    linkTo(instrument)
-    {
-        this.linkedInstruments.push(instrument);
-    }
-    
-    /**
-     * @param instrument {BasicInstrument}
-     */
-    unlinkFrom(instrument)
-    {
-        const index = this.linkedInstruments.indexOf(instrument);
-        if (index < 0)
-        {
-            SpessaSynthWarn(`Cannot unlink ${instrument.instrumentName} from ${this.sampleName}: not linked.`);
-            return;
-        }
-        this.linkedInstruments.splice(index, 1);
-    }
-    
-    
-    /**
-     * @private
-     * Decode binary vorbis into a float32 pcm
-     * @returns {Float32Array}
-     */
-    decodeVorbis()
-    {
-        if (this.sampleData)
-        {
-            return this.sampleData;
-        }
-        // get the compressed byte stream
-        // reset array and being decoding
-        try
-        {
-            /**
-             * @type {{data: Float32Array[], error: (string|null), sampleRate: number, eof: boolean}}
-             */
-            const vorbis = stbvorbis.decode(this.compressedData);
-            const decoded = vorbis.data[0];
-            if (decoded === undefined)
-            {
-                SpessaSynthWarn(`Error decoding sample ${this.sampleName}: Vorbis decode returned undefined.`);
-                return new Float32Array(0);
-            }
-            // clip
-            // because vorbis can go above 1 sometimes
-            for (let i = 0; i < decoded.length; i++)
-            {
-                // magic number is 32,767 / 32,768
-                decoded[i] = Math.max(-1, Math.min(decoded[i], 0.999969482421875));
-            }
-            return decoded;
-        }
-        catch (e)
-        {
-            // do not error out, fill with silence
-            SpessaSynthWarn(`Error decoding sample ${this.sampleName}: ${e}`);
-            return new Float32Array(this.sampleLoopEndIndex + 1);
-        }
-    }
-    
-    /**
-     * Get the float32 audio data.
-     * Note that this either decodes the compressed data or passes the ready sampleData.
-     * If neither are set then it will throw an error!
-     * @returns {Float32Array}
-     */
-    getAudioData()
-    {
-        if (this.sampleData)
-        {
-            return this.sampleData;
-        }
-        if (this.isCompressed)
-        {
-            // SF3
-            // if compressed, decode
-            this.sampleData = this.decodeVorbis();
-            return this.sampleData;
-        }
-        throw new Error("Sample data is undefined for a BasicSample instance.");
-    }
-    
-    /**
-     * Encodes s16le sample
-     * @return {IndexedByteArray}
-     */
-    encodeS16LE()
-    {
-        const data = this.getAudioData();
-        const data16 = new Int16Array(data.length);
-        const len = data.length;
-        for (let i = 0; i < len; i++)
-        {
-            let sample = data[i] * 32768;
-            // Clamp for safety (do not use Math.max/Math.min here)
-            if (sample > 32767)
-            {
-                sample = 32767;
-            }
-            else if (sample < -32768)
-            {
-                sample = -32768;
-            }
-            data16[i] = sample;
-        }
-        return new IndexedByteArray(data16.buffer);
-    }
-    
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * REPLACES the audio data
-     * @param audioData {Float32Array}
-     * @virtual
-     */
-    setAudioData(audioData)
-    {
-        this.isCompressed = false;
-        delete this.compressedData;
-        this.sampleData = audioData;
-        this.dataOverriden = true;
-    }
-    
-    /**
-     * Replaces the audio with a compressed data sample
-     * @param data {Uint8Array}
-     */
-    setCompressedData(data)
-    {
-        this.sampleData = undefined;
-        this.compressedData = data;
-        this.isCompressed = true;
-        this.dataOverriden = false;
-    }
-}
-
-
-export class CreatedSample extends BasicSample
-{
-    /**
-     * A simplified class for creating samples
-     * @param name
-     * @param sampleRate
-     * @param sampleData
-     */
-    constructor(name, sampleRate, sampleData)
-    {
-        super(name, sampleRate, 60, 0, sampleTypes.monoSample, 0, sampleData.length - 1);
-        this.setAudioData(sampleData);
-    }
-    
-    /**
-     * @param allowVorbis {boolean}
-     * @returns {Uint8Array}
-     */
-    getRawData(allowVorbis)
-    {
-        return super.getRawData(allowVorbis);
-    }
-    
-    /**
-     * @param audioData {Float32Array}
-     */
-    setAudioData(audioData)
-    {
-        super.setAudioData(audioData);
-    }
-}