Skip to content
This repository has been archived by the owner on Dec 18, 2023. It is now read-only.
/ totext Public archive

πŸ“š A simple and extensible CLI to transform audio to text.

License

Notifications You must be signed in to change notification settings

dend/totext

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

20 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ToText logo

πŸŽ™ ToText - A simple and extensible speech-to-text CLI

Convert speech to text with whatever service you want.




Stand With Ukraine

This tool is nothing more than a wrapper around the variety of speech-to-text services out there. It simplifies the process of generating text transcripts from audio files, born from my own need to do that for The Work Item.

Build

The project is written entirely in C# and .NET. To build it, you need to download and install the .NET SDK (if you haven't yet).

The following projects are currently included in the solution:

Project Description
ToText.Shell The core CLI that is responsible for taking user input and passing it to the plugins responsible for transcript creation.
ToText.SDK A simple collection of interfaces and helpers that define the ToText SDK. Any plugins that are used by the CLI need to implement the IPlugin interface from this library.
ToText.Plugin.ACS An implementation of the Azure Cognitive Services speech-to-text toolchain.

More plugins and extensions to both the CLI and SDK will be added over time.

Use

Once the project is built, navigate to the bin/ folder in the solution directory (pre-built binaries coming soon). totext.exe is the file you are looking for. It supports the following arguments:

Argument Mandatory Description
--file, -f Yes Path to the audio file that needs to be transcribed.
--processor, -p Yes The ID of the plugin that will be used to create the transcript.
--processor-version, -e No The version of the processor to be used, in case more than one processor with the same ID is available.
--output-file, -o No Path to the text file that will be used to store the generated transcript. If the parameter is absent, transcription will be live and shown in the terminal.

Available plugins

Plugin ID Version Description
Azure Cognitive Services acs 0.0.1 An experimental implementation of the Azure Cognitive Services speech-to-text toolchain. Currently only WAV file support is implemented. Data from the WAV file will be sent to the Azure service for processing, and requires an active Azure account. Read more about the plugin in its README.

Any new plugins that are implemented need to follow the ToText.Plugin.{PLUGIN_ID} scheme.

About

πŸ“š A simple and extensible CLI to transform audio to text.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages