WaveFileConverter.fromExisting_ - Code Metrics - Inspection of "Keep file metadata when converting to ADPCM" - rochars/wavefile - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5a0225...e0b877 )

by Rafael S.

created 2019-09-11 07:49 UTC

WaveFileConverter.fromExisting_ A

↳ Parent: WaveFileConverter

Complexity

Conditions

Size

Total Lines	8
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	1

/*
 * Copyright (c) 2017-2019 Rafael da Silva Rocha.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

/**
 * @fileoverview The WaveFileConverter class.
 * @see https://github.com/rochars/wavefile
 */

/** @module wavefile */

import bitDepthLib from 'bitdepth';
import * as imaadpcm from 'imaadpcm';
import * as alawmulaw from 'alawmulaw';
import {unpackArray, unpackArrayTo} from 'byte-data';
import WaveFileMetaEditor from './wavefile-meta-editor';
import truncateSamples from './truncate-samples';

/**
 * A class to convert wav files to other types of wav files.
 * @extends WaveFileMetaEditor
 */
export default class WaveFileConverter extends WaveFileMetaEditor {

  /**
   * Force a file as RIFF.
   */
  toRIFF() {
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      this.bitDepth,
      unpackArray(this.data.samples, this.dataType));
  }

  /**
   * Force a file as RIFX.
   */
  toRIFX() {
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      this.bitDepth,
      unpackArray(this.data.samples, this.dataType),
      {container: 'RIFX'});
  }

  /**
   * Encode a 16-bit wave file as 4-bit IMA ADPCM.
   * @throws {Error} If sample rate is not 8000.
   * @throws {Error} If number of channels is not 1.
   */
  toIMAADPCM() {
    if (this.fmt.sampleRate !== 8000) {
      throw new Error(
        'Only 8000 Hz files can be compressed as IMA-ADPCM.');
    } else if (this.fmt.numChannels !== 1) {
      throw new Error(
        'Only mono files can be compressed as IMA-ADPCM.');
    } else {
      this.assure16Bit_();
      /** @type {!Int16Array} */
      let output = new Int16Array(this.data.samples.length / 2);
      unpackArrayTo(this.data.samples, this.dataType, output);
      this.fromExisting_(
        this.fmt.numChannels,
        this.fmt.sampleRate,
        '4',
        imaadpcm.encode(output),
        {container: this.correctContainer_()});
    }
  }

  /**
   * Decode a 4-bit IMA ADPCM wave file as a 16-bit wave file.
   * @param {string} bitDepthCode The new bit depth of the samples.
   *    One of '8' ... '32' (integers), '32f' or '64' (floats).
   *    Optional. Default is 16.
   */
  fromIMAADPCM(bitDepthCode='16') {
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      '16',
      imaadpcm.decode(this.data.samples, this.fmt.blockAlign),
      {container: this.correctContainer_()});
    if (bitDepthCode != '16') {
      this.toBitDepth(bitDepthCode);
    }
  }

  /**
   * Encode a 16-bit wave file as 8-bit A-Law.
   */
  toALaw() {
    this.assure16Bit_();
    /** @type {!Int16Array} */
    let output = new Int16Array(this.data.samples.length / 2);
    unpackArrayTo(this.data.samples, this.dataType, output);
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      '8a',
      alawmulaw.alaw.encode(output),
      {container: this.correctContainer_()});
  }

  /**
   * Decode a 8-bit A-Law wave file into a 16-bit wave file.
   * @param {string} bitDepthCode The new bit depth of the samples.
   *    One of '8' ... '32' (integers), '32f' or '64' (floats).
   *    Optional. Default is 16.
   */
  fromALaw(bitDepthCode='16') {
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      '16',
      alawmulaw.alaw.decode(this.data.samples),
      {container: this.correctContainer_()});
    if (bitDepthCode != '16') {
      this.toBitDepth(bitDepthCode);
    }
  }

  /**
   * Encode 16-bit wave file as 8-bit mu-Law.
   */
  toMuLaw() {
    this.assure16Bit_();
    /** @type {!Int16Array} */
    let output = new Int16Array(this.data.samples.length / 2);
    unpackArrayTo(this.data.samples, this.dataType, output);
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      '8m',
      alawmulaw.mulaw.encode(output),
      {container: this.correctContainer_()});
  }

  /**
   * Decode a 8-bit mu-Law wave file into a 16-bit wave file.
   * @param {string} bitDepthCode The new bit depth of the samples.
   *    One of '8' ... '32' (integers), '32f' or '64' (floats).
   *    Optional. Default is 16.
   */
  fromMuLaw(bitDepthCode='16') {
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      '16',
      alawmulaw.mulaw.decode(this.data.samples),
      {container: this.correctContainer_()});
    if (bitDepthCode != '16') {
      this.toBitDepth(bitDepthCode);
    }
  }

  /**
   * Change the bit depth of the samples.
   * @param {string} newBitDepth The new bit depth of the samples.
   *    One of '8' ... '32' (integers), '32f' or '64' (floats)
   * @param {boolean} changeResolution A boolean indicating if the
   *    resolution of samples should be actually changed or not.
   * @throws {Error} If the bit depth is not valid.
   */
  toBitDepth(newBitDepth, changeResolution=true) {
    /** @type {string} */
    let toBitDepth = newBitDepth;
    /** @type {string} */
    let thisBitDepth = this.bitDepth;
    if (!changeResolution) {
      if (newBitDepth != '32f') {
        toBitDepth = this.dataType.bits.toString();
      }
      thisBitDepth = this.dataType.bits;
    }
    this.assureUncompressed_();
    /** @type {number} */
    let sampleCount = this.data.samples.length / (this.dataType.bits / 8);
    /** @type {!Float64Array} */
    let typedSamplesInput = new Float64Array(sampleCount);
    /** @type {!Float64Array} */
    let typedSamplesOutput = new Float64Array(sampleCount);
    unpackArrayTo(this.data.samples, this.dataType, typedSamplesInput);
    if (thisBitDepth == "32f" || thisBitDepth == "64") {
      truncateSamples(typedSamplesInput);
    }
    bitDepthLib(
      typedSamplesInput, thisBitDepth, toBitDepth, typedSamplesOutput);
    this.fromExisting_(
      this.fmt.numChannels,
      this.fmt.sampleRate,
      newBitDepth,
      typedSamplesOutput,
      {container: this.correctContainer_()});
  }

  /**
   * Make the file 16-bit if it is not.
   * @private
   */
  assure16Bit_() {
    this.assureUncompressed_();
    if (this.bitDepth != '16') {
      this.toBitDepth('16');
    }
  }

  /**
   * Uncompress the samples in case of a compressed file.
   * @private
   */
  assureUncompressed_() {
    if (this.bitDepth == '8a') {
      this.fromALaw();
    } else if (this.bitDepth == '8m') {
      this.fromMuLaw();
    } else if (this.bitDepth == '4') {
      this.fromIMAADPCM();
    }
  }

  /**
   * Return 'RIFF' if the container is 'RF64', the current container name
   * otherwise. Used to enforce 'RIFF' when RF64 is not allowed.
   * @return {string}
   * @private
   */
  correctContainer_() {
    return this.container == 'RF64' ? 'RIFF' : this.container;
  }

  /**
   * Set up the WaveFileCreator object based on the arguments passed.
   * This method only reset the fmt , fact, ds64 and data chunks.
   * @param {number} numChannels The number of channels
   *    (Integer numbers: 1 for mono, 2 stereo and so on).
   * @param {number} sampleRate The sample rate.
   *    Integer numbers like 8000, 44100, 48000, 96000, 192000.
   * @param {string} bitDepthCode The audio bit depth code.
   *    One of '4', '8', '8a', '8m', '16', '24', '32', '32f', '64'
   *    or any value between '8' and '32' (like '12').
   * @param {!Array<number>|!Array<!Array<number>>|!TypedArray} samples
   *    The samples. Must be in the correct range according to the bit depth.
   * @param {?Object} options Optional. Used to force the container
   *    as RIFX with {'container': 'RIFX'}
   * @throws {Error} If any argument does not meet the criteria.
   * @private
   */
  fromExisting_(numChannels, sampleRate, bitDepthCode, samples, options={}) {
    let tmpWav = new WaveFileMetaEditor();
    Object.assign(this.fmt, tmpWav.fmt);
    Object.assign(this.fact, tmpWav.fact);
    Object.assign(this.ds64, tmpWav.ds64);
    Object.assign(this.data, tmpWav.data);
    this.newWavFile_(numChannels, sampleRate, bitDepthCode, samples, options);
  }
}


1			/*
2			* Copyright (c) 2017-2019 Rafael da Silva Rocha.
3			*
4			* Permission is hereby granted, free of charge, to any person obtaining
5			* a copy of this software and associated documentation files (the
6			* "Software"), to deal in the Software without restriction, including
7			* without limitation the rights to use, copy, modify, merge, publish,
8			* distribute, sublicense, and/or sell copies of the Software, and to
9			* permit persons to whom the Software is furnished to do so, subject to
10			* the following conditions:
11			*
12			* The above copyright notice and this permission notice shall be
13			* included in all copies or substantial portions of the Software.
14			*
15			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16			* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17			* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18			* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19			* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20			* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21			* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22			*
23			*/
24
25			/**
26			* @fileoverview The WaveFileConverter class.
27			* @see https://github.com/rochars/wavefile
28			*/
29
30			/** @module wavefile */
31
32			import bitDepthLib from 'bitdepth';
33			import * as imaadpcm from 'imaadpcm';
34			import * as alawmulaw from 'alawmulaw';
35			import {unpackArray, unpackArrayTo} from 'byte-data';
36			import WaveFileMetaEditor from './wavefile-meta-editor';
37			import truncateSamples from './truncate-samples';
38
39			/**
40			* A class to convert wav files to other types of wav files.
41			* @extends WaveFileMetaEditor
42			*/
43			export default class WaveFileConverter extends WaveFileMetaEditor {
44
45			/**
46			* Force a file as RIFF.
47			*/
48			toRIFF() {
49			this.fromExisting_(
50			this.fmt.numChannels,
51			this.fmt.sampleRate,
52			this.bitDepth,
53			unpackArray(this.data.samples, this.dataType));
54			}
55
56			/**
57			* Force a file as RIFX.
58			*/
59			toRIFX() {
60			this.fromExisting_(
61			this.fmt.numChannels,
62			this.fmt.sampleRate,
63			this.bitDepth,
64			unpackArray(this.data.samples, this.dataType),
65			{container: 'RIFX'});
66			}
67
68			/**
69			* Encode a 16-bit wave file as 4-bit IMA ADPCM.
70			* @throws {Error} If sample rate is not 8000.
71			* @throws {Error} If number of channels is not 1.
72			*/
73			toIMAADPCM() {
74			if (this.fmt.sampleRate !== 8000) {
75			throw new Error(
76			'Only 8000 Hz files can be compressed as IMA-ADPCM.');
77			} else if (this.fmt.numChannels !== 1) {
78			throw new Error(
79			'Only mono files can be compressed as IMA-ADPCM.');
80			} else {
81			this.assure16Bit_();
82			/** @type {!Int16Array} */
83			let output = new Int16Array(this.data.samples.length / 2);
84			unpackArrayTo(this.data.samples, this.dataType, output);
85			this.fromExisting_(
86			this.fmt.numChannels,
87			this.fmt.sampleRate,
88			'4',
89			imaadpcm.encode(output),
90			{container: this.correctContainer_()});
91			}
92			}
93
94			/**
95			* Decode a 4-bit IMA ADPCM wave file as a 16-bit wave file.
96			* @param {string} bitDepthCode The new bit depth of the samples.
97			* One of '8' ... '32' (integers), '32f' or '64' (floats).
98			* Optional. Default is 16.
99			*/
100			fromIMAADPCM(bitDepthCode='16') {
101			this.fromExisting_(
102			this.fmt.numChannels,
103			this.fmt.sampleRate,
104			'16',
105			imaadpcm.decode(this.data.samples, this.fmt.blockAlign),
106			{container: this.correctContainer_()});
107			if (bitDepthCode != '16') {
108			this.toBitDepth(bitDepthCode);
109			}
110			}
111
112			/**
113			* Encode a 16-bit wave file as 8-bit A-Law.
114			*/
115			toALaw() {
116			this.assure16Bit_();
117			/** @type {!Int16Array} */
118			let output = new Int16Array(this.data.samples.length / 2);
119			unpackArrayTo(this.data.samples, this.dataType, output);
120			this.fromExisting_(
121			this.fmt.numChannels,
122			this.fmt.sampleRate,
123			'8a',
124			alawmulaw.alaw.encode(output),
125			{container: this.correctContainer_()});
126			}
127
128			/**
129			* Decode a 8-bit A-Law wave file into a 16-bit wave file.
130			* @param {string} bitDepthCode The new bit depth of the samples.
131			* One of '8' ... '32' (integers), '32f' or '64' (floats).
132			* Optional. Default is 16.
133			*/
134			fromALaw(bitDepthCode='16') {
135			this.fromExisting_(
136			this.fmt.numChannels,
137			this.fmt.sampleRate,
138			'16',
139			alawmulaw.alaw.decode(this.data.samples),
140			{container: this.correctContainer_()});
141			if (bitDepthCode != '16') {
142			this.toBitDepth(bitDepthCode);
143			}
144			}
145
146			/**
147			* Encode 16-bit wave file as 8-bit mu-Law.
148			*/
149			toMuLaw() {
150			this.assure16Bit_();
151			/** @type {!Int16Array} */
152			let output = new Int16Array(this.data.samples.length / 2);
153			unpackArrayTo(this.data.samples, this.dataType, output);
154			this.fromExisting_(
155			this.fmt.numChannels,
156			this.fmt.sampleRate,
157			'8m',
158			alawmulaw.mulaw.encode(output),
159			{container: this.correctContainer_()});
160			}
161
162			/**
163			* Decode a 8-bit mu-Law wave file into a 16-bit wave file.
164			* @param {string} bitDepthCode The new bit depth of the samples.
165			* One of '8' ... '32' (integers), '32f' or '64' (floats).
166			* Optional. Default is 16.
167			*/
168			fromMuLaw(bitDepthCode='16') {
169			this.fromExisting_(
170			this.fmt.numChannels,
171			this.fmt.sampleRate,
172			'16',
173			alawmulaw.mulaw.decode(this.data.samples),
174			{container: this.correctContainer_()});
175			if (bitDepthCode != '16') {
176			this.toBitDepth(bitDepthCode);
177			}
178			}
179
180			/**
181			* Change the bit depth of the samples.
182			* @param {string} newBitDepth The new bit depth of the samples.
183			* One of '8' ... '32' (integers), '32f' or '64' (floats)
184			* @param {boolean} changeResolution A boolean indicating if the
185			* resolution of samples should be actually changed or not.
186			* @throws {Error} If the bit depth is not valid.
187			*/
188			toBitDepth(newBitDepth, changeResolution=true) {
189			/** @type {string} */
190			let toBitDepth = newBitDepth;
191			/** @type {string} */
192			let thisBitDepth = this.bitDepth;
193			if (!changeResolution) {
194			if (newBitDepth != '32f') {
195			toBitDepth = this.dataType.bits.toString();
196			}
197			thisBitDepth = this.dataType.bits;
198			}
199			this.assureUncompressed_();
200			/** @type {number} */
201			let sampleCount = this.data.samples.length / (this.dataType.bits / 8);
202			/** @type {!Float64Array} */
203			let typedSamplesInput = new Float64Array(sampleCount);
204			/** @type {!Float64Array} */
205			let typedSamplesOutput = new Float64Array(sampleCount);
206			unpackArrayTo(this.data.samples, this.dataType, typedSamplesInput);
207			if (thisBitDepth == "32f" \|\| thisBitDepth == "64") {
208			truncateSamples(typedSamplesInput);
209			}
210			bitDepthLib(
211			typedSamplesInput, thisBitDepth, toBitDepth, typedSamplesOutput);
212			this.fromExisting_(
213			this.fmt.numChannels,
214			this.fmt.sampleRate,
215			newBitDepth,
216			typedSamplesOutput,
217			{container: this.correctContainer_()});
218			}
219
220			/**
221			* Make the file 16-bit if it is not.
222			* @private
223			*/
224			assure16Bit_() {
225			this.assureUncompressed_();
226			if (this.bitDepth != '16') {
227			this.toBitDepth('16');
228			}
229			}
230
231			/**
232			* Uncompress the samples in case of a compressed file.
233			* @private
234			*/
235			assureUncompressed_() {
236			if (this.bitDepth == '8a') {
237			this.fromALaw();
238			} else if (this.bitDepth == '8m') {
239			this.fromMuLaw();
240			} else if (this.bitDepth == '4') {
241			this.fromIMAADPCM();
242			}
243			}
244
245			/**
246			* Return 'RIFF' if the container is 'RF64', the current container name
247			* otherwise. Used to enforce 'RIFF' when RF64 is not allowed.
248			* @return {string}
249			* @private
250			*/
251			correctContainer_() {
252			return this.container == 'RF64' ? 'RIFF' : this.container;
253			}
254
255			/**
256			* Set up the WaveFileCreator object based on the arguments passed.
257			* This method only reset the fmt , fact, ds64 and data chunks.
258			* @param {number} numChannels The number of channels
259			* (Integer numbers: 1 for mono, 2 stereo and so on).
260			* @param {number} sampleRate The sample rate.
261			* Integer numbers like 8000, 44100, 48000, 96000, 192000.
262			* @param {string} bitDepthCode The audio bit depth code.
263			* One of '4', '8', '8a', '8m', '16', '24', '32', '32f', '64'
264			* or any value between '8' and '32' (like '12').
265			* @param {!Array<number>\|!Array<!Array<number>>\|!TypedArray} samples
266			* The samples. Must be in the correct range according to the bit depth.
267			* @param {?Object} options Optional. Used to force the container
268			* as RIFX with {'container': 'RIFX'}
269			* @throws {Error} If any argument does not meet the criteria.
270			* @private
271			*/
272			fromExisting_(numChannels, sampleRate, bitDepthCode, samples, options={}) {
273			let tmpWav = new WaveFileMetaEditor();
274			Object.assign(this.fmt, tmpWav.fmt);
275			Object.assign(this.fact, tmpWav.fact);
276			Object.assign(this.ds64, tmpWav.ds64);
277			Object.assign(this.data, tmpWav.data);
278			this.newWavFile_(numChannels, sampleRate, bitDepthCode, samples, options);
279			}
280			}
281

rochars / wavefile

Push — master ( 5a0225...e0b877 )

WaveFileConverter.fromExisting_ A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like