search

sveinbjornt / hear

Command line speech recognition and transcription for macOS
https://sveinbjorn.org/hear
BSD 3-Clause "New" or "Revised" License
405 stars 25 forks source link
command-line command-line-tool macos speech-recognition transcribe-audio-files transcription

readme

License [Language]() [Release]() [Build]()

hear

hear

macOS speech recognition via the command line

hear is a command line interface for the built-in speech recognition capabilities in macOS. This makes it possible to transcribe spoken audio input or entire audio files.

Apple's macOS has long shipped with the say tool, a command line interface for the operating system's venerable speech synthesis capabilities. As of 10.15 "Catalina", it also ships with highly capable speech recognition for a variety of languages. This project is an attempt to provide a robust native CLI for this functionality since no such tool is provided by Apple. hear supports speech recognition and transcription of both live microphone input and audio files in a variety of formats. All formats supported by CoreAudio should work (e.g. WAV, MP3, AIFF, AAC, CAF, ALAC, etc.).

See the man page for further details.

Download

hear is free, open source software written in Objective-C. The source code is freely available under a BSD license. If you find this program useful, please make a donation.

Installation

After downloading and expanding the archive, change to the resulting directory and run the following command:

bash install.sh

This will install the binary into /usr/local/bin and the man page into /usr/local/share/man/man1/.

Usage

Transcribe audio from microphone (or default audio input device)

hear

From microphone in single line output mode

hear -m

Transcribe audio file

hear -d -i /path/to/someone_speaking.mp3 > transcribed_text.txt

The -d flag specifies that only on-device speech recognition capabilities should be used. Otherwise, data may be sent to Apple servers, which as of writing (2024) have a hard limit of about 500 characters before quitting.

Build

To build hear from source, run the following command from the repository root (requires Xcode command line build tools):

make build_unsigned

The resulting binary is created in products/.

Test

To run tests on the built command line tool, execute the following command from the repository root:

bash test/test.sh

Troubleshooting

If running the binary leads to an abort signal, try running the binary by right-clicking, and selecting open. This should automatically open the binary with the regular terminal and prompt you to allow the required permissions.

BSD License

Copyright (c) 2022-2024 Sveinbjorn Thordarson <sveinbjorn@sveinbjorn.org>

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.