![whishper banner](misc/banner.png)

# [Whishper](https://whishper.net)

Whishper (formerly known as Web Whisper Plus) is a complete transcription suite. In simple words, it is a frontend for the Whisper model family, but [with batteries included](#features)!

> [Show me the screenshots!](#screenshots)

> [Self-hosting docs](https://whishper.net/guides/install/)

## Features

- [x] 🗣️ Transcribe any media to text: audio, video, etc.
    - Transcribe from URLs (any source supported by yt-dlp).
    - Upload a file to transcribe.
- [x] 📥 Download transcriptions in many formats: TXT, JSON, VTT, SRT or copy the raw text to your clipboard.
- [x] 🌐 Translate your transcriptions to any language supported by [Libretranslate](https://libretranslate.com).
- [x] ✍️ Edit your subtitles in a comfy and complete web UI!
    - Transcription highlighting based on media position.
    - CPS (Characters per second) warnings.
    - Segment splitting.
    - Segment insertion.
    - Subtitle language selection.
- [x] 🏠 100% Local: transcription, translation and subtitle edition happen 100% on your machine (can even work offline!).
- [x] 🚀 Fast: uses FasterWhisper as the Whisper backend: get much faster transcription times on CPU!
- [x] 👍 Quick setup: the setup involves just a docker-compose and you're good to go!
- [x] 🐎 CPU support: no GPU? No problem! Whishper can run on CPU too.
- [x] 🔥 NVIDIA GPU support: use your NVIDIA GPU to get even faster transcription times!

### Roadmap

- [x] ~~Support for GPU acceleration.~~
- [ ] Full-text search all transcriptions
- [ ] Audio recording from the browser.
- [ ] Can we do something with [seamless_communication](https://github.com/facebookresearch/seamless_communication)?

## Self hosting

Check out the self-hosting documentation [here](https://whishper.net/guides/install/).

## Project structure

Whishper is a collection of pieces that work together. The three main pieces are:

- Transcription-API: This is the API that enables running Faster-Whisper. You can find it in the `transcription-api` folder.
- Whishper-Backend: This is the backend that coordinates frontend calls, database, and tasks. You can find it in `backend` folder.
- Whishper-Frontend: This is the frontend (web UI) of the application. You can find it in `frontend` folder.
- Translation (3rd party): This is the libretranslate container that is used for translating subtitles.
- MongoDB (3rd party): This is the database that stores all the information about your transcriptions.
- Nginx (3rd party): This is the proxy that allows running everything from a single domain.

## Contributing

Contributions are welcome! Feel free to open a PR with your changes, or take a look at the issues to see if there is something you can help with.

### Development setup

Check out the development documentation [here](https://whishper.net/guides/development/).

## Screenshots

These screenshots are available on [the official website](https://whishper.net/usage/transcriptions/), click any of the following links to see:

- [A transcription creation](https://whishper.net/usage/transcriptions/)
- [A transcription translation](https://whishper.net/usage/translate/)
- [A transcription download](https://whishper.net/usage/download/)
- [The subtitle editor](https://whishper.net/usage/editor/)

## Credits

- [Faster Whisper](https://github.com/guillaumekln/faster-whisper)
- [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate)