lanczos-resampler 0.1.0 → 0.1.1

package/README.md

@@ -116,11 +116,11 @@ assert.equal(input.length, numProcessed);
 #### Resampling the whole audio track
 
 ```javascript
-import { WholeResampler, outputLength } as lanczos from 'lanczos-resampler';
+import { WholeResampler, numOutputFrames } as lanczos from 'lanczos-resampler';
 
 const input = new Float32Array(1024);
 input.fill(0.1);
-const outputLen = outputLength(1024, 44100, 48000);
+const outputLen = numOutputFrames(1024, 44100, 48000);
 const output = new Float32Array(outputLen);
 const resampler = new WholeResampler();
 const numProcessed = resampler.resampleInto(input, output);
@@ -131,9 +131,9 @@ console.log(output)
 
 ## Documentation
 
-Rust: <https://docs.rs/lanczos-resampler>
+Rust: <https://docs.rs/lanczos-resampler/latest/lanczos_resampler/>
 
-JS: <https://igankevich.github.com/lanczos-resampler>
+JS: <https://igankevich.github.io/lanczos-resampler>
 
 
 ## No-std support

package/lanczos_resampler.d.ts

@@ -7,7 +7,7 @@ export class ChunkedInterleavedResampler {
   /**
    * Get maximum output chunk length given the input chunk length.
    *
-   * Returns the same value as {@link outputLength} plus one.
+   * Returns the same value as {@link numOutputFrames} plus one.
    * This additional sample is used to compensate for unevenly divisible sample rates.
    *
    * You should consider updating buffer size every time you change output sample rate via
@@ -76,7 +76,7 @@ export class ChunkedResampler {
   /**
    * Get maximum output chunk length given the input chunk length.
    *
-   * Returns the same value as {@link outputLength} plus one.
+   * Returns the same value as {@link numOutputFrames} plus one.
    * This additional sample is used to compensate for unevenly divisible sample rates.
    *
    * You should consider updating buffer size every time you change output sample rate via
@@ -149,7 +149,7 @@ export class WholeResampler {
    * #### Panics
    *
    * Panics when the output isn't large enough to hold all the resampled points.
-   * Use {@link outputLength} to ensure that the buffer size is sufficient.
+   * Use {@link numOutputFrames} to ensure that the buffer size is sufficient.
    */
   resampleInto(input: Float32Array, output: Float32Array): number;
   /**
@@ -162,7 +162,7 @@ export class WholeResampler {
    * #### Panics
    *
    * - Panics when the output isn't large enough to hold all the resampled points.
-   *   Use {@link outputLength} to ensure that the buffer size is sufficient.
+   *   Use {@link numOutputFrames} to ensure that the buffer size is sufficient.
    * - Panics when either the input or the output length isn't evenly divisible by the number of
    *   channels.
    * @param input - input frames

package/lanczos_resampler_bg.js

@@ -150,7 +150,7 @@ export class ChunkedInterleavedResampler {
     /**
      * Get maximum output chunk length given the input chunk length.
      *
-     * Returns the same value as {@link outputLength} plus one.
+     * Returns the same value as {@link numOutputFrames} plus one.
      * This additional sample is used to compensate for unevenly divisible sample rates.
      *
      * You should consider updating buffer size every time you change output sample rate via
@@ -272,7 +272,7 @@ export class ChunkedResampler {
     /**
      * Get maximum output chunk length given the input chunk length.
      *
-     * Returns the same value as {@link outputLength} plus one.
+     * Returns the same value as {@link numOutputFrames} plus one.
      * This additional sample is used to compensate for unevenly divisible sample rates.
      *
      * You should consider updating buffer size every time you change output sample rate via
@@ -382,7 +382,7 @@ export class WholeResampler {
      * #### Panics
      *
      * Panics when the output isn't large enough to hold all the resampled points.
-     * Use {@link outputLength} to ensure that the buffer size is sufficient.
+     * Use {@link numOutputFrames} to ensure that the buffer size is sufficient.
      * @param {Float32Array} input
      * @param {Float32Array} output
      * @returns {number}
@@ -407,7 +407,7 @@ export class WholeResampler {
      * #### Panics
      *
      * - Panics when the output isn't large enough to hold all the resampled points.
-     *   Use {@link outputLength} to ensure that the buffer size is sufficient.
+     *   Use {@link numOutputFrames} to ensure that the buffer size is sufficient.
      * - Panics when either the input or the output length isn't evenly divisible by the number of
      *   channels.
      * @param {Float32Array} input - input frames

package/package.json

@@ -2,7 +2,7 @@
   "name": "lanczos-resampler",
   "type": "module",
   "description": "Audio resampler for Rust/JS that uses Lanczos filter.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "repository": {
     "type": "git",