index.d.ts

export class Encoder {
    constructor(sampleRate: number, channels: number, app: number);
    encode(
        pcm: Int16Array,
        frameSize: number,
        outData: Uint8Array,
        maxDataBytes: number
    ): number;
    encodeAsync(
        pcm: Int16Array,
        frameSize: number,
        outData: Uint8Array,
        maxDataBytes: number,
        fn: (value: string | number) => void
    ): void;
    encodeFloat(
        pcm: Float32Array,
        frameSize: number,
        data: Uint8Array,
        maxDataBytes: number
    ): number;
    // generated functions
    setApplication(value: number): void;
    getApplication(): number;
    setBitrate(value: number): void;
    getBitrate(): number;
    setMaxBandwidth(value: number): void;
    getMaxBandwidth(): number;
    setVbr(value: number): void;
    getVbr(): number;
    setBandwidth(value: number): void;
    getBandwidth(): number;
    setComplexity(value: number): void;
    getComplexity(): number;
    setInbandFec(value: number): void;
    getInbandFec(): number;
    setPacketLossPerc(value: number): void;
    getPacketLossPerc(): number;
    setDtx(value: number): void;
    getDtx(): number;
    setVbrConstraint(value: number): void;
    getVbrConstraint(): number;
    setForceChannels(value: number): void;
    getForceChannels(): number;
    setSignal(value: number): void;
    getSignal(): number;
    getLookahead(): number;
    getSampleRate(): number;
    getFinalRange(): number;
    getPitch(): number;
    setGain(value: number): void;
    getGain(): number;
    setLsbDepth(value: number): void;
    getLsbDepth(): number;
    getLastPacketDuration(): number;
    setExpertFrameDuration(value: number): void;
    getExpertFrameDuration(): number;
    setPredictionDisabled(value: number): void;
    getPredictionDisabled(): number;
    setPhaseInversionDisabled(value: number): void;
    getPhaseInversionDisabled(): number;
    getInDtx(): number;
}
export class Decoder {
    constructor(sampleRate: number, channels: number);
    decode(
        encoded: Uint8Array,
        encodedLength: number,
        pcmOut: Int16Array,
        frameSize: number,
        decodeFec: number
    ): number;
    decodeAsync(
        encoded: Uint8Array,
        encodedLength: number,
        pcmOut: Int16Array,
        frameSize: number,
        decodeFec: number,
        fn: (value: string | number) => void
    ): void;
    decodeFloat(
        encoded: Uint8Array,
        encodedLength: number,
        pcmOut: Float32Array,
        frameSize: number,
        decodeFec: number
    ): number;
    // generated functions
    setApplication(value: number): void;
    getApplication(): number;
    setBitrate(value: number): void;
    getBitrate(): number;
    setMaxBandwidth(value: number): void;
    getMaxBandwidth(): number;
    setVbr(value: number): void;
    getVbr(): number;
    setBandwidth(value: number): void;
    getBandwidth(): number;
    setComplexity(value: number): void;
    getComplexity(): number;
    setInbandFec(value: number): void;
    getInbandFec(): number;
    setPacketLossPerc(value: number): void;
    getPacketLossPerc(): number;
    setDtx(value: number): void;
    getDtx(): number;
    setVbrConstraint(value: number): void;
    getVbrConstraint(): number;
    setForceChannels(value: number): void;
    getForceChannels(): number;
    setSignal(value: number): void;
    getSignal(): number;
    getLookahead(): number;
    getSampleRate(): number;
    getFinalRange(): number;
    getPitch(): number;
    setGain(value: number): void;
    getGain(): number;
    setLsbDepth(value: number): void;
    getLsbDepth(): number;
    getLastPacketDuration(): number;
    setExpertFrameDuration(value: number): void;
    getExpertFrameDuration(): number;
    setPredictionDisabled(value: number): void;
    getPredictionDisabled(): number;
    setPhaseInversionDisabled(value: number): void;
    getPhaseInversionDisabled(): number;
    getInDtx(): number;
}

export class OpusFile {
    openFile(filePath: string);
    openMemory(data: Uint8Array);
    readFloat(value: Float32Array): {
        sampleCount: number;
        linkIndex: number;
    };
    read(value: Int16Array): {
        sampleCount: number;
        linkIndex: number;
    };
    readFloatStereo(value: Float32Array): number;
    readStereo(value: Int16Array): number;
    pcmTell(): number;

    /**
     * Get the total PCM length (number of samples at 48 kHz) of the stream, or of
     * an individual link in a (possibly-chained) Ogg Opus stream.
     * Users looking for <code>op_time_total()</code> should use op_pcm_total()
     * instead.
     * Because timestamps in Opus are fixed at 48 kHz, there is no need for a
     * separate function to convert this to seconds (and leaving it out avoids
     * introducing floating point to the API, for those that wish to avoid it).
     * @param li The index of the link whose PCM length should be computed. Use a negative number to get the PCM length of the entire stream.
     * @returns The PCM length of the entire stream if @param li is negative, the PCM length of link @param li if it is non-negative
     */
    pcmTotal(li: number): number;
    pcmSeek(offset: number): number;
    channelCount(li: number): number;
    rawTotal(li: number): number;
    linkCount(): number;
}

export namespace opusenc {
    class Encoder {
        constructor();
        createFile(
            comments: Comments,
            file: string,
            rate: number,
            channels: number,
            family: number
        ): void;
        // Write out the header now rather than wait for audio to begin.
        flushHeader(): void;
        /**
         * Create a new OggOpus stream to be used along with.ope_encoder_get_page().
         * This is mostly useful for muxing with other streams.
         */
        createPull(
            comments: Comments,
            rate: number,
            channels: number,
            family: number
        ): void;
        // Add/encode any number of float samples to the file.
        writeFloat(value: Float32Array, samples: number): void;
        // Add/encode any number of int16 samples to the file.
        write(value: Int16Array, samples: number): void;
        // Finalizes the stream, but does not deallocate the object.
        drain(): void;
        // Ends the stream and create a new file.
        continueNewFile(path: string, comments: Comments): void;
        /**
         * Deferred initialization of the encoder to force an explicit channel mapping. This can be used to override the default channel coupling,
         * but using it for regular surround will almost certainly lead to worse quality.
         */
        deferredInitWithMapping(
            family: number,
            streams: number,
            coupled_streams: number,
            mapping: Uint8Array
        ): void;
        getPage(flush: boolean): Uint8Array | null;
        chainCurrent(comments: Comments): void;
        /**
         * get information
         */
        setApplication(value: number): void;
        setBitrate(value: number): void;
        setMaxBandwidth(value: number): void;
        setVbr(value: number): void;
        setBandwidth(value: number): void;
        setComplexity(value: number): void;
        setInbandFec(value: number): void;
        setPacketLossPerc(value: number): void;
        setDtx(value: number): void;
        setVbrConstraint(value: number): void;
        setForceChannels(value: number): void;
        setSignal(value: number): void;
        setLsbDepth(value: number): void;
        setExpertFrameDuration(value: number): void;
        setPredictionDisabled(value: number): void;
        setPhaseInversionDisabled(value: number): void;

        getApplication(): number;
        getBitrate(): number;
        getMaxBandwidth(): number;
        getVbr(): number;
        getBandwidth(): number;
        getComplexity(): number;
        getInbandFec(): number;
        getPacketLossPerc(): number;
        getDtx(): number;
        getVbrConstraint(): number;
        getForceChannels(): number;
        getSignal(): number;
        getLsbDepth(): number;
        getPredictionDisabled(): number;
    }
    export class Comments {
        add(key: string, tag: string): void;
    }
}

export { default as constants } from "./constants";