lib/validators/validate-sample-rate.js   A
last analyzed

Complexity

Total Complexity 2
Complexity/F 2

Size

Lines of Code 8
Function Count 1

Duplication

Duplicated Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 5
dl 0
loc 8
rs 10
c 0
b 0
f 0
wmc 2
mnd 1
bc 1
fnc 1
bpm 1
cpm 2
noi 0
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 validateSampleRate function.
27
 * @see https://github.com/rochars/wavefile
28
 */
29
30
/**
31
 * Validate the sample rate value of a wav file according to the number of
32
 * channels and the bit depth of the audio.
33
 * @param {number} channels The number of channels in the file.
34
 * @param {number} bits The number of bits per sample.
35
 * @param {number} sampleRate The sample rate to be validated.
36
 * @return {boolean} True is the sample rate is valid, false otherwise.
37
 */
38
export function validateSampleRate(channels, bits, sampleRate) {
39
  /** @type {number} */
40
  let byteRate = channels * (bits / 8) * sampleRate;
41
  if (sampleRate < 1 || byteRate > 4294967295) {
42
    return false;
43
  }
44
  return true;
45
}
46