tone-stream 1.3.0 → 1.4.2

package/README.md

@@ -2,7 +2,7 @@
 
 A simple node.js tone stream library.
 
-You can specify frequencies to be played by adding item in the format:
+You can specify frequencies to be played by adding items in the format:
 ```
   [NUMBER_OF_SAMPLES, FREQUENCY]
 ```
@@ -15,7 +15,7 @@ or DTMF tones:
 Playing some musical notes:
 
 ```
-const ToneStream = require('tone-stream')
+const { ToneStream } = require('tone-stream')
 
 const Speaker = require('speaker')
 
@@ -29,9 +29,9 @@ const ts = new ToneStream(format)
 
 const s = new Speaker(format)
 
-ts.add([4000, 261.63]) // C4
-ts.add([4000, 296.33]) // D4
-ts.add([4000, 329.63]) // E4
+ts.add([1000, 261.63]) // C4
+ts.add([1000, 296.33]) // D4
+ts.add([1000, 329.63]) // E4
 
 ts.pipe(s)
 
@@ -41,7 +41,7 @@ setTimeout(() => {}, 2000)
 Playing some DTMF tones:
 
 ```
-const ToneStream = require('tone-stream')
+const { ToneStream } = require('tone-stream')
 
 const Speaker = require('speaker')
 
@@ -66,3 +66,46 @@ ts.pipe(s)
 setTimeout(() => {}, 2000)
 ```
 
+Using some helper function to add miscelaneous tones
+```
+const { ToneStream, utils } = require('tone-stream')
+
+const Speaker = require('speaker')
+
+const _ = require('lodash')
+
+const SAMPLE_RATE = 8000
+
+const format = {
+        sampleRate: SAMPLE_RATE,
+        bitDepth: 16,
+        channels: 1
+}
+
+const ts = new ToneStream(format)
+
+const s = new Speaker(format)
+
+const tones = _.flatten([
+    utils.gen_dtmf_tones("1234567890abcdef", 100, 0, SAMPLE_RATE),
+    utils.gen_morse_tones("Be yourself; everyone else is already taken", 880, 70, SAMPLE_RATE),
+    utils.gen_music_scale("C5 D5 E5 F5 G5 A5 B5 C6", 100, 0, SAMPLE_RATE),
+])
+
+console.log("Inspecting tones:")
+tones.forEach(tone => {
+    console.log(tone)
+})
+
+ts.concat(tones)
+
+ts.on('empty', () => {
+    console.log("Got event 'empty'. Reversing tones and playing again.")
+    tones.reverse()
+    ts.concat(tones)
+})
+
+console.log("Starting playing tones")
+ts.pipe(s)
+
+```

package/examples/detect_tones.js

@@ -1,4 +1,4 @@
-const ToneStream = require('../index.js')
+const { ToneStream } = require('../index.js')
 const goertzel = require('goertzel-stream')
 
 const {PassThrough} = require('stream')

package/examples/do_re_mi.js

@@ -1,4 +1,4 @@
-const ToneStream = require('../index.js')
+const { ToneStream } = require('../index.js')
 const Speaker = require('speaker')
 
 const format = {

package/examples/endless_dtmf_tones.js

@@ -1,4 +1,4 @@
-const ToneStream = require('../index.js')
+const { ToneStream } = require('../index.js')
 const Speaker = require('speaker')
 
 const format = {

package/examples/endless_dtmf_tones_with_interdigit_rest.js

@@ -0,0 +1,26 @@
+const { ToneStream, utils } = require('../index.js')
+const Speaker = require('speaker')
+
+const SAMPLE_RATE = 8000
+
+const format = {
+	sampleRate: SAMPLE_RATE,
+	bitDepth: 16,
+	channels: 1
+}
+
+const ts = new ToneStream(format)
+
+const s = new Speaker(format)
+
+var tones = utils.gen_dtmf_tones("1234576890abcd*#", 50, 50, SAMPLE_RATE)
+
+ts.concat(tones)
+
+ts.on('empty', () => {
+	console.log("Got event 'empty'. Reversing tones.")
+	tones.reverse()
+	ts.concat(tones)
+})
+
+ts.pipe(s)

package/examples/endless_morse_code.js

@@ -0,0 +1,27 @@
+const { ToneStream, utils } = require('../index.js')
+const Speaker = require('speaker')
+
+const SAMPLE_RATE = 8000
+
+const format = {
+	sampleRate: SAMPLE_RATE,
+	bitDepth: 16,
+	channels: 1
+}
+
+const ts = new ToneStream(format)
+
+const s = new Speaker(format)
+
+var tones = utils.gen_morse_tones("What we've got here is failure to communicate", "C6", 70, SAMPLE_RATE)
+tones.push([8000, 's'])
+
+ts.concat(tones)
+
+ts.on('empty', () => {
+	console.log("Got event 'empty'. Reversing tones.")
+	tones.reverse()
+	ts.concat(tones)
+})
+
+ts.pipe(s)

package/examples/endless_musical_scale.js

@@ -1,8 +1,10 @@
-const ToneStream = require('../index.js')
+const { ToneStream, utils } = require('../index.js')
 const Speaker = require('speaker')
 
+const SAMPLE_RATE = 8000
+
 const format = {
-	sampleRate: 8000, 
+	sampleRate: SAMPLE_RATE,
 	bitDepth: 16,
 	channels: 1
 }
@@ -11,23 +13,18 @@ const ts = new ToneStream(format)
 
 const s = new Speaker(format)
 
-var notes = [
-	[1000, 261.63], // C4
-	[1000, 296.33], // D4
-	[1000, 329.63], // E4
-	[1000, 349.23], // F4
-	[1000, 392.00], // G4
-	[1000, 440.00], // A4
-	[1000, 493.88], // B4
-	[1000, 523.25], // C5
-]
+const notes = "C4 D4 E4 F4 G4 A4 B4 C5"
+const note_duration = 100 // milliseconds
+const rest_duration = 0 // milliseconds
+
+const tones = utils.gen_music_scale(notes, note_duration, rest_duration, SAMPLE_RATE)
 
-ts.concat(notes)
+ts.concat(tones)
 
 ts.on('empty', () => {
 	console.log("Got event 'empty'. Reversing notes.")
-	notes.reverse()
-	ts.concat(notes)
+	tones.reverse()
+	ts.concat(tones)
 })
 
 ts.pipe(s)

package/examples/silence_filler.js

@@ -1,4 +1,4 @@
-const ToneStream = require('../index.js')
+const { ToneStream } = require('../index.js')
 
 const Speaker = require('speaker')
 

package/index.js

@@ -153,4 +153,7 @@ class ToneStream extends Readable {
 	}
 }
 
-module.exports = ToneStream
+module.exports = {
+    ToneStream,
+    utils: require('./lib/utils.js'),
+}

package/lib/dtmf.js

@@ -22,6 +22,11 @@ tones['a'] = tones['A']
 tones['b'] = tones['B']
 tones['c'] = tones['C']
 tones['d'] = tones['D']
+tones['e'] = tones['*']
+tones['f'] = tones['#']
+tones['E'] = tones['*']
+tones['F'] = tones['#']
+
 
 
 module.exports = tones

package/lib/utils.js

@@ -0,0 +1,111 @@
+const morse = require('morse-node').create("ITU")
+
+const noteToFrequency = require('note-to-frequency')
+
+const tone2freq = tone => {
+    if(typeof tone === 'number') {
+        return tone
+    }
+    return noteToFrequency(tone)
+}
+
+const wpm2rate = (wpm, sampleRate) => {
+    // WPM = 2.4 * (Dots per second)
+    // Ref: http://www.nu-ware.com/NuCode%20Help/index.html?morse_code_structure_and_timing_.htm
+    var dots_per_second = wpm / 2.4
+    return sampleRate / dots_per_second
+}
+
+const gen_morse_tones = (text, freq_tone, wpm, sampleRate) => {
+    if(!morse.isValid(text, 'chars')) {
+        throw `parse-failure: invalid chars`
+    }
+
+    var signals = morse.encode(text)
+
+    signals = signals.replace(/ \/ /g, "/")
+
+    var dot_duration = Math.round(wpm2rate(wpm, sampleRate)) // converts from WPM to number of samples
+    var dash_duration = dot_duration * 3
+    var word_space_duration = dot_duration * 7
+
+    var tone = tone2freq(freq_tone)
+
+    var last_was_dot_or_dash = false
+
+    var tones = []
+
+    for(var i=0 ; i<signals.length ; i++) {
+        var signal = signals[i]
+        if(last_was_dot_or_dash && (signal == '.'|| signal == '-')) {
+            tones.push([dot_duration, 's']) // silence
+        }
+        switch(signal) {
+        case '.':
+            tones.push([dot_duration, tone])
+            last_was_dot_or_dash = true
+            break
+        case '-':
+            tones.push([dash_duration, tone])
+            last_was_dot_or_dash = true
+            break
+        case ' ':
+            tones.push([dash_duration, 's']) // silence
+            last_was_dot_or_dash = false
+            break
+        case '/':
+            tones.push([word_space_duration, 's']) // silence
+            last_was_dot_or_dash = false
+            break
+        }
+    }
+
+    return tones
+}
+
+const gen_dtmf_tones = (digits, digit_duration, interdigit_duration, sampleRate) => {
+    if(!digits.match(/^[0123456789abcdefABCDEF\*#]+/)) {
+        throw `parse-failure: invalid DTMF digits`
+    }
+
+    var samples_per_digit = Math.round(digit_duration * sampleRate / 1000)
+    var samples_per_rest = Math.round(interdigit_duration * sampleRate / 1000)
+    
+    var tones = []
+
+    for (var i=0 ; i<digits.length; i++) {
+        if(i > 0) {
+            tones.push([samples_per_rest, 's'])
+        }
+        tones.push([samples_per_digit, 'DTMF:' + digits.charAt(i)])
+    }
+
+    return tones
+}
+
+const gen_music_scale = (notes, note_duration, rest_duration, sampleRate) => {
+    var tones = []
+
+    var samples_per_note = Math.round(note_duration * sampleRate / 1000)
+    var samples_per_rest = Math.round(rest_duration * sampleRate / 1000)
+
+    var notes = notes.split(" ")
+
+    for (var i=0 ; i<notes.length; i++) {
+        var note = notes[i]
+        if(i > 0) {
+            tones.push([samples_per_rest, 's'])
+        }
+        var freq = noteToFrequency(note)
+        tones.push([samples_per_note, freq])
+    }
+
+    return tones
+}
+
+
+module.exports = {
+    gen_morse_tones,
+    gen_dtmf_tones,
+    gen_music_scale,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tone-stream",
-  "version": "1.3.0",
+  "version": "1.4.2",
   "description": "A simple audio tone stream library",
   "main": "index.js",
   "repository": {
@@ -9,16 +9,25 @@
   },
   "keywords": [
     "tone",
-    "stream"
+    "stream",
+    "dtmf",
+    "morse",
+    "music",
+    "notes",
+    "audio",
+    "frequency"
   ],
   "scripts": {},
   "author": "MayamaTakeshi",
   "license": "MIT",
   "devDependencies": {
     "goertzel-stream": "git+https://github.com/MayamaTakeshi/goertzel-stream.git",
+    "lodash": "^4.17.21",
     "speaker": "^0.5.1"
   },
   "dependencies": {
+    "morse-node": "^0.1.1",
+    "note-to-frequency": "^1.4.1",
     "spec-read-stream": "^1.2.0"
   }
 }

package/a.js

@@ -1,54 +0,0 @@
-const ToneStream = require('./index.js')
-
-const Speaker = require('speaker')
-
-const assert = require('assert')
-
-const format = {
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-}
-
-const filler = 0// silence
-
-const ts = new ToneStream(format) //, filler)
-
-const s = new Speaker(format)
-
-ts.add([3000, 261.63]) // C4
-ts.add([1000, 's'])
-ts.add([3000, 296.33]) // D4
-ts.add([1000, 's'])
-ts.add([3000, 329.63]) // E4
-
-var b
-/*
-b= ts.read(500)
-console.log(b.length, b)
-assert(b.length == 500)
-s.write(b)
-
-b = ts.read(700)
-console.log(b.length, b)
-assert(b.length == 700)
-s.write(b)
-
-b = ts.read(160)
-console.log(b.length, b)
-assert(b.length == 160)
-s.write(b)
-
-b = ts.read(180)
-console.log(b.length, b)
-assert(b.length == 180)
-s.write(b)
-*/
-
-b = ts.read(12000)
-console.log(b.length, b)
-//assert(b.length == 10080) // this will be filled with zeros after all items are consumed.
-s.write(b)
-
-setTimeout(() => {}, 2000)
-

package/a.txt

@@ -1,3 +0,0 @@
-abc
-def
-ghi

package/a1.js

@@ -1,23 +0,0 @@
-const ToneStream = require('./index.js')
-
-const Speaker = require('speaker')
-
-const format = {
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-}
-
-const ts = new ToneStream(format)
-
-const s = new Speaker(format)
-
-ts.add([1000, 'DTMF:1'])
-ts.add([500, 's'])
-ts.add([1000, 'DTMF:2'])
-ts.add([500, 's'])
-ts.add([1000, 'DTMF:3'])
-
-ts.pipe(s)
-
-setTimeout(() => {}, 2000)

package/b.js

@@ -1,22 +0,0 @@
-const ToneStream = require('./index.js')
-const Speaker = require('speaker')
-
-const format = {
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-}
-
-const ts = new ToneStream(format)
-
-const s = new Speaker(format)
-
-ts.add([1570, 261.63]) // C4
-ts.add([1000, 's'])    // silence
-ts.add([1570, 296.33]) // D4
-ts.add([1000, 's'])    // silence
-ts.add([1570, 329.63]) // E4
-
-ts.pipe(s)
-
-setTimeout(() => {}, 2000)

package/c.js

@@ -1,29 +0,0 @@
-const ToneStream = require('./index.js')
-const Speaker = require('speaker')
-
-const format = {
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-}
-
-const ts = new ToneStream(format, 0)
-
-const s = new Speaker(format)
-
-ts.add([500, 261.63]) // C4
-ts.add([250, 's'])    // silence
-ts.add([500, 296.33]) // D4
-ts.add([250, 's'])    // silence
-ts.add([500, 329.63]) // E4
-
-ts.pipe(s)
-/*
-var b = ts.read(10000)
-console.log("b:")
-console.log(b)
-console.log(b.length, b)
-s.write(b)
-*/
-
-setTimeout(() => {}, 2000)

package/d.js

@@ -1,14 +0,0 @@
-const ToneStream = require('./index.js')
-
-const fs = require('fs')
-
-const ws = fs.createWriteStream('./a.raw')
-
-const ts = new ToneStream({
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-})
-
-ts.pipe(ws)
-

package/e.js

@@ -1,9 +0,0 @@
-
-var fs =require('fs')
-var spy = new require('stream').PassThrough()
-spy.on('data', data=> {
-	console.log("got data")
-	console.log(data)
-})
-
-fs.createReadStream("a.txt").pipe(spy).pipe(process.stdout)

package/f.js

@@ -1,41 +0,0 @@
-const ToneStream = require('./index.js')
-
-const Speaker = require('speaker')
-
-const assert = require('assert')
-
-const format = {
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-}
-
-const filler = 0 // silence
-
-const ts = new ToneStream(format, filler)
-
-const s = new Speaker(format)
-
-ts.add([2000, 261.63]) // C4
-ts.add([2000, 296.33]) // D4
-ts.add([2000, 329.63]) // E4
-
-const fetch_and_write = () => {
-	var res = true
-	while(res) {
-		var b = ts.read(160)
-		if(!b) return
-		console.log(b.length, b)
-		var res = s.write(b)
-		console.log(res)
-	}
-}
-
-s.on('drain', () => {
-	console.log('drain')
-	fetch_and_write()	
-})
-
-fetch_and_write()
-
-setTimeout(() => {}, 5000)

package/g.js

@@ -1,29 +0,0 @@
-
-
-var goertzel = require('goertzel-stream')
-var Generator = require('audio-generator')
-
-var freq = 261.63
-
-// Generate a sine wave at 697 Hz
-var gen = Generator(function (time) {
-  if (time > 1) {
-    return 0
-  } else {
-    return Math.sin(Math.PI * 2 * time * freq)
-  }
-})
-
-// Detection stream looking for the 697 Hz frequency
-var detect = goertzel([freq, 296.33, 329.63])
-
-// Pipe the signal into the detector
-gen.pipe(detect)
-
-detect.on('toneStart', function (tones) {
-  console.log('start', tones)
-})
-detect.on('toneEnd', function (tones) {
-  console.log('start', tones)
-})
-

package/g1.js

@@ -1,48 +0,0 @@
-
-
-var goertzel = require('goertzel-stream')
-var Generator = require('audio-generator')
-
-var lo = 697 
-//var hi = 1209
-
-var gen = Generator(function (time) {
-  if (time > 1) {
-    return 0
-  } else {
-    return (
-	//(
-		Math.sin(Math.PI * 2 * time * lo)
-//	 +
-//		Math.sin(Math.PI * 2 * time * hi)
-	//) / 2
-		)
-  }
-},
-  {
-    duration: 10,
-	period: Infinity,
-  }
-)
-
-// Detection stream looking for the 697 Hz frequency
-var detect = goertzel([697, 770, 852, 941, 1209, 1336, 1477, 1633])
-
-// Pipe the signal into the detector
-gen.pipe(detect)
-
-var Speaker = require('speaker')
-var s = new Speaker({
-	sampleRate: 32000,
-	bitDepth: 16,
-	channels: 1,
-})
-//gen.pipe(s)
-
-detect.on('toneStart', function (tones) {
-  console.log('start', tones)
-})
-detect.on('toneEnd', function (tones) {
-  console.log('start', tones)
-})
-

package/h.js

@@ -1,65 +0,0 @@
-var Generator = require('audio-generator/stream');
-var Speaker = require('speaker');
-
-var speaker = new Speaker({
-	sampleRate: 44100,
-	bitDepth: 16,
-	channels: 2,
-})
-
-var fs = require('fs')
-
-var ws = fs.createWriteStream("./b.raw")
- 
-Generator(
-    //Generator function, returns sample values -1..1 for channels
-    function (time) {
-		/*
-        return [
-            Math.sin(Math.PI * 2 * time * 439), //channel 1
-            Math.sin(Math.PI * 2 * time * 441), //channel 2
-        ]
-		*/
-        return  [
-			Math.sin(Math.PI * 2 * time * 440),
-			Math.sin(Math.PI * 2 * time * 440),
-		]
-    },
- 
-    {
-        //Duration of generated stream, in seconds, after which stream will end.
-        duration: 3,
- 
-        //Periodicity of the time.
-        period: Infinity,
-})
-.on('error', function (e) {
-    //error happened during generation the frame
-})
-.on('data', function(audioBuffer) {
-	var cd = audioBuffer.getChannelData(0)
-	//console.log(cd)
-	var b = Buffer.alloc(cd.length * 2)
-	for(var i=0 ; i<cd.length ; i++) {
-	    //if(cd[i] != 0) console.log(cd[i])
-
-		var f = cd[i]
-		var OLD_LIMIT = 0.9999999999999999
-
-		f = (32767 - -32768)/(OLD_LIMIT - -OLD_LIMIT)*(f - OLD_LIMIT)+32767
-
-		//if(f != 0) { console.log(f) }
-		b.writeInt16LE(f, i*2)
-	}
-	//console.log(b.length, b)
-//	speaker.write(b)
-	ws.write(b)
-})
-/*
-.pipe(speaker);
-.pipe(ws)
-*/
-
-
-
-

package/i.js

@@ -1,29 +0,0 @@
-const ToneStream = require('./index.js')
-const Speaker = require('speaker')
-
-const format = {
-	sampleRate: 8000, 
-	bitDepth: 16,
-	channels: 1
-}
-
-const ts = new ToneStream(format)
-
-const s = new Speaker(format)
-
-ts.add([1000, 's'])    // silence
-ts.add([2000, 261.63]) // C4
-ts.add([1000, 's'])    // silence
-ts.add([2000, 296.33]) // D4
-ts.add([1000, 's'])    // silence
-ts.add([2000, 329.63]) // E4
-
-var tid = setInterval(() => {
-	var b = ts.read(320)
-	console.log(b)
-	if(!b) {
-		clearInterval(tid)
-		return
-	}
-	s.write(b)
-}, 20)