@micdrop/client 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
20
20
  // src/index.ts
21
21
  var index_exports = {};
22
22
  __export(index_exports, {
23
+ DEFAULT_TURN_MAX_WAIT: () => DEFAULT_TURN_MAX_WAIT,
23
24
  Mic: () => Mic,
24
25
  MicController: () => MicController,
25
26
  MicDriver: () => MicDriver,
@@ -626,8 +627,8 @@ var MS_PER_FRAME = SILERO_FRAME_SAMPLES / SILERO_SAMPLE_RATE * 1e3;
626
627
  var defaultOptions = {
627
628
  positiveSpeechThreshold: 0.18,
628
629
  negativeSpeechThreshold: 0.11,
629
- minSpeechFrames: 8,
630
- redemptionFrames: 20
630
+ minSpeechFrames: 4,
631
+ redemptionFrames: 8
631
632
  };
632
633
  var loadModel;
633
634
  function setSileroModelLoader(loader) {
@@ -947,15 +948,18 @@ function equalVADConfig(a, b) {
947
948
  // src/audio/MicRecorder.ts
948
949
  var SAMPLE_RATE = 16e3;
949
950
  var CHUNK_INTERVAL = 100;
951
+ var DEFAULT_TURN_MAX_WAIT = 4e3;
950
952
  var defaultMicRecorderState = {
951
953
  isStarting: false,
952
954
  isStarted: false,
953
955
  isSpeaking: false
954
956
  };
955
957
  var MicRecorder = class extends import_eventemitter34.EventEmitter {
956
- constructor(vadConfig) {
958
+ constructor(vadConfig, turnDetector, turnMaxWait = DEFAULT_TURN_MAX_WAIT) {
957
959
  super();
958
960
  this.vadConfig = vadConfig;
961
+ this.turnDetector = turnDetector;
962
+ this.turnMaxWait = turnMaxWait;
959
963
  this.isRecording = false;
960
964
  this.speakingConfirmed = false;
961
965
  this.sourceSampleRate = SAMPLE_RATE;
@@ -964,6 +968,12 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
964
968
  this.buffer = [];
965
969
  this.bufferLength = 0;
966
970
  this.queuedChunks = [];
971
+ // The turn is open between the first confirmed word and the moment the
972
+ // server is told to answer, which can span several pauses
973
+ this.turnOpen = false;
974
+ this.turnListening = false;
975
+ // Bumped whenever the turn moves on, so a late answer is dropped
976
+ this.turnRound = 0;
967
977
  this.start = async (mic) => {
968
978
  if (this.state.isStarted) {
969
979
  throw new Error("MicRecorder is already started");
@@ -996,6 +1006,7 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
996
1006
  isStarted: false,
997
1007
  isSpeaking: false
998
1008
  });
1009
+ this.cancelPendingClose();
999
1010
  try {
1000
1011
  this.mic?.off("Frames", this.onFrames);
1001
1012
  this.mic = void 0;
@@ -1009,6 +1020,17 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
1009
1020
  }
1010
1021
  this.resetBuffers();
1011
1022
  };
1023
+ /**
1024
+ * Changes what decides when a turn is over
1025
+ * @param turnDetector - The new detector, or nothing to leave it to the VAD
1026
+ */
1027
+ this.changeTurnDetector = (turnDetector) => {
1028
+ if (turnDetector === this.turnDetector) return;
1029
+ if (this.turnOpen) {
1030
+ this.endTurn();
1031
+ }
1032
+ this.turnDetector = turnDetector;
1033
+ };
1012
1034
  this.changeVad = (vadConfig) => {
1013
1035
  if (equalVADConfig(vadConfig, this.vadConfig)) return;
1014
1036
  const mic = this.mic;
@@ -1022,6 +1044,9 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
1022
1044
  }
1023
1045
  };
1024
1046
  this.onFrames = (frames, sampleRate) => {
1047
+ if (this.turnListening) {
1048
+ this.turnDetector?.push(frames, sampleRate);
1049
+ }
1025
1050
  if (sampleRate !== this.sourceSampleRate) {
1026
1051
  this.flushChunks();
1027
1052
  this.sourceSampleRate = sampleRate;
@@ -1050,12 +1075,23 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
1050
1075
  this.bufferLength = this.reserveLength;
1051
1076
  this.reserve = [];
1052
1077
  this.reserveLength = 0;
1078
+ if (this.turnDetector && !this.turnListening) {
1079
+ this.turnDetector.reset();
1080
+ this.turnListening = true;
1081
+ for (const frames of this.buffer) {
1082
+ this.turnDetector.push(frames, this.sourceSampleRate);
1083
+ }
1084
+ }
1053
1085
  this.flushChunks();
1054
1086
  };
1055
1087
  this.onConfirmSpeaking = () => {
1056
1088
  this.speakingConfirmed = true;
1057
1089
  this.changeState({ isSpeaking: true });
1058
- this.emit("StartSpeaking");
1090
+ this.cancelPendingClose();
1091
+ if (!this.turnOpen) {
1092
+ this.turnOpen = true;
1093
+ this.emit("StartSpeaking");
1094
+ }
1059
1095
  for (const chunk of this.queuedChunks) {
1060
1096
  this.emit("Chunk", chunk);
1061
1097
  }
@@ -1063,6 +1099,9 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
1063
1099
  };
1064
1100
  this.onCancelSpeaking = () => {
1065
1101
  this.stopRecording();
1102
+ if (!this.turnOpen) {
1103
+ this.turnListening = false;
1104
+ }
1066
1105
  };
1067
1106
  this.onStopSpeaking = () => {
1068
1107
  const wasConfirmed = this.speakingConfirmed;
@@ -1071,11 +1110,55 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
1071
1110
  this.flushChunks(true);
1072
1111
  }
1073
1112
  this.stopRecording();
1074
- this.emit("StopSpeaking");
1113
+ this.closeTurn();
1075
1114
  };
1076
1115
  this.state = defaultMicRecorderState;
1077
1116
  this.vad = getVAD(vadConfig);
1078
1117
  }
1118
+ /**
1119
+ * Ends the turn, unless the detector hears an unfinished sentence.
1120
+ *
1121
+ * A microphone that is no longer listening ends it straight away: a muted or
1122
+ * paused call has nothing more to say, whatever the sentence sounded like.
1123
+ */
1124
+ async closeTurn() {
1125
+ if (!this.turnDetector || !this.turnOpen || !this.vad.isStarted || this.vad.isPaused) {
1126
+ this.endTurn();
1127
+ return;
1128
+ }
1129
+ const round = this.turnRound;
1130
+ try {
1131
+ const { complete } = await this.turnDetector.predict();
1132
+ if (round !== this.turnRound) return;
1133
+ if (complete) {
1134
+ this.endTurn();
1135
+ return;
1136
+ }
1137
+ } catch (error) {
1138
+ console.error("[Micdrop] Turn detection failed", error);
1139
+ this.endTurn();
1140
+ return;
1141
+ }
1142
+ this.cancelPendingClose();
1143
+ this.turnTimer = setTimeout(() => {
1144
+ this.turnTimer = void 0;
1145
+ this.endTurn();
1146
+ }, this.turnMaxWait);
1147
+ }
1148
+ endTurn() {
1149
+ this.cancelPendingClose();
1150
+ this.turnOpen = false;
1151
+ this.turnListening = false;
1152
+ this.emit("StopSpeaking");
1153
+ }
1154
+ /** Drops the pending close, both the timer and the answer still owed */
1155
+ cancelPendingClose() {
1156
+ this.turnRound++;
1157
+ if (this.turnTimer) {
1158
+ clearTimeout(this.turnTimer);
1159
+ this.turnTimer = void 0;
1160
+ }
1161
+ }
1079
1162
  stopRecording() {
1080
1163
  this.isRecording = false;
1081
1164
  this.speakingConfirmed = false;
@@ -1122,6 +1205,8 @@ var MicRecorder = class extends import_eventemitter34.EventEmitter {
1122
1205
  resetBuffers() {
1123
1206
  this.isRecording = false;
1124
1207
  this.speakingConfirmed = false;
1208
+ this.turnOpen = false;
1209
+ this.turnListening = false;
1125
1210
  this.reserve = [];
1126
1211
  this.reserveLength = 0;
1127
1212
  this.buffer = [];
@@ -1477,7 +1562,11 @@ var MicdropClient = class extends import_eventemitter37.EventEmitter {
1477
1562
  this.micRecorder.changeVad(options.vad);
1478
1563
  }
1479
1564
  } else {
1480
- this.micRecorder = new MicRecorder(this.options.vad);
1565
+ this.micRecorder = new MicRecorder(
1566
+ this.options.vad,
1567
+ this.options.turnDetector,
1568
+ this.options.turnMaxWait
1569
+ );
1481
1570
  this.micRecorder.on("StateChange", () => {
1482
1571
  this.notifyStateChange();
1483
1572
  });
@@ -1523,6 +1612,28 @@ var MicdropClient = class extends import_eventemitter37.EventEmitter {
1523
1612
  throw error;
1524
1613
  }
1525
1614
  };
1615
+ /**
1616
+ * Changes what decides when a turn is over, during a call or before one
1617
+ * @param turnDetector - The new detector, or nothing to leave it to the VAD
1618
+ */
1619
+ this.setTurnDetector = (turnDetector) => {
1620
+ this.options.turnDetector = turnDetector;
1621
+ this.micRecorder?.changeTurnDetector(turnDetector);
1622
+ };
1623
+ /**
1624
+ * Says how long a held turn waits for the rest of the sentence.
1625
+ *
1626
+ * The way out of a wrong verdict: a detector can hear an unfinished sentence
1627
+ * where there is none, and the speaker who never comes back still gets an
1628
+ * answer once this runs out.
1629
+ * @param milliseconds - How long to wait past the detector asking to
1630
+ */
1631
+ this.setTurnMaxWait = (milliseconds) => {
1632
+ this.options.turnMaxWait = milliseconds;
1633
+ if (this.micRecorder) {
1634
+ this.micRecorder.turnMaxWait = milliseconds;
1635
+ }
1636
+ };
1526
1637
  this.changeMicDevice = async (deviceId) => {
1527
1638
  await this.startMic({ deviceId });
1528
1639
  };
@@ -1825,6 +1936,7 @@ if (!globalScope2.micdropClient) {
1825
1936
  var Micdrop = globalScope2.micdropClient;
1826
1937
  // Annotate the CommonJS export names for ESM import in node:
1827
1938
  0 && (module.exports = {
1939
+ DEFAULT_TURN_MAX_WAIT,
1828
1940
  Mic,
1829
1941
  MicController,
1830
1942
  MicDriver,