-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Dictation): dictation tool using wavesurfer
- Loading branch information
1 parent
21167df
commit e6ff12b
Showing
4 changed files
with
214 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * React Fabric | ||
| * @version: 1.0.0 | ||
| * | ||
| * | ||
| * The MIT License (MIT) | ||
| * Copyright (c) 2024 Adarsh Pastakia | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| import { Button, CoreIcons, HotKey } from "@react-fabric/core"; | ||
| import { Format } from "@react-fabric/utilities"; | ||
| import classNames from "classnames"; | ||
| import { Fragment, useEffect, useRef, useState } from "react"; | ||
| import WaveSurfer from "wavesurfer.js"; | ||
| import RecordPlugin from "wavesurfer.js/dist/plugins/record"; | ||
|
|
||
| export interface DictationProps { | ||
| size?: "sm"; | ||
| variant?: "solid" | "outline"; | ||
| hotkey?: string; | ||
| onRecord?: (blob: Blob) => void; | ||
| } | ||
|
|
||
| export const Dictation = ({ | ||
| hotkey = "alt+t", | ||
| size, | ||
| variant, | ||
| onRecord, | ||
| }: DictationProps) => { | ||
| const [error, setError] = useState(""); | ||
| const [progress, setProgress] = useState(0); | ||
| const [recording, setRecording] = useState(false); | ||
| const wavesurfer = useRef<WaveSurfer>(); | ||
| const record = useRef<RecordPlugin>(); | ||
| const container = useRef<HTMLDivElement>(null); | ||
|
|
||
| useEffect(() => { | ||
| if (container.current) { | ||
| wavesurfer.current = new WaveSurfer({ | ||
| container: container.current, | ||
| waveColor: "#0190ff", | ||
| cursorWidth: 0, | ||
| width: 96, | ||
| height: size === "sm" ? 28 : 32, | ||
| barWidth: 1, | ||
| barRadius: 3, | ||
| barGap: 1, | ||
| barHeight: 1.5, | ||
| minPxPerSec: 16, | ||
| }); | ||
|
|
||
| record.current = wavesurfer.current.registerPlugin( | ||
| RecordPlugin.create({ | ||
| scrollingWaveform: true, | ||
| renderRecordedAudio: false, | ||
| }), | ||
| ); | ||
|
|
||
| record.current.on("record-progress", (time) => { | ||
| setProgress(time); | ||
| }); | ||
|
|
||
| return () => { | ||
| wavesurfer.current?.destroy(); | ||
| }; | ||
| } | ||
| }, [size]); | ||
|
|
||
| useEffect(() => { | ||
| record.current?.on("record-end", (blob) => { | ||
| setRecording(false); | ||
| onRecord?.(blob); | ||
| }); | ||
| }, [onRecord]); | ||
|
|
||
| const startDictation = useRef(() => { | ||
| record.current | ||
| ?.startRecording() | ||
| .then(() => { | ||
| setRecording(true); | ||
| }) | ||
| .catch(() => { | ||
| setError("Unable to access microphone"); | ||
| }); | ||
| }); | ||
|
|
||
| const stopDictation = useRef(() => { | ||
| record.current?.stopRecording(); | ||
| }); | ||
|
|
||
| return ( | ||
| <div | ||
| className={classNames( | ||
| "inline-flex rounded-full overflow-hidden items-center outline outline-tint-100 bg-dimmed -outline-offset-1 self-center", | ||
| size === "sm" ? "h-7" : "h-8", | ||
| )} | ||
| > | ||
| <div | ||
| ref={container} | ||
| className={classNames( | ||
| "overflow-hidden w-24 bg-base rounded-full shadow-inner shadow-base", | ||
| size === "sm" ? "h-7" : "h-8", | ||
| !recording && "hidden", | ||
| )} | ||
| style={{ | ||
| boxShadow: "inset 0 1px 2px 0 var(--tw-shadow-color)", | ||
| }} | ||
| /> | ||
| {error && ( | ||
| <span className="text-xs font-medium text-danger-500 px-2"> | ||
| {error} | ||
| </span> | ||
| )} | ||
| {!error && !recording && ( | ||
| <Fragment> | ||
| <HotKey global keyCombo={hotkey} handler={startDictation.current} /> | ||
| <Button | ||
| size={size} | ||
| icon={CoreIcons.mic} | ||
| aria-label="Start dictation" | ||
| rounded | ||
| variant={variant} | ||
| onClick={startDictation.current} | ||
| /> | ||
| </Fragment> | ||
| )} | ||
| {!error && recording && ( | ||
| <Fragment> | ||
| <HotKey global keyCombo="esc" handler={stopDictation.current} /> | ||
| <span className="text-xs px-2">{Format.duration(progress)}</span> | ||
| <Button | ||
| size={size} | ||
| icon={CoreIcons.stop} | ||
| aria-label="Stop dictation" | ||
| rounded | ||
| iconAlign="end" | ||
| variant="solid" | ||
| color="danger" | ||
| onClick={stopDictation.current} | ||
| /> | ||
| </Fragment> | ||
| )} | ||
| </div> | ||
| ); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * React Fabric | ||
| * @version: 1.0.0 | ||
| * | ||
| * | ||
| * The MIT License (MIT) | ||
| * Copyright (c) 2024 Adarsh Pastakia | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| import { SearchBar } from "@react-fabric/searchbar"; | ||
| import { action } from "@storybook/addon-actions"; | ||
| import type { Meta, StoryObj } from "@storybook/react"; | ||
| import { Dictation } from "../src"; | ||
|
|
||
| const meta: Meta = { | ||
| component: Dictation, | ||
| title: "@media/Dictation", | ||
| parameters: { | ||
| layout: "centered", | ||
| jest: ["media/tests/Dictation.test.tsx"], | ||
| }, | ||
| }; | ||
|
|
||
| export default meta; | ||
| type DictationStory = StoryObj<typeof Dictation>; | ||
|
|
||
| export const _Dictation: DictationStory = { | ||
| render: (args) => { | ||
| return ( | ||
| <div className=""> | ||
| <Dictation {...args} /> | ||
| </div> | ||
| ); | ||
| }, | ||
| args: { | ||
| onRecord: action("onRecord"), | ||
| }, | ||
| }; |